CleanRoomsService / Client / list_members

list_members#

CleanRoomsService.Client.list_members(**kwargs)#

Lists all members within a collaboration.

Request Syntax

response = client.list_members(
    collaborationIdentifier='string',
    nextToken='string',
    maxResults=123
)

Parameters:

collaborationIdentifier (string) –
[REQUIRED]

The identifier of the collaboration in which the members are listed.
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.

Return type:

dict

Returns:

Response Syntax

{
    'nextToken': 'string',
    'memberSummaries': [
        {
            'accountId': 'string',
            'status': 'INVITED'|'ACTIVE'|'LEFT'|'REMOVED',
            'displayName': 'string',
            'abilities': [
                'CAN_QUERY'|'CAN_RECEIVE_RESULTS',
            ],
            'createTime': datetime(2015, 1, 1),
            'updateTime': datetime(2015, 1, 1),
            'membershipId': 'string',
            'membershipArn': 'string'
        },
    ]
}

Response Structure

(dict) –
- nextToken (string) –
  
  The token value retrieved from a previous call to access the next page of results.
- memberSummaries (list) –
  
  The list of members returned by the ListMembers operation.
  - (dict) –
    
    The member object listed by the request.
    - accountId (string) –
      
      The identifier used to reference members of the collaboration. Currently only supports AWS Account ID.
    - status (string) –
      
      The status of the member. Valid values are INVITED, ACTIVE, LEFT, and REMOVED.
    - displayName (string) –
      
      The member’s display name.
    - abilities (list) –
      
      The abilities granted to the collaboration member.
      - (string) –
    - createTime (datetime) –
      
      The time when the member was created.
    - updateTime (datetime) –
      
      The time the member metadata was last updated.
    - membershipId (string) –
      
      The unique ID for the member’s associated membership, if present.
    - membershipArn (string) –
      
      The unique ARN for the member’s associated membership, if present.

Exceptions

CleanRoomsService.Client.exceptions.ResourceNotFoundException
CleanRoomsService.Client.exceptions.InternalServerException
CleanRoomsService.Client.exceptions.ValidationException
CleanRoomsService.Client.exceptions.ThrottlingException
CleanRoomsService.Client.exceptions.AccessDeniedException