Chime / Client / list_room_memberships

list_room_memberships#

Chime.Client.list_room_memberships(**kwargs)#

Lists the membership details for the specified room in an Amazon Chime Enterprise account, such as the members’ IDs, email addresses, and names.

Request Syntax

response = client.list_room_memberships(
    AccountId='string',
    RoomId='string',
    MaxResults=123,
    NextToken='string'
)

Parameters:

AccountId (string) –
[REQUIRED]

The Amazon Chime account ID.
RoomId (string) –
[REQUIRED]

The room ID.
MaxResults (integer) – The maximum number of results to return in a single call.
NextToken (string) – The token to use to retrieve the next page of results.

Return type:

dict

Returns:

Response Syntax

{
    'RoomMemberships': [
        {
            'RoomId': 'string',
            'Member': {
                'MemberId': 'string',
                'MemberType': 'User'|'Bot'|'Webhook',
                'Email': 'string',
                'FullName': 'string',
                'AccountId': 'string'
            },
            'Role': 'Administrator'|'Member',
            'InvitedBy': 'string',
            'UpdatedTimestamp': datetime(2015, 1, 1)
        },
    ],
    'NextToken': 'string'
}

Response Structure

(dict) –
- RoomMemberships (list) –
  
  The room membership details.
  - (dict) –
    
    The room membership details.
    - RoomId (string) –
      
      The room ID.
    - Member (dict) –
      
      The member details, such as email address, name, member ID, and member type.
      - MemberId (string) –
        
        The member ID (user ID or bot ID).
      - MemberType (string) –
        
        The member type.
      - Email (string) –
        
        The member email address.
      - FullName (string) –
        
        The member name.
      - AccountId (string) –
        
        The Amazon Chime account ID.
    - Role (string) –
      
      The membership role.
    - InvitedBy (string) –
      
      The identifier of the user that invited the room member.
    - UpdatedTimestamp (datetime) –
      
      The room membership update timestamp, in ISO 8601 format.
- NextToken (string) –
  
  The token to use to retrieve the next page of results.

Exceptions

Chime.Client.exceptions.NotFoundException
Chime.Client.exceptions.BadRequestException
Chime.Client.exceptions.ForbiddenException
Chime.Client.exceptions.UnauthorizedClientException
Chime.Client.exceptions.ThrottledClientException
Chime.Client.exceptions.ServiceUnavailableException
Chime.Client.exceptions.ServiceFailureException