WellArchitected / Client / associate_lenses

associate_lenses#

WellArchitected.Client.associate_lenses(**kwargs)#

Associate a lens to a workload.

Up to 10 lenses can be associated with a workload in a single API operation. A maximum of 20 lenses can be associated with a workload.

Note

Disclaimer

By accessing and/or applying custom lenses created by another Amazon Web Services user or account, you acknowledge that custom lenses created by other users and shared with you are Third Party Content as defined in the Amazon Web Services Customer Agreement.

See also: AWS API Documentation

Request Syntax

response = client.associate_lenses(
    WorkloadId='string',
    LensAliases=[
        'string',
    ]
)
Parameters:

  • WorkloadId (string) –

    [REQUIRED]

    The ID assigned to the workload. This ID is unique within an Amazon Web Services Region.

  • LensAliases (list) –

    [REQUIRED]

    List of lens aliases to associate or disassociate with a workload. Up to 10 lenses can be specified.

    Identify a lens using its LensSummary$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.

Returns:

None

Exceptions

  • WellArchitected.Client.exceptions.ValidationException

  • WellArchitected.Client.exceptions.ResourceNotFoundException

  • WellArchitected.Client.exceptions.ConflictException

  • WellArchitected.Client.exceptions.InternalServerException

  • WellArchitected.Client.exceptions.AccessDeniedException

  • WellArchitected.Client.exceptions.ThrottlingException