Describe Stream Summary

kinesis_describe_stream_summary

R Documentation

Provides a summarized description of the specified Kinesis data stream without the shard list

Description

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.

describe_stream_summary has a limit of 20 transactions per second per account.

Usage

kinesis_describe_stream_summary(StreamName, StreamARN)

Arguments

StreamName

The name of the stream to describe.

StreamARN

The ARN of the stream.

Value

A list with the following syntax:

list(
  StreamDescriptionSummary = list(
    StreamName = "string",
    StreamARN = "string",
    StreamStatus = "CREATING"|"DELETING"|"ACTIVE"|"UPDATING",
    StreamModeDetails = list(
      StreamMode = "PROVISIONED"|"ON_DEMAND"
    ),
    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",
    OpenShardCount = 123,
    ConsumerCount = 123
  )
)

Request syntax

svc$describe_stream_summary(
  StreamName = "string",
  StreamARN = "string"
)