AWS neptune documentation change

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

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

Summary

Expanded documentation for the Gremlin profile API to include multiple usage examples in two sections: AWS CLI, SDK (Python), awscurl, and curl. Added comprehensive examples for different query scenarios.

Security assessment

This change adds multiple examples of how to use the Gremlin profile API with different tools (AWS CLI, SDK, awscurl, curl). There is no evidence of addressing a security vulnerability or weakness. The awscurl examples include references to IAM authentication documentation, but this is referencing existing security features rather than adding new ones. The change appears to be routine documentation improvement to provide more comprehensive examples for developers.

Diff

diff --git a/neptune/latest/userguide/gremlin-profile-api.md b/neptune/latest/userguide/gremlin-profile-api.md
index e14e2a3ce..08e4c5149 100644
--- a//neptune/latest/userguide/gremlin-profile-api.md
+++ b//neptune/latest/userguide/gremlin-profile-api.md
@@ -62,0 +63 @@ The following is a sample `profile` query.
+AWS CLI
@@ -64 +65,52 @@ The following is a sample `profile` query.
-    curl -k -X POST https://your-neptune-endpoint:port/gremlin/profile \
+    
+    
+    aws neptunedata execute-gremlin-profile-query \
+      --endpoint-url https://your-neptune-endpoint:port \
+      --gremlin-query 'g.V().hasLabel("airport").has("code", "AUS").emit().repeat(in().simplePath()).times(2).limit(100)' \
+      --serializer "application/vnd.gremlin-v3.0+json"
+
+For more information, see [execute-gremlin-profile-query](https://docs.aws.amazon.com/cli/latest/reference/neptunedata/execute-gremlin-profile-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_profile_query(
+        gremlinQuery='g.V().hasLabel("airport").has("code", "AUS").emit().repeat(in().simplePath()).times(2).limit(100)',
+        serializer='application/vnd.gremlin-v3.0+json'
+    )
+    
+    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/profile \
+      --region us-east-1 \
+      --service neptune-db \
+      -X POST \
+      -d '{"gremlin":"g.V().hasLabel(\"airport\").has(\"code\", \"AUS\").emit().repeat(in().simplePath()).times(2).limit(100)", "profile.serializer":"application/vnd.gremlin-v3.0+json"}'
+
+###### 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/profile \
@@ -207,0 +260,50 @@ Query:
+AWS CLI
+    
+    
+    
+    aws neptunedata execute-gremlin-profile-query \
+      --endpoint-url https://your-neptune-endpoint:port \
+      --gremlin-query "g.withSideEffect('Neptune#useDFE', true).V().has('code', 'ATL').out()"
+
+For more information, see [execute-gremlin-profile-query](https://docs.aws.amazon.com/cli/latest/reference/neptunedata/execute-gremlin-profile-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_profile_query(
+        gremlinQuery="g.withSideEffect('Neptune#useDFE', true).V().has('code', 'ATL').out()"
+    )
+    
+    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/profile \
+      --region us-east-1 \
+      --service neptune-db \
+      -X POST \
+      -d '{"gremlin":"g.withSideEffect('"'"'Neptune#useDFE'"'"', true).V().has('"'"'code'"'"', '"'"'ATL'"'"').out()"}'
+
+###### 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
+    
+    
@@ -209,2 +311,2 @@ Query:
-    curl https://your-neptune-endpoint:port/gremlin/profile \
-      -d "{\"gremlin\": \"g.withSideEffect('Neptune#useDFE', true).V().has('code', 'ATL').out()\"}"
+    curl -X POST https://your-neptune-endpoint:port/gremlin/profile \
+      -d '{"gremlin":"g.withSideEffect('"'"'Neptune#useDFE'"'"', true).V().has('"'"'code'"'"', '"'"'ATL'"'"').out()"}'