PutRecords

Puts multiple records into a data stream in a single call.

This method delivers higher throughput compared to PutRecord. A single request can contain up to 500 records. Each record in the request can be up to 1 MB in size. The total request size cannot exceed 5 MB, including partition keys.

The request must include the stream name and an array of Records. Each record must contain a partition key and an object containing Base64-encoded user data. To explicitly specify the hash key determining the target shard for records, use the ExplicitHashKey parameter.

Returns an array of elements containing status information for each record. Each entry in the response array corresponds to a record in the request array. The response array maintains the same order as the request array. The response array provides status information for all records, whether processed successfully or not. A single record failure does not prevent processing of subsequent records.

PutRecords guarantees that records are written to the stream in the exact order they appear in the request array.

For successfully processed records, the response includes the ShardId of the shard where the record was stored and the SequenceNumber assigned to the record.

For records that failed processing, the response includes an ErrorCode and an ErrorMessage. Common error types include ProvisionedThroughputExceededException and InternalFailure. For ProvisionedThroughputExceededException errors, the error message includes the account ID, the stream name, and the shard ID of the failed record.

RequestRequest

The request contains JSON-formatted data.

{
  "Records": [{
    "Data": blob,
    "ExplicitHashKey": "string",
    "PartitionKey": "string"
  }],
  "StreamName": "string"
}

Request optionsRequest options

ResponseResponse

Successful requests return HTTP 200 with a JSON-formatted response body.

{
  "EncryptionType": "string",
  "FailedRecordCount": number,
  "Records": [{
    "ErrorCode": "string",
    "ErrorMessage": "string",
    "SequenceNumber": "string",
    "ShardId": "string"
  }]
}

Response parametersResponse parameters

ErrorsErrors

Errors common to all methods may occur.