list_share_invitations

WellArchitected.Client.list_share_invitations(**kwargs)

List the workload invitations.

See also: AWS API Documentation

Request Syntax

response = client.list_share_invitations(
    WorkloadNamePrefix='string',
    LensNamePrefix='string',
    ShareResourceType='WORKLOAD'|'LENS',
    NextToken='string',
    MaxResults=123
)

Parameters

• WorkloadNamePrefix (string) -- An optional string added to the beginning of each workload name returned in the results.
• LensNamePrefix (string) -- An optional string added to the beginning of each lens name returned in the results.
• ShareResourceType (string) -- The type of share invitations to be returned.
• 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.

Return type

dict

Returns

Response Syntax

{
    'ShareInvitationSummaries': [
        {
            'ShareInvitationId': 'string',
            'SharedBy': 'string',
            'SharedWith': 'string',
            'PermissionType': 'READONLY'|'CONTRIBUTOR',
            'ShareResourceType': 'WORKLOAD'|'LENS',
            'WorkloadName': 'string',
            'WorkloadId': 'string',
            'LensName': 'string',
            'LensArn': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

• (dict) --

  Input for List Share Invitations

  • ShareInvitationSummaries (list) --

    List of share invitation summaries in a workload.

    • (dict) --

      A share invitation summary return object.

      • ShareInvitationId (string) --

        The ID assigned to the share invitation.

      • SharedBy (string) --

        An Amazon Web Services account ID.

      • SharedWith (string) --

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

      • PermissionType (string) --

        Permission granted on a workload share.

      • ShareResourceType (string) --

        The resource type of the share invitation.

      • WorkloadName (string) --

        The name of the workload.

        The name must be unique within an account within an Amazon Web Services Region. Spaces and capitalization are ignored when checking for uniqueness.

      • WorkloadId (string) --

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

      • LensName (string) --

        The full name of the lens.

      • LensArn (string) --

        The ARN for the lens.

  • 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.AccessDeniedException
• WellArchitected.Client.exceptions.ThrottlingException