Skip to content

DocDB module#

Index > DocDB

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

How to install#

You can generate type annotations for aiobotocore package locally with mypy-boto3-builder. Use uv for build isolation.

  1. Run mypy-boto3-builder in your package root directory: uvx --with 'aiobotocore==2.22.0' mypy-boto3-builder
  2. Select aiobotocore AWS SDK.
  3. Add DocDB service.
  4. Use provided commands to install generated packages.

From PyPI with pip#

Install types-aiobotocore for DocDB service.

# install with aiobotocore type annotations
python -m pip install 'types-aiobotocore[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-aiobotocore-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.create_client("docdb") as DocDBClient boto3 documentation

# DocDBClient usage example

from aiobotocore.session import get_session

from types_aiobotocore_docdb.client import DocDBClient


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

Paginators#

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

# DescribeCertificatesPaginator 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.create_client("docdb").get_waiter("...").

# DBInstanceAvailableWaiter 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.

# ApplyMethodType usage example

from types_aiobotocore_docdb.literals import ApplyMethodType

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

Type definitions#

Type annotations for type definitions used in methods and schema.