ivschat / Client / get_room

get_room

ivschat.Client.get_room(**kwargs)

Gets the specified room.

See also: AWS API Documentation

Request Syntax

response = client.get_room(
    identifier='string'
)

Parameters:

identifier (string) –

[REQUIRED]

Identifier of the room for which the configuration is to be retrieved. Currently this must be an ARN.

Return type:

dict

Returns:

Response Syntax

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

Response Structure

• (dict) –

  • arn (string) –

    Room ARN, from the request (if identifier was an 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.

  • 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.

  • maximumMessageRatePerSecond (integer) –

    Maximum number of messages per second that can be sent to the room (by all clients). Default: 10.

  • maximumMessageLength (integer) –

    Maximum number of characters in a single message. Messages are expected to be UTF-8 encoded and this limit applies specifically to rune/code-point count, not number of bytes. Default: 500.

  • 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.

  • tags (dict) –

    Tags attached to the resource. Array of maps, each of the form string:string (key:value).

    • (string) –

      • (string) –

  • loggingConfigurationIdentifiers (list) –

    Array of logging configurations attached to the room.

    • (string) –

Exceptions

• ivschat.Client.exceptions.AccessDeniedException

• ivschat.Client.exceptions.ResourceNotFoundException

• ivschat.Client.exceptions.ValidationException