Table Of Contents

Feedback

User Guide

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

[ aws . kinesisvideo ]

list-streams

Description

Returns an array of StreamInfo objects. Each object describes a stream. To retrieve only streams that satisfy a specific condition, you can specify a stream-name-condition .

See also: AWS API Documentation

See 'aws help' for descriptions of global parameters.

Synopsis

  list-streams
[--max-results <value>]
[--next-token <value>]
[--stream-name-condition <value>]
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]

Options

--max-results (integer)

The maximum number of streams to return in the response. The default is 10,000.

--next-token (string)

If you specify this parameter, when the result of a list-streams operation is truncated, the call returns the next-token in the response. To get another batch of streams, provide this token in your next request.

--stream-name-condition (structure)

Optional: Returns only streams that satisfy a specific condition. Currently, you can specify only the prefix of a stream name as a condition.

Shorthand Syntax:

ComparisonOperator=string,ComparisonValue=string

JSON Syntax:

{
  "ComparisonOperator": "BEGINS_WITH",
  "ComparisonValue": "string"
}

--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.

--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.

Output

StreamInfoList -> (list)

An array of StreamInfo objects.

(structure)

An object describing a Kinesis video stream.

DeviceName -> (string)

The name of the device that is associated with the stream.

StreamName -> (string)

The name of the stream.

StreamARN -> (string)

The Amazon Resource Name (ARN) of the stream.

MediaType -> (string)

The MediaType of the stream.

KmsKeyId -> (string)

The ID of the AWS Key Management Service (AWS KMS) key that Kinesis Video Streams uses to encrypt data on the stream.

Version -> (string)

The version of the stream.

Status -> (string)

The status of the stream.

CreationTime -> (timestamp)

A time stamp that indicates when the stream was created.

DataRetentionInHours -> (integer)

How long the stream retains data, in hours.

NextToken -> (string)

If the response is truncated, the call returns this element with a token. To get the next batch of streams, use this token in your next request.