AWS SDK Version 2 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.

.NET Framework 3.5
 
Represents the output for DescribeStream.

Inheritance Hierarchy

System.Object
  Amazon.Kinesis.Model.StreamDescription

Namespace: Amazon.Kinesis.Model
Assembly: AWSSDK.dll
Version: (assembly version)

Syntax

C#
public class StreamDescription : Object

The StreamDescription type exposes the following members

Constructors

NameDescription
Public Method StreamDescription()

Properties

NameTypeDescription
Public Property HasMoreShards System.Boolean Gets and sets the property HasMoreShards.

If set to true, more shards in the stream are available to describe.

Public Property RetentionPeriodHours System.Int32 Gets and sets the property RetentionPeriodHours.

The current retention period, in hours.

Public Property Shards System.Collections.Generic.List<Amazon.Kinesis.Model.Shard> Gets and sets the property Shards.

The shards that comprise the stream.

Public Property StreamARN System.String Gets and sets the property StreamARN.

The Amazon Resource Name (ARN) for the stream being described.

Public Property StreamName System.String Gets and sets the property StreamName.

The name of the stream being described.

Public Property StreamStatus Amazon.Kinesis.StreamStatus Gets and sets the property StreamStatus.

The current status of the stream being described.

The stream status is one of the following states:

  • CREATING - The stream is being created. Amazon Kinesis immediately returns and sets StreamStatus to CREATING.
  • DELETING - The stream is being deleted. The specified stream is in the DELETING state until Amazon Kinesis completes the deletion.
  • ACTIVE - The stream exists and is ready for read and write operations or deletion. You should perform read and write operations only on an ACTIVE stream.
  • UPDATING - Shards in the stream are being merged or split. Read and write operations continue to work while the stream is in the UPDATING state.

Version Information

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

.NET for Windows Store apps:
Supported in: Windows 8.1, Windows 8

.NET for Windows Phone:
Supported in: Windows Phone 8.1, Windows Phone 8