Skip to content

DocDB module

Index > DocDB

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

How to install

From PyPI with pip

Install types-aioboto3 for DocDB service.

# install with aioboto3 type annotations
python -m pip install 'types-aioboto3[docdb]'


# Lite version does not provide session.client/resource overloads
# it is more RAM-friendly, but requires explicit type annotations
python -m pip install 'types-aioboto3-lite[docdb]'


# standalone installation
python -m pip install types-aiobotocore-docdb

How to uninstall

python -m pip uninstall -y types-aiobotocore-docdb

Usage

Code samples can be found in Examples.

DocDBClient

Type annotations and code completion for session.client("docdb") as DocDBClient boto3 documentation

Usage example
from aioboto3.session import Session

from types_aiobotocore_docdb.client import DocDBClient


session = Session()
async with session.client("docdb") as client:
    client: DocDBClient

Paginators

Type annotations and code completion for paginators from session.client("docdb").get_paginator("...").

Usage example
from types_aiobotocore_docdb.paginator import DescribeCertificatesPaginator

def get_describe_certificates_paginator() -> DescribeCertificatesPaginator:
    return client.get_paginator("describe_certificates"))

Waiters

Type annotations and code completion for waiters from session.client("docdb").get_waiter("...").

Usage example
from types_aiobotocore_docdb.waiter import DBInstanceAvailableWaiter

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

Literals

Type annotations for literals used in methods and schema.

Usage example
from types_aiobotocore_docdb.literals import ApplyMethodType

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

Typed dictionaries

Type annotations for typed dictionaries used in methods and schema.

Usage example
from types_aiobotocore_docdb.type_defs import AddSourceIdentifierToSubscriptionMessageRequestTypeDef

def get_value() -> AddSourceIdentifierToSubscriptionMessageRequestTypeDef:
    return {
        "SubscriptionName": ...,
        "SourceIdentifier": ...,
    }