Sign in

v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-1434174156.5 KB

Execute 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 that allows one of the following IAM actions in that cluster, depending on the query:

  • neptune-graph:ReadDataViaQuery

  • neptune-graph:WriteDataViaQuery

  • neptune-graph:DeleteDataViaQuery

post/queries#graphIdentifier

Headers

graphIdentifierstring required

The unique identifier of the Neptune Analytics graph.

Request body

querystring required

The query string to be executed.

language'OPEN_CYPHER' required

The query language the query is written in. Currently only openCypher is supported.

parametersobject

The data parameters the query can use in JSON format. For example: {"name": "john", "age": 20}. (optional)

planCache'ENABLED' | 'DISABLED' | 'AUTO'

Query plan cache is a feature that saves the query plan and reuses it on successive executions of the same query. This reduces query latency, and works for both <code>READ</code> and <code>UPDATE</code> queries. The plan cache is an LRU cache with a 5 minute TTL and a capacity of 1000.

explain'STATIC' | 'DETAILS'

The explain mode parameter returns a query explain instead of the actual query results. A query explain can be used to gather insights about the query execution such as planning decisions, time spent on each operator, solutions flowing etc.

queryTimeoutMillisecondsinteger

Specifies the query timeout duration, in milliseconds. (optional)

Response

Success

payloadstring required

The query results.