AWS neptune documentation change

Service: neptune · 2026-04-10 · Documentation low

File: neptune/latest/userguide/access-graph-opencypher-explain.md

Summary

Updated documentation to add multiple examples for invoking openCypher explain feature using AWS CLI, SDK, awscurl, and curl with explicit explain modes (dynamic/details) and proper endpoint formatting

Security assessment

The changes are purely documentation improvements showing different ways to invoke the explain feature. No security vulnerabilities, patches, or security features are mentioned. The changes focus on API usage examples, endpoint formatting, and tool-specific syntax without addressing authentication, authorization, vulnerabilities, or security best practices.

Diff

diff --git a/neptune/latest/userguide/access-graph-opencypher-explain.md b/neptune/latest/userguide/access-graph-opencypher-explain.md
index 6de4198dc..68109fa18 100644
--- a//neptune/latest/userguide/access-graph-opencypher-explain.md
+++ b//neptune/latest/userguide/access-graph-opencypher-explain.md
@@ -22 +22 @@ The openCypher `explain` feature is a self-service tool in Amazon Neptune that h
-For example, using `POST`:
+For example, using `POST` with `dynamic` mode:
@@ -23,0 +24 @@ For example, using `POST`:
+AWS CLI
@@ -25,2 +26,40 @@ For example, using `POST`:
-    curl HTTPS://server:port/openCypher \
-      -d "query=MATCH (n) RETURN n LIMIT 1;" \
+    
+    
+    aws neptunedata execute-open-cypher-explain-query \
+      --endpoint-url https://your-neptune-endpoint:port \
+      --open-cypher-query "MATCH (n) RETURN n LIMIT 1" \
+      --explain-mode dynamic
+
+For more information, see [execute-open-cypher-explain-query](https://docs.aws.amazon.com/cli/latest/reference/neptunedata/execute-open-cypher-explain-query.html) in the AWS CLI Command Reference.
+
+SDK
+    
+    
+    
+    import boto3
+    from botocore.config import Config
+    
+    client = boto3.client(
+        'neptunedata',
+        endpoint_url='https://your-neptune-endpoint:port',
+        config=Config(read_timeout=None, retries={'total_max_attempts': 1})
+    )
+    
+    response = client.execute_open_cypher_explain_query(
+        openCypherQuery='MATCH (n) RETURN n LIMIT 1',
+        explainMode='dynamic'
+    )
+    
+    print(response['results'].read().decode('utf-8'))
+
+For AWS SDK examples in other languages, see [AWS SDK](./access-graph-opencypher-sdk.html).
+
+awscurl
+    
+    
+    
+    awscurl https://your-neptune-endpoint:port/openCypher \
+      --region us-east-1 \
+      --service neptune-db \
+      -X POST \
+      -d "query=MATCH (n) RETURN n LIMIT 1" \
@@ -29 +68,5 @@ For example, using `POST`:
-Or, using `GET`:
+###### Note
+
+This example assumes that your AWS credentials are configured in your environment. Replace `us-east-1` with the Region of your Neptune cluster.
+
+curl
@@ -32,2 +75,4 @@ Or, using `GET`:
-    curl -X GET \
-      "HTTPS://server:port/openCypher?query=MATCH%20(n)%20RETURN%20n%20LIMIT%201&explain=dynamic"
+    
+    curl https://your-neptune-endpoint:port/openCypher \
+      -d "query=MATCH (n) RETURN n LIMIT 1" \
+      -d "explain=dynamic"
@@ -156 +201,61 @@ The query plan information that Neptune generates as openCypher explain output c
-The following is a basic example of openCypher `explain` output. The query is a single-node lookup in the air routes dataset for a node with the airport code `ATL` that invokes `explain` using the `details` mode in default ASCII output format:
+The following is a basic example of openCypher `explain` output. The query is a single-node lookup in the air routes dataset for a node with the airport code `ATL` that invokes `explain` using the `details` mode in default ASCII output format.
+
+To invoke `explain` for this query:
+
+AWS CLI
+    
+    
+    
+    aws neptunedata execute-open-cypher-explain-query \
+      --endpoint-url https://your-neptune-endpoint:port \
+      --open-cypher-query "MATCH (n {code: 'ATL'}) RETURN n" \
+      --explain-mode details
+
+For more information, see [execute-open-cypher-explain-query](https://docs.aws.amazon.com/cli/latest/reference/neptunedata/execute-open-cypher-explain-query.html) in the AWS CLI Command Reference.
+
+SDK
+    
+    
+    
+    import boto3
+    from botocore.config import Config
+    
+    client = boto3.client(
+        'neptunedata',
+        endpoint_url='https://your-neptune-endpoint:port',
+        config=Config(read_timeout=None, retries={'total_max_attempts': 1})
+    )
+    
+    response = client.execute_open_cypher_explain_query(
+        openCypherQuery="MATCH (n {code: 'ATL'}) RETURN n",
+        explainMode='details'
+    )
+    
+    print(response['results'].read().decode('utf-8'))
+
+For AWS SDK examples in other languages, see [AWS SDK](./access-graph-opencypher-sdk.html).
+
+awscurl
+    
+    
+    
+    awscurl https://your-neptune-endpoint:port/openCypher \
+      --region us-east-1 \
+      --service neptune-db \
+      -X POST \
+      -d "query=MATCH (n {code: 'ATL'}) RETURN n" \
+      -d "explain=details"
+
+###### Note
+
+This example assumes that your AWS credentials are configured in your environment. Replace `us-east-1` with the Region of your Neptune cluster.
+
+curl
+    
+    
+    
+    curl https://your-neptune-endpoint:port/openCypher \
+      -d "query=MATCH (n {code: 'ATL'}) RETURN n" \
+      -d "explain=details"
+
+The `explain` output:
@@ -159 +263,0 @@ The following is a basic example of openCypher `explain` output. The query is a
-    curl -d "query=MATCH (n {code: 'ATL'}) RETURN n" -k https://localhost:8182/openCypher -d "explain=details"                                                                                                      ~