DescribeStream
Written by
Updated at February 10, 2023
Returns information about a stream.
You can limit the number of shard descriptions returned by each method call using the Limit parameter.
Request
The request contains data in JSON format.
{
"ExclusiveStartShardId": "string",
"Limit": number,
"StreamName": "string"
}
Request parameters
| Parameter | Description |
|---|---|
ExclusiveStartShardId |
Shard ID. Information about stream shards is output starting from the shard following the specified one. By default, information is output starting from the first shard in the stream. Type: Integer Possible 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 number of descriptions returned won't exceed 100.Type: Integer Possible values: 1-10000.Default value: 100Required: No |
StreamName |
The name of the stream. Type: String Size: 1-128 characters.Possible values: [a-zA-Z][a-zA-Z0-9-]+*(?<!-)$Required: Yes |
Response
If successful, HTTP code 200 and data in JSON format are returned.
{
"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 |
The status of a stream. Type: The StreamDescription object |
Errors
| Parameter | Description | HTTP code |
|---|---|---|
LimitExceededException |
The request limit is exceeded. | 400 |
ResourceNotFoundException |
The requested resource was not found. | 400 |
Errors that are common to all methods may occur.