DocDB#
Client#
- class DocDB.Client#
A low-level client representing Amazon DocumentDB with MongoDB compatibility (DocDB)
Amazon DocumentDB is a fast, reliable, and fully managed database service. Amazon DocumentDB makes it easy to set up, operate, and scale MongoDB-compatible databases in the cloud. With Amazon DocumentDB, you can run the same application code and use the same drivers and tools that you use with MongoDB.
import boto3 client = boto3.client('docdb')
These are the available methods:
- add_source_identifier_to_subscription
- add_tags_to_resource
- apply_pending_maintenance_action
- can_paginate
- close
- copy_db_cluster_parameter_group
- copy_db_cluster_snapshot
- create_db_cluster
- create_db_cluster_parameter_group
- create_db_cluster_snapshot
- create_db_instance
- create_db_subnet_group
- create_event_subscription
- create_global_cluster
- delete_db_cluster
- delete_db_cluster_parameter_group
- delete_db_cluster_snapshot
- delete_db_instance
- delete_db_subnet_group
- delete_event_subscription
- delete_global_cluster
- describe_certificates
- describe_db_cluster_parameter_groups
- describe_db_cluster_parameters
- describe_db_cluster_snapshot_attributes
- describe_db_cluster_snapshots
- describe_db_clusters
- describe_db_engine_versions
- describe_db_instances
- describe_db_subnet_groups
- describe_engine_default_cluster_parameters
- describe_event_categories
- describe_event_subscriptions
- describe_events
- describe_global_clusters
- describe_orderable_db_instance_options
- describe_pending_maintenance_actions
- failover_db_cluster
- failover_global_cluster
- get_paginator
- get_waiter
- list_tags_for_resource
- modify_db_cluster
- modify_db_cluster_parameter_group
- modify_db_cluster_snapshot_attribute
- modify_db_instance
- modify_db_subnet_group
- modify_event_subscription
- modify_global_cluster
- reboot_db_instance
- remove_from_global_cluster
- remove_source_identifier_from_subscription
- remove_tags_from_resource
- reset_db_cluster_parameter_group
- restore_db_cluster_from_snapshot
- restore_db_cluster_to_point_in_time
- start_db_cluster
- stop_db_cluster
- switchover_global_cluster
Client Exceptions#
Client exceptions are available on a client instance via the exceptions property. For more detailed instructions and examples on the exact usage of client exceptions, see the error handling user guide.
The available client exceptions are:
- AuthorizationNotFoundFault
- CertificateNotFoundFault
- DBClusterAlreadyExistsFault
- DBClusterNotFoundFault
- DBClusterParameterGroupNotFoundFault
- DBClusterQuotaExceededFault
- DBClusterSnapshotAlreadyExistsFault
- DBClusterSnapshotNotFoundFault
- DBInstanceAlreadyExistsFault
- DBInstanceNotFoundFault
- DBParameterGroupAlreadyExistsFault
- DBParameterGroupNotFoundFault
- DBParameterGroupQuotaExceededFault
- DBSecurityGroupNotFoundFault
- DBSnapshotAlreadyExistsFault
- DBSnapshotNotFoundFault
- DBSubnetGroupAlreadyExistsFault
- DBSubnetGroupDoesNotCoverEnoughAZs
- DBSubnetGroupNotFoundFault
- DBSubnetGroupQuotaExceededFault
- DBSubnetQuotaExceededFault
- DBUpgradeDependencyFailureFault
- EventSubscriptionQuotaExceededFault
- GlobalClusterAlreadyExistsFault
- GlobalClusterNotFoundFault
- GlobalClusterQuotaExceededFault
- InstanceQuotaExceededFault
- InsufficientDBClusterCapacityFault
- InsufficientDBInstanceCapacityFault
- InsufficientStorageClusterCapacityFault
- InvalidDBClusterSnapshotStateFault
- InvalidDBClusterStateFault
- InvalidDBInstanceStateFault
- InvalidDBParameterGroupStateFault
- InvalidDBSecurityGroupStateFault
- InvalidDBSnapshotStateFault
- InvalidDBSubnetGroupStateFault
- InvalidDBSubnetStateFault
- InvalidEventSubscriptionStateFault
- InvalidGlobalClusterStateFault
- InvalidRestoreFault
- InvalidSubnet
- InvalidVPCNetworkStateFault
- KMSKeyNotAccessibleFault
- ResourceNotFoundFault
- SNSInvalidTopicFault
- SNSNoAuthorizationFault
- SNSTopicArnNotFoundFault
- SharedSnapshotQuotaExceededFault
- SnapshotQuotaExceededFault
- SourceNotFoundFault
- StorageQuotaExceededFault
- StorageTypeNotSupportedFault
- SubnetAlreadyInUse
- SubscriptionAlreadyExistFault
- SubscriptionCategoryNotFoundFault
- SubscriptionNotFoundFault
Paginators#
Paginators are available on a client instance via the get_paginator method. For more detailed instructions and examples on the usage of paginators, see the paginators user guide.
The available paginators are:
- DescribeCertificates
- DescribeDBClusterParameterGroups
- DescribeDBClusterParameters
- DescribeDBClusterSnapshots
- DescribeDBClusters
- DescribeDBEngineVersions
- DescribeDBInstances
- DescribeDBSubnetGroups
- DescribeEventSubscriptions
- DescribeEvents
- DescribeGlobalClusters
- DescribeOrderableDBInstanceOptions
- DescribePendingMaintenanceActions
Waiters#
Waiters are available on a client instance via the get_waiter method. For more detailed instructions and examples on the usage or waiters, see the waiters user guide.
The available waiters are: