aws backup
Backup is a unified backup service designed to protect Amazon Web Services services and their associated data. AWS CLI reference
115 commands Its page in the AWS CLI reference
Commands
associate-backup-vault-mpa-approval-teamAssociates an MPA approval team with a backup vault.cancel-legal-holdRemoves the specified legal hold on a recovery point.create-backup-access-pointCreates a backup access point for an Amazon S3 recovery point.create-backup-planCreates a backup plan using a backup plan name and backup rules.create-backup-selectionCreates a JSON document that specifies a set of resources to assign to a backup plan.create-backup-vaultCreates a logical container where backups are stored.create-frameworkCreates a framework with one or more controls.create-legal-holdCreates a legal hold on a recovery point (backup).create-logically-air-gapped-backup-vaultCreates a logical container to where backups may be copied.create-report-planCreates a report plan.create-restore-access-backup-vaultCreates a restore access backup vault that provides temporary access to recovery points in a logically air-gapped backup vault, subject to MPA approval.create-restore-testing-planCreates a restore testing plan.create-restore-testing-selectionThis request can be sent after CreateRestoreTestingPlan request returns successfully.create-tiering-configurationCreates a tiering configuration.delete-backup-access-pointDeletes a backup access point.delete-backup-planDeletes a backup plan.delete-backup-selectionDeletes the resource selection associated with a backup plan that is specified by the SelectionId.delete-backup-vaultDeletes the backup vault identified by its name.delete-backup-vault-access-policyDeletes the policy document that manages permissions on a backup vault.delete-backup-vault-lock-configurationDeletes Backup Vault Lock from a backup vault specified by a backup vault name.delete-backup-vault-notificationsDeletes event notifications for the specified backup vault.delete-frameworkDeletes the framework specified by a framework name.delete-recovery-pointDeletes the recovery point specified by a recovery point ID.delete-report-planDeletes the report plan specified by a report plan name.delete-restore-testing-planThis request deletes the specified restore testing plan.delete-restore-testing-selectionInput the Restore Testing Plan name and Restore Testing Selection name.delete-tiering-configurationDeletes the tiering configuration specified by a tiering configuration name.describe-backup-access-pointReturns metadata about a backup access point, including its status and the details of the underlying Amazon S3 access point.describe-backup-jobReturns backup job details for the specified BackupJobId.describe-backup-vaultReturns metadata about a backup vault specified by its name.describe-copy-jobReturns metadata associated with creating a copy of a resource.describe-frameworkReturns the framework details for the specified FrameworkName.describe-global-settingsDescribes whether the Amazon Web Services account has enabled different cross-account management options, including cross-account backup, multi-party approval, and delegated administrator.describe-protected-resourceReturns 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.describe-recovery-pointReturns metadata associated with a recovery point, including ID, status, encryption, and lifecycle.describe-region-settingsReturns the current service opt-in settings for the Region.describe-report-jobReturns the details associated with creating a report as specified by its ReportJobId.describe-report-planReturns a list of all report plans for an Amazon Web Services account and Amazon Web Services Region.describe-restore-jobReturns metadata associated with a restore job that is specified by a job ID.describe-scan-jobReturns scan job details for the specified ScanJobID.disassociate-backup-vault-mpa-approval-teamRemoves the association between an MPA approval team and a backup vault, disabling the MPA approval workflow for restore operations.disassociate-recovery-pointDeletes the specified continuous backup recovery point from Backup and releases control of that continuous backup to the source service, such as Amazon RDS.disassociate-recovery-point-from-parentThis action to a specific child (nested) recovery point removes the relationship between the specified recovery point and its parent (composite) recovery point.export-backup-plan-templateReturns the backup plan that is specified by the plan ID as a backup template.get-backup-planReturns BackupPlan details for the specified BackupPlanId.get-backup-plan-from-jsonReturns a valid JSON document specifying a backup plan or an error.get-backup-plan-from-templateReturns the template specified by its templateId as a backup plan.get-backup-selectionReturns selection metadata and a document in JSON format that specifies a list of resources that are associated with a backup plan.get-backup-vault-access-policyReturns the access policy document that is associated with the named backup vault.get-backup-vault-notificationsReturns event notifications for the specified backup vault.get-legal-holdThis action returns details for a specified legal hold.get-pitr-malware-scan-resultsReturns the malware scan results for a specified point in time within a continuous (point-in-time recovery) backup.get-recovery-point-index-detailsThis operation returns the metadata and details specific to the backup index associated with the specified recovery point.get-recovery-point-restore-metadataReturns a set of metadata key-value pairs that were used to create the backup.get-restore-job-metadataThis request returns the metadata for the specified restore job.get-restore-testing-inferred-metadataThis request returns the minimal required set of metadata needed to start a restore job with secure default settings.get-restore-testing-planReturns RestoreTestingPlan details for the specified RestoreTestingPlanName.get-restore-testing-selectionReturns RestoreTestingSelection, which displays resources and elements of the restore testing plan.get-supported-resource-typesReturns the Amazon Web Services resource types supported by Backup.get-tiering-configurationReturns TieringConfiguration details for the specified TieringConfigurationName.list-backup-access-pointsReturns a list of the backup access points in your account and Region.list-backup-access-points-by-recovery-pointReturns the backup access points associated with the specified recovery point.list-backup-access-points-by-resourceReturns the backup access points associated with the specified resource, such as an Amazon S3 bucket.list-backup-job-summariesThis is a request for a summary of backup jobs created or running within the most recent 14 days.list-backup-jobsReturns a list of existing backup jobs for an authenticated account for the last 30 days.list-backup-plan-templatesLists the backup plan templates.list-backup-plan-versionsReturns version metadata of your backup plans, including Amazon Resource Names (ARNs), backup plan IDs, creation and deletion dates, plan names, and version IDs.list-backup-plansLists the active backup plans for the account.list-backup-selectionsReturns an array containing metadata of the resources associated with the target backup plan.list-backup-vaultsReturns a list of recovery point storage containers along with information about them.list-copy-job-summariesThis request obtains a list of copy jobs created or running within the the most recent 14 days.list-copy-jobsReturns metadata about your copy jobs.list-frameworksReturns a list of all frameworks for an Amazon Web Services account and Amazon Web Services Region.list-indexed-recovery-pointsThis operation returns a list of recovery points that have an associated index, belonging to the specified account.list-legal-holdsThis action returns metadata about active and previous legal holds.list-protected-resourcesReturns an array of resources with recovery points created by Backup (regardless of the recovery point's status), including the time the resource was saved, an Amazon Resource Name (ARN) of the resource, and a resource type.list-protected-resources-by-backup-vaultThis request lists the protected resources corresponding to each backup vault.list-recovery-points-by-backup-vaultReturns detailed information about the recovery points stored in a backup vault.list-recovery-points-by-legal-holdThis action returns recovery point ARNs (Amazon Resource Names) of the specified legal hold.list-recovery-points-by-resourceThe information about the recovery points of the type specified by a resource Amazon Resource Name (ARN).list-report-jobsReturns details about your report jobs.list-report-plansReturns a list of your report plans.list-restore-access-backup-vaultsReturns a list of restore access backup vaults associated with a specified backup vault.list-restore-job-summariesThis request obtains a summary of restore jobs created or running within the the most recent 14 days.list-restore-jobsReturns a list of jobs that Backup initiated to restore a saved resource, including details about the recovery process.list-restore-jobs-by-protected-resourceThis returns restore jobs that contain the specified protected resource.list-restore-testing-plansReturns a list of restore testing plans.list-restore-testing-selectionsReturns a list of restore testing selections.list-scan-job-summariesThis is a request for a summary of scan jobs created or running within the most recent 14 days.list-scan-jobsReturns a list of existing scan jobs for an authenticated account for the last 30 days.list-tagsReturns the tags assigned to the resource, such as a target recovery point, backup plan, or backup vault.list-tiering-configurationsReturns a list of tiering configurations.put-backup-vault-access-policySets a resource-based policy that is used to manage access permissions on the target backup vault.put-backup-vault-lock-configurationApplies Backup Vault Lock to a backup vault, preventing attempts to delete any recovery point stored in or created in a backup vault.put-backup-vault-notificationsTurns on notifications on a backup vault for the specified topic and events.put-restore-validation-resultThis request allows you to send your independent self-run restore test validation results.revoke-restore-access-backup-vaultRevokes access to a restore access backup vault, removing the ability to restore from its recovery points and permanently deleting the vault.start-backup-jobStarts an on-demand backup job for the specified resource.start-copy-jobStarts a job to create a one-time copy of the specified resource.start-report-jobStarts an on-demand report job for the specified report plan.start-restore-jobRecovers the saved resource identified by an Amazon Resource Name (ARN).start-scan-jobStarts scanning jobs for specific resources.stop-backup-jobAttempts to cancel a job to create a one-time backup of a resource.tag-resourceAssigns a set of key-value pairs to a resource.untag-resourceRemoves a set of key-value pairs from a recovery point, backup plan, or backup vault identified by an Amazon Resource Name (ARN) This API is not supported for recovery points for resource types including Aurora, Amazon DocumentDB.update-backup-planUpdates the specified backup plan.update-frameworkUpdates the specified framework.update-global-settingsUpdates whether the Amazon Web Services account has enabled different cross-account management options, including cross-account backup, multi-party approval, and delegated administrator.update-recovery-point-index-settingsThis operation updates the settings of a recovery point index.update-recovery-point-lifecycleSets the transition lifecycle of a recovery point.update-region-settingsUpdates the current service opt-in settings for the Region.update-report-planUpdates the specified report plan.update-restore-testing-planThis request will send changes to your specified restore testing plan.update-restore-testing-selectionUpdates the specified restore testing selection.update-tiering-configurationThis request will send changes to your specified tiering configuration.