Skip to content

Record

Source code in docs_src/capo_kinesis/types/record.py
class Record(TypedDict, closed=True):
    sequence_number: "capo_kinesis.types.sequence_number.SequenceNumber"
    """<p>The unique identifier of the record within its shard.</p>"""
    approximate_arrival_timestamp: NotRequired["capo_kinesis.types.timestamp.Timestamp"]
    """<p>The approximate time that the record was inserted into the stream.</p>"""
    data: "capo_kinesis.types.data.Data"
    """<p>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 (10 MiB).</p>"""
    partition_key: NotRequired["capo_kinesis.types.partition_key.PartitionKey"]
    """<p>Identifies which shard in the stream the data record is assigned to.</p> <p>For a stream that uses the <code>AUTO</code> record distribution strategy, this value is not returned if the producer did not provide a partition key when writing the record. If the producer provided a partition key, the original value is returned even though it was not used to determine shard placement.</p>"""
    encryption_type: NotRequired["capo_kinesis.types.encryption_type.EncryptionType"]
    """<p>The encryption type used on the record. This parameter can be one of the following values:</p> <ul> <li> <p> <code>NONE</code>: Do not encrypt the records in the stream.</p> </li> <li> <p> <code>KMS</code>: Use server-side encryption on the records in the stream using a customer-managed Amazon Web Services KMS key.</p> </li> </ul>"""

approximate_arrival_timestamp instance-attribute

approximate_arrival_timestamp: NotRequired[Timestamp]

The approximate time that the record was inserted into the stream.

data instance-attribute

data: 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 (10 MiB).

encryption_type instance-attribute

encryption_type: NotRequired[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.

partition_key instance-attribute

partition_key: NotRequired[PartitionKey]

Identifies which shard in the stream the data record is assigned to.

For a stream that uses the AUTO record distribution strategy, this value is not returned if the producer did not provide a partition key when writing the record. If the producer provided a partition key, the original value is returned even though it was not used to determine shard placement.

sequence_number instance-attribute

sequence_number: SequenceNumber

The unique identifier of the record within its shard.