DocDB module
Index > DocDB
Auto-generated documentation for DocDB type annotations stubs module mypy-boto3-docdb.
How to install
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
Usage
Code samples can be found in Examples.
DocDBClient
Type annotations and code completion for boto3.client("docdb")
as DocDBClient
boto3 documentation
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("...")
.
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"))
- DescribeCertificatesPaginator
- DescribeDBClusterParameterGroupsPaginator
- DescribeDBClusterParametersPaginator
- DescribeDBClusterSnapshotsPaginator
- DescribeDBClustersPaginator
- DescribeDBEngineVersionsPaginator
- DescribeDBInstancesPaginator
- DescribeDBSubnetGroupsPaginator
- DescribeEventSubscriptionsPaginator
- DescribeEventsPaginator
- DescribeGlobalClustersPaginator
- DescribeOrderableDBInstanceOptionsPaginator
- DescribePendingMaintenanceActionsPaginator
Waiters
Type annotations and code completion for waiters
from boto3.client("docdb").get_waiter("...")
.
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 schemas.
Usage example
from mypy_boto3_docdb.literals import ApplyMethodType
def get_value() -> ApplyMethodType:
return "immediate"
- ApplyMethodType
- DBInstanceAvailableWaiterName
- DBInstanceDeletedWaiterName
- DescribeCertificatesPaginatorName
- DescribeDBClusterParameterGroupsPaginatorName
- DescribeDBClusterParametersPaginatorName
- DescribeDBClusterSnapshotsPaginatorName
- DescribeDBClustersPaginatorName
- DescribeDBEngineVersionsPaginatorName
- DescribeDBInstancesPaginatorName
- DescribeDBSubnetGroupsPaginatorName
- DescribeEventSubscriptionsPaginatorName
- DescribeEventsPaginatorName
- DescribeGlobalClustersPaginatorName
- DescribeOrderableDBInstanceOptionsPaginatorName
- DescribePendingMaintenanceActionsPaginatorName
- SourceTypeType
- DocDBServiceName
- ServiceName
- ResourceServiceName
- PaginatorName
- WaiterName
- RegionName
Typed dictionaries
Type annotations for typed dictionaries used in methods and schema.
Usage example
from mypy_boto3_docdb.type_defs import AddSourceIdentifierToSubscriptionMessageRequestTypeDef
def get_value() -> AddSourceIdentifierToSubscriptionMessageRequestTypeDef:
return {
"SubscriptionName": ...,
"SourceIdentifier": ...,
}
- AddSourceIdentifierToSubscriptionMessageRequestTypeDef
- EventSubscriptionTypeDef
- ResponseMetadataTypeDef
- TagTypeDef
- ApplyPendingMaintenanceActionMessageRequestTypeDef
- AvailabilityZoneTypeDef
- CertificateTypeDef
- CloudwatchLogsExportConfigurationTypeDef
- DBClusterParameterGroupTypeDef
- DBClusterSnapshotTypeDef
- CreateGlobalClusterMessageRequestTypeDef
- DBClusterMemberTypeDef
- ParameterTypeDef
- DBClusterRoleTypeDef
- DBClusterSnapshotAttributeTypeDef
- VpcSecurityGroupMembershipTypeDef
- UpgradeTargetTypeDef
- DBInstanceStatusInfoTypeDef
- EndpointTypeDef
- DeleteDBClusterMessageRequestTypeDef
- DeleteDBClusterParameterGroupMessageRequestTypeDef
- DeleteDBClusterSnapshotMessageRequestTypeDef
- DeleteDBInstanceMessageRequestTypeDef
- DeleteDBSubnetGroupMessageRequestTypeDef
- DeleteEventSubscriptionMessageRequestTypeDef
- DeleteGlobalClusterMessageRequestTypeDef
- FilterTypeDef
- PaginatorConfigTypeDef
- DescribeDBClusterSnapshotAttributesMessageRequestTypeDef
- WaiterConfigTypeDef
- EventCategoriesMapTypeDef
- EventTypeDef
- FailoverDBClusterMessageRequestTypeDef
- GlobalClusterMemberTypeDef
- ModifyDBClusterSnapshotAttributeMessageRequestTypeDef
- ModifyDBInstanceMessageRequestTypeDef
- ModifyDBSubnetGroupMessageRequestTypeDef
- ModifyEventSubscriptionMessageRequestTypeDef
- ModifyGlobalClusterMessageRequestTypeDef
- PendingCloudwatchLogsExportsTypeDef
- PendingMaintenanceActionTypeDef
- RebootDBInstanceMessageRequestTypeDef
- RemoveFromGlobalClusterMessageRequestTypeDef
- RemoveSourceIdentifierFromSubscriptionMessageRequestTypeDef
- RemoveTagsFromResourceMessageRequestTypeDef
- StartDBClusterMessageRequestTypeDef
- StopDBClusterMessageRequestTypeDef
- AddSourceIdentifierToSubscriptionResultTypeDef
- CreateEventSubscriptionResultTypeDef
- DBClusterParameterGroupNameMessageTypeDef
- DeleteEventSubscriptionResultTypeDef
- EmptyResponseMetadataTypeDef
- EventSubscriptionsMessageTypeDef
- ModifyEventSubscriptionResultTypeDef
- RemoveSourceIdentifierFromSubscriptionResultTypeDef
- AddTagsToResourceMessageRequestTypeDef
- CopyDBClusterParameterGroupMessageRequestTypeDef
- CopyDBClusterSnapshotMessageRequestTypeDef
- CreateDBClusterMessageRequestTypeDef
- CreateDBClusterParameterGroupMessageRequestTypeDef
- CreateDBClusterSnapshotMessageRequestTypeDef
- CreateDBInstanceMessageRequestTypeDef
- CreateDBSubnetGroupMessageRequestTypeDef
- CreateEventSubscriptionMessageRequestTypeDef
- RestoreDBClusterFromSnapshotMessageRequestTypeDef
- RestoreDBClusterToPointInTimeMessageRequestTypeDef
- TagListMessageTypeDef
- OrderableDBInstanceOptionTypeDef
- SubnetTypeDef
- CertificateMessageTypeDef
- ModifyDBClusterMessageRequestTypeDef
- CopyDBClusterParameterGroupResultTypeDef
- CreateDBClusterParameterGroupResultTypeDef
- DBClusterParameterGroupsMessageTypeDef
- CopyDBClusterSnapshotResultTypeDef
- CreateDBClusterSnapshotResultTypeDef
- DBClusterSnapshotMessageTypeDef
- DeleteDBClusterSnapshotResultTypeDef
- DBClusterParameterGroupDetailsTypeDef
- EngineDefaultsTypeDef
- ModifyDBClusterParameterGroupMessageRequestTypeDef
- ResetDBClusterParameterGroupMessageRequestTypeDef
- DBClusterSnapshotAttributesResultTypeDef
- DBClusterTypeDef
- DBEngineVersionTypeDef
- DescribeCertificatesMessageRequestTypeDef
- DescribeDBClusterParameterGroupsMessageRequestTypeDef
- DescribeDBClusterParametersMessageRequestTypeDef
- DescribeDBClusterSnapshotsMessageRequestTypeDef
- DescribeDBClustersMessageRequestTypeDef
- DescribeDBEngineVersionsMessageRequestTypeDef
- DescribeDBInstancesMessageRequestTypeDef
- DescribeDBSubnetGroupsMessageRequestTypeDef
- DescribeEngineDefaultClusterParametersMessageRequestTypeDef
- DescribeEventCategoriesMessageRequestTypeDef
- DescribeEventSubscriptionsMessageRequestTypeDef
- DescribeEventsMessageRequestTypeDef
- DescribeGlobalClustersMessageRequestTypeDef
- DescribeOrderableDBInstanceOptionsMessageRequestTypeDef
- DescribePendingMaintenanceActionsMessageRequestTypeDef
- ListTagsForResourceMessageRequestTypeDef
- DescribeCertificatesMessageDescribeCertificatesPaginateTypeDef
- DescribeDBClusterParameterGroupsMessageDescribeDBClusterParameterGroupsPaginateTypeDef
- DescribeDBClusterParametersMessageDescribeDBClusterParametersPaginateTypeDef
- DescribeDBClusterSnapshotsMessageDescribeDBClusterSnapshotsPaginateTypeDef
- DescribeDBClustersMessageDescribeDBClustersPaginateTypeDef
- DescribeDBEngineVersionsMessageDescribeDBEngineVersionsPaginateTypeDef
- DescribeDBInstancesMessageDescribeDBInstancesPaginateTypeDef
- DescribeDBSubnetGroupsMessageDescribeDBSubnetGroupsPaginateTypeDef
- DescribeEventSubscriptionsMessageDescribeEventSubscriptionsPaginateTypeDef
- DescribeEventsMessageDescribeEventsPaginateTypeDef
- DescribeGlobalClustersMessageDescribeGlobalClustersPaginateTypeDef
- DescribeOrderableDBInstanceOptionsMessageDescribeOrderableDBInstanceOptionsPaginateTypeDef
- DescribePendingMaintenanceActionsMessageDescribePendingMaintenanceActionsPaginateTypeDef
- DescribeDBInstancesMessageDBInstanceAvailableWaitTypeDef
- DescribeDBInstancesMessageDBInstanceDeletedWaitTypeDef
- EventCategoriesMessageTypeDef
- EventsMessageTypeDef
- GlobalClusterTypeDef
- PendingModifiedValuesTypeDef
- ResourcePendingMaintenanceActionsTypeDef
- OrderableDBInstanceOptionsMessageTypeDef
- DBSubnetGroupTypeDef
- DescribeEngineDefaultClusterParametersResultTypeDef
- DescribeDBClusterSnapshotAttributesResultTypeDef
- ModifyDBClusterSnapshotAttributeResultTypeDef
- CreateDBClusterResultTypeDef
- DBClusterMessageTypeDef
- DeleteDBClusterResultTypeDef
- FailoverDBClusterResultTypeDef
- ModifyDBClusterResultTypeDef
- RestoreDBClusterFromSnapshotResultTypeDef
- RestoreDBClusterToPointInTimeResultTypeDef
- StartDBClusterResultTypeDef
- StopDBClusterResultTypeDef
- DBEngineVersionMessageTypeDef
- CreateGlobalClusterResultTypeDef
- DeleteGlobalClusterResultTypeDef
- GlobalClustersMessageTypeDef
- ModifyGlobalClusterResultTypeDef
- RemoveFromGlobalClusterResultTypeDef
- ApplyPendingMaintenanceActionResultTypeDef
- PendingMaintenanceActionsMessageTypeDef
- CreateDBSubnetGroupResultTypeDef
- DBInstanceTypeDef
- DBSubnetGroupMessageTypeDef
- ModifyDBSubnetGroupResultTypeDef
- CreateDBInstanceResultTypeDef
- DBInstanceMessageTypeDef
- DeleteDBInstanceResultTypeDef
- ModifyDBInstanceResultTypeDef
- RebootDBInstanceResultTypeDef