Amazon Web Services, Inc.

Amazon NeptuneData

Neptune Data API The Amazon Neptune data API provides SDK support for more than 40 of Neptune's data operations, including data loading, query execution, data…

Developer tools#openapi

Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.

Overview

Neptune Data API The Amazon Neptune data API provides SDK support for more than 40 of Neptune's data operations, including data loading, query execution, data inquiry, and machine learning. It supports the Gremlin and openCypher query languages, and is available in all SDK languages. It automatically signs API requests and greatly simplifies integrating Neptune into your applications.

Endpoints 48

  • GETGet gremlin query status/gremlin/status/:queryIdGets the status of a specified Gremlin query. When invoking this operation in a Neptune cluster that has IAM authentication enabled, the IAM user or role…
  • DELETECancel gremlin query/gremlin/status/:queryIdCancels a Gremlin query. See Gremlin query cancellation for more information. When invoking this operation in a Neptune cluster that has IAM authentication…
  • POSTCancel index rebuild/storage/indexes/rebuilds/:rebuildId/cancelCancels an in-progress index rebuild operation. When invoking this operation in a Neptune cluster that has IAM authentication enabled, the IAM user or role…
  • GETGet loader job status/loader/:loadId?details=true&errors=true&page=0&errorsPerPage=0Gets status information about a specified load job. Neptune keeps track of the most recent 1,024 bulk load jobs, and stores the last 10,000 error details per…
  • DELETECancel loader job/loader/:loadIdCancels a specified load job. This is an HTTP DELETE request. See Neptune Loader Get-Status API for more information. When invoking this operation in a…
  • GETGet mL data processing job/ml/dataprocessing/:id?neptuneIamRoleArn=stringRetrieves information about a specified data processing job. See The dataprocessing command . When invoking this operation in a Neptune cluster that has IAM…
  • DELETECancel mL data processing job/ml/dataprocessing/:id?neptuneIamRoleArn=string&clean=trueCancels a Neptune ML data processing job. See The dataprocessing command . When invoking this operation in a Neptune cluster that has IAM authentication…
  • GETGet mL model training job/ml/modeltraining/:id?neptuneIamRoleArn=stringRetrieves information about a Neptune ML model training job. See Model training using the modeltraining command . When invoking this operation in a Neptune…
  • DELETECancel mL model training job/ml/modeltraining/:id?neptuneIamRoleArn=string&clean=trueCancels a Neptune ML model training job. See Model training using the modeltraining command . When invoking this operation in a Neptune cluster that has IAM…
  • GETGet mL model transform job/ml/modeltransform/:id?neptuneIamRoleArn=stringGets information about a specified model transform job. See Use a trained model to generate new model artifacts . When invoking this operation in a Neptune…
  • DELETECancel mL model transform job/ml/modeltransform/:id?neptuneIamRoleArn=string&clean=trueCancels a specified model transform job. See Use a trained model to generate new model artifacts . When invoking this operation in a Neptune cluster that has…
  • GETGet open cypher query status/opencypher/status/:queryIdRetrieves the status of a specified openCypher query. When invoking this operation in a Neptune cluster that has IAM authentication enabled, the IAM user or…
  • DELETECancel open cypher query/opencypher/status/:queryId?silent=trueCancels a specified openCypher query. See Neptune openCypher status endpoint for more information. When invoking this operation in a Neptune cluster that has…
  • GETList mL endpoints/ml/endpoints?maxItems=0&neptuneIamRoleArn=stringLists existing inference endpoints. See Managing inference endpoints using the endpoints command . When invoking this operation in a Neptune cluster that has…
  • POSTCreate mL endpoint/ml/endpointsCreates a new Neptune ML inference endpoint that lets you query one specific model that the model-training process constructed. See Managing inference…
  • GETGet mL endpoint/ml/endpoints/:id?neptuneIamRoleArn=stringRetrieves details about an inference endpoint. See Managing inference endpoints using the endpoints command . When invoking this operation in a Neptune…
  • DELETEDelete mL endpoint/ml/endpoints/:id?neptuneIamRoleArn=string&clean=trueCancels the creation of a Neptune ML inference endpoint. See Managing inference endpoints using the endpoints command . When invoking this operation in a…
  • GETGet propertygraph statistics/propertygraph/statisticsGets property graph statistics (Gremlin and openCypher). When invoking this operation in a Neptune cluster that has IAM authentication enabled, the IAM user…
  • POSTManage propertygraph statistics/propertygraph/statisticsManages the generation and use of property graph statistics. When invoking this operation in a Neptune cluster that has IAM authentication enabled, the IAM…
  • DELETEDelete propertygraph statistics/propertygraph/statisticsDeletes statistics for Gremlin and openCypher (property graph) data. When invoking this operation in a Neptune cluster that has IAM authentication enabled,…
  • GETGet sparql statistics/sparql/statisticsGets RDF statistics (SPARQL).
  • POSTManage sparql statistics/sparql/statisticsManages the generation and use of RDF graph statistics. When invoking this operation in a Neptune cluster that has IAM authentication enabled, the IAM user or…
  • DELETEDelete sparql statistics/sparql/statisticsDeletes SPARQL statistics When invoking this operation in a Neptune cluster that has IAM authentication enabled, the IAM user or role making the request must…
  • POSTExecute fast reset/systemThe fast reset REST API lets you reset a Neptune graph quicky and easily, removing all of its data. Neptune fast reset is a two-step process. First you call…
  • POSTExecute gremlin explain query/gremlin/explainExecutes a Gremlin Explain query. Amazon Neptune has added a Gremlin feature named explain that provides is a self-service tool for understanding the…
  • POSTExecute gremlin profile query/gremlin/profileExecutes a Gremlin Profile query, which runs a specified traversal, collects various metrics about the run, and produces a profile report as output. See…
  • POSTExecute gremlin query/gremlinThis commands executes a Gremlin query. Amazon Neptune is compatible with Apache TinkerPop3 and Gremlin, so you can use the Gremlin traversal language to…
  • POSTExecute open cypher explain query/opencypher/explainExecutes an openCypher explain request. See The openCypher explain feature for more information. When invoking this operation in a Neptune cluster that has…
  • POSTExecute open cypher query/opencypherExecutes an openCypher query. See Accessing the Neptune Graph with openCypher for more information. Neptune supports building graph applications using…
  • GETGet engine status/statusRetrieves the status of the graph database on the host. When invoking this operation in a Neptune cluster that has IAM authentication enabled, the IAM user or…
  • GETGet index rebuild status/storage/indexes/rebuilds/:rebuildIdRetrieves the status of an index rebuild operation. When invoking this operation in a Neptune cluster that has IAM authentication enabled, the IAM user or…
  • GETGet propertygraph stream/propertygraph/stream?limit=0&iteratorType=string&commitNum=0&opNum=0Gets a stream for a property graph. With the Neptune Streams feature, you can generate a complete sequence of change-log entries that record every change made…
  • GETGet propertygraph summary/propertygraph/statistics/summary?mode=stringGets a graph summary for a property graph. When invoking this operation in a Neptune cluster that has IAM authentication enabled, the IAM user or role making…
  • GETGet rDF graph summary/rdf/statistics/summary?mode=stringGets a graph summary for an RDF graph. When invoking this operation in a Neptune cluster that has IAM authentication enabled, the IAM user or role making the…
  • GETGet sparql stream/sparql/stream?limit=0&iteratorType=string&commitNum=0&opNum=0Gets a stream for an RDF graph. With the Neptune Streams feature, you can generate a complete sequence of change-log entries that record every change made to…
  • GETGet storage info/storage/infoRetrieves storage information for the Neptune database instance, including approximate total storage used and per-category size and entry counts. Storage…
  • GETList gremlin queries/gremlin/status?includeWaiting=trueLists active Gremlin queries. See Gremlin query status API for details about the output. When invoking this operation in a Neptune cluster that has IAM…
  • GETList index rebuilds/storage/indexes/rebuildsRetrieves a list of all index rebuild operation identifiers. When invoking this operation in a Neptune cluster that has IAM authentication enabled, the IAM…
  • POSTStart index rebuild/storage/indexes/rebuilds?scope=string&concurrency=0&writeBufferSize=stringInitiates an index rebuild operation to optimize storage and improve query performance. The rebuild operation reorganizes index to reclaim space and improve…
  • GETList loader jobs/loader?limit=0&includeQueuedLoads=trueRetrieves a list of the loadIds for all active loader jobs. When invoking this operation in a Neptune cluster that has IAM authentication enabled, the IAM…
  • POSTStart loader job/loaderStarts a Neptune bulk loader job to load data from an Amazon S3 bucket into a Neptune DB instance. See Using the Amazon Neptune Bulk Loader to Ingest Data .…
  • GETList mL data processing jobs/ml/dataprocessing?maxItems=0&neptuneIamRoleArn=stringReturns a list of Neptune ML data processing jobs. See Listing active data-processing jobs using the Neptune ML dataprocessing command . When invoking this…
  • POSTStart mL data processing job/ml/dataprocessingCreates a new Neptune ML data processing job for processing the graph data exported from Neptune for training. See The dataprocessing command . When invoking…
  • GETList mL model training jobs/ml/modeltraining?maxItems=0&neptuneIamRoleArn=stringLists Neptune ML model-training jobs. See Model training using the modeltraining command . When invoking this operation in a Neptune cluster that has IAM…
  • POSTStart mL model training job/ml/modeltrainingCreates a new Neptune ML model training job. See Model training using the modeltraining command . When invoking this operation in a Neptune cluster that has…
  • GETList mL model transform jobs/ml/modeltransform?maxItems=0&neptuneIamRoleArn=stringReturns a list of model transform job IDs. See Use a trained model to generate new model artifacts . When invoking this operation in a Neptune cluster that…
  • POSTStart mL model transform job/ml/modeltransformCreates a new model transform job. See Use a trained model to generate new model artifacts . When invoking this operation in a Neptune cluster that has IAM…
  • GETList open cypher queries/opencypher/status?includeWaiting=trueLists active openCypher queries. See Neptune openCypher status endpoint for more information. When invoking this operation in a Neptune cluster that has IAM…

API details

Base URL
https://neptune-db.{region}.amazonaws.com
Authentication
AWS Signature Version 4 (requests signed with your AWS access key)
Operations
48 operations on 31 pathsGET 24POST 15DELETE 9
Description format
AWS Smithy model, API version 2023-08-01

How to test the Amazon NeptuneData in Swastik Codes

  1. Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
  2. Fork it into your workspaceChoose a workspace. You get your own copy of the Amazon NeptuneData collection, without the publisher's secrets.
  3. Add your credentialsThis API uses AWS Signature Version 4 (requests signed with your AWS access key). Add yours in the collection's variables or an environment; the requests already reference it.
  4. Send a requestPick an endpoint, for example “Get gremlin query status” (GET /gremlin/status/:queryId), and press Send. Check the response, add tests and run the whole collection with the runner.

Frequently asked questions

What is the Amazon NeptuneData?

Neptune Data API The Amazon Neptune data API provides SDK support for more than 40 of Neptune's data operations, including data loading, query execution, data… It is listed under Developer tools and has 48 endpoints.

Who publishes the Amazon NeptuneData?

It is listed from Amazon Web Services, Inc.'s public API description (an OpenAPI document), not published by Amazon Web Services, Inc. on Swastik Codes. Anyone who controls amazonaws.com can claim the profile by adding a DNS TXT record.

What is the base URL of the Amazon NeptuneData?

Requests go to https://neptune-db.{region}.amazonaws.com. Endpoint paths are added to this base URL.

How do I authenticate with the Amazon NeptuneData?

With AWS Signature Version 4 (requests signed with your AWS access key).

How many endpoints does the Amazon NeptuneData have?

48 operations on 31 paths (24 GET, 15 POST, 9 DELETE).

Is forking the Amazon NeptuneData free?

Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.

Suggest an API

Tell us which public API is missing. We check it, then add it here with its endpoints when it has an OpenAPI (Swagger) description.