@ThreadSafe @Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class AWSBackupClient extends AmazonWebServiceClient implements AWSBackup
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.
LOGGING_AWS_REQUEST_METRIC
ENDPOINT_PREFIX
Modifier and Type | Method and Description |
---|---|
static AWSBackupClientBuilder |
builder() |
CancelLegalHoldResult |
cancelLegalHold(CancelLegalHoldRequest request)
This action removes the specified legal hold on a recovery point.
|
CreateBackupPlanResult |
createBackupPlan(CreateBackupPlanRequest request)
Creates a backup plan using a backup plan name and backup rules.
|
CreateBackupSelectionResult |
createBackupSelection(CreateBackupSelectionRequest request)
Creates a JSON document that specifies a set of resources to assign to a backup plan.
|
CreateBackupVaultResult |
createBackupVault(CreateBackupVaultRequest request)
Creates a logical container where backups are stored.
|
CreateFrameworkResult |
createFramework(CreateFrameworkRequest request)
Creates a framework with one or more controls.
|
CreateLegalHoldResult |
createLegalHold(CreateLegalHoldRequest request)
This action creates a legal hold on a recovery point (backup).
|
CreateLogicallyAirGappedBackupVaultResult |
createLogicallyAirGappedBackupVault(CreateLogicallyAirGappedBackupVaultRequest request)
This request creates a logical container to where backups may be copied.
|
CreateReportPlanResult |
createReportPlan(CreateReportPlanRequest request)
Creates a report plan.
|
CreateRestoreTestingPlanResult |
createRestoreTestingPlan(CreateRestoreTestingPlanRequest request)
This is the first of two steps to create a restore testing plan; once this request is successful, finish the
procedure with request CreateRestoreTestingSelection.
|
CreateRestoreTestingSelectionResult |
createRestoreTestingSelection(CreateRestoreTestingSelectionRequest request)
This request can be sent after CreateRestoreTestingPlan request returns successfully.
|
DeleteBackupPlanResult |
deleteBackupPlan(DeleteBackupPlanRequest request)
Deletes a backup plan.
|
DeleteBackupSelectionResult |
deleteBackupSelection(DeleteBackupSelectionRequest request)
Deletes the resource selection associated with a backup plan that is specified by the
SelectionId . |
DeleteBackupVaultResult |
deleteBackupVault(DeleteBackupVaultRequest request)
Deletes the backup vault identified by its name.
|
DeleteBackupVaultAccessPolicyResult |
deleteBackupVaultAccessPolicy(DeleteBackupVaultAccessPolicyRequest request)
Deletes the policy document that manages permissions on a backup vault.
|
DeleteBackupVaultLockConfigurationResult |
deleteBackupVaultLockConfiguration(DeleteBackupVaultLockConfigurationRequest request)
Deletes Backup Vault Lock from a backup vault specified by a backup vault name.
|
DeleteBackupVaultNotificationsResult |
deleteBackupVaultNotifications(DeleteBackupVaultNotificationsRequest request)
Deletes event notifications for the specified backup vault.
|
DeleteFrameworkResult |
deleteFramework(DeleteFrameworkRequest request)
Deletes the framework specified by a framework name.
|
DeleteRecoveryPointResult |
deleteRecoveryPoint(DeleteRecoveryPointRequest request)
Deletes the recovery point specified by a recovery point ID.
|
DeleteReportPlanResult |
deleteReportPlan(DeleteReportPlanRequest request)
Deletes the report plan specified by a report plan name.
|
DeleteRestoreTestingPlanResult |
deleteRestoreTestingPlan(DeleteRestoreTestingPlanRequest request)
This request deletes the specified restore testing plan.
|
DeleteRestoreTestingSelectionResult |
deleteRestoreTestingSelection(DeleteRestoreTestingSelectionRequest request)
Input the Restore Testing Plan name and Restore Testing Selection name.
|
DescribeBackupJobResult |
describeBackupJob(DescribeBackupJobRequest request)
Returns backup job details for the specified
BackupJobId . |
DescribeBackupVaultResult |
describeBackupVault(DescribeBackupVaultRequest request)
Returns metadata about a backup vault specified by its name.
|
DescribeCopyJobResult |
describeCopyJob(DescribeCopyJobRequest request)
Returns metadata associated with creating a copy of a resource.
|
DescribeFrameworkResult |
describeFramework(DescribeFrameworkRequest request)
Returns the framework details for the specified
FrameworkName . |
DescribeGlobalSettingsResult |
describeGlobalSettings(DescribeGlobalSettingsRequest request)
Describes whether the Amazon Web Services account is opted in to cross-account backup.
|
DescribeProtectedResourceResult |
describeProtectedResource(DescribeProtectedResourceRequest request)
Returns information about a saved resource, including the last time it was backed up, its Amazon Resource Name
(ARN), and the Amazon Web Services service type of the saved resource.
|
DescribeRecoveryPointResult |
describeRecoveryPoint(DescribeRecoveryPointRequest request)
Returns metadata associated with a recovery point, including ID, status, encryption, and lifecycle.
|
DescribeRegionSettingsResult |
describeRegionSettings(DescribeRegionSettingsRequest request)
Returns the current service opt-in settings for the Region.
|
DescribeReportJobResult |
describeReportJob(DescribeReportJobRequest request)
Returns the details associated with creating a report as specified by its
ReportJobId . |
DescribeReportPlanResult |
describeReportPlan(DescribeReportPlanRequest request)
Returns a list of all report plans for an Amazon Web Services account and Amazon Web Services Region.
|
DescribeRestoreJobResult |
describeRestoreJob(DescribeRestoreJobRequest request)
Returns metadata associated with a restore job that is specified by a job ID.
|
DisassociateRecoveryPointResult |
disassociateRecoveryPoint(DisassociateRecoveryPointRequest request)
Deletes the specified continuous backup recovery point from Backup and releases control of that continuous backup
to the source service, such as Amazon RDS.
|
DisassociateRecoveryPointFromParentResult |
disassociateRecoveryPointFromParent(DisassociateRecoveryPointFromParentRequest request)
This action to a specific child (nested) recovery point removes the relationship between the specified recovery
point and its parent (composite) recovery point.
|
ExportBackupPlanTemplateResult |
exportBackupPlanTemplate(ExportBackupPlanTemplateRequest request)
Returns the backup plan that is specified by the plan ID as a backup template.
|
GetBackupPlanResult |
getBackupPlan(GetBackupPlanRequest request)
Returns
BackupPlan details for the specified BackupPlanId . |
GetBackupPlanFromJSONResult |
getBackupPlanFromJSON(GetBackupPlanFromJSONRequest request)
Returns a valid JSON document specifying a backup plan or an error.
|
GetBackupPlanFromTemplateResult |
getBackupPlanFromTemplate(GetBackupPlanFromTemplateRequest request)
Returns the template specified by its
templateId as a backup plan. |
GetBackupSelectionResult |
getBackupSelection(GetBackupSelectionRequest request)
Returns selection metadata and a document in JSON format that specifies a list of resources that are associated
with a backup plan.
|
GetBackupVaultAccessPolicyResult |
getBackupVaultAccessPolicy(GetBackupVaultAccessPolicyRequest request)
Returns the access policy document that is associated with the named backup vault.
|
GetBackupVaultNotificationsResult |
getBackupVaultNotifications(GetBackupVaultNotificationsRequest request)
Returns event notifications for the specified backup vault.
|
ResponseMetadata |
getCachedResponseMetadata(AmazonWebServiceRequest request)
Returns additional metadata for a previously executed successful, request, typically used for debugging issues
where a service isn't acting as expected.
|
GetLegalHoldResult |
getLegalHold(GetLegalHoldRequest request)
This action returns details for a specified legal hold.
|
GetRecoveryPointRestoreMetadataResult |
getRecoveryPointRestoreMetadata(GetRecoveryPointRestoreMetadataRequest request)
Returns a set of metadata key-value pairs that were used to create the backup.
|
GetRestoreJobMetadataResult |
getRestoreJobMetadata(GetRestoreJobMetadataRequest request)
This request returns the metadata for the specified restore job.
|
GetRestoreTestingInferredMetadataResult |
getRestoreTestingInferredMetadata(GetRestoreTestingInferredMetadataRequest request)
This request returns the minimal required set of metadata needed to start a restore job with secure default
settings.
|
GetRestoreTestingPlanResult |
getRestoreTestingPlan(GetRestoreTestingPlanRequest request)
Returns
RestoreTestingPlan details for the specified RestoreTestingPlanName . |
GetRestoreTestingSelectionResult |
getRestoreTestingSelection(GetRestoreTestingSelectionRequest request)
Returns RestoreTestingSelection, which displays resources and elements of the restore testing plan.
|
GetSupportedResourceTypesResult |
getSupportedResourceTypes(GetSupportedResourceTypesRequest request)
Returns the Amazon Web Services resource types supported by Backup.
|
ListBackupJobsResult |
listBackupJobs(ListBackupJobsRequest request)
Returns a list of existing backup jobs for an authenticated account for the last 30 days.
|
ListBackupJobSummariesResult |
listBackupJobSummaries(ListBackupJobSummariesRequest request)
This is a request for a summary of backup jobs created or running within the most recent 30 days.
|
ListBackupPlansResult |
listBackupPlans(ListBackupPlansRequest request)
Returns a list of all active backup plans for an authenticated account.
|
ListBackupPlanTemplatesResult |
listBackupPlanTemplates(ListBackupPlanTemplatesRequest request)
Returns metadata of your saved backup plan templates, including the template ID, name, and the creation and
deletion dates.
|
ListBackupPlanVersionsResult |
listBackupPlanVersions(ListBackupPlanVersionsRequest request)
Returns version metadata of your backup plans, including Amazon Resource Names (ARNs), backup plan IDs, creation
and deletion dates, plan names, and version IDs.
|
ListBackupSelectionsResult |
listBackupSelections(ListBackupSelectionsRequest request)
Returns an array containing metadata of the resources associated with the target backup plan.
|
ListBackupVaultsResult |
listBackupVaults(ListBackupVaultsRequest request)
Returns a list of recovery point storage containers along with information about them.
|
ListCopyJobsResult |
listCopyJobs(ListCopyJobsRequest request)
Returns metadata about your copy jobs.
|
ListCopyJobSummariesResult |
listCopyJobSummaries(ListCopyJobSummariesRequest request)
This request obtains a list of copy jobs created or running within the the most recent 30 days.
|
ListFrameworksResult |
listFrameworks(ListFrameworksRequest request)
Returns a list of all frameworks for an Amazon Web Services account and Amazon Web Services Region.
|
ListLegalHoldsResult |
listLegalHolds(ListLegalHoldsRequest request)
This action returns metadata about active and previous legal holds.
|
ListProtectedResourcesResult |
listProtectedResources(ListProtectedResourcesRequest request)
Returns an array of resources successfully backed up by Backup, including the time the resource was saved, an
Amazon Resource Name (ARN) of the resource, and a resource type.
|
ListProtectedResourcesByBackupVaultResult |
listProtectedResourcesByBackupVault(ListProtectedResourcesByBackupVaultRequest request)
This request lists the protected resources corresponding to each backup vault.
|
ListRecoveryPointsByBackupVaultResult |
listRecoveryPointsByBackupVault(ListRecoveryPointsByBackupVaultRequest request)
Returns detailed information about the recovery points stored in a backup vault.
|
ListRecoveryPointsByLegalHoldResult |
listRecoveryPointsByLegalHold(ListRecoveryPointsByLegalHoldRequest request)
This action returns recovery point ARNs (Amazon Resource Names) of the specified legal hold.
|
ListRecoveryPointsByResourceResult |
listRecoveryPointsByResource(ListRecoveryPointsByResourceRequest request)
Returns detailed information about all the recovery points of the type specified by a resource Amazon Resource
Name (ARN).
|
ListReportJobsResult |
listReportJobs(ListReportJobsRequest request)
Returns details about your report jobs.
|
ListReportPlansResult |
listReportPlans(ListReportPlansRequest request)
Returns a list of your report plans.
|
ListRestoreJobsResult |
listRestoreJobs(ListRestoreJobsRequest request)
Returns a list of jobs that Backup initiated to restore a saved resource, including details about the recovery
process.
|
ListRestoreJobsByProtectedResourceResult |
listRestoreJobsByProtectedResource(ListRestoreJobsByProtectedResourceRequest request)
This returns restore jobs that contain the specified protected resource.
|
ListRestoreJobSummariesResult |
listRestoreJobSummaries(ListRestoreJobSummariesRequest request)
This request obtains a summary of restore jobs created or running within the the most recent 30 days.
|
ListRestoreTestingPlansResult |
listRestoreTestingPlans(ListRestoreTestingPlansRequest request)
Returns a list of restore testing plans.
|
ListRestoreTestingSelectionsResult |
listRestoreTestingSelections(ListRestoreTestingSelectionsRequest request)
Returns a list of restore testing selections.
|
ListTagsResult |
listTags(ListTagsRequest request)
Returns a list of key-value pairs assigned to a target recovery point, backup plan, or backup vault.
|
PutBackupVaultAccessPolicyResult |
putBackupVaultAccessPolicy(PutBackupVaultAccessPolicyRequest request)
Sets a resource-based policy that is used to manage access permissions on the target backup vault.
|
PutBackupVaultLockConfigurationResult |
putBackupVaultLockConfiguration(PutBackupVaultLockConfigurationRequest request)
Applies Backup Vault Lock to a backup vault, preventing attempts to delete any recovery point stored in or
created in a backup vault.
|
PutBackupVaultNotificationsResult |
putBackupVaultNotifications(PutBackupVaultNotificationsRequest request)
Turns on notifications on a backup vault for the specified topic and events.
|
PutRestoreValidationResultResult |
putRestoreValidationResult(PutRestoreValidationResultRequest request)
This request allows you to send your independent self-run restore test validation results.
|
void |
shutdown()
Shuts down this client object, releasing any resources that might be held
open.
|
StartBackupJobResult |
startBackupJob(StartBackupJobRequest request)
Starts an on-demand backup job for the specified resource.
|
StartCopyJobResult |
startCopyJob(StartCopyJobRequest request)
Starts a job to create a one-time copy of the specified resource.
|
StartReportJobResult |
startReportJob(StartReportJobRequest request)
Starts an on-demand report job for the specified report plan.
|
StartRestoreJobResult |
startRestoreJob(StartRestoreJobRequest request)
Recovers the saved resource identified by an Amazon Resource Name (ARN).
|
StopBackupJobResult |
stopBackupJob(StopBackupJobRequest request)
Attempts to cancel a job to create a one-time backup of a resource.
|
TagResourceResult |
tagResource(TagResourceRequest request)
Assigns a set of key-value pairs to a recovery point, backup plan, or backup vault identified by an Amazon
Resource Name (ARN).
|
UntagResourceResult |
untagResource(UntagResourceRequest request)
Removes a set of key-value pairs from a recovery point, backup plan, or backup vault identified by an Amazon
Resource Name (ARN)
|
UpdateBackupPlanResult |
updateBackupPlan(UpdateBackupPlanRequest request)
Updates an existing backup plan identified by its
backupPlanId with the input document in JSON
format. |
UpdateFrameworkResult |
updateFramework(UpdateFrameworkRequest request)
Updates an existing framework identified by its
FrameworkName with the input document in JSON
format. |
UpdateGlobalSettingsResult |
updateGlobalSettings(UpdateGlobalSettingsRequest request)
Updates whether the Amazon Web Services account is opted in to cross-account backup.
|
UpdateRecoveryPointLifecycleResult |
updateRecoveryPointLifecycle(UpdateRecoveryPointLifecycleRequest request)
Sets the transition lifecycle of a recovery point.
|
UpdateRegionSettingsResult |
updateRegionSettings(UpdateRegionSettingsRequest request)
Updates the current service opt-in settings for the Region.
|
UpdateReportPlanResult |
updateReportPlan(UpdateReportPlanRequest request)
Updates an existing report plan identified by its
ReportPlanName with the input document in JSON
format. |
UpdateRestoreTestingPlanResult |
updateRestoreTestingPlan(UpdateRestoreTestingPlanRequest request)
This request will send changes to your specified restore testing plan.
|
UpdateRestoreTestingSelectionResult |
updateRestoreTestingSelection(UpdateRestoreTestingSelectionRequest request)
Most elements except the
RestoreTestingSelectionName can be updated with this request. |
addRequestHandler, addRequestHandler, configureRegion, getClientConfiguration, getEndpointPrefix, getMonitoringListeners, getRequestMetricsCollector, getServiceName, getSignerByURI, getSignerOverride, getSignerRegionOverride, getTimeOffset, makeImmutable, removeRequestHandler, removeRequestHandler, setEndpoint, setEndpoint, setRegion, setServiceNameIntern, setSignerRegionOverride, setTimeOffset, withEndpoint, withRegion, withRegion, withTimeOffset
public static AWSBackupClientBuilder builder()
public CancelLegalHoldResult cancelLegalHold(CancelLegalHoldRequest request)
This action removes the specified legal hold on a recovery point. This action can only be performed by a user with sufficient permissions.
cancelLegalHold
in interface AWSBackup
cancelLegalHoldRequest
- InvalidParameterValueException
- Indicates that something is wrong with a parameter's value. For example, the value is out of range.InvalidResourceStateException
- Backup is already performing an action on this recovery point. It can't perform the action you requested
until the first action finishes. Try again later.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 CreateBackupPlanResult createBackupPlan(CreateBackupPlanRequest request)
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.
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. For examples, see Assigning resources programmatically.
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.
Do not include sensitive data, such as passport numbers, in 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 CreateFrameworkResult createFramework(CreateFrameworkRequest request)
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.
createFramework
in interface AWSBackup
createFrameworkRequest
- AlreadyExistsException
- The required resource already exists.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.public CreateLegalHoldResult createLegalHold(CreateLegalHoldRequest request)
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.
createLegalHold
in interface AWSBackup
createLegalHoldRequest
- 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 CreateLogicallyAirGappedBackupVaultResult createLogicallyAirGappedBackupVault(CreateLogicallyAirGappedBackupVaultRequest request)
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.
createLogicallyAirGappedBackupVault
in interface AWSBackup
createLogicallyAirGappedBackupVaultRequest
- 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.LimitExceededException
- A limit in the request has been exceeded; for example, a maximum number of items allowed in a request.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 CreateReportPlanResult createReportPlan(CreateReportPlanRequest request)
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.
createReportPlan
in interface AWSBackup
createReportPlanRequest
- AlreadyExistsException
- The required resource already exists.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.ServiceUnavailableException
- The request failed due to a temporary failure of the server.MissingParameterValueException
- Indicates that a required parameter is missing.public CreateRestoreTestingPlanResult createRestoreTestingPlan(CreateRestoreTestingPlanRequest request)
This is the first of two steps to create a restore testing plan; once this request is successful, finish the procedure with request CreateRestoreTestingSelection.
You must include the parameter RestoreTestingPlan. You may optionally include CreatorRequestId and Tags.
createRestoreTestingPlan
in interface AWSBackup
createRestoreTestingPlanRequest
- AlreadyExistsException
- The required resource already exists.ConflictException
- Backup can't perform the action that you requested until it finishes performing a previous action. Try
again later.InvalidParameterValueException
- Indicates that something is wrong with a parameter's value. For example, the value is out of range.LimitExceededException
- A limit in the request has been exceeded; for example, a maximum number of items allowed in a request.MissingParameterValueException
- Indicates that a required parameter is missing.ServiceUnavailableException
- The request failed due to a temporary failure of the server.public CreateRestoreTestingSelectionResult createRestoreTestingSelection(CreateRestoreTestingSelectionRequest request)
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.
createRestoreTestingSelection
in interface AWSBackup
createRestoreTestingSelectionRequest
- 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.LimitExceededException
- A limit in the request has been exceeded; for example, a maximum number of items allowed in a request.MissingParameterValueException
- Indicates that a required parameter is missing.ResourceNotFoundException
- A resource that is required for the action doesn't exist.ServiceUnavailableException
- The request failed due to a temporary failure of the server.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 DeleteBackupVaultLockConfigurationResult deleteBackupVaultLockConfiguration(DeleteBackupVaultLockConfigurationRequest request)
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.
deleteBackupVaultLockConfiguration
in interface AWSBackup
deleteBackupVaultLockConfigurationRequest
- 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.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 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 DeleteFrameworkResult deleteFramework(DeleteFrameworkRequest request)
Deletes the framework specified by a framework name.
deleteFramework
in interface AWSBackup
deleteFrameworkRequest
- 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.ConflictException
- Backup can't perform the action that you requested until it finishes performing a previous action. Try
again later.ResourceNotFoundException
- A resource that is required for the action doesn't exist.public DeleteRecoveryPointResult deleteRecoveryPoint(DeleteRecoveryPointRequest request)
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.
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.InvalidResourceStateException
- Backup is already performing an action on this recovery point. It can't perform the action you requested
until the first action finishes. Try again later.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 DeleteReportPlanResult deleteReportPlan(DeleteReportPlanRequest request)
Deletes the report plan specified by a report plan name.
deleteReportPlan
in interface AWSBackup
deleteReportPlanRequest
- 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.ConflictException
- Backup can't perform the action that you requested until it finishes performing a previous action. Try
again later.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 DeleteRestoreTestingPlanResult deleteRestoreTestingPlan(DeleteRestoreTestingPlanRequest request)
This request deletes the specified restore testing plan.
Deletion can only successfully occur if all associated restore testing selections are deleted first.
deleteRestoreTestingPlan
in interface AWSBackup
deleteRestoreTestingPlanRequest
- 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 DeleteRestoreTestingSelectionResult deleteRestoreTestingSelection(DeleteRestoreTestingSelectionRequest request)
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.
deleteRestoreTestingSelection
in interface AWSBackup
deleteRestoreTestingSelectionRequest
- ResourceNotFoundException
- A resource that is required for the action doesn't exist.ServiceUnavailableException
- The request failed due to a temporary failure of the server.public DescribeBackupJobResult describeBackupJob(DescribeBackupJobRequest request)
Returns backup job details for the specified BackupJobId
.
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 Amazon Web Services service or resource returned an error to the 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 DescribeFrameworkResult describeFramework(DescribeFrameworkRequest request)
Returns the framework details for the specified FrameworkName
.
describeFramework
in interface AWSBackup
describeFrameworkRequest
- 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 DescribeGlobalSettingsResult describeGlobalSettings(DescribeGlobalSettingsRequest request)
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
describeGlobalSettings
in interface AWSBackup
describeGlobalSettingsRequest
- 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 DescribeProtectedResourceResult describeProtectedResource(DescribeProtectedResourceRequest request)
Returns information about a saved resource, including the last time it was backed up, its Amazon Resource Name (ARN), and the Amazon Web Services service type of the saved resource.
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 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.
describeRegionSettings
in interface AWSBackup
describeRegionSettingsRequest
- ServiceUnavailableException
- The request failed due to a temporary failure of the server.public DescribeReportJobResult describeReportJob(DescribeReportJobRequest request)
Returns the details associated with creating a report as specified by its ReportJobId
.
describeReportJob
in interface AWSBackup
describeReportJobRequest
- ServiceUnavailableException
- The request failed due to a temporary failure of the server.MissingParameterValueException
- Indicates that a required parameter is missing.ResourceNotFoundException
- A resource that is required for the action doesn't exist.public DescribeReportPlanResult describeReportPlan(DescribeReportPlanRequest request)
Returns a list of all report plans for an Amazon Web Services account and Amazon Web Services Region.
describeReportPlan
in interface AWSBackup
describeReportPlanRequest
- 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.ResourceNotFoundException
- A resource that is required for the action doesn't exist.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 Amazon Web Services service or resource returned an error to the Backup service, and the
action cannot be completed.public DisassociateRecoveryPointResult disassociateRecoveryPoint(DisassociateRecoveryPointRequest request)
Deletes the specified continuous backup recovery point from Backup and releases control of that continuous backup to the source service, such as Amazon RDS. 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.
disassociateRecoveryPoint
in interface AWSBackup
disassociateRecoveryPointRequest
- 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.InvalidResourceStateException
- Backup is already performing an action on this recovery point. It can't perform the action you requested
until the first action finishes. Try again later.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 DisassociateRecoveryPointFromParentResult disassociateRecoveryPointFromParent(DisassociateRecoveryPointFromParentRequest request)
This action to a specific child (nested) recovery point removes the relationship between the specified recovery point and its parent (composite) recovery point.
disassociateRecoveryPointFromParent
in interface AWSBackup
disassociateRecoveryPointFromParentRequest
- 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 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 BackupPlan
details for the specified BackupPlanId
. The details are 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 GetLegalHoldResult getLegalHold(GetLegalHoldRequest request)
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.
getLegalHold
in interface AWSBackup
getLegalHoldRequest
- 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 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 GetRestoreJobMetadataResult getRestoreJobMetadata(GetRestoreJobMetadataRequest request)
This request returns the metadata for the specified restore job.
getRestoreJobMetadata
in interface AWSBackup
getRestoreJobMetadataRequest
- 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 GetRestoreTestingInferredMetadataResult getRestoreTestingInferredMetadata(GetRestoreTestingInferredMetadataRequest request)
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.
getRestoreTestingInferredMetadata
in interface AWSBackup
getRestoreTestingInferredMetadataRequest
- 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.ResourceNotFoundException
- A resource that is required for the action doesn't exist.ServiceUnavailableException
- The request failed due to a temporary failure of the server.public GetRestoreTestingPlanResult getRestoreTestingPlan(GetRestoreTestingPlanRequest request)
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.
getRestoreTestingPlan
in interface AWSBackup
getRestoreTestingPlanRequest
- ResourceNotFoundException
- A resource that is required for the action doesn't exist.ServiceUnavailableException
- The request failed due to a temporary failure of the server.public GetRestoreTestingSelectionResult getRestoreTestingSelection(GetRestoreTestingSelectionRequest request)
Returns RestoreTestingSelection, which displays resources and elements of the restore testing plan.
getRestoreTestingSelection
in interface AWSBackup
getRestoreTestingSelectionRequest
- ResourceNotFoundException
- A resource that is required for the action doesn't exist.ServiceUnavailableException
- The request failed due to a temporary failure of the server.public GetSupportedResourceTypesResult getSupportedResourceTypes(GetSupportedResourceTypesRequest request)
Returns the Amazon Web Services resource types supported by Backup.
getSupportedResourceTypes
in interface AWSBackup
getSupportedResourceTypesRequest
- ServiceUnavailableException
- The request failed due to a temporary failure of the server.public ListBackupJobSummariesResult listBackupJobSummaries(ListBackupJobSummariesRequest request)
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.
listBackupJobSummaries
in interface AWSBackup
listBackupJobSummariesRequest
- 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 ListBackupJobsResult listBackupJobs(ListBackupJobsRequest request)
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.
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 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.
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 ListCopyJobSummariesResult listCopyJobSummaries(ListCopyJobSummariesRequest request)
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.
listCopyJobSummaries
in interface AWSBackup
listCopyJobSummariesRequest
- 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 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 ListFrameworksResult listFrameworks(ListFrameworksRequest request)
Returns a list of all frameworks for an Amazon Web Services account and Amazon Web Services Region.
listFrameworks
in interface AWSBackup
listFrameworksRequest
- 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 ListLegalHoldsResult listLegalHolds(ListLegalHoldsRequest request)
This action returns metadata about active and previous legal holds.
listLegalHolds
in interface AWSBackup
listLegalHoldsRequest
- 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 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 ListProtectedResourcesByBackupVaultResult listProtectedResourcesByBackupVault(ListProtectedResourcesByBackupVaultRequest request)
This request lists the protected resources corresponding to each backup vault.
listProtectedResourcesByBackupVault
in interface AWSBackup
listProtectedResourcesByBackupVaultRequest
- InvalidParameterValueException
- Indicates that something is wrong with a parameter's value. For example, the value is out of range.ResourceNotFoundException
- A resource that is required for the action doesn't exist.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 ListRecoveryPointsByLegalHoldResult listRecoveryPointsByLegalHold(ListRecoveryPointsByLegalHoldRequest request)
This action returns recovery point ARNs (Amazon Resource Names) of the specified legal hold.
listRecoveryPointsByLegalHold
in interface AWSBackup
listRecoveryPointsByLegalHoldRequest
- 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 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.
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 ListReportJobsResult listReportJobs(ListReportJobsRequest request)
Returns details about your report jobs.
listReportJobs
in interface AWSBackup
listReportJobsRequest
- 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 ListReportPlansResult listReportPlans(ListReportPlansRequest request)
Returns a list of your report plans. For detailed information about a single report plan, use
DescribeReportPlan
.
listReportPlans
in interface AWSBackup
listReportPlansRequest
- 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 ListRestoreJobSummariesResult listRestoreJobSummaries(ListRestoreJobSummariesRequest request)
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.
listRestoreJobSummaries
in interface AWSBackup
listRestoreJobSummariesRequest
- 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 ListRestoreJobsResult listRestoreJobs(ListRestoreJobsRequest request)
Returns a list of jobs that Backup initiated to restore a saved resource, including details 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 ListRestoreJobsByProtectedResourceResult listRestoreJobsByProtectedResource(ListRestoreJobsByProtectedResourceRequest request)
This returns restore jobs that contain the specified protected resource.
You must include ResourceArn
. You can optionally include NextToken
,
ByStatus
, MaxResults
, ByRecoveryPointCreationDateAfter
, and
ByRecoveryPointCreationDateBefore
.
listRestoreJobsByProtectedResource
in interface AWSBackup
listRestoreJobsByProtectedResourceRequest
- 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 ListRestoreTestingPlansResult listRestoreTestingPlans(ListRestoreTestingPlansRequest request)
Returns a list of restore testing plans.
listRestoreTestingPlans
in interface AWSBackup
listRestoreTestingPlansRequest
- 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 ListRestoreTestingSelectionsResult listRestoreTestingSelections(ListRestoreTestingSelectionsRequest request)
Returns a list of restore testing selections. Can be filtered by MaxResults
and
RestoreTestingPlanName
.
listRestoreTestingSelections
in interface AWSBackup
listRestoreTestingSelectionsRequest
- InvalidParameterValueException
- Indicates that something is wrong with a parameter's value. For example, the value is out of range.ResourceNotFoundException
- A resource that is required for the action doesn't exist.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
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.
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 PutBackupVaultLockConfigurationResult putBackupVaultLockConfiguration(PutBackupVaultLockConfigurationRequest request)
Applies Backup Vault Lock to a backup vault, preventing attempts to delete any recovery point stored in or created in a backup vault. 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.
putBackupVaultLockConfiguration
in interface AWSBackup
putBackupVaultLockConfigurationRequest
- 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.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 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 PutRestoreValidationResultResult putRestoreValidationResult(PutRestoreValidationResultRequest request)
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
.
putRestoreValidationResult
in interface AWSBackup
putRestoreValidationResultRequest
- 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.MissingParameterValueException
- Indicates that a required parameter is missing.ResourceNotFoundException
- A resource that is required for the action doesn't exist.ServiceUnavailableException
- The request failed due to a temporary failure of the server.public StartBackupJobResult startBackupJob(StartBackupJobRequest request)
Starts an on-demand backup job for 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.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.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.
Does not support continuous backups.
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.InvalidRequestException
- Indicates that something is wrong with the input to the request. For example, a parameter is of the wrong
type.public StartReportJobResult startReportJob(StartReportJobRequest request)
Starts an on-demand report job for the specified report plan.
startReportJob
in interface AWSBackup
startReportJobRequest
- 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.MissingParameterValueException
- Indicates that a required parameter is missing.ResourceNotFoundException
- A resource that is required for the action doesn't exist.public StartRestoreJobResult startRestoreJob(StartRestoreJobRequest request)
Recovers the saved resource identified by an Amazon Resource Name (ARN).
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.InvalidRequestException
- Indicates that something is wrong with the input to the request. For example, a parameter is of the wrong
type.public StopBackupJobResult stopBackupJob(StopBackupJobRequest request)
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.
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)
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
.
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 UpdateFrameworkResult updateFramework(UpdateFrameworkRequest request)
Updates an existing framework identified by its FrameworkName
with the input document in JSON
format.
updateFramework
in interface AWSBackup
updateFrameworkRequest
- AlreadyExistsException
- The required resource already exists.ResourceNotFoundException
- A resource that is required for the action doesn't exist.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.ConflictException
- Backup can't perform the action that you requested until it finishes performing a previous action. Try
again later.ServiceUnavailableException
- The request failed due to a temporary failure of the server.public UpdateGlobalSettingsResult updateGlobalSettings(UpdateGlobalSettingsRequest request)
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.
updateGlobalSettings
in interface AWSBackup
updateGlobalSettingsRequest
- 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.InvalidRequestException
- Indicates that something is wrong with the input to the request. For example, a parameter is of the wrong
type.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. 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.
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.InvalidRequestException
- Indicates that something is wrong with the input to the request. For example, a parameter is of the wrong
type.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.
Use the DescribeRegionSettings
API to determine the resource types that are supported.
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 UpdateReportPlanResult updateReportPlan(UpdateReportPlanRequest request)
Updates an existing report plan identified by its ReportPlanName
with the input document in JSON
format.
updateReportPlan
in interface AWSBackup
updateReportPlanRequest
- 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.ServiceUnavailableException
- The request failed due to a temporary failure of the server.MissingParameterValueException
- Indicates that a required parameter is missing.ConflictException
- Backup can't perform the action that you requested until it finishes performing a previous action. Try
again later.public UpdateRestoreTestingPlanResult updateRestoreTestingPlan(UpdateRestoreTestingPlanRequest request)
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
updateRestoreTestingPlan
in interface AWSBackup
updateRestoreTestingPlanRequest
- ConflictException
- Backup can't perform the action that you requested until it finishes performing a previous action. Try
again later.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.ResourceNotFoundException
- A resource that is required for the action doesn't exist.ServiceUnavailableException
- The request failed due to a temporary failure of the server.public UpdateRestoreTestingSelectionResult updateRestoreTestingSelection(UpdateRestoreTestingSelectionRequest request)
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.
updateRestoreTestingSelection
in interface AWSBackup
updateRestoreTestingSelectionRequest
- ConflictException
- Backup can't perform the action that you requested until it finishes performing a previous action. Try
again later.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.ResourceNotFoundException
- A resource that is required for the action doesn't exist.ServiceUnavailableException
- The request failed due to a temporary failure of the server.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 requestpublic void shutdown()
AmazonWebServiceClient
shutdown
in interface AWSBackup
shutdown
in class AmazonWebServiceClient