@Generated(value="software.amazon.awssdk:codegen") @ThreadSafe public interface DocDbClient extends AwsClient
builder() method.
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.
| Modifier and Type | Field and Description |
|---|---|
static String |
SERVICE_METADATA_ID
Value for looking up the service's metadata from the
ServiceMetadataProvider. |
static String |
SERVICE_NAME |
| Modifier and Type | Method and Description |
|---|---|
default AddSourceIdentifierToSubscriptionResponse |
addSourceIdentifierToSubscription(AddSourceIdentifierToSubscriptionRequest addSourceIdentifierToSubscriptionRequest)
Adds a source identifier to an existing event notification subscription.
|
default AddSourceIdentifierToSubscriptionResponse |
addSourceIdentifierToSubscription(Consumer<AddSourceIdentifierToSubscriptionRequest.Builder> addSourceIdentifierToSubscriptionRequest)
Adds a source identifier to an existing event notification subscription.
|
default AddTagsToResourceResponse |
addTagsToResource(AddTagsToResourceRequest addTagsToResourceRequest)
Adds metadata tags to an Amazon DocumentDB resource.
|
default AddTagsToResourceResponse |
addTagsToResource(Consumer<AddTagsToResourceRequest.Builder> addTagsToResourceRequest)
Adds metadata tags to an Amazon DocumentDB resource.
|
default ApplyPendingMaintenanceActionResponse |
applyPendingMaintenanceAction(ApplyPendingMaintenanceActionRequest applyPendingMaintenanceActionRequest)
Applies a pending maintenance action to a resource (for example, to an Amazon DocumentDB instance).
|
default ApplyPendingMaintenanceActionResponse |
applyPendingMaintenanceAction(Consumer<ApplyPendingMaintenanceActionRequest.Builder> applyPendingMaintenanceActionRequest)
Applies a pending maintenance action to a resource (for example, to an Amazon DocumentDB instance).
|
static DocDbClientBuilder |
builder()
Create a builder that can be used to configure and create a
DocDbClient. |
default CopyDbClusterParameterGroupResponse |
copyDBClusterParameterGroup(Consumer<CopyDbClusterParameterGroupRequest.Builder> copyDbClusterParameterGroupRequest)
Copies the specified cluster parameter group.
|
default CopyDbClusterParameterGroupResponse |
copyDBClusterParameterGroup(CopyDbClusterParameterGroupRequest copyDbClusterParameterGroupRequest)
Copies the specified cluster parameter group.
|
default CopyDbClusterSnapshotResponse |
copyDBClusterSnapshot(Consumer<CopyDbClusterSnapshotRequest.Builder> copyDbClusterSnapshotRequest)
Copies a snapshot of a cluster.
|
default CopyDbClusterSnapshotResponse |
copyDBClusterSnapshot(CopyDbClusterSnapshotRequest copyDbClusterSnapshotRequest)
Copies a snapshot of a cluster.
|
static DocDbClient |
create()
Create a
DocDbClient with the region loaded from the
DefaultAwsRegionProviderChain and credentials loaded from the
DefaultCredentialsProvider. |
default CreateDbClusterResponse |
createDBCluster(Consumer<CreateDbClusterRequest.Builder> createDbClusterRequest)
Creates a new Amazon DocumentDB cluster.
|
default CreateDbClusterResponse |
createDBCluster(CreateDbClusterRequest createDbClusterRequest)
Creates a new Amazon DocumentDB cluster.
|
default CreateDbClusterParameterGroupResponse |
createDBClusterParameterGroup(Consumer<CreateDbClusterParameterGroupRequest.Builder> createDbClusterParameterGroupRequest)
Creates a new cluster parameter group.
|
default CreateDbClusterParameterGroupResponse |
createDBClusterParameterGroup(CreateDbClusterParameterGroupRequest createDbClusterParameterGroupRequest)
Creates a new cluster parameter group.
|
default CreateDbClusterSnapshotResponse |
createDBClusterSnapshot(Consumer<CreateDbClusterSnapshotRequest.Builder> createDbClusterSnapshotRequest)
Creates a snapshot of a cluster.
|
default CreateDbClusterSnapshotResponse |
createDBClusterSnapshot(CreateDbClusterSnapshotRequest createDbClusterSnapshotRequest)
Creates a snapshot of a cluster.
|
default CreateDbInstanceResponse |
createDBInstance(Consumer<CreateDbInstanceRequest.Builder> createDbInstanceRequest)
Creates a new instance.
|
default CreateDbInstanceResponse |
createDBInstance(CreateDbInstanceRequest createDbInstanceRequest)
Creates a new instance.
|
default CreateDbSubnetGroupResponse |
createDBSubnetGroup(Consumer<CreateDbSubnetGroupRequest.Builder> createDbSubnetGroupRequest)
Creates a new subnet group.
|
default CreateDbSubnetGroupResponse |
createDBSubnetGroup(CreateDbSubnetGroupRequest createDbSubnetGroupRequest)
Creates a new subnet group.
|
default CreateEventSubscriptionResponse |
createEventSubscription(Consumer<CreateEventSubscriptionRequest.Builder> createEventSubscriptionRequest)
Creates an Amazon DocumentDB event notification subscription.
|
default CreateEventSubscriptionResponse |
createEventSubscription(CreateEventSubscriptionRequest createEventSubscriptionRequest)
Creates an Amazon DocumentDB event notification subscription.
|
default CreateGlobalClusterResponse |
createGlobalCluster(Consumer<CreateGlobalClusterRequest.Builder> createGlobalClusterRequest)
Creates an Amazon DocumentDB global cluster that can span multiple multiple Amazon Web Services Regions.
|
default CreateGlobalClusterResponse |
createGlobalCluster(CreateGlobalClusterRequest createGlobalClusterRequest)
Creates an Amazon DocumentDB global cluster that can span multiple multiple Amazon Web Services Regions.
|
default DeleteDbClusterResponse |
deleteDBCluster(Consumer<DeleteDbClusterRequest.Builder> deleteDbClusterRequest)
Deletes a previously provisioned cluster.
|
default DeleteDbClusterResponse |
deleteDBCluster(DeleteDbClusterRequest deleteDbClusterRequest)
Deletes a previously provisioned cluster.
|
default DeleteDbClusterParameterGroupResponse |
deleteDBClusterParameterGroup(Consumer<DeleteDbClusterParameterGroupRequest.Builder> deleteDbClusterParameterGroupRequest)
Deletes a specified cluster parameter group.
|
default DeleteDbClusterParameterGroupResponse |
deleteDBClusterParameterGroup(DeleteDbClusterParameterGroupRequest deleteDbClusterParameterGroupRequest)
Deletes a specified cluster parameter group.
|
default DeleteDbClusterSnapshotResponse |
deleteDBClusterSnapshot(Consumer<DeleteDbClusterSnapshotRequest.Builder> deleteDbClusterSnapshotRequest)
Deletes a cluster snapshot.
|
default DeleteDbClusterSnapshotResponse |
deleteDBClusterSnapshot(DeleteDbClusterSnapshotRequest deleteDbClusterSnapshotRequest)
Deletes a cluster snapshot.
|
default DeleteDbInstanceResponse |
deleteDBInstance(Consumer<DeleteDbInstanceRequest.Builder> deleteDbInstanceRequest)
Deletes a previously provisioned instance.
|
default DeleteDbInstanceResponse |
deleteDBInstance(DeleteDbInstanceRequest deleteDbInstanceRequest)
Deletes a previously provisioned instance.
|
default DeleteDbSubnetGroupResponse |
deleteDBSubnetGroup(Consumer<DeleteDbSubnetGroupRequest.Builder> deleteDbSubnetGroupRequest)
Deletes a subnet group.
|
default DeleteDbSubnetGroupResponse |
deleteDBSubnetGroup(DeleteDbSubnetGroupRequest deleteDbSubnetGroupRequest)
Deletes a subnet group.
|
default DeleteEventSubscriptionResponse |
deleteEventSubscription(Consumer<DeleteEventSubscriptionRequest.Builder> deleteEventSubscriptionRequest)
Deletes an Amazon DocumentDB event notification subscription.
|
default DeleteEventSubscriptionResponse |
deleteEventSubscription(DeleteEventSubscriptionRequest deleteEventSubscriptionRequest)
Deletes an Amazon DocumentDB event notification subscription.
|
default DeleteGlobalClusterResponse |
deleteGlobalCluster(Consumer<DeleteGlobalClusterRequest.Builder> deleteGlobalClusterRequest)
Deletes a global cluster.
|
default DeleteGlobalClusterResponse |
deleteGlobalCluster(DeleteGlobalClusterRequest deleteGlobalClusterRequest)
Deletes a global cluster.
|
default DescribeCertificatesResponse |
describeCertificates(Consumer<DescribeCertificatesRequest.Builder> describeCertificatesRequest)
Returns a list of certificate authority (CA) certificates provided by Amazon DocumentDB for this Amazon Web
Services account.
|
default DescribeCertificatesResponse |
describeCertificates(DescribeCertificatesRequest describeCertificatesRequest)
Returns a list of certificate authority (CA) certificates provided by Amazon DocumentDB for this Amazon Web
Services account.
|
default DescribeCertificatesIterable |
describeCertificatesPaginator(Consumer<DescribeCertificatesRequest.Builder> describeCertificatesRequest)
Returns a list of certificate authority (CA) certificates provided by Amazon DocumentDB for this Amazon Web
Services account.
|
default DescribeCertificatesIterable |
describeCertificatesPaginator(DescribeCertificatesRequest describeCertificatesRequest)
Returns a list of certificate authority (CA) certificates provided by Amazon DocumentDB for this Amazon Web
Services account.
|
default DescribeDbClusterParameterGroupsResponse |
describeDBClusterParameterGroups()
Returns a list of
DBClusterParameterGroup descriptions. |
default DescribeDbClusterParameterGroupsResponse |
describeDBClusterParameterGroups(Consumer<DescribeDbClusterParameterGroupsRequest.Builder> describeDbClusterParameterGroupsRequest)
Returns a list of
DBClusterParameterGroup descriptions. |
default DescribeDbClusterParameterGroupsResponse |
describeDBClusterParameterGroups(DescribeDbClusterParameterGroupsRequest describeDbClusterParameterGroupsRequest)
Returns a list of
DBClusterParameterGroup descriptions. |
default DescribeDBClusterParameterGroupsIterable |
describeDBClusterParameterGroupsPaginator()
Returns a list of
DBClusterParameterGroup descriptions. |
default DescribeDBClusterParameterGroupsIterable |
describeDBClusterParameterGroupsPaginator(Consumer<DescribeDbClusterParameterGroupsRequest.Builder> describeDbClusterParameterGroupsRequest)
Returns a list of
DBClusterParameterGroup descriptions. |
default DescribeDBClusterParameterGroupsIterable |
describeDBClusterParameterGroupsPaginator(DescribeDbClusterParameterGroupsRequest describeDbClusterParameterGroupsRequest)
Returns a list of
DBClusterParameterGroup descriptions. |
default DescribeDbClusterParametersResponse |
describeDBClusterParameters(Consumer<DescribeDbClusterParametersRequest.Builder> describeDbClusterParametersRequest)
Returns the detailed parameter list for a particular cluster parameter group.
|
default DescribeDbClusterParametersResponse |
describeDBClusterParameters(DescribeDbClusterParametersRequest describeDbClusterParametersRequest)
Returns the detailed parameter list for a particular cluster parameter group.
|
default DescribeDBClusterParametersIterable |
describeDBClusterParametersPaginator(Consumer<DescribeDbClusterParametersRequest.Builder> describeDbClusterParametersRequest)
Returns the detailed parameter list for a particular cluster parameter group.
|
default DescribeDBClusterParametersIterable |
describeDBClusterParametersPaginator(DescribeDbClusterParametersRequest describeDbClusterParametersRequest)
Returns the detailed parameter list for a particular cluster parameter group.
|
default DescribeDbClustersResponse |
describeDBClusters()
Returns information about provisioned Amazon DocumentDB clusters.
|
default DescribeDbClustersResponse |
describeDBClusters(Consumer<DescribeDbClustersRequest.Builder> describeDbClustersRequest)
Returns information about provisioned Amazon DocumentDB clusters.
|
default DescribeDbClustersResponse |
describeDBClusters(DescribeDbClustersRequest describeDbClustersRequest)
Returns information about provisioned Amazon DocumentDB clusters.
|
default DescribeDbClusterSnapshotAttributesResponse |
describeDBClusterSnapshotAttributes(Consumer<DescribeDbClusterSnapshotAttributesRequest.Builder> describeDbClusterSnapshotAttributesRequest)
Returns a list of cluster snapshot attribute names and values for a manual DB cluster snapshot.
|
default DescribeDbClusterSnapshotAttributesResponse |
describeDBClusterSnapshotAttributes(DescribeDbClusterSnapshotAttributesRequest describeDbClusterSnapshotAttributesRequest)
Returns a list of cluster snapshot attribute names and values for a manual DB cluster snapshot.
|
default DescribeDbClusterSnapshotsResponse |
describeDBClusterSnapshots()
Returns information about cluster snapshots.
|
default DescribeDbClusterSnapshotsResponse |
describeDBClusterSnapshots(Consumer<DescribeDbClusterSnapshotsRequest.Builder> describeDbClusterSnapshotsRequest)
Returns information about cluster snapshots.
|
default DescribeDbClusterSnapshotsResponse |
describeDBClusterSnapshots(DescribeDbClusterSnapshotsRequest describeDbClusterSnapshotsRequest)
Returns information about cluster snapshots.
|
default DescribeDBClusterSnapshotsIterable |
describeDBClusterSnapshotsPaginator()
Returns information about cluster snapshots.
|
default DescribeDBClusterSnapshotsIterable |
describeDBClusterSnapshotsPaginator(Consumer<DescribeDbClusterSnapshotsRequest.Builder> describeDbClusterSnapshotsRequest)
Returns information about cluster snapshots.
|
default DescribeDBClusterSnapshotsIterable |
describeDBClusterSnapshotsPaginator(DescribeDbClusterSnapshotsRequest describeDbClusterSnapshotsRequest)
Returns information about cluster snapshots.
|
default DescribeDBClustersIterable |
describeDBClustersPaginator()
Returns information about provisioned Amazon DocumentDB clusters.
|
default DescribeDBClustersIterable |
describeDBClustersPaginator(Consumer<DescribeDbClustersRequest.Builder> describeDbClustersRequest)
Returns information about provisioned Amazon DocumentDB clusters.
|
default DescribeDBClustersIterable |
describeDBClustersPaginator(DescribeDbClustersRequest describeDbClustersRequest)
Returns information about provisioned Amazon DocumentDB clusters.
|
default DescribeDbEngineVersionsResponse |
describeDBEngineVersions()
Returns a list of the available engines.
|
default DescribeDbEngineVersionsResponse |
describeDBEngineVersions(Consumer<DescribeDbEngineVersionsRequest.Builder> describeDbEngineVersionsRequest)
Returns a list of the available engines.
|
default DescribeDbEngineVersionsResponse |
describeDBEngineVersions(DescribeDbEngineVersionsRequest describeDbEngineVersionsRequest)
Returns a list of the available engines.
|
default DescribeDBEngineVersionsIterable |
describeDBEngineVersionsPaginator()
Returns a list of the available engines.
|
default DescribeDBEngineVersionsIterable |
describeDBEngineVersionsPaginator(Consumer<DescribeDbEngineVersionsRequest.Builder> describeDbEngineVersionsRequest)
Returns a list of the available engines.
|
default DescribeDBEngineVersionsIterable |
describeDBEngineVersionsPaginator(DescribeDbEngineVersionsRequest describeDbEngineVersionsRequest)
Returns a list of the available engines.
|
default DescribeDbInstancesResponse |
describeDBInstances()
Returns information about provisioned Amazon DocumentDB instances.
|
default DescribeDbInstancesResponse |
describeDBInstances(Consumer<DescribeDbInstancesRequest.Builder> describeDbInstancesRequest)
Returns information about provisioned Amazon DocumentDB instances.
|
default DescribeDbInstancesResponse |
describeDBInstances(DescribeDbInstancesRequest describeDbInstancesRequest)
Returns information about provisioned Amazon DocumentDB instances.
|
default DescribeDBInstancesIterable |
describeDBInstancesPaginator()
Returns information about provisioned Amazon DocumentDB instances.
|
default DescribeDBInstancesIterable |
describeDBInstancesPaginator(Consumer<DescribeDbInstancesRequest.Builder> describeDbInstancesRequest)
Returns information about provisioned Amazon DocumentDB instances.
|
default DescribeDBInstancesIterable |
describeDBInstancesPaginator(DescribeDbInstancesRequest describeDbInstancesRequest)
Returns information about provisioned Amazon DocumentDB instances.
|
default DescribeDbSubnetGroupsResponse |
describeDBSubnetGroups()
Returns a list of
DBSubnetGroup descriptions. |
default DescribeDbSubnetGroupsResponse |
describeDBSubnetGroups(Consumer<DescribeDbSubnetGroupsRequest.Builder> describeDbSubnetGroupsRequest)
Returns a list of
DBSubnetGroup descriptions. |
default DescribeDbSubnetGroupsResponse |
describeDBSubnetGroups(DescribeDbSubnetGroupsRequest describeDbSubnetGroupsRequest)
Returns a list of
DBSubnetGroup descriptions. |
default DescribeDBSubnetGroupsIterable |
describeDBSubnetGroupsPaginator()
Returns a list of
DBSubnetGroup descriptions. |
default DescribeDBSubnetGroupsIterable |
describeDBSubnetGroupsPaginator(Consumer<DescribeDbSubnetGroupsRequest.Builder> describeDbSubnetGroupsRequest)
Returns a list of
DBSubnetGroup descriptions. |
default DescribeDBSubnetGroupsIterable |
describeDBSubnetGroupsPaginator(DescribeDbSubnetGroupsRequest describeDbSubnetGroupsRequest)
Returns a list of
DBSubnetGroup descriptions. |
default DescribeEngineDefaultClusterParametersResponse |
describeEngineDefaultClusterParameters(Consumer<DescribeEngineDefaultClusterParametersRequest.Builder> describeEngineDefaultClusterParametersRequest)
Returns the default engine and system parameter information for the cluster database engine.
|
default DescribeEngineDefaultClusterParametersResponse |
describeEngineDefaultClusterParameters(DescribeEngineDefaultClusterParametersRequest describeEngineDefaultClusterParametersRequest)
Returns the default engine and system parameter information for the cluster database engine.
|
default DescribeEventCategoriesResponse |
describeEventCategories()
Displays a list of categories for all event source types, or, if specified, for a specified source type.
|
default DescribeEventCategoriesResponse |
describeEventCategories(Consumer<DescribeEventCategoriesRequest.Builder> describeEventCategoriesRequest)
Displays a list of categories for all event source types, or, if specified, for a specified source type.
|
default DescribeEventCategoriesResponse |
describeEventCategories(DescribeEventCategoriesRequest describeEventCategoriesRequest)
Displays a list of categories for all event source types, or, if specified, for a specified source type.
|
default DescribeEventsResponse |
describeEvents()
Returns events related to instances, security groups, snapshots, and DB parameter groups for the past 14 days.
|
default DescribeEventsResponse |
describeEvents(Consumer<DescribeEventsRequest.Builder> describeEventsRequest)
Returns events related to instances, security groups, snapshots, and DB parameter groups for the past 14 days.
|
default DescribeEventsResponse |
describeEvents(DescribeEventsRequest describeEventsRequest)
Returns events related to instances, security groups, snapshots, and DB parameter groups for the past 14 days.
|
default DescribeEventsIterable |
describeEventsPaginator()
Returns events related to instances, security groups, snapshots, and DB parameter groups for the past 14 days.
|
default DescribeEventsIterable |
describeEventsPaginator(Consumer<DescribeEventsRequest.Builder> describeEventsRequest)
Returns events related to instances, security groups, snapshots, and DB parameter groups for the past 14 days.
|
default DescribeEventsIterable |
describeEventsPaginator(DescribeEventsRequest describeEventsRequest)
Returns events related to instances, security groups, snapshots, and DB parameter groups for the past 14 days.
|
default DescribeEventSubscriptionsResponse |
describeEventSubscriptions(Consumer<DescribeEventSubscriptionsRequest.Builder> describeEventSubscriptionsRequest)
Lists all the subscription descriptions for a customer account.
|
default DescribeEventSubscriptionsResponse |
describeEventSubscriptions(DescribeEventSubscriptionsRequest describeEventSubscriptionsRequest)
Lists all the subscription descriptions for a customer account.
|
default DescribeEventSubscriptionsIterable |
describeEventSubscriptionsPaginator(Consumer<DescribeEventSubscriptionsRequest.Builder> describeEventSubscriptionsRequest)
Lists all the subscription descriptions for a customer account.
|
default DescribeEventSubscriptionsIterable |
describeEventSubscriptionsPaginator(DescribeEventSubscriptionsRequest describeEventSubscriptionsRequest)
Lists all the subscription descriptions for a customer account.
|
default DescribeGlobalClustersResponse |
describeGlobalClusters(Consumer<DescribeGlobalClustersRequest.Builder> describeGlobalClustersRequest)
Returns information about Amazon DocumentDB global clusters.
|
default DescribeGlobalClustersResponse |
describeGlobalClusters(DescribeGlobalClustersRequest describeGlobalClustersRequest)
Returns information about Amazon DocumentDB global clusters.
|
default DescribeGlobalClustersIterable |
describeGlobalClustersPaginator(Consumer<DescribeGlobalClustersRequest.Builder> describeGlobalClustersRequest)
Returns information about Amazon DocumentDB global clusters.
|
default DescribeGlobalClustersIterable |
describeGlobalClustersPaginator(DescribeGlobalClustersRequest describeGlobalClustersRequest)
Returns information about Amazon DocumentDB global clusters.
|
default DescribeOrderableDbInstanceOptionsResponse |
describeOrderableDBInstanceOptions(Consumer<DescribeOrderableDbInstanceOptionsRequest.Builder> describeOrderableDbInstanceOptionsRequest)
Returns a list of orderable instance options for the specified engine.
|
default DescribeOrderableDbInstanceOptionsResponse |
describeOrderableDBInstanceOptions(DescribeOrderableDbInstanceOptionsRequest describeOrderableDbInstanceOptionsRequest)
Returns a list of orderable instance options for the specified engine.
|
default DescribeOrderableDBInstanceOptionsIterable |
describeOrderableDBInstanceOptionsPaginator(Consumer<DescribeOrderableDbInstanceOptionsRequest.Builder> describeOrderableDbInstanceOptionsRequest)
Returns a list of orderable instance options for the specified engine.
|
default DescribeOrderableDBInstanceOptionsIterable |
describeOrderableDBInstanceOptionsPaginator(DescribeOrderableDbInstanceOptionsRequest describeOrderableDbInstanceOptionsRequest)
Returns a list of orderable instance options for the specified engine.
|
default DescribePendingMaintenanceActionsResponse |
describePendingMaintenanceActions()
Returns a list of resources (for example, instances) that have at least one pending maintenance action.
|
default DescribePendingMaintenanceActionsResponse |
describePendingMaintenanceActions(Consumer<DescribePendingMaintenanceActionsRequest.Builder> describePendingMaintenanceActionsRequest)
Returns a list of resources (for example, instances) that have at least one pending maintenance action.
|
default DescribePendingMaintenanceActionsResponse |
describePendingMaintenanceActions(DescribePendingMaintenanceActionsRequest describePendingMaintenanceActionsRequest)
Returns a list of resources (for example, instances) that have at least one pending maintenance action.
|
default DescribePendingMaintenanceActionsIterable |
describePendingMaintenanceActionsPaginator()
Returns a list of resources (for example, instances) that have at least one pending maintenance action.
|
default DescribePendingMaintenanceActionsIterable |
describePendingMaintenanceActionsPaginator(Consumer<DescribePendingMaintenanceActionsRequest.Builder> describePendingMaintenanceActionsRequest)
Returns a list of resources (for example, instances) that have at least one pending maintenance action.
|
default DescribePendingMaintenanceActionsIterable |
describePendingMaintenanceActionsPaginator(DescribePendingMaintenanceActionsRequest describePendingMaintenanceActionsRequest)
Returns a list of resources (for example, instances) that have at least one pending maintenance action.
|
default FailoverDbClusterResponse |
failoverDBCluster(Consumer<FailoverDbClusterRequest.Builder> failoverDbClusterRequest)
Forces a failover for a cluster.
|
default FailoverDbClusterResponse |
failoverDBCluster(FailoverDbClusterRequest failoverDbClusterRequest)
Forces a failover for a cluster.
|
default ListTagsForResourceResponse |
listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest)
Lists all tags on an Amazon DocumentDB resource.
|
default ListTagsForResourceResponse |
listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)
Lists all tags on an Amazon DocumentDB resource.
|
default ModifyDbClusterResponse |
modifyDBCluster(Consumer<ModifyDbClusterRequest.Builder> modifyDbClusterRequest)
Modifies a setting for an Amazon DocumentDB cluster.
|
default ModifyDbClusterResponse |
modifyDBCluster(ModifyDbClusterRequest modifyDbClusterRequest)
Modifies a setting for an Amazon DocumentDB cluster.
|
default ModifyDbClusterParameterGroupResponse |
modifyDBClusterParameterGroup(Consumer<ModifyDbClusterParameterGroupRequest.Builder> modifyDbClusterParameterGroupRequest)
Modifies the parameters of a cluster parameter group.
|
default ModifyDbClusterParameterGroupResponse |
modifyDBClusterParameterGroup(ModifyDbClusterParameterGroupRequest modifyDbClusterParameterGroupRequest)
Modifies the parameters of a cluster parameter group.
|
default ModifyDbClusterSnapshotAttributeResponse |
modifyDBClusterSnapshotAttribute(Consumer<ModifyDbClusterSnapshotAttributeRequest.Builder> modifyDbClusterSnapshotAttributeRequest)
Adds an attribute and values to, or removes an attribute and values from, a manual cluster snapshot.
|
default ModifyDbClusterSnapshotAttributeResponse |
modifyDBClusterSnapshotAttribute(ModifyDbClusterSnapshotAttributeRequest modifyDbClusterSnapshotAttributeRequest)
Adds an attribute and values to, or removes an attribute and values from, a manual cluster snapshot.
|
default ModifyDbInstanceResponse |
modifyDBInstance(Consumer<ModifyDbInstanceRequest.Builder> modifyDbInstanceRequest)
Modifies settings for an instance.
|
default ModifyDbInstanceResponse |
modifyDBInstance(ModifyDbInstanceRequest modifyDbInstanceRequest)
Modifies settings for an instance.
|
default ModifyDbSubnetGroupResponse |
modifyDBSubnetGroup(Consumer<ModifyDbSubnetGroupRequest.Builder> modifyDbSubnetGroupRequest)
Modifies an existing subnet group.
|
default ModifyDbSubnetGroupResponse |
modifyDBSubnetGroup(ModifyDbSubnetGroupRequest modifyDbSubnetGroupRequest)
Modifies an existing subnet group.
|
default ModifyEventSubscriptionResponse |
modifyEventSubscription(Consumer<ModifyEventSubscriptionRequest.Builder> modifyEventSubscriptionRequest)
Modifies an existing Amazon DocumentDB event notification subscription.
|
default ModifyEventSubscriptionResponse |
modifyEventSubscription(ModifyEventSubscriptionRequest modifyEventSubscriptionRequest)
Modifies an existing Amazon DocumentDB event notification subscription.
|
default ModifyGlobalClusterResponse |
modifyGlobalCluster(Consumer<ModifyGlobalClusterRequest.Builder> modifyGlobalClusterRequest)
Modify a setting for an Amazon DocumentDB global cluster.
|
default ModifyGlobalClusterResponse |
modifyGlobalCluster(ModifyGlobalClusterRequest modifyGlobalClusterRequest)
Modify a setting for an Amazon DocumentDB global cluster.
|
default RebootDbInstanceResponse |
rebootDBInstance(Consumer<RebootDbInstanceRequest.Builder> rebootDbInstanceRequest)
You might need to reboot your instance, usually for maintenance reasons.
|
default RebootDbInstanceResponse |
rebootDBInstance(RebootDbInstanceRequest rebootDbInstanceRequest)
You might need to reboot your instance, usually for maintenance reasons.
|
default RemoveFromGlobalClusterResponse |
removeFromGlobalCluster(Consumer<RemoveFromGlobalClusterRequest.Builder> removeFromGlobalClusterRequest)
Detaches an Amazon DocumentDB secondary cluster from a global cluster.
|
default RemoveFromGlobalClusterResponse |
removeFromGlobalCluster(RemoveFromGlobalClusterRequest removeFromGlobalClusterRequest)
Detaches an Amazon DocumentDB secondary cluster from a global cluster.
|
default RemoveSourceIdentifierFromSubscriptionResponse |
removeSourceIdentifierFromSubscription(Consumer<RemoveSourceIdentifierFromSubscriptionRequest.Builder> removeSourceIdentifierFromSubscriptionRequest)
Removes a source identifier from an existing Amazon DocumentDB event notification subscription.
|
default RemoveSourceIdentifierFromSubscriptionResponse |
removeSourceIdentifierFromSubscription(RemoveSourceIdentifierFromSubscriptionRequest removeSourceIdentifierFromSubscriptionRequest)
Removes a source identifier from an existing Amazon DocumentDB event notification subscription.
|
default RemoveTagsFromResourceResponse |
removeTagsFromResource(Consumer<RemoveTagsFromResourceRequest.Builder> removeTagsFromResourceRequest)
Removes metadata tags from an Amazon DocumentDB resource.
|
default RemoveTagsFromResourceResponse |
removeTagsFromResource(RemoveTagsFromResourceRequest removeTagsFromResourceRequest)
Removes metadata tags from an Amazon DocumentDB resource.
|
default ResetDbClusterParameterGroupResponse |
resetDBClusterParameterGroup(Consumer<ResetDbClusterParameterGroupRequest.Builder> resetDbClusterParameterGroupRequest)
Modifies the parameters of a cluster parameter group to the default value.
|
default ResetDbClusterParameterGroupResponse |
resetDBClusterParameterGroup(ResetDbClusterParameterGroupRequest resetDbClusterParameterGroupRequest)
Modifies the parameters of a cluster parameter group to the default value.
|
default RestoreDbClusterFromSnapshotResponse |
restoreDBClusterFromSnapshot(Consumer<RestoreDbClusterFromSnapshotRequest.Builder> restoreDbClusterFromSnapshotRequest)
Creates a new cluster from a snapshot or cluster snapshot.
|
default RestoreDbClusterFromSnapshotResponse |
restoreDBClusterFromSnapshot(RestoreDbClusterFromSnapshotRequest restoreDbClusterFromSnapshotRequest)
Creates a new cluster from a snapshot or cluster snapshot.
|
default RestoreDbClusterToPointInTimeResponse |
restoreDBClusterToPointInTime(Consumer<RestoreDbClusterToPointInTimeRequest.Builder> restoreDbClusterToPointInTimeRequest)
Restores a cluster to an arbitrary point in time.
|
default RestoreDbClusterToPointInTimeResponse |
restoreDBClusterToPointInTime(RestoreDbClusterToPointInTimeRequest restoreDbClusterToPointInTimeRequest)
Restores a cluster to an arbitrary point in time.
|
default DocDbServiceClientConfiguration |
serviceClientConfiguration() |
static ServiceMetadata |
serviceMetadata() |
default StartDbClusterResponse |
startDBCluster(Consumer<StartDbClusterRequest.Builder> startDbClusterRequest)
Restarts the stopped cluster that is specified by
DBClusterIdentifier. |
default StartDbClusterResponse |
startDBCluster(StartDbClusterRequest startDbClusterRequest)
Restarts the stopped cluster that is specified by
DBClusterIdentifier. |
default StopDbClusterResponse |
stopDBCluster(Consumer<StopDbClusterRequest.Builder> stopDbClusterRequest)
Stops the running cluster that is specified by
DBClusterIdentifier. |
default StopDbClusterResponse |
stopDBCluster(StopDbClusterRequest stopDbClusterRequest)
Stops the running cluster that is specified by
DBClusterIdentifier. |
default DocDbWaiter |
waiter()
Create an instance of
DocDbWaiter using this client. |
serviceNameclosestatic final String SERVICE_NAME
static final String SERVICE_METADATA_ID
ServiceMetadataProvider.default AddSourceIdentifierToSubscriptionResponse addSourceIdentifierToSubscription(AddSourceIdentifierToSubscriptionRequest addSourceIdentifierToSubscriptionRequest) throws SubscriptionNotFoundException, SourceNotFoundException, AwsServiceException, SdkClientException, DocDbException
Adds a source identifier to an existing event notification subscription.
addSourceIdentifierToSubscriptionRequest - Represents the input to AddSourceIdentifierToSubscription.SubscriptionNotFoundException - The subscription name does not exist.SourceNotFoundException - The requested source could not be found.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.DocDbException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault AddSourceIdentifierToSubscriptionResponse addSourceIdentifierToSubscription(Consumer<AddSourceIdentifierToSubscriptionRequest.Builder> addSourceIdentifierToSubscriptionRequest) throws SubscriptionNotFoundException, SourceNotFoundException, AwsServiceException, SdkClientException, DocDbException
Adds a source identifier to an existing event notification subscription.
This is a convenience which creates an instance of the AddSourceIdentifierToSubscriptionRequest.Builder
avoiding the need to create one manually via AddSourceIdentifierToSubscriptionRequest.builder()
addSourceIdentifierToSubscriptionRequest - A Consumer that will call methods on AddSourceIdentifierToSubscriptionMessage.Builder to
create a request. Represents the input to AddSourceIdentifierToSubscription.SubscriptionNotFoundException - The subscription name does not exist.SourceNotFoundException - The requested source could not be found.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.DocDbException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault AddTagsToResourceResponse addTagsToResource(AddTagsToResourceRequest addTagsToResourceRequest) throws DbInstanceNotFoundException, DbSnapshotNotFoundException, DbClusterNotFoundException, AwsServiceException, SdkClientException, DocDbException
Adds metadata tags to an Amazon DocumentDB resource. You can use these tags with cost allocation reporting to
track costs that are associated with Amazon DocumentDB resources or in a Condition statement in an
Identity and Access Management (IAM) policy for Amazon DocumentDB.
addTagsToResourceRequest - Represents the input to AddTagsToResource.DbInstanceNotFoundException - DBInstanceIdentifier doesn't refer to an existing instance.DbSnapshotNotFoundException - DBSnapshotIdentifier doesn't refer to an existing snapshot.DbClusterNotFoundException - DBClusterIdentifier doesn't refer to an existing cluster.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.DocDbException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault AddTagsToResourceResponse addTagsToResource(Consumer<AddTagsToResourceRequest.Builder> addTagsToResourceRequest) throws DbInstanceNotFoundException, DbSnapshotNotFoundException, DbClusterNotFoundException, AwsServiceException, SdkClientException, DocDbException
Adds metadata tags to an Amazon DocumentDB resource. You can use these tags with cost allocation reporting to
track costs that are associated with Amazon DocumentDB resources or in a Condition statement in an
Identity and Access Management (IAM) policy for Amazon DocumentDB.
This is a convenience which creates an instance of the AddTagsToResourceRequest.Builder avoiding the need
to create one manually via AddTagsToResourceRequest.builder()
addTagsToResourceRequest - A Consumer that will call methods on AddTagsToResourceMessage.Builder to create a request.
Represents the input to AddTagsToResource.DbInstanceNotFoundException - DBInstanceIdentifier doesn't refer to an existing instance.DbSnapshotNotFoundException - DBSnapshotIdentifier doesn't refer to an existing snapshot.DbClusterNotFoundException - DBClusterIdentifier doesn't refer to an existing cluster.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.DocDbException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ApplyPendingMaintenanceActionResponse applyPendingMaintenanceAction(ApplyPendingMaintenanceActionRequest applyPendingMaintenanceActionRequest) throws ResourceNotFoundException, InvalidDbClusterStateException, InvalidDbInstanceStateException, AwsServiceException, SdkClientException, DocDbException
Applies a pending maintenance action to a resource (for example, to an Amazon DocumentDB instance).
applyPendingMaintenanceActionRequest - Represents the input to ApplyPendingMaintenanceAction.ResourceNotFoundException - The specified resource ID was not found.InvalidDbClusterStateException - The cluster isn't in a valid state.InvalidDbInstanceStateException - The specified instance isn't in the available state.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.DocDbException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ApplyPendingMaintenanceActionResponse applyPendingMaintenanceAction(Consumer<ApplyPendingMaintenanceActionRequest.Builder> applyPendingMaintenanceActionRequest) throws ResourceNotFoundException, InvalidDbClusterStateException, InvalidDbInstanceStateException, AwsServiceException, SdkClientException, DocDbException
Applies a pending maintenance action to a resource (for example, to an Amazon DocumentDB instance).
This is a convenience which creates an instance of the ApplyPendingMaintenanceActionRequest.Builder
avoiding the need to create one manually via ApplyPendingMaintenanceActionRequest.builder()
applyPendingMaintenanceActionRequest - A Consumer that will call methods on ApplyPendingMaintenanceActionMessage.Builder to
create a request. Represents the input to ApplyPendingMaintenanceAction.ResourceNotFoundException - The specified resource ID was not found.InvalidDbClusterStateException - The cluster isn't in a valid state.InvalidDbInstanceStateException - The specified instance isn't in the available state.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.DocDbException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault CopyDbClusterParameterGroupResponse copyDBClusterParameterGroup(CopyDbClusterParameterGroupRequest copyDbClusterParameterGroupRequest) throws DbParameterGroupNotFoundException, DbParameterGroupQuotaExceededException, DbParameterGroupAlreadyExistsException, AwsServiceException, SdkClientException, DocDbException
Copies the specified cluster parameter group.
copyDbClusterParameterGroupRequest - Represents the input to CopyDBClusterParameterGroup.DbParameterGroupNotFoundException - DBParameterGroupName doesn't refer to an existing parameter group.DbParameterGroupQuotaExceededException - This request would cause you to exceed the allowed number of parameter groups.DbParameterGroupAlreadyExistsException - A parameter group with the same name already exists.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.DocDbException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault CopyDbClusterParameterGroupResponse copyDBClusterParameterGroup(Consumer<CopyDbClusterParameterGroupRequest.Builder> copyDbClusterParameterGroupRequest) throws DbParameterGroupNotFoundException, DbParameterGroupQuotaExceededException, DbParameterGroupAlreadyExistsException, AwsServiceException, SdkClientException, DocDbException
Copies the specified cluster parameter group.
This is a convenience which creates an instance of the CopyDbClusterParameterGroupRequest.Builder
avoiding the need to create one manually via CopyDbClusterParameterGroupRequest.builder()
copyDbClusterParameterGroupRequest - A Consumer that will call methods on CopyDBClusterParameterGroupMessage.Builder to create
a request. Represents the input to CopyDBClusterParameterGroup.DbParameterGroupNotFoundException - DBParameterGroupName doesn't refer to an existing parameter group.DbParameterGroupQuotaExceededException - This request would cause you to exceed the allowed number of parameter groups.DbParameterGroupAlreadyExistsException - A parameter group with the same name already exists.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.DocDbException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault CopyDbClusterSnapshotResponse copyDBClusterSnapshot(CopyDbClusterSnapshotRequest copyDbClusterSnapshotRequest) throws DbClusterSnapshotAlreadyExistsException, DbClusterSnapshotNotFoundException, InvalidDbClusterStateException, InvalidDbClusterSnapshotStateException, SnapshotQuotaExceededException, KmsKeyNotAccessibleException, AwsServiceException, SdkClientException, DocDbException
Copies a snapshot of a cluster.
To copy a cluster snapshot from a shared manual cluster snapshot, SourceDBClusterSnapshotIdentifier
must be the Amazon Resource Name (ARN) of the shared cluster snapshot. You can only copy a shared DB cluster
snapshot, whether encrypted or not, in the same Amazon Web Services Region.
To cancel the copy operation after it is in progress, delete the target cluster snapshot identified by
TargetDBClusterSnapshotIdentifier while that cluster snapshot is in the copying status.
copyDbClusterSnapshotRequest - Represents the input to CopyDBClusterSnapshot.DbClusterSnapshotAlreadyExistsException - You already have a cluster snapshot with the given identifier.DbClusterSnapshotNotFoundException - DBClusterSnapshotIdentifier doesn't refer to an existing cluster snapshot.InvalidDbClusterStateException - The cluster isn't in a valid state.InvalidDbClusterSnapshotStateException - The provided value isn't a valid cluster snapshot state.SnapshotQuotaExceededException - The request would cause you to exceed the allowed number of snapshots.KmsKeyNotAccessibleException - An error occurred when accessing an KMS key.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.DocDbException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault CopyDbClusterSnapshotResponse copyDBClusterSnapshot(Consumer<CopyDbClusterSnapshotRequest.Builder> copyDbClusterSnapshotRequest) throws DbClusterSnapshotAlreadyExistsException, DbClusterSnapshotNotFoundException, InvalidDbClusterStateException, InvalidDbClusterSnapshotStateException, SnapshotQuotaExceededException, KmsKeyNotAccessibleException, AwsServiceException, SdkClientException, DocDbException
Copies a snapshot of a cluster.
To copy a cluster snapshot from a shared manual cluster snapshot, SourceDBClusterSnapshotIdentifier
must be the Amazon Resource Name (ARN) of the shared cluster snapshot. You can only copy a shared DB cluster
snapshot, whether encrypted or not, in the same Amazon Web Services Region.
To cancel the copy operation after it is in progress, delete the target cluster snapshot identified by
TargetDBClusterSnapshotIdentifier while that cluster snapshot is in the copying status.
This is a convenience which creates an instance of the CopyDbClusterSnapshotRequest.Builder avoiding the
need to create one manually via CopyDbClusterSnapshotRequest.builder()
copyDbClusterSnapshotRequest - A Consumer that will call methods on CopyDBClusterSnapshotMessage.Builder to create a
request. Represents the input to CopyDBClusterSnapshot.DbClusterSnapshotAlreadyExistsException - You already have a cluster snapshot with the given identifier.DbClusterSnapshotNotFoundException - DBClusterSnapshotIdentifier doesn't refer to an existing cluster snapshot.InvalidDbClusterStateException - The cluster isn't in a valid state.InvalidDbClusterSnapshotStateException - The provided value isn't a valid cluster snapshot state.SnapshotQuotaExceededException - The request would cause you to exceed the allowed number of snapshots.KmsKeyNotAccessibleException - An error occurred when accessing an KMS key.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.DocDbException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault CreateDbClusterResponse createDBCluster(CreateDbClusterRequest createDbClusterRequest) throws DbClusterAlreadyExistsException, InsufficientStorageClusterCapacityException, DbClusterQuotaExceededException, StorageQuotaExceededException, DbSubnetGroupNotFoundException, InvalidVpcNetworkStateException, InvalidDbClusterStateException, InvalidDbSubnetGroupStateException, InvalidSubnetException, InvalidDbInstanceStateException, DbClusterParameterGroupNotFoundException, KmsKeyNotAccessibleException, DbClusterNotFoundException, DbInstanceNotFoundException, DbSubnetGroupDoesNotCoverEnoughAZsException, GlobalClusterNotFoundException, InvalidGlobalClusterStateException, AwsServiceException, SdkClientException, DocDbException
Creates a new Amazon DocumentDB cluster.
createDbClusterRequest - Represents the input to CreateDBCluster.DbClusterAlreadyExistsException - You already have a cluster with the given identifier.InsufficientStorageClusterCapacityException - There is not enough storage available for the current action. You might be able to resolve this error by
updating your subnet group to use different Availability Zones that have more storage available.DbClusterQuotaExceededException - The cluster can't be created because you have reached the maximum allowed quota of clusters.StorageQuotaExceededException - The request would cause you to exceed the allowed amount of storage available across all instances.DbSubnetGroupNotFoundException - DBSubnetGroupName doesn't refer to an existing subnet group.InvalidVpcNetworkStateException - The subnet group doesn't cover all Availability Zones after it is created because of changes that were
made.InvalidDbClusterStateException - The cluster isn't in a valid state.InvalidDbSubnetGroupStateException - The subnet group can't be deleted because it's in use.InvalidSubnetException - The requested subnet is not valid, or multiple subnets were requested that are not all in a common
virtual private cloud (VPC).InvalidDbInstanceStateException - The specified instance isn't in the available state.DbClusterParameterGroupNotFoundException - DBClusterParameterGroupName doesn't refer to an existing cluster parameter group.KmsKeyNotAccessibleException - An error occurred when accessing an KMS key.DbClusterNotFoundException - DBClusterIdentifier doesn't refer to an existing cluster.DbInstanceNotFoundException - DBInstanceIdentifier doesn't refer to an existing instance.DbSubnetGroupDoesNotCoverEnoughAZsException - Subnets in the subnet group should cover at least two Availability Zones unless there is only one
Availability Zone.GlobalClusterNotFoundException - The GlobalClusterIdentifier doesn't refer to an existing global cluster.InvalidGlobalClusterStateException - The requested operation can't be performed while the cluster is in this state.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.DocDbException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault CreateDbClusterResponse createDBCluster(Consumer<CreateDbClusterRequest.Builder> createDbClusterRequest) throws DbClusterAlreadyExistsException, InsufficientStorageClusterCapacityException, DbClusterQuotaExceededException, StorageQuotaExceededException, DbSubnetGroupNotFoundException, InvalidVpcNetworkStateException, InvalidDbClusterStateException, InvalidDbSubnetGroupStateException, InvalidSubnetException, InvalidDbInstanceStateException, DbClusterParameterGroupNotFoundException, KmsKeyNotAccessibleException, DbClusterNotFoundException, DbInstanceNotFoundException, DbSubnetGroupDoesNotCoverEnoughAZsException, GlobalClusterNotFoundException, InvalidGlobalClusterStateException, AwsServiceException, SdkClientException, DocDbException
Creates a new Amazon DocumentDB cluster.
This is a convenience which creates an instance of the CreateDbClusterRequest.Builder avoiding the need
to create one manually via CreateDbClusterRequest.builder()
createDbClusterRequest - A Consumer that will call methods on CreateDBClusterMessage.Builder to create a request.
Represents the input to CreateDBCluster.DbClusterAlreadyExistsException - You already have a cluster with the given identifier.InsufficientStorageClusterCapacityException - There is not enough storage available for the current action. You might be able to resolve this error by
updating your subnet group to use different Availability Zones that have more storage available.DbClusterQuotaExceededException - The cluster can't be created because you have reached the maximum allowed quota of clusters.StorageQuotaExceededException - The request would cause you to exceed the allowed amount of storage available across all instances.DbSubnetGroupNotFoundException - DBSubnetGroupName doesn't refer to an existing subnet group.InvalidVpcNetworkStateException - The subnet group doesn't cover all Availability Zones after it is created because of changes that were
made.InvalidDbClusterStateException - The cluster isn't in a valid state.InvalidDbSubnetGroupStateException - The subnet group can't be deleted because it's in use.InvalidSubnetException - The requested subnet is not valid, or multiple subnets were requested that are not all in a common
virtual private cloud (VPC).InvalidDbInstanceStateException - The specified instance isn't in the available state.DbClusterParameterGroupNotFoundException - DBClusterParameterGroupName doesn't refer to an existing cluster parameter group.KmsKeyNotAccessibleException - An error occurred when accessing an KMS key.DbClusterNotFoundException - DBClusterIdentifier doesn't refer to an existing cluster.DbInstanceNotFoundException - DBInstanceIdentifier doesn't refer to an existing instance.DbSubnetGroupDoesNotCoverEnoughAZsException - Subnets in the subnet group should cover at least two Availability Zones unless there is only one
Availability Zone.GlobalClusterNotFoundException - The GlobalClusterIdentifier doesn't refer to an existing global cluster.InvalidGlobalClusterStateException - The requested operation can't be performed while the cluster is in this state.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.DocDbException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault CreateDbClusterParameterGroupResponse createDBClusterParameterGroup(CreateDbClusterParameterGroupRequest createDbClusterParameterGroupRequest) throws DbParameterGroupQuotaExceededException, DbParameterGroupAlreadyExistsException, AwsServiceException, SdkClientException, DocDbException
Creates a new cluster parameter group.
Parameters in a cluster parameter group apply to all of the instances in a cluster.
A cluster parameter group is initially created with the default parameters for the database engine used by
instances in the cluster. In Amazon DocumentDB, you cannot make modifications directly to the
default.docdb3.6 cluster parameter group. If your Amazon DocumentDB cluster is using the default
cluster parameter group and you want to modify a value in it, you must first create a
new parameter group or copy an
existing parameter group, modify it, and then apply the modified parameter group to your cluster. For the new
cluster parameter group and associated settings to take effect, you must then reboot the instances in the cluster
without failover. For more information, see
Modifying Amazon DocumentDB Cluster Parameter Groups.
createDbClusterParameterGroupRequest - Represents the input of CreateDBClusterParameterGroup.DbParameterGroupQuotaExceededException - This request would cause you to exceed the allowed number of parameter groups.DbParameterGroupAlreadyExistsException - A parameter group with the same name already exists.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.DocDbException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault CreateDbClusterParameterGroupResponse createDBClusterParameterGroup(Consumer<CreateDbClusterParameterGroupRequest.Builder> createDbClusterParameterGroupRequest) throws DbParameterGroupQuotaExceededException, DbParameterGroupAlreadyExistsException, AwsServiceException, SdkClientException, DocDbException
Creates a new cluster parameter group.
Parameters in a cluster parameter group apply to all of the instances in a cluster.
A cluster parameter group is initially created with the default parameters for the database engine used by
instances in the cluster. In Amazon DocumentDB, you cannot make modifications directly to the
default.docdb3.6 cluster parameter group. If your Amazon DocumentDB cluster is using the default
cluster parameter group and you want to modify a value in it, you must first create a
new parameter group or copy an
existing parameter group, modify it, and then apply the modified parameter group to your cluster. For the new
cluster parameter group and associated settings to take effect, you must then reboot the instances in the cluster
without failover. For more information, see
Modifying Amazon DocumentDB Cluster Parameter Groups.
This is a convenience which creates an instance of the CreateDbClusterParameterGroupRequest.Builder
avoiding the need to create one manually via CreateDbClusterParameterGroupRequest.builder()
createDbClusterParameterGroupRequest - A Consumer that will call methods on CreateDBClusterParameterGroupMessage.Builder to
create a request. Represents the input of CreateDBClusterParameterGroup.DbParameterGroupQuotaExceededException - This request would cause you to exceed the allowed number of parameter groups.DbParameterGroupAlreadyExistsException - A parameter group with the same name already exists.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.DocDbException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault CreateDbClusterSnapshotResponse createDBClusterSnapshot(CreateDbClusterSnapshotRequest createDbClusterSnapshotRequest) throws DbClusterSnapshotAlreadyExistsException, InvalidDbClusterStateException, DbClusterNotFoundException, SnapshotQuotaExceededException, InvalidDbClusterSnapshotStateException, AwsServiceException, SdkClientException, DocDbException
Creates a snapshot of a cluster.
createDbClusterSnapshotRequest - Represents the input of CreateDBClusterSnapshot.DbClusterSnapshotAlreadyExistsException - You already have a cluster snapshot with the given identifier.InvalidDbClusterStateException - The cluster isn't in a valid state.DbClusterNotFoundException - DBClusterIdentifier doesn't refer to an existing cluster.SnapshotQuotaExceededException - The request would cause you to exceed the allowed number of snapshots.InvalidDbClusterSnapshotStateException - The provided value isn't a valid cluster snapshot state.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.DocDbException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault CreateDbClusterSnapshotResponse createDBClusterSnapshot(Consumer<CreateDbClusterSnapshotRequest.Builder> createDbClusterSnapshotRequest) throws DbClusterSnapshotAlreadyExistsException, InvalidDbClusterStateException, DbClusterNotFoundException, SnapshotQuotaExceededException, InvalidDbClusterSnapshotStateException, AwsServiceException, SdkClientException, DocDbException
Creates a snapshot of a cluster.
This is a convenience which creates an instance of the CreateDbClusterSnapshotRequest.Builder avoiding
the need to create one manually via CreateDbClusterSnapshotRequest.builder()
createDbClusterSnapshotRequest - A Consumer that will call methods on CreateDBClusterSnapshotMessage.Builder to create a
request. Represents the input of CreateDBClusterSnapshot.DbClusterSnapshotAlreadyExistsException - You already have a cluster snapshot with the given identifier.InvalidDbClusterStateException - The cluster isn't in a valid state.DbClusterNotFoundException - DBClusterIdentifier doesn't refer to an existing cluster.SnapshotQuotaExceededException - The request would cause you to exceed the allowed number of snapshots.InvalidDbClusterSnapshotStateException - The provided value isn't a valid cluster snapshot state.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.DocDbException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault CreateDbInstanceResponse createDBInstance(CreateDbInstanceRequest createDbInstanceRequest) throws DbInstanceAlreadyExistsException, InsufficientDbInstanceCapacityException, DbParameterGroupNotFoundException, DbSecurityGroupNotFoundException, InstanceQuotaExceededException, StorageQuotaExceededException, DbSubnetGroupNotFoundException, DbSubnetGroupDoesNotCoverEnoughAZsException, InvalidDbClusterStateException, InvalidSubnetException, InvalidVpcNetworkStateException, DbClusterNotFoundException, StorageTypeNotSupportedException, AuthorizationNotFoundException, KmsKeyNotAccessibleException, AwsServiceException, SdkClientException, DocDbException
Creates a new instance.
createDbInstanceRequest - Represents the input to CreateDBInstance.DbInstanceAlreadyExistsException - You already have a instance with the given identifier.InsufficientDbInstanceCapacityException - The specified instance class isn't available in the specified Availability Zone.DbParameterGroupNotFoundException - DBParameterGroupName doesn't refer to an existing parameter group.DbSecurityGroupNotFoundException - DBSecurityGroupName doesn't refer to an existing security group.InstanceQuotaExceededException - The request would cause you to exceed the allowed number of instances.StorageQuotaExceededException - The request would cause you to exceed the allowed amount of storage available across all instances.DbSubnetGroupNotFoundException - DBSubnetGroupName doesn't refer to an existing subnet group.DbSubnetGroupDoesNotCoverEnoughAZsException - Subnets in the subnet group should cover at least two Availability Zones unless there is only one
Availability Zone.InvalidDbClusterStateException - The cluster isn't in a valid state.InvalidSubnetException - The requested subnet is not valid, or multiple subnets were requested that are not all in a common
virtual private cloud (VPC).InvalidVpcNetworkStateException - The subnet group doesn't cover all Availability Zones after it is created because of changes that were
made.DbClusterNotFoundException - DBClusterIdentifier doesn't refer to an existing cluster.StorageTypeNotSupportedException - Storage of the specified StorageType can't be associated with the DB instance.AuthorizationNotFoundException - The specified CIDR IP or Amazon EC2 security group isn't authorized for the specified security group.
Amazon DocumentDB also might not be authorized to perform necessary actions on your behalf using IAM.
KmsKeyNotAccessibleException - An error occurred when accessing an KMS key.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.DocDbException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault CreateDbInstanceResponse createDBInstance(Consumer<CreateDbInstanceRequest.Builder> createDbInstanceRequest) throws DbInstanceAlreadyExistsException, InsufficientDbInstanceCapacityException, DbParameterGroupNotFoundException, DbSecurityGroupNotFoundException, InstanceQuotaExceededException, StorageQuotaExceededException, DbSubnetGroupNotFoundException, DbSubnetGroupDoesNotCoverEnoughAZsException, InvalidDbClusterStateException, InvalidSubnetException, InvalidVpcNetworkStateException, DbClusterNotFoundException, StorageTypeNotSupportedException, AuthorizationNotFoundException, KmsKeyNotAccessibleException, AwsServiceException, SdkClientException, DocDbException
Creates a new instance.
This is a convenience which creates an instance of the CreateDbInstanceRequest.Builder avoiding the need
to create one manually via CreateDbInstanceRequest.builder()
createDbInstanceRequest - A Consumer that will call methods on CreateDBInstanceMessage.Builder to create a request.
Represents the input to CreateDBInstance.DbInstanceAlreadyExistsException - You already have a instance with the given identifier.InsufficientDbInstanceCapacityException - The specified instance class isn't available in the specified Availability Zone.DbParameterGroupNotFoundException - DBParameterGroupName doesn't refer to an existing parameter group.DbSecurityGroupNotFoundException - DBSecurityGroupName doesn't refer to an existing security group.InstanceQuotaExceededException - The request would cause you to exceed the allowed number of instances.StorageQuotaExceededException - The request would cause you to exceed the allowed amount of storage available across all instances.DbSubnetGroupNotFoundException - DBSubnetGroupName doesn't refer to an existing subnet group.DbSubnetGroupDoesNotCoverEnoughAZsException - Subnets in the subnet group should cover at least two Availability Zones unless there is only one
Availability Zone.InvalidDbClusterStateException - The cluster isn't in a valid state.InvalidSubnetException - The requested subnet is not valid, or multiple subnets were requested that are not all in a common
virtual private cloud (VPC).InvalidVpcNetworkStateException - The subnet group doesn't cover all Availability Zones after it is created because of changes that were
made.DbClusterNotFoundException - DBClusterIdentifier doesn't refer to an existing cluster.StorageTypeNotSupportedException - Storage of the specified StorageType can't be associated with the DB instance.AuthorizationNotFoundException - The specified CIDR IP or Amazon EC2 security group isn't authorized for the specified security group.
Amazon DocumentDB also might not be authorized to perform necessary actions on your behalf using IAM.
KmsKeyNotAccessibleException - An error occurred when accessing an KMS key.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.DocDbException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault CreateDbSubnetGroupResponse createDBSubnetGroup(CreateDbSubnetGroupRequest createDbSubnetGroupRequest) throws DbSubnetGroupAlreadyExistsException, DbSubnetGroupQuotaExceededException, DbSubnetQuotaExceededException, DbSubnetGroupDoesNotCoverEnoughAZsException, InvalidSubnetException, AwsServiceException, SdkClientException, DocDbException
Creates a new subnet group. subnet groups must contain at least one subnet in at least two Availability Zones in the Amazon Web Services Region.
createDbSubnetGroupRequest - Represents the input to CreateDBSubnetGroup.DbSubnetGroupAlreadyExistsException - DBSubnetGroupName is already being used by an existing subnet group.DbSubnetGroupQuotaExceededException - The request would cause you to exceed the allowed number of subnet groups.DbSubnetQuotaExceededException - The request would cause you to exceed the allowed number of subnets in a subnet group.DbSubnetGroupDoesNotCoverEnoughAZsException - Subnets in the subnet group should cover at least two Availability Zones unless there is only one
Availability Zone.InvalidSubnetException - The requested subnet is not valid, or multiple subnets were requested that are not all in a common
virtual private cloud (VPC).SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.DocDbException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault CreateDbSubnetGroupResponse createDBSubnetGroup(Consumer<CreateDbSubnetGroupRequest.Builder> createDbSubnetGroupRequest) throws DbSubnetGroupAlreadyExistsException, DbSubnetGroupQuotaExceededException, DbSubnetQuotaExceededException, DbSubnetGroupDoesNotCoverEnoughAZsException, InvalidSubnetException, AwsServiceException, SdkClientException, DocDbException
Creates a new subnet group. subnet groups must contain at least one subnet in at least two Availability Zones in the Amazon Web Services Region.
This is a convenience which creates an instance of the CreateDbSubnetGroupRequest.Builder avoiding the
need to create one manually via CreateDbSubnetGroupRequest.builder()
createDbSubnetGroupRequest - A Consumer that will call methods on CreateDBSubnetGroupMessage.Builder to create a
request. Represents the input to CreateDBSubnetGroup.DbSubnetGroupAlreadyExistsException - DBSubnetGroupName is already being used by an existing subnet group.DbSubnetGroupQuotaExceededException - The request would cause you to exceed the allowed number of subnet groups.DbSubnetQuotaExceededException - The request would cause you to exceed the allowed number of subnets in a subnet group.DbSubnetGroupDoesNotCoverEnoughAZsException - Subnets in the subnet group should cover at least two Availability Zones unless there is only one
Availability Zone.InvalidSubnetException - The requested subnet is not valid, or multiple subnets were requested that are not all in a common
virtual private cloud (VPC).SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.DocDbException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault CreateEventSubscriptionResponse createEventSubscription(CreateEventSubscriptionRequest createEventSubscriptionRequest) throws EventSubscriptionQuotaExceededException, SubscriptionAlreadyExistException, SnsInvalidTopicException, SnsNoAuthorizationException, SnsTopicArnNotFoundException, SubscriptionCategoryNotFoundException, SourceNotFoundException, AwsServiceException, SdkClientException, DocDbException
Creates an Amazon DocumentDB event notification subscription. This action requires a topic Amazon Resource Name (ARN) created by using the Amazon DocumentDB console, the Amazon SNS console, or the Amazon SNS API. To obtain an ARN with Amazon SNS, you must create a topic in Amazon SNS and subscribe to the topic. The ARN is displayed in the Amazon SNS console.
You can specify the type of source (SourceType) that you want to be notified of. You can also
provide a list of Amazon DocumentDB sources (SourceIds) that trigger the events, and you can provide
a list of event categories (EventCategories) for events that you want to be notified of. For
example, you can specify SourceType = db-instance,
SourceIds = mydbinstance1, mydbinstance2 and EventCategories = Availability, Backup.
If you specify both the SourceType and SourceIds (such as
SourceType = db-instance and SourceIdentifier = myDBInstance1), you are notified of all
the db-instance events for the specified source. If you specify a SourceType but do not
specify a SourceIdentifier, you receive notice of the events for that source type for all your
Amazon DocumentDB sources. If you do not specify either the SourceType or the
SourceIdentifier, you are notified of events generated from all Amazon DocumentDB sources belonging
to your customer account.
createEventSubscriptionRequest - Represents the input to CreateEventSubscription.EventSubscriptionQuotaExceededException - You have reached the maximum number of event subscriptions.SubscriptionAlreadyExistException - The provided subscription name already exists.SnsInvalidTopicException - Amazon SNS has responded that there is a problem with the specified topic.SnsNoAuthorizationException - You do not have permission to publish to the SNS topic Amazon Resource Name (ARN).SnsTopicArnNotFoundException - The SNS topic Amazon Resource Name (ARN) does not exist.SubscriptionCategoryNotFoundException - The provided category does not exist.SourceNotFoundException - The requested source could not be found.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.DocDbException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault CreateEventSubscriptionResponse createEventSubscription(Consumer<CreateEventSubscriptionRequest.Builder> createEventSubscriptionRequest) throws EventSubscriptionQuotaExceededException, SubscriptionAlreadyExistException, SnsInvalidTopicException, SnsNoAuthorizationException, SnsTopicArnNotFoundException, SubscriptionCategoryNotFoundException, SourceNotFoundException, AwsServiceException, SdkClientException, DocDbException
Creates an Amazon DocumentDB event notification subscription. This action requires a topic Amazon Resource Name (ARN) created by using the Amazon DocumentDB console, the Amazon SNS console, or the Amazon SNS API. To obtain an ARN with Amazon SNS, you must create a topic in Amazon SNS and subscribe to the topic. The ARN is displayed in the Amazon SNS console.
You can specify the type of source (SourceType) that you want to be notified of. You can also
provide a list of Amazon DocumentDB sources (SourceIds) that trigger the events, and you can provide
a list of event categories (EventCategories) for events that you want to be notified of. For
example, you can specify SourceType = db-instance,
SourceIds = mydbinstance1, mydbinstance2 and EventCategories = Availability, Backup.
If you specify both the SourceType and SourceIds (such as
SourceType = db-instance and SourceIdentifier = myDBInstance1), you are notified of all
the db-instance events for the specified source. If you specify a SourceType but do not
specify a SourceIdentifier, you receive notice of the events for that source type for all your
Amazon DocumentDB sources. If you do not specify either the SourceType or the
SourceIdentifier, you are notified of events generated from all Amazon DocumentDB sources belonging
to your customer account.
This is a convenience which creates an instance of the CreateEventSubscriptionRequest.Builder avoiding
the need to create one manually via CreateEventSubscriptionRequest.builder()
createEventSubscriptionRequest - A Consumer that will call methods on CreateEventSubscriptionMessage.Builder to create a
request. Represents the input to CreateEventSubscription.EventSubscriptionQuotaExceededException - You have reached the maximum number of event subscriptions.SubscriptionAlreadyExistException - The provided subscription name already exists.SnsInvalidTopicException - Amazon SNS has responded that there is a problem with the specified topic.SnsNoAuthorizationException - You do not have permission to publish to the SNS topic Amazon Resource Name (ARN).SnsTopicArnNotFoundException - The SNS topic Amazon Resource Name (ARN) does not exist.SubscriptionCategoryNotFoundException - The provided category does not exist.SourceNotFoundException - The requested source could not be found.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.DocDbException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault CreateGlobalClusterResponse createGlobalCluster(CreateGlobalClusterRequest createGlobalClusterRequest) throws GlobalClusterAlreadyExistsException, GlobalClusterQuotaExceededException, InvalidDbClusterStateException, DbClusterNotFoundException, AwsServiceException, SdkClientException, DocDbException
Creates an Amazon DocumentDB global cluster that can span multiple multiple Amazon Web Services Regions. The global cluster contains one primary cluster with read-write capability, and up-to give read-only secondary clusters. Global clusters uses storage-based fast replication across regions with latencies less than one second, using dedicated infrastructure with no impact to your workload’s performance.
You can create a global cluster that is initially empty, and then add a primary and a secondary to it. Or you can specify an existing cluster during the create operation, and this cluster becomes the primary of the global cluster.
This action only applies to Amazon DocumentDB clusters.
createGlobalClusterRequest - Represents the input to CreateGlobalCluster.GlobalClusterAlreadyExistsException - The GlobalClusterIdentifier already exists. Choose a new global cluster identifier (unique
name) to create a new global cluster.GlobalClusterQuotaExceededException - The number of global clusters for this account is already at the maximum allowed.InvalidDbClusterStateException - The cluster isn't in a valid state.DbClusterNotFoundException - DBClusterIdentifier doesn't refer to an existing cluster.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.DocDbException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault CreateGlobalClusterResponse createGlobalCluster(Consumer<CreateGlobalClusterRequest.Builder> createGlobalClusterRequest) throws GlobalClusterAlreadyExistsException, GlobalClusterQuotaExceededException, InvalidDbClusterStateException, DbClusterNotFoundException, AwsServiceException, SdkClientException, DocDbException
Creates an Amazon DocumentDB global cluster that can span multiple multiple Amazon Web Services Regions. The global cluster contains one primary cluster with read-write capability, and up-to give read-only secondary clusters. Global clusters uses storage-based fast replication across regions with latencies less than one second, using dedicated infrastructure with no impact to your workload’s performance.
You can create a global cluster that is initially empty, and then add a primary and a secondary to it. Or you can specify an existing cluster during the create operation, and this cluster becomes the primary of the global cluster.
This action only applies to Amazon DocumentDB clusters.
This is a convenience which creates an instance of the CreateGlobalClusterRequest.Builder avoiding the
need to create one manually via CreateGlobalClusterRequest.builder()
createGlobalClusterRequest - A Consumer that will call methods on CreateGlobalClusterMessage.Builder to create a
request. Represents the input to CreateGlobalCluster.GlobalClusterAlreadyExistsException - The GlobalClusterIdentifier already exists. Choose a new global cluster identifier (unique
name) to create a new global cluster.GlobalClusterQuotaExceededException - The number of global clusters for this account is already at the maximum allowed.InvalidDbClusterStateException - The cluster isn't in a valid state.DbClusterNotFoundException - DBClusterIdentifier doesn't refer to an existing cluster.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.DocDbException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DeleteDbClusterResponse deleteDBCluster(DeleteDbClusterRequest deleteDbClusterRequest) throws DbClusterNotFoundException, InvalidDbClusterStateException, DbClusterSnapshotAlreadyExistsException, SnapshotQuotaExceededException, InvalidDbClusterSnapshotStateException, AwsServiceException, SdkClientException, DocDbException
Deletes a previously provisioned cluster. When you delete a cluster, all automated backups for that cluster are deleted and can't be recovered. Manual DB cluster snapshots of the specified cluster are not deleted.
deleteDbClusterRequest - Represents the input to DeleteDBCluster.DbClusterNotFoundException - DBClusterIdentifier doesn't refer to an existing cluster.InvalidDbClusterStateException - The cluster isn't in a valid state.DbClusterSnapshotAlreadyExistsException - You already have a cluster snapshot with the given identifier.SnapshotQuotaExceededException - The request would cause you to exceed the allowed number of snapshots.InvalidDbClusterSnapshotStateException - The provided value isn't a valid cluster snapshot state.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.DocDbException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DeleteDbClusterResponse deleteDBCluster(Consumer<DeleteDbClusterRequest.Builder> deleteDbClusterRequest) throws DbClusterNotFoundException, InvalidDbClusterStateException, DbClusterSnapshotAlreadyExistsException, SnapshotQuotaExceededException, InvalidDbClusterSnapshotStateException, AwsServiceException, SdkClientException, DocDbException
Deletes a previously provisioned cluster. When you delete a cluster, all automated backups for that cluster are deleted and can't be recovered. Manual DB cluster snapshots of the specified cluster are not deleted.
This is a convenience which creates an instance of the DeleteDbClusterRequest.Builder avoiding the need
to create one manually via DeleteDbClusterRequest.builder()
deleteDbClusterRequest - A Consumer that will call methods on DeleteDBClusterMessage.Builder to create a request.
Represents the input to DeleteDBCluster.DbClusterNotFoundException - DBClusterIdentifier doesn't refer to an existing cluster.InvalidDbClusterStateException - The cluster isn't in a valid state.DbClusterSnapshotAlreadyExistsException - You already have a cluster snapshot with the given identifier.SnapshotQuotaExceededException - The request would cause you to exceed the allowed number of snapshots.InvalidDbClusterSnapshotStateException - The provided value isn't a valid cluster snapshot state.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.DocDbException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DeleteDbClusterParameterGroupResponse deleteDBClusterParameterGroup(DeleteDbClusterParameterGroupRequest deleteDbClusterParameterGroupRequest) throws InvalidDbParameterGroupStateException, DbParameterGroupNotFoundException, AwsServiceException, SdkClientException, DocDbException
Deletes a specified cluster parameter group. The cluster parameter group to be deleted can't be associated with any clusters.
deleteDbClusterParameterGroupRequest - Represents the input to DeleteDBClusterParameterGroup.InvalidDbParameterGroupStateException - The parameter group is in use, or it is in a state that is not valid. If you are trying to delete the
parameter group, you can't delete it when the parameter group is in this state.DbParameterGroupNotFoundException - DBParameterGroupName doesn't refer to an existing parameter group.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.DocDbException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DeleteDbClusterParameterGroupResponse deleteDBClusterParameterGroup(Consumer<DeleteDbClusterParameterGroupRequest.Builder> deleteDbClusterParameterGroupRequest) throws InvalidDbParameterGroupStateException, DbParameterGroupNotFoundException, AwsServiceException, SdkClientException, DocDbException
Deletes a specified cluster parameter group. The cluster parameter group to be deleted can't be associated with any clusters.
This is a convenience which creates an instance of the DeleteDbClusterParameterGroupRequest.Builder
avoiding the need to create one manually via DeleteDbClusterParameterGroupRequest.builder()
deleteDbClusterParameterGroupRequest - A Consumer that will call methods on DeleteDBClusterParameterGroupMessage.Builder to
create a request. Represents the input to DeleteDBClusterParameterGroup.InvalidDbParameterGroupStateException - The parameter group is in use, or it is in a state that is not valid. If you are trying to delete the
parameter group, you can't delete it when the parameter group is in this state.DbParameterGroupNotFoundException - DBParameterGroupName doesn't refer to an existing parameter group.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.DocDbException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DeleteDbClusterSnapshotResponse deleteDBClusterSnapshot(DeleteDbClusterSnapshotRequest deleteDbClusterSnapshotRequest) throws InvalidDbClusterSnapshotStateException, DbClusterSnapshotNotFoundException, AwsServiceException, SdkClientException, DocDbException
Deletes a cluster snapshot. If the snapshot is being copied, the copy operation is terminated.
The cluster snapshot must be in the available state to be deleted.
deleteDbClusterSnapshotRequest - Represents the input to DeleteDBClusterSnapshot.InvalidDbClusterSnapshotStateException - The provided value isn't a valid cluster snapshot state.DbClusterSnapshotNotFoundException - DBClusterSnapshotIdentifier doesn't refer to an existing cluster snapshot.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.DocDbException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DeleteDbClusterSnapshotResponse deleteDBClusterSnapshot(Consumer<DeleteDbClusterSnapshotRequest.Builder> deleteDbClusterSnapshotRequest) throws InvalidDbClusterSnapshotStateException, DbClusterSnapshotNotFoundException, AwsServiceException, SdkClientException, DocDbException
Deletes a cluster snapshot. If the snapshot is being copied, the copy operation is terminated.
The cluster snapshot must be in the available state to be deleted.
This is a convenience which creates an instance of the DeleteDbClusterSnapshotRequest.Builder avoiding
the need to create one manually via DeleteDbClusterSnapshotRequest.builder()
deleteDbClusterSnapshotRequest - A Consumer that will call methods on DeleteDBClusterSnapshotMessage.Builder to create a
request. Represents the input to DeleteDBClusterSnapshot.InvalidDbClusterSnapshotStateException - The provided value isn't a valid cluster snapshot state.DbClusterSnapshotNotFoundException - DBClusterSnapshotIdentifier doesn't refer to an existing cluster snapshot.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.DocDbException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DeleteDbInstanceResponse deleteDBInstance(DeleteDbInstanceRequest deleteDbInstanceRequest) throws DbInstanceNotFoundException, InvalidDbInstanceStateException, DbSnapshotAlreadyExistsException, SnapshotQuotaExceededException, InvalidDbClusterStateException, AwsServiceException, SdkClientException, DocDbException
Deletes a previously provisioned instance.
deleteDbInstanceRequest - Represents the input to DeleteDBInstance.DbInstanceNotFoundException - DBInstanceIdentifier doesn't refer to an existing instance.InvalidDbInstanceStateException - The specified instance isn't in the available state.DbSnapshotAlreadyExistsException - DBSnapshotIdentifier is already being used by an existing snapshot.SnapshotQuotaExceededException - The request would cause you to exceed the allowed number of snapshots.InvalidDbClusterStateException - The cluster isn't in a valid state.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.DocDbException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DeleteDbInstanceResponse deleteDBInstance(Consumer<DeleteDbInstanceRequest.Builder> deleteDbInstanceRequest) throws DbInstanceNotFoundException, InvalidDbInstanceStateException, DbSnapshotAlreadyExistsException, SnapshotQuotaExceededException, InvalidDbClusterStateException, AwsServiceException, SdkClientException, DocDbException
Deletes a previously provisioned instance.
This is a convenience which creates an instance of the DeleteDbInstanceRequest.Builder avoiding the need
to create one manually via DeleteDbInstanceRequest.builder()
deleteDbInstanceRequest - A Consumer that will call methods on DeleteDBInstanceMessage.Builder to create a request.
Represents the input to DeleteDBInstance.DbInstanceNotFoundException - DBInstanceIdentifier doesn't refer to an existing instance.InvalidDbInstanceStateException - The specified instance isn't in the available state.DbSnapshotAlreadyExistsException - DBSnapshotIdentifier is already being used by an existing snapshot.SnapshotQuotaExceededException - The request would cause you to exceed the allowed number of snapshots.InvalidDbClusterStateException - The cluster isn't in a valid state.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.DocDbException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DeleteDbSubnetGroupResponse deleteDBSubnetGroup(DeleteDbSubnetGroupRequest deleteDbSubnetGroupRequest) throws InvalidDbSubnetGroupStateException, InvalidDbSubnetStateException, DbSubnetGroupNotFoundException, AwsServiceException, SdkClientException, DocDbException
Deletes a subnet group.
The specified database subnet group must not be associated with any DB instances.
deleteDbSubnetGroupRequest - Represents the input to DeleteDBSubnetGroup.InvalidDbSubnetGroupStateException - The subnet group can't be deleted because it's in use.InvalidDbSubnetStateException - The subnet isn't in the available state.DbSubnetGroupNotFoundException - DBSubnetGroupName doesn't refer to an existing subnet group.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.DocDbException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DeleteDbSubnetGroupResponse deleteDBSubnetGroup(Consumer<DeleteDbSubnetGroupRequest.Builder> deleteDbSubnetGroupRequest) throws InvalidDbSubnetGroupStateException, InvalidDbSubnetStateException, DbSubnetGroupNotFoundException, AwsServiceException, SdkClientException, DocDbException
Deletes a subnet group.
The specified database subnet group must not be associated with any DB instances.
This is a convenience which creates an instance of the DeleteDbSubnetGroupRequest.Builder avoiding the
need to create one manually via DeleteDbSubnetGroupRequest.builder()
deleteDbSubnetGroupRequest - A Consumer that will call methods on DeleteDBSubnetGroupMessage.Builder to create a
request. Represents the input to DeleteDBSubnetGroup.InvalidDbSubnetGroupStateException - The subnet group can't be deleted because it's in use.InvalidDbSubnetStateException - The subnet isn't in the available state.DbSubnetGroupNotFoundException - DBSubnetGroupName doesn't refer to an existing subnet group.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.DocDbException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DeleteEventSubscriptionResponse deleteEventSubscription(DeleteEventSubscriptionRequest deleteEventSubscriptionRequest) throws SubscriptionNotFoundException, InvalidEventSubscriptionStateException, AwsServiceException, SdkClientException, DocDbException
Deletes an Amazon DocumentDB event notification subscription.
deleteEventSubscriptionRequest - Represents the input to DeleteEventSubscription.SubscriptionNotFoundException - The subscription name does not exist.InvalidEventSubscriptionStateException - Someone else might be modifying a subscription. Wait a few seconds, and try again.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.DocDbException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DeleteEventSubscriptionResponse deleteEventSubscription(Consumer<DeleteEventSubscriptionRequest.Builder> deleteEventSubscriptionRequest) throws SubscriptionNotFoundException, InvalidEventSubscriptionStateException, AwsServiceException, SdkClientException, DocDbException
Deletes an Amazon DocumentDB event notification subscription.
This is a convenience which creates an instance of the DeleteEventSubscriptionRequest.Builder avoiding
the need to create one manually via DeleteEventSubscriptionRequest.builder()
deleteEventSubscriptionRequest - A Consumer that will call methods on DeleteEventSubscriptionMessage.Builder to create a
request. Represents the input to DeleteEventSubscription.SubscriptionNotFoundException - The subscription name does not exist.InvalidEventSubscriptionStateException - Someone else might be modifying a subscription. Wait a few seconds, and try again.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.DocDbException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DeleteGlobalClusterResponse deleteGlobalCluster(DeleteGlobalClusterRequest deleteGlobalClusterRequest) throws GlobalClusterNotFoundException, InvalidGlobalClusterStateException, AwsServiceException, SdkClientException, DocDbException
Deletes a global cluster. The primary and secondary clusters must already be detached or deleted before attempting to delete a global cluster.
This action only applies to Amazon DocumentDB clusters.
deleteGlobalClusterRequest - Represents the input to DeleteGlobalCluster.GlobalClusterNotFoundException - The GlobalClusterIdentifier doesn't refer to an existing global cluster.InvalidGlobalClusterStateException - The requested operation can't be performed while the cluster is in this state.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.DocDbException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DeleteGlobalClusterResponse deleteGlobalCluster(Consumer<DeleteGlobalClusterRequest.Builder> deleteGlobalClusterRequest) throws GlobalClusterNotFoundException, InvalidGlobalClusterStateException, AwsServiceException, SdkClientException, DocDbException
Deletes a global cluster. The primary and secondary clusters must already be detached or deleted before attempting to delete a global cluster.
This action only applies to Amazon DocumentDB clusters.
This is a convenience which creates an instance of the DeleteGlobalClusterRequest.Builder avoiding the
need to create one manually via DeleteGlobalClusterRequest.builder()
deleteGlobalClusterRequest - A Consumer that will call methods on DeleteGlobalClusterMessage.Builder to create a
request. Represents the input to DeleteGlobalCluster.GlobalClusterNotFoundException - The GlobalClusterIdentifier doesn't refer to an existing global cluster.InvalidGlobalClusterStateException - The requested operation can't be performed while the cluster is in this state.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.DocDbException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeCertificatesResponse describeCertificates(DescribeCertificatesRequest describeCertificatesRequest) throws CertificateNotFoundException, AwsServiceException, SdkClientException, DocDbException
Returns a list of certificate authority (CA) certificates provided by Amazon DocumentDB for this Amazon Web Services account.
describeCertificatesRequest - CertificateNotFoundException - CertificateIdentifier doesn't refer to an existing certificate.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.DocDbException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeCertificatesResponse describeCertificates(Consumer<DescribeCertificatesRequest.Builder> describeCertificatesRequest) throws CertificateNotFoundException, AwsServiceException, SdkClientException, DocDbException
Returns a list of certificate authority (CA) certificates provided by Amazon DocumentDB for this Amazon Web Services account.
This is a convenience which creates an instance of the DescribeCertificatesRequest.Builder avoiding the
need to create one manually via DescribeCertificatesRequest.builder()
describeCertificatesRequest - A Consumer that will call methods on DescribeCertificatesMessage.Builder to create a
request.CertificateNotFoundException - CertificateIdentifier doesn't refer to an existing certificate.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.DocDbException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeCertificatesIterable describeCertificatesPaginator(DescribeCertificatesRequest describeCertificatesRequest) throws CertificateNotFoundException, AwsServiceException, SdkClientException, DocDbException
Returns a list of certificate authority (CA) certificates provided by Amazon DocumentDB for this Amazon Web Services account.
This is a variant of
describeCertificates(software.amazon.awssdk.services.docdb.model.DescribeCertificatesRequest) operation.
The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally
handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.docdb.paginators.DescribeCertificatesIterable responses = client.describeCertificatesPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.docdb.paginators.DescribeCertificatesIterable responses = client
.describeCertificatesPaginator(request);
for (software.amazon.awssdk.services.docdb.model.DescribeCertificatesResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.docdb.paginators.DescribeCertificatesIterable responses = client.describeCertificatesPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxRecords won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeCertificates(software.amazon.awssdk.services.docdb.model.DescribeCertificatesRequest)
operation.
describeCertificatesRequest - CertificateNotFoundException - CertificateIdentifier doesn't refer to an existing certificate.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.DocDbException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeCertificatesIterable describeCertificatesPaginator(Consumer<DescribeCertificatesRequest.Builder> describeCertificatesRequest) throws CertificateNotFoundException, AwsServiceException, SdkClientException, DocDbException
Returns a list of certificate authority (CA) certificates provided by Amazon DocumentDB for this Amazon Web Services account.
This is a variant of
describeCertificates(software.amazon.awssdk.services.docdb.model.DescribeCertificatesRequest) operation.
The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally
handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.docdb.paginators.DescribeCertificatesIterable responses = client.describeCertificatesPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.docdb.paginators.DescribeCertificatesIterable responses = client
.describeCertificatesPaginator(request);
for (software.amazon.awssdk.services.docdb.model.DescribeCertificatesResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.docdb.paginators.DescribeCertificatesIterable responses = client.describeCertificatesPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxRecords won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeCertificates(software.amazon.awssdk.services.docdb.model.DescribeCertificatesRequest)
operation.
This is a convenience which creates an instance of the DescribeCertificatesRequest.Builder avoiding the
need to create one manually via DescribeCertificatesRequest.builder()
describeCertificatesRequest - A Consumer that will call methods on DescribeCertificatesMessage.Builder to create a
request.CertificateNotFoundException - CertificateIdentifier doesn't refer to an existing certificate.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.DocDbException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeDbClusterParameterGroupsResponse describeDBClusterParameterGroups(DescribeDbClusterParameterGroupsRequest describeDbClusterParameterGroupsRequest) throws DbParameterGroupNotFoundException, AwsServiceException, SdkClientException, DocDbException
Returns a list of DBClusterParameterGroup descriptions. If a
DBClusterParameterGroupName parameter is specified, the list contains only the description of the
specified cluster parameter group.
describeDbClusterParameterGroupsRequest - Represents the input to DescribeDBClusterParameterGroups.DbParameterGroupNotFoundException - DBParameterGroupName doesn't refer to an existing parameter group.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.DocDbException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeDbClusterParameterGroupsResponse describeDBClusterParameterGroups(Consumer<DescribeDbClusterParameterGroupsRequest.Builder> describeDbClusterParameterGroupsRequest) throws DbParameterGroupNotFoundException, AwsServiceException, SdkClientException, DocDbException
Returns a list of DBClusterParameterGroup descriptions. If a
DBClusterParameterGroupName parameter is specified, the list contains only the description of the
specified cluster parameter group.
This is a convenience which creates an instance of the DescribeDbClusterParameterGroupsRequest.Builder
avoiding the need to create one manually via DescribeDbClusterParameterGroupsRequest.builder()
describeDbClusterParameterGroupsRequest - A Consumer that will call methods on DescribeDBClusterParameterGroupsMessage.Builder to
create a request. Represents the input to DescribeDBClusterParameterGroups.DbParameterGroupNotFoundException - DBParameterGroupName doesn't refer to an existing parameter group.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.DocDbException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeDbClusterParameterGroupsResponse describeDBClusterParameterGroups() throws DbParameterGroupNotFoundException, AwsServiceException, SdkClientException, DocDbException
Returns a list of DBClusterParameterGroup descriptions. If a
DBClusterParameterGroupName parameter is specified, the list contains only the description of the
specified cluster parameter group.
DbParameterGroupNotFoundException - DBParameterGroupName doesn't refer to an existing parameter group.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.DocDbException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondescribeDBClusterParameterGroups(DescribeDbClusterParameterGroupsRequest),
AWS API Documentationdefault DescribeDBClusterParameterGroupsIterable describeDBClusterParameterGroupsPaginator() throws DbParameterGroupNotFoundException, AwsServiceException, SdkClientException, DocDbException
Returns a list of DBClusterParameterGroup descriptions. If a
DBClusterParameterGroupName parameter is specified, the list contains only the description of the
specified cluster parameter group.
This is a variant of
describeDBClusterParameterGroups(software.amazon.awssdk.services.docdb.model.DescribeDbClusterParameterGroupsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.docdb.paginators.DescribeDBClusterParameterGroupsIterable responses = client.describeDBClusterParameterGroupsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.docdb.paginators.DescribeDBClusterParameterGroupsIterable responses = client
.describeDBClusterParameterGroupsPaginator(request);
for (software.amazon.awssdk.services.docdb.model.DescribeDbClusterParameterGroupsResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.docdb.paginators.DescribeDBClusterParameterGroupsIterable responses = client.describeDBClusterParameterGroupsPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxRecords won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeDBClusterParameterGroups(software.amazon.awssdk.services.docdb.model.DescribeDbClusterParameterGroupsRequest)
operation.
DbParameterGroupNotFoundException - DBParameterGroupName doesn't refer to an existing parameter group.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.DocDbException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondescribeDBClusterParameterGroupsPaginator(DescribeDbClusterParameterGroupsRequest),
AWS API Documentationdefault DescribeDBClusterParameterGroupsIterable describeDBClusterParameterGroupsPaginator(DescribeDbClusterParameterGroupsRequest describeDbClusterParameterGroupsRequest) throws DbParameterGroupNotFoundException, AwsServiceException, SdkClientException, DocDbException
Returns a list of DBClusterParameterGroup descriptions. If a
DBClusterParameterGroupName parameter is specified, the list contains only the description of the
specified cluster parameter group.
This is a variant of
describeDBClusterParameterGroups(software.amazon.awssdk.services.docdb.model.DescribeDbClusterParameterGroupsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.docdb.paginators.DescribeDBClusterParameterGroupsIterable responses = client.describeDBClusterParameterGroupsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.docdb.paginators.DescribeDBClusterParameterGroupsIterable responses = client
.describeDBClusterParameterGroupsPaginator(request);
for (software.amazon.awssdk.services.docdb.model.DescribeDbClusterParameterGroupsResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.docdb.paginators.DescribeDBClusterParameterGroupsIterable responses = client.describeDBClusterParameterGroupsPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxRecords won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeDBClusterParameterGroups(software.amazon.awssdk.services.docdb.model.DescribeDbClusterParameterGroupsRequest)
operation.
describeDbClusterParameterGroupsRequest - Represents the input to DescribeDBClusterParameterGroups.DbParameterGroupNotFoundException - DBParameterGroupName doesn't refer to an existing parameter group.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.DocDbException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeDBClusterParameterGroupsIterable describeDBClusterParameterGroupsPaginator(Consumer<DescribeDbClusterParameterGroupsRequest.Builder> describeDbClusterParameterGroupsRequest) throws DbParameterGroupNotFoundException, AwsServiceException, SdkClientException, DocDbException
Returns a list of DBClusterParameterGroup descriptions. If a
DBClusterParameterGroupName parameter is specified, the list contains only the description of the
specified cluster parameter group.
This is a variant of
describeDBClusterParameterGroups(software.amazon.awssdk.services.docdb.model.DescribeDbClusterParameterGroupsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.docdb.paginators.DescribeDBClusterParameterGroupsIterable responses = client.describeDBClusterParameterGroupsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.docdb.paginators.DescribeDBClusterParameterGroupsIterable responses = client
.describeDBClusterParameterGroupsPaginator(request);
for (software.amazon.awssdk.services.docdb.model.DescribeDbClusterParameterGroupsResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.docdb.paginators.DescribeDBClusterParameterGroupsIterable responses = client.describeDBClusterParameterGroupsPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxRecords won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeDBClusterParameterGroups(software.amazon.awssdk.services.docdb.model.DescribeDbClusterParameterGroupsRequest)
operation.
This is a convenience which creates an instance of the DescribeDbClusterParameterGroupsRequest.Builder
avoiding the need to create one manually via DescribeDbClusterParameterGroupsRequest.builder()
describeDbClusterParameterGroupsRequest - A Consumer that will call methods on DescribeDBClusterParameterGroupsMessage.Builder to
create a request. Represents the input to DescribeDBClusterParameterGroups.DbParameterGroupNotFoundException - DBParameterGroupName doesn't refer to an existing parameter group.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.DocDbException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeDbClusterParametersResponse describeDBClusterParameters(DescribeDbClusterParametersRequest describeDbClusterParametersRequest) throws DbParameterGroupNotFoundException, AwsServiceException, SdkClientException, DocDbException
Returns the detailed parameter list for a particular cluster parameter group.
describeDbClusterParametersRequest - Represents the input to DescribeDBClusterParameters.DbParameterGroupNotFoundException - DBParameterGroupName doesn't refer to an existing parameter group.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.DocDbException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeDbClusterParametersResponse describeDBClusterParameters(Consumer<DescribeDbClusterParametersRequest.Builder> describeDbClusterParametersRequest) throws DbParameterGroupNotFoundException, AwsServiceException, SdkClientException, DocDbException
Returns the detailed parameter list for a particular cluster parameter group.
This is a convenience which creates an instance of the DescribeDbClusterParametersRequest.Builder
avoiding the need to create one manually via DescribeDbClusterParametersRequest.builder()
describeDbClusterParametersRequest - A Consumer that will call methods on DescribeDBClusterParametersMessage.Builder to create
a request. Represents the input to DescribeDBClusterParameters.DbParameterGroupNotFoundException - DBParameterGroupName doesn't refer to an existing parameter group.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.DocDbException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeDBClusterParametersIterable describeDBClusterParametersPaginator(DescribeDbClusterParametersRequest describeDbClusterParametersRequest) throws DbParameterGroupNotFoundException, AwsServiceException, SdkClientException, DocDbException
Returns the detailed parameter list for a particular cluster parameter group.
This is a variant of
describeDBClusterParameters(software.amazon.awssdk.services.docdb.model.DescribeDbClusterParametersRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.docdb.paginators.DescribeDBClusterParametersIterable responses = client.describeDBClusterParametersPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.docdb.paginators.DescribeDBClusterParametersIterable responses = client
.describeDBClusterParametersPaginator(request);
for (software.amazon.awssdk.services.docdb.model.DescribeDbClusterParametersResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.docdb.paginators.DescribeDBClusterParametersIterable responses = client.describeDBClusterParametersPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxRecords won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeDBClusterParameters(software.amazon.awssdk.services.docdb.model.DescribeDbClusterParametersRequest)
operation.
describeDbClusterParametersRequest - Represents the input to DescribeDBClusterParameters.DbParameterGroupNotFoundException - DBParameterGroupName doesn't refer to an existing parameter group.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.DocDbException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeDBClusterParametersIterable describeDBClusterParametersPaginator(Consumer<DescribeDbClusterParametersRequest.Builder> describeDbClusterParametersRequest) throws DbParameterGroupNotFoundException, AwsServiceException, SdkClientException, DocDbException
Returns the detailed parameter list for a particular cluster parameter group.
This is a variant of
describeDBClusterParameters(software.amazon.awssdk.services.docdb.model.DescribeDbClusterParametersRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.docdb.paginators.DescribeDBClusterParametersIterable responses = client.describeDBClusterParametersPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.docdb.paginators.DescribeDBClusterParametersIterable responses = client
.describeDBClusterParametersPaginator(request);
for (software.amazon.awssdk.services.docdb.model.DescribeDbClusterParametersResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.docdb.paginators.DescribeDBClusterParametersIterable responses = client.describeDBClusterParametersPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxRecords won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeDBClusterParameters(software.amazon.awssdk.services.docdb.model.DescribeDbClusterParametersRequest)
operation.
This is a convenience which creates an instance of the DescribeDbClusterParametersRequest.Builder
avoiding the need to create one manually via DescribeDbClusterParametersRequest.builder()
describeDbClusterParametersRequest - A Consumer that will call methods on DescribeDBClusterParametersMessage.Builder to create
a request. Represents the input to DescribeDBClusterParameters.DbParameterGroupNotFoundException - DBParameterGroupName doesn't refer to an existing parameter group.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.DocDbException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeDbClusterSnapshotAttributesResponse describeDBClusterSnapshotAttributes(DescribeDbClusterSnapshotAttributesRequest describeDbClusterSnapshotAttributesRequest) throws DbClusterSnapshotNotFoundException, AwsServiceException, SdkClientException, DocDbException
Returns a list of cluster snapshot attribute names and values for a manual DB cluster snapshot.
When you share snapshots with other Amazon Web Services accounts,
DescribeDBClusterSnapshotAttributes returns the restore attribute and a list of IDs for
the Amazon Web Services accounts that are authorized to copy or restore the manual cluster snapshot. If
all is included in the list of values for the restore attribute, then the manual
cluster snapshot is public and can be copied or restored by all Amazon Web Services accounts.
describeDbClusterSnapshotAttributesRequest - Represents the input to DescribeDBClusterSnapshotAttributes.DbClusterSnapshotNotFoundException - DBClusterSnapshotIdentifier doesn't refer to an existing cluster snapshot.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.DocDbException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeDbClusterSnapshotAttributesResponse describeDBClusterSnapshotAttributes(Consumer<DescribeDbClusterSnapshotAttributesRequest.Builder> describeDbClusterSnapshotAttributesRequest) throws DbClusterSnapshotNotFoundException, AwsServiceException, SdkClientException, DocDbException
Returns a list of cluster snapshot attribute names and values for a manual DB cluster snapshot.
When you share snapshots with other Amazon Web Services accounts,
DescribeDBClusterSnapshotAttributes returns the restore attribute and a list of IDs for
the Amazon Web Services accounts that are authorized to copy or restore the manual cluster snapshot. If
all is included in the list of values for the restore attribute, then the manual
cluster snapshot is public and can be copied or restored by all Amazon Web Services accounts.
This is a convenience which creates an instance of the DescribeDbClusterSnapshotAttributesRequest.Builder
avoiding the need to create one manually via DescribeDbClusterSnapshotAttributesRequest.builder()
describeDbClusterSnapshotAttributesRequest - A Consumer that will call methods on DescribeDBClusterSnapshotAttributesMessage.Builder to
create a request. Represents the input to DescribeDBClusterSnapshotAttributes.DbClusterSnapshotNotFoundException - DBClusterSnapshotIdentifier doesn't refer to an existing cluster snapshot.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.DocDbException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeDbClusterSnapshotsResponse describeDBClusterSnapshots(DescribeDbClusterSnapshotsRequest describeDbClusterSnapshotsRequest) throws DbClusterSnapshotNotFoundException, AwsServiceException, SdkClientException, DocDbException
Returns information about cluster snapshots. This API operation supports pagination.
describeDbClusterSnapshotsRequest - Represents the input to DescribeDBClusterSnapshots.DbClusterSnapshotNotFoundException - DBClusterSnapshotIdentifier doesn't refer to an existing cluster snapshot.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.DocDbException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeDbClusterSnapshotsResponse describeDBClusterSnapshots(Consumer<DescribeDbClusterSnapshotsRequest.Builder> describeDbClusterSnapshotsRequest) throws DbClusterSnapshotNotFoundException, AwsServiceException, SdkClientException, DocDbException
Returns information about cluster snapshots. This API operation supports pagination.
This is a convenience which creates an instance of the DescribeDbClusterSnapshotsRequest.Builder avoiding
the need to create one manually via DescribeDbClusterSnapshotsRequest.builder()
describeDbClusterSnapshotsRequest - A Consumer that will call methods on DescribeDBClusterSnapshotsMessage.Builder to create a
request. Represents the input to DescribeDBClusterSnapshots.DbClusterSnapshotNotFoundException - DBClusterSnapshotIdentifier doesn't refer to an existing cluster snapshot.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.DocDbException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeDbClusterSnapshotsResponse describeDBClusterSnapshots() throws DbClusterSnapshotNotFoundException, AwsServiceException, SdkClientException, DocDbException
Returns information about cluster snapshots. This API operation supports pagination.
DbClusterSnapshotNotFoundException - DBClusterSnapshotIdentifier doesn't refer to an existing cluster snapshot.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.DocDbException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondescribeDBClusterSnapshots(DescribeDbClusterSnapshotsRequest),
AWS API Documentationdefault DescribeDBClusterSnapshotsIterable describeDBClusterSnapshotsPaginator() throws DbClusterSnapshotNotFoundException, AwsServiceException, SdkClientException, DocDbException
Returns information about cluster snapshots. This API operation supports pagination.
This is a variant of
describeDBClusterSnapshots(software.amazon.awssdk.services.docdb.model.DescribeDbClusterSnapshotsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.docdb.paginators.DescribeDBClusterSnapshotsIterable responses = client.describeDBClusterSnapshotsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.docdb.paginators.DescribeDBClusterSnapshotsIterable responses = client
.describeDBClusterSnapshotsPaginator(request);
for (software.amazon.awssdk.services.docdb.model.DescribeDbClusterSnapshotsResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.docdb.paginators.DescribeDBClusterSnapshotsIterable responses = client.describeDBClusterSnapshotsPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxRecords won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeDBClusterSnapshots(software.amazon.awssdk.services.docdb.model.DescribeDbClusterSnapshotsRequest)
operation.
DbClusterSnapshotNotFoundException - DBClusterSnapshotIdentifier doesn't refer to an existing cluster snapshot.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.DocDbException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondescribeDBClusterSnapshotsPaginator(DescribeDbClusterSnapshotsRequest),
AWS API Documentationdefault DescribeDBClusterSnapshotsIterable describeDBClusterSnapshotsPaginator(DescribeDbClusterSnapshotsRequest describeDbClusterSnapshotsRequest) throws DbClusterSnapshotNotFoundException, AwsServiceException, SdkClientException, DocDbException
Returns information about cluster snapshots. This API operation supports pagination.
This is a variant of
describeDBClusterSnapshots(software.amazon.awssdk.services.docdb.model.DescribeDbClusterSnapshotsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.docdb.paginators.DescribeDBClusterSnapshotsIterable responses = client.describeDBClusterSnapshotsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.docdb.paginators.DescribeDBClusterSnapshotsIterable responses = client
.describeDBClusterSnapshotsPaginator(request);
for (software.amazon.awssdk.services.docdb.model.DescribeDbClusterSnapshotsResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.docdb.paginators.DescribeDBClusterSnapshotsIterable responses = client.describeDBClusterSnapshotsPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxRecords won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeDBClusterSnapshots(software.amazon.awssdk.services.docdb.model.DescribeDbClusterSnapshotsRequest)
operation.
describeDbClusterSnapshotsRequest - Represents the input to DescribeDBClusterSnapshots.DbClusterSnapshotNotFoundException - DBClusterSnapshotIdentifier doesn't refer to an existing cluster snapshot.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.DocDbException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeDBClusterSnapshotsIterable describeDBClusterSnapshotsPaginator(Consumer<DescribeDbClusterSnapshotsRequest.Builder> describeDbClusterSnapshotsRequest) throws DbClusterSnapshotNotFoundException, AwsServiceException, SdkClientException, DocDbException
Returns information about cluster snapshots. This API operation supports pagination.
This is a variant of
describeDBClusterSnapshots(software.amazon.awssdk.services.docdb.model.DescribeDbClusterSnapshotsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.docdb.paginators.DescribeDBClusterSnapshotsIterable responses = client.describeDBClusterSnapshotsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.docdb.paginators.DescribeDBClusterSnapshotsIterable responses = client
.describeDBClusterSnapshotsPaginator(request);
for (software.amazon.awssdk.services.docdb.model.DescribeDbClusterSnapshotsResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.docdb.paginators.DescribeDBClusterSnapshotsIterable responses = client.describeDBClusterSnapshotsPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxRecords won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeDBClusterSnapshots(software.amazon.awssdk.services.docdb.model.DescribeDbClusterSnapshotsRequest)
operation.
This is a convenience which creates an instance of the DescribeDbClusterSnapshotsRequest.Builder avoiding
the need to create one manually via DescribeDbClusterSnapshotsRequest.builder()
describeDbClusterSnapshotsRequest - A Consumer that will call methods on DescribeDBClusterSnapshotsMessage.Builder to create a
request. Represents the input to DescribeDBClusterSnapshots.DbClusterSnapshotNotFoundException - DBClusterSnapshotIdentifier doesn't refer to an existing cluster snapshot.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.DocDbException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeDbClustersResponse describeDBClusters(DescribeDbClustersRequest describeDbClustersRequest) throws DbClusterNotFoundException, AwsServiceException, SdkClientException, DocDbException
Returns information about provisioned Amazon DocumentDB clusters. This API operation supports pagination. For
certain management features such as cluster and instance lifecycle management, Amazon DocumentDB leverages
operational technology that is shared with Amazon RDS and Amazon Neptune. Use the
filterName=engine,Values=docdb filter parameter to return only Amazon DocumentDB clusters.
describeDbClustersRequest - Represents the input to DescribeDBClusters.DbClusterNotFoundException - DBClusterIdentifier doesn't refer to an existing cluster.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.DocDbException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeDbClustersResponse describeDBClusters(Consumer<DescribeDbClustersRequest.Builder> describeDbClustersRequest) throws DbClusterNotFoundException, AwsServiceException, SdkClientException, DocDbException
Returns information about provisioned Amazon DocumentDB clusters. This API operation supports pagination. For
certain management features such as cluster and instance lifecycle management, Amazon DocumentDB leverages
operational technology that is shared with Amazon RDS and Amazon Neptune. Use the
filterName=engine,Values=docdb filter parameter to return only Amazon DocumentDB clusters.
This is a convenience which creates an instance of the DescribeDbClustersRequest.Builder avoiding the
need to create one manually via DescribeDbClustersRequest.builder()
describeDbClustersRequest - A Consumer that will call methods on DescribeDBClustersMessage.Builder to create a
request. Represents the input to DescribeDBClusters.DbClusterNotFoundException - DBClusterIdentifier doesn't refer to an existing cluster.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.DocDbException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeDbClustersResponse describeDBClusters() throws DbClusterNotFoundException, AwsServiceException, SdkClientException, DocDbException
Returns information about provisioned Amazon DocumentDB clusters. This API operation supports pagination. For
certain management features such as cluster and instance lifecycle management, Amazon DocumentDB leverages
operational technology that is shared with Amazon RDS and Amazon Neptune. Use the
filterName=engine,Values=docdb filter parameter to return only Amazon DocumentDB clusters.
DbClusterNotFoundException - DBClusterIdentifier doesn't refer to an existing cluster.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.DocDbException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondescribeDBClusters(DescribeDbClustersRequest),
AWS API
Documentationdefault DescribeDBClustersIterable describeDBClustersPaginator() throws DbClusterNotFoundException, AwsServiceException, SdkClientException, DocDbException
Returns information about provisioned Amazon DocumentDB clusters. This API operation supports pagination. For
certain management features such as cluster and instance lifecycle management, Amazon DocumentDB leverages
operational technology that is shared with Amazon RDS and Amazon Neptune. Use the
filterName=engine,Values=docdb filter parameter to return only Amazon DocumentDB clusters.
This is a variant of
describeDBClusters(software.amazon.awssdk.services.docdb.model.DescribeDbClustersRequest) operation. The
return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle
making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.docdb.paginators.DescribeDBClustersIterable responses = client.describeDBClustersPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.docdb.paginators.DescribeDBClustersIterable responses = client
.describeDBClustersPaginator(request);
for (software.amazon.awssdk.services.docdb.model.DescribeDbClustersResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.docdb.paginators.DescribeDBClustersIterable responses = client.describeDBClustersPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxRecords won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeDBClusters(software.amazon.awssdk.services.docdb.model.DescribeDbClustersRequest) operation.
DbClusterNotFoundException - DBClusterIdentifier doesn't refer to an existing cluster.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.DocDbException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondescribeDBClustersPaginator(DescribeDbClustersRequest),
AWS API
Documentationdefault DescribeDBClustersIterable describeDBClustersPaginator(DescribeDbClustersRequest describeDbClustersRequest) throws DbClusterNotFoundException, AwsServiceException, SdkClientException, DocDbException
Returns information about provisioned Amazon DocumentDB clusters. This API operation supports pagination. For
certain management features such as cluster and instance lifecycle management, Amazon DocumentDB leverages
operational technology that is shared with Amazon RDS and Amazon Neptune. Use the
filterName=engine,Values=docdb filter parameter to return only Amazon DocumentDB clusters.
This is a variant of
describeDBClusters(software.amazon.awssdk.services.docdb.model.DescribeDbClustersRequest) operation. The
return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle
making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.docdb.paginators.DescribeDBClustersIterable responses = client.describeDBClustersPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.docdb.paginators.DescribeDBClustersIterable responses = client
.describeDBClustersPaginator(request);
for (software.amazon.awssdk.services.docdb.model.DescribeDbClustersResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.docdb.paginators.DescribeDBClustersIterable responses = client.describeDBClustersPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxRecords won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeDBClusters(software.amazon.awssdk.services.docdb.model.DescribeDbClustersRequest) operation.
describeDbClustersRequest - Represents the input to DescribeDBClusters.DbClusterNotFoundException - DBClusterIdentifier doesn't refer to an existing cluster.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.DocDbException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeDBClustersIterable describeDBClustersPaginator(Consumer<DescribeDbClustersRequest.Builder> describeDbClustersRequest) throws DbClusterNotFoundException, AwsServiceException, SdkClientException, DocDbException
Returns information about provisioned Amazon DocumentDB clusters. This API operation supports pagination. For
certain management features such as cluster and instance lifecycle management, Amazon DocumentDB leverages
operational technology that is shared with Amazon RDS and Amazon Neptune. Use the
filterName=engine,Values=docdb filter parameter to return only Amazon DocumentDB clusters.
This is a variant of
describeDBClusters(software.amazon.awssdk.services.docdb.model.DescribeDbClustersRequest) operation. The
return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle
making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.docdb.paginators.DescribeDBClustersIterable responses = client.describeDBClustersPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.docdb.paginators.DescribeDBClustersIterable responses = client
.describeDBClustersPaginator(request);
for (software.amazon.awssdk.services.docdb.model.DescribeDbClustersResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.docdb.paginators.DescribeDBClustersIterable responses = client.describeDBClustersPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxRecords won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeDBClusters(software.amazon.awssdk.services.docdb.model.DescribeDbClustersRequest) operation.
This is a convenience which creates an instance of the DescribeDbClustersRequest.Builder avoiding the
need to create one manually via DescribeDbClustersRequest.builder()
describeDbClustersRequest - A Consumer that will call methods on DescribeDBClustersMessage.Builder to create a
request. Represents the input to DescribeDBClusters.DbClusterNotFoundException - DBClusterIdentifier doesn't refer to an existing cluster.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.DocDbException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeDbEngineVersionsResponse describeDBEngineVersions(DescribeDbEngineVersionsRequest describeDbEngineVersionsRequest) throws AwsServiceException, SdkClientException, DocDbException
Returns a list of the available engines.
describeDbEngineVersionsRequest - Represents the input to DescribeDBEngineVersions.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.DocDbException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeDbEngineVersionsResponse describeDBEngineVersions(Consumer<DescribeDbEngineVersionsRequest.Builder> describeDbEngineVersionsRequest) throws AwsServiceException, SdkClientException, DocDbException
Returns a list of the available engines.
This is a convenience which creates an instance of the DescribeDbEngineVersionsRequest.Builder avoiding
the need to create one manually via DescribeDbEngineVersionsRequest.builder()
describeDbEngineVersionsRequest - A Consumer that will call methods on DescribeDBEngineVersionsMessage.Builder to create a
request. Represents the input to DescribeDBEngineVersions.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.DocDbException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeDbEngineVersionsResponse describeDBEngineVersions() throws AwsServiceException, SdkClientException, DocDbException
Returns a list of the available engines.
SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.DocDbException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondescribeDBEngineVersions(DescribeDbEngineVersionsRequest),
AWS API Documentationdefault DescribeDBEngineVersionsIterable describeDBEngineVersionsPaginator() throws AwsServiceException, SdkClientException, DocDbException
Returns a list of the available engines.
This is a variant of
describeDBEngineVersions(software.amazon.awssdk.services.docdb.model.DescribeDbEngineVersionsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.docdb.paginators.DescribeDBEngineVersionsIterable responses = client.describeDBEngineVersionsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.docdb.paginators.DescribeDBEngineVersionsIterable responses = client
.describeDBEngineVersionsPaginator(request);
for (software.amazon.awssdk.services.docdb.model.DescribeDbEngineVersionsResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.docdb.paginators.DescribeDBEngineVersionsIterable responses = client.describeDBEngineVersionsPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxRecords won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeDBEngineVersions(software.amazon.awssdk.services.docdb.model.DescribeDbEngineVersionsRequest)
operation.
SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.DocDbException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondescribeDBEngineVersionsPaginator(DescribeDbEngineVersionsRequest),
AWS API Documentationdefault DescribeDBEngineVersionsIterable describeDBEngineVersionsPaginator(DescribeDbEngineVersionsRequest describeDbEngineVersionsRequest) throws AwsServiceException, SdkClientException, DocDbException
Returns a list of the available engines.
This is a variant of
describeDBEngineVersions(software.amazon.awssdk.services.docdb.model.DescribeDbEngineVersionsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.docdb.paginators.DescribeDBEngineVersionsIterable responses = client.describeDBEngineVersionsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.docdb.paginators.DescribeDBEngineVersionsIterable responses = client
.describeDBEngineVersionsPaginator(request);
for (software.amazon.awssdk.services.docdb.model.DescribeDbEngineVersionsResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.docdb.paginators.DescribeDBEngineVersionsIterable responses = client.describeDBEngineVersionsPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxRecords won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeDBEngineVersions(software.amazon.awssdk.services.docdb.model.DescribeDbEngineVersionsRequest)
operation.
describeDbEngineVersionsRequest - Represents the input to DescribeDBEngineVersions.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.DocDbException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeDBEngineVersionsIterable describeDBEngineVersionsPaginator(Consumer<DescribeDbEngineVersionsRequest.Builder> describeDbEngineVersionsRequest) throws AwsServiceException, SdkClientException, DocDbException
Returns a list of the available engines.
This is a variant of
describeDBEngineVersions(software.amazon.awssdk.services.docdb.model.DescribeDbEngineVersionsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.docdb.paginators.DescribeDBEngineVersionsIterable responses = client.describeDBEngineVersionsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.docdb.paginators.DescribeDBEngineVersionsIterable responses = client
.describeDBEngineVersionsPaginator(request);
for (software.amazon.awssdk.services.docdb.model.DescribeDbEngineVersionsResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.docdb.paginators.DescribeDBEngineVersionsIterable responses = client.describeDBEngineVersionsPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxRecords won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeDBEngineVersions(software.amazon.awssdk.services.docdb.model.DescribeDbEngineVersionsRequest)
operation.
This is a convenience which creates an instance of the DescribeDbEngineVersionsRequest.Builder avoiding
the need to create one manually via DescribeDbEngineVersionsRequest.builder()
describeDbEngineVersionsRequest - A Consumer that will call methods on DescribeDBEngineVersionsMessage.Builder to create a
request. Represents the input to DescribeDBEngineVersions.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.DocDbException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeDbInstancesResponse describeDBInstances(DescribeDbInstancesRequest describeDbInstancesRequest) throws DbInstanceNotFoundException, AwsServiceException, SdkClientException, DocDbException
Returns information about provisioned Amazon DocumentDB instances. This API supports pagination.
describeDbInstancesRequest - Represents the input to DescribeDBInstances.DbInstanceNotFoundException - DBInstanceIdentifier doesn't refer to an existing instance.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.DocDbException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeDbInstancesResponse describeDBInstances(Consumer<DescribeDbInstancesRequest.Builder> describeDbInstancesRequest) throws DbInstanceNotFoundException, AwsServiceException, SdkClientException, DocDbException
Returns information about provisioned Amazon DocumentDB instances. This API supports pagination.
This is a convenience which creates an instance of the DescribeDbInstancesRequest.Builder avoiding the
need to create one manually via DescribeDbInstancesRequest.builder()
describeDbInstancesRequest - A Consumer that will call methods on DescribeDBInstancesMessage.Builder to create a
request. Represents the input to DescribeDBInstances.DbInstanceNotFoundException - DBInstanceIdentifier doesn't refer to an existing instance.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.DocDbException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeDbInstancesResponse describeDBInstances() throws DbInstanceNotFoundException, AwsServiceException, SdkClientException, DocDbException
Returns information about provisioned Amazon DocumentDB instances. This API supports pagination.
DbInstanceNotFoundException - DBInstanceIdentifier doesn't refer to an existing instance.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.DocDbException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondescribeDBInstances(DescribeDbInstancesRequest),
AWS API
Documentationdefault DescribeDBInstancesIterable describeDBInstancesPaginator() throws DbInstanceNotFoundException, AwsServiceException, SdkClientException, DocDbException
Returns information about provisioned Amazon DocumentDB instances. This API supports pagination.
This is a variant of
describeDBInstances(software.amazon.awssdk.services.docdb.model.DescribeDbInstancesRequest) operation.
The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally
handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.docdb.paginators.DescribeDBInstancesIterable responses = client.describeDBInstancesPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.docdb.paginators.DescribeDBInstancesIterable responses = client
.describeDBInstancesPaginator(request);
for (software.amazon.awssdk.services.docdb.model.DescribeDbInstancesResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.docdb.paginators.DescribeDBInstancesIterable responses = client.describeDBInstancesPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxRecords won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeDBInstances(software.amazon.awssdk.services.docdb.model.DescribeDbInstancesRequest)
operation.
DbInstanceNotFoundException - DBInstanceIdentifier doesn't refer to an existing instance.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.DocDbException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondescribeDBInstancesPaginator(DescribeDbInstancesRequest),
AWS API
Documentationdefault DescribeDBInstancesIterable describeDBInstancesPaginator(DescribeDbInstancesRequest describeDbInstancesRequest) throws DbInstanceNotFoundException, AwsServiceException, SdkClientException, DocDbException
Returns information about provisioned Amazon DocumentDB instances. This API supports pagination.
This is a variant of
describeDBInstances(software.amazon.awssdk.services.docdb.model.DescribeDbInstancesRequest) operation.
The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally
handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.docdb.paginators.DescribeDBInstancesIterable responses = client.describeDBInstancesPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.docdb.paginators.DescribeDBInstancesIterable responses = client
.describeDBInstancesPaginator(request);
for (software.amazon.awssdk.services.docdb.model.DescribeDbInstancesResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.docdb.paginators.DescribeDBInstancesIterable responses = client.describeDBInstancesPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxRecords won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeDBInstances(software.amazon.awssdk.services.docdb.model.DescribeDbInstancesRequest)
operation.
describeDbInstancesRequest - Represents the input to DescribeDBInstances.DbInstanceNotFoundException - DBInstanceIdentifier doesn't refer to an existing instance.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.DocDbException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeDBInstancesIterable describeDBInstancesPaginator(Consumer<DescribeDbInstancesRequest.Builder> describeDbInstancesRequest) throws DbInstanceNotFoundException, AwsServiceException, SdkClientException, DocDbException
Returns information about provisioned Amazon DocumentDB instances. This API supports pagination.
This is a variant of
describeDBInstances(software.amazon.awssdk.services.docdb.model.DescribeDbInstancesRequest) operation.
The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally
handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.docdb.paginators.DescribeDBInstancesIterable responses = client.describeDBInstancesPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.docdb.paginators.DescribeDBInstancesIterable responses = client
.describeDBInstancesPaginator(request);
for (software.amazon.awssdk.services.docdb.model.DescribeDbInstancesResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.docdb.paginators.DescribeDBInstancesIterable responses = client.describeDBInstancesPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxRecords won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeDBInstances(software.amazon.awssdk.services.docdb.model.DescribeDbInstancesRequest)
operation.
This is a convenience which creates an instance of the DescribeDbInstancesRequest.Builder avoiding the
need to create one manually via DescribeDbInstancesRequest.builder()
describeDbInstancesRequest - A Consumer that will call methods on DescribeDBInstancesMessage.Builder to create a
request. Represents the input to DescribeDBInstances.DbInstanceNotFoundException - DBInstanceIdentifier doesn't refer to an existing instance.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.DocDbException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeDbSubnetGroupsResponse describeDBSubnetGroups(DescribeDbSubnetGroupsRequest describeDbSubnetGroupsRequest) throws DbSubnetGroupNotFoundException, AwsServiceException, SdkClientException, DocDbException
Returns a list of DBSubnetGroup descriptions. If a DBSubnetGroupName is specified, the
list will contain only the descriptions of the specified DBSubnetGroup.
describeDbSubnetGroupsRequest - Represents the input to DescribeDBSubnetGroups.DbSubnetGroupNotFoundException - DBSubnetGroupName doesn't refer to an existing subnet group.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.DocDbException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeDbSubnetGroupsResponse describeDBSubnetGroups(Consumer<DescribeDbSubnetGroupsRequest.Builder> describeDbSubnetGroupsRequest) throws DbSubnetGroupNotFoundException, AwsServiceException, SdkClientException, DocDbException
Returns a list of DBSubnetGroup descriptions. If a DBSubnetGroupName is specified, the
list will contain only the descriptions of the specified DBSubnetGroup.
This is a convenience which creates an instance of the DescribeDbSubnetGroupsRequest.Builder avoiding the
need to create one manually via DescribeDbSubnetGroupsRequest.builder()
describeDbSubnetGroupsRequest - A Consumer that will call methods on DescribeDBSubnetGroupsMessage.Builder to create a
request. Represents the input to DescribeDBSubnetGroups.DbSubnetGroupNotFoundException - DBSubnetGroupName doesn't refer to an existing subnet group.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.DocDbException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeDbSubnetGroupsResponse describeDBSubnetGroups() throws DbSubnetGroupNotFoundException, AwsServiceException, SdkClientException, DocDbException
Returns a list of DBSubnetGroup descriptions. If a DBSubnetGroupName is specified, the
list will contain only the descriptions of the specified DBSubnetGroup.
DbSubnetGroupNotFoundException - DBSubnetGroupName doesn't refer to an existing subnet group.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.DocDbException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondescribeDBSubnetGroups(DescribeDbSubnetGroupsRequest),
AWS
API Documentationdefault DescribeDBSubnetGroupsIterable describeDBSubnetGroupsPaginator() throws DbSubnetGroupNotFoundException, AwsServiceException, SdkClientException, DocDbException
Returns a list of DBSubnetGroup descriptions. If a DBSubnetGroupName is specified, the
list will contain only the descriptions of the specified DBSubnetGroup.
This is a variant of
describeDBSubnetGroups(software.amazon.awssdk.services.docdb.model.DescribeDbSubnetGroupsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.docdb.paginators.DescribeDBSubnetGroupsIterable responses = client.describeDBSubnetGroupsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.docdb.paginators.DescribeDBSubnetGroupsIterable responses = client
.describeDBSubnetGroupsPaginator(request);
for (software.amazon.awssdk.services.docdb.model.DescribeDbSubnetGroupsResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.docdb.paginators.DescribeDBSubnetGroupsIterable responses = client.describeDBSubnetGroupsPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxRecords won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeDBSubnetGroups(software.amazon.awssdk.services.docdb.model.DescribeDbSubnetGroupsRequest)
operation.
DbSubnetGroupNotFoundException - DBSubnetGroupName doesn't refer to an existing subnet group.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.DocDbException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondescribeDBSubnetGroupsPaginator(DescribeDbSubnetGroupsRequest),
AWS
API Documentationdefault DescribeDBSubnetGroupsIterable describeDBSubnetGroupsPaginator(DescribeDbSubnetGroupsRequest describeDbSubnetGroupsRequest) throws DbSubnetGroupNotFoundException, AwsServiceException, SdkClientException, DocDbException
Returns a list of DBSubnetGroup descriptions. If a DBSubnetGroupName is specified, the
list will contain only the descriptions of the specified DBSubnetGroup.
This is a variant of
describeDBSubnetGroups(software.amazon.awssdk.services.docdb.model.DescribeDbSubnetGroupsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.docdb.paginators.DescribeDBSubnetGroupsIterable responses = client.describeDBSubnetGroupsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.docdb.paginators.DescribeDBSubnetGroupsIterable responses = client
.describeDBSubnetGroupsPaginator(request);
for (software.amazon.awssdk.services.docdb.model.DescribeDbSubnetGroupsResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.docdb.paginators.DescribeDBSubnetGroupsIterable responses = client.describeDBSubnetGroupsPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxRecords won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeDBSubnetGroups(software.amazon.awssdk.services.docdb.model.DescribeDbSubnetGroupsRequest)
operation.
describeDbSubnetGroupsRequest - Represents the input to DescribeDBSubnetGroups.DbSubnetGroupNotFoundException - DBSubnetGroupName doesn't refer to an existing subnet group.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.DocDbException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeDBSubnetGroupsIterable describeDBSubnetGroupsPaginator(Consumer<DescribeDbSubnetGroupsRequest.Builder> describeDbSubnetGroupsRequest) throws DbSubnetGroupNotFoundException, AwsServiceException, SdkClientException, DocDbException
Returns a list of DBSubnetGroup descriptions. If a DBSubnetGroupName is specified, the
list will contain only the descriptions of the specified DBSubnetGroup.
This is a variant of
describeDBSubnetGroups(software.amazon.awssdk.services.docdb.model.DescribeDbSubnetGroupsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.docdb.paginators.DescribeDBSubnetGroupsIterable responses = client.describeDBSubnetGroupsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.docdb.paginators.DescribeDBSubnetGroupsIterable responses = client
.describeDBSubnetGroupsPaginator(request);
for (software.amazon.awssdk.services.docdb.model.DescribeDbSubnetGroupsResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.docdb.paginators.DescribeDBSubnetGroupsIterable responses = client.describeDBSubnetGroupsPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxRecords won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeDBSubnetGroups(software.amazon.awssdk.services.docdb.model.DescribeDbSubnetGroupsRequest)
operation.
This is a convenience which creates an instance of the DescribeDbSubnetGroupsRequest.Builder avoiding the
need to create one manually via DescribeDbSubnetGroupsRequest.builder()
describeDbSubnetGroupsRequest - A Consumer that will call methods on DescribeDBSubnetGroupsMessage.Builder to create a
request. Represents the input to DescribeDBSubnetGroups.DbSubnetGroupNotFoundException - DBSubnetGroupName doesn't refer to an existing subnet group.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.DocDbException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeEngineDefaultClusterParametersResponse describeEngineDefaultClusterParameters(DescribeEngineDefaultClusterParametersRequest describeEngineDefaultClusterParametersRequest) throws AwsServiceException, SdkClientException, DocDbException
Returns the default engine and system parameter information for the cluster database engine.
describeEngineDefaultClusterParametersRequest - Represents the input to DescribeEngineDefaultClusterParameters.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.DocDbException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeEngineDefaultClusterParametersResponse describeEngineDefaultClusterParameters(Consumer<DescribeEngineDefaultClusterParametersRequest.Builder> describeEngineDefaultClusterParametersRequest) throws AwsServiceException, SdkClientException, DocDbException
Returns the default engine and system parameter information for the cluster database engine.
This is a convenience which creates an instance of the
DescribeEngineDefaultClusterParametersRequest.Builder avoiding the need to create one manually via
DescribeEngineDefaultClusterParametersRequest.builder()
describeEngineDefaultClusterParametersRequest - A Consumer that will call methods on DescribeEngineDefaultClusterParametersMessage.Builder
to create a request. Represents the input to DescribeEngineDefaultClusterParameters.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.DocDbException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeEventCategoriesResponse describeEventCategories(DescribeEventCategoriesRequest describeEventCategoriesRequest) throws AwsServiceException, SdkClientException, DocDbException
Displays a list of categories for all event source types, or, if specified, for a specified source type.
describeEventCategoriesRequest - Represents the input to DescribeEventCategories.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.DocDbException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeEventCategoriesResponse describeEventCategories(Consumer<DescribeEventCategoriesRequest.Builder> describeEventCategoriesRequest) throws AwsServiceException, SdkClientException, DocDbException
Displays a list of categories for all event source types, or, if specified, for a specified source type.
This is a convenience which creates an instance of the DescribeEventCategoriesRequest.Builder avoiding
the need to create one manually via DescribeEventCategoriesRequest.builder()
describeEventCategoriesRequest - A Consumer that will call methods on DescribeEventCategoriesMessage.Builder to create a
request. Represents the input to DescribeEventCategories.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.DocDbException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeEventCategoriesResponse describeEventCategories() throws AwsServiceException, SdkClientException, DocDbException
Displays a list of categories for all event source types, or, if specified, for a specified source type.
SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.DocDbException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondescribeEventCategories(DescribeEventCategoriesRequest),
AWS
API Documentationdefault DescribeEventSubscriptionsResponse describeEventSubscriptions(DescribeEventSubscriptionsRequest describeEventSubscriptionsRequest) throws SubscriptionNotFoundException, AwsServiceException, SdkClientException, DocDbException
Lists all the subscription descriptions for a customer account. The description for a subscription includes
SubscriptionName, SNSTopicARN, CustomerID, SourceType,
SourceID, CreationTime, and Status.
If you specify a SubscriptionName, lists the description for that subscription.
describeEventSubscriptionsRequest - Represents the input to DescribeEventSubscriptions.SubscriptionNotFoundException - The subscription name does not exist.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.DocDbException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeEventSubscriptionsResponse describeEventSubscriptions(Consumer<DescribeEventSubscriptionsRequest.Builder> describeEventSubscriptionsRequest) throws SubscriptionNotFoundException, AwsServiceException, SdkClientException, DocDbException
Lists all the subscription descriptions for a customer account. The description for a subscription includes
SubscriptionName, SNSTopicARN, CustomerID, SourceType,
SourceID, CreationTime, and Status.
If you specify a SubscriptionName, lists the description for that subscription.
This is a convenience which creates an instance of the DescribeEventSubscriptionsRequest.Builder avoiding
the need to create one manually via DescribeEventSubscriptionsRequest.builder()
describeEventSubscriptionsRequest - A Consumer that will call methods on DescribeEventSubscriptionsMessage.Builder to create a
request. Represents the input to DescribeEventSubscriptions.SubscriptionNotFoundException - The subscription name does not exist.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.DocDbException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeEventSubscriptionsIterable describeEventSubscriptionsPaginator(DescribeEventSubscriptionsRequest describeEventSubscriptionsRequest) throws SubscriptionNotFoundException, AwsServiceException, SdkClientException, DocDbException
Lists all the subscription descriptions for a customer account. The description for a subscription includes
SubscriptionName, SNSTopicARN, CustomerID, SourceType,
SourceID, CreationTime, and Status.
If you specify a SubscriptionName, lists the description for that subscription.
This is a variant of
describeEventSubscriptions(software.amazon.awssdk.services.docdb.model.DescribeEventSubscriptionsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.docdb.paginators.DescribeEventSubscriptionsIterable responses = client.describeEventSubscriptionsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.docdb.paginators.DescribeEventSubscriptionsIterable responses = client
.describeEventSubscriptionsPaginator(request);
for (software.amazon.awssdk.services.docdb.model.DescribeEventSubscriptionsResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.docdb.paginators.DescribeEventSubscriptionsIterable responses = client.describeEventSubscriptionsPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxRecords won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeEventSubscriptions(software.amazon.awssdk.services.docdb.model.DescribeEventSubscriptionsRequest)
operation.
describeEventSubscriptionsRequest - Represents the input to DescribeEventSubscriptions.SubscriptionNotFoundException - The subscription name does not exist.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.DocDbException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeEventSubscriptionsIterable describeEventSubscriptionsPaginator(Consumer<DescribeEventSubscriptionsRequest.Builder> describeEventSubscriptionsRequest) throws SubscriptionNotFoundException, AwsServiceException, SdkClientException, DocDbException
Lists all the subscription descriptions for a customer account. The description for a subscription includes
SubscriptionName, SNSTopicARN, CustomerID, SourceType,
SourceID, CreationTime, and Status.
If you specify a SubscriptionName, lists the description for that subscription.
This is a variant of
describeEventSubscriptions(software.amazon.awssdk.services.docdb.model.DescribeEventSubscriptionsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.docdb.paginators.DescribeEventSubscriptionsIterable responses = client.describeEventSubscriptionsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.docdb.paginators.DescribeEventSubscriptionsIterable responses = client
.describeEventSubscriptionsPaginator(request);
for (software.amazon.awssdk.services.docdb.model.DescribeEventSubscriptionsResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.docdb.paginators.DescribeEventSubscriptionsIterable responses = client.describeEventSubscriptionsPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxRecords won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeEventSubscriptions(software.amazon.awssdk.services.docdb.model.DescribeEventSubscriptionsRequest)
operation.
This is a convenience which creates an instance of the DescribeEventSubscriptionsRequest.Builder avoiding
the need to create one manually via DescribeEventSubscriptionsRequest.builder()
describeEventSubscriptionsRequest - A Consumer that will call methods on DescribeEventSubscriptionsMessage.Builder to create a
request. Represents the input to DescribeEventSubscriptions.SubscriptionNotFoundException - The subscription name does not exist.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.DocDbException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeEventsResponse describeEvents(DescribeEventsRequest describeEventsRequest) throws AwsServiceException, SdkClientException, DocDbException
Returns events related to instances, security groups, snapshots, and DB parameter groups for the past 14 days. You can obtain events specific to a particular DB instance, security group, snapshot, or parameter group by providing the name as a parameter. By default, the events of the past hour are returned.
describeEventsRequest - Represents the input to DescribeEvents.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.DocDbException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeEventsResponse describeEvents(Consumer<DescribeEventsRequest.Builder> describeEventsRequest) throws AwsServiceException, SdkClientException, DocDbException
Returns events related to instances, security groups, snapshots, and DB parameter groups for the past 14 days. You can obtain events specific to a particular DB instance, security group, snapshot, or parameter group by providing the name as a parameter. By default, the events of the past hour are returned.
This is a convenience which creates an instance of the DescribeEventsRequest.Builder avoiding the need to
create one manually via DescribeEventsRequest.builder()
describeEventsRequest - A Consumer that will call methods on DescribeEventsMessage.Builder to create a request.
Represents the input to DescribeEvents.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.DocDbException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeEventsResponse describeEvents() throws AwsServiceException, SdkClientException, DocDbException
Returns events related to instances, security groups, snapshots, and DB parameter groups for the past 14 days. You can obtain events specific to a particular DB instance, security group, snapshot, or parameter group by providing the name as a parameter. By default, the events of the past hour are returned.
SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.DocDbException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondescribeEvents(DescribeEventsRequest),
AWS API
Documentationdefault DescribeEventsIterable describeEventsPaginator() throws AwsServiceException, SdkClientException, DocDbException
Returns events related to instances, security groups, snapshots, and DB parameter groups for the past 14 days. You can obtain events specific to a particular DB instance, security group, snapshot, or parameter group by providing the name as a parameter. By default, the events of the past hour are returned.
This is a variant of describeEvents(software.amazon.awssdk.services.docdb.model.DescribeEventsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.docdb.paginators.DescribeEventsIterable responses = client.describeEventsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.docdb.paginators.DescribeEventsIterable responses = client.describeEventsPaginator(request);
for (software.amazon.awssdk.services.docdb.model.DescribeEventsResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.docdb.paginators.DescribeEventsIterable responses = client.describeEventsPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxRecords won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeEvents(software.amazon.awssdk.services.docdb.model.DescribeEventsRequest) operation.
SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.DocDbException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondescribeEventsPaginator(DescribeEventsRequest),
AWS API
Documentationdefault DescribeEventsIterable describeEventsPaginator(DescribeEventsRequest describeEventsRequest) throws AwsServiceException, SdkClientException, DocDbException
Returns events related to instances, security groups, snapshots, and DB parameter groups for the past 14 days. You can obtain events specific to a particular DB instance, security group, snapshot, or parameter group by providing the name as a parameter. By default, the events of the past hour are returned.
This is a variant of describeEvents(software.amazon.awssdk.services.docdb.model.DescribeEventsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.docdb.paginators.DescribeEventsIterable responses = client.describeEventsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.docdb.paginators.DescribeEventsIterable responses = client.describeEventsPaginator(request);
for (software.amazon.awssdk.services.docdb.model.DescribeEventsResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.docdb.paginators.DescribeEventsIterable responses = client.describeEventsPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxRecords won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeEvents(software.amazon.awssdk.services.docdb.model.DescribeEventsRequest) operation.
describeEventsRequest - Represents the input to DescribeEvents.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.DocDbException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeEventsIterable describeEventsPaginator(Consumer<DescribeEventsRequest.Builder> describeEventsRequest) throws AwsServiceException, SdkClientException, DocDbException
Returns events related to instances, security groups, snapshots, and DB parameter groups for the past 14 days. You can obtain events specific to a particular DB instance, security group, snapshot, or parameter group by providing the name as a parameter. By default, the events of the past hour are returned.
This is a variant of describeEvents(software.amazon.awssdk.services.docdb.model.DescribeEventsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.docdb.paginators.DescribeEventsIterable responses = client.describeEventsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.docdb.paginators.DescribeEventsIterable responses = client.describeEventsPaginator(request);
for (software.amazon.awssdk.services.docdb.model.DescribeEventsResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.docdb.paginators.DescribeEventsIterable responses = client.describeEventsPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxRecords won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeEvents(software.amazon.awssdk.services.docdb.model.DescribeEventsRequest) operation.
This is a convenience which creates an instance of the DescribeEventsRequest.Builder avoiding the need to
create one manually via DescribeEventsRequest.builder()
describeEventsRequest - A Consumer that will call methods on DescribeEventsMessage.Builder to create a request.
Represents the input to DescribeEvents.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.DocDbException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeGlobalClustersResponse describeGlobalClusters(DescribeGlobalClustersRequest describeGlobalClustersRequest) throws GlobalClusterNotFoundException, AwsServiceException, SdkClientException, DocDbException
Returns information about Amazon DocumentDB global clusters. This API supports pagination.
This action only applies to Amazon DocumentDB clusters.
describeGlobalClustersRequest - GlobalClusterNotFoundException - The GlobalClusterIdentifier doesn't refer to an existing global cluster.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.DocDbException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeGlobalClustersResponse describeGlobalClusters(Consumer<DescribeGlobalClustersRequest.Builder> describeGlobalClustersRequest) throws GlobalClusterNotFoundException, AwsServiceException, SdkClientException, DocDbException
Returns information about Amazon DocumentDB global clusters. This API supports pagination.
This action only applies to Amazon DocumentDB clusters.
This is a convenience which creates an instance of the DescribeGlobalClustersRequest.Builder avoiding the
need to create one manually via DescribeGlobalClustersRequest.builder()
describeGlobalClustersRequest - A Consumer that will call methods on DescribeGlobalClustersMessage.Builder to create a
request.GlobalClusterNotFoundException - The GlobalClusterIdentifier doesn't refer to an existing global cluster.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.DocDbException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeGlobalClustersIterable describeGlobalClustersPaginator(DescribeGlobalClustersRequest describeGlobalClustersRequest) throws GlobalClusterNotFoundException, AwsServiceException, SdkClientException, DocDbException
Returns information about Amazon DocumentDB global clusters. This API supports pagination.
This action only applies to Amazon DocumentDB clusters.
This is a variant of
describeGlobalClusters(software.amazon.awssdk.services.docdb.model.DescribeGlobalClustersRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.docdb.paginators.DescribeGlobalClustersIterable responses = client.describeGlobalClustersPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.docdb.paginators.DescribeGlobalClustersIterable responses = client
.describeGlobalClustersPaginator(request);
for (software.amazon.awssdk.services.docdb.model.DescribeGlobalClustersResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.docdb.paginators.DescribeGlobalClustersIterable responses = client.describeGlobalClustersPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxRecords won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeGlobalClusters(software.amazon.awssdk.services.docdb.model.DescribeGlobalClustersRequest)
operation.
describeGlobalClustersRequest - GlobalClusterNotFoundException - The GlobalClusterIdentifier doesn't refer to an existing global cluster.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.DocDbException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeGlobalClustersIterable describeGlobalClustersPaginator(Consumer<DescribeGlobalClustersRequest.Builder> describeGlobalClustersRequest) throws GlobalClusterNotFoundException, AwsServiceException, SdkClientException, DocDbException
Returns information about Amazon DocumentDB global clusters. This API supports pagination.
This action only applies to Amazon DocumentDB clusters.
This is a variant of
describeGlobalClusters(software.amazon.awssdk.services.docdb.model.DescribeGlobalClustersRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.docdb.paginators.DescribeGlobalClustersIterable responses = client.describeGlobalClustersPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.docdb.paginators.DescribeGlobalClustersIterable responses = client
.describeGlobalClustersPaginator(request);
for (software.amazon.awssdk.services.docdb.model.DescribeGlobalClustersResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.docdb.paginators.DescribeGlobalClustersIterable responses = client.describeGlobalClustersPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxRecords won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeGlobalClusters(software.amazon.awssdk.services.docdb.model.DescribeGlobalClustersRequest)
operation.
This is a convenience which creates an instance of the DescribeGlobalClustersRequest.Builder avoiding the
need to create one manually via DescribeGlobalClustersRequest.builder()
describeGlobalClustersRequest - A Consumer that will call methods on DescribeGlobalClustersMessage.Builder to create a
request.GlobalClusterNotFoundException - The GlobalClusterIdentifier doesn't refer to an existing global cluster.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.DocDbException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeOrderableDbInstanceOptionsResponse describeOrderableDBInstanceOptions(DescribeOrderableDbInstanceOptionsRequest describeOrderableDbInstanceOptionsRequest) throws AwsServiceException, SdkClientException, DocDbException
Returns a list of orderable instance options for the specified engine.
describeOrderableDbInstanceOptionsRequest - Represents the input to DescribeOrderableDBInstanceOptions.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.DocDbException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeOrderableDbInstanceOptionsResponse describeOrderableDBInstanceOptions(Consumer<DescribeOrderableDbInstanceOptionsRequest.Builder> describeOrderableDbInstanceOptionsRequest) throws AwsServiceException, SdkClientException, DocDbException
Returns a list of orderable instance options for the specified engine.
This is a convenience which creates an instance of the DescribeOrderableDbInstanceOptionsRequest.Builder
avoiding the need to create one manually via DescribeOrderableDbInstanceOptionsRequest.builder()
describeOrderableDbInstanceOptionsRequest - A Consumer that will call methods on DescribeOrderableDBInstanceOptionsMessage.Builder to
create a request. Represents the input to DescribeOrderableDBInstanceOptions.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.DocDbException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeOrderableDBInstanceOptionsIterable describeOrderableDBInstanceOptionsPaginator(DescribeOrderableDbInstanceOptionsRequest describeOrderableDbInstanceOptionsRequest) throws AwsServiceException, SdkClientException, DocDbException
Returns a list of orderable instance options for the specified engine.
This is a variant of
describeOrderableDBInstanceOptions(software.amazon.awssdk.services.docdb.model.DescribeOrderableDbInstanceOptionsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.docdb.paginators.DescribeOrderableDBInstanceOptionsIterable responses = client.describeOrderableDBInstanceOptionsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.docdb.paginators.DescribeOrderableDBInstanceOptionsIterable responses = client
.describeOrderableDBInstanceOptionsPaginator(request);
for (software.amazon.awssdk.services.docdb.model.DescribeOrderableDbInstanceOptionsResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.docdb.paginators.DescribeOrderableDBInstanceOptionsIterable responses = client.describeOrderableDBInstanceOptionsPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxRecords won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeOrderableDBInstanceOptions(software.amazon.awssdk.services.docdb.model.DescribeOrderableDbInstanceOptionsRequest)
operation.
describeOrderableDbInstanceOptionsRequest - Represents the input to DescribeOrderableDBInstanceOptions.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.DocDbException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeOrderableDBInstanceOptionsIterable describeOrderableDBInstanceOptionsPaginator(Consumer<DescribeOrderableDbInstanceOptionsRequest.Builder> describeOrderableDbInstanceOptionsRequest) throws AwsServiceException, SdkClientException, DocDbException
Returns a list of orderable instance options for the specified engine.
This is a variant of
describeOrderableDBInstanceOptions(software.amazon.awssdk.services.docdb.model.DescribeOrderableDbInstanceOptionsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.docdb.paginators.DescribeOrderableDBInstanceOptionsIterable responses = client.describeOrderableDBInstanceOptionsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.docdb.paginators.DescribeOrderableDBInstanceOptionsIterable responses = client
.describeOrderableDBInstanceOptionsPaginator(request);
for (software.amazon.awssdk.services.docdb.model.DescribeOrderableDbInstanceOptionsResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.docdb.paginators.DescribeOrderableDBInstanceOptionsIterable responses = client.describeOrderableDBInstanceOptionsPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxRecords won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeOrderableDBInstanceOptions(software.amazon.awssdk.services.docdb.model.DescribeOrderableDbInstanceOptionsRequest)
operation.
This is a convenience which creates an instance of the DescribeOrderableDbInstanceOptionsRequest.Builder
avoiding the need to create one manually via DescribeOrderableDbInstanceOptionsRequest.builder()
describeOrderableDbInstanceOptionsRequest - A Consumer that will call methods on DescribeOrderableDBInstanceOptionsMessage.Builder to
create a request. Represents the input to DescribeOrderableDBInstanceOptions.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.DocDbException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribePendingMaintenanceActionsResponse describePendingMaintenanceActions(DescribePendingMaintenanceActionsRequest describePendingMaintenanceActionsRequest) throws ResourceNotFoundException, AwsServiceException, SdkClientException, DocDbException
Returns a list of resources (for example, instances) that have at least one pending maintenance action.
describePendingMaintenanceActionsRequest - Represents the input to DescribePendingMaintenanceActions.ResourceNotFoundException - The specified resource ID was not found.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.DocDbException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribePendingMaintenanceActionsResponse describePendingMaintenanceActions(Consumer<DescribePendingMaintenanceActionsRequest.Builder> describePendingMaintenanceActionsRequest) throws ResourceNotFoundException, AwsServiceException, SdkClientException, DocDbException
Returns a list of resources (for example, instances) that have at least one pending maintenance action.
This is a convenience which creates an instance of the DescribePendingMaintenanceActionsRequest.Builder
avoiding the need to create one manually via DescribePendingMaintenanceActionsRequest.builder()
describePendingMaintenanceActionsRequest - A Consumer that will call methods on DescribePendingMaintenanceActionsMessage.Builder to
create a request. Represents the input to DescribePendingMaintenanceActions.ResourceNotFoundException - The specified resource ID was not found.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.DocDbException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribePendingMaintenanceActionsResponse describePendingMaintenanceActions() throws ResourceNotFoundException, AwsServiceException, SdkClientException, DocDbException
Returns a list of resources (for example, instances) that have at least one pending maintenance action.
ResourceNotFoundException - The specified resource ID was not found.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.DocDbException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondescribePendingMaintenanceActions(DescribePendingMaintenanceActionsRequest),
AWS API Documentationdefault DescribePendingMaintenanceActionsIterable describePendingMaintenanceActionsPaginator() throws ResourceNotFoundException, AwsServiceException, SdkClientException, DocDbException
Returns a list of resources (for example, instances) that have at least one pending maintenance action.
This is a variant of
describePendingMaintenanceActions(software.amazon.awssdk.services.docdb.model.DescribePendingMaintenanceActionsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.docdb.paginators.DescribePendingMaintenanceActionsIterable responses = client.describePendingMaintenanceActionsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.docdb.paginators.DescribePendingMaintenanceActionsIterable responses = client
.describePendingMaintenanceActionsPaginator(request);
for (software.amazon.awssdk.services.docdb.model.DescribePendingMaintenanceActionsResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.docdb.paginators.DescribePendingMaintenanceActionsIterable responses = client.describePendingMaintenanceActionsPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxRecords won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describePendingMaintenanceActions(software.amazon.awssdk.services.docdb.model.DescribePendingMaintenanceActionsRequest)
operation.
ResourceNotFoundException - The specified resource ID was not found.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.DocDbException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondescribePendingMaintenanceActionsPaginator(DescribePendingMaintenanceActionsRequest),
AWS API Documentationdefault DescribePendingMaintenanceActionsIterable describePendingMaintenanceActionsPaginator(DescribePendingMaintenanceActionsRequest describePendingMaintenanceActionsRequest) throws ResourceNotFoundException, AwsServiceException, SdkClientException, DocDbException
Returns a list of resources (for example, instances) that have at least one pending maintenance action.
This is a variant of
describePendingMaintenanceActions(software.amazon.awssdk.services.docdb.model.DescribePendingMaintenanceActionsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.docdb.paginators.DescribePendingMaintenanceActionsIterable responses = client.describePendingMaintenanceActionsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.docdb.paginators.DescribePendingMaintenanceActionsIterable responses = client
.describePendingMaintenanceActionsPaginator(request);
for (software.amazon.awssdk.services.docdb.model.DescribePendingMaintenanceActionsResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.docdb.paginators.DescribePendingMaintenanceActionsIterable responses = client.describePendingMaintenanceActionsPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxRecords won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describePendingMaintenanceActions(software.amazon.awssdk.services.docdb.model.DescribePendingMaintenanceActionsRequest)
operation.
describePendingMaintenanceActionsRequest - Represents the input to DescribePendingMaintenanceActions.ResourceNotFoundException - The specified resource ID was not found.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.DocDbException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribePendingMaintenanceActionsIterable describePendingMaintenanceActionsPaginator(Consumer<DescribePendingMaintenanceActionsRequest.Builder> describePendingMaintenanceActionsRequest) throws ResourceNotFoundException, AwsServiceException, SdkClientException, DocDbException
Returns a list of resources (for example, instances) that have at least one pending maintenance action.
This is a variant of
describePendingMaintenanceActions(software.amazon.awssdk.services.docdb.model.DescribePendingMaintenanceActionsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.docdb.paginators.DescribePendingMaintenanceActionsIterable responses = client.describePendingMaintenanceActionsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.docdb.paginators.DescribePendingMaintenanceActionsIterable responses = client
.describePendingMaintenanceActionsPaginator(request);
for (software.amazon.awssdk.services.docdb.model.DescribePendingMaintenanceActionsResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.docdb.paginators.DescribePendingMaintenanceActionsIterable responses = client.describePendingMaintenanceActionsPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxRecords won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describePendingMaintenanceActions(software.amazon.awssdk.services.docdb.model.DescribePendingMaintenanceActionsRequest)
operation.
This is a convenience which creates an instance of the DescribePendingMaintenanceActionsRequest.Builder
avoiding the need to create one manually via DescribePendingMaintenanceActionsRequest.builder()
describePendingMaintenanceActionsRequest - A Consumer that will call methods on DescribePendingMaintenanceActionsMessage.Builder to
create a request. Represents the input to DescribePendingMaintenanceActions.ResourceNotFoundException - The specified resource ID was not found.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.DocDbException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault FailoverDbClusterResponse failoverDBCluster(FailoverDbClusterRequest failoverDbClusterRequest) throws DbClusterNotFoundException, InvalidDbClusterStateException, InvalidDbInstanceStateException, AwsServiceException, SdkClientException, DocDbException
Forces a failover for a cluster.
A failover for a cluster promotes one of the Amazon DocumentDB replicas (read-only instances) in the cluster to be the primary instance (the cluster writer).
If the primary instance fails, Amazon DocumentDB automatically fails over to an Amazon DocumentDB replica, if one exists. You can force a failover when you want to simulate a failure of a primary instance for testing.
failoverDbClusterRequest - Represents the input to FailoverDBCluster.DbClusterNotFoundException - DBClusterIdentifier doesn't refer to an existing cluster.InvalidDbClusterStateException - The cluster isn't in a valid state.InvalidDbInstanceStateException - The specified instance isn't in the available state.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.DocDbException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault FailoverDbClusterResponse failoverDBCluster(Consumer<FailoverDbClusterRequest.Builder> failoverDbClusterRequest) throws DbClusterNotFoundException, InvalidDbClusterStateException, InvalidDbInstanceStateException, AwsServiceException, SdkClientException, DocDbException
Forces a failover for a cluster.
A failover for a cluster promotes one of the Amazon DocumentDB replicas (read-only instances) in the cluster to be the primary instance (the cluster writer).
If the primary instance fails, Amazon DocumentDB automatically fails over to an Amazon DocumentDB replica, if one exists. You can force a failover when you want to simulate a failure of a primary instance for testing.
This is a convenience which creates an instance of the FailoverDbClusterRequest.Builder avoiding the need
to create one manually via FailoverDbClusterRequest.builder()
failoverDbClusterRequest - A Consumer that will call methods on FailoverDBClusterMessage.Builder to create a request.
Represents the input to FailoverDBCluster.DbClusterNotFoundException - DBClusterIdentifier doesn't refer to an existing cluster.InvalidDbClusterStateException - The cluster isn't in a valid state.InvalidDbInstanceStateException - The specified instance isn't in the available state.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.DocDbException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListTagsForResourceResponse listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest) throws DbInstanceNotFoundException, DbSnapshotNotFoundException, DbClusterNotFoundException, AwsServiceException, SdkClientException, DocDbException
Lists all tags on an Amazon DocumentDB resource.
listTagsForResourceRequest - Represents the input to ListTagsForResource.DbInstanceNotFoundException - DBInstanceIdentifier doesn't refer to an existing instance.DbSnapshotNotFoundException - DBSnapshotIdentifier doesn't refer to an existing snapshot.DbClusterNotFoundException - DBClusterIdentifier doesn't refer to an existing cluster.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.DocDbException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListTagsForResourceResponse listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest) throws DbInstanceNotFoundException, DbSnapshotNotFoundException, DbClusterNotFoundException, AwsServiceException, SdkClientException, DocDbException
Lists all tags on an Amazon DocumentDB resource.
This is a convenience which creates an instance of the ListTagsForResourceRequest.Builder avoiding the
need to create one manually via ListTagsForResourceRequest.builder()
listTagsForResourceRequest - A Consumer that will call methods on ListTagsForResourceMessage.Builder to create a
request. Represents the input to ListTagsForResource.DbInstanceNotFoundException - DBInstanceIdentifier doesn't refer to an existing instance.DbSnapshotNotFoundException - DBSnapshotIdentifier doesn't refer to an existing snapshot.DbClusterNotFoundException - DBClusterIdentifier doesn't refer to an existing cluster.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.DocDbException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ModifyDbClusterResponse modifyDBCluster(ModifyDbClusterRequest modifyDbClusterRequest) throws DbClusterNotFoundException, InvalidDbClusterStateException, StorageQuotaExceededException, DbSubnetGroupNotFoundException, InvalidVpcNetworkStateException, InvalidDbSubnetGroupStateException, InvalidSubnetException, DbClusterParameterGroupNotFoundException, InvalidDbSecurityGroupStateException, InvalidDbInstanceStateException, DbClusterAlreadyExistsException, AwsServiceException, SdkClientException, DocDbException
Modifies a setting for an Amazon DocumentDB cluster. You can change one or more database configuration parameters by specifying these parameters and the new values in the request.
modifyDbClusterRequest - Represents the input to ModifyDBCluster.DbClusterNotFoundException - DBClusterIdentifier doesn't refer to an existing cluster.InvalidDbClusterStateException - The cluster isn't in a valid state.StorageQuotaExceededException - The request would cause you to exceed the allowed amount of storage available across all instances.DbSubnetGroupNotFoundException - DBSubnetGroupName doesn't refer to an existing subnet group.InvalidVpcNetworkStateException - The subnet group doesn't cover all Availability Zones after it is created because of changes that were
made.InvalidDbSubnetGroupStateException - The subnet group can't be deleted because it's in use.InvalidSubnetException - The requested subnet is not valid, or multiple subnets were requested that are not all in a common
virtual private cloud (VPC).DbClusterParameterGroupNotFoundException - DBClusterParameterGroupName doesn't refer to an existing cluster parameter group.InvalidDbSecurityGroupStateException - The state of the security group doesn't allow deletion.InvalidDbInstanceStateException - The specified instance isn't in the available state.DbClusterAlreadyExistsException - You already have a cluster with the given identifier.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.DocDbException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ModifyDbClusterResponse modifyDBCluster(Consumer<ModifyDbClusterRequest.Builder> modifyDbClusterRequest) throws DbClusterNotFoundException, InvalidDbClusterStateException, StorageQuotaExceededException, DbSubnetGroupNotFoundException, InvalidVpcNetworkStateException, InvalidDbSubnetGroupStateException, InvalidSubnetException, DbClusterParameterGroupNotFoundException, InvalidDbSecurityGroupStateException, InvalidDbInstanceStateException, DbClusterAlreadyExistsException, AwsServiceException, SdkClientException, DocDbException
Modifies a setting for an Amazon DocumentDB cluster. You can change one or more database configuration parameters by specifying these parameters and the new values in the request.
This is a convenience which creates an instance of the ModifyDbClusterRequest.Builder avoiding the need
to create one manually via ModifyDbClusterRequest.builder()
modifyDbClusterRequest - A Consumer that will call methods on ModifyDBClusterMessage.Builder to create a request.
Represents the input to ModifyDBCluster.DbClusterNotFoundException - DBClusterIdentifier doesn't refer to an existing cluster.InvalidDbClusterStateException - The cluster isn't in a valid state.StorageQuotaExceededException - The request would cause you to exceed the allowed amount of storage available across all instances.DbSubnetGroupNotFoundException - DBSubnetGroupName doesn't refer to an existing subnet group.InvalidVpcNetworkStateException - The subnet group doesn't cover all Availability Zones after it is created because of changes that were
made.InvalidDbSubnetGroupStateException - The subnet group can't be deleted because it's in use.InvalidSubnetException - The requested subnet is not valid, or multiple subnets were requested that are not all in a common
virtual private cloud (VPC).DbClusterParameterGroupNotFoundException - DBClusterParameterGroupName doesn't refer to an existing cluster parameter group.InvalidDbSecurityGroupStateException - The state of the security group doesn't allow deletion.InvalidDbInstanceStateException - The specified instance isn't in the available state.DbClusterAlreadyExistsException - You already have a cluster with the given identifier.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.DocDbException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ModifyDbClusterParameterGroupResponse modifyDBClusterParameterGroup(ModifyDbClusterParameterGroupRequest modifyDbClusterParameterGroupRequest) throws DbParameterGroupNotFoundException, InvalidDbParameterGroupStateException, AwsServiceException, SdkClientException, DocDbException
Modifies the parameters of a cluster parameter group. To modify more than one parameter, submit a list of the
following: ParameterName, ParameterValue, and ApplyMethod. A maximum of 20
parameters can be modified in a single request.
Changes to dynamic parameters are applied immediately. Changes to static parameters require a reboot or maintenance window before the change can take effect.
After you create a cluster parameter group, you should wait at least 5 minutes before creating your first cluster
that uses that cluster parameter group as the default parameter group. This allows Amazon DocumentDB to fully
complete the create action before the parameter group is used as the default for a new cluster. This step is
especially important for parameters that are critical when creating the default database for a cluster, such as
the character set for the default database defined by the character_set_database parameter.
modifyDbClusterParameterGroupRequest - Represents the input to ModifyDBClusterParameterGroup.DbParameterGroupNotFoundException - DBParameterGroupName doesn't refer to an existing parameter group.InvalidDbParameterGroupStateException - The parameter group is in use, or it is in a state that is not valid. If you are trying to delete the
parameter group, you can't delete it when the parameter group is in this state.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.DocDbException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ModifyDbClusterParameterGroupResponse modifyDBClusterParameterGroup(Consumer<ModifyDbClusterParameterGroupRequest.Builder> modifyDbClusterParameterGroupRequest) throws DbParameterGroupNotFoundException, InvalidDbParameterGroupStateException, AwsServiceException, SdkClientException, DocDbException
Modifies the parameters of a cluster parameter group. To modify more than one parameter, submit a list of the
following: ParameterName, ParameterValue, and ApplyMethod. A maximum of 20
parameters can be modified in a single request.
Changes to dynamic parameters are applied immediately. Changes to static parameters require a reboot or maintenance window before the change can take effect.
After you create a cluster parameter group, you should wait at least 5 minutes before creating your first cluster
that uses that cluster parameter group as the default parameter group. This allows Amazon DocumentDB to fully
complete the create action before the parameter group is used as the default for a new cluster. This step is
especially important for parameters that are critical when creating the default database for a cluster, such as
the character set for the default database defined by the character_set_database parameter.
This is a convenience which creates an instance of the ModifyDbClusterParameterGroupRequest.Builder
avoiding the need to create one manually via ModifyDbClusterParameterGroupRequest.builder()
modifyDbClusterParameterGroupRequest - A Consumer that will call methods on ModifyDBClusterParameterGroupMessage.Builder to
create a request. Represents the input to ModifyDBClusterParameterGroup.DbParameterGroupNotFoundException - DBParameterGroupName doesn't refer to an existing parameter group.InvalidDbParameterGroupStateException - The parameter group is in use, or it is in a state that is not valid. If you are trying to delete the
parameter group, you can't delete it when the parameter group is in this state.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.DocDbException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ModifyDbClusterSnapshotAttributeResponse modifyDBClusterSnapshotAttribute(ModifyDbClusterSnapshotAttributeRequest modifyDbClusterSnapshotAttributeRequest) throws DbClusterSnapshotNotFoundException, InvalidDbClusterSnapshotStateException, SharedSnapshotQuotaExceededException, AwsServiceException, SdkClientException, DocDbException
Adds an attribute and values to, or removes an attribute and values from, a manual cluster snapshot.
To share a manual cluster snapshot with other Amazon Web Services accounts, specify restore as the
AttributeName, and use the ValuesToAdd parameter to add a list of IDs of the Amazon Web
Services accounts that are authorized to restore the manual cluster snapshot. Use the value all to
make the manual cluster snapshot public, which means that it can be copied or restored by all Amazon Web Services
accounts. Do not add the all value for any manual cluster snapshots that contain private information
that you don't want available to all Amazon Web Services accounts. If a manual cluster snapshot is encrypted, it
can be shared, but only by specifying a list of authorized Amazon Web Services account IDs for the
ValuesToAdd parameter. You can't use all as a value for that parameter in this case.
modifyDbClusterSnapshotAttributeRequest - Represents the input to ModifyDBClusterSnapshotAttribute.DbClusterSnapshotNotFoundException - DBClusterSnapshotIdentifier doesn't refer to an existing cluster snapshot.InvalidDbClusterSnapshotStateException - The provided value isn't a valid cluster snapshot state.SharedSnapshotQuotaExceededException - You have exceeded the maximum number of accounts that you can share a manual DB snapshot with.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.DocDbException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ModifyDbClusterSnapshotAttributeResponse modifyDBClusterSnapshotAttribute(Consumer<ModifyDbClusterSnapshotAttributeRequest.Builder> modifyDbClusterSnapshotAttributeRequest) throws DbClusterSnapshotNotFoundException, InvalidDbClusterSnapshotStateException, SharedSnapshotQuotaExceededException, AwsServiceException, SdkClientException, DocDbException
Adds an attribute and values to, or removes an attribute and values from, a manual cluster snapshot.
To share a manual cluster snapshot with other Amazon Web Services accounts, specify restore as the
AttributeName, and use the ValuesToAdd parameter to add a list of IDs of the Amazon Web
Services accounts that are authorized to restore the manual cluster snapshot. Use the value all to
make the manual cluster snapshot public, which means that it can be copied or restored by all Amazon Web Services
accounts. Do not add the all value for any manual cluster snapshots that contain private information
that you don't want available to all Amazon Web Services accounts. If a manual cluster snapshot is encrypted, it
can be shared, but only by specifying a list of authorized Amazon Web Services account IDs for the
ValuesToAdd parameter. You can't use all as a value for that parameter in this case.
This is a convenience which creates an instance of the ModifyDbClusterSnapshotAttributeRequest.Builder
avoiding the need to create one manually via ModifyDbClusterSnapshotAttributeRequest.builder()
modifyDbClusterSnapshotAttributeRequest - A Consumer that will call methods on ModifyDBClusterSnapshotAttributeMessage.Builder to
create a request. Represents the input to ModifyDBClusterSnapshotAttribute.DbClusterSnapshotNotFoundException - DBClusterSnapshotIdentifier doesn't refer to an existing cluster snapshot.InvalidDbClusterSnapshotStateException - The provided value isn't a valid cluster snapshot state.SharedSnapshotQuotaExceededException - You have exceeded the maximum number of accounts that you can share a manual DB snapshot with.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.DocDbException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ModifyDbInstanceResponse modifyDBInstance(ModifyDbInstanceRequest modifyDbInstanceRequest) throws InvalidDbInstanceStateException, InvalidDbSecurityGroupStateException, DbInstanceAlreadyExistsException, DbInstanceNotFoundException, DbSecurityGroupNotFoundException, DbParameterGroupNotFoundException, InsufficientDbInstanceCapacityException, StorageQuotaExceededException, InvalidVpcNetworkStateException, DbUpgradeDependencyFailureException, StorageTypeNotSupportedException, AuthorizationNotFoundException, CertificateNotFoundException, AwsServiceException, SdkClientException, DocDbException
Modifies settings for an instance. You can change one or more database configuration parameters by specifying these parameters and the new values in the request.
modifyDbInstanceRequest - Represents the input to ModifyDBInstance.InvalidDbInstanceStateException - The specified instance isn't in the available state.InvalidDbSecurityGroupStateException - The state of the security group doesn't allow deletion.DbInstanceAlreadyExistsException - You already have a instance with the given identifier.DbInstanceNotFoundException - DBInstanceIdentifier doesn't refer to an existing instance.DbSecurityGroupNotFoundException - DBSecurityGroupName doesn't refer to an existing security group.DbParameterGroupNotFoundException - DBParameterGroupName doesn't refer to an existing parameter group.InsufficientDbInstanceCapacityException - The specified instance class isn't available in the specified Availability Zone.StorageQuotaExceededException - The request would cause you to exceed the allowed amount of storage available across all instances.InvalidVpcNetworkStateException - The subnet group doesn't cover all Availability Zones after it is created because of changes that were
made.DbUpgradeDependencyFailureException - The upgrade failed because a resource that the depends on can't be modified.StorageTypeNotSupportedException - Storage of the specified StorageType can't be associated with the DB instance.AuthorizationNotFoundException - The specified CIDR IP or Amazon EC2 security group isn't authorized for the specified security group.
Amazon DocumentDB also might not be authorized to perform necessary actions on your behalf using IAM.
CertificateNotFoundException - CertificateIdentifier doesn't refer to an existing certificate.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.DocDbException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ModifyDbInstanceResponse modifyDBInstance(Consumer<ModifyDbInstanceRequest.Builder> modifyDbInstanceRequest) throws InvalidDbInstanceStateException, InvalidDbSecurityGroupStateException, DbInstanceAlreadyExistsException, DbInstanceNotFoundException, DbSecurityGroupNotFoundException, DbParameterGroupNotFoundException, InsufficientDbInstanceCapacityException, StorageQuotaExceededException, InvalidVpcNetworkStateException, DbUpgradeDependencyFailureException, StorageTypeNotSupportedException, AuthorizationNotFoundException, CertificateNotFoundException, AwsServiceException, SdkClientException, DocDbException
Modifies settings for an instance. You can change one or more database configuration parameters by specifying these parameters and the new values in the request.
This is a convenience which creates an instance of the ModifyDbInstanceRequest.Builder avoiding the need
to create one manually via ModifyDbInstanceRequest.builder()
modifyDbInstanceRequest - A Consumer that will call methods on ModifyDBInstanceMessage.Builder to create a request.
Represents the input to ModifyDBInstance.InvalidDbInstanceStateException - The specified instance isn't in the available state.InvalidDbSecurityGroupStateException - The state of the security group doesn't allow deletion.DbInstanceAlreadyExistsException - You already have a instance with the given identifier.DbInstanceNotFoundException - DBInstanceIdentifier doesn't refer to an existing instance.DbSecurityGroupNotFoundException - DBSecurityGroupName doesn't refer to an existing security group.DbParameterGroupNotFoundException - DBParameterGroupName doesn't refer to an existing parameter group.InsufficientDbInstanceCapacityException - The specified instance class isn't available in the specified Availability Zone.StorageQuotaExceededException - The request would cause you to exceed the allowed amount of storage available across all instances.InvalidVpcNetworkStateException - The subnet group doesn't cover all Availability Zones after it is created because of changes that were
made.DbUpgradeDependencyFailureException - The upgrade failed because a resource that the depends on can't be modified.StorageTypeNotSupportedException - Storage of the specified StorageType can't be associated with the DB instance.AuthorizationNotFoundException - The specified CIDR IP or Amazon EC2 security group isn't authorized for the specified security group.
Amazon DocumentDB also might not be authorized to perform necessary actions on your behalf using IAM.
CertificateNotFoundException - CertificateIdentifier doesn't refer to an existing certificate.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.DocDbException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ModifyDbSubnetGroupResponse modifyDBSubnetGroup(ModifyDbSubnetGroupRequest modifyDbSubnetGroupRequest) throws DbSubnetGroupNotFoundException, DbSubnetQuotaExceededException, SubnetAlreadyInUseException, DbSubnetGroupDoesNotCoverEnoughAZsException, InvalidSubnetException, AwsServiceException, SdkClientException, DocDbException
Modifies an existing subnet group. subnet groups must contain at least one subnet in at least two Availability Zones in the Amazon Web Services Region.
modifyDbSubnetGroupRequest - Represents the input to ModifyDBSubnetGroup.DbSubnetGroupNotFoundException - DBSubnetGroupName doesn't refer to an existing subnet group.DbSubnetQuotaExceededException - The request would cause you to exceed the allowed number of subnets in a subnet group.SubnetAlreadyInUseException - The subnet is already in use in the Availability Zone.DbSubnetGroupDoesNotCoverEnoughAZsException - Subnets in the subnet group should cover at least two Availability Zones unless there is only one
Availability Zone.InvalidSubnetException - The requested subnet is not valid, or multiple subnets were requested that are not all in a common
virtual private cloud (VPC).SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.DocDbException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ModifyDbSubnetGroupResponse modifyDBSubnetGroup(Consumer<ModifyDbSubnetGroupRequest.Builder> modifyDbSubnetGroupRequest) throws DbSubnetGroupNotFoundException, DbSubnetQuotaExceededException, SubnetAlreadyInUseException, DbSubnetGroupDoesNotCoverEnoughAZsException, InvalidSubnetException, AwsServiceException, SdkClientException, DocDbException
Modifies an existing subnet group. subnet groups must contain at least one subnet in at least two Availability Zones in the Amazon Web Services Region.
This is a convenience which creates an instance of the ModifyDbSubnetGroupRequest.Builder avoiding the
need to create one manually via ModifyDbSubnetGroupRequest.builder()
modifyDbSubnetGroupRequest - A Consumer that will call methods on ModifyDBSubnetGroupMessage.Builder to create a
request. Represents the input to ModifyDBSubnetGroup.DbSubnetGroupNotFoundException - DBSubnetGroupName doesn't refer to an existing subnet group.DbSubnetQuotaExceededException - The request would cause you to exceed the allowed number of subnets in a subnet group.SubnetAlreadyInUseException - The subnet is already in use in the Availability Zone.DbSubnetGroupDoesNotCoverEnoughAZsException - Subnets in the subnet group should cover at least two Availability Zones unless there is only one
Availability Zone.InvalidSubnetException - The requested subnet is not valid, or multiple subnets were requested that are not all in a common
virtual private cloud (VPC).SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.DocDbException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ModifyEventSubscriptionResponse modifyEventSubscription(ModifyEventSubscriptionRequest modifyEventSubscriptionRequest) throws EventSubscriptionQuotaExceededException, SubscriptionNotFoundException, SnsInvalidTopicException, SnsNoAuthorizationException, SnsTopicArnNotFoundException, SubscriptionCategoryNotFoundException, AwsServiceException, SdkClientException, DocDbException
Modifies an existing Amazon DocumentDB event notification subscription.
modifyEventSubscriptionRequest - Represents the input to ModifyEventSubscription.EventSubscriptionQuotaExceededException - You have reached the maximum number of event subscriptions.SubscriptionNotFoundException - The subscription name does not exist.SnsInvalidTopicException - Amazon SNS has responded that there is a problem with the specified topic.SnsNoAuthorizationException - You do not have permission to publish to the SNS topic Amazon Resource Name (ARN).SnsTopicArnNotFoundException - The SNS topic Amazon Resource Name (ARN) does not exist.SubscriptionCategoryNotFoundException - The provided category does not exist.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.DocDbException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ModifyEventSubscriptionResponse modifyEventSubscription(Consumer<ModifyEventSubscriptionRequest.Builder> modifyEventSubscriptionRequest) throws EventSubscriptionQuotaExceededException, SubscriptionNotFoundException, SnsInvalidTopicException, SnsNoAuthorizationException, SnsTopicArnNotFoundException, SubscriptionCategoryNotFoundException, AwsServiceException, SdkClientException, DocDbException
Modifies an existing Amazon DocumentDB event notification subscription.
This is a convenience which creates an instance of the ModifyEventSubscriptionRequest.Builder avoiding
the need to create one manually via ModifyEventSubscriptionRequest.builder()
modifyEventSubscriptionRequest - A Consumer that will call methods on ModifyEventSubscriptionMessage.Builder to create a
request. Represents the input to ModifyEventSubscription.EventSubscriptionQuotaExceededException - You have reached the maximum number of event subscriptions.SubscriptionNotFoundException - The subscription name does not exist.SnsInvalidTopicException - Amazon SNS has responded that there is a problem with the specified topic.SnsNoAuthorizationException - You do not have permission to publish to the SNS topic Amazon Resource Name (ARN).SnsTopicArnNotFoundException - The SNS topic Amazon Resource Name (ARN) does not exist.SubscriptionCategoryNotFoundException - The provided category does not exist.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.DocDbException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ModifyGlobalClusterResponse modifyGlobalCluster(ModifyGlobalClusterRequest modifyGlobalClusterRequest) throws GlobalClusterNotFoundException, InvalidGlobalClusterStateException, AwsServiceException, SdkClientException, DocDbException
Modify a setting for an Amazon DocumentDB global cluster. You can change one or more configuration parameters (for example: deletion protection), or the global cluster identifier by specifying these parameters and the new values in the request.
This action only applies to Amazon DocumentDB clusters.
modifyGlobalClusterRequest - Represents the input to ModifyGlobalCluster.GlobalClusterNotFoundException - The GlobalClusterIdentifier doesn't refer to an existing global cluster.InvalidGlobalClusterStateException - The requested operation can't be performed while the cluster is in this state.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.DocDbException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ModifyGlobalClusterResponse modifyGlobalCluster(Consumer<ModifyGlobalClusterRequest.Builder> modifyGlobalClusterRequest) throws GlobalClusterNotFoundException, InvalidGlobalClusterStateException, AwsServiceException, SdkClientException, DocDbException
Modify a setting for an Amazon DocumentDB global cluster. You can change one or more configuration parameters (for example: deletion protection), or the global cluster identifier by specifying these parameters and the new values in the request.
This action only applies to Amazon DocumentDB clusters.
This is a convenience which creates an instance of the ModifyGlobalClusterRequest.Builder avoiding the
need to create one manually via ModifyGlobalClusterRequest.builder()
modifyGlobalClusterRequest - A Consumer that will call methods on ModifyGlobalClusterMessage.Builder to create a
request. Represents the input to ModifyGlobalCluster.GlobalClusterNotFoundException - The GlobalClusterIdentifier doesn't refer to an existing global cluster.InvalidGlobalClusterStateException - The requested operation can't be performed while the cluster is in this state.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.DocDbException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault RebootDbInstanceResponse rebootDBInstance(RebootDbInstanceRequest rebootDbInstanceRequest) throws InvalidDbInstanceStateException, DbInstanceNotFoundException, AwsServiceException, SdkClientException, DocDbException
You might need to reboot your instance, usually for maintenance reasons. For example, if you make certain changes, or if you change the cluster parameter group that is associated with the instance, you must reboot the instance for the changes to take effect.
Rebooting an instance restarts the database engine service. Rebooting an instance results in a momentary outage, during which the instance status is set to rebooting.
rebootDbInstanceRequest - Represents the input to RebootDBInstance.InvalidDbInstanceStateException - The specified instance isn't in the available state.DbInstanceNotFoundException - DBInstanceIdentifier doesn't refer to an existing instance.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.DocDbException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault RebootDbInstanceResponse rebootDBInstance(Consumer<RebootDbInstanceRequest.Builder> rebootDbInstanceRequest) throws InvalidDbInstanceStateException, DbInstanceNotFoundException, AwsServiceException, SdkClientException, DocDbException
You might need to reboot your instance, usually for maintenance reasons. For example, if you make certain changes, or if you change the cluster parameter group that is associated with the instance, you must reboot the instance for the changes to take effect.
Rebooting an instance restarts the database engine service. Rebooting an instance results in a momentary outage, during which the instance status is set to rebooting.
This is a convenience which creates an instance of the RebootDbInstanceRequest.Builder avoiding the need
to create one manually via RebootDbInstanceRequest.builder()
rebootDbInstanceRequest - A Consumer that will call methods on RebootDBInstanceMessage.Builder to create a request.
Represents the input to RebootDBInstance.InvalidDbInstanceStateException - The specified instance isn't in the available state.DbInstanceNotFoundException - DBInstanceIdentifier doesn't refer to an existing instance.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.DocDbException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault RemoveFromGlobalClusterResponse removeFromGlobalCluster(RemoveFromGlobalClusterRequest removeFromGlobalClusterRequest) throws GlobalClusterNotFoundException, InvalidGlobalClusterStateException, DbClusterNotFoundException, AwsServiceException, SdkClientException, DocDbException
Detaches an Amazon DocumentDB secondary cluster from a global cluster. The cluster becomes a standalone cluster with read-write capability instead of being read-only and receiving data from a primary in a different region.
This action only applies to Amazon DocumentDB clusters.
removeFromGlobalClusterRequest - Represents the input to RemoveFromGlobalCluster.GlobalClusterNotFoundException - The GlobalClusterIdentifier doesn't refer to an existing global cluster.InvalidGlobalClusterStateException - The requested operation can't be performed while the cluster is in this state.DbClusterNotFoundException - DBClusterIdentifier doesn't refer to an existing cluster.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.DocDbException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault RemoveFromGlobalClusterResponse removeFromGlobalCluster(Consumer<RemoveFromGlobalClusterRequest.Builder> removeFromGlobalClusterRequest) throws GlobalClusterNotFoundException, InvalidGlobalClusterStateException, DbClusterNotFoundException, AwsServiceException, SdkClientException, DocDbException
Detaches an Amazon DocumentDB secondary cluster from a global cluster. The cluster becomes a standalone cluster with read-write capability instead of being read-only and receiving data from a primary in a different region.
This action only applies to Amazon DocumentDB clusters.
This is a convenience which creates an instance of the RemoveFromGlobalClusterRequest.Builder avoiding
the need to create one manually via RemoveFromGlobalClusterRequest.builder()
removeFromGlobalClusterRequest - A Consumer that will call methods on RemoveFromGlobalClusterMessage.Builder to create a
request. Represents the input to RemoveFromGlobalCluster.GlobalClusterNotFoundException - The GlobalClusterIdentifier doesn't refer to an existing global cluster.InvalidGlobalClusterStateException - The requested operation can't be performed while the cluster is in this state.DbClusterNotFoundException - DBClusterIdentifier doesn't refer to an existing cluster.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.DocDbException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault RemoveSourceIdentifierFromSubscriptionResponse removeSourceIdentifierFromSubscription(RemoveSourceIdentifierFromSubscriptionRequest removeSourceIdentifierFromSubscriptionRequest) throws SubscriptionNotFoundException, SourceNotFoundException, AwsServiceException, SdkClientException, DocDbException
Removes a source identifier from an existing Amazon DocumentDB event notification subscription.
removeSourceIdentifierFromSubscriptionRequest - Represents the input to RemoveSourceIdentifierFromSubscription.SubscriptionNotFoundException - The subscription name does not exist.SourceNotFoundException - The requested source could not be found.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.DocDbException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault RemoveSourceIdentifierFromSubscriptionResponse removeSourceIdentifierFromSubscription(Consumer<RemoveSourceIdentifierFromSubscriptionRequest.Builder> removeSourceIdentifierFromSubscriptionRequest) throws SubscriptionNotFoundException, SourceNotFoundException, AwsServiceException, SdkClientException, DocDbException
Removes a source identifier from an existing Amazon DocumentDB event notification subscription.
This is a convenience which creates an instance of the
RemoveSourceIdentifierFromSubscriptionRequest.Builder avoiding the need to create one manually via
RemoveSourceIdentifierFromSubscriptionRequest.builder()
removeSourceIdentifierFromSubscriptionRequest - A Consumer that will call methods on RemoveSourceIdentifierFromSubscriptionMessage.Builder
to create a request. Represents the input to RemoveSourceIdentifierFromSubscription.SubscriptionNotFoundException - The subscription name does not exist.SourceNotFoundException - The requested source could not be found.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.DocDbException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault RemoveTagsFromResourceResponse removeTagsFromResource(RemoveTagsFromResourceRequest removeTagsFromResourceRequest) throws DbInstanceNotFoundException, DbSnapshotNotFoundException, DbClusterNotFoundException, AwsServiceException, SdkClientException, DocDbException
Removes metadata tags from an Amazon DocumentDB resource.
removeTagsFromResourceRequest - Represents the input to RemoveTagsFromResource.DbInstanceNotFoundException - DBInstanceIdentifier doesn't refer to an existing instance.DbSnapshotNotFoundException - DBSnapshotIdentifier doesn't refer to an existing snapshot.DbClusterNotFoundException - DBClusterIdentifier doesn't refer to an existing cluster.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.DocDbException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault RemoveTagsFromResourceResponse removeTagsFromResource(Consumer<RemoveTagsFromResourceRequest.Builder> removeTagsFromResourceRequest) throws DbInstanceNotFoundException, DbSnapshotNotFoundException, DbClusterNotFoundException, AwsServiceException, SdkClientException, DocDbException
Removes metadata tags from an Amazon DocumentDB resource.
This is a convenience which creates an instance of the RemoveTagsFromResourceRequest.Builder avoiding the
need to create one manually via RemoveTagsFromResourceRequest.builder()
removeTagsFromResourceRequest - A Consumer that will call methods on RemoveTagsFromResourceMessage.Builder to create a
request. Represents the input to RemoveTagsFromResource.DbInstanceNotFoundException - DBInstanceIdentifier doesn't refer to an existing instance.DbSnapshotNotFoundException - DBSnapshotIdentifier doesn't refer to an existing snapshot.DbClusterNotFoundException - DBClusterIdentifier doesn't refer to an existing cluster.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.DocDbException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ResetDbClusterParameterGroupResponse resetDBClusterParameterGroup(ResetDbClusterParameterGroupRequest resetDbClusterParameterGroupRequest) throws InvalidDbParameterGroupStateException, DbParameterGroupNotFoundException, AwsServiceException, SdkClientException, DocDbException
Modifies the parameters of a cluster parameter group to the default value. To reset specific parameters, submit a
list of the following: ParameterName and ApplyMethod. To reset the entire cluster
parameter group, specify the DBClusterParameterGroupName and ResetAllParameters
parameters.
When you reset the entire group, dynamic parameters are updated immediately and static parameters are set to
pending-reboot to take effect on the next DB instance reboot.
resetDbClusterParameterGroupRequest - Represents the input to ResetDBClusterParameterGroup.InvalidDbParameterGroupStateException - The parameter group is in use, or it is in a state that is not valid. If you are trying to delete the
parameter group, you can't delete it when the parameter group is in this state.DbParameterGroupNotFoundException - DBParameterGroupName doesn't refer to an existing parameter group.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.DocDbException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ResetDbClusterParameterGroupResponse resetDBClusterParameterGroup(Consumer<ResetDbClusterParameterGroupRequest.Builder> resetDbClusterParameterGroupRequest) throws InvalidDbParameterGroupStateException, DbParameterGroupNotFoundException, AwsServiceException, SdkClientException, DocDbException
Modifies the parameters of a cluster parameter group to the default value. To reset specific parameters, submit a
list of the following: ParameterName and ApplyMethod. To reset the entire cluster
parameter group, specify the DBClusterParameterGroupName and ResetAllParameters
parameters.
When you reset the entire group, dynamic parameters are updated immediately and static parameters are set to
pending-reboot to take effect on the next DB instance reboot.
This is a convenience which creates an instance of the ResetDbClusterParameterGroupRequest.Builder
avoiding the need to create one manually via ResetDbClusterParameterGroupRequest.builder()
resetDbClusterParameterGroupRequest - A Consumer that will call methods on ResetDBClusterParameterGroupMessage.Builder to create
a request. Represents the input to ResetDBClusterParameterGroup.InvalidDbParameterGroupStateException - The parameter group is in use, or it is in a state that is not valid. If you are trying to delete the
parameter group, you can't delete it when the parameter group is in this state.DbParameterGroupNotFoundException - DBParameterGroupName doesn't refer to an existing parameter group.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.DocDbException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault RestoreDbClusterFromSnapshotResponse restoreDBClusterFromSnapshot(RestoreDbClusterFromSnapshotRequest restoreDbClusterFromSnapshotRequest) throws DbClusterAlreadyExistsException, DbClusterQuotaExceededException, StorageQuotaExceededException, DbSubnetGroupNotFoundException, DbSnapshotNotFoundException, DbClusterSnapshotNotFoundException, InsufficientDbClusterCapacityException, InsufficientStorageClusterCapacityException, InvalidDbSnapshotStateException, InvalidDbClusterSnapshotStateException, InvalidVpcNetworkStateException, InvalidRestoreException, InvalidSubnetException, KmsKeyNotAccessibleException, AwsServiceException, SdkClientException, DocDbException
Creates a new cluster from a snapshot or cluster snapshot.
If a snapshot is specified, the target cluster is created from the source DB snapshot with a default configuration and default security group.
If a cluster snapshot is specified, the target cluster is created from the source cluster restore point with the same configuration as the original source DB cluster, except that the new cluster is created with the default security group.
restoreDbClusterFromSnapshotRequest - Represents the input to RestoreDBClusterFromSnapshot.DbClusterAlreadyExistsException - You already have a cluster with the given identifier.DbClusterQuotaExceededException - The cluster can't be created because you have reached the maximum allowed quota of clusters.StorageQuotaExceededException - The request would cause you to exceed the allowed amount of storage available across all instances.DbSubnetGroupNotFoundException - DBSubnetGroupName doesn't refer to an existing subnet group.DbSnapshotNotFoundException - DBSnapshotIdentifier doesn't refer to an existing snapshot.DbClusterSnapshotNotFoundException - DBClusterSnapshotIdentifier doesn't refer to an existing cluster snapshot.InsufficientDbClusterCapacityException - The cluster doesn't have enough capacity for the current operation.InsufficientStorageClusterCapacityException - There is not enough storage available for the current action. You might be able to resolve this error by
updating your subnet group to use different Availability Zones that have more storage available.InvalidDbSnapshotStateException - The state of the snapshot doesn't allow deletion.InvalidDbClusterSnapshotStateException - The provided value isn't a valid cluster snapshot state.StorageQuotaExceededException - The request would cause you to exceed the allowed amount of storage available across all instances.InvalidVpcNetworkStateException - The subnet group doesn't cover all Availability Zones after it is created because of changes that were
made.InvalidRestoreException - You cannot restore from a virtual private cloud (VPC) backup to a non-VPC DB instance.DbSubnetGroupNotFoundException - DBSubnetGroupName doesn't refer to an existing subnet group.InvalidSubnetException - The requested subnet is not valid, or multiple subnets were requested that are not all in a common
virtual private cloud (VPC).KmsKeyNotAccessibleException - An error occurred when accessing an KMS key.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.DocDbException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault RestoreDbClusterFromSnapshotResponse restoreDBClusterFromSnapshot(Consumer<RestoreDbClusterFromSnapshotRequest.Builder> restoreDbClusterFromSnapshotRequest) throws DbClusterAlreadyExistsException, DbClusterQuotaExceededException, StorageQuotaExceededException, DbSubnetGroupNotFoundException, DbSnapshotNotFoundException, DbClusterSnapshotNotFoundException, InsufficientDbClusterCapacityException, InsufficientStorageClusterCapacityException, InvalidDbSnapshotStateException, InvalidDbClusterSnapshotStateException, InvalidVpcNetworkStateException, InvalidRestoreException, InvalidSubnetException, KmsKeyNotAccessibleException, AwsServiceException, SdkClientException, DocDbException
Creates a new cluster from a snapshot or cluster snapshot.
If a snapshot is specified, the target cluster is created from the source DB snapshot with a default configuration and default security group.
If a cluster snapshot is specified, the target cluster is created from the source cluster restore point with the same configuration as the original source DB cluster, except that the new cluster is created with the default security group.
This is a convenience which creates an instance of the RestoreDbClusterFromSnapshotRequest.Builder
avoiding the need to create one manually via RestoreDbClusterFromSnapshotRequest.builder()
restoreDbClusterFromSnapshotRequest - A Consumer that will call methods on RestoreDBClusterFromSnapshotMessage.Builder to create
a request. Represents the input to RestoreDBClusterFromSnapshot.DbClusterAlreadyExistsException - You already have a cluster with the given identifier.DbClusterQuotaExceededException - The cluster can't be created because you have reached the maximum allowed quota of clusters.StorageQuotaExceededException - The request would cause you to exceed the allowed amount of storage available across all instances.DbSubnetGroupNotFoundException - DBSubnetGroupName doesn't refer to an existing subnet group.DbSnapshotNotFoundException - DBSnapshotIdentifier doesn't refer to an existing snapshot.DbClusterSnapshotNotFoundException - DBClusterSnapshotIdentifier doesn't refer to an existing cluster snapshot.InsufficientDbClusterCapacityException - The cluster doesn't have enough capacity for the current operation.InsufficientStorageClusterCapacityException - There is not enough storage available for the current action. You might be able to resolve this error by
updating your subnet group to use different Availability Zones that have more storage available.InvalidDbSnapshotStateException - The state of the snapshot doesn't allow deletion.InvalidDbClusterSnapshotStateException - The provided value isn't a valid cluster snapshot state.StorageQuotaExceededException - The request would cause you to exceed the allowed amount of storage available across all instances.InvalidVpcNetworkStateException - The subnet group doesn't cover all Availability Zones after it is created because of changes that were
made.InvalidRestoreException - You cannot restore from a virtual private cloud (VPC) backup to a non-VPC DB instance.DbSubnetGroupNotFoundException - DBSubnetGroupName doesn't refer to an existing subnet group.InvalidSubnetException - The requested subnet is not valid, or multiple subnets were requested that are not all in a common
virtual private cloud (VPC).KmsKeyNotAccessibleException - An error occurred when accessing an KMS key.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.DocDbException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault RestoreDbClusterToPointInTimeResponse restoreDBClusterToPointInTime(RestoreDbClusterToPointInTimeRequest restoreDbClusterToPointInTimeRequest) throws DbClusterAlreadyExistsException, DbClusterNotFoundException, DbClusterQuotaExceededException, DbClusterSnapshotNotFoundException, DbSubnetGroupNotFoundException, InsufficientDbClusterCapacityException, InsufficientStorageClusterCapacityException, InvalidDbClusterSnapshotStateException, InvalidDbClusterStateException, InvalidDbSnapshotStateException, InvalidRestoreException, InvalidSubnetException, InvalidVpcNetworkStateException, KmsKeyNotAccessibleException, StorageQuotaExceededException, AwsServiceException, SdkClientException, DocDbException
Restores a cluster to an arbitrary point in time. Users can restore to any point in time before
LatestRestorableTime for up to BackupRetentionPeriod days. The target cluster is
created from the source cluster with the same configuration as the original cluster, except that the new cluster
is created with the default security group.
restoreDbClusterToPointInTimeRequest - Represents the input to RestoreDBClusterToPointInTime.DbClusterAlreadyExistsException - You already have a cluster with the given identifier.DbClusterNotFoundException - DBClusterIdentifier doesn't refer to an existing cluster.DbClusterQuotaExceededException - The cluster can't be created because you have reached the maximum allowed quota of clusters.DbClusterSnapshotNotFoundException - DBClusterSnapshotIdentifier doesn't refer to an existing cluster snapshot.DbSubnetGroupNotFoundException - DBSubnetGroupName doesn't refer to an existing subnet group.InsufficientDbClusterCapacityException - The cluster doesn't have enough capacity for the current operation.InsufficientStorageClusterCapacityException - There is not enough storage available for the current action. You might be able to resolve this error by
updating your subnet group to use different Availability Zones that have more storage available.InvalidDbClusterSnapshotStateException - The provided value isn't a valid cluster snapshot state.InvalidDbClusterStateException - The cluster isn't in a valid state.InvalidDbSnapshotStateException - The state of the snapshot doesn't allow deletion.InvalidRestoreException - You cannot restore from a virtual private cloud (VPC) backup to a non-VPC DB instance.InvalidSubnetException - The requested subnet is not valid, or multiple subnets were requested that are not all in a common
virtual private cloud (VPC).InvalidVpcNetworkStateException - The subnet group doesn't cover all Availability Zones after it is created because of changes that were
made.KmsKeyNotAccessibleException - An error occurred when accessing an KMS key.StorageQuotaExceededException - The request would cause you to exceed the allowed amount of storage available across all instances.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.DocDbException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault RestoreDbClusterToPointInTimeResponse restoreDBClusterToPointInTime(Consumer<RestoreDbClusterToPointInTimeRequest.Builder> restoreDbClusterToPointInTimeRequest) throws DbClusterAlreadyExistsException, DbClusterNotFoundException, DbClusterQuotaExceededException, DbClusterSnapshotNotFoundException, DbSubnetGroupNotFoundException, InsufficientDbClusterCapacityException, InsufficientStorageClusterCapacityException, InvalidDbClusterSnapshotStateException, InvalidDbClusterStateException, InvalidDbSnapshotStateException, InvalidRestoreException, InvalidSubnetException, InvalidVpcNetworkStateException, KmsKeyNotAccessibleException, StorageQuotaExceededException, AwsServiceException, SdkClientException, DocDbException
Restores a cluster to an arbitrary point in time. Users can restore to any point in time before
LatestRestorableTime for up to BackupRetentionPeriod days. The target cluster is
created from the source cluster with the same configuration as the original cluster, except that the new cluster
is created with the default security group.
This is a convenience which creates an instance of the RestoreDbClusterToPointInTimeRequest.Builder
avoiding the need to create one manually via RestoreDbClusterToPointInTimeRequest.builder()
restoreDbClusterToPointInTimeRequest - A Consumer that will call methods on RestoreDBClusterToPointInTimeMessage.Builder to
create a request. Represents the input to RestoreDBClusterToPointInTime.DbClusterAlreadyExistsException - You already have a cluster with the given identifier.DbClusterNotFoundException - DBClusterIdentifier doesn't refer to an existing cluster.DbClusterQuotaExceededException - The cluster can't be created because you have reached the maximum allowed quota of clusters.DbClusterSnapshotNotFoundException - DBClusterSnapshotIdentifier doesn't refer to an existing cluster snapshot.DbSubnetGroupNotFoundException - DBSubnetGroupName doesn't refer to an existing subnet group.InsufficientDbClusterCapacityException - The cluster doesn't have enough capacity for the current operation.InsufficientStorageClusterCapacityException - There is not enough storage available for the current action. You might be able to resolve this error by
updating your subnet group to use different Availability Zones that have more storage available.InvalidDbClusterSnapshotStateException - The provided value isn't a valid cluster snapshot state.InvalidDbClusterStateException - The cluster isn't in a valid state.InvalidDbSnapshotStateException - The state of the snapshot doesn't allow deletion.InvalidRestoreException - You cannot restore from a virtual private cloud (VPC) backup to a non-VPC DB instance.InvalidSubnetException - The requested subnet is not valid, or multiple subnets were requested that are not all in a common
virtual private cloud (VPC).InvalidVpcNetworkStateException - The subnet group doesn't cover all Availability Zones after it is created because of changes that were
made.KmsKeyNotAccessibleException - An error occurred when accessing an KMS key.StorageQuotaExceededException - The request would cause you to exceed the allowed amount of storage available across all instances.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.DocDbException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault StartDbClusterResponse startDBCluster(StartDbClusterRequest startDbClusterRequest) throws DbClusterNotFoundException, InvalidDbClusterStateException, InvalidDbInstanceStateException, AwsServiceException, SdkClientException, DocDbException
Restarts the stopped cluster that is specified by DBClusterIdentifier. For more information, see Stopping and
Starting an Amazon DocumentDB Cluster.
startDbClusterRequest - DbClusterNotFoundException - DBClusterIdentifier doesn't refer to an existing cluster.InvalidDbClusterStateException - The cluster isn't in a valid state.InvalidDbInstanceStateException - The specified instance isn't in the available state.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.DocDbException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault StartDbClusterResponse startDBCluster(Consumer<StartDbClusterRequest.Builder> startDbClusterRequest) throws DbClusterNotFoundException, InvalidDbClusterStateException, InvalidDbInstanceStateException, AwsServiceException, SdkClientException, DocDbException
Restarts the stopped cluster that is specified by DBClusterIdentifier. For more information, see Stopping and
Starting an Amazon DocumentDB Cluster.
This is a convenience which creates an instance of the StartDbClusterRequest.Builder avoiding the need to
create one manually via StartDbClusterRequest.builder()
startDbClusterRequest - A Consumer that will call methods on StartDBClusterMessage.Builder to create a request.DbClusterNotFoundException - DBClusterIdentifier doesn't refer to an existing cluster.InvalidDbClusterStateException - The cluster isn't in a valid state.InvalidDbInstanceStateException - The specified instance isn't in the available state.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.DocDbException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault StopDbClusterResponse stopDBCluster(StopDbClusterRequest stopDbClusterRequest) throws DbClusterNotFoundException, InvalidDbClusterStateException, InvalidDbInstanceStateException, AwsServiceException, SdkClientException, DocDbException
Stops the running cluster that is specified by DBClusterIdentifier. The cluster must be in the
available state. For more information, see Stopping and
Starting an Amazon DocumentDB Cluster.
stopDbClusterRequest - DbClusterNotFoundException - DBClusterIdentifier doesn't refer to an existing cluster.InvalidDbClusterStateException - The cluster isn't in a valid state.InvalidDbInstanceStateException - The specified instance isn't in the available state.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.DocDbException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault StopDbClusterResponse stopDBCluster(Consumer<StopDbClusterRequest.Builder> stopDbClusterRequest) throws DbClusterNotFoundException, InvalidDbClusterStateException, InvalidDbInstanceStateException, AwsServiceException, SdkClientException, DocDbException
Stops the running cluster that is specified by DBClusterIdentifier. The cluster must be in the
available state. For more information, see Stopping and
Starting an Amazon DocumentDB Cluster.
This is a convenience which creates an instance of the StopDbClusterRequest.Builder avoiding the need to
create one manually via StopDbClusterRequest.builder()
stopDbClusterRequest - A Consumer that will call methods on StopDBClusterMessage.Builder to create a request.DbClusterNotFoundException - DBClusterIdentifier doesn't refer to an existing cluster.InvalidDbClusterStateException - The cluster isn't in a valid state.InvalidDbInstanceStateException - The specified instance isn't in the available state.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.DocDbException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DocDbWaiter waiter()
DocDbWaiter using this client.
Waiters created via this method are managed by the SDK and resources will be released when the service client is closed.
DocDbWaiterstatic DocDbClient create()
DocDbClient with the region loaded from the
DefaultAwsRegionProviderChain and credentials loaded from the
DefaultCredentialsProvider.static DocDbClientBuilder builder()
DocDbClient.static ServiceMetadata serviceMetadata()
default DocDbServiceClientConfiguration serviceClientConfiguration()
serviceClientConfiguration in interface AwsClientserviceClientConfiguration in interface SdkClientCopyright © 2023. All rights reserved.