list-stream-sessions¶

Description¶

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.

Synopsis¶

  list-stream-sessions
--channel-arn <value>
[--max-results <value>]
[--next-token <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]

Options¶

--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 | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those 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. This may not be specified along with --cli-input-yaml.

--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. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. 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.

Examples¶

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 \
    --channelArn arn:aws:ivs:us-west-2:123456789012:channel/abcdABCDefgh \
    --maxResults 25 \
    --nextToken ""

Output:

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

For more information, see Create a Channel in the Amazon Interactive Video Service User Guide.

Output¶

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.

(structure)

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.

Table of Contents

Feedback

User Guide