Table Of Contents

Feedback

User Guide

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

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 ]

describe-stream

Description

Gets information about a stream.

See also: AWS API Documentation

See 'aws help' for descriptions of global parameters.

Synopsis

  describe-stream
--stream-id <value>
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]

Options

--stream-id (string)

The stream ID.

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

Examples

To get information about a stream

The following describe-stream example displays the details about the specified stream.

aws iot describe-stream \
    --stream-id stream12345

Output:

{
    "streamInfo": {
        "streamId": "stream12345",
        "streamArn": "arn:aws:iot:us-west-2:123456789012:stream/stream12345",
        "streamVersion": 1,
        "description": "This stream is used for Amazon FreeRTOS OTA Update 12345.",
        "files": [
            {
                "fileId": "123",
                "s3Location": {
                    "bucket":"codesign-ota-bucket",
                    "key":"48c67f3c-63bb-4f92-a98a-4ee0fbc2bef6"
                }
            }
        ],
        "createdAt": 1557863215.995,
        "lastUpdatedAt": 1557863215.995,
        "roleArn": "arn:aws:iam:123456789012:role/service-role/my_ota_stream_role"
    }
}

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

Output

streamInfo -> (structure)

Information about the stream.

streamId -> (string)

The stream ID.

streamArn -> (string)

The stream ARN.

streamVersion -> (integer)

The stream version.

description -> (string)

The description of the stream.

files -> (list)

The files to stream.

(structure)

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.

createdAt -> (timestamp)

The date when the stream was created.

lastUpdatedAt -> (timestamp)

The date when the stream was last updated.

roleArn -> (string)

An IAM role AWS IoT assumes to access your S3 files.