{
  "opencollection": "1.0.0",
  "info": {
    "name": "Amazon Neptune Neptune ML API",
    "version": "2024-01-01"
  },
  "request": {
    "auth": {
      "type": "apikey",
      "key": "Authorization",
      "value": "{{Authorization}}",
      "placement": "header"
    }
  },
  "items": [
    {
      "info": {
        "name": "Data Processing",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Amazon Neptune List Active Data Processing Jobs",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://{cluster-endpoint}:8182/ml/dataprocessing",
            "params": [
              {
                "name": "maxItems",
                "value": "",
                "type": "query",
                "description": "Maximum number of items to return (default 10, max 1024)."
              },
              {
                "name": "neptuneIamRoleArn",
                "value": "",
                "type": "query",
                "description": "The ARN of the IAM role for Neptune access."
              }
            ]
          },
          "docs": "Returns a list of active Neptune ML data processing job IDs."
        },
        {
          "info": {
            "name": "Amazon Neptune Create an ML Data Processing Job",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://{cluster-endpoint}:8182/ml/dataprocessing",
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Creates a new Neptune ML data processing job that exports and prepares graph data from Neptune for model training using Amazon SageMaker. The job reads data from Neptune and writes processed output to the specified S3 location."
        },
        {
          "info": {
            "name": "Amazon Neptune Get Data Processing Job Status",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://{cluster-endpoint}:8182/ml/dataprocessing/:id",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "The unique identifier of the data processing job."
              },
              {
                "name": "neptuneIamRoleArn",
                "value": "",
                "type": "query",
                "description": "The ARN of the IAM role for Neptune access."
              }
            ]
          },
          "docs": "Returns the status of a Neptune ML data processing job."
        },
        {
          "info": {
            "name": "Amazon Neptune Stop a Data Processing Job",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "https://{cluster-endpoint}:8182/ml/dataprocessing/:id",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "The unique identifier of the data processing job."
              },
              {
                "name": "clean",
                "value": "",
                "type": "query",
                "description": "Whether to delete all S3 artifacts when stopping."
              },
              {
                "name": "neptuneIamRoleArn",
                "value": "",
                "type": "query",
                "description": "The ARN of the IAM role for Neptune access."
              }
            ]
          },
          "docs": "Stops a running Neptune ML data processing job. Optionally deletes all S3 artifacts when the clean parameter is set to true."
        }
      ]
    },
    {
      "info": {
        "name": "Model Training",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Amazon Neptune List Active Model Training Jobs",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://{cluster-endpoint}:8182/ml/modeltraining",
            "params": [
              {
                "name": "maxItems",
                "value": "",
                "type": "query",
                "description": "Maximum number of items to return (default 10, max 1024)."
              },
              {
                "name": "neptuneIamRoleArn",
                "value": "",
                "type": "query"
              }
            ]
          },
          "docs": "Returns a list of active Neptune ML model training job IDs."
        },
        {
          "info": {
            "name": "Amazon Neptune Create an ML Model Training Job",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://{cluster-endpoint}:8182/ml/modeltraining",
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Creates a new Neptune ML model training job using Amazon SageMaker. The job trains a graph neural network model using the output from a completed data processing job. Supports relational graph convolutional network (RGCN) and knowledge graph embedding (KGE) models, as well as custom training scripts."
        },
        {
          "info": {
            "name": "Amazon Neptune Get Model Training Job Status",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://{cluster-endpoint}:8182/ml/modeltraining/:id",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "The unique identifier of the model training job."
              },
              {
                "name": "neptuneIamRoleArn",
                "value": "",
                "type": "query"
              }
            ]
          },
          "docs": "Returns the status of a Neptune ML model training job."
        },
        {
          "info": {
            "name": "Amazon Neptune Stop a Model Training Job",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "https://{cluster-endpoint}:8182/ml/modeltraining/:id",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path"
              },
              {
                "name": "clean",
                "value": "",
                "type": "query"
              },
              {
                "name": "neptuneIamRoleArn",
                "value": "",
                "type": "query"
              }
            ]
          },
          "docs": "Stops a running Neptune ML model training job. Optionally deletes all S3 artifacts when the clean parameter is set to true."
        }
      ]
    },
    {
      "info": {
        "name": "Model Transform",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Amazon Neptune List Active Model Transform Jobs",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://{cluster-endpoint}:8182/ml/modeltransform",
            "params": [
              {
                "name": "maxItems",
                "value": "",
                "type": "query"
              },
              {
                "name": "neptuneIamRoleArn",
                "value": "",
                "type": "query"
              }
            ]
          },
          "docs": "Returns a list of active Neptune ML model transform job IDs."
        },
        {
          "info": {
            "name": "Amazon Neptune Create an ML Model Transform Job",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://{cluster-endpoint}:8182/ml/modeltransform",
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Creates a new Neptune ML model transform job that generates model artifacts for inference. The transform job creates the embeddings and other artifacts needed to deploy the model to an inference endpoint."
        },
        {
          "info": {
            "name": "Amazon Neptune Get Model Transform Job Status",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://{cluster-endpoint}:8182/ml/modeltransform/:id",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path"
              },
              {
                "name": "neptuneIamRoleArn",
                "value": "",
                "type": "query"
              }
            ]
          },
          "docs": "Returns the status of a Neptune ML model transform job."
        },
        {
          "info": {
            "name": "Amazon Neptune Stop a Model Transform Job",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "https://{cluster-endpoint}:8182/ml/modeltransform/:id",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path"
              },
              {
                "name": "clean",
                "value": "",
                "type": "query"
              },
              {
                "name": "neptuneIamRoleArn",
                "value": "",
                "type": "query"
              }
            ]
          },
          "docs": "Stops a running Neptune ML model transform job."
        }
      ]
    },
    {
      "info": {
        "name": "Inference Endpoints",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Amazon Neptune List ML Inference Endpoints",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://{cluster-endpoint}:8182/ml/endpoints",
            "params": [
              {
                "name": "maxItems",
                "value": "",
                "type": "query"
              },
              {
                "name": "neptuneIamRoleArn",
                "value": "",
                "type": "query"
              }
            ]
          },
          "docs": "Returns a list of active Neptune ML inference endpoint IDs."
        },
        {
          "info": {
            "name": "Amazon Neptune Create an ML Inference Endpoint",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://{cluster-endpoint}:8182/ml/endpoints",
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Creates a new Neptune ML inference endpoint backed by Amazon SageMaker. The endpoint can be used to make real-time predictions on graph data using a trained model. Can also be used to update an existing endpoint by setting the update parameter to true."
        },
        {
          "info": {
            "name": "Amazon Neptune Get ML Inference Endpoint Status",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://{cluster-endpoint}:8182/ml/endpoints/:id",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "The unique identifier of the inference endpoint."
              },
              {
                "name": "neptuneIamRoleArn",
                "value": "",
                "type": "query"
              }
            ]
          },
          "docs": "Returns the status of a Neptune ML inference endpoint."
        },
        {
          "info": {
            "name": "Amazon Neptune Delete an ML Inference Endpoint",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "https://{cluster-endpoint}:8182/ml/endpoints/:id",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path"
              },
              {
                "name": "clean",
                "value": "",
                "type": "query",
                "description": "Whether to delete all related S3 artifacts."
              },
              {
                "name": "neptuneIamRoleArn",
                "value": "",
                "type": "query"
              }
            ]
          },
          "docs": "Deletes a Neptune ML inference endpoint. Optionally cleans up all related S3 artifacts."
        }
      ]
    }
  ],
  "bundled": true
}