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

Instance Attribute Details

#limitInteger

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)


388
389
390
391
392
# File 'gems/aws-sdk-kinesis/lib/aws-sdk-kinesis/types.rb', line 388

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

#shard_iteratorString

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.

Returns:

  • (String)


388
389
390
391
392
# File 'gems/aws-sdk-kinesis/lib/aws-sdk-kinesis/types.rb', line 388

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