Examples

Index > DocDB > Examples

Auto-generated documentation for DocDB type annotations stubs module types-aiobotocore-docdb.

Client

Implicit type annotations

Can be used with types-aiobotocore[docdb] package installed.

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

# DocDBClient usage example

from aiobotocore.session import get_session


session = get_session()

async with session.create_client("docdb") as client:  # (1)
    result = await client.add_source_identifier_to_subscription()  # (2)

1. client: DocDBClient
2. result: AddSourceIdentifierToSubscriptionResultTypeDef

# DescribeCertificatesPaginator usage example

from aiobotocore.session import get_session


session = get_session()

async with session.create_client("docdb") as client:  # (1)
    paginator = client.get_paginator("describe_certificates")  # (2)
    async for item in paginator.paginate(...):
        print(item)  # (3)

1. client: DocDBClient
2. paginator: DescribeCertificatesPaginator
3. item: CertificateMessageTypeDef

# DBInstanceAvailableWaiter usage example

from aiobotocore.session import get_session


session = get_session()

async with session.create_client("docdb") as client:  # (1)
    waiter = client.get_waiter("db_instance_available")  # (2)
    await waiter.wait()

1. client: DocDBClient
2. waiter: DBInstanceAvailableWaiter

Explicit type annotations

With types-aiobotocore-lite[docdb] or a standalone types_aiobotocore_docdb package, you have to explicitly specify client: DocDBClient 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.

# DocDBClient usage example with type annotations

from aiobotocore.session import get_session

from types_aiobotocore_docdb.client import DocDBClient
from types_aiobotocore_docdb.type_defs import AddSourceIdentifierToSubscriptionResultTypeDef
from types_aiobotocore_docdb.type_defs import AddSourceIdentifierToSubscriptionMessageRequestTypeDef


session = get_session()

async with session.create_client("docdb") as client:
    client: DocDBClient
    kwargs: AddSourceIdentifierToSubscriptionMessageRequestTypeDef = {...}
    result: AddSourceIdentifierToSubscriptionResultTypeDef = await client.add_source_identifier_to_subscription(**kwargs)

# DescribeCertificatesPaginator usage example with type annotations

from aiobotocore.session import get_session

from types_aiobotocore_docdb.client import DocDBClient
from types_aiobotocore_docdb.paginator import DescribeCertificatesPaginator
from types_aiobotocore_docdb.type_defs import CertificateMessageTypeDef


session = get_session()

async with session.create_client("docdb") as client:
    client: DocDBClient
    paginator: DescribeCertificatesPaginator = client.get_paginator("describe_certificates")
    async for item in paginator.paginate(...):
        item: CertificateMessageTypeDef
        print(item)

# DBInstanceAvailableWaiter usage example with type annotations

from aiobotocore.session import get_session

from types_aiobotocore_docdb.client import DocDBClient
from types_aiobotocore_docdb.waiter import DBInstanceAvailableWaiter


session = get_session()

async with session.create_client("docdb") as client:
    client: DocDBClient
    waiter: DBInstanceAvailableWaiter = client.get_waiter("db_instance_available")
    await waiter.wait()