Menu
AWS IoT
Developer Guide

DescribeStream

Gets information about a stream.

Request syntax:

GET /streams/streamId

URI Request Parameters:

Name

Type

Req?

Description

streamId

StreamId

yes

The stream ID.

Response syntax:

Content-type: application/json { "streamInfo": { "streamId": "string", "streamArn": "string", "streamVersion": "integer", "description": "string", "files": [ { "fileId": "integer", "s3Location": { "bucket": "string", "key": "string", "version": "string" } } ], "createdAt": "timestamp", "lastUpdatedAt": "timestamp", "roleArn": "string" } }

Response Body Parameters:

Name

Type

Req?

Description

streamInfo

StreamInfo

no

Information about the stream.

Errors:

InvalidRequestException

The contents of the request were invalid. For example, this code is returned when an UpdateJobExecution request contains invalid status details. The message contains details about the error.

HTTP response code: 400

ResourceNotFoundException

The specified resource does not exist.

HTTP response code: 404

ThrottlingException

The rate exceeds the limit.

HTTP response code: 429

UnauthorizedException

You are not authorized to perform this operation.

HTTP response code: 401

ServiceUnavailableException

The service is temporarily unavailable.

HTTP response code: 503

InternalFailureException

An unexpected error has occurred.

HTTP response code: 500

CLI

Synopsis:

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

cli-input-json format:

{ "streamId": "string" }

cli-input-json fields:

Name

Type

Description

streamId

string

length max:128 min:1

pattern: [a-zA-Z0-9_-]+

The stream ID.

Output:

{ "streamInfo": { "streamId": "string", "streamArn": "string", "streamVersion": "integer", "description": "string", "files": [ { "fileId": "integer", "s3Location": { "bucket": "string", "key": "string", "version": "string" } } ], "createdAt": "timestamp", "lastUpdatedAt": "timestamp", "roleArn": "string" } }

cli output fields:

Name

Type

Description

streamInfo

StreamInfo

Information about the stream.

streamId

string

length max:128 min:1

pattern: [a-zA-Z0-9_-]+

The stream ID.

streamArn

string

The stream ARN.

streamVersion

integer

java class: java.lang.Integer

range- max:65535 min:0

The stream version.

description

string

length max:2028

pattern: [^\\p{C}]+

The description of the stream.

files

list

member: StreamFile

The files to stream.

StreamFile

StreamFile

fileId

integer

java class: java.lang.Integer

range- max:255 min:0

The file ID.

s3Location

S3Location

The location of the file in S3.

bucket

string

length min:1

The S3 bucket that contains the file to stream.

key

string

length min:1

The name of the file within the S3 bucket to stream.

version

string

The file version.

createdAt

timestamp

The date when the stream was created.

lastUpdatedAt

timestamp

The date when the stream was last updated.

roleArn

string

length max:2048 min:20

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

On this page: