AbstractAWSBackup (AWS SDK for Java

JavaScript is disabled on your browser.

AWS SDK for Java 1.x API Reference - 1.12.795

We announced the upcoming end-of-support for AWS SDK for Java (v1). We recommend that you migrate to AWS SDK for Java v2. For dates, additional details, and information on how to migrate, please refer to the linked announcement.

Prev Class
Next Class

All Classes

Summary:
Nested |
Field |
Constr |
Method

Detail:
Field |
Constr |
Method

com.amazonaws.services.backup

Class AbstractAWSBackup

java.lang.Object
- com.amazonaws.services.backup.AbstractAWSBackup

All Implemented Interfaces:

AWSBackup

Direct Known Subclasses:

AbstractAWSBackupAsync
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class AbstractAWSBackup
extends Object
implements AWSBackup 
```
Abstract implementation of AWSBackup. Convenient method forms pass through to the corresponding overload that takes a request object, which throws an UnsupportedOperationException.

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

Method Summary

All Methods
Modifier and Type	Method and Description
`CancelLegalHoldResult`	`cancelLegalHold (CancelLegalHoldRequest request)` This action removes the specified legal hold on a recovery point.
`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.
`CreateLegalHoldResult`	`createLegalHold (CreateLegalHoldRequest request)` This action creates a legal hold on a recovery point (backup).
`CreateLogicallyAirGappedBackupVaultResult`	`createLogicallyAirGappedBackupVault (CreateLogicallyAirGappedBackupVaultRequest request)` This request creates a logical container to where backups may be copied.
`CreateReportPlanResult`	`createReportPlan (CreateReportPlanRequest request)` Creates a report plan.
`CreateRestoreTestingPlanResult`	`createRestoreTestingPlan (CreateRestoreTestingPlanRequest request)` This is the first of two steps to create a restore testing plan; once this request is successful, finish the procedure with request CreateRestoreTestingSelection.
`CreateRestoreTestingSelectionResult`	`createRestoreTestingSelection (CreateRestoreTestingSelectionRequest request)` This request can be sent after CreateRestoreTestingPlan request returns successfully.
`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.
`DeleteRestoreTestingPlanResult`	`deleteRestoreTestingPlan (DeleteRestoreTestingPlanRequest request)` This request deletes the specified restore testing plan.
`DeleteRestoreTestingSelectionResult`	`deleteRestoreTestingSelection (DeleteRestoreTestingSelectionRequest request)` Input the Restore Testing Plan name and Restore Testing Selection 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.
`DisassociateRecoveryPointFromParentResult`	`disassociateRecoveryPointFromParent (DisassociateRecoveryPointFromParentRequest request)` This action to a specific child (nested) recovery point removes the relationship between the specified recovery point and its parent (composite) recovery point.
`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.
`GetLegalHoldResult`	`getLegalHold (GetLegalHoldRequest request)` This action returns details for a specified legal hold.
`GetRecoveryPointRestoreMetadataResult`	`getRecoveryPointRestoreMetadata (GetRecoveryPointRestoreMetadataRequest request)` Returns a set of metadata key-value pairs that were used to create the backup.
`GetRestoreJobMetadataResult`	`getRestoreJobMetadata (GetRestoreJobMetadataRequest request)` This request returns the metadata for the specified restore job.
`GetRestoreTestingInferredMetadataResult`	`getRestoreTestingInferredMetadata (GetRestoreTestingInferredMetadataRequest request)` This request returns the minimal required set of metadata needed to start a restore job with secure default settings.
`GetRestoreTestingPlanResult`	`getRestoreTestingPlan (GetRestoreTestingPlanRequest request)` Returns `RestoreTestingPlan` details for the specified `RestoreTestingPlanName`.
`GetRestoreTestingSelectionResult`	`getRestoreTestingSelection (GetRestoreTestingSelectionRequest request)` Returns RestoreTestingSelection, which displays resources and elements of the restore testing plan.
`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.
`ListBackupJobSummariesResult`	`listBackupJobSummaries (ListBackupJobSummariesRequest request)` This is a request for a summary of backup jobs created or running within the most recent 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.
`ListCopyJobSummariesResult`	`listCopyJobSummaries (ListCopyJobSummariesRequest request)` This request obtains a list of copy jobs created or running within the the most recent 30 days.
`ListFrameworksResult`	`listFrameworks (ListFrameworksRequest request)` Returns a list of all frameworks for an Amazon Web Services account and Amazon Web Services Region.
`ListLegalHoldsResult`	`listLegalHolds (ListLegalHoldsRequest request)` This action returns metadata about active and previous legal holds.
`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.
`ListProtectedResourcesByBackupVaultResult`	`listProtectedResourcesByBackupVault (ListProtectedResourcesByBackupVaultRequest request)` This request lists the protected resources corresponding to each backup vault.
`ListRecoveryPointsByBackupVaultResult`	`listRecoveryPointsByBackupVault (ListRecoveryPointsByBackupVaultRequest request)` Returns detailed information about the recovery points stored in a backup vault.
`ListRecoveryPointsByLegalHoldResult`	`listRecoveryPointsByLegalHold (ListRecoveryPointsByLegalHoldRequest request)` This action returns recovery point ARNs (Amazon Resource Names) of the specified legal hold.
`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.
`ListRestoreJobsByProtectedResourceResult`	`listRestoreJobsByProtectedResource (ListRestoreJobsByProtectedResourceRequest request)` This returns restore jobs that contain the specified protected resource.
`ListRestoreJobSummariesResult`	`listRestoreJobSummaries (ListRestoreJobSummariesRequest request)` This request obtains a summary of restore jobs created or running within the the most recent 30 days.
`ListRestoreTestingPlansResult`	`listRestoreTestingPlans (ListRestoreTestingPlansRequest request)` Returns a list of restore testing plans.
`ListRestoreTestingSelectionsResult`	`listRestoreTestingSelections (ListRestoreTestingSelectionsRequest request)` Returns a list of restore testing selections.
`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.
`PutRestoreValidationResultResult`	`putRestoreValidationResult (PutRestoreValidationResultRequest request)` This request allows you to send your independent self-run restore test validation results.
`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.
`UpdateRestoreTestingPlanResult`	`updateRestoreTestingPlan (UpdateRestoreTestingPlanRequest request)` This request will send changes to your specified restore testing plan.
`UpdateRestoreTestingSelectionResult`	`updateRestoreTestingSelection (UpdateRestoreTestingSelectionRequest request)` Most elements except the `RestoreTestingSelectionName` can be updated with this request.

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

- Method Detail
  - cancelLegalHold
```
public CancelLegalHoldResult cancelLegalHold(CancelLegalHoldRequest request)
```
    Description copied from interface: AWSBackup
    
    This action removes the specified legal hold on a recovery point. This action can only be performed by a user with sufficient permissions.
    
    Specified by:
    
    cancelLegalHold in interface AWSBackup
    
    Returns:
    
    Result of the CancelLegalHold operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - createBackupPlan
```
public CreateBackupPlanResult createBackupPlan(CreateBackupPlanRequest request)
```
    Description copied from interface: AWSBackup
    
    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
    
    Returns:
    
    Result of the CreateBackupPlan operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - createBackupSelection
```
public CreateBackupSelectionResult createBackupSelection(CreateBackupSelectionRequest request)
```
    Description copied from interface: AWSBackup
    
    Creates a JSON document that specifies a set of resources to assign to a backup plan. For examples, see Assigning resources programmatically.
    
    Specified by:
    
    createBackupSelection in interface AWSBackup
    
    Returns:
    
    Result of the CreateBackupSelection operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - createBackupVault
```
public CreateBackupVaultResult createBackupVault(CreateBackupVaultRequest request)
```
    Description copied from interface: AWSBackup
    
    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
    
    Returns:
    
    Result of the CreateBackupVault operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - createFramework
```
public CreateFrameworkResult createFramework(CreateFrameworkRequest request)
```
    Description copied from interface: AWSBackup
    
    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
    
    Returns:
    
    Result of the CreateFramework operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - createLegalHold
```
public CreateLegalHoldResult createLegalHold(CreateLegalHoldRequest request)
```
    Description copied from interface: AWSBackup
    
    This action creates a legal hold on a recovery point (backup). A legal hold is a restraint on altering or deleting a backup until an authorized user cancels the legal hold. Any actions to delete or disassociate a recovery point will fail with an error if one or more active legal holds are on the recovery point.
    
    Specified by:
    
    createLegalHold in interface AWSBackup
    
    Returns:
    
    Result of the CreateLegalHold operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - createLogicallyAirGappedBackupVault
```
public CreateLogicallyAirGappedBackupVaultResult createLogicallyAirGappedBackupVault(CreateLogicallyAirGappedBackupVaultRequest request)
```
    Description copied from interface: AWSBackup
    
    This request creates a logical container to where backups may be copied.
    
    This request includes a name, the Region, the maximum number of retention days, the minimum number of retention days, and optionally can include tags and a creator request ID.
    
    Do not include sensitive data, such as passport numbers, in the name of a backup vault.
    
    Specified by:
    
    createLogicallyAirGappedBackupVault in interface AWSBackup
    
    Returns:
    
    Result of the CreateLogicallyAirGappedBackupVault operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - createReportPlan
```
public CreateReportPlanResult createReportPlan(CreateReportPlanRequest request)
```
    Description copied from interface: AWSBackup
    
    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
    
    Returns:
    
    Result of the CreateReportPlan operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - createRestoreTestingPlan
```
public CreateRestoreTestingPlanResult createRestoreTestingPlan(CreateRestoreTestingPlanRequest request)
```
    Description copied from interface: AWSBackup
    
    This is the first of two steps to create a restore testing plan; once this request is successful, finish the procedure with request CreateRestoreTestingSelection.
    
    You must include the parameter RestoreTestingPlan. You may optionally include CreatorRequestId and Tags.
    
    Specified by:
    
    createRestoreTestingPlan in interface AWSBackup
    
    Returns:
    
    Result of the CreateRestoreTestingPlan operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - createRestoreTestingSelection
```
public CreateRestoreTestingSelectionResult createRestoreTestingSelection(CreateRestoreTestingSelectionRequest request)
```
    Description copied from interface: AWSBackup
    This request can be sent after CreateRestoreTestingPlan request returns successfully. This is the second part of creating a resource testing plan, and it must be completed sequentially.
    
    This consists of RestoreTestingSelectionName, ProtectedResourceType, and one of the following:
    - ProtectedResourceArns
    - ProtectedResourceConditions
    Each protected resource type can have one single value.
    
    A restore testing selection can include a wildcard value ("*") for ProtectedResourceArns along with ProtectedResourceConditions. Alternatively, you can include up to 30 specific protected resource ARNs in ProtectedResourceArns.
    
    Cannot select by both protected resource types AND specific ARNs. Request will fail if both are included.
    Specified by:
    
    createRestoreTestingSelection in interface AWSBackup
    
    Returns:
    
    Result of the CreateRestoreTestingSelection operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - deleteBackupPlan
```
public DeleteBackupPlanResult deleteBackupPlan(DeleteBackupPlanRequest request)
```
    Description copied from interface: AWSBackup
    
    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
    
    Returns:
    
    Result of the DeleteBackupPlan operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - deleteBackupSelection
```
public DeleteBackupSelectionResult deleteBackupSelection(DeleteBackupSelectionRequest request)
```
    Description copied from interface: AWSBackup
    
    Deletes the resource selection associated with a backup plan that is specified by the SelectionId.
    
    Specified by:
    
    deleteBackupSelection in interface AWSBackup
    
    Returns:
    
    Result of the DeleteBackupSelection operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - deleteBackupVault
```
public DeleteBackupVaultResult deleteBackupVault(DeleteBackupVaultRequest request)
```
    Description copied from interface: AWSBackup
    
    Deletes the backup vault identified by its name. A vault can be deleted only if it is empty.
    
    Specified by:
    
    deleteBackupVault in interface AWSBackup
    
    Returns:
    
    Result of the DeleteBackupVault operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - deleteBackupVaultAccessPolicy
```
public DeleteBackupVaultAccessPolicyResult deleteBackupVaultAccessPolicy(DeleteBackupVaultAccessPolicyRequest request)
```
    Description copied from interface: AWSBackup
    
    Deletes the policy document that manages permissions on a backup vault.
    
    Specified by:
    
    deleteBackupVaultAccessPolicy in interface AWSBackup
    
    Returns:
    
    Result of the DeleteBackupVaultAccessPolicy operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - deleteBackupVaultLockConfiguration
```
public DeleteBackupVaultLockConfigurationResult deleteBackupVaultLockConfiguration(DeleteBackupVaultLockConfigurationRequest request)
```
    Description copied from interface: AWSBackup
    
    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
    
    Returns:
    
    Result of the DeleteBackupVaultLockConfiguration operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - deleteBackupVaultNotifications
```
public DeleteBackupVaultNotificationsResult deleteBackupVaultNotifications(DeleteBackupVaultNotificationsRequest request)
```
    Description copied from interface: AWSBackup
    
    Deletes event notifications for the specified backup vault.
    
    Specified by:
    
    deleteBackupVaultNotifications in interface AWSBackup
    
    Returns:
    
    Result of the DeleteBackupVaultNotifications operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - deleteFramework
```
public DeleteFrameworkResult deleteFramework(DeleteFrameworkRequest request)
```
    Description copied from interface: AWSBackup
    
    Deletes the framework specified by a framework name.
    
    Specified by:
    
    deleteFramework in interface AWSBackup
    
    Returns:
    
    Result of the DeleteFramework operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - deleteRecoveryPoint
```
public DeleteRecoveryPointResult deleteRecoveryPoint(DeleteRecoveryPointRequest request)
```
    Description copied from interface: AWSBackup
    
    Deletes the recovery point specified by a recovery point ID.
    
    If the recovery point ID belongs to a continuous backup, calling this endpoint deletes the existing continuous backup and stops future continuous backup.
    
    When an IAM role's permissions are insufficient to call this API, the service sends back an HTTP 200 response with an empty HTTP body, but the recovery point is not deleted. Instead, it enters an EXPIRED state.
    
    EXPIRED recovery points can be deleted with this API once the IAM role has the iam:CreateServiceLinkedRole action. To learn more about adding this role, see Troubleshooting manual deletions.
    
    If the user or role is deleted or the permission within the role is removed, the deletion will not be successful and will enter an EXPIRED state.
    
    Specified by:
    
    deleteRecoveryPoint in interface AWSBackup
    
    Returns:
    
    Result of the DeleteRecoveryPoint operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - deleteReportPlan
```
public DeleteReportPlanResult deleteReportPlan(DeleteReportPlanRequest request)
```
    Description copied from interface: AWSBackup
    
    Deletes the report plan specified by a report plan name.
    
    Specified by:
    
    deleteReportPlan in interface AWSBackup
    
    Returns:
    
    Result of the DeleteReportPlan operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - deleteRestoreTestingPlan
```
public DeleteRestoreTestingPlanResult deleteRestoreTestingPlan(DeleteRestoreTestingPlanRequest request)
```
    Description copied from interface: AWSBackup
    
    This request deletes the specified restore testing plan.
    
    Deletion can only successfully occur if all associated restore testing selections are deleted first.
    
    Specified by:
    
    deleteRestoreTestingPlan in interface AWSBackup
    
    Returns:
    
    Result of the DeleteRestoreTestingPlan operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - deleteRestoreTestingSelection
```
public DeleteRestoreTestingSelectionResult deleteRestoreTestingSelection(DeleteRestoreTestingSelectionRequest request)
```
    Description copied from interface: AWSBackup
    
    Input the Restore Testing Plan name and Restore Testing Selection name.
    
    All testing selections associated with a restore testing plan must be deleted before the restore testing plan can be deleted.
    
    Specified by:
    
    deleteRestoreTestingSelection in interface AWSBackup
    
    Returns:
    
    Result of the DeleteRestoreTestingSelection operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - describeBackupJob
```
public DescribeBackupJobResult describeBackupJob(DescribeBackupJobRequest request)
```
    Description copied from interface: AWSBackup
    
    Returns backup job details for the specified BackupJobId.
    
    Specified by:
    
    describeBackupJob in interface AWSBackup
    
    Returns:
    
    Result of the DescribeBackupJob operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - describeBackupVault
```
public DescribeBackupVaultResult describeBackupVault(DescribeBackupVaultRequest request)
```
    Description copied from interface: AWSBackup
    
    Returns metadata about a backup vault specified by its name.
    
    Specified by:
    
    describeBackupVault in interface AWSBackup
    
    Returns:
    
    Result of the DescribeBackupVault operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - describeCopyJob
```
public DescribeCopyJobResult describeCopyJob(DescribeCopyJobRequest request)
```
    Description copied from interface: AWSBackup
    
    Returns metadata associated with creating a copy of a resource.
    
    Specified by:
    
    describeCopyJob in interface AWSBackup
    
    Returns:
    
    Result of the DescribeCopyJob operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - describeFramework
```
public DescribeFrameworkResult describeFramework(DescribeFrameworkRequest request)
```
    Description copied from interface: AWSBackup
    
    Returns the framework details for the specified FrameworkName.
    
    Specified by:
    
    describeFramework in interface AWSBackup
    
    Returns:
    
    Result of the DescribeFramework operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - describeGlobalSettings
```
public DescribeGlobalSettingsResult describeGlobalSettings(DescribeGlobalSettingsRequest request)
```
    Description copied from interface: AWSBackup
    
    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
    
    Returns:
    
    Result of the DescribeGlobalSettings operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - describeProtectedResource
```
public DescribeProtectedResourceResult describeProtectedResource(DescribeProtectedResourceRequest request)
```
    Description copied from interface: AWSBackup
    
    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
    
    Returns:
    
    Result of the DescribeProtectedResource operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - describeRecoveryPoint
```
public DescribeRecoveryPointResult describeRecoveryPoint(DescribeRecoveryPointRequest request)
```
    Description copied from interface: AWSBackup
    
    Returns metadata associated with a recovery point, including ID, status, encryption, and lifecycle.
    
    Specified by:
    
    describeRecoveryPoint in interface AWSBackup
    
    Returns:
    
    Result of the DescribeRecoveryPoint operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - describeRegionSettings
```
public DescribeRegionSettingsResult describeRegionSettings(DescribeRegionSettingsRequest request)
```
    Description copied from interface: AWSBackup
    
    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
    
    Returns:
    
    Result of the DescribeRegionSettings operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - describeReportJob
```
public DescribeReportJobResult describeReportJob(DescribeReportJobRequest request)
```
    Description copied from interface: AWSBackup
    
    Returns the details associated with creating a report as specified by its ReportJobId.
    
    Specified by:
    
    describeReportJob in interface AWSBackup
    
    Returns:
    
    Result of the DescribeReportJob operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - describeReportPlan
```
public DescribeReportPlanResult describeReportPlan(DescribeReportPlanRequest request)
```
    Description copied from interface: AWSBackup
    
    Returns a list of all report plans for an Amazon Web Services account and Amazon Web Services Region.
    
    Specified by:
    
    describeReportPlan in interface AWSBackup
    
    Returns:
    
    Result of the DescribeReportPlan operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - describeRestoreJob
```
public DescribeRestoreJobResult describeRestoreJob(DescribeRestoreJobRequest request)
```
    Description copied from interface: AWSBackup
    
    Returns metadata associated with a restore job that is specified by a job ID.
    
    Specified by:
    
    describeRestoreJob in interface AWSBackup
    
    Returns:
    
    Result of the DescribeRestoreJob operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - disassociateRecoveryPoint
```
public DisassociateRecoveryPointResult disassociateRecoveryPoint(DisassociateRecoveryPointRequest request)
```
    Description copied from interface: AWSBackup
    
    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
    
    Returns:
    
    Result of the DisassociateRecoveryPoint operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - disassociateRecoveryPointFromParent
```
public DisassociateRecoveryPointFromParentResult disassociateRecoveryPointFromParent(DisassociateRecoveryPointFromParentRequest request)
```
    Description copied from interface: AWSBackup
    
    This action to a specific child (nested) recovery point removes the relationship between the specified recovery point and its parent (composite) recovery point.
    
    Specified by:
    
    disassociateRecoveryPointFromParent in interface AWSBackup
    
    Returns:
    
    Result of the DisassociateRecoveryPointFromParent operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - exportBackupPlanTemplate
```
public ExportBackupPlanTemplateResult exportBackupPlanTemplate(ExportBackupPlanTemplateRequest request)
```
    Description copied from interface: AWSBackup
    
    Returns the backup plan that is specified by the plan ID as a backup template.
    
    Specified by:
    
    exportBackupPlanTemplate in interface AWSBackup
    
    Returns:
    
    Result of the ExportBackupPlanTemplate operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - getBackupPlan
```
public GetBackupPlanResult getBackupPlan(GetBackupPlanRequest request)
```
    Description copied from interface: AWSBackup
    
    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
    
    Returns:
    
    Result of the GetBackupPlan operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - getBackupPlanFromJSON
```
public GetBackupPlanFromJSONResult getBackupPlanFromJSON(GetBackupPlanFromJSONRequest request)
```
    Description copied from interface: AWSBackup
    
    Returns a valid JSON document specifying a backup plan or an error.
    
    Specified by:
    
    getBackupPlanFromJSON in interface AWSBackup
    
    Returns:
    
    Result of the GetBackupPlanFromJSON operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - getBackupPlanFromTemplate
```
public GetBackupPlanFromTemplateResult getBackupPlanFromTemplate(GetBackupPlanFromTemplateRequest request)
```
    Description copied from interface: AWSBackup
    
    Returns the template specified by its templateId as a backup plan.
    
    Specified by:
    
    getBackupPlanFromTemplate in interface AWSBackup
    
    Returns:
    
    Result of the GetBackupPlanFromTemplate operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - getBackupSelection
```
public GetBackupSelectionResult getBackupSelection(GetBackupSelectionRequest request)
```
    Description copied from interface: AWSBackup
    
    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
    
    Returns:
    
    Result of the GetBackupSelection operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - getBackupVaultAccessPolicy
```
public GetBackupVaultAccessPolicyResult getBackupVaultAccessPolicy(GetBackupVaultAccessPolicyRequest request)
```
    Description copied from interface: AWSBackup
    
    Returns the access policy document that is associated with the named backup vault.
    
    Specified by:
    
    getBackupVaultAccessPolicy in interface AWSBackup
    
    Returns:
    
    Result of the GetBackupVaultAccessPolicy operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - getBackupVaultNotifications
```
public GetBackupVaultNotificationsResult getBackupVaultNotifications(GetBackupVaultNotificationsRequest request)
```
    Description copied from interface: AWSBackup
    
    Returns event notifications for the specified backup vault.
    
    Specified by:
    
    getBackupVaultNotifications in interface AWSBackup
    
    Returns:
    
    Result of the GetBackupVaultNotifications operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - getLegalHold
```
public GetLegalHoldResult getLegalHold(GetLegalHoldRequest request)
```
    Description copied from interface: AWSBackup
    
    This action returns details for a specified legal hold. The details are the body of a legal hold in JSON format, in addition to metadata.
    
    Specified by:
    
    getLegalHold in interface AWSBackup
    
    Returns:
    
    Result of the GetLegalHold operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - getRecoveryPointRestoreMetadata
```
public GetRecoveryPointRestoreMetadataResult getRecoveryPointRestoreMetadata(GetRecoveryPointRestoreMetadataRequest request)
```
    Description copied from interface: AWSBackup
    
    Returns a set of metadata key-value pairs that were used to create the backup.
    
    Specified by:
    
    getRecoveryPointRestoreMetadata in interface AWSBackup
    
    Returns:
    
    Result of the GetRecoveryPointRestoreMetadata operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - getRestoreJobMetadata
```
public GetRestoreJobMetadataResult getRestoreJobMetadata(GetRestoreJobMetadataRequest request)
```
    Description copied from interface: AWSBackup
    
    This request returns the metadata for the specified restore job.
    
    Specified by:
    
    getRestoreJobMetadata in interface AWSBackup
    
    Returns:
    
    Result of the GetRestoreJobMetadata operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - getRestoreTestingInferredMetadata
```
public GetRestoreTestingInferredMetadataResult getRestoreTestingInferredMetadata(GetRestoreTestingInferredMetadataRequest request)
```
    Description copied from interface: AWSBackup
    
    This request returns the minimal required set of metadata needed to start a restore job with secure default settings. BackupVaultName and RecoveryPointArn are required parameters. BackupVaultAccountId is an optional parameter.
    
    Specified by:
    
    getRestoreTestingInferredMetadata in interface AWSBackup
    
    Returns:
    
    Result of the GetRestoreTestingInferredMetadata operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - getRestoreTestingPlan
```
public GetRestoreTestingPlanResult getRestoreTestingPlan(GetRestoreTestingPlanRequest request)
```
    Description copied from interface: AWSBackup
    
    Returns RestoreTestingPlan details for the specified RestoreTestingPlanName. The details are the body of a restore testing plan in JSON format, in addition to plan metadata.
    
    Specified by:
    
    getRestoreTestingPlan in interface AWSBackup
    
    Returns:
    
    Result of the GetRestoreTestingPlan operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - getRestoreTestingSelection
```
public GetRestoreTestingSelectionResult getRestoreTestingSelection(GetRestoreTestingSelectionRequest request)
```
    Description copied from interface: AWSBackup
    
    Returns RestoreTestingSelection, which displays resources and elements of the restore testing plan.
    
    Specified by:
    
    getRestoreTestingSelection in interface AWSBackup
    
    Returns:
    
    Result of the GetRestoreTestingSelection operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - getSupportedResourceTypes
```
public GetSupportedResourceTypesResult getSupportedResourceTypes(GetSupportedResourceTypesRequest request)
```
    Description copied from interface: AWSBackup
    
    Returns the Amazon Web Services resource types supported by Backup.
    
    Specified by:
    
    getSupportedResourceTypes in interface AWSBackup
    
    Returns:
    
    Result of the GetSupportedResourceTypes operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - listBackupJobSummaries
```
public ListBackupJobSummariesResult listBackupJobSummaries(ListBackupJobSummariesRequest request)
```
    Description copied from interface: AWSBackup
    
    This is a request for a summary of backup jobs created or running within the most recent 30 days. You can include parameters AccountID, State, ResourceType, MessageCategory, AggregationPeriod, MaxResults, or NextToken to filter results.
    
    This request returns a summary that contains Region, Account, State, ResourceType, MessageCategory, StartTime, EndTime, and Count of included jobs.
    
    Specified by:
    
    listBackupJobSummaries in interface AWSBackup
    
    Returns:
    
    Result of the ListBackupJobSummaries operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - listBackupJobs
```
public ListBackupJobsResult listBackupJobs(ListBackupJobsRequest request)
```
    Description copied from interface: AWSBackup
    
    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
    
    Returns:
    
    Result of the ListBackupJobs operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - listBackupPlanTemplates
```
public ListBackupPlanTemplatesResult listBackupPlanTemplates(ListBackupPlanTemplatesRequest request)
```
    Description copied from interface: AWSBackup
    
    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
    
    Returns:
    
    Result of the ListBackupPlanTemplates operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - listBackupPlanVersions
```
public ListBackupPlanVersionsResult listBackupPlanVersions(ListBackupPlanVersionsRequest request)
```
    Description copied from interface: AWSBackup
    
    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
    
    Returns:
    
    Result of the ListBackupPlanVersions operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - listBackupPlans
```
public ListBackupPlansResult listBackupPlans(ListBackupPlansRequest request)
```
    Description copied from interface: AWSBackup
    
    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
    
    Returns:
    
    Result of the ListBackupPlans operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - listBackupSelections
```
public ListBackupSelectionsResult listBackupSelections(ListBackupSelectionsRequest request)
```
    Description copied from interface: AWSBackup
    
    Returns an array containing metadata of the resources associated with the target backup plan.
    
    Specified by:
    
    listBackupSelections in interface AWSBackup
    
    Returns:
    
    Result of the ListBackupSelections operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - listBackupVaults
```
public ListBackupVaultsResult listBackupVaults(ListBackupVaultsRequest request)
```
    Description copied from interface: AWSBackup
    
    Returns a list of recovery point storage containers along with information about them.
    
    Specified by:
    
    listBackupVaults in interface AWSBackup
    
    Returns:
    
    Result of the ListBackupVaults operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - listCopyJobSummaries
```
public ListCopyJobSummariesResult listCopyJobSummaries(ListCopyJobSummariesRequest request)
```
    Description copied from interface: AWSBackup
    
    This request obtains a list of copy jobs created or running within the the most recent 30 days. You can include parameters AccountID, State, ResourceType, MessageCategory, AggregationPeriod, MaxResults, or NextToken to filter results.
    
    This request returns a summary that contains Region, Account, State, RestourceType, MessageCategory, StartTime, EndTime, and Count of included jobs.
    
    Specified by:
    
    listCopyJobSummaries in interface AWSBackup
    
    Returns:
    
    Result of the ListCopyJobSummaries operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - listCopyJobs
```
public ListCopyJobsResult listCopyJobs(ListCopyJobsRequest request)
```
    Description copied from interface: AWSBackup
    
    Returns metadata about your copy jobs.
    
    Specified by:
    
    listCopyJobs in interface AWSBackup
    
    Returns:
    
    Result of the ListCopyJobs operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - listFrameworks
```
public ListFrameworksResult listFrameworks(ListFrameworksRequest request)
```
    Description copied from interface: AWSBackup
    
    Returns a list of all frameworks for an Amazon Web Services account and Amazon Web Services Region.
    
    Specified by:
    
    listFrameworks in interface AWSBackup
    
    Returns:
    
    Result of the ListFrameworks operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - listLegalHolds
```
public ListLegalHoldsResult listLegalHolds(ListLegalHoldsRequest request)
```
    Description copied from interface: AWSBackup
    
    This action returns metadata about active and previous legal holds.
    
    Specified by:
    
    listLegalHolds in interface AWSBackup
    
    Returns:
    
    Result of the ListLegalHolds operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - listProtectedResources
```
public ListProtectedResourcesResult listProtectedResources(ListProtectedResourcesRequest request)
```
    Description copied from interface: AWSBackup
    
    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
    
    Returns:
    
    Result of the ListProtectedResources operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - listProtectedResourcesByBackupVault
```
public ListProtectedResourcesByBackupVaultResult listProtectedResourcesByBackupVault(ListProtectedResourcesByBackupVaultRequest request)
```
    Description copied from interface: AWSBackup
    
    This request lists the protected resources corresponding to each backup vault.
    
    Specified by:
    
    listProtectedResourcesByBackupVault in interface AWSBackup
    
    Returns:
    
    Result of the ListProtectedResourcesByBackupVault operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - listRecoveryPointsByBackupVault
```
public ListRecoveryPointsByBackupVaultResult listRecoveryPointsByBackupVault(ListRecoveryPointsByBackupVaultRequest request)
```
    Description copied from interface: AWSBackup
    
    Returns detailed information about the recovery points stored in a backup vault.
    
    Specified by:
    
    listRecoveryPointsByBackupVault in interface AWSBackup
    
    Returns:
    
    Result of the ListRecoveryPointsByBackupVault operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - listRecoveryPointsByLegalHold
```
public ListRecoveryPointsByLegalHoldResult listRecoveryPointsByLegalHold(ListRecoveryPointsByLegalHoldRequest request)
```
    Description copied from interface: AWSBackup
    
    This action returns recovery point ARNs (Amazon Resource Names) of the specified legal hold.
    
    Specified by:
    
    listRecoveryPointsByLegalHold in interface AWSBackup
    
    Returns:
    
    Result of the ListRecoveryPointsByLegalHold operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - listRecoveryPointsByResource
```
public ListRecoveryPointsByResourceResult listRecoveryPointsByResource(ListRecoveryPointsByResourceRequest request)
```
    Description copied from interface: AWSBackup
    
    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
    
    Returns:
    
    Result of the ListRecoveryPointsByResource operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - listReportJobs
```
public ListReportJobsResult listReportJobs(ListReportJobsRequest request)
```
    Description copied from interface: AWSBackup
    
    Returns details about your report jobs.
    
    Specified by:
    
    listReportJobs in interface AWSBackup
    
    Returns:
    
    Result of the ListReportJobs operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - listReportPlans
```
public ListReportPlansResult listReportPlans(ListReportPlansRequest request)
```
    Description copied from interface: AWSBackup
    
    Returns a list of your report plans. For detailed information about a single report plan, use DescribeReportPlan.
    
    Specified by:
    
    listReportPlans in interface AWSBackup
    
    Returns:
    
    Result of the ListReportPlans operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - listRestoreJobSummaries
```
public ListRestoreJobSummariesResult listRestoreJobSummaries(ListRestoreJobSummariesRequest request)
```
    Description copied from interface: AWSBackup
    
    This request obtains a summary of restore jobs created or running within the the most recent 30 days. You can include parameters AccountID, State, ResourceType, AggregationPeriod, MaxResults, or NextToken to filter results.
    
    This request returns a summary that contains Region, Account, State, RestourceType, MessageCategory, StartTime, EndTime, and Count of included jobs.
    
    Specified by:
    
    listRestoreJobSummaries in interface AWSBackup
    
    Returns:
    
    Result of the ListRestoreJobSummaries operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - listRestoreJobs
```
public ListRestoreJobsResult listRestoreJobs(ListRestoreJobsRequest request)
```
    Description copied from interface: AWSBackup
    
    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
    
    Returns:
    
    Result of the ListRestoreJobs operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - listRestoreJobsByProtectedResource
```
public ListRestoreJobsByProtectedResourceResult listRestoreJobsByProtectedResource(ListRestoreJobsByProtectedResourceRequest request)
```
    Description copied from interface: AWSBackup
    
    This returns restore jobs that contain the specified protected resource.
    
    You must include ResourceArn. You can optionally include NextToken, ByStatus, MaxResults, ByRecoveryPointCreationDateAfter , and ByRecoveryPointCreationDateBefore.
    
    Specified by:
    
    listRestoreJobsByProtectedResource in interface AWSBackup
    
    Returns:
    
    Result of the ListRestoreJobsByProtectedResource operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - listRestoreTestingPlans
```
public ListRestoreTestingPlansResult listRestoreTestingPlans(ListRestoreTestingPlansRequest request)
```
    Description copied from interface: AWSBackup
    
    Returns a list of restore testing plans.
    
    Specified by:
    
    listRestoreTestingPlans in interface AWSBackup
    
    Returns:
    
    Result of the ListRestoreTestingPlans operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - listRestoreTestingSelections
```
public ListRestoreTestingSelectionsResult listRestoreTestingSelections(ListRestoreTestingSelectionsRequest request)
```
    Description copied from interface: AWSBackup
    
    Returns a list of restore testing selections. Can be filtered by MaxResults and RestoreTestingPlanName.
    
    Specified by:
    
    listRestoreTestingSelections in interface AWSBackup
    
    Returns:
    
    Result of the ListRestoreTestingSelections operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - listTags
```
public ListTagsResult listTags(ListTagsRequest request)
```
    Description copied from interface: AWSBackup
    
    Returns a list of key-value pairs assigned to a target recovery point, backup plan, or backup vault.
    
    ListTags only works for resource types that support full Backup management of their backups. Those resource types are listed in the "Full Backup management" section of the Feature availability by resource table.
    
    Specified by:
    
    listTags in interface AWSBackup
    
    Returns:
    
    Result of the ListTags operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - putBackupVaultAccessPolicy
```
public PutBackupVaultAccessPolicyResult putBackupVaultAccessPolicy(PutBackupVaultAccessPolicyRequest request)
```
    Description copied from interface: AWSBackup
    
    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
    
    Returns:
    
    Result of the PutBackupVaultAccessPolicy operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - putBackupVaultLockConfiguration
```
public PutBackupVaultLockConfigurationResult putBackupVaultLockConfiguration(PutBackupVaultLockConfigurationRequest request)
```
    Description copied from interface: AWSBackup
    
    Applies Backup Vault Lock to a backup vault, preventing attempts to delete any recovery point stored in or created in a backup vault. Vault Lock also prevents attempts to update the lifecycle policy that controls the retention period of any recovery point currently stored in a backup vault. If specified, Vault Lock enforces a minimum and maximum retention period for future backup and copy jobs that target a backup vault.
    
    Backup Vault Lock has been assessed by Cohasset Associates for use in environments that are subject to SEC 17a-4, CFTC, and FINRA regulations. For more information about how Backup Vault Lock relates to these regulations, see the Cohasset Associates Compliance Assessment.
    
    Specified by:
    
    putBackupVaultLockConfiguration in interface AWSBackup
    
    Returns:
    
    Result of the PutBackupVaultLockConfiguration operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - putBackupVaultNotifications
```
public PutBackupVaultNotificationsResult putBackupVaultNotifications(PutBackupVaultNotificationsRequest request)
```
    Description copied from interface: AWSBackup
    
    Turns on notifications on a backup vault for the specified topic and events.
    
    Specified by:
    
    putBackupVaultNotifications in interface AWSBackup
    
    Returns:
    
    Result of the PutBackupVaultNotifications operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - putRestoreValidationResult
```
public PutRestoreValidationResultResult putRestoreValidationResult(PutRestoreValidationResultRequest request)
```
    Description copied from interface: AWSBackup
    
    This request allows you to send your independent self-run restore test validation results. RestoreJobId and ValidationStatus are required. Optionally, you can input a ValidationStatusMessage.
    
    Specified by:
    
    putRestoreValidationResult in interface AWSBackup
    
    Returns:
    
    Result of the PutRestoreValidationResult operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - startBackupJob
```
public StartBackupJobResult startBackupJob(StartBackupJobRequest request)
```
    Description copied from interface: AWSBackup
    
    Starts an on-demand backup job for the specified resource.
    
    Specified by:
    
    startBackupJob in interface AWSBackup
    
    Returns:
    
    Result of the StartBackupJob operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - startCopyJob
```
public StartCopyJobResult startCopyJob(StartCopyJobRequest request)
```
    Description copied from interface: AWSBackup
    
    Starts a job to create a one-time copy of the specified resource.
    
    Does not support continuous backups.
    
    Specified by:
    
    startCopyJob in interface AWSBackup
    
    Returns:
    
    Result of the StartCopyJob operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - startReportJob
```
public StartReportJobResult startReportJob(StartReportJobRequest request)
```
    Description copied from interface: AWSBackup
    
    Starts an on-demand report job for the specified report plan.
    
    Specified by:
    
    startReportJob in interface AWSBackup
    
    Returns:
    
    Result of the StartReportJob operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - startRestoreJob
```
public StartRestoreJobResult startRestoreJob(StartRestoreJobRequest request)
```
    Description copied from interface: AWSBackup
    
    Recovers the saved resource identified by an Amazon Resource Name (ARN).
    
    Specified by:
    
    startRestoreJob in interface AWSBackup
    
    Returns:
    
    Result of the StartRestoreJob operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - stopBackupJob
```
public StopBackupJobResult stopBackupJob(StopBackupJobRequest request)
```
    Description copied from interface: AWSBackup
    
    Attempts to cancel a job to create a one-time backup of a resource.
    
    This action is not supported for the following services: Amazon FSx for Windows File Server, Amazon FSx for Lustre, Amazon FSx for NetApp ONTAP , Amazon FSx for OpenZFS, Amazon DocumentDB (with MongoDB compatibility), Amazon RDS, Amazon Aurora, and Amazon Neptune.
    
    Specified by:
    
    stopBackupJob in interface AWSBackup
    
    Returns:
    
    Result of the StopBackupJob operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - tagResource
```
public TagResourceResult tagResource(TagResourceRequest request)
```
    Description copied from interface: AWSBackup
    
    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
    
    Returns:
    
    Result of the TagResource operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - untagResource
```
public UntagResourceResult untagResource(UntagResourceRequest request)
```
    Description copied from interface: AWSBackup
    
    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
    
    Returns:
    
    Result of the UntagResource operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - updateBackupPlan
```
public UpdateBackupPlanResult updateBackupPlan(UpdateBackupPlanRequest request)
```
    Description copied from interface: AWSBackup
    
    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
    
    Returns:
    
    Result of the UpdateBackupPlan operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - updateFramework
```
public UpdateFrameworkResult updateFramework(UpdateFrameworkRequest request)
```
    Description copied from interface: AWSBackup
    
    Updates an existing framework identified by its FrameworkName with the input document in JSON format.
    
    Specified by:
    
    updateFramework in interface AWSBackup
    
    Returns:
    
    Result of the UpdateFramework operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - updateGlobalSettings
```
public UpdateGlobalSettingsResult updateGlobalSettings(UpdateGlobalSettingsRequest request)
```
    Description copied from interface: AWSBackup
    
    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
    
    Returns:
    
    Result of the UpdateGlobalSettings operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - updateRecoveryPointLifecycle
```
public UpdateRecoveryPointLifecycleResult updateRecoveryPointLifecycle(UpdateRecoveryPointLifecycleRequest request)
```
    Description copied from interface: AWSBackup
    
    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 "retention" setting must be 90 days greater than the "transition to cold after days" setting. The "transition to cold after days" setting cannot be changed after a backup has been transitioned to cold.
    
    Resource types that are able to be transitioned to cold storage are listed in the "Lifecycle to cold storage" section of the Feature availability by resource table. Backup ignores this expression for other resource types.
    
    This operation does not support continuous backups.
    
    Specified by:
    
    updateRecoveryPointLifecycle in interface AWSBackup
    
    Returns:
    
    Result of the UpdateRecoveryPointLifecycle operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - updateRegionSettings
```
public UpdateRegionSettingsResult updateRegionSettings(UpdateRegionSettingsRequest request)
```
    Description copied from interface: AWSBackup
    
    Updates the current service opt-in settings for the Region.
    
    Use the DescribeRegionSettings API to determine the resource types that are supported.
    
    Specified by:
    
    updateRegionSettings in interface AWSBackup
    
    Returns:
    
    Result of the UpdateRegionSettings operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - updateReportPlan
```
public UpdateReportPlanResult updateReportPlan(UpdateReportPlanRequest request)
```
    Description copied from interface: AWSBackup
    
    Updates an existing report plan identified by its ReportPlanName with the input document in JSON format.
    
    Specified by:
    
    updateReportPlan in interface AWSBackup
    
    Returns:
    
    Result of the UpdateReportPlan operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - updateRestoreTestingPlan
```
public UpdateRestoreTestingPlanResult updateRestoreTestingPlan(UpdateRestoreTestingPlanRequest request)
```
    Description copied from interface: AWSBackup
    This request will send changes to your specified restore testing plan. RestoreTestingPlanName cannot be updated after it is created.
    
    RecoveryPointSelection can contain:
    - Algorithm
    - ExcludeVaults
    - IncludeVaults
    - RecoveryPointTypes
    - SelectionWindowDays
    Specified by:
    
    updateRestoreTestingPlan in interface AWSBackup
    
    Returns:
    
    Result of the UpdateRestoreTestingPlan operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - updateRestoreTestingSelection
```
public UpdateRestoreTestingSelectionResult updateRestoreTestingSelection(UpdateRestoreTestingSelectionRequest request)
```
    Description copied from interface: AWSBackup
    
    Most elements except the RestoreTestingSelectionName can be updated with this request.
    
    RestoreTestingSelection can use either protected resource ARNs or conditions, but not both. That is, if your selection has ProtectedResourceArns, requesting an update with the parameter ProtectedResourceConditions will be unsuccessful.
    
    Specified by:
    
    updateRestoreTestingSelection in interface AWSBackup
    
    Returns:
    
    Result of the UpdateRestoreTestingSelection operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - shutdown
```
public void shutdown()
```
    Description copied from interface: AWSBackup
    
    Shuts down this client object, releasing any resources that might be held open. This is an optional method, and callers are not expected to call it, but can if they want to explicitly release any open resources. Once a client has been shutdown, it should not be used to make any more requests.
    
    Specified by:
    
    shutdown in interface AWSBackup
  - getCachedResponseMetadata
```
public ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
```
    Description copied from interface: AWSBackup
    
    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 a 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.

Skip navigation links

Prev Class
Next Class

All Classes

Summary:
Nested |
Field |
Constr |
Method

Detail:
Field |
Constr |
Method

AWS SDK for Java 1.x API Reference - 1.12.795

Class AbstractAWSBackup

Field Summary

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

Method Summary

Methods inherited from class java.lang.Object

Method Detail

cancelLegalHold

createBackupPlan

createBackupSelection

createBackupVault

createFramework

createLegalHold

createLogicallyAirGappedBackupVault

createReportPlan

createRestoreTestingPlan

createRestoreTestingSelection

deleteBackupPlan

deleteBackupSelection

deleteBackupVault

deleteBackupVaultAccessPolicy

deleteBackupVaultLockConfiguration

deleteBackupVaultNotifications

deleteFramework

deleteRecoveryPoint

deleteReportPlan

deleteRestoreTestingPlan

deleteRestoreTestingSelection

describeBackupJob

describeBackupVault

describeCopyJob

describeFramework

describeGlobalSettings

describeProtectedResource

describeRecoveryPoint

describeRegionSettings

describeReportJob

describeReportPlan

describeRestoreJob

disassociateRecoveryPoint

disassociateRecoveryPointFromParent

exportBackupPlanTemplate

getBackupPlan

getBackupPlanFromJSON

getBackupPlanFromTemplate

getBackupSelection

getBackupVaultAccessPolicy

getBackupVaultNotifications

getLegalHold

getRecoveryPointRestoreMetadata

getRestoreJobMetadata

getRestoreTestingInferredMetadata

getRestoreTestingPlan

getRestoreTestingSelection

getSupportedResourceTypes

listBackupJobSummaries

listBackupJobs

listBackupPlanTemplates

listBackupPlanVersions

listBackupPlans

listBackupSelections

listBackupVaults

listCopyJobSummaries

listCopyJobs

listFrameworks

listLegalHolds

listProtectedResources

listProtectedResourcesByBackupVault

listRecoveryPointsByBackupVault

listRecoveryPointsByLegalHold

listRecoveryPointsByResource

listReportJobs

listReportPlans

listRestoreJobSummaries

listRestoreJobs

listRestoreJobsByProtectedResource

listRestoreTestingPlans

listRestoreTestingSelections

listTags

putBackupVaultAccessPolicy