StartImportTaskInput

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/amazon-neptune/json-schema/amazon-neptune-start-import-task-input-schema.json",
  "title": "StartImportTaskInput",
  "x-generated": "2026-11-11",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/amazon-neptune-import-tasks-api-openapi.yml#/components/schemas/StartImportTaskInput",
  "type": "object",
  "properties": {
    "importOptions": {
      "$ref": "#/$defs/ImportOptions"
    },
    "failOnError": {
      "type": "boolean",
      "description": "If set to true, the task halts when an import error is encountered. If set to false, the task skips the data that caused the error and continues if possible."
    },
    "source": {
      "type": "string",
      "description": "A URL identifying the location of the data to be imported. This can be an Amazon S3 path, or can point to a Neptune database endpoint or snapshot."
    },
    "format": {
      "type": "string",
      "enum": [
        "CSV",
        "OPEN_CYPHER",
        "PARQUET",
        "NTRIPLES"
      ],
      "description": "Specifies the format of Amazon S3 data to be imported. Valid values are CSV, which identifies the Gremlin CSV format or OPENCYPHER, which identifies the openCypher load format."
    },
    "parquetType": {
      "type": "string",
      "enum": [
        "COLUMNAR"
      ],
      "description": "The parquet type of the import task."
    },
    "blankNodeHandling": {
      "type": "string",
      "enum": [
        "convertToIri"
      ],
      "description": "The method to handle blank nodes in the dataset. Currently, only convertToIri is supported, meaning blank nodes are converted to unique IRIs at load time. Must be provided when format is ntriples. For more information, see Handling RDF values."
    },
    "graphIdentifier": {
      "type": "string",
      "description": "The unique identifier of the Neptune Analytics graph."
    },
    "roleArn": {
      "type": "string",
      "description": "The ARN of the IAM role that will allow access to the data that is to be imported."
    }
  },
  "required": [
    "source",
    "graphIdentifier",
    "roleArn"
  ],
  "$defs": {
    "ImportOptions": {
      "type": "object",
      "properties": {
        "neptune": {
          "$ref": "#/$defs/NeptuneImportOptions"
        }
      },
      "description": "Exactly one member is set."
    },
    "NeptuneImportOptions": {
      "type": "object",
      "properties": {
        "s3ExportPath": {
          "type": "string",
          "description": "The path to an S3 bucket from which to import data."
        },
        "s3ExportKmsKeyId": {
          "type": "string",
          "description": "The KMS key to use to encrypt data in the S3 bucket where the graph data is exported"
        },
        "preserveDefaultVertexLabels": {
          "type": "boolean",
          "description": "Neptune Analytics supports label-less vertices and no labels are assigned unless one is explicitly provided. Neptune assigns default labels when none is explicitly provided. When importing the data into Neptune Analytics, the default vertex labels can be omitted by setting preserveDefaultVertexLabels to false. Note that if the vertex only has default labels, and has no other properties or edges, then the vertex will effectively not get imported into Neptune Analytics when preserveDefaultVertexLabels is set to false."
        },
        "preserveEdgeIds": {
          "type": "boolean",
          "description": "Neptune Analytics currently does not support user defined edge ids. The edge ids are not imported by default. They are imported if preserveEdgeIds is set to true, and ids are stored as properties on the relationships with the property name neptuneEdgeId."
        }
      },
      "required": [
        "s3ExportPath",
        "s3ExportKmsKeyId"
      ]
    }
  }
}