# Packages
Package docdbiface provides an interface to enable mocking the Amazon DocumentDB with MongoDB compatibility service client for testing your code.
# Functions
New creates a new instance of the client from the provided Config.
NewDescribeDBClustersRequestPaginator returns a paginator for DescribeDBClusters.
NewDescribeDBEngineVersionsRequestPaginator returns a paginator for DescribeDBEngineVersions.
NewDescribeDBInstancesRequestPaginator returns a paginator for DescribeDBInstances.
NewDescribeDBSubnetGroupsRequestPaginator returns a paginator for DescribeDBSubnetGroups.
NewDescribeEventsRequestPaginator returns a paginator for DescribeEvents.
NewDescribeOrderableDBInstanceOptionsRequestPaginator returns a paginator for DescribeOrderableDBInstanceOptions.
# Constants
Enum values for ApplyMethod.
Enum values for ApplyMethod.
Service's Endpoint identifier.
ErrCodeAuthorizationNotFoundFault for service response error code "AuthorizationNotFound".
ErrCodeCertificateNotFoundFault for service response error code "CertificateNotFound".
ErrCodeDBClusterAlreadyExistsFault for service response error code "DBClusterAlreadyExistsFault".
ErrCodeDBClusterNotFoundFault for service response error code "DBClusterNotFoundFault".
ErrCodeDBClusterParameterGroupNotFoundFault for service response error code "DBClusterParameterGroupNotFound".
ErrCodeDBClusterQuotaExceededFault for service response error code "DBClusterQuotaExceededFault".
ErrCodeDBClusterSnapshotAlreadyExistsFault for service response error code "DBClusterSnapshotAlreadyExistsFault".
ErrCodeDBClusterSnapshotNotFoundFault for service response error code "DBClusterSnapshotNotFoundFault".
ErrCodeDBInstanceAlreadyExistsFault for service response error code "DBInstanceAlreadyExists".
ErrCodeDBInstanceNotFoundFault for service response error code "DBInstanceNotFound".
ErrCodeDBParameterGroupAlreadyExistsFault for service response error code "DBParameterGroupAlreadyExists".
ErrCodeDBParameterGroupNotFoundFault for service response error code "DBParameterGroupNotFound".
ErrCodeDBParameterGroupQuotaExceededFault for service response error code "DBParameterGroupQuotaExceeded".
ErrCodeDBSecurityGroupNotFoundFault for service response error code "DBSecurityGroupNotFound".
ErrCodeDBSnapshotAlreadyExistsFault for service response error code "DBSnapshotAlreadyExists".
ErrCodeDBSnapshotNotFoundFault for service response error code "DBSnapshotNotFound".
ErrCodeDBSubnetGroupAlreadyExistsFault for service response error code "DBSubnetGroupAlreadyExists".
ErrCodeDBSubnetGroupDoesNotCoverEnoughAZs for service response error code "DBSubnetGroupDoesNotCoverEnoughAZs".
ErrCodeDBSubnetGroupNotFoundFault for service response error code "DBSubnetGroupNotFoundFault".
ErrCodeDBSubnetGroupQuotaExceededFault for service response error code "DBSubnetGroupQuotaExceeded".
ErrCodeDBSubnetQuotaExceededFault for service response error code "DBSubnetQuotaExceededFault".
ErrCodeDBUpgradeDependencyFailureFault for service response error code "DBUpgradeDependencyFailure".
ErrCodeInstanceQuotaExceededFault for service response error code "InstanceQuotaExceeded".
ErrCodeInsufficientDBClusterCapacityFault for service response error code "InsufficientDBClusterCapacityFault".
ErrCodeInsufficientDBInstanceCapacityFault for service response error code "InsufficientDBInstanceCapacity".
ErrCodeInsufficientStorageClusterCapacityFault for service response error code "InsufficientStorageClusterCapacity".
ErrCodeInvalidDBClusterSnapshotStateFault for service response error code "InvalidDBClusterSnapshotStateFault".
ErrCodeInvalidDBClusterStateFault for service response error code "InvalidDBClusterStateFault".
ErrCodeInvalidDBInstanceStateFault for service response error code "InvalidDBInstanceState".
ErrCodeInvalidDBParameterGroupStateFault for service response error code "InvalidDBParameterGroupState".
ErrCodeInvalidDBSecurityGroupStateFault for service response error code "InvalidDBSecurityGroupState".
ErrCodeInvalidDBSnapshotStateFault for service response error code "InvalidDBSnapshotState".
ErrCodeInvalidDBSubnetGroupStateFault for service response error code "InvalidDBSubnetGroupStateFault".
ErrCodeInvalidDBSubnetStateFault for service response error code "InvalidDBSubnetStateFault".
ErrCodeInvalidRestoreFault for service response error code "InvalidRestoreFault".
ErrCodeInvalidSubnet for service response error code "InvalidSubnet".
ErrCodeInvalidVPCNetworkStateFault for service response error code "InvalidVPCNetworkStateFault".
ErrCodeKMSKeyNotAccessibleFault for service response error code "KMSKeyNotAccessibleFault".
ErrCodeResourceNotFoundFault for service response error code "ResourceNotFoundFault".
ErrCodeSharedSnapshotQuotaExceededFault for service response error code "SharedSnapshotQuotaExceeded".
ErrCodeSnapshotQuotaExceededFault for service response error code "SnapshotQuotaExceeded".
ErrCodeStorageQuotaExceededFault for service response error code "StorageQuotaExceeded".
ErrCodeStorageTypeNotSupportedFault for service response error code "StorageTypeNotSupported".
ErrCodeSubnetAlreadyInUse for service response error code "SubnetAlreadyInUse".
Service's identifier.
Service's name.
Enum values for SourceType.
Enum values for SourceType.
Enum values for SourceType.
Enum values for SourceType.
Enum values for SourceType.
Enum values for SourceType.
# Structs
Represents the input to AddTagsToResource.
No description provided by the author
AddTagsToResourceRequest is the request type for the AddTagsToResource API operation.
AddTagsToResourceResponse is the response type for the AddTagsToResource API operation.
Represents the input to ApplyPendingMaintenanceAction.
No description provided by the author
ApplyPendingMaintenanceActionRequest is the request type for the ApplyPendingMaintenanceAction API operation.
ApplyPendingMaintenanceActionResponse is the response type for the ApplyPendingMaintenanceAction API operation.
Information about an Availability Zone.
A certificate authority (CA) certificate for an AWS account.
Client provides the API operation methods for making requests to Amazon DocDB.
The configuration setting for the log types to be enabled for export to Amazon CloudWatch Logs for a specific instance or cluster.
Represents the input to CopyDBClusterParameterGroup.
No description provided by the author
CopyDBClusterParameterGroupRequest is the request type for the CopyDBClusterParameterGroup API operation.
CopyDBClusterParameterGroupResponse is the response type for the CopyDBClusterParameterGroup API operation.
Represents the input to CopyDBClusterSnapshot.
No description provided by the author
CopyDBClusterSnapshotRequest is the request type for the CopyDBClusterSnapshot API operation.
CopyDBClusterSnapshotResponse is the response type for the CopyDBClusterSnapshot API operation.
Represents the input to CreateDBCluster.
No description provided by the author
Represents the input of CreateDBClusterParameterGroup.
No description provided by the author
CreateDBClusterParameterGroupRequest is the request type for the CreateDBClusterParameterGroup API operation.
CreateDBClusterParameterGroupResponse is the response type for the CreateDBClusterParameterGroup API operation.
CreateDBClusterRequest is the request type for the CreateDBCluster API operation.
CreateDBClusterResponse is the response type for the CreateDBCluster API operation.
Represents the input of CreateDBClusterSnapshot.
No description provided by the author
CreateDBClusterSnapshotRequest is the request type for the CreateDBClusterSnapshot API operation.
CreateDBClusterSnapshotResponse is the response type for the CreateDBClusterSnapshot API operation.
Represents the input to CreateDBInstance.
No description provided by the author
CreateDBInstanceRequest is the request type for the CreateDBInstance API operation.
CreateDBInstanceResponse is the response type for the CreateDBInstance API operation.
Represents the input to CreateDBSubnetGroup.
No description provided by the author
CreateDBSubnetGroupRequest is the request type for the CreateDBSubnetGroup API operation.
CreateDBSubnetGroupResponse is the response type for the CreateDBSubnetGroup API operation.
Detailed information about a cluster.
Contains information about an instance that is part of a cluster.
Detailed information about a cluster parameter group.
Describes an AWS Identity and Access Management (IAM) role that is associated with a cluster.
Detailed information about a cluster snapshot.
Contains the name and values of a manual cluster snapshot attribute.
Detailed information about the attributes that are associated with a cluster snapshot.
Detailed information about an engine version.
Detailed information about an instance.
Provides a list of status information for an instance.
Detailed information about a subnet group.
Represents the input to DeleteDBCluster.
No description provided by the author
Represents the input to DeleteDBClusterParameterGroup.
No description provided by the author
DeleteDBClusterParameterGroupRequest is the request type for the DeleteDBClusterParameterGroup API operation.
DeleteDBClusterParameterGroupResponse is the response type for the DeleteDBClusterParameterGroup API operation.
DeleteDBClusterRequest is the request type for the DeleteDBCluster API operation.
DeleteDBClusterResponse is the response type for the DeleteDBCluster API operation.
Represents the input to DeleteDBClusterSnapshot.
No description provided by the author
DeleteDBClusterSnapshotRequest is the request type for the DeleteDBClusterSnapshot API operation.
DeleteDBClusterSnapshotResponse is the response type for the DeleteDBClusterSnapshot API operation.
Represents the input to DeleteDBInstance.
No description provided by the author
DeleteDBInstanceRequest is the request type for the DeleteDBInstance API operation.
DeleteDBInstanceResponse is the response type for the DeleteDBInstance API operation.
Represents the input to DeleteDBSubnetGroup.
No description provided by the author
DeleteDBSubnetGroupRequest is the request type for the DeleteDBSubnetGroup API operation.
DeleteDBSubnetGroupResponse is the response type for the DeleteDBSubnetGroup API operation.
No description provided by the author
No description provided by the author
DescribeCertificatesRequest is the request type for the DescribeCertificates API operation.
DescribeCertificatesResponse is the response type for the DescribeCertificates API operation.
Represents the input to DescribeDBClusterParameterGroups.
Represents the output of DBClusterParameterGroups.
DescribeDBClusterParameterGroupsRequest is the request type for the DescribeDBClusterParameterGroups API operation.
DescribeDBClusterParameterGroupsResponse is the response type for the DescribeDBClusterParameterGroups API operation.
Represents the input to DescribeDBClusterParameters.
Represents the output of DBClusterParameterGroup.
DescribeDBClusterParametersRequest is the request type for the DescribeDBClusterParameters API operation.
DescribeDBClusterParametersResponse is the response type for the DescribeDBClusterParameters API operation.
Represents the input to DescribeDBClusters.
Represents the input to DescribeDBClusterSnapshotAttributes.
No description provided by the author
DescribeDBClusterSnapshotAttributesRequest is the request type for the DescribeDBClusterSnapshotAttributes API operation.
DescribeDBClusterSnapshotAttributesResponse is the response type for the DescribeDBClusterSnapshotAttributes API operation.
Represents the input to DescribeDBClusterSnapshots.
Represents the output of DescribeDBClusterSnapshots.
DescribeDBClusterSnapshotsRequest is the request type for the DescribeDBClusterSnapshots API operation.
DescribeDBClusterSnapshotsResponse is the response type for the DescribeDBClusterSnapshots API operation.
Represents the output of DescribeDBClusters.
DescribeDBClustersPaginator is used to paginate the request.
DescribeDBClustersRequest is the request type for the DescribeDBClusters API operation.
DescribeDBClustersResponse is the response type for the DescribeDBClusters API operation.
Represents the input to DescribeDBEngineVersions.
Represents the output of DescribeDBEngineVersions.
DescribeDBEngineVersionsPaginator is used to paginate the request.
DescribeDBEngineVersionsRequest is the request type for the DescribeDBEngineVersions API operation.
DescribeDBEngineVersionsResponse is the response type for the DescribeDBEngineVersions API operation.
Represents the input to DescribeDBInstances.
Represents the output of DescribeDBInstances.
DescribeDBInstancesPaginator is used to paginate the request.
DescribeDBInstancesRequest is the request type for the DescribeDBInstances API operation.
DescribeDBInstancesResponse is the response type for the DescribeDBInstances API operation.
Represents the input to DescribeDBSubnetGroups.
Represents the output of DescribeDBSubnetGroups.
DescribeDBSubnetGroupsPaginator is used to paginate the request.
DescribeDBSubnetGroupsRequest is the request type for the DescribeDBSubnetGroups API operation.
DescribeDBSubnetGroupsResponse is the response type for the DescribeDBSubnetGroups API operation.
Represents the input to DescribeEngineDefaultClusterParameters.
No description provided by the author
DescribeEngineDefaultClusterParametersRequest is the request type for the DescribeEngineDefaultClusterParameters API operation.
DescribeEngineDefaultClusterParametersResponse is the response type for the DescribeEngineDefaultClusterParameters API operation.
Represents the input to DescribeEventCategories.
Represents the output of DescribeEventCategories.
DescribeEventCategoriesRequest is the request type for the DescribeEventCategories API operation.
DescribeEventCategoriesResponse is the response type for the DescribeEventCategories API operation.
Represents the input to DescribeEvents.
Represents the output of DescribeEvents.
DescribeEventsPaginator is used to paginate the request.
DescribeEventsRequest is the request type for the DescribeEvents API operation.
DescribeEventsResponse is the response type for the DescribeEvents API operation.
Represents the input to DescribeOrderableDBInstanceOptions.
Represents the output of DescribeOrderableDBInstanceOptions.
DescribeOrderableDBInstanceOptionsPaginator is used to paginate the request.
DescribeOrderableDBInstanceOptionsRequest is the request type for the DescribeOrderableDBInstanceOptions API operation.
DescribeOrderableDBInstanceOptionsResponse is the response type for the DescribeOrderableDBInstanceOptions API operation.
Represents the input to DescribePendingMaintenanceActions.
Represents the output of DescribePendingMaintenanceActions.
DescribePendingMaintenanceActionsRequest is the request type for the DescribePendingMaintenanceActions API operation.
DescribePendingMaintenanceActionsResponse is the response type for the DescribePendingMaintenanceActions API operation.
Network information for accessing a cluster or instance.
Contains the result of a successful invocation of the DescribeEngineDefaultClusterParameters operation.
Detailed information about an event.
An event source type, accompanied by one or more event category names.
Represents the input to FailoverDBCluster.
No description provided by the author
FailoverDBClusterRequest is the request type for the FailoverDBCluster API operation.
FailoverDBClusterResponse is the response type for the FailoverDBCluster API operation.
A named set of filter values, used to return a more specific list of results.
Represents the input to ListTagsForResource.
Represents the output of ListTagsForResource.
ListTagsForResourceRequest is the request type for the ListTagsForResource API operation.
ListTagsForResourceResponse is the response type for the ListTagsForResource API operation.
Represents the input to ModifyDBCluster.
No description provided by the author
Represents the input to ModifyDBClusterParameterGroup.
Contains the name of a cluster parameter group.
ModifyDBClusterParameterGroupRequest is the request type for the ModifyDBClusterParameterGroup API operation.
ModifyDBClusterParameterGroupResponse is the response type for the ModifyDBClusterParameterGroup API operation.
ModifyDBClusterRequest is the request type for the ModifyDBCluster API operation.
ModifyDBClusterResponse is the response type for the ModifyDBCluster API operation.
Represents the input to ModifyDBClusterSnapshotAttribute.
No description provided by the author
ModifyDBClusterSnapshotAttributeRequest is the request type for the ModifyDBClusterSnapshotAttribute API operation.
ModifyDBClusterSnapshotAttributeResponse is the response type for the ModifyDBClusterSnapshotAttribute API operation.
Represents the input to ModifyDBInstance.
No description provided by the author
ModifyDBInstanceRequest is the request type for the ModifyDBInstance API operation.
ModifyDBInstanceResponse is the response type for the ModifyDBInstance API operation.
Represents the input to ModifyDBSubnetGroup.
No description provided by the author
ModifyDBSubnetGroupRequest is the request type for the ModifyDBSubnetGroup API operation.
ModifyDBSubnetGroupResponse is the response type for the ModifyDBSubnetGroup API operation.
The options that are available for an instance.
Detailed information about an individual parameter.
A list of the log types whose configuration is still pending.
Provides information about a pending maintenance action for a resource.
One or more modified settings for an instance.
Represents the input to RebootDBInstance.
No description provided by the author
RebootDBInstanceRequest is the request type for the RebootDBInstance API operation.
RebootDBInstanceResponse is the response type for the RebootDBInstance API operation.
Represents the input to RemoveTagsFromResource.
No description provided by the author
RemoveTagsFromResourceRequest is the request type for the RemoveTagsFromResource API operation.
RemoveTagsFromResourceResponse is the response type for the RemoveTagsFromResource API operation.
Represents the input to ResetDBClusterParameterGroup.
Contains the name of a cluster parameter group.
ResetDBClusterParameterGroupRequest is the request type for the ResetDBClusterParameterGroup API operation.
ResetDBClusterParameterGroupResponse is the response type for the ResetDBClusterParameterGroup API operation.
Represents the output of ApplyPendingMaintenanceAction.
Represents the input to RestoreDBClusterFromSnapshot.
No description provided by the author
RestoreDBClusterFromSnapshotRequest is the request type for the RestoreDBClusterFromSnapshot API operation.
RestoreDBClusterFromSnapshotResponse is the response type for the RestoreDBClusterFromSnapshot API operation.
Represents the input to RestoreDBClusterToPointInTime.
No description provided by the author
RestoreDBClusterToPointInTimeRequest is the request type for the RestoreDBClusterToPointInTime API operation.
RestoreDBClusterToPointInTimeResponse is the response type for the RestoreDBClusterToPointInTime API operation.
No description provided by the author
No description provided by the author
StartDBClusterRequest is the request type for the StartDBCluster API operation.
StartDBClusterResponse is the response type for the StartDBCluster API operation.
No description provided by the author
No description provided by the author
StopDBClusterRequest is the request type for the StopDBCluster API operation.
StopDBClusterResponse is the response type for the StopDBCluster API operation.
Detailed information about a subnet.
Metadata assigned to an Amazon DocumentDB resource consisting of a key-value pair.
The version of the database engine that an instance can be upgraded to.
Used as a response element for queries on virtual private cloud (VPC) security group membership.