software.amazon.awssdk.services.backup.BackupClient 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.backup;
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.AwsClient;
import software.amazon.awssdk.awscore.exception.AwsServiceException;
import software.amazon.awssdk.core.exception.SdkClientException;
import software.amazon.awssdk.regions.ServiceMetadata;
import software.amazon.awssdk.services.backup.model.AlreadyExistsException;
import software.amazon.awssdk.services.backup.model.BackupException;
import software.amazon.awssdk.services.backup.model.CancelLegalHoldRequest;
import software.amazon.awssdk.services.backup.model.CancelLegalHoldResponse;
import software.amazon.awssdk.services.backup.model.ConflictException;
import software.amazon.awssdk.services.backup.model.CreateBackupPlanRequest;
import software.amazon.awssdk.services.backup.model.CreateBackupPlanResponse;
import software.amazon.awssdk.services.backup.model.CreateBackupSelectionRequest;
import software.amazon.awssdk.services.backup.model.CreateBackupSelectionResponse;
import software.amazon.awssdk.services.backup.model.CreateBackupVaultRequest;
import software.amazon.awssdk.services.backup.model.CreateBackupVaultResponse;
import software.amazon.awssdk.services.backup.model.CreateFrameworkRequest;
import software.amazon.awssdk.services.backup.model.CreateFrameworkResponse;
import software.amazon.awssdk.services.backup.model.CreateLegalHoldRequest;
import software.amazon.awssdk.services.backup.model.CreateLegalHoldResponse;
import software.amazon.awssdk.services.backup.model.CreateLogicallyAirGappedBackupVaultRequest;
import software.amazon.awssdk.services.backup.model.CreateLogicallyAirGappedBackupVaultResponse;
import software.amazon.awssdk.services.backup.model.CreateReportPlanRequest;
import software.amazon.awssdk.services.backup.model.CreateReportPlanResponse;
import software.amazon.awssdk.services.backup.model.CreateRestoreTestingPlanRequest;
import software.amazon.awssdk.services.backup.model.CreateRestoreTestingPlanResponse;
import software.amazon.awssdk.services.backup.model.CreateRestoreTestingSelectionRequest;
import software.amazon.awssdk.services.backup.model.CreateRestoreTestingSelectionResponse;
import software.amazon.awssdk.services.backup.model.DeleteBackupPlanRequest;
import software.amazon.awssdk.services.backup.model.DeleteBackupPlanResponse;
import software.amazon.awssdk.services.backup.model.DeleteBackupSelectionRequest;
import software.amazon.awssdk.services.backup.model.DeleteBackupSelectionResponse;
import software.amazon.awssdk.services.backup.model.DeleteBackupVaultAccessPolicyRequest;
import software.amazon.awssdk.services.backup.model.DeleteBackupVaultAccessPolicyResponse;
import software.amazon.awssdk.services.backup.model.DeleteBackupVaultLockConfigurationRequest;
import software.amazon.awssdk.services.backup.model.DeleteBackupVaultLockConfigurationResponse;
import software.amazon.awssdk.services.backup.model.DeleteBackupVaultNotificationsRequest;
import software.amazon.awssdk.services.backup.model.DeleteBackupVaultNotificationsResponse;
import software.amazon.awssdk.services.backup.model.DeleteBackupVaultRequest;
import software.amazon.awssdk.services.backup.model.DeleteBackupVaultResponse;
import software.amazon.awssdk.services.backup.model.DeleteFrameworkRequest;
import software.amazon.awssdk.services.backup.model.DeleteFrameworkResponse;
import software.amazon.awssdk.services.backup.model.DeleteRecoveryPointRequest;
import software.amazon.awssdk.services.backup.model.DeleteRecoveryPointResponse;
import software.amazon.awssdk.services.backup.model.DeleteReportPlanRequest;
import software.amazon.awssdk.services.backup.model.DeleteReportPlanResponse;
import software.amazon.awssdk.services.backup.model.DeleteRestoreTestingPlanRequest;
import software.amazon.awssdk.services.backup.model.DeleteRestoreTestingPlanResponse;
import software.amazon.awssdk.services.backup.model.DeleteRestoreTestingSelectionRequest;
import software.amazon.awssdk.services.backup.model.DeleteRestoreTestingSelectionResponse;
import software.amazon.awssdk.services.backup.model.DependencyFailureException;
import software.amazon.awssdk.services.backup.model.DescribeBackupJobRequest;
import software.amazon.awssdk.services.backup.model.DescribeBackupJobResponse;
import software.amazon.awssdk.services.backup.model.DescribeBackupVaultRequest;
import software.amazon.awssdk.services.backup.model.DescribeBackupVaultResponse;
import software.amazon.awssdk.services.backup.model.DescribeCopyJobRequest;
import software.amazon.awssdk.services.backup.model.DescribeCopyJobResponse;
import software.amazon.awssdk.services.backup.model.DescribeFrameworkRequest;
import software.amazon.awssdk.services.backup.model.DescribeFrameworkResponse;
import software.amazon.awssdk.services.backup.model.DescribeGlobalSettingsRequest;
import software.amazon.awssdk.services.backup.model.DescribeGlobalSettingsResponse;
import software.amazon.awssdk.services.backup.model.DescribeProtectedResourceRequest;
import software.amazon.awssdk.services.backup.model.DescribeProtectedResourceResponse;
import software.amazon.awssdk.services.backup.model.DescribeRecoveryPointRequest;
import software.amazon.awssdk.services.backup.model.DescribeRecoveryPointResponse;
import software.amazon.awssdk.services.backup.model.DescribeRegionSettingsRequest;
import software.amazon.awssdk.services.backup.model.DescribeRegionSettingsResponse;
import software.amazon.awssdk.services.backup.model.DescribeReportJobRequest;
import software.amazon.awssdk.services.backup.model.DescribeReportJobResponse;
import software.amazon.awssdk.services.backup.model.DescribeReportPlanRequest;
import software.amazon.awssdk.services.backup.model.DescribeReportPlanResponse;
import software.amazon.awssdk.services.backup.model.DescribeRestoreJobRequest;
import software.amazon.awssdk.services.backup.model.DescribeRestoreJobResponse;
import software.amazon.awssdk.services.backup.model.DisassociateRecoveryPointFromParentRequest;
import software.amazon.awssdk.services.backup.model.DisassociateRecoveryPointFromParentResponse;
import software.amazon.awssdk.services.backup.model.DisassociateRecoveryPointRequest;
import software.amazon.awssdk.services.backup.model.DisassociateRecoveryPointResponse;
import software.amazon.awssdk.services.backup.model.ExportBackupPlanTemplateRequest;
import software.amazon.awssdk.services.backup.model.ExportBackupPlanTemplateResponse;
import software.amazon.awssdk.services.backup.model.GetBackupPlanFromJsonRequest;
import software.amazon.awssdk.services.backup.model.GetBackupPlanFromJsonResponse;
import software.amazon.awssdk.services.backup.model.GetBackupPlanFromTemplateRequest;
import software.amazon.awssdk.services.backup.model.GetBackupPlanFromTemplateResponse;
import software.amazon.awssdk.services.backup.model.GetBackupPlanRequest;
import software.amazon.awssdk.services.backup.model.GetBackupPlanResponse;
import software.amazon.awssdk.services.backup.model.GetBackupSelectionRequest;
import software.amazon.awssdk.services.backup.model.GetBackupSelectionResponse;
import software.amazon.awssdk.services.backup.model.GetBackupVaultAccessPolicyRequest;
import software.amazon.awssdk.services.backup.model.GetBackupVaultAccessPolicyResponse;
import software.amazon.awssdk.services.backup.model.GetBackupVaultNotificationsRequest;
import software.amazon.awssdk.services.backup.model.GetBackupVaultNotificationsResponse;
import software.amazon.awssdk.services.backup.model.GetLegalHoldRequest;
import software.amazon.awssdk.services.backup.model.GetLegalHoldResponse;
import software.amazon.awssdk.services.backup.model.GetRecoveryPointRestoreMetadataRequest;
import software.amazon.awssdk.services.backup.model.GetRecoveryPointRestoreMetadataResponse;
import software.amazon.awssdk.services.backup.model.GetRestoreJobMetadataRequest;
import software.amazon.awssdk.services.backup.model.GetRestoreJobMetadataResponse;
import software.amazon.awssdk.services.backup.model.GetRestoreTestingInferredMetadataRequest;
import software.amazon.awssdk.services.backup.model.GetRestoreTestingInferredMetadataResponse;
import software.amazon.awssdk.services.backup.model.GetRestoreTestingPlanRequest;
import software.amazon.awssdk.services.backup.model.GetRestoreTestingPlanResponse;
import software.amazon.awssdk.services.backup.model.GetRestoreTestingSelectionRequest;
import software.amazon.awssdk.services.backup.model.GetRestoreTestingSelectionResponse;
import software.amazon.awssdk.services.backup.model.GetSupportedResourceTypesRequest;
import software.amazon.awssdk.services.backup.model.GetSupportedResourceTypesResponse;
import software.amazon.awssdk.services.backup.model.InvalidParameterValueException;
import software.amazon.awssdk.services.backup.model.InvalidRequestException;
import software.amazon.awssdk.services.backup.model.InvalidResourceStateException;
import software.amazon.awssdk.services.backup.model.LimitExceededException;
import software.amazon.awssdk.services.backup.model.ListBackupJobSummariesRequest;
import software.amazon.awssdk.services.backup.model.ListBackupJobSummariesResponse;
import software.amazon.awssdk.services.backup.model.ListBackupJobsRequest;
import software.amazon.awssdk.services.backup.model.ListBackupJobsResponse;
import software.amazon.awssdk.services.backup.model.ListBackupPlanTemplatesRequest;
import software.amazon.awssdk.services.backup.model.ListBackupPlanTemplatesResponse;
import software.amazon.awssdk.services.backup.model.ListBackupPlanVersionsRequest;
import software.amazon.awssdk.services.backup.model.ListBackupPlanVersionsResponse;
import software.amazon.awssdk.services.backup.model.ListBackupPlansRequest;
import software.amazon.awssdk.services.backup.model.ListBackupPlansResponse;
import software.amazon.awssdk.services.backup.model.ListBackupSelectionsRequest;
import software.amazon.awssdk.services.backup.model.ListBackupSelectionsResponse;
import software.amazon.awssdk.services.backup.model.ListBackupVaultsRequest;
import software.amazon.awssdk.services.backup.model.ListBackupVaultsResponse;
import software.amazon.awssdk.services.backup.model.ListCopyJobSummariesRequest;
import software.amazon.awssdk.services.backup.model.ListCopyJobSummariesResponse;
import software.amazon.awssdk.services.backup.model.ListCopyJobsRequest;
import software.amazon.awssdk.services.backup.model.ListCopyJobsResponse;
import software.amazon.awssdk.services.backup.model.ListFrameworksRequest;
import software.amazon.awssdk.services.backup.model.ListFrameworksResponse;
import software.amazon.awssdk.services.backup.model.ListLegalHoldsRequest;
import software.amazon.awssdk.services.backup.model.ListLegalHoldsResponse;
import software.amazon.awssdk.services.backup.model.ListProtectedResourcesByBackupVaultRequest;
import software.amazon.awssdk.services.backup.model.ListProtectedResourcesByBackupVaultResponse;
import software.amazon.awssdk.services.backup.model.ListProtectedResourcesRequest;
import software.amazon.awssdk.services.backup.model.ListProtectedResourcesResponse;
import software.amazon.awssdk.services.backup.model.ListRecoveryPointsByBackupVaultRequest;
import software.amazon.awssdk.services.backup.model.ListRecoveryPointsByBackupVaultResponse;
import software.amazon.awssdk.services.backup.model.ListRecoveryPointsByLegalHoldRequest;
import software.amazon.awssdk.services.backup.model.ListRecoveryPointsByLegalHoldResponse;
import software.amazon.awssdk.services.backup.model.ListRecoveryPointsByResourceRequest;
import software.amazon.awssdk.services.backup.model.ListRecoveryPointsByResourceResponse;
import software.amazon.awssdk.services.backup.model.ListReportJobsRequest;
import software.amazon.awssdk.services.backup.model.ListReportJobsResponse;
import software.amazon.awssdk.services.backup.model.ListReportPlansRequest;
import software.amazon.awssdk.services.backup.model.ListReportPlansResponse;
import software.amazon.awssdk.services.backup.model.ListRestoreJobSummariesRequest;
import software.amazon.awssdk.services.backup.model.ListRestoreJobSummariesResponse;
import software.amazon.awssdk.services.backup.model.ListRestoreJobsByProtectedResourceRequest;
import software.amazon.awssdk.services.backup.model.ListRestoreJobsByProtectedResourceResponse;
import software.amazon.awssdk.services.backup.model.ListRestoreJobsRequest;
import software.amazon.awssdk.services.backup.model.ListRestoreJobsResponse;
import software.amazon.awssdk.services.backup.model.ListRestoreTestingPlansRequest;
import software.amazon.awssdk.services.backup.model.ListRestoreTestingPlansResponse;
import software.amazon.awssdk.services.backup.model.ListRestoreTestingSelectionsRequest;
import software.amazon.awssdk.services.backup.model.ListRestoreTestingSelectionsResponse;
import software.amazon.awssdk.services.backup.model.ListTagsRequest;
import software.amazon.awssdk.services.backup.model.ListTagsResponse;
import software.amazon.awssdk.services.backup.model.MissingParameterValueException;
import software.amazon.awssdk.services.backup.model.PutBackupVaultAccessPolicyRequest;
import software.amazon.awssdk.services.backup.model.PutBackupVaultAccessPolicyResponse;
import software.amazon.awssdk.services.backup.model.PutBackupVaultLockConfigurationRequest;
import software.amazon.awssdk.services.backup.model.PutBackupVaultLockConfigurationResponse;
import software.amazon.awssdk.services.backup.model.PutBackupVaultNotificationsRequest;
import software.amazon.awssdk.services.backup.model.PutBackupVaultNotificationsResponse;
import software.amazon.awssdk.services.backup.model.PutRestoreValidationResultRequest;
import software.amazon.awssdk.services.backup.model.PutRestoreValidationResultResponse;
import software.amazon.awssdk.services.backup.model.ResourceNotFoundException;
import software.amazon.awssdk.services.backup.model.ServiceUnavailableException;
import software.amazon.awssdk.services.backup.model.StartBackupJobRequest;
import software.amazon.awssdk.services.backup.model.StartBackupJobResponse;
import software.amazon.awssdk.services.backup.model.StartCopyJobRequest;
import software.amazon.awssdk.services.backup.model.StartCopyJobResponse;
import software.amazon.awssdk.services.backup.model.StartReportJobRequest;
import software.amazon.awssdk.services.backup.model.StartReportJobResponse;
import software.amazon.awssdk.services.backup.model.StartRestoreJobRequest;
import software.amazon.awssdk.services.backup.model.StartRestoreJobResponse;
import software.amazon.awssdk.services.backup.model.StopBackupJobRequest;
import software.amazon.awssdk.services.backup.model.StopBackupJobResponse;
import software.amazon.awssdk.services.backup.model.TagResourceRequest;
import software.amazon.awssdk.services.backup.model.TagResourceResponse;
import software.amazon.awssdk.services.backup.model.UntagResourceRequest;
import software.amazon.awssdk.services.backup.model.UntagResourceResponse;
import software.amazon.awssdk.services.backup.model.UpdateBackupPlanRequest;
import software.amazon.awssdk.services.backup.model.UpdateBackupPlanResponse;
import software.amazon.awssdk.services.backup.model.UpdateFrameworkRequest;
import software.amazon.awssdk.services.backup.model.UpdateFrameworkResponse;
import software.amazon.awssdk.services.backup.model.UpdateGlobalSettingsRequest;
import software.amazon.awssdk.services.backup.model.UpdateGlobalSettingsResponse;
import software.amazon.awssdk.services.backup.model.UpdateRecoveryPointLifecycleRequest;
import software.amazon.awssdk.services.backup.model.UpdateRecoveryPointLifecycleResponse;
import software.amazon.awssdk.services.backup.model.UpdateRegionSettingsRequest;
import software.amazon.awssdk.services.backup.model.UpdateRegionSettingsResponse;
import software.amazon.awssdk.services.backup.model.UpdateReportPlanRequest;
import software.amazon.awssdk.services.backup.model.UpdateReportPlanResponse;
import software.amazon.awssdk.services.backup.model.UpdateRestoreTestingPlanRequest;
import software.amazon.awssdk.services.backup.model.UpdateRestoreTestingPlanResponse;
import software.amazon.awssdk.services.backup.model.UpdateRestoreTestingSelectionRequest;
import software.amazon.awssdk.services.backup.model.UpdateRestoreTestingSelectionResponse;
import software.amazon.awssdk.services.backup.paginators.ListBackupJobSummariesIterable;
import software.amazon.awssdk.services.backup.paginators.ListBackupJobsIterable;
import software.amazon.awssdk.services.backup.paginators.ListBackupPlanTemplatesIterable;
import software.amazon.awssdk.services.backup.paginators.ListBackupPlanVersionsIterable;
import software.amazon.awssdk.services.backup.paginators.ListBackupPlansIterable;
import software.amazon.awssdk.services.backup.paginators.ListBackupSelectionsIterable;
import software.amazon.awssdk.services.backup.paginators.ListBackupVaultsIterable;
import software.amazon.awssdk.services.backup.paginators.ListCopyJobSummariesIterable;
import software.amazon.awssdk.services.backup.paginators.ListCopyJobsIterable;
import software.amazon.awssdk.services.backup.paginators.ListFrameworksIterable;
import software.amazon.awssdk.services.backup.paginators.ListLegalHoldsIterable;
import software.amazon.awssdk.services.backup.paginators.ListProtectedResourcesByBackupVaultIterable;
import software.amazon.awssdk.services.backup.paginators.ListProtectedResourcesIterable;
import software.amazon.awssdk.services.backup.paginators.ListRecoveryPointsByBackupVaultIterable;
import software.amazon.awssdk.services.backup.paginators.ListRecoveryPointsByLegalHoldIterable;
import software.amazon.awssdk.services.backup.paginators.ListRecoveryPointsByResourceIterable;
import software.amazon.awssdk.services.backup.paginators.ListReportJobsIterable;
import software.amazon.awssdk.services.backup.paginators.ListReportPlansIterable;
import software.amazon.awssdk.services.backup.paginators.ListRestoreJobSummariesIterable;
import software.amazon.awssdk.services.backup.paginators.ListRestoreJobsByProtectedResourceIterable;
import software.amazon.awssdk.services.backup.paginators.ListRestoreJobsIterable;
import software.amazon.awssdk.services.backup.paginators.ListRestoreTestingPlansIterable;
import software.amazon.awssdk.services.backup.paginators.ListRestoreTestingSelectionsIterable;
import software.amazon.awssdk.services.backup.paginators.ListTagsIterable;
/**
* Service client for accessing AWS Backup. This can be created using the static {@link #builder()} method.
*
* Backup
*
* Backup is a unified backup service designed to protect Amazon Web Services services and their associated data. Backup
* simplifies the creation, migration, restoration, and deletion of backups, while also providing reporting and
* auditing.
*
*/
@Generated("software.amazon.awssdk:codegen")
@SdkPublicApi
@ThreadSafe
public interface BackupClient extends AwsClient {
String SERVICE_NAME = "backup";
/**
* Value for looking up the service's metadata from the
* {@link software.amazon.awssdk.regions.ServiceMetadataProvider}.
*/
String SERVICE_METADATA_ID = "backup";
/**
*
* Removes the specified legal hold on a recovery point. This action can only be performed by a user with sufficient
* permissions.
*
*
* @param cancelLegalHoldRequest
* @return Result of the CancelLegalHold operation returned by the service.
* @throws InvalidParameterValueException
* Indicates that something is wrong with a parameter's value. For example, the value is out of range.
* @throws InvalidResourceStateException
* Backup is already performing an action on this recovery point. It can't perform the action you requested
* until the first action finishes. Try again later.
* @throws MissingParameterValueException
* Indicates that a required parameter is missing.
* @throws ServiceUnavailableException
* The request failed due to a temporary failure of the server.
* @throws ResourceNotFoundException
* A resource that is required for the action doesn't 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 BackupException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample BackupClient.CancelLegalHold
* @see AWS API
* Documentation
*/
default CancelLegalHoldResponse cancelLegalHold(CancelLegalHoldRequest cancelLegalHoldRequest)
throws InvalidParameterValueException, InvalidResourceStateException, MissingParameterValueException,
ServiceUnavailableException, ResourceNotFoundException, AwsServiceException, SdkClientException, BackupException {
throw new UnsupportedOperationException();
}
/**
*
* Removes the specified legal hold on a recovery point. This action can only be performed by a user with sufficient
* permissions.
*
*
*
* This is a convenience which creates an instance of the {@link CancelLegalHoldRequest.Builder} avoiding the need
* to create one manually via {@link CancelLegalHoldRequest#builder()}
*
*
* @param cancelLegalHoldRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.backup.model.CancelLegalHoldRequest.Builder} to create a request.
* @return Result of the CancelLegalHold operation returned by the service.
* @throws InvalidParameterValueException
* Indicates that something is wrong with a parameter's value. For example, the value is out of range.
* @throws InvalidResourceStateException
* Backup is already performing an action on this recovery point. It can't perform the action you requested
* until the first action finishes. Try again later.
* @throws MissingParameterValueException
* Indicates that a required parameter is missing.
* @throws ServiceUnavailableException
* The request failed due to a temporary failure of the server.
* @throws ResourceNotFoundException
* A resource that is required for the action doesn't 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 BackupException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample BackupClient.CancelLegalHold
* @see AWS API
* Documentation
*/
default CancelLegalHoldResponse cancelLegalHold(Consumer cancelLegalHoldRequest)
throws InvalidParameterValueException, InvalidResourceStateException, MissingParameterValueException,
ServiceUnavailableException, ResourceNotFoundException, AwsServiceException, SdkClientException, BackupException {
return cancelLegalHold(CancelLegalHoldRequest.builder().applyMutation(cancelLegalHoldRequest).build());
}
/**
*
* Creates a backup plan using a backup plan name and backup rules. A backup plan is a document that contains
* information that Backup uses to schedule tasks that create recovery points for resources.
*
*
* If you call CreateBackupPlan with a plan that already exists, you receive an
* AlreadyExistsException exception.
*
*
* @param createBackupPlanRequest
* @return Result of the CreateBackupPlan operation returned by the service.
* @throws LimitExceededException
* A limit in the request has been exceeded; for example, a maximum number of items allowed in a request.
* @throws AlreadyExistsException
* The required resource already exists.
* @throws InvalidParameterValueException
* Indicates that something is wrong with a parameter's value. For example, the value is out of range.
* @throws MissingParameterValueException
* Indicates that a required parameter is missing.
* @throws ServiceUnavailableException
* The request failed due to a temporary failure of the server.
* @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 BackupException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample BackupClient.CreateBackupPlan
* @see AWS API
* Documentation
*/
default CreateBackupPlanResponse createBackupPlan(CreateBackupPlanRequest createBackupPlanRequest)
throws LimitExceededException, AlreadyExistsException, InvalidParameterValueException,
MissingParameterValueException, ServiceUnavailableException, AwsServiceException, SdkClientException, BackupException {
throw new UnsupportedOperationException();
}
/**
*
* Creates a backup plan using a backup plan name and backup rules. A backup plan is a document that contains
* information that Backup uses to schedule tasks that create recovery points for resources.
*
*
* If you call CreateBackupPlan with a plan that already exists, you receive an
* AlreadyExistsException exception.
*
*
*
* This is a convenience which creates an instance of the {@link CreateBackupPlanRequest.Builder} avoiding the need
* to create one manually via {@link CreateBackupPlanRequest#builder()}
*
*
* @param createBackupPlanRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.backup.model.CreateBackupPlanRequest.Builder} to create a request.
* @return Result of the CreateBackupPlan operation returned by the service.
* @throws LimitExceededException
* A limit in the request has been exceeded; for example, a maximum number of items allowed in a request.
* @throws AlreadyExistsException
* The required resource already exists.
* @throws InvalidParameterValueException
* Indicates that something is wrong with a parameter's value. For example, the value is out of range.
* @throws MissingParameterValueException
* Indicates that a required parameter is missing.
* @throws ServiceUnavailableException
* The request failed due to a temporary failure of the server.
* @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 BackupException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample BackupClient.CreateBackupPlan
* @see AWS API
* Documentation
*/
default CreateBackupPlanResponse createBackupPlan(Consumer createBackupPlanRequest)
throws LimitExceededException, AlreadyExistsException, InvalidParameterValueException,
MissingParameterValueException, ServiceUnavailableException, AwsServiceException, SdkClientException, BackupException {
return createBackupPlan(CreateBackupPlanRequest.builder().applyMutation(createBackupPlanRequest).build());
}
/**
*
* Creates a JSON document that specifies a set of resources to assign to a backup plan. For examples, see Assigning resources programmatically.
*
*
* @param createBackupSelectionRequest
* @return Result of the CreateBackupSelection operation returned by the service.
* @throws LimitExceededException
* A limit in the request has been exceeded; for example, a maximum number of items allowed in a request.
* @throws AlreadyExistsException
* The required resource already exists.
* @throws InvalidParameterValueException
* Indicates that something is wrong with a parameter's value. For example, the value is out of range.
* @throws MissingParameterValueException
* Indicates that a required parameter is missing.
* @throws ServiceUnavailableException
* The request failed due to a temporary failure of the server.
* @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 BackupException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample BackupClient.CreateBackupSelection
* @see AWS
* API Documentation
*/
default CreateBackupSelectionResponse createBackupSelection(CreateBackupSelectionRequest createBackupSelectionRequest)
throws LimitExceededException, AlreadyExistsException, InvalidParameterValueException,
MissingParameterValueException, ServiceUnavailableException, AwsServiceException, SdkClientException, BackupException {
throw new UnsupportedOperationException();
}
/**
*
* Creates a JSON document that specifies a set of resources to assign to a backup plan. For examples, see Assigning resources programmatically.
*
*
*
* This is a convenience which creates an instance of the {@link CreateBackupSelectionRequest.Builder} avoiding the
* need to create one manually via {@link CreateBackupSelectionRequest#builder()}
*
*
* @param createBackupSelectionRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.backup.model.CreateBackupSelectionRequest.Builder} to create a
* request.
* @return Result of the CreateBackupSelection operation returned by the service.
* @throws LimitExceededException
* A limit in the request has been exceeded; for example, a maximum number of items allowed in a request.
* @throws AlreadyExistsException
* The required resource already exists.
* @throws InvalidParameterValueException
* Indicates that something is wrong with a parameter's value. For example, the value is out of range.
* @throws MissingParameterValueException
* Indicates that a required parameter is missing.
* @throws ServiceUnavailableException
* The request failed due to a temporary failure of the server.
* @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 BackupException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample BackupClient.CreateBackupSelection
* @see AWS
* API Documentation
*/
default CreateBackupSelectionResponse createBackupSelection(
Consumer createBackupSelectionRequest) throws LimitExceededException,
AlreadyExistsException, InvalidParameterValueException, MissingParameterValueException, ServiceUnavailableException,
AwsServiceException, SdkClientException, BackupException {
return createBackupSelection(CreateBackupSelectionRequest.builder().applyMutation(createBackupSelectionRequest).build());
}
/**
*
* Creates a logical container where backups are stored. A CreateBackupVault request includes a name,
* optionally one or more resource tags, an encryption key, and a request ID.
*
*
*
* Do not include sensitive data, such as passport numbers, in the name of a backup vault.
*
*
*
* @param createBackupVaultRequest
* @return Result of the CreateBackupVault operation returned by the service.
* @throws InvalidParameterValueException
* Indicates that something is wrong with a parameter's value. For example, the value is out of range.
* @throws MissingParameterValueException
* Indicates that a required parameter is missing.
* @throws ServiceUnavailableException
* The request failed due to a temporary failure of the server.
* @throws LimitExceededException
* A limit in the request has been exceeded; for example, a maximum number of items allowed in a request.
* @throws AlreadyExistsException
* The required resource 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 BackupException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample BackupClient.CreateBackupVault
* @see AWS API
* Documentation
*/
default CreateBackupVaultResponse createBackupVault(CreateBackupVaultRequest createBackupVaultRequest)
throws InvalidParameterValueException, MissingParameterValueException, ServiceUnavailableException,
LimitExceededException, AlreadyExistsException, AwsServiceException, SdkClientException, BackupException {
throw new UnsupportedOperationException();
}
/**
*
* Creates a logical container where backups are stored. A CreateBackupVault request includes a name,
* optionally one or more resource tags, an encryption key, and a request ID.
*
*
*
* Do not include sensitive data, such as passport numbers, in the name of a backup vault.
*
*
*
* This is a convenience which creates an instance of the {@link CreateBackupVaultRequest.Builder} avoiding the need
* to create one manually via {@link CreateBackupVaultRequest#builder()}
*
*
* @param createBackupVaultRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.backup.model.CreateBackupVaultRequest.Builder} to create a request.
* @return Result of the CreateBackupVault operation returned by the service.
* @throws InvalidParameterValueException
* Indicates that something is wrong with a parameter's value. For example, the value is out of range.
* @throws MissingParameterValueException
* Indicates that a required parameter is missing.
* @throws ServiceUnavailableException
* The request failed due to a temporary failure of the server.
* @throws LimitExceededException
* A limit in the request has been exceeded; for example, a maximum number of items allowed in a request.
* @throws AlreadyExistsException
* The required resource 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 BackupException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample BackupClient.CreateBackupVault
* @see AWS API
* Documentation
*/
default CreateBackupVaultResponse createBackupVault(Consumer createBackupVaultRequest)
throws InvalidParameterValueException, MissingParameterValueException, ServiceUnavailableException,
LimitExceededException, AlreadyExistsException, AwsServiceException, SdkClientException, BackupException {
return createBackupVault(CreateBackupVaultRequest.builder().applyMutation(createBackupVaultRequest).build());
}
/**
*
* Creates a framework with one or more controls. A framework is a collection of controls that you can use to
* evaluate your backup practices. By using pre-built customizable controls to define your policies, you can
* evaluate whether your backup practices comply with your policies and which resources are not yet in compliance.
*
*
* @param createFrameworkRequest
* @return Result of the CreateFramework operation returned by the service.
* @throws AlreadyExistsException
* The required resource already exists.
* @throws LimitExceededException
* A limit in the request has been exceeded; for example, a maximum number of items allowed in a request.
* @throws InvalidParameterValueException
* Indicates that something is wrong with a parameter's value. For example, the value is out of range.
* @throws MissingParameterValueException
* Indicates that a required parameter is missing.
* @throws ServiceUnavailableException
* The request failed due to a temporary failure of the server.
* @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 BackupException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample BackupClient.CreateFramework
* @see AWS API
* Documentation
*/
default CreateFrameworkResponse createFramework(CreateFrameworkRequest createFrameworkRequest) throws AlreadyExistsException,
LimitExceededException, InvalidParameterValueException, MissingParameterValueException, ServiceUnavailableException,
AwsServiceException, SdkClientException, BackupException {
throw new UnsupportedOperationException();
}
/**
*
* Creates a framework with one or more controls. A framework is a collection of controls that you can use to
* evaluate your backup practices. By using pre-built customizable controls to define your policies, you can
* evaluate whether your backup practices comply with your policies and which resources are not yet in compliance.
*
*
*
* This is a convenience which creates an instance of the {@link CreateFrameworkRequest.Builder} avoiding the need
* to create one manually via {@link CreateFrameworkRequest#builder()}
*
*
* @param createFrameworkRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.backup.model.CreateFrameworkRequest.Builder} to create a request.
* @return Result of the CreateFramework operation returned by the service.
* @throws AlreadyExistsException
* The required resource already exists.
* @throws LimitExceededException
* A limit in the request has been exceeded; for example, a maximum number of items allowed in a request.
* @throws InvalidParameterValueException
* Indicates that something is wrong with a parameter's value. For example, the value is out of range.
* @throws MissingParameterValueException
* Indicates that a required parameter is missing.
* @throws ServiceUnavailableException
* The request failed due to a temporary failure of the server.
* @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 BackupException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample BackupClient.CreateFramework
* @see AWS API
* Documentation
*/
default CreateFrameworkResponse createFramework(Consumer createFrameworkRequest)
throws AlreadyExistsException, LimitExceededException, InvalidParameterValueException,
MissingParameterValueException, ServiceUnavailableException, AwsServiceException, SdkClientException, BackupException {
return createFramework(CreateFrameworkRequest.builder().applyMutation(createFrameworkRequest).build());
}
/**
*
* Creates a legal hold on a recovery point (backup). A legal hold is a restraint on altering or deleting a backup
* until an authorized user cancels the legal hold. Any actions to delete or disassociate a recovery point will fail
* with an error if one or more active legal holds are on the recovery point.
*
*
* @param createLegalHoldRequest
* @return Result of the CreateLegalHold operation returned by the service.
* @throws InvalidParameterValueException
* Indicates that something is wrong with a parameter's value. For example, the value is out of range.
* @throws MissingParameterValueException
* Indicates that a required parameter is missing.
* @throws ServiceUnavailableException
* The request failed due to a temporary failure of the server.
* @throws LimitExceededException
* A limit in the request has been exceeded; for example, a maximum number of items allowed in a request.
* @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 BackupException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample BackupClient.CreateLegalHold
* @see AWS API
* Documentation
*/
default CreateLegalHoldResponse createLegalHold(CreateLegalHoldRequest createLegalHoldRequest)
throws InvalidParameterValueException, MissingParameterValueException, ServiceUnavailableException,
LimitExceededException, AwsServiceException, SdkClientException, BackupException {
throw new UnsupportedOperationException();
}
/**
*
* Creates a legal hold on a recovery point (backup). A legal hold is a restraint on altering or deleting a backup
* until an authorized user cancels the legal hold. Any actions to delete or disassociate a recovery point will fail
* with an error if one or more active legal holds are on the recovery point.
*
*
*
* This is a convenience which creates an instance of the {@link CreateLegalHoldRequest.Builder} avoiding the need
* to create one manually via {@link CreateLegalHoldRequest#builder()}
*
*
* @param createLegalHoldRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.backup.model.CreateLegalHoldRequest.Builder} to create a request.
* @return Result of the CreateLegalHold operation returned by the service.
* @throws InvalidParameterValueException
* Indicates that something is wrong with a parameter's value. For example, the value is out of range.
* @throws MissingParameterValueException
* Indicates that a required parameter is missing.
* @throws ServiceUnavailableException
* The request failed due to a temporary failure of the server.
* @throws LimitExceededException
* A limit in the request has been exceeded; for example, a maximum number of items allowed in a request.
* @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 BackupException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample BackupClient.CreateLegalHold
* @see AWS API
* Documentation
*/
default CreateLegalHoldResponse createLegalHold(Consumer createLegalHoldRequest)
throws InvalidParameterValueException, MissingParameterValueException, ServiceUnavailableException,
LimitExceededException, AwsServiceException, SdkClientException, BackupException {
return createLegalHold(CreateLegalHoldRequest.builder().applyMutation(createLegalHoldRequest).build());
}
/**
*
* Creates a logical container to where backups may be copied.
*
*
* This request includes a name, the Region, the maximum number of retention days, the minimum number of retention
* days, and optionally can include tags and a creator request ID.
*
*
*
* Do not include sensitive data, such as passport numbers, in the name of a backup vault.
*
*
*
* @param createLogicallyAirGappedBackupVaultRequest
* @return Result of the CreateLogicallyAirGappedBackupVault operation returned by the service.
* @throws AlreadyExistsException
* The required resource already exists.
* @throws InvalidParameterValueException
* Indicates that something is wrong with a parameter's value. For example, the value is out of range.
* @throws LimitExceededException
* A limit in the request has been exceeded; for example, a maximum number of items allowed in a request.
* @throws MissingParameterValueException
* Indicates that a required parameter is missing.
* @throws ServiceUnavailableException
* The request failed due to a temporary failure of the server.
* @throws InvalidRequestException
* Indicates that something is wrong with the input to the request. For example, a parameter is of the wrong
* type.
* @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 BackupException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample BackupClient.CreateLogicallyAirGappedBackupVault
* @see AWS API Documentation
*/
default CreateLogicallyAirGappedBackupVaultResponse createLogicallyAirGappedBackupVault(
CreateLogicallyAirGappedBackupVaultRequest createLogicallyAirGappedBackupVaultRequest) throws AlreadyExistsException,
InvalidParameterValueException, LimitExceededException, MissingParameterValueException, ServiceUnavailableException,
InvalidRequestException, AwsServiceException, SdkClientException, BackupException {
throw new UnsupportedOperationException();
}
/**
*
* Creates a logical container to where backups may be copied.
*
*
* This request includes a name, the Region, the maximum number of retention days, the minimum number of retention
* days, and optionally can include tags and a creator request ID.
*
*
*
* Do not include sensitive data, such as passport numbers, in the name of a backup vault.
*
*
*
* This is a convenience which creates an instance of the {@link CreateLogicallyAirGappedBackupVaultRequest.Builder}
* avoiding the need to create one manually via {@link CreateLogicallyAirGappedBackupVaultRequest#builder()}
*
*
* @param createLogicallyAirGappedBackupVaultRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.backup.model.CreateLogicallyAirGappedBackupVaultRequest.Builder} to
* create a request.
* @return Result of the CreateLogicallyAirGappedBackupVault operation returned by the service.
* @throws AlreadyExistsException
* The required resource already exists.
* @throws InvalidParameterValueException
* Indicates that something is wrong with a parameter's value. For example, the value is out of range.
* @throws LimitExceededException
* A limit in the request has been exceeded; for example, a maximum number of items allowed in a request.
* @throws MissingParameterValueException
* Indicates that a required parameter is missing.
* @throws ServiceUnavailableException
* The request failed due to a temporary failure of the server.
* @throws InvalidRequestException
* Indicates that something is wrong with the input to the request. For example, a parameter is of the wrong
* type.
* @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 BackupException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample BackupClient.CreateLogicallyAirGappedBackupVault
* @see AWS API Documentation
*/
default CreateLogicallyAirGappedBackupVaultResponse createLogicallyAirGappedBackupVault(
Consumer createLogicallyAirGappedBackupVaultRequest)
throws AlreadyExistsException, InvalidParameterValueException, LimitExceededException,
MissingParameterValueException, ServiceUnavailableException, InvalidRequestException, AwsServiceException,
SdkClientException, BackupException {
return createLogicallyAirGappedBackupVault(CreateLogicallyAirGappedBackupVaultRequest.builder()
.applyMutation(createLogicallyAirGappedBackupVaultRequest).build());
}
/**
*
* Creates a report plan. A report plan is a document that contains information about the contents of the report and
* where Backup will deliver it.
*
*
* If you call CreateReportPlan with a plan that already exists, you receive an
* AlreadyExistsException exception.
*
*
* @param createReportPlanRequest
* @return Result of the CreateReportPlan operation returned by the service.
* @throws AlreadyExistsException
* The required resource already exists.
* @throws LimitExceededException
* A limit in the request has been exceeded; for example, a maximum number of items allowed in a request.
* @throws InvalidParameterValueException
* Indicates that something is wrong with a parameter's value. For example, the value is out of range.
* @throws ServiceUnavailableException
* The request failed due to a temporary failure of the server.
* @throws MissingParameterValueException
* Indicates that a required parameter is missing.
* @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 BackupException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample BackupClient.CreateReportPlan
* @see AWS API
* Documentation
*/
default CreateReportPlanResponse createReportPlan(CreateReportPlanRequest createReportPlanRequest)
throws AlreadyExistsException, LimitExceededException, InvalidParameterValueException, ServiceUnavailableException,
MissingParameterValueException, AwsServiceException, SdkClientException, BackupException {
throw new UnsupportedOperationException();
}
/**
*
* Creates a report plan. A report plan is a document that contains information about the contents of the report and
* where Backup will deliver it.
*
*
* If you call CreateReportPlan with a plan that already exists, you receive an
* AlreadyExistsException exception.
*
*
*
* This is a convenience which creates an instance of the {@link CreateReportPlanRequest.Builder} avoiding the need
* to create one manually via {@link CreateReportPlanRequest#builder()}
*
*
* @param createReportPlanRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.backup.model.CreateReportPlanRequest.Builder} to create a request.
* @return Result of the CreateReportPlan operation returned by the service.
* @throws AlreadyExistsException
* The required resource already exists.
* @throws LimitExceededException
* A limit in the request has been exceeded; for example, a maximum number of items allowed in a request.
* @throws InvalidParameterValueException
* Indicates that something is wrong with a parameter's value. For example, the value is out of range.
* @throws ServiceUnavailableException
* The request failed due to a temporary failure of the server.
* @throws MissingParameterValueException
* Indicates that a required parameter is missing.
* @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 BackupException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample BackupClient.CreateReportPlan
* @see AWS API
* Documentation
*/
default CreateReportPlanResponse createReportPlan(Consumer createReportPlanRequest)
throws AlreadyExistsException, LimitExceededException, InvalidParameterValueException, ServiceUnavailableException,
MissingParameterValueException, AwsServiceException, SdkClientException, BackupException {
return createReportPlan(CreateReportPlanRequest.builder().applyMutation(createReportPlanRequest).build());
}
/**
*
* Creates a restore testing plan.
*
*
* The first of two steps to create a restore testing plan. After this request is successful, finish the procedure
* using CreateRestoreTestingSelection.
*
*
* @param createRestoreTestingPlanRequest
* @return Result of the CreateRestoreTestingPlan operation returned by the service.
* @throws AlreadyExistsException
* The required resource already exists.
* @throws ConflictException
* Backup can't perform the action that you requested until it finishes performing a previous action. Try
* again later.
* @throws InvalidParameterValueException
* Indicates that something is wrong with a parameter's value. For example, the value is out of range.
* @throws LimitExceededException
* A limit in the request has been exceeded; for example, a maximum number of items allowed in a request.
* @throws MissingParameterValueException
* Indicates that a required parameter is missing.
* @throws ServiceUnavailableException
* The request failed due to a temporary failure of the server.
* @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 BackupException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample BackupClient.CreateRestoreTestingPlan
* @see AWS API Documentation
*/
default CreateRestoreTestingPlanResponse createRestoreTestingPlan(
CreateRestoreTestingPlanRequest createRestoreTestingPlanRequest) throws AlreadyExistsException, ConflictException,
InvalidParameterValueException, LimitExceededException, MissingParameterValueException, ServiceUnavailableException,
AwsServiceException, SdkClientException, BackupException {
throw new UnsupportedOperationException();
}
/**
*
* Creates a restore testing plan.
*
*
* The first of two steps to create a restore testing plan. After this request is successful, finish the procedure
* using CreateRestoreTestingSelection.
*
*
*
* This is a convenience which creates an instance of the {@link CreateRestoreTestingPlanRequest.Builder} avoiding
* the need to create one manually via {@link CreateRestoreTestingPlanRequest#builder()}
*
*
* @param createRestoreTestingPlanRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.backup.model.CreateRestoreTestingPlanRequest.Builder} to create a
* request.
* @return Result of the CreateRestoreTestingPlan operation returned by the service.
* @throws AlreadyExistsException
* The required resource already exists.
* @throws ConflictException
* Backup can't perform the action that you requested until it finishes performing a previous action. Try
* again later.
* @throws InvalidParameterValueException
* Indicates that something is wrong with a parameter's value. For example, the value is out of range.
* @throws LimitExceededException
* A limit in the request has been exceeded; for example, a maximum number of items allowed in a request.
* @throws MissingParameterValueException
* Indicates that a required parameter is missing.
* @throws ServiceUnavailableException
* The request failed due to a temporary failure of the server.
* @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 BackupException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample BackupClient.CreateRestoreTestingPlan
* @see AWS API Documentation
*/
default CreateRestoreTestingPlanResponse createRestoreTestingPlan(
Consumer createRestoreTestingPlanRequest) throws AlreadyExistsException,
ConflictException, InvalidParameterValueException, LimitExceededException, MissingParameterValueException,
ServiceUnavailableException, AwsServiceException, SdkClientException, BackupException {
return createRestoreTestingPlan(CreateRestoreTestingPlanRequest.builder().applyMutation(createRestoreTestingPlanRequest)
.build());
}
/**
*
* This request can be sent after CreateRestoreTestingPlan request returns successfully. This is the second part of
* creating a resource testing plan, and it must be completed sequentially.
*
*
* This consists of RestoreTestingSelectionName, ProtectedResourceType, and one of the
* following:
*
*
* -
*
* ProtectedResourceArns
*
*
* -
*
* ProtectedResourceConditions
*
*
*
*
* Each protected resource type can have one single value.
*
*
* A restore testing selection can include a wildcard value ("*") for ProtectedResourceArns along with
* ProtectedResourceConditions. Alternatively, you can include up to 30 specific protected resource
* ARNs in ProtectedResourceArns.
*
*
* Cannot select by both protected resource types AND specific ARNs. Request will fail if both are included.
*
*
* @param createRestoreTestingSelectionRequest
* @return Result of the CreateRestoreTestingSelection operation returned by the service.
* @throws AlreadyExistsException
* The required resource already exists.
* @throws InvalidParameterValueException
* Indicates that something is wrong with a parameter's value. For example, the value is out of range.
* @throws LimitExceededException
* A limit in the request has been exceeded; for example, a maximum number of items allowed in a request.
* @throws MissingParameterValueException
* Indicates that a required parameter is missing.
* @throws ResourceNotFoundException
* A resource that is required for the action doesn't exist.
* @throws ServiceUnavailableException
* The request failed due to a temporary failure of the server.
* @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 BackupException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample BackupClient.CreateRestoreTestingSelection
* @see AWS API Documentation
*/
default CreateRestoreTestingSelectionResponse createRestoreTestingSelection(
CreateRestoreTestingSelectionRequest createRestoreTestingSelectionRequest) throws AlreadyExistsException,
InvalidParameterValueException, LimitExceededException, MissingParameterValueException, ResourceNotFoundException,
ServiceUnavailableException, AwsServiceException, SdkClientException, BackupException {
throw new UnsupportedOperationException();
}
/**
*
* This request can be sent after CreateRestoreTestingPlan request returns successfully. This is the second part of
* creating a resource testing plan, and it must be completed sequentially.
*
*
* This consists of RestoreTestingSelectionName, ProtectedResourceType, and one of the
* following:
*
*
* -
*
* ProtectedResourceArns
*
*
* -
*
* ProtectedResourceConditions
*
*
*
*
* Each protected resource type can have one single value.
*
*
* A restore testing selection can include a wildcard value ("*") for ProtectedResourceArns along with
* ProtectedResourceConditions. Alternatively, you can include up to 30 specific protected resource
* ARNs in ProtectedResourceArns.
*
*
* Cannot select by both protected resource types AND specific ARNs. Request will fail if both are included.
*
*
*
* This is a convenience which creates an instance of the {@link CreateRestoreTestingSelectionRequest.Builder}
* avoiding the need to create one manually via {@link CreateRestoreTestingSelectionRequest#builder()}
*
*
* @param createRestoreTestingSelectionRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.backup.model.CreateRestoreTestingSelectionRequest.Builder} to
* create a request.
* @return Result of the CreateRestoreTestingSelection operation returned by the service.
* @throws AlreadyExistsException
* The required resource already exists.
* @throws InvalidParameterValueException
* Indicates that something is wrong with a parameter's value. For example, the value is out of range.
* @throws LimitExceededException
* A limit in the request has been exceeded; for example, a maximum number of items allowed in a request.
* @throws MissingParameterValueException
* Indicates that a required parameter is missing.
* @throws ResourceNotFoundException
* A resource that is required for the action doesn't exist.
* @throws ServiceUnavailableException
* The request failed due to a temporary failure of the server.
* @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 BackupException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample BackupClient.CreateRestoreTestingSelection
* @see AWS API Documentation
*/
default CreateRestoreTestingSelectionResponse createRestoreTestingSelection(
Consumer createRestoreTestingSelectionRequest)
throws AlreadyExistsException, InvalidParameterValueException, LimitExceededException,
MissingParameterValueException, ResourceNotFoundException, ServiceUnavailableException, AwsServiceException,
SdkClientException, BackupException {
return createRestoreTestingSelection(CreateRestoreTestingSelectionRequest.builder()
.applyMutation(createRestoreTestingSelectionRequest).build());
}
/**
*
* Deletes a backup plan. A backup plan can only be deleted after all associated selections of resources have been
* deleted. Deleting a backup plan deletes the current version of a backup plan. Previous versions, if any, will
* still exist.
*
*
* @param deleteBackupPlanRequest
* @return Result of the DeleteBackupPlan operation returned by the service.
* @throws ResourceNotFoundException
* A resource that is required for the action doesn't exist.
* @throws InvalidParameterValueException
* Indicates that something is wrong with a parameter's value. For example, the value is out of range.
* @throws MissingParameterValueException
* Indicates that a required parameter is missing.
* @throws ServiceUnavailableException
* The request failed due to a temporary failure of the server.
* @throws InvalidRequestException
* Indicates that something is wrong with the input to the request. For example, a parameter is of the wrong
* type.
* @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 BackupException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample BackupClient.DeleteBackupPlan
* @see AWS API
* Documentation
*/
default DeleteBackupPlanResponse deleteBackupPlan(DeleteBackupPlanRequest deleteBackupPlanRequest)
throws ResourceNotFoundException, InvalidParameterValueException, MissingParameterValueException,
ServiceUnavailableException, InvalidRequestException, AwsServiceException, SdkClientException, BackupException {
throw new UnsupportedOperationException();
}
/**
*
* Deletes a backup plan. A backup plan can only be deleted after all associated selections of resources have been
* deleted. Deleting a backup plan deletes the current version of a backup plan. Previous versions, if any, will
* still exist.
*
*
*
* This is a convenience which creates an instance of the {@link DeleteBackupPlanRequest.Builder} avoiding the need
* to create one manually via {@link DeleteBackupPlanRequest#builder()}
*
*
* @param deleteBackupPlanRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.backup.model.DeleteBackupPlanRequest.Builder} to create a request.
* @return Result of the DeleteBackupPlan operation returned by the service.
* @throws ResourceNotFoundException
* A resource that is required for the action doesn't exist.
* @throws InvalidParameterValueException
* Indicates that something is wrong with a parameter's value. For example, the value is out of range.
* @throws MissingParameterValueException
* Indicates that a required parameter is missing.
* @throws ServiceUnavailableException
* The request failed due to a temporary failure of the server.
* @throws InvalidRequestException
* Indicates that something is wrong with the input to the request. For example, a parameter is of the wrong
* type.
* @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 BackupException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample BackupClient.DeleteBackupPlan
* @see AWS API
* Documentation
*/
default DeleteBackupPlanResponse deleteBackupPlan(Consumer deleteBackupPlanRequest)
throws ResourceNotFoundException, InvalidParameterValueException, MissingParameterValueException,
ServiceUnavailableException, InvalidRequestException, AwsServiceException, SdkClientException, BackupException {
return deleteBackupPlan(DeleteBackupPlanRequest.builder().applyMutation(deleteBackupPlanRequest).build());
}
/**
*
* Deletes the resource selection associated with a backup plan that is specified by the SelectionId.
*
*
* @param deleteBackupSelectionRequest
* @return Result of the DeleteBackupSelection operation returned by the service.
* @throws ResourceNotFoundException
* A resource that is required for the action doesn't exist.
* @throws InvalidParameterValueException
* Indicates that something is wrong with a parameter's value. For example, the value is out of range.
* @throws MissingParameterValueException
* Indicates that a required parameter is missing.
* @throws ServiceUnavailableException
* The request failed due to a temporary failure of the server.
* @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 BackupException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample BackupClient.DeleteBackupSelection
* @see AWS
* API Documentation
*/
default DeleteBackupSelectionResponse deleteBackupSelection(DeleteBackupSelectionRequest deleteBackupSelectionRequest)
throws ResourceNotFoundException, InvalidParameterValueException, MissingParameterValueException,
ServiceUnavailableException, AwsServiceException, SdkClientException, BackupException {
throw new UnsupportedOperationException();
}
/**
*
* Deletes the resource selection associated with a backup plan that is specified by the SelectionId.
*
*
*
* This is a convenience which creates an instance of the {@link DeleteBackupSelectionRequest.Builder} avoiding the
* need to create one manually via {@link DeleteBackupSelectionRequest#builder()}
*
*
* @param deleteBackupSelectionRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.backup.model.DeleteBackupSelectionRequest.Builder} to create a
* request.
* @return Result of the DeleteBackupSelection operation returned by the service.
* @throws ResourceNotFoundException
* A resource that is required for the action doesn't exist.
* @throws InvalidParameterValueException
* Indicates that something is wrong with a parameter's value. For example, the value is out of range.
* @throws MissingParameterValueException
* Indicates that a required parameter is missing.
* @throws ServiceUnavailableException
* The request failed due to a temporary failure of the server.
* @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 BackupException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample BackupClient.DeleteBackupSelection
* @see AWS
* API Documentation
*/
default DeleteBackupSelectionResponse deleteBackupSelection(
Consumer deleteBackupSelectionRequest) throws ResourceNotFoundException,
InvalidParameterValueException, MissingParameterValueException, ServiceUnavailableException, AwsServiceException,
SdkClientException, BackupException {
return deleteBackupSelection(DeleteBackupSelectionRequest.builder().applyMutation(deleteBackupSelectionRequest).build());
}
/**
*
* Deletes the backup vault identified by its name. A vault can be deleted only if it is empty.
*
*
* @param deleteBackupVaultRequest
* @return Result of the DeleteBackupVault operation returned by the service.
* @throws ResourceNotFoundException
* A resource that is required for the action doesn't exist.
* @throws InvalidParameterValueException
* Indicates that something is wrong with a parameter's value. For example, the value is out of range.
* @throws MissingParameterValueException
* Indicates that a required parameter is missing.
* @throws ServiceUnavailableException
* The request failed due to a temporary failure of the server.
* @throws InvalidRequestException
* Indicates that something is wrong with the input to the request. For example, a parameter is of the wrong
* type.
* @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 BackupException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample BackupClient.DeleteBackupVault
* @see AWS API
* Documentation
*/
default DeleteBackupVaultResponse deleteBackupVault(DeleteBackupVaultRequest deleteBackupVaultRequest)
throws ResourceNotFoundException, InvalidParameterValueException, MissingParameterValueException,
ServiceUnavailableException, InvalidRequestException, AwsServiceException, SdkClientException, BackupException {
throw new UnsupportedOperationException();
}
/**
*
* Deletes the backup vault identified by its name. A vault can be deleted only if it is empty.
*
*
*
* This is a convenience which creates an instance of the {@link DeleteBackupVaultRequest.Builder} avoiding the need
* to create one manually via {@link DeleteBackupVaultRequest#builder()}
*
*
* @param deleteBackupVaultRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.backup.model.DeleteBackupVaultRequest.Builder} to create a request.
* @return Result of the DeleteBackupVault operation returned by the service.
* @throws ResourceNotFoundException
* A resource that is required for the action doesn't exist.
* @throws InvalidParameterValueException
* Indicates that something is wrong with a parameter's value. For example, the value is out of range.
* @throws MissingParameterValueException
* Indicates that a required parameter is missing.
* @throws ServiceUnavailableException
* The request failed due to a temporary failure of the server.
* @throws InvalidRequestException
* Indicates that something is wrong with the input to the request. For example, a parameter is of the wrong
* type.
* @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 BackupException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample BackupClient.DeleteBackupVault
* @see AWS API
* Documentation
*/
default DeleteBackupVaultResponse deleteBackupVault(Consumer deleteBackupVaultRequest)
throws ResourceNotFoundException, InvalidParameterValueException, MissingParameterValueException,
ServiceUnavailableException, InvalidRequestException, AwsServiceException, SdkClientException, BackupException {
return deleteBackupVault(DeleteBackupVaultRequest.builder().applyMutation(deleteBackupVaultRequest).build());
}
/**
*
* Deletes the policy document that manages permissions on a backup vault.
*
*
* @param deleteBackupVaultAccessPolicyRequest
* @return Result of the DeleteBackupVaultAccessPolicy operation returned by the service.
* @throws ResourceNotFoundException
* A resource that is required for the action doesn't exist.
* @throws InvalidParameterValueException
* Indicates that something is wrong with a parameter's value. For example, the value is out of range.
* @throws MissingParameterValueException
* Indicates that a required parameter is missing.
* @throws ServiceUnavailableException
* The request failed due to a temporary failure of the server.
* @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 BackupException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample BackupClient.DeleteBackupVaultAccessPolicy
* @see AWS API Documentation
*/
default DeleteBackupVaultAccessPolicyResponse deleteBackupVaultAccessPolicy(
DeleteBackupVaultAccessPolicyRequest deleteBackupVaultAccessPolicyRequest) throws ResourceNotFoundException,
InvalidParameterValueException, MissingParameterValueException, ServiceUnavailableException, AwsServiceException,
SdkClientException, BackupException {
throw new UnsupportedOperationException();
}
/**
*
* Deletes the policy document that manages permissions on a backup vault.
*
*
*
* This is a convenience which creates an instance of the {@link DeleteBackupVaultAccessPolicyRequest.Builder}
* avoiding the need to create one manually via {@link DeleteBackupVaultAccessPolicyRequest#builder()}
*
*
* @param deleteBackupVaultAccessPolicyRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.backup.model.DeleteBackupVaultAccessPolicyRequest.Builder} to
* create a request.
* @return Result of the DeleteBackupVaultAccessPolicy operation returned by the service.
* @throws ResourceNotFoundException
* A resource that is required for the action doesn't exist.
* @throws InvalidParameterValueException
* Indicates that something is wrong with a parameter's value. For example, the value is out of range.
* @throws MissingParameterValueException
* Indicates that a required parameter is missing.
* @throws ServiceUnavailableException
* The request failed due to a temporary failure of the server.
* @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 BackupException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample BackupClient.DeleteBackupVaultAccessPolicy
* @see AWS API Documentation
*/
default DeleteBackupVaultAccessPolicyResponse deleteBackupVaultAccessPolicy(
Consumer deleteBackupVaultAccessPolicyRequest)
throws ResourceNotFoundException, InvalidParameterValueException, MissingParameterValueException,
ServiceUnavailableException, AwsServiceException, SdkClientException, BackupException {
return deleteBackupVaultAccessPolicy(DeleteBackupVaultAccessPolicyRequest.builder()
.applyMutation(deleteBackupVaultAccessPolicyRequest).build());
}
/**
*
* Deletes Backup Vault Lock from a backup vault specified by a backup vault name.
*
*
* If the Vault Lock configuration is immutable, then you cannot delete Vault Lock using API operations, and you
* will receive an InvalidRequestException if you attempt to do so. For more information, see Vault Lock in the Backup
* Developer Guide.
*
*
* @param deleteBackupVaultLockConfigurationRequest
* @return Result of the DeleteBackupVaultLockConfiguration operation returned by the service.
* @throws ResourceNotFoundException
* A resource that is required for the action doesn't exist.
* @throws InvalidParameterValueException
* Indicates that something is wrong with a parameter's value. For example, the value is out of range.
* @throws MissingParameterValueException
* Indicates that a required parameter is missing.
* @throws InvalidRequestException
* Indicates that something is wrong with the input to the request. For example, a parameter is of the wrong
* type.
* @throws ServiceUnavailableException
* The request failed due to a temporary failure of the server.
* @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 BackupException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample BackupClient.DeleteBackupVaultLockConfiguration
* @see AWS API Documentation
*/
default DeleteBackupVaultLockConfigurationResponse deleteBackupVaultLockConfiguration(
DeleteBackupVaultLockConfigurationRequest deleteBackupVaultLockConfigurationRequest)
throws ResourceNotFoundException, InvalidParameterValueException, MissingParameterValueException,
InvalidRequestException, ServiceUnavailableException, AwsServiceException, SdkClientException, BackupException {
throw new UnsupportedOperationException();
}
/**
*
* Deletes Backup Vault Lock from a backup vault specified by a backup vault name.
*
*
* If the Vault Lock configuration is immutable, then you cannot delete Vault Lock using API operations, and you
* will receive an InvalidRequestException if you attempt to do so. For more information, see Vault Lock in the Backup
* Developer Guide.
*
*
*
* This is a convenience which creates an instance of the {@link DeleteBackupVaultLockConfigurationRequest.Builder}
* avoiding the need to create one manually via {@link DeleteBackupVaultLockConfigurationRequest#builder()}
*
*
* @param deleteBackupVaultLockConfigurationRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.backup.model.DeleteBackupVaultLockConfigurationRequest.Builder} to
* create a request.
* @return Result of the DeleteBackupVaultLockConfiguration operation returned by the service.
* @throws ResourceNotFoundException
* A resource that is required for the action doesn't exist.
* @throws InvalidParameterValueException
* Indicates that something is wrong with a parameter's value. For example, the value is out of range.
* @throws MissingParameterValueException
* Indicates that a required parameter is missing.
* @throws InvalidRequestException
* Indicates that something is wrong with the input to the request. For example, a parameter is of the wrong
* type.
* @throws ServiceUnavailableException
* The request failed due to a temporary failure of the server.
* @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 BackupException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample BackupClient.DeleteBackupVaultLockConfiguration
* @see AWS API Documentation
*/
default DeleteBackupVaultLockConfigurationResponse deleteBackupVaultLockConfiguration(
Consumer deleteBackupVaultLockConfigurationRequest)
throws ResourceNotFoundException, InvalidParameterValueException, MissingParameterValueException,
InvalidRequestException, ServiceUnavailableException, AwsServiceException, SdkClientException, BackupException {
return deleteBackupVaultLockConfiguration(DeleteBackupVaultLockConfigurationRequest.builder()
.applyMutation(deleteBackupVaultLockConfigurationRequest).build());
}
/**
*
* Deletes event notifications for the specified backup vault.
*
*
* @param deleteBackupVaultNotificationsRequest
* @return Result of the DeleteBackupVaultNotifications operation returned by the service.
* @throws ResourceNotFoundException
* A resource that is required for the action doesn't exist.
* @throws InvalidParameterValueException
* Indicates that something is wrong with a parameter's value. For example, the value is out of range.
* @throws MissingParameterValueException
* Indicates that a required parameter is missing.
* @throws ServiceUnavailableException
* The request failed due to a temporary failure of the server.
* @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 BackupException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample BackupClient.DeleteBackupVaultNotifications
* @see AWS API Documentation
*/
default DeleteBackupVaultNotificationsResponse deleteBackupVaultNotifications(
DeleteBackupVaultNotificationsRequest deleteBackupVaultNotificationsRequest) throws ResourceNotFoundException,
InvalidParameterValueException, MissingParameterValueException, ServiceUnavailableException, AwsServiceException,
SdkClientException, BackupException {
throw new UnsupportedOperationException();
}
/**
*
* Deletes event notifications for the specified backup vault.
*
*
*
* This is a convenience which creates an instance of the {@link DeleteBackupVaultNotificationsRequest.Builder}
* avoiding the need to create one manually via {@link DeleteBackupVaultNotificationsRequest#builder()}
*
*
* @param deleteBackupVaultNotificationsRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.backup.model.DeleteBackupVaultNotificationsRequest.Builder} to
* create a request.
* @return Result of the DeleteBackupVaultNotifications operation returned by the service.
* @throws ResourceNotFoundException
* A resource that is required for the action doesn't exist.
* @throws InvalidParameterValueException
* Indicates that something is wrong with a parameter's value. For example, the value is out of range.
* @throws MissingParameterValueException
* Indicates that a required parameter is missing.
* @throws ServiceUnavailableException
* The request failed due to a temporary failure of the server.
* @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 BackupException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample BackupClient.DeleteBackupVaultNotifications
* @see AWS API Documentation
*/
default DeleteBackupVaultNotificationsResponse deleteBackupVaultNotifications(
Consumer deleteBackupVaultNotificationsRequest)
throws ResourceNotFoundException, InvalidParameterValueException, MissingParameterValueException,
ServiceUnavailableException, AwsServiceException, SdkClientException, BackupException {
return deleteBackupVaultNotifications(DeleteBackupVaultNotificationsRequest.builder()
.applyMutation(deleteBackupVaultNotificationsRequest).build());
}
/**
*
* Deletes the framework specified by a framework name.
*
*
* @param deleteFrameworkRequest
* @return Result of the DeleteFramework operation returned by the service.
* @throws MissingParameterValueException
* Indicates that a required parameter is missing.
* @throws InvalidParameterValueException
* Indicates that something is wrong with a parameter's value. For example, the value is out of range.
* @throws ServiceUnavailableException
* The request failed due to a temporary failure of the server.
* @throws ConflictException
* Backup can't perform the action that you requested until it finishes performing a previous action. Try
* again later.
* @throws ResourceNotFoundException
* A resource that is required for the action doesn't 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 BackupException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample BackupClient.DeleteFramework
* @see AWS API
* Documentation
*/
default DeleteFrameworkResponse deleteFramework(DeleteFrameworkRequest deleteFrameworkRequest)
throws MissingParameterValueException, InvalidParameterValueException, ServiceUnavailableException,
ConflictException, ResourceNotFoundException, AwsServiceException, SdkClientException, BackupException {
throw new UnsupportedOperationException();
}
/**
*
* Deletes the framework specified by a framework name.
*
*
*
* This is a convenience which creates an instance of the {@link DeleteFrameworkRequest.Builder} avoiding the need
* to create one manually via {@link DeleteFrameworkRequest#builder()}
*
*
* @param deleteFrameworkRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.backup.model.DeleteFrameworkRequest.Builder} to create a request.
* @return Result of the DeleteFramework operation returned by the service.
* @throws MissingParameterValueException
* Indicates that a required parameter is missing.
* @throws InvalidParameterValueException
* Indicates that something is wrong with a parameter's value. For example, the value is out of range.
* @throws ServiceUnavailableException
* The request failed due to a temporary failure of the server.
* @throws ConflictException
* Backup can't perform the action that you requested until it finishes performing a previous action. Try
* again later.
* @throws ResourceNotFoundException
* A resource that is required for the action doesn't 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 BackupException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample BackupClient.DeleteFramework
* @see AWS API
* Documentation
*/
default DeleteFrameworkResponse deleteFramework(Consumer deleteFrameworkRequest)
throws MissingParameterValueException, InvalidParameterValueException, ServiceUnavailableException,
ConflictException, ResourceNotFoundException, AwsServiceException, SdkClientException, BackupException {
return deleteFramework(DeleteFrameworkRequest.builder().applyMutation(deleteFrameworkRequest).build());
}
/**
*
* Deletes the recovery point specified by a recovery point ID.
*
*
* If the recovery point ID belongs to a continuous backup, calling this endpoint deletes the existing continuous
* backup and stops future continuous backup.
*
*
* When an IAM role's permissions are insufficient to call this API, the service sends back an HTTP 200 response
* with an empty HTTP body, but the recovery point is not deleted. Instead, it enters an EXPIRED state.
*
*
* EXPIRED recovery points can be deleted with this API once the IAM role has the
* iam:CreateServiceLinkedRole action. To learn more about adding this role, see
* Troubleshooting manual deletions.
*
*
* If the user or role is deleted or the permission within the role is removed, the deletion will not be successful
* and will enter an EXPIRED state.
*
*
* @param deleteRecoveryPointRequest
* @return Result of the DeleteRecoveryPoint operation returned by the service.
* @throws ResourceNotFoundException
* A resource that is required for the action doesn't exist.
* @throws InvalidParameterValueException
* Indicates that something is wrong with a parameter's value. For example, the value is out of range.
* @throws MissingParameterValueException
* Indicates that a required parameter is missing.
* @throws InvalidResourceStateException
* Backup is already performing an action on this recovery point. It can't perform the action you requested
* until the first action finishes. Try again later.
* @throws ServiceUnavailableException
* The request failed due to a temporary failure of the server.
* @throws InvalidRequestException
* Indicates that something is wrong with the input to the request. For example, a parameter is of the wrong
* type.
* @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 BackupException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample BackupClient.DeleteRecoveryPoint
* @see AWS
* API Documentation
*/
default DeleteRecoveryPointResponse deleteRecoveryPoint(DeleteRecoveryPointRequest deleteRecoveryPointRequest)
throws ResourceNotFoundException, InvalidParameterValueException, MissingParameterValueException,
InvalidResourceStateException, ServiceUnavailableException, InvalidRequestException, AwsServiceException,
SdkClientException, BackupException {
throw new UnsupportedOperationException();
}
/**
*
* Deletes the recovery point specified by a recovery point ID.
*
*
* If the recovery point ID belongs to a continuous backup, calling this endpoint deletes the existing continuous
* backup and stops future continuous backup.
*
*
* When an IAM role's permissions are insufficient to call this API, the service sends back an HTTP 200 response
* with an empty HTTP body, but the recovery point is not deleted. Instead, it enters an EXPIRED state.
*
*
* EXPIRED recovery points can be deleted with this API once the IAM role has the
* iam:CreateServiceLinkedRole action. To learn more about adding this role, see
* Troubleshooting manual deletions.
*
*
* If the user or role is deleted or the permission within the role is removed, the deletion will not be successful
* and will enter an EXPIRED state.
*
*
*
* This is a convenience which creates an instance of the {@link DeleteRecoveryPointRequest.Builder} avoiding the
* need to create one manually via {@link DeleteRecoveryPointRequest#builder()}
*
*
* @param deleteRecoveryPointRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.backup.model.DeleteRecoveryPointRequest.Builder} to create a
* request.
* @return Result of the DeleteRecoveryPoint operation returned by the service.
* @throws ResourceNotFoundException
* A resource that is required for the action doesn't exist.
* @throws InvalidParameterValueException
* Indicates that something is wrong with a parameter's value. For example, the value is out of range.
* @throws MissingParameterValueException
* Indicates that a required parameter is missing.
* @throws InvalidResourceStateException
* Backup is already performing an action on this recovery point. It can't perform the action you requested
* until the first action finishes. Try again later.
* @throws ServiceUnavailableException
* The request failed due to a temporary failure of the server.
* @throws InvalidRequestException
* Indicates that something is wrong with the input to the request. For example, a parameter is of the wrong
* type.
* @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 BackupException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample BackupClient.DeleteRecoveryPoint
* @see AWS
* API Documentation
*/
default DeleteRecoveryPointResponse deleteRecoveryPoint(
Consumer deleteRecoveryPointRequest) throws ResourceNotFoundException,
InvalidParameterValueException, MissingParameterValueException, InvalidResourceStateException,
ServiceUnavailableException, InvalidRequestException, AwsServiceException, SdkClientException, BackupException {
return deleteRecoveryPoint(DeleteRecoveryPointRequest.builder().applyMutation(deleteRecoveryPointRequest).build());
}
/**
*
* Deletes the report plan specified by a report plan name.
*
*
* @param deleteReportPlanRequest
* @return Result of the DeleteReportPlan operation returned by the service.
* @throws MissingParameterValueException
* Indicates that a required parameter is missing.
* @throws InvalidParameterValueException
* Indicates that something is wrong with a parameter's value. For example, the value is out of range.
* @throws ConflictException
* Backup can't perform the action that you requested until it finishes performing a previous action. Try
* again later.
* @throws ServiceUnavailableException
* The request failed due to a temporary failure of the server.
* @throws ResourceNotFoundException
* A resource that is required for the action doesn't 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 BackupException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample BackupClient.DeleteReportPlan
* @see AWS API
* Documentation
*/
default DeleteReportPlanResponse deleteReportPlan(DeleteReportPlanRequest deleteReportPlanRequest)
throws MissingParameterValueException, InvalidParameterValueException, ConflictException,
ServiceUnavailableException, ResourceNotFoundException, AwsServiceException, SdkClientException, BackupException {
throw new UnsupportedOperationException();
}
/**
*
* Deletes the report plan specified by a report plan name.
*
*
*
* This is a convenience which creates an instance of the {@link DeleteReportPlanRequest.Builder} avoiding the need
* to create one manually via {@link DeleteReportPlanRequest#builder()}
*
*
* @param deleteReportPlanRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.backup.model.DeleteReportPlanRequest.Builder} to create a request.
* @return Result of the DeleteReportPlan operation returned by the service.
* @throws MissingParameterValueException
* Indicates that a required parameter is missing.
* @throws InvalidParameterValueException
* Indicates that something is wrong with a parameter's value. For example, the value is out of range.
* @throws ConflictException
* Backup can't perform the action that you requested until it finishes performing a previous action. Try
* again later.
* @throws ServiceUnavailableException
* The request failed due to a temporary failure of the server.
* @throws ResourceNotFoundException
* A resource that is required for the action doesn't 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 BackupException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample BackupClient.DeleteReportPlan
* @see AWS API
* Documentation
*/
default DeleteReportPlanResponse deleteReportPlan(Consumer deleteReportPlanRequest)
throws MissingParameterValueException, InvalidParameterValueException, ConflictException,
ServiceUnavailableException, ResourceNotFoundException, AwsServiceException, SdkClientException, BackupException {
return deleteReportPlan(DeleteReportPlanRequest.builder().applyMutation(deleteReportPlanRequest).build());
}
/**
*
* This request deletes the specified restore testing plan.
*
*
* Deletion can only successfully occur if all associated restore testing selections are deleted first.
*
*
* @param deleteRestoreTestingPlanRequest
* @return Result of the DeleteRestoreTestingPlan operation returned by the service.
* @throws InvalidRequestException
* Indicates that something is wrong with the input to the request. For example, a parameter is of the wrong
* type.
* @throws ServiceUnavailableException
* The request failed due to a temporary failure of the server.
* @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 BackupException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample BackupClient.DeleteRestoreTestingPlan
* @see AWS API Documentation
*/
default DeleteRestoreTestingPlanResponse deleteRestoreTestingPlan(
DeleteRestoreTestingPlanRequest deleteRestoreTestingPlanRequest) throws InvalidRequestException,
ServiceUnavailableException, AwsServiceException, SdkClientException, BackupException {
throw new UnsupportedOperationException();
}
/**
*
* This request deletes the specified restore testing plan.
*
*
* Deletion can only successfully occur if all associated restore testing selections are deleted first.
*
*
*
* This is a convenience which creates an instance of the {@link DeleteRestoreTestingPlanRequest.Builder} avoiding
* the need to create one manually via {@link DeleteRestoreTestingPlanRequest#builder()}
*
*
* @param deleteRestoreTestingPlanRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.backup.model.DeleteRestoreTestingPlanRequest.Builder} to create a
* request.
* @return Result of the DeleteRestoreTestingPlan operation returned by the service.
* @throws InvalidRequestException
* Indicates that something is wrong with the input to the request. For example, a parameter is of the wrong
* type.
* @throws ServiceUnavailableException
* The request failed due to a temporary failure of the server.
* @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 BackupException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample BackupClient.DeleteRestoreTestingPlan
* @see AWS API Documentation
*/
default DeleteRestoreTestingPlanResponse deleteRestoreTestingPlan(
Consumer deleteRestoreTestingPlanRequest) throws InvalidRequestException,
ServiceUnavailableException, AwsServiceException, SdkClientException, BackupException {
return deleteRestoreTestingPlan(DeleteRestoreTestingPlanRequest.builder().applyMutation(deleteRestoreTestingPlanRequest)
.build());
}
/**
*
* Input the Restore Testing Plan name and Restore Testing Selection name.
*
*
* All testing selections associated with a restore testing plan must be deleted before the restore testing plan can
* be deleted.
*
*
* @param deleteRestoreTestingSelectionRequest
* @return Result of the DeleteRestoreTestingSelection operation returned by the service.
* @throws ResourceNotFoundException
* A resource that is required for the action doesn't exist.
* @throws ServiceUnavailableException
* The request failed due to a temporary failure of the server.
* @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 BackupException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample BackupClient.DeleteRestoreTestingSelection
* @see AWS API Documentation
*/
default DeleteRestoreTestingSelectionResponse deleteRestoreTestingSelection(
DeleteRestoreTestingSelectionRequest deleteRestoreTestingSelectionRequest) throws ResourceNotFoundException,
ServiceUnavailableException, AwsServiceException, SdkClientException, BackupException {
throw new UnsupportedOperationException();
}
/**
*
* Input the Restore Testing Plan name and Restore Testing Selection name.
*
*
* All testing selections associated with a restore testing plan must be deleted before the restore testing plan can
* be deleted.
*
*
*
* This is a convenience which creates an instance of the {@link DeleteRestoreTestingSelectionRequest.Builder}
* avoiding the need to create one manually via {@link DeleteRestoreTestingSelectionRequest#builder()}
*
*
* @param deleteRestoreTestingSelectionRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.backup.model.DeleteRestoreTestingSelectionRequest.Builder} to
* create a request.
* @return Result of the DeleteRestoreTestingSelection operation returned by the service.
* @throws ResourceNotFoundException
* A resource that is required for the action doesn't exist.
* @throws ServiceUnavailableException
* The request failed due to a temporary failure of the server.
* @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 BackupException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample BackupClient.DeleteRestoreTestingSelection
* @see AWS API Documentation
*/
default DeleteRestoreTestingSelectionResponse deleteRestoreTestingSelection(
Consumer deleteRestoreTestingSelectionRequest)
throws ResourceNotFoundException, ServiceUnavailableException, AwsServiceException, SdkClientException,
BackupException {
return deleteRestoreTestingSelection(DeleteRestoreTestingSelectionRequest.builder()
.applyMutation(deleteRestoreTestingSelectionRequest).build());
}
/**
*
* Returns backup job details for the specified BackupJobId.
*
*
* @param describeBackupJobRequest
* @return Result of the DescribeBackupJob operation returned by the service.
* @throws ResourceNotFoundException
* A resource that is required for the action doesn't exist.
* @throws InvalidParameterValueException
* Indicates that something is wrong with a parameter's value. For example, the value is out of range.
* @throws MissingParameterValueException
* Indicates that a required parameter is missing.
* @throws ServiceUnavailableException
* The request failed due to a temporary failure of the server.
* @throws DependencyFailureException
* A dependent Amazon Web Services service or resource returned an error to the Backup service, and the
* action cannot be completed.
* @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 BackupException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample BackupClient.DescribeBackupJob
* @see AWS API
* Documentation
*/
default DescribeBackupJobResponse describeBackupJob(DescribeBackupJobRequest describeBackupJobRequest)
throws ResourceNotFoundException, InvalidParameterValueException, MissingParameterValueException,
ServiceUnavailableException, DependencyFailureException, AwsServiceException, SdkClientException, BackupException {
throw new UnsupportedOperationException();
}
/**
*
* Returns backup job details for the specified BackupJobId.
*
*
*
* This is a convenience which creates an instance of the {@link DescribeBackupJobRequest.Builder} avoiding the need
* to create one manually via {@link DescribeBackupJobRequest#builder()}
*
*
* @param describeBackupJobRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.backup.model.DescribeBackupJobRequest.Builder} to create a request.
* @return Result of the DescribeBackupJob operation returned by the service.
* @throws ResourceNotFoundException
* A resource that is required for the action doesn't exist.
* @throws InvalidParameterValueException
* Indicates that something is wrong with a parameter's value. For example, the value is out of range.
* @throws MissingParameterValueException
* Indicates that a required parameter is missing.
* @throws ServiceUnavailableException
* The request failed due to a temporary failure of the server.
* @throws DependencyFailureException
* A dependent Amazon Web Services service or resource returned an error to the Backup service, and the
* action cannot be completed.
* @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 BackupException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample BackupClient.DescribeBackupJob
* @see AWS API
* Documentation
*/
default DescribeBackupJobResponse describeBackupJob(Consumer describeBackupJobRequest)
throws ResourceNotFoundException, InvalidParameterValueException, MissingParameterValueException,
ServiceUnavailableException, DependencyFailureException, AwsServiceException, SdkClientException, BackupException {
return describeBackupJob(DescribeBackupJobRequest.builder().applyMutation(describeBackupJobRequest).build());
}
/**
*
* Returns metadata about a backup vault specified by its name.
*
*
* @param describeBackupVaultRequest
* @return Result of the DescribeBackupVault operation returned by the service.
* @throws ResourceNotFoundException
* A resource that is required for the action doesn't exist.
* @throws InvalidParameterValueException
* Indicates that something is wrong with a parameter's value. For example, the value is out of range.
* @throws MissingParameterValueException
* Indicates that a required parameter is missing.
* @throws ServiceUnavailableException
* The request failed due to a temporary failure of the server.
* @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 BackupException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample BackupClient.DescribeBackupVault
* @see AWS
* API Documentation
*/
default DescribeBackupVaultResponse describeBackupVault(DescribeBackupVaultRequest describeBackupVaultRequest)
throws ResourceNotFoundException, InvalidParameterValueException, MissingParameterValueException,
ServiceUnavailableException, AwsServiceException, SdkClientException, BackupException {
throw new UnsupportedOperationException();
}
/**
*
* Returns metadata about a backup vault specified by its name.
*
*
*
* This is a convenience which creates an instance of the {@link DescribeBackupVaultRequest.Builder} avoiding the
* need to create one manually via {@link DescribeBackupVaultRequest#builder()}
*
*
* @param describeBackupVaultRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.backup.model.DescribeBackupVaultRequest.Builder} to create a
* request.
* @return Result of the DescribeBackupVault operation returned by the service.
* @throws ResourceNotFoundException
* A resource that is required for the action doesn't exist.
* @throws InvalidParameterValueException
* Indicates that something is wrong with a parameter's value. For example, the value is out of range.
* @throws MissingParameterValueException
* Indicates that a required parameter is missing.
* @throws ServiceUnavailableException
* The request failed due to a temporary failure of the server.
* @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 BackupException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample BackupClient.DescribeBackupVault
* @see AWS
* API Documentation
*/
default DescribeBackupVaultResponse describeBackupVault(
Consumer describeBackupVaultRequest) throws ResourceNotFoundException,
InvalidParameterValueException, MissingParameterValueException, ServiceUnavailableException, AwsServiceException,
SdkClientException, BackupException {
return describeBackupVault(DescribeBackupVaultRequest.builder().applyMutation(describeBackupVaultRequest).build());
}
/**
*
* Returns metadata associated with creating a copy of a resource.
*
*
* @param describeCopyJobRequest
* @return Result of the DescribeCopyJob operation returned by the service.
* @throws ResourceNotFoundException
* A resource that is required for the action doesn't exist.
* @throws InvalidParameterValueException
* Indicates that something is wrong with a parameter's value. For example, the value is out of range.
* @throws MissingParameterValueException
* Indicates that a required parameter is missing.
* @throws ServiceUnavailableException
* The request failed due to a temporary failure of the server.
* @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 BackupException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample BackupClient.DescribeCopyJob
* @see AWS API
* Documentation
*/
default DescribeCopyJobResponse describeCopyJob(DescribeCopyJobRequest describeCopyJobRequest)
throws ResourceNotFoundException, InvalidParameterValueException, MissingParameterValueException,
ServiceUnavailableException, AwsServiceException, SdkClientException, BackupException {
throw new UnsupportedOperationException();
}
/**
*
* Returns metadata associated with creating a copy of a resource.
*
*
*
* This is a convenience which creates an instance of the {@link DescribeCopyJobRequest.Builder} avoiding the need
* to create one manually via {@link DescribeCopyJobRequest#builder()}
*
*
* @param describeCopyJobRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.backup.model.DescribeCopyJobRequest.Builder} to create a request.
* @return Result of the DescribeCopyJob operation returned by the service.
* @throws ResourceNotFoundException
* A resource that is required for the action doesn't exist.
* @throws InvalidParameterValueException
* Indicates that something is wrong with a parameter's value. For example, the value is out of range.
* @throws MissingParameterValueException
* Indicates that a required parameter is missing.
* @throws ServiceUnavailableException
* The request failed due to a temporary failure of the server.
* @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 BackupException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample BackupClient.DescribeCopyJob
* @see AWS API
* Documentation
*/
default DescribeCopyJobResponse describeCopyJob(Consumer describeCopyJobRequest)
throws ResourceNotFoundException, InvalidParameterValueException, MissingParameterValueException,
ServiceUnavailableException, AwsServiceException, SdkClientException, BackupException {
return describeCopyJob(DescribeCopyJobRequest.builder().applyMutation(describeCopyJobRequest).build());
}
/**
*
* Returns the framework details for the specified FrameworkName.
*
*
* @param describeFrameworkRequest
* @return Result of the DescribeFramework operation returned by the service.
* @throws ResourceNotFoundException
* A resource that is required for the action doesn't exist.
* @throws InvalidParameterValueException
* Indicates that something is wrong with a parameter's value. For example, the value is out of range.
* @throws MissingParameterValueException
* Indicates that a required parameter is missing.
* @throws ServiceUnavailableException
* The request failed due to a temporary failure of the server.
* @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 BackupException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample BackupClient.DescribeFramework
* @see AWS API
* Documentation
*/
default DescribeFrameworkResponse describeFramework(DescribeFrameworkRequest describeFrameworkRequest)
throws ResourceNotFoundException, InvalidParameterValueException, MissingParameterValueException,
ServiceUnavailableException, AwsServiceException, SdkClientException, BackupException {
throw new UnsupportedOperationException();
}
/**
*
* Returns the framework details for the specified FrameworkName.
*
*
*
* This is a convenience which creates an instance of the {@link DescribeFrameworkRequest.Builder} avoiding the need
* to create one manually via {@link DescribeFrameworkRequest#builder()}
*
*
* @param describeFrameworkRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.backup.model.DescribeFrameworkRequest.Builder} to create a request.
* @return Result of the DescribeFramework operation returned by the service.
* @throws ResourceNotFoundException
* A resource that is required for the action doesn't exist.
* @throws InvalidParameterValueException
* Indicates that something is wrong with a parameter's value. For example, the value is out of range.
* @throws MissingParameterValueException
* Indicates that a required parameter is missing.
* @throws ServiceUnavailableException
* The request failed due to a temporary failure of the server.
* @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 BackupException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample BackupClient.DescribeFramework
* @see AWS API
* Documentation
*/
default DescribeFrameworkResponse describeFramework(Consumer describeFrameworkRequest)
throws ResourceNotFoundException, InvalidParameterValueException, MissingParameterValueException,
ServiceUnavailableException, AwsServiceException, SdkClientException, BackupException {
return describeFramework(DescribeFrameworkRequest.builder().applyMutation(describeFrameworkRequest).build());
}
/**
*
* Describes whether the Amazon Web Services account is opted in to cross-account backup. Returns an error if the
* account is not a member of an Organizations organization. Example:
* describe-global-settings --region us-west-2
*
*
* @param describeGlobalSettingsRequest
* @return Result of the DescribeGlobalSettings operation returned by the service.
* @throws InvalidRequestException
* Indicates that something is wrong with the input to the request. For example, a parameter is of the wrong
* type.
* @throws ServiceUnavailableException
* The request failed due to a temporary failure of the server.
* @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 BackupException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample BackupClient.DescribeGlobalSettings
* @see AWS
* API Documentation
*/
default DescribeGlobalSettingsResponse describeGlobalSettings(DescribeGlobalSettingsRequest describeGlobalSettingsRequest)
throws InvalidRequestException, ServiceUnavailableException, AwsServiceException, SdkClientException, BackupException {
throw new UnsupportedOperationException();
}
/**
*
* Describes whether the Amazon Web Services account is opted in to cross-account backup. Returns an error if the
* account is not a member of an Organizations organization. Example:
* describe-global-settings --region us-west-2
*
*
*
* This is a convenience which creates an instance of the {@link DescribeGlobalSettingsRequest.Builder} avoiding the
* need to create one manually via {@link DescribeGlobalSettingsRequest#builder()}
*
*
* @param describeGlobalSettingsRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.backup.model.DescribeGlobalSettingsRequest.Builder} to create a
* request.
* @return Result of the DescribeGlobalSettings operation returned by the service.
* @throws InvalidRequestException
* Indicates that something is wrong with the input to the request. For example, a parameter is of the wrong
* type.
* @throws ServiceUnavailableException
* The request failed due to a temporary failure of the server.
* @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 BackupException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample BackupClient.DescribeGlobalSettings
* @see AWS
* API Documentation
*/
default DescribeGlobalSettingsResponse describeGlobalSettings(
Consumer describeGlobalSettingsRequest) throws InvalidRequestException,
ServiceUnavailableException, AwsServiceException, SdkClientException, BackupException {
return describeGlobalSettings(DescribeGlobalSettingsRequest.builder().applyMutation(describeGlobalSettingsRequest)
.build());
}
/**
*
* Returns information about a saved resource, including the last time it was backed up, its Amazon Resource Name
* (ARN), and the Amazon Web Services service type of the saved resource.
*
*
* @param describeProtectedResourceRequest
* @return Result of the DescribeProtectedResource operation returned by the service.
* @throws MissingParameterValueException
* Indicates that a required parameter is missing.
* @throws InvalidParameterValueException
* Indicates that something is wrong with a parameter's value. For example, the value is out of range.
* @throws ServiceUnavailableException
* The request failed due to a temporary failure of the server.
* @throws ResourceNotFoundException
* A resource that is required for the action doesn't 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 BackupException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample BackupClient.DescribeProtectedResource
* @see AWS API Documentation
*/
default DescribeProtectedResourceResponse describeProtectedResource(
DescribeProtectedResourceRequest describeProtectedResourceRequest) throws MissingParameterValueException,
InvalidParameterValueException, ServiceUnavailableException, ResourceNotFoundException, AwsServiceException,
SdkClientException, BackupException {
throw new UnsupportedOperationException();
}
/**
*
* Returns information about a saved resource, including the last time it was backed up, its Amazon Resource Name
* (ARN), and the Amazon Web Services service type of the saved resource.
*
*
*
* This is a convenience which creates an instance of the {@link DescribeProtectedResourceRequest.Builder} avoiding
* the need to create one manually via {@link DescribeProtectedResourceRequest#builder()}
*
*
* @param describeProtectedResourceRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.backup.model.DescribeProtectedResourceRequest.Builder} to create a
* request.
* @return Result of the DescribeProtectedResource operation returned by the service.
* @throws MissingParameterValueException
* Indicates that a required parameter is missing.
* @throws InvalidParameterValueException
* Indicates that something is wrong with a parameter's value. For example, the value is out of range.
* @throws ServiceUnavailableException
* The request failed due to a temporary failure of the server.
* @throws ResourceNotFoundException
* A resource that is required for the action doesn't 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 BackupException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample BackupClient.DescribeProtectedResource
* @see AWS API Documentation
*/
default DescribeProtectedResourceResponse describeProtectedResource(
Consumer describeProtectedResourceRequest)
throws MissingParameterValueException, InvalidParameterValueException, ServiceUnavailableException,
ResourceNotFoundException, AwsServiceException, SdkClientException, BackupException {
return describeProtectedResource(DescribeProtectedResourceRequest.builder()
.applyMutation(describeProtectedResourceRequest).build());
}
/**
*
* Returns metadata associated with a recovery point, including ID, status, encryption, and lifecycle.
*
*
* @param describeRecoveryPointRequest
* @return Result of the DescribeRecoveryPoint operation returned by the service.
* @throws ResourceNotFoundException
* A resource that is required for the action doesn't exist.
* @throws InvalidParameterValueException
* Indicates that something is wrong with a parameter's value. For example, the value is out of range.
* @throws MissingParameterValueException
* Indicates that a required parameter is missing.
* @throws ServiceUnavailableException
* The request failed due to a temporary failure of the server.
* @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 BackupException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample BackupClient.DescribeRecoveryPoint
* @see AWS
* API Documentation
*/
default DescribeRecoveryPointResponse describeRecoveryPoint(DescribeRecoveryPointRequest describeRecoveryPointRequest)
throws ResourceNotFoundException, InvalidParameterValueException, MissingParameterValueException,
ServiceUnavailableException, AwsServiceException, SdkClientException, BackupException {
throw new UnsupportedOperationException();
}
/**
*
* Returns metadata associated with a recovery point, including ID, status, encryption, and lifecycle.
*
*
*
* This is a convenience which creates an instance of the {@link DescribeRecoveryPointRequest.Builder} avoiding the
* need to create one manually via {@link DescribeRecoveryPointRequest#builder()}
*
*
* @param describeRecoveryPointRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.backup.model.DescribeRecoveryPointRequest.Builder} to create a
* request.
* @return Result of the DescribeRecoveryPoint operation returned by the service.
* @throws ResourceNotFoundException
* A resource that is required for the action doesn't exist.
* @throws InvalidParameterValueException
* Indicates that something is wrong with a parameter's value. For example, the value is out of range.
* @throws MissingParameterValueException
* Indicates that a required parameter is missing.
* @throws ServiceUnavailableException
* The request failed due to a temporary failure of the server.
* @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 BackupException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample BackupClient.DescribeRecoveryPoint
* @see AWS
* API Documentation
*/
default DescribeRecoveryPointResponse describeRecoveryPoint(
Consumer describeRecoveryPointRequest) throws ResourceNotFoundException,
InvalidParameterValueException, MissingParameterValueException, ServiceUnavailableException, AwsServiceException,
SdkClientException, BackupException {
return describeRecoveryPoint(DescribeRecoveryPointRequest.builder().applyMutation(describeRecoveryPointRequest).build());
}
/**
*
* Returns the current service opt-in settings for the Region. If service opt-in is enabled for a service, Backup
* tries to protect that service's resources in this Region, when the resource is included in an on-demand backup or
* scheduled backup plan. Otherwise, Backup does not try to protect that service's resources in this Region.
*
*
* @param describeRegionSettingsRequest
* @return Result of the DescribeRegionSettings operation returned by the service.
* @throws ServiceUnavailableException
* The request failed due to a temporary failure of the server.
* @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 BackupException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample BackupClient.DescribeRegionSettings
* @see AWS
* API Documentation
*/
default DescribeRegionSettingsResponse describeRegionSettings(DescribeRegionSettingsRequest describeRegionSettingsRequest)
throws ServiceUnavailableException, AwsServiceException, SdkClientException, BackupException {
throw new UnsupportedOperationException();
}
/**
*
* Returns the current service opt-in settings for the Region. If service opt-in is enabled for a service, Backup
* tries to protect that service's resources in this Region, when the resource is included in an on-demand backup or
* scheduled backup plan. Otherwise, Backup does not try to protect that service's resources in this Region.
*
*
*
* This is a convenience which creates an instance of the {@link DescribeRegionSettingsRequest.Builder} avoiding the
* need to create one manually via {@link DescribeRegionSettingsRequest#builder()}
*
*
* @param describeRegionSettingsRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.backup.model.DescribeRegionSettingsRequest.Builder} to create a
* request.
* @return Result of the DescribeRegionSettings operation returned by the service.
* @throws ServiceUnavailableException
* The request failed due to a temporary failure of the server.
* @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 BackupException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample BackupClient.DescribeRegionSettings
* @see AWS
* API Documentation
*/
default DescribeRegionSettingsResponse describeRegionSettings(
Consumer describeRegionSettingsRequest) throws ServiceUnavailableException,
AwsServiceException, SdkClientException, BackupException {
return describeRegionSettings(DescribeRegionSettingsRequest.builder().applyMutation(describeRegionSettingsRequest)
.build());
}
/**
*
* Returns the details associated with creating a report as specified by its ReportJobId.
*
*
* @param describeReportJobRequest
* @return Result of the DescribeReportJob operation returned by the service.
* @throws ServiceUnavailableException
* The request failed due to a temporary failure of the server.
* @throws MissingParameterValueException
* Indicates that a required parameter is missing.
* @throws ResourceNotFoundException
* A resource that is required for the action doesn't 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 BackupException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample BackupClient.DescribeReportJob
* @see AWS API
* Documentation
*/
default DescribeReportJobResponse describeReportJob(DescribeReportJobRequest describeReportJobRequest)
throws ServiceUnavailableException, MissingParameterValueException, ResourceNotFoundException, AwsServiceException,
SdkClientException, BackupException {
throw new UnsupportedOperationException();
}
/**
*
* Returns the details associated with creating a report as specified by its ReportJobId.
*
*
*
* This is a convenience which creates an instance of the {@link DescribeReportJobRequest.Builder} avoiding the need
* to create one manually via {@link DescribeReportJobRequest#builder()}
*
*
* @param describeReportJobRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.backup.model.DescribeReportJobRequest.Builder} to create a request.
* @return Result of the DescribeReportJob operation returned by the service.
* @throws ServiceUnavailableException
* The request failed due to a temporary failure of the server.
* @throws MissingParameterValueException
* Indicates that a required parameter is missing.
* @throws ResourceNotFoundException
* A resource that is required for the action doesn't 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 BackupException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample BackupClient.DescribeReportJob
* @see AWS API
* Documentation
*/
default DescribeReportJobResponse describeReportJob(Consumer describeReportJobRequest)
throws ServiceUnavailableException, MissingParameterValueException, ResourceNotFoundException, AwsServiceException,
SdkClientException, BackupException {
return describeReportJob(DescribeReportJobRequest.builder().applyMutation(describeReportJobRequest).build());
}
/**
*
* Returns a list of all report plans for an Amazon Web Services account and Amazon Web Services Region.
*
*
* @param describeReportPlanRequest
* @return Result of the DescribeReportPlan operation returned by the service.
* @throws InvalidParameterValueException
* Indicates that something is wrong with a parameter's value. For example, the value is out of range.
* @throws MissingParameterValueException
* Indicates that a required parameter is missing.
* @throws ResourceNotFoundException
* A resource that is required for the action doesn't exist.
* @throws ServiceUnavailableException
* The request failed due to a temporary failure of the server.
* @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 BackupException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample BackupClient.DescribeReportPlan
* @see AWS API
* Documentation
*/
default DescribeReportPlanResponse describeReportPlan(DescribeReportPlanRequest describeReportPlanRequest)
throws InvalidParameterValueException, MissingParameterValueException, ResourceNotFoundException,
ServiceUnavailableException, AwsServiceException, SdkClientException, BackupException {
throw new UnsupportedOperationException();
}
/**
*
* Returns a list of all report plans for an Amazon Web Services account and Amazon Web Services Region.
*
*
*
* This is a convenience which creates an instance of the {@link DescribeReportPlanRequest.Builder} avoiding the
* need to create one manually via {@link DescribeReportPlanRequest#builder()}
*
*
* @param describeReportPlanRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.backup.model.DescribeReportPlanRequest.Builder} to create a
* request.
* @return Result of the DescribeReportPlan operation returned by the service.
* @throws InvalidParameterValueException
* Indicates that something is wrong with a parameter's value. For example, the value is out of range.
* @throws MissingParameterValueException
* Indicates that a required parameter is missing.
* @throws ResourceNotFoundException
* A resource that is required for the action doesn't exist.
* @throws ServiceUnavailableException
* The request failed due to a temporary failure of the server.
* @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 BackupException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample BackupClient.DescribeReportPlan
* @see AWS API
* Documentation
*/
default DescribeReportPlanResponse describeReportPlan(Consumer describeReportPlanRequest)
throws InvalidParameterValueException, MissingParameterValueException, ResourceNotFoundException,
ServiceUnavailableException, AwsServiceException, SdkClientException, BackupException {
return describeReportPlan(DescribeReportPlanRequest.builder().applyMutation(describeReportPlanRequest).build());
}
/**
*
* Returns metadata associated with a restore job that is specified by a job ID.
*
*
* @param describeRestoreJobRequest
* @return Result of the DescribeRestoreJob operation returned by the service.
* @throws ResourceNotFoundException
* A resource that is required for the action doesn't exist.
* @throws InvalidParameterValueException
* Indicates that something is wrong with a parameter's value. For example, the value is out of range.
* @throws MissingParameterValueException
* Indicates that a required parameter is missing.
* @throws ServiceUnavailableException
* The request failed due to a temporary failure of the server.
* @throws DependencyFailureException
* A dependent Amazon Web Services service or resource returned an error to the Backup service, and the
* action cannot be completed.
* @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 BackupException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample BackupClient.DescribeRestoreJob
* @see AWS API
* Documentation
*/
default DescribeRestoreJobResponse describeRestoreJob(DescribeRestoreJobRequest describeRestoreJobRequest)
throws ResourceNotFoundException, InvalidParameterValueException, MissingParameterValueException,
ServiceUnavailableException, DependencyFailureException, AwsServiceException, SdkClientException, BackupException {
throw new UnsupportedOperationException();
}
/**
*
* Returns metadata associated with a restore job that is specified by a job ID.
*
*
*
* This is a convenience which creates an instance of the {@link DescribeRestoreJobRequest.Builder} avoiding the
* need to create one manually via {@link DescribeRestoreJobRequest#builder()}
*
*
* @param describeRestoreJobRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.backup.model.DescribeRestoreJobRequest.Builder} to create a
* request.
* @return Result of the DescribeRestoreJob operation returned by the service.
* @throws ResourceNotFoundException
* A resource that is required for the action doesn't exist.
* @throws InvalidParameterValueException
* Indicates that something is wrong with a parameter's value. For example, the value is out of range.
* @throws MissingParameterValueException
* Indicates that a required parameter is missing.
* @throws ServiceUnavailableException
* The request failed due to a temporary failure of the server.
* @throws DependencyFailureException
* A dependent Amazon Web Services service or resource returned an error to the Backup service, and the
* action cannot be completed.
* @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 BackupException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample BackupClient.DescribeRestoreJob
* @see AWS API
* Documentation
*/
default DescribeRestoreJobResponse describeRestoreJob(Consumer describeRestoreJobRequest)
throws ResourceNotFoundException, InvalidParameterValueException, MissingParameterValueException,
ServiceUnavailableException, DependencyFailureException, AwsServiceException, SdkClientException, BackupException {
return describeRestoreJob(DescribeRestoreJobRequest.builder().applyMutation(describeRestoreJobRequest).build());
}
/**
*
* Deletes the specified continuous backup recovery point from Backup and releases control of that continuous backup
* to the source service, such as Amazon RDS. The source service will continue to create and retain continuous
* backups using the lifecycle that you specified in your original backup plan.
*
*
* Does not support snapshot backup recovery points.
*
*
* @param disassociateRecoveryPointRequest
* @return Result of the DisassociateRecoveryPoint operation returned by the service.
* @throws ResourceNotFoundException
* A resource that is required for the action doesn't exist.
* @throws InvalidParameterValueException
* Indicates that something is wrong with a parameter's value. For example, the value is out of range.
* @throws MissingParameterValueException
* Indicates that a required parameter is missing.
* @throws InvalidResourceStateException
* Backup is already performing an action on this recovery point. It can't perform the action you requested
* until the first action finishes. Try again later.
* @throws ServiceUnavailableException
* The request failed due to a temporary failure of the server.
* @throws InvalidRequestException
* Indicates that something is wrong with the input to the request. For example, a parameter is of the wrong
* type.
* @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 BackupException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample BackupClient.DisassociateRecoveryPoint
* @see AWS API Documentation
*/
default DisassociateRecoveryPointResponse disassociateRecoveryPoint(
DisassociateRecoveryPointRequest disassociateRecoveryPointRequest) throws ResourceNotFoundException,
InvalidParameterValueException, MissingParameterValueException, InvalidResourceStateException,
ServiceUnavailableException, InvalidRequestException, AwsServiceException, SdkClientException, BackupException {
throw new UnsupportedOperationException();
}
/**
*
* Deletes the specified continuous backup recovery point from Backup and releases control of that continuous backup
* to the source service, such as Amazon RDS. The source service will continue to create and retain continuous
* backups using the lifecycle that you specified in your original backup plan.
*
*
* Does not support snapshot backup recovery points.
*
*
*
* This is a convenience which creates an instance of the {@link DisassociateRecoveryPointRequest.Builder} avoiding
* the need to create one manually via {@link DisassociateRecoveryPointRequest#builder()}
*
*
* @param disassociateRecoveryPointRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.backup.model.DisassociateRecoveryPointRequest.Builder} to create a
* request.
* @return Result of the DisassociateRecoveryPoint operation returned by the service.
* @throws ResourceNotFoundException
* A resource that is required for the action doesn't exist.
* @throws InvalidParameterValueException
* Indicates that something is wrong with a parameter's value. For example, the value is out of range.
* @throws MissingParameterValueException
* Indicates that a required parameter is missing.
* @throws InvalidResourceStateException
* Backup is already performing an action on this recovery point. It can't perform the action you requested
* until the first action finishes. Try again later.
* @throws ServiceUnavailableException
* The request failed due to a temporary failure of the server.
* @throws InvalidRequestException
* Indicates that something is wrong with the input to the request. For example, a parameter is of the wrong
* type.
* @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 BackupException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample BackupClient.DisassociateRecoveryPoint
* @see AWS API Documentation
*/
default DisassociateRecoveryPointResponse disassociateRecoveryPoint(
Consumer disassociateRecoveryPointRequest)
throws ResourceNotFoundException, InvalidParameterValueException, MissingParameterValueException,
InvalidResourceStateException, ServiceUnavailableException, InvalidRequestException, AwsServiceException,
SdkClientException, BackupException {
return disassociateRecoveryPoint(DisassociateRecoveryPointRequest.builder()
.applyMutation(disassociateRecoveryPointRequest).build());
}
/**
*
* This action to a specific child (nested) recovery point removes the relationship between the specified recovery
* point and its parent (composite) recovery point.
*
*
* @param disassociateRecoveryPointFromParentRequest
* @return Result of the DisassociateRecoveryPointFromParent operation returned by the service.
* @throws ResourceNotFoundException
* A resource that is required for the action doesn't exist.
* @throws InvalidParameterValueException
* Indicates that something is wrong with a parameter's value. For example, the value is out of range.
* @throws MissingParameterValueException
* Indicates that a required parameter is missing.
* @throws ServiceUnavailableException
* The request failed due to a temporary failure of the server.
* @throws InvalidRequestException
* Indicates that something is wrong with the input to the request. For example, a parameter is of the wrong
* type.
* @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 BackupException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample BackupClient.DisassociateRecoveryPointFromParent
* @see AWS API Documentation
*/
default DisassociateRecoveryPointFromParentResponse disassociateRecoveryPointFromParent(
DisassociateRecoveryPointFromParentRequest disassociateRecoveryPointFromParentRequest)
throws ResourceNotFoundException, InvalidParameterValueException, MissingParameterValueException,
ServiceUnavailableException, InvalidRequestException, AwsServiceException, SdkClientException, BackupException {
throw new UnsupportedOperationException();
}
/**
*
* This action to a specific child (nested) recovery point removes the relationship between the specified recovery
* point and its parent (composite) recovery point.
*
*
*
* This is a convenience which creates an instance of the {@link DisassociateRecoveryPointFromParentRequest.Builder}
* avoiding the need to create one manually via {@link DisassociateRecoveryPointFromParentRequest#builder()}
*
*
* @param disassociateRecoveryPointFromParentRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.backup.model.DisassociateRecoveryPointFromParentRequest.Builder} to
* create a request.
* @return Result of the DisassociateRecoveryPointFromParent operation returned by the service.
* @throws ResourceNotFoundException
* A resource that is required for the action doesn't exist.
* @throws InvalidParameterValueException
* Indicates that something is wrong with a parameter's value. For example, the value is out of range.
* @throws MissingParameterValueException
* Indicates that a required parameter is missing.
* @throws ServiceUnavailableException
* The request failed due to a temporary failure of the server.
* @throws InvalidRequestException
* Indicates that something is wrong with the input to the request. For example, a parameter is of the wrong
* type.
* @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 BackupException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample BackupClient.DisassociateRecoveryPointFromParent
* @see AWS API Documentation
*/
default DisassociateRecoveryPointFromParentResponse disassociateRecoveryPointFromParent(
Consumer disassociateRecoveryPointFromParentRequest)
throws ResourceNotFoundException, InvalidParameterValueException, MissingParameterValueException,
ServiceUnavailableException, InvalidRequestException, AwsServiceException, SdkClientException, BackupException {
return disassociateRecoveryPointFromParent(DisassociateRecoveryPointFromParentRequest.builder()
.applyMutation(disassociateRecoveryPointFromParentRequest).build());
}
/**
*
* Returns the backup plan that is specified by the plan ID as a backup template.
*
*
* @param exportBackupPlanTemplateRequest
* @return Result of the ExportBackupPlanTemplate operation returned by the service.
* @throws InvalidParameterValueException
* Indicates that something is wrong with a parameter's value. For example, the value is out of range.
* @throws MissingParameterValueException
* Indicates that a required parameter is missing.
* @throws ServiceUnavailableException
* The request failed due to a temporary failure of the server.
* @throws ResourceNotFoundException
* A resource that is required for the action doesn't 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 BackupException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample BackupClient.ExportBackupPlanTemplate
* @see AWS API Documentation
*/
default ExportBackupPlanTemplateResponse exportBackupPlanTemplate(
ExportBackupPlanTemplateRequest exportBackupPlanTemplateRequest) throws InvalidParameterValueException,
MissingParameterValueException, ServiceUnavailableException, ResourceNotFoundException, AwsServiceException,
SdkClientException, BackupException {
throw new UnsupportedOperationException();
}
/**
*
* Returns the backup plan that is specified by the plan ID as a backup template.
*
*
*
* This is a convenience which creates an instance of the {@link ExportBackupPlanTemplateRequest.Builder} avoiding
* the need to create one manually via {@link ExportBackupPlanTemplateRequest#builder()}
*
*
* @param exportBackupPlanTemplateRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.backup.model.ExportBackupPlanTemplateRequest.Builder} to create a
* request.
* @return Result of the ExportBackupPlanTemplate operation returned by the service.
* @throws InvalidParameterValueException
* Indicates that something is wrong with a parameter's value. For example, the value is out of range.
* @throws MissingParameterValueException
* Indicates that a required parameter is missing.
* @throws ServiceUnavailableException
* The request failed due to a temporary failure of the server.
* @throws ResourceNotFoundException
* A resource that is required for the action doesn't 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 BackupException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample BackupClient.ExportBackupPlanTemplate
* @see AWS API Documentation
*/
default ExportBackupPlanTemplateResponse exportBackupPlanTemplate(
Consumer exportBackupPlanTemplateRequest)
throws InvalidParameterValueException, MissingParameterValueException, ServiceUnavailableException,
ResourceNotFoundException, AwsServiceException, SdkClientException, BackupException {
return exportBackupPlanTemplate(ExportBackupPlanTemplateRequest.builder().applyMutation(exportBackupPlanTemplateRequest)
.build());
}
/**
*
* Returns BackupPlan details for the specified BackupPlanId. The details are the body of
* a backup plan in JSON format, in addition to plan metadata.
*
*
* @param getBackupPlanRequest
* @return Result of the GetBackupPlan operation returned by the service.
* @throws ResourceNotFoundException
* A resource that is required for the action doesn't exist.
* @throws InvalidParameterValueException
* Indicates that something is wrong with a parameter's value. For example, the value is out of range.
* @throws MissingParameterValueException
* Indicates that a required parameter is missing.
* @throws ServiceUnavailableException
* The request failed due to a temporary failure of the server.
* @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 BackupException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample BackupClient.GetBackupPlan
* @see AWS API
* Documentation
*/
default GetBackupPlanResponse getBackupPlan(GetBackupPlanRequest getBackupPlanRequest) throws ResourceNotFoundException,
InvalidParameterValueException, MissingParameterValueException, ServiceUnavailableException, AwsServiceException,
SdkClientException, BackupException {
throw new UnsupportedOperationException();
}
/**
*
* Returns BackupPlan details for the specified BackupPlanId. The details are the body of
* a backup plan in JSON format, in addition to plan metadata.
*
*
*
* This is a convenience which creates an instance of the {@link GetBackupPlanRequest.Builder} avoiding the need to
* create one manually via {@link GetBackupPlanRequest#builder()}
*
*
* @param getBackupPlanRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.backup.model.GetBackupPlanRequest.Builder} to create a request.
* @return Result of the GetBackupPlan operation returned by the service.
* @throws ResourceNotFoundException
* A resource that is required for the action doesn't exist.
* @throws InvalidParameterValueException
* Indicates that something is wrong with a parameter's value. For example, the value is out of range.
* @throws MissingParameterValueException
* Indicates that a required parameter is missing.
* @throws ServiceUnavailableException
* The request failed due to a temporary failure of the server.
* @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 BackupException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample BackupClient.GetBackupPlan
* @see AWS API
* Documentation
*/
default GetBackupPlanResponse getBackupPlan(Consumer getBackupPlanRequest)
throws ResourceNotFoundException, InvalidParameterValueException, MissingParameterValueException,
ServiceUnavailableException, AwsServiceException, SdkClientException, BackupException {
return getBackupPlan(GetBackupPlanRequest.builder().applyMutation(getBackupPlanRequest).build());
}
/**
*
* Returns a valid JSON document specifying a backup plan or an error.
*
*
* @param getBackupPlanFromJsonRequest
* @return Result of the GetBackupPlanFromJSON operation returned by the service.
* @throws LimitExceededException
* A limit in the request has been exceeded; for example, a maximum number of items allowed in a request.
* @throws InvalidParameterValueException
* Indicates that something is wrong with a parameter's value. For example, the value is out of range.
* @throws MissingParameterValueException
* Indicates that a required parameter is missing.
* @throws ServiceUnavailableException
* The request failed due to a temporary failure of the server.
* @throws InvalidRequestException
* Indicates that something is wrong with the input to the request. For example, a parameter is of the wrong
* type.
* @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 BackupException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample BackupClient.GetBackupPlanFromJSON
* @see AWS
* API Documentation
*/
default GetBackupPlanFromJsonResponse getBackupPlanFromJSON(GetBackupPlanFromJsonRequest getBackupPlanFromJsonRequest)
throws LimitExceededException, InvalidParameterValueException, MissingParameterValueException,
ServiceUnavailableException, InvalidRequestException, AwsServiceException, SdkClientException, BackupException {
throw new UnsupportedOperationException();
}
/**
*
* Returns a valid JSON document specifying a backup plan or an error.
*
*
*
* This is a convenience which creates an instance of the {@link GetBackupPlanFromJsonRequest.Builder} avoiding the
* need to create one manually via {@link GetBackupPlanFromJsonRequest#builder()}
*
*
* @param getBackupPlanFromJsonRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.backup.model.GetBackupPlanFromJsonRequest.Builder} to create a
* request.
* @return Result of the GetBackupPlanFromJSON operation returned by the service.
* @throws LimitExceededException
* A limit in the request has been exceeded; for example, a maximum number of items allowed in a request.
* @throws InvalidParameterValueException
* Indicates that something is wrong with a parameter's value. For example, the value is out of range.
* @throws MissingParameterValueException
* Indicates that a required parameter is missing.
* @throws ServiceUnavailableException
* The request failed due to a temporary failure of the server.
* @throws InvalidRequestException
* Indicates that something is wrong with the input to the request. For example, a parameter is of the wrong
* type.
* @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 BackupException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample BackupClient.GetBackupPlanFromJSON
* @see AWS
* API Documentation
*/
default GetBackupPlanFromJsonResponse getBackupPlanFromJSON(
Consumer getBackupPlanFromJsonRequest) throws LimitExceededException,
InvalidParameterValueException, MissingParameterValueException, ServiceUnavailableException, InvalidRequestException,
AwsServiceException, SdkClientException, BackupException {
return getBackupPlanFromJSON(GetBackupPlanFromJsonRequest.builder().applyMutation(getBackupPlanFromJsonRequest).build());
}
/**
*
* Returns the template specified by its templateId as a backup plan.
*
*
* @param getBackupPlanFromTemplateRequest
* @return Result of the GetBackupPlanFromTemplate operation returned by the service.
* @throws InvalidParameterValueException
* Indicates that something is wrong with a parameter's value. For example, the value is out of range.
* @throws MissingParameterValueException
* Indicates that a required parameter is missing.
* @throws ServiceUnavailableException
* The request failed due to a temporary failure of the server.
* @throws ResourceNotFoundException
* A resource that is required for the action doesn't 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 BackupException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample BackupClient.GetBackupPlanFromTemplate
* @see AWS API Documentation
*/
default GetBackupPlanFromTemplateResponse getBackupPlanFromTemplate(
GetBackupPlanFromTemplateRequest getBackupPlanFromTemplateRequest) throws InvalidParameterValueException,
MissingParameterValueException, ServiceUnavailableException, ResourceNotFoundException, AwsServiceException,
SdkClientException, BackupException {
throw new UnsupportedOperationException();
}
/**
*
* Returns the template specified by its templateId as a backup plan.
*
*
*
* This is a convenience which creates an instance of the {@link GetBackupPlanFromTemplateRequest.Builder} avoiding
* the need to create one manually via {@link GetBackupPlanFromTemplateRequest#builder()}
*
*
* @param getBackupPlanFromTemplateRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.backup.model.GetBackupPlanFromTemplateRequest.Builder} to create a
* request.
* @return Result of the GetBackupPlanFromTemplate operation returned by the service.
* @throws InvalidParameterValueException
* Indicates that something is wrong with a parameter's value. For example, the value is out of range.
* @throws MissingParameterValueException
* Indicates that a required parameter is missing.
* @throws ServiceUnavailableException
* The request failed due to a temporary failure of the server.
* @throws ResourceNotFoundException
* A resource that is required for the action doesn't 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 BackupException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample BackupClient.GetBackupPlanFromTemplate
* @see AWS API Documentation
*/
default GetBackupPlanFromTemplateResponse getBackupPlanFromTemplate(
Consumer getBackupPlanFromTemplateRequest)
throws InvalidParameterValueException, MissingParameterValueException, ServiceUnavailableException,
ResourceNotFoundException, AwsServiceException, SdkClientException, BackupException {
return getBackupPlanFromTemplate(GetBackupPlanFromTemplateRequest.builder()
.applyMutation(getBackupPlanFromTemplateRequest).build());
}
/**
*
* Returns selection metadata and a document in JSON format that specifies a list of resources that are associated
* with a backup plan.
*
*
* @param getBackupSelectionRequest
* @return Result of the GetBackupSelection operation returned by the service.
* @throws ResourceNotFoundException
* A resource that is required for the action doesn't exist.
* @throws InvalidParameterValueException
* Indicates that something is wrong with a parameter's value. For example, the value is out of range.
* @throws MissingParameterValueException
* Indicates that a required parameter is missing.
* @throws ServiceUnavailableException
* The request failed due to a temporary failure of the server.
* @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 BackupException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample BackupClient.GetBackupSelection
* @see AWS API
* Documentation
*/
default GetBackupSelectionResponse getBackupSelection(GetBackupSelectionRequest getBackupSelectionRequest)
throws ResourceNotFoundException, InvalidParameterValueException, MissingParameterValueException,
ServiceUnavailableException, AwsServiceException, SdkClientException, BackupException {
throw new UnsupportedOperationException();
}
/**
*
* Returns selection metadata and a document in JSON format that specifies a list of resources that are associated
* with a backup plan.
*
*
*
* This is a convenience which creates an instance of the {@link GetBackupSelectionRequest.Builder} avoiding the
* need to create one manually via {@link GetBackupSelectionRequest#builder()}
*
*
* @param getBackupSelectionRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.backup.model.GetBackupSelectionRequest.Builder} to create a
* request.
* @return Result of the GetBackupSelection operation returned by the service.
* @throws ResourceNotFoundException
* A resource that is required for the action doesn't exist.
* @throws InvalidParameterValueException
* Indicates that something is wrong with a parameter's value. For example, the value is out of range.
* @throws MissingParameterValueException
* Indicates that a required parameter is missing.
* @throws ServiceUnavailableException
* The request failed due to a temporary failure of the server.
* @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 BackupException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample BackupClient.GetBackupSelection
* @see AWS API
* Documentation
*/
default GetBackupSelectionResponse getBackupSelection(Consumer getBackupSelectionRequest)
throws ResourceNotFoundException, InvalidParameterValueException, MissingParameterValueException,
ServiceUnavailableException, AwsServiceException, SdkClientException, BackupException {
return getBackupSelection(GetBackupSelectionRequest.builder().applyMutation(getBackupSelectionRequest).build());
}
/**
*
* Returns the access policy document that is associated with the named backup vault.
*
*
* @param getBackupVaultAccessPolicyRequest
* @return Result of the GetBackupVaultAccessPolicy operation returned by the service.
* @throws ResourceNotFoundException
* A resource that is required for the action doesn't exist.
* @throws InvalidParameterValueException
* Indicates that something is wrong with a parameter's value. For example, the value is out of range.
* @throws MissingParameterValueException
* Indicates that a required parameter is missing.
* @throws ServiceUnavailableException
* The request failed due to a temporary failure of the server.
* @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 BackupException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample BackupClient.GetBackupVaultAccessPolicy
* @see AWS API Documentation
*/
default GetBackupVaultAccessPolicyResponse getBackupVaultAccessPolicy(
GetBackupVaultAccessPolicyRequest getBackupVaultAccessPolicyRequest) throws ResourceNotFoundException,
InvalidParameterValueException, MissingParameterValueException, ServiceUnavailableException, AwsServiceException,
SdkClientException, BackupException {
throw new UnsupportedOperationException();
}
/**
*
* Returns the access policy document that is associated with the named backup vault.
*
*
*
* This is a convenience which creates an instance of the {@link GetBackupVaultAccessPolicyRequest.Builder} avoiding
* the need to create one manually via {@link GetBackupVaultAccessPolicyRequest#builder()}
*
*
* @param getBackupVaultAccessPolicyRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.backup.model.GetBackupVaultAccessPolicyRequest.Builder} to create a
* request.
* @return Result of the GetBackupVaultAccessPolicy operation returned by the service.
* @throws ResourceNotFoundException
* A resource that is required for the action doesn't exist.
* @throws InvalidParameterValueException
* Indicates that something is wrong with a parameter's value. For example, the value is out of range.
* @throws MissingParameterValueException
* Indicates that a required parameter is missing.
* @throws ServiceUnavailableException
* The request failed due to a temporary failure of the server.
* @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 BackupException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample BackupClient.GetBackupVaultAccessPolicy
* @see AWS API Documentation
*/
default GetBackupVaultAccessPolicyResponse getBackupVaultAccessPolicy(
Consumer getBackupVaultAccessPolicyRequest)
throws ResourceNotFoundException, InvalidParameterValueException, MissingParameterValueException,
ServiceUnavailableException, AwsServiceException, SdkClientException, BackupException {
return getBackupVaultAccessPolicy(GetBackupVaultAccessPolicyRequest.builder()
.applyMutation(getBackupVaultAccessPolicyRequest).build());
}
/**
*
* Returns event notifications for the specified backup vault.
*
*
* @param getBackupVaultNotificationsRequest
* @return Result of the GetBackupVaultNotifications operation returned by the service.
* @throws ResourceNotFoundException
* A resource that is required for the action doesn't exist.
* @throws InvalidParameterValueException
* Indicates that something is wrong with a parameter's value. For example, the value is out of range.
* @throws MissingParameterValueException
* Indicates that a required parameter is missing.
* @throws ServiceUnavailableException
* The request failed due to a temporary failure of the server.
* @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 BackupException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample BackupClient.GetBackupVaultNotifications
* @see AWS API Documentation
*/
default GetBackupVaultNotificationsResponse getBackupVaultNotifications(
GetBackupVaultNotificationsRequest getBackupVaultNotificationsRequest) throws ResourceNotFoundException,
InvalidParameterValueException, MissingParameterValueException, ServiceUnavailableException, AwsServiceException,
SdkClientException, BackupException {
throw new UnsupportedOperationException();
}
/**
*
* Returns event notifications for the specified backup vault.
*
*
*
* This is a convenience which creates an instance of the {@link GetBackupVaultNotificationsRequest.Builder}
* avoiding the need to create one manually via {@link GetBackupVaultNotificationsRequest#builder()}
*
*
* @param getBackupVaultNotificationsRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.backup.model.GetBackupVaultNotificationsRequest.Builder} to create
* a request.
* @return Result of the GetBackupVaultNotifications operation returned by the service.
* @throws ResourceNotFoundException
* A resource that is required for the action doesn't exist.
* @throws InvalidParameterValueException
* Indicates that something is wrong with a parameter's value. For example, the value is out of range.
* @throws MissingParameterValueException
* Indicates that a required parameter is missing.
* @throws ServiceUnavailableException
* The request failed due to a temporary failure of the server.
* @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 BackupException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample BackupClient.GetBackupVaultNotifications
* @see AWS API Documentation
*/
default GetBackupVaultNotificationsResponse getBackupVaultNotifications(
Consumer getBackupVaultNotificationsRequest)
throws ResourceNotFoundException, InvalidParameterValueException, MissingParameterValueException,
ServiceUnavailableException, AwsServiceException, SdkClientException, BackupException {
return getBackupVaultNotifications(GetBackupVaultNotificationsRequest.builder()
.applyMutation(getBackupVaultNotificationsRequest).build());
}
/**
*
* This action returns details for a specified legal hold. The details are the body of a legal hold in JSON format,
* in addition to metadata.
*
*
* @param getLegalHoldRequest
* @return Result of the GetLegalHold operation returned by the service.
* @throws InvalidParameterValueException
* Indicates that something is wrong with a parameter's value. For example, the value is out of range.
* @throws MissingParameterValueException
* Indicates that a required parameter is missing.
* @throws ServiceUnavailableException
* The request failed due to a temporary failure of the server.
* @throws ResourceNotFoundException
* A resource that is required for the action doesn't 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 BackupException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample BackupClient.GetLegalHold
* @see AWS API
* Documentation
*/
default GetLegalHoldResponse getLegalHold(GetLegalHoldRequest getLegalHoldRequest) throws InvalidParameterValueException,
MissingParameterValueException, ServiceUnavailableException, ResourceNotFoundException, AwsServiceException,
SdkClientException, BackupException {
throw new UnsupportedOperationException();
}
/**
*
* This action returns details for a specified legal hold. The details are the body of a legal hold in JSON format,
* in addition to metadata.
*
*
*
* This is a convenience which creates an instance of the {@link GetLegalHoldRequest.Builder} avoiding the need to
* create one manually via {@link GetLegalHoldRequest#builder()}
*
*
* @param getLegalHoldRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.backup.model.GetLegalHoldRequest.Builder} to create a request.
* @return Result of the GetLegalHold operation returned by the service.
* @throws InvalidParameterValueException
* Indicates that something is wrong with a parameter's value. For example, the value is out of range.
* @throws MissingParameterValueException
* Indicates that a required parameter is missing.
* @throws ServiceUnavailableException
* The request failed due to a temporary failure of the server.
* @throws ResourceNotFoundException
* A resource that is required for the action doesn't 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 BackupException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample BackupClient.GetLegalHold
* @see AWS API
* Documentation
*/
default GetLegalHoldResponse getLegalHold(Consumer getLegalHoldRequest)
throws InvalidParameterValueException, MissingParameterValueException, ServiceUnavailableException,
ResourceNotFoundException, AwsServiceException, SdkClientException, BackupException {
return getLegalHold(GetLegalHoldRequest.builder().applyMutation(getLegalHoldRequest).build());
}
/**
*
* Returns a set of metadata key-value pairs that were used to create the backup.
*
*
* @param getRecoveryPointRestoreMetadataRequest
* @return Result of the GetRecoveryPointRestoreMetadata operation returned by the service.
* @throws ResourceNotFoundException
* A resource that is required for the action doesn't exist.
* @throws InvalidParameterValueException
* Indicates that something is wrong with a parameter's value. For example, the value is out of range.
* @throws MissingParameterValueException
* Indicates that a required parameter is missing.
* @throws ServiceUnavailableException
* The request failed due to a temporary failure of the server.
* @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 BackupException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample BackupClient.GetRecoveryPointRestoreMetadata
* @see AWS API Documentation
*/
default GetRecoveryPointRestoreMetadataResponse getRecoveryPointRestoreMetadata(
GetRecoveryPointRestoreMetadataRequest getRecoveryPointRestoreMetadataRequest) throws ResourceNotFoundException,
InvalidParameterValueException, MissingParameterValueException, ServiceUnavailableException, AwsServiceException,
SdkClientException, BackupException {
throw new UnsupportedOperationException();
}
/**
*
* Returns a set of metadata key-value pairs that were used to create the backup.
*
*
*
* This is a convenience which creates an instance of the {@link GetRecoveryPointRestoreMetadataRequest.Builder}
* avoiding the need to create one manually via {@link GetRecoveryPointRestoreMetadataRequest#builder()}
*
*
* @param getRecoveryPointRestoreMetadataRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.backup.model.GetRecoveryPointRestoreMetadataRequest.Builder} to
* create a request.
* @return Result of the GetRecoveryPointRestoreMetadata operation returned by the service.
* @throws ResourceNotFoundException
* A resource that is required for the action doesn't exist.
* @throws InvalidParameterValueException
* Indicates that something is wrong with a parameter's value. For example, the value is out of range.
* @throws MissingParameterValueException
* Indicates that a required parameter is missing.
* @throws ServiceUnavailableException
* The request failed due to a temporary failure of the server.
* @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 BackupException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample BackupClient.GetRecoveryPointRestoreMetadata
* @see AWS API Documentation
*/
default GetRecoveryPointRestoreMetadataResponse getRecoveryPointRestoreMetadata(
Consumer getRecoveryPointRestoreMetadataRequest)
throws ResourceNotFoundException, InvalidParameterValueException, MissingParameterValueException,
ServiceUnavailableException, AwsServiceException, SdkClientException, BackupException {
return getRecoveryPointRestoreMetadata(GetRecoveryPointRestoreMetadataRequest.builder()
.applyMutation(getRecoveryPointRestoreMetadataRequest).build());
}
/**
*
* This request returns the metadata for the specified restore job.
*
*
* @param getRestoreJobMetadataRequest
* @return Result of the GetRestoreJobMetadata operation returned by the service.
* @throws ResourceNotFoundException
* A resource that is required for the action doesn't exist.
* @throws InvalidParameterValueException
* Indicates that something is wrong with a parameter's value. For example, the value is out of range.
* @throws MissingParameterValueException
* Indicates that a required parameter is missing.
* @throws ServiceUnavailableException
* The request failed due to a temporary failure of the server.
* @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 BackupException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample BackupClient.GetRestoreJobMetadata
* @see AWS
* API Documentation
*/
default GetRestoreJobMetadataResponse getRestoreJobMetadata(GetRestoreJobMetadataRequest getRestoreJobMetadataRequest)
throws ResourceNotFoundException, InvalidParameterValueException, MissingParameterValueException,
ServiceUnavailableException, AwsServiceException, SdkClientException, BackupException {
throw new UnsupportedOperationException();
}
/**
*
* This request returns the metadata for the specified restore job.
*
*
*
* This is a convenience which creates an instance of the {@link GetRestoreJobMetadataRequest.Builder} avoiding the
* need to create one manually via {@link GetRestoreJobMetadataRequest#builder()}
*
*
* @param getRestoreJobMetadataRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.backup.model.GetRestoreJobMetadataRequest.Builder} to create a
* request.
* @return Result of the GetRestoreJobMetadata operation returned by the service.
* @throws ResourceNotFoundException
* A resource that is required for the action doesn't exist.
* @throws InvalidParameterValueException
* Indicates that something is wrong with a parameter's value. For example, the value is out of range.
* @throws MissingParameterValueException
* Indicates that a required parameter is missing.
* @throws ServiceUnavailableException
* The request failed due to a temporary failure of the server.
* @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 BackupException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample BackupClient.GetRestoreJobMetadata
* @see AWS
* API Documentation
*/
default GetRestoreJobMetadataResponse getRestoreJobMetadata(
Consumer getRestoreJobMetadataRequest) throws ResourceNotFoundException,
InvalidParameterValueException, MissingParameterValueException, ServiceUnavailableException, AwsServiceException,
SdkClientException, BackupException {
return getRestoreJobMetadata(GetRestoreJobMetadataRequest.builder().applyMutation(getRestoreJobMetadataRequest).build());
}
/**
*
* This request returns the minimal required set of metadata needed to start a restore job with secure default
* settings. BackupVaultName and RecoveryPointArn are required parameters.
* BackupVaultAccountId is an optional parameter.
*
*
* @param getRestoreTestingInferredMetadataRequest
* @return Result of the GetRestoreTestingInferredMetadata operation returned by the service.
* @throws InvalidParameterValueException
* Indicates that something is wrong with a parameter's value. For example, the value is out of range.
* @throws MissingParameterValueException
* Indicates that a required parameter is missing.
* @throws ResourceNotFoundException
* A resource that is required for the action doesn't exist.
* @throws ServiceUnavailableException
* The request failed due to a temporary failure of the server.
* @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 BackupException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample BackupClient.GetRestoreTestingInferredMetadata
* @see AWS API Documentation
*/
default GetRestoreTestingInferredMetadataResponse getRestoreTestingInferredMetadata(
GetRestoreTestingInferredMetadataRequest getRestoreTestingInferredMetadataRequest)
throws InvalidParameterValueException, MissingParameterValueException, ResourceNotFoundException,
ServiceUnavailableException, AwsServiceException, SdkClientException, BackupException {
throw new UnsupportedOperationException();
}
/**
*
* This request returns the minimal required set of metadata needed to start a restore job with secure default
* settings. BackupVaultName and RecoveryPointArn are required parameters.
* BackupVaultAccountId is an optional parameter.
*
*
*
* This is a convenience which creates an instance of the {@link GetRestoreTestingInferredMetadataRequest.Builder}
* avoiding the need to create one manually via {@link GetRestoreTestingInferredMetadataRequest#builder()}
*
*
* @param getRestoreTestingInferredMetadataRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.backup.model.GetRestoreTestingInferredMetadataRequest.Builder} to
* create a request.
* @return Result of the GetRestoreTestingInferredMetadata operation returned by the service.
* @throws InvalidParameterValueException
* Indicates that something is wrong with a parameter's value. For example, the value is out of range.
* @throws MissingParameterValueException
* Indicates that a required parameter is missing.
* @throws ResourceNotFoundException
* A resource that is required for the action doesn't exist.
* @throws ServiceUnavailableException
* The request failed due to a temporary failure of the server.
* @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 BackupException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample BackupClient.GetRestoreTestingInferredMetadata
* @see AWS API Documentation
*/
default GetRestoreTestingInferredMetadataResponse getRestoreTestingInferredMetadata(
Consumer getRestoreTestingInferredMetadataRequest)
throws InvalidParameterValueException, MissingParameterValueException, ResourceNotFoundException,
ServiceUnavailableException, AwsServiceException, SdkClientException, BackupException {
return getRestoreTestingInferredMetadata(GetRestoreTestingInferredMetadataRequest.builder()
.applyMutation(getRestoreTestingInferredMetadataRequest).build());
}
/**
*
* Returns RestoreTestingPlan details for the specified RestoreTestingPlanName. The
* details are the body of a restore testing plan in JSON format, in addition to plan metadata.
*
*
* @param getRestoreTestingPlanRequest
* @return Result of the GetRestoreTestingPlan operation returned by the service.
* @throws ResourceNotFoundException
* A resource that is required for the action doesn't exist.
* @throws ServiceUnavailableException
* The request failed due to a temporary failure of the server.
* @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 BackupException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample BackupClient.GetRestoreTestingPlan
* @see AWS
* API Documentation
*/
default GetRestoreTestingPlanResponse getRestoreTestingPlan(GetRestoreTestingPlanRequest getRestoreTestingPlanRequest)
throws ResourceNotFoundException, ServiceUnavailableException, AwsServiceException, SdkClientException,
BackupException {
throw new UnsupportedOperationException();
}
/**
*
* Returns RestoreTestingPlan details for the specified RestoreTestingPlanName. The
* details are the body of a restore testing plan in JSON format, in addition to plan metadata.
*
*
*
* This is a convenience which creates an instance of the {@link GetRestoreTestingPlanRequest.Builder} avoiding the
* need to create one manually via {@link GetRestoreTestingPlanRequest#builder()}
*
*
* @param getRestoreTestingPlanRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.backup.model.GetRestoreTestingPlanRequest.Builder} to create a
* request.
* @return Result of the GetRestoreTestingPlan operation returned by the service.
* @throws ResourceNotFoundException
* A resource that is required for the action doesn't exist.
* @throws ServiceUnavailableException
* The request failed due to a temporary failure of the server.
* @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 BackupException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample BackupClient.GetRestoreTestingPlan
* @see AWS
* API Documentation
*/
default GetRestoreTestingPlanResponse getRestoreTestingPlan(
Consumer getRestoreTestingPlanRequest) throws ResourceNotFoundException,
ServiceUnavailableException, AwsServiceException, SdkClientException, BackupException {
return getRestoreTestingPlan(GetRestoreTestingPlanRequest.builder().applyMutation(getRestoreTestingPlanRequest).build());
}
/**
*
* Returns RestoreTestingSelection, which displays resources and elements of the restore testing plan.
*
*
* @param getRestoreTestingSelectionRequest
* @return Result of the GetRestoreTestingSelection operation returned by the service.
* @throws ResourceNotFoundException
* A resource that is required for the action doesn't exist.
* @throws ServiceUnavailableException
* The request failed due to a temporary failure of the server.
* @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 BackupException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample BackupClient.GetRestoreTestingSelection
* @see AWS API Documentation
*/
default GetRestoreTestingSelectionResponse getRestoreTestingSelection(
GetRestoreTestingSelectionRequest getRestoreTestingSelectionRequest) throws ResourceNotFoundException,
ServiceUnavailableException, AwsServiceException, SdkClientException, BackupException {
throw new UnsupportedOperationException();
}
/**
*
* Returns RestoreTestingSelection, which displays resources and elements of the restore testing plan.
*
*
*
* This is a convenience which creates an instance of the {@link GetRestoreTestingSelectionRequest.Builder} avoiding
* the need to create one manually via {@link GetRestoreTestingSelectionRequest#builder()}
*
*
* @param getRestoreTestingSelectionRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.backup.model.GetRestoreTestingSelectionRequest.Builder} to create a
* request.
* @return Result of the GetRestoreTestingSelection operation returned by the service.
* @throws ResourceNotFoundException
* A resource that is required for the action doesn't exist.
* @throws ServiceUnavailableException
* The request failed due to a temporary failure of the server.
* @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 BackupException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample BackupClient.GetRestoreTestingSelection
* @see AWS API Documentation
*/
default GetRestoreTestingSelectionResponse getRestoreTestingSelection(
Consumer getRestoreTestingSelectionRequest)
throws ResourceNotFoundException, ServiceUnavailableException, AwsServiceException, SdkClientException,
BackupException {
return getRestoreTestingSelection(GetRestoreTestingSelectionRequest.builder()
.applyMutation(getRestoreTestingSelectionRequest).build());
}
/**
*
* Returns the Amazon Web Services resource types supported by Backup.
*
*
* @param getSupportedResourceTypesRequest
* @return Result of the GetSupportedResourceTypes operation returned by the service.
* @throws ServiceUnavailableException
* The request failed due to a temporary failure of the server.
* @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 BackupException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample BackupClient.GetSupportedResourceTypes
* @see AWS API Documentation
*/
default GetSupportedResourceTypesResponse getSupportedResourceTypes(
GetSupportedResourceTypesRequest getSupportedResourceTypesRequest) throws ServiceUnavailableException,
AwsServiceException, SdkClientException, BackupException {
throw new UnsupportedOperationException();
}
/**
*
* Returns the Amazon Web Services resource types supported by Backup.
*
*
*
* This is a convenience which creates an instance of the {@link GetSupportedResourceTypesRequest.Builder} avoiding
* the need to create one manually via {@link GetSupportedResourceTypesRequest#builder()}
*
*
* @param getSupportedResourceTypesRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.backup.model.GetSupportedResourceTypesRequest.Builder} to create a
* request.
* @return Result of the GetSupportedResourceTypes operation returned by the service.
* @throws ServiceUnavailableException
* The request failed due to a temporary failure of the server.
* @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 BackupException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample BackupClient.GetSupportedResourceTypes
* @see AWS API Documentation
*/
default GetSupportedResourceTypesResponse getSupportedResourceTypes(
Consumer getSupportedResourceTypesRequest)
throws ServiceUnavailableException, AwsServiceException, SdkClientException, BackupException {
return getSupportedResourceTypes(GetSupportedResourceTypesRequest.builder()
.applyMutation(getSupportedResourceTypesRequest).build());
}
/**
*
* This is a request for a summary of backup jobs created or running within the most recent 30 days. You can include
* parameters AccountID, State, ResourceType, MessageCategory, AggregationPeriod, MaxResults, or NextToken to filter
* results.
*
*
* This request returns a summary that contains Region, Account, State, ResourceType, MessageCategory, StartTime,
* EndTime, and Count of included jobs.
*
*
* @param listBackupJobSummariesRequest
* @return Result of the ListBackupJobSummaries operation returned by the service.
* @throws InvalidParameterValueException
* Indicates that something is wrong with a parameter's value. For example, the value is out of range.
* @throws ServiceUnavailableException
* The request failed due to a temporary failure of the server.
* @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 BackupException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample BackupClient.ListBackupJobSummaries
* @see AWS
* API Documentation
*/
default ListBackupJobSummariesResponse listBackupJobSummaries(ListBackupJobSummariesRequest listBackupJobSummariesRequest)
throws InvalidParameterValueException, ServiceUnavailableException, AwsServiceException, SdkClientException,
BackupException {
throw new UnsupportedOperationException();
}
/**
*
* This is a request for a summary of backup jobs created or running within the most recent 30 days. You can include
* parameters AccountID, State, ResourceType, MessageCategory, AggregationPeriod, MaxResults, or NextToken to filter
* results.
*
*
* This request returns a summary that contains Region, Account, State, ResourceType, MessageCategory, StartTime,
* EndTime, and Count of included jobs.
*
*
*
* This is a convenience which creates an instance of the {@link ListBackupJobSummariesRequest.Builder} avoiding the
* need to create one manually via {@link ListBackupJobSummariesRequest#builder()}
*
*
* @param listBackupJobSummariesRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.backup.model.ListBackupJobSummariesRequest.Builder} to create a
* request.
* @return Result of the ListBackupJobSummaries operation returned by the service.
* @throws InvalidParameterValueException
* Indicates that something is wrong with a parameter's value. For example, the value is out of range.
* @throws ServiceUnavailableException
* The request failed due to a temporary failure of the server.
* @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 BackupException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample BackupClient.ListBackupJobSummaries
* @see AWS
* API Documentation
*/
default ListBackupJobSummariesResponse listBackupJobSummaries(
Consumer listBackupJobSummariesRequest) throws InvalidParameterValueException,
ServiceUnavailableException, AwsServiceException, SdkClientException, BackupException {
return listBackupJobSummaries(ListBackupJobSummariesRequest.builder().applyMutation(listBackupJobSummariesRequest)
.build());
}
/**
*
* This is a variant of
* {@link #listBackupJobSummaries(software.amazon.awssdk.services.backup.model.ListBackupJobSummariesRequest)}
* 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.backup.paginators.ListBackupJobSummariesIterable responses = client.listBackupJobSummariesPaginator(request);
* responses.stream().forEach(....);
* }
*
*
* 2) Using For loop
*
*
* {
* @code
* software.amazon.awssdk.services.backup.paginators.ListBackupJobSummariesIterable responses = client
* .listBackupJobSummariesPaginator(request);
* for (software.amazon.awssdk.services.backup.model.ListBackupJobSummariesResponse response : responses) {
* // do something;
* }
* }
*
*
* 3) Use iterator directly
*
*
* {@code
* software.amazon.awssdk.services.backup.paginators.ListBackupJobSummariesIterable responses = client.listBackupJobSummariesPaginator(request);
* responses.iterator().forEachRemaining(....);
* }
*
*
* Please notice that the configuration of MaxResults 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 #listBackupJobSummaries(software.amazon.awssdk.services.backup.model.ListBackupJobSummariesRequest)}
* operation.
*
*
* @param listBackupJobSummariesRequest
* @return A custom iterable that can be used to iterate through all the response pages.
* @throws InvalidParameterValueException
* Indicates that something is wrong with a parameter's value. For example, the value is out of range.
* @throws ServiceUnavailableException
* The request failed due to a temporary failure of the server.
* @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 BackupException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample BackupClient.ListBackupJobSummaries
* @see AWS
* API Documentation
*/
default ListBackupJobSummariesIterable listBackupJobSummariesPaginator(
ListBackupJobSummariesRequest listBackupJobSummariesRequest) throws InvalidParameterValueException,
ServiceUnavailableException, AwsServiceException, SdkClientException, BackupException {
return new ListBackupJobSummariesIterable(this, listBackupJobSummariesRequest);
}
/**
*
* This is a variant of
* {@link #listBackupJobSummaries(software.amazon.awssdk.services.backup.model.ListBackupJobSummariesRequest)}
* 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.backup.paginators.ListBackupJobSummariesIterable responses = client.listBackupJobSummariesPaginator(request);
* responses.stream().forEach(....);
* }
*
*
* 2) Using For loop
*
*
* {
* @code
* software.amazon.awssdk.services.backup.paginators.ListBackupJobSummariesIterable responses = client
* .listBackupJobSummariesPaginator(request);
* for (software.amazon.awssdk.services.backup.model.ListBackupJobSummariesResponse response : responses) {
* // do something;
* }
* }
*
*
* 3) Use iterator directly
*
*
* {@code
* software.amazon.awssdk.services.backup.paginators.ListBackupJobSummariesIterable responses = client.listBackupJobSummariesPaginator(request);
* responses.iterator().forEachRemaining(....);
* }
*
*
* Please notice that the configuration of MaxResults 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 #listBackupJobSummaries(software.amazon.awssdk.services.backup.model.ListBackupJobSummariesRequest)}
* operation.
*
*
*
* This is a convenience which creates an instance of the {@link ListBackupJobSummariesRequest.Builder} avoiding the
* need to create one manually via {@link ListBackupJobSummariesRequest#builder()}
*
*
* @param listBackupJobSummariesRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.backup.model.ListBackupJobSummariesRequest.Builder} to create a
* request.
* @return A custom iterable that can be used to iterate through all the response pages.
* @throws InvalidParameterValueException
* Indicates that something is wrong with a parameter's value. For example, the value is out of range.
* @throws ServiceUnavailableException
* The request failed due to a temporary failure of the server.
* @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 BackupException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample BackupClient.ListBackupJobSummaries
* @see AWS
* API Documentation
*/
default ListBackupJobSummariesIterable listBackupJobSummariesPaginator(
Consumer listBackupJobSummariesRequest) throws InvalidParameterValueException,
ServiceUnavailableException, AwsServiceException, SdkClientException, BackupException {
return listBackupJobSummariesPaginator(ListBackupJobSummariesRequest.builder()
.applyMutation(listBackupJobSummariesRequest).build());
}
/**
*
* Returns a list of existing backup jobs for an authenticated account for the last 30 days. For a longer period of
* time, consider using these monitoring tools.
*
*
* @param listBackupJobsRequest
* @return Result of the ListBackupJobs operation returned by the service.
* @throws InvalidParameterValueException
* Indicates that something is wrong with a parameter's value. For example, the value is out of range.
* @throws ServiceUnavailableException
* The request failed due to a temporary failure of the server.
* @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 BackupException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample BackupClient.ListBackupJobs
* @see AWS API
* Documentation
*/
default ListBackupJobsResponse listBackupJobs(ListBackupJobsRequest listBackupJobsRequest)
throws InvalidParameterValueException, ServiceUnavailableException, AwsServiceException, SdkClientException,
BackupException {
throw new UnsupportedOperationException();
}
/**
*
* Returns a list of existing backup jobs for an authenticated account for the last 30 days. For a longer period of
* time, consider using these monitoring tools.
*
*
*
* This is a convenience which creates an instance of the {@link ListBackupJobsRequest.Builder} avoiding the need to
* create one manually via {@link ListBackupJobsRequest#builder()}
*
*
* @param listBackupJobsRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.backup.model.ListBackupJobsRequest.Builder} to create a request.
* @return Result of the ListBackupJobs operation returned by the service.
* @throws InvalidParameterValueException
* Indicates that something is wrong with a parameter's value. For example, the value is out of range.
* @throws ServiceUnavailableException
* The request failed due to a temporary failure of the server.
* @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 BackupException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample BackupClient.ListBackupJobs
* @see AWS API
* Documentation
*/
default ListBackupJobsResponse listBackupJobs(Consumer listBackupJobsRequest)
throws InvalidParameterValueException, ServiceUnavailableException, AwsServiceException, SdkClientException,
BackupException {
return listBackupJobs(ListBackupJobsRequest.builder().applyMutation(listBackupJobsRequest).build());
}
/**
*
* Returns a list of existing backup jobs for an authenticated account for the last 30 days. For a longer period of
* time, consider using these monitoring tools.
*
*
* @return Result of the ListBackupJobs operation returned by the service.
* @throws InvalidParameterValueException
* Indicates that something is wrong with a parameter's value. For example, the value is out of range.
* @throws ServiceUnavailableException
* The request failed due to a temporary failure of the server.
* @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 BackupException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample BackupClient.ListBackupJobs
* @see #listBackupJobs(ListBackupJobsRequest)
* @see AWS API
* Documentation
*/
default ListBackupJobsResponse listBackupJobs() throws InvalidParameterValueException, ServiceUnavailableException,
AwsServiceException, SdkClientException, BackupException {
return listBackupJobs(ListBackupJobsRequest.builder().build());
}
/**
*
* This is a variant of {@link #listBackupJobs(software.amazon.awssdk.services.backup.model.ListBackupJobsRequest)}
* 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.backup.paginators.ListBackupJobsIterable responses = client.listBackupJobsPaginator(request);
* responses.stream().forEach(....);
* }
*
*
* 2) Using For loop
*
*
* {
* @code
* software.amazon.awssdk.services.backup.paginators.ListBackupJobsIterable responses = client.listBackupJobsPaginator(request);
* for (software.amazon.awssdk.services.backup.model.ListBackupJobsResponse response : responses) {
* // do something;
* }
* }
*
*
* 3) Use iterator directly
*
*
* {@code
* software.amazon.awssdk.services.backup.paginators.ListBackupJobsIterable responses = client.listBackupJobsPaginator(request);
* responses.iterator().forEachRemaining(....);
* }
*
*
* Please notice that the configuration of MaxResults 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 #listBackupJobs(software.amazon.awssdk.services.backup.model.ListBackupJobsRequest)} operation.
*
*
* @return A custom iterable that can be used to iterate through all the response pages.
* @throws InvalidParameterValueException
* Indicates that something is wrong with a parameter's value. For example, the value is out of range.
* @throws ServiceUnavailableException
* The request failed due to a temporary failure of the server.
* @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 BackupException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample BackupClient.ListBackupJobs
* @see #listBackupJobsPaginator(ListBackupJobsRequest)
* @see AWS API
* Documentation
*/
default ListBackupJobsIterable listBackupJobsPaginator() throws InvalidParameterValueException, ServiceUnavailableException,
AwsServiceException, SdkClientException, BackupException {
return listBackupJobsPaginator(ListBackupJobsRequest.builder().build());
}
/**
*
* This is a variant of {@link #listBackupJobs(software.amazon.awssdk.services.backup.model.ListBackupJobsRequest)}
* 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.backup.paginators.ListBackupJobsIterable responses = client.listBackupJobsPaginator(request);
* responses.stream().forEach(....);
* }
*
*
* 2) Using For loop
*
*
* {
* @code
* software.amazon.awssdk.services.backup.paginators.ListBackupJobsIterable responses = client.listBackupJobsPaginator(request);
* for (software.amazon.awssdk.services.backup.model.ListBackupJobsResponse response : responses) {
* // do something;
* }
* }
*
*
* 3) Use iterator directly
*
*
* {@code
* software.amazon.awssdk.services.backup.paginators.ListBackupJobsIterable responses = client.listBackupJobsPaginator(request);
* responses.iterator().forEachRemaining(....);
* }
*
*
* Please notice that the configuration of MaxResults 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 #listBackupJobs(software.amazon.awssdk.services.backup.model.ListBackupJobsRequest)} operation.
*
*
* @param listBackupJobsRequest
* @return A custom iterable that can be used to iterate through all the response pages.
* @throws InvalidParameterValueException
* Indicates that something is wrong with a parameter's value. For example, the value is out of range.
* @throws ServiceUnavailableException
* The request failed due to a temporary failure of the server.
* @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 BackupException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample BackupClient.ListBackupJobs
* @see AWS API
* Documentation
*/
default ListBackupJobsIterable listBackupJobsPaginator(ListBackupJobsRequest listBackupJobsRequest)
throws InvalidParameterValueException, ServiceUnavailableException, AwsServiceException, SdkClientException,
BackupException {
return new ListBackupJobsIterable(this, listBackupJobsRequest);
}
/**
*
* This is a variant of {@link #listBackupJobs(software.amazon.awssdk.services.backup.model.ListBackupJobsRequest)}
* 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.backup.paginators.ListBackupJobsIterable responses = client.listBackupJobsPaginator(request);
* responses.stream().forEach(....);
* }
*
*
* 2) Using For loop
*
*
* {
* @code
* software.amazon.awssdk.services.backup.paginators.ListBackupJobsIterable responses = client.listBackupJobsPaginator(request);
* for (software.amazon.awssdk.services.backup.model.ListBackupJobsResponse response : responses) {
* // do something;
* }
* }
*
*
* 3) Use iterator directly
*
*
* {@code
* software.amazon.awssdk.services.backup.paginators.ListBackupJobsIterable responses = client.listBackupJobsPaginator(request);
* responses.iterator().forEachRemaining(....);
* }
*
*
* Please notice that the configuration of MaxResults 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 #listBackupJobs(software.amazon.awssdk.services.backup.model.ListBackupJobsRequest)} operation.
*
*
*
* This is a convenience which creates an instance of the {@link ListBackupJobsRequest.Builder} avoiding the need to
* create one manually via {@link ListBackupJobsRequest#builder()}
*
*
* @param listBackupJobsRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.backup.model.ListBackupJobsRequest.Builder} to create a request.
* @return A custom iterable that can be used to iterate through all the response pages.
* @throws InvalidParameterValueException
* Indicates that something is wrong with a parameter's value. For example, the value is out of range.
* @throws ServiceUnavailableException
* The request failed due to a temporary failure of the server.
* @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 BackupException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample BackupClient.ListBackupJobs
* @see AWS API
* Documentation
*/
default ListBackupJobsIterable listBackupJobsPaginator(Consumer listBackupJobsRequest)
throws InvalidParameterValueException, ServiceUnavailableException, AwsServiceException, SdkClientException,
BackupException {
return listBackupJobsPaginator(ListBackupJobsRequest.builder().applyMutation(listBackupJobsRequest).build());
}
/**
*
* Lists the backup plan templates.
*
*
* @param listBackupPlanTemplatesRequest
* @return Result of the ListBackupPlanTemplates operation returned by the service.
* @throws InvalidParameterValueException
* Indicates that something is wrong with a parameter's value. For example, the value is out of range.
* @throws MissingParameterValueException
* Indicates that a required parameter is missing.
* @throws ServiceUnavailableException
* The request failed due to a temporary failure of the server.
* @throws ResourceNotFoundException
* A resource that is required for the action doesn't 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 BackupException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample BackupClient.ListBackupPlanTemplates
* @see AWS API Documentation
*/
default ListBackupPlanTemplatesResponse listBackupPlanTemplates(ListBackupPlanTemplatesRequest listBackupPlanTemplatesRequest)
throws InvalidParameterValueException, MissingParameterValueException, ServiceUnavailableException,
ResourceNotFoundException, AwsServiceException, SdkClientException, BackupException {
throw new UnsupportedOperationException();
}
/**
*
* Lists the backup plan templates.
*
*
*
* This is a convenience which creates an instance of the {@link ListBackupPlanTemplatesRequest.Builder} avoiding
* the need to create one manually via {@link ListBackupPlanTemplatesRequest#builder()}
*
*
* @param listBackupPlanTemplatesRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.backup.model.ListBackupPlanTemplatesRequest.Builder} to create a
* request.
* @return Result of the ListBackupPlanTemplates operation returned by the service.
* @throws InvalidParameterValueException
* Indicates that something is wrong with a parameter's value. For example, the value is out of range.
* @throws MissingParameterValueException
* Indicates that a required parameter is missing.
* @throws ServiceUnavailableException
* The request failed due to a temporary failure of the server.
* @throws ResourceNotFoundException
* A resource that is required for the action doesn't 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 BackupException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample BackupClient.ListBackupPlanTemplates
* @see AWS API Documentation
*/
default ListBackupPlanTemplatesResponse listBackupPlanTemplates(
Consumer listBackupPlanTemplatesRequest)
throws InvalidParameterValueException, MissingParameterValueException, ServiceUnavailableException,
ResourceNotFoundException, AwsServiceException, SdkClientException, BackupException {
return listBackupPlanTemplates(ListBackupPlanTemplatesRequest.builder().applyMutation(listBackupPlanTemplatesRequest)
.build());
}
/**
*
* Lists the backup plan templates.
*
*
* @return Result of the ListBackupPlanTemplates operation returned by the service.
* @throws InvalidParameterValueException
* Indicates that something is wrong with a parameter's value. For example, the value is out of range.
* @throws MissingParameterValueException
* Indicates that a required parameter is missing.
* @throws ServiceUnavailableException
* The request failed due to a temporary failure of the server.
* @throws ResourceNotFoundException
* A resource that is required for the action doesn't 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 BackupException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample BackupClient.ListBackupPlanTemplates
* @see #listBackupPlanTemplates(ListBackupPlanTemplatesRequest)
* @see AWS API Documentation
*/
default ListBackupPlanTemplatesResponse listBackupPlanTemplates() throws InvalidParameterValueException,
MissingParameterValueException, ServiceUnavailableException, ResourceNotFoundException, AwsServiceException,
SdkClientException, BackupException {
return listBackupPlanTemplates(ListBackupPlanTemplatesRequest.builder().build());
}
/**
*
* This is a variant of
* {@link #listBackupPlanTemplates(software.amazon.awssdk.services.backup.model.ListBackupPlanTemplatesRequest)}
* 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.backup.paginators.ListBackupPlanTemplatesIterable responses = client.listBackupPlanTemplatesPaginator(request);
* responses.stream().forEach(....);
* }
*
*
* 2) Using For loop
*
*
* {
* @code
* software.amazon.awssdk.services.backup.paginators.ListBackupPlanTemplatesIterable responses = client
* .listBackupPlanTemplatesPaginator(request);
* for (software.amazon.awssdk.services.backup.model.ListBackupPlanTemplatesResponse response : responses) {
* // do something;
* }
* }
*
*
* 3) Use iterator directly
*
*
* {@code
* software.amazon.awssdk.services.backup.paginators.ListBackupPlanTemplatesIterable responses = client.listBackupPlanTemplatesPaginator(request);
* responses.iterator().forEachRemaining(....);
* }
*
*
* Please notice that the configuration of MaxResults 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 #listBackupPlanTemplates(software.amazon.awssdk.services.backup.model.ListBackupPlanTemplatesRequest)}
* operation.
*
*
* @return A custom iterable that can be used to iterate through all the response pages.
* @throws InvalidParameterValueException
* Indicates that something is wrong with a parameter's value. For example, the value is out of range.
* @throws MissingParameterValueException
* Indicates that a required parameter is missing.
* @throws ServiceUnavailableException
* The request failed due to a temporary failure of the server.
* @throws ResourceNotFoundException
* A resource that is required for the action doesn't 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 BackupException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample BackupClient.ListBackupPlanTemplates
* @see #listBackupPlanTemplatesPaginator(ListBackupPlanTemplatesRequest)
* @see AWS API Documentation
*/
default ListBackupPlanTemplatesIterable listBackupPlanTemplatesPaginator() throws InvalidParameterValueException,
MissingParameterValueException, ServiceUnavailableException, ResourceNotFoundException, AwsServiceException,
SdkClientException, BackupException {
return listBackupPlanTemplatesPaginator(ListBackupPlanTemplatesRequest.builder().build());
}
/**
*
* This is a variant of
* {@link #listBackupPlanTemplates(software.amazon.awssdk.services.backup.model.ListBackupPlanTemplatesRequest)}
* 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.backup.paginators.ListBackupPlanTemplatesIterable responses = client.listBackupPlanTemplatesPaginator(request);
* responses.stream().forEach(....);
* }
*
*
* 2) Using For loop
*
*
* {
* @code
* software.amazon.awssdk.services.backup.paginators.ListBackupPlanTemplatesIterable responses = client
* .listBackupPlanTemplatesPaginator(request);
* for (software.amazon.awssdk.services.backup.model.ListBackupPlanTemplatesResponse response : responses) {
* // do something;
* }
* }
*
*
* 3) Use iterator directly
*
*
* {@code
* software.amazon.awssdk.services.backup.paginators.ListBackupPlanTemplatesIterable responses = client.listBackupPlanTemplatesPaginator(request);
* responses.iterator().forEachRemaining(....);
* }
*
*
* Please notice that the configuration of MaxResults 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 #listBackupPlanTemplates(software.amazon.awssdk.services.backup.model.ListBackupPlanTemplatesRequest)}
* operation.
*
*
* @param listBackupPlanTemplatesRequest
* @return A custom iterable that can be used to iterate through all the response pages.
* @throws InvalidParameterValueException
* Indicates that something is wrong with a parameter's value. For example, the value is out of range.
* @throws MissingParameterValueException
* Indicates that a required parameter is missing.
* @throws ServiceUnavailableException
* The request failed due to a temporary failure of the server.
* @throws ResourceNotFoundException
* A resource that is required for the action doesn't 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 BackupException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample BackupClient.ListBackupPlanTemplates
* @see AWS API Documentation
*/
default ListBackupPlanTemplatesIterable listBackupPlanTemplatesPaginator(
ListBackupPlanTemplatesRequest listBackupPlanTemplatesRequest) throws InvalidParameterValueException,
MissingParameterValueException, ServiceUnavailableException, ResourceNotFoundException, AwsServiceException,
SdkClientException, BackupException {
return new ListBackupPlanTemplatesIterable(this, listBackupPlanTemplatesRequest);
}
/**
*
* This is a variant of
* {@link #listBackupPlanTemplates(software.amazon.awssdk.services.backup.model.ListBackupPlanTemplatesRequest)}
* 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.backup.paginators.ListBackupPlanTemplatesIterable responses = client.listBackupPlanTemplatesPaginator(request);
* responses.stream().forEach(....);
* }
*
*
* 2) Using For loop
*
*
* {
* @code
* software.amazon.awssdk.services.backup.paginators.ListBackupPlanTemplatesIterable responses = client
* .listBackupPlanTemplatesPaginator(request);
* for (software.amazon.awssdk.services.backup.model.ListBackupPlanTemplatesResponse response : responses) {
* // do something;
* }
* }
*
*
* 3) Use iterator directly
*
*
* {@code
* software.amazon.awssdk.services.backup.paginators.ListBackupPlanTemplatesIterable responses = client.listBackupPlanTemplatesPaginator(request);
* responses.iterator().forEachRemaining(....);
* }
*
*
* Please notice that the configuration of MaxResults 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 #listBackupPlanTemplates(software.amazon.awssdk.services.backup.model.ListBackupPlanTemplatesRequest)}
* operation.
*
*
*
* This is a convenience which creates an instance of the {@link ListBackupPlanTemplatesRequest.Builder} avoiding
* the need to create one manually via {@link ListBackupPlanTemplatesRequest#builder()}
*
*
* @param listBackupPlanTemplatesRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.backup.model.ListBackupPlanTemplatesRequest.Builder} to create a
* request.
* @return A custom iterable that can be used to iterate through all the response pages.
* @throws InvalidParameterValueException
* Indicates that something is wrong with a parameter's value. For example, the value is out of range.
* @throws MissingParameterValueException
* Indicates that a required parameter is missing.
* @throws ServiceUnavailableException
* The request failed due to a temporary failure of the server.
* @throws ResourceNotFoundException
* A resource that is required for the action doesn't 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 BackupException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample BackupClient.ListBackupPlanTemplates
* @see AWS API Documentation
*/
default ListBackupPlanTemplatesIterable listBackupPlanTemplatesPaginator(
Consumer listBackupPlanTemplatesRequest)
throws InvalidParameterValueException, MissingParameterValueException, ServiceUnavailableException,
ResourceNotFoundException, AwsServiceException, SdkClientException, BackupException {
return listBackupPlanTemplatesPaginator(ListBackupPlanTemplatesRequest.builder()
.applyMutation(listBackupPlanTemplatesRequest).build());
}
/**
*
* Returns version metadata of your backup plans, including Amazon Resource Names (ARNs), backup plan IDs, creation
* and deletion dates, plan names, and version IDs.
*
*
* @param listBackupPlanVersionsRequest
* @return Result of the ListBackupPlanVersions operation returned by the service.
* @throws ResourceNotFoundException
* A resource that is required for the action doesn't exist.
* @throws InvalidParameterValueException
* Indicates that something is wrong with a parameter's value. For example, the value is out of range.
* @throws MissingParameterValueException
* Indicates that a required parameter is missing.
* @throws ServiceUnavailableException
* The request failed due to a temporary failure of the server.
* @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 BackupException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample BackupClient.ListBackupPlanVersions
* @see AWS
* API Documentation
*/
default ListBackupPlanVersionsResponse listBackupPlanVersions(ListBackupPlanVersionsRequest listBackupPlanVersionsRequest)
throws ResourceNotFoundException, InvalidParameterValueException, MissingParameterValueException,
ServiceUnavailableException, AwsServiceException, SdkClientException, BackupException {
throw new UnsupportedOperationException();
}
/**
*
* Returns version metadata of your backup plans, including Amazon Resource Names (ARNs), backup plan IDs, creation
* and deletion dates, plan names, and version IDs.
*
*
*
* This is a convenience which creates an instance of the {@link ListBackupPlanVersionsRequest.Builder} avoiding the
* need to create one manually via {@link ListBackupPlanVersionsRequest#builder()}
*
*
* @param listBackupPlanVersionsRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.backup.model.ListBackupPlanVersionsRequest.Builder} to create a
* request.
* @return Result of the ListBackupPlanVersions operation returned by the service.
* @throws ResourceNotFoundException
* A resource that is required for the action doesn't exist.
* @throws InvalidParameterValueException
* Indicates that something is wrong with a parameter's value. For example, the value is out of range.
* @throws MissingParameterValueException
* Indicates that a required parameter is missing.
* @throws ServiceUnavailableException
* The request failed due to a temporary failure of the server.
* @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 BackupException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample BackupClient.ListBackupPlanVersions
* @see AWS
* API Documentation
*/
default ListBackupPlanVersionsResponse listBackupPlanVersions(
Consumer listBackupPlanVersionsRequest) throws ResourceNotFoundException,
InvalidParameterValueException, MissingParameterValueException, ServiceUnavailableException, AwsServiceException,
SdkClientException, BackupException {
return listBackupPlanVersions(ListBackupPlanVersionsRequest.builder().applyMutation(listBackupPlanVersionsRequest)
.build());
}
/**
*
* This is a variant of
* {@link #listBackupPlanVersions(software.amazon.awssdk.services.backup.model.ListBackupPlanVersionsRequest)}
* 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.backup.paginators.ListBackupPlanVersionsIterable responses = client.listBackupPlanVersionsPaginator(request);
* responses.stream().forEach(....);
* }
*
*
* 2) Using For loop
*
*
* {
* @code
* software.amazon.awssdk.services.backup.paginators.ListBackupPlanVersionsIterable responses = client
* .listBackupPlanVersionsPaginator(request);
* for (software.amazon.awssdk.services.backup.model.ListBackupPlanVersionsResponse response : responses) {
* // do something;
* }
* }
*
*
* 3) Use iterator directly
*
*
* {@code
* software.amazon.awssdk.services.backup.paginators.ListBackupPlanVersionsIterable responses = client.listBackupPlanVersionsPaginator(request);
* responses.iterator().forEachRemaining(....);
* }
*
*
* Please notice that the configuration of MaxResults 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 #listBackupPlanVersions(software.amazon.awssdk.services.backup.model.ListBackupPlanVersionsRequest)}
* operation.
*
*
* @param listBackupPlanVersionsRequest
* @return A custom iterable that can be used to iterate through all the response pages.
* @throws ResourceNotFoundException
* A resource that is required for the action doesn't exist.
* @throws InvalidParameterValueException
* Indicates that something is wrong with a parameter's value. For example, the value is out of range.
* @throws MissingParameterValueException
* Indicates that a required parameter is missing.
* @throws ServiceUnavailableException
* The request failed due to a temporary failure of the server.
* @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 BackupException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample BackupClient.ListBackupPlanVersions
* @see AWS
* API Documentation
*/
default ListBackupPlanVersionsIterable listBackupPlanVersionsPaginator(
ListBackupPlanVersionsRequest listBackupPlanVersionsRequest) throws ResourceNotFoundException,
InvalidParameterValueException, MissingParameterValueException, ServiceUnavailableException, AwsServiceException,
SdkClientException, BackupException {
return new ListBackupPlanVersionsIterable(this, listBackupPlanVersionsRequest);
}
/**
*
* This is a variant of
* {@link #listBackupPlanVersions(software.amazon.awssdk.services.backup.model.ListBackupPlanVersionsRequest)}
* 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.backup.paginators.ListBackupPlanVersionsIterable responses = client.listBackupPlanVersionsPaginator(request);
* responses.stream().forEach(....);
* }
*
*
* 2) Using For loop
*
*
* {
* @code
* software.amazon.awssdk.services.backup.paginators.ListBackupPlanVersionsIterable responses = client
* .listBackupPlanVersionsPaginator(request);
* for (software.amazon.awssdk.services.backup.model.ListBackupPlanVersionsResponse response : responses) {
* // do something;
* }
* }
*
*
* 3) Use iterator directly
*
*
* {@code
* software.amazon.awssdk.services.backup.paginators.ListBackupPlanVersionsIterable responses = client.listBackupPlanVersionsPaginator(request);
* responses.iterator().forEachRemaining(....);
* }
*
*
* Please notice that the configuration of MaxResults 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 #listBackupPlanVersions(software.amazon.awssdk.services.backup.model.ListBackupPlanVersionsRequest)}
* operation.
*
*
*
* This is a convenience which creates an instance of the {@link ListBackupPlanVersionsRequest.Builder} avoiding the
* need to create one manually via {@link ListBackupPlanVersionsRequest#builder()}
*
*
* @param listBackupPlanVersionsRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.backup.model.ListBackupPlanVersionsRequest.Builder} to create a
* request.
* @return A custom iterable that can be used to iterate through all the response pages.
* @throws ResourceNotFoundException
* A resource that is required for the action doesn't exist.
* @throws InvalidParameterValueException
* Indicates that something is wrong with a parameter's value. For example, the value is out of range.
* @throws MissingParameterValueException
* Indicates that a required parameter is missing.
* @throws ServiceUnavailableException
* The request failed due to a temporary failure of the server.
* @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 BackupException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample BackupClient.ListBackupPlanVersions
* @see AWS
* API Documentation
*/
default ListBackupPlanVersionsIterable listBackupPlanVersionsPaginator(
Consumer listBackupPlanVersionsRequest) throws ResourceNotFoundException,
InvalidParameterValueException, MissingParameterValueException, ServiceUnavailableException, AwsServiceException,
SdkClientException, BackupException {
return listBackupPlanVersionsPaginator(ListBackupPlanVersionsRequest.builder()
.applyMutation(listBackupPlanVersionsRequest).build());
}
/**
*
* Lists the active backup plans for the account.
*
*
* @param listBackupPlansRequest
* @return Result of the ListBackupPlans operation returned by the service.
* @throws ResourceNotFoundException
* A resource that is required for the action doesn't exist.
* @throws InvalidParameterValueException
* Indicates that something is wrong with a parameter's value. For example, the value is out of range.
* @throws MissingParameterValueException
* Indicates that a required parameter is missing.
* @throws ServiceUnavailableException
* The request failed due to a temporary failure of the server.
* @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 BackupException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample BackupClient.ListBackupPlans
* @see AWS API
* Documentation
*/
default ListBackupPlansResponse listBackupPlans(ListBackupPlansRequest listBackupPlansRequest)
throws ResourceNotFoundException, InvalidParameterValueException, MissingParameterValueException,
ServiceUnavailableException, AwsServiceException, SdkClientException, BackupException {
throw new UnsupportedOperationException();
}
/**
*
* Lists the active backup plans for the account.
*
*
*
* This is a convenience which creates an instance of the {@link ListBackupPlansRequest.Builder} avoiding the need
* to create one manually via {@link ListBackupPlansRequest#builder()}
*
*
* @param listBackupPlansRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.backup.model.ListBackupPlansRequest.Builder} to create a request.
* @return Result of the ListBackupPlans operation returned by the service.
* @throws ResourceNotFoundException
* A resource that is required for the action doesn't exist.
* @throws InvalidParameterValueException
* Indicates that something is wrong with a parameter's value. For example, the value is out of range.
* @throws MissingParameterValueException
* Indicates that a required parameter is missing.
* @throws ServiceUnavailableException
* The request failed due to a temporary failure of the server.
* @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 BackupException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample BackupClient.ListBackupPlans
* @see AWS API
* Documentation
*/
default ListBackupPlansResponse listBackupPlans(Consumer listBackupPlansRequest)
throws ResourceNotFoundException, InvalidParameterValueException, MissingParameterValueException,
ServiceUnavailableException, AwsServiceException, SdkClientException, BackupException {
return listBackupPlans(ListBackupPlansRequest.builder().applyMutation(listBackupPlansRequest).build());
}
/**
*
* Lists the active backup plans for the account.
*
*
* @return Result of the ListBackupPlans operation returned by the service.
* @throws ResourceNotFoundException
* A resource that is required for the action doesn't exist.
* @throws InvalidParameterValueException
* Indicates that something is wrong with a parameter's value. For example, the value is out of range.
* @throws MissingParameterValueException
* Indicates that a required parameter is missing.
* @throws ServiceUnavailableException
* The request failed due to a temporary failure of the server.
* @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 BackupException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample BackupClient.ListBackupPlans
* @see #listBackupPlans(ListBackupPlansRequest)
* @see AWS API
* Documentation
*/
default ListBackupPlansResponse listBackupPlans() throws ResourceNotFoundException, InvalidParameterValueException,
MissingParameterValueException, ServiceUnavailableException, AwsServiceException, SdkClientException, BackupException {
return listBackupPlans(ListBackupPlansRequest.builder().build());
}
/**
*
* This is a variant of
* {@link #listBackupPlans(software.amazon.awssdk.services.backup.model.ListBackupPlansRequest)} 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.backup.paginators.ListBackupPlansIterable responses = client.listBackupPlansPaginator(request);
* responses.stream().forEach(....);
* }
*
*
* 2) Using For loop
*
*
* {
* @code
* software.amazon.awssdk.services.backup.paginators.ListBackupPlansIterable responses = client
* .listBackupPlansPaginator(request);
* for (software.amazon.awssdk.services.backup.model.ListBackupPlansResponse response : responses) {
* // do something;
* }
* }
*
*
* 3) Use iterator directly
*
*
* {@code
* software.amazon.awssdk.services.backup.paginators.ListBackupPlansIterable responses = client.listBackupPlansPaginator(request);
* responses.iterator().forEachRemaining(....);
* }
*
*
* Please notice that the configuration of MaxResults 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 #listBackupPlans(software.amazon.awssdk.services.backup.model.ListBackupPlansRequest)} operation.
*
*
* @return A custom iterable that can be used to iterate through all the response pages.
* @throws ResourceNotFoundException
* A resource that is required for the action doesn't exist.
* @throws InvalidParameterValueException
* Indicates that something is wrong with a parameter's value. For example, the value is out of range.
* @throws MissingParameterValueException
* Indicates that a required parameter is missing.
* @throws ServiceUnavailableException
* The request failed due to a temporary failure of the server.
* @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 BackupException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample BackupClient.ListBackupPlans
* @see #listBackupPlansPaginator(ListBackupPlansRequest)
* @see AWS API
* Documentation
*/
default ListBackupPlansIterable listBackupPlansPaginator() throws ResourceNotFoundException, InvalidParameterValueException,
MissingParameterValueException, ServiceUnavailableException, AwsServiceException, SdkClientException, BackupException {
return listBackupPlansPaginator(ListBackupPlansRequest.builder().build());
}
/**
*
* This is a variant of
* {@link #listBackupPlans(software.amazon.awssdk.services.backup.model.ListBackupPlansRequest)} 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.backup.paginators.ListBackupPlansIterable responses = client.listBackupPlansPaginator(request);
* responses.stream().forEach(....);
* }
*
*
* 2) Using For loop
*
*
* {
* @code
* software.amazon.awssdk.services.backup.paginators.ListBackupPlansIterable responses = client
* .listBackupPlansPaginator(request);
* for (software.amazon.awssdk.services.backup.model.ListBackupPlansResponse response : responses) {
* // do something;
* }
* }
*
*
* 3) Use iterator directly
*
*
* {@code
* software.amazon.awssdk.services.backup.paginators.ListBackupPlansIterable responses = client.listBackupPlansPaginator(request);
* responses.iterator().forEachRemaining(....);
* }
*
*
* Please notice that the configuration of MaxResults 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 #listBackupPlans(software.amazon.awssdk.services.backup.model.ListBackupPlansRequest)} operation.
*
*
* @param listBackupPlansRequest
* @return A custom iterable that can be used to iterate through all the response pages.
* @throws ResourceNotFoundException
* A resource that is required for the action doesn't exist.
* @throws InvalidParameterValueException
* Indicates that something is wrong with a parameter's value. For example, the value is out of range.
* @throws MissingParameterValueException
* Indicates that a required parameter is missing.
* @throws ServiceUnavailableException
* The request failed due to a temporary failure of the server.
* @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 BackupException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample BackupClient.ListBackupPlans
* @see AWS API
* Documentation
*/
default ListBackupPlansIterable listBackupPlansPaginator(ListBackupPlansRequest listBackupPlansRequest)
throws ResourceNotFoundException, InvalidParameterValueException, MissingParameterValueException,
ServiceUnavailableException, AwsServiceException, SdkClientException, BackupException {
return new ListBackupPlansIterable(this, listBackupPlansRequest);
}
/**
*
* This is a variant of
* {@link #listBackupPlans(software.amazon.awssdk.services.backup.model.ListBackupPlansRequest)} 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.backup.paginators.ListBackupPlansIterable responses = client.listBackupPlansPaginator(request);
* responses.stream().forEach(....);
* }
*
*
* 2) Using For loop
*
*
* {
* @code
* software.amazon.awssdk.services.backup.paginators.ListBackupPlansIterable responses = client
* .listBackupPlansPaginator(request);
* for (software.amazon.awssdk.services.backup.model.ListBackupPlansResponse response : responses) {
* // do something;
* }
* }
*
*
* 3) Use iterator directly
*
*
* {@code
* software.amazon.awssdk.services.backup.paginators.ListBackupPlansIterable responses = client.listBackupPlansPaginator(request);
* responses.iterator().forEachRemaining(....);
* }
*
*
* Please notice that the configuration of MaxResults 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 #listBackupPlans(software.amazon.awssdk.services.backup.model.ListBackupPlansRequest)} operation.
*
*
*
* This is a convenience which creates an instance of the {@link ListBackupPlansRequest.Builder} avoiding the need
* to create one manually via {@link ListBackupPlansRequest#builder()}
*
*
* @param listBackupPlansRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.backup.model.ListBackupPlansRequest.Builder} to create a request.
* @return A custom iterable that can be used to iterate through all the response pages.
* @throws ResourceNotFoundException
* A resource that is required for the action doesn't exist.
* @throws InvalidParameterValueException
* Indicates that something is wrong with a parameter's value. For example, the value is out of range.
* @throws MissingParameterValueException
* Indicates that a required parameter is missing.
* @throws ServiceUnavailableException
* The request failed due to a temporary failure of the server.
* @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 BackupException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample BackupClient.ListBackupPlans
* @see AWS API
* Documentation
*/
default ListBackupPlansIterable listBackupPlansPaginator(Consumer listBackupPlansRequest)
throws ResourceNotFoundException, InvalidParameterValueException, MissingParameterValueException,
ServiceUnavailableException, AwsServiceException, SdkClientException, BackupException {
return listBackupPlansPaginator(ListBackupPlansRequest.builder().applyMutation(listBackupPlansRequest).build());
}
/**
*
* Returns an array containing metadata of the resources associated with the target backup plan.
*
*
* @param listBackupSelectionsRequest
* @return Result of the ListBackupSelections operation returned by the service.
* @throws ResourceNotFoundException
* A resource that is required for the action doesn't exist.
* @throws InvalidParameterValueException
* Indicates that something is wrong with a parameter's value. For example, the value is out of range.
* @throws MissingParameterValueException
* Indicates that a required parameter is missing.
* @throws ServiceUnavailableException
* The request failed due to a temporary failure of the server.
* @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 BackupException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample BackupClient.ListBackupSelections
* @see AWS
* API Documentation
*/
default ListBackupSelectionsResponse listBackupSelections(ListBackupSelectionsRequest listBackupSelectionsRequest)
throws ResourceNotFoundException, InvalidParameterValueException, MissingParameterValueException,
ServiceUnavailableException, AwsServiceException, SdkClientException, BackupException {
throw new UnsupportedOperationException();
}
/**
*
* Returns an array containing metadata of the resources associated with the target backup plan.
*
*
*
* This is a convenience which creates an instance of the {@link ListBackupSelectionsRequest.Builder} avoiding the
* need to create one manually via {@link ListBackupSelectionsRequest#builder()}
*
*
* @param listBackupSelectionsRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.backup.model.ListBackupSelectionsRequest.Builder} to create a
* request.
* @return Result of the ListBackupSelections operation returned by the service.
* @throws ResourceNotFoundException
* A resource that is required for the action doesn't exist.
* @throws InvalidParameterValueException
* Indicates that something is wrong with a parameter's value. For example, the value is out of range.
* @throws MissingParameterValueException
* Indicates that a required parameter is missing.
* @throws ServiceUnavailableException
* The request failed due to a temporary failure of the server.
* @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 BackupException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample BackupClient.ListBackupSelections
* @see AWS
* API Documentation
*/
default ListBackupSelectionsResponse listBackupSelections(
Consumer listBackupSelectionsRequest) throws ResourceNotFoundException,
InvalidParameterValueException, MissingParameterValueException, ServiceUnavailableException, AwsServiceException,
SdkClientException, BackupException {
return listBackupSelections(ListBackupSelectionsRequest.builder().applyMutation(listBackupSelectionsRequest).build());
}
/**
*
* This is a variant of
* {@link #listBackupSelections(software.amazon.awssdk.services.backup.model.ListBackupSelectionsRequest)}
* 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.backup.paginators.ListBackupSelectionsIterable responses = client.listBackupSelectionsPaginator(request);
* responses.stream().forEach(....);
* }
*
*
* 2) Using For loop
*
*
* {
* @code
* software.amazon.awssdk.services.backup.paginators.ListBackupSelectionsIterable responses = client
* .listBackupSelectionsPaginator(request);
* for (software.amazon.awssdk.services.backup.model.ListBackupSelectionsResponse response : responses) {
* // do something;
* }
* }
*
*
* 3) Use iterator directly
*
*
* {@code
* software.amazon.awssdk.services.backup.paginators.ListBackupSelectionsIterable responses = client.listBackupSelectionsPaginator(request);
* responses.iterator().forEachRemaining(....);
* }
*
*
* Please notice that the configuration of MaxResults 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 #listBackupSelections(software.amazon.awssdk.services.backup.model.ListBackupSelectionsRequest)}
* operation.
*
*
* @param listBackupSelectionsRequest
* @return A custom iterable that can be used to iterate through all the response pages.
* @throws ResourceNotFoundException
* A resource that is required for the action doesn't exist.
* @throws InvalidParameterValueException
* Indicates that something is wrong with a parameter's value. For example, the value is out of range.
* @throws MissingParameterValueException
* Indicates that a required parameter is missing.
* @throws ServiceUnavailableException
* The request failed due to a temporary failure of the server.
* @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 BackupException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample BackupClient.ListBackupSelections
* @see AWS
* API Documentation
*/
default ListBackupSelectionsIterable listBackupSelectionsPaginator(ListBackupSelectionsRequest listBackupSelectionsRequest)
throws ResourceNotFoundException, InvalidParameterValueException, MissingParameterValueException,
ServiceUnavailableException, AwsServiceException, SdkClientException, BackupException {
return new ListBackupSelectionsIterable(this, listBackupSelectionsRequest);
}
/**
*
* This is a variant of
* {@link #listBackupSelections(software.amazon.awssdk.services.backup.model.ListBackupSelectionsRequest)}
* 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.backup.paginators.ListBackupSelectionsIterable responses = client.listBackupSelectionsPaginator(request);
* responses.stream().forEach(....);
* }
*
*
* 2) Using For loop
*
*
* {
* @code
* software.amazon.awssdk.services.backup.paginators.ListBackupSelectionsIterable responses = client
* .listBackupSelectionsPaginator(request);
* for (software.amazon.awssdk.services.backup.model.ListBackupSelectionsResponse response : responses) {
* // do something;
* }
* }
*
*
* 3) Use iterator directly
*
*
* {@code
* software.amazon.awssdk.services.backup.paginators.ListBackupSelectionsIterable responses = client.listBackupSelectionsPaginator(request);
* responses.iterator().forEachRemaining(....);
* }
*
*
* Please notice that the configuration of MaxResults 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 #listBackupSelections(software.amazon.awssdk.services.backup.model.ListBackupSelectionsRequest)}
* operation.
*
*
*
* This is a convenience which creates an instance of the {@link ListBackupSelectionsRequest.Builder} avoiding the
* need to create one manually via {@link ListBackupSelectionsRequest#builder()}
*
*
* @param listBackupSelectionsRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.backup.model.ListBackupSelectionsRequest.Builder} to create a
* request.
* @return A custom iterable that can be used to iterate through all the response pages.
* @throws ResourceNotFoundException
* A resource that is required for the action doesn't exist.
* @throws InvalidParameterValueException
* Indicates that something is wrong with a parameter's value. For example, the value is out of range.
* @throws MissingParameterValueException
* Indicates that a required parameter is missing.
* @throws ServiceUnavailableException
* The request failed due to a temporary failure of the server.
* @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 BackupException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample BackupClient.ListBackupSelections
* @see AWS
* API Documentation
*/
default ListBackupSelectionsIterable listBackupSelectionsPaginator(
Consumer listBackupSelectionsRequest) throws ResourceNotFoundException,
InvalidParameterValueException, MissingParameterValueException, ServiceUnavailableException, AwsServiceException,
SdkClientException, BackupException {
return listBackupSelectionsPaginator(ListBackupSelectionsRequest.builder().applyMutation(listBackupSelectionsRequest)
.build());
}
/**
*
* Returns a list of recovery point storage containers along with information about them.
*
*
* @param listBackupVaultsRequest
* @return Result of the ListBackupVaults operation returned by the service.
* @throws ResourceNotFoundException
* A resource that is required for the action doesn't exist.
* @throws InvalidParameterValueException
* Indicates that something is wrong with a parameter's value. For example, the value is out of range.
* @throws MissingParameterValueException
* Indicates that a required parameter is missing.
* @throws ServiceUnavailableException
* The request failed due to a temporary failure of the server.
* @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 BackupException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample BackupClient.ListBackupVaults
* @see AWS API
* Documentation
*/
default ListBackupVaultsResponse listBackupVaults(ListBackupVaultsRequest listBackupVaultsRequest)
throws ResourceNotFoundException, InvalidParameterValueException, MissingParameterValueException,
ServiceUnavailableException, AwsServiceException, SdkClientException, BackupException {
throw new UnsupportedOperationException();
}
/**
*
* Returns a list of recovery point storage containers along with information about them.
*
*
*
* This is a convenience which creates an instance of the {@link ListBackupVaultsRequest.Builder} avoiding the need
* to create one manually via {@link ListBackupVaultsRequest#builder()}
*
*
* @param listBackupVaultsRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.backup.model.ListBackupVaultsRequest.Builder} to create a request.
* @return Result of the ListBackupVaults operation returned by the service.
* @throws ResourceNotFoundException
* A resource that is required for the action doesn't exist.
* @throws InvalidParameterValueException
* Indicates that something is wrong with a parameter's value. For example, the value is out of range.
* @throws MissingParameterValueException
* Indicates that a required parameter is missing.
* @throws ServiceUnavailableException
* The request failed due to a temporary failure of the server.
* @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 BackupException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample BackupClient.ListBackupVaults
* @see AWS API
* Documentation
*/
default ListBackupVaultsResponse listBackupVaults(Consumer listBackupVaultsRequest)
throws ResourceNotFoundException, InvalidParameterValueException, MissingParameterValueException,
ServiceUnavailableException, AwsServiceException, SdkClientException, BackupException {
return listBackupVaults(ListBackupVaultsRequest.builder().applyMutation(listBackupVaultsRequest).build());
}
/**
*
* Returns a list of recovery point storage containers along with information about them.
*
*
* @return Result of the ListBackupVaults operation returned by the service.
* @throws ResourceNotFoundException
* A resource that is required for the action doesn't exist.
* @throws InvalidParameterValueException
* Indicates that something is wrong with a parameter's value. For example, the value is out of range.
* @throws MissingParameterValueException
* Indicates that a required parameter is missing.
* @throws ServiceUnavailableException
* The request failed due to a temporary failure of the server.
* @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 BackupException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample BackupClient.ListBackupVaults
* @see #listBackupVaults(ListBackupVaultsRequest)
* @see AWS API
* Documentation
*/
default ListBackupVaultsResponse listBackupVaults() throws ResourceNotFoundException, InvalidParameterValueException,
MissingParameterValueException, ServiceUnavailableException, AwsServiceException, SdkClientException, BackupException {
return listBackupVaults(ListBackupVaultsRequest.builder().build());
}
/**
*
* This is a variant of
* {@link #listBackupVaults(software.amazon.awssdk.services.backup.model.ListBackupVaultsRequest)} 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.backup.paginators.ListBackupVaultsIterable responses = client.listBackupVaultsPaginator(request);
* responses.stream().forEach(....);
* }
*
*
* 2) Using For loop
*
*
* {
* @code
* software.amazon.awssdk.services.backup.paginators.ListBackupVaultsIterable responses = client
* .listBackupVaultsPaginator(request);
* for (software.amazon.awssdk.services.backup.model.ListBackupVaultsResponse response : responses) {
* // do something;
* }
* }
*
*
* 3) Use iterator directly
*
*
* {@code
* software.amazon.awssdk.services.backup.paginators.ListBackupVaultsIterable responses = client.listBackupVaultsPaginator(request);
* responses.iterator().forEachRemaining(....);
* }
*
*
* Please notice that the configuration of MaxResults 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 #listBackupVaults(software.amazon.awssdk.services.backup.model.ListBackupVaultsRequest)} operation.
*
*
* @return A custom iterable that can be used to iterate through all the response pages.
* @throws ResourceNotFoundException
* A resource that is required for the action doesn't exist.
* @throws InvalidParameterValueException
* Indicates that something is wrong with a parameter's value. For example, the value is out of range.
* @throws MissingParameterValueException
* Indicates that a required parameter is missing.
* @throws ServiceUnavailableException
* The request failed due to a temporary failure of the server.
* @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 BackupException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample BackupClient.ListBackupVaults
* @see #listBackupVaultsPaginator(ListBackupVaultsRequest)
* @see AWS API
* Documentation
*/
default ListBackupVaultsIterable listBackupVaultsPaginator() throws ResourceNotFoundException,
InvalidParameterValueException, MissingParameterValueException, ServiceUnavailableException, AwsServiceException,
SdkClientException, BackupException {
return listBackupVaultsPaginator(ListBackupVaultsRequest.builder().build());
}
/**
*
* This is a variant of
* {@link #listBackupVaults(software.amazon.awssdk.services.backup.model.ListBackupVaultsRequest)} 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.backup.paginators.ListBackupVaultsIterable responses = client.listBackupVaultsPaginator(request);
* responses.stream().forEach(....);
* }
*
*
* 2) Using For loop
*
*
* {
* @code
* software.amazon.awssdk.services.backup.paginators.ListBackupVaultsIterable responses = client
* .listBackupVaultsPaginator(request);
* for (software.amazon.awssdk.services.backup.model.ListBackupVaultsResponse response : responses) {
* // do something;
* }
* }
*
*
* 3) Use iterator directly
*
*
* {@code
* software.amazon.awssdk.services.backup.paginators.ListBackupVaultsIterable responses = client.listBackupVaultsPaginator(request);
* responses.iterator().forEachRemaining(....);
* }
*
*
* Please notice that the configuration of MaxResults 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 #listBackupVaults(software.amazon.awssdk.services.backup.model.ListBackupVaultsRequest)} operation.
*
*
* @param listBackupVaultsRequest
* @return A custom iterable that can be used to iterate through all the response pages.
* @throws ResourceNotFoundException
* A resource that is required for the action doesn't exist.
* @throws InvalidParameterValueException
* Indicates that something is wrong with a parameter's value. For example, the value is out of range.
* @throws MissingParameterValueException
* Indicates that a required parameter is missing.
* @throws ServiceUnavailableException
* The request failed due to a temporary failure of the server.
* @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 BackupException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample BackupClient.ListBackupVaults
* @see AWS API
* Documentation
*/
default ListBackupVaultsIterable listBackupVaultsPaginator(ListBackupVaultsRequest listBackupVaultsRequest)
throws ResourceNotFoundException, InvalidParameterValueException, MissingParameterValueException,
ServiceUnavailableException, AwsServiceException, SdkClientException, BackupException {
return new ListBackupVaultsIterable(this, listBackupVaultsRequest);
}
/**
*
* This is a variant of
* {@link #listBackupVaults(software.amazon.awssdk.services.backup.model.ListBackupVaultsRequest)} 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.backup.paginators.ListBackupVaultsIterable responses = client.listBackupVaultsPaginator(request);
* responses.stream().forEach(....);
* }
*
*
* 2) Using For loop
*
*
* {
* @code
* software.amazon.awssdk.services.backup.paginators.ListBackupVaultsIterable responses = client
* .listBackupVaultsPaginator(request);
* for (software.amazon.awssdk.services.backup.model.ListBackupVaultsResponse response : responses) {
* // do something;
* }
* }
*
*
* 3) Use iterator directly
*
*
* {@code
* software.amazon.awssdk.services.backup.paginators.ListBackupVaultsIterable responses = client.listBackupVaultsPaginator(request);
* responses.iterator().forEachRemaining(....);
* }
*
*
* Please notice that the configuration of MaxResults 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 #listBackupVaults(software.amazon.awssdk.services.backup.model.ListBackupVaultsRequest)} operation.
*
*
*
* This is a convenience which creates an instance of the {@link ListBackupVaultsRequest.Builder} avoiding the need
* to create one manually via {@link ListBackupVaultsRequest#builder()}
*
*
* @param listBackupVaultsRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.backup.model.ListBackupVaultsRequest.Builder} to create a request.
* @return A custom iterable that can be used to iterate through all the response pages.
* @throws ResourceNotFoundException
* A resource that is required for the action doesn't exist.
* @throws InvalidParameterValueException
* Indicates that something is wrong with a parameter's value. For example, the value is out of range.
* @throws MissingParameterValueException
* Indicates that a required parameter is missing.
* @throws ServiceUnavailableException
* The request failed due to a temporary failure of the server.
* @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 BackupException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample BackupClient.ListBackupVaults
* @see AWS API
* Documentation
*/
default ListBackupVaultsIterable listBackupVaultsPaginator(Consumer listBackupVaultsRequest)
throws ResourceNotFoundException, InvalidParameterValueException, MissingParameterValueException,
ServiceUnavailableException, AwsServiceException, SdkClientException, BackupException {
return listBackupVaultsPaginator(ListBackupVaultsRequest.builder().applyMutation(listBackupVaultsRequest).build());
}
/**
*
* This request obtains a list of copy jobs created or running within the the most recent 30 days. You can include
* parameters AccountID, State, ResourceType, MessageCategory, AggregationPeriod, MaxResults, or NextToken to filter
* results.
*
*
* This request returns a summary that contains Region, Account, State, RestourceType, MessageCategory, StartTime,
* EndTime, and Count of included jobs.
*
*
* @param listCopyJobSummariesRequest
* @return Result of the ListCopyJobSummaries operation returned by the service.
* @throws InvalidParameterValueException
* Indicates that something is wrong with a parameter's value. For example, the value is out of range.
* @throws ServiceUnavailableException
* The request failed due to a temporary failure of the server.
* @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 BackupException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample BackupClient.ListCopyJobSummaries
* @see AWS
* API Documentation
*/
default ListCopyJobSummariesResponse listCopyJobSummaries(ListCopyJobSummariesRequest listCopyJobSummariesRequest)
throws InvalidParameterValueException, ServiceUnavailableException, AwsServiceException, SdkClientException,
BackupException {
throw new UnsupportedOperationException();
}
/**
*
* This request obtains a list of copy jobs created or running within the the most recent 30 days. You can include
* parameters AccountID, State, ResourceType, MessageCategory, AggregationPeriod, MaxResults, or NextToken to filter
* results.
*
*
* This request returns a summary that contains Region, Account, State, RestourceType, MessageCategory, StartTime,
* EndTime, and Count of included jobs.
*
*
*
* This is a convenience which creates an instance of the {@link ListCopyJobSummariesRequest.Builder} avoiding the
* need to create one manually via {@link ListCopyJobSummariesRequest#builder()}
*
*
* @param listCopyJobSummariesRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.backup.model.ListCopyJobSummariesRequest.Builder} to create a
* request.
* @return Result of the ListCopyJobSummaries operation returned by the service.
* @throws InvalidParameterValueException
* Indicates that something is wrong with a parameter's value. For example, the value is out of range.
* @throws ServiceUnavailableException
* The request failed due to a temporary failure of the server.
* @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 BackupException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample BackupClient.ListCopyJobSummaries
* @see AWS
* API Documentation
*/
default ListCopyJobSummariesResponse listCopyJobSummaries(
Consumer listCopyJobSummariesRequest) throws InvalidParameterValueException,
ServiceUnavailableException, AwsServiceException, SdkClientException, BackupException {
return listCopyJobSummaries(ListCopyJobSummariesRequest.builder().applyMutation(listCopyJobSummariesRequest).build());
}
/**
*
* This is a variant of
* {@link #listCopyJobSummaries(software.amazon.awssdk.services.backup.model.ListCopyJobSummariesRequest)}
* 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.backup.paginators.ListCopyJobSummariesIterable responses = client.listCopyJobSummariesPaginator(request);
* responses.stream().forEach(....);
* }
*
*
* 2) Using For loop
*
*
* {
* @code
* software.amazon.awssdk.services.backup.paginators.ListCopyJobSummariesIterable responses = client
* .listCopyJobSummariesPaginator(request);
* for (software.amazon.awssdk.services.backup.model.ListCopyJobSummariesResponse response : responses) {
* // do something;
* }
* }
*
*
* 3) Use iterator directly
*
*
* {@code
* software.amazon.awssdk.services.backup.paginators.ListCopyJobSummariesIterable responses = client.listCopyJobSummariesPaginator(request);
* responses.iterator().forEachRemaining(....);
* }
*
*
* Please notice that the configuration of MaxResults 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 #listCopyJobSummaries(software.amazon.awssdk.services.backup.model.ListCopyJobSummariesRequest)}
* operation.
*
*
* @param listCopyJobSummariesRequest
* @return A custom iterable that can be used to iterate through all the response pages.
* @throws InvalidParameterValueException
* Indicates that something is wrong with a parameter's value. For example, the value is out of range.
* @throws ServiceUnavailableException
* The request failed due to a temporary failure of the server.
* @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 BackupException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample BackupClient.ListCopyJobSummaries
* @see AWS
* API Documentation
*/
default ListCopyJobSummariesIterable listCopyJobSummariesPaginator(ListCopyJobSummariesRequest listCopyJobSummariesRequest)
throws InvalidParameterValueException, ServiceUnavailableException, AwsServiceException, SdkClientException,
BackupException {
return new ListCopyJobSummariesIterable(this, listCopyJobSummariesRequest);
}
/**
*
* This is a variant of
* {@link #listCopyJobSummaries(software.amazon.awssdk.services.backup.model.ListCopyJobSummariesRequest)}
* 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.backup.paginators.ListCopyJobSummariesIterable responses = client.listCopyJobSummariesPaginator(request);
* responses.stream().forEach(....);
* }
*
*
* 2) Using For loop
*
*
* {
* @code
* software.amazon.awssdk.services.backup.paginators.ListCopyJobSummariesIterable responses = client
* .listCopyJobSummariesPaginator(request);
* for (software.amazon.awssdk.services.backup.model.ListCopyJobSummariesResponse response : responses) {
* // do something;
* }
* }
*
*
* 3) Use iterator directly
*
*
* {@code
* software.amazon.awssdk.services.backup.paginators.ListCopyJobSummariesIterable responses = client.listCopyJobSummariesPaginator(request);
* responses.iterator().forEachRemaining(....);
* }
*
*
* Please notice that the configuration of MaxResults 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 #listCopyJobSummaries(software.amazon.awssdk.services.backup.model.ListCopyJobSummariesRequest)}
* operation.
*
*
*
* This is a convenience which creates an instance of the {@link ListCopyJobSummariesRequest.Builder} avoiding the
* need to create one manually via {@link ListCopyJobSummariesRequest#builder()}
*
*
* @param listCopyJobSummariesRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.backup.model.ListCopyJobSummariesRequest.Builder} to create a
* request.
* @return A custom iterable that can be used to iterate through all the response pages.
* @throws InvalidParameterValueException
* Indicates that something is wrong with a parameter's value. For example, the value is out of range.
* @throws ServiceUnavailableException
* The request failed due to a temporary failure of the server.
* @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 BackupException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample BackupClient.ListCopyJobSummaries
* @see AWS
* API Documentation
*/
default ListCopyJobSummariesIterable listCopyJobSummariesPaginator(
Consumer listCopyJobSummariesRequest) throws InvalidParameterValueException,
ServiceUnavailableException, AwsServiceException, SdkClientException, BackupException {
return listCopyJobSummariesPaginator(ListCopyJobSummariesRequest.builder().applyMutation(listCopyJobSummariesRequest)
.build());
}
/**
*
* Returns metadata about your copy jobs.
*
*
* @param listCopyJobsRequest
* @return Result of the ListCopyJobs operation returned by the service.
* @throws InvalidParameterValueException
* Indicates that something is wrong with a parameter's value. For example, the value is out of range.
* @throws ServiceUnavailableException
* The request failed due to a temporary failure of the server.
* @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 BackupException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample BackupClient.ListCopyJobs
* @see AWS API
* Documentation
*/
default ListCopyJobsResponse listCopyJobs(ListCopyJobsRequest listCopyJobsRequest) throws InvalidParameterValueException,
ServiceUnavailableException, AwsServiceException, SdkClientException, BackupException {
throw new UnsupportedOperationException();
}
/**
*
* Returns metadata about your copy jobs.
*
*
*
* This is a convenience which creates an instance of the {@link ListCopyJobsRequest.Builder} avoiding the need to
* create one manually via {@link ListCopyJobsRequest#builder()}
*
*
* @param listCopyJobsRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.backup.model.ListCopyJobsRequest.Builder} to create a request.
* @return Result of the ListCopyJobs operation returned by the service.
* @throws InvalidParameterValueException
* Indicates that something is wrong with a parameter's value. For example, the value is out of range.
* @throws ServiceUnavailableException
* The request failed due to a temporary failure of the server.
* @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 BackupException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample BackupClient.ListCopyJobs
* @see AWS API
* Documentation
*/
default ListCopyJobsResponse listCopyJobs(Consumer listCopyJobsRequest)
throws InvalidParameterValueException, ServiceUnavailableException, AwsServiceException, SdkClientException,
BackupException {
return listCopyJobs(ListCopyJobsRequest.builder().applyMutation(listCopyJobsRequest).build());
}
/**
*
* This is a variant of {@link #listCopyJobs(software.amazon.awssdk.services.backup.model.ListCopyJobsRequest)}
* 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.backup.paginators.ListCopyJobsIterable responses = client.listCopyJobsPaginator(request);
* responses.stream().forEach(....);
* }
*
*
* 2) Using For loop
*
*
* {
* @code
* software.amazon.awssdk.services.backup.paginators.ListCopyJobsIterable responses = client.listCopyJobsPaginator(request);
* for (software.amazon.awssdk.services.backup.model.ListCopyJobsResponse response : responses) {
* // do something;
* }
* }
*
*
* 3) Use iterator directly
*
*
* {@code
* software.amazon.awssdk.services.backup.paginators.ListCopyJobsIterable responses = client.listCopyJobsPaginator(request);
* responses.iterator().forEachRemaining(....);
* }
*
*
* Please notice that the configuration of MaxResults 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 #listCopyJobs(software.amazon.awssdk.services.backup.model.ListCopyJobsRequest)} operation.
*
*
* @param listCopyJobsRequest
* @return A custom iterable that can be used to iterate through all the response pages.
* @throws InvalidParameterValueException
* Indicates that something is wrong with a parameter's value. For example, the value is out of range.
* @throws ServiceUnavailableException
* The request failed due to a temporary failure of the server.
* @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 BackupException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample BackupClient.ListCopyJobs
* @see AWS API
* Documentation
*/
default ListCopyJobsIterable listCopyJobsPaginator(ListCopyJobsRequest listCopyJobsRequest)
throws InvalidParameterValueException, ServiceUnavailableException, AwsServiceException, SdkClientException,
BackupException {
return new ListCopyJobsIterable(this, listCopyJobsRequest);
}
/**
*
* This is a variant of {@link #listCopyJobs(software.amazon.awssdk.services.backup.model.ListCopyJobsRequest)}
* 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.backup.paginators.ListCopyJobsIterable responses = client.listCopyJobsPaginator(request);
* responses.stream().forEach(....);
* }
*
*
* 2) Using For loop
*
*
* {
* @code
* software.amazon.awssdk.services.backup.paginators.ListCopyJobsIterable responses = client.listCopyJobsPaginator(request);
* for (software.amazon.awssdk.services.backup.model.ListCopyJobsResponse response : responses) {
* // do something;
* }
* }
*
*
* 3) Use iterator directly
*
*
* {@code
* software.amazon.awssdk.services.backup.paginators.ListCopyJobsIterable responses = client.listCopyJobsPaginator(request);
* responses.iterator().forEachRemaining(....);
* }
*
*
* Please notice that the configuration of MaxResults 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 #listCopyJobs(software.amazon.awssdk.services.backup.model.ListCopyJobsRequest)} operation.
*
*
*
* This is a convenience which creates an instance of the {@link ListCopyJobsRequest.Builder} avoiding the need to
* create one manually via {@link ListCopyJobsRequest#builder()}
*
*
* @param listCopyJobsRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.backup.model.ListCopyJobsRequest.Builder} to create a request.
* @return A custom iterable that can be used to iterate through all the response pages.
* @throws InvalidParameterValueException
* Indicates that something is wrong with a parameter's value. For example, the value is out of range.
* @throws ServiceUnavailableException
* The request failed due to a temporary failure of the server.
* @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 BackupException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample BackupClient.ListCopyJobs
* @see AWS API
* Documentation
*/
default ListCopyJobsIterable listCopyJobsPaginator(Consumer listCopyJobsRequest)
throws InvalidParameterValueException, ServiceUnavailableException, AwsServiceException, SdkClientException,
BackupException {
return listCopyJobsPaginator(ListCopyJobsRequest.builder().applyMutation(listCopyJobsRequest).build());
}
/**
*
* Returns a list of all frameworks for an Amazon Web Services account and Amazon Web Services Region.
*
*
* @param listFrameworksRequest
* @return Result of the ListFrameworks operation returned by the service.
* @throws InvalidParameterValueException
* Indicates that something is wrong with a parameter's value. For example, the value is out of range.
* @throws ServiceUnavailableException
* The request failed due to a temporary failure of the server.
* @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 BackupException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample BackupClient.ListFrameworks
* @see AWS API
* Documentation
*/
default ListFrameworksResponse listFrameworks(ListFrameworksRequest listFrameworksRequest)
throws InvalidParameterValueException, ServiceUnavailableException, AwsServiceException, SdkClientException,
BackupException {
throw new UnsupportedOperationException();
}
/**
*
* Returns a list of all frameworks for an Amazon Web Services account and Amazon Web Services Region.
*
*
*
* This is a convenience which creates an instance of the {@link ListFrameworksRequest.Builder} avoiding the need to
* create one manually via {@link ListFrameworksRequest#builder()}
*
*
* @param listFrameworksRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.backup.model.ListFrameworksRequest.Builder} to create a request.
* @return Result of the ListFrameworks operation returned by the service.
* @throws InvalidParameterValueException
* Indicates that something is wrong with a parameter's value. For example, the value is out of range.
* @throws ServiceUnavailableException
* The request failed due to a temporary failure of the server.
* @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 BackupException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample BackupClient.ListFrameworks
* @see AWS API
* Documentation
*/
default ListFrameworksResponse listFrameworks(Consumer listFrameworksRequest)
throws InvalidParameterValueException, ServiceUnavailableException, AwsServiceException, SdkClientException,
BackupException {
return listFrameworks(ListFrameworksRequest.builder().applyMutation(listFrameworksRequest).build());
}
/**
*
* This is a variant of {@link #listFrameworks(software.amazon.awssdk.services.backup.model.ListFrameworksRequest)}
* 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.backup.paginators.ListFrameworksIterable responses = client.listFrameworksPaginator(request);
* responses.stream().forEach(....);
* }
*
*
* 2) Using For loop
*
*
* {
* @code
* software.amazon.awssdk.services.backup.paginators.ListFrameworksIterable responses = client.listFrameworksPaginator(request);
* for (software.amazon.awssdk.services.backup.model.ListFrameworksResponse response : responses) {
* // do something;
* }
* }
*
*
* 3) Use iterator directly
*
*
* {@code
* software.amazon.awssdk.services.backup.paginators.ListFrameworksIterable responses = client.listFrameworksPaginator(request);
* responses.iterator().forEachRemaining(....);
* }
*
*
* Please notice that the configuration of MaxResults 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 #listFrameworks(software.amazon.awssdk.services.backup.model.ListFrameworksRequest)} operation.
*
*
* @param listFrameworksRequest
* @return A custom iterable that can be used to iterate through all the response pages.
* @throws InvalidParameterValueException
* Indicates that something is wrong with a parameter's value. For example, the value is out of range.
* @throws ServiceUnavailableException
* The request failed due to a temporary failure of the server.
* @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 BackupException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample BackupClient.ListFrameworks
* @see AWS API
* Documentation
*/
default ListFrameworksIterable listFrameworksPaginator(ListFrameworksRequest listFrameworksRequest)
throws InvalidParameterValueException, ServiceUnavailableException, AwsServiceException, SdkClientException,
BackupException {
return new ListFrameworksIterable(this, listFrameworksRequest);
}
/**
*
* This is a variant of {@link #listFrameworks(software.amazon.awssdk.services.backup.model.ListFrameworksRequest)}
* 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.backup.paginators.ListFrameworksIterable responses = client.listFrameworksPaginator(request);
* responses.stream().forEach(....);
* }
*
*
* 2) Using For loop
*
*
* {
* @code
* software.amazon.awssdk.services.backup.paginators.ListFrameworksIterable responses = client.listFrameworksPaginator(request);
* for (software.amazon.awssdk.services.backup.model.ListFrameworksResponse response : responses) {
* // do something;
* }
* }
*
*
* 3) Use iterator directly
*
*
* {@code
* software.amazon.awssdk.services.backup.paginators.ListFrameworksIterable responses = client.listFrameworksPaginator(request);
* responses.iterator().forEachRemaining(....);
* }
*
*
* Please notice that the configuration of MaxResults 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 #listFrameworks(software.amazon.awssdk.services.backup.model.ListFrameworksRequest)} operation.
*
*
*
* This is a convenience which creates an instance of the {@link ListFrameworksRequest.Builder} avoiding the need to
* create one manually via {@link ListFrameworksRequest#builder()}
*
*
* @param listFrameworksRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.backup.model.ListFrameworksRequest.Builder} to create a request.
* @return A custom iterable that can be used to iterate through all the response pages.
* @throws InvalidParameterValueException
* Indicates that something is wrong with a parameter's value. For example, the value is out of range.
* @throws ServiceUnavailableException
* The request failed due to a temporary failure of the server.
* @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 BackupException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample BackupClient.ListFrameworks
* @see AWS API
* Documentation
*/
default ListFrameworksIterable listFrameworksPaginator(Consumer listFrameworksRequest)
throws InvalidParameterValueException, ServiceUnavailableException, AwsServiceException, SdkClientException,
BackupException {
return listFrameworksPaginator(ListFrameworksRequest.builder().applyMutation(listFrameworksRequest).build());
}
/**
*
* This action returns metadata about active and previous legal holds.
*
*
* @param listLegalHoldsRequest
* @return Result of the ListLegalHolds operation returned by the service.
* @throws InvalidParameterValueException
* Indicates that something is wrong with a parameter's value. For example, the value is out of range.
* @throws ServiceUnavailableException
* The request failed due to a temporary failure of the server.
* @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 BackupException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample BackupClient.ListLegalHolds
* @see AWS API
* Documentation
*/
default ListLegalHoldsResponse listLegalHolds(ListLegalHoldsRequest listLegalHoldsRequest)
throws InvalidParameterValueException, ServiceUnavailableException, AwsServiceException, SdkClientException,
BackupException {
throw new UnsupportedOperationException();
}
/**
*
* This action returns metadata about active and previous legal holds.
*
*
*
* This is a convenience which creates an instance of the {@link ListLegalHoldsRequest.Builder} avoiding the need to
* create one manually via {@link ListLegalHoldsRequest#builder()}
*
*
* @param listLegalHoldsRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.backup.model.ListLegalHoldsRequest.Builder} to create a request.
* @return Result of the ListLegalHolds operation returned by the service.
* @throws InvalidParameterValueException
* Indicates that something is wrong with a parameter's value. For example, the value is out of range.
* @throws ServiceUnavailableException
* The request failed due to a temporary failure of the server.
* @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 BackupException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample BackupClient.ListLegalHolds
* @see AWS API
* Documentation
*/
default ListLegalHoldsResponse listLegalHolds(Consumer listLegalHoldsRequest)
throws InvalidParameterValueException, ServiceUnavailableException, AwsServiceException, SdkClientException,
BackupException {
return listLegalHolds(ListLegalHoldsRequest.builder().applyMutation(listLegalHoldsRequest).build());
}
/**
*
* This is a variant of {@link #listLegalHolds(software.amazon.awssdk.services.backup.model.ListLegalHoldsRequest)}
* 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.backup.paginators.ListLegalHoldsIterable responses = client.listLegalHoldsPaginator(request);
* responses.stream().forEach(....);
* }
*
*
* 2) Using For loop
*
*
* {
* @code
* software.amazon.awssdk.services.backup.paginators.ListLegalHoldsIterable responses = client.listLegalHoldsPaginator(request);
* for (software.amazon.awssdk.services.backup.model.ListLegalHoldsResponse response : responses) {
* // do something;
* }
* }
*
*
* 3) Use iterator directly
*
*
* {@code
* software.amazon.awssdk.services.backup.paginators.ListLegalHoldsIterable responses = client.listLegalHoldsPaginator(request);
* responses.iterator().forEachRemaining(....);
* }
*
*
* Please notice that the configuration of MaxResults 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 #listLegalHolds(software.amazon.awssdk.services.backup.model.ListLegalHoldsRequest)} operation.
*
*
* @param listLegalHoldsRequest
* @return A custom iterable that can be used to iterate through all the response pages.
* @throws InvalidParameterValueException
* Indicates that something is wrong with a parameter's value. For example, the value is out of range.
* @throws ServiceUnavailableException
* The request failed due to a temporary failure of the server.
* @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 BackupException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample BackupClient.ListLegalHolds
* @see AWS API
* Documentation
*/
default ListLegalHoldsIterable listLegalHoldsPaginator(ListLegalHoldsRequest listLegalHoldsRequest)
throws InvalidParameterValueException, ServiceUnavailableException, AwsServiceException, SdkClientException,
BackupException {
return new ListLegalHoldsIterable(this, listLegalHoldsRequest);
}
/**
*
* This is a variant of {@link #listLegalHolds(software.amazon.awssdk.services.backup.model.ListLegalHoldsRequest)}
* 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.backup.paginators.ListLegalHoldsIterable responses = client.listLegalHoldsPaginator(request);
* responses.stream().forEach(....);
* }
*
*
* 2) Using For loop
*
*
* {
* @code
* software.amazon.awssdk.services.backup.paginators.ListLegalHoldsIterable responses = client.listLegalHoldsPaginator(request);
* for (software.amazon.awssdk.services.backup.model.ListLegalHoldsResponse response : responses) {
* // do something;
* }
* }
*
*
* 3) Use iterator directly
*
*
* {@code
* software.amazon.awssdk.services.backup.paginators.ListLegalHoldsIterable responses = client.listLegalHoldsPaginator(request);
* responses.iterator().forEachRemaining(....);
* }
*
*
* Please notice that the configuration of MaxResults 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 #listLegalHolds(software.amazon.awssdk.services.backup.model.ListLegalHoldsRequest)} operation.
*
*
*
* This is a convenience which creates an instance of the {@link ListLegalHoldsRequest.Builder} avoiding the need to
* create one manually via {@link ListLegalHoldsRequest#builder()}
*
*
* @param listLegalHoldsRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.backup.model.ListLegalHoldsRequest.Builder} to create a request.
* @return A custom iterable that can be used to iterate through all the response pages.
* @throws InvalidParameterValueException
* Indicates that something is wrong with a parameter's value. For example, the value is out of range.
* @throws ServiceUnavailableException
* The request failed due to a temporary failure of the server.
* @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 BackupException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample BackupClient.ListLegalHolds
* @see AWS API
* Documentation
*/
default ListLegalHoldsIterable listLegalHoldsPaginator(Consumer listLegalHoldsRequest)
throws InvalidParameterValueException, ServiceUnavailableException, AwsServiceException, SdkClientException,
BackupException {
return listLegalHoldsPaginator(ListLegalHoldsRequest.builder().applyMutation(listLegalHoldsRequest).build());
}
/**
*
* Returns an array of resources successfully backed up by Backup, including the time the resource was saved, an
* Amazon Resource Name (ARN) of the resource, and a resource type.
*
*
* @param listProtectedResourcesRequest
* @return Result of the ListProtectedResources operation returned by the service.
* @throws InvalidParameterValueException
* Indicates that something is wrong with a parameter's value. For example, the value is out of range.
* @throws ServiceUnavailableException
* The request failed due to a temporary failure of the server.
* @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 BackupException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample BackupClient.ListProtectedResources
* @see AWS
* API Documentation
*/
default ListProtectedResourcesResponse listProtectedResources(ListProtectedResourcesRequest listProtectedResourcesRequest)
throws InvalidParameterValueException, ServiceUnavailableException, AwsServiceException, SdkClientException,
BackupException {
throw new UnsupportedOperationException();
}
/**
*
* Returns an array of resources successfully backed up by Backup, including the time the resource was saved, an
* Amazon Resource Name (ARN) of the resource, and a resource type.
*
*
*
* This is a convenience which creates an instance of the {@link ListProtectedResourcesRequest.Builder} avoiding the
* need to create one manually via {@link ListProtectedResourcesRequest#builder()}
*
*
* @param listProtectedResourcesRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.backup.model.ListProtectedResourcesRequest.Builder} to create a
* request.
* @return Result of the ListProtectedResources operation returned by the service.
* @throws InvalidParameterValueException
* Indicates that something is wrong with a parameter's value. For example, the value is out of range.
* @throws ServiceUnavailableException
* The request failed due to a temporary failure of the server.
* @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 BackupException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample BackupClient.ListProtectedResources
* @see AWS
* API Documentation
*/
default ListProtectedResourcesResponse listProtectedResources(
Consumer listProtectedResourcesRequest) throws InvalidParameterValueException,
ServiceUnavailableException, AwsServiceException, SdkClientException, BackupException {
return listProtectedResources(ListProtectedResourcesRequest.builder().applyMutation(listProtectedResourcesRequest)
.build());
}
/**
*
* Returns an array of resources successfully backed up by Backup, including the time the resource was saved, an
* Amazon Resource Name (ARN) of the resource, and a resource type.
*
*
* @return Result of the ListProtectedResources operation returned by the service.
* @throws InvalidParameterValueException
* Indicates that something is wrong with a parameter's value. For example, the value is out of range.
* @throws ServiceUnavailableException
* The request failed due to a temporary failure of the server.
* @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 BackupException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample BackupClient.ListProtectedResources
* @see #listProtectedResources(ListProtectedResourcesRequest)
* @see AWS
* API Documentation
*/
default ListProtectedResourcesResponse listProtectedResources() throws InvalidParameterValueException,
ServiceUnavailableException, AwsServiceException, SdkClientException, BackupException {
return listProtectedResources(ListProtectedResourcesRequest.builder().build());
}
/**
*
* This is a variant of
* {@link #listProtectedResources(software.amazon.awssdk.services.backup.model.ListProtectedResourcesRequest)}
* 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.backup.paginators.ListProtectedResourcesIterable responses = client.listProtectedResourcesPaginator(request);
* responses.stream().forEach(....);
* }
*
*
* 2) Using For loop
*
*
* {
* @code
* software.amazon.awssdk.services.backup.paginators.ListProtectedResourcesIterable responses = client
* .listProtectedResourcesPaginator(request);
* for (software.amazon.awssdk.services.backup.model.ListProtectedResourcesResponse response : responses) {
* // do something;
* }
* }
*
*
* 3) Use iterator directly
*
*
* {@code
* software.amazon.awssdk.services.backup.paginators.ListProtectedResourcesIterable responses = client.listProtectedResourcesPaginator(request);
* responses.iterator().forEachRemaining(....);
* }
*
*
* Please notice that the configuration of MaxResults 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 #listProtectedResources(software.amazon.awssdk.services.backup.model.ListProtectedResourcesRequest)}
* operation.
*
*
* @return A custom iterable that can be used to iterate through all the response pages.
* @throws InvalidParameterValueException
* Indicates that something is wrong with a parameter's value. For example, the value is out of range.
* @throws ServiceUnavailableException
* The request failed due to a temporary failure of the server.
* @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 BackupException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample BackupClient.ListProtectedResources
* @see #listProtectedResourcesPaginator(ListProtectedResourcesRequest)
* @see AWS
* API Documentation
*/
default ListProtectedResourcesIterable listProtectedResourcesPaginator() throws InvalidParameterValueException,
ServiceUnavailableException, AwsServiceException, SdkClientException, BackupException {
return listProtectedResourcesPaginator(ListProtectedResourcesRequest.builder().build());
}
/**
*
* This is a variant of
* {@link #listProtectedResources(software.amazon.awssdk.services.backup.model.ListProtectedResourcesRequest)}
* 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.backup.paginators.ListProtectedResourcesIterable responses = client.listProtectedResourcesPaginator(request);
* responses.stream().forEach(....);
* }
*
*
* 2) Using For loop
*
*
* {
* @code
* software.amazon.awssdk.services.backup.paginators.ListProtectedResourcesIterable responses = client
* .listProtectedResourcesPaginator(request);
* for (software.amazon.awssdk.services.backup.model.ListProtectedResourcesResponse response : responses) {
* // do something;
* }
* }
*
*
* 3) Use iterator directly
*
*
* {@code
* software.amazon.awssdk.services.backup.paginators.ListProtectedResourcesIterable responses = client.listProtectedResourcesPaginator(request);
* responses.iterator().forEachRemaining(....);
* }
*
*
* Please notice that the configuration of MaxResults 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 #listProtectedResources(software.amazon.awssdk.services.backup.model.ListProtectedResourcesRequest)}
* operation.
*
*
* @param listProtectedResourcesRequest
* @return A custom iterable that can be used to iterate through all the response pages.
* @throws InvalidParameterValueException
* Indicates that something is wrong with a parameter's value. For example, the value is out of range.
* @throws ServiceUnavailableException
* The request failed due to a temporary failure of the server.
* @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 BackupException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample BackupClient.ListProtectedResources
* @see AWS
* API Documentation
*/
default ListProtectedResourcesIterable listProtectedResourcesPaginator(
ListProtectedResourcesRequest listProtectedResourcesRequest) throws InvalidParameterValueException,
ServiceUnavailableException, AwsServiceException, SdkClientException, BackupException {
return new ListProtectedResourcesIterable(this, listProtectedResourcesRequest);
}
/**
*
* This is a variant of
* {@link #listProtectedResources(software.amazon.awssdk.services.backup.model.ListProtectedResourcesRequest)}
* 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.backup.paginators.ListProtectedResourcesIterable responses = client.listProtectedResourcesPaginator(request);
* responses.stream().forEach(....);
* }
*
*
* 2) Using For loop
*
*
* {
* @code
* software.amazon.awssdk.services.backup.paginators.ListProtectedResourcesIterable responses = client
* .listProtectedResourcesPaginator(request);
* for (software.amazon.awssdk.services.backup.model.ListProtectedResourcesResponse response : responses) {
* // do something;
* }
* }
*
*
* 3) Use iterator directly
*
*
* {@code
* software.amazon.awssdk.services.backup.paginators.ListProtectedResourcesIterable responses = client.listProtectedResourcesPaginator(request);
* responses.iterator().forEachRemaining(....);
* }
*
*
* Please notice that the configuration of MaxResults 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 #listProtectedResources(software.amazon.awssdk.services.backup.model.ListProtectedResourcesRequest)}
* operation.
*
*
*
* This is a convenience which creates an instance of the {@link ListProtectedResourcesRequest.Builder} avoiding the
* need to create one manually via {@link ListProtectedResourcesRequest#builder()}
*
*
* @param listProtectedResourcesRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.backup.model.ListProtectedResourcesRequest.Builder} to create a
* request.
* @return A custom iterable that can be used to iterate through all the response pages.
* @throws InvalidParameterValueException
* Indicates that something is wrong with a parameter's value. For example, the value is out of range.
* @throws ServiceUnavailableException
* The request failed due to a temporary failure of the server.
* @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 BackupException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample BackupClient.ListProtectedResources
* @see AWS
* API Documentation
*/
default ListProtectedResourcesIterable listProtectedResourcesPaginator(
Consumer listProtectedResourcesRequest) throws InvalidParameterValueException,
ServiceUnavailableException, AwsServiceException, SdkClientException, BackupException {
return listProtectedResourcesPaginator(ListProtectedResourcesRequest.builder()
.applyMutation(listProtectedResourcesRequest).build());
}
/**
*
* This request lists the protected resources corresponding to each backup vault.
*
*
* @param listProtectedResourcesByBackupVaultRequest
* @return Result of the ListProtectedResourcesByBackupVault operation returned by the service.
* @throws InvalidParameterValueException
* Indicates that something is wrong with a parameter's value. For example, the value is out of range.
* @throws ResourceNotFoundException
* A resource that is required for the action doesn't exist.
* @throws ServiceUnavailableException
* The request failed due to a temporary failure of the server.
* @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 BackupException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample BackupClient.ListProtectedResourcesByBackupVault
* @see AWS API Documentation
*/
default ListProtectedResourcesByBackupVaultResponse listProtectedResourcesByBackupVault(
ListProtectedResourcesByBackupVaultRequest listProtectedResourcesByBackupVaultRequest)
throws InvalidParameterValueException, ResourceNotFoundException, ServiceUnavailableException, AwsServiceException,
SdkClientException, BackupException {
throw new UnsupportedOperationException();
}
/**
*
* This request lists the protected resources corresponding to each backup vault.
*
*
*
* This is a convenience which creates an instance of the {@link ListProtectedResourcesByBackupVaultRequest.Builder}
* avoiding the need to create one manually via {@link ListProtectedResourcesByBackupVaultRequest#builder()}
*
*
* @param listProtectedResourcesByBackupVaultRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.backup.model.ListProtectedResourcesByBackupVaultRequest.Builder} to
* create a request.
* @return Result of the ListProtectedResourcesByBackupVault operation returned by the service.
* @throws InvalidParameterValueException
* Indicates that something is wrong with a parameter's value. For example, the value is out of range.
* @throws ResourceNotFoundException
* A resource that is required for the action doesn't exist.
* @throws ServiceUnavailableException
* The request failed due to a temporary failure of the server.
* @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 BackupException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample BackupClient.ListProtectedResourcesByBackupVault
* @see AWS API Documentation
*/
default ListProtectedResourcesByBackupVaultResponse listProtectedResourcesByBackupVault(
Consumer listProtectedResourcesByBackupVaultRequest)
throws InvalidParameterValueException, ResourceNotFoundException, ServiceUnavailableException, AwsServiceException,
SdkClientException, BackupException {
return listProtectedResourcesByBackupVault(ListProtectedResourcesByBackupVaultRequest.builder()
.applyMutation(listProtectedResourcesByBackupVaultRequest).build());
}
/**
*
* This is a variant of
* {@link #listProtectedResourcesByBackupVault(software.amazon.awssdk.services.backup.model.ListProtectedResourcesByBackupVaultRequest)}
* 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.backup.paginators.ListProtectedResourcesByBackupVaultIterable responses = client.listProtectedResourcesByBackupVaultPaginator(request);
* responses.stream().forEach(....);
* }
*
*
* 2) Using For loop
*
*
* {
* @code
* software.amazon.awssdk.services.backup.paginators.ListProtectedResourcesByBackupVaultIterable responses = client
* .listProtectedResourcesByBackupVaultPaginator(request);
* for (software.amazon.awssdk.services.backup.model.ListProtectedResourcesByBackupVaultResponse response : responses) {
* // do something;
* }
* }
*
*
* 3) Use iterator directly
*
*
* {@code
* software.amazon.awssdk.services.backup.paginators.ListProtectedResourcesByBackupVaultIterable responses = client.listProtectedResourcesByBackupVaultPaginator(request);
* responses.iterator().forEachRemaining(....);
* }
*
*
* Please notice that the configuration of MaxResults 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 #listProtectedResourcesByBackupVault(software.amazon.awssdk.services.backup.model.ListProtectedResourcesByBackupVaultRequest)}
* operation.
*
*
* @param listProtectedResourcesByBackupVaultRequest
* @return A custom iterable that can be used to iterate through all the response pages.
* @throws InvalidParameterValueException
* Indicates that something is wrong with a parameter's value. For example, the value is out of range.
* @throws ResourceNotFoundException
* A resource that is required for the action doesn't exist.
* @throws ServiceUnavailableException
* The request failed due to a temporary failure of the server.
* @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 BackupException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample BackupClient.ListProtectedResourcesByBackupVault
* @see AWS API Documentation
*/
default ListProtectedResourcesByBackupVaultIterable listProtectedResourcesByBackupVaultPaginator(
ListProtectedResourcesByBackupVaultRequest listProtectedResourcesByBackupVaultRequest)
throws InvalidParameterValueException, ResourceNotFoundException, ServiceUnavailableException, AwsServiceException,
SdkClientException, BackupException {
return new ListProtectedResourcesByBackupVaultIterable(this, listProtectedResourcesByBackupVaultRequest);
}
/**
*
* This is a variant of
* {@link #listProtectedResourcesByBackupVault(software.amazon.awssdk.services.backup.model.ListProtectedResourcesByBackupVaultRequest)}
* 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.backup.paginators.ListProtectedResourcesByBackupVaultIterable responses = client.listProtectedResourcesByBackupVaultPaginator(request);
* responses.stream().forEach(....);
* }
*
*
* 2) Using For loop
*
*
* {
* @code
* software.amazon.awssdk.services.backup.paginators.ListProtectedResourcesByBackupVaultIterable responses = client
* .listProtectedResourcesByBackupVaultPaginator(request);
* for (software.amazon.awssdk.services.backup.model.ListProtectedResourcesByBackupVaultResponse response : responses) {
* // do something;
* }
* }
*
*
* 3) Use iterator directly
*
*
* {@code
* software.amazon.awssdk.services.backup.paginators.ListProtectedResourcesByBackupVaultIterable responses = client.listProtectedResourcesByBackupVaultPaginator(request);
* responses.iterator().forEachRemaining(....);
* }
*
*
* Please notice that the configuration of MaxResults 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 #listProtectedResourcesByBackupVault(software.amazon.awssdk.services.backup.model.ListProtectedResourcesByBackupVaultRequest)}
* operation.
*
*
*
* This is a convenience which creates an instance of the {@link ListProtectedResourcesByBackupVaultRequest.Builder}
* avoiding the need to create one manually via {@link ListProtectedResourcesByBackupVaultRequest#builder()}
*
*
* @param listProtectedResourcesByBackupVaultRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.backup.model.ListProtectedResourcesByBackupVaultRequest.Builder} to
* create a request.
* @return A custom iterable that can be used to iterate through all the response pages.
* @throws InvalidParameterValueException
* Indicates that something is wrong with a parameter's value. For example, the value is out of range.
* @throws ResourceNotFoundException
* A resource that is required for the action doesn't exist.
* @throws ServiceUnavailableException
* The request failed due to a temporary failure of the server.
* @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 BackupException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample BackupClient.ListProtectedResourcesByBackupVault
* @see AWS API Documentation
*/
default ListProtectedResourcesByBackupVaultIterable listProtectedResourcesByBackupVaultPaginator(
Consumer listProtectedResourcesByBackupVaultRequest)
throws InvalidParameterValueException, ResourceNotFoundException, ServiceUnavailableException, AwsServiceException,
SdkClientException, BackupException {
return listProtectedResourcesByBackupVaultPaginator(ListProtectedResourcesByBackupVaultRequest.builder()
.applyMutation(listProtectedResourcesByBackupVaultRequest).build());
}
/**
*
* Returns detailed information about the recovery points stored in a backup vault.
*
*
* @param listRecoveryPointsByBackupVaultRequest
* @return Result of the ListRecoveryPointsByBackupVault operation returned by the service.
* @throws ResourceNotFoundException
* A resource that is required for the action doesn't exist.
* @throws InvalidParameterValueException
* Indicates that something is wrong with a parameter's value. For example, the value is out of range.
* @throws MissingParameterValueException
* Indicates that a required parameter is missing.
* @throws ServiceUnavailableException
* The request failed due to a temporary failure of the server.
* @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 BackupException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample BackupClient.ListRecoveryPointsByBackupVault
* @see AWS API Documentation
*/
default ListRecoveryPointsByBackupVaultResponse listRecoveryPointsByBackupVault(
ListRecoveryPointsByBackupVaultRequest listRecoveryPointsByBackupVaultRequest) throws ResourceNotFoundException,
InvalidParameterValueException, MissingParameterValueException, ServiceUnavailableException, AwsServiceException,
SdkClientException, BackupException {
throw new UnsupportedOperationException();
}
/**
*
* Returns detailed information about the recovery points stored in a backup vault.
*
*
*
* This is a convenience which creates an instance of the {@link ListRecoveryPointsByBackupVaultRequest.Builder}
* avoiding the need to create one manually via {@link ListRecoveryPointsByBackupVaultRequest#builder()}
*
*
* @param listRecoveryPointsByBackupVaultRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.backup.model.ListRecoveryPointsByBackupVaultRequest.Builder} to
* create a request.
* @return Result of the ListRecoveryPointsByBackupVault operation returned by the service.
* @throws ResourceNotFoundException
* A resource that is required for the action doesn't exist.
* @throws InvalidParameterValueException
* Indicates that something is wrong with a parameter's value. For example, the value is out of range.
* @throws MissingParameterValueException
* Indicates that a required parameter is missing.
* @throws ServiceUnavailableException
* The request failed due to a temporary failure of the server.
* @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 BackupException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample BackupClient.ListRecoveryPointsByBackupVault
* @see AWS API Documentation
*/
default ListRecoveryPointsByBackupVaultResponse listRecoveryPointsByBackupVault(
Consumer listRecoveryPointsByBackupVaultRequest)
throws ResourceNotFoundException, InvalidParameterValueException, MissingParameterValueException,
ServiceUnavailableException, AwsServiceException, SdkClientException, BackupException {
return listRecoveryPointsByBackupVault(ListRecoveryPointsByBackupVaultRequest.builder()
.applyMutation(listRecoveryPointsByBackupVaultRequest).build());
}
/**
*
* This is a variant of
* {@link #listRecoveryPointsByBackupVault(software.amazon.awssdk.services.backup.model.ListRecoveryPointsByBackupVaultRequest)}
* 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.backup.paginators.ListRecoveryPointsByBackupVaultIterable responses = client.listRecoveryPointsByBackupVaultPaginator(request);
* responses.stream().forEach(....);
* }
*
*
* 2) Using For loop
*
*
* {
* @code
* software.amazon.awssdk.services.backup.paginators.ListRecoveryPointsByBackupVaultIterable responses = client
* .listRecoveryPointsByBackupVaultPaginator(request);
* for (software.amazon.awssdk.services.backup.model.ListRecoveryPointsByBackupVaultResponse response : responses) {
* // do something;
* }
* }
*
*
* 3) Use iterator directly
*
*
* {@code
* software.amazon.awssdk.services.backup.paginators.ListRecoveryPointsByBackupVaultIterable responses = client.listRecoveryPointsByBackupVaultPaginator(request);
* responses.iterator().forEachRemaining(....);
* }
*
*
* Please notice that the configuration of MaxResults 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 #listRecoveryPointsByBackupVault(software.amazon.awssdk.services.backup.model.ListRecoveryPointsByBackupVaultRequest)}
* operation.
*
*
* @param listRecoveryPointsByBackupVaultRequest
* @return A custom iterable that can be used to iterate through all the response pages.
* @throws ResourceNotFoundException
* A resource that is required for the action doesn't exist.
* @throws InvalidParameterValueException
* Indicates that something is wrong with a parameter's value. For example, the value is out of range.
* @throws MissingParameterValueException
* Indicates that a required parameter is missing.
* @throws ServiceUnavailableException
* The request failed due to a temporary failure of the server.
* @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 BackupException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample BackupClient.ListRecoveryPointsByBackupVault
* @see AWS API Documentation
*/
default ListRecoveryPointsByBackupVaultIterable listRecoveryPointsByBackupVaultPaginator(
ListRecoveryPointsByBackupVaultRequest listRecoveryPointsByBackupVaultRequest) throws ResourceNotFoundException,
InvalidParameterValueException, MissingParameterValueException, ServiceUnavailableException, AwsServiceException,
SdkClientException, BackupException {
return new ListRecoveryPointsByBackupVaultIterable(this, listRecoveryPointsByBackupVaultRequest);
}
/**
*
* This is a variant of
* {@link #listRecoveryPointsByBackupVault(software.amazon.awssdk.services.backup.model.ListRecoveryPointsByBackupVaultRequest)}
* 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.backup.paginators.ListRecoveryPointsByBackupVaultIterable responses = client.listRecoveryPointsByBackupVaultPaginator(request);
* responses.stream().forEach(....);
* }
*
*
* 2) Using For loop
*
*
* {
* @code
* software.amazon.awssdk.services.backup.paginators.ListRecoveryPointsByBackupVaultIterable responses = client
* .listRecoveryPointsByBackupVaultPaginator(request);
* for (software.amazon.awssdk.services.backup.model.ListRecoveryPointsByBackupVaultResponse response : responses) {
* // do something;
* }
* }
*
*
* 3) Use iterator directly
*
*
* {@code
* software.amazon.awssdk.services.backup.paginators.ListRecoveryPointsByBackupVaultIterable responses = client.listRecoveryPointsByBackupVaultPaginator(request);
* responses.iterator().forEachRemaining(....);
* }
*
*
* Please notice that the configuration of MaxResults 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 #listRecoveryPointsByBackupVault(software.amazon.awssdk.services.backup.model.ListRecoveryPointsByBackupVaultRequest)}
* operation.
*
*
*
* This is a convenience which creates an instance of the {@link ListRecoveryPointsByBackupVaultRequest.Builder}
* avoiding the need to create one manually via {@link ListRecoveryPointsByBackupVaultRequest#builder()}
*
*
* @param listRecoveryPointsByBackupVaultRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.backup.model.ListRecoveryPointsByBackupVaultRequest.Builder} to
* create a request.
* @return A custom iterable that can be used to iterate through all the response pages.
* @throws ResourceNotFoundException
* A resource that is required for the action doesn't exist.
* @throws InvalidParameterValueException
* Indicates that something is wrong with a parameter's value. For example, the value is out of range.
* @throws MissingParameterValueException
* Indicates that a required parameter is missing.
* @throws ServiceUnavailableException
* The request failed due to a temporary failure of the server.
* @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 BackupException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample BackupClient.ListRecoveryPointsByBackupVault
* @see AWS API Documentation
*/
default ListRecoveryPointsByBackupVaultIterable listRecoveryPointsByBackupVaultPaginator(
Consumer listRecoveryPointsByBackupVaultRequest)
throws ResourceNotFoundException, InvalidParameterValueException, MissingParameterValueException,
ServiceUnavailableException, AwsServiceException, SdkClientException, BackupException {
return listRecoveryPointsByBackupVaultPaginator(ListRecoveryPointsByBackupVaultRequest.builder()
.applyMutation(listRecoveryPointsByBackupVaultRequest).build());
}
/**
*
* This action returns recovery point ARNs (Amazon Resource Names) of the specified legal hold.
*
*
* @param listRecoveryPointsByLegalHoldRequest
* @return Result of the ListRecoveryPointsByLegalHold operation returned by the service.
* @throws InvalidParameterValueException
* Indicates that something is wrong with a parameter's value. For example, the value is out of range.
* @throws MissingParameterValueException
* Indicates that a required parameter is missing.
* @throws ServiceUnavailableException
* The request failed due to a temporary failure of the server.
* @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 BackupException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample BackupClient.ListRecoveryPointsByLegalHold
* @see AWS API Documentation
*/
default ListRecoveryPointsByLegalHoldResponse listRecoveryPointsByLegalHold(
ListRecoveryPointsByLegalHoldRequest listRecoveryPointsByLegalHoldRequest) throws InvalidParameterValueException,
MissingParameterValueException, ServiceUnavailableException, AwsServiceException, SdkClientException, BackupException {
throw new UnsupportedOperationException();
}
/**
*
* This action returns recovery point ARNs (Amazon Resource Names) of the specified legal hold.
*
*
*
* This is a convenience which creates an instance of the {@link ListRecoveryPointsByLegalHoldRequest.Builder}
* avoiding the need to create one manually via {@link ListRecoveryPointsByLegalHoldRequest#builder()}
*
*
* @param listRecoveryPointsByLegalHoldRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.backup.model.ListRecoveryPointsByLegalHoldRequest.Builder} to
* create a request.
* @return Result of the ListRecoveryPointsByLegalHold operation returned by the service.
* @throws InvalidParameterValueException
* Indicates that something is wrong with a parameter's value. For example, the value is out of range.
* @throws MissingParameterValueException
* Indicates that a required parameter is missing.
* @throws ServiceUnavailableException
* The request failed due to a temporary failure of the server.
* @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 BackupException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample BackupClient.ListRecoveryPointsByLegalHold
* @see AWS API Documentation
*/
default ListRecoveryPointsByLegalHoldResponse listRecoveryPointsByLegalHold(
Consumer listRecoveryPointsByLegalHoldRequest)
throws InvalidParameterValueException, MissingParameterValueException, ServiceUnavailableException,
AwsServiceException, SdkClientException, BackupException {
return listRecoveryPointsByLegalHold(ListRecoveryPointsByLegalHoldRequest.builder()
.applyMutation(listRecoveryPointsByLegalHoldRequest).build());
}
/**
*
* This is a variant of
* {@link #listRecoveryPointsByLegalHold(software.amazon.awssdk.services.backup.model.ListRecoveryPointsByLegalHoldRequest)}
* 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.backup.paginators.ListRecoveryPointsByLegalHoldIterable responses = client.listRecoveryPointsByLegalHoldPaginator(request);
* responses.stream().forEach(....);
* }
*
*
* 2) Using For loop
*
*
* {
* @code
* software.amazon.awssdk.services.backup.paginators.ListRecoveryPointsByLegalHoldIterable responses = client
* .listRecoveryPointsByLegalHoldPaginator(request);
* for (software.amazon.awssdk.services.backup.model.ListRecoveryPointsByLegalHoldResponse response : responses) {
* // do something;
* }
* }
*
*
* 3) Use iterator directly
*
*
* {@code
* software.amazon.awssdk.services.backup.paginators.ListRecoveryPointsByLegalHoldIterable responses = client.listRecoveryPointsByLegalHoldPaginator(request);
* responses.iterator().forEachRemaining(....);
* }
*
*
* Please notice that the configuration of MaxResults 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 #listRecoveryPointsByLegalHold(software.amazon.awssdk.services.backup.model.ListRecoveryPointsByLegalHoldRequest)}
* operation.
*
*
* @param listRecoveryPointsByLegalHoldRequest
* @return A custom iterable that can be used to iterate through all the response pages.
* @throws InvalidParameterValueException
* Indicates that something is wrong with a parameter's value. For example, the value is out of range.
* @throws MissingParameterValueException
* Indicates that a required parameter is missing.
* @throws ServiceUnavailableException
* The request failed due to a temporary failure of the server.
* @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 BackupException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample BackupClient.ListRecoveryPointsByLegalHold
* @see AWS API Documentation
*/
default ListRecoveryPointsByLegalHoldIterable listRecoveryPointsByLegalHoldPaginator(
ListRecoveryPointsByLegalHoldRequest listRecoveryPointsByLegalHoldRequest) throws InvalidParameterValueException,
MissingParameterValueException, ServiceUnavailableException, AwsServiceException, SdkClientException, BackupException {
return new ListRecoveryPointsByLegalHoldIterable(this, listRecoveryPointsByLegalHoldRequest);
}
/**
*
* This is a variant of
* {@link #listRecoveryPointsByLegalHold(software.amazon.awssdk.services.backup.model.ListRecoveryPointsByLegalHoldRequest)}
* 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.backup.paginators.ListRecoveryPointsByLegalHoldIterable responses = client.listRecoveryPointsByLegalHoldPaginator(request);
* responses.stream().forEach(....);
* }
*
*
* 2) Using For loop
*
*
* {
* @code
* software.amazon.awssdk.services.backup.paginators.ListRecoveryPointsByLegalHoldIterable responses = client
* .listRecoveryPointsByLegalHoldPaginator(request);
* for (software.amazon.awssdk.services.backup.model.ListRecoveryPointsByLegalHoldResponse response : responses) {
* // do something;
* }
* }
*
*
* 3) Use iterator directly
*
*
* {@code
* software.amazon.awssdk.services.backup.paginators.ListRecoveryPointsByLegalHoldIterable responses = client.listRecoveryPointsByLegalHoldPaginator(request);
* responses.iterator().forEachRemaining(....);
* }
*
*
* Please notice that the configuration of MaxResults 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 #listRecoveryPointsByLegalHold(software.amazon.awssdk.services.backup.model.ListRecoveryPointsByLegalHoldRequest)}
* operation.
*
*
*
* This is a convenience which creates an instance of the {@link ListRecoveryPointsByLegalHoldRequest.Builder}
* avoiding the need to create one manually via {@link ListRecoveryPointsByLegalHoldRequest#builder()}
*
*
* @param listRecoveryPointsByLegalHoldRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.backup.model.ListRecoveryPointsByLegalHoldRequest.Builder} to
* create a request.
* @return A custom iterable that can be used to iterate through all the response pages.
* @throws InvalidParameterValueException
* Indicates that something is wrong with a parameter's value. For example, the value is out of range.
* @throws MissingParameterValueException
* Indicates that a required parameter is missing.
* @throws ServiceUnavailableException
* The request failed due to a temporary failure of the server.
* @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 BackupException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample BackupClient.ListRecoveryPointsByLegalHold
* @see AWS API Documentation
*/
default ListRecoveryPointsByLegalHoldIterable listRecoveryPointsByLegalHoldPaginator(
Consumer listRecoveryPointsByLegalHoldRequest)
throws InvalidParameterValueException, MissingParameterValueException, ServiceUnavailableException,
AwsServiceException, SdkClientException, BackupException {
return listRecoveryPointsByLegalHoldPaginator(ListRecoveryPointsByLegalHoldRequest.builder()
.applyMutation(listRecoveryPointsByLegalHoldRequest).build());
}
/**
*
* The information about the recovery points of the type specified by a resource Amazon Resource Name (ARN).
*
*
*
* For Amazon EFS and Amazon EC2, this action only lists recovery points created by Backup.
*
*
*
* @param listRecoveryPointsByResourceRequest
* @return Result of the ListRecoveryPointsByResource operation returned by the service.
* @throws ResourceNotFoundException
* A resource that is required for the action doesn't exist.
* @throws InvalidParameterValueException
* Indicates that something is wrong with a parameter's value. For example, the value is out of range.
* @throws MissingParameterValueException
* Indicates that a required parameter is missing.
* @throws ServiceUnavailableException
* The request failed due to a temporary failure of the server.
* @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 BackupException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample BackupClient.ListRecoveryPointsByResource
* @see AWS API Documentation
*/
default ListRecoveryPointsByResourceResponse listRecoveryPointsByResource(
ListRecoveryPointsByResourceRequest listRecoveryPointsByResourceRequest) throws ResourceNotFoundException,
InvalidParameterValueException, MissingParameterValueException, ServiceUnavailableException, AwsServiceException,
SdkClientException, BackupException {
throw new UnsupportedOperationException();
}
/**
*
* The information about the recovery points of the type specified by a resource Amazon Resource Name (ARN).
*
*
*
* For Amazon EFS and Amazon EC2, this action only lists recovery points created by Backup.
*
*
*
* This is a convenience which creates an instance of the {@link ListRecoveryPointsByResourceRequest.Builder}
* avoiding the need to create one manually via {@link ListRecoveryPointsByResourceRequest#builder()}
*
*
* @param listRecoveryPointsByResourceRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.backup.model.ListRecoveryPointsByResourceRequest.Builder} to create
* a request.
* @return Result of the ListRecoveryPointsByResource operation returned by the service.
* @throws ResourceNotFoundException
* A resource that is required for the action doesn't exist.
* @throws InvalidParameterValueException
* Indicates that something is wrong with a parameter's value. For example, the value is out of range.
* @throws MissingParameterValueException
* Indicates that a required parameter is missing.
* @throws ServiceUnavailableException
* The request failed due to a temporary failure of the server.
* @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 BackupException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample BackupClient.ListRecoveryPointsByResource
* @see AWS API Documentation
*/
default ListRecoveryPointsByResourceResponse listRecoveryPointsByResource(
Consumer listRecoveryPointsByResourceRequest)
throws ResourceNotFoundException, InvalidParameterValueException, MissingParameterValueException,
ServiceUnavailableException, AwsServiceException, SdkClientException, BackupException {
return listRecoveryPointsByResource(ListRecoveryPointsByResourceRequest.builder()
.applyMutation(listRecoveryPointsByResourceRequest).build());
}
/**
*
* This is a variant of
* {@link #listRecoveryPointsByResource(software.amazon.awssdk.services.backup.model.ListRecoveryPointsByResourceRequest)}
* 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.backup.paginators.ListRecoveryPointsByResourceIterable responses = client.listRecoveryPointsByResourcePaginator(request);
* responses.stream().forEach(....);
* }
*
*
* 2) Using For loop
*
*
* {
* @code
* software.amazon.awssdk.services.backup.paginators.ListRecoveryPointsByResourceIterable responses = client
* .listRecoveryPointsByResourcePaginator(request);
* for (software.amazon.awssdk.services.backup.model.ListRecoveryPointsByResourceResponse response : responses) {
* // do something;
* }
* }
*
*
* 3) Use iterator directly
*
*
* {@code
* software.amazon.awssdk.services.backup.paginators.ListRecoveryPointsByResourceIterable responses = client.listRecoveryPointsByResourcePaginator(request);
* responses.iterator().forEachRemaining(....);
* }
*
*
* Please notice that the configuration of MaxResults 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 #listRecoveryPointsByResource(software.amazon.awssdk.services.backup.model.ListRecoveryPointsByResourceRequest)}
* operation.
*
*
* @param listRecoveryPointsByResourceRequest
* @return A custom iterable that can be used to iterate through all the response pages.
* @throws ResourceNotFoundException
* A resource that is required for the action doesn't exist.
* @throws InvalidParameterValueException
* Indicates that something is wrong with a parameter's value. For example, the value is out of range.
* @throws MissingParameterValueException
* Indicates that a required parameter is missing.
* @throws ServiceUnavailableException
* The request failed due to a temporary failure of the server.
* @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 BackupException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample BackupClient.ListRecoveryPointsByResource
* @see AWS API Documentation
*/
default ListRecoveryPointsByResourceIterable listRecoveryPointsByResourcePaginator(
ListRecoveryPointsByResourceRequest listRecoveryPointsByResourceRequest) throws ResourceNotFoundException,
InvalidParameterValueException, MissingParameterValueException, ServiceUnavailableException, AwsServiceException,
SdkClientException, BackupException {
return new ListRecoveryPointsByResourceIterable(this, listRecoveryPointsByResourceRequest);
}
/**
*
* This is a variant of
* {@link #listRecoveryPointsByResource(software.amazon.awssdk.services.backup.model.ListRecoveryPointsByResourceRequest)}
* 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.backup.paginators.ListRecoveryPointsByResourceIterable responses = client.listRecoveryPointsByResourcePaginator(request);
* responses.stream().forEach(....);
* }
*
*
* 2) Using For loop
*
*
* {
* @code
* software.amazon.awssdk.services.backup.paginators.ListRecoveryPointsByResourceIterable responses = client
* .listRecoveryPointsByResourcePaginator(request);
* for (software.amazon.awssdk.services.backup.model.ListRecoveryPointsByResourceResponse response : responses) {
* // do something;
* }
* }
*
*
* 3) Use iterator directly
*
*
* {@code
* software.amazon.awssdk.services.backup.paginators.ListRecoveryPointsByResourceIterable responses = client.listRecoveryPointsByResourcePaginator(request);
* responses.iterator().forEachRemaining(....);
* }
*
*
* Please notice that the configuration of MaxResults 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 #listRecoveryPointsByResource(software.amazon.awssdk.services.backup.model.ListRecoveryPointsByResourceRequest)}
* operation.
*
*
*
* This is a convenience which creates an instance of the {@link ListRecoveryPointsByResourceRequest.Builder}
* avoiding the need to create one manually via {@link ListRecoveryPointsByResourceRequest#builder()}
*
*
* @param listRecoveryPointsByResourceRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.backup.model.ListRecoveryPointsByResourceRequest.Builder} to create
* a request.
* @return A custom iterable that can be used to iterate through all the response pages.
* @throws ResourceNotFoundException
* A resource that is required for the action doesn't exist.
* @throws InvalidParameterValueException
* Indicates that something is wrong with a parameter's value. For example, the value is out of range.
* @throws MissingParameterValueException
* Indicates that a required parameter is missing.
* @throws ServiceUnavailableException
* The request failed due to a temporary failure of the server.
* @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 BackupException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample BackupClient.ListRecoveryPointsByResource
* @see AWS API Documentation
*/
default ListRecoveryPointsByResourceIterable listRecoveryPointsByResourcePaginator(
Consumer listRecoveryPointsByResourceRequest)
throws ResourceNotFoundException, InvalidParameterValueException, MissingParameterValueException,
ServiceUnavailableException, AwsServiceException, SdkClientException, BackupException {
return listRecoveryPointsByResourcePaginator(ListRecoveryPointsByResourceRequest.builder()
.applyMutation(listRecoveryPointsByResourceRequest).build());
}
/**
*
* Returns details about your report jobs.
*
*
* @param listReportJobsRequest
* @return Result of the ListReportJobs operation returned by the service.
* @throws InvalidParameterValueException
* Indicates that something is wrong with a parameter's value. For example, the value is out of range.
* @throws ServiceUnavailableException
* The request failed due to a temporary failure of the server.
* @throws ResourceNotFoundException
* A resource that is required for the action doesn't 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 BackupException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample BackupClient.ListReportJobs
* @see AWS API
* Documentation
*/
default ListReportJobsResponse listReportJobs(ListReportJobsRequest listReportJobsRequest)
throws InvalidParameterValueException, ServiceUnavailableException, ResourceNotFoundException, AwsServiceException,
SdkClientException, BackupException {
throw new UnsupportedOperationException();
}
/**
*
* Returns details about your report jobs.
*
*
*
* This is a convenience which creates an instance of the {@link ListReportJobsRequest.Builder} avoiding the need to
* create one manually via {@link ListReportJobsRequest#builder()}
*
*
* @param listReportJobsRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.backup.model.ListReportJobsRequest.Builder} to create a request.
* @return Result of the ListReportJobs operation returned by the service.
* @throws InvalidParameterValueException
* Indicates that something is wrong with a parameter's value. For example, the value is out of range.
* @throws ServiceUnavailableException
* The request failed due to a temporary failure of the server.
* @throws ResourceNotFoundException
* A resource that is required for the action doesn't 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 BackupException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample BackupClient.ListReportJobs
* @see AWS API
* Documentation
*/
default ListReportJobsResponse listReportJobs(Consumer listReportJobsRequest)
throws InvalidParameterValueException, ServiceUnavailableException, ResourceNotFoundException, AwsServiceException,
SdkClientException, BackupException {
return listReportJobs(ListReportJobsRequest.builder().applyMutation(listReportJobsRequest).build());
}
/**
*
* This is a variant of {@link #listReportJobs(software.amazon.awssdk.services.backup.model.ListReportJobsRequest)}
* 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.backup.paginators.ListReportJobsIterable responses = client.listReportJobsPaginator(request);
* responses.stream().forEach(....);
* }
*
*
* 2) Using For loop
*
*
* {
* @code
* software.amazon.awssdk.services.backup.paginators.ListReportJobsIterable responses = client.listReportJobsPaginator(request);
* for (software.amazon.awssdk.services.backup.model.ListReportJobsResponse response : responses) {
* // do something;
* }
* }
*
*
* 3) Use iterator directly
*
*
* {@code
* software.amazon.awssdk.services.backup.paginators.ListReportJobsIterable responses = client.listReportJobsPaginator(request);
* responses.iterator().forEachRemaining(....);
* }
*
*
* Please notice that the configuration of MaxResults 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 #listReportJobs(software.amazon.awssdk.services.backup.model.ListReportJobsRequest)} operation.
*
*
* @param listReportJobsRequest
* @return A custom iterable that can be used to iterate through all the response pages.
* @throws InvalidParameterValueException
* Indicates that something is wrong with a parameter's value. For example, the value is out of range.
* @throws ServiceUnavailableException
* The request failed due to a temporary failure of the server.
* @throws ResourceNotFoundException
* A resource that is required for the action doesn't 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 BackupException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample BackupClient.ListReportJobs
* @see AWS API
* Documentation
*/
default ListReportJobsIterable listReportJobsPaginator(ListReportJobsRequest listReportJobsRequest)
throws InvalidParameterValueException, ServiceUnavailableException, ResourceNotFoundException, AwsServiceException,
SdkClientException, BackupException {
return new ListReportJobsIterable(this, listReportJobsRequest);
}
/**
*
* This is a variant of {@link #listReportJobs(software.amazon.awssdk.services.backup.model.ListReportJobsRequest)}
* 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.backup.paginators.ListReportJobsIterable responses = client.listReportJobsPaginator(request);
* responses.stream().forEach(....);
* }
*
*
* 2) Using For loop
*
*
* {
* @code
* software.amazon.awssdk.services.backup.paginators.ListReportJobsIterable responses = client.listReportJobsPaginator(request);
* for (software.amazon.awssdk.services.backup.model.ListReportJobsResponse response : responses) {
* // do something;
* }
* }
*
*
* 3) Use iterator directly
*
*
* {@code
* software.amazon.awssdk.services.backup.paginators.ListReportJobsIterable responses = client.listReportJobsPaginator(request);
* responses.iterator().forEachRemaining(....);
* }
*
*
* Please notice that the configuration of MaxResults 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 #listReportJobs(software.amazon.awssdk.services.backup.model.ListReportJobsRequest)} operation.
*
*
*
* This is a convenience which creates an instance of the {@link ListReportJobsRequest.Builder} avoiding the need to
* create one manually via {@link ListReportJobsRequest#builder()}
*
*
* @param listReportJobsRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.backup.model.ListReportJobsRequest.Builder} to create a request.
* @return A custom iterable that can be used to iterate through all the response pages.
* @throws InvalidParameterValueException
* Indicates that something is wrong with a parameter's value. For example, the value is out of range.
* @throws ServiceUnavailableException
* The request failed due to a temporary failure of the server.
* @throws ResourceNotFoundException
* A resource that is required for the action doesn't 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 BackupException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample BackupClient.ListReportJobs
* @see AWS API
* Documentation
*/
default ListReportJobsIterable listReportJobsPaginator(Consumer listReportJobsRequest)
throws InvalidParameterValueException, ServiceUnavailableException, ResourceNotFoundException, AwsServiceException,
SdkClientException, BackupException {
return listReportJobsPaginator(ListReportJobsRequest.builder().applyMutation(listReportJobsRequest).build());
}
/**
*
* Returns a list of your report plans. For detailed information about a single report plan, use
* DescribeReportPlan.
*
*
* @param listReportPlansRequest
* @return Result of the ListReportPlans operation returned by the service.
* @throws InvalidParameterValueException
* Indicates that something is wrong with a parameter's value. For example, the value is out of range.
* @throws ServiceUnavailableException
* The request failed due to a temporary failure of the server.
* @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 BackupException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample BackupClient.ListReportPlans
* @see AWS API
* Documentation
*/
default ListReportPlansResponse listReportPlans(ListReportPlansRequest listReportPlansRequest)
throws InvalidParameterValueException, ServiceUnavailableException, AwsServiceException, SdkClientException,
BackupException {
throw new UnsupportedOperationException();
}
/**
*
* Returns a list of your report plans. For detailed information about a single report plan, use
* DescribeReportPlan.
*
*
*
* This is a convenience which creates an instance of the {@link ListReportPlansRequest.Builder} avoiding the need
* to create one manually via {@link ListReportPlansRequest#builder()}
*
*
* @param listReportPlansRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.backup.model.ListReportPlansRequest.Builder} to create a request.
* @return Result of the ListReportPlans operation returned by the service.
* @throws InvalidParameterValueException
* Indicates that something is wrong with a parameter's value. For example, the value is out of range.
* @throws ServiceUnavailableException
* The request failed due to a temporary failure of the server.
* @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 BackupException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample BackupClient.ListReportPlans
* @see AWS API
* Documentation
*/
default ListReportPlansResponse listReportPlans(Consumer listReportPlansRequest)
throws InvalidParameterValueException, ServiceUnavailableException, AwsServiceException, SdkClientException,
BackupException {
return listReportPlans(ListReportPlansRequest.builder().applyMutation(listReportPlansRequest).build());
}
/**
*
* This is a variant of
* {@link #listReportPlans(software.amazon.awssdk.services.backup.model.ListReportPlansRequest)} 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.backup.paginators.ListReportPlansIterable responses = client.listReportPlansPaginator(request);
* responses.stream().forEach(....);
* }
*
*
* 2) Using For loop
*
*
* {
* @code
* software.amazon.awssdk.services.backup.paginators.ListReportPlansIterable responses = client
* .listReportPlansPaginator(request);
* for (software.amazon.awssdk.services.backup.model.ListReportPlansResponse response : responses) {
* // do something;
* }
* }
*
*
* 3) Use iterator directly
*
*
* {@code
* software.amazon.awssdk.services.backup.paginators.ListReportPlansIterable responses = client.listReportPlansPaginator(request);
* responses.iterator().forEachRemaining(....);
* }
*
*
* Please notice that the configuration of MaxResults 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 #listReportPlans(software.amazon.awssdk.services.backup.model.ListReportPlansRequest)} operation.
*
*
* @param listReportPlansRequest
* @return A custom iterable that can be used to iterate through all the response pages.
* @throws InvalidParameterValueException
* Indicates that something is wrong with a parameter's value. For example, the value is out of range.
* @throws ServiceUnavailableException
* The request failed due to a temporary failure of the server.
* @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 BackupException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample BackupClient.ListReportPlans
* @see AWS API
* Documentation
*/
default ListReportPlansIterable listReportPlansPaginator(ListReportPlansRequest listReportPlansRequest)
throws InvalidParameterValueException, ServiceUnavailableException, AwsServiceException, SdkClientException,
BackupException {
return new ListReportPlansIterable(this, listReportPlansRequest);
}
/**
*
* This is a variant of
* {@link #listReportPlans(software.amazon.awssdk.services.backup.model.ListReportPlansRequest)} 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.backup.paginators.ListReportPlansIterable responses = client.listReportPlansPaginator(request);
* responses.stream().forEach(....);
* }
*
*
* 2) Using For loop
*
*
* {
* @code
* software.amazon.awssdk.services.backup.paginators.ListReportPlansIterable responses = client
* .listReportPlansPaginator(request);
* for (software.amazon.awssdk.services.backup.model.ListReportPlansResponse response : responses) {
* // do something;
* }
* }
*
*
* 3) Use iterator directly
*
*
* {@code
* software.amazon.awssdk.services.backup.paginators.ListReportPlansIterable responses = client.listReportPlansPaginator(request);
* responses.iterator().forEachRemaining(....);
* }
*
*
* Please notice that the configuration of MaxResults 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 #listReportPlans(software.amazon.awssdk.services.backup.model.ListReportPlansRequest)} operation.
*
*
*
* This is a convenience which creates an instance of the {@link ListReportPlansRequest.Builder} avoiding the need
* to create one manually via {@link ListReportPlansRequest#builder()}
*
*
* @param listReportPlansRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.backup.model.ListReportPlansRequest.Builder} to create a request.
* @return A custom iterable that can be used to iterate through all the response pages.
* @throws InvalidParameterValueException
* Indicates that something is wrong with a parameter's value. For example, the value is out of range.
* @throws ServiceUnavailableException
* The request failed due to a temporary failure of the server.
* @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 BackupException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample BackupClient.ListReportPlans
* @see AWS API
* Documentation
*/
default ListReportPlansIterable listReportPlansPaginator(Consumer listReportPlansRequest)
throws InvalidParameterValueException, ServiceUnavailableException, AwsServiceException, SdkClientException,
BackupException {
return listReportPlansPaginator(ListReportPlansRequest.builder().applyMutation(listReportPlansRequest).build());
}
/**
*
* This request obtains a summary of restore jobs created or running within the the most recent 30 days. You can
* include parameters AccountID, State, ResourceType, AggregationPeriod, MaxResults, or NextToken to filter results.
*
*
* This request returns a summary that contains Region, Account, State, RestourceType, MessageCategory, StartTime,
* EndTime, and Count of included jobs.
*
*
* @param listRestoreJobSummariesRequest
* @return Result of the ListRestoreJobSummaries operation returned by the service.
* @throws InvalidParameterValueException
* Indicates that something is wrong with a parameter's value. For example, the value is out of range.
* @throws ServiceUnavailableException
* The request failed due to a temporary failure of the server.
* @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 BackupException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample BackupClient.ListRestoreJobSummaries
* @see AWS API Documentation
*/
default ListRestoreJobSummariesResponse listRestoreJobSummaries(ListRestoreJobSummariesRequest listRestoreJobSummariesRequest)
throws InvalidParameterValueException, ServiceUnavailableException, AwsServiceException, SdkClientException,
BackupException {
throw new UnsupportedOperationException();
}
/**
*
* This request obtains a summary of restore jobs created or running within the the most recent 30 days. You can
* include parameters AccountID, State, ResourceType, AggregationPeriod, MaxResults, or NextToken to filter results.
*
*
* This request returns a summary that contains Region, Account, State, RestourceType, MessageCategory, StartTime,
* EndTime, and Count of included jobs.
*
*
*
* This is a convenience which creates an instance of the {@link ListRestoreJobSummariesRequest.Builder} avoiding
* the need to create one manually via {@link ListRestoreJobSummariesRequest#builder()}
*
*
* @param listRestoreJobSummariesRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.backup.model.ListRestoreJobSummariesRequest.Builder} to create a
* request.
* @return Result of the ListRestoreJobSummaries operation returned by the service.
* @throws InvalidParameterValueException
* Indicates that something is wrong with a parameter's value. For example, the value is out of range.
* @throws ServiceUnavailableException
* The request failed due to a temporary failure of the server.
* @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 BackupException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample BackupClient.ListRestoreJobSummaries
* @see AWS API Documentation
*/
default ListRestoreJobSummariesResponse listRestoreJobSummaries(
Consumer listRestoreJobSummariesRequest)
throws InvalidParameterValueException, ServiceUnavailableException, AwsServiceException, SdkClientException,
BackupException {
return listRestoreJobSummaries(ListRestoreJobSummariesRequest.builder().applyMutation(listRestoreJobSummariesRequest)
.build());
}
/**
*
* This is a variant of
* {@link #listRestoreJobSummaries(software.amazon.awssdk.services.backup.model.ListRestoreJobSummariesRequest)}
* 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.backup.paginators.ListRestoreJobSummariesIterable responses = client.listRestoreJobSummariesPaginator(request);
* responses.stream().forEach(....);
* }
*
*
* 2) Using For loop
*
*
* {
* @code
* software.amazon.awssdk.services.backup.paginators.ListRestoreJobSummariesIterable responses = client
* .listRestoreJobSummariesPaginator(request);
* for (software.amazon.awssdk.services.backup.model.ListRestoreJobSummariesResponse response : responses) {
* // do something;
* }
* }
*
*
* 3) Use iterator directly
*
*
* {@code
* software.amazon.awssdk.services.backup.paginators.ListRestoreJobSummariesIterable responses = client.listRestoreJobSummariesPaginator(request);
* responses.iterator().forEachRemaining(....);
* }
*
*
* Please notice that the configuration of MaxResults 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 #listRestoreJobSummaries(software.amazon.awssdk.services.backup.model.ListRestoreJobSummariesRequest)}
* operation.
*
*
* @param listRestoreJobSummariesRequest
* @return A custom iterable that can be used to iterate through all the response pages.
* @throws InvalidParameterValueException
* Indicates that something is wrong with a parameter's value. For example, the value is out of range.
* @throws ServiceUnavailableException
* The request failed due to a temporary failure of the server.
* @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 BackupException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample BackupClient.ListRestoreJobSummaries
* @see AWS API Documentation
*/
default ListRestoreJobSummariesIterable listRestoreJobSummariesPaginator(
ListRestoreJobSummariesRequest listRestoreJobSummariesRequest) throws InvalidParameterValueException,
ServiceUnavailableException, AwsServiceException, SdkClientException, BackupException {
return new ListRestoreJobSummariesIterable(this, listRestoreJobSummariesRequest);
}
/**
*
* This is a variant of
* {@link #listRestoreJobSummaries(software.amazon.awssdk.services.backup.model.ListRestoreJobSummariesRequest)}
* 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.backup.paginators.ListRestoreJobSummariesIterable responses = client.listRestoreJobSummariesPaginator(request);
* responses.stream().forEach(....);
* }
*
*
* 2) Using For loop
*
*
* {
* @code
* software.amazon.awssdk.services.backup.paginators.ListRestoreJobSummariesIterable responses = client
* .listRestoreJobSummariesPaginator(request);
* for (software.amazon.awssdk.services.backup.model.ListRestoreJobSummariesResponse response : responses) {
* // do something;
* }
* }
*
*
* 3) Use iterator directly
*
*
* {@code
* software.amazon.awssdk.services.backup.paginators.ListRestoreJobSummariesIterable responses = client.listRestoreJobSummariesPaginator(request);
* responses.iterator().forEachRemaining(....);
* }
*
*
* Please notice that the configuration of MaxResults 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 #listRestoreJobSummaries(software.amazon.awssdk.services.backup.model.ListRestoreJobSummariesRequest)}
* operation.
*
*
*
* This is a convenience which creates an instance of the {@link ListRestoreJobSummariesRequest.Builder} avoiding
* the need to create one manually via {@link ListRestoreJobSummariesRequest#builder()}
*
*
* @param listRestoreJobSummariesRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.backup.model.ListRestoreJobSummariesRequest.Builder} to create a
* request.
* @return A custom iterable that can be used to iterate through all the response pages.
* @throws InvalidParameterValueException
* Indicates that something is wrong with a parameter's value. For example, the value is out of range.
* @throws ServiceUnavailableException
* The request failed due to a temporary failure of the server.
* @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 BackupException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample BackupClient.ListRestoreJobSummaries
* @see AWS API Documentation
*/
default ListRestoreJobSummariesIterable listRestoreJobSummariesPaginator(
Consumer listRestoreJobSummariesRequest)
throws InvalidParameterValueException, ServiceUnavailableException, AwsServiceException, SdkClientException,
BackupException {
return listRestoreJobSummariesPaginator(ListRestoreJobSummariesRequest.builder()
.applyMutation(listRestoreJobSummariesRequest).build());
}
/**
*
* Returns a list of jobs that Backup initiated to restore a saved resource, including details about the recovery
* process.
*
*
* @param listRestoreJobsRequest
* @return Result of the ListRestoreJobs operation returned by the service.
* @throws ResourceNotFoundException
* A resource that is required for the action doesn't exist.
* @throws InvalidParameterValueException
* Indicates that something is wrong with a parameter's value. For example, the value is out of range.
* @throws MissingParameterValueException
* Indicates that a required parameter is missing.
* @throws ServiceUnavailableException
* The request failed due to a temporary failure of the server.
* @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 BackupException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample BackupClient.ListRestoreJobs
* @see AWS API
* Documentation
*/
default ListRestoreJobsResponse listRestoreJobs(ListRestoreJobsRequest listRestoreJobsRequest)
throws ResourceNotFoundException, InvalidParameterValueException, MissingParameterValueException,
ServiceUnavailableException, AwsServiceException, SdkClientException, BackupException {
throw new UnsupportedOperationException();
}
/**
*
* Returns a list of jobs that Backup initiated to restore a saved resource, including details about the recovery
* process.
*
*
*
* This is a convenience which creates an instance of the {@link ListRestoreJobsRequest.Builder} avoiding the need
* to create one manually via {@link ListRestoreJobsRequest#builder()}
*
*
* @param listRestoreJobsRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.backup.model.ListRestoreJobsRequest.Builder} to create a request.
* @return Result of the ListRestoreJobs operation returned by the service.
* @throws ResourceNotFoundException
* A resource that is required for the action doesn't exist.
* @throws InvalidParameterValueException
* Indicates that something is wrong with a parameter's value. For example, the value is out of range.
* @throws MissingParameterValueException
* Indicates that a required parameter is missing.
* @throws ServiceUnavailableException
* The request failed due to a temporary failure of the server.
* @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 BackupException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample BackupClient.ListRestoreJobs
* @see AWS API
* Documentation
*/
default ListRestoreJobsResponse listRestoreJobs(Consumer listRestoreJobsRequest)
throws ResourceNotFoundException, InvalidParameterValueException, MissingParameterValueException,
ServiceUnavailableException, AwsServiceException, SdkClientException, BackupException {
return listRestoreJobs(ListRestoreJobsRequest.builder().applyMutation(listRestoreJobsRequest).build());
}
/**
*
* Returns a list of jobs that Backup initiated to restore a saved resource, including details about the recovery
* process.
*
*
* @return Result of the ListRestoreJobs operation returned by the service.
* @throws ResourceNotFoundException
* A resource that is required for the action doesn't exist.
* @throws InvalidParameterValueException
* Indicates that something is wrong with a parameter's value. For example, the value is out of range.
* @throws MissingParameterValueException
* Indicates that a required parameter is missing.
* @throws ServiceUnavailableException
* The request failed due to a temporary failure of the server.
* @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 BackupException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample BackupClient.ListRestoreJobs
* @see #listRestoreJobs(ListRestoreJobsRequest)
* @see AWS API
* Documentation
*/
default ListRestoreJobsResponse listRestoreJobs() throws ResourceNotFoundException, InvalidParameterValueException,
MissingParameterValueException, ServiceUnavailableException, AwsServiceException, SdkClientException, BackupException {
return listRestoreJobs(ListRestoreJobsRequest.builder().build());
}
/**
*
* This is a variant of
* {@link #listRestoreJobs(software.amazon.awssdk.services.backup.model.ListRestoreJobsRequest)} 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.backup.paginators.ListRestoreJobsIterable responses = client.listRestoreJobsPaginator(request);
* responses.stream().forEach(....);
* }
*
*
* 2) Using For loop
*
*
* {
* @code
* software.amazon.awssdk.services.backup.paginators.ListRestoreJobsIterable responses = client
* .listRestoreJobsPaginator(request);
* for (software.amazon.awssdk.services.backup.model.ListRestoreJobsResponse response : responses) {
* // do something;
* }
* }
*
*
* 3) Use iterator directly
*
*
* {@code
* software.amazon.awssdk.services.backup.paginators.ListRestoreJobsIterable responses = client.listRestoreJobsPaginator(request);
* responses.iterator().forEachRemaining(....);
* }
*
*
* Please notice that the configuration of MaxResults 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 #listRestoreJobs(software.amazon.awssdk.services.backup.model.ListRestoreJobsRequest)} operation.
*
*
* @return A custom iterable that can be used to iterate through all the response pages.
* @throws ResourceNotFoundException
* A resource that is required for the action doesn't exist.
* @throws InvalidParameterValueException
* Indicates that something is wrong with a parameter's value. For example, the value is out of range.
* @throws MissingParameterValueException
* Indicates that a required parameter is missing.
* @throws ServiceUnavailableException
* The request failed due to a temporary failure of the server.
* @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 BackupException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample BackupClient.ListRestoreJobs
* @see #listRestoreJobsPaginator(ListRestoreJobsRequest)
* @see AWS API
* Documentation
*/
default ListRestoreJobsIterable listRestoreJobsPaginator() throws ResourceNotFoundException, InvalidParameterValueException,
MissingParameterValueException, ServiceUnavailableException, AwsServiceException, SdkClientException, BackupException {
return listRestoreJobsPaginator(ListRestoreJobsRequest.builder().build());
}
/**
*
* This is a variant of
* {@link #listRestoreJobs(software.amazon.awssdk.services.backup.model.ListRestoreJobsRequest)} 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.backup.paginators.ListRestoreJobsIterable responses = client.listRestoreJobsPaginator(request);
* responses.stream().forEach(....);
* }
*
*
* 2) Using For loop
*
*
* {
* @code
* software.amazon.awssdk.services.backup.paginators.ListRestoreJobsIterable responses = client
* .listRestoreJobsPaginator(request);
* for (software.amazon.awssdk.services.backup.model.ListRestoreJobsResponse response : responses) {
* // do something;
* }
* }
*
*
* 3) Use iterator directly
*
*
* {@code
* software.amazon.awssdk.services.backup.paginators.ListRestoreJobsIterable responses = client.listRestoreJobsPaginator(request);
* responses.iterator().forEachRemaining(....);
* }
*
*
* Please notice that the configuration of MaxResults 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 #listRestoreJobs(software.amazon.awssdk.services.backup.model.ListRestoreJobsRequest)} operation.
*
*
* @param listRestoreJobsRequest
* @return A custom iterable that can be used to iterate through all the response pages.
* @throws ResourceNotFoundException
* A resource that is required for the action doesn't exist.
* @throws InvalidParameterValueException
* Indicates that something is wrong with a parameter's value. For example, the value is out of range.
* @throws MissingParameterValueException
* Indicates that a required parameter is missing.
* @throws ServiceUnavailableException
* The request failed due to a temporary failure of the server.
* @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 BackupException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample BackupClient.ListRestoreJobs
* @see AWS API
* Documentation
*/
default ListRestoreJobsIterable listRestoreJobsPaginator(ListRestoreJobsRequest listRestoreJobsRequest)
throws ResourceNotFoundException, InvalidParameterValueException, MissingParameterValueException,
ServiceUnavailableException, AwsServiceException, SdkClientException, BackupException {
return new ListRestoreJobsIterable(this, listRestoreJobsRequest);
}
/**
*
* This is a variant of
* {@link #listRestoreJobs(software.amazon.awssdk.services.backup.model.ListRestoreJobsRequest)} 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.backup.paginators.ListRestoreJobsIterable responses = client.listRestoreJobsPaginator(request);
* responses.stream().forEach(....);
* }
*
*
* 2) Using For loop
*
*
* {
* @code
* software.amazon.awssdk.services.backup.paginators.ListRestoreJobsIterable responses = client
* .listRestoreJobsPaginator(request);
* for (software.amazon.awssdk.services.backup.model.ListRestoreJobsResponse response : responses) {
* // do something;
* }
* }
*
*
* 3) Use iterator directly
*
*
* {@code
* software.amazon.awssdk.services.backup.paginators.ListRestoreJobsIterable responses = client.listRestoreJobsPaginator(request);
* responses.iterator().forEachRemaining(....);
* }
*
*
* Please notice that the configuration of MaxResults 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 #listRestoreJobs(software.amazon.awssdk.services.backup.model.ListRestoreJobsRequest)} operation.
*
*
*
* This is a convenience which creates an instance of the {@link ListRestoreJobsRequest.Builder} avoiding the need
* to create one manually via {@link ListRestoreJobsRequest#builder()}
*
*
* @param listRestoreJobsRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.backup.model.ListRestoreJobsRequest.Builder} to create a request.
* @return A custom iterable that can be used to iterate through all the response pages.
* @throws ResourceNotFoundException
* A resource that is required for the action doesn't exist.
* @throws InvalidParameterValueException
* Indicates that something is wrong with a parameter's value. For example, the value is out of range.
* @throws MissingParameterValueException
* Indicates that a required parameter is missing.
* @throws ServiceUnavailableException
* The request failed due to a temporary failure of the server.
* @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 BackupException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample BackupClient.ListRestoreJobs
* @see AWS API
* Documentation
*/
default ListRestoreJobsIterable listRestoreJobsPaginator(Consumer listRestoreJobsRequest)
throws ResourceNotFoundException, InvalidParameterValueException, MissingParameterValueException,
ServiceUnavailableException, AwsServiceException, SdkClientException, BackupException {
return listRestoreJobsPaginator(ListRestoreJobsRequest.builder().applyMutation(listRestoreJobsRequest).build());
}
/**
*
* This returns restore jobs that contain the specified protected resource.
*
*
* You must include ResourceArn. You can optionally include NextToken,
* ByStatus, MaxResults, ByRecoveryPointCreationDateAfter , and
* ByRecoveryPointCreationDateBefore.
*
*
* @param listRestoreJobsByProtectedResourceRequest
* @return Result of the ListRestoreJobsByProtectedResource operation returned by the service.
* @throws ResourceNotFoundException
* A resource that is required for the action doesn't exist.
* @throws InvalidParameterValueException
* Indicates that something is wrong with a parameter's value. For example, the value is out of range.
* @throws MissingParameterValueException
* Indicates that a required parameter is missing.
* @throws ServiceUnavailableException
* The request failed due to a temporary failure of the server.
* @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 BackupException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample BackupClient.ListRestoreJobsByProtectedResource
* @see AWS API Documentation
*/
default ListRestoreJobsByProtectedResourceResponse listRestoreJobsByProtectedResource(
ListRestoreJobsByProtectedResourceRequest listRestoreJobsByProtectedResourceRequest)
throws ResourceNotFoundException, InvalidParameterValueException, MissingParameterValueException,
ServiceUnavailableException, AwsServiceException, SdkClientException, BackupException {
throw new UnsupportedOperationException();
}
/**
*
* This returns restore jobs that contain the specified protected resource.
*
*
* You must include ResourceArn. You can optionally include NextToken,
* ByStatus, MaxResults, ByRecoveryPointCreationDateAfter , and
* ByRecoveryPointCreationDateBefore.
*
*
*
* This is a convenience which creates an instance of the {@link ListRestoreJobsByProtectedResourceRequest.Builder}
* avoiding the need to create one manually via {@link ListRestoreJobsByProtectedResourceRequest#builder()}
*
*
* @param listRestoreJobsByProtectedResourceRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.backup.model.ListRestoreJobsByProtectedResourceRequest.Builder} to
* create a request.
* @return Result of the ListRestoreJobsByProtectedResource operation returned by the service.
* @throws ResourceNotFoundException
* A resource that is required for the action doesn't exist.
* @throws InvalidParameterValueException
* Indicates that something is wrong with a parameter's value. For example, the value is out of range.
* @throws MissingParameterValueException
* Indicates that a required parameter is missing.
* @throws ServiceUnavailableException
* The request failed due to a temporary failure of the server.
* @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 BackupException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample BackupClient.ListRestoreJobsByProtectedResource
* @see AWS API Documentation
*/
default ListRestoreJobsByProtectedResourceResponse listRestoreJobsByProtectedResource(
Consumer listRestoreJobsByProtectedResourceRequest)
throws ResourceNotFoundException, InvalidParameterValueException, MissingParameterValueException,
ServiceUnavailableException, AwsServiceException, SdkClientException, BackupException {
return listRestoreJobsByProtectedResource(ListRestoreJobsByProtectedResourceRequest.builder()
.applyMutation(listRestoreJobsByProtectedResourceRequest).build());
}
/**
*
* This is a variant of
* {@link #listRestoreJobsByProtectedResource(software.amazon.awssdk.services.backup.model.ListRestoreJobsByProtectedResourceRequest)}
* 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.backup.paginators.ListRestoreJobsByProtectedResourceIterable responses = client.listRestoreJobsByProtectedResourcePaginator(request);
* responses.stream().forEach(....);
* }
*
*
* 2) Using For loop
*
*
* {
* @code
* software.amazon.awssdk.services.backup.paginators.ListRestoreJobsByProtectedResourceIterable responses = client
* .listRestoreJobsByProtectedResourcePaginator(request);
* for (software.amazon.awssdk.services.backup.model.ListRestoreJobsByProtectedResourceResponse response : responses) {
* // do something;
* }
* }
*
*
* 3) Use iterator directly
*
*
* {@code
* software.amazon.awssdk.services.backup.paginators.ListRestoreJobsByProtectedResourceIterable responses = client.listRestoreJobsByProtectedResourcePaginator(request);
* responses.iterator().forEachRemaining(....);
* }
*
*
* Please notice that the configuration of MaxResults 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 #listRestoreJobsByProtectedResource(software.amazon.awssdk.services.backup.model.ListRestoreJobsByProtectedResourceRequest)}
* operation.
*
*
* @param listRestoreJobsByProtectedResourceRequest
* @return A custom iterable that can be used to iterate through all the response pages.
* @throws ResourceNotFoundException
* A resource that is required for the action doesn't exist.
* @throws InvalidParameterValueException
* Indicates that something is wrong with a parameter's value. For example, the value is out of range.
* @throws MissingParameterValueException
* Indicates that a required parameter is missing.
* @throws ServiceUnavailableException
* The request failed due to a temporary failure of the server.
* @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 BackupException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample BackupClient.ListRestoreJobsByProtectedResource
* @see AWS API Documentation
*/
default ListRestoreJobsByProtectedResourceIterable listRestoreJobsByProtectedResourcePaginator(
ListRestoreJobsByProtectedResourceRequest listRestoreJobsByProtectedResourceRequest)
throws ResourceNotFoundException, InvalidParameterValueException, MissingParameterValueException,
ServiceUnavailableException, AwsServiceException, SdkClientException, BackupException {
return new ListRestoreJobsByProtectedResourceIterable(this, listRestoreJobsByProtectedResourceRequest);
}
/**
*
* This is a variant of
* {@link #listRestoreJobsByProtectedResource(software.amazon.awssdk.services.backup.model.ListRestoreJobsByProtectedResourceRequest)}
* 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.backup.paginators.ListRestoreJobsByProtectedResourceIterable responses = client.listRestoreJobsByProtectedResourcePaginator(request);
* responses.stream().forEach(....);
* }
*
*
* 2) Using For loop
*
*
* {
* @code
* software.amazon.awssdk.services.backup.paginators.ListRestoreJobsByProtectedResourceIterable responses = client
* .listRestoreJobsByProtectedResourcePaginator(request);
* for (software.amazon.awssdk.services.backup.model.ListRestoreJobsByProtectedResourceResponse response : responses) {
* // do something;
* }
* }
*
*
* 3) Use iterator directly
*
*
* {@code
* software.amazon.awssdk.services.backup.paginators.ListRestoreJobsByProtectedResourceIterable responses = client.listRestoreJobsByProtectedResourcePaginator(request);
* responses.iterator().forEachRemaining(....);
* }
*
*
* Please notice that the configuration of MaxResults 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 #listRestoreJobsByProtectedResource(software.amazon.awssdk.services.backup.model.ListRestoreJobsByProtectedResourceRequest)}
* operation.
*
*
*
* This is a convenience which creates an instance of the {@link ListRestoreJobsByProtectedResourceRequest.Builder}
* avoiding the need to create one manually via {@link ListRestoreJobsByProtectedResourceRequest#builder()}
*
*
* @param listRestoreJobsByProtectedResourceRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.backup.model.ListRestoreJobsByProtectedResourceRequest.Builder} to
* create a request.
* @return A custom iterable that can be used to iterate through all the response pages.
* @throws ResourceNotFoundException
* A resource that is required for the action doesn't exist.
* @throws InvalidParameterValueException
* Indicates that something is wrong with a parameter's value. For example, the value is out of range.
* @throws MissingParameterValueException
* Indicates that a required parameter is missing.
* @throws ServiceUnavailableException
* The request failed due to a temporary failure of the server.
* @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 BackupException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample BackupClient.ListRestoreJobsByProtectedResource
* @see AWS API Documentation
*/
default ListRestoreJobsByProtectedResourceIterable listRestoreJobsByProtectedResourcePaginator(
Consumer listRestoreJobsByProtectedResourceRequest)
throws ResourceNotFoundException, InvalidParameterValueException, MissingParameterValueException,
ServiceUnavailableException, AwsServiceException, SdkClientException, BackupException {
return listRestoreJobsByProtectedResourcePaginator(ListRestoreJobsByProtectedResourceRequest.builder()
.applyMutation(listRestoreJobsByProtectedResourceRequest).build());
}
/**
*
* Returns a list of restore testing plans.
*
*
* @param listRestoreTestingPlansRequest
* @return Result of the ListRestoreTestingPlans operation returned by the service.
* @throws InvalidParameterValueException
* Indicates that something is wrong with a parameter's value. For example, the value is out of range.
* @throws ServiceUnavailableException
* The request failed due to a temporary failure of the server.
* @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 BackupException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample BackupClient.ListRestoreTestingPlans
* @see AWS API Documentation
*/
default ListRestoreTestingPlansResponse listRestoreTestingPlans(ListRestoreTestingPlansRequest listRestoreTestingPlansRequest)
throws InvalidParameterValueException, ServiceUnavailableException, AwsServiceException, SdkClientException,
BackupException {
throw new UnsupportedOperationException();
}
/**
*
* Returns a list of restore testing plans.
*
*
*
* This is a convenience which creates an instance of the {@link ListRestoreTestingPlansRequest.Builder} avoiding
* the need to create one manually via {@link ListRestoreTestingPlansRequest#builder()}
*
*
* @param listRestoreTestingPlansRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.backup.model.ListRestoreTestingPlansRequest.Builder} to create a
* request.
* @return Result of the ListRestoreTestingPlans operation returned by the service.
* @throws InvalidParameterValueException
* Indicates that something is wrong with a parameter's value. For example, the value is out of range.
* @throws ServiceUnavailableException
* The request failed due to a temporary failure of the server.
* @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 BackupException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample BackupClient.ListRestoreTestingPlans
* @see AWS API Documentation
*/
default ListRestoreTestingPlansResponse listRestoreTestingPlans(
Consumer listRestoreTestingPlansRequest)
throws InvalidParameterValueException, ServiceUnavailableException, AwsServiceException, SdkClientException,
BackupException {
return listRestoreTestingPlans(ListRestoreTestingPlansRequest.builder().applyMutation(listRestoreTestingPlansRequest)
.build());
}
/**
*
* This is a variant of
* {@link #listRestoreTestingPlans(software.amazon.awssdk.services.backup.model.ListRestoreTestingPlansRequest)}
* 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.backup.paginators.ListRestoreTestingPlansIterable responses = client.listRestoreTestingPlansPaginator(request);
* responses.stream().forEach(....);
* }
*
*
* 2) Using For loop
*
*
* {
* @code
* software.amazon.awssdk.services.backup.paginators.ListRestoreTestingPlansIterable responses = client
* .listRestoreTestingPlansPaginator(request);
* for (software.amazon.awssdk.services.backup.model.ListRestoreTestingPlansResponse response : responses) {
* // do something;
* }
* }
*
*
* 3) Use iterator directly
*
*
* {@code
* software.amazon.awssdk.services.backup.paginators.ListRestoreTestingPlansIterable responses = client.listRestoreTestingPlansPaginator(request);
* responses.iterator().forEachRemaining(....);
* }
*
*
* Please notice that the configuration of MaxResults 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 #listRestoreTestingPlans(software.amazon.awssdk.services.backup.model.ListRestoreTestingPlansRequest)}
* operation.
*
*
* @param listRestoreTestingPlansRequest
* @return A custom iterable that can be used to iterate through all the response pages.
* @throws InvalidParameterValueException
* Indicates that something is wrong with a parameter's value. For example, the value is out of range.
* @throws ServiceUnavailableException
* The request failed due to a temporary failure of the server.
* @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 BackupException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample BackupClient.ListRestoreTestingPlans
* @see AWS API Documentation
*/
default ListRestoreTestingPlansIterable listRestoreTestingPlansPaginator(
ListRestoreTestingPlansRequest listRestoreTestingPlansRequest) throws InvalidParameterValueException,
ServiceUnavailableException, AwsServiceException, SdkClientException, BackupException {
return new ListRestoreTestingPlansIterable(this, listRestoreTestingPlansRequest);
}
/**
*
* This is a variant of
* {@link #listRestoreTestingPlans(software.amazon.awssdk.services.backup.model.ListRestoreTestingPlansRequest)}
* 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.backup.paginators.ListRestoreTestingPlansIterable responses = client.listRestoreTestingPlansPaginator(request);
* responses.stream().forEach(....);
* }
*
*
* 2) Using For loop
*
*
* {
* @code
* software.amazon.awssdk.services.backup.paginators.ListRestoreTestingPlansIterable responses = client
* .listRestoreTestingPlansPaginator(request);
* for (software.amazon.awssdk.services.backup.model.ListRestoreTestingPlansResponse response : responses) {
* // do something;
* }
* }
*
*
* 3) Use iterator directly
*
*
* {@code
* software.amazon.awssdk.services.backup.paginators.ListRestoreTestingPlansIterable responses = client.listRestoreTestingPlansPaginator(request);
* responses.iterator().forEachRemaining(....);
* }
*
*
* Please notice that the configuration of MaxResults 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 #listRestoreTestingPlans(software.amazon.awssdk.services.backup.model.ListRestoreTestingPlansRequest)}
* operation.
*
*
*
* This is a convenience which creates an instance of the {@link ListRestoreTestingPlansRequest.Builder} avoiding
* the need to create one manually via {@link ListRestoreTestingPlansRequest#builder()}
*
*
* @param listRestoreTestingPlansRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.backup.model.ListRestoreTestingPlansRequest.Builder} to create a
* request.
* @return A custom iterable that can be used to iterate through all the response pages.
* @throws InvalidParameterValueException
* Indicates that something is wrong with a parameter's value. For example, the value is out of range.
* @throws ServiceUnavailableException
* The request failed due to a temporary failure of the server.
* @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 BackupException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample BackupClient.ListRestoreTestingPlans
* @see AWS API Documentation
*/
default ListRestoreTestingPlansIterable listRestoreTestingPlansPaginator(
Consumer listRestoreTestingPlansRequest)
throws InvalidParameterValueException, ServiceUnavailableException, AwsServiceException, SdkClientException,
BackupException {
return listRestoreTestingPlansPaginator(ListRestoreTestingPlansRequest.builder()
.applyMutation(listRestoreTestingPlansRequest).build());
}
/**
*
* Returns a list of restore testing selections. Can be filtered by MaxResults and
* RestoreTestingPlanName.
*
*
* @param listRestoreTestingSelectionsRequest
* @return Result of the ListRestoreTestingSelections operation returned by the service.
* @throws InvalidParameterValueException
* Indicates that something is wrong with a parameter's value. For example, the value is out of range.
* @throws ResourceNotFoundException
* A resource that is required for the action doesn't exist.
* @throws ServiceUnavailableException
* The request failed due to a temporary failure of the server.
* @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 BackupException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample BackupClient.ListRestoreTestingSelections
* @see AWS API Documentation
*/
default ListRestoreTestingSelectionsResponse listRestoreTestingSelections(
ListRestoreTestingSelectionsRequest listRestoreTestingSelectionsRequest) throws InvalidParameterValueException,
ResourceNotFoundException, ServiceUnavailableException, AwsServiceException, SdkClientException, BackupException {
throw new UnsupportedOperationException();
}
/**
*
* Returns a list of restore testing selections. Can be filtered by MaxResults and
* RestoreTestingPlanName.
*
*
*
* This is a convenience which creates an instance of the {@link ListRestoreTestingSelectionsRequest.Builder}
* avoiding the need to create one manually via {@link ListRestoreTestingSelectionsRequest#builder()}
*
*
* @param listRestoreTestingSelectionsRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.backup.model.ListRestoreTestingSelectionsRequest.Builder} to create
* a request.
* @return Result of the ListRestoreTestingSelections operation returned by the service.
* @throws InvalidParameterValueException
* Indicates that something is wrong with a parameter's value. For example, the value is out of range.
* @throws ResourceNotFoundException
* A resource that is required for the action doesn't exist.
* @throws ServiceUnavailableException
* The request failed due to a temporary failure of the server.
* @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 BackupException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample BackupClient.ListRestoreTestingSelections
* @see AWS API Documentation
*/
default ListRestoreTestingSelectionsResponse listRestoreTestingSelections(
Consumer listRestoreTestingSelectionsRequest)
throws InvalidParameterValueException, ResourceNotFoundException, ServiceUnavailableException, AwsServiceException,
SdkClientException, BackupException {
return listRestoreTestingSelections(ListRestoreTestingSelectionsRequest.builder()
.applyMutation(listRestoreTestingSelectionsRequest).build());
}
/**
*
* This is a variant of
* {@link #listRestoreTestingSelections(software.amazon.awssdk.services.backup.model.ListRestoreTestingSelectionsRequest)}
* 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.backup.paginators.ListRestoreTestingSelectionsIterable responses = client.listRestoreTestingSelectionsPaginator(request);
* responses.stream().forEach(....);
* }
*
*
* 2) Using For loop
*
*
* {
* @code
* software.amazon.awssdk.services.backup.paginators.ListRestoreTestingSelectionsIterable responses = client
* .listRestoreTestingSelectionsPaginator(request);
* for (software.amazon.awssdk.services.backup.model.ListRestoreTestingSelectionsResponse response : responses) {
* // do something;
* }
* }
*
*
* 3) Use iterator directly
*
*
* {@code
* software.amazon.awssdk.services.backup.paginators.ListRestoreTestingSelectionsIterable responses = client.listRestoreTestingSelectionsPaginator(request);
* responses.iterator().forEachRemaining(....);
* }
*
*
* Please notice that the configuration of MaxResults 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 #listRestoreTestingSelections(software.amazon.awssdk.services.backup.model.ListRestoreTestingSelectionsRequest)}
* operation.
*
*
* @param listRestoreTestingSelectionsRequest
* @return A custom iterable that can be used to iterate through all the response pages.
* @throws InvalidParameterValueException
* Indicates that something is wrong with a parameter's value. For example, the value is out of range.
* @throws ResourceNotFoundException
* A resource that is required for the action doesn't exist.
* @throws ServiceUnavailableException
* The request failed due to a temporary failure of the server.
* @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 BackupException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample BackupClient.ListRestoreTestingSelections
* @see AWS API Documentation
*/
default ListRestoreTestingSelectionsIterable listRestoreTestingSelectionsPaginator(
ListRestoreTestingSelectionsRequest listRestoreTestingSelectionsRequest) throws InvalidParameterValueException,
ResourceNotFoundException, ServiceUnavailableException, AwsServiceException, SdkClientException, BackupException {
return new ListRestoreTestingSelectionsIterable(this, listRestoreTestingSelectionsRequest);
}
/**
*
* This is a variant of
* {@link #listRestoreTestingSelections(software.amazon.awssdk.services.backup.model.ListRestoreTestingSelectionsRequest)}
* 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.backup.paginators.ListRestoreTestingSelectionsIterable responses = client.listRestoreTestingSelectionsPaginator(request);
* responses.stream().forEach(....);
* }
*
*
* 2) Using For loop
*
*
* {
* @code
* software.amazon.awssdk.services.backup.paginators.ListRestoreTestingSelectionsIterable responses = client
* .listRestoreTestingSelectionsPaginator(request);
* for (software.amazon.awssdk.services.backup.model.ListRestoreTestingSelectionsResponse response : responses) {
* // do something;
* }
* }
*
*
* 3) Use iterator directly
*
*
* {@code
* software.amazon.awssdk.services.backup.paginators.ListRestoreTestingSelectionsIterable responses = client.listRestoreTestingSelectionsPaginator(request);
* responses.iterator().forEachRemaining(....);
* }
*
*
* Please notice that the configuration of MaxResults 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 #listRestoreTestingSelections(software.amazon.awssdk.services.backup.model.ListRestoreTestingSelectionsRequest)}
* operation.
*
*
*
* This is a convenience which creates an instance of the {@link ListRestoreTestingSelectionsRequest.Builder}
* avoiding the need to create one manually via {@link ListRestoreTestingSelectionsRequest#builder()}
*
*
* @param listRestoreTestingSelectionsRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.backup.model.ListRestoreTestingSelectionsRequest.Builder} to create
* a request.
* @return A custom iterable that can be used to iterate through all the response pages.
* @throws InvalidParameterValueException
* Indicates that something is wrong with a parameter's value. For example, the value is out of range.
* @throws ResourceNotFoundException
* A resource that is required for the action doesn't exist.
* @throws ServiceUnavailableException
* The request failed due to a temporary failure of the server.
* @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 BackupException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample BackupClient.ListRestoreTestingSelections
* @see AWS API Documentation
*/
default ListRestoreTestingSelectionsIterable listRestoreTestingSelectionsPaginator(
Consumer listRestoreTestingSelectionsRequest)
throws InvalidParameterValueException, ResourceNotFoundException, ServiceUnavailableException, AwsServiceException,
SdkClientException, BackupException {
return listRestoreTestingSelectionsPaginator(ListRestoreTestingSelectionsRequest.builder()
.applyMutation(listRestoreTestingSelectionsRequest).build());
}
/**
*
* Returns the tags assigned to the resource, such as a target recovery point, backup plan, or backup vault.
*
*
* @param listTagsRequest
* @return Result of the ListTags operation returned by the service.
* @throws ResourceNotFoundException
* A resource that is required for the action doesn't exist.
* @throws InvalidParameterValueException
* Indicates that something is wrong with a parameter's value. For example, the value is out of range.
* @throws MissingParameterValueException
* Indicates that a required parameter is missing.
* @throws ServiceUnavailableException
* The request failed due to a temporary failure of the server.
* @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 BackupException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample BackupClient.ListTags
* @see AWS API
* Documentation
*/
default ListTagsResponse listTags(ListTagsRequest listTagsRequest) throws ResourceNotFoundException,
InvalidParameterValueException, MissingParameterValueException, ServiceUnavailableException, AwsServiceException,
SdkClientException, BackupException {
throw new UnsupportedOperationException();
}
/**
*
* Returns the tags assigned to the resource, such as a target recovery point, backup plan, or backup vault.
*
*
*
* This is a convenience which creates an instance of the {@link ListTagsRequest.Builder} avoiding the need to
* create one manually via {@link ListTagsRequest#builder()}
*
*
* @param listTagsRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.backup.model.ListTagsRequest.Builder} to create a request.
* @return Result of the ListTags operation returned by the service.
* @throws ResourceNotFoundException
* A resource that is required for the action doesn't exist.
* @throws InvalidParameterValueException
* Indicates that something is wrong with a parameter's value. For example, the value is out of range.
* @throws MissingParameterValueException
* Indicates that a required parameter is missing.
* @throws ServiceUnavailableException
* The request failed due to a temporary failure of the server.
* @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 BackupException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample BackupClient.ListTags
* @see AWS API
* Documentation
*/
default ListTagsResponse listTags(Consumer listTagsRequest) throws ResourceNotFoundException,
InvalidParameterValueException, MissingParameterValueException, ServiceUnavailableException, AwsServiceException,
SdkClientException, BackupException {
return listTags(ListTagsRequest.builder().applyMutation(listTagsRequest).build());
}
/**
*
* This is a variant of {@link #listTags(software.amazon.awssdk.services.backup.model.ListTagsRequest)} 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.backup.paginators.ListTagsIterable responses = client.listTagsPaginator(request);
* responses.stream().forEach(....);
* }
*
*
* 2) Using For loop
*
*
* {
* @code
* software.amazon.awssdk.services.backup.paginators.ListTagsIterable responses = client.listTagsPaginator(request);
* for (software.amazon.awssdk.services.backup.model.ListTagsResponse response : responses) {
* // do something;
* }
* }
*
*
* 3) Use iterator directly
*
*
* {@code
* software.amazon.awssdk.services.backup.paginators.ListTagsIterable responses = client.listTagsPaginator(request);
* responses.iterator().forEachRemaining(....);
* }
*
*
* Please notice that the configuration of MaxResults 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 #listTags(software.amazon.awssdk.services.backup.model.ListTagsRequest)} operation.
*
*
* @param listTagsRequest
* @return A custom iterable that can be used to iterate through all the response pages.
* @throws ResourceNotFoundException
* A resource that is required for the action doesn't exist.
* @throws InvalidParameterValueException
* Indicates that something is wrong with a parameter's value. For example, the value is out of range.
* @throws MissingParameterValueException
* Indicates that a required parameter is missing.
* @throws ServiceUnavailableException
* The request failed due to a temporary failure of the server.
* @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 BackupException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample BackupClient.ListTags
* @see AWS API
* Documentation
*/
default ListTagsIterable listTagsPaginator(ListTagsRequest listTagsRequest) throws ResourceNotFoundException,
InvalidParameterValueException, MissingParameterValueException, ServiceUnavailableException, AwsServiceException,
SdkClientException, BackupException {
return new ListTagsIterable(this, listTagsRequest);
}
/**
*
* This is a variant of {@link #listTags(software.amazon.awssdk.services.backup.model.ListTagsRequest)} 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.backup.paginators.ListTagsIterable responses = client.listTagsPaginator(request);
* responses.stream().forEach(....);
* }
*
*
* 2) Using For loop
*
*
* {
* @code
* software.amazon.awssdk.services.backup.paginators.ListTagsIterable responses = client.listTagsPaginator(request);
* for (software.amazon.awssdk.services.backup.model.ListTagsResponse response : responses) {
* // do something;
* }
* }
*
*
* 3) Use iterator directly
*
*
* {@code
* software.amazon.awssdk.services.backup.paginators.ListTagsIterable responses = client.listTagsPaginator(request);
* responses.iterator().forEachRemaining(....);
* }
*
*
* Please notice that the configuration of MaxResults 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 #listTags(software.amazon.awssdk.services.backup.model.ListTagsRequest)} operation.
*
*
*
* This is a convenience which creates an instance of the {@link ListTagsRequest.Builder} avoiding the need to
* create one manually via {@link ListTagsRequest#builder()}
*
*
* @param listTagsRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.backup.model.ListTagsRequest.Builder} to create a request.
* @return A custom iterable that can be used to iterate through all the response pages.
* @throws ResourceNotFoundException
* A resource that is required for the action doesn't exist.
* @throws InvalidParameterValueException
* Indicates that something is wrong with a parameter's value. For example, the value is out of range.
* @throws MissingParameterValueException
* Indicates that a required parameter is missing.
* @throws ServiceUnavailableException
* The request failed due to a temporary failure of the server.
* @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 BackupException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample BackupClient.ListTags
* @see AWS API
* Documentation
*/
default ListTagsIterable listTagsPaginator(Consumer listTagsRequest)
throws ResourceNotFoundException, InvalidParameterValueException, MissingParameterValueException,
ServiceUnavailableException, AwsServiceException, SdkClientException, BackupException {
return listTagsPaginator(ListTagsRequest.builder().applyMutation(listTagsRequest).build());
}
/**
*
* Sets a resource-based policy that is used to manage access permissions on the target backup vault. Requires a
* backup vault name and an access policy document in JSON format.
*
*
* @param putBackupVaultAccessPolicyRequest
* @return Result of the PutBackupVaultAccessPolicy operation returned by the service.
* @throws ResourceNotFoundException
* A resource that is required for the action doesn't exist.
* @throws InvalidParameterValueException
* Indicates that something is wrong with a parameter's value. For example, the value is out of range.
* @throws MissingParameterValueException
* Indicates that a required parameter is missing.
* @throws ServiceUnavailableException
* The request failed due to a temporary failure of the server.
* @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 BackupException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample BackupClient.PutBackupVaultAccessPolicy
* @see AWS API Documentation
*/
default PutBackupVaultAccessPolicyResponse putBackupVaultAccessPolicy(
PutBackupVaultAccessPolicyRequest putBackupVaultAccessPolicyRequest) throws ResourceNotFoundException,
InvalidParameterValueException, MissingParameterValueException, ServiceUnavailableException, AwsServiceException,
SdkClientException, BackupException {
throw new UnsupportedOperationException();
}
/**
*
* Sets a resource-based policy that is used to manage access permissions on the target backup vault. Requires a
* backup vault name and an access policy document in JSON format.
*
*
*
* This is a convenience which creates an instance of the {@link PutBackupVaultAccessPolicyRequest.Builder} avoiding
* the need to create one manually via {@link PutBackupVaultAccessPolicyRequest#builder()}
*
*
* @param putBackupVaultAccessPolicyRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.backup.model.PutBackupVaultAccessPolicyRequest.Builder} to create a
* request.
* @return Result of the PutBackupVaultAccessPolicy operation returned by the service.
* @throws ResourceNotFoundException
* A resource that is required for the action doesn't exist.
* @throws InvalidParameterValueException
* Indicates that something is wrong with a parameter's value. For example, the value is out of range.
* @throws MissingParameterValueException
* Indicates that a required parameter is missing.
* @throws ServiceUnavailableException
* The request failed due to a temporary failure of the server.
* @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 BackupException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample BackupClient.PutBackupVaultAccessPolicy
* @see AWS API Documentation
*/
default PutBackupVaultAccessPolicyResponse putBackupVaultAccessPolicy(
Consumer putBackupVaultAccessPolicyRequest)
throws ResourceNotFoundException, InvalidParameterValueException, MissingParameterValueException,
ServiceUnavailableException, AwsServiceException, SdkClientException, BackupException {
return putBackupVaultAccessPolicy(PutBackupVaultAccessPolicyRequest.builder()
.applyMutation(putBackupVaultAccessPolicyRequest).build());
}
/**
*
* Applies Backup Vault Lock to a backup vault, preventing attempts to delete any recovery point stored in or
* created in a backup vault. Vault Lock also prevents attempts to update the lifecycle policy that controls the
* retention period of any recovery point currently stored in a backup vault. If specified, Vault Lock enforces a
* minimum and maximum retention period for future backup and copy jobs that target a backup vault.
*
*
*
* Backup Vault Lock has been assessed by Cohasset Associates for use in environments that are subject to SEC 17a-4,
* CFTC, and FINRA regulations. For more information about how Backup Vault Lock relates to these regulations, see
* the Cohasset
* Associates Compliance Assessment.
*
*
*
* For more information, see Backup
* Vault Lock.
*
*
* @param putBackupVaultLockConfigurationRequest
* @return Result of the PutBackupVaultLockConfiguration operation returned by the service.
* @throws ResourceNotFoundException
* A resource that is required for the action doesn't exist.
* @throws InvalidParameterValueException
* Indicates that something is wrong with a parameter's value. For example, the value is out of range.
* @throws MissingParameterValueException
* Indicates that a required parameter is missing.
* @throws InvalidRequestException
* Indicates that something is wrong with the input to the request. For example, a parameter is of the wrong
* type.
* @throws ServiceUnavailableException
* The request failed due to a temporary failure of the server.
* @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 BackupException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample BackupClient.PutBackupVaultLockConfiguration
* @see AWS API Documentation
*/
default PutBackupVaultLockConfigurationResponse putBackupVaultLockConfiguration(
PutBackupVaultLockConfigurationRequest putBackupVaultLockConfigurationRequest) throws ResourceNotFoundException,
InvalidParameterValueException, MissingParameterValueException, InvalidRequestException, ServiceUnavailableException,
AwsServiceException, SdkClientException, BackupException {
throw new UnsupportedOperationException();
}
/**
*
* Applies Backup Vault Lock to a backup vault, preventing attempts to delete any recovery point stored in or
* created in a backup vault. Vault Lock also prevents attempts to update the lifecycle policy that controls the
* retention period of any recovery point currently stored in a backup vault. If specified, Vault Lock enforces a
* minimum and maximum retention period for future backup and copy jobs that target a backup vault.
*
*
*
* Backup Vault Lock has been assessed by Cohasset Associates for use in environments that are subject to SEC 17a-4,
* CFTC, and FINRA regulations. For more information about how Backup Vault Lock relates to these regulations, see
* the Cohasset
* Associates Compliance Assessment.
*
*
*
* For more information, see Backup
* Vault Lock.
*
*
*
* This is a convenience which creates an instance of the {@link PutBackupVaultLockConfigurationRequest.Builder}
* avoiding the need to create one manually via {@link PutBackupVaultLockConfigurationRequest#builder()}
*
*
* @param putBackupVaultLockConfigurationRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.backup.model.PutBackupVaultLockConfigurationRequest.Builder} to
* create a request.
* @return Result of the PutBackupVaultLockConfiguration operation returned by the service.
* @throws ResourceNotFoundException
* A resource that is required for the action doesn't exist.
* @throws InvalidParameterValueException
* Indicates that something is wrong with a parameter's value. For example, the value is out of range.
* @throws MissingParameterValueException
* Indicates that a required parameter is missing.
* @throws InvalidRequestException
* Indicates that something is wrong with the input to the request. For example, a parameter is of the wrong
* type.
* @throws ServiceUnavailableException
* The request failed due to a temporary failure of the server.
* @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 BackupException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample BackupClient.PutBackupVaultLockConfiguration
* @see AWS API Documentation
*/
default PutBackupVaultLockConfigurationResponse putBackupVaultLockConfiguration(
Consumer putBackupVaultLockConfigurationRequest)
throws ResourceNotFoundException, InvalidParameterValueException, MissingParameterValueException,
InvalidRequestException, ServiceUnavailableException, AwsServiceException, SdkClientException, BackupException {
return putBackupVaultLockConfiguration(PutBackupVaultLockConfigurationRequest.builder()
.applyMutation(putBackupVaultLockConfigurationRequest).build());
}
/**
*
* Turns on notifications on a backup vault for the specified topic and events.
*
*
* @param putBackupVaultNotificationsRequest
* @return Result of the PutBackupVaultNotifications operation returned by the service.
* @throws ResourceNotFoundException
* A resource that is required for the action doesn't exist.
* @throws InvalidParameterValueException
* Indicates that something is wrong with a parameter's value. For example, the value is out of range.
* @throws MissingParameterValueException
* Indicates that a required parameter is missing.
* @throws ServiceUnavailableException
* The request failed due to a temporary failure of the server.
* @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 BackupException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample BackupClient.PutBackupVaultNotifications
* @see AWS API Documentation
*/
default PutBackupVaultNotificationsResponse putBackupVaultNotifications(
PutBackupVaultNotificationsRequest putBackupVaultNotificationsRequest) throws ResourceNotFoundException,
InvalidParameterValueException, MissingParameterValueException, ServiceUnavailableException, AwsServiceException,
SdkClientException, BackupException {
throw new UnsupportedOperationException();
}
/**
*
* Turns on notifications on a backup vault for the specified topic and events.
*
*
*
* This is a convenience which creates an instance of the {@link PutBackupVaultNotificationsRequest.Builder}
* avoiding the need to create one manually via {@link PutBackupVaultNotificationsRequest#builder()}
*
*
* @param putBackupVaultNotificationsRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.backup.model.PutBackupVaultNotificationsRequest.Builder} to create
* a request.
* @return Result of the PutBackupVaultNotifications operation returned by the service.
* @throws ResourceNotFoundException
* A resource that is required for the action doesn't exist.
* @throws InvalidParameterValueException
* Indicates that something is wrong with a parameter's value. For example, the value is out of range.
* @throws MissingParameterValueException
* Indicates that a required parameter is missing.
* @throws ServiceUnavailableException
* The request failed due to a temporary failure of the server.
* @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 BackupException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample BackupClient.PutBackupVaultNotifications
* @see AWS API Documentation
*/
default PutBackupVaultNotificationsResponse putBackupVaultNotifications(
Consumer putBackupVaultNotificationsRequest)
throws ResourceNotFoundException, InvalidParameterValueException, MissingParameterValueException,
ServiceUnavailableException, AwsServiceException, SdkClientException, BackupException {
return putBackupVaultNotifications(PutBackupVaultNotificationsRequest.builder()
.applyMutation(putBackupVaultNotificationsRequest).build());
}
/**
*
* This request allows you to send your independent self-run restore test validation results.
* RestoreJobId and ValidationStatus are required. Optionally, you can input a
* ValidationStatusMessage.
*
*
* @param putRestoreValidationResultRequest
* @return Result of the PutRestoreValidationResult operation returned by the service.
* @throws InvalidParameterValueException
* Indicates that something is wrong with a parameter's value. For example, the value is out of range.
* @throws InvalidRequestException
* Indicates that something is wrong with the input to the request. For example, a parameter is of the wrong
* type.
* @throws MissingParameterValueException
* Indicates that a required parameter is missing.
* @throws ResourceNotFoundException
* A resource that is required for the action doesn't exist.
* @throws ServiceUnavailableException
* The request failed due to a temporary failure of the server.
* @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 BackupException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample BackupClient.PutRestoreValidationResult
* @see AWS API Documentation
*/
default PutRestoreValidationResultResponse putRestoreValidationResult(
PutRestoreValidationResultRequest putRestoreValidationResultRequest) throws InvalidParameterValueException,
InvalidRequestException, MissingParameterValueException, ResourceNotFoundException, ServiceUnavailableException,
AwsServiceException, SdkClientException, BackupException {
throw new UnsupportedOperationException();
}
/**
*
* This request allows you to send your independent self-run restore test validation results.
* RestoreJobId and ValidationStatus are required. Optionally, you can input a
* ValidationStatusMessage.
*
*
*
* This is a convenience which creates an instance of the {@link PutRestoreValidationResultRequest.Builder} avoiding
* the need to create one manually via {@link PutRestoreValidationResultRequest#builder()}
*
*
* @param putRestoreValidationResultRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.backup.model.PutRestoreValidationResultRequest.Builder} to create a
* request.
* @return Result of the PutRestoreValidationResult operation returned by the service.
* @throws InvalidParameterValueException
* Indicates that something is wrong with a parameter's value. For example, the value is out of range.
* @throws InvalidRequestException
* Indicates that something is wrong with the input to the request. For example, a parameter is of the wrong
* type.
* @throws MissingParameterValueException
* Indicates that a required parameter is missing.
* @throws ResourceNotFoundException
* A resource that is required for the action doesn't exist.
* @throws ServiceUnavailableException
* The request failed due to a temporary failure of the server.
* @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 BackupException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample BackupClient.PutRestoreValidationResult
* @see AWS API Documentation
*/
default PutRestoreValidationResultResponse putRestoreValidationResult(
Consumer putRestoreValidationResultRequest)
throws InvalidParameterValueException, InvalidRequestException, MissingParameterValueException,
ResourceNotFoundException, ServiceUnavailableException, AwsServiceException, SdkClientException, BackupException {
return putRestoreValidationResult(PutRestoreValidationResultRequest.builder()
.applyMutation(putRestoreValidationResultRequest).build());
}
/**
*
* Starts an on-demand backup job for the specified resource.
*
*
* @param startBackupJobRequest
* @return Result of the StartBackupJob operation returned by the service.
* @throws ResourceNotFoundException
* A resource that is required for the action doesn't exist.
* @throws InvalidParameterValueException
* Indicates that something is wrong with a parameter's value. For example, the value is out of range.
* @throws MissingParameterValueException
* Indicates that a required parameter is missing.
* @throws InvalidRequestException
* Indicates that something is wrong with the input to the request. For example, a parameter is of the wrong
* type.
* @throws ServiceUnavailableException
* The request failed due to a temporary failure of the server.
* @throws LimitExceededException
* A limit in the request has been exceeded; for example, a maximum number of items allowed in a request.
* @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 BackupException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample BackupClient.StartBackupJob
* @see AWS API
* Documentation
*/
default StartBackupJobResponse startBackupJob(StartBackupJobRequest startBackupJobRequest) throws ResourceNotFoundException,
InvalidParameterValueException, MissingParameterValueException, InvalidRequestException, ServiceUnavailableException,
LimitExceededException, AwsServiceException, SdkClientException, BackupException {
throw new UnsupportedOperationException();
}
/**
*
* Starts an on-demand backup job for the specified resource.
*
*
*
* This is a convenience which creates an instance of the {@link StartBackupJobRequest.Builder} avoiding the need to
* create one manually via {@link StartBackupJobRequest#builder()}
*
*
* @param startBackupJobRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.backup.model.StartBackupJobRequest.Builder} to create a request.
* @return Result of the StartBackupJob operation returned by the service.
* @throws ResourceNotFoundException
* A resource that is required for the action doesn't exist.
* @throws InvalidParameterValueException
* Indicates that something is wrong with a parameter's value. For example, the value is out of range.
* @throws MissingParameterValueException
* Indicates that a required parameter is missing.
* @throws InvalidRequestException
* Indicates that something is wrong with the input to the request. For example, a parameter is of the wrong
* type.
* @throws ServiceUnavailableException
* The request failed due to a temporary failure of the server.
* @throws LimitExceededException
* A limit in the request has been exceeded; for example, a maximum number of items allowed in a request.
* @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 BackupException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample BackupClient.StartBackupJob
* @see AWS API
* Documentation
*/
default StartBackupJobResponse startBackupJob(Consumer startBackupJobRequest)
throws ResourceNotFoundException, InvalidParameterValueException, MissingParameterValueException,
InvalidRequestException, ServiceUnavailableException, LimitExceededException, AwsServiceException,
SdkClientException, BackupException {
return startBackupJob(StartBackupJobRequest.builder().applyMutation(startBackupJobRequest).build());
}
/**
*
* Starts a job to create a one-time copy of the specified resource.
*
*
* Does not support continuous backups.
*
*
* @param startCopyJobRequest
* @return Result of the StartCopyJob operation returned by the service.
* @throws ResourceNotFoundException
* A resource that is required for the action doesn't exist.
* @throws InvalidParameterValueException
* Indicates that something is wrong with a parameter's value. For example, the value is out of range.
* @throws MissingParameterValueException
* Indicates that a required parameter is missing.
* @throws ServiceUnavailableException
* The request failed due to a temporary failure of the server.
* @throws LimitExceededException
* A limit in the request has been exceeded; for example, a maximum number of items allowed in a request.
* @throws InvalidRequestException
* Indicates that something is wrong with the input to the request. For example, a parameter is of the wrong
* type.
* @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 BackupException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample BackupClient.StartCopyJob
* @see AWS API
* Documentation
*/
default StartCopyJobResponse startCopyJob(StartCopyJobRequest startCopyJobRequest) throws ResourceNotFoundException,
InvalidParameterValueException, MissingParameterValueException, ServiceUnavailableException, LimitExceededException,
InvalidRequestException, AwsServiceException, SdkClientException, BackupException {
throw new UnsupportedOperationException();
}
/**
*
* Starts a job to create a one-time copy of the specified resource.
*
*
* Does not support continuous backups.
*
*
*
* This is a convenience which creates an instance of the {@link StartCopyJobRequest.Builder} avoiding the need to
* create one manually via {@link StartCopyJobRequest#builder()}
*
*
* @param startCopyJobRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.backup.model.StartCopyJobRequest.Builder} to create a request.
* @return Result of the StartCopyJob operation returned by the service.
* @throws ResourceNotFoundException
* A resource that is required for the action doesn't exist.
* @throws InvalidParameterValueException
* Indicates that something is wrong with a parameter's value. For example, the value is out of range.
* @throws MissingParameterValueException
* Indicates that a required parameter is missing.
* @throws ServiceUnavailableException
* The request failed due to a temporary failure of the server.
* @throws LimitExceededException
* A limit in the request has been exceeded; for example, a maximum number of items allowed in a request.
* @throws InvalidRequestException
* Indicates that something is wrong with the input to the request. For example, a parameter is of the wrong
* type.
* @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 BackupException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample BackupClient.StartCopyJob
* @see AWS API
* Documentation
*/
default StartCopyJobResponse startCopyJob(Consumer startCopyJobRequest)
throws ResourceNotFoundException, InvalidParameterValueException, MissingParameterValueException,
ServiceUnavailableException, LimitExceededException, InvalidRequestException, AwsServiceException,
SdkClientException, BackupException {
return startCopyJob(StartCopyJobRequest.builder().applyMutation(startCopyJobRequest).build());
}
/**
*
* Starts an on-demand report job for the specified report plan.
*
*
* @param startReportJobRequest
* @return Result of the StartReportJob operation returned by the service.
* @throws InvalidParameterValueException
* Indicates that something is wrong with a parameter's value. For example, the value is out of range.
* @throws ServiceUnavailableException
* The request failed due to a temporary failure of the server.
* @throws MissingParameterValueException
* Indicates that a required parameter is missing.
* @throws ResourceNotFoundException
* A resource that is required for the action doesn't 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 BackupException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample BackupClient.StartReportJob
* @see AWS API
* Documentation
*/
default StartReportJobResponse startReportJob(StartReportJobRequest startReportJobRequest)
throws InvalidParameterValueException, ServiceUnavailableException, MissingParameterValueException,
ResourceNotFoundException, AwsServiceException, SdkClientException, BackupException {
throw new UnsupportedOperationException();
}
/**
*
* Starts an on-demand report job for the specified report plan.
*
*
*
* This is a convenience which creates an instance of the {@link StartReportJobRequest.Builder} avoiding the need to
* create one manually via {@link StartReportJobRequest#builder()}
*
*
* @param startReportJobRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.backup.model.StartReportJobRequest.Builder} to create a request.
* @return Result of the StartReportJob operation returned by the service.
* @throws InvalidParameterValueException
* Indicates that something is wrong with a parameter's value. For example, the value is out of range.
* @throws ServiceUnavailableException
* The request failed due to a temporary failure of the server.
* @throws MissingParameterValueException
* Indicates that a required parameter is missing.
* @throws ResourceNotFoundException
* A resource that is required for the action doesn't 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 BackupException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample BackupClient.StartReportJob
* @see AWS API
* Documentation
*/
default StartReportJobResponse startReportJob(Consumer startReportJobRequest)
throws InvalidParameterValueException, ServiceUnavailableException, MissingParameterValueException,
ResourceNotFoundException, AwsServiceException, SdkClientException, BackupException {
return startReportJob(StartReportJobRequest.builder().applyMutation(startReportJobRequest).build());
}
/**
*
* Recovers the saved resource identified by an Amazon Resource Name (ARN).
*
*
* @param startRestoreJobRequest
* @return Result of the StartRestoreJob operation returned by the service.
* @throws ResourceNotFoundException
* A resource that is required for the action doesn't exist.
* @throws InvalidParameterValueException
* Indicates that something is wrong with a parameter's value. For example, the value is out of range.
* @throws MissingParameterValueException
* Indicates that a required parameter is missing.
* @throws ServiceUnavailableException
* The request failed due to a temporary failure of the server.
* @throws InvalidRequestException
* Indicates that something is wrong with the input to the request. For example, a parameter is of the wrong
* type.
* @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 BackupException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample BackupClient.StartRestoreJob
* @see AWS API
* Documentation
*/
default StartRestoreJobResponse startRestoreJob(StartRestoreJobRequest startRestoreJobRequest)
throws ResourceNotFoundException, InvalidParameterValueException, MissingParameterValueException,
ServiceUnavailableException, InvalidRequestException, AwsServiceException, SdkClientException, BackupException {
throw new UnsupportedOperationException();
}
/**
*
* Recovers the saved resource identified by an Amazon Resource Name (ARN).
*
*
*
* This is a convenience which creates an instance of the {@link StartRestoreJobRequest.Builder} avoiding the need
* to create one manually via {@link StartRestoreJobRequest#builder()}
*
*
* @param startRestoreJobRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.backup.model.StartRestoreJobRequest.Builder} to create a request.
* @return Result of the StartRestoreJob operation returned by the service.
* @throws ResourceNotFoundException
* A resource that is required for the action doesn't exist.
* @throws InvalidParameterValueException
* Indicates that something is wrong with a parameter's value. For example, the value is out of range.
* @throws MissingParameterValueException
* Indicates that a required parameter is missing.
* @throws ServiceUnavailableException
* The request failed due to a temporary failure of the server.
* @throws InvalidRequestException
* Indicates that something is wrong with the input to the request. For example, a parameter is of the wrong
* type.
* @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 BackupException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample BackupClient.StartRestoreJob
* @see AWS API
* Documentation
*/
default StartRestoreJobResponse startRestoreJob(Consumer startRestoreJobRequest)
throws ResourceNotFoundException, InvalidParameterValueException, MissingParameterValueException,
ServiceUnavailableException, InvalidRequestException, AwsServiceException, SdkClientException, BackupException {
return startRestoreJob(StartRestoreJobRequest.builder().applyMutation(startRestoreJobRequest).build());
}
/**
*
* Attempts to cancel a job to create a one-time backup of a resource.
*
*
* This action is not supported for the following services: Amazon FSx for Windows File Server, Amazon FSx for
* Lustre, Amazon FSx for NetApp ONTAP, Amazon FSx for OpenZFS, Amazon DocumentDB (with MongoDB compatibility),
* Amazon RDS, Amazon Aurora, and Amazon Neptune.
*
*
* @param stopBackupJobRequest
* @return Result of the StopBackupJob operation returned by the service.
* @throws MissingParameterValueException
* Indicates that a required parameter is missing.
* @throws ResourceNotFoundException
* A resource that is required for the action doesn't exist.
* @throws InvalidParameterValueException
* Indicates that something is wrong with a parameter's value. For example, the value is out of range.
* @throws InvalidRequestException
* Indicates that something is wrong with the input to the request. For example, a parameter is of the wrong
* type.
* @throws ServiceUnavailableException
* The request failed due to a temporary failure of the server.
* @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 BackupException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample BackupClient.StopBackupJob
* @see AWS API
* Documentation
*/
default StopBackupJobResponse stopBackupJob(StopBackupJobRequest stopBackupJobRequest) throws MissingParameterValueException,
ResourceNotFoundException, InvalidParameterValueException, InvalidRequestException, ServiceUnavailableException,
AwsServiceException, SdkClientException, BackupException {
throw new UnsupportedOperationException();
}
/**
*
* Attempts to cancel a job to create a one-time backup of a resource.
*
*
* This action is not supported for the following services: Amazon FSx for Windows File Server, Amazon FSx for
* Lustre, Amazon FSx for NetApp ONTAP, Amazon FSx for OpenZFS, Amazon DocumentDB (with MongoDB compatibility),
* Amazon RDS, Amazon Aurora, and Amazon Neptune.
*
*
*
* This is a convenience which creates an instance of the {@link StopBackupJobRequest.Builder} avoiding the need to
* create one manually via {@link StopBackupJobRequest#builder()}
*
*
* @param stopBackupJobRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.backup.model.StopBackupJobRequest.Builder} to create a request.
* @return Result of the StopBackupJob operation returned by the service.
* @throws MissingParameterValueException
* Indicates that a required parameter is missing.
* @throws ResourceNotFoundException
* A resource that is required for the action doesn't exist.
* @throws InvalidParameterValueException
* Indicates that something is wrong with a parameter's value. For example, the value is out of range.
* @throws InvalidRequestException
* Indicates that something is wrong with the input to the request. For example, a parameter is of the wrong
* type.
* @throws ServiceUnavailableException
* The request failed due to a temporary failure of the server.
* @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 BackupException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample BackupClient.StopBackupJob
* @see AWS API
* Documentation
*/
default StopBackupJobResponse stopBackupJob(Consumer stopBackupJobRequest)
throws MissingParameterValueException, ResourceNotFoundException, InvalidParameterValueException,
InvalidRequestException, ServiceUnavailableException, AwsServiceException, SdkClientException, BackupException {
return stopBackupJob(StopBackupJobRequest.builder().applyMutation(stopBackupJobRequest).build());
}
/**
*
* Assigns a set of key-value pairs to a recovery point, backup plan, or backup vault identified by an Amazon
* Resource Name (ARN).
*
*
* This API is supported for recovery points for resource types including Aurora, Amazon DocumentDB. Amazon EBS,
* Amazon FSx, Neptune, and Amazon RDS.
*
*
* @param tagResourceRequest
* @return Result of the TagResource operation returned by the service.
* @throws ResourceNotFoundException
* A resource that is required for the action doesn't exist.
* @throws InvalidParameterValueException
* Indicates that something is wrong with a parameter's value. For example, the value is out of range.
* @throws MissingParameterValueException
* Indicates that a required parameter is missing.
* @throws ServiceUnavailableException
* The request failed due to a temporary failure of the server.
* @throws LimitExceededException
* A limit in the request has been exceeded; for example, a maximum number of items allowed in a request.
* @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 BackupException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample BackupClient.TagResource
* @see AWS API
* Documentation
*/
default TagResourceResponse tagResource(TagResourceRequest tagResourceRequest) throws ResourceNotFoundException,
InvalidParameterValueException, MissingParameterValueException, ServiceUnavailableException, LimitExceededException,
AwsServiceException, SdkClientException, BackupException {
throw new UnsupportedOperationException();
}
/**
*
* Assigns a set of key-value pairs to a recovery point, backup plan, or backup vault identified by an Amazon
* Resource Name (ARN).
*
*
* This API is supported for recovery points for resource types including Aurora, Amazon DocumentDB. Amazon EBS,
* Amazon FSx, Neptune, and Amazon RDS.
*
*
*
* This is a convenience which creates an instance of the {@link TagResourceRequest.Builder} avoiding the need to
* create one manually via {@link TagResourceRequest#builder()}
*
*
* @param tagResourceRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.backup.model.TagResourceRequest.Builder} to create a request.
* @return Result of the TagResource operation returned by the service.
* @throws ResourceNotFoundException
* A resource that is required for the action doesn't exist.
* @throws InvalidParameterValueException
* Indicates that something is wrong with a parameter's value. For example, the value is out of range.
* @throws MissingParameterValueException
* Indicates that a required parameter is missing.
* @throws ServiceUnavailableException
* The request failed due to a temporary failure of the server.
* @throws LimitExceededException
* A limit in the request has been exceeded; for example, a maximum number of items allowed in a request.
* @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 BackupException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample BackupClient.TagResource
* @see AWS API
* Documentation
*/
default TagResourceResponse tagResource(Consumer tagResourceRequest)
throws ResourceNotFoundException, InvalidParameterValueException, MissingParameterValueException,
ServiceUnavailableException, LimitExceededException, AwsServiceException, SdkClientException, BackupException {
return tagResource(TagResourceRequest.builder().applyMutation(tagResourceRequest).build());
}
/**
*
* Removes a set of key-value pairs from a recovery point, backup plan, or backup vault identified by an Amazon
* Resource Name (ARN)
*
*
* This API is not supported for recovery points for resource types including Aurora, Amazon DocumentDB. Amazon EBS,
* Amazon FSx, Neptune, and Amazon RDS.
*
*
* @param untagResourceRequest
* @return Result of the UntagResource operation returned by the service.
* @throws ResourceNotFoundException
* A resource that is required for the action doesn't exist.
* @throws InvalidParameterValueException
* Indicates that something is wrong with a parameter's value. For example, the value is out of range.
* @throws MissingParameterValueException
* Indicates that a required parameter is missing.
* @throws ServiceUnavailableException
* The request failed due to a temporary failure of the server.
* @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 BackupException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample BackupClient.UntagResource
* @see AWS API
* Documentation
*/
default UntagResourceResponse untagResource(UntagResourceRequest untagResourceRequest) throws ResourceNotFoundException,
InvalidParameterValueException, MissingParameterValueException, ServiceUnavailableException, AwsServiceException,
SdkClientException, BackupException {
throw new UnsupportedOperationException();
}
/**
*
* Removes a set of key-value pairs from a recovery point, backup plan, or backup vault identified by an Amazon
* Resource Name (ARN)
*
*
* This API is not supported for recovery points for resource types including Aurora, Amazon DocumentDB. Amazon EBS,
* Amazon FSx, Neptune, and Amazon RDS.
*
*
*
* This is a convenience which creates an instance of the {@link UntagResourceRequest.Builder} avoiding the need to
* create one manually via {@link UntagResourceRequest#builder()}
*
*
* @param untagResourceRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.backup.model.UntagResourceRequest.Builder} to create a request.
* @return Result of the UntagResource operation returned by the service.
* @throws ResourceNotFoundException
* A resource that is required for the action doesn't exist.
* @throws InvalidParameterValueException
* Indicates that something is wrong with a parameter's value. For example, the value is out of range.
* @throws MissingParameterValueException
* Indicates that a required parameter is missing.
* @throws ServiceUnavailableException
* The request failed due to a temporary failure of the server.
* @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 BackupException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample BackupClient.UntagResource
* @see AWS API
* Documentation
*/
default UntagResourceResponse untagResource(Consumer untagResourceRequest)
throws ResourceNotFoundException, InvalidParameterValueException, MissingParameterValueException,
ServiceUnavailableException, AwsServiceException, SdkClientException, BackupException {
return untagResource(UntagResourceRequest.builder().applyMutation(untagResourceRequest).build());
}
/**
*
* Updates the specified backup plan. The new version is uniquely identified by its ID.
*
*
* @param updateBackupPlanRequest
* @return Result of the UpdateBackupPlan operation returned by the service.
* @throws ResourceNotFoundException
* A resource that is required for the action doesn't exist.
* @throws InvalidParameterValueException
* Indicates that something is wrong with a parameter's value. For example, the value is out of range.
* @throws MissingParameterValueException
* Indicates that a required parameter is missing.
* @throws ServiceUnavailableException
* The request failed due to a temporary failure of the server.
* @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 BackupException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample BackupClient.UpdateBackupPlan
* @see AWS API
* Documentation
*/
default UpdateBackupPlanResponse updateBackupPlan(UpdateBackupPlanRequest updateBackupPlanRequest)
throws ResourceNotFoundException, InvalidParameterValueException, MissingParameterValueException,
ServiceUnavailableException, AwsServiceException, SdkClientException, BackupException {
throw new UnsupportedOperationException();
}
/**
*
* Updates the specified backup plan. The new version is uniquely identified by its ID.
*
*
*
* This is a convenience which creates an instance of the {@link UpdateBackupPlanRequest.Builder} avoiding the need
* to create one manually via {@link UpdateBackupPlanRequest#builder()}
*
*
* @param updateBackupPlanRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.backup.model.UpdateBackupPlanRequest.Builder} to create a request.
* @return Result of the UpdateBackupPlan operation returned by the service.
* @throws ResourceNotFoundException
* A resource that is required for the action doesn't exist.
* @throws InvalidParameterValueException
* Indicates that something is wrong with a parameter's value. For example, the value is out of range.
* @throws MissingParameterValueException
* Indicates that a required parameter is missing.
* @throws ServiceUnavailableException
* The request failed due to a temporary failure of the server.
* @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 BackupException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample BackupClient.UpdateBackupPlan
* @see AWS API
* Documentation
*/
default UpdateBackupPlanResponse updateBackupPlan(Consumer updateBackupPlanRequest)
throws ResourceNotFoundException, InvalidParameterValueException, MissingParameterValueException,
ServiceUnavailableException, AwsServiceException, SdkClientException, BackupException {
return updateBackupPlan(UpdateBackupPlanRequest.builder().applyMutation(updateBackupPlanRequest).build());
}
/**
*
* Updates the specified framework.
*
*
* @param updateFrameworkRequest
* @return Result of the UpdateFramework operation returned by the service.
* @throws AlreadyExistsException
* The required resource already exists.
* @throws ResourceNotFoundException
* A resource that is required for the action doesn't exist.
* @throws LimitExceededException
* A limit in the request has been exceeded; for example, a maximum number of items allowed in a request.
* @throws InvalidParameterValueException
* Indicates that something is wrong with a parameter's value. For example, the value is out of range.
* @throws MissingParameterValueException
* Indicates that a required parameter is missing.
* @throws ConflictException
* Backup can't perform the action that you requested until it finishes performing a previous action. Try
* again later.
* @throws ServiceUnavailableException
* The request failed due to a temporary failure of the server.
* @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 BackupException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample BackupClient.UpdateFramework
* @see AWS API
* Documentation
*/
default UpdateFrameworkResponse updateFramework(UpdateFrameworkRequest updateFrameworkRequest) throws AlreadyExistsException,
ResourceNotFoundException, LimitExceededException, InvalidParameterValueException, MissingParameterValueException,
ConflictException, ServiceUnavailableException, AwsServiceException, SdkClientException, BackupException {
throw new UnsupportedOperationException();
}
/**
*
* Updates the specified framework.
*
*
*
* This is a convenience which creates an instance of the {@link UpdateFrameworkRequest.Builder} avoiding the need
* to create one manually via {@link UpdateFrameworkRequest#builder()}
*
*
* @param updateFrameworkRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.backup.model.UpdateFrameworkRequest.Builder} to create a request.
* @return Result of the UpdateFramework operation returned by the service.
* @throws AlreadyExistsException
* The required resource already exists.
* @throws ResourceNotFoundException
* A resource that is required for the action doesn't exist.
* @throws LimitExceededException
* A limit in the request has been exceeded; for example, a maximum number of items allowed in a request.
* @throws InvalidParameterValueException
* Indicates that something is wrong with a parameter's value. For example, the value is out of range.
* @throws MissingParameterValueException
* Indicates that a required parameter is missing.
* @throws ConflictException
* Backup can't perform the action that you requested until it finishes performing a previous action. Try
* again later.
* @throws ServiceUnavailableException
* The request failed due to a temporary failure of the server.
* @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 BackupException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample BackupClient.UpdateFramework
* @see AWS API
* Documentation
*/
default UpdateFrameworkResponse updateFramework(Consumer updateFrameworkRequest)
throws AlreadyExistsException, ResourceNotFoundException, LimitExceededException, InvalidParameterValueException,
MissingParameterValueException, ConflictException, ServiceUnavailableException, AwsServiceException,
SdkClientException, BackupException {
return updateFramework(UpdateFrameworkRequest.builder().applyMutation(updateFrameworkRequest).build());
}
/**
*
* Updates whether the Amazon Web Services account is opted in to cross-account backup. Returns an error if the
* account is not an Organizations management account. Use the DescribeGlobalSettings API to determine
* the current settings.
*
*
* @param updateGlobalSettingsRequest
* @return Result of the UpdateGlobalSettings operation returned by the service.
* @throws ServiceUnavailableException
* The request failed due to a temporary failure of the server.
* @throws MissingParameterValueException
* Indicates that a required parameter is missing.
* @throws InvalidParameterValueException
* Indicates that something is wrong with a parameter's value. For example, the value is out of range.
* @throws InvalidRequestException
* Indicates that something is wrong with the input to the request. For example, a parameter is of the wrong
* type.
* @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 BackupException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample BackupClient.UpdateGlobalSettings
* @see AWS
* API Documentation
*/
default UpdateGlobalSettingsResponse updateGlobalSettings(UpdateGlobalSettingsRequest updateGlobalSettingsRequest)
throws ServiceUnavailableException, MissingParameterValueException, InvalidParameterValueException,
InvalidRequestException, AwsServiceException, SdkClientException, BackupException {
throw new UnsupportedOperationException();
}
/**
*
* Updates whether the Amazon Web Services account is opted in to cross-account backup. Returns an error if the
* account is not an Organizations management account. Use the DescribeGlobalSettings API to determine
* the current settings.
*
*
*
* This is a convenience which creates an instance of the {@link UpdateGlobalSettingsRequest.Builder} avoiding the
* need to create one manually via {@link UpdateGlobalSettingsRequest#builder()}
*
*
* @param updateGlobalSettingsRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.backup.model.UpdateGlobalSettingsRequest.Builder} to create a
* request.
* @return Result of the UpdateGlobalSettings operation returned by the service.
* @throws ServiceUnavailableException
* The request failed due to a temporary failure of the server.
* @throws MissingParameterValueException
* Indicates that a required parameter is missing.
* @throws InvalidParameterValueException
* Indicates that something is wrong with a parameter's value. For example, the value is out of range.
* @throws InvalidRequestException
* Indicates that something is wrong with the input to the request. For example, a parameter is of the wrong
* type.
* @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 BackupException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample BackupClient.UpdateGlobalSettings
* @see AWS
* API Documentation
*/
default UpdateGlobalSettingsResponse updateGlobalSettings(
Consumer updateGlobalSettingsRequest) throws ServiceUnavailableException,
MissingParameterValueException, InvalidParameterValueException, InvalidRequestException, AwsServiceException,
SdkClientException, BackupException {
return updateGlobalSettings(UpdateGlobalSettingsRequest.builder().applyMutation(updateGlobalSettingsRequest).build());
}
/**
*
* Sets the transition lifecycle of a recovery point.
*
*
* The lifecycle defines when a protected resource is transitioned to cold storage and when it expires. Backup
* transitions and expires backups automatically according to the lifecycle that you define.
*
*
* Resource types that can transition to cold storage are listed in the Feature availability by resource table. Backup ignores this expression for other resource types.
*
*
* Backups transitioned to cold storage must be stored in cold storage for a minimum of 90 days. Therefore, the
* “retention” setting must be 90 days greater than the “transition to cold after days” setting. The “transition to
* cold after days” setting cannot be changed after a backup has been transitioned to cold.
*
*
*
* If your lifecycle currently uses the parameters DeleteAfterDays and
* MoveToColdStorageAfterDays, include these parameters and their values when you call this operation.
* Not including them may result in your plan updating with null values.
*
*
*
* This operation does not support continuous backups.
*
*
* @param updateRecoveryPointLifecycleRequest
* @return Result of the UpdateRecoveryPointLifecycle operation returned by the service.
* @throws ResourceNotFoundException
* A resource that is required for the action doesn't exist.
* @throws InvalidParameterValueException
* Indicates that something is wrong with a parameter's value. For example, the value is out of range.
* @throws InvalidRequestException
* Indicates that something is wrong with the input to the request. For example, a parameter is of the wrong
* type.
* @throws MissingParameterValueException
* Indicates that a required parameter is missing.
* @throws ServiceUnavailableException
* The request failed due to a temporary failure of the server.
* @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 BackupException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample BackupClient.UpdateRecoveryPointLifecycle
* @see AWS API Documentation
*/
default UpdateRecoveryPointLifecycleResponse updateRecoveryPointLifecycle(
UpdateRecoveryPointLifecycleRequest updateRecoveryPointLifecycleRequest) throws ResourceNotFoundException,
InvalidParameterValueException, InvalidRequestException, MissingParameterValueException, ServiceUnavailableException,
AwsServiceException, SdkClientException, BackupException {
throw new UnsupportedOperationException();
}
/**
*
* Sets the transition lifecycle of a recovery point.
*
*
* The lifecycle defines when a protected resource is transitioned to cold storage and when it expires. Backup
* transitions and expires backups automatically according to the lifecycle that you define.
*
*
* Resource types that can transition to cold storage are listed in the Feature availability by resource table. Backup ignores this expression for other resource types.
*
*
* Backups transitioned to cold storage must be stored in cold storage for a minimum of 90 days. Therefore, the
* “retention” setting must be 90 days greater than the “transition to cold after days” setting. The “transition to
* cold after days” setting cannot be changed after a backup has been transitioned to cold.
*
*
*
* If your lifecycle currently uses the parameters DeleteAfterDays and
* MoveToColdStorageAfterDays, include these parameters and their values when you call this operation.
* Not including them may result in your plan updating with null values.
*
*
*
* This operation does not support continuous backups.
*
*
*
* This is a convenience which creates an instance of the {@link UpdateRecoveryPointLifecycleRequest.Builder}
* avoiding the need to create one manually via {@link UpdateRecoveryPointLifecycleRequest#builder()}
*
*
* @param updateRecoveryPointLifecycleRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.backup.model.UpdateRecoveryPointLifecycleRequest.Builder} to create
* a request.
* @return Result of the UpdateRecoveryPointLifecycle operation returned by the service.
* @throws ResourceNotFoundException
* A resource that is required for the action doesn't exist.
* @throws InvalidParameterValueException
* Indicates that something is wrong with a parameter's value. For example, the value is out of range.
* @throws InvalidRequestException
* Indicates that something is wrong with the input to the request. For example, a parameter is of the wrong
* type.
* @throws MissingParameterValueException
* Indicates that a required parameter is missing.
* @throws ServiceUnavailableException
* The request failed due to a temporary failure of the server.
* @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 BackupException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample BackupClient.UpdateRecoveryPointLifecycle
* @see AWS API Documentation
*/
default UpdateRecoveryPointLifecycleResponse updateRecoveryPointLifecycle(
Consumer updateRecoveryPointLifecycleRequest)
throws ResourceNotFoundException, InvalidParameterValueException, InvalidRequestException,
MissingParameterValueException, ServiceUnavailableException, AwsServiceException, SdkClientException, BackupException {
return updateRecoveryPointLifecycle(UpdateRecoveryPointLifecycleRequest.builder()
.applyMutation(updateRecoveryPointLifecycleRequest).build());
}
/**
*
* Updates the current service opt-in settings for the Region.
*
*
* Use the DescribeRegionSettings API to determine the resource types that are supported.
*
*
* @param updateRegionSettingsRequest
* @return Result of the UpdateRegionSettings operation returned by the service.
* @throws ServiceUnavailableException
* The request failed due to a temporary failure of the server.
* @throws MissingParameterValueException
* Indicates that a required parameter is missing.
* @throws InvalidParameterValueException
* Indicates that something is wrong with a parameter's value. For example, the value is out of range.
* @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 BackupException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample BackupClient.UpdateRegionSettings
* @see AWS
* API Documentation
*/
default UpdateRegionSettingsResponse updateRegionSettings(UpdateRegionSettingsRequest updateRegionSettingsRequest)
throws ServiceUnavailableException, MissingParameterValueException, InvalidParameterValueException,
AwsServiceException, SdkClientException, BackupException {
throw new UnsupportedOperationException();
}
/**
*
* Updates the current service opt-in settings for the Region.
*
*
* Use the DescribeRegionSettings API to determine the resource types that are supported.
*
*
*
* This is a convenience which creates an instance of the {@link UpdateRegionSettingsRequest.Builder} avoiding the
* need to create one manually via {@link UpdateRegionSettingsRequest#builder()}
*
*
* @param updateRegionSettingsRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.backup.model.UpdateRegionSettingsRequest.Builder} to create a
* request.
* @return Result of the UpdateRegionSettings operation returned by the service.
* @throws ServiceUnavailableException
* The request failed due to a temporary failure of the server.
* @throws MissingParameterValueException
* Indicates that a required parameter is missing.
* @throws InvalidParameterValueException
* Indicates that something is wrong with a parameter's value. For example, the value is out of range.
* @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 BackupException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample BackupClient.UpdateRegionSettings
* @see AWS
* API Documentation
*/
default UpdateRegionSettingsResponse updateRegionSettings(
Consumer updateRegionSettingsRequest) throws ServiceUnavailableException,
MissingParameterValueException, InvalidParameterValueException, AwsServiceException, SdkClientException,
BackupException {
return updateRegionSettings(UpdateRegionSettingsRequest.builder().applyMutation(updateRegionSettingsRequest).build());
}
/**
*
* Updates the specified report plan.
*
*
* @param updateReportPlanRequest
* @return Result of the UpdateReportPlan operation returned by the service.
* @throws ResourceNotFoundException
* A resource that is required for the action doesn't exist.
* @throws InvalidParameterValueException
* Indicates that something is wrong with a parameter's value. For example, the value is out of range.
* @throws ServiceUnavailableException
* The request failed due to a temporary failure of the server.
* @throws MissingParameterValueException
* Indicates that a required parameter is missing.
* @throws ConflictException
* Backup can't perform the action that you requested until it finishes performing a previous action. Try
* again later.
* @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 BackupException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample BackupClient.UpdateReportPlan
* @see AWS API
* Documentation
*/
default UpdateReportPlanResponse updateReportPlan(UpdateReportPlanRequest updateReportPlanRequest)
throws ResourceNotFoundException, InvalidParameterValueException, ServiceUnavailableException,
MissingParameterValueException, ConflictException, AwsServiceException, SdkClientException, BackupException {
throw new UnsupportedOperationException();
}
/**
*
* Updates the specified report plan.
*
*
*
* This is a convenience which creates an instance of the {@link UpdateReportPlanRequest.Builder} avoiding the need
* to create one manually via {@link UpdateReportPlanRequest#builder()}
*
*
* @param updateReportPlanRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.backup.model.UpdateReportPlanRequest.Builder} to create a request.
* @return Result of the UpdateReportPlan operation returned by the service.
* @throws ResourceNotFoundException
* A resource that is required for the action doesn't exist.
* @throws InvalidParameterValueException
* Indicates that something is wrong with a parameter's value. For example, the value is out of range.
* @throws ServiceUnavailableException
* The request failed due to a temporary failure of the server.
* @throws MissingParameterValueException
* Indicates that a required parameter is missing.
* @throws ConflictException
* Backup can't perform the action that you requested until it finishes performing a previous action. Try
* again later.
* @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 BackupException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample BackupClient.UpdateReportPlan
* @see AWS API
* Documentation
*/
default UpdateReportPlanResponse updateReportPlan(Consumer updateReportPlanRequest)
throws ResourceNotFoundException, InvalidParameterValueException, ServiceUnavailableException,
MissingParameterValueException, ConflictException, AwsServiceException, SdkClientException, BackupException {
return updateReportPlan(UpdateReportPlanRequest.builder().applyMutation(updateReportPlanRequest).build());
}
/**
*
* This request will send changes to your specified restore testing plan. RestoreTestingPlanName cannot
* be updated after it is created.
*
*
* RecoveryPointSelection can contain:
*
*
* -
*
* Algorithm
*
*
* -
*
* ExcludeVaults
*
*
* -
*
* IncludeVaults
*
*
* -
*
* RecoveryPointTypes
*
*
* -
*
* SelectionWindowDays
*
*
*
*
* @param updateRestoreTestingPlanRequest
* @return Result of the UpdateRestoreTestingPlan operation returned by the service.
* @throws ConflictException
* Backup can't perform the action that you requested until it finishes performing a previous action. Try
* again later.
* @throws InvalidParameterValueException
* Indicates that something is wrong with a parameter's value. For example, the value is out of range.
* @throws MissingParameterValueException
* Indicates that a required parameter is missing.
* @throws ResourceNotFoundException
* A resource that is required for the action doesn't exist.
* @throws ServiceUnavailableException
* The request failed due to a temporary failure of the server.
* @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 BackupException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample BackupClient.UpdateRestoreTestingPlan
* @see AWS API Documentation
*/
default UpdateRestoreTestingPlanResponse updateRestoreTestingPlan(
UpdateRestoreTestingPlanRequest updateRestoreTestingPlanRequest) throws ConflictException,
InvalidParameterValueException, MissingParameterValueException, ResourceNotFoundException,
ServiceUnavailableException, AwsServiceException, SdkClientException, BackupException {
throw new UnsupportedOperationException();
}
/**
*
* This request will send changes to your specified restore testing plan. RestoreTestingPlanName cannot
* be updated after it is created.
*
*
* RecoveryPointSelection can contain:
*
*
* -
*
* Algorithm
*
*
* -
*
* ExcludeVaults
*
*
* -
*
* IncludeVaults
*
*
* -
*
* RecoveryPointTypes
*
*
* -
*
* SelectionWindowDays
*
*
*
*
*
* This is a convenience which creates an instance of the {@link UpdateRestoreTestingPlanRequest.Builder} avoiding
* the need to create one manually via {@link UpdateRestoreTestingPlanRequest#builder()}
*
*
* @param updateRestoreTestingPlanRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.backup.model.UpdateRestoreTestingPlanRequest.Builder} to create a
* request.
* @return Result of the UpdateRestoreTestingPlan operation returned by the service.
* @throws ConflictException
* Backup can't perform the action that you requested until it finishes performing a previous action. Try
* again later.
* @throws InvalidParameterValueException
* Indicates that something is wrong with a parameter's value. For example, the value is out of range.
* @throws MissingParameterValueException
* Indicates that a required parameter is missing.
* @throws ResourceNotFoundException
* A resource that is required for the action doesn't exist.
* @throws ServiceUnavailableException
* The request failed due to a temporary failure of the server.
* @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 BackupException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample BackupClient.UpdateRestoreTestingPlan
* @see AWS API Documentation
*/
default UpdateRestoreTestingPlanResponse updateRestoreTestingPlan(
Consumer updateRestoreTestingPlanRequest) throws ConflictException,
InvalidParameterValueException, MissingParameterValueException, ResourceNotFoundException,
ServiceUnavailableException, AwsServiceException, SdkClientException, BackupException {
return updateRestoreTestingPlan(UpdateRestoreTestingPlanRequest.builder().applyMutation(updateRestoreTestingPlanRequest)
.build());
}
/**
*
* Updates the specified restore testing selection.
*
*
* Most elements except the RestoreTestingSelectionName can be updated with this request.
*
*
* You can use either protected resource ARNs or conditions, but not both.
*
*
* @param updateRestoreTestingSelectionRequest
* @return Result of the UpdateRestoreTestingSelection operation returned by the service.
* @throws ConflictException
* Backup can't perform the action that you requested until it finishes performing a previous action. Try
* again later.
* @throws InvalidParameterValueException
* Indicates that something is wrong with a parameter's value. For example, the value is out of range.
* @throws MissingParameterValueException
* Indicates that a required parameter is missing.
* @throws ResourceNotFoundException
* A resource that is required for the action doesn't exist.
* @throws ServiceUnavailableException
* The request failed due to a temporary failure of the server.
* @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 BackupException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample BackupClient.UpdateRestoreTestingSelection
* @see AWS API Documentation
*/
default UpdateRestoreTestingSelectionResponse updateRestoreTestingSelection(
UpdateRestoreTestingSelectionRequest updateRestoreTestingSelectionRequest) throws ConflictException,
InvalidParameterValueException, MissingParameterValueException, ResourceNotFoundException,
ServiceUnavailableException, AwsServiceException, SdkClientException, BackupException {
throw new UnsupportedOperationException();
}
/**
*
* Updates the specified restore testing selection.
*
*
* Most elements except the RestoreTestingSelectionName can be updated with this request.
*
*
* You can use either protected resource ARNs or conditions, but not both.
*
*
*
* This is a convenience which creates an instance of the {@link UpdateRestoreTestingSelectionRequest.Builder}
* avoiding the need to create one manually via {@link UpdateRestoreTestingSelectionRequest#builder()}
*
*
* @param updateRestoreTestingSelectionRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.backup.model.UpdateRestoreTestingSelectionRequest.Builder} to
* create a request.
* @return Result of the UpdateRestoreTestingSelection operation returned by the service.
* @throws ConflictException
* Backup can't perform the action that you requested until it finishes performing a previous action. Try
* again later.
* @throws InvalidParameterValueException
* Indicates that something is wrong with a parameter's value. For example, the value is out of range.
* @throws MissingParameterValueException
* Indicates that a required parameter is missing.
* @throws ResourceNotFoundException
* A resource that is required for the action doesn't exist.
* @throws ServiceUnavailableException
* The request failed due to a temporary failure of the server.
* @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 BackupException
* Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
* @sample BackupClient.UpdateRestoreTestingSelection
* @see AWS API Documentation
*/
default UpdateRestoreTestingSelectionResponse updateRestoreTestingSelection(
Consumer updateRestoreTestingSelectionRequest)
throws ConflictException, InvalidParameterValueException, MissingParameterValueException, ResourceNotFoundException,
ServiceUnavailableException, AwsServiceException, SdkClientException, BackupException {
return updateRestoreTestingSelection(UpdateRestoreTestingSelectionRequest.builder()
.applyMutation(updateRestoreTestingSelectionRequest).build());
}
/**
* Create a {@link BackupClient} 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 BackupClient create() {
return builder().build();
}
/**
* Create a builder that can be used to configure and create a {@link BackupClient}.
*/
static BackupClientBuilder builder() {
return new DefaultBackupClientBuilder();
}
static ServiceMetadata serviceMetadata() {
return ServiceMetadata.of(SERVICE_METADATA_ID);
}
@Override
default BackupServiceClientConfiguration serviceClientConfiguration() {
throw new UnsupportedOperationException();
}
}