Examples

Index > NeptuneGraph > Examples

Auto-generated documentation for NeptuneGraph type annotations stubs module types-aiobotocore-neptune-graph.

Client

Implicit type annotations

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

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

# NeptuneGraphClient usage example

from aioboto3.session import Session


session = Session()

async with session.client("neptune-graph") as client:  # (1)
    result = await client.cancel_import_task()  # (2)

1. client: NeptuneGraphClient
2. result: CancelImportTaskOutputTypeDef

# ListGraphSnapshotsPaginator usage example

from aioboto3.session import Session


session = Session()

async with session.client("neptune-graph") as client:  # (1)
    paginator = client.get_paginator("list_graph_snapshots")  # (2)
    async for item in paginator.paginate(...):
        print(item)  # (3)

1. client: NeptuneGraphClient
2. paginator: ListGraphSnapshotsPaginator
3. item: ListGraphSnapshotsOutputTypeDef

# GraphAvailableWaiter usage example

from aioboto3.session import Session


session = Session()

async with session.client("neptune-graph") as client:  # (1)
    waiter = client.get_waiter("graph_available")  # (2)
    await waiter.wait()

1. client: NeptuneGraphClient
2. waiter: GraphAvailableWaiter

Explicit type annotations

With types-aioboto3-lite[neptune-graph] or a standalone types_aiobotocore_neptune_graph package, you have to explicitly specify client: NeptuneGraphClient 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.

# NeptuneGraphClient usage example with type annotations

from aioboto3.session import Session

from types_aiobotocore_neptune_graph.client import NeptuneGraphClient
from types_aiobotocore_neptune_graph.type_defs import CancelImportTaskOutputTypeDef
from types_aiobotocore_neptune_graph.type_defs import CancelImportTaskInputRequestTypeDef


session = Session()

client: NeptuneGraphClient
async with session.client("neptune-graph") as client:  # (1)
    kwargs: CancelImportTaskInputRequestTypeDef = {...}  # (2)
    result: CancelImportTaskOutputTypeDef = await client.cancel_import_task(**kwargs)  # (3)

1. client: NeptuneGraphClient
2. kwargs: CancelImportTaskInputRequestTypeDef
3. result: CancelImportTaskOutputTypeDef

# ListGraphSnapshotsPaginator usage example with type annotations

from aioboto3.session import Session

from types_aiobotocore_neptune_graph.client import NeptuneGraphClient
from types_aiobotocore_neptune_graph.paginator import ListGraphSnapshotsPaginator
from types_aiobotocore_neptune_graph.type_defs import ListGraphSnapshotsOutputTypeDef


session = Session()

client: NeptuneGraphClient
async with session.client("neptune-graph") as client:  # (1)
    paginator: ListGraphSnapshotsPaginator = client.get_paginator("list_graph_snapshots")  # (2)
    async for item in paginator.paginate(...):
        item: ListGraphSnapshotsOutputTypeDef
        print(item)  # (3)

1. client: NeptuneGraphClient
2. paginator: ListGraphSnapshotsPaginator
3. item: ListGraphSnapshotsOutputTypeDef

# GraphAvailableWaiter usage example with type annotations

from aioboto3.session import Session

from types_aiobotocore_neptune_graph.client import NeptuneGraphClient
from types_aiobotocore_neptune_graph.waiter import GraphAvailableWaiter


session = Session()

async with session.client("neptune-graph") as client:  # (1)
    waiter = client.get_waiter("graph_available")  # (2)
    await waiter.wait()

1. client: NeptuneGraphClient
2. waiter: GraphAvailableWaiter