@ThreadSafe @Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class AWSBackupClient extends AmazonWebServiceClient implements AWSBackup
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.
LOGGING_AWS_REQUEST_METRIC
ENDPOINT_PREFIX
Modifier and Type | Method and Description |
---|---|
static AWSBackupClientBuilder |
builder() |
CreateBackupPlanResult |
createBackupPlan(CreateBackupPlanRequest request)
Backup plans are documents that contain information that AWS Backup uses to schedule tasks that create recovery
points of resources.
|
CreateBackupSelectionResult |
createBackupSelection(CreateBackupSelectionRequest request)
Creates a JSON document that specifies a set of resources to assign to a backup plan.
|
CreateBackupVaultResult |
createBackupVault(CreateBackupVaultRequest request)
Creates a logical container where backups are stored.
|
DeleteBackupPlanResult |
deleteBackupPlan(DeleteBackupPlanRequest request)
Deletes a backup plan.
|
DeleteBackupSelectionResult |
deleteBackupSelection(DeleteBackupSelectionRequest request)
Deletes the resource selection associated with a backup plan that is specified by the
SelectionId . |
DeleteBackupVaultResult |
deleteBackupVault(DeleteBackupVaultRequest request)
Deletes the backup vault identified by its name.
|
DeleteBackupVaultAccessPolicyResult |
deleteBackupVaultAccessPolicy(DeleteBackupVaultAccessPolicyRequest request)
Deletes the policy document that manages permissions on a backup vault.
|
DeleteBackupVaultNotificationsResult |
deleteBackupVaultNotifications(DeleteBackupVaultNotificationsRequest request)
Deletes event notifications for the specified backup vault.
|
DeleteRecoveryPointResult |
deleteRecoveryPoint(DeleteRecoveryPointRequest request)
Deletes the recovery point specified by a recovery point ID.
|
DescribeBackupJobResult |
describeBackupJob(DescribeBackupJobRequest request)
Returns metadata associated with creating a backup of a resource.
|
DescribeBackupVaultResult |
describeBackupVault(DescribeBackupVaultRequest request)
Returns metadata about a backup vault specified by its name.
|
DescribeCopyJobResult |
describeCopyJob(DescribeCopyJobRequest request)
Returns metadata associated with creating a copy of a resource.
|
DescribeProtectedResourceResult |
describeProtectedResource(DescribeProtectedResourceRequest request)
Returns information about a saved resource, including the last time it was backed up, its Amazon Resource Name
(ARN), and the AWS service type of the saved resource.
|
DescribeRecoveryPointResult |
describeRecoveryPoint(DescribeRecoveryPointRequest request)
Returns metadata associated with a recovery point, including ID, status, encryption, and lifecycle.
|
DescribeRegionSettingsResult |
describeRegionSettings(DescribeRegionSettingsRequest request)
Returns the current service opt-in settings for the Region.
|
DescribeRestoreJobResult |
describeRestoreJob(DescribeRestoreJobRequest request)
Returns metadata associated with a restore job that is specified by a job ID.
|
ExportBackupPlanTemplateResult |
exportBackupPlanTemplate(ExportBackupPlanTemplateRequest request)
Returns the backup plan that is specified by the plan ID as a backup template.
|
GetBackupPlanResult |
getBackupPlan(GetBackupPlanRequest request)
Returns the body of a backup plan in JSON format, in addition to plan metadata.
|
GetBackupPlanFromJSONResult |
getBackupPlanFromJSON(GetBackupPlanFromJSONRequest request)
Returns a valid JSON document specifying a backup plan or an error.
|
GetBackupPlanFromTemplateResult |
getBackupPlanFromTemplate(GetBackupPlanFromTemplateRequest request)
Returns the template specified by its
templateId as a backup plan. |
GetBackupSelectionResult |
getBackupSelection(GetBackupSelectionRequest request)
Returns selection metadata and a document in JSON format that specifies a list of resources that are associated
with a backup plan.
|
GetBackupVaultAccessPolicyResult |
getBackupVaultAccessPolicy(GetBackupVaultAccessPolicyRequest request)
Returns the access policy document that is associated with the named backup vault.
|
GetBackupVaultNotificationsResult |
getBackupVaultNotifications(GetBackupVaultNotificationsRequest request)
Returns event notifications for the specified backup vault.
|
ResponseMetadata |
getCachedResponseMetadata(AmazonWebServiceRequest request)
Returns additional metadata for a previously executed successful, request, typically used for debugging issues
where a service isn't acting as expected.
|
GetRecoveryPointRestoreMetadataResult |
getRecoveryPointRestoreMetadata(GetRecoveryPointRestoreMetadataRequest request)
Returns a set of metadata key-value pairs that were used to create the backup.
|
GetSupportedResourceTypesResult |
getSupportedResourceTypes(GetSupportedResourceTypesRequest request)
Returns the AWS resource types supported by AWS Backup.
|
ListBackupJobsResult |
listBackupJobs(ListBackupJobsRequest request)
Returns metadata about your backup jobs.
|
ListBackupPlansResult |
listBackupPlans(ListBackupPlansRequest request)
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 request)
Returns metadata of your saved backup plan templates, including the template ID, name, and the creation and
deletion dates.
|
ListBackupPlanVersionsResult |
listBackupPlanVersions(ListBackupPlanVersionsRequest request)
Returns version metadata of your backup plans, including Amazon Resource Names (ARNs), backup plan IDs, creation
and deletion dates, plan names, and version IDs.
|
ListBackupSelectionsResult |
listBackupSelections(ListBackupSelectionsRequest request)
Returns an array containing metadata of the resources associated with the target backup plan.
|
ListBackupVaultsResult |
listBackupVaults(ListBackupVaultsRequest request)
Returns a list of recovery point storage containers along with information about them.
|
ListCopyJobsResult |
listCopyJobs(ListCopyJobsRequest request)
Returns metadata about your copy jobs.
|
ListProtectedResourcesResult |
listProtectedResources(ListProtectedResourcesRequest request)
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 request)
Returns detailed information about the recovery points stored in a backup vault.
|
ListRecoveryPointsByResourceResult |
listRecoveryPointsByResource(ListRecoveryPointsByResourceRequest request)
Returns detailed information about recovery points of the type specified by a resource Amazon Resource Name
(ARN).
|
ListRestoreJobsResult |
listRestoreJobs(ListRestoreJobsRequest request)
Returns a list of jobs that AWS Backup initiated to restore a saved resource, including metadata about the
recovery process.
|
ListTagsResult |
listTags(ListTagsRequest request)
Returns a list of key-value pairs assigned to a target recovery point, backup plan, or backup vault.
|
PutBackupVaultAccessPolicyResult |
putBackupVaultAccessPolicy(PutBackupVaultAccessPolicyRequest request)
Sets a resource-based policy that is used to manage access permissions on the target backup vault.
|
PutBackupVaultNotificationsResult |
putBackupVaultNotifications(PutBackupVaultNotificationsRequest request)
Turns on notifications on a backup vault for the specified topic and events.
|
StartBackupJobResult |
startBackupJob(StartBackupJobRequest request)
Starts a job to create a one-time backup of the specified resource.
|
StartCopyJobResult |
startCopyJob(StartCopyJobRequest request)
Starts a job to create a one-time copy of the specified resource.
|
StartRestoreJobResult |
startRestoreJob(StartRestoreJobRequest request)
Recovers the saved resource identified by an Amazon Resource Name (ARN).
|
StopBackupJobResult |
stopBackupJob(StopBackupJobRequest request)
Attempts to cancel a job to create a one-time backup of a resource.
|
TagResourceResult |
tagResource(TagResourceRequest request)
Assigns a set of key-value pairs to a recovery point, backup plan, or backup vault identified by an Amazon
Resource Name (ARN).
|
UntagResourceResult |
untagResource(UntagResourceRequest request)
Removes a set of key-value pairs from a recovery point, backup plan, or backup vault identified by an Amazon
Resource Name (ARN)
|
UpdateBackupPlanResult |
updateBackupPlan(UpdateBackupPlanRequest request)
Replaces the body of a saved backup plan identified by its
backupPlanId with the input document in
JSON format. |
UpdateRecoveryPointLifecycleResult |
updateRecoveryPointLifecycle(UpdateRecoveryPointLifecycleRequest request)
Sets the transition lifecycle of a recovery point.
|
UpdateRegionSettingsResult |
updateRegionSettings(UpdateRegionSettingsRequest request)
Updates the current service opt-in settings for the Region.
|
addRequestHandler, addRequestHandler, configureRegion, getClientConfiguration, getEndpointPrefix, getMonitoringListeners, getRequestMetricsCollector, getServiceName, getSignerByURI, getSignerOverride, getSignerRegionOverride, getTimeOffset, makeImmutable, removeRequestHandler, removeRequestHandler, setEndpoint, setEndpoint, setRegion, setServiceNameIntern, setSignerRegionOverride, setTimeOffset, shutdown, withEndpoint, withRegion, withRegion, withTimeOffset
public static AWSBackupClientBuilder builder()
public CreateBackupPlanResult createBackupPlan(CreateBackupPlanRequest request)
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.
createBackupPlan
in interface AWSBackup
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.public CreateBackupSelectionResult createBackupSelection(CreateBackupSelectionRequest request)
Creates a JSON document that specifies a set of resources to assign to a backup plan. Resources can be included
by specifying patterns for a ListOfTags
and selected Resources
.
For example, consider the following patterns:
Resources: "arn:aws:ec2:region:account-id:volume/volume-id"
ConditionKey:"department"
ConditionValue:"finance"
ConditionType:"StringEquals"
ConditionKey:"importance"
ConditionValue:"critical"
ConditionType:"StringEquals"
Using these patterns would back up all Amazon Elastic Block Store (Amazon EBS) volumes that are tagged as
"department=finance"
, "importance=critical"
, in addition to an EBS volume with the
specified volume Id.
Resources and conditions are additive in that all resources that match the pattern are selected. This shouldn't be confused with a logical AND, where all conditions must match. The matching patterns are logically 'put together using the OR operator. In other words, all patterns that match are selected for backup.
createBackupSelection
in interface AWSBackup
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.public CreateBackupVaultResult createBackupVault(CreateBackupVaultRequest request)
Creates a logical container where backups are stored. A CreateBackupVault
request includes a name,
optionally one or more resource tags, an encryption key, and a request ID.
Sensitive data, such as passport numbers, should not be included the name of a backup vault.
createBackupVault
in interface AWSBackup
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.public DeleteBackupPlanResult deleteBackupPlan(DeleteBackupPlanRequest request)
Deletes a backup plan. A backup plan can only be deleted after all associated selections of resources have been deleted. Deleting a backup plan deletes the current version of a backup plan. Previous versions, if any, will still exist.
deleteBackupPlan
in interface AWSBackup
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.public DeleteBackupSelectionResult deleteBackupSelection(DeleteBackupSelectionRequest request)
Deletes the resource selection associated with a backup plan that is specified by the SelectionId
.
deleteBackupSelection
in interface AWSBackup
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.public DeleteBackupVaultResult deleteBackupVault(DeleteBackupVaultRequest request)
Deletes the backup vault identified by its name. A vault can be deleted only if it is empty.
deleteBackupVault
in interface AWSBackup
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.public DeleteBackupVaultAccessPolicyResult deleteBackupVaultAccessPolicy(DeleteBackupVaultAccessPolicyRequest request)
Deletes the policy document that manages permissions on a backup vault.
deleteBackupVaultAccessPolicy
in interface AWSBackup
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.public DeleteBackupVaultNotificationsResult deleteBackupVaultNotifications(DeleteBackupVaultNotificationsRequest request)
Deletes event notifications for the specified backup vault.
deleteBackupVaultNotifications
in interface AWSBackup
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.public DeleteRecoveryPointResult deleteRecoveryPoint(DeleteRecoveryPointRequest request)
Deletes the recovery point specified by a recovery point ID.
deleteRecoveryPoint
in interface AWSBackup
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.public DescribeBackupJobResult describeBackupJob(DescribeBackupJobRequest request)
Returns metadata associated with creating a backup of a resource.
describeBackupJob
in interface AWSBackup
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.public DescribeBackupVaultResult describeBackupVault(DescribeBackupVaultRequest request)
Returns metadata about a backup vault specified by its name.
describeBackupVault
in interface AWSBackup
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.public DescribeCopyJobResult describeCopyJob(DescribeCopyJobRequest request)
Returns metadata associated with creating a copy of a resource.
describeCopyJob
in interface AWSBackup
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.public DescribeProtectedResourceResult describeProtectedResource(DescribeProtectedResourceRequest request)
Returns information about a saved resource, including the last time it was backed up, its Amazon Resource Name (ARN), and the AWS service type of the saved resource.
describeProtectedResource
in interface AWSBackup
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.public DescribeRecoveryPointResult describeRecoveryPoint(DescribeRecoveryPointRequest request)
Returns metadata associated with a recovery point, including ID, status, encryption, and lifecycle.
describeRecoveryPoint
in interface AWSBackup
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.public DescribeRegionSettingsResult describeRegionSettings(DescribeRegionSettingsRequest request)
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.
describeRegionSettings
in interface AWSBackup
describeRegionSettingsRequest
- ServiceUnavailableException
- The request failed due to a temporary failure of the server.public DescribeRestoreJobResult describeRestoreJob(DescribeRestoreJobRequest request)
Returns metadata associated with a restore job that is specified by a job ID.
describeRestoreJob
in interface AWSBackup
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.public ExportBackupPlanTemplateResult exportBackupPlanTemplate(ExportBackupPlanTemplateRequest request)
Returns the backup plan that is specified by the plan ID as a backup template.
exportBackupPlanTemplate
in interface AWSBackup
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.public GetBackupPlanResult getBackupPlan(GetBackupPlanRequest request)
Returns the body of a backup plan in JSON format, in addition to plan metadata.
getBackupPlan
in interface AWSBackup
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.public GetBackupPlanFromJSONResult getBackupPlanFromJSON(GetBackupPlanFromJSONRequest request)
Returns a valid JSON document specifying a backup plan or an error.
getBackupPlanFromJSON
in interface AWSBackup
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.public GetBackupPlanFromTemplateResult getBackupPlanFromTemplate(GetBackupPlanFromTemplateRequest request)
Returns the template specified by its templateId
as a backup plan.
getBackupPlanFromTemplate
in interface AWSBackup
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.public GetBackupSelectionResult getBackupSelection(GetBackupSelectionRequest request)
Returns selection metadata and a document in JSON format that specifies a list of resources that are associated with a backup plan.
getBackupSelection
in interface AWSBackup
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.public GetBackupVaultAccessPolicyResult getBackupVaultAccessPolicy(GetBackupVaultAccessPolicyRequest request)
Returns the access policy document that is associated with the named backup vault.
getBackupVaultAccessPolicy
in interface AWSBackup
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.public GetBackupVaultNotificationsResult getBackupVaultNotifications(GetBackupVaultNotificationsRequest request)
Returns event notifications for the specified backup vault.
getBackupVaultNotifications
in interface AWSBackup
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.public GetRecoveryPointRestoreMetadataResult getRecoveryPointRestoreMetadata(GetRecoveryPointRestoreMetadataRequest request)
Returns a set of metadata key-value pairs that were used to create the backup.
getRecoveryPointRestoreMetadata
in interface AWSBackup
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.public GetSupportedResourceTypesResult getSupportedResourceTypes(GetSupportedResourceTypesRequest request)
Returns the AWS resource types supported by AWS Backup.
getSupportedResourceTypes
in interface AWSBackup
getSupportedResourceTypesRequest
- ServiceUnavailableException
- The request failed due to a temporary failure of the server.public ListBackupJobsResult listBackupJobs(ListBackupJobsRequest request)
Returns metadata about your backup jobs.
listBackupJobs
in interface AWSBackup
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.public ListBackupPlanTemplatesResult listBackupPlanTemplates(ListBackupPlanTemplatesRequest request)
Returns metadata of your saved backup plan templates, including the template ID, name, and the creation and deletion dates.
listBackupPlanTemplates
in interface AWSBackup
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.public ListBackupPlanVersionsResult listBackupPlanVersions(ListBackupPlanVersionsRequest request)
Returns version metadata of your backup plans, including Amazon Resource Names (ARNs), backup plan IDs, creation and deletion dates, plan names, and version IDs.
listBackupPlanVersions
in interface AWSBackup
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.public ListBackupPlansResult listBackupPlans(ListBackupPlansRequest request)
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.
listBackupPlans
in interface AWSBackup
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.public ListBackupSelectionsResult listBackupSelections(ListBackupSelectionsRequest request)
Returns an array containing metadata of the resources associated with the target backup plan.
listBackupSelections
in interface AWSBackup
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.public ListBackupVaultsResult listBackupVaults(ListBackupVaultsRequest request)
Returns a list of recovery point storage containers along with information about them.
listBackupVaults
in interface AWSBackup
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.public ListCopyJobsResult listCopyJobs(ListCopyJobsRequest request)
Returns metadata about your copy jobs.
listCopyJobs
in interface AWSBackup
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.public ListProtectedResourcesResult listProtectedResources(ListProtectedResourcesRequest request)
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.
listProtectedResources
in interface AWSBackup
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.public ListRecoveryPointsByBackupVaultResult listRecoveryPointsByBackupVault(ListRecoveryPointsByBackupVaultRequest request)
Returns detailed information about the recovery points stored in a backup vault.
listRecoveryPointsByBackupVault
in interface AWSBackup
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.public ListRecoveryPointsByResourceResult listRecoveryPointsByResource(ListRecoveryPointsByResourceRequest request)
Returns detailed information about recovery points of the type specified by a resource Amazon Resource Name (ARN).
listRecoveryPointsByResource
in interface AWSBackup
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.public ListRestoreJobsResult listRestoreJobs(ListRestoreJobsRequest request)
Returns a list of jobs that AWS Backup initiated to restore a saved resource, including metadata about the recovery process.
listRestoreJobs
in interface AWSBackup
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.public ListTagsResult listTags(ListTagsRequest request)
Returns a list of key-value pairs assigned to a target recovery point, backup plan, or backup vault.
ListTags
are currently only supported with Amazon EFS backups.
listTags
in interface AWSBackup
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.public PutBackupVaultAccessPolicyResult putBackupVaultAccessPolicy(PutBackupVaultAccessPolicyRequest request)
Sets a resource-based policy that is used to manage access permissions on the target backup vault. Requires a backup vault name and an access policy document in JSON format.
putBackupVaultAccessPolicy
in interface AWSBackup
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.public PutBackupVaultNotificationsResult putBackupVaultNotifications(PutBackupVaultNotificationsRequest request)
Turns on notifications on a backup vault for the specified topic and events.
putBackupVaultNotifications
in interface AWSBackup
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.public StartBackupJobResult startBackupJob(StartBackupJobRequest request)
Starts a job to create a one-time backup of the specified resource.
startBackupJob
in interface AWSBackup
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.public StartCopyJobResult startCopyJob(StartCopyJobRequest request)
Starts a job to create a one-time copy of the specified resource.
startCopyJob
in interface AWSBackup
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.public StartRestoreJobResult startRestoreJob(StartRestoreJobRequest request)
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.
startRestoreJob
in interface AWSBackup
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.public StopBackupJobResult stopBackupJob(StopBackupJobRequest request)
Attempts to cancel a job to create a one-time backup of a resource.
stopBackupJob
in interface AWSBackup
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.public TagResourceResult tagResource(TagResourceRequest request)
Assigns a set of key-value pairs to a recovery point, backup plan, or backup vault identified by an Amazon Resource Name (ARN).
tagResource
in interface AWSBackup
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.public UntagResourceResult untagResource(UntagResourceRequest request)
Removes a set of key-value pairs from a recovery point, backup plan, or backup vault identified by an Amazon Resource Name (ARN)
untagResource
in interface AWSBackup
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.public UpdateBackupPlanResult updateBackupPlan(UpdateBackupPlanRequest request)
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
.
updateBackupPlan
in interface AWSBackup
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.public UpdateRecoveryPointLifecycleResult updateRecoveryPointLifecycle(UpdateRecoveryPointLifecycleRequest request)
Sets the transition lifecycle of a recovery point.
The lifecycle defines when a protected resource is transitioned to cold storage and when it expires. 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.
updateRecoveryPointLifecycle
in interface AWSBackup
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.public UpdateRegionSettingsResult updateRegionSettings(UpdateRegionSettingsRequest request)
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.
updateRegionSettings
in interface AWSBackup
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.public 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 the request.
getCachedResponseMetadata
in interface AWSBackup
request
- The originally executed request