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

Inherits:

Struct

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

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.

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #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)

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

class GetRecordsInput < Struct.new(
  :shard_iterator,
  :limit)
  SENSITIVE = []
  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.

Returns:

• (String)

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

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