Copyright | (c) 2013-2023 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | Safe-Inferred |
Language | Haskell2010 |
Synopsis
- data Record = Record' {}
- newRecord :: Text -> ByteString -> Text -> Record
- record_approximateArrivalTimestamp :: Lens' Record (Maybe UTCTime)
- record_encryptionType :: Lens' Record (Maybe EncryptionType)
- record_sequenceNumber :: Lens' Record Text
- record_data :: Lens' Record ByteString
- record_partitionKey :: Lens' Record Text
Documentation
The unit of data of the Kinesis data stream, which is composed of a sequence number, a partition key, and a data blob.
See: newRecord
smart constructor.
Record' | |
|
Instances
:: Text | |
-> ByteString | |
-> Text | |
-> Record |
Create a value of Record
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:approximateArrivalTimestamp:Record'
, record_approximateArrivalTimestamp
- The approximate time that the record was inserted into the stream.
$sel:encryptionType:Record'
, record_encryptionType
- The encryption type used on the record. This parameter can be one of the
following values:
NONE
: Do not encrypt the records in the stream.KMS
: Use server-side encryption on the records in the stream using a customer-managed Amazon Web Services KMS key.
$sel:sequenceNumber:Record'
, record_sequenceNumber
- The unique identifier of the record within its shard.
$sel:data':Record'
, record_data
- The data blob. The data in the blob is both opaque and immutable to
Kinesis Data Streams, which does not inspect, interpret, or change the
data in the blob in any way. 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:Record'
, record_partitionKey
- Identifies which shard in the stream the data record is assigned to.
record_approximateArrivalTimestamp :: Lens' Record (Maybe UTCTime) Source #
The approximate time that the record was inserted into the stream.
record_encryptionType :: Lens' Record (Maybe EncryptionType) Source #
The encryption type used on the record. This parameter can be one of the following values:
NONE
: Do not encrypt the records in the stream.KMS
: Use server-side encryption on the records in the stream using a customer-managed Amazon Web Services KMS key.
record_sequenceNumber :: Lens' Record Text Source #
The unique identifier of the record within its shard.
record_data :: Lens' Record ByteString Source #
The data blob. The data in the blob is both opaque and immutable to
Kinesis Data Streams, which does not inspect, interpret, or change the
data in the blob in any way. 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.