DescribeStreamSummary
Provides a summarized description of the specified Kinesis data stream without the shard list.
The information returned includes the stream name, Amazon Resource Name (ARN), status, record retention period, approximate creation time, monitoring, encryption details, and open shard count.
DescribeStreamSummary has a limit of 20 transactions per second per account.
Request Syntax
{
"StreamName": "string"
}Request Parameters
The request accepts the following data in JSON format.
- StreamName
-
The name of the stream to describe.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 128.
Pattern:
[a-zA-Z0-9_.-]+Required: Yes
Response Syntax
{
"StreamDescriptionSummary": {
"ConsumerCount": number,
"EncryptionType": "string",
"EnhancedMonitoring": [
{
"ShardLevelMetrics": [ "string" ]
}
],
"KeyId": "string",
"OpenShardCount": number,
"RetentionPeriodHours": number,
"StreamARN": "string",
"StreamCreationTimestamp": number,
"StreamModeDetails": {
"StreamMode": "string"
},
"StreamName": "string",
"StreamStatus": "string"
}
}Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
- StreamDescriptionSummary
-
A StreamDescriptionSummary containing information about the stream.
Type: StreamDescriptionSummary object
Errors
For information about the errors that are common to all actions, see Common Errors.
- LimitExceededException
-
The requested resource exceeds the maximum number allowed, or the number of concurrent stream requests exceeds the maximum number allowed.
HTTP Status Code: 400
- ResourceNotFoundException
-
The requested resource could not be found. The stream might not be specified correctly.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific Amazon SDKs, see the following: