Skip to content

Neptune module#

Index > Neptune

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

How to install#

VSCode extension#

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

Click Modify and select boto3 common and Neptune.

From PyPI with pip#

Install boto3-stubs for Neptune service.

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

# 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]'

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

How to uninstall#

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


Code samples can be found in Examples.


Type annotations and code completion for boto3.client("neptune") as NeptuneClient boto3 documentation

# NeptuneClient usage example

from boto3.session import Session

from mypy_boto3_neptune.client import NeptuneClient

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


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

# DescribeDBClusterEndpointsPaginator usage example

from boto3.session import Session

from mypy_boto3_neptune.paginator import DescribeDBClusterEndpointsPaginator

def get_describe_db_cluster_endpoints_paginator() -> DescribeDBClusterEndpointsPaginator:
    return Session().client("neptune").get_paginator("describe_db_cluster_endpoints"))


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

# DBInstanceAvailableWaiter usage example

from boto3.session import Session

from mypy_boto3_neptune.waiter import DBInstanceAvailableWaiter

def get_db_instance_available_waiter() -> DBInstanceAvailableWaiter:
    return Session().client("neptune").get_waiter("db_instance_available")


Type annotations for literals used in methods and schemas.

# ApplyMethodType usage example

from mypy_boto3_neptune.literals import ApplyMethodType

def get_value() -> ApplyMethodType:
    return "immediate"

Typed dictionaries#

Type annotations for typed dictionaries used in methods and schema.

# AddRoleToDBClusterMessageRequestTypeDef usage example

from mypy_boto3_neptune.type_defs import AddRoleToDBClusterMessageRequestTypeDef

def get_value() -> AddRoleToDBClusterMessageRequestTypeDef:
    return {
        "DBClusterIdentifier": ...,
        "RoleArn": ...,