View Source aws_backup (aws v1.0.4)
Backup
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.Summary
Functions
This action removes the specified legal hold on a recovery point.
Creates a backup plan using a backup plan name and backup rules.
Creates a JSON document that specifies a set of resources to assign to a backup plan.
Creates a logical container where backups are stored.
Creates a framework with one or more controls.
This action creates a legal hold on a recovery point (backup).
This request creates a logical container to where backups may be copied.
Creates a report plan.
This is the first of two steps to create a restore testing plan; once this request is successful, finish the procedure with request CreateRestoreTestingSelection.
This request can be sent after CreateRestoreTestingPlan request returns successfully.
Deletes a backup plan.
SelectionId
.Deletes the backup vault identified by its name.
Deletes Backup Vault Lock from a backup vault specified by a backup vault name.
Deletes the recovery point specified by a recovery point ID.
This request deletes the specified restore testing plan.
Input the Restore Testing Plan name and Restore Testing Selection name.
BackupJobId
.FrameworkName
.Describes whether the Amazon Web Services account is opted in to cross-account backup.
Returns the current service opt-in settings for the Region.
ReportJobId
.Deletes the specified continuous backup recovery point from Backup and releases control of that continuous backup to the source service, such as Amazon RDS.
Returns BackupPlan
details for the specified BackupPlanId
.
templateId
as a backup plan.This action returns details for a specified legal hold.
This request returns the minimal required set of metadata needed to start a restore job with secure default settings.
Returns RestoreTestingPlan
details for the specified RestoreTestingPlanName
.
This is a request for a summary of backup jobs created or running within the most recent 30 days.
Returns a list of existing backup jobs for an authenticated account for the last 30 days.
Returns a list of all active backup plans for an authenticated account.
This request obtains a list of copy jobs created or running within the the most recent 30 days.
Returns detailed information about all the recovery points of the type specified by a resource Amazon Resource Name (ARN).
Returns a list of your report plans.
This request obtains a summary of restore jobs created or running within the the most recent 30 days.
This returns restore jobs that contain the specified protected resource.
Returns a list of restore testing selections.
Returns a list of key-value pairs assigned to a target recovery point, backup plan, or backup vault.
Sets a resource-based policy that is used to manage access permissions on the target backup vault.
Applies Backup Vault Lock to a backup vault, preventing attempts to delete any recovery point stored in or created in a backup vault.
This request allows you to send your independent self-run restore test validation results.
Starts a job to create a one-time copy of the specified resource.
Attempts to cancel a job to create a one-time backup of a resource.
Updates an existing backup plan identified by its backupPlanId
with the input document in JSON format.
FrameworkName
with the input document in JSON format.Updates whether the Amazon Web Services account is opted in to cross-account backup.
Sets the transition lifecycle of a recovery point.
Updates the current service opt-in settings for the Region.
ReportPlanName
with the input document in JSON format.This request will send changes to your specified restore testing plan.
Most elements except the RestoreTestingSelectionName
can be updated with this request.
Functions
This action removes the specified legal hold on a recovery point.
This action can only be performed by a user with sufficient permissions.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 callCreateBackupPlan
with a plan that already exists, you receive an AlreadyExistsException
exception.
Creates a JSON document that specifies a set of resources to assign to a backup plan.
For examples, see Assigning resources programmatically: https://docs.aws.amazon.com/aws-backup/latest/devguide/assigning-resources.html#assigning-resources-json.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.
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.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.create_logically_air_gapped_backup_vault(Client, BackupVaultName, Input)
View SourceThis 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.create_logically_air_gapped_backup_vault(Client, BackupVaultName, Input0, Options0)
View SourceCreates 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 callCreateReportPlan
with a plan that already exists, you receive an AlreadyExistsException
exception.
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.create_restore_testing_selection(Client, RestoreTestingPlanName, Input)
View SourceThis 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
.
create_restore_testing_selection(Client, RestoreTestingPlanName, Input0, Options0)
View SourceDeletes 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.SelectionId
.
delete_backup_selection(Client, BackupPlanId, SelectionId, Input0, Options0)
View SourceDeletes the backup vault identified by its name.
A vault can be deleted only if it is empty.delete_backup_vault_access_policy(Client, BackupVaultName, Input0, Options0)
View Sourcedelete_backup_vault_lock_configuration(Client, BackupVaultName, Input)
View SourceDeletes 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 anInvalidRequestException
if you attempt to do so. For more information, see Vault Lock: https://docs.aws.amazon.com/aws-backup/latest/devguide/vault-lock.html in the Backup Developer Guide.
delete_backup_vault_lock_configuration(Client, BackupVaultName, Input0, Options0)
View Sourcedelete_backup_vault_notifications(Client, BackupVaultName, Input0, Options0)
View Sourcedelete_recovery_point(Client, BackupVaultName, RecoveryPointArn, Input)
View SourceDeletes 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: https://docs.aws.amazon.com/aws-backup/latest/devguide/deleting-backups.html#deleting-backups-troubleshooting.
EXPIRED
state.
delete_recovery_point(Client, BackupVaultName, RecoveryPointArn, Input0, Options0)
View Sourcedelete_restore_testing_plan(Client, RestoreTestingPlanName, Input)
View SourceThis request deletes the specified restore testing plan.
Deletion can only successfully occur if all associated restore testing selections are deleted first.delete_restore_testing_plan(Client, RestoreTestingPlanName, Input0, Options0)
View Sourcedelete_restore_testing_selection(Client, RestoreTestingPlanName, RestoreTestingSelectionName, Input)
View SourceInput 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.delete_restore_testing_selection(Client, RestoreTestingPlanName, RestoreTestingSelectionName, Input0, Options0)
View SourceBackupJobId
.
describe_backup_job(Client, BackupJobId, QueryMap, HeadersMap, Options0)
View Sourcedescribe_backup_vault(Client, BackupVaultName, QueryMap, HeadersMap)
View Sourcedescribe_backup_vault(Client, BackupVaultName, QueryMap, HeadersMap, Options0)
View Sourcedescribe_copy_job(Client, CopyJobId, QueryMap, HeadersMap, Options0)
View SourceFrameworkName
.
describe_framework(Client, FrameworkName, QueryMap, HeadersMap, Options0)
View SourceDescribes 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
describe_protected_resource(Client, ResourceArn, QueryMap, HeadersMap)
View Sourcedescribe_protected_resource(Client, ResourceArn, QueryMap, HeadersMap, Options0)
View Sourcedescribe_recovery_point(Client, BackupVaultName, RecoveryPointArn)
View Sourcedescribe_recovery_point(Client, BackupVaultName, RecoveryPointArn, QueryMap, HeadersMap)
View Sourcedescribe_recovery_point(Client, BackupVaultName, RecoveryPointArn, QueryMap, HeadersMap, Options0)
View SourceReturns 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.ReportJobId
.
describe_report_job(Client, ReportJobId, QueryMap, HeadersMap, Options0)
View Sourcedescribe_report_plan(Client, ReportPlanName, QueryMap, HeadersMap)
View Sourcedescribe_report_plan(Client, ReportPlanName, QueryMap, HeadersMap, Options0)
View Sourcedescribe_restore_job(Client, RestoreJobId, QueryMap, HeadersMap, Options0)
View Sourcedisassociate_recovery_point(Client, BackupVaultName, RecoveryPointArn, Input)
View SourceDeletes 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.disassociate_recovery_point(Client, BackupVaultName, RecoveryPointArn, Input0, Options0)
View Sourcedisassociate_recovery_point_from_parent(Client, BackupVaultName, RecoveryPointArn, Input)
View Sourcedisassociate_recovery_point_from_parent(Client, BackupVaultName, RecoveryPointArn, Input0, Options0)
View Sourceexport_backup_plan_template(Client, BackupPlanId, QueryMap, HeadersMap)
View Sourceexport_backup_plan_template(Client, BackupPlanId, QueryMap, HeadersMap, Options0)
View SourceReturns BackupPlan
details for the specified BackupPlanId
.
get_backup_plan(Client, BackupPlanId, QueryMap, HeadersMap, Options0)
View SourcetemplateId
as a backup plan.
get_backup_plan_from_template(Client, BackupPlanTemplateId, QueryMap, HeadersMap)
View Sourceget_backup_plan_from_template(Client, BackupPlanTemplateId, QueryMap, HeadersMap, Options0)
View Sourceget_backup_selection(Client, BackupPlanId, SelectionId, QueryMap, HeadersMap)
View Sourceget_backup_selection(Client, BackupPlanId, SelectionId, QueryMap, HeadersMap, Options0)
View Sourceget_backup_vault_access_policy(Client, BackupVaultName, QueryMap, HeadersMap)
View Sourceget_backup_vault_access_policy(Client, BackupVaultName, QueryMap, HeadersMap, Options0)
View Sourceget_backup_vault_notifications(Client, BackupVaultName, QueryMap, HeadersMap)
View Sourceget_backup_vault_notifications(Client, BackupVaultName, QueryMap, HeadersMap, Options0)
View SourceThis action returns details for a specified legal hold.
The details are the body of a legal hold in JSON format, in addition to metadata.get_legal_hold(Client, LegalHoldId, QueryMap, HeadersMap, Options0)
View Sourceget_recovery_point_restore_metadata(Client, BackupVaultName, RecoveryPointArn)
View Sourceget_recovery_point_restore_metadata(Client, BackupVaultName, RecoveryPointArn, QueryMap, HeadersMap)
View Sourceget_recovery_point_restore_metadata(Client, BackupVaultName, RecoveryPointArn, QueryMap, HeadersMap, Options0)
View Sourceget_restore_job_metadata(Client, RestoreJobId, QueryMap, HeadersMap)
View Sourceget_restore_job_metadata(Client, RestoreJobId, QueryMap, HeadersMap, Options0)
View Sourceget_restore_testing_inferred_metadata(Client, BackupVaultName, RecoveryPointArn)
View SourceThis 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.
get_restore_testing_inferred_metadata(Client, BackupVaultName, RecoveryPointArn, QueryMap, HeadersMap)
View Sourceget_restore_testing_inferred_metadata(Client, BackupVaultName, RecoveryPointArn, QueryMap, HeadersMap, Options0)
View SourceReturns RestoreTestingPlan
details for the specified RestoreTestingPlanName
.
get_restore_testing_plan(Client, RestoreTestingPlanName, QueryMap, HeadersMap)
View Sourceget_restore_testing_plan(Client, RestoreTestingPlanName, QueryMap, HeadersMap, Options0)
View Sourceget_restore_testing_selection(Client, RestoreTestingPlanName, RestoreTestingSelectionName)
View Sourceget_restore_testing_selection(Client, RestoreTestingPlanName, RestoreTestingSelectionName, QueryMap, HeadersMap)
View Sourceget_restore_testing_selection(Client, RestoreTestingPlanName, RestoreTestingSelectionName, QueryMap, HeadersMap, Options0)
View Sourceget_supported_resource_types(Client, QueryMap, HeadersMap, Options0)
View SourceThis 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.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: https://docs.aws.amazon.com/aws-backup/latest/devguide/monitoring.html.list_backup_plan_templates(Client, QueryMap, HeadersMap, Options0)
View Sourcelist_backup_plan_versions(Client, BackupPlanId, QueryMap, HeadersMap)
View Sourcelist_backup_plan_versions(Client, BackupPlanId, QueryMap, HeadersMap, Options0)
View SourceReturns 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.list_backup_selections(Client, BackupPlanId, QueryMap, HeadersMap)
View Sourcelist_backup_selections(Client, BackupPlanId, QueryMap, HeadersMap, Options0)
View SourceThis 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.list_protected_resources_by_backup_vault(Client, BackupVaultName, QueryMap, HeadersMap)
View Sourcelist_protected_resources_by_backup_vault(Client, BackupVaultName, QueryMap, HeadersMap, Options0)
View Sourcelist_recovery_points_by_backup_vault(Client, BackupVaultName, QueryMap, HeadersMap)
View Sourcelist_recovery_points_by_backup_vault(Client, BackupVaultName, QueryMap, HeadersMap, Options0)
View Sourcelist_recovery_points_by_legal_hold(Client, LegalHoldId, QueryMap, HeadersMap)
View Sourcelist_recovery_points_by_legal_hold(Client, LegalHoldId, QueryMap, HeadersMap, Options0)
View SourceReturns 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.list_recovery_points_by_resource(Client, ResourceArn, QueryMap, HeadersMap)
View Sourcelist_recovery_points_by_resource(Client, ResourceArn, QueryMap, HeadersMap, Options0)
View SourceReturns a list of your report plans.
For detailed information about a single report plan, useDescribeReportPlan
.
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.list_restore_job_summaries(Client, QueryMap, HeadersMap, Options0)
View SourceThis returns restore jobs that contain the specified protected resource.
You must includeResourceArn
. You can optionally include NextToken
, ByStatus
, MaxResults
, ByRecoveryPointCreationDateAfter
, and ByRecoveryPointCreationDateBefore
.
list_restore_jobs_by_protected_resource(Client, ResourceArn, QueryMap, HeadersMap)
View Sourcelist_restore_jobs_by_protected_resource(Client, ResourceArn, QueryMap, HeadersMap, Options0)
View Sourcelist_restore_testing_plans(Client, QueryMap, HeadersMap, Options0)
View SourceReturns a list of restore testing selections.
Can be filtered byMaxResults
and RestoreTestingPlanName
.
list_restore_testing_selections(Client, RestoreTestingPlanName, QueryMap, HeadersMap)
View Sourcelist_restore_testing_selections(Client, RestoreTestingPlanName, QueryMap, HeadersMap, Options0)
View SourceReturns 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: https://docs.aws.amazon.com/aws-backup/latest/devguide/whatisbackup.html#features-by-resource table.
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.put_backup_vault_access_policy(Client, BackupVaultName, Input0, Options0)
View Sourceput_backup_vault_lock_configuration(Client, BackupVaultName, Input)
View SourceApplies 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.: samples/cohassetreport.zipput_backup_vault_lock_configuration(Client, BackupVaultName, Input0, Options0)
View Sourceput_backup_vault_notifications(Client, BackupVaultName, Input0, Options0)
View SourceThis request allows you to send your independent self-run restore test validation results.
RestoreJobId
and ValidationStatus
are required. Optionally, you can input a ValidationStatusMessage
.
put_restore_validation_result(Client, RestoreJobId, Input0, Options0)
View SourceStarts a job to create a one-time copy of the specified resource.
Does not support continuous backups.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, FSx for ONTAP , Amazon FSx for OpenZFS, Amazon DocumentDB (with MongoDB compatibility), Amazon RDS, Amazon Aurora, and Amazon Neptune.Updates an existing backup plan identified by its backupPlanId
with the input document in JSON format.
VersionId
.
FrameworkName
with the input document in JSON format.
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 theDescribeGlobalSettings
API to determine the current settings.
update_recovery_point_lifecycle(Client, BackupVaultName, RecoveryPointArn, Input)
View SourceSets 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: https://docs.aws.amazon.com/aws-backup/latest/devguide/whatisbackup.html#features-by-resource table. Backup ignores this expression for other resource types.
This operation does not support continuous backups.update_recovery_point_lifecycle(Client, BackupVaultName, RecoveryPointArn, Input0, Options0)
View SourceUpdates the current service opt-in settings for the Region.
Use theDescribeRegionSettings
API to determine the resource types that are supported.
ReportPlanName
with the input document in JSON format.
update_restore_testing_plan(Client, RestoreTestingPlanName, Input)
View SourceThis 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
update_restore_testing_plan(Client, RestoreTestingPlanName, Input0, Options0)
View Sourceupdate_restore_testing_selection(Client, RestoreTestingPlanName, RestoreTestingSelectionName, Input)
View SourceMost 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.