WellArchitected / Client / list_workload_shares

list_workload_shares#

WellArchitected.Client.list_workload_shares(**kwargs)#

List the workload shares associated with the workload.

See also: AWS API Documentation

Request Syntax

response = client.list_workload_shares(
    WorkloadId='string',
    SharedWithPrefix='string',
    NextToken='string',
    MaxResults=123,
    Status='ACCEPTED'|'REJECTED'|'PENDING'|'REVOKED'|'EXPIRED'|'ASSOCIATING'|'ASSOCIATED'|'FAILED'
)
Parameters:

  • WorkloadId (string) –

    [REQUIRED]

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

  • SharedWithPrefix (string) – The Amazon Web Services account ID, IAM role, organization ID, or organizational unit (OU) ID with which the workload 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

{
    'WorkloadId': 'string',
    'WorkloadShareSummaries': [
        {
            'ShareId': 'string',
            'SharedWith': 'string',
            'PermissionType': 'READONLY'|'CONTRIBUTOR',
            'Status': 'ACCEPTED'|'REJECTED'|'PENDING'|'REVOKED'|'EXPIRED'|'ASSOCIATING'|'ASSOCIATED'|'FAILED',
            'StatusMessage': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) –

    Input for List Workload Share

    • WorkloadId (string) –

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

    • WorkloadShareSummaries (list) –

      A list of workload share summaries.

      • (dict) –

        A workload 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.

        • PermissionType (string) –

          Permission granted on a workload share.

        • 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