Describe Stream
dynamodbstreams_describe_stream | R Documentation |
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¶
Description¶
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.
You can call describe_stream
at a maximum rate of 10 times per second.
Each shard in the stream has a SequenceNumberRange
associated with it.
If the SequenceNumberRange
has a StartingSequenceNumber
but no
EndingSequenceNumber
, then the shard is still open (able to receive
more stream records). If both StartingSequenceNumber
and
EndingSequenceNumber
are present, then that shard is closed and can no
longer receive more data.
Usage¶
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.
Value¶
A list with the following syntax:
list(
StreamDescription = list(
StreamArn = "string",
StreamLabel = "string",
StreamStatus = "ENABLING"|"ENABLED"|"DISABLING"|"DISABLED",
StreamViewType = "NEW_IMAGE"|"OLD_IMAGE"|"NEW_AND_OLD_IMAGES"|"KEYS_ONLY",
CreationRequestDateTime = as.POSIXct(
"2015-01-01"
),
TableName = "string",
KeySchema = list(
list(
AttributeName = "string",
KeyType = "HASH"|"RANGE"
)
),
Shards = list(
list(
ShardId = "string",
SequenceNumberRange = list(
StartingSequenceNumber = "string",
EndingSequenceNumber = "string"
),
ParentShardId = "string"
)
),
LastEvaluatedShardId = "string"
)
)