software.amazon.awssdk.services.backup.BackupClient Maven / Gradle / Ivy
/*
* Copyright 2014-2019 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.awscore.exception.AwsServiceException;
import software.amazon.awssdk.core.SdkClient;
import software.amazon.awssdk.core.exception.SdkClientException;
import software.amazon.awssdk.regions.ServiceMetadata;
import software.amazon.awssdk.services.backup.model.AlreadyExistsException;
import software.amazon.awssdk.services.backup.model.BackupException;
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.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.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.DeleteRecoveryPointRequest;
import software.amazon.awssdk.services.backup.model.DeleteRecoveryPointResponse;
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.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.DescribeRestoreJobRequest;
import software.amazon.awssdk.services.backup.model.DescribeRestoreJobResponse;
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.GetRecoveryPointRestoreMetadataRequest;
import software.amazon.awssdk.services.backup.model.GetRecoveryPointRestoreMetadataResponse;
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.LimitExceededException;
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.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.ListRecoveryPointsByResourceRequest;
import software.amazon.awssdk.services.backup.model.ListRecoveryPointsByResourceResponse;
import software.amazon.awssdk.services.backup.model.ListRestoreJobsRequest;
import software.amazon.awssdk.services.backup.model.ListRestoreJobsResponse;
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.PutBackupVaultNotificationsRequest;
import software.amazon.awssdk.services.backup.model.PutBackupVaultNotificationsResponse;
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.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.UpdateRecoveryPointLifecycleRequest;
import software.amazon.awssdk.services.backup.model.UpdateRecoveryPointLifecycleResponse;
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.ListProtectedResourcesIterable;
import software.amazon.awssdk.services.backup.paginators.ListRecoveryPointsByBackupVaultIterable;
import software.amazon.awssdk.services.backup.paginators.ListRecoveryPointsByResourceIterable;
import software.amazon.awssdk.services.backup.paginators.ListRestoreJobsIterable;
import software.amazon.awssdk.services.backup.paginators.ListTagsIterable;
/**
* Service client for accessing AWS Backup. This can be created using the static {@link #builder()} method.
*
* AWS Backup
*
* AWS Backup is a unified backup service designed to protect AWS services and their associated data. AWS Backup
* simplifies the creation, migration, restoration, and deletion of backups, while also providing reporting and
* auditing.
*
*/
@Generated("software.amazon.awssdk:codegen")
public interface BackupClient extends SdkClient {
String SERVICE_NAME = "backup";
/**
* 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();
}
/**
*
* Backup plans are documents that contain information that AWS Backup uses to schedule tasks that create recovery
* points of resources.
*
*
* If you call CreateBackupPlan with a plan that already exists, the existing backupPlanId
* is returned.
*
*
* @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();
}
/**
*
* Backup plans are documents that contain information that AWS Backup uses to schedule tasks that create recovery
* points of resources.
*
*
* If you call CreateBackupPlan with a plan that already exists, the existing backupPlanId
* is returned.
*
*
*
* 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 CreateBackupPlanInput.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. Resources can be included
* by specifying patterns for a ListOfTags and selected Resources.
*
*
* For example, consider the following patterns:
*
*
* -
*
* Resources: "arn:aws:ec2:region:account-id:volume/volume-id"
*
*
* -
*
* ConditionKey:"department"
*
*
* ConditionValue:"finance"
*
*
* ConditionType:"StringEquals"
*
*
* -
*
* ConditionKey:"importance"
*
*
* ConditionValue:"critical"
*
*
* ConditionType:"StringEquals"
*
*
*
*
* Using these patterns would back up all Amazon Elastic Block Store (Amazon EBS) volumes that are tagged as
* "department=finance", "importance=critical", in addition to an EBS volume with the
* specified volume Id.
*
*
* Resources and conditions are additive in that all resources that match the pattern are selected. This shouldn't
* be confused with a logical AND, where all conditions must match. The matching patterns are logically 'put
* together using the OR operator. In other words, all patterns that match are selected for backup.
*
*
* @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. Resources can be included
* by specifying patterns for a ListOfTags and selected Resources.
*
*
* For example, consider the following patterns:
*
*
* -
*
* Resources: "arn:aws:ec2:region:account-id:volume/volume-id"
*
*
* -
*
* ConditionKey:"department"
*
*
* ConditionValue:"finance"
*
*
* ConditionType:"StringEquals"
*
*
* -
*
* ConditionKey:"importance"
*
*
* ConditionValue:"critical"
*
*
* ConditionType:"StringEquals"
*
*
*
*
* Using these patterns would back up all Amazon Elastic Block Store (Amazon EBS) volumes that are tagged as
* "department=finance", "importance=critical", in addition to an EBS volume with the
* specified volume Id.
*
*
* Resources and conditions are additive in that all resources that match the pattern are selected. This shouldn't
* be confused with a logical AND, where all conditions must match. The matching patterns are logically 'put
* together using the OR operator. In other words, all patterns that match are selected for backup.
*
*
*
* 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 CreateBackupSelectionInput.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.
*
*
*
* Sensitive data, such as passport numbers, should not be included 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.
*
*
*
* Sensitive data, such as passport numbers, should not be included 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 CreateBackupVaultInput.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());
}
/**
*
* 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 DeleteBackupPlanInput.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 DeleteBackupSelectionInput.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 DeleteBackupVaultInput.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 DeleteBackupVaultAccessPolicyInput.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 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 DeleteBackupVaultNotificationsInput.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 recovery point specified by a recovery point ID.
*
*
* @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 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,
ServiceUnavailableException, InvalidRequestException, AwsServiceException, SdkClientException, BackupException {
throw new UnsupportedOperationException();
}
/**
*
* Deletes the recovery point specified by a recovery point ID.
*
*
*
* 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 DeleteRecoveryPointInput.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 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, ServiceUnavailableException, InvalidRequestException,
AwsServiceException, SdkClientException, BackupException {
return deleteRecoveryPoint(DeleteRecoveryPointRequest.builder().applyMutation(deleteRecoveryPointRequest).build());
}
/**
*
* Returns metadata associated with creating a backup of a resource.
*
*
* @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 AWS service or resource returned an error to the AWS 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 metadata associated with creating a backup of a resource.
*
*
*
* 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 DescribeBackupJobInput.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 AWS service or resource returned an error to the AWS 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 DescribeBackupVaultInput.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 information about a saved resource, including the last time it was backed-up, its Amazon Resource Name
* (ARN), and the AWS 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 AWS 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 DescribeProtectedResourceInput.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 DescribeRecoveryPointInput.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 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 AWS service or resource returned an error to the AWS 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 DescribeRestoreJobInput.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 AWS service or resource returned an error to the AWS 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());
}
/**
*
* 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 ExportBackupPlanTemplateInput.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 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 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 GetBackupPlanInput.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 GetBackupPlanFromJSONInput.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 GetBackupPlanFromTemplateInput.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 GetBackupSelectionInput.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 GetBackupVaultAccessPolicyInput.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 GetBackupVaultNotificationsInput.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());
}
/**
*
* Returns two sets of metadata key-value pairs. The first set lists the metadata that the recovery point was
* created with. The second set lists the metadata key-value pairs that are required to restore the recovery point.
*
*
* These sets can be the same, or the restore metadata set can contain different values if the target service to be
* restored has changed since the recovery point was created and now requires additional or different information in
* order to be restored.
*
*
* @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 two sets of metadata key-value pairs. The first set lists the metadata that the recovery point was
* created with. The second set lists the metadata key-value pairs that are required to restore the recovery point.
*
*
* These sets can be the same, or the restore metadata set can contain different values if the target service to be
* restored has changed since the recovery point was created and now requires additional or different information in
* order to be restored.
*
*
*
* 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 GetRecoveryPointRestoreMetadataInput.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());
}
/**
*
* Returns the AWS resource types supported by AWS 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 AWS resource types supported by AWS 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 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());
}
/**
*
* Returns metadata about your backup jobs.
*
*
* @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());
}
/**
*
* Returns metadata about your backup jobs.
*
*
* @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 metadata about your backup jobs.
*
*
*
* 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 ListBackupJobsInput.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 metadata about your backup jobs.
*
*
*
* 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(....);
* }
*
*
* 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());
}
/**
*
* Returns metadata about your backup jobs.
*
*
*
* 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(....);
* }
*
*
* 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 {
throw new UnsupportedOperationException();
}
/**
*
* Returns metadata about your backup jobs.
*
*
*
* 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(....);
* }
*
*
* 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 ListBackupJobsInput.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());
}
/**
*
* Returns metadata of your saved backup plan templates, including the template ID, name, and the creation and
* deletion dates.
*
*
* @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());
}
/**
*
* Returns metadata of your saved backup plan templates, including the template ID, name, and the creation and
* deletion dates.
*
*
* @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();
}
/**
*
* Returns metadata of your saved backup plan templates, including the template ID, name, and the creation and
* deletion dates.
*
*
*
* 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 ListBackupPlanTemplatesInput.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());
}
/**
*
* Returns metadata of your saved backup plan templates, including the template ID, name, and the creation and
* deletion dates.
*
*
*
* 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(....);
* }
*
*
* 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());
}
/**
*
* Returns metadata of your saved backup plan templates, including the template ID, name, and the creation and
* deletion dates.
*
*
*
* 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(....);
* }
*
*
* 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 {
throw new UnsupportedOperationException();
}
/**
*
* Returns metadata of your saved backup plan templates, including the template ID, name, and the creation and
* deletion dates.
*
*
*
* 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(....);
* }
*
*
* 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 ListBackupPlanTemplatesInput.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 ListBackupPlanVersionsInput.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());
}
/**
*
* 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 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(....);
* }
*
*
* 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 {
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 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(....);
* }
*
*
* 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 ListBackupPlanVersionsInput.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());
}
/**
*
* Returns metadata of your saved backup plans, including Amazon Resource Names (ARNs), plan IDs, creation and
* deletion dates, version IDs, plan names, and creator request IDs.
*
*
* @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());
}
/**
*
* Returns metadata of your saved backup plans, including Amazon Resource Names (ARNs), plan IDs, creation and
* deletion dates, version IDs, plan names, and creator request IDs.
*
*
* @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();
}
/**
*
* Returns metadata of your saved backup plans, including Amazon Resource Names (ARNs), plan IDs, creation and
* deletion dates, version IDs, plan names, and creator request IDs.
*
*
*
* 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 ListBackupPlansInput.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());
}
/**
*
* Returns metadata of your saved backup plans, including Amazon Resource Names (ARNs), plan IDs, creation and
* deletion dates, version IDs, plan names, and creator request IDs.
*
*
*
* 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(....);
* }
*
*
* 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());
}
/**
*
* Returns metadata of your saved backup plans, including Amazon Resource Names (ARNs), plan IDs, creation and
* deletion dates, version IDs, plan names, and creator request IDs.
*
*
*
* 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(....);
* }
*
*
* 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 {
throw new UnsupportedOperationException();
}
/**
*
* Returns metadata of your saved backup plans, including Amazon Resource Names (ARNs), plan IDs, creation and
* deletion dates, version IDs, plan names, and creator request IDs.
*
*
*
* 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(....);
* }
*
*
* 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 ListBackupPlansInput.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 ListBackupSelectionsInput.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());
}
/**
*
* Returns an array containing metadata of the resources associated with the target backup plan.
*
*
*
* 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(....);
* }
*
*
* 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 {
throw new UnsupportedOperationException();
}
/**
*
* Returns an array containing metadata of the resources associated with the target backup plan.
*
*
*
* 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(....);
* }
*
*
* 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 ListBackupSelectionsInput.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.
*
*
* @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());
}
/**
*
* 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 ListBackupVaultsInput.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.
*
*
*
* 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(....);
* }
*
*
* 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());
}
/**
*
* Returns a list of recovery point storage containers along with information about them.
*
*
*
* 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(....);
* }
*
*
* 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 {
throw new UnsupportedOperationException();
}
/**
*
* Returns a list of recovery point storage containers along with information about them.
*
*
*
* 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(....);
* }
*
*
* 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 ListBackupVaultsInput.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());
}
/**
*
* Returns an array of resources successfully backed up by AWS 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());
}
/**
*
* Returns an array of resources successfully backed up by AWS 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 AWS 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 ListProtectedResourcesInput.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 AWS Backup, including the time the resource was saved, an
* Amazon Resource Name (ARN) of the resource, and a resource type.
*
*
*
* 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(....);
* }
*
*
* 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());
}
/**
*
* Returns an array of resources successfully backed up by AWS Backup, including the time the resource was saved, an
* Amazon Resource Name (ARN) of the resource, and a resource type.
*
*
*
* 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(....);
* }
*
*
* 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 {
throw new UnsupportedOperationException();
}
/**
*
* Returns an array of resources successfully backed up by AWS Backup, including the time the resource was saved, an
* Amazon Resource Name (ARN) of the resource, and a resource type.
*
*
*
* 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(....);
* }
*
*
* 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 ListProtectedResourcesInput.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());
}
/**
*
* 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 ListRecoveryPointsByBackupVaultInput.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());
}
/**
*
* Returns detailed information about the recovery points stored in a backup vault.
*
*
*
* 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(....);
* }
*
*
* 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 {
throw new UnsupportedOperationException();
}
/**
*
* Returns detailed information about the recovery points stored in a backup vault.
*
*
*
* 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(....);
* }
*
*
* 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 ListRecoveryPointsByBackupVaultInput.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());
}
/**
*
* Returns detailed information about recovery points of the type specified by a resource Amazon Resource Name
* (ARN).
*
*
* @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();
}
/**
*
* Returns detailed information about recovery points of the type specified by a resource Amazon Resource Name
* (ARN).
*
*
*
* 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 ListRecoveryPointsByResourceInput.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());
}
/**
*
* Returns detailed information about recovery points of the type specified by a resource Amazon Resource Name
* (ARN).
*
*
*
* 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(....);
* }
*
*
* 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 {
throw new UnsupportedOperationException();
}
/**
*
* Returns detailed information about recovery points of the type specified by a resource Amazon Resource Name
* (ARN).
*
*
*
* 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(....);
* }
*
*
* 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 ListRecoveryPointsByResourceInput.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 a list of jobs that AWS Backup initiated to restore a saved resource, including metadata 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());
}
/**
*
* Returns a list of jobs that AWS Backup initiated to restore a saved resource, including metadata 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 AWS Backup initiated to restore a saved resource, including metadata 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 ListRestoreJobsInput.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 AWS Backup initiated to restore a saved resource, including metadata about the
* recovery process.
*
*
*
* 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(....);
* }
*
*
* 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());
}
/**
*
* Returns a list of jobs that AWS Backup initiated to restore a saved resource, including metadata about the
* recovery process.
*
*
*
* 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(....);
* }
*
*
* 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 {
throw new UnsupportedOperationException();
}
/**
*
* Returns a list of jobs that AWS Backup initiated to restore a saved resource, including metadata about the
* recovery process.
*
*
*
* 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(....);
* }
*
*
* 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 ListRestoreJobsInput.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());
}
/**
*
* Returns a list of key-value pairs assigned to 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 a list of key-value pairs assigned to 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 ListTagsInput.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());
}
/**
*
* Returns a list of key-value pairs assigned to a target recovery point, backup plan, or backup vault.
*
*
*
* 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(....);
* }
*
*
* 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 {
throw new UnsupportedOperationException();
}
/**
*
* Returns a list of key-value pairs assigned to a target recovery point, backup plan, or backup vault.
*
*
*
* 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(....);
* }
*
*
* 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 ListTagsInput.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 PutBackupVaultAccessPolicyInput.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());
}
/**
*
* 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 PutBackupVaultNotificationsInput.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());
}
/**
*
* Starts a job to create a one-time backup of 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 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, ServiceUnavailableException, LimitExceededException,
AwsServiceException, SdkClientException, BackupException {
throw new UnsupportedOperationException();
}
/**
*
* Starts a job to create a one-time backup of 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 StartBackupJobInput.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 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,
ServiceUnavailableException, LimitExceededException, AwsServiceException, SdkClientException, BackupException {
return startBackupJob(StartBackupJobRequest.builder().applyMutation(startBackupJobRequest).build());
}
/**
*
* Recovers the saved resource identified by an Amazon Resource Name (ARN).
*
*
* If the resource ARN is included in the request, then the last complete backup of that resource is recovered. If
* the ARN of a recovery point is supplied, then that recovery point is restored.
*
*
* @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 SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used 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, AwsServiceException, SdkClientException, BackupException {
throw new UnsupportedOperationException();
}
/**
*
* Recovers the saved resource identified by an Amazon Resource Name (ARN).
*
*
* If the resource ARN is included in the request, then the last complete backup of that resource is recovered. If
* the ARN of a recovery point is supplied, then that recovery point is restored.
*
*
*
* 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 StartRestoreJobInput.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 SdkException
* Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used 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, AwsServiceException, SdkClientException, BackupException {
return startRestoreJob(StartRestoreJobRequest.builder().applyMutation(startRestoreJobRequest).build());
}
/**
*
* Attempts to cancel a job to create a one-time backup of a resource.
*
*
* @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 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 StopBackupJobInput.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).
*
*
* @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 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 TagResourceInput.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)
*
*
* @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 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 UntagResourceInput.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());
}
/**
*
* Replaces the body of a saved backup plan identified by its backupPlanId with the input document in
* JSON format. The new version is uniquely identified by a VersionId.
*
*
* @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();
}
/**
*
* Replaces the body of a saved backup plan identified by its backupPlanId with the input document in
* JSON format. The new version is uniquely identified by a VersionId.
*
*
*
* 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 UpdateBackupPlanInput.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());
}
/**
*
* Sets the transition lifecycle of a recovery point.
*
*
* The lifecycle defines when a protected resource is transitioned to cold storage and when it expires. AWS Backup
* transitions and expires backups automatically according to the lifecycle that you define.
*
*
* Backups transitioned to cold storage must be stored in cold storage for a minimum of 90 days. Therefore, the
* “expire after days” 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.
*
*
* @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 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, 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. AWS Backup
* transitions and expires backups automatically according to the lifecycle that you define.
*
*
* Backups transitioned to cold storage must be stored in cold storage for a minimum of 90 days. Therefore, the
* “expire after days” 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.
*
*
*
* 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 UpdateRecoveryPointLifecycleInput.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 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, MissingParameterValueException,
ServiceUnavailableException, AwsServiceException, SdkClientException, BackupException {
return updateRecoveryPointLifecycle(UpdateRecoveryPointLifecycleRequest.builder()
.applyMutation(updateRecoveryPointLifecycleRequest).build());
}
static ServiceMetadata serviceMetadata() {
return ServiceMetadata.of("backup");
}
}