@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public interface AWSBackup
Note: Do not directly implement this interface, new methods are added to it regularly. Extend from
AbstractAWSBackup
instead.
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.
Modifier and Type | Field and Description |
---|---|
static String |
ENDPOINT_PREFIX
The region metadata service name for computing region endpoints.
|
Modifier and Type | Method and Description |
---|---|
CancelLegalHoldResult |
cancelLegalHold(CancelLegalHoldRequest cancelLegalHoldRequest)
This action removes the specified legal hold on a recovery point.
|
CreateBackupPlanResult |
createBackupPlan(CreateBackupPlanRequest createBackupPlanRequest)
Creates a backup plan using a backup plan name and backup rules.
|
CreateBackupSelectionResult |
createBackupSelection(CreateBackupSelectionRequest createBackupSelectionRequest)
Creates a JSON document that specifies a set of resources to assign to a backup plan.
|
CreateBackupVaultResult |
createBackupVault(CreateBackupVaultRequest createBackupVaultRequest)
Creates a logical container where backups are stored.
|
CreateFrameworkResult |
createFramework(CreateFrameworkRequest createFrameworkRequest)
Creates a framework with one or more controls.
|
CreateLegalHoldResult |
createLegalHold(CreateLegalHoldRequest createLegalHoldRequest)
This action creates a legal hold on a recovery point (backup).
|
CreateLogicallyAirGappedBackupVaultResult |
createLogicallyAirGappedBackupVault(CreateLogicallyAirGappedBackupVaultRequest createLogicallyAirGappedBackupVaultRequest)
This request creates a logical container to where backups may be copied.
|
CreateReportPlanResult |
createReportPlan(CreateReportPlanRequest createReportPlanRequest)
Creates a report plan.
|
CreateRestoreTestingPlanResult |
createRestoreTestingPlan(CreateRestoreTestingPlanRequest createRestoreTestingPlanRequest)
This is the first of two steps to create a restore testing plan; once this request is successful, finish the
procedure with request CreateRestoreTestingSelection.
|
CreateRestoreTestingSelectionResult |
createRestoreTestingSelection(CreateRestoreTestingSelectionRequest createRestoreTestingSelectionRequest)
This request can be sent after CreateRestoreTestingPlan request returns successfully.
|
DeleteBackupPlanResult |
deleteBackupPlan(DeleteBackupPlanRequest deleteBackupPlanRequest)
Deletes a backup plan.
|
DeleteBackupSelectionResult |
deleteBackupSelection(DeleteBackupSelectionRequest deleteBackupSelectionRequest)
Deletes the resource selection associated with a backup plan that is specified by the
SelectionId . |
DeleteBackupVaultResult |
deleteBackupVault(DeleteBackupVaultRequest deleteBackupVaultRequest)
Deletes the backup vault identified by its name.
|
DeleteBackupVaultAccessPolicyResult |
deleteBackupVaultAccessPolicy(DeleteBackupVaultAccessPolicyRequest deleteBackupVaultAccessPolicyRequest)
Deletes the policy document that manages permissions on a backup vault.
|
DeleteBackupVaultLockConfigurationResult |
deleteBackupVaultLockConfiguration(DeleteBackupVaultLockConfigurationRequest deleteBackupVaultLockConfigurationRequest)
Deletes Backup Vault Lock from a backup vault specified by a backup vault name.
|
DeleteBackupVaultNotificationsResult |
deleteBackupVaultNotifications(DeleteBackupVaultNotificationsRequest deleteBackupVaultNotificationsRequest)
Deletes event notifications for the specified backup vault.
|
DeleteFrameworkResult |
deleteFramework(DeleteFrameworkRequest deleteFrameworkRequest)
Deletes the framework specified by a framework name.
|
DeleteRecoveryPointResult |
deleteRecoveryPoint(DeleteRecoveryPointRequest deleteRecoveryPointRequest)
Deletes the recovery point specified by a recovery point ID.
|
DeleteReportPlanResult |
deleteReportPlan(DeleteReportPlanRequest deleteReportPlanRequest)
Deletes the report plan specified by a report plan name.
|
DeleteRestoreTestingPlanResult |
deleteRestoreTestingPlan(DeleteRestoreTestingPlanRequest deleteRestoreTestingPlanRequest)
This request deletes the specified restore testing plan.
|
DeleteRestoreTestingSelectionResult |
deleteRestoreTestingSelection(DeleteRestoreTestingSelectionRequest deleteRestoreTestingSelectionRequest)
Input the Restore Testing Plan name and Restore Testing Selection name.
|
DescribeBackupJobResult |
describeBackupJob(DescribeBackupJobRequest describeBackupJobRequest)
Returns backup job details for the specified
BackupJobId . |
DescribeBackupVaultResult |
describeBackupVault(DescribeBackupVaultRequest describeBackupVaultRequest)
Returns metadata about a backup vault specified by its name.
|
DescribeCopyJobResult |
describeCopyJob(DescribeCopyJobRequest describeCopyJobRequest)
Returns metadata associated with creating a copy of a resource.
|
DescribeFrameworkResult |
describeFramework(DescribeFrameworkRequest describeFrameworkRequest)
Returns the framework details for the specified
FrameworkName . |
DescribeGlobalSettingsResult |
describeGlobalSettings(DescribeGlobalSettingsRequest describeGlobalSettingsRequest)
Describes whether the Amazon Web Services account is opted in to cross-account backup.
|
DescribeProtectedResourceResult |
describeProtectedResource(DescribeProtectedResourceRequest describeProtectedResourceRequest)
Returns information about a saved resource, including the last time it was backed up, its Amazon Resource Name
(ARN), and the Amazon Web Services service type of the saved resource.
|
DescribeRecoveryPointResult |
describeRecoveryPoint(DescribeRecoveryPointRequest describeRecoveryPointRequest)
Returns metadata associated with a recovery point, including ID, status, encryption, and lifecycle.
|
DescribeRegionSettingsResult |
describeRegionSettings(DescribeRegionSettingsRequest describeRegionSettingsRequest)
Returns the current service opt-in settings for the Region.
|
DescribeReportJobResult |
describeReportJob(DescribeReportJobRequest describeReportJobRequest)
Returns the details associated with creating a report as specified by its
ReportJobId . |
DescribeReportPlanResult |
describeReportPlan(DescribeReportPlanRequest describeReportPlanRequest)
Returns a list of all report plans for an Amazon Web Services account and Amazon Web Services Region.
|
DescribeRestoreJobResult |
describeRestoreJob(DescribeRestoreJobRequest describeRestoreJobRequest)
Returns metadata associated with a restore job that is specified by a job ID.
|
DisassociateRecoveryPointResult |
disassociateRecoveryPoint(DisassociateRecoveryPointRequest disassociateRecoveryPointRequest)
Deletes the specified continuous backup recovery point from Backup and releases control of that continuous backup
to the source service, such as Amazon RDS.
|
DisassociateRecoveryPointFromParentResult |
disassociateRecoveryPointFromParent(DisassociateRecoveryPointFromParentRequest disassociateRecoveryPointFromParentRequest)
This action to a specific child (nested) recovery point removes the relationship between the specified recovery
point and its parent (composite) recovery point.
|
ExportBackupPlanTemplateResult |
exportBackupPlanTemplate(ExportBackupPlanTemplateRequest exportBackupPlanTemplateRequest)
Returns the backup plan that is specified by the plan ID as a backup template.
|
GetBackupPlanResult |
getBackupPlan(GetBackupPlanRequest getBackupPlanRequest)
Returns
BackupPlan details for the specified BackupPlanId . |
GetBackupPlanFromJSONResult |
getBackupPlanFromJSON(GetBackupPlanFromJSONRequest getBackupPlanFromJSONRequest)
Returns a valid JSON document specifying a backup plan or an error.
|
GetBackupPlanFromTemplateResult |
getBackupPlanFromTemplate(GetBackupPlanFromTemplateRequest getBackupPlanFromTemplateRequest)
Returns the template specified by its
templateId as a backup plan. |
GetBackupSelectionResult |
getBackupSelection(GetBackupSelectionRequest getBackupSelectionRequest)
Returns selection metadata and a document in JSON format that specifies a list of resources that are associated
with a backup plan.
|
GetBackupVaultAccessPolicyResult |
getBackupVaultAccessPolicy(GetBackupVaultAccessPolicyRequest getBackupVaultAccessPolicyRequest)
Returns the access policy document that is associated with the named backup vault.
|
GetBackupVaultNotificationsResult |
getBackupVaultNotifications(GetBackupVaultNotificationsRequest getBackupVaultNotificationsRequest)
Returns event notifications for the specified backup vault.
|
ResponseMetadata |
getCachedResponseMetadata(AmazonWebServiceRequest request)
Returns additional metadata for a previously executed successful request, typically used for debugging issues
where a service isn't acting as expected.
|
GetLegalHoldResult |
getLegalHold(GetLegalHoldRequest getLegalHoldRequest)
This action returns details for a specified legal hold.
|
GetRecoveryPointRestoreMetadataResult |
getRecoveryPointRestoreMetadata(GetRecoveryPointRestoreMetadataRequest getRecoveryPointRestoreMetadataRequest)
Returns a set of metadata key-value pairs that were used to create the backup.
|
GetRestoreJobMetadataResult |
getRestoreJobMetadata(GetRestoreJobMetadataRequest getRestoreJobMetadataRequest)
This request returns the metadata for the specified restore job.
|
GetRestoreTestingInferredMetadataResult |
getRestoreTestingInferredMetadata(GetRestoreTestingInferredMetadataRequest getRestoreTestingInferredMetadataRequest)
This request returns the minimal required set of metadata needed to start a restore job with secure default
settings.
|
GetRestoreTestingPlanResult |
getRestoreTestingPlan(GetRestoreTestingPlanRequest getRestoreTestingPlanRequest)
Returns
RestoreTestingPlan details for the specified RestoreTestingPlanName . |
GetRestoreTestingSelectionResult |
getRestoreTestingSelection(GetRestoreTestingSelectionRequest getRestoreTestingSelectionRequest)
Returns RestoreTestingSelection, which displays resources and elements of the restore testing plan.
|
GetSupportedResourceTypesResult |
getSupportedResourceTypes(GetSupportedResourceTypesRequest getSupportedResourceTypesRequest)
Returns the Amazon Web Services resource types supported by Backup.
|
ListBackupJobsResult |
listBackupJobs(ListBackupJobsRequest listBackupJobsRequest)
Returns a list of existing backup jobs for an authenticated account for the last 30 days.
|
ListBackupJobSummariesResult |
listBackupJobSummaries(ListBackupJobSummariesRequest listBackupJobSummariesRequest)
This is a request for a summary of backup jobs created or running within the most recent 30 days.
|
ListBackupPlansResult |
listBackupPlans(ListBackupPlansRequest listBackupPlansRequest)
Returns a list of all active backup plans for an authenticated account.
|
ListBackupPlanTemplatesResult |
listBackupPlanTemplates(ListBackupPlanTemplatesRequest listBackupPlanTemplatesRequest)
Returns metadata of your saved backup plan templates, including the template ID, name, and the creation and
deletion dates.
|
ListBackupPlanVersionsResult |
listBackupPlanVersions(ListBackupPlanVersionsRequest listBackupPlanVersionsRequest)
Returns version metadata of your backup plans, including Amazon Resource Names (ARNs), backup plan IDs, creation
and deletion dates, plan names, and version IDs.
|
ListBackupSelectionsResult |
listBackupSelections(ListBackupSelectionsRequest listBackupSelectionsRequest)
Returns an array containing metadata of the resources associated with the target backup plan.
|
ListBackupVaultsResult |
listBackupVaults(ListBackupVaultsRequest listBackupVaultsRequest)
Returns a list of recovery point storage containers along with information about them.
|
ListCopyJobsResult |
listCopyJobs(ListCopyJobsRequest listCopyJobsRequest)
Returns metadata about your copy jobs.
|
ListCopyJobSummariesResult |
listCopyJobSummaries(ListCopyJobSummariesRequest listCopyJobSummariesRequest)
This request obtains a list of copy jobs created or running within the the most recent 30 days.
|
ListFrameworksResult |
listFrameworks(ListFrameworksRequest listFrameworksRequest)
Returns a list of all frameworks for an Amazon Web Services account and Amazon Web Services Region.
|
ListLegalHoldsResult |
listLegalHolds(ListLegalHoldsRequest listLegalHoldsRequest)
This action returns metadata about active and previous legal holds.
|
ListProtectedResourcesResult |
listProtectedResources(ListProtectedResourcesRequest listProtectedResourcesRequest)
Returns an array of resources successfully backed up by Backup, including the time the resource was saved, an
Amazon Resource Name (ARN) of the resource, and a resource type.
|
ListProtectedResourcesByBackupVaultResult |
listProtectedResourcesByBackupVault(ListProtectedResourcesByBackupVaultRequest listProtectedResourcesByBackupVaultRequest)
This request lists the protected resources corresponding to each backup vault.
|
ListRecoveryPointsByBackupVaultResult |
listRecoveryPointsByBackupVault(ListRecoveryPointsByBackupVaultRequest listRecoveryPointsByBackupVaultRequest)
Returns detailed information about the recovery points stored in a backup vault.
|
ListRecoveryPointsByLegalHoldResult |
listRecoveryPointsByLegalHold(ListRecoveryPointsByLegalHoldRequest listRecoveryPointsByLegalHoldRequest)
This action returns recovery point ARNs (Amazon Resource Names) of the specified legal hold.
|
ListRecoveryPointsByResourceResult |
listRecoveryPointsByResource(ListRecoveryPointsByResourceRequest listRecoveryPointsByResourceRequest)
Returns detailed information about all the recovery points of the type specified by a resource Amazon Resource
Name (ARN).
|
ListReportJobsResult |
listReportJobs(ListReportJobsRequest listReportJobsRequest)
Returns details about your report jobs.
|
ListReportPlansResult |
listReportPlans(ListReportPlansRequest listReportPlansRequest)
Returns a list of your report plans.
|
ListRestoreJobsResult |
listRestoreJobs(ListRestoreJobsRequest listRestoreJobsRequest)
Returns a list of jobs that Backup initiated to restore a saved resource, including details about the recovery
process.
|
ListRestoreJobsByProtectedResourceResult |
listRestoreJobsByProtectedResource(ListRestoreJobsByProtectedResourceRequest listRestoreJobsByProtectedResourceRequest)
This returns restore jobs that contain the specified protected resource.
|
ListRestoreJobSummariesResult |
listRestoreJobSummaries(ListRestoreJobSummariesRequest listRestoreJobSummariesRequest)
This request obtains a summary of restore jobs created or running within the the most recent 30 days.
|
ListRestoreTestingPlansResult |
listRestoreTestingPlans(ListRestoreTestingPlansRequest listRestoreTestingPlansRequest)
Returns a list of restore testing plans.
|
ListRestoreTestingSelectionsResult |
listRestoreTestingSelections(ListRestoreTestingSelectionsRequest listRestoreTestingSelectionsRequest)
Returns a list of restore testing selections.
|
ListTagsResult |
listTags(ListTagsRequest listTagsRequest)
Returns a list of key-value pairs assigned to a target recovery point, backup plan, or backup vault.
|
PutBackupVaultAccessPolicyResult |
putBackupVaultAccessPolicy(PutBackupVaultAccessPolicyRequest putBackupVaultAccessPolicyRequest)
Sets a resource-based policy that is used to manage access permissions on the target backup vault.
|
PutBackupVaultLockConfigurationResult |
putBackupVaultLockConfiguration(PutBackupVaultLockConfigurationRequest putBackupVaultLockConfigurationRequest)
Applies Backup Vault Lock to a backup vault, preventing attempts to delete any recovery point stored in or
created in a backup vault.
|
PutBackupVaultNotificationsResult |
putBackupVaultNotifications(PutBackupVaultNotificationsRequest putBackupVaultNotificationsRequest)
Turns on notifications on a backup vault for the specified topic and events.
|
PutRestoreValidationResultResult |
putRestoreValidationResult(PutRestoreValidationResultRequest putRestoreValidationResultRequest)
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 startBackupJobRequest)
Starts an on-demand backup job for the specified resource.
|
StartCopyJobResult |
startCopyJob(StartCopyJobRequest startCopyJobRequest)
Starts a job to create a one-time copy of the specified resource.
|
StartReportJobResult |
startReportJob(StartReportJobRequest startReportJobRequest)
Starts an on-demand report job for the specified report plan.
|
StartRestoreJobResult |
startRestoreJob(StartRestoreJobRequest startRestoreJobRequest)
Recovers the saved resource identified by an Amazon Resource Name (ARN).
|
StopBackupJobResult |
stopBackupJob(StopBackupJobRequest stopBackupJobRequest)
Attempts to cancel a job to create a one-time backup of a resource.
|
TagResourceResult |
tagResource(TagResourceRequest tagResourceRequest)
Assigns a set of key-value pairs to a recovery point, backup plan, or backup vault identified by an Amazon
Resource Name (ARN).
|
UntagResourceResult |
untagResource(UntagResourceRequest untagResourceRequest)
Removes a set of key-value pairs from a recovery point, backup plan, or backup vault identified by an Amazon
Resource Name (ARN)
|
UpdateBackupPlanResult |
updateBackupPlan(UpdateBackupPlanRequest updateBackupPlanRequest)
Updates an existing backup plan identified by its
backupPlanId with the input document in JSON
format. |
UpdateFrameworkResult |
updateFramework(UpdateFrameworkRequest updateFrameworkRequest)
Updates an existing framework identified by its
FrameworkName with the input document in JSON
format. |
UpdateGlobalSettingsResult |
updateGlobalSettings(UpdateGlobalSettingsRequest updateGlobalSettingsRequest)
Updates whether the Amazon Web Services account is opted in to cross-account backup.
|
UpdateRecoveryPointLifecycleResult |
updateRecoveryPointLifecycle(UpdateRecoveryPointLifecycleRequest updateRecoveryPointLifecycleRequest)
Sets the transition lifecycle of a recovery point.
|
UpdateRegionSettingsResult |
updateRegionSettings(UpdateRegionSettingsRequest updateRegionSettingsRequest)
Updates the current service opt-in settings for the Region.
|
UpdateReportPlanResult |
updateReportPlan(UpdateReportPlanRequest updateReportPlanRequest)
Updates an existing report plan identified by its
ReportPlanName with the input document in JSON
format. |
UpdateRestoreTestingPlanResult |
updateRestoreTestingPlan(UpdateRestoreTestingPlanRequest updateRestoreTestingPlanRequest)
This request will send changes to your specified restore testing plan.
|
UpdateRestoreTestingSelectionResult |
updateRestoreTestingSelection(UpdateRestoreTestingSelectionRequest updateRestoreTestingSelectionRequest)
Most elements except the
RestoreTestingSelectionName can be updated with this request. |
static final String ENDPOINT_PREFIX
CancelLegalHoldResult cancelLegalHold(CancelLegalHoldRequest cancelLegalHoldRequest)
This action removes the specified legal hold on a recovery point. This action can only be performed by a user with sufficient permissions.
cancelLegalHoldRequest
- 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.CreateBackupPlanResult createBackupPlan(CreateBackupPlanRequest createBackupPlanRequest)
Creates a backup plan using a backup plan name and backup rules. A backup plan is a document that contains information that Backup uses to schedule tasks that create recovery points for resources.
If you call CreateBackupPlan
with a plan that already exists, you receive an
AlreadyExistsException
exception.
createBackupPlanRequest
- LimitExceededException
- A limit in the request has been exceeded; for example, a maximum number of items allowed in a request.AlreadyExistsException
- The required resource already exists.InvalidParameterValueException
- Indicates that something is wrong with a parameter's value. For example, the value is out of range.MissingParameterValueException
- Indicates that a required parameter is missing.ServiceUnavailableException
- The request failed due to a temporary failure of the server.CreateBackupSelectionResult createBackupSelection(CreateBackupSelectionRequest createBackupSelectionRequest)
Creates a JSON document that specifies a set of resources to assign to a backup plan. For examples, see Assigning resources programmatically.
createBackupSelectionRequest
- LimitExceededException
- A limit in the request has been exceeded; for example, a maximum number of items allowed in a request.AlreadyExistsException
- The required resource already exists.InvalidParameterValueException
- Indicates that something is wrong with a parameter's value. For example, the value is out of range.MissingParameterValueException
- Indicates that a required parameter is missing.ServiceUnavailableException
- The request failed due to a temporary failure of the server.CreateBackupVaultResult createBackupVault(CreateBackupVaultRequest createBackupVaultRequest)
Creates a logical container where backups are stored. A CreateBackupVault
request includes a name,
optionally one or more resource tags, an encryption key, and a request ID.
Do not include sensitive data, such as passport numbers, in the name of a backup vault.
createBackupVaultRequest
- InvalidParameterValueException
- Indicates that something is wrong with a parameter's value. For example, the value is out of range.MissingParameterValueException
- Indicates that a required parameter is missing.ServiceUnavailableException
- The request failed due to a temporary failure of the server.LimitExceededException
- A limit in the request has been exceeded; for example, a maximum number of items allowed in a request.AlreadyExistsException
- The required resource already exists.CreateFrameworkResult createFramework(CreateFrameworkRequest createFrameworkRequest)
Creates a framework with one or more controls. A framework is a collection of controls that you can use to evaluate your backup practices. By using pre-built customizable controls to define your policies, you can evaluate whether your backup practices comply with your policies and which resources are not yet in compliance.
createFrameworkRequest
- 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.CreateLegalHoldResult createLegalHold(CreateLegalHoldRequest createLegalHoldRequest)
This action creates a legal hold on a recovery point (backup). A legal hold is a restraint on altering or deleting a backup until an authorized user cancels the legal hold. Any actions to delete or disassociate a recovery point will fail with an error if one or more active legal holds are on the recovery point.
createLegalHoldRequest
- 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.CreateLogicallyAirGappedBackupVaultResult createLogicallyAirGappedBackupVault(CreateLogicallyAirGappedBackupVaultRequest createLogicallyAirGappedBackupVaultRequest)
This request creates a logical container to where backups may be copied.
This request includes a name, the Region, the maximum number of retention days, the minimum number of retention days, and optionally can include tags and a creator request ID.
Do not include sensitive data, such as passport numbers, in the name of a backup vault.
createLogicallyAirGappedBackupVaultRequest
- 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.CreateReportPlanResult createReportPlan(CreateReportPlanRequest createReportPlanRequest)
Creates a report plan. A report plan is a document that contains information about the contents of the report and where Backup will deliver it.
If you call CreateReportPlan
with a plan that already exists, you receive an
AlreadyExistsException
exception.
createReportPlanRequest
- 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.CreateRestoreTestingPlanResult createRestoreTestingPlan(CreateRestoreTestingPlanRequest createRestoreTestingPlanRequest)
This is the first of two steps to create a restore testing plan; once this request is successful, finish the procedure with request CreateRestoreTestingSelection.
You must include the parameter RestoreTestingPlan. You may optionally include CreatorRequestId and Tags.
createRestoreTestingPlanRequest
- 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.CreateRestoreTestingSelectionResult createRestoreTestingSelection(CreateRestoreTestingSelectionRequest createRestoreTestingSelectionRequest)
This request can be sent after CreateRestoreTestingPlan request returns successfully. This is the second part of creating a resource testing plan, and it must be completed sequentially.
This consists of RestoreTestingSelectionName
, ProtectedResourceType
, and one of the
following:
ProtectedResourceArns
ProtectedResourceConditions
Each protected resource type can have one single value.
A restore testing selection can include a wildcard value ("*") for ProtectedResourceArns
along with
ProtectedResourceConditions
. Alternatively, you can include up to 30 specific protected resource
ARNs in ProtectedResourceArns
.
Cannot select by both protected resource types AND specific ARNs. Request will fail if both are included.
createRestoreTestingSelectionRequest
- 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.DeleteBackupPlanResult deleteBackupPlan(DeleteBackupPlanRequest deleteBackupPlanRequest)
Deletes a backup plan. A backup plan can only be deleted after all associated selections of resources have been deleted. Deleting a backup plan deletes the current version of a backup plan. Previous versions, if any, will still exist.
deleteBackupPlanRequest
- ResourceNotFoundException
- A resource that is required for the action doesn't exist.InvalidParameterValueException
- Indicates that something is wrong with a parameter's value. For example, the value is out of range.MissingParameterValueException
- Indicates that a required parameter is missing.ServiceUnavailableException
- The request failed due to a temporary failure of the server.InvalidRequestException
- Indicates that something is wrong with the input to the request. For example, a parameter is of the wrong
type.DeleteBackupSelectionResult deleteBackupSelection(DeleteBackupSelectionRequest deleteBackupSelectionRequest)
Deletes the resource selection associated with a backup plan that is specified by the SelectionId
.
deleteBackupSelectionRequest
- ResourceNotFoundException
- A resource that is required for the action doesn't exist.InvalidParameterValueException
- Indicates that something is wrong with a parameter's value. For example, the value is out of range.MissingParameterValueException
- Indicates that a required parameter is missing.ServiceUnavailableException
- The request failed due to a temporary failure of the server.DeleteBackupVaultResult deleteBackupVault(DeleteBackupVaultRequest deleteBackupVaultRequest)
Deletes the backup vault identified by its name. A vault can be deleted only if it is empty.
deleteBackupVaultRequest
- ResourceNotFoundException
- A resource that is required for the action doesn't exist.InvalidParameterValueException
- Indicates that something is wrong with a parameter's value. For example, the value is out of range.MissingParameterValueException
- Indicates that a required parameter is missing.ServiceUnavailableException
- The request failed due to a temporary failure of the server.InvalidRequestException
- Indicates that something is wrong with the input to the request. For example, a parameter is of the wrong
type.DeleteBackupVaultAccessPolicyResult deleteBackupVaultAccessPolicy(DeleteBackupVaultAccessPolicyRequest deleteBackupVaultAccessPolicyRequest)
Deletes the policy document that manages permissions on a backup vault.
deleteBackupVaultAccessPolicyRequest
- ResourceNotFoundException
- A resource that is required for the action doesn't exist.InvalidParameterValueException
- Indicates that something is wrong with a parameter's value. For example, the value is out of range.MissingParameterValueException
- Indicates that a required parameter is missing.ServiceUnavailableException
- The request failed due to a temporary failure of the server.DeleteBackupVaultLockConfigurationResult deleteBackupVaultLockConfiguration(DeleteBackupVaultLockConfigurationRequest deleteBackupVaultLockConfigurationRequest)
Deletes Backup Vault Lock from a backup vault specified by a backup vault name.
If the Vault Lock configuration is immutable, then you cannot delete Vault Lock using API operations, and you
will receive an InvalidRequestException
if you attempt to do so. For more information, see Vault Lock in the Backup
Developer Guide.
deleteBackupVaultLockConfigurationRequest
- 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.DeleteBackupVaultNotificationsResult deleteBackupVaultNotifications(DeleteBackupVaultNotificationsRequest deleteBackupVaultNotificationsRequest)
Deletes event notifications for the specified backup vault.
deleteBackupVaultNotificationsRequest
- ResourceNotFoundException
- A resource that is required for the action doesn't exist.InvalidParameterValueException
- Indicates that something is wrong with a parameter's value. For example, the value is out of range.MissingParameterValueException
- Indicates that a required parameter is missing.ServiceUnavailableException
- The request failed due to a temporary failure of the server.DeleteFrameworkResult deleteFramework(DeleteFrameworkRequest deleteFrameworkRequest)
Deletes the framework specified by a framework name.
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.DeleteRecoveryPointResult deleteRecoveryPoint(DeleteRecoveryPointRequest deleteRecoveryPointRequest)
Deletes the recovery point specified by a recovery point ID.
If the recovery point ID belongs to a continuous backup, calling this endpoint deletes the existing continuous backup and stops future continuous backup.
When an IAM role's permissions are insufficient to call this API, the service sends back an HTTP 200 response
with an empty HTTP body, but the recovery point is not deleted. Instead, it enters an EXPIRED
state.
EXPIRED
recovery points can be deleted with this API once the IAM role has the
iam:CreateServiceLinkedRole
action. To learn more about adding this role, see
Troubleshooting manual deletions.
If the user or role is deleted or the permission within the role is removed, the deletion will not be successful
and will enter an EXPIRED
state.
deleteRecoveryPointRequest
- 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.DeleteReportPlanResult deleteReportPlan(DeleteReportPlanRequest deleteReportPlanRequest)
Deletes the report plan specified by a report plan name.
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.DeleteRestoreTestingPlanResult deleteRestoreTestingPlan(DeleteRestoreTestingPlanRequest deleteRestoreTestingPlanRequest)
This request deletes the specified restore testing plan.
Deletion can only successfully occur if all associated restore testing selections are deleted first.
deleteRestoreTestingPlanRequest
- 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.DeleteRestoreTestingSelectionResult deleteRestoreTestingSelection(DeleteRestoreTestingSelectionRequest deleteRestoreTestingSelectionRequest)
Input the Restore Testing Plan name and Restore Testing Selection name.
All testing selections associated with a restore testing plan must be deleted before the restore testing plan can be deleted.
deleteRestoreTestingSelectionRequest
- ResourceNotFoundException
- A resource that is required for the action doesn't exist.ServiceUnavailableException
- The request failed due to a temporary failure of the server.DescribeBackupJobResult describeBackupJob(DescribeBackupJobRequest describeBackupJobRequest)
Returns backup job details for the specified BackupJobId
.
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.DescribeBackupVaultResult describeBackupVault(DescribeBackupVaultRequest describeBackupVaultRequest)
Returns metadata about a backup vault specified by its name.
describeBackupVaultRequest
- ResourceNotFoundException
- A resource that is required for the action doesn't exist.InvalidParameterValueException
- Indicates that something is wrong with a parameter's value. For example, the value is out of range.MissingParameterValueException
- Indicates that a required parameter is missing.ServiceUnavailableException
- The request failed due to a temporary failure of the server.DescribeCopyJobResult describeCopyJob(DescribeCopyJobRequest describeCopyJobRequest)
Returns metadata associated with creating a copy of a resource.
describeCopyJobRequest
- ResourceNotFoundException
- A resource that is required for the action doesn't exist.InvalidParameterValueException
- Indicates that something is wrong with a parameter's value. For example, the value is out of range.MissingParameterValueException
- Indicates that a required parameter is missing.ServiceUnavailableException
- The request failed due to a temporary failure of the server.DescribeFrameworkResult describeFramework(DescribeFrameworkRequest describeFrameworkRequest)
Returns the framework details for the specified FrameworkName
.
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.DescribeGlobalSettingsResult describeGlobalSettings(DescribeGlobalSettingsRequest describeGlobalSettingsRequest)
Describes whether the Amazon Web Services account is opted in to cross-account backup. Returns an error if the
account is not a member of an Organizations organization. Example:
describe-global-settings --region us-west-2
describeGlobalSettingsRequest
- 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.DescribeProtectedResourceResult describeProtectedResource(DescribeProtectedResourceRequest describeProtectedResourceRequest)
Returns information about a saved resource, including the last time it was backed up, its Amazon Resource Name (ARN), and the Amazon Web Services service type of the saved resource.
describeProtectedResourceRequest
- MissingParameterValueException
- Indicates that a required parameter is missing.InvalidParameterValueException
- Indicates that something is wrong with a parameter's value. For example, the value is out of range.ServiceUnavailableException
- The request failed due to a temporary failure of the server.ResourceNotFoundException
- A resource that is required for the action doesn't exist.DescribeRecoveryPointResult describeRecoveryPoint(DescribeRecoveryPointRequest describeRecoveryPointRequest)
Returns metadata associated with a recovery point, including ID, status, encryption, and lifecycle.
describeRecoveryPointRequest
- ResourceNotFoundException
- A resource that is required for the action doesn't exist.InvalidParameterValueException
- Indicates that something is wrong with a parameter's value. For example, the value is out of range.MissingParameterValueException
- Indicates that a required parameter is missing.ServiceUnavailableException
- The request failed due to a temporary failure of the server.DescribeRegionSettingsResult describeRegionSettings(DescribeRegionSettingsRequest describeRegionSettingsRequest)
Returns the current service opt-in settings for the Region. If service opt-in is enabled for a service, Backup tries to protect that service's resources in this Region, when the resource is included in an on-demand backup or scheduled backup plan. Otherwise, Backup does not try to protect that service's resources in this Region.
describeRegionSettingsRequest
- ServiceUnavailableException
- The request failed due to a temporary failure of the server.DescribeReportJobResult describeReportJob(DescribeReportJobRequest describeReportJobRequest)
Returns the details associated with creating a report as specified by its ReportJobId
.
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.DescribeReportPlanResult describeReportPlan(DescribeReportPlanRequest describeReportPlanRequest)
Returns a list of all report plans for an Amazon Web Services account and Amazon Web Services Region.
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.DescribeRestoreJobResult describeRestoreJob(DescribeRestoreJobRequest describeRestoreJobRequest)
Returns metadata associated with a restore job that is specified by a job ID.
describeRestoreJobRequest
- ResourceNotFoundException
- A resource that is required for the action doesn't exist.InvalidParameterValueException
- Indicates that something is wrong with a parameter's value. For example, the value is out of range.MissingParameterValueException
- Indicates that a required parameter is missing.ServiceUnavailableException
- The request failed due to a temporary failure of the server.DependencyFailureException
- A dependent Amazon Web Services service or resource returned an error to the Backup service, and the
action cannot be completed.DisassociateRecoveryPointResult disassociateRecoveryPoint(DisassociateRecoveryPointRequest disassociateRecoveryPointRequest)
Deletes the specified continuous backup recovery point from Backup and releases control of that continuous backup to the source service, such as Amazon RDS. The source service will continue to create and retain continuous backups using the lifecycle that you specified in your original backup plan.
Does not support snapshot backup recovery points.
disassociateRecoveryPointRequest
- 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.DisassociateRecoveryPointFromParentResult disassociateRecoveryPointFromParent(DisassociateRecoveryPointFromParentRequest disassociateRecoveryPointFromParentRequest)
This action to a specific child (nested) recovery point removes the relationship between the specified recovery point and its parent (composite) recovery point.
disassociateRecoveryPointFromParentRequest
- 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.ExportBackupPlanTemplateResult exportBackupPlanTemplate(ExportBackupPlanTemplateRequest exportBackupPlanTemplateRequest)
Returns the backup plan that is specified by the plan ID as a backup template.
exportBackupPlanTemplateRequest
- InvalidParameterValueException
- Indicates that something is wrong with a parameter's value. For example, the value is out of range.MissingParameterValueException
- Indicates that a required parameter is missing.ServiceUnavailableException
- The request failed due to a temporary failure of the server.ResourceNotFoundException
- A resource that is required for the action doesn't exist.GetBackupPlanResult getBackupPlan(GetBackupPlanRequest getBackupPlanRequest)
Returns BackupPlan
details for the specified BackupPlanId
. The details are the body of
a backup plan in JSON format, in addition to plan metadata.
getBackupPlanRequest
- ResourceNotFoundException
- A resource that is required for the action doesn't exist.InvalidParameterValueException
- Indicates that something is wrong with a parameter's value. For example, the value is out of range.MissingParameterValueException
- Indicates that a required parameter is missing.ServiceUnavailableException
- The request failed due to a temporary failure of the server.GetBackupPlanFromJSONResult getBackupPlanFromJSON(GetBackupPlanFromJSONRequest getBackupPlanFromJSONRequest)
Returns a valid JSON document specifying a backup plan or an error.
getBackupPlanFromJSONRequest
- LimitExceededException
- A limit in the request has been exceeded; for example, a maximum number of items allowed in a request.InvalidParameterValueException
- Indicates that something is wrong with a parameter's value. For example, the value is out of range.MissingParameterValueException
- Indicates that a required parameter is missing.ServiceUnavailableException
- The request failed due to a temporary failure of the server.InvalidRequestException
- Indicates that something is wrong with the input to the request. For example, a parameter is of the wrong
type.GetBackupPlanFromTemplateResult getBackupPlanFromTemplate(GetBackupPlanFromTemplateRequest getBackupPlanFromTemplateRequest)
Returns the template specified by its templateId
as a backup plan.
getBackupPlanFromTemplateRequest
- InvalidParameterValueException
- Indicates that something is wrong with a parameter's value. For example, the value is out of range.MissingParameterValueException
- Indicates that a required parameter is missing.ServiceUnavailableException
- The request failed due to a temporary failure of the server.ResourceNotFoundException
- A resource that is required for the action doesn't exist.GetBackupSelectionResult getBackupSelection(GetBackupSelectionRequest getBackupSelectionRequest)
Returns selection metadata and a document in JSON format that specifies a list of resources that are associated with a backup plan.
getBackupSelectionRequest
- ResourceNotFoundException
- A resource that is required for the action doesn't exist.InvalidParameterValueException
- Indicates that something is wrong with a parameter's value. For example, the value is out of range.MissingParameterValueException
- Indicates that a required parameter is missing.ServiceUnavailableException
- The request failed due to a temporary failure of the server.GetBackupVaultAccessPolicyResult getBackupVaultAccessPolicy(GetBackupVaultAccessPolicyRequest getBackupVaultAccessPolicyRequest)
Returns the access policy document that is associated with the named backup vault.
getBackupVaultAccessPolicyRequest
- ResourceNotFoundException
- A resource that is required for the action doesn't exist.InvalidParameterValueException
- Indicates that something is wrong with a parameter's value. For example, the value is out of range.MissingParameterValueException
- Indicates that a required parameter is missing.ServiceUnavailableException
- The request failed due to a temporary failure of the server.GetBackupVaultNotificationsResult getBackupVaultNotifications(GetBackupVaultNotificationsRequest getBackupVaultNotificationsRequest)
Returns event notifications for the specified backup vault.
getBackupVaultNotificationsRequest
- ResourceNotFoundException
- A resource that is required for the action doesn't exist.InvalidParameterValueException
- Indicates that something is wrong with a parameter's value. For example, the value is out of range.MissingParameterValueException
- Indicates that a required parameter is missing.ServiceUnavailableException
- The request failed due to a temporary failure of the server.GetLegalHoldResult getLegalHold(GetLegalHoldRequest getLegalHoldRequest)
This action returns details for a specified legal hold. The details are the body of a legal hold in JSON format, in addition to metadata.
getLegalHoldRequest
- 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.GetRecoveryPointRestoreMetadataResult getRecoveryPointRestoreMetadata(GetRecoveryPointRestoreMetadataRequest getRecoveryPointRestoreMetadataRequest)
Returns a set of metadata key-value pairs that were used to create the backup.
getRecoveryPointRestoreMetadataRequest
- ResourceNotFoundException
- A resource that is required for the action doesn't exist.InvalidParameterValueException
- Indicates that something is wrong with a parameter's value. For example, the value is out of range.MissingParameterValueException
- Indicates that a required parameter is missing.ServiceUnavailableException
- The request failed due to a temporary failure of the server.GetRestoreJobMetadataResult getRestoreJobMetadata(GetRestoreJobMetadataRequest getRestoreJobMetadataRequest)
This request returns the metadata for the specified restore job.
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.GetRestoreTestingInferredMetadataResult getRestoreTestingInferredMetadata(GetRestoreTestingInferredMetadataRequest getRestoreTestingInferredMetadataRequest)
This request returns the minimal required set of metadata needed to start a restore job with secure default
settings. BackupVaultName
and RecoveryPointArn
are required parameters.
BackupVaultAccountId
is an optional parameter.
getRestoreTestingInferredMetadataRequest
- 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.GetRestoreTestingPlanResult getRestoreTestingPlan(GetRestoreTestingPlanRequest getRestoreTestingPlanRequest)
Returns RestoreTestingPlan
details for the specified RestoreTestingPlanName
. The
details are the body of a restore testing plan in JSON format, in addition to plan metadata.
getRestoreTestingPlanRequest
- ResourceNotFoundException
- A resource that is required for the action doesn't exist.ServiceUnavailableException
- The request failed due to a temporary failure of the server.GetRestoreTestingSelectionResult getRestoreTestingSelection(GetRestoreTestingSelectionRequest getRestoreTestingSelectionRequest)
Returns RestoreTestingSelection, which displays resources and elements of the restore testing plan.
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.GetSupportedResourceTypesResult getSupportedResourceTypes(GetSupportedResourceTypesRequest getSupportedResourceTypesRequest)
Returns the Amazon Web Services resource types supported by Backup.
getSupportedResourceTypesRequest
- ServiceUnavailableException
- The request failed due to a temporary failure of the server.ListBackupJobSummariesResult listBackupJobSummaries(ListBackupJobSummariesRequest listBackupJobSummariesRequest)
This is a request for a summary of backup jobs created or running within the most recent 30 days. You can include parameters AccountID, State, ResourceType, MessageCategory, AggregationPeriod, MaxResults, or NextToken to filter results.
This request returns a summary that contains Region, Account, State, ResourceType, MessageCategory, StartTime, EndTime, and Count of included jobs.
listBackupJobSummariesRequest
- 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.ListBackupJobsResult listBackupJobs(ListBackupJobsRequest listBackupJobsRequest)
Returns a list of existing backup jobs for an authenticated account for the last 30 days. For a longer period of time, consider using these monitoring tools.
listBackupJobsRequest
- InvalidParameterValueException
- Indicates that something is wrong with a parameter's value. For example, the value is out of range.ServiceUnavailableException
- The request failed due to a temporary failure of the server.ListBackupPlanTemplatesResult listBackupPlanTemplates(ListBackupPlanTemplatesRequest listBackupPlanTemplatesRequest)
Returns metadata of your saved backup plan templates, including the template ID, name, and the creation and deletion dates.
listBackupPlanTemplatesRequest
- InvalidParameterValueException
- Indicates that something is wrong with a parameter's value. For example, the value is out of range.MissingParameterValueException
- Indicates that a required parameter is missing.ServiceUnavailableException
- The request failed due to a temporary failure of the server.ResourceNotFoundException
- A resource that is required for the action doesn't exist.ListBackupPlanVersionsResult listBackupPlanVersions(ListBackupPlanVersionsRequest listBackupPlanVersionsRequest)
Returns version metadata of your backup plans, including Amazon Resource Names (ARNs), backup plan IDs, creation and deletion dates, plan names, and version IDs.
listBackupPlanVersionsRequest
- ResourceNotFoundException
- A resource that is required for the action doesn't exist.InvalidParameterValueException
- Indicates that something is wrong with a parameter's value. For example, the value is out of range.MissingParameterValueException
- Indicates that a required parameter is missing.ServiceUnavailableException
- The request failed due to a temporary failure of the server.ListBackupPlansResult listBackupPlans(ListBackupPlansRequest listBackupPlansRequest)
Returns a list of all active backup plans for an authenticated account. The list contains information such as Amazon Resource Names (ARNs), plan IDs, creation and deletion dates, version IDs, plan names, and creator request IDs.
listBackupPlansRequest
- ResourceNotFoundException
- A resource that is required for the action doesn't exist.InvalidParameterValueException
- Indicates that something is wrong with a parameter's value. For example, the value is out of range.MissingParameterValueException
- Indicates that a required parameter is missing.ServiceUnavailableException
- The request failed due to a temporary failure of the server.ListBackupSelectionsResult listBackupSelections(ListBackupSelectionsRequest listBackupSelectionsRequest)
Returns an array containing metadata of the resources associated with the target backup plan.
listBackupSelectionsRequest
- ResourceNotFoundException
- A resource that is required for the action doesn't exist.InvalidParameterValueException
- Indicates that something is wrong with a parameter's value. For example, the value is out of range.MissingParameterValueException
- Indicates that a required parameter is missing.ServiceUnavailableException
- The request failed due to a temporary failure of the server.ListBackupVaultsResult listBackupVaults(ListBackupVaultsRequest listBackupVaultsRequest)
Returns a list of recovery point storage containers along with information about them.
listBackupVaultsRequest
- ResourceNotFoundException
- A resource that is required for the action doesn't exist.InvalidParameterValueException
- Indicates that something is wrong with a parameter's value. For example, the value is out of range.MissingParameterValueException
- Indicates that a required parameter is missing.ServiceUnavailableException
- The request failed due to a temporary failure of the server.ListCopyJobSummariesResult listCopyJobSummaries(ListCopyJobSummariesRequest listCopyJobSummariesRequest)
This request obtains a list of copy jobs created or running within the the most recent 30 days. You can include parameters AccountID, State, ResourceType, MessageCategory, AggregationPeriod, MaxResults, or NextToken to filter results.
This request returns a summary that contains Region, Account, State, RestourceType, MessageCategory, StartTime, EndTime, and Count of included jobs.
listCopyJobSummariesRequest
- 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.ListCopyJobsResult listCopyJobs(ListCopyJobsRequest listCopyJobsRequest)
Returns metadata about your copy jobs.
listCopyJobsRequest
- InvalidParameterValueException
- Indicates that something is wrong with a parameter's value. For example, the value is out of range.ServiceUnavailableException
- The request failed due to a temporary failure of the server.ListFrameworksResult listFrameworks(ListFrameworksRequest listFrameworksRequest)
Returns a list of all frameworks for an Amazon Web Services account and Amazon Web Services Region.
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.ListLegalHoldsResult listLegalHolds(ListLegalHoldsRequest listLegalHoldsRequest)
This action returns metadata about active and previous legal holds.
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.ListProtectedResourcesResult listProtectedResources(ListProtectedResourcesRequest listProtectedResourcesRequest)
Returns an array of resources successfully backed up by Backup, including the time the resource was saved, an Amazon Resource Name (ARN) of the resource, and a resource type.
listProtectedResourcesRequest
- 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.ListProtectedResourcesByBackupVaultResult listProtectedResourcesByBackupVault(ListProtectedResourcesByBackupVaultRequest listProtectedResourcesByBackupVaultRequest)
This request lists the protected resources corresponding to each backup vault.
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.ListRecoveryPointsByBackupVaultResult listRecoveryPointsByBackupVault(ListRecoveryPointsByBackupVaultRequest listRecoveryPointsByBackupVaultRequest)
Returns detailed information about the recovery points stored in a backup vault.
listRecoveryPointsByBackupVaultRequest
- ResourceNotFoundException
- A resource that is required for the action doesn't exist.InvalidParameterValueException
- Indicates that something is wrong with a parameter's value. For example, the value is out of range.MissingParameterValueException
- Indicates that a required parameter is missing.ServiceUnavailableException
- The request failed due to a temporary failure of the server.ListRecoveryPointsByLegalHoldResult listRecoveryPointsByLegalHold(ListRecoveryPointsByLegalHoldRequest listRecoveryPointsByLegalHoldRequest)
This action returns recovery point ARNs (Amazon Resource Names) of the specified legal hold.
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.ListRecoveryPointsByResourceResult listRecoveryPointsByResource(ListRecoveryPointsByResourceRequest listRecoveryPointsByResourceRequest)
Returns detailed information about all the recovery points of the type specified by a resource Amazon Resource Name (ARN).
For Amazon EFS and Amazon EC2, this action only lists recovery points created by Backup.
listRecoveryPointsByResourceRequest
- 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.ListReportJobsResult listReportJobs(ListReportJobsRequest listReportJobsRequest)
Returns details about your report jobs.
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.ListReportPlansResult listReportPlans(ListReportPlansRequest listReportPlansRequest)
Returns a list of your report plans. For detailed information about a single report plan, use
DescribeReportPlan
.
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.ListRestoreJobSummariesResult listRestoreJobSummaries(ListRestoreJobSummariesRequest listRestoreJobSummariesRequest)
This request obtains a summary of restore jobs created or running within the the most recent 30 days. You can include parameters AccountID, State, ResourceType, AggregationPeriod, MaxResults, or NextToken to filter results.
This request returns a summary that contains Region, Account, State, RestourceType, MessageCategory, StartTime, EndTime, and Count of included jobs.
listRestoreJobSummariesRequest
- 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.ListRestoreJobsResult listRestoreJobs(ListRestoreJobsRequest listRestoreJobsRequest)
Returns a list of jobs that Backup initiated to restore a saved resource, including details about the recovery process.
listRestoreJobsRequest
- ResourceNotFoundException
- A resource that is required for the action doesn't exist.InvalidParameterValueException
- Indicates that something is wrong with a parameter's value. For example, the value is out of range.MissingParameterValueException
- Indicates that a required parameter is missing.ServiceUnavailableException
- The request failed due to a temporary failure of the server.ListRestoreJobsByProtectedResourceResult listRestoreJobsByProtectedResource(ListRestoreJobsByProtectedResourceRequest listRestoreJobsByProtectedResourceRequest)
This returns restore jobs that contain the specified protected resource.
You must include ResourceArn
. You can optionally include NextToken
,
ByStatus
, MaxResults
, ByRecoveryPointCreationDateAfter
, and
ByRecoveryPointCreationDateBefore
.
listRestoreJobsByProtectedResourceRequest
- 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.ListRestoreTestingPlansResult listRestoreTestingPlans(ListRestoreTestingPlansRequest listRestoreTestingPlansRequest)
Returns a list of restore testing plans.
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.ListRestoreTestingSelectionsResult listRestoreTestingSelections(ListRestoreTestingSelectionsRequest listRestoreTestingSelectionsRequest)
Returns a list of restore testing selections. Can be filtered by MaxResults
and
RestoreTestingPlanName
.
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.ListTagsResult listTags(ListTagsRequest listTagsRequest)
Returns a list of key-value pairs assigned to a target recovery point, backup plan, or backup vault.
ListTags
only works for resource types that support full Backup management of their backups. Those
resource types are listed in the "Full Backup management" section of the Feature
availability by resource table.
listTagsRequest
- ResourceNotFoundException
- A resource that is required for the action doesn't exist.InvalidParameterValueException
- Indicates that something is wrong with a parameter's value. For example, the value is out of range.MissingParameterValueException
- Indicates that a required parameter is missing.ServiceUnavailableException
- The request failed due to a temporary failure of the server.PutBackupVaultAccessPolicyResult putBackupVaultAccessPolicy(PutBackupVaultAccessPolicyRequest putBackupVaultAccessPolicyRequest)
Sets a resource-based policy that is used to manage access permissions on the target backup vault. Requires a backup vault name and an access policy document in JSON format.
putBackupVaultAccessPolicyRequest
- ResourceNotFoundException
- A resource that is required for the action doesn't exist.InvalidParameterValueException
- Indicates that something is wrong with a parameter's value. For example, the value is out of range.MissingParameterValueException
- Indicates that a required parameter is missing.ServiceUnavailableException
- The request failed due to a temporary failure of the server.PutBackupVaultLockConfigurationResult putBackupVaultLockConfiguration(PutBackupVaultLockConfigurationRequest putBackupVaultLockConfigurationRequest)
Applies Backup Vault Lock to a backup vault, preventing attempts to delete any recovery point stored in or created in a backup vault. Vault Lock also prevents attempts to update the lifecycle policy that controls the retention period of any recovery point currently stored in a backup vault. If specified, Vault Lock enforces a minimum and maximum retention period for future backup and copy jobs that target a backup vault.
Backup Vault Lock has been assessed by Cohasset Associates for use in environments that are subject to SEC 17a-4, CFTC, and FINRA regulations. For more information about how Backup Vault Lock relates to these regulations, see the Cohasset Associates Compliance Assessment.
putBackupVaultLockConfigurationRequest
- 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.PutBackupVaultNotificationsResult putBackupVaultNotifications(PutBackupVaultNotificationsRequest putBackupVaultNotificationsRequest)
Turns on notifications on a backup vault for the specified topic and events.
putBackupVaultNotificationsRequest
- ResourceNotFoundException
- A resource that is required for the action doesn't exist.InvalidParameterValueException
- Indicates that something is wrong with a parameter's value. For example, the value is out of range.MissingParameterValueException
- Indicates that a required parameter is missing.ServiceUnavailableException
- The request failed due to a temporary failure of the server.PutRestoreValidationResultResult putRestoreValidationResult(PutRestoreValidationResultRequest putRestoreValidationResultRequest)
This request allows you to send your independent self-run restore test validation results.
RestoreJobId
and ValidationStatus
are required. Optionally, you can input a
ValidationStatusMessage
.
putRestoreValidationResultRequest
- 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.StartBackupJobResult startBackupJob(StartBackupJobRequest startBackupJobRequest)
Starts an on-demand backup job for the specified resource.
startBackupJobRequest
- ResourceNotFoundException
- A resource that is required for the action doesn't exist.InvalidParameterValueException
- Indicates that something is wrong with a parameter's value. For example, the value is out of range.MissingParameterValueException
- Indicates that a required parameter is missing.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.StartCopyJobResult startCopyJob(StartCopyJobRequest startCopyJobRequest)
Starts a job to create a one-time copy of the specified resource.
Does not support continuous backups.
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.StartReportJobResult startReportJob(StartReportJobRequest startReportJobRequest)
Starts an on-demand report job for the specified report plan.
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.StartRestoreJobResult startRestoreJob(StartRestoreJobRequest startRestoreJobRequest)
Recovers the saved resource identified by an Amazon Resource Name (ARN).
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.StopBackupJobResult stopBackupJob(StopBackupJobRequest stopBackupJobRequest)
Attempts to cancel a job to create a one-time backup of a resource.
This action is not supported for the following services: Amazon FSx for Windows File Server, Amazon FSx for Lustre, Amazon FSx for NetApp ONTAP , Amazon FSx for OpenZFS, Amazon DocumentDB (with MongoDB compatibility), Amazon RDS, Amazon Aurora, and Amazon Neptune.
stopBackupJobRequest
- MissingParameterValueException
- Indicates that a required parameter is missing.ResourceNotFoundException
- A resource that is required for the action doesn't exist.InvalidParameterValueException
- Indicates that something is wrong with a parameter's value. For example, the value is out of range.InvalidRequestException
- Indicates that something is wrong with the input to the request. For example, a parameter is of the wrong
type.ServiceUnavailableException
- The request failed due to a temporary failure of the server.TagResourceResult tagResource(TagResourceRequest tagResourceRequest)
Assigns a set of key-value pairs to a recovery point, backup plan, or backup vault identified by an Amazon Resource Name (ARN).
tagResourceRequest
- ResourceNotFoundException
- A resource that is required for the action doesn't exist.InvalidParameterValueException
- Indicates that something is wrong with a parameter's value. For example, the value is out of range.MissingParameterValueException
- Indicates that a required parameter is missing.ServiceUnavailableException
- The request failed due to a temporary failure of the server.LimitExceededException
- A limit in the request has been exceeded; for example, a maximum number of items allowed in a request.UntagResourceResult untagResource(UntagResourceRequest untagResourceRequest)
Removes a set of key-value pairs from a recovery point, backup plan, or backup vault identified by an Amazon Resource Name (ARN)
untagResourceRequest
- ResourceNotFoundException
- A resource that is required for the action doesn't exist.InvalidParameterValueException
- Indicates that something is wrong with a parameter's value. For example, the value is out of range.MissingParameterValueException
- Indicates that a required parameter is missing.ServiceUnavailableException
- The request failed due to a temporary failure of the server.UpdateBackupPlanResult updateBackupPlan(UpdateBackupPlanRequest updateBackupPlanRequest)
Updates an existing backup plan identified by its backupPlanId
with the input document in JSON
format. The new version is uniquely identified by a VersionId
.
updateBackupPlanRequest
- 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.UpdateFrameworkResult updateFramework(UpdateFrameworkRequest updateFrameworkRequest)
Updates an existing framework identified by its FrameworkName
with the input document in JSON
format.
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.UpdateGlobalSettingsResult updateGlobalSettings(UpdateGlobalSettingsRequest updateGlobalSettingsRequest)
Updates whether the Amazon Web Services account is opted in to cross-account backup. Returns an error if the
account is not an Organizations management account. Use the DescribeGlobalSettings
API to determine
the current settings.
updateGlobalSettingsRequest
- 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.UpdateRecoveryPointLifecycleResult updateRecoveryPointLifecycle(UpdateRecoveryPointLifecycleRequest updateRecoveryPointLifecycleRequest)
Sets the transition lifecycle of a recovery point.
The lifecycle defines when a protected resource is transitioned to cold storage and when it expires. Backup transitions and expires backups automatically according to the lifecycle that you define.
Backups transitioned to cold storage must be stored in cold storage for a minimum of 90 days. Therefore, the “retention” setting must be 90 days greater than the “transition to cold after days” setting. The “transition to cold after days” setting cannot be changed after a backup has been transitioned to cold.
Resource types that are able to be transitioned to cold storage are listed in the "Lifecycle to cold storage" section of the Feature availability by resource table. Backup ignores this expression for other resource types.
This operation does not support continuous backups.
updateRecoveryPointLifecycleRequest
- 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.UpdateRegionSettingsResult updateRegionSettings(UpdateRegionSettingsRequest updateRegionSettingsRequest)
Updates the current service opt-in settings for the Region.
Use the DescribeRegionSettings
API to determine the resource types that are supported.
updateRegionSettingsRequest
- 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.UpdateReportPlanResult updateReportPlan(UpdateReportPlanRequest updateReportPlanRequest)
Updates an existing report plan identified by its ReportPlanName
with the input document in JSON
format.
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.UpdateRestoreTestingPlanResult updateRestoreTestingPlan(UpdateRestoreTestingPlanRequest updateRestoreTestingPlanRequest)
This request will send changes to your specified restore testing plan. RestoreTestingPlanName
cannot
be updated after it is created.
RecoveryPointSelection
can contain:
Algorithm
ExcludeVaults
IncludeVaults
RecoveryPointTypes
SelectionWindowDays
updateRestoreTestingPlanRequest
- 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.UpdateRestoreTestingSelectionResult updateRestoreTestingSelection(UpdateRestoreTestingSelectionRequest updateRestoreTestingSelectionRequest)
Most elements except the RestoreTestingSelectionName
can be updated with this request.
RestoreTestingSelection
can use either protected resource ARNs or conditions, but not both. That is,
if your selection has ProtectedResourceArns
, requesting an update with the parameter
ProtectedResourceConditions
will be unsuccessful.
updateRestoreTestingSelectionRequest
- 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.void shutdown()
ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
Response metadata is only cached for a limited period of time, so if you need to access this extra diagnostic information for an executed request, you should use this method to retrieve it as soon as possible after executing a request.
request
- The originally executed request.