Skip to content

DocDB module#

Index > DocDB

Auto-generated documentation for DocDB type annotations stubs module mypy-boto3-docdb.

How to install#

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

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

VSCode extension#

Add AWS Boto3 extension to your VSCode and run AWS boto3: Quick Start command.

Click Modify and select boto3 common and DocDB.

From PyPI with pip#

Install boto3-stubs for DocDB service.

# install with boto3 type annotations
python -m pip install 'boto3-stubs[docdb]'

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

# standalone installation
python -m pip install mypy-boto3-docdb

How to uninstall#

python -m pip uninstall -y mypy-boto3-docdb

Usage#

Code samples can be found in Examples.

DocDBClient#

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

# DocDBClient usage example

from boto3.session import Session

from mypy_boto3_docdb.client import DocDBClient

def get_client() -> DocDBClient:
    return Session().client("docdb")

Paginators#

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

# DescribeCertificatesPaginator usage example

from boto3.session import Session

from mypy_boto3_docdb.paginator import DescribeCertificatesPaginator

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

Waiters#

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

# DBInstanceAvailableWaiter usage example

from boto3.session import Session

from mypy_boto3_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 mypy_boto3_docdb.literals import ApplyMethodType

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

Type definitions#

Type annotations for type definitions used in methods and schema.