AWS Batch Scheduling Policies API

The Scheduling Policies API from AWS Batch — 5 operation(s) for scheduling policies.

OpenAPI Specification

aws-batch-scheduling-policies-api-openapi.yml Raw ↑
openapi: 3.1.0
info:
  title: AWS Batch Compute Environments Scheduling Policies 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: Scheduling Policies
paths:
  /v1/createschedulingpolicy:
    post:
      tags:
      - Scheduling Policies
      operationId: CreateSchedulingPolicy
      summary: Create a scheduling policy
      requestBody:
        $ref: '#/components/requestBodies/JsonBody'
      responses:
        '200':
          $ref: '#/components/responses/OK'
  /v1/describeschedulingpolicies:
    post:
      tags:
      - Scheduling Policies
      operationId: DescribeSchedulingPolicies
      summary: Describe scheduling policies
      requestBody:
        $ref: '#/components/requestBodies/JsonBody'
      responses:
        '200':
          $ref: '#/components/responses/OK'
  /v1/listschedulingpolicies:
    post:
      tags:
      - Scheduling Policies
      operationId: ListSchedulingPolicies
      summary: List scheduling policies
      requestBody:
        $ref: '#/components/requestBodies/JsonBody'
      responses:
        '200':
          $ref: '#/components/responses/OK'
  /v1/updateschedulingpolicy:
    post:
      tags:
      - Scheduling Policies
      operationId: UpdateSchedulingPolicy
      summary: Update a scheduling policy
      requestBody:
        $ref: '#/components/requestBodies/JsonBody'
      responses:
        '200':
          $ref: '#/components/responses/OK'
  /v1/deleteschedulingpolicy:
    post:
      tags:
      - Scheduling Policies
      operationId: DeleteSchedulingPolicy
      summary: Delete a scheduling policy
      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