Sign in

v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-1424200374.6 KB

Describes a list of job definitions. You can specify a <code>status</code> (such as <code>ACTIVE</code>) to only return job definitions that match that status.

post/v1/describejobdefinitions

Query parameters

maxResultsstring

Pagination limit

nextTokenstring

Pagination token

Request body

jobDefinitionsString[]

A list of up to 100 job definitions. Each entry in the list can either be an ARN in the format <code>arn:aws:batch:${Region}:${Account}:job-definition/${JobDefinitionName}:${Revision}</code> or a short version using the form <code>${JobDefinitionName}:${Revision}</code>.

maxResultsinteger

The maximum number of results returned by <code>DescribeJobDefinitions</code> in paginated output. When this parameter is used, <code>DescribeJobDefinitions</code> only returns <code>maxResults</code> results in a single page and a <code>nextToken</code> response element. The remaining results of the initial request can be seen by sending another <code>DescribeJobDefinitions</code> request with the returned <code>nextToken</code> value. This value can be between 1 and 100. If this parameter isn't used, then <code>DescribeJobDefinitions</code> returns up to 100 results and a <code>nextToken</code> value if applicable.

jobDefinitionNamestring

The name of the job definition to describe.

statusstring

The status used to filter job definitions.

nextTokenstring
<p>The <code>nextToken</code> value returned from a previous paginated <code>DescribeJobDefinitions</code> request where <code>maxResults</code> was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the <code>nextToken</code> value. This value is <code>null</code> when there are no more results to return.</p> <note> <p>Treat this token as an opaque identifier that's only used to retrieve the next items in a list and not for other programmatic purposes.</p> </note>

Response

Success

nextTokenstring

The <code>nextToken</code> value to include in a future <code>DescribeJobDefinitions</code> request. When the results of a <code>DescribeJobDefinitions</code> request exceed <code>maxResults</code>, this value can be used to retrieve the next page of results. This value is <code>null</code> when there are no more results to return.

Example response

{
  "jobDefinitions": [
    {
      "type": "container",
      "containerProperties": {
        "command": [
          "sleep",
          "60"
        ],
        "environment": [],
        "image": "busybox",
        "mountPoints": [],
        "resourceRequirements": [
          {
            "type": "MEMORY",
            "value": "128"
          },
          {
            "type": "VCPU",
            "value": "1"
          }
        ],
        "ulimits": [],
        "volumes": []
      },
      "jobDefinitionArn": "arn:aws:batch:us-east-1:012345678910:job-definition/sleep60:1",
      "jobDefinitionName": "sleep60",
      "revision": 1,
      "status": "ACTIVE"
    }
  ]
}