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

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

Inherits:

Struct

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

show all

Defined in:: gems/aws-sdk-kinesis/lib/aws-sdk-kinesis/types.rb

Overview

Note:

When making an API call, you may pass GetRecordsInput data as a 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.

Returns:

(Integer)

# File 'gems/aws-sdk-kinesis/lib/aws-sdk-kinesis/types.rb', line 417

class GetRecordsInput < Struct.new(
  :shard_iterator,
  :limit)
  include Aws::Structure
end

#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.