export_lens

export_lens(**kwargs)

Export an existing lens.

Lenses are defined in JSON. For more information, see JSON format specification in the Well-Architected Tool User Guide . Only the owner of a lens can export it.

Note

Disclaimer

Do not include or gather personal identifiable information (PII) of end users or other identifiable individuals in or via your custom lenses. If your custom lens or those shared with you and used in your account do include or collect PII you are responsible for: ensuring that the included PII is processed in accordance with applicable law, providing adequate privacy notices, and obtaining necessary consents for processing such data.

See also: AWS API Documentation

Request Syntax

response = client.export_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 exported.

Return type

dict

Returns

Response Syntax

{
    'LensJSON': 'string'
}

Response Structure

• (dict) --

  • LensJSON (string) --

    The JSON for the lens.

Exceptions

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