v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-14179784.8 KB

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

post/CreateRoom

Request body

namestring

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

maximumMessageRatePerSecondinteger

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

maximumMessageLengthinteger

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.

tagsobject

Tags to attach to the resource. Array of maps, each of the form <code>string:string (key:value)</code>. See <a href="https://docs.aws.amazon.com/tag-editor/latest/userguide/best-practices-and-strats.html">Best practices and strategies</a> in <i>Tagging Amazon Web Services Resources and Tag Editor</i> 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.

loggingConfigurationIdentifiersLoggingConfigurationIdentifier[]

Array of logging-configuration identifiers attached to the room.

Response

Success

arnstring

Room ARN, assigned by the system.

idstring

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

namestring

Room name, from the request (if specified).

createTimestring date-time

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

updateTimestring date-time

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

maximumMessageRatePerSecondinteger

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

maximumMessageLengthinteger

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

tagsobject

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

loggingConfigurationIdentifiersLoggingConfigurationIdentifier[]

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