AWS neptune documentation change

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

File: neptune/latest/userguide/gremlin-explain-api.md

Summary

Expanded documentation for the Gremlin explain API to include multiple usage examples: AWS CLI, SDK (Python), awscurl, and curl. Updated from a single curl example to comprehensive examples with different tools.

Security assessment

This change adds multiple examples of how to use the Gremlin explain API with different tools (AWS CLI, SDK, awscurl, curl). There is no evidence of addressing a security vulnerability or weakness. The awscurl example includes a note about IAM authentication, but this is referencing existing security documentation rather than adding new security features. The change appears to be routine documentation improvement for better developer experience.

Diff

diff --git a/neptune/latest/userguide/gremlin-explain-api.md b/neptune/latest/userguide/gremlin-explain-api.md
index 7858dcee4..8a1bd2fff 100644
--- a//neptune/latest/userguide/gremlin-explain-api.md
+++ b//neptune/latest/userguide/gremlin-explain-api.md
@@ -48 +48 @@ See Example with DFE enabled for a sample report.
-The syntax of the `explain` API is the same as that for the HTTP API for query, except that it uses `/gremlin/explain` as the endpoint instead of `/gremlin`, as in the following example.
+The syntax of the `explain` API is the same as that for the HTTP API for query, except that it uses `/gremlin/explain` as the endpoint instead of `/gremlin`, as in the following examples.
@@ -49,0 +50 @@ The syntax of the `explain` API is the same as that for the HTTP API for query,
+AWS CLI
@@ -51 +52,51 @@ The syntax of the `explain` API is the same as that for the HTTP API for query,
-    curl -X POST https://your-neptune-endpoint:port/gremlin/explain -d '{"gremlin":"g.V().limit(1)"}'
+    
+    
+    aws neptunedata execute-gremlin-explain-query \
+      --endpoint-url https://your-neptune-endpoint:port \
+      --gremlin-query "g.V().limit(1)"
+
+For more information, see [execute-gremlin-explain-query](https://docs.aws.amazon.com/cli/latest/reference/neptunedata/execute-gremlin-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_gremlin_explain_query(
+        gremlinQuery='g.V().limit(1)'
+    )
+    
+    print(response['output'])
+
+For AWS SDK examples in other languages like Java, .NET, and more, see [AWS SDK](./access-graph-gremlin-sdk.html).
+
+awscurl
+    
+    
+    
+    awscurl https://your-neptune-endpoint:port/gremlin/explain \
+      --region us-east-1 \
+      --service neptune-db \
+      -X POST \
+      -d '{"gremlin":"g.V().limit(1)"}'
+
+###### Note
+
+This example assumes that your AWS credentials are configured in your environment. Replace `us-east-1` with the Region of your Neptune cluster.
+
+For more information about using **awscurl** with IAM authentication, see [Using awscurl with temporary credentials to securely connect to a DB cluster with IAM authentication enabled](./iam-auth-connect-command-line.html#iam-auth-connect-awscurl).
+
+curl
+    
+    
+    
+    curl -X POST https://your-neptune-endpoint:port/gremlin/explain \
+      -d '{"gremlin":"g.V().limit(1)"}'