Skip to content

create_review_template

create_review_template(
    *,
    config_overrides: Optional[WellArchitectedClientConfig] = None,
    template_name: Optional[TemplateName] = None,
    description: Optional[TemplateDescription] = None,
    lenses: Optional[ReviewTemplateLenses] = None,
    notes: Optional[Notes] = None,
    tags: Optional[TagMap] = None,
    client_request_token: Optional[ClientRequestToken] = None,
) -> CreateReviewTemplateOutput

Create a review template.

Disclaimer

Do not include or gather personal identifiable information (PII) of end users or other identifiable individuals in or via your review templates. If your review template or those shared with you and used in your account do include or collect PII you are responsible for: ensuring that the included PII is processed in accordance with applicable law, providing adequate privacy notices, and obtaining necessary consents for processing such data.

Parameters:

Raises:

Source code in docs_src/capo_wellarchitected/_services/well_architected.py
def create_review_template(
    self,
    *,
    config_overrides: Optional[WellArchitectedClientConfig] = None,
    template_name: Optional[
        "capo_wellarchitected.types.template_name.TemplateName"
    ] = None,
    description: Optional[
        "capo_wellarchitected.types.template_description.TemplateDescription"
    ] = None,
    lenses: Optional[
        "capo_wellarchitected.types.review_template_lenses.ReviewTemplateLenses"
    ] = None,
    notes: Optional["capo_wellarchitected.types.notes.Notes"] = None,
    tags: Optional["capo_wellarchitected.types.tag_map.TagMap"] = None,
    client_request_token: Optional[
        "capo_wellarchitected.types.client_request_token.ClientRequestToken"
    ] = None,
) -> "capo_wellarchitected.types.create_review_template_output.CreateReviewTemplateOutput":
    """<p>Create a review template.</p> <note> <p> <b>Disclaimer</b> </p> <p>Do not include or gather personal identifiable information (PII) of end users or other identifiable individuals in or via your review templates. If your review template or those shared with you and used in your account do include or collect PII you are responsible for: ensuring that the included PII is processed in accordance with applicable law, providing adequate privacy notices, and obtaining necessary consents for processing such data.</p> </note>

    Args:
        template_name: <p>Name of the review template.</p>
        description: <p>The review template description.</p>
        lenses: <p>Lenses applied to the review template.</p>
        tags: <p>The tags assigned to the review template.</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.service_quota_exceeded_exception.ServiceQuotaExceededException: <p>The user has reached their resource quota.</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.create_review_template_input.CreateReviewTemplateInput]",
    ) -> OperationResponse[
        "capo_wellarchitected.types.create_review_template_output.CreateReviewTemplateOutput"
    ]:
        import capo_wellarchitected._operations.well_architected_api_service_lambda.create_review_template

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

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("CreateReviewTemplate")
    )
    input_: capo_wellarchitected.types.create_review_template_input.CreateReviewTemplateInput = {}
    if template_name is not None:
        input_["template_name"] = template_name
    if description is not None:
        input_["description"] = description
    if lenses is not None:
        input_["lenses"] = lenses
    if notes is not None:
        input_["notes"] = notes
    if tags is not None:
        input_["tags"] = tags
    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