AWSBackupClient (AWS SDK for Java

java.lang.Object
- com.amazonaws.AmazonWebServiceClient
- - com.amazonaws.services.backup.AWSBackupClient

All Implemented Interfaces:

AWSBackup

Direct Known Subclasses:

AWSBackupAsyncClient
```
@ThreadSafe
 @Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class AWSBackupClient
extends AmazonWebServiceClient
implements AWSBackup
```
Client for accessing AWS Backup. All service calls made using this client are blocking, and will not return until the service call completes.
Backup
Backup is a unified backup service designed to protect Amazon Web Services services and their associated data. Backup simplifies the creation, migration, restoration, and deletion of backups, while also providing reporting and auditing.

Field Summary
- Fields inherited from class com.amazonaws.AmazonWebServiceClient
  LOGGING_AWS_REQUEST_METRIC
- Fields inherited from interface com.amazonaws.services.backup.AWSBackup
  ENDPOINT_PREFIX

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static AWSBackupClientBuilder`	`builder()`
`CreateBackupPlanResult`	`createBackupPlan(CreateBackupPlanRequest request)` Creates a backup plan using a backup plan name and backup rules.
`CreateBackupSelectionResult`	`createBackupSelection(CreateBackupSelectionRequest request)` Creates a JSON document that specifies a set of resources to assign to a backup plan.
`CreateBackupVaultResult`	`createBackupVault(CreateBackupVaultRequest request)` Creates a logical container where backups are stored.
`CreateFrameworkResult`	`createFramework(CreateFrameworkRequest request)` Creates a framework with one or more controls.
`CreateReportPlanResult`	`createReportPlan(CreateReportPlanRequest request)` Creates a report plan.
`DeleteBackupPlanResult`	`deleteBackupPlan(DeleteBackupPlanRequest request)` Deletes a backup plan.
`DeleteBackupSelectionResult`	`deleteBackupSelection(DeleteBackupSelectionRequest request)` Deletes the resource selection associated with a backup plan that is specified by the `SelectionId`.
`DeleteBackupVaultResult`	`deleteBackupVault(DeleteBackupVaultRequest request)` Deletes the backup vault identified by its name.
`DeleteBackupVaultAccessPolicyResult`	`deleteBackupVaultAccessPolicy(DeleteBackupVaultAccessPolicyRequest request)` Deletes the policy document that manages permissions on a backup vault.
`DeleteBackupVaultLockConfigurationResult`	`deleteBackupVaultLockConfiguration(DeleteBackupVaultLockConfigurationRequest request)` Deletes Backup Vault Lock from a backup vault specified by a backup vault name.
`DeleteBackupVaultNotificationsResult`	`deleteBackupVaultNotifications(DeleteBackupVaultNotificationsRequest request)` Deletes event notifications for the specified backup vault.
`DeleteFrameworkResult`	`deleteFramework(DeleteFrameworkRequest request)` Deletes the framework specified by a framework name.
`DeleteRecoveryPointResult`	`deleteRecoveryPoint(DeleteRecoveryPointRequest request)` Deletes the recovery point specified by a recovery point ID.
`DeleteReportPlanResult`	`deleteReportPlan(DeleteReportPlanRequest request)` Deletes the report plan specified by a report plan name.
`DescribeBackupJobResult`	`describeBackupJob(DescribeBackupJobRequest request)` Returns backup job details for the specified `BackupJobId`.
`DescribeBackupVaultResult`	`describeBackupVault(DescribeBackupVaultRequest request)` Returns metadata about a backup vault specified by its name.
`DescribeCopyJobResult`	`describeCopyJob(DescribeCopyJobRequest request)` Returns metadata associated with creating a copy of a resource.
`DescribeFrameworkResult`	`describeFramework(DescribeFrameworkRequest request)` Returns the framework details for the specified `FrameworkName`.
`DescribeGlobalSettingsResult`	`describeGlobalSettings(DescribeGlobalSettingsRequest request)` Describes whether the Amazon Web Services account is opted in to cross-account backup.
`DescribeProtectedResourceResult`	`describeProtectedResource(DescribeProtectedResourceRequest request)` Returns information about a saved resource, including the last time it was backed up, its Amazon Resource Name (ARN), and the Amazon Web Services service type of the saved resource.
`DescribeRecoveryPointResult`	`describeRecoveryPoint(DescribeRecoveryPointRequest request)` Returns metadata associated with a recovery point, including ID, status, encryption, and lifecycle.
`DescribeRegionSettingsResult`	`describeRegionSettings(DescribeRegionSettingsRequest request)` Returns the current service opt-in settings for the Region.
`DescribeReportJobResult`	`describeReportJob(DescribeReportJobRequest request)` Returns the details associated with creating a report as specified by its `ReportJobId`.
`DescribeReportPlanResult`	`describeReportPlan(DescribeReportPlanRequest request)` Returns a list of all report plans for an Amazon Web Services account and Amazon Web Services Region.
`DescribeRestoreJobResult`	`describeRestoreJob(DescribeRestoreJobRequest request)` Returns metadata associated with a restore job that is specified by a job ID.
`DisassociateRecoveryPointResult`	`disassociateRecoveryPoint(DisassociateRecoveryPointRequest request)` Deletes the specified continuous backup recovery point from Backup and releases control of that continuous backup to the source service, such as Amazon RDS.
`ExportBackupPlanTemplateResult`	`exportBackupPlanTemplate(ExportBackupPlanTemplateRequest request)` Returns the backup plan that is specified by the plan ID as a backup template.
`GetBackupPlanResult`	`getBackupPlan(GetBackupPlanRequest request)` Returns `BackupPlan` details for the specified `BackupPlanId`.
`GetBackupPlanFromJSONResult`	`getBackupPlanFromJSON(GetBackupPlanFromJSONRequest request)` Returns a valid JSON document specifying a backup plan or an error.
`GetBackupPlanFromTemplateResult`	`getBackupPlanFromTemplate(GetBackupPlanFromTemplateRequest request)` Returns the template specified by its `templateId` as a backup plan.
`GetBackupSelectionResult`	`getBackupSelection(GetBackupSelectionRequest request)` Returns selection metadata and a document in JSON format that specifies a list of resources that are associated with a backup plan.
`GetBackupVaultAccessPolicyResult`	`getBackupVaultAccessPolicy(GetBackupVaultAccessPolicyRequest request)` Returns the access policy document that is associated with the named backup vault.
`GetBackupVaultNotificationsResult`	`getBackupVaultNotifications(GetBackupVaultNotificationsRequest request)` Returns event notifications for the specified backup vault.
`ResponseMetadata`	`getCachedResponseMetadata(AmazonWebServiceRequest request)` Returns additional metadata for a previously executed successful, request, typically used for debugging issues where a service isn't acting as expected.
`GetRecoveryPointRestoreMetadataResult`	`getRecoveryPointRestoreMetadata(GetRecoveryPointRestoreMetadataRequest request)` Returns a set of metadata key-value pairs that were used to create the backup.
`GetSupportedResourceTypesResult`	`getSupportedResourceTypes(GetSupportedResourceTypesRequest request)` Returns the Amazon Web Services resource types supported by Backup.
`ListBackupJobsResult`	`listBackupJobs(ListBackupJobsRequest request)` Returns a list of existing backup jobs for an authenticated account for the last 30 days.
`ListBackupPlansResult`	`listBackupPlans(ListBackupPlansRequest request)` Returns a list of all active backup plans for an authenticated account.
`ListBackupPlanTemplatesResult`	`listBackupPlanTemplates(ListBackupPlanTemplatesRequest request)` Returns metadata of your saved backup plan templates, including the template ID, name, and the creation and deletion dates.
`ListBackupPlanVersionsResult`	`listBackupPlanVersions(ListBackupPlanVersionsRequest request)` Returns version metadata of your backup plans, including Amazon Resource Names (ARNs), backup plan IDs, creation and deletion dates, plan names, and version IDs.
`ListBackupSelectionsResult`	`listBackupSelections(ListBackupSelectionsRequest request)` Returns an array containing metadata of the resources associated with the target backup plan.
`ListBackupVaultsResult`	`listBackupVaults(ListBackupVaultsRequest request)` Returns a list of recovery point storage containers along with information about them.
`ListCopyJobsResult`	`listCopyJobs(ListCopyJobsRequest request)` Returns metadata about your copy jobs.
`ListFrameworksResult`	`listFrameworks(ListFrameworksRequest request)` Returns a list of all frameworks for an Amazon Web Services account and Amazon Web Services Region.
`ListProtectedResourcesResult`	`listProtectedResources(ListProtectedResourcesRequest request)` Returns an array of resources successfully backed up by Backup, including the time the resource was saved, an Amazon Resource Name (ARN) of the resource, and a resource type.
`ListRecoveryPointsByBackupVaultResult`	`listRecoveryPointsByBackupVault(ListRecoveryPointsByBackupVaultRequest request)` Returns detailed information about the recovery points stored in a backup vault.
`ListRecoveryPointsByResourceResult`	`listRecoveryPointsByResource(ListRecoveryPointsByResourceRequest request)` Returns detailed information about all the recovery points of the type specified by a resource Amazon Resource Name (ARN).
`ListReportJobsResult`	`listReportJobs(ListReportJobsRequest request)` Returns details about your report jobs.
`ListReportPlansResult`	`listReportPlans(ListReportPlansRequest request)` Returns a list of your report plans.
`ListRestoreJobsResult`	`listRestoreJobs(ListRestoreJobsRequest request)` Returns a list of jobs that Backup initiated to restore a saved resource, including details about the recovery process.
`ListTagsResult`	`listTags(ListTagsRequest request)` Returns a list of key-value pairs assigned to a target recovery point, backup plan, or backup vault.
`PutBackupVaultAccessPolicyResult`	`putBackupVaultAccessPolicy(PutBackupVaultAccessPolicyRequest request)` Sets a resource-based policy that is used to manage access permissions on the target backup vault.
`PutBackupVaultLockConfigurationResult`	`putBackupVaultLockConfiguration(PutBackupVaultLockConfigurationRequest request)` Applies Backup Vault Lock to a backup vault, preventing attempts to delete any recovery point stored in or created in a backup vault.
`PutBackupVaultNotificationsResult`	`putBackupVaultNotifications(PutBackupVaultNotificationsRequest request)` Turns on notifications on a backup vault for the specified topic and events.
`void`	`shutdown()` Shuts down this client object, releasing any resources that might be held open.
`StartBackupJobResult`	`startBackupJob(StartBackupJobRequest request)` Starts an on-demand backup job for the specified resource.
`StartCopyJobResult`	`startCopyJob(StartCopyJobRequest request)` Starts a job to create a one-time copy of the specified resource.
`StartReportJobResult`	`startReportJob(StartReportJobRequest request)` Starts an on-demand report job for the specified report plan.
`StartRestoreJobResult`	`startRestoreJob(StartRestoreJobRequest request)` Recovers the saved resource identified by an Amazon Resource Name (ARN).
`StopBackupJobResult`	`stopBackupJob(StopBackupJobRequest request)` Attempts to cancel a job to create a one-time backup of a resource.
`TagResourceResult`	`tagResource(TagResourceRequest request)` Assigns a set of key-value pairs to a recovery point, backup plan, or backup vault identified by an Amazon Resource Name (ARN).
`UntagResourceResult`	`untagResource(UntagResourceRequest request)` Removes a set of key-value pairs from a recovery point, backup plan, or backup vault identified by an Amazon Resource Name (ARN)
`UpdateBackupPlanResult`	`updateBackupPlan(UpdateBackupPlanRequest request)` Updates an existing backup plan identified by its `backupPlanId` with the input document in JSON format.
`UpdateFrameworkResult`	`updateFramework(UpdateFrameworkRequest request)` Updates an existing framework identified by its `FrameworkName` with the input document in JSON format.
`UpdateGlobalSettingsResult`	`updateGlobalSettings(UpdateGlobalSettingsRequest request)` Updates whether the Amazon Web Services account is opted in to cross-account backup.
`UpdateRecoveryPointLifecycleResult`	`updateRecoveryPointLifecycle(UpdateRecoveryPointLifecycleRequest request)` Sets the transition lifecycle of a recovery point.
`UpdateRegionSettingsResult`	`updateRegionSettings(UpdateRegionSettingsRequest request)` Updates the current service opt-in settings for the Region.
`UpdateReportPlanResult`	`updateReportPlan(UpdateReportPlanRequest request)` Updates an existing report plan identified by its `ReportPlanName` with the input document in JSON format.

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Method Detail
  - builder
```
public static AWSBackupClientBuilder builder()
```
  - createBackupPlan
```
public CreateBackupPlanResult createBackupPlan(CreateBackupPlanRequest request)
```
    Creates a backup plan using a backup plan name and backup rules. A backup plan is a document that contains information that Backup uses to schedule tasks that create recovery points for resources.
    
    If you call CreateBackupPlan with a plan that already exists, you receive an AlreadyExistsException exception.
    
    Specified by:
    
    createBackupPlan in interface AWSBackup
    
    Parameters:
    
    createBackupPlanRequest -
    
    Returns:
    
    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.
    
    AlreadyExistsException - The required resource already exists.
    
    InvalidParameterValueException - Indicates that something is wrong with a parameter's value. For example, the value is out of range.
    
    MissingParameterValueException - Indicates that a required parameter is missing.
    
    ServiceUnavailableException - The request failed due to a temporary failure of the server.
    
    See Also:
    
    AWS API Documentation
  - createBackupSelection
```
public CreateBackupSelectionResult createBackupSelection(CreateBackupSelectionRequest request)
```
    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.
    Specified by:
    
    createBackupSelection in interface AWSBackup
    
    Parameters:
    
    createBackupSelectionRequest -
    
    Returns:
    
    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.
    
    AlreadyExistsException - The required resource already exists.
    
    InvalidParameterValueException - Indicates that something is wrong with a parameter's value. For example, the value is out of range.
    
    MissingParameterValueException - Indicates that a required parameter is missing.
    
    ServiceUnavailableException - The request failed due to a temporary failure of the server.
    
    See Also:
    
    AWS API Documentation
  - createBackupVault
```
public CreateBackupVaultResult createBackupVault(CreateBackupVaultRequest request)
```
    Creates a logical container where backups are stored. A CreateBackupVault request includes a name, optionally one or more resource tags, an encryption key, and a request ID.
    
    Do not include sensitive data, such as passport numbers, in the name of a backup vault.
    
    Specified by:
    
    createBackupVault in interface AWSBackup
    
    Parameters:
    
    createBackupVaultRequest -
    
    Returns:
    
    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.
    
    MissingParameterValueException - Indicates that a required parameter is missing.
    
    ServiceUnavailableException - The request failed due to a temporary failure of the server.
    
    LimitExceededException - A limit in the request has been exceeded; for example, a maximum number of items allowed in a request.
    
    AlreadyExistsException - The required resource already exists.
    
    See Also:
    
    AWS API Documentation
  - createFramework
```
public CreateFrameworkResult createFramework(CreateFrameworkRequest request)
```
    Creates a framework with one or more controls. A framework is a collection of controls that you can use to evaluate your backup practices. By using pre-built customizable controls to define your policies, you can evaluate whether your backup practices comply with your policies and which resources are not yet in compliance.
    
    Specified by:
    
    createFramework in interface AWSBackup
    
    Parameters:
    
    createFrameworkRequest -
    
    Returns:
    
    Result of the CreateFramework operation returned by the service.
    
    Throws:
    
    AlreadyExistsException - The required resource already exists.
    
    LimitExceededException - A limit in the request has been exceeded; for example, a maximum number of items allowed in a request.
    
    InvalidParameterValueException - Indicates that something is wrong with a parameter's value. For example, the value is out of range.
    
    MissingParameterValueException - Indicates that a required parameter is missing.
    
    ServiceUnavailableException - The request failed due to a temporary failure of the server.
    
    See Also:
    
    AWS API Documentation
  - createReportPlan
```
public CreateReportPlanResult createReportPlan(CreateReportPlanRequest request)
```
    Creates a report plan. A report plan is a document that contains information about the contents of the report and where Backup will deliver it.
    
    If you call CreateReportPlan with a plan that already exists, you receive an AlreadyExistsException exception.
    
    Specified by:
    
    createReportPlan in interface AWSBackup
    
    Parameters:
    
    createReportPlanRequest -
    
    Returns:
    
    Result of the CreateReportPlan operation returned by the service.
    
    Throws:
    
    AlreadyExistsException - The required resource already exists.
    
    LimitExceededException - A limit in the request has been exceeded; for example, a maximum number of items allowed in a request.
    
    InvalidParameterValueException - Indicates that something is wrong with a parameter's value. For example, the value is out of range.
    
    ServiceUnavailableException - The request failed due to a temporary failure of the server.
    
    MissingParameterValueException - Indicates that a required parameter is missing.
    
    See Also:
    
    AWS API Documentation
  - deleteBackupPlan
```
public DeleteBackupPlanResult deleteBackupPlan(DeleteBackupPlanRequest request)
```
    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.
    
    Specified by:
    
    deleteBackupPlan in interface AWSBackup
    
    Parameters:
    
    deleteBackupPlanRequest -
    
    Returns:
    
    Result of the DeleteBackupPlan operation returned by the service.
    
    Throws:
    
    ResourceNotFoundException - A resource that is required for the action doesn't exist.
    
    InvalidParameterValueException - Indicates that something is wrong with a parameter's value. For example, the value is out of range.
    
    MissingParameterValueException - Indicates that a required parameter is missing.
    
    ServiceUnavailableException - The request failed due to a temporary failure of the server.
    
    InvalidRequestException - Indicates that something is wrong with the input to the request. For example, a parameter is of the wrong type.
    
    See Also:
    
    AWS API Documentation
  - deleteBackupSelection
```
public DeleteBackupSelectionResult deleteBackupSelection(DeleteBackupSelectionRequest request)
```
    Deletes the resource selection associated with a backup plan that is specified by the SelectionId.
    
    Specified by:
    
    deleteBackupSelection in interface AWSBackup
    
    Parameters:
    
    deleteBackupSelectionRequest -
    
    Returns:
    
    Result of the DeleteBackupSelection operation returned by the service.
    
    Throws:
    
    ResourceNotFoundException - A resource that is required for the action doesn't exist.
    
    InvalidParameterValueException - Indicates that something is wrong with a parameter's value. For example, the value is out of range.
    
    MissingParameterValueException - Indicates that a required parameter is missing.
    
    ServiceUnavailableException - The request failed due to a temporary failure of the server.
    
    See Also:
    
    AWS API Documentation
  - deleteBackupVault
```
public DeleteBackupVaultResult deleteBackupVault(DeleteBackupVaultRequest request)
```
    Deletes the backup vault identified by its name. A vault can be deleted only if it is empty.
    
    Specified by:
    
    deleteBackupVault in interface AWSBackup
    
    Parameters:
    
    deleteBackupVaultRequest -
    
    Returns:
    
    Result of the DeleteBackupVault operation returned by the service.
    
    Throws:
    
    ResourceNotFoundException - A resource that is required for the action doesn't exist.
    
    InvalidParameterValueException - Indicates that something is wrong with a parameter's value. For example, the value is out of range.
    
    MissingParameterValueException - Indicates that a required parameter is missing.
    
    ServiceUnavailableException - The request failed due to a temporary failure of the server.
    
    InvalidRequestException - Indicates that something is wrong with the input to the request. For example, a parameter is of the wrong type.
    
    See Also:
    
    AWS API Documentation
  - deleteBackupVaultAccessPolicy
```
public DeleteBackupVaultAccessPolicyResult deleteBackupVaultAccessPolicy(DeleteBackupVaultAccessPolicyRequest request)
```
    Deletes the policy document that manages permissions on a backup vault.
    
    Specified by:
    
    deleteBackupVaultAccessPolicy in interface AWSBackup
    
    Parameters:
    
    deleteBackupVaultAccessPolicyRequest -
    
    Returns:
    
    Result of the DeleteBackupVaultAccessPolicy operation returned by the service.
    
    Throws:
    
    ResourceNotFoundException - A resource that is required for the action doesn't exist.
    
    InvalidParameterValueException - Indicates that something is wrong with a parameter's value. For example, the value is out of range.
    
    MissingParameterValueException - Indicates that a required parameter is missing.
    
    ServiceUnavailableException - The request failed due to a temporary failure of the server.
    
    See Also:
    
    AWS API Documentation
  - deleteBackupVaultLockConfiguration
```
public DeleteBackupVaultLockConfigurationResult deleteBackupVaultLockConfiguration(DeleteBackupVaultLockConfigurationRequest request)
```
    Deletes Backup Vault Lock from a backup vault specified by a backup vault name.
    
    If the Vault Lock configuration is immutable, then you cannot delete Vault Lock using API operations, and you will receive an InvalidRequestException if you attempt to do so. For more information, see Vault Lock in the Backup Developer Guide.
    
    Specified by:
    
    deleteBackupVaultLockConfiguration in interface AWSBackup
    
    Parameters:
    
    deleteBackupVaultLockConfigurationRequest -
    
    Returns:
    
    Result of the DeleteBackupVaultLockConfiguration operation returned by the service.
    
    Throws:
    
    ResourceNotFoundException - A resource that is required for the action doesn't exist.
    
    InvalidParameterValueException - Indicates that something is wrong with a parameter's value. For example, the value is out of range.
    
    MissingParameterValueException - Indicates that a required parameter is missing.
    
    InvalidRequestException - Indicates that something is wrong with the input to the request. For example, a parameter is of the wrong type.
    
    ServiceUnavailableException - The request failed due to a temporary failure of the server.
    
    See Also:
    
    AWS API Documentation
  - deleteBackupVaultNotifications
```
public DeleteBackupVaultNotificationsResult deleteBackupVaultNotifications(DeleteBackupVaultNotificationsRequest request)
```
    Deletes event notifications for the specified backup vault.
    
    Specified by:
    
    deleteBackupVaultNotifications in interface AWSBackup
    
    Parameters:
    
    deleteBackupVaultNotificationsRequest -
    
    Returns:
    
    Result of the DeleteBackupVaultNotifications operation returned by the service.
    
    Throws:
    
    ResourceNotFoundException - A resource that is required for the action doesn't exist.
    
    InvalidParameterValueException - Indicates that something is wrong with a parameter's value. For example, the value is out of range.
    
    MissingParameterValueException - Indicates that a required parameter is missing.
    
    ServiceUnavailableException - The request failed due to a temporary failure of the server.
    
    See Also:
    
    AWS API Documentation
  - deleteFramework
```
public DeleteFrameworkResult deleteFramework(DeleteFrameworkRequest request)
```
    Deletes the framework specified by a framework name.
    
    Specified by:
    
    deleteFramework in interface AWSBackup
    
    Parameters:
    
    deleteFrameworkRequest -
    
    Returns:
    
    Result of the DeleteFramework operation returned by the service.
    
    Throws:
    
    MissingParameterValueException - Indicates that a required parameter is missing.
    
    InvalidParameterValueException - Indicates that something is wrong with a parameter's value. For example, the value is out of range.
    
    ServiceUnavailableException - The request failed due to a temporary failure of the server.
    
    ConflictException - Backup can't perform the action that you requested until it finishes performing a previous action. Try again later.
    
    ResourceNotFoundException - A resource that is required for the action doesn't exist.
    
    See Also:
    
    AWS API Documentation
  - deleteRecoveryPoint
```
public DeleteRecoveryPointResult deleteRecoveryPoint(DeleteRecoveryPointRequest request)
```
    Deletes the recovery point specified by a recovery point ID.
    
    If the recovery point ID belongs to a continuous backup, calling this endpoint deletes the existing continuous backup and stops future continuous backup.
    
    Specified by:
    
    deleteRecoveryPoint in interface AWSBackup
    
    Parameters:
    
    deleteRecoveryPointRequest -
    
    Returns:
    
    Result of the DeleteRecoveryPoint operation returned by the service.
    
    Throws:
    
    ResourceNotFoundException - A resource that is required for the action doesn't exist.
    
    InvalidParameterValueException - Indicates that something is wrong with a parameter's value. For example, the value is out of range.
    
    MissingParameterValueException - Indicates that a required parameter is missing.
    
    InvalidResourceStateException - Backup is already performing an action on this recovery point. It can't perform the action you requested until the first action finishes. Try again later.
    
    ServiceUnavailableException - The request failed due to a temporary failure of the server.
    
    InvalidRequestException - Indicates that something is wrong with the input to the request. For example, a parameter is of the wrong type.
    
    See Also:
    
    AWS API Documentation
  - deleteReportPlan
```
public DeleteReportPlanResult deleteReportPlan(DeleteReportPlanRequest request)
```
    Deletes the report plan specified by a report plan name.
    
    Specified by:
    
    deleteReportPlan in interface AWSBackup
    
    Parameters:
    
    deleteReportPlanRequest -
    
    Returns:
    
    Result of the DeleteReportPlan operation returned by the service.
    
    Throws:
    
    MissingParameterValueException - Indicates that a required parameter is missing.
    
    InvalidParameterValueException - Indicates that something is wrong with a parameter's value. For example, the value is out of range.
    
    ConflictException - Backup can't perform the action that you requested until it finishes performing a previous action. Try again later.
    
    ServiceUnavailableException - The request failed due to a temporary failure of the server.
    
    ResourceNotFoundException - A resource that is required for the action doesn't exist.
    
    See Also:
    
    AWS API Documentation
  - describeBackupJob
```
public DescribeBackupJobResult describeBackupJob(DescribeBackupJobRequest request)
```
    Returns backup job details for the specified BackupJobId.
    
    Specified by:
    
    describeBackupJob in interface AWSBackup
    
    Parameters:
    
    describeBackupJobRequest -
    
    Returns:
    
    Result of the DescribeBackupJob operation returned by the service.
    
    Throws:
    
    ResourceNotFoundException - A resource that is required for the action doesn't exist.
    
    InvalidParameterValueException - Indicates that something is wrong with a parameter's value. For example, the value is out of range.
    
    MissingParameterValueException - Indicates that a required parameter is missing.
    
    ServiceUnavailableException - The request failed due to a temporary failure of the server.
    
    DependencyFailureException - A dependent Amazon Web Services service or resource returned an error to the Backup service, and the action cannot be completed.
    
    See Also:
    
    AWS API Documentation
  - describeBackupVault
```
public DescribeBackupVaultResult describeBackupVault(DescribeBackupVaultRequest request)
```
    Returns metadata about a backup vault specified by its name.
    
    Specified by:
    
    describeBackupVault in interface AWSBackup
    
    Parameters:
    
    describeBackupVaultRequest -
    
    Returns:
    
    Result of the DescribeBackupVault operation returned by the service.
    
    Throws:
    
    ResourceNotFoundException - A resource that is required for the action doesn't exist.
    
    InvalidParameterValueException - Indicates that something is wrong with a parameter's value. For example, the value is out of range.
    
    MissingParameterValueException - Indicates that a required parameter is missing.
    
    ServiceUnavailableException - The request failed due to a temporary failure of the server.
    
    See Also:
    
    AWS API Documentation
  - describeCopyJob
```
public DescribeCopyJobResult describeCopyJob(DescribeCopyJobRequest request)
```
    Returns metadata associated with creating a copy of a resource.
    
    Specified by:
    
    describeCopyJob in interface AWSBackup
    
    Parameters:
    
    describeCopyJobRequest -
    
    Returns:
    
    Result of the DescribeCopyJob operation returned by the service.
    
    Throws:
    
    ResourceNotFoundException - A resource that is required for the action doesn't exist.
    
    InvalidParameterValueException - Indicates that something is wrong with a parameter's value. For example, the value is out of range.
    
    MissingParameterValueException - Indicates that a required parameter is missing.
    
    ServiceUnavailableException - The request failed due to a temporary failure of the server.
    
    See Also:
    
    AWS API Documentation
  - describeFramework
```
public DescribeFrameworkResult describeFramework(DescribeFrameworkRequest request)
```
    Returns the framework details for the specified FrameworkName.
    
    Specified by:
    
    describeFramework in interface AWSBackup
    
    Parameters:
    
    describeFrameworkRequest -
    
    Returns:
    
    Result of the DescribeFramework operation returned by the service.
    
    Throws:
    
    ResourceNotFoundException - A resource that is required for the action doesn't exist.
    
    InvalidParameterValueException - Indicates that something is wrong with a parameter's value. For example, the value is out of range.
    
    MissingParameterValueException - Indicates that a required parameter is missing.
    
    ServiceUnavailableException - The request failed due to a temporary failure of the server.
    
    See Also:
    
    AWS API Documentation
  - describeGlobalSettings
```
public DescribeGlobalSettingsResult describeGlobalSettings(DescribeGlobalSettingsRequest request)
```
    Describes whether the Amazon Web Services account is opted in to cross-account backup. Returns an error if the account is not a member of an Organizations organization. Example: describe-global-settings --region us-west-2
    
    Specified by:
    
    describeGlobalSettings in interface AWSBackup
    
    Parameters:
    
    describeGlobalSettingsRequest -
    
    Returns:
    
    Result of the DescribeGlobalSettings operation returned by the service.
    
    Throws:
    
    InvalidRequestException - Indicates that something is wrong with the input to the request. For example, a parameter is of the wrong type.
    
    ServiceUnavailableException - The request failed due to a temporary failure of the server.
    
    See Also:
    
    AWS API Documentation
  - describeProtectedResource
```
public DescribeProtectedResourceResult describeProtectedResource(DescribeProtectedResourceRequest request)
```
    Returns information about a saved resource, including the last time it was backed up, its Amazon Resource Name (ARN), and the Amazon Web Services service type of the saved resource.
    
    Specified by:
    
    describeProtectedResource in interface AWSBackup
    
    Parameters:
    
    describeProtectedResourceRequest -
    
    Returns:
    
    Result of the DescribeProtectedResource operation returned by the service.
    
    Throws:
    
    MissingParameterValueException - Indicates that a required parameter is missing.
    
    InvalidParameterValueException - Indicates that something is wrong with a parameter's value. For example, the value is out of range.
    
    ServiceUnavailableException - The request failed due to a temporary failure of the server.
    
    ResourceNotFoundException - A resource that is required for the action doesn't exist.
    
    See Also:
    
    AWS API Documentation
  - describeRecoveryPoint
```
public DescribeRecoveryPointResult describeRecoveryPoint(DescribeRecoveryPointRequest request)
```
    Returns metadata associated with a recovery point, including ID, status, encryption, and lifecycle.
    
    Specified by:
    
    describeRecoveryPoint in interface AWSBackup
    
    Parameters:
    
    describeRecoveryPointRequest -
    
    Returns:
    
    Result of the DescribeRecoveryPoint operation returned by the service.
    
    Throws:
    
    ResourceNotFoundException - A resource that is required for the action doesn't exist.
    
    InvalidParameterValueException - Indicates that something is wrong with a parameter's value. For example, the value is out of range.
    
    MissingParameterValueException - Indicates that a required parameter is missing.
    
    ServiceUnavailableException - The request failed due to a temporary failure of the server.
    
    See Also:
    
    AWS API Documentation
  - describeRegionSettings
```
public DescribeRegionSettingsResult describeRegionSettings(DescribeRegionSettingsRequest request)
```
    Returns the current service opt-in settings for the Region. If service opt-in is enabled for a service, Backup tries to protect that service's resources in this Region, when the resource is included in an on-demand backup or scheduled backup plan. Otherwise, Backup does not try to protect that service's resources in this Region.
    
    Specified by:
    
    describeRegionSettings in interface AWSBackup
    
    Parameters:
    
    describeRegionSettingsRequest -
    
    Returns:
    
    Result of the DescribeRegionSettings operation returned by the service.
    
    Throws:
    
    ServiceUnavailableException - The request failed due to a temporary failure of the server.
    
    See Also:
    
    AWS API Documentation
  - describeReportJob
```
public DescribeReportJobResult describeReportJob(DescribeReportJobRequest request)
```
    Returns the details associated with creating a report as specified by its ReportJobId.
    
    Specified by:
    
    describeReportJob in interface AWSBackup
    
    Parameters:
    
    describeReportJobRequest -
    
    Returns:
    
    Result of the DescribeReportJob operation returned by the service.
    
    Throws:
    
    ServiceUnavailableException - The request failed due to a temporary failure of the server.
    
    MissingParameterValueException - Indicates that a required parameter is missing.
    
    ResourceNotFoundException - A resource that is required for the action doesn't exist.
    
    See Also:
    
    AWS API Documentation
  - describeReportPlan
```
public DescribeReportPlanResult describeReportPlan(DescribeReportPlanRequest request)
```
    Returns a list of all report plans for an Amazon Web Services account and Amazon Web Services Region.
    
    Specified by:
    
    describeReportPlan in interface AWSBackup
    
    Parameters:
    
    describeReportPlanRequest -
    
    Returns:
    
    Result of the DescribeReportPlan operation returned by the service.
    
    Throws:
    
    InvalidParameterValueException - Indicates that something is wrong with a parameter's value. For example, the value is out of range.
    
    MissingParameterValueException - Indicates that a required parameter is missing.
    
    ResourceNotFoundException - A resource that is required for the action doesn't exist.
    
    ServiceUnavailableException - The request failed due to a temporary failure of the server.
    
    See Also:
    
    AWS API Documentation
  - describeRestoreJob
```
public DescribeRestoreJobResult describeRestoreJob(DescribeRestoreJobRequest request)
```
    Returns metadata associated with a restore job that is specified by a job ID.
    
    Specified by:
    
    describeRestoreJob in interface AWSBackup
    
    Parameters:
    
    describeRestoreJobRequest -
    
    Returns:
    
    Result of the DescribeRestoreJob operation returned by the service.
    
    Throws:
    
    ResourceNotFoundException - A resource that is required for the action doesn't exist.
    
    InvalidParameterValueException - Indicates that something is wrong with a parameter's value. For example, the value is out of range.
    
    MissingParameterValueException - Indicates that a required parameter is missing.
    
    ServiceUnavailableException - The request failed due to a temporary failure of the server.
    
    DependencyFailureException - A dependent Amazon Web Services service or resource returned an error to the Backup service, and the action cannot be completed.
    
    See Also:
    
    AWS API Documentation
  - disassociateRecoveryPoint
```
public DisassociateRecoveryPointResult disassociateRecoveryPoint(DisassociateRecoveryPointRequest request)
```
    Deletes the specified continuous backup recovery point from Backup and releases control of that continuous backup to the source service, such as Amazon RDS. The source service will continue to create and retain continuous backups using the lifecycle that you specified in your original backup plan.
    
    Does not support snapshot backup recovery points.
    
    Specified by:
    
    disassociateRecoveryPoint in interface AWSBackup
    
    Parameters:
    
    disassociateRecoveryPointRequest -
    
    Returns:
    
    Result of the DisassociateRecoveryPoint operation returned by the service.
    
    Throws:
    
    ResourceNotFoundException - A resource that is required for the action doesn't exist.
    
    InvalidParameterValueException - Indicates that something is wrong with a parameter's value. For example, the value is out of range.
    
    MissingParameterValueException - Indicates that a required parameter is missing.
    
    InvalidResourceStateException - Backup is already performing an action on this recovery point. It can't perform the action you requested until the first action finishes. Try again later.
    
    ServiceUnavailableException - The request failed due to a temporary failure of the server.
    
    InvalidRequestException - Indicates that something is wrong with the input to the request. For example, a parameter is of the wrong type.
    
    See Also:
    
    AWS API Documentation
  - exportBackupPlanTemplate
```
public ExportBackupPlanTemplateResult exportBackupPlanTemplate(ExportBackupPlanTemplateRequest request)
```
    Returns the backup plan that is specified by the plan ID as a backup template.
    
    Specified by:
    
    exportBackupPlanTemplate in interface AWSBackup
    
    Parameters:
    
    exportBackupPlanTemplateRequest -
    
    Returns:
    
    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.
    
    MissingParameterValueException - Indicates that a required parameter is missing.
    
    ServiceUnavailableException - The request failed due to a temporary failure of the server.
    
    ResourceNotFoundException - A resource that is required for the action doesn't exist.
    
    See Also:
    
    AWS API Documentation
  - getBackupPlan
```
public GetBackupPlanResult getBackupPlan(GetBackupPlanRequest request)
```
    Returns BackupPlan details for the specified BackupPlanId. The details are the body of a backup plan in JSON format, in addition to plan metadata.
    
    Specified by:
    
    getBackupPlan in interface AWSBackup
    
    Parameters:
    
    getBackupPlanRequest -
    
    Returns:
    
    Result of the GetBackupPlan operation returned by the service.
    
    Throws:
    
    ResourceNotFoundException - A resource that is required for the action doesn't exist.
    
    InvalidParameterValueException - Indicates that something is wrong with a parameter's value. For example, the value is out of range.
    
    MissingParameterValueException - Indicates that a required parameter is missing.
    
    ServiceUnavailableException - The request failed due to a temporary failure of the server.
    
    See Also:
    
    AWS API Documentation
  - getBackupPlanFromJSON
```
public GetBackupPlanFromJSONResult getBackupPlanFromJSON(GetBackupPlanFromJSONRequest request)
```
    Returns a valid JSON document specifying a backup plan or an error.
    
    Specified by:
    
    getBackupPlanFromJSON in interface AWSBackup
    
    Parameters:
    
    getBackupPlanFromJSONRequest -
    
    Returns:
    
    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.
    
    InvalidParameterValueException - Indicates that something is wrong with a parameter's value. For example, the value is out of range.
    
    MissingParameterValueException - Indicates that a required parameter is missing.
    
    ServiceUnavailableException - The request failed due to a temporary failure of the server.
    
    InvalidRequestException - Indicates that something is wrong with the input to the request. For example, a parameter is of the wrong type.
    
    See Also:
    
    AWS API Documentation
  - getBackupPlanFromTemplate
```
public GetBackupPlanFromTemplateResult getBackupPlanFromTemplate(GetBackupPlanFromTemplateRequest request)
```
    Returns the template specified by its templateId as a backup plan.
    
    Specified by:
    
    getBackupPlanFromTemplate in interface AWSBackup
    
    Parameters:
    
    getBackupPlanFromTemplateRequest -
    
    Returns:
    
    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.
    
    MissingParameterValueException - Indicates that a required parameter is missing.
    
    ServiceUnavailableException - The request failed due to a temporary failure of the server.
    
    ResourceNotFoundException - A resource that is required for the action doesn't exist.
    
    See Also:
    
    AWS API Documentation
  - getBackupSelection
```
public GetBackupSelectionResult getBackupSelection(GetBackupSelectionRequest request)
```
    Returns selection metadata and a document in JSON format that specifies a list of resources that are associated with a backup plan.
    
    Specified by:
    
    getBackupSelection in interface AWSBackup
    
    Parameters:
    
    getBackupSelectionRequest -
    
    Returns:
    
    Result of the GetBackupSelection operation returned by the service.
    
    Throws:
    
    ResourceNotFoundException - A resource that is required for the action doesn't exist.
    
    InvalidParameterValueException - Indicates that something is wrong with a parameter's value. For example, the value is out of range.
    
    MissingParameterValueException - Indicates that a required parameter is missing.
    
    ServiceUnavailableException - The request failed due to a temporary failure of the server.
    
    See Also:
    
    AWS API Documentation
  - getBackupVaultAccessPolicy
```
public GetBackupVaultAccessPolicyResult getBackupVaultAccessPolicy(GetBackupVaultAccessPolicyRequest request)
```
    Returns the access policy document that is associated with the named backup vault.
    
    Specified by:
    
    getBackupVaultAccessPolicy in interface AWSBackup
    
    Parameters:
    
    getBackupVaultAccessPolicyRequest -
    
    Returns:
    
    Result of the GetBackupVaultAccessPolicy operation returned by the service.
    
    Throws:
    
    ResourceNotFoundException - A resource that is required for the action doesn't exist.
    
    InvalidParameterValueException - Indicates that something is wrong with a parameter's value. For example, the value is out of range.
    
    MissingParameterValueException - Indicates that a required parameter is missing.
    
    ServiceUnavailableException - The request failed due to a temporary failure of the server.
    
    See Also:
    
    AWS API Documentation
  - getBackupVaultNotifications
```
public GetBackupVaultNotificationsResult getBackupVaultNotifications(GetBackupVaultNotificationsRequest request)
```
    Returns event notifications for the specified backup vault.
    
    Specified by:
    
    getBackupVaultNotifications in interface AWSBackup
    
    Parameters:
    
    getBackupVaultNotificationsRequest -
    
    Returns:
    
    Result of the GetBackupVaultNotifications operation returned by the service.
    
    Throws:
    
    ResourceNotFoundException - A resource that is required for the action doesn't exist.
    
    InvalidParameterValueException - Indicates that something is wrong with a parameter's value. For example, the value is out of range.
    
    MissingParameterValueException - Indicates that a required parameter is missing.
    
    ServiceUnavailableException - The request failed due to a temporary failure of the server.
    
    See Also:
    
    AWS API Documentation
  - getRecoveryPointRestoreMetadata
```
public GetRecoveryPointRestoreMetadataResult getRecoveryPointRestoreMetadata(GetRecoveryPointRestoreMetadataRequest request)
```
    Returns a set of metadata key-value pairs that were used to create the backup.
    
    Specified by:
    
    getRecoveryPointRestoreMetadata in interface AWSBackup
    
    Parameters:
    
    getRecoveryPointRestoreMetadataRequest -
    
    Returns:
    
    Result of the GetRecoveryPointRestoreMetadata operation returned by the service.
    
    Throws:
    
    ResourceNotFoundException - A resource that is required for the action doesn't exist.
    
    InvalidParameterValueException - Indicates that something is wrong with a parameter's value. For example, the value is out of range.
    
    MissingParameterValueException - Indicates that a required parameter is missing.
    
    ServiceUnavailableException - The request failed due to a temporary failure of the server.
    
    See Also:
    
    AWS API Documentation
  - getSupportedResourceTypes
```
public GetSupportedResourceTypesResult getSupportedResourceTypes(GetSupportedResourceTypesRequest request)
```
    Returns the Amazon Web Services resource types supported by Backup.
    
    Specified by:
    
    getSupportedResourceTypes in interface AWSBackup
    
    Parameters:
    
    getSupportedResourceTypesRequest -
    
    Returns:
    
    Result of the GetSupportedResourceTypes operation returned by the service.
    
    Throws:
    
    ServiceUnavailableException - The request failed due to a temporary failure of the server.
    
    See Also:
    
    AWS API Documentation
  - listBackupJobs
```
public ListBackupJobsResult listBackupJobs(ListBackupJobsRequest request)
```
    Returns a list of existing backup jobs for an authenticated account for the last 30 days. For a longer period of time, consider using these monitoring tools.
    
    Specified by:
    
    listBackupJobs in interface AWSBackup
    
    Parameters:
    
    listBackupJobsRequest -
    
    Returns:
    
    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.
    
    ServiceUnavailableException - The request failed due to a temporary failure of the server.
    
    See Also:
    
    AWS API Documentation
  - listBackupPlanTemplates
```
public ListBackupPlanTemplatesResult listBackupPlanTemplates(ListBackupPlanTemplatesRequest request)
```
    Returns metadata of your saved backup plan templates, including the template ID, name, and the creation and deletion dates.
    
    Specified by:
    
    listBackupPlanTemplates in interface AWSBackup
    
    Parameters:
    
    listBackupPlanTemplatesRequest -
    
    Returns:
    
    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.
    
    MissingParameterValueException - Indicates that a required parameter is missing.
    
    ServiceUnavailableException - The request failed due to a temporary failure of the server.
    
    ResourceNotFoundException - A resource that is required for the action doesn't exist.
    
    See Also:
    
    AWS API Documentation
  - listBackupPlanVersions
```
public ListBackupPlanVersionsResult listBackupPlanVersions(ListBackupPlanVersionsRequest request)
```
    Returns version metadata of your backup plans, including Amazon Resource Names (ARNs), backup plan IDs, creation and deletion dates, plan names, and version IDs.
    
    Specified by:
    
    listBackupPlanVersions in interface AWSBackup
    
    Parameters:
    
    listBackupPlanVersionsRequest -
    
    Returns:
    
    Result of the ListBackupPlanVersions operation returned by the service.
    
    Throws:
    
    ResourceNotFoundException - A resource that is required for the action doesn't exist.
    
    InvalidParameterValueException - Indicates that something is wrong with a parameter's value. For example, the value is out of range.
    
    MissingParameterValueException - Indicates that a required parameter is missing.
    
    ServiceUnavailableException - The request failed due to a temporary failure of the server.
    
    See Also:
    
    AWS API Documentation
  - listBackupPlans
```
public ListBackupPlansResult listBackupPlans(ListBackupPlansRequest request)
```
    Returns a list of all active backup plans for an authenticated account. The list contains information such as Amazon Resource Names (ARNs), plan IDs, creation and deletion dates, version IDs, plan names, and creator request IDs.
    
    Specified by:
    
    listBackupPlans in interface AWSBackup
    
    Parameters:
    
    listBackupPlansRequest -
    
    Returns:
    
    Result of the ListBackupPlans operation returned by the service.
    
    Throws:
    
    ResourceNotFoundException - A resource that is required for the action doesn't exist.
    
    InvalidParameterValueException - Indicates that something is wrong with a parameter's value. For example, the value is out of range.
    
    MissingParameterValueException - Indicates that a required parameter is missing.
    
    ServiceUnavailableException - The request failed due to a temporary failure of the server.
    
    See Also:
    
    AWS API Documentation
  - listBackupSelections
```
public ListBackupSelectionsResult listBackupSelections(ListBackupSelectionsRequest request)
```
    Returns an array containing metadata of the resources associated with the target backup plan.
    
    Specified by:
    
    listBackupSelections in interface AWSBackup
    
    Parameters:
    
    listBackupSelectionsRequest -
    
    Returns:
    
    Result of the ListBackupSelections operation returned by the service.
    
    Throws:
    
    ResourceNotFoundException - A resource that is required for the action doesn't exist.
    
    InvalidParameterValueException - Indicates that something is wrong with a parameter's value. For example, the value is out of range.
    
    MissingParameterValueException - Indicates that a required parameter is missing.
    
    ServiceUnavailableException - The request failed due to a temporary failure of the server.
    
    See Also:
    
    AWS API Documentation
  - listBackupVaults
```
public ListBackupVaultsResult listBackupVaults(ListBackupVaultsRequest request)
```
    Returns a list of recovery point storage containers along with information about them.
    
    Specified by:
    
    listBackupVaults in interface AWSBackup
    
    Parameters:
    
    listBackupVaultsRequest -
    
    Returns:
    
    Result of the ListBackupVaults operation returned by the service.
    
    Throws:
    
    ResourceNotFoundException - A resource that is required for the action doesn't exist.
    
    InvalidParameterValueException - Indicates that something is wrong with a parameter's value. For example, the value is out of range.
    
    MissingParameterValueException - Indicates that a required parameter is missing.
    
    ServiceUnavailableException - The request failed due to a temporary failure of the server.
    
    See Also:
    
    AWS API Documentation
  - listCopyJobs
```
public ListCopyJobsResult listCopyJobs(ListCopyJobsRequest request)
```
    Returns metadata about your copy jobs.
    
    Specified by:
    
    listCopyJobs in interface AWSBackup
    
    Parameters:
    
    listCopyJobsRequest -
    
    Returns:
    
    Result of the ListCopyJobs operation returned by the service.
    
    Throws:
    
    InvalidParameterValueException - Indicates that something is wrong with a parameter's value. For example, the value is out of range.
    
    ServiceUnavailableException - The request failed due to a temporary failure of the server.
    
    See Also:
    
    AWS API Documentation
  - listFrameworks
```
public ListFrameworksResult listFrameworks(ListFrameworksRequest request)
```
    Returns a list of all frameworks for an Amazon Web Services account and Amazon Web Services Region.
    
    Specified by:
    
    listFrameworks in interface AWSBackup
    
    Parameters:
    
    listFrameworksRequest -
    
    Returns:
    
    Result of the ListFrameworks operation returned by the service.
    
    Throws:
    
    InvalidParameterValueException - Indicates that something is wrong with a parameter's value. For example, the value is out of range.
    
    ServiceUnavailableException - The request failed due to a temporary failure of the server.
    
    See Also:
    
    AWS API Documentation
  - listProtectedResources
```
public ListProtectedResourcesResult listProtectedResources(ListProtectedResourcesRequest request)
```
    Returns an array of resources successfully backed up by Backup, including the time the resource was saved, an Amazon Resource Name (ARN) of the resource, and a resource type.
    
    Specified by:
    
    listProtectedResources in interface AWSBackup
    
    Parameters:
    
    listProtectedResourcesRequest -
    
    Returns:
    
    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.
    
    ServiceUnavailableException - The request failed due to a temporary failure of the server.
    
    See Also:
    
    AWS API Documentation
  - listRecoveryPointsByBackupVault
```
public ListRecoveryPointsByBackupVaultResult listRecoveryPointsByBackupVault(ListRecoveryPointsByBackupVaultRequest request)
```
    Returns detailed information about the recovery points stored in a backup vault.
    
    Specified by:
    
    listRecoveryPointsByBackupVault in interface AWSBackup
    
    Parameters:
    
    listRecoveryPointsByBackupVaultRequest -
    
    Returns:
    
    Result of the ListRecoveryPointsByBackupVault operation returned by the service.
    
    Throws:
    
    ResourceNotFoundException - A resource that is required for the action doesn't exist.
    
    InvalidParameterValueException - Indicates that something is wrong with a parameter's value. For example, the value is out of range.
    
    MissingParameterValueException - Indicates that a required parameter is missing.
    
    ServiceUnavailableException - The request failed due to a temporary failure of the server.
    
    See Also:
    
    AWS API Documentation
  - listRecoveryPointsByResource
```
public ListRecoveryPointsByResourceResult listRecoveryPointsByResource(ListRecoveryPointsByResourceRequest request)
```
    Returns detailed information about all the recovery points of the type specified by a resource Amazon Resource Name (ARN).
    
    For Amazon EFS and Amazon EC2, this action only lists recovery points created by Backup.
    
    Specified by:
    
    listRecoveryPointsByResource in interface AWSBackup
    
    Parameters:
    
    listRecoveryPointsByResourceRequest -
    
    Returns:
    
    Result of the ListRecoveryPointsByResource operation returned by the service.
    
    Throws:
    
    ResourceNotFoundException - A resource that is required for the action doesn't exist.
    
    InvalidParameterValueException - Indicates that something is wrong with a parameter's value. For example, the value is out of range.
    
    MissingParameterValueException - Indicates that a required parameter is missing.
    
    ServiceUnavailableException - The request failed due to a temporary failure of the server.
    
    See Also:
    
    AWS API Documentation
  - listReportJobs
```
public ListReportJobsResult listReportJobs(ListReportJobsRequest request)
```
    Returns details about your report jobs.
    
    Specified by:
    
    listReportJobs in interface AWSBackup
    
    Parameters:
    
    listReportJobsRequest -
    
    Returns:
    
    Result of the ListReportJobs operation returned by the service.
    
    Throws:
    
    InvalidParameterValueException - Indicates that something is wrong with a parameter's value. For example, the value is out of range.
    
    ServiceUnavailableException - The request failed due to a temporary failure of the server.
    
    See Also:
    
    AWS API Documentation
  - listReportPlans
```
public ListReportPlansResult listReportPlans(ListReportPlansRequest request)
```
    Returns a list of your report plans. For detailed information about a single report plan, use DescribeReportPlan.
    
    Specified by:
    
    listReportPlans in interface AWSBackup
    
    Parameters:
    
    listReportPlansRequest -
    
    Returns:
    
    Result of the ListReportPlans operation returned by the service.
    
    Throws:
    
    InvalidParameterValueException - Indicates that something is wrong with a parameter's value. For example, the value is out of range.
    
    ServiceUnavailableException - The request failed due to a temporary failure of the server.
    
    See Also:
    
    AWS API Documentation
  - listRestoreJobs
```
public ListRestoreJobsResult listRestoreJobs(ListRestoreJobsRequest request)
```
    Returns a list of jobs that Backup initiated to restore a saved resource, including details about the recovery process.
    
    Specified by:
    
    listRestoreJobs in interface AWSBackup
    
    Parameters:
    
    listRestoreJobsRequest -
    
    Returns:
    
    Result of the ListRestoreJobs operation returned by the service.
    
    Throws:
    
    ResourceNotFoundException - A resource that is required for the action doesn't exist.
    
    InvalidParameterValueException - Indicates that something is wrong with a parameter's value. For example, the value is out of range.
    
    MissingParameterValueException - Indicates that a required parameter is missing.
    
    ServiceUnavailableException - The request failed due to a temporary failure of the server.
    
    See Also:
    
    AWS API Documentation
  - listTags
```
public ListTagsResult listTags(ListTagsRequest request)
```
    Returns a list of key-value pairs assigned to a target recovery point, backup plan, or backup vault.
    
    ListTags are currently only supported with Amazon EFS backups.
    
    Specified by:
    
    listTags in interface AWSBackup
    
    Parameters:
    
    listTagsRequest -
    
    Returns:
    
    Result of the ListTags operation returned by the service.
    
    Throws:
    
    ResourceNotFoundException - A resource that is required for the action doesn't exist.
    
    InvalidParameterValueException - Indicates that something is wrong with a parameter's value. For example, the value is out of range.
    
    MissingParameterValueException - Indicates that a required parameter is missing.
    
    ServiceUnavailableException - The request failed due to a temporary failure of the server.
    
    See Also:
    
    AWS API Documentation
  - putBackupVaultAccessPolicy
```
public PutBackupVaultAccessPolicyResult putBackupVaultAccessPolicy(PutBackupVaultAccessPolicyRequest request)
```
    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.
    
    Specified by:
    
    putBackupVaultAccessPolicy in interface AWSBackup
    
    Parameters:
    
    putBackupVaultAccessPolicyRequest -
    
    Returns:
    
    Result of the PutBackupVaultAccessPolicy operation returned by the service.
    
    Throws:
    
    ResourceNotFoundException - A resource that is required for the action doesn't exist.
    
    InvalidParameterValueException - Indicates that something is wrong with a parameter's value. For example, the value is out of range.
    
    MissingParameterValueException - Indicates that a required parameter is missing.
    
    ServiceUnavailableException - The request failed due to a temporary failure of the server.
    
    See Also:
    
    AWS API Documentation
  - putBackupVaultLockConfiguration
```
public PutBackupVaultLockConfigurationResult putBackupVaultLockConfiguration(PutBackupVaultLockConfigurationRequest request)
```
    Applies Backup Vault Lock to a backup vault, preventing attempts to delete any recovery point stored in or created in a backup vault. Vault Lock also prevents attempts to update the lifecycle policy that controls the retention period of any recovery point currently stored in a backup vault. If specified, Vault Lock enforces a minimum and maximum retention period for future backup and copy jobs that target a backup vault.
    
    Specified by:
    
    putBackupVaultLockConfiguration in interface AWSBackup
    
    Parameters:
    
    putBackupVaultLockConfigurationRequest -
    
    Returns:
    
    Result of the PutBackupVaultLockConfiguration operation returned by the service.
    
    Throws:
    
    ResourceNotFoundException - A resource that is required for the action doesn't exist.
    
    InvalidParameterValueException - Indicates that something is wrong with a parameter's value. For example, the value is out of range.
    
    MissingParameterValueException - Indicates that a required parameter is missing.
    
    InvalidRequestException - Indicates that something is wrong with the input to the request. For example, a parameter is of the wrong type.
    
    ServiceUnavailableException - The request failed due to a temporary failure of the server.
    
    See Also:
    
    AWS API Documentation
  - putBackupVaultNotifications
```
public PutBackupVaultNotificationsResult putBackupVaultNotifications(PutBackupVaultNotificationsRequest request)
```
    Turns on notifications on a backup vault for the specified topic and events.
    
    Specified by:
    
    putBackupVaultNotifications in interface AWSBackup
    
    Parameters:
    
    putBackupVaultNotificationsRequest -
    
    Returns:
    
    Result of the PutBackupVaultNotifications operation returned by the service.
    
    Throws:
    
    ResourceNotFoundException - A resource that is required for the action doesn't exist.
    
    InvalidParameterValueException - Indicates that something is wrong with a parameter's value. For example, the value is out of range.
    
    MissingParameterValueException - Indicates that a required parameter is missing.
    
    ServiceUnavailableException - The request failed due to a temporary failure of the server.
    
    See Also:
    
    AWS API Documentation
  - startBackupJob
```
public StartBackupJobResult startBackupJob(StartBackupJobRequest request)
```
    Starts an on-demand backup job for the specified resource.
    
    Specified by:
    
    startBackupJob in interface AWSBackup
    
    Parameters:
    
    startBackupJobRequest -
    
    Returns:
    
    Result of the StartBackupJob operation returned by the service.
    
    Throws:
    
    ResourceNotFoundException - A resource that is required for the action doesn't exist.
    
    InvalidParameterValueException - Indicates that something is wrong with a parameter's value. For example, the value is out of range.
    
    MissingParameterValueException - Indicates that a required parameter is missing.
    
    InvalidRequestException - Indicates that something is wrong with the input to the request. For example, a parameter is of the wrong type.
    
    ServiceUnavailableException - The request failed due to a temporary failure of the server.
    
    LimitExceededException - A limit in the request has been exceeded; for example, a maximum number of items allowed in a request.
    
    See Also:
    
    AWS API Documentation
  - startCopyJob
```
public StartCopyJobResult startCopyJob(StartCopyJobRequest request)
```
    Starts a job to create a one-time copy of the specified resource.
    
    Does not support continuous backups.
    
    Specified by:
    
    startCopyJob in interface AWSBackup
    
    Parameters:
    
    startCopyJobRequest -
    
    Returns:
    
    Result of the StartCopyJob operation returned by the service.
    
    Throws:
    
    ResourceNotFoundException - A resource that is required for the action doesn't exist.
    
    InvalidParameterValueException - Indicates that something is wrong with a parameter's value. For example, the value is out of range.
    
    MissingParameterValueException - Indicates that a required parameter is missing.
    
    ServiceUnavailableException - The request failed due to a temporary failure of the server.
    
    LimitExceededException - A limit in the request has been exceeded; for example, a maximum number of items allowed in a request.
    
    InvalidRequestException - Indicates that something is wrong with the input to the request. For example, a parameter is of the wrong type.
    
    See Also:
    
    AWS API Documentation
  - startReportJob
```
public StartReportJobResult startReportJob(StartReportJobRequest request)
```
    Starts an on-demand report job for the specified report plan.
    
    Specified by:
    
    startReportJob in interface AWSBackup
    
    Parameters:
    
    startReportJobRequest -
    
    Returns:
    
    Result of the StartReportJob operation returned by the service.
    
    Throws:
    
    InvalidParameterValueException - Indicates that something is wrong with a parameter's value. For example, the value is out of range.
    
    ServiceUnavailableException - The request failed due to a temporary failure of the server.
    
    MissingParameterValueException - Indicates that a required parameter is missing.
    
    ResourceNotFoundException - A resource that is required for the action doesn't exist.
    
    See Also:
    
    AWS API Documentation
  - startRestoreJob
```
public StartRestoreJobResult startRestoreJob(StartRestoreJobRequest request)
```
    Recovers the saved resource identified by an Amazon Resource Name (ARN).
    
    Specified by:
    
    startRestoreJob in interface AWSBackup
    
    Parameters:
    
    startRestoreJobRequest -
    
    Returns:
    
    Result of the StartRestoreJob operation returned by the service.
    
    Throws:
    
    ResourceNotFoundException - A resource that is required for the action doesn't exist.
    
    InvalidParameterValueException - Indicates that something is wrong with a parameter's value. For example, the value is out of range.
    
    MissingParameterValueException - Indicates that a required parameter is missing.
    
    ServiceUnavailableException - The request failed due to a temporary failure of the server.
    
    See Also:
    
    AWS API Documentation
  - stopBackupJob
```
public StopBackupJobResult stopBackupJob(StopBackupJobRequest request)
```
    Attempts to cancel a job to create a one-time backup of a resource.
    
    Specified by:
    
    stopBackupJob in interface AWSBackup
    
    Parameters:
    
    stopBackupJobRequest -
    
    Returns:
    
    Result of the StopBackupJob operation returned by the service.
    
    Throws:
    
    MissingParameterValueException - Indicates that a required parameter is missing.
    
    ResourceNotFoundException - A resource that is required for the action doesn't exist.
    
    InvalidParameterValueException - Indicates that something is wrong with a parameter's value. For example, the value is out of range.
    
    InvalidRequestException - Indicates that something is wrong with the input to the request. For example, a parameter is of the wrong type.
    
    ServiceUnavailableException - The request failed due to a temporary failure of the server.
    
    See Also:
    
    AWS API Documentation
  - tagResource
```
public TagResourceResult tagResource(TagResourceRequest request)
```
    Assigns a set of key-value pairs to a recovery point, backup plan, or backup vault identified by an Amazon Resource Name (ARN).
    
    Specified by:
    
    tagResource in interface AWSBackup
    
    Parameters:
    
    tagResourceRequest -
    
    Returns:
    
    Result of the TagResource operation returned by the service.
    
    Throws:
    
    ResourceNotFoundException - A resource that is required for the action doesn't exist.
    
    InvalidParameterValueException - Indicates that something is wrong with a parameter's value. For example, the value is out of range.
    
    MissingParameterValueException - Indicates that a required parameter is missing.
    
    ServiceUnavailableException - The request failed due to a temporary failure of the server.
    
    LimitExceededException - A limit in the request has been exceeded; for example, a maximum number of items allowed in a request.
    
    See Also:
    
    AWS API Documentation
  - untagResource
```
public UntagResourceResult untagResource(UntagResourceRequest request)
```
    Removes a set of key-value pairs from a recovery point, backup plan, or backup vault identified by an Amazon Resource Name (ARN)
    
    Specified by:
    
    untagResource in interface AWSBackup
    
    Parameters:
    
    untagResourceRequest -
    
    Returns:
    
    Result of the UntagResource operation returned by the service.
    
    Throws:
    
    ResourceNotFoundException - A resource that is required for the action doesn't exist.
    
    InvalidParameterValueException - Indicates that something is wrong with a parameter's value. For example, the value is out of range.
    
    MissingParameterValueException - Indicates that a required parameter is missing.
    
    ServiceUnavailableException - The request failed due to a temporary failure of the server.
    
    See Also:
    
    AWS API Documentation
  - updateBackupPlan
```
public UpdateBackupPlanResult updateBackupPlan(UpdateBackupPlanRequest request)
```
    Updates an existing backup plan identified by its backupPlanId with the input document in JSON format. The new version is uniquely identified by a VersionId.
    
    Specified by:
    
    updateBackupPlan in interface AWSBackup
    
    Parameters:
    
    updateBackupPlanRequest -
    
    Returns:
    
    Result of the UpdateBackupPlan operation returned by the service.
    
    Throws:
    
    ResourceNotFoundException - A resource that is required for the action doesn't exist.
    
    InvalidParameterValueException - Indicates that something is wrong with a parameter's value. For example, the value is out of range.
    
    MissingParameterValueException - Indicates that a required parameter is missing.
    
    ServiceUnavailableException - The request failed due to a temporary failure of the server.
    
    See Also:
    
    AWS API Documentation
  - updateFramework
```
public UpdateFrameworkResult updateFramework(UpdateFrameworkRequest request)
```
    Updates an existing framework identified by its FrameworkName with the input document in JSON format.
    
    Specified by:
    
    updateFramework in interface AWSBackup
    
    Parameters:
    
    updateFrameworkRequest -
    
    Returns:
    
    Result of the UpdateFramework operation returned by the service.
    
    Throws:
    
    AlreadyExistsException - The required resource already exists.
    
    ResourceNotFoundException - A resource that is required for the action doesn't exist.
    
    LimitExceededException - A limit in the request has been exceeded; for example, a maximum number of items allowed in a request.
    
    InvalidParameterValueException - Indicates that something is wrong with a parameter's value. For example, the value is out of range.
    
    MissingParameterValueException - Indicates that a required parameter is missing.
    
    ConflictException - Backup can't perform the action that you requested until it finishes performing a previous action. Try again later.
    
    ServiceUnavailableException - The request failed due to a temporary failure of the server.
    
    See Also:
    
    AWS API Documentation
  - updateGlobalSettings
```
public UpdateGlobalSettingsResult updateGlobalSettings(UpdateGlobalSettingsRequest request)
```
    Updates whether the Amazon Web Services account is opted in to cross-account backup. Returns an error if the account is not an Organizations management account. Use the DescribeGlobalSettings API to determine the current settings.
    
    Specified by:
    
    updateGlobalSettings in interface AWSBackup
    
    Parameters:
    
    updateGlobalSettingsRequest -
    
    Returns:
    
    Result of the UpdateGlobalSettings operation returned by the service.
    
    Throws:
    
    ServiceUnavailableException - The request failed due to a temporary failure of the server.
    
    MissingParameterValueException - Indicates that a required parameter is missing.
    
    InvalidParameterValueException - Indicates that something is wrong with a parameter's value. For example, the value is out of range.
    
    InvalidRequestException - Indicates that something is wrong with the input to the request. For example, a parameter is of the wrong type.
    
    See Also:
    
    AWS API Documentation
  - updateRecoveryPointLifecycle
```
public UpdateRecoveryPointLifecycleResult updateRecoveryPointLifecycle(UpdateRecoveryPointLifecycleRequest request)
```
    Sets the transition lifecycle of a recovery point.
    
    The lifecycle defines when a protected resource is transitioned to cold storage and when it expires. Backup transitions and expires backups automatically according to the lifecycle that you define.
    
    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.
    
    Only Amazon EFS file system backups can be transitioned to cold storage.
    
    Does not support continuous backups.
    
    Specified by:
    
    updateRecoveryPointLifecycle in interface AWSBackup
    
    Parameters:
    
    updateRecoveryPointLifecycleRequest -
    
    Returns:
    
    Result of the UpdateRecoveryPointLifecycle operation returned by the service.
    
    Throws:
    
    ResourceNotFoundException - A resource that is required for the action doesn't exist.
    
    InvalidParameterValueException - Indicates that something is wrong with a parameter's value. For example, the value is out of range.
    
    MissingParameterValueException - Indicates that a required parameter is missing.
    
    ServiceUnavailableException - The request failed due to a temporary failure of the server.
    
    See Also:
    
    AWS API Documentation
  - updateRegionSettings
```
public UpdateRegionSettingsResult updateRegionSettings(UpdateRegionSettingsRequest request)
```
    Updates the current service opt-in settings for the Region. If service-opt-in is enabled for a service, Backup tries to protect that service's resources in this Region, when the resource is included in an on-demand backup or scheduled backup plan. Otherwise, Backup does not try to protect that service's resources in this Region. Use the DescribeRegionSettings API to determine the resource types that are supported.
    
    Specified by:
    
    updateRegionSettings in interface AWSBackup
    
    Parameters:
    
    updateRegionSettingsRequest -
    
    Returns:
    
    Result of the UpdateRegionSettings operation returned by the service.
    
    Throws:
    
    ServiceUnavailableException - The request failed due to a temporary failure of the server.
    
    MissingParameterValueException - Indicates that a required parameter is missing.
    
    InvalidParameterValueException - Indicates that something is wrong with a parameter's value. For example, the value is out of range.
    
    See Also:
    
    AWS API Documentation
  - updateReportPlan
```
public UpdateReportPlanResult updateReportPlan(UpdateReportPlanRequest request)
```
    Updates an existing report plan identified by its ReportPlanName with the input document in JSON format.
    
    Specified by:
    
    updateReportPlan in interface AWSBackup
    
    Parameters:
    
    updateReportPlanRequest -
    
    Returns:
    
    Result of the UpdateReportPlan operation returned by the service.
    
    Throws:
    
    ResourceNotFoundException - A resource that is required for the action doesn't exist.
    
    InvalidParameterValueException - Indicates that something is wrong with a parameter's value. For example, the value is out of range.
    
    ServiceUnavailableException - The request failed due to a temporary failure of the server.
    
    MissingParameterValueException - Indicates that a required parameter is missing.
    
    ConflictException - Backup can't perform the action that you requested until it finishes performing a previous action. Try again later.
    
    See Also:
    
    AWS API Documentation
  - getCachedResponseMetadata
```
public ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
```
    Returns additional metadata for a previously executed successful, request, typically used for debugging issues where a service isn't acting as expected. This data isn't considered part of the result data returned by an operation, so it's available through this separate, diagnostic interface.
    Response metadata is only cached for a limited period of time, so if you need to access this extra diagnostic information for an executed request, you should use this method to retrieve it as soon as possible after executing the request.
    
    Specified by:
    
    getCachedResponseMetadata in interface AWSBackup
    
    Parameters:
    
    request - The originally executed request
    
    Returns:
    
    The response metadata for the specified request, or null if none is available.
  - shutdown
```
public void shutdown()
```
    Description copied from class: AmazonWebServiceClient
    
    Shuts down this client object, releasing any resources that might be held open. If this method is not invoked, resources may be leaked. Once a client has been shutdown, it should not be used to make any more requests.
    
    Specified by:
    
    shutdown in interface AWSBackup
    
    Overrides:
    
    shutdown in class AmazonWebServiceClient

Did this page help you?

Class AWSBackupClient

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceClient

Fields inherited from interface com.amazonaws.services.backup.AWSBackup

Method Summary

Methods inherited from class com.amazonaws.AmazonWebServiceClient

Methods inherited from class java.lang.Object

Method Detail

builder

createBackupPlan

createBackupSelection

createBackupVault

createFramework

createReportPlan

deleteBackupPlan

deleteBackupSelection

deleteBackupVault

deleteBackupVaultAccessPolicy

deleteBackupVaultLockConfiguration

deleteBackupVaultNotifications

deleteFramework

deleteRecoveryPoint

deleteReportPlan

describeBackupJob

describeBackupVault

describeCopyJob

describeFramework

describeGlobalSettings

describeProtectedResource

describeRecoveryPoint

describeRegionSettings

describeReportJob

describeReportPlan

describeRestoreJob

disassociateRecoveryPoint

exportBackupPlanTemplate

getBackupPlan

getBackupPlanFromJSON

getBackupPlanFromTemplate

getBackupSelection

getBackupVaultAccessPolicy

getBackupVaultNotifications

getRecoveryPointRestoreMetadata

getSupportedResourceTypes

listBackupJobs

listBackupPlanTemplates

listBackupPlanVersions

listBackupPlans

listBackupSelections

listBackupVaults

listCopyJobs

listFrameworks

listProtectedResources

listRecoveryPointsByBackupVault

listRecoveryPointsByResource

listReportJobs

listReportPlans

listRestoreJobs

listTags

putBackupVaultAccessPolicy

putBackupVaultLockConfiguration

putBackupVaultNotifications

startBackupJob

startCopyJob

startReportJob

startRestoreJob

stopBackupJob

tagResource

untagResource

updateBackupPlan

updateFramework

updateGlobalSettings

updateRecoveryPointLifecycle

updateRegionSettings

updateReportPlan

getCachedResponseMetadata

shutdown