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



Updates an existing stream. The stream version will be incremented by one.

Requires permission to access the UpdateStream action.

See also: AWS API Documentation

See 'aws help' for descriptions of global parameters.


--stream-id <value>
[--description <value>]
[--files <value>]
[--role-arn <value>]
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]


--stream-id (string)

The stream ID.

--description (string)

The description of the stream.

--files (list)

The files associated with the stream.


Represents a file to stream.

fileId -> (integer)

The file ID.

s3Location -> (structure)

The location of the file in S3.

bucket -> (string)

The S3 bucket.

key -> (string)

The S3 key.

version -> (string)

The S3 bucket version.

Shorthand Syntax:

fileId=integer,s3Location={bucket=string,key=string,version=string} ...

JSON Syntax:

    "fileId": integer,
    "s3Location": {
      "bucket": "string",
      "key": "string",
      "version": "string"

--role-arn (string)

An IAM role that allows the IoT service principal assumes to access your S3 files.

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


To update a stream

The following update-stream example updates an existing stream. The stream version is incremented by one.

aws iot update-stream \
    --cli-input-json file://update-stream.json

Contents of update-stream.json:

    "streamId": "stream12345",
    "description": "This stream is used for Amazon FreeRTOS OTA Update 12345.",
    "files": [
            "fileId": 123,
            "s3Location": {
    "roleArn": "arn:aws:iam:us-west-2:123456789012:role/service-role/my_ota_stream_role"


    "streamId": "stream12345",
    "streamArn": "arn:aws:iot:us-west-2:123456789012:stream/stream12345",
    "description": "This stream is used for Amazon FreeRTOS OTA Update 12345.",
    "streamVersion": 2

For more information, see UpdateStream in the AWS IoT API Reference.


streamId -> (string)

The stream ID.

streamArn -> (string)

The stream ARN.

description -> (string)

A description of the stream.

streamVersion -> (integer)

The stream version.