PutRecord
to send data from the producer into the Amazon Kinesis 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 MB per second.
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 Amazon Kinesis to distribute data across shards. Amazon Kinesis segregates the data records that belong to a data stream into multiple shards, using the partition key associated with each data record to determine which shard a given data record belongs to.
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 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 generally increase over time. To guarantee strictly increasing ordering,
use the SequenceNumberForOrdering parameter. For more information, see
Adding
Data to a Stream in the Amazon Kinesis Developer Guide.
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 only 24 hours from the time that they are added to an Amazon Kinesis stream. This retention period can be modified using the DecreaseStreamRetentionPeriod and IncreaseStreamRetentionPeriod operations.
Inheritance Hierarchy
Amazon.Runtime.AmazonWebServiceRequest
Amazon.Kinesis.AmazonKinesisRequest
Amazon.Kinesis.Model.PutRecordRequest
Namespace: Amazon.Kinesis.Model
Assembly: AWSSDK.dll
Version: (assembly version)
Syntax
public class PutRecordRequest : AmazonKinesisRequest IRequestEvents
The PutRecordRequest type exposes the following members
Constructors
| Name | Description | |
|---|---|---|
|
PutRecordRequest() |
Properties
| Name | Type | Description | |
|---|---|---|---|
|
|
Data | System.IO.MemoryStream |
Gets and sets the property Data.
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 (1 MB). |
|
|
ExplicitHashKey | System.String |
Gets and sets the property ExplicitHashKey.
The hash value used to explicitly determine the shard the data record is assigned to by overriding the partition key hash. |
|
|
PartitionKey | System.String |
Gets and sets the property PartitionKey.
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 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 will map to the same shard within the stream. |
|
|
SequenceNumberForOrdering | System.String |
Gets and sets the property SequenceNumberForOrdering.
Guarantees strictly increasing sequence numbers, for puts from the same client and
to the same partition key. Usage: set the |
|
|
StreamName | System.String |
Gets and sets the property StreamName.
The name of the stream to put the data record into. |
Version Information
.NET Framework:
Supported in: 4.5, 4.0, 3.5
.NET for Windows Store apps:
Supported in: Windows 8.1, Windows 8
.NET for Windows Phone:
Supported in: Windows Phone 8.1, Windows Phone 8