AWS IoT
API Reference

The AWS Documentation website is getting a new look!
Try it now and let us know what you think. Switch to the new look >>

You can return to the original look by selecting English in the language selector above.

ListStreams

Lists all of the streams in your AWS account.

Request Syntax

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

URI Request Parameters

The request requires the following URI parameters.

ascendingOrder

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

maxResults

The maximum number of results to return at a time.

Valid Range: Minimum value of 1. Maximum value of 250.

nextToken

A token used to get the next set of results.

Request Body

The request does not have a request body.

Response Syntax

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

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

nextToken

A token used to get the next set of results.

Type: String

streams

A list of streams.

Type: Array of StreamSummary objects

Errors

InternalFailureException

An unexpected error has occurred.

HTTP Status Code: 500

InvalidRequestException

The request is not valid.

HTTP Status Code: 400

ServiceUnavailableException

The service is temporarily unavailable.

HTTP Status Code: 503

ThrottlingException

The rate exceeds the limit.

HTTP Status Code: 429

UnauthorizedException

You are not authorized to perform this operation.

HTTP Status Code: 401

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: