Skip to content

DocDBElastic module#

Index > DocDBElastic

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

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.35.86' mypy_boto3_builder
  2. Select boto3-stubs AWS SDK.
  3. Add DocDBElastic 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 DocDBElastic.

From PyPI with pip#

Install boto3-stubs for DocDBElastic service.

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

# 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-elastic]'

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

How to uninstall#

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

Usage#

Code samples can be found in Examples.

DocDBElasticClient#

Type annotations and code completion for boto3.client("docdb-elastic") as DocDBElasticClient boto3 documentation

# DocDBElasticClient usage example

from boto3.session import Session

from mypy_boto3_docdb_elastic.client import DocDBElasticClient

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

Paginators#

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

# ListClusterSnapshotsPaginator usage example

from boto3.session import Session

from mypy_boto3_docdb_elastic.paginator import ListClusterSnapshotsPaginator

def get_list_cluster_snapshots_paginator() -> ListClusterSnapshotsPaginator:
    return Session().client("docdb-elastic").get_paginator("list_cluster_snapshots"))

Literals#

Type annotations for literals used in methods and schema.

# AuthType usage example

from mypy_boto3_docdb_elastic.literals import AuthType

def get_value() -> AuthType:
    return "PLAIN_TEXT"

Type definitions#

Type annotations for type definitions used in methods and schema.