Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

AWS Batch Jobs API

The Jobs API from AWS Batch — 5 operation(s) for jobs.

AWS Batch Jobs API is one of 7 APIs that AWS Batch publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Jobs. The published artifact set on APIs.io includes an OpenAPI specification.

This API exposes 5 operations across 5 paths. It is described by OpenAPI 3.1.0, at version 2016-08-10.

Requests are made against a single base URL, https://batch.{region}.amazonaws.com.

5 operations 5 paths 0 schemas 5 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
2016-08-10
Base URL
https://batch.us-east-1.amazonaws.com
Authentication
API Key
Resource Areas
1

Authentication & Security 1

AWS Batch Jobs API declares 1 security scheme for authenticating requests. An API key is passed in the header as Authorization (SigV4). By default, every request must be authenticated.

  • SigV4 — AWS Signature Version 4 signed Authorization header

Paths & Operations 5

Across 5 paths, the API surfaces 5 operations — 5 POST. Each is listed below with its method, path, parameters, and response codes.

Jobs 5
POST
/v1/submitjob
Submit a job
SubmitJob body → 200
POST
/v1/listjobs
List jobs
ListJobs body → 200
POST
/v1/describejobs
Describe jobs
DescribeJobs body → 200
POST
/v1/canceljob
Cancel a job
CancelJob body → 200
POST
/v1/terminatejob
Terminate a job
TerminateJob body → 200

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

aws-batch-jobs-api-openapi.yml Raw ↑

Other APIs AWS Batch publishes across the network.

AWS Batch API
AWS Batch Compute Environments API
AWS Batch Job Definitions API
AWS Batch Job Queues API
AWS Batch Scheduling Policies API
AWS Batch Tags API