WellArchitected / Client / get_lens_version_difference

get_lens_version_difference#

WellArchitected.Client.get_lens_version_difference(**kwargs)#

Get lens version differences.

See also: AWS API Documentation

Request Syntax

response = client.get_lens_version_difference(
    LensAlias='string',
    BaseLensVersion='string',
    TargetLensVersion='string'
)
Parameters:

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

  • BaseLensVersion (string) – The base version of the lens.

  • TargetLensVersion (string) – The lens version to target a difference for.

Return type:

dict

Returns:

Response Syntax

{
    'LensAlias': 'string',
    'LensArn': 'string',
    'BaseLensVersion': 'string',
    'TargetLensVersion': 'string',
    'LatestLensVersion': 'string',
    'VersionDifferences': {
        'PillarDifferences': [
            {
                'PillarId': 'string',
                'PillarName': 'string',
                'DifferenceStatus': 'UPDATED'|'NEW'|'DELETED',
                'QuestionDifferences': [
                    {
                        'QuestionId': 'string',
                        'QuestionTitle': 'string',
                        'DifferenceStatus': 'UPDATED'|'NEW'|'DELETED'
                    },
                ]
            },
        ]
    }
}

Response Structure

  • (dict) –

    • 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 ARN for the lens.

    • BaseLensVersion (string) –

      The base version of the lens.

    • TargetLensVersion (string) –

      The target lens version for the lens.

    • LatestLensVersion (string) –

      The latest version of the lens.

    • VersionDifferences (dict) –

      The differences between the base and latest versions of the lens.

      • PillarDifferences (list) –

        The differences between the base and latest versions of the lens.

        • (dict) –

          A pillar difference return object.

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

          • DifferenceStatus (string) –

            Indicates the type of change to the pillar.

          • QuestionDifferences (list) –

            List of question differences.

            • (dict) –

              A question difference return object.

              • QuestionId (string) –

                The ID of the question.

              • QuestionTitle (string) –

                The title of the question.

              • DifferenceStatus (string) –

                Indicates the type of change to the question.

Exceptions