Class: Aws::Kinesis::Types::PutRecordsRequestEntry

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

Overview

Represents the output for PutRecords.

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#data ⇒ String

The data blob to put into the record, which is base64-encoded when the blob is serialized. When the data blob (the payload before base64-encoding) is added to the partition key size, the total size must not exceed the maximum record size (10 MiB).

Returns:

  • (String) 


2446
2447
2448
2449
2450
2451
2452
 
# File 'gems/aws-sdk-kinesis/lib/aws-sdk-kinesis/types.rb', line 2446

class PutRecordsRequestEntry < Struct.new(
  :data,
  :explicit_hash_key,
  :partition_key)
  SENSITIVE = []
  include Aws::Structure
end

#explicit_hash_key ⇒ String

The hash value used to determine explicitly the shard that the data record is assigned to by overriding the partition key hash.

Returns:

  • (String) 


2446
2447
2448
2449
2450
2451
2452
 
# File 'gems/aws-sdk-kinesis/lib/aws-sdk-kinesis/types.rb', line 2446

class PutRecordsRequestEntry < Struct.new(
  :data,
  :explicit_hash_key,
  :partition_key)
  SENSITIVE = []
  include Aws::Structure
end

#partition_key ⇒ String

Determines which shard in the stream the data record is assigned to. Partition keys are Unicode strings with a maximum length limit of 256 characters for each key. Amazon Kinesis Data Streams uses the partition key as input to a hash function that maps the partition key and associated data to a specific shard. Specifically, an MD5 hash function is used to map partition keys to 128-bit integer values and to map associated data records to shards. As a result of this hashing mechanism, all data records with the same partition key map to the same shard within the stream.

If the stream uses the USER_PARTITION_KEY record distribution strategy (the default), a partition key is required for each record. If the stream uses the AUTO record distribution strategy, the partition key is optional and any value you provide is ignored, along with any ExplicitHashKey you provide. In that case, Amazon Kinesis Data Streams distributes records across shards using service-managed algorithms. For more information, see UpdateStreamRecordDistributionStrategy.

Returns:

  • (String) 


2446
2447
2448
2449
2450
2451
2452
 
# File 'gems/aws-sdk-kinesis/lib/aws-sdk-kinesis/types.rb', line 2446

class PutRecordsRequestEntry < Struct.new(
  :data,
  :explicit_hash_key,
  :partition_key)
  SENSITIVE = []
  include Aws::Structure
end