You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

Class: Aws::Kinesis::Types::GetRecordsInput

Inherits:

Struct

Object
Struct
Aws::Kinesis::Types::GetRecordsInput

show all

Defined in:: (unknown)

Overview

Note:

When passing GetRecordsInput as input to an Aws::Client method, you can use a vanilla Hash:

{
  shard_iterator: "ShardIterator", # required
  limit: 1,
}

Represents the input for GetRecords.

Instance Attribute Summary collapse

#limit ⇒ Integer
The maximum number of records to return.
#shard_iterator ⇒ String
The position in the shard from which you want to start sequentially reading data records.

Instance Attribute Details

#limit ⇒ `Integer`

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, GetRecords throws InvalidArgumentException. The default value is 10,000.

Returns:

(Integer) —
The maximum number of records to return.

#shard_iterator ⇒ `String`

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.