ListStreams
Written by
Updated at February 10, 2023
Outputs a list of streams.
The HasMoreStreams response parameter indicates that there are more streams to output. To request them, specify the name of the stream returned last as the ExclusiveStartStreamName value in the next request.
Request
The request contains data in JSON format.
{
"ExclusiveStartStreamName": "string",
"Limit": number
}
Request parameters
| Parameter | Description |
|---|---|
ExclusiveStartStreamName |
The name of the stream to start the output from. Type: String Size: 1-128 characters.Possible values: [a-zA-Z0-9_.-]+Required: No |
Limit |
The maximum number of streams in the list. If you specify a value greater than 100, no more than 100 streams will be output.Type: Integer Possible values: 1-10000.Default value: 100Required: No |
Response
If successful, HTTP code 200 and data in JSON format are returned.
{
"HasMoreStreams": boolean,
"StreamNames": ["string"]
}
Response parameters
| Parameter | Description |
|---|---|
HasMoreStreams |
If true, the list contains more streams to output.Type: Boolean |
StreamNames |
The name of a stream. Type: String Size: 1-128 characters.Possible values: [a-zA-Z][a-zA-Z0-9-]+*(?<!-)$ |
Errors
| Parameter | Description |
|---|---|
LimitExceededException |
The request limit is exceeded. |
Errors that are common to all methods may occur.