botor (version 0.4.0)

kinesis_get_shard_iterator: Gets an Amazon Kinesis shard iterator

Description

Gets an Amazon Kinesis shard iterator

Usage

kinesis_get_shard_iterator(
  stream,
  shard,
  shard_iterator_type = c("TRIM_HORIZON", "LATEST", "AT_SEQUENCE_NUMBER",
    "AFTER_SEQUENCE_NUMBER", "AT_TIMESTAMP"),
  ...
)

Value

list of ShardIterator

Arguments

stream

the name of the stream to describe

shard

the shard ID of the Kinesis Data Streams shard to get the iterator for

shard_iterator_type

determines how the shard iterator is used to start reading data records from the shard

...

optional further parameters, such as StartingSequenceNumber or Timestamp

References

https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/kinesis.html#Kinesis.Client.get_shard_iterator

See Also

kinesis_get_records