Select your cookie preferences

We use cookies and similar tools to enhance your experience, provide our services, deliver relevant advertising, and make improvements. Approved third parties also use these tools to help us deliver advertising and provide certain site features.

get_lens

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-west-2::lens/serverless .

    For custom lenses, this is the lens ARN, such as arn:aws:wellarchitected:us-east-1:123456789012:lens/my-lens .

    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

  • WellArchitected.Client.exceptions.ValidationException
  • WellArchitected.Client.exceptions.ResourceNotFoundException
  • WellArchitected.Client.exceptions.InternalServerException
  • WellArchitected.Client.exceptions.AccessDeniedException
  • WellArchitected.Client.exceptions.ThrottlingException