list_lens_shares

WellArchitected.Client.list_lens_shares(**kwargs)

List the lens shares associated with the lens.

See also: AWS API Documentation

Request Syntax

response = client.list_lens_shares(
    LensAlias='string',
    SharedWithPrefix='string',
    NextToken='string',
    MaxResults=123,
    Status='ACCEPTED'|'REJECTED'|'PENDING'|'REVOKED'|'EXPIRED'|'ASSOCIATING'|'ASSOCIATED'|'FAILED'
)

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.

• SharedWithPrefix (string) -- The Amazon Web Services account ID, IAM role, organization ID, or organizational unit (OU) ID with which the lens is shared.
• NextToken (string) -- The token to use to retrieve the next set of results.
• MaxResults (integer) -- The maximum number of results to return for this request.
• Status (string) -- The status of a workload share.

Return type

dict

Returns

Response Syntax

{
    'LensShareSummaries': [
        {
            'ShareId': 'string',
            'SharedWith': 'string',
            'Status': 'ACCEPTED'|'REJECTED'|'PENDING'|'REVOKED'|'EXPIRED'|'ASSOCIATING'|'ASSOCIATED'|'FAILED',
            'StatusMessage': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

• (dict) --

  • LensShareSummaries (list) --

    A list of lens share summaries.

    • (dict) --

      A lens share summary return object.

      • ShareId (string) --

        The ID associated with the workload share.

      • SharedWith (string) --

        The Amazon Web Services account ID, IAM role, organization ID, or organizational unit (OU) ID with which the workload is shared.

      • Status (string) --

        The status of a workload share.

      • StatusMessage (string) --

        Optional message to compliment the Status field.

  • NextToken (string) --

    The token to use to retrieve the next set of results.

Exceptions

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