DescribeJobDefinitions - Amazon Batch
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China (PDF).


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

Request Syntax

POST /v1/describejobdefinitions HTTP/1.1 Content-type: application/json { "jobDefinitionName": "string", "jobDefinitions": [ "string" ], "maxResults": number, "nextToken": "string", "status": "string" }

URI Request Parameters

The request does not use any URI parameters.

Request Body

The request accepts the following data in JSON format.


The name of the job definition to describe.

Type: String

Required: No


A list of up to 100 job definitions. Each entry in the list can either be an ARN in the format arn:aws:batch:${Region}:${Account}:job-definition/${JobDefinitionName}:${Revision} or a short version using the form ${JobDefinitionName}:${Revision}. This parameter can't be used with other parameters.

Type: Array of strings

Required: No


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

Type: Integer

Required: No


The nextToken value returned from a previous paginated DescribeJobDefinitions request where maxResults was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the nextToken value. This value is null when there are no more results to return.


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.

Type: String

Required: No


The status used to filter job definitions.

Type: String

Required: No

Response Syntax

HTTP/1.1 200 Content-type: application/json { "jobDefinitions": [ { "containerOrchestrationType": "string", "containerProperties": { "command": [ "string" ], "environment": [ { "name": "string", "value": "string" } ], "ephemeralStorage": { "sizeInGiB": number }, "executionRoleArn": "string", "fargatePlatformConfiguration": { "platformVersion": "string" }, "image": "string", "instanceType": "string", "jobRoleArn": "string", "linuxParameters": { "devices": [ { "containerPath": "string", "hostPath": "string", "permissions": [ "string" ] } ], "initProcessEnabled": boolean, "maxSwap": number, "sharedMemorySize": number, "swappiness": number, "tmpfs": [ { "containerPath": "string", "mountOptions": [ "string" ], "size": number } ] }, "logConfiguration": { "logDriver": "string", "options": { "string" : "string" }, "secretOptions": [ { "name": "string", "valueFrom": "string" } ] }, "memory": number, "mountPoints": [ { "containerPath": "string", "readOnly": boolean, "sourceVolume": "string" } ], "networkConfiguration": { "assignPublicIp": "string" }, "privileged": boolean, "readonlyRootFilesystem": boolean, "resourceRequirements": [ { "type": "string", "value": "string" } ], "runtimePlatform": { "cpuArchitecture": "string", "operatingSystemFamily": "string" }, "secrets": [ { "name": "string", "valueFrom": "string" } ], "ulimits": [ { "hardLimit": number, "name": "string", "softLimit": number } ], "user": "string", "vcpus": number, "volumes": [ { "efsVolumeConfiguration": { "authorizationConfig": { "accessPointId": "string", "iam": "string" }, "fileSystemId": "string", "rootDirectory": "string", "transitEncryption": "string", "transitEncryptionPort": number }, "host": { "sourcePath": "string" }, "name": "string" } ] }, "eksProperties": { "podProperties": { "containers": [ { "args": [ "string" ], "command": [ "string" ], "env": [ { "name": "string", "value": "string" } ], "image": "string", "imagePullPolicy": "string", "name": "string", "resources": { "limits": { "string" : "string" }, "requests": { "string" : "string" } }, "securityContext": { "privileged": boolean, "readOnlyRootFilesystem": boolean, "runAsGroup": number, "runAsNonRoot": boolean, "runAsUser": number }, "volumeMounts": [ { "mountPath": "string", "name": "string", "readOnly": boolean } ] } ], "dnsPolicy": "string", "hostNetwork": boolean, "metadata": { "labels": { "string" : "string" } }, "serviceAccountName": "string", "volumes": [ { "emptyDir": { "medium": "string", "sizeLimit": "string" }, "hostPath": { "path": "string" }, "name": "string", "secret": { "optional": boolean, "secretName": "string" } } ] } }, "jobDefinitionArn": "string", "jobDefinitionName": "string", "nodeProperties": { "mainNode": number, "nodeRangeProperties": [ { "container": { "command": [ "string" ], "environment": [ { "name": "string", "value": "string" } ], "ephemeralStorage": { "sizeInGiB": number }, "executionRoleArn": "string", "fargatePlatformConfiguration": { "platformVersion": "string" }, "image": "string", "instanceType": "string", "jobRoleArn": "string", "linuxParameters": { "devices": [ { "containerPath": "string", "hostPath": "string", "permissions": [ "string" ] } ], "initProcessEnabled": boolean, "maxSwap": number, "sharedMemorySize": number, "swappiness": number, "tmpfs": [ { "containerPath": "string", "mountOptions": [ "string" ], "size": number } ] }, "logConfiguration": { "logDriver": "string", "options": { "string" : "string" }, "secretOptions": [ { "name": "string", "valueFrom": "string" } ] }, "memory": number, "mountPoints": [ { "containerPath": "string", "readOnly": boolean, "sourceVolume": "string" } ], "networkConfiguration": { "assignPublicIp": "string" }, "privileged": boolean, "readonlyRootFilesystem": boolean, "resourceRequirements": [ { "type": "string", "value": "string" } ], "runtimePlatform": { "cpuArchitecture": "string", "operatingSystemFamily": "string" }, "secrets": [ { "name": "string", "valueFrom": "string" } ], "ulimits": [ { "hardLimit": number, "name": "string", "softLimit": number } ], "user": "string", "vcpus": number, "volumes": [ { "efsVolumeConfiguration": { "authorizationConfig": { "accessPointId": "string", "iam": "string" }, "fileSystemId": "string", "rootDirectory": "string", "transitEncryption": "string", "transitEncryptionPort": number }, "host": { "sourcePath": "string" }, "name": "string" } ] }, "targetNodes": "string" } ], "numNodes": number }, "parameters": { "string" : "string" }, "platformCapabilities": [ "string" ], "propagateTags": boolean, "retryStrategy": { "attempts": number, "evaluateOnExit": [ { "action": "string", "onExitCode": "string", "onReason": "string", "onStatusReason": "string" } ] }, "revision": number, "schedulingPriority": number, "status": "string", "tags": { "string" : "string" }, "timeout": { "attemptDurationSeconds": number }, "type": "string" } ], "nextToken": "string" }

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.


The list of job definitions.

Type: Array of JobDefinition objects


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

Type: String



These errors are usually caused by a client action. One example cause is using an action or resource on behalf of a user that doesn't have permissions to use the action or resource. Another cause is specifying an identifier that's not valid.

HTTP Status Code: 400


These errors are usually caused by a server issue.

HTTP Status Code: 500


In the following example or examples, the Authorization header contents ( [authorization-params] ) must be replaced with an Amazon Signature Version 4 signature. For more information about creating these signatures, see Signature Version 4 Signing Process in the Amazon General Reference.

You only need to learn how to sign HTTP requests if you intend to manually create them. When you use the Amazon Command Line Interface (Amazon CLI) or one of the Amazon SDKs to make requests to Amazon, these tools automatically sign the requests for you with the access key that you specify when you configure the tools. When you use these tools, you don't need to learn how to sign requests yourself.


This example describes all of your active job definitions.

Sample Request

POST /v1/describejobdefinitions HTTP/1.1 Host: Accept-Encoding: identity Content-Length: [content-length] Authorization: [authorization-params] X-Amz-Date: 20161128T221855Z User-Agent: aws-cli/1.11.21 Python/2.7.12 Darwin/16.1.0 botocore/1.4.78 { "status": "ACTIVE" }

Sample Response

HTTP/1.1 200 OK Content-Type: application/json Content-Length: [content-length] Connection: keep-alive Date: Mon, 28 Nov 2016 22:18:55 GMT x-amzn-RequestId: [request-id] X-Amzn-Trace-Id: [trace-id] X-Cache: Miss from cloudfront Via: 1.1 (CloudFront) X-Amz-Cf-Id: hd-CAMqfaCJt-1oH7tBu9j5c-IhLQuMjFHFPck6F0MMt5CBea8mQBQ== { "jobDefinitions": [{ "jobDefinitionName": "sleep60", "jobDefinitionArn": "arn:aws:batch:us-east-1:123456789012:job-definition/sleep60:1", "revision": 1, "status": "ACTIVE", "type": "container", "containerProperties": { "image": "busybox", "vcpus": 1, "memory": 128, "command": ["sleep", "60"], "volumes": [], "environment": [], "mountPoints": [], "ulimits": [] } }] }

See Also

For more information about using this API in one of the language-specific Amazon SDKs, see the following: