DescribeStream
Written by
Updated at August 15, 2025
Returns information about the data stream.
You can limit the number of shard descriptions per method call using the Limit option.
Request
The request contains JSON-formatted data.
{
"ExclusiveStartShardId": "string",
"Limit": number,
"StreamName": "string"
}
Request options
| Option | Description |
|---|---|
ExclusiveStartShardId |
Shard ID. Stream shard information is returned starting from the shard following the specified one. By default, the output begins with the first shard in the stream. Type: Integer Allowed values: [a-zA-Z0-9_.-]+Required: No |
Limit |
The maximum number of shard descriptions returned per method call. If you specify a value greater than 100, the response will contain 100 shard descriptions.Type: Integer Allowed values: 1-10000.Default value: 100Required: No |
StreamName |
Data stream name. Type: String Size: 1-128 characters.The possible values are: [a-zA-Z][a-zA-Z0-9-]+*(?<!-)$Required: Yes |
Response
Successful requests return HTTP 200 with a JSON-formatted response body.
{
"StreamDescription": {
"EncryptionType": "string",
"EnhancedMonitoring": [{
"ShardLevelMetrics": ["string"]
}],
"HasMoreShards": boolean,
"KeyId": "string",
"RetentionPeriodHours": number,
"Shards": [{
"AdjacentParentShardId": "string",
"HashKeyRange": {
"EndingHashKey": "string",
"StartingHashKey": "string"
},
"ParentShardId": "string",
"SequenceNumberRange": {
"EndingSequenceNumber": "string",
"StartingSequenceNumber": "string"
},
"ShardId": "string"
}],
"StreamCreationTimestamp": number,
"StreamName": "string",
"StreamStatus": "string"
}
}
Response parameters
| Parameter | Description |
|---|---|
StreamDescription |
Stream status. Type: Object StreamDescription |
Errors
| Error | Description | HTTP code |
|---|---|---|
LimitExceededException |
The request limit is exceeded. | 400 |
ResourceNotFoundException |
The requested resource was not found. | 400 |
Errors common to all methods may occur.