ListRooms - Amazon IVS

ListRooms

Gets summary information about all your rooms in the AWS region where the API request is processed. Results are sorted in descending order of updateTime.

Request Syntax

POST /ListRooms HTTP/1.1 Content-type: application/json { "maxResults": number, "messageReviewHandlerUri": "string", "name": "string", "nextToken": "string" }

URI Request Parameters

The request does not use any URI parameters.

Request Body

The request accepts the following data in JSON format.

maxResults

Maximum number of rooms to return. Default: 50.

Type: Integer

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

Required: No

messageReviewHandlerUri

Filters the list to match the specified message review handler URI.

Type: String

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

Pattern: ^$|^arn:aws:lambda:[a-z0-9-]+:[0-9]{12}:function:.+

Required: No

name

Filters the list to match the specified room name.

Type: String

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

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

Required: No

nextToken

The first room to retrieve. This is used for pagination; see the nextToken response field.

Type: String

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

Required: No

Response Syntax

HTTP/1.1 200 Content-type: application/json { "nextToken": "string", "rooms": [ { "arn": "string", "createTime": number, "id": "string", "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.

nextToken

If there are more rooms than maxResults, use nextToken in the request to get the next set.

Type: String

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

rooms

List of the matching rooms (summary information only).

Type: Array of RoomSummary objects

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: