put_records¶
Operation¶
put_records
async
¶
put_records(request: PutRecordsInput | PutRecordsInputDict, /, *, plugins: list[Plugin] | None = None) -> PutRecordsOutput
put_records(*, plugins: list[Plugin] | None = None, **kwargs: Unpack[PutRecordsInputDict]) -> PutRecordsOutput
Writes multiple data records into a Kinesis data stream in a single call
(also referred to as a PutRecords request). Use this operation to send
data into the stream for data ingestion and processing.
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.
Each PutRecords request can support up to 500 records. Each record in
the request can be as large as 10 MiB, up to a limit of 10 MiB for the
entire request, including partition keys. Each shard can support writes
up to 1,000 records per second, up to a maximum data write total of 1 MB
per second.
You must specify the name of the stream that captures, stores, and
transports the data; and an array of request Records, with each record
in the array requiring a partition key and data blob. The record size
limit applies to the total size of the partition key and data blob.
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 as input to a hash function that maps the partition key and associated data to a specific shard. 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. For more information, see Adding Data to a Stream in the Amazon Kinesis Data Streams Developer Guide.
Each record in the Records array may include an optional parameter,
ExplicitHashKey, which overrides the partition key to shard mapping.
This parameter allows a data producer to determine explicitly the shard
where the record is stored. For more information, see Adding Multiple
Records with
PutRecords
in the Amazon Kinesis Data Streams Developer Guide.
The PutRecords response includes an array of response Records. Each
record in the response array directly correlates with a record in the
request array using natural ordering, from the top to the bottom of the
request and response. The response Records array always includes the
same number of records as the request array.
The response Records array includes both successfully and
unsuccessfully processed records. Kinesis Data Streams attempts to
process all records in each PutRecords request. A single record
failure does not stop the processing of subsequent records. As a result,
PutRecords doesn't guarantee the ordering of records. If you need to
read records in the same order they are written to the stream, use
PutRecord instead of PutRecords, and write to the same shard.
A successfully processed record includes ShardId and SequenceNumber
values. The ShardId parameter identifies the shard in the stream where
the record is stored. The SequenceNumber parameter is an identifier
assigned to the put record, unique to all records in the stream.
An unsuccessfully processed record includes ErrorCode and
ErrorMessage values. ErrorCode reflects the type of error and can be
one of the following values: ProvisionedThroughputExceededException or
InternalFailure. ErrorMessage provides more detailed information
about the ProvisionedThroughputExceededException exception including
the account ID, stream name, and shard ID of the record that was
throttled. For more information about partially successful responses,
see Adding Multiple Records with
PutRecords
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.
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 |
|---|---|---|---|
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 |
|---|---|
PutRecordsOutput
|
An instance of |
Input¶
Pass the input fields as keyword arguments, or pass a model or dictionary as the first positional argument. Pass plugins separately as a keyword argument.
Model¶
PutRecordsInput
dataclass
¶
Bases: _SerdeShape
A PutRecords request.
Attributes¶
dry_run
class-attribute
instance-attribute
¶
dry_run: bool | None = ...
Checks if your request will succeed. DryRun is an optional parameter.
records
class-attribute
instance-attribute
¶
records: list[PutRecordsRequestEntry] | None = ...
The records associated with the request.
Dictionaries¶
PutRecordsInputDict
¶
Bases: TypedDict
Dictionary form of PutRecordsInput.
Attributes¶
dry_run
instance-attribute
¶
dry_run: bool | None
Checks if your request will succeed. DryRun is an optional parameter.
records
instance-attribute
¶
records: Required[Sequence[PutRecordsRequestEntry | PutRecordsRequestEntryDict]]
The records associated with the request.
Output¶
PutRecordsOutput
dataclass
¶
Bases: _SerdeShape
PutRecords results.
Attributes¶
encryption_type
class-attribute
instance-attribute
¶
encryption_type: str | None = ...
The encryption type used on the records. This parameter can be one of the following values:
-
NONE: Do not encrypt the records. -
KMS: Use server-side encryption on the records using a customer-managed Amazon Web Services KMS key.
failed_record_count
class-attribute
instance-attribute
¶
failed_record_count: int | None = ...
The number of unsuccessfully processed records in a PutRecords
request.
records
instance-attribute
¶
records: list[PutRecordsResultEntry]
An array of successfully and unsuccessfully processed record results. A
record that is successfully added to a stream includes SequenceNumber
and ShardId in the result. A record that fails to be added to a stream
includes ErrorCode and ErrorMessage in the result.
response_metadata
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.