Skip to content

Get Shard Iterator

dynamodbstreams_get_shard_iterator R Documentation

Returns a shard iterator

Description

Returns a shard iterator. A shard iterator provides information about how to retrieve the stream records from within a shard. Use the shard iterator in a subsequent get_records request to read the stream records from the shard.

A shard iterator expires 15 minutes after it is returned to the requester.

Usage

dynamodbstreams_get_shard_iterator(StreamArn, ShardId,
  ShardIteratorType, SequenceNumber)

Arguments

StreamArn

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

ShardId

[required] The identifier of the shard. The iterator will be returned for this shard ID.

ShardIteratorType

[required] Determines how the shard iterator is used to start reading stream records from the shard:

  • AT_SEQUENCE_NUMBER - Start reading exactly from the position denoted by a specific sequence number.

  • AFTER_SEQUENCE_NUMBER - Start reading right after the position denoted by a specific sequence number.

  • TRIM_HORIZON - Start reading at the last (untrimmed) stream record, which is the oldest record in the shard. In DynamoDB Streams, there is a 24 hour limit on data retention. Stream records whose age exceeds this limit are subject to removal (trimming) from the stream.

  • LATEST - Start reading just after the most recent stream record in the shard, so that you always read the most recent data in the shard.

SequenceNumber

The sequence number of a stream record in the shard from which to start reading.

Value

A list with the following syntax: 

list(
  ShardIterator = "string"
)

Request syntax

svc$get_shard_iterator(
  StreamArn = "string",
  ShardId = "string",
  ShardIteratorType = "TRIM_HORIZON"|"LATEST"|"AT_SEQUENCE_NUMBER"|"AFTER_SEQUENCE_NUMBER",
  SequenceNumber = "string"
)

Examples

## Not run: 
# The following example returns a shard iterator for the provided stream
# ARN and shard ID.
svc$get_shard_iterator(
  ShardId = "00000001414576573621-f55eea83",
  ShardIteratorType = "TRIM_HORIZON",
  StreamArn = "arn:aws:dynamodb:us-west-2:111122223333:table/Forum/stream/2..."
)

## End(Not run)