AWS Batch Job Definitions API

The Job Definitions API from AWS Batch — 3 operation(s) for job definitions.

OpenAPI Specification

aws-batch-job-definitions-api-openapi.yml Raw ↑
openapi: 3.1.0
info:
  title: AWS Batch Compute Environments Job Definitions 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: Job Definitions
paths:
  /v1/registerjobdefinition:
    post:
      tags:
      - Job Definitions
      operationId: RegisterJobDefinition
      summary: Register a job definition
      requestBody:
        $ref: '#/components/requestBodies/JsonBody'
      responses:
        '200':
          $ref: '#/components/responses/OK'
  /v1/describejobdefinitions:
    post:
      tags:
      - Job Definitions
      operationId: DescribeJobDefinitions
      summary: Describe job definitions
      requestBody:
        $ref: '#/components/requestBodies/JsonBody'
      responses:
        '200':
          $ref: '#/components/responses/OK'
  /v1/deregisterjobdefinition:
    post:
      tags:
      - Job Definitions
      operationId: DeregisterJobDefinition
      summary: Deregister a job definition
      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