AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.
Writes a single data record into an Amazon Kinesis data stream. Call
When invoking this API, you must use either the 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 1 MiB per second.
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.
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.
This is an asynchronous operation using the standard naming convention for .NET 4.5 or higher. For .NET 3.5 the operation is implemented as a pair of methods using the standard naming convention of BeginPutRecord and EndPutRecord.
Namespace: Amazon.Kinesis
Assembly: AWSSDK.Kinesis.dll
Version: 3.x.y.z
public abstract Task<PutRecordResponse> PutRecordAsync( PutRecordRequest request, CancellationToken cancellationToken )
Container for the necessary parameters to execute the PutRecord service method.
A cancellation token that can be used by other objects or threads to receive notice of cancellation.
| Exception | Condition |
|---|---|
| AccessDeniedException | Specifies that you do not have the permissions required to perform this operation. |
| InvalidArgumentException | A specified parameter exceeds its restrictions, is not supported, or can't be used. For more information, see the returned message. |
| KMSAccessDeniedException | The ciphertext references a key that doesn't exist or that you don't have access to. |
| KMSDisabledException | The request was rejected because the specified customer master key (CMK) isn't enabled. |
| KMSInvalidStateException | The request was rejected because the state of the specified resource isn't valid for this request. For more information, see How Key State Affects Use of a Customer Master Key in the Amazon Web Services Key Management Service Developer Guide. |
| KMSNotFoundException | The request was rejected because the specified entity or resource can't be found. |
| KMSOptInRequiredException | The Amazon Web Services access key ID needs a subscription for the service. |
| KMSThrottlingException | The request was denied due to request throttling. For more information about throttling, see Limits in the Amazon Web Services Key Management Service Developer Guide. |
| ProvisionedThroughputExceededException | The request rate for the stream is too high, or the requested data is too large for the available throughput. Reduce the frequency or size of your requests. For more information, see Streams Limits in the Amazon Kinesis Data Streams Developer Guide, and Error Retries and Exponential Backoff in Amazon Web Services in the Amazon Web Services General Reference. |
| ResourceNotFoundException | The requested resource could not be found. The stream might not be specified correctly. |
.NET:
Supported in: 8.0 and newer, Core 3.1
.NET Standard:
Supported in: 2.0
.NET Framework:
Supported in: 4.5 and newer