WellArchitected / Client / list_share_invitations

list_share_invitations#

WellArchitected.Client.list_share_invitations(**kwargs)#

List the share invitations.

WorkloadNamePrefix, LensNamePrefix, ProfileNamePrefix, and TemplateNamePrefix are mutually exclusive. Use the parameter that matches your ShareResourceType.

See also: AWS API Documentation

Request Syntax

response = client.list_share_invitations(
    WorkloadNamePrefix='string',
    LensNamePrefix='string',
    ShareResourceType='WORKLOAD'|'LENS'|'PROFILE'|'TEMPLATE',
    NextToken='string',
    MaxResults=123,
    ProfileNamePrefix='string',
    TemplateNamePrefix='string'
)
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.

  • ProfileNamePrefix (string) – An optional string added to the beginning of each profile name returned in the results.

  • TemplateNamePrefix (string) – An optional string added to the beginning of each review template name returned in the results.

Return type:

dict

Returns:

Response Syntax

{
    'ShareInvitationSummaries': [
        {
            'ShareInvitationId': 'string',
            'SharedBy': 'string',
            'SharedWith': 'string',
            'PermissionType': 'READONLY'|'CONTRIBUTOR',
            'ShareResourceType': 'WORKLOAD'|'LENS'|'PROFILE'|'TEMPLATE',
            'WorkloadName': 'string',
            'WorkloadId': 'string',
            'LensName': 'string',
            'LensArn': 'string',
            'ProfileName': 'string',
            'ProfileArn': 'string',
            'TemplateName': 'string',
            'TemplateArn': '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, organization ID, or organizational unit (OU) ID with which the workload, lens, profile, or review template is shared.

        • PermissionType (string) –

          Permission granted on a share request.

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

        • ProfileName (string) –

          The profile name.

        • ProfileArn (string) –

          The profile ARN.

        • TemplateName (string) –

          The name of the review template.

        • TemplateArn (string) –

          The review template ARN.

    • NextToken (string) –

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

Exceptions