v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-14179784.8 KB

Updates a room’s configuration.

post/UpdateRoom

Request body

identifierstring required

Identifier of the room to be updated. Currently this must be an ARN.

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

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

loggingConfigurationIdentifiersLoggingConfigurationIdentifier[]

Array of logging-configuration identifiers attached to the room.

Response

Success

arnstring

Room ARN, from the request (if <code>identifier</code> was an ARN).

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. Array of maps, each of the form <code>string:string (key:value)</code>.

loggingConfigurationIdentifiersLoggingConfigurationIdentifier[]

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