AWS Backup Vaults API

openapi: 3.2.0
info:
  title: Aws Backup Backup Vaults API
  version: '2018-11-15'
  description: 'Operations tagged Backup Vaults across 2 of this provider''s published API definitions: aws-backup-openapi.yml, aws-backup-backup-vaults-api-openapi.yml. Each path carries the servers of the definition it was published in.'
servers:
- url: https://backup.{region}.amazonaws.com
  description: AWS Backup regional endpoint
  variables:
    region:
      default: us-east-1
      description: AWS region
tags:
- name: Backup Vaults
paths:
  /backup-vaults:
    get:
      tags:
      - Backup Vaults
      summary: List backup vaults
      operationId: ListBackupVaults
      parameters:
      - $ref: '#/components/parameters/MaxResults'
      - $ref: '#/components/parameters/NextToken'
      responses:
        '200':
          $ref: '#/components/responses/OK'
      security:
      - SigV4: []
    servers:
    - url: https://backup.{region}.amazonaws.com
      description: AWS Backup regional endpoint
      variables:
        region:
          default: us-east-1
          description: AWS region
  /backup-vaults/{backupVaultName}:
    put:
      tags:
      - Backup Vaults
      summary: Create a backup vault
      operationId: CreateBackupVault
      parameters:
      - $ref: '#/components/parameters/BackupVaultName'
      requestBody:
        $ref: '#/components/requestBodies/JsonBody'
      responses:
        '200':
          $ref: '#/components/responses/OK'
      security:
      - SigV4: []
    get:
      tags:
      - Backup Vaults
      summary: Describe a backup vault
      operationId: DescribeBackupVault
      parameters:
      - $ref: '#/components/parameters/BackupVaultName'
      responses:
        '200':
          $ref: '#/components/responses/OK'
      security:
      - SigV4: []
    delete:
      tags:
      - Backup Vaults
      summary: Delete a backup vault
      operationId: DeleteBackupVault
      parameters:
      - $ref: '#/components/parameters/BackupVaultName'
      responses:
        '200':
          $ref: '#/components/responses/OK'
      security:
      - SigV4: []
    servers:
    - url: https://backup.{region}.amazonaws.com
      description: AWS Backup regional endpoint
      variables:
        region:
          default: us-east-1
          description: AWS region
  /backup-vaults/{BackupVaultName}:
    put:
      operationId: putBackupVaultsByBackupVaultName
      summary: Create Backup Vault
      description: 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.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreateBackupVaultOutput'
        '400':
          description: AlreadyExistsException; InvalidParameterValueException; LimitExceededException; MissingParameterValueException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AlreadyExistsException'
        '500':
          description: ServiceUnavailableException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceUnavailableException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateBackupVaultInput'
      tags:
      - Backup Vaults
      security:
      - sigv4: []
      x-operation-id-source: normalized
      x-operation-id-original: CreateBackupVault
    delete:
      operationId: deleteBackupVaultsByBackupVaultName
      summary: Delete Backup Vault
      description: Deletes the backup vault identified by its name. A vault can be deleted only if it is empty.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: string
        '400':
          description: InvalidParameterValueException; InvalidRequestException; MissingParameterValueException; ResourceNotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InvalidParameterValueException'
        '500':
          description: ServiceUnavailableException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceUnavailableException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DeleteBackupVaultInput'
      tags:
      - Backup Vaults
      security:
      - sigv4: []
      x-operation-id-source: normalized
      x-operation-id-original: DeleteBackupVault
    get:
      operationId: getBackupVaultsByBackupVaultName
      summary: Describe Backup Vault
      description: Returns metadata about a backup vault specified by its name.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DescribeBackupVaultOutput'
        '400':
          description: InvalidParameterValueException; MissingParameterValueException; ResourceNotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InvalidParameterValueException'
        '500':
          description: ServiceUnavailableException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceUnavailableException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DescribeBackupVaultInput'
      tags:
      - Backup Vaults
      security:
      - sigv4: []
      x-operation-id-source: normalized
      x-operation-id-original: DescribeBackupVault
    servers:
    - url: https://backup.{region}.amazonaws.com
      variables:
        region:
          default: us-east-1
components:
  responses:
    OK:
      description: Successful response
      content:
        application/json:
          schema:
            type: object
            additionalProperties: true
  parameters:
    MaxResults:
      name: maxResults
      in: query
      schema:
        type: integer
        minimum: 1
        maximum: 1000
    BackupVaultName:
      name: backupVaultName
      in: path
      required: true
      schema:
        type: string
    NextToken:
      name: nextToken
      in: query
      schema:
        type: string
  requestBodies:
    JsonBody:
      required: true
      content:
        application/json:
          schema:
            type: object
            additionalProperties: true
  schemas:
    AlreadyExistsException:
      type: object
      properties:
        Code:
          type: string
        Message:
          type: string
        CreatorRequestId:
          type: string
        Arn:
          type: string
        Type:
          type: string
        Context:
          type: string
    ServiceUnavailableException:
      type: object
      properties:
        Code:
          type: string
        Message:
          type: string
        Type:
          type: string
        Context:
          type: string
    LatestMpaApprovalTeamUpdate:
      type: object
      properties:
        MpaSessionArn:
          type: string
          description: The ARN of the MPA session associated with this update.
        Status:
          type: string
          enum:
          - PENDING
          - APPROVED
          - FAILED
          description: The current status of the MPA approval team update.
        StatusMessage:
          type: string
          description: A message describing the current status of the MPA approval team update.
        InitiationDate:
          type: string
          format: date-time
          description: The date and time when the MPA approval team update was initiated.
        ExpiryDate:
          type: string
          format: date-time
          description: The date and time when the MPA approval team update will expire.
    InvalidParameterValueException:
      type: object
      properties:
        Code:
          type: string
        Message:
          type: string
        Type:
          type: string
        Context:
          type: string
    CreateBackupVaultOutput:
      type: object
      properties:
        BackupVaultName:
          type: string
          description: The name of a logical container where backups are stored. Backup vaults are identified by names that are unique to the account used to create them and the Region where they are created. They consist of lowercase letters, numbers, and hyphens.
        BackupVaultArn:
          type: string
          description: An Amazon Resource Name (ARN) that uniquely identifies a backup vault; for example, arn:aws:backup:us-east-1:123456789012:backup-vault:aBackupVault.
        CreationDate:
          type: string
          format: date-time
          description: The date and time a backup vault is created, in Unix format and Coordinated Universal Time (UTC). The value of CreationDate is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.
    DeleteBackupVaultInput:
      type: object
      properties:
        BackupVaultName:
          type: string
          description: The name of a logical container where backups are stored. Backup vaults are identified by names that are unique to the account used to create them and the Amazon Web Services Region where they are created.
      required:
      - BackupVaultName
    DescribeBackupVaultInput:
      type: object
      properties:
        BackupVaultName:
          type: string
          description: The name of a logical container where backups are stored. Backup vaults are identified by names that are unique to the account used to create them and the Amazon Web Services Region where they are created.
        BackupVaultAccountId:
          type: string
          description: The account ID of the specified backup vault.
      required:
      - BackupVaultName
    DescribeBackupVaultOutput:
      type: object
      properties:
        BackupVaultName:
          type: string
          description: The name of a logical container where backups are stored. Backup vaults are identified by names that are unique to the account used to create them and the Region where they are created.
        BackupVaultArn:
          type: string
          description: An Amazon Resource Name (ARN) that uniquely identifies a backup vault; for example, arn:aws:backup:us-east-1:123456789012:backup-vault:aBackupVault.
        VaultType:
          type: string
          enum:
          - BACKUP_VAULT
          - LOGICALLY_AIR_GAPPED_BACKUP_VAULT
          - RESTORE_ACCESS_BACKUP_VAULT
          description: The type of vault described.
        VaultState:
          type: string
          enum:
          - CREATING
          - AVAILABLE
          - FAILED
          description: The current state of the vault.->
        EncryptionKeyArn:
          type: string
          description: The server-side encryption key that is used to protect your backups; for example, arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab.
        CreationDate:
          type: string
          format: date-time
          description: The date and time that a backup vault is created, in Unix format and Coordinated Universal Time (UTC). The value of CreationDate is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.
        CreatorRequestId:
          type: string
          description: A unique string that identifies the request and allows failed requests to be retried without the risk of running the operation twice. This parameter is optional. If used, this parameter must contain 1 to 50 alphanumeric or '-_.' characters.
        NumberOfRecoveryPoints:
          type: integer
          description: The number of recovery points that are stored in a backup vault. Recovery point count value displayed in the console can be an approximation. Use ListRecoveryPointsByBackupVault API to obtain the exact count.
        Locked:
          type: boolean
          description: A Boolean that indicates whether Backup Vault Lock is currently protecting the backup vault. True means that Vault Lock causes delete or update operations on the recovery points stored in the vault to fail.
        MinRetentionDays:
          type: integer
          description: The Backup Vault Lock setting that specifies the minimum retention period that the vault retains its recovery points. If this parameter is not specified, Vault Lock will not enforce a minimum retention period. If specified, any backup or copy job to the vault must have a lifecycle policy with a retention period equal to or longer than the minimum retention period. If the job's retention period is shorter than that minimum retention period, then the vault fails the backup or copy job, and you should either modify your lifecycle settings or use a different vault. Recovery points already stored i
        MaxRetentionDays:
          type: integer
          description: The Backup Vault Lock setting that specifies the maximum retention period that the vault retains its recovery points. If this parameter is not specified, Vault Lock does not enforce a maximum retention period on the recovery points in the vault (allowing indefinite storage). If specified, any backup or copy job to the vault must have a lifecycle policy with a retention period equal to or shorter than the maximum retention period. If the job's retention period is longer than that maximum retention period, then the vault fails the backup or copy job, and you should either modify your lifecycle s
        LockDate:
          type: string
          format: date-time
          description: The date and time when Backup Vault Lock configuration cannot be changed or deleted. If you applied Vault Lock to your vault without specifying a lock date, you can change any of your Vault Lock settings, or delete Vault Lock from the vault entirely, at any time. This value is in Unix format, Coordinated Universal Time (UTC), and accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.
        SourceBackupVaultArn:
          type: string
          description: The ARN of the source backup vault from which this restore access backup vault was created.
        MpaApprovalTeamArn:
          type: string
          description: The ARN of the MPA approval team associated with this backup vault.
        MpaSessionArn:
          type: string
          description: The ARN of the MPA session associated with this backup vault.
        LatestMpaApprovalTeamUpdate:
          $ref: '#/components/schemas/LatestMpaApprovalTeamUpdate'
        EncryptionKeyType:
          type: string
          enum:
          - AWS_OWNED_KMS_KEY
          - CUSTOMER_MANAGED_KMS_KEY
          description: The type of encryption key used for the backup vault. Valid values are CUSTOMER_MANAGED_KMS_KEY for customer-managed keys or Amazon Web Services_OWNED_KMS_KEY for Amazon Web Services-owned keys.
    CreateBackupVaultInput:
      type: object
      properties:
        BackupVaultName:
          type: string
          description: The name of a logical container where backups are stored. Backup vaults are identified by names that are unique to the account used to create them and the Amazon Web Services Region where they are created. They consist of letters, numbers, and hyphens.
        BackupVaultTags:
          type: object
          additionalProperties:
            type: string
          description: The tags to assign to the backup vault.
        EncryptionKeyArn:
          type: string
          description: The server-side encryption key that is used to protect your backups; for example, arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab.
        CreatorRequestId:
          type: string
          description: A unique string that identifies the request and allows failed requests to be retried without the risk of running the operation twice. This parameter is optional. If used, this parameter must contain 1 to 50 alphanumeric or '-_.' characters.
      required:
      - BackupVaultName
  securitySchemes:
    SigV4:
      type: apiKey
      in: header
      name: Authorization
      description: AWS Signature Version 4 signed Authorization header
    sigv4:
      type: apiKey
      in: header
      name: Authorization
      description: AWS Signature Version 4. The Authorization header carries an AWS4-HMAC-SHA256 signature over the canonical request, with X-Amz-Date (and X-Amz-Security-Token for temporary credentials). Not a bearer token.
      x-aws-sigv4:
        signingName: backup
x-refined-from:
- aws-backup-openapi.yml
- aws-backup-backup-vaults-api-openapi.yml