Skip to content

NeptuneGraph module#

Index > NeptuneGraph

Auto-generated documentation for NeptuneGraph type annotations stubs module mypy-boto3-neptune-graph.

How to install#

You can generate type annotations for boto3 package locally with mypy_boto3_builder. Use uv for build isolation.

  1. Run mypy-boto3-builder in your package root directory: uvx --with 'boto3==1.35.86' mypy_boto3_builder
  2. Select boto3-stubs AWS SDK.
  3. Add NeptuneGraph service.
  4. Use provided commands to install generated packages.

VSCode extension#

Add AWS Boto3 extension to your VSCode and run AWS boto3: Quick Start command.

Click Modify and select boto3 common and NeptuneGraph.

From PyPI with pip#

Install boto3-stubs for NeptuneGraph service.

# install with boto3 type annotations
python -m pip install 'boto3-stubs[neptune-graph]'

# Lite version does not provide session.client/resource overloads
# it is more RAM-friendly, but requires explicit type annotations
python -m pip install 'boto3-stubs-lite[neptune-graph]'

# standalone installation
python -m pip install mypy-boto3-neptune-graph

How to uninstall#

python -m pip uninstall -y mypy-boto3-neptune-graph

Usage#

Code samples can be found in Examples.

NeptuneGraphClient#

Type annotations and code completion for boto3.client("neptune-graph") as NeptuneGraphClient boto3 documentation

# NeptuneGraphClient usage example

from boto3.session import Session

from mypy_boto3_neptune_graph.client import NeptuneGraphClient

def get_client() -> NeptuneGraphClient:
    return Session().client("neptune-graph")

Paginators#

Type annotations and code completion for paginators from boto3.client("neptune-graph").get_paginator("...").

# ListExportTasksPaginator usage example

from boto3.session import Session

from mypy_boto3_neptune_graph.paginator import ListExportTasksPaginator

def get_list_export_tasks_paginator() -> ListExportTasksPaginator:
    return Session().client("neptune-graph").get_paginator("list_export_tasks"))

Waiters#

Type annotations and code completion for waiters from boto3.client("neptune-graph").get_waiter("...").

# ExportTaskCancelledWaiter usage example

from boto3.session import Session

from mypy_boto3_neptune_graph.waiter import ExportTaskCancelledWaiter

def get_export_task_cancelled_waiter() -> ExportTaskCancelledWaiter:
    return Session().client("neptune-graph").get_waiter("export_task_cancelled")

Literals#

Type annotations for literals used in methods and schema.

# BlankNodeHandlingType usage example

from mypy_boto3_neptune_graph.literals import BlankNodeHandlingType

def get_value() -> BlankNodeHandlingType:
    return "convertToIri"

Type definitions#

Type annotations for type definitions used in methods and schema.