Amazon Web Services, Inc.

Amazon Neptune Graph

Neptune Analytics is a new analytics database engine for Amazon Neptune that helps customers get to insights faster by quickly processing large amounts of…

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 Analytics is a new analytics database engine for Amazon Neptune that helps customers get to insights faster by quickly processing large amounts of graph data, invoking popular graph analytic algorithms in low-latency queries, and getting analytics results in seconds.

Endpoints 34

Task

  • GETGet export task/exporttasks/:taskIdentifierRetrieves a specified export task.
  • DELETECancel export task/exporttasks/:taskIdentifierCancel the specified export task.
  • GETGet import task/importtasks/:taskIdentifierRetrieves a specified import task.
  • DELETECancel import task/importtasks/:taskIdentifierDeletes the specified import task.
  • GETList import tasks/importtasks?graphIdentifier=string&nextToken=string&maxResults=0Lists import tasks.
  • POSTCreate graph using import task/importtasksCreates a new Neptune Analytics graph and imports data into it, either from Amazon Simple Storage Service (S3) or from a Neptune database or a Neptune…
  • GETList export tasks/exporttasks?graphIdentifier=string&nextToken=string&maxResults=0Retrieves a list of export tasks.
  • POSTStart export task/exporttasksExport data from an existing Neptune Analytics graph to Amazon S3. The graph state should be AVAILABLE .
  • POSTStart import task/graphs/:graphIdentifier/importtasksImport data into existing Neptune Analytics graph from Amazon Simple Storage Service (S3). The graph needs to be empty and in the AVAILABLE state.

Graph

  • GETList graphs/graphs?nextToken=string&maxResults=0Lists available Neptune Analytics graphs.
  • POSTCreate graph/graphsCreates a new Neptune Analytics graph.
  • GETGet graph/graphs/:graphIdentifierGets information about a specified graph.
  • PUTReset graph/graphs/:graphIdentifierEmpties the data from a specified Neptune Analytics graph.
  • DELETEDelete graph/graphs/:graphIdentifier?skipSnapshot=trueDeletes the specified graph. Graphs cannot be deleted if delete-protection is enabled.
  • PATCHUpdate graph/graphs/:graphIdentifierUpdates the configuration of a specified Neptune Analytics graph
  • POSTRestore graph from snapshot/snapshots/:snapshotIdentifier/restoreRestores a graph from a snapshot.
  • POSTStart graph/graphs/:graphIdentifier/startStarts the specific graph.
  • POSTStop graph/graphs/:graphIdentifier/stopStops the specific graph.

Snapshot

  • GETList graph snapshots/snapshots?graphIdentifier=string&nextToken=string&maxResults=0Lists available snapshots of a specified Neptune Analytics graph.
  • POSTCreate graph snapshot/snapshotsCreates a snapshot of the specific graph.
  • GETGet graph snapshot/snapshots/:snapshotIdentifierRetrieves a specified graph snapshot.
  • DELETEDelete graph snapshot/snapshots/:snapshotIdentifierDeletes the specified graph snapshot.

Private graph endpoint

  • GETList private graph endpoints/graphs/:graphIdentifier/endpoints/?nextToken=string&maxResults=0Lists private endpoints for a specified Neptune Analytics graph.
  • POSTCreate private graph endpoint/graphs/:graphIdentifier/endpoints/Create a private graph endpoint to allow private access to the graph from within a VPC. You can attach security groups to the private graph endpoint. VPC…
  • GETGet private graph endpoint/graphs/:graphIdentifier/endpoints/:vpcIdRetrieves information about a specified private endpoint.
  • DELETEDelete private graph endpoint/graphs/:graphIdentifier/endpoints/:vpcIdDeletes a private graph endpoint.
  • GETGet query/queries/:queryIdRetrieves the status of a specified query. When invoking this operation in a Neptune Analytics cluster, the IAM user or role making the request must have the…
  • DELETECancel query/queries/:queryIdCancels a specified query.
  • GETList queries/queries?maxResults=0&state=stringLists active openCypher queries.
  • POSTExecute query/queriesExecute an openCypher query. When invoking this operation in a Neptune Analytics cluster, the IAM user or role making the request must have a policy attached…
  • GETGet graph summary/summary?mode=stringGets a graph summary for a property graph.
  • GETList tags for resource/tags/:resourceArnLists tags associated with a specified resource.
  • POSTTag resource/tags/:resourceArnAdds tags to the specified resource.
  • DELETEUntag resource/tags/:resourceArn?tagKeys=Removes the specified tags from the specified resource.

API details

Base URL
https://neptune-graph.{region}.amazonaws.com
Authentication
AWS Signature Version 4 (requests signed with your AWS access key)
Operations
34 operations on 18 pathsGET 14POST 11DELETE 7PUT 1PATCH 1
Main resources
Graph 9Task 9Private graph endpoint 4Snapshot 4
Description format
AWS Smithy model, API version 2023-11-29

How to test the Amazon Neptune Graph 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 Neptune Graph 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 export task” (GET /exporttasks/:taskIdentifier), and press Send. Check the response, add tests and run the whole collection with the runner.

Frequently asked questions

What is the Amazon Neptune Graph?

Neptune Analytics is a new analytics database engine for Amazon Neptune that helps customers get to insights faster by quickly processing large amounts of… It is listed under Developer tools and has 34 endpoints.

Who publishes the Amazon Neptune Graph?

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 Neptune Graph?

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

How do I authenticate with the Amazon Neptune Graph?

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

How many endpoints does the Amazon Neptune Graph have?

34 operations on 18 paths (14 GET, 11 POST, 7 DELETE, 1 PUT, 1 PATCH). The largest groups are Graph, Task, Private graph endpoint, Snapshot.

Is forking the Amazon Neptune Graph 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.