Skip to content

update_environment_template_version

update_environment_template_version(
    template_name: ResourceName,
    major_version: TemplateVersionPart,
    minor_version: TemplateVersionPart,
    *,
    config_overrides: Optional[ProtonClientConfig] = None,
    description: Optional[Description] = None,
    status: Optional[TemplateVersionStatus] = None,
) -> UpdateEnvironmentTemplateVersionOutput

Update a major or minor version of an environment template.

Parameters:

  • template_name (ResourceName) –

    The name of the environment template.

  • major_version (TemplateVersionPart) –

    To update a major version of an environment template, include major Version.

  • minor_version (TemplateVersionPart) –

    To update a minor version of an environment template, include minorVersion.

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

    A description of environment template version to update.

  • status (Optional[TemplateVersionStatus], default: None ) –

    The status of the environment template minor version to update.

Raises:

Source code in docs_src/capo_proton/_services/proton.py
def update_environment_template_version(
    self,
    template_name: "capo_proton.types.resource_name.ResourceName",
    major_version: "capo_proton.types.template_version_part.TemplateVersionPart",
    minor_version: "capo_proton.types.template_version_part.TemplateVersionPart",
    *,
    config_overrides: Optional[ProtonClientConfig] = None,
    description: Optional["capo_proton.types.description.Description"] = None,
    status: Optional[
        "capo_proton.types.template_version_status.TemplateVersionStatus"
    ] = None,
) -> "capo_proton.types.update_environment_template_version_output.UpdateEnvironmentTemplateVersionOutput":
    """<p>Update a major or minor version of an environment template.</p>

    Args:
        template_name: <p>The name of the environment template.</p>
        major_version: <p>To update a major version of an environment template, include <code>major Version</code>.</p>
        minor_version: <p>To update a minor version of an environment template, include <code>minorVersion</code>.</p>
        description: <p>A description of environment template version to update.</p>
        status: <p>The status of the environment template minor version to 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.
    """

    def _handler(
        req: "OperationRequest[capo_proton.types.update_environment_template_version_input.UpdateEnvironmentTemplateVersionInput]",
    ) -> OperationResponse[
        "capo_proton.types.update_environment_template_version_output.UpdateEnvironmentTemplateVersionOutput"
    ]:
        import capo_proton._operations.aws_proton20200720.update_environment_template_version

        output, http_response = (
            capo_proton._operations.aws_proton20200720.update_environment_template_version.update_environment_template_version(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

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

        return capo_proton.types.update_environment_template_version_input.redact_sensitive(
            input_
        )

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

        return capo_proton.types.update_environment_template_version_output.redact_sensitive(
            output
        )

    interceptors_, options_ = self.operation_options(
        config_overrides,
        OperationLogging(
            "UpdateEnvironmentTemplateVersion",
            redact_input=_redact_input,
            redact_output=_redact_output,
        ),
    )
    input_: capo_proton.types.update_environment_template_version_input.UpdateEnvironmentTemplateVersionInput = {
        "template_name": template_name,
        "major_version": major_version,
        "minor_version": minor_version,
    }
    if description is not None:
        input_["description"] = description
    if status is not None:
        input_["status"] = status

    response = execute_pipeline(
        OperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    response.response.close()
    return response.output