v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-1443187284.6 KB

Executes an openCypher explain request. See The openCypher explain feature for more information.

When invoking this operation in a Neptune cluster that has IAM authentication enabled, the IAM user or role making the request must have a policy attached that allows the neptune-db:ReadDataViaQuery IAM action in that cluster.

Note that the neptune-db:QueryLanguage:OpenCypher IAM condition key can be used in the policy document to restrict the use of openCypher queries (see Condition keys available in Neptune IAM data-access policy statements).

post/opencypher/explain

Request body

querystring required

The openCypher query string.

parametersstring

The openCypher query parameters.

explain'static' | 'dynamic' | 'details' required

The openCypher <code>explain</code> mode. Can be one of: <code>static</code>, <code>dynamic</code>, or <code>details</code>.

Response

Success

resultsstring required

A text blob containing the openCypher <code>explain</code> results.