Container for the parameters to the DescribeStreamSummary operation.
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.
Inheritance Hierarchy
Amazon.Runtime.AmazonWebServiceRequest
Amazon.Kinesis.AmazonKinesisRequest
Amazon.Kinesis.Model.DescribeStreamSummaryRequest
Namespace: Amazon.Kinesis.Model
Assembly: AWSSDK.Kinesis.dll
Version: 3.x.y.z
Syntax
public class DescribeStreamSummaryRequest : AmazonKinesisRequest IAmazonWebServiceRequest
The DescribeStreamSummaryRequest type exposes the following members
Constructors
| Name | Description | |
|---|---|---|
|
DescribeStreamSummaryRequest() |
Properties
| Name | Type | Description | |
|---|---|---|---|
|
|
StreamARN | System.String |
Gets and sets the property StreamARN. The ARN of the stream. |
|
|
StreamName | System.String |
Gets and sets the property StreamName. The name of the stream to describe. |
Version Information
.NET Core App:
Supported in: 3.1
.NET Standard:
Supported in: 2.0
.NET Framework:
Supported in: 4.5, 4.0, 3.5