Table Of Contents

Feedback

User Guide

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

[ aws . kinesisvideo ]

update-stream

Description

Updates stream metadata, such as the device name and media type.

You must provide the stream name or the Amazon Resource Name (ARN) of the stream.

To make sure that you have the latest version of the stream before updating it, you can specify the stream version. Kinesis Video Streams assigns a version to each stream. When you update a stream, Kinesis Video Streams assigns a new version number. To get the latest stream version, use the describe-stream API.

update-stream is an asynchronous operation, and takes time to complete.

See also: AWS API Documentation

See 'aws help' for descriptions of global parameters.

Synopsis

  update-stream
[--stream-name <value>]
[--stream-arn <value>]
--current-version <value>
[--device-name <value>]
[--media-type <value>]
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]

Options

--stream-name (string)

The name of the stream whose metadata you want to update.

The stream name is an identifier for the stream, and must be unique for each account and region.

--stream-arn (string)

The ARN of the stream whose metadata you want to update.

--current-version (string)

The version of the stream whose metadata you want to update.

--device-name (string)

The name of the device that is writing to the stream.

Note

In the current implementation, Kinesis Video Streams does not use this name.

--media-type (string)

The stream's media type. Use media-type to specify the type of content that the stream contains to the consumers of the stream. For more information about media types, see Media Types . If you choose to specify the media-type , see Naming Requirements .

To play video on the console, you must specify the correct video type. For example, if the video in the stream is H.264, specify video/h264 as the media-type .

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