AWS neptune documentation change
Summary
Expanded documentation for Neptune DFE statistics operations by adding detailed examples using AWS CLI, SDK, awscurl, and curl for all statistics management functions. Added RDF-specific notes and improved IAM authentication guidance.
Security assessment
The changes enhance documentation of IAM authentication methods for accessing DFE statistics endpoints. They add explicit examples using AWS CLI, SDK, and awscurl with IAM authentication, and reference secure connection methods. However, there's no evidence of a specific security vulnerability being addressed.
Diff
diff --git a/neptune/latest/userguide/neptune-dfe-statistics.md b/neptune/latest/userguide/neptune-dfe-statistics.md index 8c135079f..e168b2b17 100644 --- a//neptune/latest/userguide/neptune-dfe-statistics.md +++ b//neptune/latest/userguide/neptune-dfe-statistics.md @@ -42,2 +41,0 @@ As of [engine release 1.2.1.0](./engine-releases-1.2.1.0.html), the SPARQL stati -In the examples below, `$STATISTICS_ENDPOINT` stands for any of these endpoint URLs. - @@ -63 +61,53 @@ These limits may change. -You can check the current status of DFE statistics using the following `curl` request: +You can check the current status of DFE statistics as follows: + +###### Note + +The following examples use the property graph endpoint and commands. For RDF data, use `get-sparql-statistics` for the AWS CLI, and `/rdf/statistics` for REST endpoints. + +AWS CLI + + + + aws neptunedata get-propertygraph-statistics \ + --endpoint-url https://your-neptune-endpoint:port \ + --region us-east-1 + +###### Note + +Replace `us-east-1` with the Region of your Neptune cluster. You can omit `--region` if you have configured a default Region. + +For more information, see [get-propertygraph-statistics](https://docs.aws.amazon.com/cli/latest/reference/neptunedata/get-propertygraph-statistics.html) in the AWS CLI Command Reference. + +SDK + + + + import boto3 + import json + 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_propertygraph_statistics() + + print(json.dumps(response['payload'], indent=2, default=str)) + +awscurl + + + + awscurl https://your-neptune-endpoint:port/propertygraph/statistics \ + --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. + +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 @@ -66 +116,2 @@ You can check the current status of DFE statistics using the following `curl` re - curl -G "$STATISTICS_ENDPOINT" + + curl -G https://your-neptune-endpoint:port/propertygraph/statistics @@ -148,0 +200,33 @@ You can disable auto-generation as follows: +###### Note + +The following examples use the property graph endpoint and commands. For RDF data, use `manage-sparql-statistics` for the AWS CLI, and `/rdf/statistics` for REST endpoints. + +AWS CLI + + + + aws neptunedata manage-propertygraph-statistics \ + --endpoint-url https://your-neptune-endpoint:port \ + --mode disableAutoCompute + +For more information, see [manage-propertygraph-statistics](https://docs.aws.amazon.com/cli/latest/reference/neptunedata/manage-propertygraph-statistics.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.manage_propertygraph_statistics(mode='disableAutoCompute') + + print(response['status']) + +awscurl + @@ -150 +234,19 @@ You can disable auto-generation as follows: - curl -X POST "$STATISTICS_ENDPOINT" -d '{ "mode" : "disableAutoCompute" }' + + awscurl https://your-neptune-endpoint:port/propertygraph/statistics \ + --region us-east-1 \ + --service neptune-db \ + -X POST \ + -H 'Content-Type: application/json' \ + -d '{"mode":"disableAutoCompute"}' + +###### 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 -d '{ "mode" : "disableAutoCompute" }' https://your-neptune-endpoint:port/propertygraph/statistics @@ -177,0 +280,28 @@ By default, auto-generation of DFE statistics is already enabled when you enable +###### Note + +The following examples use the property graph endpoint and commands. For RDF data, use `manage-sparql-statistics` for the AWS CLI, and `/rdf/statistics` for REST endpoints. + +AWS CLI + + + + aws neptunedata manage-propertygraph-statistics \ + --endpoint-url https://your-neptune-endpoint:port \ + --mode enableAutoCompute + +For more information, see [manage-propertygraph-statistics](https://docs.aws.amazon.com/cli/latest/reference/neptunedata/manage-propertygraph-statistics.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.manage_propertygraph_statistics(mode='enableAutoCompute') @@ -179 +309,24 @@ By default, auto-generation of DFE statistics is already enabled when you enable - curl -X POST "$STATISTICS_ENDPOINT" -d '{ "mode" : "enableAutoCompute" }' + print(response['status']) + +awscurl + + + + awscurl https://your-neptune-endpoint:port/propertygraph/statistics \ + --region us-east-1 \ + --service neptune-db \ + -X POST \ + -H 'Content-Type: application/json' \ + -d '{"mode":"enableAutoCompute"}' + +###### 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 -d '{ "mode" : "enableAutoCompute" }' https://your-neptune-endpoint:port/propertygraph/statistics @@ -193,0 +347,17 @@ You can initiate DFE statistics generation manually as follows: +###### Note + +The following examples use the property graph endpoint and commands. For RDF data, use `manage-sparql-statistics` for the AWS CLI, and `/rdf/statistics` for REST endpoints. + +AWS CLI + + + + aws neptunedata manage-propertygraph-statistics \ + --endpoint-url https://your-neptune-endpoint:port \ + --mode refresh + +For more information, see [manage-propertygraph-statistics](https://docs.aws.amazon.com/cli/latest/reference/neptunedata/manage-propertygraph-statistics.html) in the AWS CLI Command Reference. + +SDK + + @@ -195 +365,36 @@ You can initiate DFE statistics generation manually as follows: - curl -X POST "$STATISTICS_ENDPOINT" -d '{ "mode" : "refresh" }' + import boto3 + import json + from botocore.config import Config +