CreateRoom - Amazon IVS

CreateRoom

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

Request Syntax

POST /CreateRoom HTTP/1.1 Content-type: application/json { "loggingConfigurationIdentifiers": [ "string" ], "maximumMessageLength": number, "maximumMessageRatePerSecond": number, "messageReviewHandler": { "fallbackResult": "string", "uri": "string" }, "name": "string", "tags": { "string" : "string" } }

URI Request Parameters

The request does not use any URI parameters.

Request Body

The request accepts the following data in JSON format.

loggingConfigurationIdentifiers

Array of logging-configuration identifiers attached to the room.

Type: Array of strings

Array Members: Minimum number of 0 items. Maximum number of 3 items.

Length Constraints: Minimum length of 1. Maximum length of 128.

Pattern: ^arn:aws:ivschat:[a-z0-9-]+:[0-9]+:logging-configuration/[a-zA-Z0-9-]+$

Required: No

maximumMessageLength

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.

Type: Integer

Valid Range: Minimum value of 1. Maximum value of 500.

Required: No

maximumMessageRatePerSecond

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

Type: Integer

Valid Range: Minimum value of 1. Maximum value of 10.

Required: No

messageReviewHandler

Configuration information for optional review of messages.

Type: MessageReviewHandler object

Required: No

name

Room name. The value does not need to be unique.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 128.

Pattern: ^[a-zA-Z0-9-_]*$

Required: No

tags

Tags to attach to the resource. Array of maps, each of the form string:string (key:value). See Tagging AWS Resources 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.

Type: String to string map

Map Entries: Minimum number of 0 items. Maximum number of 50 items.

Key Length Constraints: Minimum length of 1. Maximum length of 128.

Value Length Constraints: Minimum length of 0. Maximum length of 256.

Required: No

Response Syntax

HTTP/1.1 200 Content-type: application/json { "arn": "string", "createTime": number, "id": "string", "loggingConfigurationIdentifiers": [ "string" ], "maximumMessageLength": number, "maximumMessageRatePerSecond": number, "messageReviewHandler": { "fallbackResult": "string", "uri": "string" }, "name": "string", "tags": { "string" : "string" }, "updateTime": number }

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

arn

Room ARN, assigned by the system.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 128.

Pattern: ^arn:aws:ivschat:[a-z0-9-]+:[0-9]+:room/[a-zA-Z0-9-]+$

createTime

Time when the room was created. This is an ISO 8601 timestamp; note that this is returned as a string.

Type: Timestamp

id

Room ID, generated by the system. This is a relative identifier, the part of the ARN that uniquely identifies the room.

Type: String

Length Constraints: Fixed length of 12.

Pattern: ^[a-zA-Z0-9]+$

loggingConfigurationIdentifiers

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

Type: Array of strings

Array Members: Minimum number of 0 items. Maximum number of 3 items.

Length Constraints: Minimum length of 1. Maximum length of 128.

Pattern: ^arn:aws:ivschat:[a-z0-9-]+:[0-9]+:logging-configuration/[a-zA-Z0-9-]+$

maximumMessageLength

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

Type: Integer

Valid Range: Minimum value of 1. Maximum value of 500.

maximumMessageRatePerSecond

Maximum number of messages per second that can be sent to the room (by all clients), from the request (if specified).

Type: Integer

Valid Range: Minimum value of 1. Maximum value of 10.

messageReviewHandler

Configuration information for optional review of messages.

Type: MessageReviewHandler object

name

Room name, from the request (if specified).

Type: String

Length Constraints: Minimum length of 0. Maximum length of 128.

Pattern: ^[a-zA-Z0-9-_]*$

tags

Tags attached to the resource, from the request (if specified).

Type: String to string map

Map Entries: Minimum number of 0 items. Maximum number of 50 items.

Key Length Constraints: Minimum length of 1. Maximum length of 128.

Value Length Constraints: Minimum length of 0. Maximum length of 256.

updateTime

Time of the room’s last update. This is an ISO 8601 timestamp; note that this is returned as a string.

Type: Timestamp

Errors

For information about the errors that are common to all actions, see Common Errors.

AccessDeniedException

HTTP Status Code: 403

ConflictException

HTTP Status Code: 409

PendingVerification

HTTP Status Code: 403

ResourceNotFoundException

HTTP Status Code: 404

ServiceQuotaExceededException

HTTP Status Code: 402

ValidationException

HTTP Status Code: 400

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: