AWS Batch Jobs API

openapi: 3.1.0
info:
  title: AWS Batch Compute Environments Jobs API
  version: '2016-08-10'
  description: 'AWS Batch enables developers to run batch and machine-learning compute

    jobs efficiently on AWS by dynamically provisioning the optimal quantity

    and type of compute resources. The API provides operations for managing

    compute environments, job queues, job definitions, scheduling policies,

    and submitting/terminating jobs. All requests are signed with AWS

    Signature Version 4 (SigV4).


    See https://docs.aws.amazon.com/batch/latest/APIReference/Welcome.html

    for full reference.

    '
servers:
- url: https://batch.{region}.amazonaws.com
  description: AWS Batch regional endpoint
  variables:
    region:
      default: us-east-1
security:
- SigV4: []
tags:
- name: Jobs
paths:
  /v1/submitjob:
    post:
      tags:
      - Jobs
      operationId: SubmitJob
      summary: Submit a job
      requestBody:
        $ref: '#/components/requestBodies/JsonBody'
      responses:
        '200':
          $ref: '#/components/responses/OK'
  /v1/listjobs:
    post:
      tags:
      - Jobs
      operationId: ListJobs
      summary: List jobs
      requestBody:
        $ref: '#/components/requestBodies/JsonBody'
      responses:
        '200':
          $ref: '#/components/responses/OK'
  /v1/describejobs:
    post:
      tags:
      - Jobs
      operationId: DescribeJobs
      summary: Describe jobs
      requestBody:
        $ref: '#/components/requestBodies/JsonBody'
      responses:
        '200':
          $ref: '#/components/responses/OK'
  /v1/canceljob:
    post:
      tags:
      - Jobs
      operationId: CancelJob
      summary: Cancel a job
      requestBody:
        $ref: '#/components/requestBodies/JsonBody'
      responses:
        '200':
          $ref: '#/components/responses/OK'
  /v1/terminatejob:
    post:
      tags:
      - Jobs
      operationId: TerminateJob
      summary: Terminate a job
      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