PutRecordsCommand

Suggest an Edit

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.

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 1 MiB, up to a limit of 5 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 MiB 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.

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.

Example Syntax

Use a bare-bones client and the command you need to make an API call.

import { KinesisClient, PutRecordsCommand } from "@aws-sdk/client-kinesis"; // ES Modules import
// const { KinesisClient, PutRecordsCommand } = require("@aws-sdk/client-kinesis"); // CommonJS import
const client = new KinesisClient(config);
const input = { // PutRecordsInput
  Records: [ // PutRecordsRequestEntryList // required
    { // PutRecordsRequestEntry
      Data: new Uint8Array(), // e.g. Buffer.from("") or new TextEncoder().encode("")       // required
      ExplicitHashKey: "STRING_VALUE",
      PartitionKey: "STRING_VALUE", // required
    },
  ],
  StreamName: "STRING_VALUE",
  StreamARN: "STRING_VALUE",
};
const command = new PutRecordsCommand(input);
const response = await client.send(command);
// { // PutRecordsOutput
//   FailedRecordCount: Number("int"),
//   Records: [ // PutRecordsResultEntryList // required
//     { // PutRecordsResultEntry
//       SequenceNumber: "STRING_VALUE",
//       ShardId: "STRING_VALUE",
//       ErrorCode: "STRING_VALUE",
//       ErrorMessage: "STRING_VALUE",
//     },
//   ],
//   EncryptionType: "NONE" || "KMS",
// };

PutRecordsCommand Input

See PutRecordsCommandInput for more details

Parameter
Type
Description
Records
Required
PutRecordsRequestEntry[] | undefined

The records associated with the request.

StreamARN
string | undefined

The ARN of the stream.

StreamName
string | undefined

The stream name associated with the request.

PutRecordsCommand Output

See PutRecordsCommandOutput for details

Parameter
Type
Description
$metadata
Required
ResponseMetadata
Metadata pertaining to this request.
Records
Required
PutRecordsResultEntry[] | undefined

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.

EncryptionType
EncryptionType | undefined

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.

FailedRecordCount
number | undefined

The number of unsuccessfully processed records in a PutRecords request.

Throws

Name
Fault
Details
AccessDeniedException
client

Specifies that you do not have the permissions required to perform this operation.

InvalidArgumentException
client

A specified parameter exceeds its restrictions, is not supported, or can't be used. For more information, see the returned message.

KMSAccessDeniedException
client

The ciphertext references a key that doesn't exist or that you don't have access to.

KMSDisabledException
client

The request was rejected because the specified customer master key (CMK) isn't enabled.

KMSInvalidStateException
client

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
client

The request was rejected because the specified entity or resource can't be found.

KMSOptInRequired
client

The Amazon Web Services access key ID needs a subscription for the service.

KMSThrottlingException
client

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
client

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
client

The requested resource could not be found. The stream might not be specified correctly.

KinesisServiceException
Base exception class for all service exceptions from Kinesis service.