ivschat / Client / create_room

create_room

ivschat.Client.create_room(**kwargs)

Creates a room that allows clients to connect and pass messages.

See also: AWS API Documentation

Request Syntax

response = client.create_room(
    name='string',
    maximumMessageRatePerSecond=123,
    maximumMessageLength=123,
    messageReviewHandler={
        'uri': 'string',
        'fallbackResult': 'ALLOW'|'DENY'
    },
    tags={
        'string': 'string'
    },
    loggingConfigurationIdentifiers=[
        'string',
    ]
)

Parameters:

• name (string) – Room name. The value does not need to be unique.

• 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 to attach 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) –

  Array of logging-configuration identifiers attached to the room.

  • (string) –

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, assigned by the system.

  • 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, from the request (if specified).

  • 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), from the request (if specified).

  • maximumMessageLength (integer) –

    Maximum number of characters in a single message, from the request (if specified).

  • 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, from the request (if specified).

    • (string) –

      • (string) –

  • loggingConfigurationIdentifiers (list) –

    Array of logging configurations attached to the room, from the request (if specified).

    • (string) –

Exceptions

• ivschat.Client.exceptions.ConflictException

• ivschat.Client.exceptions.AccessDeniedException

• ivschat.Client.exceptions.ResourceNotFoundException

• ivschat.Client.exceptions.ServiceQuotaExceededException

• ivschat.Client.exceptions.PendingVerification

• ivschat.Client.exceptions.ValidationException