[ aws . kinesisvideo ]

describe-stream

Description

Returns the most current information about the specified stream. You must specify either the StreamName or the StreamARN .

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

  describe-stream
[--stream-name <value>]
[--stream-arn <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]

Options

--stream-name (string)

The name of the stream.

--stream-arn (string)

The Amazon Resource Name (ARN) of the stream.

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

Output

StreamInfo -> (structure)

An object that describes the 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 Key Management Service (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.