AWS neptune documentation change
Summary
Expanded documentation for cancelling Gremlin queries to include multiple methods (AWS CLI, SDK, awscurl, and curl) with examples for each approach, and added a note about using awscurl with IAM authentication.
Security assessment
The changes add documentation about using awscurl with IAM authentication for secure connections when cancelling queries, which is a security feature. However, there is no evidence of addressing a specific security vulnerability or incident - this appears to be routine documentation enhancement to provide multiple access methods for query cancellation.
Diff
diff --git a/neptune/latest/userguide/gremlin-api-status-cancel.md b/neptune/latest/userguide/gremlin-api-status-cancel.md index 182e61066..4a138aa47 100644 --- a//neptune/latest/userguide/gremlin-api-status-cancel.md +++ b//neptune/latest/userguide/gremlin-api-status-cancel.md @@ -22 +22,51 @@ To get the status of Gremlin queries, use HTTP `GET` or `POST` to make a request -The following is an example of the `curl` command to cancel a query. +The following is an example of cancelling a query. + +AWS CLI + + + + aws neptunedata cancel-gremlin-query \ + --endpoint-url https://your-neptune-endpoint:port \ + --query-id "fb34cd3e-f37c-4d12-9cf2-03bb741bf54f" + +For more information, see [cancel-gremlin-query](https://docs.aws.amazon.com/cli/latest/reference/neptunedata/cancel-gremlin-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.cancel_gremlin_query( + queryId='fb34cd3e-f37c-4d12-9cf2-03bb741bf54f' + ) + + print(response) + +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/status \ + --region us-east-1 \ + --service neptune-db \ + --data-urlencode "cancelQuery" \ + --data-urlencode "queryId=fb34cd3e-f37c-4d12-9cf2-03bb741bf54f" + +###### 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 +