AWS Kinesis · Schema

GetRecordsOutput

Represents the output for GetRecords.

AnalyticsApache FlinkBig DataData ProcessingReal-TimeStreamingVideo

Properties

Name Type Description
Records object
NextShardIterator object
MillisBehindLatest object
ChildShards object
View JSON Schema on GitHub

JSON Schema

kinesis-getrecordsoutput-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/GetRecordsOutput",
  "title": "GetRecordsOutput",
  "type": "object",
  "required": [
    "Records"
  ],
  "properties": {
    "Records": {
      "allOf": [
        {
          "$ref": "#/components/schemas/RecordList"
        },
        {
          "description": "The data records retrieved from the shard."
        }
      ]
    },
    "NextShardIterator": {
      "allOf": [
        {
          "$ref": "#/components/schemas/ShardIterator"
        },
        {
          "description": "The next position in the shard from which to start sequentially reading data records. If set to <code>null</code>, the shard has been closed and the requested iterator does not return any more data. "
        }
      ]
    },
    "MillisBehindLatest": {
      "allOf": [
        {
          "$ref": "#/components/schemas/MillisBehindLatest"
        },
        {
          "description": "The number of milliseconds the <a>GetRecords</a> response is from the tip of the stream, indicating how far behind current time the consumer is. A value of zero indicates that record processing is caught up, and there are no new records to process at this moment."
        }
      ]
    },
    "ChildShards": {
      "allOf": [
        {
          "$ref": "#/components/schemas/ChildShardList"
        },
        {
          "description": "The list of the current shard's child shards, returned in the <code>GetRecords</code> API's response only when the end of the current shard is reached."
        }
      ]
    }
  },
  "description": "Represents the output for <a>GetRecords</a>."
}