WellArchitected / Client / list_review_templates

list_review_templates#

WellArchitected.Client.list_review_templates(**kwargs)#

List review templates.

See also: AWS API Documentation

Request Syntax

response = client.list_review_templates(
    NextToken='string',
    MaxResults=123
)
Parameters:

  • NextToken (string) – The token to use to retrieve the next set of results.

  • MaxResults (integer) – The maximum number of results to return for this request.

Return type:

dict

Returns:

Response Syntax

{
    'ReviewTemplates': [
        {
            'Description': 'string',
            'Lenses': [
                'string',
            ],
            'Owner': 'string',
            'UpdatedAt': datetime(2015, 1, 1),
            'TemplateArn': 'string',
            'TemplateName': 'string',
            'UpdateStatus': 'CURRENT'|'LENS_NOT_CURRENT'
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) –

    • ReviewTemplates (list) –

      List of review templates.

      • (dict) –

        Summary of a review template.

        • Description (string) –

          Description of the review template.

        • Lenses (list) –

          Lenses associated with 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.

        • Owner (string) –

          An Amazon Web Services account ID.

        • UpdatedAt (datetime) –

          The date and time recorded.

        • TemplateArn (string) –

          The review template ARN.

        • TemplateName (string) –

          The name of the review template.

        • UpdateStatus (string) –

          The latest status of a review template.

    • NextToken (string) –

      The token to use to retrieve the next set of results.

Exceptions