ivschat / Client / list_rooms

list_rooms#

ivschat.Client.list_rooms(**kwargs)#

Gets summary information about all your rooms in the AWS region where the API request is processed. Results are sorted in descending order of updateTime.

Request Syntax

response = client.list_rooms(
    name='string',
    nextToken='string',
    maxResults=123,
    messageReviewHandlerUri='string',
    loggingConfigurationIdentifier='string'
)

Parameters:

name (string) – Filters the list to match the specified room name.
nextToken (string) – The first room to retrieve. This is used for pagination; see the nextToken response field.
maxResults (integer) – Maximum number of rooms to return. Default: 50.
messageReviewHandlerUri (string) – Filters the list to match the specified message review handler URI.
loggingConfigurationIdentifier (string) – Logging-configuration identifier.

Return type:

dict

Returns:

Response Syntax

{
    'rooms': [
        {
            'arn': 'string',
            'id': 'string',
            'name': 'string',
            'messageReviewHandler': {
                'uri': 'string',
                'fallbackResult': 'ALLOW'|'DENY'
            },
            'createTime': datetime(2015, 1, 1),
            'updateTime': datetime(2015, 1, 1),
            'tags': {
                'string': 'string'
            },
            'loggingConfigurationIdentifiers': [
                'string',
            ]
        },
    ],
    'nextToken': 'string'
}

Response Structure

(dict) –
- rooms (list) –
  
  List of the matching rooms (summary information only).
  - (dict) –
    
    Summary information about a room.
    - arn (string) –
      
      Room ARN.
    - id (string) –
      
      Room ID, generated by the system. This is a relative identifier, the part of the ARN that uniquely identifies the room.
    - name (string) –
      
      Room name. The value does not need to be unique.
    - messageReviewHandler (dict) –
      
      Configuration information for optional review of messages.
      - uri (string) –
        
        Identifier of the message review handler. Currently this must be an ARN of a lambda function.
      - fallbackResult (string) –
        
        Specifies the fallback behavior (whether the message is allowed or denied) if the handler does not return a valid response, encounters an error, or times out. (For the timeout period, see Service Quotas.) If allowed, the message is delivered with returned content to all users connected to the room. If denied, the message is not delivered to any user. Default: ALLOW.
    - createTime (datetime) –
      
      Time when the room was created. This is an ISO 8601 timestamp; note that this is returned as a string.
    - updateTime (datetime) –
      
      Time of the room’s last update. This is an ISO 8601 timestamp; note that this is returned as a string.
    - tags (dict) –
      
      Tags attached to the resource. Array of maps, each of the form string:string (key:value). See Best practices and strategies in Tagging Amazon Web Services Resources and Tag Editor for details, including restrictions that apply to tags and “Tag naming limits and requirements”; Amazon IVS Chat has no constraints beyond what is documented there.
      - (string) –
        
        (string) –
    - loggingConfigurationIdentifiers (list) –
      
      List of logging-configuration identifiers attached to the room.
      - (string) –
- nextToken (string) –
  
  If there are more rooms than maxResults, use nextToken in the request to get the next set.

Exceptions

ivschat.Client.exceptions.AccessDeniedException
ivschat.Client.exceptions.ResourceNotFoundException
ivschat.Client.exceptions.ValidationException