CleanRoomsService / Client / list_memberships

list_memberships#

CleanRoomsService.Client.list_memberships(**kwargs)#

Lists all memberships resources within the caller’s account.

See also: AWS API Documentation

Request Syntax

response = client.list_memberships(
    nextToken='string',
    maxResults=123,
    status='ACTIVE'|'REMOVED'|'COLLABORATION_DELETED'
)
Parameters:

  • nextToken (string) – The token value retrieved from a previous call to access the next page of results.

  • maxResults (integer) – The maximum size of the results that is returned per call.

  • status (string) – A filter which will return only memberships in the specified status.

Return type:

dict

Returns:

Response Syntax

{
    'nextToken': 'string',
    'membershipSummaries': [
        {
            'id': 'string',
            'arn': 'string',
            'collaborationArn': 'string',
            'collaborationId': 'string',
            'collaborationCreatorAccountId': 'string',
            'collaborationCreatorDisplayName': 'string',
            'collaborationName': 'string',
            'createTime': datetime(2015, 1, 1),
            'updateTime': datetime(2015, 1, 1),
            'status': 'ACTIVE'|'REMOVED'|'COLLABORATION_DELETED',
            'memberAbilities': [
                'CAN_QUERY'|'CAN_RECEIVE_RESULTS',
            ]
        },
    ]
}

Response Structure

  • (dict) –

    • nextToken (string) –

      The token value retrieved from a previous call to access the next page of results.

    • membershipSummaries (list) –

      The list of memberships returned from the ListMemberships operation.

      • (dict) –

        The membership object listed by the request.

        • id (string) –

          The unique ID for the membership’s collaboration.

        • arn (string) –

          The unique ARN for the membership.

        • collaborationArn (string) –

          The unique ARN for the membership’s associated collaboration.

        • collaborationId (string) –

          The unique ID for the membership’s collaboration.

        • collaborationCreatorAccountId (string) –

          The identifier of the AWS principal that created the collaboration. Currently only supports AWS account ID.

        • collaborationCreatorDisplayName (string) –

          The display name of the collaboration creator.

        • collaborationName (string) –

          The name for the membership’s collaboration.

        • createTime (datetime) –

          The time when the membership was created.

        • updateTime (datetime) –

          The time the membership metadata was last updated.

        • status (string) –

          The status of the membership. Valid values are ACTIVE, REMOVED, and COLLABORATION_DELETED.

        • memberAbilities (list) –

          The abilities granted to the collaboration member.

          • (string) –

Exceptions

  • CleanRoomsService.Client.exceptions.InternalServerException

  • CleanRoomsService.Client.exceptions.ValidationException

  • CleanRoomsService.Client.exceptions.ThrottlingException

  • CleanRoomsService.Client.exceptions.AccessDeniedException