AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.
Provides a summarized description of the specified Kinesis data stream without the
shard list.
When invoking this API, you must use either the StreamARN or the StreamName
parameter, or both. It is recommended that you use the StreamARN input parameter
when you invoke this API.
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.
For .NET Core this operation is only available in asynchronous form. Please refer to DescribeStreamSummaryAsync.
Namespace: Amazon.Kinesis
Assembly: AWSSDK.Kinesis.dll
Version: 3.x.y.z
public virtual DescribeStreamSummaryResponse DescribeStreamSummary( DescribeStreamSummaryRequest request )
Container for the necessary parameters to execute the DescribeStreamSummary service method.
| Exception | Condition |
|---|---|
| AccessDeniedException | Specifies that you do not have the permissions required to perform this operation. |
| InvalidArgumentException | A specified parameter exceeds its restrictions, is not supported, or can't be used. For more information, see the returned message. |
| LimitExceededException | The requested resource exceeds the maximum number allowed, or the number of concurrent stream requests exceeds the maximum number allowed. |
| ResourceNotFoundException | The requested resource could not be found. The stream might not be specified correctly. |
.NET Framework:
Supported in: 4.5, 4.0, 3.5