@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public interface AWSBackup
Note: Do not directly implement this interface, new methods are added to it regularly. Extend from
AbstractAWSBackup
instead.
AWS Backup is a unified backup service designed to protect AWS services and their associated data. AWS Backup simplifies the creation, migration, restoration, and deletion of backups, while also providing reporting and auditing.
Modifier and Type | Field and Description |
---|---|
static String |
ENDPOINT_PREFIX
The region metadata service name for computing region endpoints.
|
Modifier and Type | Method and Description |
---|---|
CreateBackupPlanResult |
createBackupPlan(CreateBackupPlanRequest createBackupPlanRequest)
Backup plans are documents that contain information that AWS Backup uses to schedule tasks that create recovery
points of resources.
|
CreateBackupSelectionResult |
createBackupSelection(CreateBackupSelectionRequest createBackupSelectionRequest)
Creates a JSON document that specifies a set of resources to assign to a backup plan.
|
CreateBackupVaultResult |
createBackupVault(CreateBackupVaultRequest createBackupVaultRequest)
Creates a logical container where backups are stored.
|
DeleteBackupPlanResult |
deleteBackupPlan(DeleteBackupPlanRequest deleteBackupPlanRequest)
Deletes a backup plan.
|
DeleteBackupSelectionResult |
deleteBackupSelection(DeleteBackupSelectionRequest deleteBackupSelectionRequest)
Deletes the resource selection associated with a backup plan that is specified by the
SelectionId . |
DeleteBackupVaultResult |
deleteBackupVault(DeleteBackupVaultRequest deleteBackupVaultRequest)
Deletes the backup vault identified by its name.
|
DeleteBackupVaultAccessPolicyResult |
deleteBackupVaultAccessPolicy(DeleteBackupVaultAccessPolicyRequest deleteBackupVaultAccessPolicyRequest)
Deletes the policy document that manages permissions on a backup vault.
|
DeleteBackupVaultNotificationsResult |
deleteBackupVaultNotifications(DeleteBackupVaultNotificationsRequest deleteBackupVaultNotificationsRequest)
Deletes event notifications for the specified backup vault.
|
DeleteRecoveryPointResult |
deleteRecoveryPoint(DeleteRecoveryPointRequest deleteRecoveryPointRequest)
Deletes the recovery point specified by a recovery point ID.
|
DescribeBackupJobResult |
describeBackupJob(DescribeBackupJobRequest describeBackupJobRequest)
Returns metadata associated with creating a backup of a resource.
|
DescribeBackupVaultResult |
describeBackupVault(DescribeBackupVaultRequest describeBackupVaultRequest)
Returns metadata about a backup vault specified by its name.
|
DescribeCopyJobResult |
describeCopyJob(DescribeCopyJobRequest describeCopyJobRequest)
Returns metadata associated with creating a copy of a resource.
|
DescribeProtectedResourceResult |
describeProtectedResource(DescribeProtectedResourceRequest describeProtectedResourceRequest)
Returns information about a saved resource, including the last time it was backed up, its Amazon Resource Name
(ARN), and the AWS service type of the saved resource.
|
DescribeRecoveryPointResult |
describeRecoveryPoint(DescribeRecoveryPointRequest describeRecoveryPointRequest)
Returns metadata associated with a recovery point, including ID, status, encryption, and lifecycle.
|
DescribeRegionSettingsResult |
describeRegionSettings(DescribeRegionSettingsRequest describeRegionSettingsRequest)
Returns the current service opt-in settings for the Region.
|
DescribeRestoreJobResult |
describeRestoreJob(DescribeRestoreJobRequest describeRestoreJobRequest)
Returns metadata associated with a restore job that is specified by a job ID.
|
ExportBackupPlanTemplateResult |
exportBackupPlanTemplate(ExportBackupPlanTemplateRequest exportBackupPlanTemplateRequest)
Returns the backup plan that is specified by the plan ID as a backup template.
|
GetBackupPlanResult |
getBackupPlan(GetBackupPlanRequest getBackupPlanRequest)
Returns the body of a backup plan in JSON format, in addition to plan metadata.
|
GetBackupPlanFromJSONResult |
getBackupPlanFromJSON(GetBackupPlanFromJSONRequest getBackupPlanFromJSONRequest)
Returns a valid JSON document specifying a backup plan or an error.
|
GetBackupPlanFromTemplateResult |
getBackupPlanFromTemplate(GetBackupPlanFromTemplateRequest getBackupPlanFromTemplateRequest)
Returns the template specified by its
templateId as a backup plan. |
GetBackupSelectionResult |
getBackupSelection(GetBackupSelectionRequest getBackupSelectionRequest)
Returns selection metadata and a document in JSON format that specifies a list of resources that are associated
with a backup plan.
|
GetBackupVaultAccessPolicyResult |
getBackupVaultAccessPolicy(GetBackupVaultAccessPolicyRequest getBackupVaultAccessPolicyRequest)
Returns the access policy document that is associated with the named backup vault.
|
GetBackupVaultNotificationsResult |
getBackupVaultNotifications(GetBackupVaultNotificationsRequest getBackupVaultNotificationsRequest)
Returns event notifications for the specified backup vault.
|
ResponseMetadata |
getCachedResponseMetadata(AmazonWebServiceRequest request)
Returns additional metadata for a previously executed successful request, typically used for debugging issues
where a service isn't acting as expected.
|
GetRecoveryPointRestoreMetadataResult |
getRecoveryPointRestoreMetadata(GetRecoveryPointRestoreMetadataRequest getRecoveryPointRestoreMetadataRequest)
Returns a set of metadata key-value pairs that were used to create the backup.
|
GetSupportedResourceTypesResult |
getSupportedResourceTypes(GetSupportedResourceTypesRequest getSupportedResourceTypesRequest)
Returns the AWS resource types supported by AWS Backup.
|
ListBackupJobsResult |
listBackupJobs(ListBackupJobsRequest listBackupJobsRequest)
Returns metadata about your backup jobs.
|
ListBackupPlansResult |
listBackupPlans(ListBackupPlansRequest listBackupPlansRequest)
Returns metadata of your saved backup plans, including Amazon Resource Names (ARNs), plan IDs, creation and
deletion dates, version IDs, plan names, and creator request IDs.
|
ListBackupPlanTemplatesResult |
listBackupPlanTemplates(ListBackupPlanTemplatesRequest listBackupPlanTemplatesRequest)
Returns metadata of your saved backup plan templates, including the template ID, name, and the creation and
deletion dates.
|
ListBackupPlanVersionsResult |
listBackupPlanVersions(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.
|
ListBackupSelectionsResult |
listBackupSelections(ListBackupSelectionsRequest listBackupSelectionsRequest)
Returns an array containing metadata of the resources associated with the target backup plan.
|
ListBackupVaultsResult |
listBackupVaults(ListBackupVaultsRequest listBackupVaultsRequest)
Returns a list of recovery point storage containers along with information about them.
|
ListCopyJobsResult |
listCopyJobs(ListCopyJobsRequest listCopyJobsRequest)
Returns metadata about your copy jobs.
|
ListProtectedResourcesResult |
listProtectedResources(ListProtectedResourcesRequest listProtectedResourcesRequest)
Returns an array of resources successfully backed up by AWS Backup, including the time the resource was saved, an
Amazon Resource Name (ARN) of the resource, and a resource type.
|
ListRecoveryPointsByBackupVaultResult |
listRecoveryPointsByBackupVault(ListRecoveryPointsByBackupVaultRequest listRecoveryPointsByBackupVaultRequest)
Returns detailed information about the recovery points stored in a backup vault.
|
ListRecoveryPointsByResourceResult |
listRecoveryPointsByResource(ListRecoveryPointsByResourceRequest listRecoveryPointsByResourceRequest)
Returns detailed information about recovery points of the type specified by a resource Amazon Resource Name
(ARN).
|
ListRestoreJobsResult |
listRestoreJobs(ListRestoreJobsRequest listRestoreJobsRequest)
Returns a list of jobs that AWS Backup initiated to restore a saved resource, including metadata about the
recovery process.
|
ListTagsResult |
listTags(ListTagsRequest listTagsRequest)
Returns a list of key-value pairs assigned to a target recovery point, backup plan, or backup vault.
|
PutBackupVaultAccessPolicyResult |
putBackupVaultAccessPolicy(PutBackupVaultAccessPolicyRequest putBackupVaultAccessPolicyRequest)
Sets a resource-based policy that is used to manage access permissions on the target backup vault.
|
PutBackupVaultNotificationsResult |
putBackupVaultNotifications(PutBackupVaultNotificationsRequest putBackupVaultNotificationsRequest)
Turns on notifications on a backup vault for the specified topic and events.
|
void |
shutdown()
Shuts down this client object, releasing any resources that might be held open.
|
StartBackupJobResult |
startBackupJob(StartBackupJobRequest startBackupJobRequest)
Starts a job to create a one-time backup of the specified resource.
|
StartCopyJobResult |
startCopyJob(StartCopyJobRequest startCopyJobRequest)
Starts a job to create a one-time copy of the specified resource.
|
StartRestoreJobResult |
startRestoreJob(StartRestoreJobRequest startRestoreJobRequest)
Recovers the saved resource identified by an Amazon Resource Name (ARN).
|
StopBackupJobResult |
stopBackupJob(StopBackupJobRequest stopBackupJobRequest)
Attempts to cancel a job to create a one-time backup of a resource.
|
TagResourceResult |
tagResource(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).
|
UntagResourceResult |
untagResource(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)
|
UpdateBackupPlanResult |
updateBackupPlan(UpdateBackupPlanRequest updateBackupPlanRequest)
Replaces the body of a saved backup plan identified by its
backupPlanId with the input document in
JSON format. |
UpdateRecoveryPointLifecycleResult |
updateRecoveryPointLifecycle(UpdateRecoveryPointLifecycleRequest updateRecoveryPointLifecycleRequest)
Sets the transition lifecycle of a recovery point.
|
UpdateRegionSettingsResult |
updateRegionSettings(UpdateRegionSettingsRequest updateRegionSettingsRequest)
Updates the current service opt-in settings for the Region.
|
static final String ENDPOINT_PREFIX
CreateBackupPlanResult createBackupPlan(CreateBackupPlanRequest createBackupPlanRequest)
Backup plans are documents that contain information that AWS Backup uses to schedule tasks that create recovery points of resources.
If you call CreateBackupPlan
with a plan that already exists, an AlreadyExistsException
is returned.
createBackupPlanRequest
- LimitExceededException
- A limit in the request has been exceeded; for example, a maximum number of items allowed in a request.AlreadyExistsException
- The required resource already exists.InvalidParameterValueException
- Indicates that something is wrong with a parameter's value. For example, the value is out of range.MissingParameterValueException
- Indicates that a required parameter is missing.ServiceUnavailableException
- The request failed due to a temporary failure of the server.CreateBackupSelectionResult createBackupSelection(CreateBackupSelectionRequest createBackupSelectionRequest)
Creates a JSON document that specifies a set of resources to assign to a backup plan. Resources can be included
by specifying patterns for a ListOfTags
and selected Resources
.
For example, consider the following patterns:
Resources: "arn:aws:ec2:region:account-id:volume/volume-id"
ConditionKey:"department"
ConditionValue:"finance"
ConditionType:"StringEquals"
ConditionKey:"importance"
ConditionValue:"critical"
ConditionType:"StringEquals"
Using these patterns would back up all Amazon Elastic Block Store (Amazon EBS) volumes that are tagged as
"department=finance"
, "importance=critical"
, in addition to an EBS volume with the
specified volume Id.
Resources and conditions are additive in that all resources that match the pattern are selected. This shouldn't be confused with a logical AND, where all conditions must match. The matching patterns are logically 'put together using the OR operator. In other words, all patterns that match are selected for backup.
createBackupSelectionRequest
- LimitExceededException
- A limit in the request has been exceeded; for example, a maximum number of items allowed in a request.AlreadyExistsException
- The required resource already exists.InvalidParameterValueException
- Indicates that something is wrong with a parameter's value. For example, the value is out of range.MissingParameterValueException
- Indicates that a required parameter is missing.ServiceUnavailableException
- The request failed due to a temporary failure of the server.CreateBackupVaultResult createBackupVault(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.
Sensitive data, such as passport numbers, should not be included the name of a backup vault.
createBackupVaultRequest
- InvalidParameterValueException
- Indicates that something is wrong with a parameter's value. For example, the value is out of range.MissingParameterValueException
- Indicates that a required parameter is missing.ServiceUnavailableException
- The request failed due to a temporary failure of the server.LimitExceededException
- A limit in the request has been exceeded; for example, a maximum number of items allowed in a request.AlreadyExistsException
- The required resource already exists.DeleteBackupPlanResult deleteBackupPlan(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
- ResourceNotFoundException
- A resource that is required for the action doesn't exist.InvalidParameterValueException
- Indicates that something is wrong with a parameter's value. For example, the value is out of range.MissingParameterValueException
- Indicates that a required parameter is missing.ServiceUnavailableException
- The request failed due to a temporary failure of the server.InvalidRequestException
- Indicates that something is wrong with the input to the request. For example, a parameter is of the wrong
type.DeleteBackupSelectionResult deleteBackupSelection(DeleteBackupSelectionRequest deleteBackupSelectionRequest)
Deletes the resource selection associated with a backup plan that is specified by the SelectionId
.
deleteBackupSelectionRequest
- ResourceNotFoundException
- A resource that is required for the action doesn't exist.InvalidParameterValueException
- Indicates that something is wrong with a parameter's value. For example, the value is out of range.MissingParameterValueException
- Indicates that a required parameter is missing.ServiceUnavailableException
- The request failed due to a temporary failure of the server.DeleteBackupVaultResult deleteBackupVault(DeleteBackupVaultRequest deleteBackupVaultRequest)
Deletes the backup vault identified by its name. A vault can be deleted only if it is empty.
deleteBackupVaultRequest
- ResourceNotFoundException
- A resource that is required for the action doesn't exist.InvalidParameterValueException
- Indicates that something is wrong with a parameter's value. For example, the value is out of range.MissingParameterValueException
- Indicates that a required parameter is missing.ServiceUnavailableException
- The request failed due to a temporary failure of the server.InvalidRequestException
- Indicates that something is wrong with the input to the request. For example, a parameter is of the wrong
type.DeleteBackupVaultAccessPolicyResult deleteBackupVaultAccessPolicy(DeleteBackupVaultAccessPolicyRequest deleteBackupVaultAccessPolicyRequest)
Deletes the policy document that manages permissions on a backup vault.
deleteBackupVaultAccessPolicyRequest
- ResourceNotFoundException
- A resource that is required for the action doesn't exist.InvalidParameterValueException
- Indicates that something is wrong with a parameter's value. For example, the value is out of range.MissingParameterValueException
- Indicates that a required parameter is missing.ServiceUnavailableException
- The request failed due to a temporary failure of the server.DeleteBackupVaultNotificationsResult deleteBackupVaultNotifications(DeleteBackupVaultNotificationsRequest deleteBackupVaultNotificationsRequest)
Deletes event notifications for the specified backup vault.
deleteBackupVaultNotificationsRequest
- ResourceNotFoundException
- A resource that is required for the action doesn't exist.InvalidParameterValueException
- Indicates that something is wrong with a parameter's value. For example, the value is out of range.MissingParameterValueException
- Indicates that a required parameter is missing.ServiceUnavailableException
- The request failed due to a temporary failure of the server.DeleteRecoveryPointResult deleteRecoveryPoint(DeleteRecoveryPointRequest deleteRecoveryPointRequest)
Deletes the recovery point specified by a recovery point ID.
deleteRecoveryPointRequest
- ResourceNotFoundException
- A resource that is required for the action doesn't exist.InvalidParameterValueException
- Indicates that something is wrong with a parameter's value. For example, the value is out of range.MissingParameterValueException
- Indicates that a required parameter is missing.ServiceUnavailableException
- The request failed due to a temporary failure of the server.InvalidRequestException
- Indicates that something is wrong with the input to the request. For example, a parameter is of the wrong
type.DescribeBackupJobResult describeBackupJob(DescribeBackupJobRequest describeBackupJobRequest)
Returns metadata associated with creating a backup of a resource.
describeBackupJobRequest
- ResourceNotFoundException
- A resource that is required for the action doesn't exist.InvalidParameterValueException
- Indicates that something is wrong with a parameter's value. For example, the value is out of range.MissingParameterValueException
- Indicates that a required parameter is missing.ServiceUnavailableException
- The request failed due to a temporary failure of the server.DependencyFailureException
- A dependent AWS service or resource returned an error to the AWS Backup service, and the action cannot be
completed.DescribeBackupVaultResult describeBackupVault(DescribeBackupVaultRequest describeBackupVaultRequest)
Returns metadata about a backup vault specified by its name.
describeBackupVaultRequest
- ResourceNotFoundException
- A resource that is required for the action doesn't exist.InvalidParameterValueException
- Indicates that something is wrong with a parameter's value. For example, the value is out of range.MissingParameterValueException
- Indicates that a required parameter is missing.ServiceUnavailableException
- The request failed due to a temporary failure of the server.DescribeCopyJobResult describeCopyJob(DescribeCopyJobRequest describeCopyJobRequest)
Returns metadata associated with creating a copy of a resource.
describeCopyJobRequest
- ResourceNotFoundException
- A resource that is required for the action doesn't exist.InvalidParameterValueException
- Indicates that something is wrong with a parameter's value. For example, the value is out of range.MissingParameterValueException
- Indicates that a required parameter is missing.ServiceUnavailableException
- The request failed due to a temporary failure of the server.DescribeProtectedResourceResult describeProtectedResource(DescribeProtectedResourceRequest describeProtectedResourceRequest)
Returns information about a saved resource, including the last time it was backed up, its Amazon Resource Name (ARN), and the AWS service type of the saved resource.
describeProtectedResourceRequest
- MissingParameterValueException
- Indicates that a required parameter is missing.InvalidParameterValueException
- Indicates that something is wrong with a parameter's value. For example, the value is out of range.ServiceUnavailableException
- The request failed due to a temporary failure of the server.ResourceNotFoundException
- A resource that is required for the action doesn't exist.DescribeRecoveryPointResult describeRecoveryPoint(DescribeRecoveryPointRequest describeRecoveryPointRequest)
Returns metadata associated with a recovery point, including ID, status, encryption, and lifecycle.
describeRecoveryPointRequest
- ResourceNotFoundException
- A resource that is required for the action doesn't exist.InvalidParameterValueException
- Indicates that something is wrong with a parameter's value. For example, the value is out of range.MissingParameterValueException
- Indicates that a required parameter is missing.ServiceUnavailableException
- The request failed due to a temporary failure of the server.DescribeRegionSettingsResult describeRegionSettings(DescribeRegionSettingsRequest describeRegionSettingsRequest)
Returns the current service opt-in settings for the Region. If the service has a value set to true
,
AWS Backup attempts to protect that service's resources in this Region, when included in an on-demand backup or
scheduled backup plan. If the value is set to false
for a service, AWS Backup does not attempt to
protect that service's resources in this Region.
describeRegionSettingsRequest
- ServiceUnavailableException
- The request failed due to a temporary failure of the server.DescribeRestoreJobResult describeRestoreJob(DescribeRestoreJobRequest describeRestoreJobRequest)
Returns metadata associated with a restore job that is specified by a job ID.
describeRestoreJobRequest
- ResourceNotFoundException
- A resource that is required for the action doesn't exist.InvalidParameterValueException
- Indicates that something is wrong with a parameter's value. For example, the value is out of range.MissingParameterValueException
- Indicates that a required parameter is missing.ServiceUnavailableException
- The request failed due to a temporary failure of the server.DependencyFailureException
- A dependent AWS service or resource returned an error to the AWS Backup service, and the action cannot be
completed.ExportBackupPlanTemplateResult exportBackupPlanTemplate(ExportBackupPlanTemplateRequest exportBackupPlanTemplateRequest)
Returns the backup plan that is specified by the plan ID as a backup template.
exportBackupPlanTemplateRequest
- InvalidParameterValueException
- Indicates that something is wrong with a parameter's value. For example, the value is out of range.MissingParameterValueException
- Indicates that a required parameter is missing.ServiceUnavailableException
- The request failed due to a temporary failure of the server.ResourceNotFoundException
- A resource that is required for the action doesn't exist.GetBackupPlanResult getBackupPlan(GetBackupPlanRequest getBackupPlanRequest)
Returns the body of a backup plan in JSON format, in addition to plan metadata.
getBackupPlanRequest
- ResourceNotFoundException
- A resource that is required for the action doesn't exist.InvalidParameterValueException
- Indicates that something is wrong with a parameter's value. For example, the value is out of range.MissingParameterValueException
- Indicates that a required parameter is missing.ServiceUnavailableException
- The request failed due to a temporary failure of the server.GetBackupPlanFromJSONResult getBackupPlanFromJSON(GetBackupPlanFromJSONRequest getBackupPlanFromJSONRequest)
Returns a valid JSON document specifying a backup plan or an error.
getBackupPlanFromJSONRequest
- LimitExceededException
- A limit in the request has been exceeded; for example, a maximum number of items allowed in a request.InvalidParameterValueException
- Indicates that something is wrong with a parameter's value. For example, the value is out of range.MissingParameterValueException
- Indicates that a required parameter is missing.ServiceUnavailableException
- The request failed due to a temporary failure of the server.InvalidRequestException
- Indicates that something is wrong with the input to the request. For example, a parameter is of the wrong
type.GetBackupPlanFromTemplateResult getBackupPlanFromTemplate(GetBackupPlanFromTemplateRequest getBackupPlanFromTemplateRequest)
Returns the template specified by its templateId
as a backup plan.
getBackupPlanFromTemplateRequest
- InvalidParameterValueException
- Indicates that something is wrong with a parameter's value. For example, the value is out of range.MissingParameterValueException
- Indicates that a required parameter is missing.ServiceUnavailableException
- The request failed due to a temporary failure of the server.ResourceNotFoundException
- A resource that is required for the action doesn't exist.GetBackupSelectionResult getBackupSelection(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
- ResourceNotFoundException
- A resource that is required for the action doesn't exist.InvalidParameterValueException
- Indicates that something is wrong with a parameter's value. For example, the value is out of range.MissingParameterValueException
- Indicates that a required parameter is missing.ServiceUnavailableException
- The request failed due to a temporary failure of the server.GetBackupVaultAccessPolicyResult getBackupVaultAccessPolicy(GetBackupVaultAccessPolicyRequest getBackupVaultAccessPolicyRequest)
Returns the access policy document that is associated with the named backup vault.
getBackupVaultAccessPolicyRequest
- ResourceNotFoundException
- A resource that is required for the action doesn't exist.InvalidParameterValueException
- Indicates that something is wrong with a parameter's value. For example, the value is out of range.MissingParameterValueException
- Indicates that a required parameter is missing.ServiceUnavailableException
- The request failed due to a temporary failure of the server.GetBackupVaultNotificationsResult getBackupVaultNotifications(GetBackupVaultNotificationsRequest getBackupVaultNotificationsRequest)
Returns event notifications for the specified backup vault.
getBackupVaultNotificationsRequest
- ResourceNotFoundException
- A resource that is required for the action doesn't exist.InvalidParameterValueException
- Indicates that something is wrong with a parameter's value. For example, the value is out of range.MissingParameterValueException
- Indicates that a required parameter is missing.ServiceUnavailableException
- The request failed due to a temporary failure of the server.GetRecoveryPointRestoreMetadataResult getRecoveryPointRestoreMetadata(GetRecoveryPointRestoreMetadataRequest getRecoveryPointRestoreMetadataRequest)
Returns a set of metadata key-value pairs that were used to create the backup.
getRecoveryPointRestoreMetadataRequest
- ResourceNotFoundException
- A resource that is required for the action doesn't exist.InvalidParameterValueException
- Indicates that something is wrong with a parameter's value. For example, the value is out of range.MissingParameterValueException
- Indicates that a required parameter is missing.ServiceUnavailableException
- The request failed due to a temporary failure of the server.GetSupportedResourceTypesResult getSupportedResourceTypes(GetSupportedResourceTypesRequest getSupportedResourceTypesRequest)
Returns the AWS resource types supported by AWS Backup.
getSupportedResourceTypesRequest
- ServiceUnavailableException
- The request failed due to a temporary failure of the server.ListBackupJobsResult listBackupJobs(ListBackupJobsRequest listBackupJobsRequest)
Returns metadata about your backup jobs.
listBackupJobsRequest
- InvalidParameterValueException
- Indicates that something is wrong with a parameter's value. For example, the value is out of range.ServiceUnavailableException
- The request failed due to a temporary failure of the server.ListBackupPlanTemplatesResult listBackupPlanTemplates(ListBackupPlanTemplatesRequest listBackupPlanTemplatesRequest)
Returns metadata of your saved backup plan templates, including the template ID, name, and the creation and deletion dates.
listBackupPlanTemplatesRequest
- InvalidParameterValueException
- Indicates that something is wrong with a parameter's value. For example, the value is out of range.MissingParameterValueException
- Indicates that a required parameter is missing.ServiceUnavailableException
- The request failed due to a temporary failure of the server.ResourceNotFoundException
- A resource that is required for the action doesn't exist.ListBackupPlanVersionsResult listBackupPlanVersions(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
- ResourceNotFoundException
- A resource that is required for the action doesn't exist.InvalidParameterValueException
- Indicates that something is wrong with a parameter's value. For example, the value is out of range.MissingParameterValueException
- Indicates that a required parameter is missing.ServiceUnavailableException
- The request failed due to a temporary failure of the server.ListBackupPlansResult listBackupPlans(ListBackupPlansRequest listBackupPlansRequest)
Returns metadata of your saved backup plans, including Amazon Resource Names (ARNs), plan IDs, creation and deletion dates, version IDs, plan names, and creator request IDs.
listBackupPlansRequest
- ResourceNotFoundException
- A resource that is required for the action doesn't exist.InvalidParameterValueException
- Indicates that something is wrong with a parameter's value. For example, the value is out of range.MissingParameterValueException
- Indicates that a required parameter is missing.ServiceUnavailableException
- The request failed due to a temporary failure of the server.ListBackupSelectionsResult listBackupSelections(ListBackupSelectionsRequest listBackupSelectionsRequest)
Returns an array containing metadata of the resources associated with the target backup plan.
listBackupSelectionsRequest
- ResourceNotFoundException
- A resource that is required for the action doesn't exist.InvalidParameterValueException
- Indicates that something is wrong with a parameter's value. For example, the value is out of range.MissingParameterValueException
- Indicates that a required parameter is missing.ServiceUnavailableException
- The request failed due to a temporary failure of the server.ListBackupVaultsResult listBackupVaults(ListBackupVaultsRequest listBackupVaultsRequest)
Returns a list of recovery point storage containers along with information about them.
listBackupVaultsRequest
- ResourceNotFoundException
- A resource that is required for the action doesn't exist.InvalidParameterValueException
- Indicates that something is wrong with a parameter's value. For example, the value is out of range.MissingParameterValueException
- Indicates that a required parameter is missing.ServiceUnavailableException
- The request failed due to a temporary failure of the server.ListCopyJobsResult listCopyJobs(ListCopyJobsRequest listCopyJobsRequest)
Returns metadata about your copy jobs.
listCopyJobsRequest
- InvalidParameterValueException
- Indicates that something is wrong with a parameter's value. For example, the value is out of range.ServiceUnavailableException
- The request failed due to a temporary failure of the server.ListProtectedResourcesResult listProtectedResources(ListProtectedResourcesRequest listProtectedResourcesRequest)
Returns an array of resources successfully backed up by AWS Backup, including the time the resource was saved, an Amazon Resource Name (ARN) of the resource, and a resource type.
listProtectedResourcesRequest
- InvalidParameterValueException
- Indicates that something is wrong with a parameter's value. For example, the value is out of range.ServiceUnavailableException
- The request failed due to a temporary failure of the server.ListRecoveryPointsByBackupVaultResult listRecoveryPointsByBackupVault(ListRecoveryPointsByBackupVaultRequest listRecoveryPointsByBackupVaultRequest)
Returns detailed information about the recovery points stored in a backup vault.
listRecoveryPointsByBackupVaultRequest
- ResourceNotFoundException
- A resource that is required for the action doesn't exist.InvalidParameterValueException
- Indicates that something is wrong with a parameter's value. For example, the value is out of range.MissingParameterValueException
- Indicates that a required parameter is missing.ServiceUnavailableException
- The request failed due to a temporary failure of the server.ListRecoveryPointsByResourceResult listRecoveryPointsByResource(ListRecoveryPointsByResourceRequest listRecoveryPointsByResourceRequest)
Returns detailed information about recovery points of the type specified by a resource Amazon Resource Name (ARN).
listRecoveryPointsByResourceRequest
- ResourceNotFoundException
- A resource that is required for the action doesn't exist.InvalidParameterValueException
- Indicates that something is wrong with a parameter's value. For example, the value is out of range.MissingParameterValueException
- Indicates that a required parameter is missing.ServiceUnavailableException
- The request failed due to a temporary failure of the server.ListRestoreJobsResult listRestoreJobs(ListRestoreJobsRequest listRestoreJobsRequest)
Returns a list of jobs that AWS Backup initiated to restore a saved resource, including metadata about the recovery process.
listRestoreJobsRequest
- ResourceNotFoundException
- A resource that is required for the action doesn't exist.InvalidParameterValueException
- Indicates that something is wrong with a parameter's value. For example, the value is out of range.MissingParameterValueException
- Indicates that a required parameter is missing.ServiceUnavailableException
- The request failed due to a temporary failure of the server.ListTagsResult listTags(ListTagsRequest listTagsRequest)
Returns a list of key-value pairs assigned to a target recovery point, backup plan, or backup vault.
ListTags
are currently only supported with Amazon EFS backups.
listTagsRequest
- ResourceNotFoundException
- A resource that is required for the action doesn't exist.InvalidParameterValueException
- Indicates that something is wrong with a parameter's value. For example, the value is out of range.MissingParameterValueException
- Indicates that a required parameter is missing.ServiceUnavailableException
- The request failed due to a temporary failure of the server.PutBackupVaultAccessPolicyResult putBackupVaultAccessPolicy(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
- ResourceNotFoundException
- A resource that is required for the action doesn't exist.InvalidParameterValueException
- Indicates that something is wrong with a parameter's value. For example, the value is out of range.MissingParameterValueException
- Indicates that a required parameter is missing.ServiceUnavailableException
- The request failed due to a temporary failure of the server.PutBackupVaultNotificationsResult putBackupVaultNotifications(PutBackupVaultNotificationsRequest putBackupVaultNotificationsRequest)
Turns on notifications on a backup vault for the specified topic and events.
putBackupVaultNotificationsRequest
- ResourceNotFoundException
- A resource that is required for the action doesn't exist.InvalidParameterValueException
- Indicates that something is wrong with a parameter's value. For example, the value is out of range.MissingParameterValueException
- Indicates that a required parameter is missing.ServiceUnavailableException
- The request failed due to a temporary failure of the server.StartBackupJobResult startBackupJob(StartBackupJobRequest startBackupJobRequest)
Starts a job to create a one-time backup of the specified resource.
startBackupJobRequest
- ResourceNotFoundException
- A resource that is required for the action doesn't exist.InvalidParameterValueException
- Indicates that something is wrong with a parameter's value. For example, the value is out of range.MissingParameterValueException
- Indicates that a required parameter is missing.ServiceUnavailableException
- The request failed due to a temporary failure of the server.LimitExceededException
- A limit in the request has been exceeded; for example, a maximum number of items allowed in a request.StartCopyJobResult startCopyJob(StartCopyJobRequest startCopyJobRequest)
Starts a job to create a one-time copy of the specified resource.
startCopyJobRequest
- ResourceNotFoundException
- A resource that is required for the action doesn't exist.InvalidParameterValueException
- Indicates that something is wrong with a parameter's value. For example, the value is out of range.MissingParameterValueException
- Indicates that a required parameter is missing.ServiceUnavailableException
- The request failed due to a temporary failure of the server.LimitExceededException
- A limit in the request has been exceeded; for example, a maximum number of items allowed in a request.StartRestoreJobResult startRestoreJob(StartRestoreJobRequest startRestoreJobRequest)
Recovers the saved resource identified by an Amazon Resource Name (ARN).
If the resource ARN is included in the request, then the last complete backup of that resource is recovered. If the ARN of a recovery point is supplied, then that recovery point is restored.
startRestoreJobRequest
- ResourceNotFoundException
- A resource that is required for the action doesn't exist.InvalidParameterValueException
- Indicates that something is wrong with a parameter's value. For example, the value is out of range.MissingParameterValueException
- Indicates that a required parameter is missing.ServiceUnavailableException
- The request failed due to a temporary failure of the server.StopBackupJobResult stopBackupJob(StopBackupJobRequest stopBackupJobRequest)
Attempts to cancel a job to create a one-time backup of a resource.
stopBackupJobRequest
- MissingParameterValueException
- Indicates that a required parameter is missing.ResourceNotFoundException
- A resource that is required for the action doesn't exist.InvalidParameterValueException
- Indicates that something is wrong with a parameter's value. For example, the value is out of range.InvalidRequestException
- Indicates that something is wrong with the input to the request. For example, a parameter is of the wrong
type.ServiceUnavailableException
- The request failed due to a temporary failure of the server.TagResourceResult tagResource(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
- ResourceNotFoundException
- A resource that is required for the action doesn't exist.InvalidParameterValueException
- Indicates that something is wrong with a parameter's value. For example, the value is out of range.MissingParameterValueException
- Indicates that a required parameter is missing.ServiceUnavailableException
- The request failed due to a temporary failure of the server.LimitExceededException
- A limit in the request has been exceeded; for example, a maximum number of items allowed in a request.UntagResourceResult untagResource(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
- ResourceNotFoundException
- A resource that is required for the action doesn't exist.InvalidParameterValueException
- Indicates that something is wrong with a parameter's value. For example, the value is out of range.MissingParameterValueException
- Indicates that a required parameter is missing.ServiceUnavailableException
- The request failed due to a temporary failure of the server.UpdateBackupPlanResult updateBackupPlan(UpdateBackupPlanRequest updateBackupPlanRequest)
Replaces the body of a saved backup plan identified by its backupPlanId
with the input document in
JSON format. The new version is uniquely identified by a VersionId
.
updateBackupPlanRequest
- ResourceNotFoundException
- A resource that is required for the action doesn't exist.InvalidParameterValueException
- Indicates that something is wrong with a parameter's value. For example, the value is out of range.MissingParameterValueException
- Indicates that a required parameter is missing.ServiceUnavailableException
- The request failed due to a temporary failure of the server.UpdateRecoveryPointLifecycleResult updateRecoveryPointLifecycle(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. AWS Backup transitions and expires backups automatically according to the lifecycle that you define.
Backups transitioned to cold storage must be stored in cold storage for a minimum of 90 days. Therefore, the “expire after days” setting must be 90 days greater than the “transition to cold after days” setting. The “transition to cold after days” setting cannot be changed after a backup has been transitioned to cold.
updateRecoveryPointLifecycleRequest
- ResourceNotFoundException
- A resource that is required for the action doesn't exist.InvalidParameterValueException
- Indicates that something is wrong with a parameter's value. For example, the value is out of range.MissingParameterValueException
- Indicates that a required parameter is missing.ServiceUnavailableException
- The request failed due to a temporary failure of the server.UpdateRegionSettingsResult updateRegionSettings(UpdateRegionSettingsRequest updateRegionSettingsRequest)
Updates the current service opt-in settings for the Region. If the service has a value set to true
,
AWS Backup attempts to protect that service's resources in this Region, when included in an on-demand backup or
scheduled backup plan. If the value is set to false
for a service, AWS Backup does not attempt to
protect that service's resources in this Region.
updateRegionSettingsRequest
- ServiceUnavailableException
- The request failed due to a temporary failure of the server.MissingParameterValueException
- Indicates that a required parameter is missing.InvalidParameterValueException
- Indicates that something is wrong with a parameter's value. For example, the value is out of range.void shutdown()
ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
Response metadata is only cached for a limited period of time, so if you need to access this extra diagnostic information for an executed request, you should use this method to retrieve it as soon as possible after executing a request.
request
- The originally executed request.