AWS SDK Version 3 for .NET
API Reference

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.

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.

Note:

For .NET Core, PCL and Unity this operation is only available in asynchronous form. Please refer to DescribeStreamSummaryAsync.

Namespace: Amazon.Kinesis
Assembly: AWSSDK.Kinesis.dll
Version: 3.x.y.z

Syntax

C#
public virtual DescribeStreamSummaryResponse DescribeStreamSummary(
         DescribeStreamSummaryRequest request
)
Parameters
request
Type: Amazon.Kinesis.Model.DescribeStreamSummaryRequest

Container for the necessary parameters to execute the DescribeStreamSummary service method.

Return Value
The response from the DescribeStreamSummary service method, as returned by Kinesis.

Exceptions

ExceptionCondition
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.

Version Information

.NET Framework:
Supported in: 4.5, 4.0, 3.5

Portable Class Library:
Supported in: Windows Store Apps
Supported in: Windows Phone 8.1
Supported in: Xamarin Android
Supported in: Xamarin iOS (Unified)
Supported in: Xamarin.Forms

Unity:
Supported Versions: 4.6 and above
Supported Platforms: Android, iOS, Standalone

See Also