DocDBClient

Index > DocDB > DocDBClient

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

DocDBClient

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

# DocDBClient usage example

from boto3.session import Session
from types_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.

# Exceptions.exceptions usage example

client = boto3.client("docdb")

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

# Exceptions.exceptions type checking example

from types_boto3_docdb.client import Exceptions

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

Methods

can_paginate

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

# can_paginate method definition

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

generate_presigned_url

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

# generate_presigned_url method definition

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

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

# add_source_identifier_to_subscription method definition

def add_source_identifier_to_subscription(
    self,
    *,
    SubscriptionName: str,
    SourceIdentifier: str,
) -> AddSourceIdentifierToSubscriptionResultTypeDef:  # (1)
    ...

1. See AddSourceIdentifierToSubscriptionResultTypeDef

# add_source_identifier_to_subscription method usage example with argument unpacking

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

# add_tags_to_resource method definition

def add_tags_to_resource(
    self,
    *,
    ResourceName: str,
    Tags: Sequence[TagTypeDef],  # (1)
) -> EmptyResponseMetadataTypeDef:  # (2)
    ...

1. See TagTypeDef
2. See EmptyResponseMetadataTypeDef

# add_tags_to_resource method usage example with argument unpacking

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

# apply_pending_maintenance_action method definition

def apply_pending_maintenance_action(
    self,
    *,
    ResourceIdentifier: str,
    ApplyAction: str,
    OptInType: str,
) -> ApplyPendingMaintenanceActionResultTypeDef:  # (1)
    ...

1. See ApplyPendingMaintenanceActionResultTypeDef

# apply_pending_maintenance_action method usage example with argument unpacking

kwargs: ApplyPendingMaintenanceActionMessageRequestTypeDef = {  # (1)
    "ResourceIdentifier": ...,
    "ApplyAction": ...,
    "OptInType": ...,
}

parent.apply_pending_maintenance_action(**kwargs)

1. See ApplyPendingMaintenanceActionMessageRequestTypeDef

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

# copy_db_cluster_parameter_group 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

# copy_db_cluster_parameter_group method usage example with argument unpacking

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

# copy_db_cluster_snapshot 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

# copy_db_cluster_snapshot method usage example with argument unpacking

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

# create_db_cluster 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 = ...,
    StorageType: str = ...,
    ManageMasterUserPassword: bool = ...,
    MasterUserSecretKmsKeyId: str = ...,
    SourceRegion: str = ...,
) -> CreateDBClusterResultTypeDef:  # (2)
    ...

1. See TagTypeDef
2. See CreateDBClusterResultTypeDef

# create_db_cluster method usage example with argument unpacking

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

# create_db_cluster_parameter_group 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

# create_db_cluster_parameter_group method usage example with argument unpacking

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

# create_db_cluster_snapshot method definition

def create_db_cluster_snapshot(
    self,
    *,
    DBClusterSnapshotIdentifier: str,
    DBClusterIdentifier: str,
    Tags: Sequence[TagTypeDef] = ...,  # (1)
) -> CreateDBClusterSnapshotResultTypeDef:  # (2)
    ...

1. See TagTypeDef
2. See CreateDBClusterSnapshotResultTypeDef

# create_db_cluster_snapshot method usage example with argument unpacking

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

# create_db_instance 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 = ...,
    CACertificateIdentifier: str = ...,
) -> CreateDBInstanceResultTypeDef:  # (2)
    ...

1. See TagTypeDef
2. See CreateDBInstanceResultTypeDef

# create_db_instance method usage example with argument unpacking

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

# create_db_subnet_group 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

# create_db_subnet_group method usage example with argument unpacking

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

# create_event_subscription 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

# create_event_subscription method usage example with argument unpacking

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

# create_global_cluster 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

# create_global_cluster method usage example with argument unpacking

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

# delete_db_cluster method definition

def delete_db_cluster(
    self,
    *,
    DBClusterIdentifier: str,
    SkipFinalSnapshot: bool = ...,
    FinalDBSnapshotIdentifier: str = ...,
) -> DeleteDBClusterResultTypeDef:  # (1)
    ...

1. See DeleteDBClusterResultTypeDef

# delete_db_cluster method usage example with argument unpacking

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

# delete_db_cluster_parameter_group method definition

def delete_db_cluster_parameter_group(
    self,
    *,
    DBClusterParameterGroupName: str,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...

1. See EmptyResponseMetadataTypeDef

# delete_db_cluster_parameter_group method usage example with argument unpacking

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

# delete_db_cluster_snapshot method definition

def delete_db_cluster_snapshot(
    self,
    *,
    DBClusterSnapshotIdentifier: str,
) -> DeleteDBClusterSnapshotResultTypeDef:  # (1)
    ...

1. See DeleteDBClusterSnapshotResultTypeDef

# delete_db_cluster_snapshot method usage example with argument unpacking

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

# delete_db_instance method definition

def delete_db_instance(
    self,
    *,
    DBInstanceIdentifier: str,
) -> DeleteDBInstanceResultTypeDef:  # (1)
    ...

1. See DeleteDBInstanceResultTypeDef

# delete_db_instance method usage example with argument unpacking

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

# delete_db_subnet_group method definition

def delete_db_subnet_group(
    self,
    *,
    DBSubnetGroupName: str,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...

1. See EmptyResponseMetadataTypeDef

# delete_db_subnet_group method usage example with argument unpacking

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

# delete_event_subscription method definition

def delete_event_subscription(
    self,
    *,
    SubscriptionName: str,
) -> DeleteEventSubscriptionResultTypeDef:  # (1)
    ...

1. See DeleteEventSubscriptionResultTypeDef

# delete_event_subscription method usage example with argument unpacking

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

# delete_global_cluster method definition

def delete_global_cluster(
    self,
    *,
    GlobalClusterIdentifier: str,
) -> DeleteGlobalClusterResultTypeDef:  # (1)
    ...

1. See DeleteGlobalClusterResultTypeDef

# delete_global_cluster method usage example with argument unpacking

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

# describe_certificates method definition

def describe_certificates(
    self,
    *,
    CertificateIdentifier: str = ...,
    Filters: Sequence[FilterTypeDef] = ...,  # (1)
    MaxRecords: int = ...,
    Marker: str = ...,
) -> CertificateMessageTypeDef:  # (2)
    ...

1. See FilterTypeDef
2. See CertificateMessageTypeDef

# describe_certificates method usage example with argument unpacking

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

# describe_db_cluster_parameter_groups 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

# describe_db_cluster_parameter_groups method usage example with argument unpacking

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

# describe_db_cluster_parameters 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

# describe_db_cluster_parameters method usage example with argument unpacking

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

# describe_db_cluster_snapshot_attributes method definition

def describe_db_cluster_snapshot_attributes(
    self,
    *,
    DBClusterSnapshotIdentifier: str,
) -> DescribeDBClusterSnapshotAttributesResultTypeDef:  # (1)
    ...

1. See DescribeDBClusterSnapshotAttributesResultTypeDef

# describe_db_cluster_snapshot_attributes method usage example with argument unpacking

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

# describe_db_cluster_snapshots 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

# describe_db_cluster_snapshots method usage example with argument unpacking

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

# describe_db_clusters 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

# describe_db_clusters method usage example with argument unpacking

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

# describe_db_engine_versions 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

# describe_db_engine_versions method usage example with argument unpacking

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

# describe_db_instances 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

# describe_db_instances method usage example with argument unpacking

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

# describe_db_subnet_groups 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

# describe_db_subnet_groups method usage example with argument unpacking

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

# describe_engine_default_cluster_parameters 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

# describe_engine_default_cluster_parameters method usage example with argument unpacking

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

# describe_event_categories method definition

def describe_event_categories(
    self,
    *,
    SourceType: str = ...,
    Filters: Sequence[FilterTypeDef] = ...,  # (1)
) -> EventCategoriesMessageTypeDef:  # (2)
    ...

1. See FilterTypeDef
2. See EventCategoriesMessageTypeDef

# describe_event_categories method usage example with argument unpacking

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

# describe_event_subscriptions 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

# describe_event_subscriptions method usage example with argument unpacking

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

# describe_events method definition

def describe_events(
    self,
    *,
    SourceIdentifier: str = ...,
    SourceType: SourceTypeType = ...,  # (1)
    StartTime: TimestampTypeDef = ...,
    EndTime: TimestampTypeDef = ...,
    Duration: int = ...,
    EventCategories: Sequence[str] = ...,
    Filters: Sequence[FilterTypeDef] = ...,  # (2)
    MaxRecords: int = ...,
    Marker: str = ...,
) -> EventsMessageTypeDef:  # (3)
    ...

1. See SourceTypeType
2. See FilterTypeDef
3. See EventsMessageTypeDef

# describe_events method usage example with argument unpacking

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

# describe_global_clusters 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

# describe_global_clusters method usage example with argument unpacking

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

# describe_orderable_db_instance_options 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

# describe_orderable_db_instance_options method usage example with argument unpacking

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

# describe_pending_maintenance_actions 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

# describe_pending_maintenance_actions method usage example with argument unpacking

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

# failover_db_cluster method definition

def failover_db_cluster(
    self,
    *,
    DBClusterIdentifier: str = ...,
    TargetDBInstanceIdentifier: str = ...,
) -> FailoverDBClusterResultTypeDef:  # (1)
    ...

1. See FailoverDBClusterResultTypeDef

# failover_db_cluster method usage example with argument unpacking

kwargs: FailoverDBClusterMessageRequestTypeDef = {  # (1)
    "DBClusterIdentifier": ...,
}

parent.failover_db_cluster(**kwargs)

1. See FailoverDBClusterMessageRequestTypeDef

failover_global_cluster

Promotes the specified secondary DB cluster to be the primary DB cluster in the global cluster when failing over a global cluster occurs.

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

# failover_global_cluster method definition

def failover_global_cluster(
    self,
    *,
    GlobalClusterIdentifier: str,
    TargetDbClusterIdentifier: str,
    AllowDataLoss: bool = ...,
    Switchover: bool = ...,
) -> FailoverGlobalClusterResultTypeDef:  # (1)
    ...

1. See FailoverGlobalClusterResultTypeDef

# failover_global_cluster method usage example with argument unpacking

kwargs: FailoverGlobalClusterMessageRequestTypeDef = {  # (1)
    "GlobalClusterIdentifier": ...,
    "TargetDbClusterIdentifier": ...,
}

parent.failover_global_cluster(**kwargs)

1. See FailoverGlobalClusterMessageRequestTypeDef

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

# list_tags_for_resource method definition

def list_tags_for_resource(
    self,
    *,
    ResourceName: str,
    Filters: Sequence[FilterTypeDef] = ...,  # (1)
) -> TagListMessageTypeDef:  # (2)
    ...

1. See FilterTypeDef
2. See TagListMessageTypeDef

# list_tags_for_resource method usage example with argument unpacking

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

# modify_db_cluster 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 = ...,
    AllowMajorVersionUpgrade: bool = ...,
    DeletionProtection: bool = ...,
    StorageType: str = ...,
    ManageMasterUserPassword: bool = ...,
    MasterUserSecretKmsKeyId: str = ...,
    RotateMasterUserPassword: bool = ...,
) -> ModifyDBClusterResultTypeDef:  # (2)
    ...

1. See CloudwatchLogsExportConfigurationTypeDef
2. See ModifyDBClusterResultTypeDef

# modify_db_cluster method usage example with argument unpacking

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

# modify_db_cluster_parameter_group method definition

def modify_db_cluster_parameter_group(
    self,
    *,
    DBClusterParameterGroupName: str,
    Parameters: Sequence[ParameterTypeDef],  # (1)
) -> DBClusterParameterGroupNameMessageTypeDef:  # (2)
    ...

1. See ParameterTypeDef
2. See DBClusterParameterGroupNameMessageTypeDef

# modify_db_cluster_parameter_group method usage example with argument unpacking

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

# modify_db_cluster_snapshot_attribute method definition

def modify_db_cluster_snapshot_attribute(
    self,
    *,
    DBClusterSnapshotIdentifier: str,
    AttributeName: str,
    ValuesToAdd: Sequence[str] = ...,
    ValuesToRemove: Sequence[str] = ...,
) -> ModifyDBClusterSnapshotAttributeResultTypeDef:  # (1)
    ...

1. See ModifyDBClusterSnapshotAttributeResultTypeDef

# modify_db_cluster_snapshot_attribute method usage example with argument unpacking

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

# modify_db_instance 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 = ...,
    CertificateRotationRestart: bool = ...,
) -> ModifyDBInstanceResultTypeDef:  # (1)
    ...

1. See ModifyDBInstanceResultTypeDef

# modify_db_instance method usage example with argument unpacking

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

# modify_db_subnet_group method definition

def modify_db_subnet_group(
    self,
    *,
    DBSubnetGroupName: str,
    SubnetIds: Sequence[str],
    DBSubnetGroupDescription: str = ...,
) -> ModifyDBSubnetGroupResultTypeDef:  # (1)
    ...

1. See ModifyDBSubnetGroupResultTypeDef

# modify_db_subnet_group method usage example with argument unpacking

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

# modify_event_subscription method definition

def modify_event_subscription(
    self,
    *,
    SubscriptionName: str,
    SnsTopicArn: str = ...,
    SourceType: str = ...,
    EventCategories: Sequence[str] = ...,
    Enabled: bool = ...,
) -> ModifyEventSubscriptionResultTypeDef:  # (1)
    ...

1. See ModifyEventSubscriptionResultTypeDef

# modify_event_subscription method usage example with argument unpacking

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

# modify_global_cluster method definition

def modify_global_cluster(
    self,
    *,
    GlobalClusterIdentifier: str,
    NewGlobalClusterIdentifier: str = ...,
    DeletionProtection: bool = ...,
) -> ModifyGlobalClusterResultTypeDef:  # (1)
    ...

1. See ModifyGlobalClusterResultTypeDef

# modify_global_cluster method usage example with argument unpacking

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

# reboot_db_instance method definition

def reboot_db_instance(
    self,
    *,
    DBInstanceIdentifier: str,
    ForceFailover: bool = ...,
) -> RebootDBInstanceResultTypeDef:  # (1)
    ...

1. See RebootDBInstanceResultTypeDef

# reboot_db_instance method usage example with argument unpacking

kwargs: RebootDBInstanceMessageRequestTypeDef = {  # (1)
    "DBInstanceIdentifier": ...,
}

parent.reboot_db_instance(**kwargs)

1. See RebootDBInstanceMessageRequestTypeDef

remove_from_global_cluster

Detaches an Amazon DocumentDB secondary cluster from a global cluster.

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

# remove_from_global_cluster method definition

def remove_from_global_cluster(
    self,
    *,
    GlobalClusterIdentifier: str,
    DbClusterIdentifier: str,
) -> RemoveFromGlobalClusterResultTypeDef:  # (1)
    ...

1. See RemoveFromGlobalClusterResultTypeDef

# remove_from_global_cluster method usage example with argument unpacking

kwargs: RemoveFromGlobalClusterMessageRequestTypeDef = {  # (1)
    "GlobalClusterIdentifier": ...,
    "DbClusterIdentifier": ...,
}

parent.remove_from_global_cluster(**kwargs)

1. See RemoveFromGlobalClusterMessageRequestTypeDef

remove_source_identifier_from_subscription

Removes a source identifier from an existing Amazon DocumentDB event notification subscription.

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

# remove_source_identifier_from_subscription method definition

def remove_source_identifier_from_subscription(
    self,
    *,
    SubscriptionName: str,
    SourceIdentifier: str,
) -> RemoveSourceIdentifierFromSubscriptionResultTypeDef:  # (1)
    ...

1. See RemoveSourceIdentifierFromSubscriptionResultTypeDef

# remove_source_identifier_from_subscription method usage example with argument unpacking

kwargs: RemoveSourceIdentifierFromSubscriptionMessageRequestTypeDef = {  # (1)
    "SubscriptionName": ...,
    "SourceIdentifier": ...,
}

parent.remove_source_identifier_from_subscription(**kwargs)

1. See RemoveSourceIdentifierFromSubscriptionMessageRequestTypeDef

remove_tags_from_resource

Removes metadata tags from an Amazon DocumentDB resource.

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

# remove_tags_from_resource method definition

def remove_tags_from_resource(
    self,
    *,
    ResourceName: str,
    TagKeys: Sequence[str],
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...

1. See EmptyResponseMetadataTypeDef

# remove_tags_from_resource method usage example with argument unpacking

kwargs: RemoveTagsFromResourceMessageRequestTypeDef = {  # (1)
    "ResourceName": ...,
    "TagKeys": ...,
}

parent.remove_tags_from_resource(**kwargs)

1. See RemoveTagsFromResourceMessageRequestTypeDef

reset_db_cluster_parameter_group

Modifies the parameters of a cluster parameter group to the default value.

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

# reset_db_cluster_parameter_group method definition

def reset_db_cluster_parameter_group(
    self,
    *,
    DBClusterParameterGroupName: str,
    ResetAllParameters: bool = ...,
    Parameters: Sequence[ParameterTypeDef] = ...,  # (1)
) -> DBClusterParameterGroupNameMessageTypeDef:  # (2)
    ...

1. See ParameterTypeDef
2. See DBClusterParameterGroupNameMessageTypeDef

# reset_db_cluster_parameter_group method usage example with argument unpacking

kwargs: ResetDBClusterParameterGroupMessageRequestTypeDef = {  # (1)
    "DBClusterParameterGroupName": ...,
}

parent.reset_db_cluster_parameter_group(**kwargs)

1. See ResetDBClusterParameterGroupMessageRequestTypeDef

restore_db_cluster_from_snapshot

Creates a new cluster from a snapshot or cluster snapshot.

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

# restore_db_cluster_from_snapshot method definition

def restore_db_cluster_from_snapshot(
    self,
    *,
    DBClusterIdentifier: str,
    SnapshotIdentifier: str,
    Engine: str,
    AvailabilityZones: Sequence[str] = ...,
    EngineVersion: str = ...,
    Port: int = ...,
    DBSubnetGroupName: str = ...,
    VpcSecurityGroupIds: Sequence[str] = ...,
    Tags: Sequence[TagTypeDef] = ...,  # (1)
    KmsKeyId: str = ...,
    EnableCloudwatchLogsExports: Sequence[str] = ...,
    DeletionProtection: bool = ...,
    DBClusterParameterGroupName: str = ...,
    StorageType: str = ...,
) -> RestoreDBClusterFromSnapshotResultTypeDef:  # (2)
    ...

1. See TagTypeDef
2. See RestoreDBClusterFromSnapshotResultTypeDef

# restore_db_cluster_from_snapshot method usage example with argument unpacking

kwargs: RestoreDBClusterFromSnapshotMessageRequestTypeDef = {  # (1)
    "DBClusterIdentifier": ...,
    "SnapshotIdentifier": ...,
    "Engine": ...,
}

parent.restore_db_cluster_from_snapshot(**kwargs)

1. See RestoreDBClusterFromSnapshotMessageRequestTypeDef

restore_db_cluster_to_point_in_time

Restores a cluster to an arbitrary point in time.

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

# restore_db_cluster_to_point_in_time method definition

def restore_db_cluster_to_point_in_time(
    self,
    *,
    DBClusterIdentifier: str,
    SourceDBClusterIdentifier: str,
    RestoreType: str = ...,
    RestoreToTime: TimestampTypeDef = ...,
    UseLatestRestorableTime: bool = ...,
    Port: int = ...,
    DBSubnetGroupName: str = ...,
    VpcSecurityGroupIds: Sequence[str] = ...,
    Tags: Sequence[TagTypeDef] = ...,  # (1)
    KmsKeyId: str = ...,
    EnableCloudwatchLogsExports: Sequence[str] = ...,
    DeletionProtection: bool = ...,
    StorageType: str = ...,
) -> RestoreDBClusterToPointInTimeResultTypeDef:  # (2)
    ...

1. See TagTypeDef
2. See RestoreDBClusterToPointInTimeResultTypeDef

# restore_db_cluster_to_point_in_time method usage example with argument unpacking

kwargs: RestoreDBClusterToPointInTimeMessageRequestTypeDef = {  # (1)
    "DBClusterIdentifier": ...,
    "SourceDBClusterIdentifier": ...,
}

parent.restore_db_cluster_to_point_in_time(**kwargs)

1. See RestoreDBClusterToPointInTimeMessageRequestTypeDef

start_db_cluster

Restarts the stopped cluster that is specified by DBClusterIdentifier.

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

# start_db_cluster method definition

def start_db_cluster(
    self,
    *,
    DBClusterIdentifier: str,
) -> StartDBClusterResultTypeDef:  # (1)
    ...

1. See StartDBClusterResultTypeDef

# start_db_cluster method usage example with argument unpacking

kwargs: StartDBClusterMessageRequestTypeDef = {  # (1)
    "DBClusterIdentifier": ...,
}

parent.start_db_cluster(**kwargs)

1. See StartDBClusterMessageRequestTypeDef

stop_db_cluster

Stops the running cluster that is specified by DBClusterIdentifier.

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

# stop_db_cluster method definition

def stop_db_cluster(
    self,
    *,
    DBClusterIdentifier: str,
) -> StopDBClusterResultTypeDef:  # (1)
    ...

1. See StopDBClusterResultTypeDef

# stop_db_cluster method usage example with argument unpacking

kwargs: StopDBClusterMessageRequestTypeDef = {  # (1)
    "DBClusterIdentifier": ...,
}

parent.stop_db_cluster(**kwargs)

1. See StopDBClusterMessageRequestTypeDef

switchover_global_cluster

Switches over the specified secondary Amazon DocumentDB cluster to be the new primary Amazon DocumentDB cluster in the global database cluster.

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

# switchover_global_cluster method definition

def switchover_global_cluster(
    self,
    *,
    GlobalClusterIdentifier: str,
    TargetDbClusterIdentifier: str,
) -> SwitchoverGlobalClusterResultTypeDef:  # (1)
    ...

1. See SwitchoverGlobalClusterResultTypeDef

# switchover_global_cluster method usage example with argument unpacking

kwargs: SwitchoverGlobalClusterMessageRequestTypeDef = {  # (1)
    "GlobalClusterIdentifier": ...,
    "TargetDbClusterIdentifier": ...,
}

parent.switchover_global_cluster(**kwargs)

1. See SwitchoverGlobalClusterMessageRequestTypeDef

get_paginator

Type annotations and code completion for boto3.client("docdb").get_paginator method with overloads.

• client.get_paginator("describe_certificates") -> DescribeCertificatesPaginator
• client.get_paginator("describe_db_cluster_parameter_groups") -> DescribeDBClusterParameterGroupsPaginator
• client.get_paginator("describe_db_cluster_parameters") -> DescribeDBClusterParametersPaginator
• client.get_paginator("describe_db_cluster_snapshots") -> DescribeDBClusterSnapshotsPaginator
• client.get_paginator("describe_db_clusters") -> DescribeDBClustersPaginator
• client.get_paginator("describe_db_engine_versions") -> DescribeDBEngineVersionsPaginator
• client.get_paginator("describe_db_instances") -> DescribeDBInstancesPaginator
• client.get_paginator("describe_db_subnet_groups") -> DescribeDBSubnetGroupsPaginator
• client.get_paginator("describe_event_subscriptions") -> DescribeEventSubscriptionsPaginator
• client.get_paginator("describe_events") -> DescribeEventsPaginator
• client.get_paginator("describe_global_clusters") -> DescribeGlobalClustersPaginator
• client.get_paginator("describe_orderable_db_instance_options") -> DescribeOrderableDBInstanceOptionsPaginator
• client.get_paginator("describe_pending_maintenance_actions") -> DescribePendingMaintenanceActionsPaginator

get_waiter

Type annotations and code completion for boto3.client("docdb").get_waiter method with overloads.

• client.get_waiter("db_instance_available") -> DBInstanceAvailableWaiter
• client.get_waiter("db_instance_deleted") -> DBInstanceDeletedWaiter