Skip to contents

Describes the specified Kinesis data stream

Source: R/kinesis_operations.R
kinesis_describe_stream.Rd

Describes the specified Kinesis data stream.

See https://www.paws-r-sdk.com/docs/kinesis_describe_stream/ for full documentation.

Usage

kinesis_describe_stream(
  StreamName = NULL,
  Limit = NULL,
  ExclusiveStartShardId = NULL,
  StreamARN = NULL,
  StreamId = NULL
)

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.

StreamId

Not Implemented. Reserved for future use.