WellArchitected / Client / get_review_template_lens_review

get_review_template_lens_review#

WellArchitected.Client.get_review_template_lens_review(**kwargs)#

Get a lens review associated with a review template.

See also: AWS API Documentation

Request Syntax

response = client.get_review_template_lens_review(
    TemplateArn='string',
    LensAlias='string'
)
Parameters:

  • TemplateArn (string) –

    [REQUIRED]

    The review template ARN.

  • LensAlias (string) –

    [REQUIRED]

    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.

Return type:

dict

Returns:

Response Syntax

{
    'TemplateArn': 'string',
    'LensReview': {
        'LensAlias': 'string',
        'LensArn': 'string',
        'LensVersion': 'string',
        'LensName': 'string',
        'LensStatus': 'CURRENT'|'NOT_CURRENT'|'DEPRECATED'|'DELETED'|'UNSHARED',
        'PillarReviewSummaries': [
            {
                'PillarId': 'string',
                'PillarName': 'string',
                'Notes': 'string',
                'QuestionCounts': {
                    'string': 123
                }
            },
        ],
        'UpdatedAt': datetime(2015, 1, 1),
        'Notes': 'string',
        'QuestionCounts': {
            'string': 123
        },
        'NextToken': 'string'
    }
}

Response Structure

  • (dict) –

    • TemplateArn (string) –

      The review template ARN.

    • LensReview (dict) –

      A lens review of a question.

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

      • LensArn (string) –

        The lens ARN.

      • LensVersion (string) –

        The version of the lens.

      • LensName (string) –

        The full name of the lens.

      • LensStatus (string) –

        The status of the lens.

      • PillarReviewSummaries (list) –

        Pillar review summaries of a lens review.

        • (dict) –

          Summary of a review template.

          • PillarId (string) –

            The ID used to identify a pillar, for example, security.

            A pillar is identified by its PillarReviewSummary$PillarId.

          • PillarName (string) –

            The name of the pillar.

          • 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 questions are answered and unanswered in the requested pillar of the lens review.

            • (string) –

              • (integer) –

                A non-negative integer that denotes how many.

      • UpdatedAt (datetime) –

        The date and time recorded.

      • 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 questions are answered and unanswered in the lens review.

        • (string) –

          • (integer) –

            A non-negative integer that denotes how many.

      • NextToken (string) –

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

Exceptions