software.amazon.awssdk.services.docdb.DocDbClient Maven / Gradle / Ivy
/*
* Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with
* the License. A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
* CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions
* and limitations under the License.
*/
package software.amazon.awssdk.services.docdb;
import java.util.function.Consumer;
import software.amazon.awssdk.annotations.Generated;
import software.amazon.awssdk.annotations.SdkPublicApi;
import software.amazon.awssdk.annotations.ThreadSafe;
import software.amazon.awssdk.awscore.exception.AwsServiceException;
import software.amazon.awssdk.core.SdkClient;
import software.amazon.awssdk.core.exception.SdkClientException;
import software.amazon.awssdk.regions.ServiceMetadata;
import software.amazon.awssdk.services.docdb.model.AddSourceIdentifierToSubscriptionRequest;
import software.amazon.awssdk.services.docdb.model.AddSourceIdentifierToSubscriptionResponse;
import software.amazon.awssdk.services.docdb.model.AddTagsToResourceRequest;
import software.amazon.awssdk.services.docdb.model.AddTagsToResourceResponse;
import software.amazon.awssdk.services.docdb.model.ApplyPendingMaintenanceActionRequest;
import software.amazon.awssdk.services.docdb.model.ApplyPendingMaintenanceActionResponse;
import software.amazon.awssdk.services.docdb.model.AuthorizationNotFoundException;
import software.amazon.awssdk.services.docdb.model.CertificateNotFoundException;
import software.amazon.awssdk.services.docdb.model.CopyDbClusterParameterGroupRequest;
import software.amazon.awssdk.services.docdb.model.CopyDbClusterParameterGroupResponse;
import software.amazon.awssdk.services.docdb.model.CopyDbClusterSnapshotRequest;
import software.amazon.awssdk.services.docdb.model.CopyDbClusterSnapshotResponse;
import software.amazon.awssdk.services.docdb.model.CreateDbClusterParameterGroupRequest;
import software.amazon.awssdk.services.docdb.model.CreateDbClusterParameterGroupResponse;
import software.amazon.awssdk.services.docdb.model.CreateDbClusterRequest;
import software.amazon.awssdk.services.docdb.model.CreateDbClusterResponse;
import software.amazon.awssdk.services.docdb.model.CreateDbClusterSnapshotRequest;
import software.amazon.awssdk.services.docdb.model.CreateDbClusterSnapshotResponse;
import software.amazon.awssdk.services.docdb.model.CreateDbInstanceRequest;
import software.amazon.awssdk.services.docdb.model.CreateDbInstanceResponse;
import software.amazon.awssdk.services.docdb.model.CreateDbSubnetGroupRequest;
import software.amazon.awssdk.services.docdb.model.CreateDbSubnetGroupResponse;
import software.amazon.awssdk.services.docdb.model.CreateEventSubscriptionRequest;
import software.amazon.awssdk.services.docdb.model.CreateEventSubscriptionResponse;
import software.amazon.awssdk.services.docdb.model.CreateGlobalClusterRequest;
import software.amazon.awssdk.services.docdb.model.CreateGlobalClusterResponse;
import software.amazon.awssdk.services.docdb.model.DbClusterAlreadyExistsException;
import software.amazon.awssdk.services.docdb.model.DbClusterNotFoundException;
import software.amazon.awssdk.services.docdb.model.DbClusterParameterGroupNotFoundException;
import software.amazon.awssdk.services.docdb.model.DbClusterQuotaExceededException;
import software.amazon.awssdk.services.docdb.model.DbClusterSnapshotAlreadyExistsException;
import software.amazon.awssdk.services.docdb.model.DbClusterSnapshotNotFoundException;
import software.amazon.awssdk.services.docdb.model.DbInstanceAlreadyExistsException;
import software.amazon.awssdk.services.docdb.model.DbInstanceNotFoundException;
import software.amazon.awssdk.services.docdb.model.DbParameterGroupAlreadyExistsException;
import software.amazon.awssdk.services.docdb.model.DbParameterGroupNotFoundException;
import software.amazon.awssdk.services.docdb.model.DbParameterGroupQuotaExceededException;
import software.amazon.awssdk.services.docdb.model.DbSecurityGroupNotFoundException;
import software.amazon.awssdk.services.docdb.model.DbSnapshotAlreadyExistsException;
import software.amazon.awssdk.services.docdb.model.DbSnapshotNotFoundException;
import software.amazon.awssdk.services.docdb.model.DbSubnetGroupAlreadyExistsException;
import software.amazon.awssdk.services.docdb.model.DbSubnetGroupDoesNotCoverEnoughAZsException;
import software.amazon.awssdk.services.docdb.model.DbSubnetGroupNotFoundException;
import software.amazon.awssdk.services.docdb.model.DbSubnetGroupQuotaExceededException;
import software.amazon.awssdk.services.docdb.model.DbSubnetQuotaExceededException;
import software.amazon.awssdk.services.docdb.model.DbUpgradeDependencyFailureException;
import software.amazon.awssdk.services.docdb.model.DeleteDbClusterParameterGroupRequest;
import software.amazon.awssdk.services.docdb.model.DeleteDbClusterParameterGroupResponse;
import software.amazon.awssdk.services.docdb.model.DeleteDbClusterRequest;
import software.amazon.awssdk.services.docdb.model.DeleteDbClusterResponse;
import software.amazon.awssdk.services.docdb.model.DeleteDbClusterSnapshotRequest;
import software.amazon.awssdk.services.docdb.model.DeleteDbClusterSnapshotResponse;
import software.amazon.awssdk.services.docdb.model.DeleteDbInstanceRequest;
import software.amazon.awssdk.services.docdb.model.DeleteDbInstanceResponse;
import software.amazon.awssdk.services.docdb.model.DeleteDbSubnetGroupRequest;
import software.amazon.awssdk.services.docdb.model.DeleteDbSubnetGroupResponse;
import software.amazon.awssdk.services.docdb.model.DeleteEventSubscriptionRequest;
import software.amazon.awssdk.services.docdb.model.DeleteEventSubscriptionResponse;
import software.amazon.awssdk.services.docdb.model.DeleteGlobalClusterRequest;
import software.amazon.awssdk.services.docdb.model.DeleteGlobalClusterResponse;
import software.amazon.awssdk.services.docdb.model.DescribeCertificatesRequest;
import software.amazon.awssdk.services.docdb.model.DescribeCertificatesResponse;
import software.amazon.awssdk.services.docdb.model.DescribeDbClusterParameterGroupsRequest;
import software.amazon.awssdk.services.docdb.model.DescribeDbClusterParameterGroupsResponse;
import software.amazon.awssdk.services.docdb.model.DescribeDbClusterParametersRequest;
import software.amazon.awssdk.services.docdb.model.DescribeDbClusterParametersResponse;
import software.amazon.awssdk.services.docdb.model.DescribeDbClusterSnapshotAttributesRequest;
import software.amazon.awssdk.services.docdb.model.DescribeDbClusterSnapshotAttributesResponse;
import software.amazon.awssdk.services.docdb.model.DescribeDbClusterSnapshotsRequest;
import software.amazon.awssdk.services.docdb.model.DescribeDbClusterSnapshotsResponse;
import software.amazon.awssdk.services.docdb.model.DescribeDbClustersRequest;
import software.amazon.awssdk.services.docdb.model.DescribeDbClustersResponse;
import software.amazon.awssdk.services.docdb.model.DescribeDbEngineVersionsRequest;
import software.amazon.awssdk.services.docdb.model.DescribeDbEngineVersionsResponse;
import software.amazon.awssdk.services.docdb.model.DescribeDbInstancesRequest;
import software.amazon.awssdk.services.docdb.model.DescribeDbInstancesResponse;
import software.amazon.awssdk.services.docdb.model.DescribeDbSubnetGroupsRequest;
import software.amazon.awssdk.services.docdb.model.DescribeDbSubnetGroupsResponse;
import software.amazon.awssdk.services.docdb.model.DescribeEngineDefaultClusterParametersRequest;
import software.amazon.awssdk.services.docdb.model.DescribeEngineDefaultClusterParametersResponse;
import software.amazon.awssdk.services.docdb.model.DescribeEventCategoriesRequest;
import software.amazon.awssdk.services.docdb.model.DescribeEventCategoriesResponse;
import software.amazon.awssdk.services.docdb.model.DescribeEventSubscriptionsRequest;
import software.amazon.awssdk.services.docdb.model.DescribeEventSubscriptionsResponse;
import software.amazon.awssdk.services.docdb.model.DescribeEventsRequest;
import software.amazon.awssdk.services.docdb.model.DescribeEventsResponse;
import software.amazon.awssdk.services.docdb.model.DescribeGlobalClustersRequest;
import software.amazon.awssdk.services.docdb.model.DescribeGlobalClustersResponse;
import software.amazon.awssdk.services.docdb.model.DescribeOrderableDbInstanceOptionsRequest;
import software.amazon.awssdk.services.docdb.model.DescribeOrderableDbInstanceOptionsResponse;
import software.amazon.awssdk.services.docdb.model.DescribePendingMaintenanceActionsRequest;
import software.amazon.awssdk.services.docdb.model.DescribePendingMaintenanceActionsResponse;
import software.amazon.awssdk.services.docdb.model.DocDbException;
import software.amazon.awssdk.services.docdb.model.EventSubscriptionQuotaExceededException;
import software.amazon.awssdk.services.docdb.model.FailoverDbClusterRequest;
import software.amazon.awssdk.services.docdb.model.FailoverDbClusterResponse;
import software.amazon.awssdk.services.docdb.model.GlobalClusterAlreadyExistsException;
import software.amazon.awssdk.services.docdb.model.GlobalClusterNotFoundException;
import software.amazon.awssdk.services.docdb.model.GlobalClusterQuotaExceededException;
import software.amazon.awssdk.services.docdb.model.InstanceQuotaExceededException;
import software.amazon.awssdk.services.docdb.model.InsufficientDbClusterCapacityException;
import software.amazon.awssdk.services.docdb.model.InsufficientDbInstanceCapacityException;
import software.amazon.awssdk.services.docdb.model.InsufficientStorageClusterCapacityException;
import software.amazon.awssdk.services.docdb.model.InvalidDbClusterSnapshotStateException;
import software.amazon.awssdk.services.docdb.model.InvalidDbClusterStateException;
import software.amazon.awssdk.services.docdb.model.InvalidDbInstanceStateException;
import software.amazon.awssdk.services.docdb.model.InvalidDbParameterGroupStateException;
import software.amazon.awssdk.services.docdb.model.InvalidDbSecurityGroupStateException;
import software.amazon.awssdk.services.docdb.model.InvalidDbSnapshotStateException;
import software.amazon.awssdk.services.docdb.model.InvalidDbSubnetGroupStateException;
import software.amazon.awssdk.services.docdb.model.InvalidDbSubnetStateException;
import software.amazon.awssdk.services.docdb.model.InvalidEventSubscriptionStateException;
import software.amazon.awssdk.services.docdb.model.InvalidGlobalClusterStateException;
import software.amazon.awssdk.services.docdb.model.InvalidRestoreException;
import software.amazon.awssdk.services.docdb.model.InvalidSubnetException;
import software.amazon.awssdk.services.docdb.model.InvalidVpcNetworkStateException;
import software.amazon.awssdk.services.docdb.model.KmsKeyNotAccessibleException;
import software.amazon.awssdk.services.docdb.model.ListTagsForResourceRequest;
import software.amazon.awssdk.services.docdb.model.ListTagsForResourceResponse;
import software.amazon.awssdk.services.docdb.model.ModifyDbClusterParameterGroupRequest;
import software.amazon.awssdk.services.docdb.model.ModifyDbClusterParameterGroupResponse;
import software.amazon.awssdk.services.docdb.model.ModifyDbClusterRequest;
import software.amazon.awssdk.services.docdb.model.ModifyDbClusterResponse;
import software.amazon.awssdk.services.docdb.model.ModifyDbClusterSnapshotAttributeRequest;
import software.amazon.awssdk.services.docdb.model.ModifyDbClusterSnapshotAttributeResponse;
import software.amazon.awssdk.services.docdb.model.ModifyDbInstanceRequest;
import software.amazon.awssdk.services.docdb.model.ModifyDbInstanceResponse;
import software.amazon.awssdk.services.docdb.model.ModifyDbSubnetGroupRequest;
import software.amazon.awssdk.services.docdb.model.ModifyDbSubnetGroupResponse;
import software.amazon.awssdk.services.docdb.model.ModifyEventSubscriptionRequest;
import software.amazon.awssdk.services.docdb.model.ModifyEventSubscriptionResponse;
import software.amazon.awssdk.services.docdb.model.ModifyGlobalClusterRequest;
import software.amazon.awssdk.services.docdb.model.ModifyGlobalClusterResponse;
import software.amazon.awssdk.services.docdb.model.RebootDbInstanceRequest;
import software.amazon.awssdk.services.docdb.model.RebootDbInstanceResponse;
import software.amazon.awssdk.services.docdb.model.RemoveFromGlobalClusterRequest;
import software.amazon.awssdk.services.docdb.model.RemoveFromGlobalClusterResponse;
import software.amazon.awssdk.services.docdb.model.RemoveSourceIdentifierFromSubscriptionRequest;
import software.amazon.awssdk.services.docdb.model.RemoveSourceIdentifierFromSubscriptionResponse;
import software.amazon.awssdk.services.docdb.model.RemoveTagsFromResourceRequest;
import software.amazon.awssdk.services.docdb.model.RemoveTagsFromResourceResponse;
import software.amazon.awssdk.services.docdb.model.ResetDbClusterParameterGroupRequest;
import software.amazon.awssdk.services.docdb.model.ResetDbClusterParameterGroupResponse;
import software.amazon.awssdk.services.docdb.model.ResourceNotFoundException;
import software.amazon.awssdk.services.docdb.model.RestoreDbClusterFromSnapshotRequest;
import software.amazon.awssdk.services.docdb.model.RestoreDbClusterFromSnapshotResponse;
import software.amazon.awssdk.services.docdb.model.RestoreDbClusterToPointInTimeRequest;
import software.amazon.awssdk.services.docdb.model.RestoreDbClusterToPointInTimeResponse;
import software.amazon.awssdk.services.docdb.model.SharedSnapshotQuotaExceededException;
import software.amazon.awssdk.services.docdb.model.SnapshotQuotaExceededException;
import software.amazon.awssdk.services.docdb.model.SnsInvalidTopicException;
import software.amazon.awssdk.services.docdb.model.SnsNoAuthorizationException;
import software.amazon.awssdk.services.docdb.model.SnsTopicArnNotFoundException;
import software.amazon.awssdk.services.docdb.model.SourceNotFoundException;
import software.amazon.awssdk.services.docdb.model.StartDbClusterRequest;
import software.amazon.awssdk.services.docdb.model.StartDbClusterResponse;
import software.amazon.awssdk.services.docdb.model.StopDbClusterRequest;
import software.amazon.awssdk.services.docdb.model.StopDbClusterResponse;
import software.amazon.awssdk.services.docdb.model.StorageQuotaExceededException;
import software.amazon.awssdk.services.docdb.model.StorageTypeNotSupportedException;
import software.amazon.awssdk.services.docdb.model.SubnetAlreadyInUseException;
import software.amazon.awssdk.services.docdb.model.SubscriptionAlreadyExistException;
import software.amazon.awssdk.services.docdb.model.SubscriptionCategoryNotFoundException;
import software.amazon.awssdk.services.docdb.model.SubscriptionNotFoundException;
import software.amazon.awssdk.services.docdb.paginators.DescribeCertificatesIterable;
import software.amazon.awssdk.services.docdb.paginators.DescribeDBClusterParameterGroupsIterable;
import software.amazon.awssdk.services.docdb.paginators.DescribeDBClusterParametersIterable;
import software.amazon.awssdk.services.docdb.paginators.DescribeDBClusterSnapshotsIterable;
import software.amazon.awssdk.services.docdb.paginators.DescribeDBClustersIterable;
import software.amazon.awssdk.services.docdb.paginators.DescribeDBEngineVersionsIterable;
import software.amazon.awssdk.services.docdb.paginators.DescribeDBInstancesIterable;
import software.amazon.awssdk.services.docdb.paginators.DescribeDBSubnetGroupsIterable;
import software.amazon.awssdk.services.docdb.paginators.DescribeEventSubscriptionsIterable;
import software.amazon.awssdk.services.docdb.paginators.DescribeEventsIterable;
import software.amazon.awssdk.services.docdb.paginators.DescribeGlobalClustersIterable;
import software.amazon.awssdk.services.docdb.paginators.DescribeOrderableDBInstanceOptionsIterable;
import software.amazon.awssdk.services.docdb.paginators.DescribePendingMaintenanceActionsIterable;
import software.amazon.awssdk.services.docdb.waiters.DocDbWaiter;
/**
* Service client for accessing Amazon DocDB. This can be created using the static {@link #builder()} method.
*
*
* Amazon DocumentDB API documentation
*
*/
@Generated("software.amazon.awssdk:codegen")
@SdkPublicApi
@ThreadSafe
public interface DocDbClient extends SdkClient {
String SERVICE_NAME = "rds";
/**
* Value for looking up the service's metadata from the
* {@link software.amazon.awssdk.regions.ServiceMetadataProvider}.
*/
String SERVICE_METADATA_ID = "rds";
/**
* Create a {@link DocDbClient} with the region loaded from the
* {@link software.amazon.awssdk.regions.providers.DefaultAwsRegionProviderChain} and credentials loaded from the
* {@link software.amazon.awssdk.auth.credentials.DefaultCredentialsProvider}.
*/
static DocDbClient create() {
return builder().build();
}
/**
* Create a builder that can be used to configure and create a {@link DocDbClient}.
*/
static DocDbClientBuilder builder() {
return new DefaultDocDbClientBuilder();
}
/**
*
* Adds a source identifier to an existing event notification subscription.
*
*
* @param addSourceIdentifierToSubscriptionRequest
* Represents the input to AddSourceIdentifierToSubscription.
* @return Result of the AddSourceIdentifierToSubscription operation returned by the service.
* @throws SubscriptionNotFoundException
* The subscription name does not exist.
* @throws SourceNotFoundException
* The requested source could not be found.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws DocDbException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample DocDbClient.AddSourceIdentifierToSubscription
* @see AWS API Documentation
*/
default AddSourceIdentifierToSubscriptionResponse addSourceIdentifierToSubscription(
AddSourceIdentifierToSubscriptionRequest addSourceIdentifierToSubscriptionRequest)
throws SubscriptionNotFoundException, SourceNotFoundException, AwsServiceException, SdkClientException,
DocDbException {
throw new UnsupportedOperationException();
}
/**
*
* Adds a source identifier to an existing event notification subscription.
*
*
*
* This is a convenience which creates an instance of the {@link AddSourceIdentifierToSubscriptionRequest.Builder}
* avoiding the need to create one manually via {@link AddSourceIdentifierToSubscriptionRequest#builder()}
*
*
* @param addSourceIdentifierToSubscriptionRequest
* A {@link Consumer} that will call methods on {@link AddSourceIdentifierToSubscriptionMessage.Builder} to
* create a request. Represents the input to AddSourceIdentifierToSubscription.
* @return Result of the AddSourceIdentifierToSubscription operation returned by the service.
* @throws SubscriptionNotFoundException
* The subscription name does not exist.
* @throws SourceNotFoundException
* The requested source could not be found.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws DocDbException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample DocDbClient.AddSourceIdentifierToSubscription
* @see AWS API Documentation
*/
default AddSourceIdentifierToSubscriptionResponse addSourceIdentifierToSubscription(
Consumer addSourceIdentifierToSubscriptionRequest)
throws SubscriptionNotFoundException, SourceNotFoundException, AwsServiceException, SdkClientException,
DocDbException {
return addSourceIdentifierToSubscription(AddSourceIdentifierToSubscriptionRequest.builder()
.applyMutation(addSourceIdentifierToSubscriptionRequest).build());
}
/**
*
* 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.
*
*
* @param addTagsToResourceRequest
* Represents the input to AddTagsToResource.
* @return Result of the AddTagsToResource operation returned by the service.
* @throws DbInstanceNotFoundException
* DBInstanceIdentifier doesn't refer to an existing instance.
* @throws DbSnapshotNotFoundException
* DBSnapshotIdentifier doesn't refer to an existing snapshot.
* @throws DbClusterNotFoundException
* DBClusterIdentifier doesn't refer to an existing cluster.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws DocDbException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample DocDbClient.AddTagsToResource
* @see AWS API
* Documentation
*/
default AddTagsToResourceResponse addTagsToResource(AddTagsToResourceRequest addTagsToResourceRequest)
throws DbInstanceNotFoundException, DbSnapshotNotFoundException, DbClusterNotFoundException, AwsServiceException,
SdkClientException, DocDbException {
throw new UnsupportedOperationException();
}
/**
*
* 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 {@link AddTagsToResourceRequest.Builder} avoiding the need
* to create one manually via {@link AddTagsToResourceRequest#builder()}
*
*
* @param addTagsToResourceRequest
* A {@link Consumer} that will call methods on {@link AddTagsToResourceMessage.Builder} to create a request.
* Represents the input to AddTagsToResource.
* @return Result of the AddTagsToResource operation returned by the service.
* @throws DbInstanceNotFoundException
* DBInstanceIdentifier doesn't refer to an existing instance.
* @throws DbSnapshotNotFoundException
* DBSnapshotIdentifier doesn't refer to an existing snapshot.
* @throws DbClusterNotFoundException
* DBClusterIdentifier doesn't refer to an existing cluster.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws DocDbException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample DocDbClient.AddTagsToResource
* @see AWS API
* Documentation
*/
default AddTagsToResourceResponse addTagsToResource(Consumer addTagsToResourceRequest)
throws DbInstanceNotFoundException, DbSnapshotNotFoundException, DbClusterNotFoundException, AwsServiceException,
SdkClientException, DocDbException {
return addTagsToResource(AddTagsToResourceRequest.builder().applyMutation(addTagsToResourceRequest).build());
}
/**
*
* Applies a pending maintenance action to a resource (for example, to an Amazon DocumentDB instance).
*
*
* @param applyPendingMaintenanceActionRequest
* Represents the input to ApplyPendingMaintenanceAction.
* @return Result of the ApplyPendingMaintenanceAction operation returned by the service.
* @throws ResourceNotFoundException
* The specified resource ID was not found.
* @throws InvalidDbClusterStateException
* The cluster isn't in a valid state.
* @throws InvalidDbInstanceStateException
* The specified instance isn't in the available state.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws DocDbException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample DocDbClient.ApplyPendingMaintenanceAction
* @see AWS API Documentation
*/
default ApplyPendingMaintenanceActionResponse applyPendingMaintenanceAction(
ApplyPendingMaintenanceActionRequest applyPendingMaintenanceActionRequest) throws ResourceNotFoundException,
InvalidDbClusterStateException, InvalidDbInstanceStateException, AwsServiceException, SdkClientException,
DocDbException {
throw new UnsupportedOperationException();
}
/**
*
* 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 {@link ApplyPendingMaintenanceActionRequest.Builder}
* avoiding the need to create one manually via {@link ApplyPendingMaintenanceActionRequest#builder()}
*
*
* @param applyPendingMaintenanceActionRequest
* A {@link Consumer} that will call methods on {@link ApplyPendingMaintenanceActionMessage.Builder} to
* create a request. Represents the input to ApplyPendingMaintenanceAction.
* @return Result of the ApplyPendingMaintenanceAction operation returned by the service.
* @throws ResourceNotFoundException
* The specified resource ID was not found.
* @throws InvalidDbClusterStateException
* The cluster isn't in a valid state.
* @throws InvalidDbInstanceStateException
* The specified instance isn't in the available state.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws DocDbException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample DocDbClient.ApplyPendingMaintenanceAction
* @see AWS API Documentation
*/
default ApplyPendingMaintenanceActionResponse applyPendingMaintenanceAction(
Consumer applyPendingMaintenanceActionRequest)
throws ResourceNotFoundException, InvalidDbClusterStateException, InvalidDbInstanceStateException,
AwsServiceException, SdkClientException, DocDbException {
return applyPendingMaintenanceAction(ApplyPendingMaintenanceActionRequest.builder()
.applyMutation(applyPendingMaintenanceActionRequest).build());
}
/**
*
* Copies the specified cluster parameter group.
*
*
* @param copyDbClusterParameterGroupRequest
* Represents the input to CopyDBClusterParameterGroup.
* @return Result of the CopyDBClusterParameterGroup operation returned by the service.
* @throws DbParameterGroupNotFoundException
* DBParameterGroupName doesn't refer to an existing parameter group.
* @throws DbParameterGroupQuotaExceededException
* This request would cause you to exceed the allowed number of parameter groups.
* @throws DbParameterGroupAlreadyExistsException
* A parameter group with the same name already exists.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws DocDbException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample DocDbClient.CopyDBClusterParameterGroup
* @see AWS API Documentation
*/
default CopyDbClusterParameterGroupResponse copyDBClusterParameterGroup(
CopyDbClusterParameterGroupRequest copyDbClusterParameterGroupRequest) throws DbParameterGroupNotFoundException,
DbParameterGroupQuotaExceededException, DbParameterGroupAlreadyExistsException, AwsServiceException,
SdkClientException, DocDbException {
throw new UnsupportedOperationException();
}
/**
*
* Copies the specified cluster parameter group.
*
*
*
* This is a convenience which creates an instance of the {@link CopyDbClusterParameterGroupRequest.Builder}
* avoiding the need to create one manually via {@link CopyDbClusterParameterGroupRequest#builder()}
*
*
* @param copyDbClusterParameterGroupRequest
* A {@link Consumer} that will call methods on {@link CopyDBClusterParameterGroupMessage.Builder} to create
* a request. Represents the input to CopyDBClusterParameterGroup.
* @return Result of the CopyDBClusterParameterGroup operation returned by the service.
* @throws DbParameterGroupNotFoundException
* DBParameterGroupName doesn't refer to an existing parameter group.
* @throws DbParameterGroupQuotaExceededException
* This request would cause you to exceed the allowed number of parameter groups.
* @throws DbParameterGroupAlreadyExistsException
* A parameter group with the same name already exists.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws DocDbException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample DocDbClient.CopyDBClusterParameterGroup
* @see AWS API Documentation
*/
default CopyDbClusterParameterGroupResponse copyDBClusterParameterGroup(
Consumer copyDbClusterParameterGroupRequest)
throws DbParameterGroupNotFoundException, DbParameterGroupQuotaExceededException,
DbParameterGroupAlreadyExistsException, AwsServiceException, SdkClientException, DocDbException {
return copyDBClusterParameterGroup(CopyDbClusterParameterGroupRequest.builder()
.applyMutation(copyDbClusterParameterGroupRequest).build());
}
/**
*
* 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.
*
*
* @param copyDbClusterSnapshotRequest
* Represents the input to CopyDBClusterSnapshot.
* @return Result of the CopyDBClusterSnapshot operation returned by the service.
* @throws DbClusterSnapshotAlreadyExistsException
* You already have a cluster snapshot with the given identifier.
* @throws DbClusterSnapshotNotFoundException
* DBClusterSnapshotIdentifier doesn't refer to an existing cluster snapshot.
* @throws InvalidDbClusterStateException
* The cluster isn't in a valid state.
* @throws InvalidDbClusterSnapshotStateException
* The provided value isn't a valid cluster snapshot state.
* @throws SnapshotQuotaExceededException
* The request would cause you to exceed the allowed number of snapshots.
* @throws KmsKeyNotAccessibleException
* An error occurred when accessing an KMS key.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws DocDbException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample DocDbClient.CopyDBClusterSnapshot
* @see AWS
* API Documentation
*/
default CopyDbClusterSnapshotResponse copyDBClusterSnapshot(CopyDbClusterSnapshotRequest copyDbClusterSnapshotRequest)
throws DbClusterSnapshotAlreadyExistsException, DbClusterSnapshotNotFoundException, InvalidDbClusterStateException,
InvalidDbClusterSnapshotStateException, SnapshotQuotaExceededException, KmsKeyNotAccessibleException,
AwsServiceException, SdkClientException, DocDbException {
throw new UnsupportedOperationException();
}
/**
*
* 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 {@link CopyDbClusterSnapshotRequest.Builder} avoiding the
* need to create one manually via {@link CopyDbClusterSnapshotRequest#builder()}
*
*
* @param copyDbClusterSnapshotRequest
* A {@link Consumer} that will call methods on {@link CopyDBClusterSnapshotMessage.Builder} to create a
* request. Represents the input to CopyDBClusterSnapshot.
* @return Result of the CopyDBClusterSnapshot operation returned by the service.
* @throws DbClusterSnapshotAlreadyExistsException
* You already have a cluster snapshot with the given identifier.
* @throws DbClusterSnapshotNotFoundException
* DBClusterSnapshotIdentifier doesn't refer to an existing cluster snapshot.
* @throws InvalidDbClusterStateException
* The cluster isn't in a valid state.
* @throws InvalidDbClusterSnapshotStateException
* The provided value isn't a valid cluster snapshot state.
* @throws SnapshotQuotaExceededException
* The request would cause you to exceed the allowed number of snapshots.
* @throws KmsKeyNotAccessibleException
* An error occurred when accessing an KMS key.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws DocDbException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample DocDbClient.CopyDBClusterSnapshot
* @see AWS
* API Documentation
*/
default CopyDbClusterSnapshotResponse copyDBClusterSnapshot(
Consumer copyDbClusterSnapshotRequest)
throws DbClusterSnapshotAlreadyExistsException, DbClusterSnapshotNotFoundException, InvalidDbClusterStateException,
InvalidDbClusterSnapshotStateException, SnapshotQuotaExceededException, KmsKeyNotAccessibleException,
AwsServiceException, SdkClientException, DocDbException {
return copyDBClusterSnapshot(CopyDbClusterSnapshotRequest.builder().applyMutation(copyDbClusterSnapshotRequest).build());
}
/**
*
* Creates a new Amazon DocumentDB cluster.
*
*
* @param createDbClusterRequest
* Represents the input to CreateDBCluster.
* @return Result of the CreateDBCluster operation returned by the service.
* @throws DbClusterAlreadyExistsException
* You already have a cluster with the given identifier.
* @throws 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.
* @throws DbClusterQuotaExceededException
* The cluster can't be created because you have reached the maximum allowed quota of clusters.
* @throws StorageQuotaExceededException
* The request would cause you to exceed the allowed amount of storage available across all instances.
* @throws DbSubnetGroupNotFoundException
* DBSubnetGroupName doesn't refer to an existing subnet group.
* @throws InvalidVpcNetworkStateException
* The subnet group doesn't cover all Availability Zones after it is created because of changes that were
* made.
* @throws InvalidDbClusterStateException
* The cluster isn't in a valid state.
* @throws InvalidDbSubnetGroupStateException
* The subnet group can't be deleted because it's in use.
* @throws InvalidSubnetException
* The requested subnet is not valid, or multiple subnets were requested that are not all in a common
* virtual private cloud (VPC).
* @throws InvalidDbInstanceStateException
* The specified instance isn't in the available state.
* @throws DbClusterParameterGroupNotFoundException
* DBClusterParameterGroupName doesn't refer to an existing cluster parameter group.
* @throws KmsKeyNotAccessibleException
* An error occurred when accessing an KMS key.
* @throws DbClusterNotFoundException
* DBClusterIdentifier doesn't refer to an existing cluster.
* @throws DbInstanceNotFoundException
* DBInstanceIdentifier doesn't refer to an existing instance.
* @throws DbSubnetGroupDoesNotCoverEnoughAZsException
* Subnets in the subnet group should cover at least two Availability Zones unless there is only one
* Availability Zone.
* @throws GlobalClusterNotFoundException
* The GlobalClusterIdentifier doesn't refer to an existing global cluster.
* @throws InvalidGlobalClusterStateException
* The requested operation can't be performed while the cluster is in this state.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws DocDbException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample DocDbClient.CreateDBCluster
* @see AWS API
* Documentation
*/
default 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 {
throw new UnsupportedOperationException();
}
/**
*
* Creates a new Amazon DocumentDB cluster.
*
*
*
* This is a convenience which creates an instance of the {@link CreateDbClusterRequest.Builder} avoiding the need
* to create one manually via {@link CreateDbClusterRequest#builder()}
*
*
* @param createDbClusterRequest
* A {@link Consumer} that will call methods on {@link CreateDBClusterMessage.Builder} to create a request.
* Represents the input to CreateDBCluster.
* @return Result of the CreateDBCluster operation returned by the service.
* @throws DbClusterAlreadyExistsException
* You already have a cluster with the given identifier.
* @throws 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.
* @throws DbClusterQuotaExceededException
* The cluster can't be created because you have reached the maximum allowed quota of clusters.
* @throws StorageQuotaExceededException
* The request would cause you to exceed the allowed amount of storage available across all instances.
* @throws DbSubnetGroupNotFoundException
* DBSubnetGroupName doesn't refer to an existing subnet group.
* @throws InvalidVpcNetworkStateException
* The subnet group doesn't cover all Availability Zones after it is created because of changes that were
* made.
* @throws InvalidDbClusterStateException
* The cluster isn't in a valid state.
* @throws InvalidDbSubnetGroupStateException
* The subnet group can't be deleted because it's in use.
* @throws InvalidSubnetException
* The requested subnet is not valid, or multiple subnets were requested that are not all in a common
* virtual private cloud (VPC).
* @throws InvalidDbInstanceStateException
* The specified instance isn't in the available state.
* @throws DbClusterParameterGroupNotFoundException
* DBClusterParameterGroupName doesn't refer to an existing cluster parameter group.
* @throws KmsKeyNotAccessibleException
* An error occurred when accessing an KMS key.
* @throws DbClusterNotFoundException
* DBClusterIdentifier doesn't refer to an existing cluster.
* @throws DbInstanceNotFoundException
* DBInstanceIdentifier doesn't refer to an existing instance.
* @throws DbSubnetGroupDoesNotCoverEnoughAZsException
* Subnets in the subnet group should cover at least two Availability Zones unless there is only one
* Availability Zone.
* @throws GlobalClusterNotFoundException
* The GlobalClusterIdentifier doesn't refer to an existing global cluster.
* @throws InvalidGlobalClusterStateException
* The requested operation can't be performed while the cluster is in this state.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws DocDbException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample DocDbClient.CreateDBCluster
* @see AWS API
* Documentation
*/
default CreateDbClusterResponse createDBCluster(Consumer createDbClusterRequest)
throws DbClusterAlreadyExistsException, InsufficientStorageClusterCapacityException, DbClusterQuotaExceededException,
StorageQuotaExceededException, DbSubnetGroupNotFoundException, InvalidVpcNetworkStateException,
InvalidDbClusterStateException, InvalidDbSubnetGroupStateException, InvalidSubnetException,
InvalidDbInstanceStateException, DbClusterParameterGroupNotFoundException, KmsKeyNotAccessibleException,
DbClusterNotFoundException, DbInstanceNotFoundException, DbSubnetGroupDoesNotCoverEnoughAZsException,
GlobalClusterNotFoundException, InvalidGlobalClusterStateException, AwsServiceException, SdkClientException,
DocDbException {
return createDBCluster(CreateDbClusterRequest.builder().applyMutation(createDbClusterRequest).build());
}
/**
*
* 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.
*
*
* @param createDbClusterParameterGroupRequest
* Represents the input of CreateDBClusterParameterGroup.
* @return Result of the CreateDBClusterParameterGroup operation returned by the service.
* @throws DbParameterGroupQuotaExceededException
* This request would cause you to exceed the allowed number of parameter groups.
* @throws DbParameterGroupAlreadyExistsException
* A parameter group with the same name already exists.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws DocDbException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample DocDbClient.CreateDBClusterParameterGroup
* @see AWS API Documentation
*/
default CreateDbClusterParameterGroupResponse createDBClusterParameterGroup(
CreateDbClusterParameterGroupRequest createDbClusterParameterGroupRequest)
throws DbParameterGroupQuotaExceededException, DbParameterGroupAlreadyExistsException, AwsServiceException,
SdkClientException, DocDbException {
throw new UnsupportedOperationException();
}
/**
*
* 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 {@link CreateDbClusterParameterGroupRequest.Builder}
* avoiding the need to create one manually via {@link CreateDbClusterParameterGroupRequest#builder()}
*
*
* @param createDbClusterParameterGroupRequest
* A {@link Consumer} that will call methods on {@link CreateDBClusterParameterGroupMessage.Builder} to
* create a request. Represents the input of CreateDBClusterParameterGroup.
* @return Result of the CreateDBClusterParameterGroup operation returned by the service.
* @throws DbParameterGroupQuotaExceededException
* This request would cause you to exceed the allowed number of parameter groups.
* @throws DbParameterGroupAlreadyExistsException
* A parameter group with the same name already exists.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws DocDbException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample DocDbClient.CreateDBClusterParameterGroup
* @see AWS API Documentation
*/
default CreateDbClusterParameterGroupResponse createDBClusterParameterGroup(
Consumer createDbClusterParameterGroupRequest)
throws DbParameterGroupQuotaExceededException, DbParameterGroupAlreadyExistsException, AwsServiceException,
SdkClientException, DocDbException {
return createDBClusterParameterGroup(CreateDbClusterParameterGroupRequest.builder()
.applyMutation(createDbClusterParameterGroupRequest).build());
}
/**
*
* Creates a snapshot of a cluster.
*
*
* @param createDbClusterSnapshotRequest
* Represents the input of CreateDBClusterSnapshot.
* @return Result of the CreateDBClusterSnapshot operation returned by the service.
* @throws DbClusterSnapshotAlreadyExistsException
* You already have a cluster snapshot with the given identifier.
* @throws InvalidDbClusterStateException
* The cluster isn't in a valid state.
* @throws DbClusterNotFoundException
* DBClusterIdentifier doesn't refer to an existing cluster.
* @throws SnapshotQuotaExceededException
* The request would cause you to exceed the allowed number of snapshots.
* @throws InvalidDbClusterSnapshotStateException
* The provided value isn't a valid cluster snapshot state.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws DocDbException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample DocDbClient.CreateDBClusterSnapshot
* @see AWS
* API Documentation
*/
default CreateDbClusterSnapshotResponse createDBClusterSnapshot(CreateDbClusterSnapshotRequest createDbClusterSnapshotRequest)
throws DbClusterSnapshotAlreadyExistsException, InvalidDbClusterStateException, DbClusterNotFoundException,
SnapshotQuotaExceededException, InvalidDbClusterSnapshotStateException, AwsServiceException, SdkClientException,
DocDbException {
throw new UnsupportedOperationException();
}
/**
*
* Creates a snapshot of a cluster.
*
*
*
* This is a convenience which creates an instance of the {@link CreateDbClusterSnapshotRequest.Builder} avoiding
* the need to create one manually via {@link CreateDbClusterSnapshotRequest#builder()}
*
*
* @param createDbClusterSnapshotRequest
* A {@link Consumer} that will call methods on {@link CreateDBClusterSnapshotMessage.Builder} to create a
* request. Represents the input of CreateDBClusterSnapshot.
* @return Result of the CreateDBClusterSnapshot operation returned by the service.
* @throws DbClusterSnapshotAlreadyExistsException
* You already have a cluster snapshot with the given identifier.
* @throws InvalidDbClusterStateException
* The cluster isn't in a valid state.
* @throws DbClusterNotFoundException
* DBClusterIdentifier doesn't refer to an existing cluster.
* @throws SnapshotQuotaExceededException
* The request would cause you to exceed the allowed number of snapshots.
* @throws InvalidDbClusterSnapshotStateException
* The provided value isn't a valid cluster snapshot state.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws DocDbException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample DocDbClient.CreateDBClusterSnapshot
* @see AWS
* API Documentation
*/
default CreateDbClusterSnapshotResponse createDBClusterSnapshot(
Consumer createDbClusterSnapshotRequest)
throws DbClusterSnapshotAlreadyExistsException, InvalidDbClusterStateException, DbClusterNotFoundException,
SnapshotQuotaExceededException, InvalidDbClusterSnapshotStateException, AwsServiceException, SdkClientException,
DocDbException {
return createDBClusterSnapshot(CreateDbClusterSnapshotRequest.builder().applyMutation(createDbClusterSnapshotRequest)
.build());
}
/**
*
* Creates a new instance.
*
*
* @param createDbInstanceRequest
* Represents the input to CreateDBInstance.
* @return Result of the CreateDBInstance operation returned by the service.
* @throws DbInstanceAlreadyExistsException
* You already have a instance with the given identifier.
* @throws InsufficientDbInstanceCapacityException
* The specified instance class isn't available in the specified Availability Zone.
* @throws DbParameterGroupNotFoundException
* DBParameterGroupName doesn't refer to an existing parameter group.
* @throws DbSecurityGroupNotFoundException
* DBSecurityGroupName doesn't refer to an existing security group.
* @throws InstanceQuotaExceededException
* The request would cause you to exceed the allowed number of instances.
* @throws StorageQuotaExceededException
* The request would cause you to exceed the allowed amount of storage available across all instances.
* @throws DbSubnetGroupNotFoundException
* DBSubnetGroupName doesn't refer to an existing subnet group.
* @throws DbSubnetGroupDoesNotCoverEnoughAZsException
* Subnets in the subnet group should cover at least two Availability Zones unless there is only one
* Availability Zone.
* @throws InvalidDbClusterStateException
* The cluster isn't in a valid state.
* @throws InvalidSubnetException
* The requested subnet is not valid, or multiple subnets were requested that are not all in a common
* virtual private cloud (VPC).
* @throws InvalidVpcNetworkStateException
* The subnet group doesn't cover all Availability Zones after it is created because of changes that were
* made.
* @throws DbClusterNotFoundException
* DBClusterIdentifier doesn't refer to an existing cluster.
* @throws StorageTypeNotSupportedException
* Storage of the specified StorageType can't be associated with the DB instance.
* @throws 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.
* @throws KmsKeyNotAccessibleException
* An error occurred when accessing an KMS key.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws DocDbException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample DocDbClient.CreateDBInstance
* @see AWS API
* Documentation
*/
default CreateDbInstanceResponse createDBInstance(CreateDbInstanceRequest createDbInstanceRequest)
throws DbInstanceAlreadyExistsException, InsufficientDbInstanceCapacityException, DbParameterGroupNotFoundException,
DbSecurityGroupNotFoundException, InstanceQuotaExceededException, StorageQuotaExceededException,
DbSubnetGroupNotFoundException, DbSubnetGroupDoesNotCoverEnoughAZsException, InvalidDbClusterStateException,
InvalidSubnetException, InvalidVpcNetworkStateException, DbClusterNotFoundException,
StorageTypeNotSupportedException, AuthorizationNotFoundException, KmsKeyNotAccessibleException, AwsServiceException,
SdkClientException, DocDbException {
throw new UnsupportedOperationException();
}
/**
*
* Creates a new instance.
*
*
*
* This is a convenience which creates an instance of the {@link CreateDbInstanceRequest.Builder} avoiding the need
* to create one manually via {@link CreateDbInstanceRequest#builder()}
*
*
* @param createDbInstanceRequest
* A {@link Consumer} that will call methods on {@link CreateDBInstanceMessage.Builder} to create a request.
* Represents the input to CreateDBInstance.
* @return Result of the CreateDBInstance operation returned by the service.
* @throws DbInstanceAlreadyExistsException
* You already have a instance with the given identifier.
* @throws InsufficientDbInstanceCapacityException
* The specified instance class isn't available in the specified Availability Zone.
* @throws DbParameterGroupNotFoundException
* DBParameterGroupName doesn't refer to an existing parameter group.
* @throws DbSecurityGroupNotFoundException
* DBSecurityGroupName doesn't refer to an existing security group.
* @throws InstanceQuotaExceededException
* The request would cause you to exceed the allowed number of instances.
* @throws StorageQuotaExceededException
* The request would cause you to exceed the allowed amount of storage available across all instances.
* @throws DbSubnetGroupNotFoundException
* DBSubnetGroupName doesn't refer to an existing subnet group.
* @throws DbSubnetGroupDoesNotCoverEnoughAZsException
* Subnets in the subnet group should cover at least two Availability Zones unless there is only one
* Availability Zone.
* @throws InvalidDbClusterStateException
* The cluster isn't in a valid state.
* @throws InvalidSubnetException
* The requested subnet is not valid, or multiple subnets were requested that are not all in a common
* virtual private cloud (VPC).
* @throws InvalidVpcNetworkStateException
* The subnet group doesn't cover all Availability Zones after it is created because of changes that were
* made.
* @throws DbClusterNotFoundException
* DBClusterIdentifier doesn't refer to an existing cluster.
* @throws StorageTypeNotSupportedException
* Storage of the specified StorageType can't be associated with the DB instance.
* @throws 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.
* @throws KmsKeyNotAccessibleException
* An error occurred when accessing an KMS key.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws DocDbException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample DocDbClient.CreateDBInstance
* @see AWS API
* Documentation
*/
default CreateDbInstanceResponse createDBInstance(Consumer createDbInstanceRequest)
throws DbInstanceAlreadyExistsException, InsufficientDbInstanceCapacityException, DbParameterGroupNotFoundException,
DbSecurityGroupNotFoundException, InstanceQuotaExceededException, StorageQuotaExceededException,
DbSubnetGroupNotFoundException, DbSubnetGroupDoesNotCoverEnoughAZsException, InvalidDbClusterStateException,
InvalidSubnetException, InvalidVpcNetworkStateException, DbClusterNotFoundException,
StorageTypeNotSupportedException, AuthorizationNotFoundException, KmsKeyNotAccessibleException, AwsServiceException,
SdkClientException, DocDbException {
return createDBInstance(CreateDbInstanceRequest.builder().applyMutation(createDbInstanceRequest).build());
}
/**
*
* 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.
*
*
* @param createDbSubnetGroupRequest
* Represents the input to CreateDBSubnetGroup.
* @return Result of the CreateDBSubnetGroup operation returned by the service.
* @throws DbSubnetGroupAlreadyExistsException
* DBSubnetGroupName is already being used by an existing subnet group.
* @throws DbSubnetGroupQuotaExceededException
* The request would cause you to exceed the allowed number of subnet groups.
* @throws DbSubnetQuotaExceededException
* The request would cause you to exceed the allowed number of subnets in a subnet group.
* @throws DbSubnetGroupDoesNotCoverEnoughAZsException
* Subnets in the subnet group should cover at least two Availability Zones unless there is only one
* Availability Zone.
* @throws InvalidSubnetException
* The requested subnet is not valid, or multiple subnets were requested that are not all in a common
* virtual private cloud (VPC).
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws DocDbException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample DocDbClient.CreateDBSubnetGroup
* @see AWS API
* Documentation
*/
default CreateDbSubnetGroupResponse createDBSubnetGroup(CreateDbSubnetGroupRequest createDbSubnetGroupRequest)
throws DbSubnetGroupAlreadyExistsException, DbSubnetGroupQuotaExceededException, DbSubnetQuotaExceededException,
DbSubnetGroupDoesNotCoverEnoughAZsException, InvalidSubnetException, AwsServiceException, SdkClientException,
DocDbException {
throw new UnsupportedOperationException();
}
/**
*
* 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 {@link CreateDbSubnetGroupRequest.Builder} avoiding the
* need to create one manually via {@link CreateDbSubnetGroupRequest#builder()}
*
*
* @param createDbSubnetGroupRequest
* A {@link Consumer} that will call methods on {@link CreateDBSubnetGroupMessage.Builder} to create a
* request. Represents the input to CreateDBSubnetGroup.
* @return Result of the CreateDBSubnetGroup operation returned by the service.
* @throws DbSubnetGroupAlreadyExistsException
* DBSubnetGroupName is already being used by an existing subnet group.
* @throws DbSubnetGroupQuotaExceededException
* The request would cause you to exceed the allowed number of subnet groups.
* @throws DbSubnetQuotaExceededException
* The request would cause you to exceed the allowed number of subnets in a subnet group.
* @throws DbSubnetGroupDoesNotCoverEnoughAZsException
* Subnets in the subnet group should cover at least two Availability Zones unless there is only one
* Availability Zone.
* @throws InvalidSubnetException
* The requested subnet is not valid, or multiple subnets were requested that are not all in a common
* virtual private cloud (VPC).
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws DocDbException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample DocDbClient.CreateDBSubnetGroup
* @see AWS API
* Documentation
*/
default CreateDbSubnetGroupResponse createDBSubnetGroup(
Consumer createDbSubnetGroupRequest) throws DbSubnetGroupAlreadyExistsException,
DbSubnetGroupQuotaExceededException, DbSubnetQuotaExceededException, DbSubnetGroupDoesNotCoverEnoughAZsException,
InvalidSubnetException, AwsServiceException, SdkClientException, DocDbException {
return createDBSubnetGroup(CreateDbSubnetGroupRequest.builder().applyMutation(createDbSubnetGroupRequest).build());
}
/**
*
* 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.
*
*
* @param createEventSubscriptionRequest
* Represents the input to CreateEventSubscription.
* @return Result of the CreateEventSubscription operation returned by the service.
* @throws EventSubscriptionQuotaExceededException
* You have reached the maximum number of event subscriptions.
* @throws SubscriptionAlreadyExistException
* The provided subscription name already exists.
* @throws SnsInvalidTopicException
* Amazon SNS has responded that there is a problem with the specified topic.
* @throws SnsNoAuthorizationException
* You do not have permission to publish to the SNS topic Amazon Resource Name (ARN).
* @throws SnsTopicArnNotFoundException
* The SNS topic Amazon Resource Name (ARN) does not exist.
* @throws SubscriptionCategoryNotFoundException
* The provided category does not exist.
* @throws SourceNotFoundException
* The requested source could not be found.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws DocDbException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample DocDbClient.CreateEventSubscription
* @see AWS
* API Documentation
*/
default CreateEventSubscriptionResponse createEventSubscription(CreateEventSubscriptionRequest createEventSubscriptionRequest)
throws EventSubscriptionQuotaExceededException, SubscriptionAlreadyExistException, SnsInvalidTopicException,
SnsNoAuthorizationException, SnsTopicArnNotFoundException, SubscriptionCategoryNotFoundException,
SourceNotFoundException, AwsServiceException, SdkClientException, DocDbException {
throw new UnsupportedOperationException();
}
/**
*
* 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 {@link CreateEventSubscriptionRequest.Builder} avoiding
* the need to create one manually via {@link CreateEventSubscriptionRequest#builder()}
*
*
* @param createEventSubscriptionRequest
* A {@link Consumer} that will call methods on {@link CreateEventSubscriptionMessage.Builder} to create a
* request. Represents the input to CreateEventSubscription.
* @return Result of the CreateEventSubscription operation returned by the service.
* @throws EventSubscriptionQuotaExceededException
* You have reached the maximum number of event subscriptions.
* @throws SubscriptionAlreadyExistException
* The provided subscription name already exists.
* @throws SnsInvalidTopicException
* Amazon SNS has responded that there is a problem with the specified topic.
* @throws SnsNoAuthorizationException
* You do not have permission to publish to the SNS topic Amazon Resource Name (ARN).
* @throws SnsTopicArnNotFoundException
* The SNS topic Amazon Resource Name (ARN) does not exist.
* @throws SubscriptionCategoryNotFoundException
* The provided category does not exist.
* @throws SourceNotFoundException
* The requested source could not be found.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws DocDbException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample DocDbClient.CreateEventSubscription
* @see AWS
* API Documentation
*/
default CreateEventSubscriptionResponse createEventSubscription(
Consumer createEventSubscriptionRequest)
throws EventSubscriptionQuotaExceededException, SubscriptionAlreadyExistException, SnsInvalidTopicException,
SnsNoAuthorizationException, SnsTopicArnNotFoundException, SubscriptionCategoryNotFoundException,
SourceNotFoundException, AwsServiceException, SdkClientException, DocDbException {
return createEventSubscription(CreateEventSubscriptionRequest.builder().applyMutation(createEventSubscriptionRequest)
.build());
}
/**
*
* 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.
*
*
*
* @param createGlobalClusterRequest
* Represents the input to CreateGlobalCluster.
* @return Result of the CreateGlobalCluster operation returned by the service.
* @throws GlobalClusterAlreadyExistsException
* The GlobalClusterIdentifier already exists. Choose a new global cluster identifier (unique
* name) to create a new global cluster.
* @throws GlobalClusterQuotaExceededException
* The number of global clusters for this account is already at the maximum allowed.
* @throws InvalidDbClusterStateException
* The cluster isn't in a valid state.
* @throws DbClusterNotFoundException
* DBClusterIdentifier doesn't refer to an existing cluster.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws DocDbException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample DocDbClient.CreateGlobalCluster
* @see AWS API
* Documentation
*/
default CreateGlobalClusterResponse createGlobalCluster(CreateGlobalClusterRequest createGlobalClusterRequest)
throws GlobalClusterAlreadyExistsException, GlobalClusterQuotaExceededException, InvalidDbClusterStateException,
DbClusterNotFoundException, AwsServiceException, SdkClientException, DocDbException {
throw new UnsupportedOperationException();
}
/**
*
* 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 {@link CreateGlobalClusterRequest.Builder} avoiding the
* need to create one manually via {@link CreateGlobalClusterRequest#builder()}
*
*
* @param createGlobalClusterRequest
* A {@link Consumer} that will call methods on {@link CreateGlobalClusterMessage.Builder} to create a
* request. Represents the input to CreateGlobalCluster.
* @return Result of the CreateGlobalCluster operation returned by the service.
* @throws GlobalClusterAlreadyExistsException
* The GlobalClusterIdentifier already exists. Choose a new global cluster identifier (unique
* name) to create a new global cluster.
* @throws GlobalClusterQuotaExceededException
* The number of global clusters for this account is already at the maximum allowed.
* @throws InvalidDbClusterStateException
* The cluster isn't in a valid state.
* @throws DbClusterNotFoundException
* DBClusterIdentifier doesn't refer to an existing cluster.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws DocDbException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample DocDbClient.CreateGlobalCluster
* @see AWS API
* Documentation
*/
default CreateGlobalClusterResponse createGlobalCluster(
Consumer createGlobalClusterRequest) throws GlobalClusterAlreadyExistsException,
GlobalClusterQuotaExceededException, InvalidDbClusterStateException, DbClusterNotFoundException, AwsServiceException,
SdkClientException, DocDbException {
return createGlobalCluster(CreateGlobalClusterRequest.builder().applyMutation(createGlobalClusterRequest).build());
}
/**
*
* 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.
*
*
*
* @param deleteDbClusterRequest
* Represents the input to DeleteDBCluster.
* @return Result of the DeleteDBCluster operation returned by the service.
* @throws DbClusterNotFoundException
* DBClusterIdentifier doesn't refer to an existing cluster.
* @throws InvalidDbClusterStateException
* The cluster isn't in a valid state.
* @throws DbClusterSnapshotAlreadyExistsException
* You already have a cluster snapshot with the given identifier.
* @throws SnapshotQuotaExceededException
* The request would cause you to exceed the allowed number of snapshots.
* @throws InvalidDbClusterSnapshotStateException
* The provided value isn't a valid cluster snapshot state.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws DocDbException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample DocDbClient.DeleteDBCluster
* @see AWS API
* Documentation
*/
default DeleteDbClusterResponse deleteDBCluster(DeleteDbClusterRequest deleteDbClusterRequest)
throws DbClusterNotFoundException, InvalidDbClusterStateException, DbClusterSnapshotAlreadyExistsException,
SnapshotQuotaExceededException, InvalidDbClusterSnapshotStateException, AwsServiceException, SdkClientException,
DocDbException {
throw new UnsupportedOperationException();
}
/**
*
* 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 {@link DeleteDbClusterRequest.Builder} avoiding the need
* to create one manually via {@link DeleteDbClusterRequest#builder()}
*
*
* @param deleteDbClusterRequest
* A {@link Consumer} that will call methods on {@link DeleteDBClusterMessage.Builder} to create a request.
* Represents the input to DeleteDBCluster.
* @return Result of the DeleteDBCluster operation returned by the service.
* @throws DbClusterNotFoundException
* DBClusterIdentifier doesn't refer to an existing cluster.
* @throws InvalidDbClusterStateException
* The cluster isn't in a valid state.
* @throws DbClusterSnapshotAlreadyExistsException
* You already have a cluster snapshot with the given identifier.
* @throws SnapshotQuotaExceededException
* The request would cause you to exceed the allowed number of snapshots.
* @throws InvalidDbClusterSnapshotStateException
* The provided value isn't a valid cluster snapshot state.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws DocDbException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample DocDbClient.DeleteDBCluster
* @see AWS API
* Documentation
*/
default DeleteDbClusterResponse deleteDBCluster(Consumer deleteDbClusterRequest)
throws DbClusterNotFoundException, InvalidDbClusterStateException, DbClusterSnapshotAlreadyExistsException,
SnapshotQuotaExceededException, InvalidDbClusterSnapshotStateException, AwsServiceException, SdkClientException,
DocDbException {
return deleteDBCluster(DeleteDbClusterRequest.builder().applyMutation(deleteDbClusterRequest).build());
}
/**
*
* Deletes a specified cluster parameter group. The cluster parameter group to be deleted can't be associated with
* any clusters.
*
*
* @param deleteDbClusterParameterGroupRequest
* Represents the input to DeleteDBClusterParameterGroup.
* @return Result of the DeleteDBClusterParameterGroup operation returned by the service.
* @throws 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.
* @throws DbParameterGroupNotFoundException
* DBParameterGroupName doesn't refer to an existing parameter group.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws DocDbException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample DocDbClient.DeleteDBClusterParameterGroup
* @see AWS API Documentation
*/
default DeleteDbClusterParameterGroupResponse deleteDBClusterParameterGroup(
DeleteDbClusterParameterGroupRequest deleteDbClusterParameterGroupRequest)
throws InvalidDbParameterGroupStateException, DbParameterGroupNotFoundException, AwsServiceException,
SdkClientException, DocDbException {
throw new UnsupportedOperationException();
}
/**
*
* 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 {@link DeleteDbClusterParameterGroupRequest.Builder}
* avoiding the need to create one manually via {@link DeleteDbClusterParameterGroupRequest#builder()}
*
*
* @param deleteDbClusterParameterGroupRequest
* A {@link Consumer} that will call methods on {@link DeleteDBClusterParameterGroupMessage.Builder} to
* create a request. Represents the input to DeleteDBClusterParameterGroup.
* @return Result of the DeleteDBClusterParameterGroup operation returned by the service.
* @throws 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.
* @throws DbParameterGroupNotFoundException
* DBParameterGroupName doesn't refer to an existing parameter group.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws DocDbException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample DocDbClient.DeleteDBClusterParameterGroup
* @see AWS API Documentation
*/
default DeleteDbClusterParameterGroupResponse deleteDBClusterParameterGroup(
Consumer deleteDbClusterParameterGroupRequest)
throws InvalidDbParameterGroupStateException, DbParameterGroupNotFoundException, AwsServiceException,
SdkClientException, DocDbException {
return deleteDBClusterParameterGroup(DeleteDbClusterParameterGroupRequest.builder()
.applyMutation(deleteDbClusterParameterGroupRequest).build());
}
/**
*
* 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.
*
*
*
* @param deleteDbClusterSnapshotRequest
* Represents the input to DeleteDBClusterSnapshot.
* @return Result of the DeleteDBClusterSnapshot operation returned by the service.
* @throws InvalidDbClusterSnapshotStateException
* The provided value isn't a valid cluster snapshot state.
* @throws DbClusterSnapshotNotFoundException
* DBClusterSnapshotIdentifier doesn't refer to an existing cluster snapshot.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws DocDbException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample DocDbClient.DeleteDBClusterSnapshot
* @see AWS
* API Documentation
*/
default DeleteDbClusterSnapshotResponse deleteDBClusterSnapshot(DeleteDbClusterSnapshotRequest deleteDbClusterSnapshotRequest)
throws InvalidDbClusterSnapshotStateException, DbClusterSnapshotNotFoundException, AwsServiceException,
SdkClientException, DocDbException {
throw new UnsupportedOperationException();
}
/**
*
* 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 {@link DeleteDbClusterSnapshotRequest.Builder} avoiding
* the need to create one manually via {@link DeleteDbClusterSnapshotRequest#builder()}
*
*
* @param deleteDbClusterSnapshotRequest
* A {@link Consumer} that will call methods on {@link DeleteDBClusterSnapshotMessage.Builder} to create a
* request. Represents the input to DeleteDBClusterSnapshot.
* @return Result of the DeleteDBClusterSnapshot operation returned by the service.
* @throws InvalidDbClusterSnapshotStateException
* The provided value isn't a valid cluster snapshot state.
* @throws DbClusterSnapshotNotFoundException
* DBClusterSnapshotIdentifier doesn't refer to an existing cluster snapshot.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws DocDbException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample DocDbClient.DeleteDBClusterSnapshot
* @see AWS
* API Documentation
*/
default DeleteDbClusterSnapshotResponse deleteDBClusterSnapshot(
Consumer deleteDbClusterSnapshotRequest)
throws InvalidDbClusterSnapshotStateException, DbClusterSnapshotNotFoundException, AwsServiceException,
SdkClientException, DocDbException {
return deleteDBClusterSnapshot(DeleteDbClusterSnapshotRequest.builder().applyMutation(deleteDbClusterSnapshotRequest)
.build());
}
/**
*
* Deletes a previously provisioned instance.
*
*
* @param deleteDbInstanceRequest
* Represents the input to DeleteDBInstance.
* @return Result of the DeleteDBInstance operation returned by the service.
* @throws DbInstanceNotFoundException
* DBInstanceIdentifier doesn't refer to an existing instance.
* @throws InvalidDbInstanceStateException
* The specified instance isn't in the available state.
* @throws DbSnapshotAlreadyExistsException
* DBSnapshotIdentifier is already being used by an existing snapshot.
* @throws SnapshotQuotaExceededException
* The request would cause you to exceed the allowed number of snapshots.
* @throws InvalidDbClusterStateException
* The cluster isn't in a valid state.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws DocDbException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample DocDbClient.DeleteDBInstance
* @see AWS API
* Documentation
*/
default DeleteDbInstanceResponse deleteDBInstance(DeleteDbInstanceRequest deleteDbInstanceRequest)
throws DbInstanceNotFoundException, InvalidDbInstanceStateException, DbSnapshotAlreadyExistsException,
SnapshotQuotaExceededException, InvalidDbClusterStateException, AwsServiceException, SdkClientException,
DocDbException {
throw new UnsupportedOperationException();
}
/**
*
* Deletes a previously provisioned instance.
*
*
*
* This is a convenience which creates an instance of the {@link DeleteDbInstanceRequest.Builder} avoiding the need
* to create one manually via {@link DeleteDbInstanceRequest#builder()}
*
*
* @param deleteDbInstanceRequest
* A {@link Consumer} that will call methods on {@link DeleteDBInstanceMessage.Builder} to create a request.
* Represents the input to DeleteDBInstance.
* @return Result of the DeleteDBInstance operation returned by the service.
* @throws DbInstanceNotFoundException
* DBInstanceIdentifier doesn't refer to an existing instance.
* @throws InvalidDbInstanceStateException
* The specified instance isn't in the available state.
* @throws DbSnapshotAlreadyExistsException
* DBSnapshotIdentifier is already being used by an existing snapshot.
* @throws SnapshotQuotaExceededException
* The request would cause you to exceed the allowed number of snapshots.
* @throws InvalidDbClusterStateException
* The cluster isn't in a valid state.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws DocDbException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample DocDbClient.DeleteDBInstance
* @see AWS API
* Documentation
*/
default DeleteDbInstanceResponse deleteDBInstance(Consumer deleteDbInstanceRequest)
throws DbInstanceNotFoundException, InvalidDbInstanceStateException, DbSnapshotAlreadyExistsException,
SnapshotQuotaExceededException, InvalidDbClusterStateException, AwsServiceException, SdkClientException,
DocDbException {
return deleteDBInstance(DeleteDbInstanceRequest.builder().applyMutation(deleteDbInstanceRequest).build());
}
/**
*
* Deletes a subnet group.
*
*
*
* The specified database subnet group must not be associated with any DB instances.
*
*
*
* @param deleteDbSubnetGroupRequest
* Represents the input to DeleteDBSubnetGroup.
* @return Result of the DeleteDBSubnetGroup operation returned by the service.
* @throws InvalidDbSubnetGroupStateException
* The subnet group can't be deleted because it's in use.
* @throws InvalidDbSubnetStateException
* The subnet isn't in the available state.
* @throws DbSubnetGroupNotFoundException
* DBSubnetGroupName doesn't refer to an existing subnet group.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws DocDbException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample DocDbClient.DeleteDBSubnetGroup
* @see AWS API
* Documentation
*/
default DeleteDbSubnetGroupResponse deleteDBSubnetGroup(DeleteDbSubnetGroupRequest deleteDbSubnetGroupRequest)
throws InvalidDbSubnetGroupStateException, InvalidDbSubnetStateException, DbSubnetGroupNotFoundException,
AwsServiceException, SdkClientException, DocDbException {
throw new UnsupportedOperationException();
}
/**
*
* 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 {@link DeleteDbSubnetGroupRequest.Builder} avoiding the
* need to create one manually via {@link DeleteDbSubnetGroupRequest#builder()}
*
*
* @param deleteDbSubnetGroupRequest
* A {@link Consumer} that will call methods on {@link DeleteDBSubnetGroupMessage.Builder} to create a
* request. Represents the input to DeleteDBSubnetGroup.
* @return Result of the DeleteDBSubnetGroup operation returned by the service.
* @throws InvalidDbSubnetGroupStateException
* The subnet group can't be deleted because it's in use.
* @throws InvalidDbSubnetStateException
* The subnet isn't in the available state.
* @throws DbSubnetGroupNotFoundException
* DBSubnetGroupName doesn't refer to an existing subnet group.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws DocDbException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample DocDbClient.DeleteDBSubnetGroup
* @see AWS API
* Documentation
*/
default DeleteDbSubnetGroupResponse deleteDBSubnetGroup(
Consumer deleteDbSubnetGroupRequest) throws InvalidDbSubnetGroupStateException,
InvalidDbSubnetStateException, DbSubnetGroupNotFoundException, AwsServiceException, SdkClientException,
DocDbException {
return deleteDBSubnetGroup(DeleteDbSubnetGroupRequest.builder().applyMutation(deleteDbSubnetGroupRequest).build());
}
/**
*
* Deletes an Amazon DocumentDB event notification subscription.
*
*
* @param deleteEventSubscriptionRequest
* Represents the input to DeleteEventSubscription.
* @return Result of the DeleteEventSubscription operation returned by the service.
* @throws SubscriptionNotFoundException
* The subscription name does not exist.
* @throws InvalidEventSubscriptionStateException
* Someone else might be modifying a subscription. Wait a few seconds, and try again.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws DocDbException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample DocDbClient.DeleteEventSubscription
* @see AWS
* API Documentation
*/
default DeleteEventSubscriptionResponse deleteEventSubscription(DeleteEventSubscriptionRequest deleteEventSubscriptionRequest)
throws SubscriptionNotFoundException, InvalidEventSubscriptionStateException, AwsServiceException,
SdkClientException, DocDbException {
throw new UnsupportedOperationException();
}
/**
*
* Deletes an Amazon DocumentDB event notification subscription.
*
*
*
* This is a convenience which creates an instance of the {@link DeleteEventSubscriptionRequest.Builder} avoiding
* the need to create one manually via {@link DeleteEventSubscriptionRequest#builder()}
*
*
* @param deleteEventSubscriptionRequest
* A {@link Consumer} that will call methods on {@link DeleteEventSubscriptionMessage.Builder} to create a
* request. Represents the input to DeleteEventSubscription.
* @return Result of the DeleteEventSubscription operation returned by the service.
* @throws SubscriptionNotFoundException
* The subscription name does not exist.
* @throws InvalidEventSubscriptionStateException
* Someone else might be modifying a subscription. Wait a few seconds, and try again.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws DocDbException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample DocDbClient.DeleteEventSubscription
* @see AWS
* API Documentation
*/
default DeleteEventSubscriptionResponse deleteEventSubscription(
Consumer deleteEventSubscriptionRequest)
throws SubscriptionNotFoundException, InvalidEventSubscriptionStateException, AwsServiceException,
SdkClientException, DocDbException {
return deleteEventSubscription(DeleteEventSubscriptionRequest.builder().applyMutation(deleteEventSubscriptionRequest)
.build());
}
/**
*
* 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.
*
*
*
* @param deleteGlobalClusterRequest
* Represents the input to DeleteGlobalCluster.
* @return Result of the DeleteGlobalCluster operation returned by the service.
* @throws GlobalClusterNotFoundException
* The GlobalClusterIdentifier doesn't refer to an existing global cluster.
* @throws InvalidGlobalClusterStateException
* The requested operation can't be performed while the cluster is in this state.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws DocDbException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample DocDbClient.DeleteGlobalCluster
* @see AWS API
* Documentation
*/
default DeleteGlobalClusterResponse deleteGlobalCluster(DeleteGlobalClusterRequest deleteGlobalClusterRequest)
throws GlobalClusterNotFoundException, InvalidGlobalClusterStateException, AwsServiceException, SdkClientException,
DocDbException {
throw new UnsupportedOperationException();
}
/**
*
* 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 {@link DeleteGlobalClusterRequest.Builder} avoiding the
* need to create one manually via {@link DeleteGlobalClusterRequest#builder()}
*
*
* @param deleteGlobalClusterRequest
* A {@link Consumer} that will call methods on {@link DeleteGlobalClusterMessage.Builder} to create a
* request. Represents the input to DeleteGlobalCluster.
* @return Result of the DeleteGlobalCluster operation returned by the service.
* @throws GlobalClusterNotFoundException
* The GlobalClusterIdentifier doesn't refer to an existing global cluster.
* @throws InvalidGlobalClusterStateException
* The requested operation can't be performed while the cluster is in this state.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws DocDbException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample DocDbClient.DeleteGlobalCluster
* @see AWS API
* Documentation
*/
default DeleteGlobalClusterResponse deleteGlobalCluster(
Consumer deleteGlobalClusterRequest) throws GlobalClusterNotFoundException,
InvalidGlobalClusterStateException, AwsServiceException, SdkClientException, DocDbException {
return deleteGlobalCluster(DeleteGlobalClusterRequest.builder().applyMutation(deleteGlobalClusterRequest).build());
}
/**
*
* Returns a list of certificate authority (CA) certificates provided by Amazon DocumentDB for this Amazon Web
* Services account.
*
*
* @param describeCertificatesRequest
* @return Result of the DescribeCertificates operation returned by the service.
* @throws CertificateNotFoundException
* CertificateIdentifier doesn't refer to an existing certificate.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws DocDbException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample DocDbClient.DescribeCertificates
* @see AWS
* API Documentation
*/
default DescribeCertificatesResponse describeCertificates(DescribeCertificatesRequest describeCertificatesRequest)
throws CertificateNotFoundException, AwsServiceException, SdkClientException, DocDbException {
throw new UnsupportedOperationException();
}
/**
*
* 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 {@link DescribeCertificatesRequest.Builder} avoiding the
* need to create one manually via {@link DescribeCertificatesRequest#builder()}
*
*
* @param describeCertificatesRequest
* A {@link Consumer} that will call methods on {@link DescribeCertificatesMessage.Builder} to create a
* request.
* @return Result of the DescribeCertificates operation returned by the service.
* @throws CertificateNotFoundException
* CertificateIdentifier doesn't refer to an existing certificate.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws DocDbException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample DocDbClient.DescribeCertificates
* @see AWS
* API Documentation
*/
default DescribeCertificatesResponse describeCertificates(
Consumer describeCertificatesRequest) throws CertificateNotFoundException,
AwsServiceException, SdkClientException, DocDbException {
return describeCertificates(DescribeCertificatesRequest.builder().applyMutation(describeCertificatesRequest).build());
}
/**
*
* Returns a list of certificate authority (CA) certificates provided by Amazon DocumentDB for this Amazon Web
* Services account.
*
*
*
* This is a variant of
* {@link #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
*
*
* {@code
* 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
*
*
* {@code
* 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
* {@link #describeCertificates(software.amazon.awssdk.services.docdb.model.DescribeCertificatesRequest)}
* operation.
*
*
* @param describeCertificatesRequest
* @return A custom iterable that can be used to iterate through all the response pages.
* @throws CertificateNotFoundException
* CertificateIdentifier doesn't refer to an existing certificate.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws DocDbException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample DocDbClient.DescribeCertificates
* @see AWS
* API Documentation
*/
default DescribeCertificatesIterable describeCertificatesPaginator(DescribeCertificatesRequest describeCertificatesRequest)
throws CertificateNotFoundException, AwsServiceException, SdkClientException, DocDbException {
throw new UnsupportedOperationException();
}
/**
*
* Returns a list of certificate authority (CA) certificates provided by Amazon DocumentDB for this Amazon Web
* Services account.
*
*
*
* This is a variant of
* {@link #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
*
*
* {@code
* 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
*
*
* {@code
* 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
* {@link #describeCertificates(software.amazon.awssdk.services.docdb.model.DescribeCertificatesRequest)}
* operation.
*
*
* This is a convenience which creates an instance of the {@link DescribeCertificatesRequest.Builder} avoiding the
* need to create one manually via {@link DescribeCertificatesRequest#builder()}
*
*
* @param describeCertificatesRequest
* A {@link Consumer} that will call methods on {@link DescribeCertificatesMessage.Builder} to create a
* request.
* @return A custom iterable that can be used to iterate through all the response pages.
* @throws CertificateNotFoundException
* CertificateIdentifier doesn't refer to an existing certificate.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws DocDbException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample DocDbClient.DescribeCertificates
* @see AWS
* API Documentation
*/
default DescribeCertificatesIterable describeCertificatesPaginator(
Consumer describeCertificatesRequest) throws CertificateNotFoundException,
AwsServiceException, SdkClientException, DocDbException {
return describeCertificatesPaginator(DescribeCertificatesRequest.builder().applyMutation(describeCertificatesRequest)
.build());
}
/**
*
* Returns a list of DBClusterParameterGroup descriptions. If a
* DBClusterParameterGroupName parameter is specified, the list contains only the description of the
* specified cluster parameter group.
*
*
* @return Result of the DescribeDBClusterParameterGroups operation returned by the service.
* @throws DbParameterGroupNotFoundException
* DBParameterGroupName doesn't refer to an existing parameter group.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws DocDbException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample DocDbClient.DescribeDBClusterParameterGroups
* @see #describeDBClusterParameterGroups(DescribeDbClusterParameterGroupsRequest)
* @see AWS API Documentation
*/
default DescribeDbClusterParameterGroupsResponse describeDBClusterParameterGroups() throws DbParameterGroupNotFoundException,
AwsServiceException, SdkClientException, DocDbException {
return describeDBClusterParameterGroups(DescribeDbClusterParameterGroupsRequest.builder().build());
}
/**
*
* Returns a list of DBClusterParameterGroup descriptions. If a
* DBClusterParameterGroupName parameter is specified, the list contains only the description of the
* specified cluster parameter group.
*
*
* @param describeDbClusterParameterGroupsRequest
* Represents the input to DescribeDBClusterParameterGroups.
* @return Result of the DescribeDBClusterParameterGroups operation returned by the service.
* @throws DbParameterGroupNotFoundException
* DBParameterGroupName doesn't refer to an existing parameter group.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws DocDbException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample DocDbClient.DescribeDBClusterParameterGroups
* @see AWS API Documentation
*/
default DescribeDbClusterParameterGroupsResponse describeDBClusterParameterGroups(
DescribeDbClusterParameterGroupsRequest describeDbClusterParameterGroupsRequest)
throws DbParameterGroupNotFoundException, AwsServiceException, SdkClientException, DocDbException {
throw new UnsupportedOperationException();
}
/**
*
* 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 {@link DescribeDbClusterParameterGroupsRequest.Builder}
* avoiding the need to create one manually via {@link DescribeDbClusterParameterGroupsRequest#builder()}
*
*
* @param describeDbClusterParameterGroupsRequest
* A {@link Consumer} that will call methods on {@link DescribeDBClusterParameterGroupsMessage.Builder} to
* create a request. Represents the input to DescribeDBClusterParameterGroups.
* @return Result of the DescribeDBClusterParameterGroups operation returned by the service.
* @throws DbParameterGroupNotFoundException
* DBParameterGroupName doesn't refer to an existing parameter group.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws DocDbException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample DocDbClient.DescribeDBClusterParameterGroups
* @see AWS API Documentation
*/
default DescribeDbClusterParameterGroupsResponse describeDBClusterParameterGroups(
Consumer describeDbClusterParameterGroupsRequest)
throws DbParameterGroupNotFoundException, AwsServiceException, SdkClientException, DocDbException {
return describeDBClusterParameterGroups(DescribeDbClusterParameterGroupsRequest.builder()
.applyMutation(describeDbClusterParameterGroupsRequest).build());
}
/**
*
* 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
* {@link #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
*
*
* {@code
* 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
*
*
* {@code
* 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
* {@link #describeDBClusterParameterGroups(software.amazon.awssdk.services.docdb.model.DescribeDbClusterParameterGroupsRequest)}
* operation.
*
*
* @return A custom iterable that can be used to iterate through all the response pages.
* @throws DbParameterGroupNotFoundException
* DBParameterGroupName doesn't refer to an existing parameter group.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws DocDbException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample DocDbClient.DescribeDBClusterParameterGroups
* @see #describeDBClusterParameterGroupsPaginator(DescribeDbClusterParameterGroupsRequest)
* @see AWS API Documentation
*/
default DescribeDBClusterParameterGroupsIterable describeDBClusterParameterGroupsPaginator()
throws DbParameterGroupNotFoundException, AwsServiceException, SdkClientException, DocDbException {
return describeDBClusterParameterGroupsPaginator(DescribeDbClusterParameterGroupsRequest.builder().build());
}
/**
*
* 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
* {@link #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
*
*
* {@code
* 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
*
*
* {@code
* 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
* {@link #describeDBClusterParameterGroups(software.amazon.awssdk.services.docdb.model.DescribeDbClusterParameterGroupsRequest)}
* operation.
*
*
* @param describeDbClusterParameterGroupsRequest
* Represents the input to DescribeDBClusterParameterGroups.
* @return A custom iterable that can be used to iterate through all the response pages.
* @throws DbParameterGroupNotFoundException
* DBParameterGroupName doesn't refer to an existing parameter group.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws DocDbException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample DocDbClient.DescribeDBClusterParameterGroups
* @see AWS API Documentation
*/
default DescribeDBClusterParameterGroupsIterable describeDBClusterParameterGroupsPaginator(
DescribeDbClusterParameterGroupsRequest describeDbClusterParameterGroupsRequest)
throws DbParameterGroupNotFoundException, AwsServiceException, SdkClientException, DocDbException {
throw new UnsupportedOperationException();
}
/**
*
* 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
* {@link #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
*
*
* {@code
* 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
*
*
* {@code
* 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
* {@link #describeDBClusterParameterGroups(software.amazon.awssdk.services.docdb.model.DescribeDbClusterParameterGroupsRequest)}
* operation.
*
*
* This is a convenience which creates an instance of the {@link DescribeDbClusterParameterGroupsRequest.Builder}
* avoiding the need to create one manually via {@link DescribeDbClusterParameterGroupsRequest#builder()}
*
*
* @param describeDbClusterParameterGroupsRequest
* A {@link Consumer} that will call methods on {@link DescribeDBClusterParameterGroupsMessage.Builder} to
* create a request. Represents the input to DescribeDBClusterParameterGroups.
* @return A custom iterable that can be used to iterate through all the response pages.
* @throws DbParameterGroupNotFoundException
* DBParameterGroupName doesn't refer to an existing parameter group.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws DocDbException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample DocDbClient.DescribeDBClusterParameterGroups
* @see AWS API Documentation
*/
default DescribeDBClusterParameterGroupsIterable describeDBClusterParameterGroupsPaginator(
Consumer describeDbClusterParameterGroupsRequest)
throws DbParameterGroupNotFoundException, AwsServiceException, SdkClientException, DocDbException {
return describeDBClusterParameterGroupsPaginator(DescribeDbClusterParameterGroupsRequest.builder()
.applyMutation(describeDbClusterParameterGroupsRequest).build());
}
/**
*
* Returns the detailed parameter list for a particular cluster parameter group.
*
*
* @param describeDbClusterParametersRequest
* Represents the input to DescribeDBClusterParameters.
* @return Result of the DescribeDBClusterParameters operation returned by the service.
* @throws DbParameterGroupNotFoundException
* DBParameterGroupName doesn't refer to an existing parameter group.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws DocDbException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample DocDbClient.DescribeDBClusterParameters
* @see AWS API Documentation
*/
default DescribeDbClusterParametersResponse describeDBClusterParameters(
DescribeDbClusterParametersRequest describeDbClusterParametersRequest) throws DbParameterGroupNotFoundException,
AwsServiceException, SdkClientException, DocDbException {
throw new UnsupportedOperationException();
}
/**
*
* Returns the detailed parameter list for a particular cluster parameter group.
*
*
*
* This is a convenience which creates an instance of the {@link DescribeDbClusterParametersRequest.Builder}
* avoiding the need to create one manually via {@link DescribeDbClusterParametersRequest#builder()}
*
*
* @param describeDbClusterParametersRequest
* A {@link Consumer} that will call methods on {@link DescribeDBClusterParametersMessage.Builder} to create
* a request. Represents the input to DescribeDBClusterParameters.
* @return Result of the DescribeDBClusterParameters operation returned by the service.
* @throws DbParameterGroupNotFoundException
* DBParameterGroupName doesn't refer to an existing parameter group.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws DocDbException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample DocDbClient.DescribeDBClusterParameters
* @see AWS API Documentation
*/
default DescribeDbClusterParametersResponse describeDBClusterParameters(
Consumer describeDbClusterParametersRequest)
throws DbParameterGroupNotFoundException, AwsServiceException, SdkClientException, DocDbException {
return describeDBClusterParameters(DescribeDbClusterParametersRequest.builder()
.applyMutation(describeDbClusterParametersRequest).build());
}
/**
*
* Returns the detailed parameter list for a particular cluster parameter group.
*
*
*
* This is a variant of
* {@link #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
*
*
* {@code
* 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
*
*
* {@code
* 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
* {@link #describeDBClusterParameters(software.amazon.awssdk.services.docdb.model.DescribeDbClusterParametersRequest)}
* operation.
*
*
* @param describeDbClusterParametersRequest
* Represents the input to DescribeDBClusterParameters.
* @return A custom iterable that can be used to iterate through all the response pages.
* @throws DbParameterGroupNotFoundException
* DBParameterGroupName doesn't refer to an existing parameter group.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws DocDbException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample DocDbClient.DescribeDBClusterParameters
* @see AWS API Documentation
*/
default DescribeDBClusterParametersIterable describeDBClusterParametersPaginator(
DescribeDbClusterParametersRequest describeDbClusterParametersRequest) throws DbParameterGroupNotFoundException,
AwsServiceException, SdkClientException, DocDbException {
throw new UnsupportedOperationException();
}
/**
*
* Returns the detailed parameter list for a particular cluster parameter group.
*
*
*
* This is a variant of
* {@link #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
*
*
* {@code
* 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
*
*
* {@code
* 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
* {@link #describeDBClusterParameters(software.amazon.awssdk.services.docdb.model.DescribeDbClusterParametersRequest)}
* operation.
*
*
* This is a convenience which creates an instance of the {@link DescribeDbClusterParametersRequest.Builder}
* avoiding the need to create one manually via {@link DescribeDbClusterParametersRequest#builder()}
*
*
* @param describeDbClusterParametersRequest
* A {@link Consumer} that will call methods on {@link DescribeDBClusterParametersMessage.Builder} to create
* a request. Represents the input to DescribeDBClusterParameters.
* @return A custom iterable that can be used to iterate through all the response pages.
* @throws DbParameterGroupNotFoundException
* DBParameterGroupName doesn't refer to an existing parameter group.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws DocDbException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample DocDbClient.DescribeDBClusterParameters
* @see AWS API Documentation
*/
default DescribeDBClusterParametersIterable describeDBClusterParametersPaginator(
Consumer describeDbClusterParametersRequest)
throws DbParameterGroupNotFoundException, AwsServiceException, SdkClientException, DocDbException {
return describeDBClusterParametersPaginator(DescribeDbClusterParametersRequest.builder()
.applyMutation(describeDbClusterParametersRequest).build());
}
/**
*
* 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.
*
*
* @param describeDbClusterSnapshotAttributesRequest
* Represents the input to DescribeDBClusterSnapshotAttributes.
* @return Result of the DescribeDBClusterSnapshotAttributes operation returned by the service.
* @throws DbClusterSnapshotNotFoundException
* DBClusterSnapshotIdentifier doesn't refer to an existing cluster snapshot.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws DocDbException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample DocDbClient.DescribeDBClusterSnapshotAttributes
* @see AWS API Documentation
*/
default DescribeDbClusterSnapshotAttributesResponse describeDBClusterSnapshotAttributes(
DescribeDbClusterSnapshotAttributesRequest describeDbClusterSnapshotAttributesRequest)
throws DbClusterSnapshotNotFoundException, AwsServiceException, SdkClientException, DocDbException {
throw new UnsupportedOperationException();
}
/**
*
* 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 {@link DescribeDbClusterSnapshotAttributesRequest.Builder}
* avoiding the need to create one manually via {@link DescribeDbClusterSnapshotAttributesRequest#builder()}
*
*
* @param describeDbClusterSnapshotAttributesRequest
* A {@link Consumer} that will call methods on {@link DescribeDBClusterSnapshotAttributesMessage.Builder} to
* create a request. Represents the input to DescribeDBClusterSnapshotAttributes.
* @return Result of the DescribeDBClusterSnapshotAttributes operation returned by the service.
* @throws DbClusterSnapshotNotFoundException
* DBClusterSnapshotIdentifier doesn't refer to an existing cluster snapshot.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws DocDbException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample DocDbClient.DescribeDBClusterSnapshotAttributes
* @see AWS API Documentation
*/
default DescribeDbClusterSnapshotAttributesResponse describeDBClusterSnapshotAttributes(
Consumer describeDbClusterSnapshotAttributesRequest)
throws DbClusterSnapshotNotFoundException, AwsServiceException, SdkClientException, DocDbException {
return describeDBClusterSnapshotAttributes(DescribeDbClusterSnapshotAttributesRequest.builder()
.applyMutation(describeDbClusterSnapshotAttributesRequest).build());
}
/**
*
* Returns information about cluster snapshots. This API operation supports pagination.
*
*
* @return Result of the DescribeDBClusterSnapshots operation returned by the service.
* @throws DbClusterSnapshotNotFoundException
* DBClusterSnapshotIdentifier doesn't refer to an existing cluster snapshot.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws DocDbException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample DocDbClient.DescribeDBClusterSnapshots
* @see #describeDBClusterSnapshots(DescribeDbClusterSnapshotsRequest)
* @see AWS API Documentation
*/
default DescribeDbClusterSnapshotsResponse describeDBClusterSnapshots() throws DbClusterSnapshotNotFoundException,
AwsServiceException, SdkClientException, DocDbException {
return describeDBClusterSnapshots(DescribeDbClusterSnapshotsRequest.builder().build());
}
/**
*
* Returns information about cluster snapshots. This API operation supports pagination.
*
*
* @param describeDbClusterSnapshotsRequest
* Represents the input to DescribeDBClusterSnapshots.
* @return Result of the DescribeDBClusterSnapshots operation returned by the service.
* @throws DbClusterSnapshotNotFoundException
* DBClusterSnapshotIdentifier doesn't refer to an existing cluster snapshot.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws DocDbException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample DocDbClient.DescribeDBClusterSnapshots
* @see AWS API Documentation
*/
default DescribeDbClusterSnapshotsResponse describeDBClusterSnapshots(
DescribeDbClusterSnapshotsRequest describeDbClusterSnapshotsRequest) throws DbClusterSnapshotNotFoundException,
AwsServiceException, SdkClientException, DocDbException {
throw new UnsupportedOperationException();
}
/**
*
* Returns information about cluster snapshots. This API operation supports pagination.
*
*
*
* This is a convenience which creates an instance of the {@link DescribeDbClusterSnapshotsRequest.Builder} avoiding
* the need to create one manually via {@link DescribeDbClusterSnapshotsRequest#builder()}
*
*
* @param describeDbClusterSnapshotsRequest
* A {@link Consumer} that will call methods on {@link DescribeDBClusterSnapshotsMessage.Builder} to create a
* request. Represents the input to DescribeDBClusterSnapshots.
* @return Result of the DescribeDBClusterSnapshots operation returned by the service.
* @throws DbClusterSnapshotNotFoundException
* DBClusterSnapshotIdentifier doesn't refer to an existing cluster snapshot.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws DocDbException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample DocDbClient.DescribeDBClusterSnapshots
* @see AWS API Documentation
*/
default DescribeDbClusterSnapshotsResponse describeDBClusterSnapshots(
Consumer describeDbClusterSnapshotsRequest)
throws DbClusterSnapshotNotFoundException, AwsServiceException, SdkClientException, DocDbException {
return describeDBClusterSnapshots(DescribeDbClusterSnapshotsRequest.builder()
.applyMutation(describeDbClusterSnapshotsRequest).build());
}
/**
*
* Returns information about cluster snapshots. This API operation supports pagination.
*
*
*
* This is a variant of
* {@link #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
*
*
* {@code
* 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
*
*
* {@code
* 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
* {@link #describeDBClusterSnapshots(software.amazon.awssdk.services.docdb.model.DescribeDbClusterSnapshotsRequest)}
* operation.
*
*
* @return A custom iterable that can be used to iterate through all the response pages.
* @throws DbClusterSnapshotNotFoundException
* DBClusterSnapshotIdentifier doesn't refer to an existing cluster snapshot.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws DocDbException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample DocDbClient.DescribeDBClusterSnapshots
* @see #describeDBClusterSnapshotsPaginator(DescribeDbClusterSnapshotsRequest)
* @see AWS API Documentation
*/
default DescribeDBClusterSnapshotsIterable describeDBClusterSnapshotsPaginator() throws DbClusterSnapshotNotFoundException,
AwsServiceException, SdkClientException, DocDbException {
return describeDBClusterSnapshotsPaginator(DescribeDbClusterSnapshotsRequest.builder().build());
}
/**
*
* Returns information about cluster snapshots. This API operation supports pagination.
*
*
*
* This is a variant of
* {@link #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
*
*
* {@code
* 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
*
*
* {@code
* 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
* {@link #describeDBClusterSnapshots(software.amazon.awssdk.services.docdb.model.DescribeDbClusterSnapshotsRequest)}
* operation.
*
*
* @param describeDbClusterSnapshotsRequest
* Represents the input to DescribeDBClusterSnapshots.
* @return A custom iterable that can be used to iterate through all the response pages.
* @throws DbClusterSnapshotNotFoundException
* DBClusterSnapshotIdentifier doesn't refer to an existing cluster snapshot.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws DocDbException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample DocDbClient.DescribeDBClusterSnapshots
* @see AWS API Documentation
*/
default DescribeDBClusterSnapshotsIterable describeDBClusterSnapshotsPaginator(
DescribeDbClusterSnapshotsRequest describeDbClusterSnapshotsRequest) throws DbClusterSnapshotNotFoundException,
AwsServiceException, SdkClientException, DocDbException {
throw new UnsupportedOperationException();
}
/**
*
* Returns information about cluster snapshots. This API operation supports pagination.
*
*
*
* This is a variant of
* {@link #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
*
*
* {@code
* 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
*
*
* {@code
* 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
* {@link #describeDBClusterSnapshots(software.amazon.awssdk.services.docdb.model.DescribeDbClusterSnapshotsRequest)}
* operation.
*
*
* This is a convenience which creates an instance of the {@link DescribeDbClusterSnapshotsRequest.Builder} avoiding
* the need to create one manually via {@link DescribeDbClusterSnapshotsRequest#builder()}
*
*
* @param describeDbClusterSnapshotsRequest
* A {@link Consumer} that will call methods on {@link DescribeDBClusterSnapshotsMessage.Builder} to create a
* request. Represents the input to DescribeDBClusterSnapshots.
* @return A custom iterable that can be used to iterate through all the response pages.
* @throws DbClusterSnapshotNotFoundException
* DBClusterSnapshotIdentifier doesn't refer to an existing cluster snapshot.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws DocDbException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample DocDbClient.DescribeDBClusterSnapshots
* @see AWS API Documentation
*/
default DescribeDBClusterSnapshotsIterable describeDBClusterSnapshotsPaginator(
Consumer describeDbClusterSnapshotsRequest)
throws DbClusterSnapshotNotFoundException, AwsServiceException, SdkClientException, DocDbException {
return describeDBClusterSnapshotsPaginator(DescribeDbClusterSnapshotsRequest.builder()
.applyMutation(describeDbClusterSnapshotsRequest).build());
}
/**
*
* 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.
*
*
* @return Result of the DescribeDBClusters operation returned by the service.
* @throws DbClusterNotFoundException
* DBClusterIdentifier doesn't refer to an existing cluster.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws DocDbException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample DocDbClient.DescribeDBClusters
* @see #describeDBClusters(DescribeDbClustersRequest)
* @see AWS API
* Documentation
*/
default DescribeDbClustersResponse describeDBClusters() throws DbClusterNotFoundException, AwsServiceException,
SdkClientException, DocDbException {
return describeDBClusters(DescribeDbClustersRequest.builder().build());
}
/**
*
* 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.
*
*
* @param describeDbClustersRequest
* Represents the input to DescribeDBClusters.
* @return Result of the DescribeDBClusters operation returned by the service.
* @throws DbClusterNotFoundException
* DBClusterIdentifier doesn't refer to an existing cluster.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws DocDbException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample DocDbClient.DescribeDBClusters
* @see AWS API
* Documentation
*/
default DescribeDbClustersResponse describeDBClusters(DescribeDbClustersRequest describeDbClustersRequest)
throws DbClusterNotFoundException, AwsServiceException, SdkClientException, DocDbException {
throw new UnsupportedOperationException();
}
/**
*
* 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 {@link DescribeDbClustersRequest.Builder} avoiding the
* need to create one manually via {@link DescribeDbClustersRequest#builder()}
*
*
* @param describeDbClustersRequest
* A {@link Consumer} that will call methods on {@link DescribeDBClustersMessage.Builder} to create a
* request. Represents the input to DescribeDBClusters.
* @return Result of the DescribeDBClusters operation returned by the service.
* @throws DbClusterNotFoundException
* DBClusterIdentifier doesn't refer to an existing cluster.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws DocDbException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample DocDbClient.DescribeDBClusters
* @see AWS API
* Documentation
*/
default DescribeDbClustersResponse describeDBClusters(Consumer describeDbClustersRequest)
throws DbClusterNotFoundException, AwsServiceException, SdkClientException, DocDbException {
return describeDBClusters(DescribeDbClustersRequest.builder().applyMutation(describeDbClustersRequest).build());
}
/**
*
* 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
* {@link #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
*
*
* {@code
* 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
*
*
* {@code
* 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
* {@link #describeDBClusters(software.amazon.awssdk.services.docdb.model.DescribeDbClustersRequest)} operation.
*
*
* @return A custom iterable that can be used to iterate through all the response pages.
* @throws DbClusterNotFoundException
* DBClusterIdentifier doesn't refer to an existing cluster.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws DocDbException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample DocDbClient.DescribeDBClusters
* @see #describeDBClustersPaginator(DescribeDbClustersRequest)
* @see AWS API
* Documentation
*/
default DescribeDBClustersIterable describeDBClustersPaginator() throws DbClusterNotFoundException, AwsServiceException,
SdkClientException, DocDbException {
return describeDBClustersPaginator(DescribeDbClustersRequest.builder().build());
}
/**
*
* 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
* {@link #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
*
*
* {@code
* 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
*
*
* {@code
* 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
* {@link #describeDBClusters(software.amazon.awssdk.services.docdb.model.DescribeDbClustersRequest)} operation.
*
*
* @param describeDbClustersRequest
* Represents the input to DescribeDBClusters.
* @return A custom iterable that can be used to iterate through all the response pages.
* @throws DbClusterNotFoundException
* DBClusterIdentifier doesn't refer to an existing cluster.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws DocDbException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample DocDbClient.DescribeDBClusters
* @see AWS API
* Documentation
*/
default DescribeDBClustersIterable describeDBClustersPaginator(DescribeDbClustersRequest describeDbClustersRequest)
throws DbClusterNotFoundException, AwsServiceException, SdkClientException, DocDbException {
throw new UnsupportedOperationException();
}
/**
*
* 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
* {@link #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
*
*
* {@code
* 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
*
*
* {@code
* 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
* {@link #describeDBClusters(software.amazon.awssdk.services.docdb.model.DescribeDbClustersRequest)} operation.
*
*
* This is a convenience which creates an instance of the {@link DescribeDbClustersRequest.Builder} avoiding the
* need to create one manually via {@link DescribeDbClustersRequest#builder()}
*
*
* @param describeDbClustersRequest
* A {@link Consumer} that will call methods on {@link DescribeDBClustersMessage.Builder} to create a
* request. Represents the input to DescribeDBClusters.
* @return A custom iterable that can be used to iterate through all the response pages.
* @throws DbClusterNotFoundException
* DBClusterIdentifier doesn't refer to an existing cluster.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws DocDbException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample DocDbClient.DescribeDBClusters
* @see AWS API
* Documentation
*/
default DescribeDBClustersIterable describeDBClustersPaginator(
Consumer describeDbClustersRequest) throws DbClusterNotFoundException,
AwsServiceException, SdkClientException, DocDbException {
return describeDBClustersPaginator(DescribeDbClustersRequest.builder().applyMutation(describeDbClustersRequest).build());
}
/**
*
* Returns a list of the available engines.
*
*
* @return Result of the DescribeDBEngineVersions operation returned by the service.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws DocDbException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample DocDbClient.DescribeDBEngineVersions
* @see #describeDBEngineVersions(DescribeDbEngineVersionsRequest)
* @see AWS API Documentation
*/
default DescribeDbEngineVersionsResponse describeDBEngineVersions() throws AwsServiceException, SdkClientException,
DocDbException {
return describeDBEngineVersions(DescribeDbEngineVersionsRequest.builder().build());
}
/**
*
* Returns a list of the available engines.
*
*
* @param describeDbEngineVersionsRequest
* Represents the input to DescribeDBEngineVersions.
* @return Result of the DescribeDBEngineVersions operation returned by the service.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws DocDbException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample DocDbClient.DescribeDBEngineVersions
* @see AWS API Documentation
*/
default DescribeDbEngineVersionsResponse describeDBEngineVersions(
DescribeDbEngineVersionsRequest describeDbEngineVersionsRequest) throws AwsServiceException, SdkClientException,
DocDbException {
throw new UnsupportedOperationException();
}
/**
*
* Returns a list of the available engines.
*
*
*
* This is a convenience which creates an instance of the {@link DescribeDbEngineVersionsRequest.Builder} avoiding
* the need to create one manually via {@link DescribeDbEngineVersionsRequest#builder()}
*
*
* @param describeDbEngineVersionsRequest
* A {@link Consumer} that will call methods on {@link DescribeDBEngineVersionsMessage.Builder} to create a
* request. Represents the input to DescribeDBEngineVersions.
* @return Result of the DescribeDBEngineVersions operation returned by the service.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws DocDbException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample DocDbClient.DescribeDBEngineVersions
* @see AWS API Documentation
*/
default DescribeDbEngineVersionsResponse describeDBEngineVersions(
Consumer describeDbEngineVersionsRequest) throws AwsServiceException,
SdkClientException, DocDbException {
return describeDBEngineVersions(DescribeDbEngineVersionsRequest.builder().applyMutation(describeDbEngineVersionsRequest)
.build());
}
/**
*
* Returns a list of the available engines.
*
*
*
* This is a variant of
* {@link #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
*
*
* {@code
* 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
*
*
* {@code
* 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
* {@link #describeDBEngineVersions(software.amazon.awssdk.services.docdb.model.DescribeDbEngineVersionsRequest)}
* operation.
*
*
* @return A custom iterable that can be used to iterate through all the response pages.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws DocDbException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample DocDbClient.DescribeDBEngineVersions
* @see #describeDBEngineVersionsPaginator(DescribeDbEngineVersionsRequest)
* @see AWS API Documentation
*/
default DescribeDBEngineVersionsIterable describeDBEngineVersionsPaginator() throws AwsServiceException, SdkClientException,
DocDbException {
return describeDBEngineVersionsPaginator(DescribeDbEngineVersionsRequest.builder().build());
}
/**
*
* Returns a list of the available engines.
*
*
*
* This is a variant of
* {@link #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
*
*
* {@code
* 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
*
*
* {@code
* 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
* {@link #describeDBEngineVersions(software.amazon.awssdk.services.docdb.model.DescribeDbEngineVersionsRequest)}
* operation.
*
*
* @param describeDbEngineVersionsRequest
* Represents the input to DescribeDBEngineVersions.
* @return A custom iterable that can be used to iterate through all the response pages.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws DocDbException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample DocDbClient.DescribeDBEngineVersions
* @see AWS API Documentation
*/
default DescribeDBEngineVersionsIterable describeDBEngineVersionsPaginator(
DescribeDbEngineVersionsRequest describeDbEngineVersionsRequest) throws AwsServiceException, SdkClientException,
DocDbException {
throw new UnsupportedOperationException();
}
/**
*
* Returns a list of the available engines.
*
*
*
* This is a variant of
* {@link #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
*
*
* {@code
* 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
*
*
* {@code
* 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
* {@link #describeDBEngineVersions(software.amazon.awssdk.services.docdb.model.DescribeDbEngineVersionsRequest)}
* operation.
*
*
* This is a convenience which creates an instance of the {@link DescribeDbEngineVersionsRequest.Builder} avoiding
* the need to create one manually via {@link DescribeDbEngineVersionsRequest#builder()}
*
*
* @param describeDbEngineVersionsRequest
* A {@link Consumer} that will call methods on {@link DescribeDBEngineVersionsMessage.Builder} to create a
* request. Represents the input to DescribeDBEngineVersions.
* @return A custom iterable that can be used to iterate through all the response pages.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws DocDbException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample DocDbClient.DescribeDBEngineVersions
* @see AWS API Documentation
*/
default DescribeDBEngineVersionsIterable describeDBEngineVersionsPaginator(
Consumer describeDbEngineVersionsRequest) throws AwsServiceException,
SdkClientException, DocDbException {
return describeDBEngineVersionsPaginator(DescribeDbEngineVersionsRequest.builder()
.applyMutation(describeDbEngineVersionsRequest).build());
}
/**
*
* Returns information about provisioned Amazon DocumentDB instances. This API supports pagination.
*
*
* @return Result of the DescribeDBInstances operation returned by the service.
* @throws DbInstanceNotFoundException
* DBInstanceIdentifier doesn't refer to an existing instance.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws DocDbException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample DocDbClient.DescribeDBInstances
* @see #describeDBInstances(DescribeDbInstancesRequest)
* @see AWS API
* Documentation
*/
default DescribeDbInstancesResponse describeDBInstances() throws DbInstanceNotFoundException, AwsServiceException,
SdkClientException, DocDbException {
return describeDBInstances(DescribeDbInstancesRequest.builder().build());
}
/**
*
* Returns information about provisioned Amazon DocumentDB instances. This API supports pagination.
*
*
* @param describeDbInstancesRequest
* Represents the input to DescribeDBInstances.
* @return Result of the DescribeDBInstances operation returned by the service.
* @throws DbInstanceNotFoundException
* DBInstanceIdentifier doesn't refer to an existing instance.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws DocDbException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample DocDbClient.DescribeDBInstances
* @see AWS API
* Documentation
*/
default DescribeDbInstancesResponse describeDBInstances(DescribeDbInstancesRequest describeDbInstancesRequest)
throws DbInstanceNotFoundException, AwsServiceException, SdkClientException, DocDbException {
throw new UnsupportedOperationException();
}
/**
*
* Returns information about provisioned Amazon DocumentDB instances. This API supports pagination.
*
*
*
* This is a convenience which creates an instance of the {@link DescribeDbInstancesRequest.Builder} avoiding the
* need to create one manually via {@link DescribeDbInstancesRequest#builder()}
*
*
* @param describeDbInstancesRequest
* A {@link Consumer} that will call methods on {@link DescribeDBInstancesMessage.Builder} to create a
* request. Represents the input to DescribeDBInstances.
* @return Result of the DescribeDBInstances operation returned by the service.
* @throws DbInstanceNotFoundException
* DBInstanceIdentifier doesn't refer to an existing instance.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws DocDbException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample DocDbClient.DescribeDBInstances
* @see AWS API
* Documentation
*/
default DescribeDbInstancesResponse describeDBInstances(
Consumer describeDbInstancesRequest) throws DbInstanceNotFoundException,
AwsServiceException, SdkClientException, DocDbException {
return describeDBInstances(DescribeDbInstancesRequest.builder().applyMutation(describeDbInstancesRequest).build());
}
/**
*
* Returns information about provisioned Amazon DocumentDB instances. This API supports pagination.
*
*
*
* This is a variant of
* {@link #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
*
*
* {@code
* 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
*
*
* {@code
* 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
* {@link #describeDBInstances(software.amazon.awssdk.services.docdb.model.DescribeDbInstancesRequest)}
* operation.
*
*
* @return A custom iterable that can be used to iterate through all the response pages.
* @throws DbInstanceNotFoundException
* DBInstanceIdentifier doesn't refer to an existing instance.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws DocDbException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample DocDbClient.DescribeDBInstances
* @see #describeDBInstancesPaginator(DescribeDbInstancesRequest)
* @see AWS API
* Documentation
*/
default DescribeDBInstancesIterable describeDBInstancesPaginator() throws DbInstanceNotFoundException, AwsServiceException,
SdkClientException, DocDbException {
return describeDBInstancesPaginator(DescribeDbInstancesRequest.builder().build());
}
/**
*
* Returns information about provisioned Amazon DocumentDB instances. This API supports pagination.
*
*
*
* This is a variant of
* {@link #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
*
*
* {@code
* 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
*
*
* {@code
* 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
* {@link #describeDBInstances(software.amazon.awssdk.services.docdb.model.DescribeDbInstancesRequest)}
* operation.
*
*
* @param describeDbInstancesRequest
* Represents the input to DescribeDBInstances.
* @return A custom iterable that can be used to iterate through all the response pages.
* @throws DbInstanceNotFoundException
* DBInstanceIdentifier doesn't refer to an existing instance.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws DocDbException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample DocDbClient.DescribeDBInstances
* @see AWS API
* Documentation
*/
default DescribeDBInstancesIterable describeDBInstancesPaginator(DescribeDbInstancesRequest describeDbInstancesRequest)
throws DbInstanceNotFoundException, AwsServiceException, SdkClientException, DocDbException {
throw new UnsupportedOperationException();
}
/**
*
* Returns information about provisioned Amazon DocumentDB instances. This API supports pagination.
*
*
*
* This is a variant of
* {@link #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
*
*
* {@code
* 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
*
*
* {@code
* 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
* {@link #describeDBInstances(software.amazon.awssdk.services.docdb.model.DescribeDbInstancesRequest)}
* operation.
*
*
* This is a convenience which creates an instance of the {@link DescribeDbInstancesRequest.Builder} avoiding the
* need to create one manually via {@link DescribeDbInstancesRequest#builder()}
*
*
* @param describeDbInstancesRequest
* A {@link Consumer} that will call methods on {@link DescribeDBInstancesMessage.Builder} to create a
* request. Represents the input to DescribeDBInstances.
* @return A custom iterable that can be used to iterate through all the response pages.
* @throws DbInstanceNotFoundException
* DBInstanceIdentifier doesn't refer to an existing instance.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws DocDbException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample DocDbClient.DescribeDBInstances
* @see AWS API
* Documentation
*/
default DescribeDBInstancesIterable describeDBInstancesPaginator(
Consumer describeDbInstancesRequest) throws DbInstanceNotFoundException,
AwsServiceException, SdkClientException, DocDbException {
return describeDBInstancesPaginator(DescribeDbInstancesRequest.builder().applyMutation(describeDbInstancesRequest)
.build());
}
/**
*
* Returns a list of DBSubnetGroup descriptions. If a DBSubnetGroupName is specified, the
* list will contain only the descriptions of the specified DBSubnetGroup.
*
*
* @return Result of the DescribeDBSubnetGroups operation returned by the service.
* @throws DbSubnetGroupNotFoundException
* DBSubnetGroupName doesn't refer to an existing subnet group.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws DocDbException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample DocDbClient.DescribeDBSubnetGroups
* @see #describeDBSubnetGroups(DescribeDbSubnetGroupsRequest)
* @see AWS
* API Documentation
*/
default DescribeDbSubnetGroupsResponse describeDBSubnetGroups() throws DbSubnetGroupNotFoundException, AwsServiceException,
SdkClientException, DocDbException {
return describeDBSubnetGroups(DescribeDbSubnetGroupsRequest.builder().build());
}
/**
*
* Returns a list of DBSubnetGroup descriptions. If a DBSubnetGroupName is specified, the
* list will contain only the descriptions of the specified DBSubnetGroup.
*
*
* @param describeDbSubnetGroupsRequest
* Represents the input to DescribeDBSubnetGroups.
* @return Result of the DescribeDBSubnetGroups operation returned by the service.
* @throws DbSubnetGroupNotFoundException
* DBSubnetGroupName doesn't refer to an existing subnet group.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws DocDbException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample DocDbClient.DescribeDBSubnetGroups
* @see AWS
* API Documentation
*/
default DescribeDbSubnetGroupsResponse describeDBSubnetGroups(DescribeDbSubnetGroupsRequest describeDbSubnetGroupsRequest)
throws DbSubnetGroupNotFoundException, AwsServiceException, SdkClientException, DocDbException {
throw new UnsupportedOperationException();
}
/**
*
* 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 {@link DescribeDbSubnetGroupsRequest.Builder} avoiding the
* need to create one manually via {@link DescribeDbSubnetGroupsRequest#builder()}
*
*
* @param describeDbSubnetGroupsRequest
* A {@link Consumer} that will call methods on {@link DescribeDBSubnetGroupsMessage.Builder} to create a
* request. Represents the input to DescribeDBSubnetGroups.
* @return Result of the DescribeDBSubnetGroups operation returned by the service.
* @throws DbSubnetGroupNotFoundException
* DBSubnetGroupName doesn't refer to an existing subnet group.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws DocDbException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample DocDbClient.DescribeDBSubnetGroups
* @see AWS
* API Documentation
*/
default DescribeDbSubnetGroupsResponse describeDBSubnetGroups(
Consumer describeDbSubnetGroupsRequest) throws DbSubnetGroupNotFoundException,
AwsServiceException, SdkClientException, DocDbException {
return describeDBSubnetGroups(DescribeDbSubnetGroupsRequest.builder().applyMutation(describeDbSubnetGroupsRequest)
.build());
}
/**
*
* 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
* {@link #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
*
*
* {@code
* 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
*
*
* {@code
* 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
* {@link #describeDBSubnetGroups(software.amazon.awssdk.services.docdb.model.DescribeDbSubnetGroupsRequest)}
* operation.
*
*
* @return A custom iterable that can be used to iterate through all the response pages.
* @throws DbSubnetGroupNotFoundException
* DBSubnetGroupName doesn't refer to an existing subnet group.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws DocDbException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample DocDbClient.DescribeDBSubnetGroups
* @see #describeDBSubnetGroupsPaginator(DescribeDbSubnetGroupsRequest)
* @see AWS
* API Documentation
*/
default DescribeDBSubnetGroupsIterable describeDBSubnetGroupsPaginator() throws DbSubnetGroupNotFoundException,
AwsServiceException, SdkClientException, DocDbException {
return describeDBSubnetGroupsPaginator(DescribeDbSubnetGroupsRequest.builder().build());
}
/**
*
* 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
* {@link #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
*
*
* {@code
* 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
*
*
* {@code
* 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
* {@link #describeDBSubnetGroups(software.amazon.awssdk.services.docdb.model.DescribeDbSubnetGroupsRequest)}
* operation.
*
*
* @param describeDbSubnetGroupsRequest
* Represents the input to DescribeDBSubnetGroups.
* @return A custom iterable that can be used to iterate through all the response pages.
* @throws DbSubnetGroupNotFoundException
* DBSubnetGroupName doesn't refer to an existing subnet group.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws DocDbException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample DocDbClient.DescribeDBSubnetGroups
* @see AWS
* API Documentation
*/
default DescribeDBSubnetGroupsIterable describeDBSubnetGroupsPaginator(
DescribeDbSubnetGroupsRequest describeDbSubnetGroupsRequest) throws DbSubnetGroupNotFoundException,
AwsServiceException, SdkClientException, DocDbException {
throw new UnsupportedOperationException();
}
/**
*
* 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
* {@link #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
*
*
* {@code
* 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
*
*
* {@code
* 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
* {@link #describeDBSubnetGroups(software.amazon.awssdk.services.docdb.model.DescribeDbSubnetGroupsRequest)}
* operation.
*
*
* This is a convenience which creates an instance of the {@link DescribeDbSubnetGroupsRequest.Builder} avoiding the
* need to create one manually via {@link DescribeDbSubnetGroupsRequest#builder()}
*
*
* @param describeDbSubnetGroupsRequest
* A {@link Consumer} that will call methods on {@link DescribeDBSubnetGroupsMessage.Builder} to create a
* request. Represents the input to DescribeDBSubnetGroups.
* @return A custom iterable that can be used to iterate through all the response pages.
* @throws DbSubnetGroupNotFoundException
* DBSubnetGroupName doesn't refer to an existing subnet group.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws DocDbException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample DocDbClient.DescribeDBSubnetGroups
* @see AWS
* API Documentation
*/
default DescribeDBSubnetGroupsIterable describeDBSubnetGroupsPaginator(
Consumer describeDbSubnetGroupsRequest) throws DbSubnetGroupNotFoundException,
AwsServiceException, SdkClientException, DocDbException {
return describeDBSubnetGroupsPaginator(DescribeDbSubnetGroupsRequest.builder()
.applyMutation(describeDbSubnetGroupsRequest).build());
}
/**
*
* Returns the default engine and system parameter information for the cluster database engine.
*
*
* @param describeEngineDefaultClusterParametersRequest
* Represents the input to DescribeEngineDefaultClusterParameters.
* @return Result of the DescribeEngineDefaultClusterParameters operation returned by the service.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws DocDbException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample DocDbClient.DescribeEngineDefaultClusterParameters
* @see AWS API Documentation
*/
default DescribeEngineDefaultClusterParametersResponse describeEngineDefaultClusterParameters(
DescribeEngineDefaultClusterParametersRequest describeEngineDefaultClusterParametersRequest)
throws AwsServiceException, SdkClientException, DocDbException {
throw new UnsupportedOperationException();
}
/**
*
* Returns the default engine and system parameter information for the cluster database engine.
*
*
*
* This is a convenience which creates an instance of the
* {@link DescribeEngineDefaultClusterParametersRequest.Builder} avoiding the need to create one manually via
* {@link DescribeEngineDefaultClusterParametersRequest#builder()}
*
*
* @param describeEngineDefaultClusterParametersRequest
* A {@link Consumer} that will call methods on {@link DescribeEngineDefaultClusterParametersMessage.Builder}
* to create a request. Represents the input to DescribeEngineDefaultClusterParameters.
* @return Result of the DescribeEngineDefaultClusterParameters operation returned by the service.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws DocDbException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample DocDbClient.DescribeEngineDefaultClusterParameters
* @see AWS API Documentation
*/
default DescribeEngineDefaultClusterParametersResponse describeEngineDefaultClusterParameters(
Consumer describeEngineDefaultClusterParametersRequest)
throws AwsServiceException, SdkClientException, DocDbException {
return describeEngineDefaultClusterParameters(DescribeEngineDefaultClusterParametersRequest.builder()
.applyMutation(describeEngineDefaultClusterParametersRequest).build());
}
/**
*
* Displays a list of categories for all event source types, or, if specified, for a specified source type.
*
*
* @return Result of the DescribeEventCategories operation returned by the service.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws DocDbException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample DocDbClient.DescribeEventCategories
* @see #describeEventCategories(DescribeEventCategoriesRequest)
* @see AWS
* API Documentation
*/
default DescribeEventCategoriesResponse describeEventCategories() throws AwsServiceException, SdkClientException,
DocDbException {
return describeEventCategories(DescribeEventCategoriesRequest.builder().build());
}
/**
*
* Displays a list of categories for all event source types, or, if specified, for a specified source type.
*
*
* @param describeEventCategoriesRequest
* Represents the input to DescribeEventCategories.
* @return Result of the DescribeEventCategories operation returned by the service.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws DocDbException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample DocDbClient.DescribeEventCategories
* @see AWS
* API Documentation
*/
default DescribeEventCategoriesResponse describeEventCategories(DescribeEventCategoriesRequest describeEventCategoriesRequest)
throws AwsServiceException, SdkClientException, DocDbException {
throw new UnsupportedOperationException();
}
/**
*
* 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 {@link DescribeEventCategoriesRequest.Builder} avoiding
* the need to create one manually via {@link DescribeEventCategoriesRequest#builder()}
*
*
* @param describeEventCategoriesRequest
* A {@link Consumer} that will call methods on {@link DescribeEventCategoriesMessage.Builder} to create a
* request. Represents the input to DescribeEventCategories.
* @return Result of the DescribeEventCategories operation returned by the service.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws DocDbException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample DocDbClient.DescribeEventCategories
* @see AWS
* API Documentation
*/
default DescribeEventCategoriesResponse describeEventCategories(
Consumer describeEventCategoriesRequest) throws AwsServiceException,
SdkClientException, DocDbException {
return describeEventCategories(DescribeEventCategoriesRequest.builder().applyMutation(describeEventCategoriesRequest)
.build());
}
/**
*
* 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.
*
*
* @param describeEventSubscriptionsRequest
* Represents the input to DescribeEventSubscriptions.
* @return Result of the DescribeEventSubscriptions operation returned by the service.
* @throws SubscriptionNotFoundException
* The subscription name does not exist.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws DocDbException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample DocDbClient.DescribeEventSubscriptions
* @see AWS API Documentation
*/
default DescribeEventSubscriptionsResponse describeEventSubscriptions(
DescribeEventSubscriptionsRequest describeEventSubscriptionsRequest) throws SubscriptionNotFoundException,
AwsServiceException, SdkClientException, DocDbException {
throw new UnsupportedOperationException();
}
/**
*
* 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 {@link DescribeEventSubscriptionsRequest.Builder} avoiding
* the need to create one manually via {@link DescribeEventSubscriptionsRequest#builder()}
*
*
* @param describeEventSubscriptionsRequest
* A {@link Consumer} that will call methods on {@link DescribeEventSubscriptionsMessage.Builder} to create a
* request. Represents the input to DescribeEventSubscriptions.
* @return Result of the DescribeEventSubscriptions operation returned by the service.
* @throws SubscriptionNotFoundException
* The subscription name does not exist.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws DocDbException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample DocDbClient.DescribeEventSubscriptions
* @see AWS API Documentation
*/
default DescribeEventSubscriptionsResponse describeEventSubscriptions(
Consumer describeEventSubscriptionsRequest)
throws SubscriptionNotFoundException, AwsServiceException, SdkClientException, DocDbException {
return describeEventSubscriptions(DescribeEventSubscriptionsRequest.builder()
.applyMutation(describeEventSubscriptionsRequest).build());
}
/**
*
* 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
* {@link #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
*
*
* {@code
* 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
*
*
* {@code
* 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
* {@link #describeEventSubscriptions(software.amazon.awssdk.services.docdb.model.DescribeEventSubscriptionsRequest)}
* operation.
*
*
* @param describeEventSubscriptionsRequest
* Represents the input to DescribeEventSubscriptions.
* @return A custom iterable that can be used to iterate through all the response pages.
* @throws SubscriptionNotFoundException
* The subscription name does not exist.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws DocDbException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample DocDbClient.DescribeEventSubscriptions
* @see AWS API Documentation
*/
default DescribeEventSubscriptionsIterable describeEventSubscriptionsPaginator(
DescribeEventSubscriptionsRequest describeEventSubscriptionsRequest) throws SubscriptionNotFoundException,
AwsServiceException, SdkClientException, DocDbException {
throw new UnsupportedOperationException();
}
/**
*
* 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
* {@link #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
*
*
* {@code
* 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
*
*
* {@code
* 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
* {@link #describeEventSubscriptions(software.amazon.awssdk.services.docdb.model.DescribeEventSubscriptionsRequest)}
* operation.
*
*
* This is a convenience which creates an instance of the {@link DescribeEventSubscriptionsRequest.Builder} avoiding
* the need to create one manually via {@link DescribeEventSubscriptionsRequest#builder()}
*
*
* @param describeEventSubscriptionsRequest
* A {@link Consumer} that will call methods on {@link DescribeEventSubscriptionsMessage.Builder} to create a
* request. Represents the input to DescribeEventSubscriptions.
* @return A custom iterable that can be used to iterate through all the response pages.
* @throws SubscriptionNotFoundException
* The subscription name does not exist.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws DocDbException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample DocDbClient.DescribeEventSubscriptions
* @see AWS API Documentation
*/
default DescribeEventSubscriptionsIterable describeEventSubscriptionsPaginator(
Consumer describeEventSubscriptionsRequest)
throws SubscriptionNotFoundException, AwsServiceException, SdkClientException, DocDbException {
return describeEventSubscriptionsPaginator(DescribeEventSubscriptionsRequest.builder()
.applyMutation(describeEventSubscriptionsRequest).build());
}
/**
*
* 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.
*
*
* @return Result of the DescribeEvents operation returned by the service.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws DocDbException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample DocDbClient.DescribeEvents
* @see #describeEvents(DescribeEventsRequest)
* @see AWS API
* Documentation
*/
default DescribeEventsResponse describeEvents() throws AwsServiceException, SdkClientException, DocDbException {
return describeEvents(DescribeEventsRequest.builder().build());
}
/**
*
* 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.
*
*
* @param describeEventsRequest
* Represents the input to DescribeEvents.
* @return Result of the DescribeEvents operation returned by the service.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws DocDbException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample DocDbClient.DescribeEvents
* @see AWS API
* Documentation
*/
default DescribeEventsResponse describeEvents(DescribeEventsRequest describeEventsRequest) throws AwsServiceException,
SdkClientException, DocDbException {
throw new UnsupportedOperationException();
}
/**
*
* 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 {@link DescribeEventsRequest.Builder} avoiding the need to
* create one manually via {@link DescribeEventsRequest#builder()}
*
*
* @param describeEventsRequest
* A {@link Consumer} that will call methods on {@link DescribeEventsMessage.Builder} to create a request.
* Represents the input to DescribeEvents.
* @return Result of the DescribeEvents operation returned by the service.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws DocDbException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample DocDbClient.DescribeEvents
* @see AWS API
* Documentation
*/
default DescribeEventsResponse describeEvents(Consumer describeEventsRequest)
throws AwsServiceException, SdkClientException, DocDbException {
return describeEvents(DescribeEventsRequest.builder().applyMutation(describeEventsRequest).build());
}
/**
*
* 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 {@link #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
*
*
* {@code
* 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
*
*
* {@code
* 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
* {@link #describeEvents(software.amazon.awssdk.services.docdb.model.DescribeEventsRequest)} operation.
*
*
* @return A custom iterable that can be used to iterate through all the response pages.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws DocDbException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample DocDbClient.DescribeEvents
* @see #describeEventsPaginator(DescribeEventsRequest)
* @see AWS API
* Documentation
*/
default DescribeEventsIterable describeEventsPaginator() throws AwsServiceException, SdkClientException, DocDbException {
return describeEventsPaginator(DescribeEventsRequest.builder().build());
}
/**
*
* 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 {@link #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
*
*
* {@code
* 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
*
*
* {@code
* 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
* {@link #describeEvents(software.amazon.awssdk.services.docdb.model.DescribeEventsRequest)} operation.
*
*
* @param describeEventsRequest
* Represents the input to DescribeEvents.
* @return A custom iterable that can be used to iterate through all the response pages.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws DocDbException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample DocDbClient.DescribeEvents
* @see AWS API
* Documentation
*/
default DescribeEventsIterable describeEventsPaginator(DescribeEventsRequest describeEventsRequest)
throws AwsServiceException, SdkClientException, DocDbException {
throw new UnsupportedOperationException();
}
/**
*
* 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 {@link #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
*
*
* {@code
* 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
*
*
* {@code
* 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
* {@link #describeEvents(software.amazon.awssdk.services.docdb.model.DescribeEventsRequest)} operation.
*
*
* This is a convenience which creates an instance of the {@link DescribeEventsRequest.Builder} avoiding the need to
* create one manually via {@link DescribeEventsRequest#builder()}
*
*
* @param describeEventsRequest
* A {@link Consumer} that will call methods on {@link DescribeEventsMessage.Builder} to create a request.
* Represents the input to DescribeEvents.
* @return A custom iterable that can be used to iterate through all the response pages.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws DocDbException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample DocDbClient.DescribeEvents
* @see AWS API
* Documentation
*/
default DescribeEventsIterable describeEventsPaginator(Consumer describeEventsRequest)
throws AwsServiceException, SdkClientException, DocDbException {
return describeEventsPaginator(DescribeEventsRequest.builder().applyMutation(describeEventsRequest).build());
}
/**
*
* Returns information about Amazon DocumentDB global clusters. This API supports pagination.
*
*
*
* This action only applies to Amazon DocumentDB clusters.
*
*
*
* @param describeGlobalClustersRequest
* @return Result of the DescribeGlobalClusters operation returned by the service.
* @throws GlobalClusterNotFoundException
* The GlobalClusterIdentifier doesn't refer to an existing global cluster.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws DocDbException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample DocDbClient.DescribeGlobalClusters
* @see AWS
* API Documentation
*/
default DescribeGlobalClustersResponse describeGlobalClusters(DescribeGlobalClustersRequest describeGlobalClustersRequest)
throws GlobalClusterNotFoundException, AwsServiceException, SdkClientException, DocDbException {
throw new UnsupportedOperationException();
}
/**
*
* 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 {@link DescribeGlobalClustersRequest.Builder} avoiding the
* need to create one manually via {@link DescribeGlobalClustersRequest#builder()}
*
*
* @param describeGlobalClustersRequest
* A {@link Consumer} that will call methods on {@link DescribeGlobalClustersMessage.Builder} to create a
* request.
* @return Result of the DescribeGlobalClusters operation returned by the service.
* @throws GlobalClusterNotFoundException
* The GlobalClusterIdentifier doesn't refer to an existing global cluster.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws DocDbException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample DocDbClient.DescribeGlobalClusters
* @see AWS
* API Documentation
*/
default DescribeGlobalClustersResponse describeGlobalClusters(
Consumer describeGlobalClustersRequest) throws GlobalClusterNotFoundException,
AwsServiceException, SdkClientException, DocDbException {
return describeGlobalClusters(DescribeGlobalClustersRequest.builder().applyMutation(describeGlobalClustersRequest)
.build());
}
/**
*
* Returns information about Amazon DocumentDB global clusters. This API supports pagination.
*
*
*
* This action only applies to Amazon DocumentDB clusters.
*
*
*
* This is a variant of
* {@link #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
*
*
* {@code
* 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
*
*
* {@code
* 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
* {@link #describeGlobalClusters(software.amazon.awssdk.services.docdb.model.DescribeGlobalClustersRequest)}
* operation.
*
*
* @param describeGlobalClustersRequest
* @return A custom iterable that can be used to iterate through all the response pages.
* @throws GlobalClusterNotFoundException
* The GlobalClusterIdentifier doesn't refer to an existing global cluster.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws DocDbException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample DocDbClient.DescribeGlobalClusters
* @see AWS
* API Documentation
*/
default DescribeGlobalClustersIterable describeGlobalClustersPaginator(
DescribeGlobalClustersRequest describeGlobalClustersRequest) throws GlobalClusterNotFoundException,
AwsServiceException, SdkClientException, DocDbException {
throw new UnsupportedOperationException();
}
/**
*
* Returns information about Amazon DocumentDB global clusters. This API supports pagination.
*
*
*
* This action only applies to Amazon DocumentDB clusters.
*
*
*
* This is a variant of
* {@link #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
*
*
* {@code
* 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
*
*
* {@code
* 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
* {@link #describeGlobalClusters(software.amazon.awssdk.services.docdb.model.DescribeGlobalClustersRequest)}
* operation.
*
*
* This is a convenience which creates an instance of the {@link DescribeGlobalClustersRequest.Builder} avoiding the
* need to create one manually via {@link DescribeGlobalClustersRequest#builder()}
*
*
* @param describeGlobalClustersRequest
* A {@link Consumer} that will call methods on {@link DescribeGlobalClustersMessage.Builder} to create a
* request.
* @return A custom iterable that can be used to iterate through all the response pages.
* @throws GlobalClusterNotFoundException
* The GlobalClusterIdentifier doesn't refer to an existing global cluster.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws DocDbException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample DocDbClient.DescribeGlobalClusters
* @see AWS
* API Documentation
*/
default DescribeGlobalClustersIterable describeGlobalClustersPaginator(
Consumer describeGlobalClustersRequest) throws GlobalClusterNotFoundException,
AwsServiceException, SdkClientException, DocDbException {
return describeGlobalClustersPaginator(DescribeGlobalClustersRequest.builder()
.applyMutation(describeGlobalClustersRequest).build());
}
/**
*
* Returns a list of orderable instance options for the specified engine.
*
*
* @param describeOrderableDbInstanceOptionsRequest
* Represents the input to DescribeOrderableDBInstanceOptions.
* @return Result of the DescribeOrderableDBInstanceOptions operation returned by the service.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws DocDbException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample DocDbClient.DescribeOrderableDBInstanceOptions
* @see AWS API Documentation
*/
default DescribeOrderableDbInstanceOptionsResponse describeOrderableDBInstanceOptions(
DescribeOrderableDbInstanceOptionsRequest describeOrderableDbInstanceOptionsRequest) throws AwsServiceException,
SdkClientException, DocDbException {
throw new UnsupportedOperationException();
}
/**
*
* Returns a list of orderable instance options for the specified engine.
*
*
*
* This is a convenience which creates an instance of the {@link DescribeOrderableDbInstanceOptionsRequest.Builder}
* avoiding the need to create one manually via {@link DescribeOrderableDbInstanceOptionsRequest#builder()}
*
*
* @param describeOrderableDbInstanceOptionsRequest
* A {@link Consumer} that will call methods on {@link DescribeOrderableDBInstanceOptionsMessage.Builder} to
* create a request. Represents the input to DescribeOrderableDBInstanceOptions.
* @return Result of the DescribeOrderableDBInstanceOptions operation returned by the service.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws DocDbException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample DocDbClient.DescribeOrderableDBInstanceOptions
* @see AWS API Documentation
*/
default DescribeOrderableDbInstanceOptionsResponse describeOrderableDBInstanceOptions(
Consumer describeOrderableDbInstanceOptionsRequest)
throws AwsServiceException, SdkClientException, DocDbException {
return describeOrderableDBInstanceOptions(DescribeOrderableDbInstanceOptionsRequest.builder()
.applyMutation(describeOrderableDbInstanceOptionsRequest).build());
}
/**
*
* Returns a list of orderable instance options for the specified engine.
*
*
*
* This is a variant of
* {@link #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
*
*
* {@code
* 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
*
*
* {@code
* 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
* {@link #describeOrderableDBInstanceOptions(software.amazon.awssdk.services.docdb.model.DescribeOrderableDbInstanceOptionsRequest)}
* operation.
*
*
* @param describeOrderableDbInstanceOptionsRequest
* Represents the input to DescribeOrderableDBInstanceOptions.
* @return A custom iterable that can be used to iterate through all the response pages.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws DocDbException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample DocDbClient.DescribeOrderableDBInstanceOptions
* @see AWS API Documentation
*/
default DescribeOrderableDBInstanceOptionsIterable describeOrderableDBInstanceOptionsPaginator(
DescribeOrderableDbInstanceOptionsRequest describeOrderableDbInstanceOptionsRequest) throws AwsServiceException,
SdkClientException, DocDbException {
throw new UnsupportedOperationException();
}
/**
*
* Returns a list of orderable instance options for the specified engine.
*
*
*
* This is a variant of
* {@link #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
*
*
* {@code
* 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
*
*
* {@code
* 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
* {@link #describeOrderableDBInstanceOptions(software.amazon.awssdk.services.docdb.model.DescribeOrderableDbInstanceOptionsRequest)}
* operation.
*
*
* This is a convenience which creates an instance of the {@link DescribeOrderableDbInstanceOptionsRequest.Builder}
* avoiding the need to create one manually via {@link DescribeOrderableDbInstanceOptionsRequest#builder()}
*
*
* @param describeOrderableDbInstanceOptionsRequest
* A {@link Consumer} that will call methods on {@link DescribeOrderableDBInstanceOptionsMessage.Builder} to
* create a request. Represents the input to DescribeOrderableDBInstanceOptions.
* @return A custom iterable that can be used to iterate through all the response pages.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws DocDbException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample DocDbClient.DescribeOrderableDBInstanceOptions
* @see AWS API Documentation
*/
default DescribeOrderableDBInstanceOptionsIterable describeOrderableDBInstanceOptionsPaginator(
Consumer describeOrderableDbInstanceOptionsRequest)
throws AwsServiceException, SdkClientException, DocDbException {
return describeOrderableDBInstanceOptionsPaginator(DescribeOrderableDbInstanceOptionsRequest.builder()
.applyMutation(describeOrderableDbInstanceOptionsRequest).build());
}
/**
*
* Returns a list of resources (for example, instances) that have at least one pending maintenance action.
*
*
* @return Result of the DescribePendingMaintenanceActions operation returned by the service.
* @throws ResourceNotFoundException
* The specified resource ID was not found.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws DocDbException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample DocDbClient.DescribePendingMaintenanceActions
* @see #describePendingMaintenanceActions(DescribePendingMaintenanceActionsRequest)
* @see AWS API Documentation
*/
default DescribePendingMaintenanceActionsResponse describePendingMaintenanceActions() throws ResourceNotFoundException,
AwsServiceException, SdkClientException, DocDbException {
return describePendingMaintenanceActions(DescribePendingMaintenanceActionsRequest.builder().build());
}
/**
*
* Returns a list of resources (for example, instances) that have at least one pending maintenance action.
*
*
* @param describePendingMaintenanceActionsRequest
* Represents the input to DescribePendingMaintenanceActions.
* @return Result of the DescribePendingMaintenanceActions operation returned by the service.
* @throws ResourceNotFoundException
* The specified resource ID was not found.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws DocDbException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample DocDbClient.DescribePendingMaintenanceActions
* @see AWS API Documentation
*/
default DescribePendingMaintenanceActionsResponse describePendingMaintenanceActions(
DescribePendingMaintenanceActionsRequest describePendingMaintenanceActionsRequest) throws ResourceNotFoundException,
AwsServiceException, SdkClientException, DocDbException {
throw new UnsupportedOperationException();
}
/**
*
* 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 {@link DescribePendingMaintenanceActionsRequest.Builder}
* avoiding the need to create one manually via {@link DescribePendingMaintenanceActionsRequest#builder()}
*
*
* @param describePendingMaintenanceActionsRequest
* A {@link Consumer} that will call methods on {@link DescribePendingMaintenanceActionsMessage.Builder} to
* create a request. Represents the input to DescribePendingMaintenanceActions.
* @return Result of the DescribePendingMaintenanceActions operation returned by the service.
* @throws ResourceNotFoundException
* The specified resource ID was not found.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws DocDbException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample DocDbClient.DescribePendingMaintenanceActions
* @see AWS API Documentation
*/
default DescribePendingMaintenanceActionsResponse describePendingMaintenanceActions(
Consumer describePendingMaintenanceActionsRequest)
throws ResourceNotFoundException, AwsServiceException, SdkClientException, DocDbException {
return describePendingMaintenanceActions(DescribePendingMaintenanceActionsRequest.builder()
.applyMutation(describePendingMaintenanceActionsRequest).build());
}
/**
*
* Returns a list of resources (for example, instances) that have at least one pending maintenance action.
*
*
*
* This is a variant of
* {@link #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
*
*
* {@code
* 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
*
*
* {@code
* 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
* {@link #describePendingMaintenanceActions(software.amazon.awssdk.services.docdb.model.DescribePendingMaintenanceActionsRequest)}
* operation.
*
*
* @return A custom iterable that can be used to iterate through all the response pages.
* @throws ResourceNotFoundException
* The specified resource ID was not found.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws DocDbException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample DocDbClient.DescribePendingMaintenanceActions
* @see #describePendingMaintenanceActionsPaginator(DescribePendingMaintenanceActionsRequest)
* @see AWS API Documentation
*/
default DescribePendingMaintenanceActionsIterable describePendingMaintenanceActionsPaginator()
throws ResourceNotFoundException, AwsServiceException, SdkClientException, DocDbException {
return describePendingMaintenanceActionsPaginator(DescribePendingMaintenanceActionsRequest.builder().build());
}
/**
*
* Returns a list of resources (for example, instances) that have at least one pending maintenance action.
*
*
*
* This is a variant of
* {@link #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
*
*
* {@code
* 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
*
*
* {@code
* 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
* {@link #describePendingMaintenanceActions(software.amazon.awssdk.services.docdb.model.DescribePendingMaintenanceActionsRequest)}
* operation.
*
*
* @param describePendingMaintenanceActionsRequest
* Represents the input to DescribePendingMaintenanceActions.
* @return A custom iterable that can be used to iterate through all the response pages.
* @throws ResourceNotFoundException
* The specified resource ID was not found.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws DocDbException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample DocDbClient.DescribePendingMaintenanceActions
* @see AWS API Documentation
*/
default DescribePendingMaintenanceActionsIterable describePendingMaintenanceActionsPaginator(
DescribePendingMaintenanceActionsRequest describePendingMaintenanceActionsRequest) throws ResourceNotFoundException,
AwsServiceException, SdkClientException, DocDbException {
throw new UnsupportedOperationException();
}
/**
*
* Returns a list of resources (for example, instances) that have at least one pending maintenance action.
*
*
*
* This is a variant of
* {@link #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
*
*
* {@code
* 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
*
*
* {@code
* 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
* {@link #describePendingMaintenanceActions(software.amazon.awssdk.services.docdb.model.DescribePendingMaintenanceActionsRequest)}
* operation.
*
*
* This is a convenience which creates an instance of the {@link DescribePendingMaintenanceActionsRequest.Builder}
* avoiding the need to create one manually via {@link DescribePendingMaintenanceActionsRequest#builder()}
*
*
* @param describePendingMaintenanceActionsRequest
* A {@link Consumer} that will call methods on {@link DescribePendingMaintenanceActionsMessage.Builder} to
* create a request. Represents the input to DescribePendingMaintenanceActions.
* @return A custom iterable that can be used to iterate through all the response pages.
* @throws ResourceNotFoundException
* The specified resource ID was not found.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws DocDbException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample DocDbClient.DescribePendingMaintenanceActions
* @see AWS API Documentation
*/
default DescribePendingMaintenanceActionsIterable describePendingMaintenanceActionsPaginator(
Consumer describePendingMaintenanceActionsRequest)
throws ResourceNotFoundException, AwsServiceException, SdkClientException, DocDbException {
return describePendingMaintenanceActionsPaginator(DescribePendingMaintenanceActionsRequest.builder()
.applyMutation(describePendingMaintenanceActionsRequest).build());
}
/**
*
* 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.
*
*
* @param failoverDbClusterRequest
* Represents the input to FailoverDBCluster.
* @return Result of the FailoverDBCluster operation returned by the service.
* @throws DbClusterNotFoundException
* DBClusterIdentifier doesn't refer to an existing cluster.
* @throws InvalidDbClusterStateException
* The cluster isn't in a valid state.
* @throws InvalidDbInstanceStateException
* The specified instance isn't in the available state.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws DocDbException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample DocDbClient.FailoverDBCluster
* @see AWS API
* Documentation
*/
default FailoverDbClusterResponse failoverDBCluster(FailoverDbClusterRequest failoverDbClusterRequest)
throws DbClusterNotFoundException, InvalidDbClusterStateException, InvalidDbInstanceStateException,
AwsServiceException, SdkClientException, DocDbException {
throw new UnsupportedOperationException();
}
/**
*
* 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 {@link FailoverDbClusterRequest.Builder} avoiding the need
* to create one manually via {@link FailoverDbClusterRequest#builder()}
*
*
* @param failoverDbClusterRequest
* A {@link Consumer} that will call methods on {@link FailoverDBClusterMessage.Builder} to create a request.
* Represents the input to FailoverDBCluster.
* @return Result of the FailoverDBCluster operation returned by the service.
* @throws DbClusterNotFoundException
* DBClusterIdentifier doesn't refer to an existing cluster.
* @throws InvalidDbClusterStateException
* The cluster isn't in a valid state.
* @throws InvalidDbInstanceStateException
* The specified instance isn't in the available state.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws DocDbException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample DocDbClient.FailoverDBCluster
* @see AWS API
* Documentation
*/
default FailoverDbClusterResponse failoverDBCluster(Consumer failoverDbClusterRequest)
throws DbClusterNotFoundException, InvalidDbClusterStateException, InvalidDbInstanceStateException,
AwsServiceException, SdkClientException, DocDbException {
return failoverDBCluster(FailoverDbClusterRequest.builder().applyMutation(failoverDbClusterRequest).build());
}
/**
*
* Lists all tags on an Amazon DocumentDB resource.
*
*
* @param listTagsForResourceRequest
* Represents the input to ListTagsForResource.
* @return Result of the ListTagsForResource operation returned by the service.
* @throws DbInstanceNotFoundException
* DBInstanceIdentifier doesn't refer to an existing instance.
* @throws DbSnapshotNotFoundException
* DBSnapshotIdentifier doesn't refer to an existing snapshot.
* @throws DbClusterNotFoundException
* DBClusterIdentifier doesn't refer to an existing cluster.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws DocDbException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample DocDbClient.ListTagsForResource
* @see AWS API
* Documentation
*/
default ListTagsForResourceResponse listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)
throws DbInstanceNotFoundException, DbSnapshotNotFoundException, DbClusterNotFoundException, AwsServiceException,
SdkClientException, DocDbException {
throw new UnsupportedOperationException();
}
/**
*
* Lists all tags on an Amazon DocumentDB resource.
*
*
*
* This is a convenience which creates an instance of the {@link ListTagsForResourceRequest.Builder} avoiding the
* need to create one manually via {@link ListTagsForResourceRequest#builder()}
*
*
* @param listTagsForResourceRequest
* A {@link Consumer} that will call methods on {@link ListTagsForResourceMessage.Builder} to create a
* request. Represents the input to ListTagsForResource.
* @return Result of the ListTagsForResource operation returned by the service.
* @throws DbInstanceNotFoundException
* DBInstanceIdentifier doesn't refer to an existing instance.
* @throws DbSnapshotNotFoundException
* DBSnapshotIdentifier doesn't refer to an existing snapshot.
* @throws DbClusterNotFoundException
* DBClusterIdentifier doesn't refer to an existing cluster.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws DocDbException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample DocDbClient.ListTagsForResource
* @see AWS API
* Documentation
*/
default ListTagsForResourceResponse listTagsForResource(
Consumer listTagsForResourceRequest) throws DbInstanceNotFoundException,
DbSnapshotNotFoundException, DbClusterNotFoundException, AwsServiceException, SdkClientException, DocDbException {
return listTagsForResource(ListTagsForResourceRequest.builder().applyMutation(listTagsForResourceRequest).build());
}
/**
*
* 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.
*
*
* @param modifyDbClusterRequest
* Represents the input to ModifyDBCluster.
* @return Result of the ModifyDBCluster operation returned by the service.
* @throws DbClusterNotFoundException
* DBClusterIdentifier doesn't refer to an existing cluster.
* @throws InvalidDbClusterStateException
* The cluster isn't in a valid state.
* @throws StorageQuotaExceededException
* The request would cause you to exceed the allowed amount of storage available across all instances.
* @throws DbSubnetGroupNotFoundException
* DBSubnetGroupName doesn't refer to an existing subnet group.
* @throws InvalidVpcNetworkStateException
* The subnet group doesn't cover all Availability Zones after it is created because of changes that were
* made.
* @throws InvalidDbSubnetGroupStateException
* The subnet group can't be deleted because it's in use.
* @throws InvalidSubnetException
* The requested subnet is not valid, or multiple subnets were requested that are not all in a common
* virtual private cloud (VPC).
* @throws DbClusterParameterGroupNotFoundException
* DBClusterParameterGroupName doesn't refer to an existing cluster parameter group.
* @throws InvalidDbSecurityGroupStateException
* The state of the security group doesn't allow deletion.
* @throws InvalidDbInstanceStateException
* The specified instance isn't in the available state.
* @throws DbClusterAlreadyExistsException
* You already have a cluster with the given identifier.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws DocDbException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample DocDbClient.ModifyDBCluster
* @see AWS API
* Documentation
*/
default ModifyDbClusterResponse modifyDBCluster(ModifyDbClusterRequest modifyDbClusterRequest)
throws DbClusterNotFoundException, InvalidDbClusterStateException, StorageQuotaExceededException,
DbSubnetGroupNotFoundException, InvalidVpcNetworkStateException, InvalidDbSubnetGroupStateException,
InvalidSubnetException, DbClusterParameterGroupNotFoundException, InvalidDbSecurityGroupStateException,
InvalidDbInstanceStateException, DbClusterAlreadyExistsException, AwsServiceException, SdkClientException,
DocDbException {
throw new UnsupportedOperationException();
}
/**
*
* 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 {@link ModifyDbClusterRequest.Builder} avoiding the need
* to create one manually via {@link ModifyDbClusterRequest#builder()}
*
*
* @param modifyDbClusterRequest
* A {@link Consumer} that will call methods on {@link ModifyDBClusterMessage.Builder} to create a request.
* Represents the input to ModifyDBCluster.
* @return Result of the ModifyDBCluster operation returned by the service.
* @throws DbClusterNotFoundException
* DBClusterIdentifier doesn't refer to an existing cluster.
* @throws InvalidDbClusterStateException
* The cluster isn't in a valid state.
* @throws StorageQuotaExceededException
* The request would cause you to exceed the allowed amount of storage available across all instances.
* @throws DbSubnetGroupNotFoundException
* DBSubnetGroupName doesn't refer to an existing subnet group.
* @throws InvalidVpcNetworkStateException
* The subnet group doesn't cover all Availability Zones after it is created because of changes that were
* made.
* @throws InvalidDbSubnetGroupStateException
* The subnet group can't be deleted because it's in use.
* @throws InvalidSubnetException
* The requested subnet is not valid, or multiple subnets were requested that are not all in a common
* virtual private cloud (VPC).
* @throws DbClusterParameterGroupNotFoundException
* DBClusterParameterGroupName doesn't refer to an existing cluster parameter group.
* @throws InvalidDbSecurityGroupStateException
* The state of the security group doesn't allow deletion.
* @throws InvalidDbInstanceStateException
* The specified instance isn't in the available state.
* @throws DbClusterAlreadyExistsException
* You already have a cluster with the given identifier.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws DocDbException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample DocDbClient.ModifyDBCluster
* @see AWS API
* Documentation
*/
default ModifyDbClusterResponse modifyDBCluster(Consumer modifyDbClusterRequest)
throws DbClusterNotFoundException, InvalidDbClusterStateException, StorageQuotaExceededException,
DbSubnetGroupNotFoundException, InvalidVpcNetworkStateException, InvalidDbSubnetGroupStateException,
InvalidSubnetException, DbClusterParameterGroupNotFoundException, InvalidDbSecurityGroupStateException,
InvalidDbInstanceStateException, DbClusterAlreadyExistsException, AwsServiceException, SdkClientException,
DocDbException {
return modifyDBCluster(ModifyDbClusterRequest.builder().applyMutation(modifyDbClusterRequest).build());
}
/**
*
* 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.
*
*
*
* @param modifyDbClusterParameterGroupRequest
* Represents the input to ModifyDBClusterParameterGroup.
* @return Result of the ModifyDBClusterParameterGroup operation returned by the service.
* @throws DbParameterGroupNotFoundException
* DBParameterGroupName doesn't refer to an existing parameter group.
* @throws 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.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws DocDbException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample DocDbClient.ModifyDBClusterParameterGroup
* @see AWS API Documentation
*/
default ModifyDbClusterParameterGroupResponse modifyDBClusterParameterGroup(
ModifyDbClusterParameterGroupRequest modifyDbClusterParameterGroupRequest) throws DbParameterGroupNotFoundException,
InvalidDbParameterGroupStateException, AwsServiceException, SdkClientException, DocDbException {
throw new UnsupportedOperationException();
}
/**
*
* 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 {@link ModifyDbClusterParameterGroupRequest.Builder}
* avoiding the need to create one manually via {@link ModifyDbClusterParameterGroupRequest#builder()}
*
*
* @param modifyDbClusterParameterGroupRequest
* A {@link Consumer} that will call methods on {@link ModifyDBClusterParameterGroupMessage.Builder} to
* create a request. Represents the input to ModifyDBClusterParameterGroup.
* @return Result of the ModifyDBClusterParameterGroup operation returned by the service.
* @throws DbParameterGroupNotFoundException
* DBParameterGroupName doesn't refer to an existing parameter group.
* @throws 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.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws DocDbException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample DocDbClient.ModifyDBClusterParameterGroup
* @see AWS API Documentation
*/
default ModifyDbClusterParameterGroupResponse modifyDBClusterParameterGroup(
Consumer modifyDbClusterParameterGroupRequest)
throws DbParameterGroupNotFoundException, InvalidDbParameterGroupStateException, AwsServiceException,
SdkClientException, DocDbException {
return modifyDBClusterParameterGroup(ModifyDbClusterParameterGroupRequest.builder()
.applyMutation(modifyDbClusterParameterGroupRequest).build());
}
/**
*
* 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.
*
*
* @param modifyDbClusterSnapshotAttributeRequest
* Represents the input to ModifyDBClusterSnapshotAttribute.
* @return Result of the ModifyDBClusterSnapshotAttribute operation returned by the service.
* @throws DbClusterSnapshotNotFoundException
* DBClusterSnapshotIdentifier doesn't refer to an existing cluster snapshot.
* @throws InvalidDbClusterSnapshotStateException
* The provided value isn't a valid cluster snapshot state.
* @throws SharedSnapshotQuotaExceededException
* You have exceeded the maximum number of accounts that you can share a manual DB snapshot with.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws DocDbException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample DocDbClient.ModifyDBClusterSnapshotAttribute
* @see AWS API Documentation
*/
default ModifyDbClusterSnapshotAttributeResponse modifyDBClusterSnapshotAttribute(
ModifyDbClusterSnapshotAttributeRequest modifyDbClusterSnapshotAttributeRequest)
throws DbClusterSnapshotNotFoundException, InvalidDbClusterSnapshotStateException,
SharedSnapshotQuotaExceededException, AwsServiceException, SdkClientException, DocDbException {
throw new UnsupportedOperationException();
}
/**
*
* 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 {@link ModifyDbClusterSnapshotAttributeRequest.Builder}
* avoiding the need to create one manually via {@link ModifyDbClusterSnapshotAttributeRequest#builder()}
*
*
* @param modifyDbClusterSnapshotAttributeRequest
* A {@link Consumer} that will call methods on {@link ModifyDBClusterSnapshotAttributeMessage.Builder} to
* create a request. Represents the input to ModifyDBClusterSnapshotAttribute.
* @return Result of the ModifyDBClusterSnapshotAttribute operation returned by the service.
* @throws DbClusterSnapshotNotFoundException
* DBClusterSnapshotIdentifier doesn't refer to an existing cluster snapshot.
* @throws InvalidDbClusterSnapshotStateException
* The provided value isn't a valid cluster snapshot state.
* @throws SharedSnapshotQuotaExceededException
* You have exceeded the maximum number of accounts that you can share a manual DB snapshot with.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws DocDbException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample DocDbClient.ModifyDBClusterSnapshotAttribute
* @see AWS API Documentation
*/
default ModifyDbClusterSnapshotAttributeResponse modifyDBClusterSnapshotAttribute(
Consumer modifyDbClusterSnapshotAttributeRequest)
throws DbClusterSnapshotNotFoundException, InvalidDbClusterSnapshotStateException,
SharedSnapshotQuotaExceededException, AwsServiceException, SdkClientException, DocDbException {
return modifyDBClusterSnapshotAttribute(ModifyDbClusterSnapshotAttributeRequest.builder()
.applyMutation(modifyDbClusterSnapshotAttributeRequest).build());
}
/**
*
* 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.
*
*
* @param modifyDbInstanceRequest
* Represents the input to ModifyDBInstance.
* @return Result of the ModifyDBInstance operation returned by the service.
* @throws InvalidDbInstanceStateException
* The specified instance isn't in the available state.
* @throws InvalidDbSecurityGroupStateException
* The state of the security group doesn't allow deletion.
* @throws DbInstanceAlreadyExistsException
* You already have a instance with the given identifier.
* @throws DbInstanceNotFoundException
* DBInstanceIdentifier doesn't refer to an existing instance.
* @throws DbSecurityGroupNotFoundException
* DBSecurityGroupName doesn't refer to an existing security group.
* @throws DbParameterGroupNotFoundException
* DBParameterGroupName doesn't refer to an existing parameter group.
* @throws InsufficientDbInstanceCapacityException
* The specified instance class isn't available in the specified Availability Zone.
* @throws StorageQuotaExceededException
* The request would cause you to exceed the allowed amount of storage available across all instances.
* @throws InvalidVpcNetworkStateException
* The subnet group doesn't cover all Availability Zones after it is created because of changes that were
* made.
* @throws DbUpgradeDependencyFailureException
* The upgrade failed because a resource that the depends on can't be modified.
* @throws StorageTypeNotSupportedException
* Storage of the specified StorageType can't be associated with the DB instance.
* @throws 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.
* @throws CertificateNotFoundException
* CertificateIdentifier doesn't refer to an existing certificate.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws DocDbException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample DocDbClient.ModifyDBInstance
* @see AWS API
* Documentation
*/
default ModifyDbInstanceResponse modifyDBInstance(ModifyDbInstanceRequest modifyDbInstanceRequest)
throws InvalidDbInstanceStateException, InvalidDbSecurityGroupStateException, DbInstanceAlreadyExistsException,
DbInstanceNotFoundException, DbSecurityGroupNotFoundException, DbParameterGroupNotFoundException,
InsufficientDbInstanceCapacityException, StorageQuotaExceededException, InvalidVpcNetworkStateException,
DbUpgradeDependencyFailureException, StorageTypeNotSupportedException, AuthorizationNotFoundException,
CertificateNotFoundException, AwsServiceException, SdkClientException, DocDbException {
throw new UnsupportedOperationException();
}
/**
*
* 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 {@link ModifyDbInstanceRequest.Builder} avoiding the need
* to create one manually via {@link ModifyDbInstanceRequest#builder()}
*
*
* @param modifyDbInstanceRequest
* A {@link Consumer} that will call methods on {@link ModifyDBInstanceMessage.Builder} to create a request.
* Represents the input to ModifyDBInstance.
* @return Result of the ModifyDBInstance operation returned by the service.
* @throws InvalidDbInstanceStateException
* The specified instance isn't in the available state.
* @throws InvalidDbSecurityGroupStateException
* The state of the security group doesn't allow deletion.
* @throws DbInstanceAlreadyExistsException
* You already have a instance with the given identifier.
* @throws DbInstanceNotFoundException
* DBInstanceIdentifier doesn't refer to an existing instance.
* @throws DbSecurityGroupNotFoundException
* DBSecurityGroupName doesn't refer to an existing security group.
* @throws DbParameterGroupNotFoundException
* DBParameterGroupName doesn't refer to an existing parameter group.
* @throws InsufficientDbInstanceCapacityException
* The specified instance class isn't available in the specified Availability Zone.
* @throws StorageQuotaExceededException
* The request would cause you to exceed the allowed amount of storage available across all instances.
* @throws InvalidVpcNetworkStateException
* The subnet group doesn't cover all Availability Zones after it is created because of changes that were
* made.
* @throws DbUpgradeDependencyFailureException
* The upgrade failed because a resource that the depends on can't be modified.
* @throws StorageTypeNotSupportedException
* Storage of the specified StorageType can't be associated with the DB instance.
* @throws 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.
* @throws CertificateNotFoundException
* CertificateIdentifier doesn't refer to an existing certificate.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws DocDbException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample DocDbClient.ModifyDBInstance
* @see AWS API
* Documentation
*/
default ModifyDbInstanceResponse modifyDBInstance(Consumer modifyDbInstanceRequest)
throws InvalidDbInstanceStateException, InvalidDbSecurityGroupStateException, DbInstanceAlreadyExistsException,
DbInstanceNotFoundException, DbSecurityGroupNotFoundException, DbParameterGroupNotFoundException,
InsufficientDbInstanceCapacityException, StorageQuotaExceededException, InvalidVpcNetworkStateException,
DbUpgradeDependencyFailureException, StorageTypeNotSupportedException, AuthorizationNotFoundException,
CertificateNotFoundException, AwsServiceException, SdkClientException, DocDbException {
return modifyDBInstance(ModifyDbInstanceRequest.builder().applyMutation(modifyDbInstanceRequest).build());
}
/**
*
* 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.
*
*
* @param modifyDbSubnetGroupRequest
* Represents the input to ModifyDBSubnetGroup.
* @return Result of the ModifyDBSubnetGroup operation returned by the service.
* @throws DbSubnetGroupNotFoundException
* DBSubnetGroupName doesn't refer to an existing subnet group.
* @throws DbSubnetQuotaExceededException
* The request would cause you to exceed the allowed number of subnets in a subnet group.
* @throws SubnetAlreadyInUseException
* The subnet is already in use in the Availability Zone.
* @throws DbSubnetGroupDoesNotCoverEnoughAZsException
* Subnets in the subnet group should cover at least two Availability Zones unless there is only one
* Availability Zone.
* @throws InvalidSubnetException
* The requested subnet is not valid, or multiple subnets were requested that are not all in a common
* virtual private cloud (VPC).
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws DocDbException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample DocDbClient.ModifyDBSubnetGroup
* @see AWS API
* Documentation
*/
default ModifyDbSubnetGroupResponse modifyDBSubnetGroup(ModifyDbSubnetGroupRequest modifyDbSubnetGroupRequest)
throws DbSubnetGroupNotFoundException, DbSubnetQuotaExceededException, SubnetAlreadyInUseException,
DbSubnetGroupDoesNotCoverEnoughAZsException, InvalidSubnetException, AwsServiceException, SdkClientException,
DocDbException {
throw new UnsupportedOperationException();
}
/**
*
* 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 {@link ModifyDbSubnetGroupRequest.Builder} avoiding the
* need to create one manually via {@link ModifyDbSubnetGroupRequest#builder()}
*
*
* @param modifyDbSubnetGroupRequest
* A {@link Consumer} that will call methods on {@link ModifyDBSubnetGroupMessage.Builder} to create a
* request. Represents the input to ModifyDBSubnetGroup.
* @return Result of the ModifyDBSubnetGroup operation returned by the service.
* @throws DbSubnetGroupNotFoundException
* DBSubnetGroupName doesn't refer to an existing subnet group.
* @throws DbSubnetQuotaExceededException
* The request would cause you to exceed the allowed number of subnets in a subnet group.
* @throws SubnetAlreadyInUseException
* The subnet is already in use in the Availability Zone.
* @throws DbSubnetGroupDoesNotCoverEnoughAZsException
* Subnets in the subnet group should cover at least two Availability Zones unless there is only one
* Availability Zone.
* @throws InvalidSubnetException
* The requested subnet is not valid, or multiple subnets were requested that are not all in a common
* virtual private cloud (VPC).
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws DocDbException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample DocDbClient.ModifyDBSubnetGroup
* @see AWS API
* Documentation
*/
default ModifyDbSubnetGroupResponse modifyDBSubnetGroup(
Consumer modifyDbSubnetGroupRequest) throws DbSubnetGroupNotFoundException,
DbSubnetQuotaExceededException, SubnetAlreadyInUseException, DbSubnetGroupDoesNotCoverEnoughAZsException,
InvalidSubnetException, AwsServiceException, SdkClientException, DocDbException {
return modifyDBSubnetGroup(ModifyDbSubnetGroupRequest.builder().applyMutation(modifyDbSubnetGroupRequest).build());
}
/**
*
* Modifies an existing Amazon DocumentDB event notification subscription.
*
*
* @param modifyEventSubscriptionRequest
* Represents the input to ModifyEventSubscription.
* @return Result of the ModifyEventSubscription operation returned by the service.
* @throws EventSubscriptionQuotaExceededException
* You have reached the maximum number of event subscriptions.
* @throws SubscriptionNotFoundException
* The subscription name does not exist.
* @throws SnsInvalidTopicException
* Amazon SNS has responded that there is a problem with the specified topic.
* @throws SnsNoAuthorizationException
* You do not have permission to publish to the SNS topic Amazon Resource Name (ARN).
* @throws SnsTopicArnNotFoundException
* The SNS topic Amazon Resource Name (ARN) does not exist.
* @throws SubscriptionCategoryNotFoundException
* The provided category does not exist.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws DocDbException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample DocDbClient.ModifyEventSubscription
* @see AWS
* API Documentation
*/
default ModifyEventSubscriptionResponse modifyEventSubscription(ModifyEventSubscriptionRequest modifyEventSubscriptionRequest)
throws EventSubscriptionQuotaExceededException, SubscriptionNotFoundException, SnsInvalidTopicException,
SnsNoAuthorizationException, SnsTopicArnNotFoundException, SubscriptionCategoryNotFoundException,
AwsServiceException, SdkClientException, DocDbException {
throw new UnsupportedOperationException();
}
/**
*
* Modifies an existing Amazon DocumentDB event notification subscription.
*
*
*
* This is a convenience which creates an instance of the {@link ModifyEventSubscriptionRequest.Builder} avoiding
* the need to create one manually via {@link ModifyEventSubscriptionRequest#builder()}
*
*
* @param modifyEventSubscriptionRequest
* A {@link Consumer} that will call methods on {@link ModifyEventSubscriptionMessage.Builder} to create a
* request. Represents the input to ModifyEventSubscription.
* @return Result of the ModifyEventSubscription operation returned by the service.
* @throws EventSubscriptionQuotaExceededException
* You have reached the maximum number of event subscriptions.
* @throws SubscriptionNotFoundException
* The subscription name does not exist.
* @throws SnsInvalidTopicException
* Amazon SNS has responded that there is a problem with the specified topic.
* @throws SnsNoAuthorizationException
* You do not have permission to publish to the SNS topic Amazon Resource Name (ARN).
* @throws SnsTopicArnNotFoundException
* The SNS topic Amazon Resource Name (ARN) does not exist.
* @throws SubscriptionCategoryNotFoundException
* The provided category does not exist.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws DocDbException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample DocDbClient.ModifyEventSubscription
* @see AWS
* API Documentation
*/
default ModifyEventSubscriptionResponse modifyEventSubscription(
Consumer modifyEventSubscriptionRequest)
throws EventSubscriptionQuotaExceededException, SubscriptionNotFoundException, SnsInvalidTopicException,
SnsNoAuthorizationException, SnsTopicArnNotFoundException, SubscriptionCategoryNotFoundException,
AwsServiceException, SdkClientException, DocDbException {
return modifyEventSubscription(ModifyEventSubscriptionRequest.builder().applyMutation(modifyEventSubscriptionRequest)
.build());
}
/**
*
* 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.
*
*
*
* @param modifyGlobalClusterRequest
* Represents the input to ModifyGlobalCluster.
* @return Result of the ModifyGlobalCluster operation returned by the service.
* @throws GlobalClusterNotFoundException
* The GlobalClusterIdentifier doesn't refer to an existing global cluster.
* @throws InvalidGlobalClusterStateException
* The requested operation can't be performed while the cluster is in this state.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws DocDbException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample DocDbClient.ModifyGlobalCluster
* @see AWS API
* Documentation
*/
default ModifyGlobalClusterResponse modifyGlobalCluster(ModifyGlobalClusterRequest modifyGlobalClusterRequest)
throws GlobalClusterNotFoundException, InvalidGlobalClusterStateException, AwsServiceException, SdkClientException,
DocDbException {
throw new UnsupportedOperationException();
}
/**
*
* 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 {@link ModifyGlobalClusterRequest.Builder} avoiding the
* need to create one manually via {@link ModifyGlobalClusterRequest#builder()}
*
*
* @param modifyGlobalClusterRequest
* A {@link Consumer} that will call methods on {@link ModifyGlobalClusterMessage.Builder} to create a
* request. Represents the input to ModifyGlobalCluster.
* @return Result of the ModifyGlobalCluster operation returned by the service.
* @throws GlobalClusterNotFoundException
* The GlobalClusterIdentifier doesn't refer to an existing global cluster.
* @throws InvalidGlobalClusterStateException
* The requested operation can't be performed while the cluster is in this state.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws DocDbException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample DocDbClient.ModifyGlobalCluster
* @see AWS API
* Documentation
*/
default ModifyGlobalClusterResponse modifyGlobalCluster(
Consumer modifyGlobalClusterRequest) throws GlobalClusterNotFoundException,
InvalidGlobalClusterStateException, AwsServiceException, SdkClientException, DocDbException {
return modifyGlobalCluster(ModifyGlobalClusterRequest.builder().applyMutation(modifyGlobalClusterRequest).build());
}
/**
*
* 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.
*
*
* @param rebootDbInstanceRequest
* Represents the input to RebootDBInstance.
* @return Result of the RebootDBInstance operation returned by the service.
* @throws InvalidDbInstanceStateException
* The specified instance isn't in the available state.
* @throws DbInstanceNotFoundException
* DBInstanceIdentifier doesn't refer to an existing instance.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws DocDbException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample DocDbClient.RebootDBInstance
* @see AWS API
* Documentation
*/
default RebootDbInstanceResponse rebootDBInstance(RebootDbInstanceRequest rebootDbInstanceRequest)
throws InvalidDbInstanceStateException, DbInstanceNotFoundException, AwsServiceException, SdkClientException,
DocDbException {
throw new UnsupportedOperationException();
}
/**
*
* 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 {@link RebootDbInstanceRequest.Builder} avoiding the need
* to create one manually via {@link RebootDbInstanceRequest#builder()}
*
*
* @param rebootDbInstanceRequest
* A {@link Consumer} that will call methods on {@link RebootDBInstanceMessage.Builder} to create a request.
* Represents the input to RebootDBInstance.
* @return Result of the RebootDBInstance operation returned by the service.
* @throws InvalidDbInstanceStateException
* The specified instance isn't in the available state.
* @throws DbInstanceNotFoundException
* DBInstanceIdentifier doesn't refer to an existing instance.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws DocDbException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample DocDbClient.RebootDBInstance
* @see AWS API
* Documentation
*/
default RebootDbInstanceResponse rebootDBInstance(Consumer rebootDbInstanceRequest)
throws InvalidDbInstanceStateException, DbInstanceNotFoundException, AwsServiceException, SdkClientException,
DocDbException {
return rebootDBInstance(RebootDbInstanceRequest.builder().applyMutation(rebootDbInstanceRequest).build());
}
/**
*
* 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.
*
*
*
* @param removeFromGlobalClusterRequest
* Represents the input to RemoveFromGlobalCluster.
* @return Result of the RemoveFromGlobalCluster operation returned by the service.
* @throws GlobalClusterNotFoundException
* The GlobalClusterIdentifier doesn't refer to an existing global cluster.
* @throws InvalidGlobalClusterStateException
* The requested operation can't be performed while the cluster is in this state.
* @throws DbClusterNotFoundException
* DBClusterIdentifier doesn't refer to an existing cluster.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws DocDbException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample DocDbClient.RemoveFromGlobalCluster
* @see AWS
* API Documentation
*/
default RemoveFromGlobalClusterResponse removeFromGlobalCluster(RemoveFromGlobalClusterRequest removeFromGlobalClusterRequest)
throws GlobalClusterNotFoundException, InvalidGlobalClusterStateException, DbClusterNotFoundException,
AwsServiceException, SdkClientException, DocDbException {
throw new UnsupportedOperationException();
}
/**
*
* 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 {@link RemoveFromGlobalClusterRequest.Builder} avoiding
* the need to create one manually via {@link RemoveFromGlobalClusterRequest#builder()}
*
*
* @param removeFromGlobalClusterRequest
* A {@link Consumer} that will call methods on {@link RemoveFromGlobalClusterMessage.Builder} to create a
* request. Represents the input to RemoveFromGlobalCluster.
* @return Result of the RemoveFromGlobalCluster operation returned by the service.
* @throws GlobalClusterNotFoundException
* The GlobalClusterIdentifier doesn't refer to an existing global cluster.
* @throws InvalidGlobalClusterStateException
* The requested operation can't be performed while the cluster is in this state.
* @throws DbClusterNotFoundException
* DBClusterIdentifier doesn't refer to an existing cluster.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws DocDbException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample DocDbClient.RemoveFromGlobalCluster
* @see AWS
* API Documentation
*/
default RemoveFromGlobalClusterResponse removeFromGlobalCluster(
Consumer removeFromGlobalClusterRequest)
throws GlobalClusterNotFoundException, InvalidGlobalClusterStateException, DbClusterNotFoundException,
AwsServiceException, SdkClientException, DocDbException {
return removeFromGlobalCluster(RemoveFromGlobalClusterRequest.builder().applyMutation(removeFromGlobalClusterRequest)
.build());
}
/**
*
* Removes a source identifier from an existing Amazon DocumentDB event notification subscription.
*
*
* @param removeSourceIdentifierFromSubscriptionRequest
* Represents the input to RemoveSourceIdentifierFromSubscription.
* @return Result of the RemoveSourceIdentifierFromSubscription operation returned by the service.
* @throws SubscriptionNotFoundException
* The subscription name does not exist.
* @throws SourceNotFoundException
* The requested source could not be found.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws DocDbException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample DocDbClient.RemoveSourceIdentifierFromSubscription
* @see AWS API Documentation
*/
default RemoveSourceIdentifierFromSubscriptionResponse removeSourceIdentifierFromSubscription(
RemoveSourceIdentifierFromSubscriptionRequest removeSourceIdentifierFromSubscriptionRequest)
throws SubscriptionNotFoundException, SourceNotFoundException, AwsServiceException, SdkClientException,
DocDbException {
throw new UnsupportedOperationException();
}
/**
*
* Removes a source identifier from an existing Amazon DocumentDB event notification subscription.
*
*
*
* This is a convenience which creates an instance of the
* {@link RemoveSourceIdentifierFromSubscriptionRequest.Builder} avoiding the need to create one manually via
* {@link RemoveSourceIdentifierFromSubscriptionRequest#builder()}
*
*
* @param removeSourceIdentifierFromSubscriptionRequest
* A {@link Consumer} that will call methods on {@link RemoveSourceIdentifierFromSubscriptionMessage.Builder}
* to create a request. Represents the input to RemoveSourceIdentifierFromSubscription.
* @return Result of the RemoveSourceIdentifierFromSubscription operation returned by the service.
* @throws SubscriptionNotFoundException
* The subscription name does not exist.
* @throws SourceNotFoundException
* The requested source could not be found.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws DocDbException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample DocDbClient.RemoveSourceIdentifierFromSubscription
* @see AWS API Documentation
*/
default RemoveSourceIdentifierFromSubscriptionResponse removeSourceIdentifierFromSubscription(
Consumer removeSourceIdentifierFromSubscriptionRequest)
throws SubscriptionNotFoundException, SourceNotFoundException, AwsServiceException, SdkClientException,
DocDbException {
return removeSourceIdentifierFromSubscription(RemoveSourceIdentifierFromSubscriptionRequest.builder()
.applyMutation(removeSourceIdentifierFromSubscriptionRequest).build());
}
/**
*
* Removes metadata tags from an Amazon DocumentDB resource.
*
*
* @param removeTagsFromResourceRequest
* Represents the input to RemoveTagsFromResource.
* @return Result of the RemoveTagsFromResource operation returned by the service.
* @throws DbInstanceNotFoundException
* DBInstanceIdentifier doesn't refer to an existing instance.
* @throws DbSnapshotNotFoundException
* DBSnapshotIdentifier doesn't refer to an existing snapshot.
* @throws DbClusterNotFoundException
* DBClusterIdentifier doesn't refer to an existing cluster.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws DocDbException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample DocDbClient.RemoveTagsFromResource
* @see AWS
* API Documentation
*/
default RemoveTagsFromResourceResponse removeTagsFromResource(RemoveTagsFromResourceRequest removeTagsFromResourceRequest)
throws DbInstanceNotFoundException, DbSnapshotNotFoundException, DbClusterNotFoundException, AwsServiceException,
SdkClientException, DocDbException {
throw new UnsupportedOperationException();
}
/**
*
* Removes metadata tags from an Amazon DocumentDB resource.
*
*
*
* This is a convenience which creates an instance of the {@link RemoveTagsFromResourceRequest.Builder} avoiding the
* need to create one manually via {@link RemoveTagsFromResourceRequest#builder()}
*
*
* @param removeTagsFromResourceRequest
* A {@link Consumer} that will call methods on {@link RemoveTagsFromResourceMessage.Builder} to create a
* request. Represents the input to RemoveTagsFromResource.
* @return Result of the RemoveTagsFromResource operation returned by the service.
* @throws DbInstanceNotFoundException
* DBInstanceIdentifier doesn't refer to an existing instance.
* @throws DbSnapshotNotFoundException
* DBSnapshotIdentifier doesn't refer to an existing snapshot.
* @throws DbClusterNotFoundException
* DBClusterIdentifier doesn't refer to an existing cluster.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws DocDbException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample DocDbClient.RemoveTagsFromResource
* @see AWS
* API Documentation
*/
default RemoveTagsFromResourceResponse removeTagsFromResource(
Consumer removeTagsFromResourceRequest) throws DbInstanceNotFoundException,
DbSnapshotNotFoundException, DbClusterNotFoundException, AwsServiceException, SdkClientException, DocDbException {
return removeTagsFromResource(RemoveTagsFromResourceRequest.builder().applyMutation(removeTagsFromResourceRequest)
.build());
}
/**
*
* 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.
*
*
* @param resetDbClusterParameterGroupRequest
* Represents the input to ResetDBClusterParameterGroup.
* @return Result of the ResetDBClusterParameterGroup operation returned by the service.
* @throws 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.
* @throws DbParameterGroupNotFoundException
* DBParameterGroupName doesn't refer to an existing parameter group.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws DocDbException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample DocDbClient.ResetDBClusterParameterGroup
* @see AWS API Documentation
*/
default ResetDbClusterParameterGroupResponse resetDBClusterParameterGroup(
ResetDbClusterParameterGroupRequest resetDbClusterParameterGroupRequest)
throws InvalidDbParameterGroupStateException, DbParameterGroupNotFoundException, AwsServiceException,
SdkClientException, DocDbException {
throw new UnsupportedOperationException();
}
/**
*
* 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 {@link ResetDbClusterParameterGroupRequest.Builder}
* avoiding the need to create one manually via {@link ResetDbClusterParameterGroupRequest#builder()}
*
*
* @param resetDbClusterParameterGroupRequest
* A {@link Consumer} that will call methods on {@link ResetDBClusterParameterGroupMessage.Builder} to create
* a request. Represents the input to ResetDBClusterParameterGroup.
* @return Result of the ResetDBClusterParameterGroup operation returned by the service.
* @throws 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.
* @throws DbParameterGroupNotFoundException
* DBParameterGroupName doesn't refer to an existing parameter group.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws DocDbException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample DocDbClient.ResetDBClusterParameterGroup
* @see AWS API Documentation
*/
default ResetDbClusterParameterGroupResponse resetDBClusterParameterGroup(
Consumer resetDbClusterParameterGroupRequest)
throws InvalidDbParameterGroupStateException, DbParameterGroupNotFoundException, AwsServiceException,
SdkClientException, DocDbException {
return resetDBClusterParameterGroup(ResetDbClusterParameterGroupRequest.builder()
.applyMutation(resetDbClusterParameterGroupRequest).build());
}
/**
*
* 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.
*
*
* @param restoreDbClusterFromSnapshotRequest
* Represents the input to RestoreDBClusterFromSnapshot.
* @return Result of the RestoreDBClusterFromSnapshot operation returned by the service.
* @throws DbClusterAlreadyExistsException
* You already have a cluster with the given identifier.
* @throws DbClusterQuotaExceededException
* The cluster can't be created because you have reached the maximum allowed quota of clusters.
* @throws StorageQuotaExceededException
* The request would cause you to exceed the allowed amount of storage available across all instances.
* @throws DbSubnetGroupNotFoundException
* DBSubnetGroupName doesn't refer to an existing subnet group.
* @throws DbSnapshotNotFoundException
* DBSnapshotIdentifier doesn't refer to an existing snapshot.
* @throws DbClusterSnapshotNotFoundException
* DBClusterSnapshotIdentifier doesn't refer to an existing cluster snapshot.
* @throws InsufficientDbClusterCapacityException
* The cluster doesn't have enough capacity for the current operation.
* @throws 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.
* @throws InvalidDbSnapshotStateException
* The state of the snapshot doesn't allow deletion.
* @throws InvalidDbClusterSnapshotStateException
* The provided value isn't a valid cluster snapshot state.
* @throws StorageQuotaExceededException
* The request would cause you to exceed the allowed amount of storage available across all instances.
* @throws InvalidVpcNetworkStateException
* The subnet group doesn't cover all Availability Zones after it is created because of changes that were
* made.
* @throws InvalidRestoreException
* You cannot restore from a virtual private cloud (VPC) backup to a non-VPC DB instance.
* @throws DbSubnetGroupNotFoundException
* DBSubnetGroupName doesn't refer to an existing subnet group.
* @throws InvalidSubnetException
* The requested subnet is not valid, or multiple subnets were requested that are not all in a common
* virtual private cloud (VPC).
* @throws KmsKeyNotAccessibleException
* An error occurred when accessing an KMS key.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws DocDbException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample DocDbClient.RestoreDBClusterFromSnapshot
* @see AWS API Documentation
*/
default RestoreDbClusterFromSnapshotResponse restoreDBClusterFromSnapshot(
RestoreDbClusterFromSnapshotRequest restoreDbClusterFromSnapshotRequest) throws DbClusterAlreadyExistsException,
DbClusterQuotaExceededException, StorageQuotaExceededException, DbSubnetGroupNotFoundException,
DbSnapshotNotFoundException, DbClusterSnapshotNotFoundException, InsufficientDbClusterCapacityException,
InsufficientStorageClusterCapacityException, InvalidDbSnapshotStateException, InvalidDbClusterSnapshotStateException,
InvalidVpcNetworkStateException, InvalidRestoreException, InvalidSubnetException, KmsKeyNotAccessibleException,
AwsServiceException, SdkClientException, DocDbException {
throw new UnsupportedOperationException();
}
/**
*
* 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 {@link RestoreDbClusterFromSnapshotRequest.Builder}
* avoiding the need to create one manually via {@link RestoreDbClusterFromSnapshotRequest#builder()}
*
*
* @param restoreDbClusterFromSnapshotRequest
* A {@link Consumer} that will call methods on {@link RestoreDBClusterFromSnapshotMessage.Builder} to create
* a request. Represents the input to RestoreDBClusterFromSnapshot.
* @return Result of the RestoreDBClusterFromSnapshot operation returned by the service.
* @throws DbClusterAlreadyExistsException
* You already have a cluster with the given identifier.
* @throws DbClusterQuotaExceededException
* The cluster can't be created because you have reached the maximum allowed quota of clusters.
* @throws StorageQuotaExceededException
* The request would cause you to exceed the allowed amount of storage available across all instances.
* @throws DbSubnetGroupNotFoundException
* DBSubnetGroupName doesn't refer to an existing subnet group.
* @throws DbSnapshotNotFoundException
* DBSnapshotIdentifier doesn't refer to an existing snapshot.
* @throws DbClusterSnapshotNotFoundException
* DBClusterSnapshotIdentifier doesn't refer to an existing cluster snapshot.
* @throws InsufficientDbClusterCapacityException
* The cluster doesn't have enough capacity for the current operation.
* @throws 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.
* @throws InvalidDbSnapshotStateException
* The state of the snapshot doesn't allow deletion.
* @throws InvalidDbClusterSnapshotStateException
* The provided value isn't a valid cluster snapshot state.
* @throws StorageQuotaExceededException
* The request would cause you to exceed the allowed amount of storage available across all instances.
* @throws InvalidVpcNetworkStateException
* The subnet group doesn't cover all Availability Zones after it is created because of changes that were
* made.
* @throws InvalidRestoreException
* You cannot restore from a virtual private cloud (VPC) backup to a non-VPC DB instance.
* @throws DbSubnetGroupNotFoundException
* DBSubnetGroupName doesn't refer to an existing subnet group.
* @throws InvalidSubnetException
* The requested subnet is not valid, or multiple subnets were requested that are not all in a common
* virtual private cloud (VPC).
* @throws KmsKeyNotAccessibleException
* An error occurred when accessing an KMS key.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws DocDbException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample DocDbClient.RestoreDBClusterFromSnapshot
* @see AWS API Documentation
*/
default RestoreDbClusterFromSnapshotResponse restoreDBClusterFromSnapshot(
Consumer restoreDbClusterFromSnapshotRequest)
throws DbClusterAlreadyExistsException, DbClusterQuotaExceededException, StorageQuotaExceededException,
DbSubnetGroupNotFoundException, DbSnapshotNotFoundException, DbClusterSnapshotNotFoundException,
InsufficientDbClusterCapacityException, InsufficientStorageClusterCapacityException, InvalidDbSnapshotStateException,
InvalidDbClusterSnapshotStateException, InvalidVpcNetworkStateException, InvalidRestoreException,
InvalidSubnetException, KmsKeyNotAccessibleException, AwsServiceException, SdkClientException, DocDbException {
return restoreDBClusterFromSnapshot(RestoreDbClusterFromSnapshotRequest.builder()
.applyMutation(restoreDbClusterFromSnapshotRequest).build());
}
/**
*
* 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.
*
*
* @param restoreDbClusterToPointInTimeRequest
* Represents the input to RestoreDBClusterToPointInTime.
* @return Result of the RestoreDBClusterToPointInTime operation returned by the service.
* @throws DbClusterAlreadyExistsException
* You already have a cluster with the given identifier.
* @throws DbClusterNotFoundException
* DBClusterIdentifier doesn't refer to an existing cluster.
* @throws DbClusterQuotaExceededException
* The cluster can't be created because you have reached the maximum allowed quota of clusters.
* @throws DbClusterSnapshotNotFoundException
* DBClusterSnapshotIdentifier doesn't refer to an existing cluster snapshot.
* @throws DbSubnetGroupNotFoundException
* DBSubnetGroupName doesn't refer to an existing subnet group.
* @throws InsufficientDbClusterCapacityException
* The cluster doesn't have enough capacity for the current operation.
* @throws 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.
* @throws InvalidDbClusterSnapshotStateException
* The provided value isn't a valid cluster snapshot state.
* @throws InvalidDbClusterStateException
* The cluster isn't in a valid state.
* @throws InvalidDbSnapshotStateException
* The state of the snapshot doesn't allow deletion.
* @throws InvalidRestoreException
* You cannot restore from a virtual private cloud (VPC) backup to a non-VPC DB instance.
* @throws InvalidSubnetException
* The requested subnet is not valid, or multiple subnets were requested that are not all in a common
* virtual private cloud (VPC).
* @throws InvalidVpcNetworkStateException
* The subnet group doesn't cover all Availability Zones after it is created because of changes that were
* made.
* @throws KmsKeyNotAccessibleException
* An error occurred when accessing an KMS key.
* @throws StorageQuotaExceededException
* The request would cause you to exceed the allowed amount of storage available across all instances.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws DocDbException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample DocDbClient.RestoreDBClusterToPointInTime
* @see AWS API Documentation
*/
default RestoreDbClusterToPointInTimeResponse restoreDBClusterToPointInTime(
RestoreDbClusterToPointInTimeRequest restoreDbClusterToPointInTimeRequest) throws DbClusterAlreadyExistsException,
DbClusterNotFoundException, DbClusterQuotaExceededException, DbClusterSnapshotNotFoundException,
DbSubnetGroupNotFoundException, InsufficientDbClusterCapacityException, InsufficientStorageClusterCapacityException,
InvalidDbClusterSnapshotStateException, InvalidDbClusterStateException, InvalidDbSnapshotStateException,
InvalidRestoreException, InvalidSubnetException, InvalidVpcNetworkStateException, KmsKeyNotAccessibleException,
StorageQuotaExceededException, AwsServiceException, SdkClientException, DocDbException {
throw new UnsupportedOperationException();
}
/**
*
* 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 {@link RestoreDbClusterToPointInTimeRequest.Builder}
* avoiding the need to create one manually via {@link RestoreDbClusterToPointInTimeRequest#builder()}
*
*
* @param restoreDbClusterToPointInTimeRequest
* A {@link Consumer} that will call methods on {@link RestoreDBClusterToPointInTimeMessage.Builder} to
* create a request. Represents the input to RestoreDBClusterToPointInTime.
* @return Result of the RestoreDBClusterToPointInTime operation returned by the service.
* @throws DbClusterAlreadyExistsException
* You already have a cluster with the given identifier.
* @throws DbClusterNotFoundException
* DBClusterIdentifier doesn't refer to an existing cluster.
* @throws DbClusterQuotaExceededException
* The cluster can't be created because you have reached the maximum allowed quota of clusters.
* @throws DbClusterSnapshotNotFoundException
* DBClusterSnapshotIdentifier doesn't refer to an existing cluster snapshot.
* @throws DbSubnetGroupNotFoundException
* DBSubnetGroupName doesn't refer to an existing subnet group.
* @throws InsufficientDbClusterCapacityException
* The cluster doesn't have enough capacity for the current operation.
* @throws 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.
* @throws InvalidDbClusterSnapshotStateException
* The provided value isn't a valid cluster snapshot state.
* @throws InvalidDbClusterStateException
* The cluster isn't in a valid state.
* @throws InvalidDbSnapshotStateException
* The state of the snapshot doesn't allow deletion.
* @throws InvalidRestoreException
* You cannot restore from a virtual private cloud (VPC) backup to a non-VPC DB instance.
* @throws InvalidSubnetException
* The requested subnet is not valid, or multiple subnets were requested that are not all in a common
* virtual private cloud (VPC).
* @throws InvalidVpcNetworkStateException
* The subnet group doesn't cover all Availability Zones after it is created because of changes that were
* made.
* @throws KmsKeyNotAccessibleException
* An error occurred when accessing an KMS key.
* @throws StorageQuotaExceededException
* The request would cause you to exceed the allowed amount of storage available across all instances.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws DocDbException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample DocDbClient.RestoreDBClusterToPointInTime
* @see AWS API Documentation
*/
default RestoreDbClusterToPointInTimeResponse restoreDBClusterToPointInTime(
Consumer restoreDbClusterToPointInTimeRequest)
throws DbClusterAlreadyExistsException, DbClusterNotFoundException, DbClusterQuotaExceededException,
DbClusterSnapshotNotFoundException, DbSubnetGroupNotFoundException, InsufficientDbClusterCapacityException,
InsufficientStorageClusterCapacityException, InvalidDbClusterSnapshotStateException, InvalidDbClusterStateException,
InvalidDbSnapshotStateException, InvalidRestoreException, InvalidSubnetException, InvalidVpcNetworkStateException,
KmsKeyNotAccessibleException, StorageQuotaExceededException, AwsServiceException, SdkClientException, DocDbException {
return restoreDBClusterToPointInTime(RestoreDbClusterToPointInTimeRequest.builder()
.applyMutation(restoreDbClusterToPointInTimeRequest).build());
}
/**
*
* Restarts the stopped cluster that is specified by DBClusterIdentifier. For more information, see Stopping and
* Starting an Amazon DocumentDB Cluster.
*
*
* @param startDbClusterRequest
* @return Result of the StartDBCluster operation returned by the service.
* @throws DbClusterNotFoundException
* DBClusterIdentifier doesn't refer to an existing cluster.
* @throws InvalidDbClusterStateException
* The cluster isn't in a valid state.
* @throws InvalidDbInstanceStateException
* The specified instance isn't in the available state.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws DocDbException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample DocDbClient.StartDBCluster
* @see AWS API
* Documentation
*/
default StartDbClusterResponse startDBCluster(StartDbClusterRequest startDbClusterRequest) throws DbClusterNotFoundException,
InvalidDbClusterStateException, InvalidDbInstanceStateException, AwsServiceException, SdkClientException,
DocDbException {
throw new UnsupportedOperationException();
}
/**
*
* 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 {@link StartDbClusterRequest.Builder} avoiding the need to
* create one manually via {@link StartDbClusterRequest#builder()}
*
*
* @param startDbClusterRequest
* A {@link Consumer} that will call methods on {@link StartDBClusterMessage.Builder} to create a request.
* @return Result of the StartDBCluster operation returned by the service.
* @throws DbClusterNotFoundException
* DBClusterIdentifier doesn't refer to an existing cluster.
* @throws InvalidDbClusterStateException
* The cluster isn't in a valid state.
* @throws InvalidDbInstanceStateException
* The specified instance isn't in the available state.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws DocDbException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample DocDbClient.StartDBCluster
* @see AWS API
* Documentation
*/
default StartDbClusterResponse startDBCluster(Consumer startDbClusterRequest)
throws DbClusterNotFoundException, InvalidDbClusterStateException, InvalidDbInstanceStateException,
AwsServiceException, SdkClientException, DocDbException {
return startDBCluster(StartDbClusterRequest.builder().applyMutation(startDbClusterRequest).build());
}
/**
*
* 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.
*
*
* @param stopDbClusterRequest
* @return Result of the StopDBCluster operation returned by the service.
* @throws DbClusterNotFoundException
* DBClusterIdentifier doesn't refer to an existing cluster.
* @throws InvalidDbClusterStateException
* The cluster isn't in a valid state.
* @throws InvalidDbInstanceStateException
* The specified instance isn't in the available state.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws DocDbException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample DocDbClient.StopDBCluster
* @see AWS API
* Documentation
*/
default StopDbClusterResponse stopDBCluster(StopDbClusterRequest stopDbClusterRequest) throws DbClusterNotFoundException,
InvalidDbClusterStateException, InvalidDbInstanceStateException, AwsServiceException, SdkClientException,
DocDbException {
throw new UnsupportedOperationException();
}
/**
*
* 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 {@link StopDbClusterRequest.Builder} avoiding the need to
* create one manually via {@link StopDbClusterRequest#builder()}
*
*
* @param stopDbClusterRequest
* A {@link Consumer} that will call methods on {@link StopDBClusterMessage.Builder} to create a request.
* @return Result of the StopDBCluster operation returned by the service.
* @throws DbClusterNotFoundException
* DBClusterIdentifier doesn't refer to an existing cluster.
* @throws InvalidDbClusterStateException
* The cluster isn't in a valid state.
* @throws InvalidDbInstanceStateException
* The specified instance isn't in the available state.
* @throws SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
* catch all scenarios.
* @throws SdkClientException
* If any client side error occurs such as an IO related failure, failure to get credentials, etc.
* @throws DocDbException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample DocDbClient.StopDBCluster
* @see AWS API
* Documentation
*/
default StopDbClusterResponse stopDBCluster(Consumer stopDbClusterRequest)
throws DbClusterNotFoundException, InvalidDbClusterStateException, InvalidDbInstanceStateException,
AwsServiceException, SdkClientException, DocDbException {
return stopDBCluster(StopDbClusterRequest.builder().applyMutation(stopDbClusterRequest).build());
}
static ServiceMetadata serviceMetadata() {
return ServiceMetadata.of(SERVICE_METADATA_ID);
}
/**
* Create an instance of {@link 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.
*
* @return an instance of {@link DocDbWaiter}
*/
default DocDbWaiter waiter() {
throw new UnsupportedOperationException();
}
}