Skip to content

delete_review_template

delete_review_template(
    template_arn: TemplateArn,
    *,
    config_overrides: Optional[WellArchitectedClientConfig] = None,
    client_request_token: Optional[ClientRequestToken] = None,
) -> None

Delete a review template.

Only the owner of a review template can delete it.

After the review template is deleted, Amazon Web Services accounts, users, organizations, and organizational units (OUs) that you shared the review template with will no longer be able to apply it to new workloads.

Parameters:

  • template_arn (TemplateArn) –

    The review template ARN.

Raises:

Source code in docs_src/capo_wellarchitected/_services/well_architected.py
def delete_review_template(
    self,
    template_arn: "capo_wellarchitected.types.template_arn.TemplateArn",
    *,
    config_overrides: Optional[WellArchitectedClientConfig] = None,
    client_request_token: Optional[
        "capo_wellarchitected.types.client_request_token.ClientRequestToken"
    ] = None,
) -> None:
    """<p>Delete a review template.</p> <p>Only the owner of a review template can delete it.</p> <p>After the review template is deleted, Amazon Web Services accounts, users, organizations, and organizational units (OUs) that you shared the review template with will no longer be able to apply it to new workloads.</p>

    Args:
        template_arn: <p>The review template ARN.</p>

    Raises:
        capo_wellarchitected.errors.access_denied_exception.AccessDeniedException: <p>User does not have sufficient access to perform this action.</p>
        capo_wellarchitected.errors.conflict_exception.ConflictException: <p>The resource has already been processed, was deleted, or is too large.</p>
        capo_wellarchitected.errors.internal_server_exception.InternalServerException: <p>There is a problem with the Well-Architected Tool API service.</p>
        capo_wellarchitected.errors.resource_not_found_exception.ResourceNotFoundException: <p>The requested resource was not found.</p>
        capo_wellarchitected.errors.throttling_exception.ThrottlingException: <p>Request was denied due to request throttling.</p>
        capo_wellarchitected.errors.validation_exception.ValidationException: <p>The user input is not valid.</p>
        capo_wellarchitected.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_wellarchitected.types.delete_review_template_input.DeleteReviewTemplateInput]",
    ) -> OperationResponse[None]:
        import capo_wellarchitected._operations.well_architected_api_service_lambda.delete_review_template

        output, http_response = (
            capo_wellarchitected._operations.well_architected_api_service_lambda.delete_review_template.delete_review_template(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("DeleteReviewTemplate")
    )
    input_: capo_wellarchitected.types.delete_review_template_input.DeleteReviewTemplateInput = {
        "template_arn": template_arn
    }
    if client_request_token is None:
        client_request_token = str(uuid.uuid4())
    input_["client_request_token"] = client_request_token

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