Amazonka.Kinesis.Types.PutRecordsRequestEntry

Documentation

data PutRecordsRequestEntry

Represents the output for PutRecords.

See: newPutRecordsRequestEntry smart constructor.

Constructors

PutRecordsRequestEntry'

Fields

• explicitHashKey :: Maybe Text

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

• data' :: Base64

  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 (1 MiB).

• partitionKey :: Text

  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.

Instances

ToJSON PutRecordsRequestEntry

Defined in Amazonka.Kinesis.Types.PutRecordsRequestEntry

Methods

toJSON :: PutRecordsRequestEntry -> Value

toEncoding :: PutRecordsRequestEntry -> Encoding

toJSONList :: [PutRecordsRequestEntry] -> Value

toEncodingList :: [PutRecordsRequestEntry] -> Encoding

Generic PutRecordsRequestEntry

Defined in Amazonka.Kinesis.Types.PutRecordsRequestEntry

Associated Types

type Rep PutRecordsRequestEntry :: Type -> Type

Methods

from :: PutRecordsRequestEntry -> Rep PutRecordsRequestEntry x

to :: Rep PutRecordsRequestEntry x -> PutRecordsRequestEntry

Read PutRecordsRequestEntry

Defined in Amazonka.Kinesis.Types.PutRecordsRequestEntry

Methods

readsPrec :: Int -> ReadS PutRecordsRequestEntry

readList :: ReadS [PutRecordsRequestEntry]

readPrec :: ReadPrec PutRecordsRequestEntry

readListPrec :: ReadPrec [PutRecordsRequestEntry]

Show PutRecordsRequestEntry

Defined in Amazonka.Kinesis.Types.PutRecordsRequestEntry

Methods

showsPrec :: Int -> PutRecordsRequestEntry -> ShowS

show :: PutRecordsRequestEntry -> String

showList :: [PutRecordsRequestEntry] -> ShowS

NFData PutRecordsRequestEntry

Defined in Amazonka.Kinesis.Types.PutRecordsRequestEntry

Methods

rnf :: PutRecordsRequestEntry -> ()

Eq PutRecordsRequestEntry

Defined in Amazonka.Kinesis.Types.PutRecordsRequestEntry

Methods

(==) :: PutRecordsRequestEntry -> PutRecordsRequestEntry -> Bool

(/=) :: PutRecordsRequestEntry -> PutRecordsRequestEntry -> Bool

Hashable PutRecordsRequestEntry

Defined in Amazonka.Kinesis.Types.PutRecordsRequestEntry

Methods

hashWithSalt :: Int -> PutRecordsRequestEntry -> Int

hash :: PutRecordsRequestEntry -> Int

type Rep PutRecordsRequestEntry

Defined in Amazonka.Kinesis.Types.PutRecordsRequestEntry

type Rep PutRecordsRequestEntry = D1 ('MetaData "PutRecordsRequestEntry" "Amazonka.Kinesis.Types.PutRecordsRequestEntry" "amazonka-kinesis-2.0-AW1spVPMUGf3LUqQQ22bci" 'False) (C1 ('MetaCons "PutRecordsRequestEntry'" 'PrefixI 'True) (S1 ('MetaSel ('Just "explicitHashKey") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "data'") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Base64) :*: S1 ('MetaSel ('Just "partitionKey") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))

newPutRecordsRequestEntry

Arguments

:: ByteString

$sel:data':PutRecordsRequestEntry'

-> Text

$sel:partitionKey:PutRecordsRequestEntry'

-> PutRecordsRequestEntry

Create a value of PutRecordsRequestEntry with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:explicitHashKey:PutRecordsRequestEntry', putRecordsRequestEntry_explicitHashKey - The hash value used to determine explicitly the shard that the data record is assigned to by overriding the partition key hash.

$sel:data':PutRecordsRequestEntry', putRecordsRequestEntry_data - 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 (1 MiB).-- -- Note: This Lens automatically encodes and decodes Base64 data. -- The underlying isomorphism will encode to Base64 representation during -- serialisation, and decode from Base64 representation during deserialisation. -- This Lens accepts and returns only raw unencoded data.

$sel:partitionKey:PutRecordsRequestEntry', putRecordsRequestEntry_partitionKey - 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.

putRecordsRequestEntry_explicitHashKey :: Lens' PutRecordsRequestEntry (Maybe Text)

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

putRecordsRequestEntry_data :: Lens' PutRecordsRequestEntry ByteString

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 (1 MiB).-- -- Note: This Lens automatically encodes and decodes Base64 data. -- The underlying isomorphism will encode to Base64 representation during -- serialisation, and decode from Base64 representation during deserialisation. -- This Lens accepts and returns only raw unencoded data.

putRecordsRequestEntry_partitionKey :: Lens' PutRecordsRequestEntry Text

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.