openapi: 3.1.0
info:
  title: Amazon Batch AWS Batch Compute Environments Jobs API
  description: The AWS Batch API enables programmatic management of batch computing workloads, including creating compute environments, job queues, job definitions, scheduling policies, and submitting and monitoring jobs at any scale.
  version: '2016-08-10'
  contact:
    name: AWS Support
    url: https://aws.amazon.com/premiumsupport/
  license:
    name: Apache 2.0
    url: https://www.apache.org/licenses/LICENSE-2.0.html
  x-logo:
    url: https://a0.awsstatic.com/libra-css/images/logos/aws_logo_smile_1200x630.png
servers:
- url: https://batch.{region}.amazonaws.com
  description: AWS Batch regional endpoint
  variables:
    region:
      default: us-east-1
      description: AWS region
      enum:
      - us-east-1
      - us-east-2
      - us-west-1
      - us-west-2
      - eu-west-1
      - eu-west-2
      - eu-west-3
      - eu-central-1
      - ap-northeast-1
      - ap-northeast-2
      - ap-southeast-1
      - ap-southeast-2
      - ap-south-1
      - sa-east-1
      - ca-central-1
security:
- sigv4: []
tags:
- name: Jobs
  description: Operations for submitting and managing jobs
paths:
  /v1/submitjob:
    post:
      operationId: SubmitJob
      summary: Amazon Batch Submit a batch job
      description: Submits an AWS Batch job from a job definition.
      tags:
      - Jobs
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SubmitJobInput'
      responses:
        '200':
          description: Job submitted successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SubmitJobOutput'
        '400':
          description: Invalid request
        '500':
          description: Internal server error
components:
  schemas:
    SubmitJobOutput:
      type: object
      properties:
        jobArn:
          type: string
        jobName:
          type: string
        jobId:
          type: string
    SubmitJobInput:
      type: object
      required:
      - jobName
      - jobQueue
      - jobDefinition
      properties:
        jobName:
          type: string
          description: The name of the job
        jobQueue:
          type: string
          description: The job queue to submit to
        jobDefinition:
          type: string
          description: The job definition to use
        parameters:
          type: object
          additionalProperties:
            type: string
        containerOverrides:
          type: object
  securitySchemes:
    sigv4:
      type: apiKey
      name: Authorization
      in: header
      description: AWS Signature Version 4