Examples

Index > Neptune > Examples

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

Client

Implicit type annotations

Can be used with types-boto3[neptune] package installed.

Write your Neptune code as usual, type checking and code completion should work out of the box.

Client method usage example

# NeptuneClient usage example

from boto3.session import Session


session = Session()

client = session.client("neptune")  # (1)
result = client.add_role_to_db_cluster()  # (2)

1. client: NeptuneClient
2. result: EmptyResponseMetadataTypeDef

Paginator usage example

# DescribeDBClusterEndpointsPaginator usage example

from boto3.session import Session


session = Session()
client = session.client("neptune")  # (1)

paginator = client.get_paginator("describe_db_cluster_endpoints")  # (2)
for item in paginator.paginate(...):
    print(item)  # (3)

1. client: NeptuneClient
2. paginator: DescribeDBClusterEndpointsPaginator
3. item: DBClusterEndpointMessageTypeDef

Waiter usage example

# DBInstanceAvailableWaiter usage example

from boto3.session import Session


session = Session()
client = session.client("neptune")  # (1)

waiter = client.get_waiter("db_instance_available")  # (2)
waiter.wait(...)

1. client: NeptuneClient
2. waiter: DBInstanceAvailableWaiter

Explicit type annotations

With types-boto3-lite[neptune] or a standalone types_boto3_neptune package, you have to explicitly specify client: NeptuneClient type annotation.

All other type annotations are optional, as types should be discovered automatically. However, these type annotations can be helpful in your functions and methods.

Client method usage example

# NeptuneClient usage example with type annotations

from boto3.session import Session

from types_boto3_neptune.client import NeptuneClient
from types_boto3_neptune.type_defs import EmptyResponseMetadataTypeDef
from types_boto3_neptune.type_defs import AddRoleToDBClusterMessageTypeDef


session = Session()

client: NeptuneClient = session.client("neptune")

kwargs: AddRoleToDBClusterMessageTypeDef = {...}
result: EmptyResponseMetadataTypeDef = client.add_role_to_db_cluster(**kwargs)

Paginator usage example

# DescribeDBClusterEndpointsPaginator usage example with type annotations

from boto3.session import Session

from types_boto3_neptune.client import NeptuneClient
from types_boto3_neptune.paginator import DescribeDBClusterEndpointsPaginator
from types_boto3_neptune.type_defs import DBClusterEndpointMessageTypeDef


session = Session()
client: NeptuneClient = session.client("neptune")

paginator: DescribeDBClusterEndpointsPaginator = client.get_paginator("describe_db_cluster_endpoints")
for item in paginator.paginate(...):
    item: DBClusterEndpointMessageTypeDef
    print(item)

Waiter usage example

# DBInstanceAvailableWaiter usage example with type annotations

from boto3.session import Session

from types_boto3_neptune.client import NeptuneClient
from types_boto3_neptune.waiter import DBInstanceAvailableWaiter

session = Session()
client: NeptuneClient = session.client("neptune")

waiter: DBInstanceAvailableWaiter = client.get_waiter("db_instance_available")
waiter.wait(...)