# PutRecord 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](https://docs.aws.amazon.com/kinesis/latest/dev/developing-producers-with-sdk.html#kinesis-using-sdk-java-add-data-to-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](https://docs.aws.amazon.com/kinesis/latest/dev/developing-producers-with-sdk.html#kinesis-using-sdk-java-add-data-to-stream) in the *Amazon Kinesis Data Streams Developer Guide*. **Important** 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](API_IncreaseStreamRetentionPeriod.md) or [DecreaseStreamRetentionPeriod](API_DecreaseStreamRetentionPeriod.md) to modify this retention period. ## Request Syntax ``` { "Data": blob, "ExplicitHashKey": "string", "PartitionKey": "string", "SequenceNumberForOrdering": "string", "StreamARN": "string", "StreamId": "string", "StreamName": "string" } ``` ## Request Parameters The request accepts the following data in JSON format. ** [Data](#API_PutRecord_RequestSyntax) ** 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). Type: Base64-encoded binary data object Length Constraints: Minimum length of 0. Maximum length of 10485760. Required: Yes ** [ExplicitHashKey](#API_PutRecord_RequestSyntax) ** The hash value used to explicitly determine the shard the data record is assigned to by overriding the partition key hash. Type: String Pattern: `0|([1-9]\d{0,38})` Required: No ** [PartitionKey](#API_PutRecord_RequestSyntax) ** 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. Type: String Length Constraints: Minimum length of 1. Maximum length of 256. Required: Yes ** [SequenceNumberForOrdering](#API_PutRecord_RequestSyntax) ** 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. Type: String Pattern: `0|([1-9]\d{0,128})` Required: No ** [StreamARN](#API_PutRecord_RequestSyntax) ** The ARN of the stream. Type: String Length Constraints: Minimum length of 1. Maximum length of 2048. Pattern: `arn:aws.*:kinesis:.*:\d{12}:stream/\S+` Required: No ** [StreamId](#API_PutRecord_RequestSyntax) ** Not Implemented. Reserved for future use. Type: String Length Constraints: Minimum length of 1. Maximum length of 24. Pattern: `[a-z0-9]{20}-[a-z0-9]{3}` Required: No ** [StreamName](#API_PutRecord_RequestSyntax) ** The name of the stream to put the data record into. Type: String Length Constraints: Minimum length of 1. Maximum length of 128. Pattern: `[a-zA-Z0-9_.-]+` Required: No ## Response Syntax ``` { "EncryptionType": "string", "SequenceNumber": "string", "ShardId": "string" } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [EncryptionType](#API_PutRecord_ResponseSyntax) ** 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 AWS KMS key. Type: String Valid Values: `NONE | KMS` ** [SequenceNumber](#API_PutRecord_ResponseSyntax) ** The sequence number identifier that was assigned to the put data record. The sequence number for the record is unique across all records in the stream. A sequence number is the identifier associated with every record put into the stream. Type: String Pattern: `0|([1-9]\d{0,128})` ** [ShardId](#API_PutRecord_ResponseSyntax) ** The shard ID of the shard where the data record was placed. Type: String Length Constraints: Minimum length of 1. Maximum length of 128. Pattern: `[a-zA-Z0-9_.-]+` ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** AccessDeniedException ** Specifies that you do not have the permissions required to perform this operation. HTTP Status Code: 400 ** InternalFailureException ** The processing of the request failed because of an unknown error, exception, or failure. HTTP Status Code: 500 ** InvalidArgumentException ** A specified parameter exceeds its restrictions, is not supported, or can't be used. For more information, see the returned message. ** message ** A message that provides information about the error. HTTP Status Code: 400 ** KMSAccessDeniedException ** The ciphertext references a key that doesn't exist or that you don't have access to. ** message ** A message that provides information about the error. HTTP Status Code: 400 ** KMSDisabledException ** The request was rejected because the specified customer master key (CMK) isn't enabled. ** message ** A message that provides information about the error. HTTP Status Code: 400 ** 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](https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html) in the * AWS Key Management Service Developer Guide*. ** message ** A message that provides information about the error. HTTP Status Code: 400 ** KMSNotFoundException ** The request was rejected because the specified entity or resource can't be found. ** message ** A message that provides information about the error. HTTP Status Code: 400 ** KMSOptInRequired ** The AWS access key ID needs a subscription for the service. ** message ** A message that provides information about the error. HTTP Status Code: 400 ** KMSThrottlingException ** The request was denied due to request throttling. For more information about throttling, see [Limits](https://docs.aws.amazon.com/kms/latest/developerguide/limits.html#requests-per-second) in the * AWS Key Management Service Developer Guide*. ** message ** A message that provides information about the error. HTTP Status Code: 400 ** 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](https://docs.aws.amazon.com/kinesis/latest/dev/service-sizes-and-limits.html) in the *Amazon Kinesis Data Streams Developer Guide*, and [Error Retries and Exponential Backoff in AWS](https://docs.aws.amazon.com/general/latest/gr/api-retries.html) in the * AWS General Reference*. ** message ** A message that provides information about the error. HTTP Status Code: 400 ** ResourceNotFoundException ** The requested resource could not be found. The stream might not be specified correctly. ** message ** A message that provides information about the error. HTTP Status Code: 400 ## Examples ### To add data to a stream The following JSON example adds data to the specified stream. #### Sample Request ``` POST / HTTP/1.1 Host: kinesis.. Content-Length: User-Agent: Content-Type: application/x-amz-json-1.1 Authorization: Connection: Keep-Alive X-Amz-Date: X-Amz-Target: Kinesis_20131202.PutRecord { "StreamName": "exampleStreamName", "Data": "XzxkYXRhPl8x", "PartitionKey": "partitionKey" } ``` #### Sample Response ``` HTTP/1.1 200 OK x-amzn-RequestId: Content-Type: application/x-amz-json-1.1 Content-Length: Date: { "SequenceNumber": "21269319989653637946712965403778482177", "ShardId": "shardId-000000000001" } ``` ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/kinesis-2013-12-02/PutRecord) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/kinesis-2013-12-02/PutRecord) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/kinesis-2013-12-02/PutRecord) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/kinesis-2013-12-02/PutRecord) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/kinesis-2013-12-02/PutRecord) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/kinesis-2013-12-02/PutRecord) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/kinesis-2013-12-02/PutRecord) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/kinesis-2013-12-02/PutRecord) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/kinesis-2013-12-02/PutRecord) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/kinesis-2013-12-02/PutRecord)