Amazon Web Services Backup Vaults API

openapi: 3.2.0
info:
  title: Amazon Web Services backup Backup Vaults API
  description: '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.'
tags:
- name: Backup Vaults
paths:
  /backup-vaults/{backupVaultName}:
    GET:
      summary: Amazon Web Services Describebackupvault
      description: Returns metadata about a backup vault specified by its name.
      operationId: amazonWebServicesDescribeBackupVault
      tags:
      - Backup Vaults
  /backup-vaults/{backupVaultName}/access-policy:
    PUT:
      summary: Amazon Web Services Putbackupvaultaccesspolicy
      description: 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.
      operationId: amazonWebServicesPutBackupVaultAccessPolicy
      tags:
      - Backup Vaults
  /backup-vaults/{backupVaultName}/vault-lock:
    PUT:
      summary: Amazon Web Services Putbackupvaultlockconfiguration
      description: 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.
      operationId: amazonWebServicesPutBackupVaultLockConfiguration
      tags:
      - Backup Vaults
  /backup-vaults/{backupVaultName}/notification-configuration:
    PUT:
      summary: Amazon Web Services Putbackupvaultnotifications
      description: Turns on notifications on a backup vault for the specified topic and events.
      operationId: amazonWebServicesPutBackupVaultNotifications
      tags:
      - Backup Vaults
  /backup-vaults/{backupVaultName}/recovery-points/{recoveryPointArn}:
    POST:
      summary: Amazon Web Services Updaterecoverypointlifecycle
      description: 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.
      operationId: amazonWebServicesUpdateRecoveryPointLifecycle
      tags:
      - Backup Vaults
  /backup-vaults/{backupVaultName}/recovery-points/{recoveryPointArn}/disassociate:
    POST:
      summary: Amazon Web Services Disassociaterecoverypoint
      description: 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.
      operationId: amazonWebServicesDisassociateRecoveryPoint
      tags:
      - Backup Vaults
  /backup-vaults/{backupVaultName}/recovery-points/{recoveryPointArn}/parentAssociation:
    DELETE:
      summary: Amazon Web Services Disassociaterecoverypointfromparent
      description: This action to a specific child (nested) recovery point removes the relationship between the specified recovery point and its parent (composite) recovery point.
      operationId: amazonWebServicesDisassociateRecoveryPointFromParent
      tags:
      - Backup Vaults
  /backup-vaults/{backupVaultName}/recovery-points/{recoveryPointArn}/restore-metadata:
    GET:
      summary: Amazon Web Services Getrecoverypointrestoremetadata
      description: Returns a set of metadata key-value pairs that were used to create the backup.
      operationId: amazonWebServicesGetRecoveryPointRestoreMetadata
      tags:
      - Backup Vaults
  /backup-vaults/:
    GET:
      summary: Amazon Web Services Listbackupvaults
      description: Returns a list of recovery point storage containers along with information about them.
      operationId: amazonWebServicesListBackupVaults
      tags:
      - Backup Vaults
  /backup-vaults/{backupVaultName}/resources/:
    GET:
      summary: Amazon Web Services Listprotectedresourcesbybackupvault
      description: This request lists the protected resources corresponding to each backup vault.
      operationId: amazonWebServicesListProtectedResourcesByBackupVault
      tags:
      - Backup Vaults
  /backup-vaults/{backupVaultName}/recovery-points/:
    GET:
      summary: Amazon Web Services Listrecoverypointsbybackupvault
      description: Returns detailed information about the recovery points stored in a backup vault.
      operationId: amazonWebServicesListRecoveryPointsByBackupVault
      tags:
      - Backup Vaults