aws ivschat list-rooms

Gets summary information about all your rooms in the AWS region where the API request is processed. AWS CLI reference

1 example 5 options Its page in the AWS CLI reference

Examples

from aws-cli, each command read by CmdID

To get summary information about all your rooms in the current region

The following list-rooms example gets summary information about all the rooms in the AWS region where the request is processed. Results are sorted in descending order of updateTime.

aws ivschat list-rooms --logging-configuration-identifier "arn:aws:ivschat:us-west-2:123456789012:logging-configuration/ABcdef34ghIJ" --max-results 10 --next-token ""

Identify

--logging-configuration-identifierLogging-configuration identifier.

--max-resultsMaximum number of rooms to return.

--next-tokenThe first room to retrieve.

Its output

{
    "nextToken": "page3",
    "rooms": [
        {
            "arn": "arn:aws:ivschat:us-west-2:12345689012:room/g1H2I3j4k5L6",
            "createTime": "2022-03-16T04:44:09+00:00",
            "id": "g1H2I3j4k5L6",
            "loggingConfigurationIdentifiers": ["arn:aws:ivschat:us-west-2:123456789012:logging-configuration/ABcdef34ghIJ"],
            "name": "test-room-1",
            "tags": {},
            "updateTime": "2022-03-16T07:22:09+00:00"
        }
    ]
}

For more information, see Getting Started with Amazon IVS Chat in the Amazon Interactive Video Service User Guide.

Options

5 in the AWS CLI reference

--logging-configuration-identifierLogging-configuration identifier.

--max-resultsMaximum number of rooms to return.

--message-review-handler-uriFilters the list to match the specified message review handler URI.

--nameFilters the list to match the specified room name.

--next-tokenThe first room to retrieve.