@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<CancelLegalHoldResult> |
cancelLegalHoldAsync(CancelLegalHoldRequest cancelLegalHoldRequest)
This action removes the specified legal hold on a recovery point.
|
Future<CancelLegalHoldResult> |
cancelLegalHoldAsync(CancelLegalHoldRequest cancelLegalHoldRequest,
AsyncHandler<CancelLegalHoldRequest,CancelLegalHoldResult> asyncHandler)
This action removes the specified legal hold on a recovery point.
|
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<CreateLegalHoldResult> |
createLegalHoldAsync(CreateLegalHoldRequest createLegalHoldRequest)
This action creates a legal hold on a recovery point (backup).
|
Future<CreateLegalHoldResult> |
createLegalHoldAsync(CreateLegalHoldRequest createLegalHoldRequest,
AsyncHandler<CreateLegalHoldRequest,CreateLegalHoldResult> asyncHandler)
This action creates a legal hold on a recovery point (backup).
|
Future<CreateLogicallyAirGappedBackupVaultResult> |
createLogicallyAirGappedBackupVaultAsync(CreateLogicallyAirGappedBackupVaultRequest createLogicallyAirGappedBackupVaultRequest)
This request creates a logical container to where backups may be copied.
|
Future<CreateLogicallyAirGappedBackupVaultResult> |
createLogicallyAirGappedBackupVaultAsync(CreateLogicallyAirGappedBackupVaultRequest createLogicallyAirGappedBackupVaultRequest,
AsyncHandler<CreateLogicallyAirGappedBackupVaultRequest,CreateLogicallyAirGappedBackupVaultResult> asyncHandler)
This request creates a logical container to where backups may be copied.
|
Future<CreateReportPlanResult> |
createReportPlanAsync(CreateReportPlanRequest createReportPlanRequest)
Creates a report plan.
|
Future<CreateReportPlanResult> |
createReportPlanAsync(CreateReportPlanRequest createReportPlanRequest,
AsyncHandler<CreateReportPlanRequest,CreateReportPlanResult> asyncHandler)
Creates a report plan.
|
Future<CreateRestoreTestingPlanResult> |
createRestoreTestingPlanAsync(CreateRestoreTestingPlanRequest createRestoreTestingPlanRequest)
This is the first of two steps to create a restore testing plan; once this request is successful, finish the
procedure with request CreateRestoreTestingSelection.
|
Future<CreateRestoreTestingPlanResult> |
createRestoreTestingPlanAsync(CreateRestoreTestingPlanRequest createRestoreTestingPlanRequest,
AsyncHandler<CreateRestoreTestingPlanRequest,CreateRestoreTestingPlanResult> asyncHandler)
This is the first of two steps to create a restore testing plan; once this request is successful, finish the
procedure with request CreateRestoreTestingSelection.
|
Future<CreateRestoreTestingSelectionResult> |
createRestoreTestingSelectionAsync(CreateRestoreTestingSelectionRequest createRestoreTestingSelectionRequest)
This request can be sent after CreateRestoreTestingPlan request returns successfully.
|
Future<CreateRestoreTestingSelectionResult> |
createRestoreTestingSelectionAsync(CreateRestoreTestingSelectionRequest createRestoreTestingSelectionRequest,
AsyncHandler<CreateRestoreTestingSelectionRequest,CreateRestoreTestingSelectionResult> asyncHandler)
This request can be sent after CreateRestoreTestingPlan request returns successfully.
|
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<DeleteBackupVaultLockConfigurationResult> |
deleteBackupVaultLockConfigurationAsync(DeleteBackupVaultLockConfigurationRequest deleteBackupVaultLockConfigurationRequest)
Deletes Backup Vault Lock from a backup vault specified by a backup vault name.
|
Future<DeleteBackupVaultLockConfigurationResult> |
deleteBackupVaultLockConfigurationAsync(DeleteBackupVaultLockConfigurationRequest deleteBackupVaultLockConfigurationRequest,
AsyncHandler<DeleteBackupVaultLockConfigurationRequest,DeleteBackupVaultLockConfigurationResult> asyncHandler)
Deletes Backup Vault Lock from a backup vault specified by a backup vault 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<DeleteRestoreTestingPlanResult> |
deleteRestoreTestingPlanAsync(DeleteRestoreTestingPlanRequest deleteRestoreTestingPlanRequest)
This request deletes the specified restore testing plan.
|
Future<DeleteRestoreTestingPlanResult> |
deleteRestoreTestingPlanAsync(DeleteRestoreTestingPlanRequest deleteRestoreTestingPlanRequest,
AsyncHandler<DeleteRestoreTestingPlanRequest,DeleteRestoreTestingPlanResult> asyncHandler)
This request deletes the specified restore testing plan.
|
Future<DeleteRestoreTestingSelectionResult> |
deleteRestoreTestingSelectionAsync(DeleteRestoreTestingSelectionRequest deleteRestoreTestingSelectionRequest)
Input the Restore Testing Plan name and Restore Testing Selection name.
|
Future<DeleteRestoreTestingSelectionResult> |
deleteRestoreTestingSelectionAsync(DeleteRestoreTestingSelectionRequest deleteRestoreTestingSelectionRequest,
AsyncHandler<DeleteRestoreTestingSelectionRequest,DeleteRestoreTestingSelectionResult> asyncHandler)
Input the Restore Testing Plan name and Restore Testing Selection 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<DisassociateRecoveryPointFromParentResult> |
disassociateRecoveryPointFromParentAsync(DisassociateRecoveryPointFromParentRequest disassociateRecoveryPointFromParentRequest)
This action to a specific child (nested) recovery point removes the relationship between the specified recovery
point and its parent (composite) recovery point.
|
Future<DisassociateRecoveryPointFromParentResult> |
disassociateRecoveryPointFromParentAsync(DisassociateRecoveryPointFromParentRequest disassociateRecoveryPointFromParentRequest,
AsyncHandler<DisassociateRecoveryPointFromParentRequest,DisassociateRecoveryPointFromParentResult> asyncHandler)
This action to a specific child (nested) recovery point removes the relationship between the specified recovery
point and its parent (composite) recovery point.
|
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<GetLegalHoldResult> |
getLegalHoldAsync(GetLegalHoldRequest getLegalHoldRequest)
This action returns details for a specified legal hold.
|
Future<GetLegalHoldResult> |
getLegalHoldAsync(GetLegalHoldRequest getLegalHoldRequest,
AsyncHandler<GetLegalHoldRequest,GetLegalHoldResult> asyncHandler)
This action returns details for a specified legal hold.
|
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<GetRestoreJobMetadataResult> |
getRestoreJobMetadataAsync(GetRestoreJobMetadataRequest getRestoreJobMetadataRequest)
This request returns the metadata for the specified restore job.
|
Future<GetRestoreJobMetadataResult> |
getRestoreJobMetadataAsync(GetRestoreJobMetadataRequest getRestoreJobMetadataRequest,
AsyncHandler<GetRestoreJobMetadataRequest,GetRestoreJobMetadataResult> asyncHandler)
This request returns the metadata for the specified restore job.
|
Future<GetRestoreTestingInferredMetadataResult> |
getRestoreTestingInferredMetadataAsync(GetRestoreTestingInferredMetadataRequest getRestoreTestingInferredMetadataRequest)
This request returns the minimal required set of metadata needed to start a restore job with secure default
settings.
|
Future<GetRestoreTestingInferredMetadataResult> |
getRestoreTestingInferredMetadataAsync(GetRestoreTestingInferredMetadataRequest getRestoreTestingInferredMetadataRequest,
AsyncHandler<GetRestoreTestingInferredMetadataRequest,GetRestoreTestingInferredMetadataResult> asyncHandler)
This request returns the minimal required set of metadata needed to start a restore job with secure default
settings.
|
Future<GetRestoreTestingPlanResult> |
getRestoreTestingPlanAsync(GetRestoreTestingPlanRequest getRestoreTestingPlanRequest)
Returns
RestoreTestingPlan details for the specified RestoreTestingPlanName . |
Future<GetRestoreTestingPlanResult> |
getRestoreTestingPlanAsync(GetRestoreTestingPlanRequest getRestoreTestingPlanRequest,
AsyncHandler<GetRestoreTestingPlanRequest,GetRestoreTestingPlanResult> asyncHandler)
Returns
RestoreTestingPlan details for the specified RestoreTestingPlanName . |
Future<GetRestoreTestingSelectionResult> |
getRestoreTestingSelectionAsync(GetRestoreTestingSelectionRequest getRestoreTestingSelectionRequest)
Returns RestoreTestingSelection, which displays resources and elements of the restore testing plan.
|
Future<GetRestoreTestingSelectionResult> |
getRestoreTestingSelectionAsync(GetRestoreTestingSelectionRequest getRestoreTestingSelectionRequest,
AsyncHandler<GetRestoreTestingSelectionRequest,GetRestoreTestingSelectionResult> asyncHandler)
Returns RestoreTestingSelection, which displays resources and elements of the restore testing plan.
|
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<ListBackupJobSummariesResult> |
listBackupJobSummariesAsync(ListBackupJobSummariesRequest listBackupJobSummariesRequest)
This is a request for a summary of backup jobs created or running within the most recent 30 days.
|
Future<ListBackupJobSummariesResult> |
listBackupJobSummariesAsync(ListBackupJobSummariesRequest listBackupJobSummariesRequest,
AsyncHandler<ListBackupJobSummariesRequest,ListBackupJobSummariesResult> asyncHandler)
This is a request for a summary of backup jobs created or running within the most recent 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<ListCopyJobSummariesResult> |
listCopyJobSummariesAsync(ListCopyJobSummariesRequest listCopyJobSummariesRequest)
This request obtains a list of copy jobs created or running within the the most recent 30 days.
|
Future<ListCopyJobSummariesResult> |
listCopyJobSummariesAsync(ListCopyJobSummariesRequest listCopyJobSummariesRequest,
AsyncHandler<ListCopyJobSummariesRequest,ListCopyJobSummariesResult> asyncHandler)
This request obtains a list of copy jobs created or running within the the most recent 30 days.
|
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<ListLegalHoldsResult> |
listLegalHoldsAsync(ListLegalHoldsRequest listLegalHoldsRequest)
This action returns metadata about active and previous legal holds.
|
Future<ListLegalHoldsResult> |
listLegalHoldsAsync(ListLegalHoldsRequest listLegalHoldsRequest,
AsyncHandler<ListLegalHoldsRequest,ListLegalHoldsResult> asyncHandler)
This action returns metadata about active and previous legal holds.
|
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<ListProtectedResourcesByBackupVaultResult> |
listProtectedResourcesByBackupVaultAsync(ListProtectedResourcesByBackupVaultRequest listProtectedResourcesByBackupVaultRequest)
This request lists the protected resources corresponding to each backup vault.
|
Future<ListProtectedResourcesByBackupVaultResult> |
listProtectedResourcesByBackupVaultAsync(ListProtectedResourcesByBackupVaultRequest listProtectedResourcesByBackupVaultRequest,
AsyncHandler<ListProtectedResourcesByBackupVaultRequest,ListProtectedResourcesByBackupVaultResult> asyncHandler)
This request lists the protected resources corresponding to each backup vault.
|
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<ListRecoveryPointsByLegalHoldResult> |
listRecoveryPointsByLegalHoldAsync(ListRecoveryPointsByLegalHoldRequest listRecoveryPointsByLegalHoldRequest)
This action returns recovery point ARNs (Amazon Resource Names) of the specified legal hold.
|
Future<ListRecoveryPointsByLegalHoldResult> |
listRecoveryPointsByLegalHoldAsync(ListRecoveryPointsByLegalHoldRequest listRecoveryPointsByLegalHoldRequest,
AsyncHandler<ListRecoveryPointsByLegalHoldRequest,ListRecoveryPointsByLegalHoldResult> asyncHandler)
This action returns recovery point ARNs (Amazon Resource Names) of the specified legal hold.
|
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<ListRestoreJobsByProtectedResourceResult> |
listRestoreJobsByProtectedResourceAsync(ListRestoreJobsByProtectedResourceRequest listRestoreJobsByProtectedResourceRequest)
This returns restore jobs that contain the specified protected resource.
|
Future<ListRestoreJobsByProtectedResourceResult> |
listRestoreJobsByProtectedResourceAsync(ListRestoreJobsByProtectedResourceRequest listRestoreJobsByProtectedResourceRequest,
AsyncHandler<ListRestoreJobsByProtectedResourceRequest,ListRestoreJobsByProtectedResourceResult> asyncHandler)
This returns restore jobs that contain the specified protected resource.
|
Future<ListRestoreJobSummariesResult> |
listRestoreJobSummariesAsync(ListRestoreJobSummariesRequest listRestoreJobSummariesRequest)
This request obtains a summary of restore jobs created or running within the the most recent 30 days.
|
Future<ListRestoreJobSummariesResult> |
listRestoreJobSummariesAsync(ListRestoreJobSummariesRequest listRestoreJobSummariesRequest,
AsyncHandler<ListRestoreJobSummariesRequest,ListRestoreJobSummariesResult> asyncHandler)
This request obtains a summary of restore jobs created or running within the the most recent 30 days.
|
Future<ListRestoreTestingPlansResult> |
listRestoreTestingPlansAsync(ListRestoreTestingPlansRequest listRestoreTestingPlansRequest)
Returns a list of restore testing plans.
|
Future<ListRestoreTestingPlansResult> |
listRestoreTestingPlansAsync(ListRestoreTestingPlansRequest listRestoreTestingPlansRequest,
AsyncHandler<ListRestoreTestingPlansRequest,ListRestoreTestingPlansResult> asyncHandler)
Returns a list of restore testing plans.
|
Future<ListRestoreTestingSelectionsResult> |
listRestoreTestingSelectionsAsync(ListRestoreTestingSelectionsRequest listRestoreTestingSelectionsRequest)
Returns a list of restore testing selections.
|
Future<ListRestoreTestingSelectionsResult> |
listRestoreTestingSelectionsAsync(ListRestoreTestingSelectionsRequest listRestoreTestingSelectionsRequest,
AsyncHandler<ListRestoreTestingSelectionsRequest,ListRestoreTestingSelectionsResult> asyncHandler)
Returns a list of restore testing selections.
|
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<PutBackupVaultLockConfigurationResult> |
putBackupVaultLockConfigurationAsync(PutBackupVaultLockConfigurationRequest putBackupVaultLockConfigurationRequest)
Applies Backup Vault Lock to a backup vault, preventing attempts to delete any recovery point stored in or
created in a backup vault.
|
Future<PutBackupVaultLockConfigurationResult> |
putBackupVaultLockConfigurationAsync(PutBackupVaultLockConfigurationRequest putBackupVaultLockConfigurationRequest,
AsyncHandler<PutBackupVaultLockConfigurationRequest,PutBackupVaultLockConfigurationResult> asyncHandler)
Applies Backup Vault Lock to a backup vault, preventing attempts to delete any recovery point stored in or
created in a 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<PutRestoreValidationResultResult> |
putRestoreValidationResultAsync(PutRestoreValidationResultRequest putRestoreValidationResultRequest)
This request allows you to send your independent self-run restore test validation results.
|
Future<PutRestoreValidationResultResult> |
putRestoreValidationResultAsync(PutRestoreValidationResultRequest putRestoreValidationResultRequest,
AsyncHandler<PutRestoreValidationResultRequest,PutRestoreValidationResultResult> asyncHandler)
This request allows you to send your independent self-run restore test validation results.
|
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. |
Future<UpdateRestoreTestingPlanResult> |
updateRestoreTestingPlanAsync(UpdateRestoreTestingPlanRequest updateRestoreTestingPlanRequest)
This request will send changes to your specified restore testing plan.
|
Future<UpdateRestoreTestingPlanResult> |
updateRestoreTestingPlanAsync(UpdateRestoreTestingPlanRequest updateRestoreTestingPlanRequest,
AsyncHandler<UpdateRestoreTestingPlanRequest,UpdateRestoreTestingPlanResult> asyncHandler)
This request will send changes to your specified restore testing plan.
|
Future<UpdateRestoreTestingSelectionResult> |
updateRestoreTestingSelectionAsync(UpdateRestoreTestingSelectionRequest updateRestoreTestingSelectionRequest)
Most elements except the
RestoreTestingSelectionName can be updated with this request. |
Future<UpdateRestoreTestingSelectionResult> |
updateRestoreTestingSelectionAsync(UpdateRestoreTestingSelectionRequest updateRestoreTestingSelectionRequest,
AsyncHandler<UpdateRestoreTestingSelectionRequest,UpdateRestoreTestingSelectionResult> asyncHandler)
Most elements except the
RestoreTestingSelectionName can be updated with this request. |
cancelLegalHold, createBackupPlan, createBackupSelection, createBackupVault, createFramework, createLegalHold, createLogicallyAirGappedBackupVault, createReportPlan, createRestoreTestingPlan, createRestoreTestingSelection, deleteBackupPlan, deleteBackupSelection, deleteBackupVault, deleteBackupVaultAccessPolicy, deleteBackupVaultLockConfiguration, deleteBackupVaultNotifications, deleteFramework, deleteRecoveryPoint, deleteReportPlan, deleteRestoreTestingPlan, deleteRestoreTestingSelection, describeBackupJob, describeBackupVault, describeCopyJob, describeFramework, describeGlobalSettings, describeProtectedResource, describeRecoveryPoint, describeRegionSettings, describeReportJob, describeReportPlan, describeRestoreJob, disassociateRecoveryPoint, disassociateRecoveryPointFromParent, exportBackupPlanTemplate, getBackupPlan, getBackupPlanFromJSON, getBackupPlanFromTemplate, getBackupSelection, getBackupVaultAccessPolicy, getBackupVaultNotifications, getCachedResponseMetadata, getLegalHold, getRecoveryPointRestoreMetadata, getRestoreJobMetadata, getRestoreTestingInferredMetadata, getRestoreTestingPlan, getRestoreTestingSelection, getSupportedResourceTypes, listBackupJobs, listBackupJobSummaries, listBackupPlans, listBackupPlanTemplates, listBackupPlanVersions, listBackupSelections, listBackupVaults, listCopyJobs, listCopyJobSummaries, listFrameworks, listLegalHolds, listProtectedResources, listProtectedResourcesByBackupVault, listRecoveryPointsByBackupVault, listRecoveryPointsByLegalHold, listRecoveryPointsByResource, listReportJobs, listReportPlans, listRestoreJobs, listRestoreJobsByProtectedResource, listRestoreJobSummaries, listRestoreTestingPlans, listRestoreTestingSelections, listTags, putBackupVaultAccessPolicy, putBackupVaultLockConfiguration, putBackupVaultNotifications, putRestoreValidationResult, shutdown, startBackupJob, startCopyJob, startReportJob, startRestoreJob, stopBackupJob, tagResource, untagResource, updateBackupPlan, updateFramework, updateGlobalSettings, updateRecoveryPointLifecycle, updateRegionSettings, updateReportPlan, updateRestoreTestingPlan, updateRestoreTestingSelection
Future<CancelLegalHoldResult> cancelLegalHoldAsync(CancelLegalHoldRequest cancelLegalHoldRequest)
This action removes the specified legal hold on a recovery point. This action can only be performed by a user with sufficient permissions.
cancelLegalHoldRequest
- Future<CancelLegalHoldResult> cancelLegalHoldAsync(CancelLegalHoldRequest cancelLegalHoldRequest, AsyncHandler<CancelLegalHoldRequest,CancelLegalHoldResult> asyncHandler)
This action removes the specified legal hold on a recovery point. This action can only be performed by a user with sufficient permissions.
cancelLegalHoldRequest
- 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<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. For examples, see Assigning resources programmatically.
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. For examples, see Assigning resources programmatically.
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<CreateLegalHoldResult> createLegalHoldAsync(CreateLegalHoldRequest createLegalHoldRequest)
This action creates a legal hold on a recovery point (backup). A legal hold is a restraint on altering or deleting a backup until an authorized user cancels the legal hold. Any actions to delete or disassociate a recovery point will fail with an error if one or more active legal holds are on the recovery point.
createLegalHoldRequest
- Future<CreateLegalHoldResult> createLegalHoldAsync(CreateLegalHoldRequest createLegalHoldRequest, AsyncHandler<CreateLegalHoldRequest,CreateLegalHoldResult> asyncHandler)
This action creates a legal hold on a recovery point (backup). A legal hold is a restraint on altering or deleting a backup until an authorized user cancels the legal hold. Any actions to delete or disassociate a recovery point will fail with an error if one or more active legal holds are on the recovery point.
createLegalHoldRequest
- 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<CreateLogicallyAirGappedBackupVaultResult> createLogicallyAirGappedBackupVaultAsync(CreateLogicallyAirGappedBackupVaultRequest createLogicallyAirGappedBackupVaultRequest)
This request creates a logical container to where backups may be copied.
This request includes a name, the Region, the maximum number of retention days, the minimum number of retention days, and optionally can include tags and a creator request ID.
Do not include sensitive data, such as passport numbers, in the name of a backup vault.
createLogicallyAirGappedBackupVaultRequest
- Future<CreateLogicallyAirGappedBackupVaultResult> createLogicallyAirGappedBackupVaultAsync(CreateLogicallyAirGappedBackupVaultRequest createLogicallyAirGappedBackupVaultRequest, AsyncHandler<CreateLogicallyAirGappedBackupVaultRequest,CreateLogicallyAirGappedBackupVaultResult> asyncHandler)
This request creates a logical container to where backups may be copied.
This request includes a name, the Region, the maximum number of retention days, the minimum number of retention days, and optionally can include tags and a creator request ID.
Do not include sensitive data, such as passport numbers, in the name of a backup vault.
createLogicallyAirGappedBackupVaultRequest
- 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<CreateRestoreTestingPlanResult> createRestoreTestingPlanAsync(CreateRestoreTestingPlanRequest createRestoreTestingPlanRequest)
This is the first of two steps to create a restore testing plan; once this request is successful, finish the procedure with request CreateRestoreTestingSelection.
You must include the parameter RestoreTestingPlan. You may optionally include CreatorRequestId and Tags.
createRestoreTestingPlanRequest
- Future<CreateRestoreTestingPlanResult> createRestoreTestingPlanAsync(CreateRestoreTestingPlanRequest createRestoreTestingPlanRequest, AsyncHandler<CreateRestoreTestingPlanRequest,CreateRestoreTestingPlanResult> asyncHandler)
This is the first of two steps to create a restore testing plan; once this request is successful, finish the procedure with request CreateRestoreTestingSelection.
You must include the parameter RestoreTestingPlan. You may optionally include CreatorRequestId and Tags.
createRestoreTestingPlanRequest
- 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<CreateRestoreTestingSelectionResult> createRestoreTestingSelectionAsync(CreateRestoreTestingSelectionRequest createRestoreTestingSelectionRequest)
This request can be sent after CreateRestoreTestingPlan request returns successfully. This is the second part of creating a resource testing plan, and it must be completed sequentially.
This consists of RestoreTestingSelectionName
, ProtectedResourceType
, and one of the
following:
ProtectedResourceArns
ProtectedResourceConditions
Each protected resource type can have one single value.
A restore testing selection can include a wildcard value ("*") for ProtectedResourceArns
along with
ProtectedResourceConditions
. Alternatively, you can include up to 30 specific protected resource
ARNs in ProtectedResourceArns
.
Cannot select by both protected resource types AND specific ARNs. Request will fail if both are included.
createRestoreTestingSelectionRequest
- Future<CreateRestoreTestingSelectionResult> createRestoreTestingSelectionAsync(CreateRestoreTestingSelectionRequest createRestoreTestingSelectionRequest, AsyncHandler<CreateRestoreTestingSelectionRequest,CreateRestoreTestingSelectionResult> asyncHandler)
This request can be sent after CreateRestoreTestingPlan request returns successfully. This is the second part of creating a resource testing plan, and it must be completed sequentially.
This consists of RestoreTestingSelectionName
, ProtectedResourceType
, and one of the
following:
ProtectedResourceArns
ProtectedResourceConditions
Each protected resource type can have one single value.
A restore testing selection can include a wildcard value ("*") for ProtectedResourceArns
along with
ProtectedResourceConditions
. Alternatively, you can include up to 30 specific protected resource
ARNs in ProtectedResourceArns
.
Cannot select by both protected resource types AND specific ARNs. Request will fail if both are included.
createRestoreTestingSelectionRequest
- 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<DeleteBackupVaultLockConfigurationResult> deleteBackupVaultLockConfigurationAsync(DeleteBackupVaultLockConfigurationRequest deleteBackupVaultLockConfigurationRequest)
Deletes Backup Vault Lock from a backup vault specified by a backup vault name.
If the Vault Lock configuration is immutable, then you cannot delete Vault Lock using API operations, and you
will receive an InvalidRequestException
if you attempt to do so. For more information, see Vault Lock in the Backup
Developer Guide.
deleteBackupVaultLockConfigurationRequest
- Future<DeleteBackupVaultLockConfigurationResult> deleteBackupVaultLockConfigurationAsync(DeleteBackupVaultLockConfigurationRequest deleteBackupVaultLockConfigurationRequest, AsyncHandler<DeleteBackupVaultLockConfigurationRequest,DeleteBackupVaultLockConfigurationResult> asyncHandler)
Deletes Backup Vault Lock from a backup vault specified by a backup vault name.
If the Vault Lock configuration is immutable, then you cannot delete Vault Lock using API operations, and you
will receive an InvalidRequestException
if you attempt to do so. For more information, see Vault Lock in the Backup
Developer Guide.
deleteBackupVaultLockConfigurationRequest
- 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.
When an IAM role's permissions are insufficient to call this API, the service sends back an HTTP 200 response
with an empty HTTP body, but the recovery point is not deleted. Instead, it enters an EXPIRED
state.
EXPIRED
recovery points can be deleted with this API once the IAM role has the
iam:CreateServiceLinkedRole
action. To learn more about adding this role, see
Troubleshooting manual deletions.
If the user or role is deleted or the permission within the role is removed, the deletion will not be successful
and will enter an EXPIRED
state.
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.
When an IAM role's permissions are insufficient to call this API, the service sends back an HTTP 200 response
with an empty HTTP body, but the recovery point is not deleted. Instead, it enters an EXPIRED
state.
EXPIRED
recovery points can be deleted with this API once the IAM role has the
iam:CreateServiceLinkedRole
action. To learn more about adding this role, see
Troubleshooting manual deletions.
If the user or role is deleted or the permission within the role is removed, the deletion will not be successful
and will enter an EXPIRED
state.
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<DeleteRestoreTestingPlanResult> deleteRestoreTestingPlanAsync(DeleteRestoreTestingPlanRequest deleteRestoreTestingPlanRequest)
This request deletes the specified restore testing plan.
Deletion can only successfully occur if all associated restore testing selections are deleted first.
deleteRestoreTestingPlanRequest
- Future<DeleteRestoreTestingPlanResult> deleteRestoreTestingPlanAsync(DeleteRestoreTestingPlanRequest deleteRestoreTestingPlanRequest, AsyncHandler<DeleteRestoreTestingPlanRequest,DeleteRestoreTestingPlanResult> asyncHandler)
This request deletes the specified restore testing plan.
Deletion can only successfully occur if all associated restore testing selections are deleted first.
deleteRestoreTestingPlanRequest
- 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<DeleteRestoreTestingSelectionResult> deleteRestoreTestingSelectionAsync(DeleteRestoreTestingSelectionRequest deleteRestoreTestingSelectionRequest)
Input the Restore Testing Plan name and Restore Testing Selection name.
All testing selections associated with a restore testing plan must be deleted before the restore testing plan can be deleted.
deleteRestoreTestingSelectionRequest
- Future<DeleteRestoreTestingSelectionResult> deleteRestoreTestingSelectionAsync(DeleteRestoreTestingSelectionRequest deleteRestoreTestingSelectionRequest, AsyncHandler<DeleteRestoreTestingSelectionRequest,DeleteRestoreTestingSelectionResult> asyncHandler)
Input the Restore Testing Plan name and Restore Testing Selection name.
All testing selections associated with a restore testing plan must be deleted before the restore testing plan can be deleted.
deleteRestoreTestingSelectionRequest
- 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<DisassociateRecoveryPointFromParentResult> disassociateRecoveryPointFromParentAsync(DisassociateRecoveryPointFromParentRequest disassociateRecoveryPointFromParentRequest)
This action to a specific child (nested) recovery point removes the relationship between the specified recovery point and its parent (composite) recovery point.
disassociateRecoveryPointFromParentRequest
- Future<DisassociateRecoveryPointFromParentResult> disassociateRecoveryPointFromParentAsync(DisassociateRecoveryPointFromParentRequest disassociateRecoveryPointFromParentRequest, AsyncHandler<DisassociateRecoveryPointFromParentRequest,DisassociateRecoveryPointFromParentResult> asyncHandler)
This action to a specific child (nested) recovery point removes the relationship between the specified recovery point and its parent (composite) recovery point.
disassociateRecoveryPointFromParentRequest
- 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<GetLegalHoldResult> getLegalHoldAsync(GetLegalHoldRequest getLegalHoldRequest)
This action returns details for a specified legal hold. The details are the body of a legal hold in JSON format, in addition to metadata.
getLegalHoldRequest
- Future<GetLegalHoldResult> getLegalHoldAsync(GetLegalHoldRequest getLegalHoldRequest, AsyncHandler<GetLegalHoldRequest,GetLegalHoldResult> asyncHandler)
This action returns details for a specified legal hold. The details are the body of a legal hold in JSON format, in addition to metadata.
getLegalHoldRequest
- 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<GetRestoreJobMetadataResult> getRestoreJobMetadataAsync(GetRestoreJobMetadataRequest getRestoreJobMetadataRequest)
This request returns the metadata for the specified restore job.
getRestoreJobMetadataRequest
- Future<GetRestoreJobMetadataResult> getRestoreJobMetadataAsync(GetRestoreJobMetadataRequest getRestoreJobMetadataRequest, AsyncHandler<GetRestoreJobMetadataRequest,GetRestoreJobMetadataResult> asyncHandler)
This request returns the metadata for the specified restore job.
getRestoreJobMetadataRequest
- 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<GetRestoreTestingInferredMetadataResult> getRestoreTestingInferredMetadataAsync(GetRestoreTestingInferredMetadataRequest getRestoreTestingInferredMetadataRequest)
This request returns the minimal required set of metadata needed to start a restore job with secure default
settings. BackupVaultName
and RecoveryPointArn
are required parameters.
BackupVaultAccountId
is an optional parameter.
getRestoreTestingInferredMetadataRequest
- Future<GetRestoreTestingInferredMetadataResult> getRestoreTestingInferredMetadataAsync(GetRestoreTestingInferredMetadataRequest getRestoreTestingInferredMetadataRequest, AsyncHandler<GetRestoreTestingInferredMetadataRequest,GetRestoreTestingInferredMetadataResult> asyncHandler)
This request returns the minimal required set of metadata needed to start a restore job with secure default
settings. BackupVaultName
and RecoveryPointArn
are required parameters.
BackupVaultAccountId
is an optional parameter.
getRestoreTestingInferredMetadataRequest
- 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<GetRestoreTestingPlanResult> getRestoreTestingPlanAsync(GetRestoreTestingPlanRequest getRestoreTestingPlanRequest)
Returns RestoreTestingPlan
details for the specified RestoreTestingPlanName
. The
details are the body of a restore testing plan in JSON format, in addition to plan metadata.
getRestoreTestingPlanRequest
- Future<GetRestoreTestingPlanResult> getRestoreTestingPlanAsync(GetRestoreTestingPlanRequest getRestoreTestingPlanRequest, AsyncHandler<GetRestoreTestingPlanRequest,GetRestoreTestingPlanResult> asyncHandler)
Returns RestoreTestingPlan
details for the specified RestoreTestingPlanName
. The
details are the body of a restore testing plan in JSON format, in addition to plan metadata.
getRestoreTestingPlanRequest
- 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<GetRestoreTestingSelectionResult> getRestoreTestingSelectionAsync(GetRestoreTestingSelectionRequest getRestoreTestingSelectionRequest)
Returns RestoreTestingSelection, which displays resources and elements of the restore testing plan.
getRestoreTestingSelectionRequest
- Future<GetRestoreTestingSelectionResult> getRestoreTestingSelectionAsync(GetRestoreTestingSelectionRequest getRestoreTestingSelectionRequest, AsyncHandler<GetRestoreTestingSelectionRequest,GetRestoreTestingSelectionResult> asyncHandler)
Returns RestoreTestingSelection, which displays resources and elements of the restore testing plan.
getRestoreTestingSelectionRequest
- 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<ListBackupJobSummariesResult> listBackupJobSummariesAsync(ListBackupJobSummariesRequest listBackupJobSummariesRequest)
This is a request for a summary of backup jobs created or running within the most recent 30 days. You can include parameters AccountID, State, ResourceType, MessageCategory, AggregationPeriod, MaxResults, or NextToken to filter results.
This request returns a summary that contains Region, Account, State, ResourceType, MessageCategory, StartTime, EndTime, and Count of included jobs.
listBackupJobSummariesRequest
- Future<ListBackupJobSummariesResult> listBackupJobSummariesAsync(ListBackupJobSummariesRequest listBackupJobSummariesRequest, AsyncHandler<ListBackupJobSummariesRequest,ListBackupJobSummariesResult> asyncHandler)
This is a request for a summary of backup jobs created or running within the most recent 30 days. You can include parameters AccountID, State, ResourceType, MessageCategory, AggregationPeriod, MaxResults, or NextToken to filter results.
This request returns a summary that contains Region, Account, State, ResourceType, MessageCategory, StartTime, EndTime, and Count of included jobs.
listBackupJobSummariesRequest
- 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<ListCopyJobSummariesResult> listCopyJobSummariesAsync(ListCopyJobSummariesRequest listCopyJobSummariesRequest)
This request obtains a list of copy jobs created or running within the the most recent 30 days. You can include parameters AccountID, State, ResourceType, MessageCategory, AggregationPeriod, MaxResults, or NextToken to filter results.
This request returns a summary that contains Region, Account, State, RestourceType, MessageCategory, StartTime, EndTime, and Count of included jobs.
listCopyJobSummariesRequest
- Future<ListCopyJobSummariesResult> listCopyJobSummariesAsync(ListCopyJobSummariesRequest listCopyJobSummariesRequest, AsyncHandler<ListCopyJobSummariesRequest,ListCopyJobSummariesResult> asyncHandler)
This request obtains a list of copy jobs created or running within the the most recent 30 days. You can include parameters AccountID, State, ResourceType, MessageCategory, AggregationPeriod, MaxResults, or NextToken to filter results.
This request returns a summary that contains Region, Account, State, RestourceType, MessageCategory, StartTime, EndTime, and Count of included jobs.
listCopyJobSummariesRequest
- 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<ListLegalHoldsResult> listLegalHoldsAsync(ListLegalHoldsRequest listLegalHoldsRequest)
This action returns metadata about active and previous legal holds.
listLegalHoldsRequest
- Future<ListLegalHoldsResult> listLegalHoldsAsync(ListLegalHoldsRequest listLegalHoldsRequest, AsyncHandler<ListLegalHoldsRequest,ListLegalHoldsResult> asyncHandler)
This action returns metadata about active and previous legal holds.
listLegalHoldsRequest
- 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<ListProtectedResourcesByBackupVaultResult> listProtectedResourcesByBackupVaultAsync(ListProtectedResourcesByBackupVaultRequest listProtectedResourcesByBackupVaultRequest)
This request lists the protected resources corresponding to each backup vault.
listProtectedResourcesByBackupVaultRequest
- Future<ListProtectedResourcesByBackupVaultResult> listProtectedResourcesByBackupVaultAsync(ListProtectedResourcesByBackupVaultRequest listProtectedResourcesByBackupVaultRequest, AsyncHandler<ListProtectedResourcesByBackupVaultRequest,ListProtectedResourcesByBackupVaultResult> asyncHandler)
This request lists the protected resources corresponding to each backup vault.
listProtectedResourcesByBackupVaultRequest
- 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<ListRecoveryPointsByLegalHoldResult> listRecoveryPointsByLegalHoldAsync(ListRecoveryPointsByLegalHoldRequest listRecoveryPointsByLegalHoldRequest)
This action returns recovery point ARNs (Amazon Resource Names) of the specified legal hold.
listRecoveryPointsByLegalHoldRequest
- Future<ListRecoveryPointsByLegalHoldResult> listRecoveryPointsByLegalHoldAsync(ListRecoveryPointsByLegalHoldRequest listRecoveryPointsByLegalHoldRequest, AsyncHandler<ListRecoveryPointsByLegalHoldRequest,ListRecoveryPointsByLegalHoldResult> asyncHandler)
This action returns recovery point ARNs (Amazon Resource Names) of the specified legal hold.
listRecoveryPointsByLegalHoldRequest
- 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<ListRestoreJobSummariesResult> listRestoreJobSummariesAsync(ListRestoreJobSummariesRequest listRestoreJobSummariesRequest)
This request obtains a summary of restore jobs created or running within the the most recent 30 days. You can include parameters AccountID, State, ResourceType, AggregationPeriod, MaxResults, or NextToken to filter results.
This request returns a summary that contains Region, Account, State, RestourceType, MessageCategory, StartTime, EndTime, and Count of included jobs.
listRestoreJobSummariesRequest
- Future<ListRestoreJobSummariesResult> listRestoreJobSummariesAsync(ListRestoreJobSummariesRequest listRestoreJobSummariesRequest, AsyncHandler<ListRestoreJobSummariesRequest,ListRestoreJobSummariesResult> asyncHandler)
This request obtains a summary of restore jobs created or running within the the most recent 30 days. You can include parameters AccountID, State, ResourceType, AggregationPeriod, MaxResults, or NextToken to filter results.
This request returns a summary that contains Region, Account, State, RestourceType, MessageCategory, StartTime, EndTime, and Count of included jobs.
listRestoreJobSummariesRequest
- 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<ListRestoreJobsByProtectedResourceResult> listRestoreJobsByProtectedResourceAsync(ListRestoreJobsByProtectedResourceRequest listRestoreJobsByProtectedResourceRequest)
This returns restore jobs that contain the specified protected resource.
You must include ResourceArn
. You can optionally include NextToken
,
ByStatus
, MaxResults
, ByRecoveryPointCreationDateAfter
, and
ByRecoveryPointCreationDateBefore
.
listRestoreJobsByProtectedResourceRequest
- Future<ListRestoreJobsByProtectedResourceResult> listRestoreJobsByProtectedResourceAsync(ListRestoreJobsByProtectedResourceRequest listRestoreJobsByProtectedResourceRequest, AsyncHandler<ListRestoreJobsByProtectedResourceRequest,ListRestoreJobsByProtectedResourceResult> asyncHandler)
This returns restore jobs that contain the specified protected resource.
You must include ResourceArn
. You can optionally include NextToken
,
ByStatus
, MaxResults
, ByRecoveryPointCreationDateAfter
, and
ByRecoveryPointCreationDateBefore
.
listRestoreJobsByProtectedResourceRequest
- 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<ListRestoreTestingPlansResult> listRestoreTestingPlansAsync(ListRestoreTestingPlansRequest listRestoreTestingPlansRequest)
Returns a list of restore testing plans.
listRestoreTestingPlansRequest
- Future<ListRestoreTestingPlansResult> listRestoreTestingPlansAsync(ListRestoreTestingPlansRequest listRestoreTestingPlansRequest, AsyncHandler<ListRestoreTestingPlansRequest,ListRestoreTestingPlansResult> asyncHandler)
Returns a list of restore testing plans.
listRestoreTestingPlansRequest
- 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<ListRestoreTestingSelectionsResult> listRestoreTestingSelectionsAsync(ListRestoreTestingSelectionsRequest listRestoreTestingSelectionsRequest)
Returns a list of restore testing selections. Can be filtered by MaxResults
and
RestoreTestingPlanName
.
listRestoreTestingSelectionsRequest
- Future<ListRestoreTestingSelectionsResult> listRestoreTestingSelectionsAsync(ListRestoreTestingSelectionsRequest listRestoreTestingSelectionsRequest, AsyncHandler<ListRestoreTestingSelectionsRequest,ListRestoreTestingSelectionsResult> asyncHandler)
Returns a list of restore testing selections. Can be filtered by MaxResults
and
RestoreTestingPlanName
.
listRestoreTestingSelectionsRequest
- 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
only works for resource types that support full Backup management of their backups. Those
resource types are listed in the "Full Backup management" section of the Feature
availability by resource table.
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
only works for resource types that support full Backup management of their backups. Those
resource types are listed in the "Full Backup management" section of the Feature
availability by resource table.
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<PutBackupVaultLockConfigurationResult> putBackupVaultLockConfigurationAsync(PutBackupVaultLockConfigurationRequest putBackupVaultLockConfigurationRequest)
Applies Backup Vault Lock to a backup vault, preventing attempts to delete any recovery point stored in or created in a backup vault. Vault Lock also prevents attempts to update the lifecycle policy that controls the retention period of any recovery point currently stored in a backup vault. If specified, Vault Lock enforces a minimum and maximum retention period for future backup and copy jobs that target a backup vault.
Backup Vault Lock has been assessed by Cohasset Associates for use in environments that are subject to SEC 17a-4, CFTC, and FINRA regulations. For more information about how Backup Vault Lock relates to these regulations, see the Cohasset Associates Compliance Assessment.
putBackupVaultLockConfigurationRequest
- Future<PutBackupVaultLockConfigurationResult> putBackupVaultLockConfigurationAsync(PutBackupVaultLockConfigurationRequest putBackupVaultLockConfigurationRequest, AsyncHandler<PutBackupVaultLockConfigurationRequest,PutBackupVaultLockConfigurationResult> asyncHandler)
Applies Backup Vault Lock to a backup vault, preventing attempts to delete any recovery point stored in or created in a backup vault. Vault Lock also prevents attempts to update the lifecycle policy that controls the retention period of any recovery point currently stored in a backup vault. If specified, Vault Lock enforces a minimum and maximum retention period for future backup and copy jobs that target a backup vault.
Backup Vault Lock has been assessed by Cohasset Associates for use in environments that are subject to SEC 17a-4, CFTC, and FINRA regulations. For more information about how Backup Vault Lock relates to these regulations, see the Cohasset Associates Compliance Assessment.
putBackupVaultLockConfigurationRequest
- 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<PutRestoreValidationResultResult> putRestoreValidationResultAsync(PutRestoreValidationResultRequest putRestoreValidationResultRequest)
This request allows you to send your independent self-run restore test validation results.
RestoreJobId
and ValidationStatus
are required. Optionally, you can input a
ValidationStatusMessage
.
putRestoreValidationResultRequest
- Future<PutRestoreValidationResultResult> putRestoreValidationResultAsync(PutRestoreValidationResultRequest putRestoreValidationResultRequest, AsyncHandler<PutRestoreValidationResultRequest,PutRestoreValidationResultResult> asyncHandler)
This request allows you to send your independent self-run restore test validation results.
RestoreJobId
and ValidationStatus
are required. Optionally, you can input a
ValidationStatusMessage
.
putRestoreValidationResultRequest
- 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.
This action is not supported for the following services: Amazon FSx for Windows File Server, Amazon FSx for Lustre, Amazon FSx for NetApp ONTAP , Amazon FSx for OpenZFS, Amazon DocumentDB (with MongoDB compatibility), Amazon RDS, Amazon Aurora, and Amazon Neptune.
stopBackupJobRequest
- Future<StopBackupJobResult> stopBackupJobAsync(StopBackupJobRequest stopBackupJobRequest, AsyncHandler<StopBackupJobRequest,StopBackupJobResult> asyncHandler)
Attempts to cancel a job to create a one-time backup of a resource.
This action is not supported for the following services: Amazon FSx for Windows File Server, Amazon FSx for Lustre, Amazon FSx for NetApp ONTAP , Amazon FSx for OpenZFS, Amazon DocumentDB (with MongoDB compatibility), Amazon RDS, Amazon Aurora, and Amazon Neptune.
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 “retention” setting must be 90 days greater than the “transition to cold after days” setting. The “transition to cold after days” setting cannot be changed after a backup has been transitioned to cold.
Resource types that are able to be transitioned to cold storage are listed in the "Lifecycle to cold storage" section of the Feature availability by resource table. Backup ignores this expression for other resource types.
This operation does not support continuous backups.
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 “retention” setting must be 90 days greater than the “transition to cold after days” setting. The “transition to cold after days” setting cannot be changed after a backup has been transitioned to cold.
Resource types that are able to be transitioned to cold storage are listed in the "Lifecycle to cold storage" section of the Feature availability by resource table. Backup ignores this expression for other resource types.
This operation does not support continuous backups.
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.
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.
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.Future<UpdateRestoreTestingPlanResult> updateRestoreTestingPlanAsync(UpdateRestoreTestingPlanRequest updateRestoreTestingPlanRequest)
This request will send changes to your specified restore testing plan. RestoreTestingPlanName
cannot
be updated after it is created.
RecoveryPointSelection
can contain:
Algorithm
ExcludeVaults
IncludeVaults
RecoveryPointTypes
SelectionWindowDays
updateRestoreTestingPlanRequest
- Future<UpdateRestoreTestingPlanResult> updateRestoreTestingPlanAsync(UpdateRestoreTestingPlanRequest updateRestoreTestingPlanRequest, AsyncHandler<UpdateRestoreTestingPlanRequest,UpdateRestoreTestingPlanResult> asyncHandler)
This request will send changes to your specified restore testing plan. RestoreTestingPlanName
cannot
be updated after it is created.
RecoveryPointSelection
can contain:
Algorithm
ExcludeVaults
IncludeVaults
RecoveryPointTypes
SelectionWindowDays
updateRestoreTestingPlanRequest
- 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<UpdateRestoreTestingSelectionResult> updateRestoreTestingSelectionAsync(UpdateRestoreTestingSelectionRequest updateRestoreTestingSelectionRequest)
Most elements except the RestoreTestingSelectionName
can be updated with this request.
RestoreTestingSelection
can use either protected resource ARNs or conditions, but not both. That is,
if your selection has ProtectedResourceArns
, requesting an update with the parameter
ProtectedResourceConditions
will be unsuccessful.
updateRestoreTestingSelectionRequest
- Future<UpdateRestoreTestingSelectionResult> updateRestoreTestingSelectionAsync(UpdateRestoreTestingSelectionRequest updateRestoreTestingSelectionRequest, AsyncHandler<UpdateRestoreTestingSelectionRequest,UpdateRestoreTestingSelectionResult> asyncHandler)
Most elements except the RestoreTestingSelectionName
can be updated with this request.
RestoreTestingSelection
can use either protected resource ARNs or conditions, but not both. That is,
if your selection has ProtectedResourceArns
, requesting an update with the parameter
ProtectedResourceConditions
will be unsuccessful.
updateRestoreTestingSelectionRequest
- 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.