AWS neptune documentation change
Summary
Restructured documentation to emphasize multiple access tools (AWS CLI, SDKs, curl/awscurl, notebooks, drivers) instead of focusing solely on curl. Added security guidance for IAM-authenticated connections and linked to getting started guides.
Security assessment
The change adds explicit instructions for using awscurl or curl 7.75.0+ with --aws-sigv4 for IAM authentication, which enhances security documentation. However, there's no evidence of a specific security vulnerability being addressed - it's a proactive documentation improvement.
Diff
diff --git a/neptune/latest/userguide/get-started-access-graph.md b/neptune/latest/userguide/get-started-access-graph.md index d8426897b..2b9cb1a22 100644 --- a//neptune/latest/userguide/get-started-access-graph.md +++ b//neptune/latest/userguide/get-started-access-graph.md @@ -7 +7 @@ -Setting up curlQuery languages +ToolsQuery languages @@ -11 +11 @@ Setting up curlQuery languages -You can interact with a Amazon Neptune DB cluster after creating a connection. This involves loading data, executing queries, and performing other operations. Most users leverage the `curl` or `awscurl` command-line tools to communicate with the Neptune DB cluster effectively. These tools enable you to send requests, load data, and retrieve results from the graph database, facilitating seamless data management and querying capabilities. +You can interact with a Amazon Neptune DB cluster after establishing network connectivity. If you have not set up access to your cluster yet, see [Connect to a cluster](./get-started-connecting.html). The following sections describe the tools and query languages you can use to load data, run queries, and manage your graph. @@ -13 +13 @@ You can interact with a Amazon Neptune DB cluster after creating a connection. T -## Setting up `curl` to communicate with your Neptune endpoint +## Tools for accessing Neptune @@ -15 +15,11 @@ You can interact with a Amazon Neptune DB cluster after creating a connection. T -As illustrated in many of the examples in this documentation, the [curl](https://curl.haxx.se/) command line tool is a handy option for communicating with your Neptune endpoint. For information about the tool, see the [curl man page](https://curl.haxx.se/docs/manpage.html), and the book _[Everything curl](https://ec.haxx.se/)_. +Neptune supports several tools for submitting queries and managing your graph data: + + * **AWS CLI** – Use the `aws neptunedata` commands to run Gremlin and openCypher queries, check engine status, manage bulk loads, and more. For more information, see [neptunedata](https://docs.aws.amazon.com/cli/latest/reference/neptunedata/) in the AWS CLI Command Reference. + + * **AWS SDKs** – Use the Neptune Data API through the AWS SDKs to run queries programmatically. SDKs are available for [Gremlin](./access-graph-gremlin-sdk.html) and [openCypher](./access-graph-opencypher-sdk.html). + + * **`curl` and `awscurl`** – Use `curl` to submit HTTP requests directly to the Neptune endpoints. If IAM authentication is enabled, use [awscurl](https://github.com/okigan/awscurl) or `curl` 7.75.0+ with the `--aws-sigv4` option to sign requests. For more information, 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). + + * **Neptune notebooks** – Use Neptune notebooks to run interactive queries in a Jupyter environment with built-in visualizations. For more information, see [Using Neptune with graph notebooks](./graph-notebooks.html). + + * **Drivers** – Connect using language-specific drivers for each query language. For Gremlin, use TinkerPop-compliant drivers available from the [Apache TinkerPop project](https://tinkerpop.apache.org/docs/current/reference/#gremlin-drivers-variants). For openCypher, use Bolt protocol drivers as described in [Using the Bolt protocol](./access-graph-opencypher-bolt.html). For SPARQL, use compatible tools such as RDF4J for Java as described in [Java](./access-graph-sparql-java.html). @@ -17 +26,0 @@ As illustrated in many of the examples in this documentation, the [curl](https:/ -To connect using HTTPS (as we recommend and as Neptune requires in most Regions), `curl` needs access to appropriate certificates. To learn how to obtain these certificates and how to format them properly into a certificate authority (CA) certificate store that `curl` can use, see [SSL Certificate Verification](https://curl.haxx.se/docs/sslcerts.html) in the `curl` documentation. @@ -19 +27,0 @@ To connect using HTTPS (as we recommend and as Neptune requires in most Regions) -You can then specify the location of this CA certificate store using the `CURL_CA_BUNDLE` environment variable. On Windows, `curl` automatically looks for it in a file named `curl-ca-bundle.crt`. It looks first in the same directory as `curl.exe` and then elsewhere on the path. For more information, see [SSL Certificate Verification](https://curl.haxx.se/docs/sslcerts.html). @@ -21 +28,0 @@ You can then specify the location of this CA certificate store using the `CURL_C -As long as `curl` can locate the appropriate certificates, it handles HTTPS connections just like HTTP connections, without extra parameters. Examples in this documentation are based on that scenario. @@ -32,0 +40,2 @@ The Neptune implementation of Gremlin has some differences from other implementa +To get started, see [Using Gremlin](./get-started-graph-gremlin.html). + @@ -35 +44,5 @@ The Neptune implementation of Gremlin has some differences from other implementa - * [SPARQL](./access-graph-sparql.html) is a declarative query language for [RDF](https://www.w3.org/2001/sw/wiki/RDF) data, based on the graph pattern matching that is standardized by the World Wide Web Consortium (W3C) and described in [SPARQL 1.1 Overview](https://www.w3.org/TR/sparql11-overview/)) and the [SPARQL 1.1 Query Language](https://www.w3.org/TR/sparql11-query/) specification. +To get started, see [Using openCypher](./get-started-graph-opencypher.html). + + * [SPARQL](./access-graph-sparql.html) is a declarative query language for [RDF](https://www.w3.org/2001/sw/wiki/RDF) data, based on the graph pattern matching that is standardized by the World Wide Web Consortium (W3C) and described in [SPARQL 1.1 Overview](https://www.w3.org/TR/sparql11-overview/) and the [SPARQL 1.1 Query Language](https://www.w3.org/TR/sparql11-query/) specification. + +To get started, see [Using SPARQL](./get-started-graph-sparql.html). @@ -52 +65 @@ Securing access to Neptune -Using Gremlin +Using command-line tools