Chime / Client / list_rooms

list_rooms#

Chime.Client.list_rooms(**kwargs)#

Lists the room details for the specified Amazon Chime Enterprise account. Optionally, filter the results by a member ID (user ID or bot ID) to see a list of rooms that the member belongs to.

Request Syntax

response = client.list_rooms(
    AccountId='string',
    MemberId='string',
    MaxResults=123,
    NextToken='string'
)

Parameters:

AccountId (string) –
[REQUIRED]

The Amazon Chime account ID.
MemberId (string) – The member ID (user ID or bot 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

{
    'Rooms': [
        {
            'RoomId': 'string',
            'Name': 'string',
            'AccountId': 'string',
            'CreatedBy': 'string',
            'CreatedTimestamp': datetime(2015, 1, 1),
            'UpdatedTimestamp': datetime(2015, 1, 1)
        },
    ],
    'NextToken': 'string'
}

Response Structure

(dict) –
- Rooms (list) –
  
  The room details.
  - (dict) –
    
    The Amazon Chime chat room details.
    - RoomId (string) –
      
      The room ID.
    - Name (string) –
      
      The room name.
    - AccountId (string) –
      
      The Amazon Chime account ID.
    - CreatedBy (string) –
      
      The identifier of the room creator.
    - CreatedTimestamp (datetime) –
      
      The room creation timestamp, in ISO 8601 format.
    - UpdatedTimestamp (datetime) –
      
      The room 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