AWS Kinesis · Schema

GetRecordsInput

Represents the input for GetRecords.

AnalyticsApache FlinkBig DataData ProcessingReal-TimeStreamingVideo

Properties

Name Type Description
ShardIterator object
Limit object
StreamARN object
View JSON Schema on GitHub

JSON Schema

kinesis-getrecordsinput-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/GetRecordsInput",
  "title": "GetRecordsInput",
  "type": "object",
  "required": [
    "ShardIterator"
  ],
  "properties": {
    "ShardIterator": {
      "allOf": [
        {
          "$ref": "#/components/schemas/ShardIterator"
        },
        {
          "description": "The position in the shard from which you want to start sequentially reading data records. A shard iterator specifies this position using the sequence number of a data record in the shard."
        }
      ]
    },
    "Limit": {
      "allOf": [
        {
          "$ref": "#/components/schemas/GetRecordsInputLimit"
        },
        {
          "description": "The maximum number of records to return. Specify a value of up to 10,000. If you specify a value that is greater than 10,000, <a>GetRecords</a> throws <code>InvalidArgumentException</code>. The default value is 10,000."
        }
      ]
    },
    "StreamARN": {
      "allOf": [
        {
          "$ref": "#/components/schemas/StreamARN"
        },
        {
          "description": "The ARN of the stream."
        }
      ]
    }
  },
  "description": "Represents the input for <a>GetRecords</a>."
}