> For the complete documentation index, see [llms.txt](https://docs.stackai.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.stackai.com/integrations/catalog/aws-neptune.md).

# AWS Neptune

Connect to Amazon Neptune graph database. Query property graphs with openCypher, Gremlin, or RDF graphs with SPARQL. Retrieve graph schemas, statistics, and manage queries.

### Connectors

Choose the connector that matches your authentication method. The options below use the names shown in StackAI.

| Connector   | Authentication |
| ----------- | -------------- |
| AWS Neptune | Credentials    |

#### AWS Neptune

Connect to Amazon Neptune graph database using AWS IAM credentials. Supports openCypher, Gremlin, and SPARQL query languages.

**Set up in AWS Neptune**

1. In the AWS console, create (or reuse) an IAM user or role that has permission to access your Neptune cluster (for example the `neptune-db:*` data-access actions) and note its access key ID and secret access key.
2. Confirm IAM database authentication is enabled on the Neptune cluster and record the cluster endpoint, port, and AWS region.

**Set up in StackAI**

1. Open **Settings → Connections**, add a connection, and select **AWS Neptune**.
2. Enter the credentials and connection details in the fields below.
3. Save the connection and check its connection status. Select this saved connection when configuring an action or feature that uses it.

**Connection fields**

| StackAI field         | Required                 | What to enter                                                                                              |
| --------------------- | ------------------------ | ---------------------------------------------------------------------------------------------------------- |
| Neptune Endpoint      | Yes                      | Neptune cluster endpoint (hostname or full URL). Protocol and port will be added automatically if missing. |
| AWS Region            | Yes                      | AWS region where Neptune cluster is deployed (e.g., us-east-1).                                            |
| AWS Access Key ID     | Yes                      | IAM access key with Neptune permissions.                                                                   |
| AWS Secret Access Key | Yes                      | The secret key paired with your Access Key ID.                                                             |
| AWS Session Token     | Optional / as applicable | Optional session token for temporary credentials (from STS assume role, etc.).                             |

**Provider documentation:** [Setup reference](https://docs.aws.amazon.com/neptune/latest/userguide/iam-auth.html).

#### Verify the connection

Check that the connection is healthy. Then run a read operation against a resource the connected account can access. A successful connection check confirms authentication; it does not guarantee permission for every action.

If access is denied, check the credential or OAuth permissions, the selected account or environment, and access to the specific resource. Update expired credentials or reconnect after permissions change.

### Use an action

1. Add the required **AWS Neptune** action to the workflow.
2. Select a connection when the action requests one.
3. Complete the required fields. Use the reference picker when a value comes from another workflow step.
4. Run the workflow and inspect the action’s output. Check the result before using it in a later step.

### Actions

#### Get Property Graph Schema

Retrieve the property graph schema from Amazon Neptune

**Inputs**

No input fields are required in this catalog entry.

**Outputs**

| Field  | Type   | Description                                                                   |
| ------ | ------ | ----------------------------------------------------------------------------- |
| Schema | string | The property graph schema including node labels, edge labels, and properties. |

#### Get RDF Graph Schema

Retrieve the RDF graph schema from Amazon Neptune

**Inputs**

No input fields are required in this catalog entry.

**Outputs**

| Field  | Type   | Description                                            |
| ------ | ------ | ------------------------------------------------------ |
| Schema | string | The RDF graph schema including classes and predicates. |

#### Execute openCypher Query

Execute an openCypher query against Amazon Neptune

**Inputs**

| Field            | Type   | Required | Description                                      |
| ---------------- | ------ | -------- | ------------------------------------------------ |
| openCypher Query | string | Yes      | The openCypher query to execute against Neptune. |

**Outputs**

| Field   | Type   | Description                |
| ------- | ------ | -------------------------- |
| Results | string | The query results as JSON. |

#### Execute SPARQL Query

Execute a SPARQL query against Amazon Neptune

**Inputs**

| Field        | Type   | Required | Description                                  |
| ------------ | ------ | -------- | -------------------------------------------- |
| SPARQL Query | string | Yes      | The SPARQL query to execute against Neptune. |

**Outputs**

| Field   | Type   | Description                |
| ------- | ------ | -------------------------- |
| Results | string | The query results as JSON. |

#### Execute Gremlin Query

Execute a Gremlin traversal query against Amazon Neptune

**Inputs**

| Field         | Type   | Required | Description                                             |
| ------------- | ------ | -------- | ------------------------------------------------------- |
| Gremlin Query | string | Yes      | The Gremlin traversal query to execute against Neptune. |

**Outputs**

| Field   | Type   | Description                |
| ------- | ------ | -------------------------- |
| Results | string | The query results as JSON. |

#### Cancel openCypher Query

Cancel a running openCypher query on Amazon Neptune

**Inputs**

| Field    | Type   | Required | Description                               |
| -------- | ------ | -------- | ----------------------------------------- |
| Query ID | string | Yes      | The ID of the openCypher query to cancel. |

**Outputs**

| Field  | Type   | Description              |
| ------ | ------ | ------------------------ |
| Result | string | The cancellation status. |

#### Cancel Gremlin Query

Cancel a running Gremlin query on Amazon Neptune

**Inputs**

| Field    | Type   | Required | Description                            |
| -------- | ------ | -------- | -------------------------------------- |
| Query ID | string | Yes      | The ID of the Gremlin query to cancel. |

**Outputs**

| Field  | Type   | Description              |
| ------ | ------ | ------------------------ |
| Result | string | The cancellation status. |

#### List openCypher Queries

List active openCypher queries on Amazon Neptune

**Inputs**

No input fields are required in this catalog entry.

**Outputs**

| Field          | Type   | Description                                                         |
| -------------- | ------ | ------------------------------------------------------------------- |
| Active Queries | string | List of active openCypher queries with their status and statistics. |

#### List Gremlin Queries

List active Gremlin queries on Amazon Neptune

**Inputs**

No input fields are required in this catalog entry.

**Outputs**

| Field          | Type   | Description                                                      |
| -------------- | ------ | ---------------------------------------------------------------- |
| Active Queries | string | List of active Gremlin queries with their status and statistics. |

#### Get Property Graph Statistics

Retrieve property graph statistics from Amazon Neptune

**Inputs**

No input fields are required in this catalog entry.

**Outputs**

| Field      | Type   | Description                                                                |
| ---------- | ------ | -------------------------------------------------------------------------- |
| Statistics | string | Property graph statistics including signature counts and predicate counts. |

#### Get SPARQL Statistics

Retrieve SPARQL statistics from Amazon Neptune

**Inputs**

No input fields are required in this catalog entry.

**Outputs**

| Field      | Type   | Description                                                        |
| ---------- | ------ | ------------------------------------------------------------------ |
| Statistics | string | SPARQL statistics including signature counts and predicate counts. |

#### Start Bulk Loader Job

Load data from S3 into Amazon Neptune using the bulk loader

**Inputs**

| Field            | Type   | Required | Description                                                                 |
| ---------------- | ------ | -------- | --------------------------------------------------------------------------- |
| S3 Source        | string | Yes      | S3 URI of the data to load (file, files, or folder).                        |
| Data Format      | string | Yes      | Format of the data: csv, opencypher, ntriples, nquads, rdfxml, or turtle.   |
| S3 Bucket Region | string | Yes      | AWS region of the S3 bucket (must match Neptune cluster region).            |
| IAM Role ARN     | string | Yes      | ARN of the IAM role Neptune assumes to access S3.                           |
| Load Mode        | string | No       | Load mode: AUTO (default), NEW, or RESUME. Default: AUTO.                   |
| Fail on Error    | string | No       | Whether to stop on the first error (TRUE or FALSE). Default: TRUE.          |
| Parallelism      | string | No       | Thread count: LOW, MEDIUM, HIGH (default), or OVERSUBSCRIBE. Default: HIGH. |

**Outputs**

| Field              | Type   | Description                                              |
| ------------------ | ------ | -------------------------------------------------------- |
| Loader Job Details | string | Details of the started loader job including the load ID. |

### Important behavior

Actions that create, update, send, or delete data can change the connected service. Review their inputs before running them. A retry can repeat an operation; consider this when configuring retries for actions that change data.

The catalog lists the fields and capabilities available in the supplied provider definition. Availability can also depend on your deployment and organization’s Feature Access settings.


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.stackai.com/integrations/catalog/aws-neptune.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
