put_record¶
Operation¶
async
¶
put_record(input: PutRecordInput, plugins: list[Plugin] | None = None) -> PutRecordOutput
Writes a single data record into an Amazon Kinesis data stream. Call
PutRecord to send data into the stream for real-time ingestion and
subsequent processing, one record at a time. Each shard can support
writes up to 1,000 records per second, up to a maximum data write total
of 10 MiB per second.
Note
When invoking this API, you must use either the StreamARN or the
StreamName parameter, or both. It is recommended that you use the
StreamARN input parameter when you invoke this API.
You must specify the name of the stream that captures, stores, and transports the data; a partition key; and the data blob itself.
The data blob can be any type of data; for example, a segment from a log file, geographic/location data, website clickstream data, and so on.
The partition key is used by Kinesis Data Streams to distribute data across shards. Kinesis Data Streams segregates the data records that belong to a stream into multiple shards, using the partition key associated with each data record to determine the shard to which a given data record belongs.
Partition keys are Unicode strings, with a maximum length limit of 256
characters for each key. An MD5 hash function is used to map partition
keys to 128-bit integer values and to map associated data records to
shards using the hash key ranges of the shards. You can override hashing
the partition key to determine the shard by explicitly specifying a hash
value using the ExplicitHashKey parameter. For more information, see
Adding Data to a
Stream
in the Amazon Kinesis Data Streams Developer Guide.
PutRecord returns the shard ID of where the data record was placed and
the sequence number that was assigned to the data record.
Sequence numbers increase over time and are specific to a shard within a
stream, not across all shards within a stream. To guarantee strictly
increasing ordering, write serially to a shard and use the
SequenceNumberForOrdering parameter. For more information, see Adding
Data to a
Stream
in the Amazon Kinesis Data Streams Developer Guide.
Warning
After you write a record to a stream, you cannot modify that record or its order within the stream.
If a PutRecord request cannot be processed because of insufficient
provisioned throughput on the shard involved in the request, PutRecord
throws ProvisionedThroughputExceededException.
By default, data records are accessible for 24 hours from the time that they are added to a stream. You can use IncreaseStreamRetentionPeriod or DecreaseStreamRetentionPeriod to modify this retention period.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
input
|
PutRecordInput
|
An instance of |
required |
plugins
|
list[Plugin] | None
|
A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations. |
None
|
Returns:
| Type | Description |
|---|---|
PutRecordOutput
|
An instance of |
Input¶
dataclass
¶
Bases: _SerdeShape
Represents the input for PutRecord.
Attributes¶
class-attribute
instance-attribute
¶
data: bytes | None = ...
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).
class-attribute
instance-attribute
¶
dry_run: bool | None = ...
Checks if your request will succeed. DryRun is an optional parameter.
class-attribute
instance-attribute
¶
explicit_hash_key: str | None = ...
The hash value used to explicitly determine the shard the data record is assigned to by overriding the partition key hash.
class-attribute
instance-attribute
¶
partition_key: str | None = ...
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. 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 the
record across shards using service-managed algorithms. For more
information, see UpdateStreamRecordDistributionStrategy.
class-attribute
instance-attribute
¶
sequence_number_for_ordering: str | None = ...
Guarantees strictly increasing sequence numbers, for puts from the same
client and to the same partition key. Usage: set the
SequenceNumberForOrdering of record n to the sequence number of
record n-1 (as returned in the result when putting record n-1). If
this parameter is not set, records are coarsely ordered based on arrival
time.
Output¶
dataclass
¶
Bases: _SerdeShape
Represents the output for PutRecord.
Attributes¶
class-attribute
instance-attribute
¶
encryption_type: str | None = ...
The encryption type to use 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.
class-attribute
instance-attribute
¶
Metadata about the response that produced this output. Use this to recover the request identifiers a service's support team needs in order to investigate a call. Members of the metadata are individually optional.