WellArchitected / Client / get_review_template

get_review_template

WellArchitected.Client.get_review_template(**kwargs)

Get review template.

See also: AWS API Documentation

Request Syntax

response = client.get_review_template(
    TemplateArn='string'
)

Parameters:

TemplateArn (string) –

[REQUIRED]

The review template ARN.

Return type:

dict

Returns:

Response Syntax

{
    'ReviewTemplate': {
        'Description': 'string',
        'Lenses': [
            'string',
        ],
        'Notes': 'string',
        'QuestionCounts': {
            'string': 123
        },
        'Owner': 'string',
        'UpdatedAt': datetime(2015, 1, 1),
        'TemplateArn': 'string',
        'TemplateName': 'string',
        'Tags': {
            'string': 'string'
        },
        'UpdateStatus': 'CURRENT'|'LENS_NOT_CURRENT',
        'ShareInvitationId': 'string'
    }
}

Response Structure

• (dict) –

  • ReviewTemplate (dict) –

    The review template.

    • Description (string) –

      The review template description.

    • Lenses (list) –

      The 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.

    • QuestionCounts (dict) –

      A count of how many total questions are answered and unanswered in the review template.

      • (string) –

        • (integer) –

          A non-negative integer that denotes how many.

    • 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.

    • Tags (dict) –

      The tags assigned to the review template.

      • (string) –

        • (string) –

    • UpdateStatus (string) –

      The latest status of a review template.

    • ShareInvitationId (string) –

      The ID assigned to the template share invitation.

Exceptions

• WellArchitected.Client.exceptions.ValidationException

• WellArchitected.Client.exceptions.ResourceNotFoundException

• WellArchitected.Client.exceptions.InternalServerException

• WellArchitected.Client.exceptions.AccessDeniedException

• WellArchitected.Client.exceptions.ThrottlingException