AWS Backup Report Plans API

The Report Plans API from AWS Backup — 1 operation(s) for report plans.

OpenAPI Specification

aws-backup-report-plans-api-openapi.yml Raw ↑
openapi: 3.1.0
info:
  title: AWS Backup Backup Jobs Report Plans 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: Report Plans
paths:
  /audit/report-plans:
    get:
      tags:
      - Report Plans
      summary: List report plans
      operationId: ListReportPlans
      responses:
        '200':
          $ref: '#/components/responses/OK'
    post:
      tags:
      - Report Plans
      summary: Create a report plan
      operationId: CreateReportPlan
      requestBody:
        $ref: '#/components/requestBodies/JsonBody'
      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
  securitySchemes:
    SigV4:
      type: apiKey
      in: header
      name: Authorization
      description: AWS Signature Version 4 signed Authorization header