StartLoaderJobInput

StartLoaderJobInput schema from Neptune

DatabaseGraph DatabaseGremlinNeptuneProperty GraphRDFSPARQL

Properties

Name	Type	Description
source	string	Amazon S3 URI identifying files or folders to load (s3://bucket/key).
format	string	The data format of the files to load.
iamRoleArn	string	The ARN of the IAM role with S3 access.
region	string	The AWS Region of the S3 bucket.
mode	string	The load mode.
failOnError	string	Whether to stop the load job on error.
parallelism	string	The degree of parallelism for loading.
parserConfiguration	object	Optional parser configuration settings.
updateSingleCardinalityProperties	string	Whether to update existing single-cardinality properties.
queueRequest	string	Whether to queue the request if a load is already running.
dependencies	array	Load job IDs that must complete before this job runs.
userProvidedEdgeIds	string	For openCypher format, whether edge IDs are provided.

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/amazon-neptune/refs/heads/main/json-schema/data-start-loader-job-input-schema.json",
  "title": "StartLoaderJobInput",
  "description": "StartLoaderJobInput schema from Neptune",
  "type": "object",
  "properties": {
    "source": {
      "type": "string",
      "description": "Amazon S3 URI identifying files or folders to load (s3://bucket/key)."
    },
    "format": {
      "type": "string",
      "description": "The data format of the files to load.",
      "enum": [
        "csv",
        "opencypher",
        "ntriples",
        "nquads",
        "rdfxml",
        "turtle"
      ]
    },
    "iamRoleArn": {
      "type": "string",
      "description": "The ARN of the IAM role with S3 access."
    },
    "region": {
      "type": "string",
      "description": "The AWS Region of the S3 bucket."
    },
    "mode": {
      "type": "string",
      "description": "The load mode.",
      "enum": [
        "NEW",
        "RESUME",
        "AUTO"
      ],
      "default": "AUTO"
    },
    "failOnError": {
      "type": "string",
      "description": "Whether to stop the load job on error.",
      "enum": [
        "TRUE",
        "FALSE"
      ],
      "default": "TRUE"
    },
    "parallelism": {
      "type": "string",
      "description": "The degree of parallelism for loading.",
      "enum": [
        "LOW",
        "MEDIUM",
        "HIGH",
        "OVERSUBSCRIBE"
      ],
      "default": "HIGH"
    },
    "parserConfiguration": {
      "type": "object",
      "description": "Optional parser configuration settings.",
      "properties": {
        "baseUri": {
          "type": "string"
        },
        "namedGraphUri": {
          "type": "string"
        },
        "allowEmptyStrings": {
          "type": "boolean"
        }
      }
    },
    "updateSingleCardinalityProperties": {
      "type": "string",
      "description": "Whether to update existing single-cardinality properties.",
      "enum": [
        "TRUE",
        "FALSE"
      ],
      "default": "FALSE"
    },
    "queueRequest": {
      "type": "string",
      "description": "Whether to queue the request if a load is already running.",
      "enum": [
        "TRUE",
        "FALSE"
      ],
      "default": "FALSE"
    },
    "dependencies": {
      "type": "array",
      "description": "Load job IDs that must complete before this job runs.",
      "items": {
        "type": "string"
      }
    },
    "userProvidedEdgeIds": {
      "type": "string",
      "description": "For openCypher format, whether edge IDs are provided.",
      "enum": [
        "TRUE",
        "FALSE"
      ]
    }
  },
  "required": [
    "source",
    "format",
    "iamRoleArn",
    "region"
  ]
}