{
  "opencollection": "1.0.0",
  "info": {
    "name": "Amazon Neptune Neptune Loader API",
    "version": "2024-01-01"
  },
  "request": {
    "auth": {
      "type": "apikey",
      "key": "Authorization",
      "value": "{{Authorization}}",
      "placement": "header"
    }
  },
  "items": [
    {
      "info": {
        "name": "Loader",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Amazon Neptune List Bulk Load Job IDs",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://{cluster-endpoint}:8182/loader",
            "params": [
              {
                "name": "limit",
                "value": "",
                "type": "query",
                "description": "The maximum number of load IDs to return."
              },
              {
                "name": "includeQueuedLoads",
                "value": "",
                "type": "query",
                "description": "Whether to include queued load jobs in the response."
              }
            ]
          },
          "docs": "Returns a list of bulk load job IDs. Neptune tracks the most recent 1,024 bulk load jobs."
        },
        {
          "info": {
            "name": "Amazon Neptune Start a Bulk Data Load Job from S3",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://{cluster-endpoint}:8182/loader",
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Initiates a bulk data loading job from Amazon S3 into the Neptune database. The source data can be in CSV format for property graphs or in N-Triples, N-Quads, RDF/XML, or Turtle formats for RDF data. The loader requires an IAM role with access to the S3 bucket. Neptune queues up to 64 jobs in FIFO order when queueRequest is enabled."
        },
        {
          "info": {
            "name": "Amazon Neptune Get the Status of a Bulk Load Job",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://{cluster-endpoint}:8182/loader/:loadId",
            "params": [
              {
                "name": "loadId",
                "value": "",
                "type": "path",
                "description": "The unique identifier of the bulk load job."
              },
              {
                "name": "details",
                "value": "",
                "type": "query",
                "description": "Whether to include detailed feed-level status information."
              },
              {
                "name": "errors",
                "value": "",
                "type": "query",
                "description": "Whether to include error details in the response."
              },
              {
                "name": "page",
                "value": "",
                "type": "query",
                "description": "The error page number to retrieve (when errors=true)."
              },
              {
                "name": "errorsPerPage",
                "value": "",
                "type": "query",
                "description": "The number of errors per page (when errors=true)."
              }
            ]
          },
          "docs": "Returns the status of a specific bulk load job by its load ID. Includes overall status, feed counts, and optionally detailed error information. Neptune stores the last 10,000 error details per job."
        },
        {
          "info": {
            "name": "Amazon Neptune Cancel an In-progress Bulk Load Job",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "https://{cluster-endpoint}:8182/loader/:loadId",
            "params": [
              {
                "name": "loadId",
                "value": "",
                "type": "path",
                "description": "The unique identifier of the load job to cancel."
              }
            ]
          },
          "docs": "Cancels an in-progress bulk load job by its load ID. Must be executed against the read/write cluster endpoint (not a read replica)."
        }
      ]
    }
  ],
  "bundled": true
}