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

# DocDBClient 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.

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

# 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

can_paginate#

Check if an operation can be paginated.

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:
    ...

close#

Closes underlying endpoint connections.

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

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

# 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 = ...,
    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 = ...,
) -> 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.