AWS Backup Frameworks API

openapi: 3.1.0
info:
  title: AWS Backup Frameworks API
  version: '2018-11-15'
  description: Generated from AWS's published Smithy model for AWS Backup. 2 operation(s).
  contact:
    name: Amazon Web Services
    url: https://aws.amazon.com/contact-us/
  license:
    name: Apache 2.0
    identifier: Apache-2.0
    url: https://github.com/aws/api-models-aws/blob/main/LICENSE
servers:
- url: https://backup.{region}.amazonaws.com
  variables:
    region:
      default: us-east-1
security:
- sigv4: []
paths:
  /audit/frameworks:
    post:
      operationId: CreateFramework
      summary: Create Framework
      description: Creates a framework with one or more controls. A framework is a collection of controls that you can use
        to evaluate your backup practices. By using pre-built customizable controls to define your policies, you can evaluate
        whether your backup practices comply with your policies and which resources are not yet in compliance.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreateFrameworkOutput'
        '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/CreateFrameworkInput'
      tags:
      - Frameworks
    get:
      operationId: ListFrameworks
      summary: List Frameworks
      description: Returns a list of all frameworks for an Amazon Web Services account and Amazon Web Services Region.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListFrameworksOutput'
        '400':
          description: InvalidParameterValueException
          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/ListFrameworksInput'
      tags:
      - Frameworks
components:
  securitySchemes:
    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
  schemas:
    AlreadyExistsException:
      type: object
      properties:
        Code:
          type: string
        Message:
          type: string
        CreatorRequestId:
          type: string
        Arn:
          type: string
        Type:
          type: string
        Context:
          type: string
    ControlInputParameter:
      type: object
      properties:
        ParameterName:
          type: string
          description: The name of a parameter, for example, BackupPlanFrequency.
        ParameterValue:
          type: string
          description: The value of parameter, for example, hourly.
    ControlScope:
      type: object
      properties:
        ComplianceResourceIds:
          type: array
          items:
            type: string
          description: The ID of the only Amazon Web Services resource that you want your control scope to contain.
        ComplianceResourceTypes:
          type: array
          items:
            type: string
          description: Describes whether the control scope includes one or more types of resources, such as EFS or RDS.
        Tags:
          type: object
          additionalProperties:
            type: string
          description: 'The tag key-value pair applied to those Amazon Web Services resources that you want to trigger an
            evaluation for a rule. A maximum of one key-value pair can be provided. The tag value is optional, but it cannot
            be an empty string if you are creating or editing a framework from the console (though the value can be an empty
            string when included in a CloudFormation template). The structure to assign a tag is: [{"Key":"string","Value":"string"}].'
    CreateFrameworkInput:
      type: object
      properties:
        FrameworkName:
          type: string
          description: The unique name of the framework. The name must be between 1 and 256 characters, starting with a letter,
            and consisting of letters (a-z, A-Z), numbers (0-9), and underscores (_).
        FrameworkDescription:
          type: string
          description: An optional description of the framework with a maximum of 1,024 characters.
        FrameworkControls:
          type: array
          items:
            $ref: '#/components/schemas/FrameworkControl'
          description: The controls that make up the framework. Each control in the list has a name, input parameters, and
            scope.
        IdempotencyToken:
          type: string
          description: A customer-chosen string that you can use to distinguish between otherwise identical calls to CreateFrameworkInput.
            Retrying a successful request with the same idempotency token results in a success message with no action taken.
        FrameworkTags:
          type: object
          additionalProperties:
            type: string
          description: The tags to assign to the framework.
      required:
      - FrameworkName
      - FrameworkControls
    CreateFrameworkOutput:
      type: object
      properties:
        FrameworkName:
          type: string
          description: The unique name of the framework. The name must be between 1 and 256 characters, starting with a letter,
            and consisting of letters (a-z, A-Z), numbers (0-9), and underscores (_).
        FrameworkArn:
          type: string
          description: An Amazon Resource Name (ARN) that uniquely identifies a resource. The format of the ARN depends on
            the resource type.
    Framework:
      type: object
      properties:
        FrameworkName:
          type: string
          description: The unique name of a framework. This name is between 1 and 256 characters, starting with a letter,
            and consisting of letters (a-z, A-Z), numbers (0-9), and underscores (_).
        FrameworkArn:
          type: string
          description: An Amazon Resource Name (ARN) that uniquely identifies a resource. The format of the ARN depends on
            the resource type.
        FrameworkDescription:
          type: string
          description: An optional description of the framework with a maximum 1,024 characters.
        NumberOfControls:
          type: integer
          description: The number of controls contained by the framework.
        CreationTime:
          type: string
          format: date-time
          description: The date and time that a framework is created, in ISO 8601 representation. The value of CreationTime
            is accurate to milliseconds. For example, 2020-07-10T15:00:00.000-08:00 represents the 10th of July 2020 at 3:00
            PM 8 hours behind UTC.
        DeploymentStatus:
          type: string
          description: 'The deployment status of a framework. The statuses are: CREATE_IN_PROGRESS | UPDATE_IN_PROGRESS |
            DELETE_IN_PROGRESS | COMPLETED | FAILED'
    FrameworkControl:
      type: object
      properties:
        ControlName:
          type: string
          description: The name of a control. This name is between 1 and 256 characters.
        ControlInputParameters:
          type: array
          items:
            $ref: '#/components/schemas/ControlInputParameter'
          description: The name/value pairs.
        ControlScope:
          $ref: '#/components/schemas/ControlScope'
      required:
      - ControlName
    InvalidParameterValueException:
      type: object
      properties:
        Code:
          type: string
        Message:
          type: string
        Type:
          type: string
        Context:
          type: string
    ListFrameworksInput:
      type: object
      properties:
        MaxResults:
          type: integer
          description: The number of desired results from 1 to 1000. Optional. If unspecified, the query will return 1 MB
            of data.
        NextToken:
          type: string
          description: An identifier that was returned from the previous call to this operation, which can be used to return
            the next set of items in the list.
    ListFrameworksOutput:
      type: object
      properties:
        Frameworks:
          type: array
          items:
            $ref: '#/components/schemas/Framework'
          description: The frameworks with details for each framework, including the framework name, Amazon Resource Name
            (ARN), description, number of controls, creation time, and deployment status.
        NextToken:
          type: string
          description: An identifier that was returned from the previous call to this operation, which can be used to return
            the next set of items in the list.
    ServiceUnavailableException:
      type: object
      properties:
        Code:
          type: string
        Message:
          type: string
        Type:
          type: string
        Context:
          type: string
x-provenance:
  method: harvested
  publisher: Amazon Web Services
  source: https://raw.githubusercontent.com/aws/api-models-aws/3cd98287b471c106254abd89279cc87308d38bfd/models/backup/service/2018-11-15/backup-2018-11-15.json
  note: converted by smithy-to-openapi.py from AWS's Smithy model (roadmap#1001)