DocDBElastic module#
Index > DocDBElastic
Auto-generated documentation for DocDBElastic type annotations stubs module types-aiobotocore-docdb-elastic.
How to install#
Generate locally (recommended)#
You can generate type annotations for aiobotocore
package locally with mypy-boto3-builder
.
Use uv for build isolation.
- Run mypy-boto3-builder in your package root directory:
uvx --with 'aiobotocore==2.23.0' mypy-boto3-builder
- Select
aiobotocore
AWS SDK. - Add
DocDBElastic
service. - Use provided commands to install generated packages.
From PyPI with pip#
Install types-aiobotocore
for DocDBElastic
service.
# install with aiobotocore type annotations
python -m pip install 'types-aiobotocore[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 'types-aiobotocore-lite[docdb-elastic]'
# standalone installation
python -m pip install types-aiobotocore-docdb-elastic
How to uninstall#
python -m pip uninstall -y types-aiobotocore-docdb-elastic
Usage#
Code samples can be found in Examples.
DocDBElasticClient#
Type annotations and code completion for session.create_client("docdb-elastic")
as DocDBElasticClient
boto3 documentation
# DocDBElasticClient usage example
from aiobotocore.session import get_session
from types_aiobotocore_docdb_elastic.client import DocDBElasticClient
session = get_session()
async with session.create_client("docdb-elastic") as client:
client: DocDBElasticClient
Paginators#
Type annotations and code completion for
paginators
from session.create_client("docdb-elastic").get_paginator("...")
.
# ListClusterSnapshotsPaginator usage example
from types_aiobotocore_docdb_elastic.paginator import ListClusterSnapshotsPaginator
def get_list_cluster_snapshots_paginator() -> ListClusterSnapshotsPaginator:
return client.get_paginator("list_cluster_snapshots"))
Literals#
Type annotations for literals used in methods and schema.
# AuthType usage example
from types_aiobotocore_docdb_elastic.literals import AuthType
def get_value() -> AuthType:
return "PLAIN_TEXT"
- AuthType
- ListClusterSnapshotsPaginatorName
- ListClustersPaginatorName
- ListPendingMaintenanceActionsPaginatorName
- OptInTypeType
- SnapshotTypeType
- StatusType
- DocDBElasticServiceName
- ServiceName
- ResourceServiceName
- PaginatorName
Type definitions#
Type annotations for type definitions used in methods and schema.
- ApplyPendingMaintenanceActionInputTypeDef
- ResponseMetadataTypeDef
- ClusterInListTypeDef
- ClusterSnapshotInListTypeDef
- ClusterSnapshotTypeDef
- ShardTypeDef
- CopyClusterSnapshotInputTypeDef
- CreateClusterInputTypeDef
- CreateClusterSnapshotInputTypeDef
- DeleteClusterInputTypeDef
- DeleteClusterSnapshotInputTypeDef
- GetClusterInputTypeDef
- GetClusterSnapshotInputTypeDef
- GetPendingMaintenanceActionInputTypeDef
- PaginatorConfigTypeDef
- ListClusterSnapshotsInputTypeDef
- ListClustersInputTypeDef
- ListPendingMaintenanceActionsInputTypeDef
- ListTagsForResourceRequestTypeDef
- PendingMaintenanceActionDetailsTypeDef
- RestoreClusterFromSnapshotInputTypeDef
- StartClusterInputTypeDef
- StopClusterInputTypeDef
- TagResourceRequestTypeDef
- UntagResourceRequestTypeDef
- UpdateClusterInputTypeDef
- ListTagsForResourceResponseTypeDef
- ListClustersOutputTypeDef
- ListClusterSnapshotsOutputTypeDef
- CopyClusterSnapshotOutputTypeDef
- CreateClusterSnapshotOutputTypeDef
- DeleteClusterSnapshotOutputTypeDef
- GetClusterSnapshotOutputTypeDef
- ClusterTypeDef
- ListClusterSnapshotsInputPaginateTypeDef
- ListClustersInputPaginateTypeDef
- ListPendingMaintenanceActionsInputPaginateTypeDef
- ResourcePendingMaintenanceActionTypeDef
- CreateClusterOutputTypeDef
- DeleteClusterOutputTypeDef
- GetClusterOutputTypeDef
- RestoreClusterFromSnapshotOutputTypeDef
- StartClusterOutputTypeDef
- StopClusterOutputTypeDef
- UpdateClusterOutputTypeDef
- ApplyPendingMaintenanceActionOutputTypeDef
- GetPendingMaintenanceActionOutputTypeDef
- ListPendingMaintenanceActionsOutputTypeDef