AWS integration guide#

The Neptune-AWS integration lets you initialize Neptune by reading your credentials from AWS Secrets.

The integration exposes the init_run() function that reads the Neptune API token and project name from AWS Secrets Manager instead of environment variables. This makes it smoother to use the Neptune client library in your AWS setup.

Before you start#

Set up your Neptune project, where the runs and metadata will go: Create a Neptune project
Set up an AWS secret with the info of your Neptune account and project: Set up Neptune credentials in AWS Secrets

Installing the integration#

pipconda

Use your preinstalled version of Neptune together with the integration

pip install -U neptune-aws

Install both Neptune + integration

pip install -U "neptune[aws]"

Use your preinstalled version of Neptune together with the integration

conda install -c conda-forge neptune-aws

Install both Neptune + integration

conda install -c conda-forge neptune neptune-aws

Usage#

You can now initialize a Neptune run by passing the name of the secret and an AWS region:

from neptune.integrations.aws import init_run

run = init_run(
    secret="neptune-secret",  # Use your secret name here
    region="us-west-1",  # Use the appropriate region here
)