@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public interface AWSBackupAsync extends AWSBackup
AsyncHandler
can be used to receive
notification when an asynchronous operation completes.
Note: Do not directly implement this interface, new methods are added to it regularly. Extend from
AbstractAWSBackupAsync
instead.
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.
ENDPOINT_PREFIX
Modifier and Type | Method and Description |
---|---|
Future<CreateBackupPlanResult> |
createBackupPlanAsync(CreateBackupPlanRequest createBackupPlanRequest)
Creates a backup plan using a backup plan name and backup rules.
|
Future<CreateBackupPlanResult> |
createBackupPlanAsync(CreateBackupPlanRequest createBackupPlanRequest,
AsyncHandler<CreateBackupPlanRequest,CreateBackupPlanResult> asyncHandler)
Creates a backup plan using a backup plan name and backup rules.
|
Future<CreateBackupSelectionResult> |
createBackupSelectionAsync(CreateBackupSelectionRequest createBackupSelectionRequest)
Creates a JSON document that specifies a set of resources to assign to a backup plan.
|
Future<CreateBackupSelectionResult> |
createBackupSelectionAsync(CreateBackupSelectionRequest createBackupSelectionRequest,
AsyncHandler<CreateBackupSelectionRequest,CreateBackupSelectionResult> asyncHandler)
Creates a JSON document that specifies a set of resources to assign to a backup plan.
|
Future<CreateBackupVaultResult> |
createBackupVaultAsync(CreateBackupVaultRequest createBackupVaultRequest)
Creates a logical container where backups are stored.
|
Future<CreateBackupVaultResult> |
createBackupVaultAsync(CreateBackupVaultRequest createBackupVaultRequest,
AsyncHandler<CreateBackupVaultRequest,CreateBackupVaultResult> asyncHandler)
Creates a logical container where backups are stored.
|
Future<CreateFrameworkResult> |
createFrameworkAsync(CreateFrameworkRequest createFrameworkRequest)
Creates a framework with one or more controls.
|
Future<CreateFrameworkResult> |
createFrameworkAsync(CreateFrameworkRequest createFrameworkRequest,
AsyncHandler<CreateFrameworkRequest,CreateFrameworkResult> asyncHandler)
Creates a framework with one or more controls.
|
Future<CreateReportPlanResult> |
createReportPlanAsync(CreateReportPlanRequest createReportPlanRequest)
Creates a report plan.
|
Future<CreateReportPlanResult> |
createReportPlanAsync(CreateReportPlanRequest createReportPlanRequest,
AsyncHandler<CreateReportPlanRequest,CreateReportPlanResult> asyncHandler)
Creates a report plan.
|
Future<DeleteBackupPlanResult> |
deleteBackupPlanAsync(DeleteBackupPlanRequest deleteBackupPlanRequest)
Deletes a backup plan.
|
Future<DeleteBackupPlanResult> |
deleteBackupPlanAsync(DeleteBackupPlanRequest deleteBackupPlanRequest,
AsyncHandler<DeleteBackupPlanRequest,DeleteBackupPlanResult> asyncHandler)
Deletes a backup plan.
|
Future<DeleteBackupSelectionResult> |
deleteBackupSelectionAsync(DeleteBackupSelectionRequest deleteBackupSelectionRequest)
Deletes the resource selection associated with a backup plan that is specified by the
SelectionId . |
Future<DeleteBackupSelectionResult> |
deleteBackupSelectionAsync(DeleteBackupSelectionRequest deleteBackupSelectionRequest,
AsyncHandler<DeleteBackupSelectionRequest,DeleteBackupSelectionResult> asyncHandler)
Deletes the resource selection associated with a backup plan that is specified by the
SelectionId . |
Future<DeleteBackupVaultAccessPolicyResult> |
deleteBackupVaultAccessPolicyAsync(DeleteBackupVaultAccessPolicyRequest deleteBackupVaultAccessPolicyRequest)
Deletes the policy document that manages permissions on a backup vault.
|
Future<DeleteBackupVaultAccessPolicyResult> |
deleteBackupVaultAccessPolicyAsync(DeleteBackupVaultAccessPolicyRequest deleteBackupVaultAccessPolicyRequest,
AsyncHandler<DeleteBackupVaultAccessPolicyRequest,DeleteBackupVaultAccessPolicyResult> asyncHandler)
Deletes the policy document that manages permissions on a backup vault.
|
Future<DeleteBackupVaultResult> |
deleteBackupVaultAsync(DeleteBackupVaultRequest deleteBackupVaultRequest)
Deletes the backup vault identified by its name.
|
Future<DeleteBackupVaultResult> |
deleteBackupVaultAsync(DeleteBackupVaultRequest deleteBackupVaultRequest,
AsyncHandler<DeleteBackupVaultRequest,DeleteBackupVaultResult> asyncHandler)
Deletes the backup vault identified by its name.
|
Future<DeleteBackupVaultNotificationsResult> |
deleteBackupVaultNotificationsAsync(DeleteBackupVaultNotificationsRequest deleteBackupVaultNotificationsRequest)
Deletes event notifications for the specified backup vault.
|
Future<DeleteBackupVaultNotificationsResult> |
deleteBackupVaultNotificationsAsync(DeleteBackupVaultNotificationsRequest deleteBackupVaultNotificationsRequest,
AsyncHandler<DeleteBackupVaultNotificationsRequest,DeleteBackupVaultNotificationsResult> asyncHandler)
Deletes event notifications for the specified backup vault.
|
Future<DeleteFrameworkResult> |
deleteFrameworkAsync(DeleteFrameworkRequest deleteFrameworkRequest)
Deletes the framework specified by a framework name.
|
Future<DeleteFrameworkResult> |
deleteFrameworkAsync(DeleteFrameworkRequest deleteFrameworkRequest,
AsyncHandler<DeleteFrameworkRequest,DeleteFrameworkResult> asyncHandler)
Deletes the framework specified by a framework name.
|
Future<DeleteRecoveryPointResult> |
deleteRecoveryPointAsync(DeleteRecoveryPointRequest deleteRecoveryPointRequest)
Deletes the recovery point specified by a recovery point ID.
|
Future<DeleteRecoveryPointResult> |
deleteRecoveryPointAsync(DeleteRecoveryPointRequest deleteRecoveryPointRequest,
AsyncHandler<DeleteRecoveryPointRequest,DeleteRecoveryPointResult> asyncHandler)
Deletes the recovery point specified by a recovery point ID.
|
Future<DeleteReportPlanResult> |
deleteReportPlanAsync(DeleteReportPlanRequest deleteReportPlanRequest)
Deletes the report plan specified by a report plan name.
|
Future<DeleteReportPlanResult> |
deleteReportPlanAsync(DeleteReportPlanRequest deleteReportPlanRequest,
AsyncHandler<DeleteReportPlanRequest,DeleteReportPlanResult> asyncHandler)
Deletes the report plan specified by a report plan name.
|
Future<DescribeBackupJobResult> |
describeBackupJobAsync(DescribeBackupJobRequest describeBackupJobRequest)
Returns backup job details for the specified
BackupJobId . |
Future<DescribeBackupJobResult> |
describeBackupJobAsync(DescribeBackupJobRequest describeBackupJobRequest,
AsyncHandler<DescribeBackupJobRequest,DescribeBackupJobResult> asyncHandler)
Returns backup job details for the specified
BackupJobId . |
Future<DescribeBackupVaultResult> |
describeBackupVaultAsync(DescribeBackupVaultRequest describeBackupVaultRequest)
Returns metadata about a backup vault specified by its name.
|
Future<DescribeBackupVaultResult> |
describeBackupVaultAsync(DescribeBackupVaultRequest describeBackupVaultRequest,
AsyncHandler<DescribeBackupVaultRequest,DescribeBackupVaultResult> asyncHandler)
Returns metadata about a backup vault specified by its name.
|
Future<DescribeCopyJobResult> |
describeCopyJobAsync(DescribeCopyJobRequest describeCopyJobRequest)
Returns metadata associated with creating a copy of a resource.
|
Future<DescribeCopyJobResult> |
describeCopyJobAsync(DescribeCopyJobRequest describeCopyJobRequest,
AsyncHandler<DescribeCopyJobRequest,DescribeCopyJobResult> asyncHandler)
Returns metadata associated with creating a copy of a resource.
|
Future<DescribeFrameworkResult> |
describeFrameworkAsync(DescribeFrameworkRequest describeFrameworkRequest)
Returns the framework details for the specified
FrameworkName . |
Future<DescribeFrameworkResult> |
describeFrameworkAsync(DescribeFrameworkRequest describeFrameworkRequest,
AsyncHandler<DescribeFrameworkRequest,DescribeFrameworkResult> asyncHandler)
Returns the framework details for the specified
FrameworkName . |
Future<DescribeGlobalSettingsResult> |
describeGlobalSettingsAsync(DescribeGlobalSettingsRequest describeGlobalSettingsRequest)
Describes whether the Amazon Web Services account is opted in to cross-account backup.
|
Future<DescribeGlobalSettingsResult> |
describeGlobalSettingsAsync(DescribeGlobalSettingsRequest describeGlobalSettingsRequest,
AsyncHandler<DescribeGlobalSettingsRequest,DescribeGlobalSettingsResult> asyncHandler)
Describes whether the Amazon Web Services account is opted in to cross-account backup.
|
Future<DescribeProtectedResourceResult> |
describeProtectedResourceAsync(DescribeProtectedResourceRequest describeProtectedResourceRequest)
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.
|
Future<DescribeProtectedResourceResult> |
describeProtectedResourceAsync(DescribeProtectedResourceRequest describeProtectedResourceRequest,
AsyncHandler<DescribeProtectedResourceRequest,DescribeProtectedResourceResult> asyncHandler)
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.
|
Future<DescribeRecoveryPointResult> |
describeRecoveryPointAsync(DescribeRecoveryPointRequest describeRecoveryPointRequest)
Returns metadata associated with a recovery point, including ID, status, encryption, and lifecycle.
|
Future<DescribeRecoveryPointResult> |
describeRecoveryPointAsync(DescribeRecoveryPointRequest describeRecoveryPointRequest,
AsyncHandler<DescribeRecoveryPointRequest,DescribeRecoveryPointResult> asyncHandler)
Returns metadata associated with a recovery point, including ID, status, encryption, and lifecycle.
|
Future<DescribeRegionSettingsResult> |
describeRegionSettingsAsync(DescribeRegionSettingsRequest describeRegionSettingsRequest)
Returns the current service opt-in settings for the Region.
|
Future<DescribeRegionSettingsResult> |
describeRegionSettingsAsync(DescribeRegionSettingsRequest describeRegionSettingsRequest,
AsyncHandler<DescribeRegionSettingsRequest,DescribeRegionSettingsResult> asyncHandler)
Returns the current service opt-in settings for the Region.
|
Future<DescribeReportJobResult> |
describeReportJobAsync(DescribeReportJobRequest describeReportJobRequest)
Returns the details associated with creating a report as specified by its
ReportJobId . |
Future<DescribeReportJobResult> |
describeReportJobAsync(DescribeReportJobRequest describeReportJobRequest,
AsyncHandler<DescribeReportJobRequest,DescribeReportJobResult> asyncHandler)
Returns the details associated with creating a report as specified by its
ReportJobId . |
Future<DescribeReportPlanResult> |
describeReportPlanAsync(DescribeReportPlanRequest describeReportPlanRequest)
Returns a list of all report plans for an Amazon Web Services account and Amazon Web Services Region.
|
Future<DescribeReportPlanResult> |
describeReportPlanAsync(DescribeReportPlanRequest describeReportPlanRequest,
AsyncHandler<DescribeReportPlanRequest,DescribeReportPlanResult> asyncHandler)
Returns a list of all report plans for an Amazon Web Services account and Amazon Web Services Region.
|
Future<DescribeRestoreJobResult> |
describeRestoreJobAsync(DescribeRestoreJobRequest describeRestoreJobRequest)
Returns metadata associated with a restore job that is specified by a job ID.
|
Future<DescribeRestoreJobResult> |
describeRestoreJobAsync(DescribeRestoreJobRequest describeRestoreJobRequest,
AsyncHandler<DescribeRestoreJobRequest,DescribeRestoreJobResult> asyncHandler)
Returns metadata associated with a restore job that is specified by a job ID.
|
Future<DisassociateRecoveryPointResult> |
disassociateRecoveryPointAsync(DisassociateRecoveryPointRequest disassociateRecoveryPointRequest)
Deletes the specified continuous backup recovery point from Backup and releases control of that continuous backup
to the source service, such as Amazon RDS.
|
Future<DisassociateRecoveryPointResult> |
disassociateRecoveryPointAsync(DisassociateRecoveryPointRequest disassociateRecoveryPointRequest,
AsyncHandler<DisassociateRecoveryPointRequest,DisassociateRecoveryPointResult> asyncHandler)
Deletes the specified continuous backup recovery point from Backup and releases control of that continuous backup
to the source service, such as Amazon RDS.
|
Future<ExportBackupPlanTemplateResult> |
exportBackupPlanTemplateAsync(ExportBackupPlanTemplateRequest exportBackupPlanTemplateRequest)
Returns the backup plan that is specified by the plan ID as a backup template.
|
Future<ExportBackupPlanTemplateResult> |
exportBackupPlanTemplateAsync(ExportBackupPlanTemplateRequest exportBackupPlanTemplateRequest,
AsyncHandler<ExportBackupPlanTemplateRequest,ExportBackupPlanTemplateResult> asyncHandler)
Returns the backup plan that is specified by the plan ID as a backup template.
|
Future<GetBackupPlanResult> |
getBackupPlanAsync(GetBackupPlanRequest getBackupPlanRequest)
Returns
BackupPlan details for the specified BackupPlanId . |
Future<GetBackupPlanResult> |
getBackupPlanAsync(GetBackupPlanRequest getBackupPlanRequest,
AsyncHandler<GetBackupPlanRequest,GetBackupPlanResult> asyncHandler)
Returns
BackupPlan details for the specified BackupPlanId . |
Future<GetBackupPlanFromJSONResult> |
getBackupPlanFromJSONAsync(GetBackupPlanFromJSONRequest getBackupPlanFromJSONRequest)
Returns a valid JSON document specifying a backup plan or an error.
|
Future<GetBackupPlanFromJSONResult> |
getBackupPlanFromJSONAsync(GetBackupPlanFromJSONRequest getBackupPlanFromJSONRequest,
AsyncHandler<GetBackupPlanFromJSONRequest,GetBackupPlanFromJSONResult> asyncHandler)
Returns a valid JSON document specifying a backup plan or an error.
|
Future<GetBackupPlanFromTemplateResult> |
getBackupPlanFromTemplateAsync(GetBackupPlanFromTemplateRequest getBackupPlanFromTemplateRequest)
Returns the template specified by its
templateId as a backup plan. |
Future<GetBackupPlanFromTemplateResult> |
getBackupPlanFromTemplateAsync(GetBackupPlanFromTemplateRequest getBackupPlanFromTemplateRequest,
AsyncHandler<GetBackupPlanFromTemplateRequest,GetBackupPlanFromTemplateResult> asyncHandler)
Returns the template specified by its
templateId as a backup plan. |
Future<GetBackupSelectionResult> |
getBackupSelectionAsync(GetBackupSelectionRequest getBackupSelectionRequest)
Returns selection metadata and a document in JSON format that specifies a list of resources that are associated
with a backup plan.
|
Future<GetBackupSelectionResult> |
getBackupSelectionAsync(GetBackupSelectionRequest getBackupSelectionRequest,
AsyncHandler<GetBackupSelectionRequest,GetBackupSelectionResult> asyncHandler)
Returns selection metadata and a document in JSON format that specifies a list of resources that are associated
with a backup plan.
|
Future<GetBackupVaultAccessPolicyResult> |
getBackupVaultAccessPolicyAsync(GetBackupVaultAccessPolicyRequest getBackupVaultAccessPolicyRequest)
Returns the access policy document that is associated with the named backup vault.
|
Future<GetBackupVaultAccessPolicyResult> |
getBackupVaultAccessPolicyAsync(GetBackupVaultAccessPolicyRequest getBackupVaultAccessPolicyRequest,
AsyncHandler<GetBackupVaultAccessPolicyRequest,GetBackupVaultAccessPolicyResult> asyncHandler)
Returns the access policy document that is associated with the named backup vault.
|
Future<GetBackupVaultNotificationsResult> |
getBackupVaultNotificationsAsync(GetBackupVaultNotificationsRequest getBackupVaultNotificationsRequest)
Returns event notifications for the specified backup vault.
|
Future<GetBackupVaultNotificationsResult> |
getBackupVaultNotificationsAsync(GetBackupVaultNotificationsRequest getBackupVaultNotificationsRequest,
AsyncHandler<GetBackupVaultNotificationsRequest,GetBackupVaultNotificationsResult> asyncHandler)
Returns event notifications for the specified backup vault.
|
Future<GetRecoveryPointRestoreMetadataResult> |
getRecoveryPointRestoreMetadataAsync(GetRecoveryPointRestoreMetadataRequest getRecoveryPointRestoreMetadataRequest)
Returns a set of metadata key-value pairs that were used to create the backup.
|
Future<GetRecoveryPointRestoreMetadataResult> |
getRecoveryPointRestoreMetadataAsync(GetRecoveryPointRestoreMetadataRequest getRecoveryPointRestoreMetadataRequest,
AsyncHandler<GetRecoveryPointRestoreMetadataRequest,GetRecoveryPointRestoreMetadataResult> asyncHandler)
Returns a set of metadata key-value pairs that were used to create the backup.
|
Future<GetSupportedResourceTypesResult> |
getSupportedResourceTypesAsync(GetSupportedResourceTypesRequest getSupportedResourceTypesRequest)
Returns the Amazon Web Services resource types supported by Backup.
|
Future<GetSupportedResourceTypesResult> |
getSupportedResourceTypesAsync(GetSupportedResourceTypesRequest getSupportedResourceTypesRequest,
AsyncHandler<GetSupportedResourceTypesRequest,GetSupportedResourceTypesResult> asyncHandler)
Returns the Amazon Web Services resource types supported by Backup.
|
Future<ListBackupJobsResult> |
listBackupJobsAsync(ListBackupJobsRequest listBackupJobsRequest)
Returns a list of existing backup jobs for an authenticated account for the last 30 days.
|
Future<ListBackupJobsResult> |
listBackupJobsAsync(ListBackupJobsRequest listBackupJobsRequest,
AsyncHandler<ListBackupJobsRequest,ListBackupJobsResult> asyncHandler)
Returns a list of existing backup jobs for an authenticated account for the last 30 days.
|
Future<ListBackupPlansResult> |
listBackupPlansAsync(ListBackupPlansRequest listBackupPlansRequest)
Returns a list of all active backup plans for an authenticated account.
|
Future<ListBackupPlansResult> |
listBackupPlansAsync(ListBackupPlansRequest listBackupPlansRequest,
AsyncHandler<ListBackupPlansRequest,ListBackupPlansResult> asyncHandler)
Returns a list of all active backup plans for an authenticated account.
|
Future<ListBackupPlanTemplatesResult> |
listBackupPlanTemplatesAsync(ListBackupPlanTemplatesRequest listBackupPlanTemplatesRequest)
Returns metadata of your saved backup plan templates, including the template ID, name, and the creation and
deletion dates.
|
Future<ListBackupPlanTemplatesResult> |
listBackupPlanTemplatesAsync(ListBackupPlanTemplatesRequest listBackupPlanTemplatesRequest,
AsyncHandler<ListBackupPlanTemplatesRequest,ListBackupPlanTemplatesResult> asyncHandler)
Returns metadata of your saved backup plan templates, including the template ID, name, and the creation and
deletion dates.
|
Future<ListBackupPlanVersionsResult> |
listBackupPlanVersionsAsync(ListBackupPlanVersionsRequest listBackupPlanVersionsRequest)
Returns version metadata of your backup plans, including Amazon Resource Names (ARNs), backup plan IDs, creation
and deletion dates, plan names, and version IDs.
|
Future<ListBackupPlanVersionsResult> |
listBackupPlanVersionsAsync(ListBackupPlanVersionsRequest listBackupPlanVersionsRequest,
AsyncHandler<ListBackupPlanVersionsRequest,ListBackupPlanVersionsResult> asyncHandler)
Returns version metadata of your backup plans, including Amazon Resource Names (ARNs), backup plan IDs, creation
and deletion dates, plan names, and version IDs.
|
Future<ListBackupSelectionsResult> |
listBackupSelectionsAsync(ListBackupSelectionsRequest listBackupSelectionsRequest)
Returns an array containing metadata of the resources associated with the target backup plan.
|
Future<ListBackupSelectionsResult> |
listBackupSelectionsAsync(ListBackupSelectionsRequest listBackupSelectionsRequest,
AsyncHandler<ListBackupSelectionsRequest,ListBackupSelectionsResult> asyncHandler)
Returns an array containing metadata of the resources associated with the target backup plan.
|
Future<ListBackupVaultsResult> |
listBackupVaultsAsync(ListBackupVaultsRequest listBackupVaultsRequest)
Returns a list of recovery point storage containers along with information about them.
|
Future<ListBackupVaultsResult> |
listBackupVaultsAsync(ListBackupVaultsRequest listBackupVaultsRequest,
AsyncHandler<ListBackupVaultsRequest,ListBackupVaultsResult> asyncHandler)
Returns a list of recovery point storage containers along with information about them.
|
Future<ListCopyJobsResult> |
listCopyJobsAsync(ListCopyJobsRequest listCopyJobsRequest)
Returns metadata about your copy jobs.
|
Future<ListCopyJobsResult> |
listCopyJobsAsync(ListCopyJobsRequest listCopyJobsRequest,
AsyncHandler<ListCopyJobsRequest,ListCopyJobsResult> asyncHandler)
Returns metadata about your copy jobs.
|
Future<ListFrameworksResult> |
listFrameworksAsync(ListFrameworksRequest listFrameworksRequest)
Returns a list of all frameworks for an Amazon Web Services account and Amazon Web Services Region.
|
Future<ListFrameworksResult> |
listFrameworksAsync(ListFrameworksRequest listFrameworksRequest,
AsyncHandler<ListFrameworksRequest,ListFrameworksResult> asyncHandler)
Returns a list of all frameworks for an Amazon Web Services account and Amazon Web Services Region.
|
Future<ListProtectedResourcesResult> |
listProtectedResourcesAsync(ListProtectedResourcesRequest listProtectedResourcesRequest)
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.
|
Future<ListProtectedResourcesResult> |
listProtectedResourcesAsync(ListProtectedResourcesRequest listProtectedResourcesRequest,
AsyncHandler<ListProtectedResourcesRequest,ListProtectedResourcesResult> asyncHandler)
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.
|
Future<ListRecoveryPointsByBackupVaultResult> |
listRecoveryPointsByBackupVaultAsync(ListRecoveryPointsByBackupVaultRequest listRecoveryPointsByBackupVaultRequest)
Returns detailed information about the recovery points stored in a backup vault.
|
Future<ListRecoveryPointsByBackupVaultResult> |
listRecoveryPointsByBackupVaultAsync(ListRecoveryPointsByBackupVaultRequest listRecoveryPointsByBackupVaultRequest,
AsyncHandler<ListRecoveryPointsByBackupVaultRequest,ListRecoveryPointsByBackupVaultResult> asyncHandler)
Returns detailed information about the recovery points stored in a backup vault.
|
Future<ListRecoveryPointsByResourceResult> |
listRecoveryPointsByResourceAsync(ListRecoveryPointsByResourceRequest listRecoveryPointsByResourceRequest)
Returns detailed information about all the recovery points of the type specified by a resource Amazon Resource
Name (ARN).
|
Future<ListRecoveryPointsByResourceResult> |
listRecoveryPointsByResourceAsync(ListRecoveryPointsByResourceRequest listRecoveryPointsByResourceRequest,
AsyncHandler<ListRecoveryPointsByResourceRequest,ListRecoveryPointsByResourceResult> asyncHandler)
Returns detailed information about all the recovery points of the type specified by a resource Amazon Resource
Name (ARN).
|
Future<ListReportJobsResult> |
listReportJobsAsync(ListReportJobsRequest listReportJobsRequest)
Returns details about your report jobs.
|
Future<ListReportJobsResult> |
listReportJobsAsync(ListReportJobsRequest listReportJobsRequest,
AsyncHandler<ListReportJobsRequest,ListReportJobsResult> asyncHandler)
Returns details about your report jobs.
|
Future<ListReportPlansResult> |
listReportPlansAsync(ListReportPlansRequest listReportPlansRequest)
Returns a list of your report plans.
|
Future<ListReportPlansResult> |
listReportPlansAsync(ListReportPlansRequest listReportPlansRequest,
AsyncHandler<ListReportPlansRequest,ListReportPlansResult> asyncHandler)
Returns a list of your report plans.
|
Future<ListRestoreJobsResult> |
listRestoreJobsAsync(ListRestoreJobsRequest listRestoreJobsRequest)
Returns a list of jobs that Backup initiated to restore a saved resource, including details about the recovery
process.
|
Future<ListRestoreJobsResult> |
listRestoreJobsAsync(ListRestoreJobsRequest listRestoreJobsRequest,
AsyncHandler<ListRestoreJobsRequest,ListRestoreJobsResult> asyncHandler)
Returns a list of jobs that Backup initiated to restore a saved resource, including details about the recovery
process.
|
Future<ListTagsResult> |
listTagsAsync(ListTagsRequest listTagsRequest)
Returns a list of key-value pairs assigned to a target recovery point, backup plan, or backup vault.
|
Future<ListTagsResult> |
listTagsAsync(ListTagsRequest listTagsRequest,
AsyncHandler<ListTagsRequest,ListTagsResult> asyncHandler)
Returns a list of key-value pairs assigned to a target recovery point, backup plan, or backup vault.
|
Future<PutBackupVaultAccessPolicyResult> |
putBackupVaultAccessPolicyAsync(PutBackupVaultAccessPolicyRequest putBackupVaultAccessPolicyRequest)
Sets a resource-based policy that is used to manage access permissions on the target backup vault.
|
Future<PutBackupVaultAccessPolicyResult> |
putBackupVaultAccessPolicyAsync(PutBackupVaultAccessPolicyRequest putBackupVaultAccessPolicyRequest,
AsyncHandler<PutBackupVaultAccessPolicyRequest,PutBackupVaultAccessPolicyResult> asyncHandler)
Sets a resource-based policy that is used to manage access permissions on the target backup vault.
|
Future<PutBackupVaultNotificationsResult> |
putBackupVaultNotificationsAsync(PutBackupVaultNotificationsRequest putBackupVaultNotificationsRequest)
Turns on notifications on a backup vault for the specified topic and events.
|
Future<PutBackupVaultNotificationsResult> |
putBackupVaultNotificationsAsync(PutBackupVaultNotificationsRequest putBackupVaultNotificationsRequest,
AsyncHandler<PutBackupVaultNotificationsRequest,PutBackupVaultNotificationsResult> asyncHandler)
Turns on notifications on a backup vault for the specified topic and events.
|
Future<StartBackupJobResult> |
startBackupJobAsync(StartBackupJobRequest startBackupJobRequest)
Starts an on-demand backup job for the specified resource.
|
Future<StartBackupJobResult> |
startBackupJobAsync(StartBackupJobRequest startBackupJobRequest,
AsyncHandler<StartBackupJobRequest,StartBackupJobResult> asyncHandler)
Starts an on-demand backup job for the specified resource.
|
Future<StartCopyJobResult> |
startCopyJobAsync(StartCopyJobRequest startCopyJobRequest)
Starts a job to create a one-time copy of the specified resource.
|
Future<StartCopyJobResult> |
startCopyJobAsync(StartCopyJobRequest startCopyJobRequest,
AsyncHandler<StartCopyJobRequest,StartCopyJobResult> asyncHandler)
Starts a job to create a one-time copy of the specified resource.
|
Future<StartReportJobResult> |
startReportJobAsync(StartReportJobRequest startReportJobRequest)
Starts an on-demand report job for the specified report plan.
|
Future<StartReportJobResult> |
startReportJobAsync(StartReportJobRequest startReportJobRequest,
AsyncHandler<StartReportJobRequest,StartReportJobResult> asyncHandler)
Starts an on-demand report job for the specified report plan.
|
Future<StartRestoreJobResult> |
startRestoreJobAsync(StartRestoreJobRequest startRestoreJobRequest)
Recovers the saved resource identified by an Amazon Resource Name (ARN).
|
Future<StartRestoreJobResult> |
startRestoreJobAsync(StartRestoreJobRequest startRestoreJobRequest,
AsyncHandler<StartRestoreJobRequest,StartRestoreJobResult> asyncHandler)
Recovers the saved resource identified by an Amazon Resource Name (ARN).
|
Future<StopBackupJobResult> |
stopBackupJobAsync(StopBackupJobRequest stopBackupJobRequest)
Attempts to cancel a job to create a one-time backup of a resource.
|
Future<StopBackupJobResult> |
stopBackupJobAsync(StopBackupJobRequest stopBackupJobRequest,
AsyncHandler<StopBackupJobRequest,StopBackupJobResult> asyncHandler)
Attempts to cancel a job to create a one-time backup of a resource.
|
Future<TagResourceResult> |
tagResourceAsync(TagResourceRequest tagResourceRequest)
Assigns a set of key-value pairs to a recovery point, backup plan, or backup vault identified by an Amazon
Resource Name (ARN).
|
Future<TagResourceResult> |
tagResourceAsync(TagResourceRequest tagResourceRequest,
AsyncHandler<TagResourceRequest,TagResourceResult> asyncHandler)
Assigns a set of key-value pairs to a recovery point, backup plan, or backup vault identified by an Amazon
Resource Name (ARN).
|
Future<UntagResourceResult> |
untagResourceAsync(UntagResourceRequest untagResourceRequest)
Removes a set of key-value pairs from a recovery point, backup plan, or backup vault identified by an Amazon
Resource Name (ARN)
|
Future<UntagResourceResult> |
untagResourceAsync(UntagResourceRequest untagResourceRequest,
AsyncHandler<UntagResourceRequest,UntagResourceResult> asyncHandler)
Removes a set of key-value pairs from a recovery point, backup plan, or backup vault identified by an Amazon
Resource Name (ARN)
|
Future<UpdateBackupPlanResult> |
updateBackupPlanAsync(UpdateBackupPlanRequest updateBackupPlanRequest)
Updates an existing backup plan identified by its
backupPlanId with the input document in JSON
format. |
Future<UpdateBackupPlanResult> |
updateBackupPlanAsync(UpdateBackupPlanRequest updateBackupPlanRequest,
AsyncHandler<UpdateBackupPlanRequest,UpdateBackupPlanResult> asyncHandler)
Updates an existing backup plan identified by its
backupPlanId with the input document in JSON
format. |
Future<UpdateFrameworkResult> |
updateFrameworkAsync(UpdateFrameworkRequest updateFrameworkRequest)
Updates an existing framework identified by its
FrameworkName with the input document in JSON
format. |
Future<UpdateFrameworkResult> |
updateFrameworkAsync(UpdateFrameworkRequest updateFrameworkRequest,
AsyncHandler<UpdateFrameworkRequest,UpdateFrameworkResult> asyncHandler)
Updates an existing framework identified by its
FrameworkName with the input document in JSON
format. |
Future<UpdateGlobalSettingsResult> |
updateGlobalSettingsAsync(UpdateGlobalSettingsRequest updateGlobalSettingsRequest)
Updates whether the Amazon Web Services account is opted in to cross-account backup.
|
Future<UpdateGlobalSettingsResult> |
updateGlobalSettingsAsync(UpdateGlobalSettingsRequest updateGlobalSettingsRequest,
AsyncHandler<UpdateGlobalSettingsRequest,UpdateGlobalSettingsResult> asyncHandler)
Updates whether the Amazon Web Services account is opted in to cross-account backup.
|
Future<UpdateRecoveryPointLifecycleResult> |
updateRecoveryPointLifecycleAsync(UpdateRecoveryPointLifecycleRequest updateRecoveryPointLifecycleRequest)
Sets the transition lifecycle of a recovery point.
|
Future<UpdateRecoveryPointLifecycleResult> |
updateRecoveryPointLifecycleAsync(UpdateRecoveryPointLifecycleRequest updateRecoveryPointLifecycleRequest,
AsyncHandler<UpdateRecoveryPointLifecycleRequest,UpdateRecoveryPointLifecycleResult> asyncHandler)
Sets the transition lifecycle of a recovery point.
|
Future<UpdateRegionSettingsResult> |
updateRegionSettingsAsync(UpdateRegionSettingsRequest updateRegionSettingsRequest)
Updates the current service opt-in settings for the Region.
|
Future<UpdateRegionSettingsResult> |
updateRegionSettingsAsync(UpdateRegionSettingsRequest updateRegionSettingsRequest,
AsyncHandler<UpdateRegionSettingsRequest,UpdateRegionSettingsResult> asyncHandler)
Updates the current service opt-in settings for the Region.
|
Future<UpdateReportPlanResult> |
updateReportPlanAsync(UpdateReportPlanRequest updateReportPlanRequest)
Updates an existing report plan identified by its
ReportPlanName with the input document in JSON
format. |
Future<UpdateReportPlanResult> |
updateReportPlanAsync(UpdateReportPlanRequest updateReportPlanRequest,
AsyncHandler<UpdateReportPlanRequest,UpdateReportPlanResult> asyncHandler)
Updates an existing report plan identified by its
ReportPlanName with the input document in JSON
format. |
createBackupPlan, createBackupSelection, createBackupVault, createFramework, createReportPlan, deleteBackupPlan, deleteBackupSelection, deleteBackupVault, deleteBackupVaultAccessPolicy, deleteBackupVaultNotifications, deleteFramework, deleteRecoveryPoint, deleteReportPlan, describeBackupJob, describeBackupVault, describeCopyJob, describeFramework, describeGlobalSettings, describeProtectedResource, describeRecoveryPoint, describeRegionSettings, describeReportJob, describeReportPlan, describeRestoreJob, disassociateRecoveryPoint, exportBackupPlanTemplate, getBackupPlan, getBackupPlanFromJSON, getBackupPlanFromTemplate, getBackupSelection, getBackupVaultAccessPolicy, getBackupVaultNotifications, getCachedResponseMetadata, getRecoveryPointRestoreMetadata, getSupportedResourceTypes, listBackupJobs, listBackupPlans, listBackupPlanTemplates, listBackupPlanVersions, listBackupSelections, listBackupVaults, listCopyJobs, listFrameworks, listProtectedResources, listRecoveryPointsByBackupVault, listRecoveryPointsByResource, listReportJobs, listReportPlans, listRestoreJobs, listTags, putBackupVaultAccessPolicy, putBackupVaultNotifications, shutdown, startBackupJob, startCopyJob, startReportJob, startRestoreJob, stopBackupJob, tagResource, untagResource, updateBackupPlan, updateFramework, updateGlobalSettings, updateRecoveryPointLifecycle, updateRegionSettings, updateReportPlan
Future<CreateBackupPlanResult> createBackupPlanAsync(CreateBackupPlanRequest createBackupPlanRequest)
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.
createBackupPlanRequest
- Future<CreateBackupPlanResult> createBackupPlanAsync(CreateBackupPlanRequest createBackupPlanRequest, AsyncHandler<CreateBackupPlanRequest,CreateBackupPlanResult> asyncHandler)
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.
createBackupPlanRequest
- asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<CreateBackupSelectionResult> createBackupSelectionAsync(CreateBackupSelectionRequest createBackupSelectionRequest)
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.
createBackupSelectionRequest
- Future<CreateBackupSelectionResult> createBackupSelectionAsync(CreateBackupSelectionRequest createBackupSelectionRequest, AsyncHandler<CreateBackupSelectionRequest,CreateBackupSelectionResult> asyncHandler)
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.
createBackupSelectionRequest
- asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<CreateBackupVaultResult> createBackupVaultAsync(CreateBackupVaultRequest createBackupVaultRequest)
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.
createBackupVaultRequest
- Future<CreateBackupVaultResult> createBackupVaultAsync(CreateBackupVaultRequest createBackupVaultRequest, AsyncHandler<CreateBackupVaultRequest,CreateBackupVaultResult> asyncHandler)
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.
createBackupVaultRequest
- asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<CreateFrameworkResult> createFrameworkAsync(CreateFrameworkRequest createFrameworkRequest)
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.
createFrameworkRequest
- Future<CreateFrameworkResult> createFrameworkAsync(CreateFrameworkRequest createFrameworkRequest, AsyncHandler<CreateFrameworkRequest,CreateFrameworkResult> asyncHandler)
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.
createFrameworkRequest
- asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<CreateReportPlanResult> createReportPlanAsync(CreateReportPlanRequest createReportPlanRequest)
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.
createReportPlanRequest
- Future<CreateReportPlanResult> createReportPlanAsync(CreateReportPlanRequest createReportPlanRequest, AsyncHandler<CreateReportPlanRequest,CreateReportPlanResult> asyncHandler)
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.
createReportPlanRequest
- asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<DeleteBackupPlanResult> deleteBackupPlanAsync(DeleteBackupPlanRequest deleteBackupPlanRequest)
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.
deleteBackupPlanRequest
- Future<DeleteBackupPlanResult> deleteBackupPlanAsync(DeleteBackupPlanRequest deleteBackupPlanRequest, AsyncHandler<DeleteBackupPlanRequest,DeleteBackupPlanResult> asyncHandler)
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.
deleteBackupPlanRequest
- asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<DeleteBackupSelectionResult> deleteBackupSelectionAsync(DeleteBackupSelectionRequest deleteBackupSelectionRequest)
Deletes the resource selection associated with a backup plan that is specified by the SelectionId
.
deleteBackupSelectionRequest
- Future<DeleteBackupSelectionResult> deleteBackupSelectionAsync(DeleteBackupSelectionRequest deleteBackupSelectionRequest, AsyncHandler<DeleteBackupSelectionRequest,DeleteBackupSelectionResult> asyncHandler)
Deletes the resource selection associated with a backup plan that is specified by the SelectionId
.
deleteBackupSelectionRequest
- asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<DeleteBackupVaultResult> deleteBackupVaultAsync(DeleteBackupVaultRequest deleteBackupVaultRequest)
Deletes the backup vault identified by its name. A vault can be deleted only if it is empty.
deleteBackupVaultRequest
- Future<DeleteBackupVaultResult> deleteBackupVaultAsync(DeleteBackupVaultRequest deleteBackupVaultRequest, AsyncHandler<DeleteBackupVaultRequest,DeleteBackupVaultResult> asyncHandler)
Deletes the backup vault identified by its name. A vault can be deleted only if it is empty.
deleteBackupVaultRequest
- asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<DeleteBackupVaultAccessPolicyResult> deleteBackupVaultAccessPolicyAsync(DeleteBackupVaultAccessPolicyRequest deleteBackupVaultAccessPolicyRequest)
Deletes the policy document that manages permissions on a backup vault.
deleteBackupVaultAccessPolicyRequest
- Future<DeleteBackupVaultAccessPolicyResult> deleteBackupVaultAccessPolicyAsync(DeleteBackupVaultAccessPolicyRequest deleteBackupVaultAccessPolicyRequest, AsyncHandler<DeleteBackupVaultAccessPolicyRequest,DeleteBackupVaultAccessPolicyResult> asyncHandler)
Deletes the policy document that manages permissions on a backup vault.
deleteBackupVaultAccessPolicyRequest
- asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<DeleteBackupVaultNotificationsResult> deleteBackupVaultNotificationsAsync(DeleteBackupVaultNotificationsRequest deleteBackupVaultNotificationsRequest)
Deletes event notifications for the specified backup vault.
deleteBackupVaultNotificationsRequest
- Future<DeleteBackupVaultNotificationsResult> deleteBackupVaultNotificationsAsync(DeleteBackupVaultNotificationsRequest deleteBackupVaultNotificationsRequest, AsyncHandler<DeleteBackupVaultNotificationsRequest,DeleteBackupVaultNotificationsResult> asyncHandler)
Deletes event notifications for the specified backup vault.
deleteBackupVaultNotificationsRequest
- asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<DeleteFrameworkResult> deleteFrameworkAsync(DeleteFrameworkRequest deleteFrameworkRequest)
Deletes the framework specified by a framework name.
deleteFrameworkRequest
- Future<DeleteFrameworkResult> deleteFrameworkAsync(DeleteFrameworkRequest deleteFrameworkRequest, AsyncHandler<DeleteFrameworkRequest,DeleteFrameworkResult> asyncHandler)
Deletes the framework specified by a framework name.
deleteFrameworkRequest
- asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<DeleteRecoveryPointResult> deleteRecoveryPointAsync(DeleteRecoveryPointRequest deleteRecoveryPointRequest)
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.
deleteRecoveryPointRequest
- Future<DeleteRecoveryPointResult> deleteRecoveryPointAsync(DeleteRecoveryPointRequest deleteRecoveryPointRequest, AsyncHandler<DeleteRecoveryPointRequest,DeleteRecoveryPointResult> asyncHandler)
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.
deleteRecoveryPointRequest
- asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<DeleteReportPlanResult> deleteReportPlanAsync(DeleteReportPlanRequest deleteReportPlanRequest)
Deletes the report plan specified by a report plan name.
deleteReportPlanRequest
- Future<DeleteReportPlanResult> deleteReportPlanAsync(DeleteReportPlanRequest deleteReportPlanRequest, AsyncHandler<DeleteReportPlanRequest,DeleteReportPlanResult> asyncHandler)
Deletes the report plan specified by a report plan name.
deleteReportPlanRequest
- asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<DescribeBackupJobResult> describeBackupJobAsync(DescribeBackupJobRequest describeBackupJobRequest)
Returns backup job details for the specified BackupJobId
.
describeBackupJobRequest
- Future<DescribeBackupJobResult> describeBackupJobAsync(DescribeBackupJobRequest describeBackupJobRequest, AsyncHandler<DescribeBackupJobRequest,DescribeBackupJobResult> asyncHandler)
Returns backup job details for the specified BackupJobId
.
describeBackupJobRequest
- asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<DescribeBackupVaultResult> describeBackupVaultAsync(DescribeBackupVaultRequest describeBackupVaultRequest)
Returns metadata about a backup vault specified by its name.
describeBackupVaultRequest
- Future<DescribeBackupVaultResult> describeBackupVaultAsync(DescribeBackupVaultRequest describeBackupVaultRequest, AsyncHandler<DescribeBackupVaultRequest,DescribeBackupVaultResult> asyncHandler)
Returns metadata about a backup vault specified by its name.
describeBackupVaultRequest
- asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<DescribeCopyJobResult> describeCopyJobAsync(DescribeCopyJobRequest describeCopyJobRequest)
Returns metadata associated with creating a copy of a resource.
describeCopyJobRequest
- Future<DescribeCopyJobResult> describeCopyJobAsync(DescribeCopyJobRequest describeCopyJobRequest, AsyncHandler<DescribeCopyJobRequest,DescribeCopyJobResult> asyncHandler)
Returns metadata associated with creating a copy of a resource.
describeCopyJobRequest
- asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<DescribeFrameworkResult> describeFrameworkAsync(DescribeFrameworkRequest describeFrameworkRequest)
Returns the framework details for the specified FrameworkName
.
describeFrameworkRequest
- Future<DescribeFrameworkResult> describeFrameworkAsync(DescribeFrameworkRequest describeFrameworkRequest, AsyncHandler<DescribeFrameworkRequest,DescribeFrameworkResult> asyncHandler)
Returns the framework details for the specified FrameworkName
.
describeFrameworkRequest
- asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<DescribeGlobalSettingsResult> describeGlobalSettingsAsync(DescribeGlobalSettingsRequest describeGlobalSettingsRequest)
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
describeGlobalSettingsRequest
- Future<DescribeGlobalSettingsResult> describeGlobalSettingsAsync(DescribeGlobalSettingsRequest describeGlobalSettingsRequest, AsyncHandler<DescribeGlobalSettingsRequest,DescribeGlobalSettingsResult> asyncHandler)
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
describeGlobalSettingsRequest
- asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<DescribeProtectedResourceResult> describeProtectedResourceAsync(DescribeProtectedResourceRequest describeProtectedResourceRequest)
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.
describeProtectedResourceRequest
- Future<DescribeProtectedResourceResult> describeProtectedResourceAsync(DescribeProtectedResourceRequest describeProtectedResourceRequest, AsyncHandler<DescribeProtectedResourceRequest,DescribeProtectedResourceResult> asyncHandler)
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.
describeProtectedResourceRequest
- asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<DescribeRecoveryPointResult> describeRecoveryPointAsync(DescribeRecoveryPointRequest describeRecoveryPointRequest)
Returns metadata associated with a recovery point, including ID, status, encryption, and lifecycle.
describeRecoveryPointRequest
- Future<DescribeRecoveryPointResult> describeRecoveryPointAsync(DescribeRecoveryPointRequest describeRecoveryPointRequest, AsyncHandler<DescribeRecoveryPointRequest,DescribeRecoveryPointResult> asyncHandler)
Returns metadata associated with a recovery point, including ID, status, encryption, and lifecycle.
describeRecoveryPointRequest
- asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<DescribeRegionSettingsResult> describeRegionSettingsAsync(DescribeRegionSettingsRequest describeRegionSettingsRequest)
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.
describeRegionSettingsRequest
- Future<DescribeRegionSettingsResult> describeRegionSettingsAsync(DescribeRegionSettingsRequest describeRegionSettingsRequest, AsyncHandler<DescribeRegionSettingsRequest,DescribeRegionSettingsResult> asyncHandler)
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.
describeRegionSettingsRequest
- asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<DescribeReportJobResult> describeReportJobAsync(DescribeReportJobRequest describeReportJobRequest)
Returns the details associated with creating a report as specified by its ReportJobId
.
describeReportJobRequest
- Future<DescribeReportJobResult> describeReportJobAsync(DescribeReportJobRequest describeReportJobRequest, AsyncHandler<DescribeReportJobRequest,DescribeReportJobResult> asyncHandler)
Returns the details associated with creating a report as specified by its ReportJobId
.
describeReportJobRequest
- asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<DescribeReportPlanResult> describeReportPlanAsync(DescribeReportPlanRequest describeReportPlanRequest)
Returns a list of all report plans for an Amazon Web Services account and Amazon Web Services Region.
describeReportPlanRequest
- Future<DescribeReportPlanResult> describeReportPlanAsync(DescribeReportPlanRequest describeReportPlanRequest, AsyncHandler<DescribeReportPlanRequest,DescribeReportPlanResult> asyncHandler)
Returns a list of all report plans for an Amazon Web Services account and Amazon Web Services Region.
describeReportPlanRequest
- asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<DescribeRestoreJobResult> describeRestoreJobAsync(DescribeRestoreJobRequest describeRestoreJobRequest)
Returns metadata associated with a restore job that is specified by a job ID.
describeRestoreJobRequest
- Future<DescribeRestoreJobResult> describeRestoreJobAsync(DescribeRestoreJobRequest describeRestoreJobRequest, AsyncHandler<DescribeRestoreJobRequest,DescribeRestoreJobResult> asyncHandler)
Returns metadata associated with a restore job that is specified by a job ID.
describeRestoreJobRequest
- asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<DisassociateRecoveryPointResult> disassociateRecoveryPointAsync(DisassociateRecoveryPointRequest disassociateRecoveryPointRequest)
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.
disassociateRecoveryPointRequest
- Future<DisassociateRecoveryPointResult> disassociateRecoveryPointAsync(DisassociateRecoveryPointRequest disassociateRecoveryPointRequest, AsyncHandler<DisassociateRecoveryPointRequest,DisassociateRecoveryPointResult> asyncHandler)
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.
disassociateRecoveryPointRequest
- asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<ExportBackupPlanTemplateResult> exportBackupPlanTemplateAsync(ExportBackupPlanTemplateRequest exportBackupPlanTemplateRequest)
Returns the backup plan that is specified by the plan ID as a backup template.
exportBackupPlanTemplateRequest
- Future<ExportBackupPlanTemplateResult> exportBackupPlanTemplateAsync(ExportBackupPlanTemplateRequest exportBackupPlanTemplateRequest, AsyncHandler<ExportBackupPlanTemplateRequest,ExportBackupPlanTemplateResult> asyncHandler)
Returns the backup plan that is specified by the plan ID as a backup template.
exportBackupPlanTemplateRequest
- asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<GetBackupPlanResult> getBackupPlanAsync(GetBackupPlanRequest getBackupPlanRequest)
Returns BackupPlan
details for the specified BackupPlanId
. The details are the body of
a backup plan in JSON format, in addition to plan metadata.
getBackupPlanRequest
- Future<GetBackupPlanResult> getBackupPlanAsync(GetBackupPlanRequest getBackupPlanRequest, AsyncHandler<GetBackupPlanRequest,GetBackupPlanResult> asyncHandler)
Returns BackupPlan
details for the specified BackupPlanId
. The details are the body of
a backup plan in JSON format, in addition to plan metadata.
getBackupPlanRequest
- asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<GetBackupPlanFromJSONResult> getBackupPlanFromJSONAsync(GetBackupPlanFromJSONRequest getBackupPlanFromJSONRequest)
Returns a valid JSON document specifying a backup plan or an error.
getBackupPlanFromJSONRequest
- Future<GetBackupPlanFromJSONResult> getBackupPlanFromJSONAsync(GetBackupPlanFromJSONRequest getBackupPlanFromJSONRequest, AsyncHandler<GetBackupPlanFromJSONRequest,GetBackupPlanFromJSONResult> asyncHandler)
Returns a valid JSON document specifying a backup plan or an error.
getBackupPlanFromJSONRequest
- asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<GetBackupPlanFromTemplateResult> getBackupPlanFromTemplateAsync(GetBackupPlanFromTemplateRequest getBackupPlanFromTemplateRequest)
Returns the template specified by its templateId
as a backup plan.
getBackupPlanFromTemplateRequest
- Future<GetBackupPlanFromTemplateResult> getBackupPlanFromTemplateAsync(GetBackupPlanFromTemplateRequest getBackupPlanFromTemplateRequest, AsyncHandler<GetBackupPlanFromTemplateRequest,GetBackupPlanFromTemplateResult> asyncHandler)
Returns the template specified by its templateId
as a backup plan.
getBackupPlanFromTemplateRequest
- asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<GetBackupSelectionResult> getBackupSelectionAsync(GetBackupSelectionRequest getBackupSelectionRequest)
Returns selection metadata and a document in JSON format that specifies a list of resources that are associated with a backup plan.
getBackupSelectionRequest
- Future<GetBackupSelectionResult> getBackupSelectionAsync(GetBackupSelectionRequest getBackupSelectionRequest, AsyncHandler<GetBackupSelectionRequest,GetBackupSelectionResult> asyncHandler)
Returns selection metadata and a document in JSON format that specifies a list of resources that are associated with a backup plan.
getBackupSelectionRequest
- asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<GetBackupVaultAccessPolicyResult> getBackupVaultAccessPolicyAsync(GetBackupVaultAccessPolicyRequest getBackupVaultAccessPolicyRequest)
Returns the access policy document that is associated with the named backup vault.
getBackupVaultAccessPolicyRequest
- Future<GetBackupVaultAccessPolicyResult> getBackupVaultAccessPolicyAsync(GetBackupVaultAccessPolicyRequest getBackupVaultAccessPolicyRequest, AsyncHandler<GetBackupVaultAccessPolicyRequest,GetBackupVaultAccessPolicyResult> asyncHandler)
Returns the access policy document that is associated with the named backup vault.
getBackupVaultAccessPolicyRequest
- asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<GetBackupVaultNotificationsResult> getBackupVaultNotificationsAsync(GetBackupVaultNotificationsRequest getBackupVaultNotificationsRequest)
Returns event notifications for the specified backup vault.
getBackupVaultNotificationsRequest
- Future<GetBackupVaultNotificationsResult> getBackupVaultNotificationsAsync(GetBackupVaultNotificationsRequest getBackupVaultNotificationsRequest, AsyncHandler<GetBackupVaultNotificationsRequest,GetBackupVaultNotificationsResult> asyncHandler)
Returns event notifications for the specified backup vault.
getBackupVaultNotificationsRequest
- asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<GetRecoveryPointRestoreMetadataResult> getRecoveryPointRestoreMetadataAsync(GetRecoveryPointRestoreMetadataRequest getRecoveryPointRestoreMetadataRequest)
Returns a set of metadata key-value pairs that were used to create the backup.
getRecoveryPointRestoreMetadataRequest
- Future<GetRecoveryPointRestoreMetadataResult> getRecoveryPointRestoreMetadataAsync(GetRecoveryPointRestoreMetadataRequest getRecoveryPointRestoreMetadataRequest, AsyncHandler<GetRecoveryPointRestoreMetadataRequest,GetRecoveryPointRestoreMetadataResult> asyncHandler)
Returns a set of metadata key-value pairs that were used to create the backup.
getRecoveryPointRestoreMetadataRequest
- asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<GetSupportedResourceTypesResult> getSupportedResourceTypesAsync(GetSupportedResourceTypesRequest getSupportedResourceTypesRequest)
Returns the Amazon Web Services resource types supported by Backup.
getSupportedResourceTypesRequest
- Future<GetSupportedResourceTypesResult> getSupportedResourceTypesAsync(GetSupportedResourceTypesRequest getSupportedResourceTypesRequest, AsyncHandler<GetSupportedResourceTypesRequest,GetSupportedResourceTypesResult> asyncHandler)
Returns the Amazon Web Services resource types supported by Backup.
getSupportedResourceTypesRequest
- asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<ListBackupJobsResult> listBackupJobsAsync(ListBackupJobsRequest listBackupJobsRequest)
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.
listBackupJobsRequest
- Future<ListBackupJobsResult> listBackupJobsAsync(ListBackupJobsRequest listBackupJobsRequest, AsyncHandler<ListBackupJobsRequest,ListBackupJobsResult> asyncHandler)
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.
listBackupJobsRequest
- asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<ListBackupPlanTemplatesResult> listBackupPlanTemplatesAsync(ListBackupPlanTemplatesRequest listBackupPlanTemplatesRequest)
Returns metadata of your saved backup plan templates, including the template ID, name, and the creation and deletion dates.
listBackupPlanTemplatesRequest
- Future<ListBackupPlanTemplatesResult> listBackupPlanTemplatesAsync(ListBackupPlanTemplatesRequest listBackupPlanTemplatesRequest, AsyncHandler<ListBackupPlanTemplatesRequest,ListBackupPlanTemplatesResult> asyncHandler)
Returns metadata of your saved backup plan templates, including the template ID, name, and the creation and deletion dates.
listBackupPlanTemplatesRequest
- asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<ListBackupPlanVersionsResult> listBackupPlanVersionsAsync(ListBackupPlanVersionsRequest listBackupPlanVersionsRequest)
Returns version metadata of your backup plans, including Amazon Resource Names (ARNs), backup plan IDs, creation and deletion dates, plan names, and version IDs.
listBackupPlanVersionsRequest
- Future<ListBackupPlanVersionsResult> listBackupPlanVersionsAsync(ListBackupPlanVersionsRequest listBackupPlanVersionsRequest, AsyncHandler<ListBackupPlanVersionsRequest,ListBackupPlanVersionsResult> asyncHandler)
Returns version metadata of your backup plans, including Amazon Resource Names (ARNs), backup plan IDs, creation and deletion dates, plan names, and version IDs.
listBackupPlanVersionsRequest
- asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<ListBackupPlansResult> listBackupPlansAsync(ListBackupPlansRequest listBackupPlansRequest)
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.
listBackupPlansRequest
- Future<ListBackupPlansResult> listBackupPlansAsync(ListBackupPlansRequest listBackupPlansRequest, AsyncHandler<ListBackupPlansRequest,ListBackupPlansResult> asyncHandler)
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.
listBackupPlansRequest
- asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<ListBackupSelectionsResult> listBackupSelectionsAsync(ListBackupSelectionsRequest listBackupSelectionsRequest)
Returns an array containing metadata of the resources associated with the target backup plan.
listBackupSelectionsRequest
- Future<ListBackupSelectionsResult> listBackupSelectionsAsync(ListBackupSelectionsRequest listBackupSelectionsRequest, AsyncHandler<ListBackupSelectionsRequest,ListBackupSelectionsResult> asyncHandler)
Returns an array containing metadata of the resources associated with the target backup plan.
listBackupSelectionsRequest
- asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<ListBackupVaultsResult> listBackupVaultsAsync(ListBackupVaultsRequest listBackupVaultsRequest)
Returns a list of recovery point storage containers along with information about them.
listBackupVaultsRequest
- Future<ListBackupVaultsResult> listBackupVaultsAsync(ListBackupVaultsRequest listBackupVaultsRequest, AsyncHandler<ListBackupVaultsRequest,ListBackupVaultsResult> asyncHandler)
Returns a list of recovery point storage containers along with information about them.
listBackupVaultsRequest
- asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<ListCopyJobsResult> listCopyJobsAsync(ListCopyJobsRequest listCopyJobsRequest)
Returns metadata about your copy jobs.
listCopyJobsRequest
- Future<ListCopyJobsResult> listCopyJobsAsync(ListCopyJobsRequest listCopyJobsRequest, AsyncHandler<ListCopyJobsRequest,ListCopyJobsResult> asyncHandler)
Returns metadata about your copy jobs.
listCopyJobsRequest
- asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<ListFrameworksResult> listFrameworksAsync(ListFrameworksRequest listFrameworksRequest)
Returns a list of all frameworks for an Amazon Web Services account and Amazon Web Services Region.
listFrameworksRequest
- Future<ListFrameworksResult> listFrameworksAsync(ListFrameworksRequest listFrameworksRequest, AsyncHandler<ListFrameworksRequest,ListFrameworksResult> asyncHandler)
Returns a list of all frameworks for an Amazon Web Services account and Amazon Web Services Region.
listFrameworksRequest
- asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<ListProtectedResourcesResult> listProtectedResourcesAsync(ListProtectedResourcesRequest listProtectedResourcesRequest)
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.
listProtectedResourcesRequest
- Future<ListProtectedResourcesResult> listProtectedResourcesAsync(ListProtectedResourcesRequest listProtectedResourcesRequest, AsyncHandler<ListProtectedResourcesRequest,ListProtectedResourcesResult> asyncHandler)
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.
listProtectedResourcesRequest
- asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<ListRecoveryPointsByBackupVaultResult> listRecoveryPointsByBackupVaultAsync(ListRecoveryPointsByBackupVaultRequest listRecoveryPointsByBackupVaultRequest)
Returns detailed information about the recovery points stored in a backup vault.
listRecoveryPointsByBackupVaultRequest
- Future<ListRecoveryPointsByBackupVaultResult> listRecoveryPointsByBackupVaultAsync(ListRecoveryPointsByBackupVaultRequest listRecoveryPointsByBackupVaultRequest, AsyncHandler<ListRecoveryPointsByBackupVaultRequest,ListRecoveryPointsByBackupVaultResult> asyncHandler)
Returns detailed information about the recovery points stored in a backup vault.
listRecoveryPointsByBackupVaultRequest
- asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<ListRecoveryPointsByResourceResult> listRecoveryPointsByResourceAsync(ListRecoveryPointsByResourceRequest listRecoveryPointsByResourceRequest)
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.
listRecoveryPointsByResourceRequest
- Future<ListRecoveryPointsByResourceResult> listRecoveryPointsByResourceAsync(ListRecoveryPointsByResourceRequest listRecoveryPointsByResourceRequest, AsyncHandler<ListRecoveryPointsByResourceRequest,ListRecoveryPointsByResourceResult> asyncHandler)
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.
listRecoveryPointsByResourceRequest
- asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<ListReportJobsResult> listReportJobsAsync(ListReportJobsRequest listReportJobsRequest)
Returns details about your report jobs.
listReportJobsRequest
- Future<ListReportJobsResult> listReportJobsAsync(ListReportJobsRequest listReportJobsRequest, AsyncHandler<ListReportJobsRequest,ListReportJobsResult> asyncHandler)
Returns details about your report jobs.
listReportJobsRequest
- asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<ListReportPlansResult> listReportPlansAsync(ListReportPlansRequest listReportPlansRequest)
Returns a list of your report plans. For detailed information about a single report plan, use
DescribeReportPlan
.
listReportPlansRequest
- Future<ListReportPlansResult> listReportPlansAsync(ListReportPlansRequest listReportPlansRequest, AsyncHandler<ListReportPlansRequest,ListReportPlansResult> asyncHandler)
Returns a list of your report plans. For detailed information about a single report plan, use
DescribeReportPlan
.
listReportPlansRequest
- asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<ListRestoreJobsResult> listRestoreJobsAsync(ListRestoreJobsRequest listRestoreJobsRequest)
Returns a list of jobs that Backup initiated to restore a saved resource, including details about the recovery process.
listRestoreJobsRequest
- Future<ListRestoreJobsResult> listRestoreJobsAsync(ListRestoreJobsRequest listRestoreJobsRequest, AsyncHandler<ListRestoreJobsRequest,ListRestoreJobsResult> asyncHandler)
Returns a list of jobs that Backup initiated to restore a saved resource, including details about the recovery process.
listRestoreJobsRequest
- asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<ListTagsResult> listTagsAsync(ListTagsRequest listTagsRequest)
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.
listTagsRequest
- Future<ListTagsResult> listTagsAsync(ListTagsRequest listTagsRequest, AsyncHandler<ListTagsRequest,ListTagsResult> asyncHandler)
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.
listTagsRequest
- asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<PutBackupVaultAccessPolicyResult> putBackupVaultAccessPolicyAsync(PutBackupVaultAccessPolicyRequest putBackupVaultAccessPolicyRequest)
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.
putBackupVaultAccessPolicyRequest
- Future<PutBackupVaultAccessPolicyResult> putBackupVaultAccessPolicyAsync(PutBackupVaultAccessPolicyRequest putBackupVaultAccessPolicyRequest, AsyncHandler<PutBackupVaultAccessPolicyRequest,PutBackupVaultAccessPolicyResult> asyncHandler)
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.
putBackupVaultAccessPolicyRequest
- asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<PutBackupVaultNotificationsResult> putBackupVaultNotificationsAsync(PutBackupVaultNotificationsRequest putBackupVaultNotificationsRequest)
Turns on notifications on a backup vault for the specified topic and events.
putBackupVaultNotificationsRequest
- Future<PutBackupVaultNotificationsResult> putBackupVaultNotificationsAsync(PutBackupVaultNotificationsRequest putBackupVaultNotificationsRequest, AsyncHandler<PutBackupVaultNotificationsRequest,PutBackupVaultNotificationsResult> asyncHandler)
Turns on notifications on a backup vault for the specified topic and events.
putBackupVaultNotificationsRequest
- asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<StartBackupJobResult> startBackupJobAsync(StartBackupJobRequest startBackupJobRequest)
Starts an on-demand backup job for the specified resource.
startBackupJobRequest
- Future<StartBackupJobResult> startBackupJobAsync(StartBackupJobRequest startBackupJobRequest, AsyncHandler<StartBackupJobRequest,StartBackupJobResult> asyncHandler)
Starts an on-demand backup job for the specified resource.
startBackupJobRequest
- asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<StartCopyJobResult> startCopyJobAsync(StartCopyJobRequest startCopyJobRequest)
Starts a job to create a one-time copy of the specified resource.
Does not support continuous backups.
startCopyJobRequest
- Future<StartCopyJobResult> startCopyJobAsync(StartCopyJobRequest startCopyJobRequest, AsyncHandler<StartCopyJobRequest,StartCopyJobResult> asyncHandler)
Starts a job to create a one-time copy of the specified resource.
Does not support continuous backups.
startCopyJobRequest
- asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<StartReportJobResult> startReportJobAsync(StartReportJobRequest startReportJobRequest)
Starts an on-demand report job for the specified report plan.
startReportJobRequest
- Future<StartReportJobResult> startReportJobAsync(StartReportJobRequest startReportJobRequest, AsyncHandler<StartReportJobRequest,StartReportJobResult> asyncHandler)
Starts an on-demand report job for the specified report plan.
startReportJobRequest
- asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<StartRestoreJobResult> startRestoreJobAsync(StartRestoreJobRequest startRestoreJobRequest)
Recovers the saved resource identified by an Amazon Resource Name (ARN).
startRestoreJobRequest
- Future<StartRestoreJobResult> startRestoreJobAsync(StartRestoreJobRequest startRestoreJobRequest, AsyncHandler<StartRestoreJobRequest,StartRestoreJobResult> asyncHandler)
Recovers the saved resource identified by an Amazon Resource Name (ARN).
startRestoreJobRequest
- asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<StopBackupJobResult> stopBackupJobAsync(StopBackupJobRequest stopBackupJobRequest)
Attempts to cancel a job to create a one-time backup of a resource.
stopBackupJobRequest
- Future<StopBackupJobResult> stopBackupJobAsync(StopBackupJobRequest stopBackupJobRequest, AsyncHandler<StopBackupJobRequest,StopBackupJobResult> asyncHandler)
Attempts to cancel a job to create a one-time backup of a resource.
stopBackupJobRequest
- asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<TagResourceResult> tagResourceAsync(TagResourceRequest tagResourceRequest)
Assigns a set of key-value pairs to a recovery point, backup plan, or backup vault identified by an Amazon Resource Name (ARN).
tagResourceRequest
- Future<TagResourceResult> tagResourceAsync(TagResourceRequest tagResourceRequest, AsyncHandler<TagResourceRequest,TagResourceResult> asyncHandler)
Assigns a set of key-value pairs to a recovery point, backup plan, or backup vault identified by an Amazon Resource Name (ARN).
tagResourceRequest
- asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<UntagResourceResult> untagResourceAsync(UntagResourceRequest untagResourceRequest)
Removes a set of key-value pairs from a recovery point, backup plan, or backup vault identified by an Amazon Resource Name (ARN)
untagResourceRequest
- Future<UntagResourceResult> untagResourceAsync(UntagResourceRequest untagResourceRequest, AsyncHandler<UntagResourceRequest,UntagResourceResult> asyncHandler)
Removes a set of key-value pairs from a recovery point, backup plan, or backup vault identified by an Amazon Resource Name (ARN)
untagResourceRequest
- asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<UpdateBackupPlanResult> updateBackupPlanAsync(UpdateBackupPlanRequest updateBackupPlanRequest)
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
.
updateBackupPlanRequest
- Future<UpdateBackupPlanResult> updateBackupPlanAsync(UpdateBackupPlanRequest updateBackupPlanRequest, AsyncHandler<UpdateBackupPlanRequest,UpdateBackupPlanResult> asyncHandler)
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
.
updateBackupPlanRequest
- asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<UpdateFrameworkResult> updateFrameworkAsync(UpdateFrameworkRequest updateFrameworkRequest)
Updates an existing framework identified by its FrameworkName
with the input document in JSON
format.
updateFrameworkRequest
- Future<UpdateFrameworkResult> updateFrameworkAsync(UpdateFrameworkRequest updateFrameworkRequest, AsyncHandler<UpdateFrameworkRequest,UpdateFrameworkResult> asyncHandler)
Updates an existing framework identified by its FrameworkName
with the input document in JSON
format.
updateFrameworkRequest
- asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<UpdateGlobalSettingsResult> updateGlobalSettingsAsync(UpdateGlobalSettingsRequest updateGlobalSettingsRequest)
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.
updateGlobalSettingsRequest
- Future<UpdateGlobalSettingsResult> updateGlobalSettingsAsync(UpdateGlobalSettingsRequest updateGlobalSettingsRequest, AsyncHandler<UpdateGlobalSettingsRequest,UpdateGlobalSettingsResult> asyncHandler)
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.
updateGlobalSettingsRequest
- asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<UpdateRecoveryPointLifecycleResult> updateRecoveryPointLifecycleAsync(UpdateRecoveryPointLifecycleRequest updateRecoveryPointLifecycleRequest)
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.
updateRecoveryPointLifecycleRequest
- Future<UpdateRecoveryPointLifecycleResult> updateRecoveryPointLifecycleAsync(UpdateRecoveryPointLifecycleRequest updateRecoveryPointLifecycleRequest, AsyncHandler<UpdateRecoveryPointLifecycleRequest,UpdateRecoveryPointLifecycleResult> asyncHandler)
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.
updateRecoveryPointLifecycleRequest
- asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<UpdateRegionSettingsResult> updateRegionSettingsAsync(UpdateRegionSettingsRequest updateRegionSettingsRequest)
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.
updateRegionSettingsRequest
- Future<UpdateRegionSettingsResult> updateRegionSettingsAsync(UpdateRegionSettingsRequest updateRegionSettingsRequest, AsyncHandler<UpdateRegionSettingsRequest,UpdateRegionSettingsResult> asyncHandler)
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.
updateRegionSettingsRequest
- asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<UpdateReportPlanResult> updateReportPlanAsync(UpdateReportPlanRequest updateReportPlanRequest)
Updates an existing report plan identified by its ReportPlanName
with the input document in JSON
format.
updateReportPlanRequest
- Future<UpdateReportPlanResult> updateReportPlanAsync(UpdateReportPlanRequest updateReportPlanRequest, AsyncHandler<UpdateReportPlanRequest,UpdateReportPlanResult> asyncHandler)
Updates an existing report plan identified by its ReportPlanName
with the input document in JSON
format.
updateReportPlanRequest
- asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.