GetRoom - Amazon IVS

GetRoom

Gets the specified room.

Request Syntax

POST /GetRoom HTTP/1.1 Content-type: application/json { "identifier": "string" }

URI Request Parameters

The request does not use any URI parameters.

Request Body

The request accepts the following data in JSON format.

identifier

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

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-]+$

Required: Yes

Response Syntax

HTTP/1.1 200 Content-type: application/json { "arn": "string", "createTime": number, "id": "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, from the request (if identifier was an ARN).

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]+$

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.

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.

messageReviewHandler

Configuration information for optional review of messages.

Type: MessageReviewHandler object

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-_]*$

tags

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

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

ResourceNotFoundException

HTTP Status Code: 404

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: