AWS Kinesis · Schema

PutRecordsRequestEntry

Represents the output for PutRecords.

AnalyticsApache FlinkBig DataData ProcessingReal-TimeStreamingVideo

Properties

Name Type Description
Data object
ExplicitHashKey object
PartitionKey object
View JSON Schema on GitHub

JSON Schema

kinesis-putrecordsrequestentry-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/PutRecordsRequestEntry",
  "title": "PutRecordsRequestEntry",
  "type": "object",
  "required": [
    "Data",
    "PartitionKey"
  ],
  "properties": {
    "Data": {
      "allOf": [
        {
          "$ref": "#/components/schemas/Data"
        },
        {
          "description": "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 MiB)."
        }
      ]
    },
    "ExplicitHashKey": {
      "allOf": [
        {
          "$ref": "#/components/schemas/HashKey"
        },
        {
          "description": "The hash value used to determine explicitly the shard that the data record is assigned to by overriding the partition key hash."
        }
      ]
    },
    "PartitionKey": {
      "allOf": [
        {
          "$ref": "#/components/schemas/PartitionKey"
        },
        {
          "description": "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."
        }
      ]
    }
  },
  "description": "Represents the output for <code>PutRecords</code>."
}