Amazon Neptune · JSON Structure

Data Start Loader Job Input Structure

StartLoaderJobInput schema from Neptune

Type: object Properties: 12 Required: 4

DatabaseGraph DatabaseGremlinNeptuneProperty GraphRDFSPARQL

StartLoaderJobInput is a JSON Structure definition published by Amazon Neptune, describing 12 properties, of which 4 are required. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

source format iamRoleArn region mode failOnError parallelism parserConfiguration updateSingleCardinalityProperties queueRequest dependencies userProvidedEdgeIds

Meta-schema: https://json-structure.org/meta/core/v0/#

JSON Structure

{
  "$schema": "https://json-structure.org/meta/core/v0/#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/amazon-neptune/refs/heads/main/json-structure/data-start-loader-job-input-structure.json",
  "name": "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"
  ]
}