import_lens

WellArchitected.Client.import_lens(**kwargs)

Import a new lens.

The lens cannot be applied to workloads or shared with other Amazon Web Services accounts until it's published with CreateLensVersion

Lenses are defined in JSON. For more information, see JSON format specification in the Well-Architected Tool User Guide .

A custom lens cannot exceed 500 KB in size.

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.import_lens(
    LensAlias='string',
    JSONString='string',
    ClientRequestToken='string',
    Tags={
        'string': 'string'
    }
)

Parameters

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

• JSONString (string) --

  [REQUIRED]

  The JSON representation of a lens.

• ClientRequestToken (string) --

  [REQUIRED]

  A unique case-sensitive string used to ensure that this request is idempotent (executes only once).

  You should not reuse the same token for other requests. If you retry a request with the same client request token and the same parameters after it has completed successfully, the result of the original request is returned.

  Warning

  This token is listed as required, however, if you do not specify it, the Amazon Web Services SDKs automatically generate one for you. If you are not using the Amazon Web Services SDK or the CLI, you must provide this token or the request will fail.

  This field is autopopulated if not provided.

• Tags (dict) --

  Tags to associate to a lens.

  • (string) --
    • (string) --

Return type

dict

Returns

Response Syntax

{
    'LensArn': 'string',
    'Status': 'IN_PROGRESS'|'COMPLETE'|'ERROR'
}

Response Structure

• (dict) --

  • LensArn (string) --

    The ARN for the lens.

  • Status (string) --

    The status of the imported lens.

Exceptions

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