Menu
AWS IoT
Developer Guide

ListStreams

Lists all of the streams in your AWS account.

Request syntax:

GET /streams?maxResults=maxResults&nextToken=nextToken&isAscendingOrder=ascendingOrder

URI Request Parameters:

Name

Type

Req?

Description

maxResults

MaxResults

no

The maximum number of results to return at a time.

nextToken

NextToken

no

A token used to get the next set of results.

ascendingOrder

AscendingOrder

no

Set to true to return the list of streams in ascending order.

Response syntax:

Content-type: application/json { "streams": [ { "streamId": "string", "streamArn": "string", "streamVersion": "integer", "description": "string" } ], "nextToken": "string" }

Response Body Parameters:

Name

Type

Req?

Description

streams

StreamsSummary

no

A list of streams.

nextToken

NextToken

no

A token used to get the next set of results.

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

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 list-streams \ [--max-results <value>] \ [--next-token <value>] \ [--ascending-order | --no-ascending-order] \ [--cli-input-json <value>] \ [--generate-cli-skeleton]

cli-input-json format:

{ "maxResults": "integer", "nextToken": "string", "ascendingOrder": "boolean" }

cli-input-json fields:

Name

Type

Description

maxResults

integer

java class: java.lang.Integer

range- max:250 min:1

The maximum number of results to return at a time.

nextToken

string

A token used to get the next set of results.

ascendingOrder

boolean

Set to true to return the list of streams in ascending order.

Output:

{ "streams": [ { "streamId": "string", "streamArn": "string", "streamVersion": "integer", "description": "string" } ], "nextToken": "string" }

cli output fields:

Name

Type

Description

streams

list

member: StreamSummary

A list of streams.

StreamSummary

StreamSummary

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}]+

A description of the stream.

nextToken

string

A token used to get the next set of results.

On this page: