AWS Kinesis · Schema

PutRecordsResultEntry

Represents the result of an individual record from a PutRecords request. A record that is successfully added to a stream includes SequenceNumber and ShardId in the result. A record that fails to be added to the stream includes ErrorCode and ErrorMessage in the result.

AnalyticsApache FlinkBig DataData ProcessingReal-TimeStreamingVideo

Properties

Name Type Description
SequenceNumber object
ShardId object
ErrorCode object
ErrorMessage object
View JSON Schema on GitHub

JSON Schema

kinesis-putrecordsresultentry-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/PutRecordsResultEntry",
  "title": "PutRecordsResultEntry",
  "type": "object",
  "properties": {
    "SequenceNumber": {
      "allOf": [
        {
          "$ref": "#/components/schemas/SequenceNumber"
        },
        {
          "description": "The sequence number for an individual record result."
        }
      ]
    },
    "ShardId": {
      "allOf": [
        {
          "$ref": "#/components/schemas/ShardId"
        },
        {
          "description": "The shard ID for an individual record result."
        }
      ]
    },
    "ErrorCode": {
      "allOf": [
        {
          "$ref": "#/components/schemas/ErrorCode"
        },
        {
          "description": "The error code for an individual record result. <code>ErrorCodes</code> can be either <code>ProvisionedThroughputExceededException</code> or <code>InternalFailure</code>."
        }
      ]
    },
    "ErrorMessage": {
      "allOf": [
        {
          "$ref": "#/components/schemas/ErrorMessage"
        },
        {
          "description": "The error message for an individual record result. An <code>ErrorCode</code> value of <code>ProvisionedThroughputExceededException</code> has an error message that includes the account ID, stream name, and shard ID. An <code>ErrorCode</code> value of <code>InternalFailure</code> has the error message <code>\"Internal Service Failure\"</code>."
        }
      ]
    }
  },
  "description": "Represents the result of an individual record from a <code>PutRecords</code> request. A record that is successfully added to a stream includes <code>SequenceNumber</code> and <code>ShardId</code> in the result. A record that fails to be added to the stream includes <code>ErrorCode</code> and <code>ErrorMessage</code> in the result."
}