ListStreams
Written by
Updated at August 15, 2025
Returns a list of streams.
The HasMoreStreams response parameter indicates there are more streams to retrieve. To fetch remaining streams, use the last returned stream name as the ExclusiveStartStreamName parameter in your subsequent request.
Request
The request contains JSON-formatted data.
{
"ExclusiveStartStreamName": "string",
"Limit": number
}
Request options
| Option | Description |
|---|---|
ExclusiveStartStreamName |
The name of the stream where output should begin Type: String Size: 1-128 characters.The possible values are: [a-zA-Z0-9_.-]+Required: No |
Limit |
The maximum number of streams in the list. If you specify a value greater than 100, the response will contain 100 streams.Type: Integer Allowed values: 1-10000.Default value: 100Required: No |
Response
Successful requests return HTTP 200 with a JSON-formatted response body.
{
"HasMoreStreams": boolean,
"StreamNames": ["string"]
}
Response parameters
| Parameter | Description |
|---|---|
HasMoreStreams |
If true, the list contains more streams to retrieve.Type: Boolean |
StreamNames |
Data stream name. Type: String Size: 1-128 characters.The possible values are: [a-zA-Z][a-zA-Z0-9-]+*(?<!-)$ |
Errors
| Error | Description |
|---|---|
LimitExceededException |
The request limit is exceeded. |
Errors common to all methods may occur.