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-aioboto3[docdb] package installed.

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

ClientPaginatorsWaiters

Client usage example

from aioboto3.session import Session


session = Session()

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

1. client: DocDBClient
2. result: AddSourceIdentifierToSubscriptionResultTypeDef

Paginator usage example

from aioboto3.session import Session


session = Session()

async with session.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

Waiter usage example

from aioboto3.session import Session


session = Session()

async with session.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-aioboto3-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.

ClientPaginatorsWaiters

Client usage example

from aioboto3.session import 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 = Session()

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

1. client: DocDBClient
2. kwargs: AddSourceIdentifierToSubscriptionMessageRequestTypeDef
3. result: AddSourceIdentifierToSubscriptionResultTypeDef

Paginator usage example

from aioboto3.session import Session

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


session = Session()

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

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

Waiter usage example

from aioboto3.session import Session

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


session = Session()

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

1. client: DocDBClient
2. waiter: DBInstanceAvailableWaiter