Skip to contents

Returns information about a stream, including the current status of the stream, its Amazon Resource Name (ARN), the composition of its shards, and its corresponding DynamoDB table

Source: R/dynamodbstreams_operations.R
dynamodbstreams_describe_stream.Rd

Returns information about a stream, including the current status of the stream, its Amazon Resource Name (ARN), the composition of its shards, and its corresponding DynamoDB table.

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

Usage

dynamodbstreams_describe_stream(
  StreamArn,
  Limit = NULL,
  ExclusiveStartShardId = NULL,
  ShardFilter = NULL
)

Arguments

StreamArn

[required] The Amazon Resource Name (ARN) for the stream.

Limit

The maximum number of shard objects to return. The upper limit is 100.

ExclusiveStartShardId

The shard ID of the first item that this operation will evaluate. Use the value that was returned for LastEvaluatedShardId in the previous operation.

ShardFilter

This optional field contains the filter definition for the describe_stream API.