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

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-kinesis/lib/aws-sdk-kinesis/types.rb

Overview

Represents the input for GetRecords.

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

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) 


763
764
765
766
767
768
769
770
 
# File 'gems/aws-sdk-kinesis/lib/aws-sdk-kinesis/types.rb', line 763

class GetRecordsInput < Struct.new(
  :shard_iterator,
  :limit,
  :stream_arn,
  :stream_id)
  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) 


763
764
765
766
767
768
769
770
 
# File 'gems/aws-sdk-kinesis/lib/aws-sdk-kinesis/types.rb', line 763

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

#stream_arn ⇒ String

The ARN of the stream.

Returns:

  • (String) 


763
764
765
766
767
768
769
770
 
# File 'gems/aws-sdk-kinesis/lib/aws-sdk-kinesis/types.rb', line 763

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

#stream_id ⇒ String

Not Implemented. Reserved for future use.

Returns:

  • (String) 


763
764
765
766
767
768
769
770
 
# File 'gems/aws-sdk-kinesis/lib/aws-sdk-kinesis/types.rb', line 763

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