AWS Backup Jobs API

openapi: 3.2.0
info:
  title: Aws Backup Backup Jobs API
  version: '2018-11-15'
  description: 'Operations tagged Backup Jobs across 2 of this provider''s published API definitions: aws-backup-openapi.yml, aws-backup-backup-jobs-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 Jobs
paths:
  /backup-jobs:
    get:
      tags:
      - Backup Jobs
      summary: List backup jobs
      operationId: ListBackupJobs
      parameters:
      - $ref: '#/components/parameters/MaxResults'
      - $ref: '#/components/parameters/NextToken'
      responses:
        '200':
          $ref: '#/components/responses/OK'
      security:
      - SigV4: []
    put:
      tags:
      - Backup Jobs
      summary: Start a backup job
      operationId: StartBackupJob
      requestBody:
        $ref: '#/components/requestBodies/JsonBody'
      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-jobs/{backupJobId}:
    get:
      tags:
      - Backup Jobs
      summary: Describe a backup job
      operationId: DescribeBackupJob
      parameters:
      - $ref: '#/components/parameters/BackupJobId'
      responses:
        '200':
          $ref: '#/components/responses/OK'
      security:
      - SigV4: []
    post:
      tags:
      - Backup Jobs
      summary: Stop a backup job
      operationId: StopBackupJob
      parameters:
      - $ref: '#/components/parameters/BackupJobId'
      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-jobs/{BackupJobId}:
    get:
      operationId: getBackupJobsByBackupJobId
      summary: Describe Backup Job
      description: Returns backup job details for the specified BackupJobId.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DescribeBackupJobOutput'
        '500':
          description: DependencyFailureException; ServiceUnavailableException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DependencyFailureException'
        '400':
          description: InvalidParameterValueException; MissingParameterValueException; ResourceNotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InvalidParameterValueException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DescribeBackupJobInput'
      tags:
      - Backup Jobs
      security:
      - sigv4: []
      x-operation-id-source: normalized
      x-operation-id-original: DescribeBackupJob
    post:
      operationId: postBackupJobsByBackupJobId
      summary: Stop Backup Job
      description: 'Attempts to cancel a job to create a one-time backup of a resource. This action is not supported for the following services: Amazon Aurora Amazon DocumentDB (with MongoDB compatibility) Amazon FSx for Lustre Amazon FSx for NetApp ONTAP Amazon FSx for OpenZFS Amazon FSx for Windows File Server Amazon Neptune SAP HANA databases on Amazon EC2 instances Amazon RDS'
      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/StopBackupJobInput'
      tags:
      - Backup Jobs
      security:
      - sigv4: []
      x-operation-id-source: normalized
      x-operation-id-original: StopBackupJob
    servers:
    - url: https://backup.{region}.amazonaws.com
      variables:
        region:
          default: us-east-1
components:
  parameters:
    BackupJobId:
      name: backupJobId
      in: path
      required: true
      schema:
        type: string
    MaxResults:
      name: maxResults
      in: query
      schema:
        type: integer
        minimum: 1
        maximum: 1000
    NextToken:
      name: nextToken
      in: query
      schema:
        type: string
  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
  schemas:
    StopBackupJobInput:
      type: object
      properties:
        BackupJobId:
          type: string
          description: Uniquely identifies a request to Backup to back up a resource.
      required:
      - BackupJobId
    Lifecycle:
      type: object
      properties:
        MoveToColdStorageAfterDays:
          type: integer
          description: The number of days after creation that a recovery point is moved to cold storage.
        DeleteAfterDays:
          type: integer
          description: The number of days after creation that a recovery point is deleted. This value must be at least 90 days after the number of days specified in MoveToColdStorageAfterDays.
        OptInToArchiveForSupportedResources:
          type: boolean
          description: If the value is true, your backup plan transitions supported resources to archive (cold) storage tier in accordance with your lifecycle settings.
        DeleteAfterEvent:
          type: string
          enum:
          - DELETE_AFTER_COPY
          description: The event after which a recovery point is deleted. A recovery point with both DeleteAfterDays and DeleteAfterEvent will delete after whichever condition is satisfied first. Not valid as an input.
    ServiceUnavailableException:
      type: object
      properties:
        Code:
          type: string
        Message:
          type: string
        Type:
          type: string
        Context:
          type: string
    RecoveryPointCreator:
      type: object
      properties:
        BackupPlanId:
          type: string
          description: Uniquely identifies a backup plan.
        BackupPlanArn:
          type: string
          description: An Amazon Resource Name (ARN) that uniquely identifies a backup plan; for example, arn:aws:backup:us-east-1:123456789012:plan:8F81F553-3A74-4A3F-B93D-B3360DC80C50.
        BackupPlanName:
          type: string
          description: The name of the backup plan that created this recovery point. This provides human-readable context about which backup plan was responsible for the backup job.
        BackupPlanVersion:
          type: string
          description: Version IDs are unique, randomly generated, Unicode, UTF-8 encoded strings that are at most 1,024 bytes long. They cannot be edited.
        BackupRuleId:
          type: string
          description: Uniquely identifies a rule used to schedule the backup of a selection of resources.
        BackupRuleName:
          type: string
          description: The name of the backup rule within the backup plan that created this recovery point. This helps identify which specific rule triggered the backup job.
        BackupRuleCron:
          type: string
          description: The cron expression that defines the schedule for the backup rule. This shows the frequency and timing of when backups are automatically triggered.
        BackupRuleTimezone:
          type: string
          description: The timezone used for the backup rule schedule. This provides context for when backups are scheduled to run in the specified timezone.
    DescribeBackupJobOutput:
      type: object
      properties:
        AccountId:
          type: string
          description: Returns the account ID that owns the backup job.
        BackupJobId:
          type: string
          description: Uniquely identifies a request to Backup to back up a resource.
        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.
        RecoveryPointLifecycle:
          $ref: '#/components/schemas/Lifecycle'
        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
          description: The type of backup vault where the recovery point is stored. Valid values are BACKUP_VAULT for standard backup vaults and LOGICALLY_AIR_GAPPED_BACKUP_VAULT for logically air-gapped vaults.
        VaultLockState:
          type: string
          description: The lock state of the backup vault. For logically air-gapped vaults, this indicates whether the vault is locked in compliance mode. Valid values include LOCKED and UNLOCKED.
        RecoveryPointArn:
          type: string
          description: An ARN that uniquely identifies a recovery point; for example, arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45.
        EncryptionKeyArn:
          type: string
          description: The Amazon Resource Name (ARN) of the KMS key used to encrypt the backup. This can be a customer-managed key or an Amazon Web Services managed key, depending on the vault configuration.
        IsEncrypted:
          type: boolean
          description: A boolean value indicating whether the backup is encrypted. All backups in Backup are encrypted, but this field indicates the encryption status for transparency.
        ResourceArn:
          type: string
          description: An ARN that uniquely identifies a saved resource. The format of the ARN depends on the resource type.
        CreationDate:
          type: string
          format: date-time
          description: The date and time that a backup job 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.
        CompletionDate:
          type: string
          format: date-time
          description: The date and time that a job to create a backup job is completed, in Unix format and Coordinated Universal Time (UTC). The value of CompletionDate is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.
        State:
          type: string
          enum:
          - CREATED
          - PENDING
          - RUNNING
          - ABORTING
          - ABORTED
          - COMPLETED
          - FAILED
          - EXPIRED
          - PARTIAL
          description: The current state of a backup job.
        StatusMessage:
          type: string
          description: A detailed message explaining the status of the job to back up a resource.
        PercentDone:
          type: string
          description: Contains an estimated percentage that is complete of a job at the time the job status was queried.
        BackupSizeInBytes:
          type: integer
          description: 'The size, in bytes, of a backup (recovery point). This value can render differently depending on the resource type as Backup pulls in data information from other Amazon Web Services services. For example, the value returned may show a value of 0, which may differ from the anticipated value. The expected behavior for values by resource type are described as follows: Amazon Aurora, Amazon DocumentDB, and Amazon Neptune do not have this value populate from the operation GetBackupJobStatus. For Amazon DynamoDB with advanced features, this value refers to the size of the recovery point (backup). Am'
        IamRoleArn:
          type: string
          description: Specifies the IAM role ARN used to create the target recovery point; for example, arn:aws:iam::123456789012:role/S3Access.
        CreatedBy:
          $ref: '#/components/schemas/RecoveryPointCreator'
        ResourceType:
          type: string
          description: The type of Amazon Web Services resource to be backed up; for example, an Amazon Elastic Block Store (Amazon EBS) volume or an Amazon Relational Database Service (Amazon RDS) database.
        BytesTransferred:
          type: integer
          description: The size in bytes transferred to a backup vault at the time that the job status was queried.
        ExpectedCompletionDate:
          type: string
          format: date-time
          description: The date and time that a job to back up resources is expected to be completed, in Unix format and Coordinated Universal Time (UTC). The value of ExpectedCompletionDate is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.
        StartBy:
          type: string
          format: date-time
          description: Specifies the time in Unix format and Coordinated Universal Time (UTC) when a backup job must be started before it is canceled. The value is calculated by adding the start window to the scheduled time. So if the scheduled time were 6:00 PM and the start window is 2 hours, the StartBy time would be 8:00 PM on the date specified. The value of StartBy is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.
        BackupOptions:
          type: object
          additionalProperties:
            type: string
          description: Represents the options specified as part of backup plan or on-demand backup job.
        BackupType:
          type: string
          description: Represents the actual backup type selected for a backup job. For example, if a successful Windows Volume Shadow Copy Service (VSS) backup was taken, BackupType returns "WindowsVSS". If BackupType is empty, then the backup type was a regular backup.
        ParentJobId:
          type: string
          description: This returns the parent (composite) resource backup job ID.
        IsParent:
          type: boolean
          description: This returns the boolean value that a backup job is a parent (composite) job.
        NumberOfChildJobs:
          type: integer
          description: This returns the number of child (nested) backup jobs.
        ChildJobsInState:
          type: object
          additionalProperties:
            type: integer
          description: This returns the statistics of the included child (nested) backup jobs.
        ResourceName:
          type: string
          description: The non-unique name of the resource that belongs to the specified backup.
        InitiationDate:
          type: string
          format: date-time
          description: The date a backup job was initiated.
        MessageCategory:
          type: string
          description: The job count for the specified message category. Example strings may include AccessDenied, SUCCESS, AGGREGATE_ALL, and INVALIDPARAMETERS. View Monitoring for a list of accepted MessageCategory strings.
    InvalidParameterValueException:
      type: object
      properties:
        Code:
          type: string
        Message:
          type: string
        Type:
          type: string
        Context:
          type: string
    DependencyFailureException:
      type: object
      properties:
        Code:
          type: string
        Message:
          type: string
        Type:
          type: string
        Context:
          type: string
    DescribeBackupJobInput:
      type: object
      properties:
        BackupJobId:
          type: string
          description: Uniquely identifies a request to Backup to back up a resource.
      required:
      - BackupJobId
  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-jobs-api-openapi.yml