AWS neptune documentation change
Summary
Updated documentation for Neptune OpenCypher status API with comprehensive examples using AWS CLI, SDK, awscurl, and curl. Changed endpoint references from generic 'server:port' to 'your-neptune-endpoint:port' and added detailed authentication/configuration examples.
Security assessment
This change improves documentation clarity and adds multiple client examples but doesn't address any specific security vulnerability or weakness. The updates focus on API usage patterns, endpoint configuration, and authentication setup (mentioning AWS credentials configuration). While authentication is a security concern, this is routine documentation improvement rather than addressing a specific security issue.
Diff
diff --git a/neptune/latest/userguide/access-graph-opencypher-status.md b/neptune/latest/userguide/access-graph-opencypher-status.md index 2518995c7..170593ec4 100644 --- a//neptune/latest/userguide/access-graph-opencypher-status.md +++ b//neptune/latest/userguide/access-graph-opencypher-status.md @@ -71 +71,46 @@ When used with the `DELETE` method, `queryId` always indicates a specific query - curl https://server:port/openCypher/status \ +AWS CLI + + + aws neptunedata get-open-cypher-query-status \ + --endpoint-url https://your-neptune-endpoint:port \ + --include-waiting + +For more information, see [get-open-cypher-query-status](https://docs.aws.amazon.com/cli/latest/reference/neptunedata/get-open-cypher-query-status.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.get_open_cypher_query_status( + includeWaiting=True + ) + + print(response) + +For AWS SDK examples in other languages, see [AWS SDK](./access-graph-opencypher-sdk.html). + +awscurl + + + awscurl https://your-neptune-endpoint:port/openCypher/status \ + --region us-east-1 \ + --service neptune-db \ + -X POST \ + -d "includeWaiting=true" + +###### 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/status \ @@ -84 +129,41 @@ _Response:_ - curl https://server:port/openCypher/status +AWS CLI + + + aws neptunedata get-open-cypher-query-status \ + --endpoint-url https://your-neptune-endpoint:port + +For more information, see [get-open-cypher-query-status](https://docs.aws.amazon.com/cli/latest/reference/neptunedata/get-open-cypher-query-status.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.get_open_cypher_query_status() + + print(response) + +For AWS SDK examples in other languages, see [AWS SDK](./access-graph-opencypher-sdk.html). + +awscurl + + + awscurl https://your-neptune-endpoint:port/openCypher/status \ + --region us-east-1 \ + --service neptune-db + +###### 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/status @@ -96 +181,46 @@ _Response:_ - curl https://server:port/openCypher/status \ +AWS CLI + + + aws neptunedata get-open-cypher-query-status \ + --endpoint-url https://your-neptune-endpoint:port \ + --query-id eadc6eea-698b-4a2f-8554-5270ab17ebee + +For more information, see [get-open-cypher-query-status](https://docs.aws.amazon.com/cli/latest/reference/neptunedata/get-open-cypher-query-status.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.get_open_cypher_query_status( + queryId='eadc6eea-698b-4a2f-8554-5270ab17ebee' + ) + + print(response) + +For AWS SDK examples in other languages, see [AWS SDK](./access-graph-opencypher-sdk.html). + +awscurl + + + awscurl https://your-neptune-endpoint:port/openCypher/status \ + --region us-east-1 \ + --service neptune-db \ + -X POST \ + -d "queryId=eadc6eea-698b-4a2f-8554-5270ab17ebee" + +###### 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/status \ @@ -112,0 +243,46 @@ _Response:_ +AWS CLI + + + aws neptunedata cancel-open-cypher-query \ + --endpoint-url https://your-neptune-endpoint:port \ + --query-id f43ce17b-db01-4d37-a074-c76d1c26d7a9 + +For more information, see [cancel-open-cypher-query](https://docs.aws.amazon.com/cli/latest/reference/neptunedata/cancel-open-cypher-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_open_cypher_query( + queryId='f43ce17b-db01-4d37-a074-c76d1c26d7a9' + ) + + print(response) + +For AWS SDK examples in other languages, see [AWS SDK](./access-graph-opencypher-sdk.html). + +awscurl + + + awscurl https://your-neptune-endpoint:port/openCypher/status \ + --region us-east-1 \ + --service neptune-db \ + -X POST \ + -d "cancelQuery" \ + -d "queryId=f43ce17b-db01-4d37-a074-c76d1c26d7a9" + +###### 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 + + @@ -115 +291 @@ _Response:_ - curl -X POST https://server:port/openCypher/status \ + curl -X POST https://your-neptune-endpoint:port/openCypher/status \ @@ -119,7 +294,0 @@ _Response:_ -_Response:_ - - { - "status" : "200 OK", - "payload" : true - }