Skip to content

DocDBClient

Index > DocDB > DocDBClient

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

DocDBClient

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

Usage example
from boto3.session import Session
from mypy_boto3_docdb.client import DocDBClient

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

Exceptions

boto3 client exceptions are generated in runtime. This class provides code completion for boto3.client("docdb").exceptions structure.

Usage example
client = boto3.client("docdb")

try:
    do_something(client)
except (
    client.AuthorizationNotFoundFault,
    client.CertificateNotFoundFault,
    client.ClientError,
    client.DBClusterAlreadyExistsFault,
    client.DBClusterNotFoundFault,
    client.DBClusterParameterGroupNotFoundFault,
    client.DBClusterQuotaExceededFault,
    client.DBClusterSnapshotAlreadyExistsFault,
    client.DBClusterSnapshotNotFoundFault,
    client.DBInstanceAlreadyExistsFault,
    client.DBInstanceNotFoundFault,
    client.DBParameterGroupAlreadyExistsFault,
    client.DBParameterGroupNotFoundFault,
    client.DBParameterGroupQuotaExceededFault,
    client.DBSecurityGroupNotFoundFault,
    client.DBSnapshotAlreadyExistsFault,
    client.DBSnapshotNotFoundFault,
    client.DBSubnetGroupAlreadyExistsFault,
    client.DBSubnetGroupDoesNotCoverEnoughAZs,
    client.DBSubnetGroupNotFoundFault,
    client.DBSubnetGroupQuotaExceededFault,
    client.DBSubnetQuotaExceededFault,
    client.DBUpgradeDependencyFailureFault,
    client.EventSubscriptionQuotaExceededFault,
    client.GlobalClusterAlreadyExistsFault,
    client.GlobalClusterNotFoundFault,
    client.GlobalClusterQuotaExceededFault,
    client.InstanceQuotaExceededFault,
    client.InsufficientDBClusterCapacityFault,
    client.InsufficientDBInstanceCapacityFault,
    client.InsufficientStorageClusterCapacityFault,
    client.InvalidDBClusterSnapshotStateFault,
    client.InvalidDBClusterStateFault,
    client.InvalidDBInstanceStateFault,
    client.InvalidDBParameterGroupStateFault,
    client.InvalidDBSecurityGroupStateFault,
    client.InvalidDBSnapshotStateFault,
    client.InvalidDBSubnetGroupStateFault,
    client.InvalidDBSubnetStateFault,
    client.InvalidEventSubscriptionStateFault,
    client.InvalidGlobalClusterStateFault,
    client.InvalidRestoreFault,
    client.InvalidSubnet,
    client.InvalidVPCNetworkStateFault,
    client.KMSKeyNotAccessibleFault,
    client.ResourceNotFoundFault,
    client.SNSInvalidTopicFault,
    client.SNSNoAuthorizationFault,
    client.SNSTopicArnNotFoundFault,
    client.SharedSnapshotQuotaExceededFault,
    client.SnapshotQuotaExceededFault,
    client.SourceNotFoundFault,
    client.StorageQuotaExceededFault,
    client.StorageTypeNotSupportedFault,
    client.SubnetAlreadyInUse,
    client.SubscriptionAlreadyExistFault,
    client.SubscriptionCategoryNotFoundFault,
    client.SubscriptionNotFoundFault,
) as e:
    print(e)
Type checking example
from mypy_boto3_docdb.client import Exceptions

def handle_error(exc: Exceptions.AuthorizationNotFoundFault) -> None:
    ...

Methods

add_source_identifier_to_subscription

Adds a source identifier to an existing event notification subscription.

Type annotations and code completion for boto3.client("docdb").add_source_identifier_to_subscription method. boto3 documentation

Method definition
def add_source_identifier_to_subscription(
    self,
    *,
    SubscriptionName: str,
    SourceIdentifier: str,
) -> AddSourceIdentifierToSubscriptionResultTypeDef:  # (1)
    ...
  1. See AddSourceIdentifierToSubscriptionResultTypeDef
Usage example with kwargs
kwargs: AddSourceIdentifierToSubscriptionMessageRequestTypeDef = {  # (1)
    "SubscriptionName": ...,
    "SourceIdentifier": ...,
}

parent.add_source_identifier_to_subscription(**kwargs)
  1. See AddSourceIdentifierToSubscriptionMessageRequestTypeDef

add_tags_to_resource

Adds metadata tags to an Amazon DocumentDB resource.

Type annotations and code completion for boto3.client("docdb").add_tags_to_resource method. boto3 documentation

Method definition
def add_tags_to_resource(
    self,
    *,
    ResourceName: str,
    Tags: Sequence[TagTypeDef],  # (1)
) -> EmptyResponseMetadataTypeDef:  # (2)
    ...
  1. See TagTypeDef
  2. See EmptyResponseMetadataTypeDef
Usage example with kwargs
kwargs: AddTagsToResourceMessageRequestTypeDef = {  # (1)
    "ResourceName": ...,
    "Tags": ...,
}

parent.add_tags_to_resource(**kwargs)
  1. See AddTagsToResourceMessageRequestTypeDef

apply_pending_maintenance_action

Applies a pending maintenance action to a resource (for example, to an Amazon DocumentDB instance).

Type annotations and code completion for boto3.client("docdb").apply_pending_maintenance_action method. boto3 documentation

Method definition
def apply_pending_maintenance_action(
    self,
    *,
    ResourceIdentifier: str,
    ApplyAction: str,
    OptInType: str,
) -> ApplyPendingMaintenanceActionResultTypeDef:  # (1)
    ...
  1. See ApplyPendingMaintenanceActionResultTypeDef
Usage example with kwargs
kwargs: ApplyPendingMaintenanceActionMessageRequestTypeDef = {  # (1)
    "ResourceIdentifier": ...,
    "ApplyAction": ...,
    "OptInType": ...,
}

parent.apply_pending_maintenance_action(**kwargs)
  1. See ApplyPendingMaintenanceActionMessageRequestTypeDef

can_paginate

Check if an operation can be paginated.

Type annotations and code completion for boto3.client("docdb").can_paginate method. boto3 documentation

Method definition
def can_paginate(
    self,
    operation_name: str,
) -> bool:
    ...

close

Closes underlying endpoint connections.

Type annotations and code completion for boto3.client("docdb").close method. boto3 documentation

Method definition
def close(
    self,
) -> None:
    ...

copy_db_cluster_parameter_group

Copies the specified cluster parameter group.

Type annotations and code completion for boto3.client("docdb").copy_db_cluster_parameter_group method. boto3 documentation

Method definition
def copy_db_cluster_parameter_group(
    self,
    *,
    SourceDBClusterParameterGroupIdentifier: str,
    TargetDBClusterParameterGroupIdentifier: str,
    TargetDBClusterParameterGroupDescription: str,
    Tags: Sequence[TagTypeDef] = ...,  # (1)
) -> CopyDBClusterParameterGroupResultTypeDef:  # (2)
    ...
  1. See TagTypeDef
  2. See CopyDBClusterParameterGroupResultTypeDef
Usage example with kwargs
kwargs: CopyDBClusterParameterGroupMessageRequestTypeDef = {  # (1)
    "SourceDBClusterParameterGroupIdentifier": ...,
    "TargetDBClusterParameterGroupIdentifier": ...,
    "TargetDBClusterParameterGroupDescription": ...,
}

parent.copy_db_cluster_parameter_group(**kwargs)
  1. See CopyDBClusterParameterGroupMessageRequestTypeDef

copy_db_cluster_snapshot

Copies a snapshot of a cluster.

Type annotations and code completion for boto3.client("docdb").copy_db_cluster_snapshot method. boto3 documentation

Method definition
def copy_db_cluster_snapshot(
    self,
    *,
    SourceDBClusterSnapshotIdentifier: str,
    TargetDBClusterSnapshotIdentifier: str,
    KmsKeyId: str = ...,
    PreSignedUrl: str = ...,
    CopyTags: bool = ...,
    Tags: Sequence[TagTypeDef] = ...,  # (1)
    SourceRegion: str = ...,
) -> CopyDBClusterSnapshotResultTypeDef:  # (2)
    ...
  1. See TagTypeDef
  2. See CopyDBClusterSnapshotResultTypeDef
Usage example with kwargs
kwargs: CopyDBClusterSnapshotMessageRequestTypeDef = {  # (1)
    "SourceDBClusterSnapshotIdentifier": ...,
    "TargetDBClusterSnapshotIdentifier": ...,
}

parent.copy_db_cluster_snapshot(**kwargs)
  1. See CopyDBClusterSnapshotMessageRequestTypeDef

create_db_cluster

Creates a new Amazon DocumentDB cluster.

Type annotations and code completion for boto3.client("docdb").create_db_cluster method. boto3 documentation

Method definition
def create_db_cluster(
    self,
    *,
    DBClusterIdentifier: str,
    Engine: str,
    AvailabilityZones: Sequence[str] = ...,
    BackupRetentionPeriod: int = ...,
    DBClusterParameterGroupName: str = ...,
    VpcSecurityGroupIds: Sequence[str] = ...,
    DBSubnetGroupName: str = ...,
    EngineVersion: str = ...,
    Port: int = ...,
    MasterUsername: str = ...,
    MasterUserPassword: str = ...,
    PreferredBackupWindow: str = ...,
    PreferredMaintenanceWindow: str = ...,
    Tags: Sequence[TagTypeDef] = ...,  # (1)
    StorageEncrypted: bool = ...,
    KmsKeyId: str = ...,
    PreSignedUrl: str = ...,
    EnableCloudwatchLogsExports: Sequence[str] = ...,
    DeletionProtection: bool = ...,
    GlobalClusterIdentifier: str = ...,
    SourceRegion: str = ...,
) -> CreateDBClusterResultTypeDef:  # (2)
    ...
  1. See TagTypeDef
  2. See CreateDBClusterResultTypeDef
Usage example with kwargs
kwargs: CreateDBClusterMessageRequestTypeDef = {  # (1)
    "DBClusterIdentifier": ...,
    "Engine": ...,
}

parent.create_db_cluster(**kwargs)
  1. See CreateDBClusterMessageRequestTypeDef

create_db_cluster_parameter_group

Creates a new cluster parameter group.

Type annotations and code completion for boto3.client("docdb").create_db_cluster_parameter_group method. boto3 documentation

Method definition
def create_db_cluster_parameter_group(
    self,
    *,
    DBClusterParameterGroupName: str,
    DBParameterGroupFamily: str,
    Description: str,
    Tags: Sequence[TagTypeDef] = ...,  # (1)
) -> CreateDBClusterParameterGroupResultTypeDef:  # (2)
    ...
  1. See TagTypeDef
  2. See CreateDBClusterParameterGroupResultTypeDef
Usage example with kwargs
kwargs: CreateDBClusterParameterGroupMessageRequestTypeDef = {  # (1)
    "DBClusterParameterGroupName": ...,
    "DBParameterGroupFamily": ...,
    "Description": ...,
}

parent.create_db_cluster_parameter_group(**kwargs)
  1. See CreateDBClusterParameterGroupMessageRequestTypeDef

create_db_cluster_snapshot

Creates a snapshot of a cluster.

Type annotations and code completion for boto3.client("docdb").create_db_cluster_snapshot method. boto3 documentation

Method definition
def create_db_cluster_snapshot(
    self,
    *,
    DBClusterSnapshotIdentifier: str,
    DBClusterIdentifier: str,
    Tags: Sequence[TagTypeDef] = ...,  # (1)
) -> CreateDBClusterSnapshotResultTypeDef:  # (2)
    ...
  1. See TagTypeDef
  2. See CreateDBClusterSnapshotResultTypeDef
Usage example with kwargs
kwargs: CreateDBClusterSnapshotMessageRequestTypeDef = {  # (1)
    "DBClusterSnapshotIdentifier": ...,
    "DBClusterIdentifier": ...,
}

parent.create_db_cluster_snapshot(**kwargs)
  1. See CreateDBClusterSnapshotMessageRequestTypeDef

create_db_instance

Creates a new instance.

Type annotations and code completion for boto3.client("docdb").create_db_instance method. boto3 documentation

Method definition
def create_db_instance(
    self,
    *,
    DBInstanceIdentifier: str,
    DBInstanceClass: str,
    Engine: str,
    DBClusterIdentifier: str,
    AvailabilityZone: str = ...,
    PreferredMaintenanceWindow: str = ...,
    AutoMinorVersionUpgrade: bool = ...,
    Tags: Sequence[TagTypeDef] = ...,  # (1)
    CopyTagsToSnapshot: bool = ...,
    PromotionTier: int = ...,
    EnablePerformanceInsights: bool = ...,
    PerformanceInsightsKMSKeyId: str = ...,
) -> CreateDBInstanceResultTypeDef:  # (2)
    ...
  1. See TagTypeDef
  2. See CreateDBInstanceResultTypeDef
Usage example with kwargs
kwargs: CreateDBInstanceMessageRequestTypeDef = {  # (1)
    "DBInstanceIdentifier": ...,
    "DBInstanceClass": ...,
    "Engine": ...,
    "DBClusterIdentifier": ...,
}

parent.create_db_instance(**kwargs)
  1. See CreateDBInstanceMessageRequestTypeDef

create_db_subnet_group

Creates a new subnet group.

Type annotations and code completion for boto3.client("docdb").create_db_subnet_group method. boto3 documentation

Method definition
def create_db_subnet_group(
    self,
    *,
    DBSubnetGroupName: str,
    DBSubnetGroupDescription: str,
    SubnetIds: Sequence[str],
    Tags: Sequence[TagTypeDef] = ...,  # (1)
) -> CreateDBSubnetGroupResultTypeDef:  # (2)
    ...
  1. See TagTypeDef
  2. See CreateDBSubnetGroupResultTypeDef
Usage example with kwargs
kwargs: CreateDBSubnetGroupMessageRequestTypeDef = {  # (1)
    "DBSubnetGroupName": ...,
    "DBSubnetGroupDescription": ...,
    "SubnetIds": ...,
}

parent.create_db_subnet_group(**kwargs)
  1. See CreateDBSubnetGroupMessageRequestTypeDef

create_event_subscription

Creates an Amazon DocumentDB event notification subscription.

Type annotations and code completion for boto3.client("docdb").create_event_subscription method. boto3 documentation

Method definition
def create_event_subscription(
    self,
    *,
    SubscriptionName: str,
    SnsTopicArn: str,
    SourceType: str = ...,
    EventCategories: Sequence[str] = ...,
    SourceIds: Sequence[str] = ...,
    Enabled: bool = ...,
    Tags: Sequence[TagTypeDef] = ...,  # (1)
) -> CreateEventSubscriptionResultTypeDef:  # (2)
    ...
  1. See TagTypeDef
  2. See CreateEventSubscriptionResultTypeDef
Usage example with kwargs
kwargs: CreateEventSubscriptionMessageRequestTypeDef = {  # (1)
    "SubscriptionName": ...,
    "SnsTopicArn": ...,
}

parent.create_event_subscription(**kwargs)
  1. See CreateEventSubscriptionMessageRequestTypeDef

create_global_cluster

Creates an Amazon DocumentDB global cluster that can span multiple multiple Amazon Web Services Regions.

Type annotations and code completion for boto3.client("docdb").create_global_cluster method. boto3 documentation

Method definition
def create_global_cluster(
    self,
    *,
    GlobalClusterIdentifier: str,
    SourceDBClusterIdentifier: str = ...,
    Engine: str = ...,
    EngineVersion: str = ...,
    DeletionProtection: bool = ...,
    DatabaseName: str = ...,
    StorageEncrypted: bool = ...,
) -> CreateGlobalClusterResultTypeDef:  # (1)
    ...
  1. See CreateGlobalClusterResultTypeDef
Usage example with kwargs
kwargs: CreateGlobalClusterMessageRequestTypeDef = {  # (1)
    "GlobalClusterIdentifier": ...,
}

parent.create_global_cluster(**kwargs)
  1. See CreateGlobalClusterMessageRequestTypeDef

delete_db_cluster

Deletes a previously provisioned cluster.

Type annotations and code completion for boto3.client("docdb").delete_db_cluster method. boto3 documentation

Method definition
def delete_db_cluster(
    self,
    *,
    DBClusterIdentifier: str,
    SkipFinalSnapshot: bool = ...,
    FinalDBSnapshotIdentifier: str = ...,
) -> DeleteDBClusterResultTypeDef:  # (1)
    ...
  1. See DeleteDBClusterResultTypeDef
Usage example with kwargs
kwargs: DeleteDBClusterMessageRequestTypeDef = {  # (1)
    "DBClusterIdentifier": ...,
}

parent.delete_db_cluster(**kwargs)
  1. See DeleteDBClusterMessageRequestTypeDef

delete_db_cluster_parameter_group

Deletes a specified cluster parameter group.

Type annotations and code completion for boto3.client("docdb").delete_db_cluster_parameter_group method. boto3 documentation

Method definition
def delete_db_cluster_parameter_group(
    self,
    *,
    DBClusterParameterGroupName: str,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...
  1. See EmptyResponseMetadataTypeDef
Usage example with kwargs
kwargs: DeleteDBClusterParameterGroupMessageRequestTypeDef = {  # (1)
    "DBClusterParameterGroupName": ...,
}

parent.delete_db_cluster_parameter_group(**kwargs)
  1. See DeleteDBClusterParameterGroupMessageRequestTypeDef

delete_db_cluster_snapshot

Deletes a cluster snapshot.

Type annotations and code completion for boto3.client("docdb").delete_db_cluster_snapshot method. boto3 documentation

Method definition
def delete_db_cluster_snapshot(
    self,
    *,
    DBClusterSnapshotIdentifier: str,
) -> DeleteDBClusterSnapshotResultTypeDef:  # (1)
    ...
  1. See DeleteDBClusterSnapshotResultTypeDef
Usage example with kwargs
kwargs: DeleteDBClusterSnapshotMessageRequestTypeDef = {  # (1)
    "DBClusterSnapshotIdentifier": ...,
}

parent.delete_db_cluster_snapshot(**kwargs)
  1. See DeleteDBClusterSnapshotMessageRequestTypeDef

delete_db_instance

Deletes a previously provisioned instance.

Type annotations and code completion for boto3.client("docdb").delete_db_instance method. boto3 documentation

Method definition
def delete_db_instance(
    self,
    *,
    DBInstanceIdentifier: str,
) -> DeleteDBInstanceResultTypeDef:  # (1)
    ...
  1. See DeleteDBInstanceResultTypeDef
Usage example with kwargs
kwargs: DeleteDBInstanceMessageRequestTypeDef = {  # (1)
    "DBInstanceIdentifier": ...,
}

parent.delete_db_instance(**kwargs)
  1. See DeleteDBInstanceMessageRequestTypeDef

delete_db_subnet_group

Deletes a subnet group.

Type annotations and code completion for boto3.client("docdb").delete_db_subnet_group method. boto3 documentation

Method definition
def delete_db_subnet_group(
    self,
    *,
    DBSubnetGroupName: str,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...
  1. See EmptyResponseMetadataTypeDef
Usage example with kwargs
kwargs: DeleteDBSubnetGroupMessageRequestTypeDef = {  # (1)
    "DBSubnetGroupName": ...,
}

parent.delete_db_subnet_group(**kwargs)
  1. See DeleteDBSubnetGroupMessageRequestTypeDef

delete_event_subscription

Deletes an Amazon DocumentDB event notification subscription.

Type annotations and code completion for boto3.client("docdb").delete_event_subscription method. boto3 documentation

Method definition
def delete_event_subscription(
    self,
    *,
    SubscriptionName: str,
) -> DeleteEventSubscriptionResultTypeDef:  # (1)
    ...
  1. See DeleteEventSubscriptionResultTypeDef
Usage example with kwargs
kwargs: DeleteEventSubscriptionMessageRequestTypeDef = {  # (1)
    "SubscriptionName": ...,
}

parent.delete_event_subscription(**kwargs)
  1. See DeleteEventSubscriptionMessageRequestTypeDef

delete_global_cluster

Deletes a global cluster.

Type annotations and code completion for boto3.client("docdb").delete_global_cluster method. boto3 documentation

Method definition
def delete_global_cluster(
    self,
    *,
    GlobalClusterIdentifier: str,
) -> DeleteGlobalClusterResultTypeDef:  # (1)
    ...
  1. See DeleteGlobalClusterResultTypeDef
Usage example with kwargs
kwargs: DeleteGlobalClusterMessageRequestTypeDef = {  # (1)
    "GlobalClusterIdentifier": ...,
}

parent.delete_global_cluster(**kwargs)
  1. See DeleteGlobalClusterMessageRequestTypeDef

describe_certificates

Returns a list of certificate authority (CA) certificates provided by Amazon DocumentDB for this Amazon Web Services account.

Type annotations and code completion for boto3.client("docdb").describe_certificates method. boto3 documentation

Method definition
def describe_certificates(
    self,
    *,
    CertificateIdentifier: str = ...,
    Filters: Sequence[FilterTypeDef] = ...,  # (1)
    MaxRecords: int = ...,
    Marker: str = ...,
) -> CertificateMessageTypeDef:  # (2)
    ...
  1. See FilterTypeDef
  2. See CertificateMessageTypeDef
Usage example with kwargs
kwargs: DescribeCertificatesMessageRequestTypeDef = {  # (1)
    "CertificateIdentifier": ...,
}

parent.describe_certificates(**kwargs)
  1. See DescribeCertificatesMessageRequestTypeDef

describe_db_cluster_parameter_groups

Returns a list of DBClusterParameterGroup descriptions.

Type annotations and code completion for boto3.client("docdb").describe_db_cluster_parameter_groups method. boto3 documentation

Method definition
def describe_db_cluster_parameter_groups(
    self,
    *,
    DBClusterParameterGroupName: str = ...,
    Filters: Sequence[FilterTypeDef] = ...,  # (1)
    MaxRecords: int = ...,
    Marker: str = ...,
) -> DBClusterParameterGroupsMessageTypeDef:  # (2)
    ...
  1. See FilterTypeDef
  2. See DBClusterParameterGroupsMessageTypeDef
Usage example with kwargs
kwargs: DescribeDBClusterParameterGroupsMessageRequestTypeDef = {  # (1)
    "DBClusterParameterGroupName": ...,
}

parent.describe_db_cluster_parameter_groups(**kwargs)
  1. See DescribeDBClusterParameterGroupsMessageRequestTypeDef

describe_db_cluster_parameters

Returns the detailed parameter list for a particular cluster parameter group.

Type annotations and code completion for boto3.client("docdb").describe_db_cluster_parameters method. boto3 documentation

Method definition
def describe_db_cluster_parameters(
    self,
    *,
    DBClusterParameterGroupName: str,
    Source: str = ...,
    Filters: Sequence[FilterTypeDef] = ...,  # (1)
    MaxRecords: int = ...,
    Marker: str = ...,
) -> DBClusterParameterGroupDetailsTypeDef:  # (2)
    ...
  1. See FilterTypeDef
  2. See DBClusterParameterGroupDetailsTypeDef
Usage example with kwargs
kwargs: DescribeDBClusterParametersMessageRequestTypeDef = {  # (1)
    "DBClusterParameterGroupName": ...,
}

parent.describe_db_cluster_parameters(**kwargs)
  1. See DescribeDBClusterParametersMessageRequestTypeDef

describe_db_cluster_snapshot_attributes

Returns a list of cluster snapshot attribute names and values for a manual DB cluster snapshot.

Type annotations and code completion for boto3.client("docdb").describe_db_cluster_snapshot_attributes method. boto3 documentation

Method definition
def describe_db_cluster_snapshot_attributes(
    self,
    *,
    DBClusterSnapshotIdentifier: str,
) -> DescribeDBClusterSnapshotAttributesResultTypeDef:  # (1)
    ...
  1. See DescribeDBClusterSnapshotAttributesResultTypeDef
Usage example with kwargs
kwargs: DescribeDBClusterSnapshotAttributesMessageRequestTypeDef = {  # (1)
    "DBClusterSnapshotIdentifier": ...,
}

parent.describe_db_cluster_snapshot_attributes(**kwargs)
  1. See DescribeDBClusterSnapshotAttributesMessageRequestTypeDef

describe_db_cluster_snapshots

Returns information about cluster snapshots.

Type annotations and code completion for boto3.client("docdb").describe_db_cluster_snapshots method. boto3 documentation

Method definition
def describe_db_cluster_snapshots(
    self,
    *,
    DBClusterIdentifier: str = ...,
    DBClusterSnapshotIdentifier: str = ...,
    SnapshotType: str = ...,
    Filters: Sequence[FilterTypeDef] = ...,  # (1)
    MaxRecords: int = ...,
    Marker: str = ...,
    IncludeShared: bool = ...,
    IncludePublic: bool = ...,
) -> DBClusterSnapshotMessageTypeDef:  # (2)
    ...
  1. See FilterTypeDef
  2. See DBClusterSnapshotMessageTypeDef
Usage example with kwargs
kwargs: DescribeDBClusterSnapshotsMessageRequestTypeDef = {  # (1)
    "DBClusterIdentifier": ...,
}

parent.describe_db_cluster_snapshots(**kwargs)
  1. See DescribeDBClusterSnapshotsMessageRequestTypeDef

describe_db_clusters

Returns information about provisioned Amazon DocumentDB clusters.

Type annotations and code completion for boto3.client("docdb").describe_db_clusters method. boto3 documentation

Method definition
def describe_db_clusters(
    self,
    *,
    DBClusterIdentifier: str = ...,
    Filters: Sequence[FilterTypeDef] = ...,  # (1)
    MaxRecords: int = ...,
    Marker: str = ...,
) -> DBClusterMessageTypeDef:  # (2)
    ...
  1. See FilterTypeDef
  2. See DBClusterMessageTypeDef
Usage example with kwargs
kwargs: DescribeDBClustersMessageRequestTypeDef = {  # (1)
    "DBClusterIdentifier": ...,
}

parent.describe_db_clusters(**kwargs)
  1. See DescribeDBClustersMessageRequestTypeDef

describe_db_engine_versions

Returns a list of the available engines.

Type annotations and code completion for boto3.client("docdb").describe_db_engine_versions method. boto3 documentation

Method definition
def describe_db_engine_versions(
    self,
    *,
    Engine: str = ...,
    EngineVersion: str = ...,
    DBParameterGroupFamily: str = ...,
    Filters: Sequence[FilterTypeDef] = ...,  # (1)
    MaxRecords: int = ...,
    Marker: str = ...,
    DefaultOnly: bool = ...,
    ListSupportedCharacterSets: bool = ...,
    ListSupportedTimezones: bool = ...,
) -> DBEngineVersionMessageTypeDef:  # (2)
    ...
  1. See FilterTypeDef
  2. See DBEngineVersionMessageTypeDef
Usage example with kwargs
kwargs: DescribeDBEngineVersionsMessageRequestTypeDef = {  # (1)
    "Engine": ...,
}

parent.describe_db_engine_versions(**kwargs)
  1. See DescribeDBEngineVersionsMessageRequestTypeDef

describe_db_instances

Returns information about provisioned Amazon DocumentDB instances.

Type annotations and code completion for boto3.client("docdb").describe_db_instances method. boto3 documentation

Method definition
def describe_db_instances(
    self,
    *,
    DBInstanceIdentifier: str = ...,
    Filters: Sequence[FilterTypeDef] = ...,  # (1)
    MaxRecords: int = ...,
    Marker: str = ...,
) -> DBInstanceMessageTypeDef:  # (2)
    ...
  1. See FilterTypeDef
  2. See DBInstanceMessageTypeDef
Usage example with kwargs
kwargs: DescribeDBInstancesMessageRequestTypeDef = {  # (1)
    "DBInstanceIdentifier": ...,
}

parent.describe_db_instances(**kwargs)
  1. See DescribeDBInstancesMessageRequestTypeDef

describe_db_subnet_groups

Returns a list of DBSubnetGroup descriptions.

Type annotations and code completion for boto3.client("docdb").describe_db_subnet_groups method. boto3 documentation

Method definition
def describe_db_subnet_groups(
    self,
    *,
    DBSubnetGroupName: str = ...,
    Filters: Sequence[FilterTypeDef] = ...,  # (1)
    MaxRecords: int = ...,
    Marker: str = ...,
) -> DBSubnetGroupMessageTypeDef:  # (2)
    ...
  1. See FilterTypeDef
  2. See DBSubnetGroupMessageTypeDef
Usage example with kwargs
kwargs: DescribeDBSubnetGroupsMessageRequestTypeDef = {  # (1)
    "DBSubnetGroupName": ...,
}

parent.describe_db_subnet_groups(**kwargs)
  1. See DescribeDBSubnetGroupsMessageRequestTypeDef

describe_engine_default_cluster_parameters

Returns the default engine and system parameter information for the cluster database engine.

Type annotations and code completion for boto3.client("docdb").describe_engine_default_cluster_parameters method. boto3 documentation

Method definition
def describe_engine_default_cluster_parameters(
    self,
    *,
    DBParameterGroupFamily: str,
    Filters: Sequence[FilterTypeDef] = ...,  # (1)
    MaxRecords: int = ...,
    Marker: str = ...,
) -> DescribeEngineDefaultClusterParametersResultTypeDef:  # (2)
    ...
  1. See FilterTypeDef
  2. See DescribeEngineDefaultClusterParametersResultTypeDef
Usage example with kwargs
kwargs: DescribeEngineDefaultClusterParametersMessageRequestTypeDef = {  # (1)
    "DBParameterGroupFamily": ...,
}

parent.describe_engine_default_cluster_parameters(**kwargs)
  1. See DescribeEngineDefaultClusterParametersMessageRequestTypeDef

describe_event_categories

Displays a list of categories for all event source types, or, if specified, for a specified source type.

Type annotations and code completion for boto3.client("docdb").describe_event_categories method. boto3 documentation

Method definition
def describe_event_categories(
    self,
    *,
    SourceType: str = ...,
    Filters: Sequence[FilterTypeDef] = ...,  # (1)
) -> EventCategoriesMessageTypeDef:  # (2)
    ...
  1. See FilterTypeDef
  2. See EventCategoriesMessageTypeDef
Usage example with kwargs
kwargs: DescribeEventCategoriesMessageRequestTypeDef = {  # (1)
    "SourceType": ...,
}

parent.describe_event_categories(**kwargs)
  1. See DescribeEventCategoriesMessageRequestTypeDef

describe_event_subscriptions

Lists all the subscription descriptions for a customer account.

Type annotations and code completion for boto3.client("docdb").describe_event_subscriptions method. boto3 documentation

Method definition
def describe_event_subscriptions(
    self,
    *,
    SubscriptionName: str = ...,
    Filters: Sequence[FilterTypeDef] = ...,  # (1)
    MaxRecords: int = ...,
    Marker: str = ...,
) -> EventSubscriptionsMessageTypeDef:  # (2)
    ...
  1. See FilterTypeDef
  2. See EventSubscriptionsMessageTypeDef
Usage example with kwargs
kwargs: DescribeEventSubscriptionsMessageRequestTypeDef = {  # (1)
    "SubscriptionName": ...,
}

parent.describe_event_subscriptions(**kwargs)
  1. See DescribeEventSubscriptionsMessageRequestTypeDef

describe_events

Returns events related to instances, security groups, snapshots, and DB parameter groups for the past 14 days.

Type annotations and code completion for boto3.client("docdb").describe_events method. boto3 documentation

Method definition
def describe_events(
    self,
    *,
    SourceIdentifier: str = ...,
    SourceType: SourceTypeType = ...,  # (1)
    StartTime: Union[datetime, str] = ...,
    EndTime: Union[datetime, str] = ...,
    Duration: int = ...,
    EventCategories: Sequence[str] = ...,
    Filters: Sequence[FilterTypeDef] = ...,  # (2)
    MaxRecords: int = ...,
    Marker: str = ...,
) -> EventsMessageTypeDef:  # (3)
    ...
  1. See SourceTypeType
  2. See FilterTypeDef
  3. See EventsMessageTypeDef
Usage example with kwargs
kwargs: DescribeEventsMessageRequestTypeDef = {  # (1)
    "SourceIdentifier": ...,
}

parent.describe_events(**kwargs)
  1. See DescribeEventsMessageRequestTypeDef

describe_global_clusters

Returns information about Amazon DocumentDB global clusters.

Type annotations and code completion for boto3.client("docdb").describe_global_clusters method. boto3 documentation

Method definition
def describe_global_clusters(
    self,
    *,
    GlobalClusterIdentifier: str = ...,
    Filters: Sequence[FilterTypeDef] = ...,  # (1)
    MaxRecords: int = ...,
    Marker: str = ...,
) -> GlobalClustersMessageTypeDef:  # (2)
    ...
  1. See FilterTypeDef
  2. See GlobalClustersMessageTypeDef
Usage example with kwargs
kwargs: DescribeGlobalClustersMessageRequestTypeDef = {  # (1)
    "GlobalClusterIdentifier": ...,
}

parent.describe_global_clusters(**kwargs)
  1. See DescribeGlobalClustersMessageRequestTypeDef

describe_orderable_db_instance_options

Returns a list of orderable instance options for the specified engine.

Type annotations and code completion for boto3.client("docdb").describe_orderable_db_instance_options method. boto3 documentation

Method definition
def describe_orderable_db_instance_options(
    self,
    *,
    Engine: str,
    EngineVersion: str = ...,
    DBInstanceClass: str = ...,
    LicenseModel: str = ...,
    Vpc: bool = ...,
    Filters: Sequence[FilterTypeDef] = ...,  # (1)
    MaxRecords: int = ...,
    Marker: str = ...,
) -> OrderableDBInstanceOptionsMessageTypeDef:  # (2)
    ...
  1. See FilterTypeDef
  2. See OrderableDBInstanceOptionsMessageTypeDef
Usage example with kwargs
kwargs: DescribeOrderableDBInstanceOptionsMessageRequestTypeDef = {  # (1)
    "Engine": ...,
}

parent.describe_orderable_db_instance_options(**kwargs)
  1. See DescribeOrderableDBInstanceOptionsMessageRequestTypeDef

describe_pending_maintenance_actions

Returns a list of resources (for example, instances) that have at least one pending maintenance action.

Type annotations and code completion for boto3.client("docdb").describe_pending_maintenance_actions method. boto3 documentation

Method definition
def describe_pending_maintenance_actions(
    self,
    *,
    ResourceIdentifier: str = ...,
    Filters: Sequence[FilterTypeDef] = ...,  # (1)
    Marker: str = ...,
    MaxRecords: int = ...,
) -> PendingMaintenanceActionsMessageTypeDef:  # (2)
    ...
  1. See FilterTypeDef
  2. See PendingMaintenanceActionsMessageTypeDef
Usage example with kwargs
kwargs: DescribePendingMaintenanceActionsMessageRequestTypeDef = {  # (1)
    "ResourceIdentifier": ...,
}

parent.describe_pending_maintenance_actions(**kwargs)
  1. See DescribePendingMaintenanceActionsMessageRequestTypeDef

failover_db_cluster

Forces a failover for a cluster.

Type annotations and code completion for boto3.client("docdb").failover_db_cluster method. boto3 documentation

Method definition
def failover_db_cluster(
    self,
    *,
    DBClusterIdentifier: str = ...,
    TargetDBInstanceIdentifier: str = ...,
) -> FailoverDBClusterResultTypeDef:  # (1)
    ...
  1. See FailoverDBClusterResultTypeDef
Usage example with kwargs
kwargs: FailoverDBClusterMessageRequestTypeDef = {  # (1)
    "DBClusterIdentifier": ...,
}

parent.failover_db_cluster(**kwargs)
  1. See FailoverDBClusterMessageRequestTypeDef

generate_presigned_url

Generate a presigned url given a client, its method, and arguments.

Type annotations and code completion for boto3.client("docdb").generate_presigned_url method. boto3 documentation

Method definition
def generate_presigned_url(
    self,
    ClientMethod: str,
    Params: Mapping[str, Any] = ...,
    ExpiresIn: int = 3600,
    HttpMethod: str = ...,
) -> str:
    ...

list_tags_for_resource

Lists all tags on an Amazon DocumentDB resource.

Type annotations and code completion for boto3.client("docdb").list_tags_for_resource method. boto3 documentation

Method definition
def list_tags_for_resource(
    self,
    *,
    ResourceName: str,
    Filters: Sequence[FilterTypeDef] = ...,  # (1)
) -> TagListMessageTypeDef:  # (2)
    ...
  1. See FilterTypeDef
  2. See TagListMessageTypeDef
Usage example with kwargs
kwargs: ListTagsForResourceMessageRequestTypeDef = {  # (1)
    "ResourceName": ...,
}

parent.list_tags_for_resource(**kwargs)
  1. See ListTagsForResourceMessageRequestTypeDef

modify_db_cluster

Modifies a setting for an Amazon DocumentDB cluster.

Type annotations and code completion for boto3.client("docdb").modify_db_cluster method. boto3 documentation

Method definition
def modify_db_cluster(
    self,
    *,
    DBClusterIdentifier: str,
    NewDBClusterIdentifier: str = ...,
    ApplyImmediately: bool = ...,
    BackupRetentionPeriod: int = ...,
    DBClusterParameterGroupName: str = ...,
    VpcSecurityGroupIds: Sequence[str] = ...,
    Port: int = ...,
    MasterUserPassword: str = ...,
    PreferredBackupWindow: str = ...,
    PreferredMaintenanceWindow: str = ...,
    CloudwatchLogsExportConfiguration: CloudwatchLogsExportConfigurationTypeDef = ...,  # (1)
    EngineVersion: str = ...,
    DeletionProtection: bool = ...,
) -> ModifyDBClusterResultTypeDef:  # (2)
    ...
  1. See CloudwatchLogsExportConfigurationTypeDef
  2. See ModifyDBClusterResultTypeDef
Usage example with kwargs
kwargs: ModifyDBClusterMessageRequestTypeDef = {  # (1)
    "DBClusterIdentifier": ...,
}

parent.modify_db_cluster(**kwargs)
  1. See ModifyDBClusterMessageRequestTypeDef

modify_db_cluster_parameter_group

Modifies the parameters of a cluster parameter group.

Type annotations and code completion for boto3.client("docdb").modify_db_cluster_parameter_group method. boto3 documentation

Method definition
def modify_db_cluster_parameter_group(
    self,
    *,
    DBClusterParameterGroupName: str,
    Parameters: Sequence[ParameterTypeDef],  # (1)
) -> DBClusterParameterGroupNameMessageTypeDef:  # (2)
    ...
  1. See ParameterTypeDef
  2. See DBClusterParameterGroupNameMessageTypeDef
Usage example with kwargs
kwargs: ModifyDBClusterParameterGroupMessageRequestTypeDef = {  # (1)
    "DBClusterParameterGroupName": ...,
    "Parameters": ...,
}

parent.modify_db_cluster_parameter_group(**kwargs)
  1. See ModifyDBClusterParameterGroupMessageRequestTypeDef

modify_db_cluster_snapshot_attribute

Adds an attribute and values to, or removes an attribute and values from, a manual cluster snapshot.

Type annotations and code completion for boto3.client("docdb").modify_db_cluster_snapshot_attribute method. boto3 documentation

Method definition
def modify_db_cluster_snapshot_attribute(
    self,
    *,
    DBClusterSnapshotIdentifier: str,
    AttributeName: str,
    ValuesToAdd: Sequence[str] = ...,
    ValuesToRemove: Sequence[str] = ...,
) -> ModifyDBClusterSnapshotAttributeResultTypeDef:  # (1)
    ...
  1. See ModifyDBClusterSnapshotAttributeResultTypeDef
Usage example with kwargs
kwargs: ModifyDBClusterSnapshotAttributeMessageRequestTypeDef = {  # (1)
    "DBClusterSnapshotIdentifier": ...,
    "AttributeName": ...,
}

parent.modify_db_cluster_snapshot_attribute(**kwargs)
  1. See ModifyDBClusterSnapshotAttributeMessageRequestTypeDef

modify_db_instance

Modifies settings for an instance.

Type annotations and code completion for boto3.client("docdb").modify_db_instance method. boto3 documentation

Method definition
def modify_db_instance(
    self,
    *,
    DBInstanceIdentifier: str,
    DBInstanceClass: str = ...,
    ApplyImmediately: bool = ...,
    PreferredMaintenanceWindow: str = ...,
    AutoMinorVersionUpgrade: bool = ...,
    NewDBInstanceIdentifier: str = ...,
    CACertificateIdentifier: str = ...,
    CopyTagsToSnapshot: bool = ...,
    PromotionTier: int = ...,
    EnablePerformanceInsights: bool = ...,
    PerformanceInsightsKMSKeyId: str = ...,
) -> ModifyDBInstanceResultTypeDef:  # (1)
    ...
  1. See ModifyDBInstanceResultTypeDef
Usage example with kwargs
kwargs: ModifyDBInstanceMessageRequestTypeDef = {  # (1)
    "DBInstanceIdentifier": ...,
}

parent.modify_db_instance(**kwargs)
  1. See ModifyDBInstanceMessageRequestTypeDef

modify_db_subnet_group

Modifies an existing subnet group.

Type annotations and code completion for boto3.client("docdb").modify_db_subnet_group method. boto3 documentation

Method definition
def modify_db_subnet_group(
    self,
    *,
    DBSubnetGroupName: str,
    SubnetIds: Sequence[str],
    DBSubnetGroupDescription: str = ...,
) -> ModifyDBSubnetGroupResultTypeDef:  # (1)
    ...
  1. See ModifyDBSubnetGroupResultTypeDef
Usage example with kwargs
kwargs: ModifyDBSubnetGroupMessageRequestTypeDef = {  # (1)
    "DBSubnetGroupName": ...,
    "SubnetIds": ...,
}

parent.modify_db_subnet_group(**kwargs)
  1. See ModifyDBSubnetGroupMessageRequestTypeDef

modify_event_subscription

Modifies an existing Amazon DocumentDB event notification subscription.

Type annotations and code completion for boto3.client("docdb").modify_event_subscription method. boto3 documentation

Method definition
def modify_event_subscription(
    self,
    *,
    SubscriptionName: str,
    SnsTopicArn: str = ...,
    SourceType: str = ...,
    EventCategories: Sequence[str] = ...,
    Enabled: bool = ...,
) -> ModifyEventSubscriptionResultTypeDef:  # (1)
    ...
  1. See ModifyEventSubscriptionResultTypeDef
Usage example with kwargs
kwargs: ModifyEventSubscriptionMessageRequestTypeDef = {  # (1)
    "SubscriptionName": ...,
}

parent.modify_event_subscription(**kwargs)
  1. See ModifyEventSubscriptionMessageRequestTypeDef

modify_global_cluster

Modify a setting for an Amazon DocumentDB global cluster.

Type annotations and code completion for boto3.client("docdb").modify_global_cluster method. boto3 documentation

Method definition
def modify_global_cluster(
    self,
    *,
    GlobalClusterIdentifier: str,
    NewGlobalClusterIdentifier: str = ...,
    DeletionProtection: bool = ...,
) -> ModifyGlobalClusterResultTypeDef:  # (1)
    ...
  1. See ModifyGlobalClusterResultTypeDef
Usage example with kwargs
kwargs: ModifyGlobalClusterMessageRequestTypeDef = {  # (1)
    "GlobalClusterIdentifier": ...,
}

parent.modify_global_cluster(**kwargs)
  1. See ModifyGlobalClusterMessageRequestTypeDef

reboot_db_instance

You might need to reboot your instance, usually for maintenance reasons.

Type annotations and code completion for boto3.client("docdb").reboot_db_instance method. boto3 documentation

Method definition
def reboot_db_instance(
    self,
    *,
    DBInstanceIdentifier: str,
    ForceFailover: bool = ...,
) -> RebootDBInstanceResultTypeDef:  # (1)
    ...
  1. See RebootDBInstanceResultTypeDef
Usage example with kwargs
kwargs: RebootDBInstanceMessageRequestTypeDef = {  # (1)
    "DBInstanceIdentifier": ...,
}