CreateStream
Written by
Updated at August 15, 2025
Creates a data stream.
On success, this method initiates stream creation, sets the stream status to CREATING, and returns an HTTP 200 response. Read and write operations are only permitted for streams with the ACTIVE status. To check the stream status, use the DescribeStream method.
If you attempt to create more streams than your account quota allows, the request will return LimitExceededException.
Request
The request contains JSON-formatted data.
{
"StreamName": "string",
"ShardCount": number,
"WriteQuotaKbPerSec": number,
"RetentionPeriodHours": number
}
Request options
| Option | Description |
|---|---|
StreamName |
Data stream name. Type: String Size: 1-128 characters.The possible values are: [a-zA-Z][a-zA-Z0-9-]+*(?<!-)$Required: Yes |
ShardCount |
Number of stream shards. Type: Integer Minimum value: 1.Required: Yes |
WriteQuotaKbPerSec |
Stream write throughput limit, KB/s. Type: Integer Allowed values: 128, 512, 1024.Required: No |
RetentionPeriodHours |
Record retention period, hours. Type: Integer Allowed values: 4, 12, 24.Required: No |
Response
Successful responses include an HTTP 200 code and an empty response body.
Errors
| Error type | Description | HTTP code |
|---|---|---|
InvalidArgumentException |
The argument is invalid. See the error message for details. | 400 |
LimitExceededException |
The request limit is exceeded. | 400 |
ResourceInUseException |
The resource is currently locked by another operation. | 400 |
Errors common to all methods may occur.