CmdID / aws / aws ivs

aws ivs list-stream-sessions

Gets a summary of current and previous streams for a specified channel in your account, in the AWS region where the API request is processed. AWS CLI reference

1 example 3 options Its page in the AWS CLI reference

Examples

from aws-cli, each command read by CmdID

To get a summary of current and previous streams for a specified channel in the current AWS region

The following list-stream-sessions example reports summary information for streams for a specified channel ARN (Amazon Resource Name).

aws ivs list-stream-sessions --channel-arn arn:aws:ivs:us-west-2:123456789012:channel/abcdABCDefgh --max-results 25 --next-token ""

Identify

--channel-arnChannel ARN used to filter the list.

--max-resultsMaximum number of streams to return.

--next-tokenThe first stream to retrieve.

Its output

{
    "nextToken": "set-2",
    "streamSessions": [
        {
            "startTime": 1641578182,
            "endTime": 1641579982,
            "hasErrorEvent": false,
            "streamId": "mystream"
        }
    ]
}

For more information, see Create a Channel in the IVS Low-Latency User Guide.

Options

3 in the AWS CLI reference

--channel-arnChannel ARN used to filter the list.

--max-resultsMaximum number of streams to return.

--next-tokenThe first stream to retrieve.