Skip to content

update_environment_template async

update_environment_template(
    name: ResourceName,
    *,
    config_overrides: Optional[AsyncProtonClientConfig] = None,
    display_name: Optional[DisplayName] = None,
    description: Optional[Description] = None,
) -> UpdateEnvironmentTemplateOutput

Update an environment template.

Parameters:

  • name (ResourceName) –

    The name of the environment template to update.

  • display_name (Optional[DisplayName], default: None ) –

    The name of the environment template to update as displayed in the developer interface.

  • description (Optional[Description], default: None ) –

    A description of the environment template update.

Raises:

Source code in docs_src/capo_proton/_services/async_proton.py
async def update_environment_template(
    self,
    name: "capo_proton.types.resource_name.ResourceName",
    *,
    config_overrides: Optional[AsyncProtonClientConfig] = None,
    display_name: Optional["capo_proton.types.display_name.DisplayName"] = None,
    description: Optional["capo_proton.types.description.Description"] = None,
) -> "capo_proton.types.update_environment_template_output.UpdateEnvironmentTemplateOutput":
    """<p>Update an environment template.</p>

    Args:
        name: <p>The name of the environment template to update.</p>
        display_name: <p>The name of the environment template to update as displayed in the developer interface.</p>
        description: <p>A description of the environment template update.</p>

    Raises:
        capo_proton.errors.access_denied_exception.AccessDeniedException: <p>There <i>isn't</i> sufficient access for performing this action.</p>
        capo_proton.errors.conflict_exception.ConflictException: <p>The request <i>couldn't</i> be made due to a conflicting operation or resource.</p>
        capo_proton.errors.internal_server_exception.InternalServerException: <p>The request failed to register with the service.</p>
        capo_proton.errors.resource_not_found_exception.ResourceNotFoundException: <p>The requested resource <i>wasn't</i> found.</p>
        capo_proton.errors.throttling_exception.ThrottlingException: <p>The request was denied due to request throttling.</p>
        capo_proton.errors.validation_exception.ValidationException: <p>The input is invalid or an out-of-range value was supplied for the input parameter.</p>
        capo_proton.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_proton.types.update_environment_template_input.UpdateEnvironmentTemplateInput]",
    ) -> AsyncOperationResponse[
        "capo_proton.types.update_environment_template_output.UpdateEnvironmentTemplateOutput"
    ]:
        import capo_proton._operations.aws_proton20200720.update_environment_template

        (
            output,
            http_response,
        ) = await capo_proton._operations.aws_proton20200720.update_environment_template.async_update_environment_template(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    def _redact_input(
        input_: "capo_proton.types.update_environment_template_input.UpdateEnvironmentTemplateInput",
    ) -> dict[str, Any]:
        import capo_proton.types.update_environment_template_input

        return capo_proton.types.update_environment_template_input.redact_sensitive(
            input_
        )

    def _redact_output(
        output: "capo_proton.types.update_environment_template_output.UpdateEnvironmentTemplateOutput",
    ) -> dict[str, Any]:
        import capo_proton.types.update_environment_template_output

        return (
            capo_proton.types.update_environment_template_output.redact_sensitive(
                output
            )
        )

    interceptors_, options_ = self.operation_options(
        config_overrides,
        OperationLogging(
            "UpdateEnvironmentTemplate",
            redact_input=_redact_input,
            redact_output=_redact_output,
        ),
    )
    input_: capo_proton.types.update_environment_template_input.UpdateEnvironmentTemplateInput = {
        "name": name
    }
    if display_name is not None:
        input_["display_name"] = display_name
    if description is not None:
        input_["description"] = description

    response = await aexecute_pipeline(
        AsyncOperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    await response.response.aclose()
    return response.output