WellArchitected / Client / get_lens

get_lens#

WellArchitected.Client.get_lens(**kwargs)#

Get an existing lens.

See also: AWS API Documentation

Request Syntax

response = client.get_lens(
    LensAlias='string',
    LensVersion='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.

  • LensVersion (string) – The lens version to be retrieved.

Return type:

dict

Returns:

Response Syntax

{
    'Lens': {
        'LensArn': 'string',
        'LensVersion': 'string',
        'Name': 'string',
        'Description': 'string',
        'Owner': 'string',
        'ShareInvitationId': 'string',
        'Tags': {
            'string': 'string'
        }
    }
}

Response Structure

  • (dict) –

    • Lens (dict) –

      A lens return object.

      • LensArn (string) –

        The ARN of a lens.

      • LensVersion (string) –

        The version of a lens.

      • Name (string) –

        The full name of the lens.

      • Description (string) –

        The description of the lens.

      • Owner (string) –

        The Amazon Web Services account ID that owns the lens.

      • ShareInvitationId (string) –

        The ID assigned to the share invitation.

      • Tags (dict) –

        The tags assigned to the lens.

        • (string) –

          • (string) –

Exceptions