v1

latestOpenAPI 3.1.0Apache 2.02026-07-17870411.0 KB
AWS Batch

List AWS Batch job definitions visible to this EDH environment

Retrieves AWS Batch job definitions that are tagged with the EDH visibility tag for this cluster. If a specific job definition name is provided, only that definition is returned (if it has the correct tag). Otherwise, all matching definitions are returned with pagination handled automatically.

get/api/containers/batch/job_definition

Query parameters

job_definitionstring

Name of a specific job definition to look up. If omitted, all visible job definitions are returned.

status'ACTIVE' | 'INACTIVE'

Filter job definitions by status

Headers

X-EDH-USERstring required

EDH username for authentication

X-EDH-TOKENstring required

EDH authentication token

Response

Job definitions retrieved successfully

successboolean required

Example response

{
  "success": true,
  "message": [
    {
      "jobDefinitionName": "my-job-def",
      "jobDefinitionArn": "arn:aws:batch:us-east-1:123456789012:job-definition/my-job-def:1",
      "revision": 1,
      "status": "ACTIVE",
      "type": "container"
    }
  ]
}