Table Of Contents


User Guide

First time using the AWS CLI? See the User Guide for help getting started.

Note: You are viewing the documentation for an older major version of the AWS CLI (version 1).

AWS CLI version 2, the latest major version of AWS CLI, is now stable and recommended for general use. To view this page for the AWS CLI version 2, click here. For more information see the AWS CLI version 2 installation instructions and migration guide.

[ aws . ivs ]



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.

See also: AWS API Documentation

See 'aws help' for descriptions of global parameters.


--channel-arn <value>
[--max-results <value>]
[--next-token <value>]
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]


--channel-arn (string)

Channel ARN used to filter the list.

--max-results (integer)

Maximum number of streams to return. Default: 50.

--next-token (string)

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

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

See 'aws help' for descriptions of global parameters.


nextToken -> (string)

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

streamSessions -> (list)

List of stream sessions.


Summary information about a stream session.

endTime -> (timestamp)

UTC ISO-8601 formatted timestamp of when the channel went offline. For live streams, this is NULL .

hasErrorEvent -> (boolean)

If true , this stream encountered a quota breach or failure.

startTime -> (timestamp)

UTC ISO-8601 formatted timestamp of when the channel went live.

streamId -> (string)

Unique identifier for a live or previously live stream in the specified channel.