GetPropertygraphStreamInput

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/amazon-neptune/json-schema/amazon-neptune-get-propertygraph-stream-input-schema.json",
  "title": "GetPropertygraphStreamInput",
  "x-generated": "2026-11-11",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/amazon-neptune-property-graph-stream-api-openapi.yml#/components/schemas/GetPropertygraphStreamInput",
  "type": "object",
  "properties": {
    "limit": {
      "type": "integer",
      "description": "Specifies the maximum number of records to return. There is also a size limit of 10 MB on the response that can't be modified and that takes precedence over the number of records specified in the limit parameter. The response does include a threshold-breaching record if the 10 MB limit was reached. The range for limit is 1 to 100,000, with a default of 10."
    },
    "iteratorType": {
      "type": "string",
      "enum": [
        "AT_SEQUENCE_NUMBER",
        "AFTER_SEQUENCE_NUMBER",
        "TRIM_HORIZON",
        "LATEST"
      ],
      "description": "Can be one of: AT_SEQUENCE_NUMBER - Indicates that reading should start from the event sequence number specified jointly by the commitNum and opNum parameters. AFTER_SEQUENCE_NUMBER - Indicates that reading should start right after the event sequence number specified jointly by the commitNum and opNum parameters. TRIM_HORIZON - Indicates that reading should start at the last untrimmed record in the system, which is the oldest unexpired (not yet deleted) record in the change-log stream. LATEST - Indicates that reading should start at the most recent record in the system, which is the latest une"
    },
    "commitNum": {
      "type": "integer",
      "description": "The commit number of the starting record to read from the change-log stream. This parameter is required when iteratorType isAT_SEQUENCE_NUMBER or AFTER_SEQUENCE_NUMBER, and ignored when iteratorType is TRIM_HORIZON or LATEST."
    },
    "opNum": {
      "type": "integer",
      "description": "The operation sequence number within the specified commit to start reading from in the change-log stream data. The default is 1."
    },
    "encoding": {
      "type": "string",
      "enum": [
        "gzip"
      ],
      "description": "If set to TRUE, Neptune compresses the response using gzip encoding."
    }
  }
}