WellArchitected / Client / create_review_template

create_review_template#

WellArchitected.Client.create_review_template(**kwargs)#

Create a review template.

Note

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.

See also: AWS API Documentation

Request Syntax

response = client.create_review_template(
    TemplateName='string',
    Description='string',
    Lenses=[
        'string',
    ],
    Notes='string',
    Tags={
        'string': 'string'
    },
    ClientRequestToken='string'
)
Parameters:

  • TemplateName (string) –

    [REQUIRED]

    Name of the review template.

  • Description (string) –

    [REQUIRED]

    The review template description.

  • Lenses (list) –

    [REQUIRED]

    Lenses applied to the review template.

    • (string) –

      The alias of the lens.

      For Amazon Web Services official lenses, this is either the lens alias, such as serverless, or the lens ARN, such as arn:aws:wellarchitected:us-east-1::lens/serverless. Note that some operations (such as ExportLens and CreateLensShare) are not permitted on Amazon Web Services official lenses.

      For custom lenses, this is the lens ARN, such as arn:aws:wellarchitected:us-west-2:123456789012:lens/0123456789abcdef01234567890abcdef.

      Each lens is identified by its LensSummary$LensAlias.

  • Notes (string) –

    The notes associated with the workload.

    For a review template, these are the notes that will be associated with the workload when the template is applied.

  • Tags (dict) –

    The tags assigned to the review template.

    • (string) –

      • (string) –

  • ClientRequestToken (string) –

    [REQUIRED]

    A unique case-sensitive string used to ensure that this request is idempotent (executes only once).

    You should not reuse the same token for other requests. If you retry a request with the same client request token and the same parameters after the original request has completed successfully, the result of the original request is returned.

    Warning

    This token is listed as required, however, if you do not specify it, the Amazon Web Services SDKs automatically generate one for you. If you are not using the Amazon Web Services SDK or the CLI, you must provide this token or the request will fail.

    This field is autopopulated if not provided.

Return type:

dict

Returns:

Response Syntax

{
    'TemplateArn': 'string'
}

Response Structure

  • (dict) –

    • TemplateArn (string) –

      The review template ARN.

Exceptions