kinesis_get_records: Get record from a Kinesis Stream

In AWR.Kinesis: Amazon 'Kinesis' Consumer Application for Stream Processing

Get record from a Kinesis Stream

Description

Get record from a Kinesis Stream

Usage

kinesis_get_records(
  stream,
  region = "us-west-1",
  limit = 25,
  shard_id,
  iterator_type = c("TRIM_HORIZON", "LATEST", "AT_SEQUENCE_NUMBER",
    "AFTER_SEQUENCE_NUMBER", "AT_TIMESTAMP"),
  start_sequence_number,
  start_timestamp
)

Arguments

stream	stream name (string)
region	AWS region (string)
limit	number of records to fetch
shard_id	optional shard id - will pick a random active shard if left empty
iterator_type	shard iterator type
start_sequence_number	for AT_SEQUENCE_NUMBER and AFTER_SEQUENCE_NUMBER iterators
start_timestamp	for AT_TIMESTAMP iterator

Value

character vector that you might want to post-process eg with jsonlite::stream_in

Note

Use this no more than getting sample data from a stream - it's not intended for prod usage.

References

https://docs.aws.amazon.com/AWSJavaSDK/latest/javadoc/com/amazonaws/services/kinesis/model/GetRecordsRequest.html

AWR.Kinesis documentation built on Aug. 19, 2023, 1:07 a.m.