kinesis_get_records: Gets data records from a Kinesis data stream's shard

View source: R/kinesis_operations.R

kinesis_get_recordsR Documentation

Gets data records from a Kinesis data stream's shard

Description

Gets data records from a Kinesis data stream's shard.

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

Usage

kinesis_get_records(
  ShardIterator,
  Limit = NULL,
  StreamARN = NULL,
  StreamId = NULL,
  DryRun = NULL
)

Arguments

ShardIterator

[required] The position in the shard from which you want to start sequentially reading data records. A shard iterator specifies this position using the sequence number of a data record in the shard.

Limit

The maximum number of records to return. Specify a value of up to 10,000. If you specify a value that is greater than 10,000, get_records throws InvalidArgumentException. The default value is 10,000.

StreamARN

The ARN of the stream.

StreamId

Not Implemented. Reserved for future use.

DryRun

Checks if your request will succeed. DryRun is an optional parameter.


paws.analytics documentation built on Oct. 8, 2026, 1:09 a.m.