AWS Backup Backup Vaults API

The Backup Vaults API from AWS Backup — 2 operation(s) for backup vaults.

OpenAPI Specification

aws-backup-backup-vaults-api-openapi.yml Raw ↑
openapi: 3.1.0
info:
  title: AWS Backup Backup Jobs Backup Vaults API
  version: '2018-11-15'
  description: 'AWS Backup is a fully managed, policy-based data protection service that

    centralizes and automates backup of data across AWS services. The AWS

    Backup API exposes REST operations for managing backup plans, backup

    selections, backup vaults, recovery points, restore jobs, and audit

    frameworks. All requests are signed with AWS Signature Version 4 (SigV4).


    See https://docs.aws.amazon.com/aws-backup/latest/devguide/api-reference.html

    for the full reference.

    '
  contact:
    name: AWS Backup Documentation
    url: https://docs.aws.amazon.com/aws-backup/
servers:
- url: https://backup.{region}.amazonaws.com
  description: AWS Backup regional endpoint
  variables:
    region:
      default: us-east-1
      description: AWS region
security:
- SigV4: []
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'
  /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'
    get:
      tags:
      - Backup Vaults
      summary: Describe a backup vault
      operationId: DescribeBackupVault
      parameters:
      - $ref: '#/components/parameters/BackupVaultName'
      responses:
        '200':
          $ref: '#/components/responses/OK'
    delete:
      tags:
      - Backup Vaults
      summary: Delete a backup vault
      operationId: DeleteBackupVault
      parameters:
      - $ref: '#/components/parameters/BackupVaultName'
      responses:
        '200':
          $ref: '#/components/responses/OK'
components:
  responses:
    OK:
      description: Successful response
      content:
        application/json:
          schema:
            type: object
            additionalProperties: true
  requestBodies:
    JsonBody:
      required: true
      content:
        application/json:
          schema:
            type: object
            additionalProperties: true
  parameters:
    BackupVaultName:
      name: backupVaultName
      in: path
      required: true
      schema:
        type: string
    NextToken:
      name: nextToken
      in: query
      schema:
        type: string
    MaxResults:
      name: maxResults
      in: query
      schema:
        type: integer
        minimum: 1
        maximum: 1000
  securitySchemes:
    SigV4:
      type: apiKey
      in: header
      name: Authorization
      description: AWS Signature Version 4 signed Authorization header