Describe Stream

kinesis_describe_stream

R Documentation

Describes the specified Kinesis data stream

Description

Describes the specified Kinesis data stream.

This API has been revised. It's highly recommended that you use the describe_stream_summary API to get a summarized description of the specified Kinesis data stream and the list_shards API to list the shards in a specified data stream and obtain information about each shard.

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), creation time, enhanced metric configuration, and shard map. The shard map is an array of shard objects. For each shard object, there is the hash key and sequence number ranges that the shard spans, and the IDs of any earlier shards that played in a role in creating the shard. Every record ingested in the stream is identified by a sequence number, which is assigned when the record is put into the stream.

You can limit the number of shards returned by each call. For more information, see Retrieving Shards from a Stream in the Amazon Kinesis Data Streams Developer Guide.

There are no guarantees about the chronological order shards returned. To process shards in chronological order, use the ID of the parent shard to track the lineage to the oldest shard.

This operation has a limit of 10 transactions per second per account.

Usage

kinesis_describe_stream(StreamName, Limit, ExclusiveStartShardId,
  StreamARN)

Arguments

StreamName

The name of the stream to describe.

Limit

The maximum number of shards to return in a single call. The default value is 100. If you specify a value greater than 100, at most 100 results are returned.

ExclusiveStartShardId

The shard ID of the shard to start with.

Specify this parameter to indicate that you want to describe the stream starting with the shard whose ID immediately follows ExclusiveStartShardId.

If you don't specify this parameter, the default behavior for describe_stream is to describe the stream starting with the first shard in the stream.

StreamARN

The ARN of the stream.

Value

A list with the following syntax:

list(
  StreamDescription = list(
    StreamName = "string",
    StreamARN = "string",
    StreamStatus = "CREATING"|"DELETING"|"ACTIVE"|"UPDATING",
    StreamModeDetails = list(
      StreamMode = "PROVISIONED"|"ON_DEMAND"
    ),
    Shards = list(
      list(
        ShardId = "string",
        ParentShardId = "string",
        AdjacentParentShardId = "string",
        HashKeyRange = list(
          StartingHashKey = "string",
          EndingHashKey = "string"
        ),
        SequenceNumberRange = list(
          StartingSequenceNumber = "string",
          EndingSequenceNumber = "string"
        )
      )
    ),
    HasMoreShards = TRUE|FALSE,
    RetentionPeriodHours = 123,
    StreamCreationTimestamp = as.POSIXct(
      "2015-01-01"
    ),
    EnhancedMonitoring = list(
      list(
        ShardLevelMetrics = list(
          "IncomingBytes"|"IncomingRecords"|"OutgoingBytes"|"OutgoingRecords"|"WriteProvisionedThroughputExceeded"|"ReadProvisionedThroughputExceeded"|"IteratorAgeMilliseconds"|"ALL"
        )
      )
    ),
    EncryptionType = "NONE"|"KMS",
    KeyId = "string"
  )
)

Request syntax

svc$describe_stream(
  StreamName = "string",
  Limit = 123,
  ExclusiveStartShardId = "string",
  StreamARN = "string"
)