0% found this document useful (0 votes)

40 views437 pages

Batch Api

The document is the API Reference for AWS Batch, detailing various actions such as creating, deleting, and managing job queues and compute environments. It includes request syntax, URI parameters, response elements, and error handling for each action. The document serves as a comprehensive guide for developers using AWS Batch services.

Uploaded by

jaime

We take content rights seriously. If you suspect this is your content, claim it here.

Available Formats

Download as PDF, TXT or read online on Scribd

0% found this document useful (0 votes)

40 views437 pages

Batch Api

Uploaded by

jaime

We take content rights seriously. If you suspect this is your content, claim it here.

Available Formats

Download as PDF, TXT or read online on Scribd

You are on page 1/ 437

API Reference

AWS Batch

API Version 2016-08-10

AWS Batch: API Reference

Amazon's trademarks and trade dress may not be used in connection with any product or service
that is not Amazon's, in any manner that is likely to cause confusion among customers, or in any
manner that disparages or discredits Amazon. All other trademarks not owned by Amazon are
the property of their respective owners, who may or may not be aﬃliated with, connected to, or
sponsored by Amazon.
AWS Batch API Reference

Table of Contents
Welcome ........................................................................................................................................... 1
Actions .............................................................................................................................................. 2
CancelJob ....................................................................................................................................................... 3
Request Syntax ........................................................................................................................................ 3
URI Request Parameters ........................................................................................................................ 3
Request Body ........................................................................................................................................... 3
Response Syntax ...................................................................................................................................... 4
Response Elements ................................................................................................................................. 4
Errors .......................................................................................................................................................... 4
Examples ................................................................................................................................................... 4
See Also ..................................................................................................................................................... 6
CreateComputeEnvironment ...................................................................................................................... 7
Request Syntax ........................................................................................................................................ 9
URI Request Parameters ...................................................................................................................... 10
Request Body ......................................................................................................................................... 10
Response Syntax ................................................................................................................................... 14
Response Elements ............................................................................................................................... 14
Errors ....................................................................................................................................................... 14
Examples ................................................................................................................................................. 15
See Also .................................................................................................................................................. 18
CreateJobQueue ......................................................................................................................................... 20
Request Syntax ...................................................................................................................................... 20
URI Request Parameters ...................................................................................................................... 20
Request Body ......................................................................................................................................... 21
Response Syntax ................................................................................................................................... 23
Response Elements ............................................................................................................................... 23
Errors ....................................................................................................................................................... 24
Examples ................................................................................................................................................. 24
See Also .................................................................................................................................................. 26
CreateSchedulingPolicy ............................................................................................................................. 28
Request Syntax ...................................................................................................................................... 28
URI Request Parameters ...................................................................................................................... 28
Request Body ......................................................................................................................................... 28
Response Syntax ................................................................................................................................... 29

API Version 2016-08-10 iii

AWS Batch API Reference

Response Elements ............................................................................................................................... 29

Errors ....................................................................................................................................................... 30
Examples ................................................................................................................................................. 30
See Also .................................................................................................................................................. 32
DeleteComputeEnvironment .................................................................................................................... 34
Request Syntax ...................................................................................................................................... 34
URI Request Parameters ...................................................................................................................... 34
Request Body ......................................................................................................................................... 34
Response Syntax ................................................................................................................................... 34
Response Elements ............................................................................................................................... 35
Errors ....................................................................................................................................................... 35
Examples ................................................................................................................................................. 35
See Also .................................................................................................................................................. 36
DeleteJobQueue ......................................................................................................................................... 38
Request Syntax ...................................................................................................................................... 38
URI Request Parameters ...................................................................................................................... 38
Request Body ......................................................................................................................................... 38
Response Syntax ................................................................................................................................... 38
Response Elements ............................................................................................................................... 39
Errors ....................................................................................................................................................... 39
Examples ................................................................................................................................................. 39
See Also .................................................................................................................................................. 40
DeleteSchedulingPolicy ............................................................................................................................. 42
Request Syntax ...................................................................................................................................... 42
URI Request Parameters ...................................................................................................................... 42
Request Body ......................................................................................................................................... 42
Response Syntax ................................................................................................................................... 42
Response Elements ............................................................................................................................... 42
Errors ....................................................................................................................................................... 43
Examples ................................................................................................................................................. 43
See Also .................................................................................................................................................. 44
DeregisterJobDeﬁnition ............................................................................................................................ 46
Request Syntax ...................................................................................................................................... 46
URI Request Parameters ...................................................................................................................... 46
Request Body ......................................................................................................................................... 46
Response Syntax ................................................................................................................................... 46

API Version 2016-08-10 iv

AWS Batch API Reference

Response Elements ............................................................................................................................... 46

Errors ....................................................................................................................................................... 47
Examples ................................................................................................................................................. 47
See Also .................................................................................................................................................. 48
DescribeComputeEnvironments .............................................................................................................. 49
Request Syntax ...................................................................................................................................... 49
URI Request Parameters ...................................................................................................................... 49
Request Body ......................................................................................................................................... 49
Response Syntax ................................................................................................................................... 50
Response Elements ............................................................................................................................... 52
Errors ....................................................................................................................................................... 52
Examples ................................................................................................................................................. 53
See Also .................................................................................................................................................. 54
DescribeJobDeﬁnitions .............................................................................................................................. 56
Request Syntax ...................................................................................................................................... 56
URI Request Parameters ...................................................................................................................... 56
Request Body ......................................................................................................................................... 56
Response Syntax ................................................................................................................................... 58
Response Elements ............................................................................................................................... 74
Errors ....................................................................................................................................................... 75
Examples ................................................................................................................................................. 75
See Also .................................................................................................................................................. 77
DescribeJobQueues .................................................................................................................................... 78
Request Syntax ...................................................................................................................................... 78
URI Request Parameters ...................................................................................................................... 78
Request Body ......................................................................................................................................... 78
Response Syntax ................................................................................................................................... 79
Response Elements ............................................................................................................................... 80
Errors ....................................................................................................................................................... 80
Examples ................................................................................................................................................. 81
See Also .................................................................................................................................................. 82
DescribeJobs ................................................................................................................................................ 84
Request Syntax ...................................................................................................................................... 84
URI Request Parameters ...................................................................................................................... 84
Request Body ......................................................................................................................................... 84
Response Syntax ................................................................................................................................... 84

API Version 2016-08-10 v

AWS Batch API Reference

Response Elements ............................................................................................................................ 104

Errors ..................................................................................................................................................... 104
Examples ............................................................................................................................................... 104
See Also ................................................................................................................................................ 107
DescribeSchedulingPolicies .................................................................................................................... 109
Request Syntax .................................................................................................................................... 109
URI Request Parameters ................................................................................................................... 109
Request Body ....................................................................................................................................... 109
Response Syntax ................................................................................................................................. 109
Response Elements ............................................................................................................................ 110
Errors ..................................................................................................................................................... 110
Examples ............................................................................................................................................... 111
See Also ................................................................................................................................................ 113
GetJobQueueSnapshot ........................................................................................................................... 114
Request Syntax .................................................................................................................................... 114
URI Request Parameters ................................................................................................................... 114
Request Body ....................................................................................................................................... 114
Response Syntax ................................................................................................................................. 114
Response Elements ............................................................................................................................ 115
Errors ..................................................................................................................................................... 115
See Also ................................................................................................................................................ 115
ListJobs ....................................................................................................................................................... 117
Request Syntax .................................................................................................................................... 117
URI Request Parameters ................................................................................................................... 117
Request Body ....................................................................................................................................... 117
Response Syntax ................................................................................................................................. 120
Response Elements ............................................................................................................................ 121
Errors ..................................................................................................................................................... 122
Examples ............................................................................................................................................... 122
See Also ................................................................................................................................................ 124
ListSchedulingPolicies ............................................................................................................................. 126
Request Syntax .................................................................................................................................... 126
URI Request Parameters ................................................................................................................... 126
Request Body ....................................................................................................................................... 126
Response Syntax ................................................................................................................................. 127
Response Elements ............................................................................................................................ 127

API Version 2016-08-10 vi

AWS Batch API Reference

Errors ..................................................................................................................................................... 128

Examples ............................................................................................................................................... 128
See Also ................................................................................................................................................ 129
ListTagsForResource ................................................................................................................................ 131
Request Syntax .................................................................................................................................... 131
URI Request Parameters ................................................................................................................... 131
Request Body ....................................................................................................................................... 131
Response Syntax ................................................................................................................................. 131
Response Elements ............................................................................................................................ 132
Errors ..................................................................................................................................................... 132
Examples ............................................................................................................................................... 132
See Also ................................................................................................................................................ 134
RegisterJobDeﬁnition .............................................................................................................................. 135
Request Syntax .................................................................................................................................... 135
URI Request Parameters ................................................................................................................... 151
Request Body ....................................................................................................................................... 151
Response Syntax ................................................................................................................................. 156
Response Elements ............................................................................................................................ 156
Errors ..................................................................................................................................................... 156
Examples ............................................................................................................................................... 157
See Also ................................................................................................................................................ 160
SubmitJob .................................................................................................................................................. 161
Request Syntax .................................................................................................................................... 161
URI Request Parameters ................................................................................................................... 167
Request Body ....................................................................................................................................... 167
Response Syntax ................................................................................................................................. 171
Response Elements ............................................................................................................................ 171
Errors ..................................................................................................................................................... 172
Examples ............................................................................................................................................... 172
See Also ................................................................................................................................................ 173
TagResource .............................................................................................................................................. 175
Request Syntax .................................................................................................................................... 175
URI Request Parameters ................................................................................................................... 175
Request Body ....................................................................................................................................... 175
Response Syntax ................................................................................................................................. 176
Response Elements ............................................................................................................................ 176

API Version 2016-08-10 vii

AWS Batch API Reference

Errors ..................................................................................................................................................... 176

Examples ............................................................................................................................................... 176
See Also ................................................................................................................................................ 178
TerminateJob ............................................................................................................................................ 179
Request Syntax .................................................................................................................................... 179
URI Request Parameters ................................................................................................................... 179
Request Body ....................................................................................................................................... 179
Response Syntax ................................................................................................................................. 180
Response Elements ............................................................................................................................ 180
Errors ..................................................................................................................................................... 180
Examples ............................................................................................................................................... 180
See Also ................................................................................................................................................ 181
UntagResource .......................................................................................................................................... 183
Request Syntax .................................................................................................................................... 183
URI Request Parameters ................................................................................................................... 183
Request Body ....................................................................................................................................... 183
Response Syntax ................................................................................................................................. 183
Response Elements ............................................................................................................................ 184
Errors ..................................................................................................................................................... 184
Examples ............................................................................................................................................... 184
See Also ................................................................................................................................................ 185
UpdateComputeEnvironment ................................................................................................................ 186
Request Syntax .................................................................................................................................... 186
URI Request Parameters ................................................................................................................... 187
Request Body ....................................................................................................................................... 187
Response Syntax ................................................................................................................................. 190
Response Elements ............................................................................................................................ 190
Errors ..................................................................................................................................................... 190
Examples ............................................................................................................................................... 191
See Also ................................................................................................................................................ 192
UpdateJobQueue ..................................................................................................................................... 193
Request Syntax .................................................................................................................................... 193
URI Request Parameters ................................................................................................................... 193
Request Body ....................................................................................................................................... 193
Response Syntax ................................................................................................................................. 195
Response Elements ............................................................................................................................ 195

API Version 2016-08-10 viii

AWS Batch API Reference

Errors ..................................................................................................................................................... 196

Examples ............................................................................................................................................... 196
See Also ................................................................................................................................................ 197
UpdateSchedulingPolicy ......................................................................................................................... 199
Request Syntax .................................................................................................................................... 199
URI Request Parameters ................................................................................................................... 199
Request Body ....................................................................................................................................... 199
Response Syntax ................................................................................................................................. 200
Response Elements ............................................................................................................................ 200
Errors ..................................................................................................................................................... 200
Examples ............................................................................................................................................... 200
See Also ................................................................................................................................................ 202
Data Types ................................................................................................................................... 203
ArrayProperties ......................................................................................................................................... 207
Contents ............................................................................................................................................... 207
See Also ................................................................................................................................................ 207
ArrayPropertiesDetail .............................................................................................................................. 208
Contents ............................................................................................................................................... 208
See Also ................................................................................................................................................ 208
ArrayPropertiesSummary ....................................................................................................................... 209
Contents ............................................................................................................................................... 209
See Also ................................................................................................................................................ 209
AttemptContainerDetail ......................................................................................................................... 210
Contents ............................................................................................................................................... 210
See Also ................................................................................................................................................ 211
AttemptDetail ........................................................................................................................................... 212
Contents ............................................................................................................................................... 212
See Also ................................................................................................................................................ 213
AttemptEcsTaskDetails ............................................................................................................................ 214
Contents ............................................................................................................................................... 214
See Also ................................................................................................................................................ 214
AttemptTaskContainerDetails ................................................................................................................ 215
Contents ............................................................................................................................................... 215
See Also ................................................................................................................................................ 216
ComputeEnvironmentDetail ................................................................................................................... 217
Contents ............................................................................................................................................... 217

API Version 2016-08-10 ix

AWS Batch API Reference

API Version 2016-08-10 x

AWS Batch API Reference

API Version 2016-08-10 xi

AWS Batch API Reference

API Version 2016-08-10 xii

AWS Batch API Reference

API Version 2016-08-10 xiii

AWS Batch API Reference

API Version 2016-08-10 xiv

AWS Batch API Reference

API Version 2016-08-10 xv

AWS Batch API Reference

API Version 2016-08-10 xvi

AWS Batch API Reference

Welcome
Using AWS Batch, you can run batch computing workloads on the AWS Cloud. Batch computing
is a common means for developers, scientists, and engineers to access large amounts of compute
resources. AWS Batch uses the advantages of the batch computing to remove the undifferentiated
heavy lifting of configuring and managing required infrastructure. At the same time, it also adopts
a familiar batch computing software approach. You can use AWS Batch to efficiently provision
resources, and work toward eliminating capacity constraints, reducing your overall compute costs,
and delivering results more quickly.

As a fully managed service, AWS Batch can run batch computing workloads of any scale. AWS Batch
automatically provisions compute resources and optimizes workload distribution based on the
quantity and scale of your speciﬁc workloads. With AWS Batch, there's no need to install or manage
batch computing software. This means that you can focus on analyzing results and solving your
speciﬁc problems instead.

This document was last published on September 11, 2024.

API Version 2016-08-10 1

AWS Batch API Reference

Actions
The following actions are supported:

• CancelJob
• CreateComputeEnvironment
• CreateJobQueue
• CreateSchedulingPolicy
• DeleteComputeEnvironment
• DeleteJobQueue
• DeleteSchedulingPolicy
• DeregisterJobDefinition
• DescribeComputeEnvironments
• DescribeJobDefinitions
• DescribeJobQueues
• DescribeJobs
• DescribeSchedulingPolicies
• GetJobQueueSnapshot
• ListJobs
• ListSchedulingPolicies
• ListTagsForResource
• RegisterJobDefinition
• SubmitJob
• TagResource
• TerminateJob
• UntagResource
• UpdateComputeEnvironment
• UpdateJobQueue
• UpdateSchedulingPolicy

API Version 2016-08-10 2

AWS Batch API Reference

CancelJob
Cancels a job in an AWS Batch job queue. Jobs that are in a SUBMITTED, PENDING, or RUNNABLE
state are cancelled and the job status is updated to FAILED.

Note
A PENDING job is canceled after all dependency jobs are completed. Therefore, it may take
longer than expected to cancel a job in PENDING status.
When you try to cancel an array parent job in PENDING, AWS Batch attempts to cancel all
child jobs. The array parent job is canceled when all child jobs are completed.

Jobs that progressed to the STARTING or RUNNING state aren't canceled. However, the API
operation still succeeds, even if no job is canceled. These jobs must be terminated with the
TerminateJob operation.

Request Syntax

POST /v1/canceljob HTTP/1.1

Content-type: application/json

{
"jobId": "string",
"reason": "string"
}

URI Request Parameters

The request does not use any URI parameters.

Request Body
The request accepts the following data in JSON format.

jobId

The AWS Batch job ID of the job to cancel.

Type: String

CancelJob API Version 2016-08-10 3

AWS Batch API Reference

Required: Yes
reason

A message to attach to the job that explains the reason for canceling it. This message is
returned by future DescribeJobs operations on the job. It is also recorded in the AWS Batch
activity logs.

This parameter has as limit of 1024 characters.

Type: String

Required: Yes

Response Syntax

HTTP/1.1 200

Response Elements
If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

Errors
ClientException

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 identiﬁer that's not valid.

HTTP Status Code: 400

ServerException

These errors are usually caused by a server issue.

HTTP Status Code: 500

Examples
In the following example or examples, the Authorization header contents ( [authorization-
params] ) must be replaced with an AWS Signature Version 4 signature. For more information

Response Syntax API Version 2016-08-10 4

AWS Batch API Reference

about creating these signatures, see Signature Version 4 Signing Process in the AWS General
Reference.

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

Example

This example cancels a job with the speciﬁed job ID.

Sample Request

POST /v1/canceljob HTTP/1.1

Host: batch.us-east-1.amazonaws.com
Accept-Encoding: identity
Content-Length: [content-length]
Authorization: [authorization-params]
X-Amz-Date: 20161130T001258Z
User-Agent: aws-cli/1.11.22 Python/2.7.12 Darwin/16.1.0 botocore/1.4.79

{
"reason": "Cancelling job.",
"jobId": "1d828f65-7a4d-42e8-996d-3b900ed59dc4"
}

Sample Response

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 2
Connection: keep-alive
Date: Wed, 30 Nov 2016 00:12:59 GMT
x-amzn-RequestId: [request-id]
X-Amzn-Trace-Id: [trace-id]
X-Cache: Miss from cloudfront
Via: 1.1 bfdd5909914586f5bc4851846228c27f.cloudfront.net (CloudFront)
X-Amz-Cf-Id: whn1dX1uTx34Lvao7-7ZdkDXEbCZ_sjn3v3hHVFgbo1ORJtXyeggSw==

{}

Examples API Version 2016-08-10 5

AWS Batch API Reference

See Also
For more information about using this API in one of the language-speciﬁc AWS SDKs, see the
following:

• AWS Command Line Interface

• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go v2
• AWS SDK for Java V2
• AWS SDK for JavaScript V3
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3

CreateComputeEnvironment API Version 2016-08-10 7

AWS Batch API Reference

Note
AWS Batch doesn't automatically upgrade the AMIs in a compute environment after it's
created. For example, it also doesn't update the AMIs in your compute environment when
a newer version of the Amazon ECS optimized AMI is available. You're responsible for
the management of the guest operating system. This includes any updates and security
patches. You're also responsible for any additional application software or utilities that you
install on the compute resources. There are two ways to use a new AMI for your AWS Batch
jobs. The original method is to complete these steps:

1. Create a new compute environment with the new AMI.

2. Add the compute environment to an existing job queue.

3. Remove the earlier compute environment from your job queue.

4. Delete the earlier compute environment.

In April 2022, AWS Batch added enhanced support for updating compute environments.
For more information, see Updating compute environments. To use the enhanced updating
of compute environments to update AMIs, follow these rules:

• Either don't set the service role (serviceRole) parameter or set it to the
AWSBatchServiceRole service-linked role.

• Set the allocation strategy (allocationStrategy) parameter

to BEST_FIT_PROGRESSIVE, SPOT_CAPACITY_OPTIMIZED, or
SPOT_PRICE_CAPACITY_OPTIMIZED.
• Set the update to latest image version (updateToLatestImageVersion) parameter
to true. The updateToLatestImageVersion parameter is used when you update
a compute environment. This parameter is ignored when you create a compute
environment.

• Don't specify an AMI ID in imageId, imageIdOverride (in ec2Configuration),

or in the launch template (launchTemplate). In that case, AWS Batch selects the
latest Amazon ECS optimized AMI that's supported by AWS Batch at the time the
infrastructure update is initiated. Alternatively, you can specify the AMI ID in the
imageId or imageIdOverride parameters, or the launch template identiﬁed by the
LaunchTemplate properties. Changing any of these properties starts an infrastructure
update. If the AMI ID is speciﬁed in the launch template, it can't be replaced by specifying
an AMI ID in either the imageId or imageIdOverride parameters. It can only be
CreateComputeEnvironment API Version 2016-08-10 8
AWS Batch API Reference

replaced by specifying a diﬀerent launch template, or if the launch template version

is set to $Default or $Latest, by setting either a new default version for the launch
template (if $Default) or by adding a new version to the launch template (if $Latest).

If these rules are followed, any update that starts an infrastructure update causes the AMI
ID to be re-selected. If the version setting in the launch template (launchTemplate)
is set to $Latest or $Default, the latest or default version of the launch template is
evaluated up at the time of the infrastructure update, even if the launchTemplate wasn't
updated.

Request Syntax

POST /v1/createcomputeenvironment HTTP/1.1

Content-type: application/json

{
"computeEnvironmentName": "string",
"computeResources": {
"allocationStrategy": "string",
"bidPercentage": number,
"desiredvCpus": number,
"ec2Configuration": [
{
"imageIdOverride": "string",
"imageKubernetesVersion": "string",
"imageType": "string"
}
],
"ec2KeyPair": "string",
"imageId": "string",
"instanceRole": "string",
"instanceTypes": [ "string" ],
"launchTemplate": {
"launchTemplateId": "string",
"launchTemplateName": "string",
"version": "string"
},
"maxvCpus": number,
"minvCpus": number,
"placementGroup": "string",

Request Syntax API Version 2016-08-10 9

AWS Batch API Reference

"securityGroupIds": [ "string" ],
"spotIamFleetRole": "string",
"subnets": [ "string" ],
"tags": {
"string" : "string"
},
"type": "string"
},
"context": "string",
"eksConfiguration": {
"eksClusterArn": "string",
"kubernetesNamespace": "string"
},
"serviceRole": "string",
"state": "string",
"tags": {
"string" : "string"
},
"type": "string",
"unmanagedvCpus": number
}

URI Request Parameters

The request does not use any URI parameters.

Request Body
The request accepts the following data in JSON format.

computeEnvironmentName

The name for your compute environment. It can be up to 128 characters long. It can contain
uppercase and lowercase letters, numbers, hyphens (-), and underscores (_).

Type: String

Required: Yes
computeResources

Details about the compute resources managed by the compute environment. This parameter
is required for managed compute environments. For more information, see Compute
Environments in the AWS Batch User Guide.

URI Request Parameters API Version 2016-08-10 10

AWS Batch API Reference

Type: ComputeResource object

Required: No
context

Reserved.

Type: String

Required: No
eksConﬁguration

The details for the Amazon EKS cluster that supports the compute environment.

Type: EksConﬁguration object

Required: No
serviceRole

The full Amazon Resource Name (ARN) of the IAM role that allows AWS Batch to make calls to
other AWS services on your behalf. For more information, see AWS Batch service IAM role in the
AWS Batch User Guide.

Important
If your account already created the AWS Batch service-linked role, that role is used by
default for your compute environment unless you specify a diﬀerent role here. If the
AWS Batch service-linked role doesn't exist in your account, and no role is speciﬁed here,
the service attempts to create the AWS Batch service-linked role in your account.

If your speciﬁed role has a path other than /, then you must specify either the full role ARN
(recommended) or preﬁx the role name with the path. For example, if a role with the name bar
has a path of /foo/, specify /foo/bar as the role name. For more information, see Friendly
names and paths in the IAM User Guide.

Note
Depending on how you created your AWS Batch service role, its ARN might contain the
service-role path preﬁx. When you only specify the name of the service role, AWS

Request Body API Version 2016-08-10 11

AWS Batch API Reference

Batch assumes that your ARN doesn't use the service-role path preﬁx. Because of
this, we recommend that you specify the full ARN of your service role when you create
compute environments.

Type: String

Required: No
state

The state of the compute environment. If the state is ENABLED, then the compute environment
accepts jobs from a queue and can scale out automatically based on queues.

If the state is ENABLED, then the AWS Batch scheduler can attempt to place jobs from an
associated job queue on the compute resources within the environment. If the compute
environment is managed, then it can scale its instances out or in automatically, based on the job
queue demand.

If the state is DISABLED, then the AWS Batch scheduler doesn't attempt to place jobs within
the environment. Jobs in a STARTING or RUNNING state continue to progress normally.
Managed compute environments in the DISABLED state don't scale out.

Note
Compute environments in a DISABLED state may continue to incur billing charges. To
prevent additional charges, turn oﬀ and then delete the compute environment. For
more information, see State in the AWS Batch User Guide.

When an instance is idle, the instance scales down to the minvCpus value. However, the
instance size doesn't change. For example, consider a c5.8xlarge instance with a minvCpus
value of 4 and a desiredvCpus value of 36. This instance doesn't scale down to a c5.large
instance.

Type: String

Valid Values: ENABLED | DISABLED

Required: No

Request Body API Version 2016-08-10 12

AWS Batch API Reference

tags

The tags that you apply to the compute environment to help you categorize and organize your
resources. Each tag consists of a key and an optional value. For more information, see Tagging
AWS Resources in AWS General Reference.

These tags can be updated or removed using the TagResource and UntagResource API
operations. These tags don't propagate to the underlying compute resources.

Type: String to string map

Map Entries: Maximum number of 50 items.

Key Length Constraints: Minimum length of 1. Maximum length of 128.

Value Length Constraints: Maximum length of 256.

Required: No
type

The type of the compute environment: MANAGED or UNMANAGED. For more information, see
Compute Environments in the AWS Batch User Guide.

Type: String

Valid Values: MANAGED | UNMANAGED

Required: Yes
unmanagedvCpus

The maximum number of vCPUs for an unmanaged compute environment. This parameter is
only used for fair share scheduling to reserve vCPU capacity for new share identiﬁers. If this
parameter isn't provided for a fair share job queue, no vCPU capacity is reserved.

Note
This parameter is only supported when the type parameter is set to UNMANAGED.

Type: Integer

Request Body API Version 2016-08-10 13

AWS Batch API Reference

Required: No

Response Syntax

HTTP/1.1 200
Content-type: application/json

{
"computeEnvironmentArn": "string",
"computeEnvironmentName": "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.

computeEnvironmentArn

The Amazon Resource Name (ARN) of the compute environment.

Type: String
computeEnvironmentName

The name of the compute environment. It can be up to 128 characters long. It can contain
uppercase and lowercase letters, numbers, hyphens (-), and underscores (_).

Type: String

Errors
ClientException

HTTP Status Code: 400

Response Syntax API Version 2016-08-10 14

AWS Batch API Reference

ServerException

These errors are usually caused by a server issue.

HTTP Status Code: 500

Examples

In the following example or examples, the Authorization header contents ( [authorization-

params] ) must be replaced with an AWS Signature Version 4 signature. For more information
about creating these signatures, see Signature Version 4 Signing Process in the AWS General
Reference.

Example

This example creates a managed compute environment with speciﬁc C4 instance types that are
launched on demand. The compute environment is called C4OnDemand.

Sample Request

POST /v1/createcomputeenvironment HTTP/1.1

Host: batch.us-east-1.amazonaws.com
Accept-Encoding: identity
Content-Length: [content-length]
Authorization: [authorization-params]
X-Amz-Date: 20161128T223128Z
User-Agent: aws-cli/1.11.21 Python/2.7.12 Darwin/16.1.0 botocore/1.4.78

{
"computeEnvironmentName": "C4OnDemand",
"state": "ENABLED",
"type": "MANAGED",
"computeResources": {
"subnets": [

Examples API Version 2016-08-10 15

AWS Batch API Reference

"subnet-220c0e0a",
"subnet-1a95556d",
"subnet-978f6dce"
],
"tags": {
"Name": "Batch Instance - C4OnDemand",
"Department": "Engineering"
},
"desiredvCpus": 48,
"minvCpus": 0,
"instanceTypes": [
"c4.large",
"c4.xlarge",
"c4.2xlarge",
"c4.4xlarge",
"c4.8xlarge"
],
"securityGroupIds": [
"sg-cf5093b2"
],
"instanceRole": "ecsInstanceRole",
"maxvCpus": 128,
"type": "EC2",
"ec2KeyPair": "id_rsa"
},
"serviceRole": "arn:aws:iam::123456789012:role/AWSBatchServiceRole"
}

Sample Response

HTTP/1.1 200 OK
Date: Mon, 28 Nov 2016 22:31:28 GMT
Content-Type: application/json
Content-Length: [content-length]
Connection: keep-alive
x-amzn-RequestId: [request-id]
X-Amzn-Trace-Id: [trace-id]
X-Cache: Miss from cloudfront
Via: 1.1 7e587c722adb25336835ccb4e5814e4e.cloudfront.net (CloudFront)
X-Amz-Cf-Id: GwQRsxvmiuj1HYwbYq9MAEsQfJpN6BknGQlNX1jAd5qLQFXyHBwOUQ==

{
"computeEnvironmentName": "C4OnDemand",

Examples API Version 2016-08-10 16

AWS Batch API Reference

"computeEnvironmentArn": "arn:aws:batch:us-east-1:123456789012:compute-environment/
C4OnDemand"
}

Example

This example creates a managed compute environment with the M4 instance type that's launched
when the Spot Instance price less than or equal to 20% of the On-Demand price for the instance
type. The compute environment is called M4Spot.

Sample Request

POST /v1/createcomputeenvironment HTTP/1.1

Host: batch.us-east-1.amazonaws.com
Accept-Encoding: identity
Content-Length: [content-length]
Authorization: [authorization-params]
X-Amz-Date: 20161128T223813Z
User-Agent: aws-cli/1.11.21 Python/2.7.12 Darwin/16.1.0 botocore/1.4.78

{
"computeEnvironmentName": "M4Spot",
"state": "ENABLED",
"type": "MANAGED",
"computeResources": {
"subnets": [
"subnet-220c0e0a",
"subnet-1a95556d",
"subnet-978f6dce"
],
"type": "SPOT",
"spotIamFleetRole": "arn:aws:iam::123456789012:role/aws-ec2-spot-fleet-role",
"tags": {
"Name": "Batch Instance - M4Spot",
"Department": "Marketing"
},
"desiredvCpus": 4,
"minvCpus": 0,
"instanceTypes": [
"m4"
],
"securityGroupIds": [
"sg-cf5093b2"

Examples API Version 2016-08-10 17

AWS Batch API Reference

],
"instanceRole": "ecsInstanceRole",
"maxvCpus": 128,
"bidPercentage": 20,
"ec2KeyPair": "id_rsa"
},
"serviceRole": "arn:aws:iam::123456789012:role/AWSBatchServiceRole"
}

Sample Response

HTTP/1.1 200 OK
Date: Mon, 28 Nov 2016 22:38:16 GMT
Content-Type: application/json
Content-Length: [content-length]
Connection: keep-alive
x-amzn-RequestId: [request-id]
X-Amzn-Trace-Id: [trace-id]
X-Cache: Miss from cloudfront
Via: 1.1 8455edd9286a1292a39c993fdeccce65.cloudfront.net (CloudFront)
X-Amz-Cf-Id: 4mklLyUpygUko86fMNzPgA8_D64lSwPmG6iIKhAZkGpOp2e-3cKg_w==

{
"computeEnvironmentName": "M4Spot",
"computeEnvironmentArn": "arn:aws:batch:us-east-1:123456789012:compute-environment/
M4Spot"
}

See Also
For more information about using this API in one of the language-speciﬁc AWS SDKs, see the
following:

• AWS Command Line Interface

• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go v2
• AWS SDK for Java V2
• AWS SDK for JavaScript V3
• AWS SDK for PHP V3

• AWS SDK for Python

• AWS SDK for Ruby V3

POST /v1/createjobqueue HTTP/1.1

Content-type: application/json

{
"computeEnvironmentOrder": [
{
"computeEnvironment": "string",
"order": number
}
],
"jobQueueName": "string",
"jobStateTimeLimitActions": [
{
"action": "string",
"maxTimeSeconds": number,
"reason": "string",
"state": "string"
}
],
"priority": number,
"schedulingPolicyArn": "string",
"state": "string",
"tags": {
"string" : "string"
}
}

URI Request Parameters

The request does not use any URI parameters.

CreateJobQueue API Version 2016-08-10 20

AWS Batch API Reference

Request Body
The request accepts the following data in JSON format.

computeEnvironmentOrder

The set of compute environments mapped to a job queue and their order relative to each
other. The job scheduler uses this parameter to determine which compute environment runs
a speciﬁc job. Compute environments must be in the VALID state before you can associate
them with a job queue. You can associate up to three compute environments with a job queue.
All of the compute environments must be either EC2 (EC2 or SPOT) or Fargate (FARGATE or
FARGATE_SPOT); EC2 and Fargate compute environments can't be mixed.

Note
All compute environments that are associated with a job queue must share the same
architecture. AWS Batch doesn't support mixing compute environment architecture
types in a single job queue.

Type: Array of ComputeEnvironmentOrder objects

Required: Yes
jobQueueName

The name of the job queue. It can be up to 128 letters long. It can contain uppercase and
lowercase letters, numbers, hyphens (-), and underscores (_).

Type: String

Required: Yes
jobStateTimeLimitActions

The set of actions that AWS Batch performs on jobs that remain at the head of the job queue
in the speciﬁed state longer than speciﬁed times. AWS Batch will perform each action after
maxTimeSeconds has passed. (Note: The minimum value for maxTimeSeconds is 600 (10
minutes) and its maximum value is 86,400 (24 hours).)

Type: Array of JobStateTimeLimitAction objects

Required: No

Request Body API Version 2016-08-10 21

AWS Batch API Reference

priority

The priority of the job queue. Job queues with a higher priority (or a higher integer value
for the priority parameter) are evaluated ﬁrst when associated with the same compute
environment. Priority is determined in descending order. For example, a job queue with a
priority value of 10 is given scheduling preference over a job queue with a priority value of 1.
All of the compute environments must be either EC2 (EC2 or SPOT) or Fargate (FARGATE or
FARGATE_SPOT); EC2 and Fargate compute environments can't be mixed.

Type: Integer

Required: Yes
schedulingPolicyArn

The Amazon Resource Name (ARN) of the fair share scheduling policy. Job queues that don't
have a scheduling policy are scheduled in a ﬁrst-in, ﬁrst-out (FIFO) model. After a job queue has
a scheduling policy, it can be replaced but can't be removed.

The format is aws:Partition:batch:Region:Account:scheduling-policy/Name .

An example is aws:aws:batch:us-west-2:123456789012:scheduling-policy/
MySchedulingPolicy.

A job queue without a scheduling policy is scheduled as a FIFO job queue and can't have a
scheduling policy added. Jobs queues with a scheduling policy can have a maximum of 500
active fair share identiﬁers. When the limit has been reached, submissions of any jobs that add a
new fair share identiﬁer fail.

Type: String

Required: No
state

The state of the job queue. If the job queue state is ENABLED, it is able to accept jobs. If the job
queue state is DISABLED, new jobs can't be added to the queue, but jobs already in the queue
can ﬁnish.

Type: String

Valid Values: ENABLED | DISABLED

Required: No

Request Body API Version 2016-08-10 22

AWS Batch API Reference

tags

The tags that you apply to the job queue to help you categorize and organize your resources.
Each tag consists of a key and an optional value. For more information, see Tagging your AWS
Batch resources in AWS Batch User Guide.

Type: String to string map

Map Entries: Maximum number of 50 items.

Key Length Constraints: Minimum length of 1. Maximum length of 128.

Value Length Constraints: Maximum length of 256.

Required: No

Response Syntax

HTTP/1.1 200
Content-type: application/json

{
"jobQueueArn": "string",
"jobQueueName": "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.

jobQueueArn

The Amazon Resource Name (ARN) of the job queue.

Type: String
jobQueueName

The name of the job queue.

Type: String

Response Syntax API Version 2016-08-10 23

AWS Batch API Reference

Errors
ClientException

HTTP Status Code: 400

ServerException

These errors are usually caused by a server issue.

HTTP Status Code: 500

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

Example

This example creates a job queue called LowPriority that uses the M4Spot compute
environment.

Sample Request

POST /v1/createjobqueue HTTP/1.1

Host: batch.us-east-1.amazonaws.com
Accept-Encoding: identity
Content-Length: [content-length]
Authorization: [authorization-params]
X-Amz-Date: 20161128T234201Z

Errors API Version 2016-08-10 24

AWS Batch API Reference

User-Agent: aws-cli/1.11.21 Python/2.7.12 Darwin/16.1.0 botocore/1.4.78

{
"priority": 1,
"state": "ENABLED",
"computeEnvironmentOrder": [
{
"computeEnvironment": "M4Spot",
"order": 1
}
],
"jobQueueName": "LowPriority"
}

Sample Response

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: [content-length]
Connection: keep-alive
Date: Mon, 28 Nov 2016 23:42:02 GMT
x-amzn-RequestId: [request-id]
X-Amzn-Trace-Id: [trace-id]
X-Cache: Miss from cloudfront
Via: 1.1 a44b4468444ef3ee67472bd5c5016098.cloudfront.net (CloudFront)
X-Amz-Cf-Id: bz9IuCM5FNkDfge5y-Zw7nFEjDdTHDYFwbEY2AKUqrt9l2XeKUcuyA==

{
"jobQueueName": "LowPriority",
"jobQueueArn": "arn:aws:batch:us-east-1:123456789012:job-queue/LowPriority"
}

Example

This example creates a job queue called HighPriority that uses the C4OnDemand compute
environment with an order of 1 and the M4Spot compute environment with an order of 2.

Sample Request

POST /v1/createjobqueue HTTP/1.1

Host: batch.us-east-1.amazonaws.com
Accept-Encoding: identity
Content-Length: [content-length]

Examples API Version 2016-08-10 25

AWS Batch API Reference

Authorization: [authorization-params]
X-Amz-Date: 20161128T234933Z
User-Agent: aws-cli/1.11.21 Python/2.7.12 Darwin/16.1.0 botocore/1.4.78

{
"priority": 10,
"state": "ENABLED",
"computeEnvironmentOrder": [
{
"computeEnvironment": "C4OnDemand",
"order": 1
},
{
"computeEnvironment": "M4Spot",
"order": 2
}
],
"jobQueueName": "HighPriority"
}

Sample Response

HTTP/1.1 200 OK
Date: Mon, 28 Nov 2016 23:49:34 GMT
Content-Type: application/json
Content-Length: [content-length]
Connection: keep-alive
x-amzn-RequestId: [request-id]
X-Amzn-Trace-Id: [trace-id]
X-Cache: Miss from cloudfront
Via: 1.1 e81bbcbc86832b655de5b9a19317ad01.cloudfront.net (CloudFront)
X-Amz-Cf-Id: 8NB20odDPMaKy9zHa6GPaGN_r562QsynDTRYPuhKwHSvQrMG70IHSQ==

{
"jobQueueName": "HighPriority",
"jobQueueArn": "arn:aws:batch:us-east-1:123456789012:job-queue/HighPriority"
}

See Also

For more information about using this API in one of the language-speciﬁc AWS SDKs, see the
following:

• AWS Command Line Interface

• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go v2
• AWS SDK for Java V2
• AWS SDK for JavaScript V3
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3

POST /v1/createschedulingpolicy HTTP/1.1

Content-type: application/json

{
"fairsharePolicy": {
"computeReservation": number,
"shareDecaySeconds": number,
"shareDistribution": [
{
"shareIdentifier": "string",
"weightFactor": number
}
]
},
"name": "string",
"tags": {
"string" : "string"
}
}

URI Request Parameters

The request does not use any URI parameters.

Request Body

The request accepts the following data in JSON format.

fairsharePolicy

The fair share policy of the scheduling policy.

Type: FairsharePolicy object

Required: No

CreateSchedulingPolicy API Version 2016-08-10 28

AWS Batch API Reference

name

The name of the scheduling policy. It can be up to 128 letters long. It can contain uppercase
and lowercase letters, numbers, hyphens (-), and underscores (_).

Type: String

Required: Yes
tags

The tags that you apply to the scheduling policy to help you categorize and organize your
resources. Each tag consists of a key and an optional value. For more information, see Tagging
AWS Resources in AWS General Reference.

These tags can be updated or removed using the TagResource and UntagResource API
operations.

Type: String to string map

Map Entries: Maximum number of 50 items.

Key Length Constraints: Minimum length of 1. Maximum length of 128.

Value Length Constraints: Maximum length of 256.

Required: No

Response Syntax

HTTP/1.1 200
Content-type: application/json

{
"arn": "string",
"name": "string"
}

Response Elements

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

Response Syntax API Version 2016-08-10 29

AWS Batch API Reference

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

arn

The Amazon Resource Name (ARN) of the scheduling policy. The format is
aws:Partition:batch:Region:Account:scheduling-policy/Name . For
example, aws:aws:batch:us-west-2:123456789012:scheduling-policy/
MySchedulingPolicy.

Type: String
name

The name of the scheduling policy.

Type: String

Errors
ClientException

HTTP Status Code: 400

ServerException

These errors are usually caused by a server issue.

HTTP Status Code: 500

You only need to learn how to sign HTTP requests if you intend to manually create them. When
you use the AWS Command Line Interface (AWS CLI) or one of the AWS SDKs to make requests to

Errors API Version 2016-08-10 30

AWS Batch API Reference

AWS, these tools automatically sign the requests for you with the access key that you specify when
you conﬁgure the tools. When you use these tools, you don't need to learn how to sign requests
yourself.

Example

This example creates a scheduling policy with the specified fair share identifiers and fair share
identifier prefixes.

Sample Request

POST /v1/createschedulingpolicy HTTP/1.1

Host: batch.us-east-1.amazonaws.com
Accept-Encoding: identity
User-Agent: aws-cli/1.20.21 Python/3.6.9 Linux/4.4.0-19041-Microsoft botocore/1.21.21
X-Amz-Date: 20210928T231724Z
X-Amz-Security-Token: [security-token]
Authorization: [authorization-params]
Content-Length: [content-length]

{
"name": "ExampleFairSharePolicy",
"fairsharePolicy": {
"shareDecaySeconds": 3600,
"computeReservation": 1,
"shareDistribution": [
{
"shareIdentifier": "A1*",
"weightFactor": 0.1
},
{
"shareIdentifier": "A2",
"weightFactor": 0.2
},
{
"shareIdentifier": "B*",
"weightFactor": 0.8
},
{
"shareIdentifier": "C",
"weightFactor": 1.2
},
{

Examples API Version 2016-08-10 31

AWS Batch API Reference

"shareIdentifier": "D*",
"weightFactor": 1.5
},
{
"shareIdentifier": "E",
"weightFactor": 1.8
}
]
},
"tags": {
"Hot": "Dog",
"Beef": "Brisket",
"Pork": "Ribs",
"Department": "Engineering"
}
}

Sample Response

HTTP/1.1 200 OK
Date: Tue, 28 Sep 2021 23:17:50 GMT
Content-Type: application/json
Content-Length: [content-length]
x-amzn-RequestId: [request-id]
Access-Control-Allow-Origin: *
x-amz-apigw-id: [apigw-id]
Access-Control-Expose-Headers: X-amzn-errortype,X-amzn-requestid,X-amzn-errormessage,X-
amzn-trace-id,X-amz-apigw-id,date
X-Amzn-Trace-Id: [trace-id]
Connection: keep-alive

{
"schedulingPolicies": [{
"arn": "arn:aws:batch:us-east-1:123456789012:scheduling-policy/
ExampleFairSharePolicy"
}]
}

See Also

For more information about using this API in one of the language-speciﬁc AWS SDKs, see the
following:

• AWS Command Line Interface

• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go v2
• AWS SDK for Java V2
• AWS SDK for JavaScript V3
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3

POST /v1/deletecomputeenvironment HTTP/1.1

Content-type: application/json

{
"computeEnvironment": "string"
}

URI Request Parameters

The request does not use any URI parameters.

Request Body

The request accepts the following data in JSON format.

computeEnvironment

The name or Amazon Resource Name (ARN) of the compute environment to delete.

Type: String

Required: Yes

Response Syntax

HTTP/1.1 200

DeleteComputeEnvironment API Version 2016-08-10 34

AWS Batch API Reference

Response Elements

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

Errors
ClientException

HTTP Status Code: 400

ServerException

These errors are usually caused by a server issue.

HTTP Status Code: 500

Examples

In the following example or examples, the Authorization header contents ( [authorization-

params] ) must be replaced with an AWS Signature Version 4 signature. For more information
about creating these signatures, see Signature Version 4 Signing Process in the AWS General
Reference.

Example

This example deletes the P3OnDemand compute environment.

Sample Request

POST /v1/deletecomputeenvironment HTTP/1.1

Response Elements API Version 2016-08-10 35

AWS Batch API Reference

Host: batch.us-east-1.amazonaws.com
Accept-Encoding: identity
Content-Length: [content-length]
Authorization: [authorization-params]
X-Amz-Date: 20161128T202219Z
User-Agent: aws-cli/1.11.21 Python/2.7.12 Darwin/16.1.0 botocore/1.4.78

{
"computeEnvironment": "P3OnDemand"
}

Sample Response

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 2
Connection: keep-alive
Date: Mon, 28 Nov 2016 20:22:20 GMT
x-amzn-RequestId: [request-id]
X-Amzn-Trace-Id: [trace-id]
X-Cache: Miss from cloudfront
Via: 1.1 b63769e2d89c89274acd908e4bfcb9f4.cloudfront.net (CloudFront)
X-Amz-Cf-Id: mqHP9krdcbSbT0pivub4bJEM0_XCTTfENz0xPwwye-USu1CVGlj-nw==

{}

See Also

For more information about using this API in one of the language-speciﬁc AWS SDKs, see the
following:

• AWS Command Line Interface

• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go v2
• AWS SDK for Java V2
• AWS SDK for JavaScript V3
• AWS SDK for PHP V3
• AWS SDK for Python

• AWS SDK for Ruby V3

POST /v1/deletejobqueue HTTP/1.1

Content-type: application/json

{
"jobQueue": "string"
}

URI Request Parameters

The request does not use any URI parameters.

Request Body

The request accepts the following data in JSON format.

jobQueue

The short name or full Amazon Resource Name (ARN) of the queue to delete.

Type: String

Required: Yes

Response Syntax

HTTP/1.1 200

DeleteJobQueue API Version 2016-08-10 38

AWS Batch API Reference

Response Elements

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

Errors
ClientException

HTTP Status Code: 400

ServerException

These errors are usually caused by a server issue.

HTTP Status Code: 500

Examples

In the following example or examples, the Authorization header contents ( [authorization-

params] ) must be replaced with an AWS Signature Version 4 signature. For more information
about creating these signatures, see Signature Version 4 Signing Process in the AWS General
Reference.

Example

This example deletes the GPGPU job queue.

Sample Request

POST /v1/deletejobqueue HTTP/1.1

Response Elements API Version 2016-08-10 39

AWS Batch API Reference

Host: batch.us-east-1.amazonaws.com
Accept-Encoding: identity
Content-Length: [content-length]
Authorization: [authorization-params]
X-Amz-Date: 20161128T201857Z
User-Agent: aws-cli/1.11.21 Python/2.7.12 Darwin/16.1.0 botocore/1.4.78

{
"jobQueue": "GPGPU"
}

Sample Response

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 2
Connection: keep-alive
Date: Mon, 28 Nov 2016 20:18:57 GMT
x-amzn-RequestId: [request-id]
X-Amzn-Trace-Id: [trace-id]
X-Cache: Miss from cloudfront
Via: 1.1 56908f89e8d17ba579c0607313114955.cloudfront.net (CloudFront)
X-Amz-Cf-Id: UnpbX7PjdrV3N-Y79pD6eV3DfqYUXdEx3HAI9VYhUZ8h7yRBi5_ZVQ==

{}

See Also

For more information about using this API in one of the language-speciﬁc AWS SDKs, see the
following:

• AWS Command Line Interface

• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go v2
• AWS SDK for Java V2
• AWS SDK for JavaScript V3
• AWS SDK for PHP V3
• AWS SDK for Python

• AWS SDK for Ruby V3

POST /v1/deleteschedulingpolicy HTTP/1.1

Content-type: application/json

{
"arn": "string"
}

URI Request Parameters

The request does not use any URI parameters.

Request Body

The request accepts the following data in JSON format.

arn

The Amazon Resource Name (ARN) of the scheduling policy to delete.

Type: String

Required: Yes

Response Syntax

HTTP/1.1 200

Response Elements

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

DeleteSchedulingPolicy API Version 2016-08-10 42

AWS Batch API Reference

Errors
ClientException

HTTP Status Code: 400

ServerException

These errors are usually caused by a server issue.

HTTP Status Code: 500

Examples

In the following example or examples, the Authorization header contents ( [authorization-

params] ) must be replaced with an AWS Signature Version 4 signature. For more information
about creating these signatures, see Signature Version 4 Signing Process in the AWS General
Reference.

Example

This example deletes a scheduling policy with the speciﬁed ARN.

Sample Request

POST /v1/deleteschedulingpolicy HTTP/1.1

Errors API Version 2016-08-10 43

AWS Batch API Reference

Authorization: [authorization-params]
Content-Length: [content-length]

{
"arn": "arn:aws:batch:us-east-1:123456789012:scheduling-policy/
ExampleFairSharePolicy2"
}

Sample Response

HTTP/1.1 200 OK
Date: Wed, 29 Sep 2021 00:58:26 GMT
Content-Type: application/json
Content-Length: 2
x-amzn-RequestId: [request-id]
Access-Control-Allow-Origin: *
x-amz-apigw-id: [apigw-id]
Access-Control-Expose-Headers: X-amzn-errortype,X-amzn-requestid,X-amzn-errormessage,X-
amzn-trace-id,X-amz-apigw-id,date
X-Amzn-Trace-Id: [trace-id]
Connection: keep-alive

{}

See Also

For more information about using this API in one of the language-speciﬁc AWS SDKs, see the
following:

• AWS Command Line Interface

• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go v2
• AWS SDK for Java V2
• AWS SDK for JavaScript V3
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3

POST /v1/deregisterjobdefinition HTTP/1.1

Content-type: application/json

{
"jobDefinition": "string"
}

URI Request Parameters

The request does not use any URI parameters.

Request Body

The request accepts the following data in JSON format.

jobDeﬁnition

The name and revision (name:revision) or full Amazon Resource Name (ARN) of the job
deﬁnition to deregister.

Type: String

Required: Yes

Response Syntax

HTTP/1.1 200

Response Elements

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

DeregisterJobDeﬁnition API Version 2016-08-10 46

AWS Batch API Reference

Errors
ClientException

HTTP Status Code: 400

ServerException

These errors are usually caused by a server issue.

HTTP Status Code: 500

Example

This example deregisters a job deﬁnition called sleep10.

Sample Request

POST /v1/deregisterjobdefinition HTTP/1.1

Host: batch.us-east-1.amazonaws.com
Accept-Encoding: identity
Content-Length: [content-length]
Authorization: [authorization-params]
X-Amz-Date: 20161128T215745Z

Errors API Version 2016-08-10 47

AWS Batch API Reference

User-Agent: aws-cli/1.11.21 Python/2.7.12 Darwin/16.1.0 botocore/1.4.78

{
"jobDefinition": "sleep10:1"
}

Sample Response

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 2
Connection: keep-alive
Date: Mon, 28 Nov 2016 21:57:45 GMT
x-amzn-RequestId: [request-id]
X-Amzn-Trace-Id: [trace-id]
X-Cache: Miss from cloudfront
Via: 1.1 e892630891779ff1ccadccf205a776f3.cloudfront.net (CloudFront)
X-Amz-Cf-Id: wKAY_NOTbvY8PFcmo1aGja0xqGLxsTJgEtuc1KosPYAPYL8icYwvKw==

{}

See Also
For more information about using this API in one of the language-speciﬁc AWS SDKs, see the
following:

• AWS Command Line Interface

• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go v2
• AWS SDK for Java V2
• AWS SDK for JavaScript V3
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3

If you're using an unmanaged compute environment, you can use the

DescribeComputeEnvironment operation to determine the ecsClusterArn that you launch
your Amazon ECS container instances into.

Request Syntax

POST /v1/describecomputeenvironments HTTP/1.1

Content-type: application/json

{
"computeEnvironments": [ "string" ],
"maxResults": number,
"nextToken": "string"
}

URI Request Parameters

The request does not use any URI parameters.

Request Body
The request accepts the following data in JSON format.

computeEnvironments

A list of up to 100 compute environment names or full Amazon Resource Name (ARN) entries.

Type: Array of strings

Required: No
maxResults

The maximum number of cluster results returned by DescribeComputeEnvironments

in paginated output. When this parameter is used, DescribeComputeEnvironments
only returns maxResults results in a single page along with a nextToken response
element. The remaining results of the initial request can be seen by sending another
DescribeComputeEnvironments request with the returned nextToken value. This value can

DescribeComputeEnvironments API Version 2016-08-10 49

AWS Batch API Reference

be between 1 and 100. If this parameter isn't used, then DescribeComputeEnvironments

returns up to 100 results and a nextToken value if applicable.

Type: Integer

Required: No
nextToken

The nextToken value returned from a previous paginated DescribeComputeEnvironments

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.

Note
Treat this token as an opaque identiﬁer that's only used to retrieve the next items in a
list and not for other programmatic purposes.

Type: String

Required: No

Response Syntax

HTTP/1.1 200
Content-type: application/json

{
"computeEnvironments": [
{
"computeEnvironmentArn": "string",
"computeEnvironmentName": "string",
"computeResources": {
"allocationStrategy": "string",
"bidPercentage": number,
"desiredvCpus": number,
"ec2Configuration": [
{
"imageIdOverride": "string",
"imageKubernetesVersion": "string",

Response Syntax API Version 2016-08-10 50

AWS Batch API Reference

"imageType": "string"
}
],
"ec2KeyPair": "string",
"imageId": "string",
"instanceRole": "string",
"instanceTypes": [ "string" ],
"launchTemplate": {
"launchTemplateId": "string",
"launchTemplateName": "string",
"version": "string"
},
"maxvCpus": number,
"minvCpus": number,
"placementGroup": "string",
"securityGroupIds": [ "string" ],
"spotIamFleetRole": "string",
"subnets": [ "string" ],
"tags": {
"string" : "string"
},
"type": "string"
},
"containerOrchestrationType": "string",
"context": "string",
"ecsClusterArn": "string",
"eksConfiguration": {
"eksClusterArn": "string",
"kubernetesNamespace": "string"
},
"serviceRole": "string",
"state": "string",
"status": "string",
"statusReason": "string",
"tags": {
"string" : "string"
},
"type": "string",
"unmanagedvCpus": number,
"updatePolicy": {
"jobExecutionTimeoutMinutes": number,
"terminateJobsOnUpdate": boolean
},
"uuid": "string"

Response Syntax API Version 2016-08-10 51

AWS Batch API Reference

}
],
"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.

computeEnvironments

The list of compute environments.

Type: Array of ComputeEnvironmentDetail objects

nextToken

The nextToken value to include in a future DescribeComputeEnvironments request. When

the results of a DescribeComputeEnvironments 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

Errors
ClientException

HTTP Status Code: 400

ServerException

These errors are usually caused by a server issue.

HTTP Status Code: 500

Response Elements API Version 2016-08-10 52

AWS Batch API Reference

Example

This example describes the P3OnDemand compute environment.

Sample Request

POST /v1/describecomputeenvironments HTTP/1.1

Host: batch.us-east-1.amazonaws.com
Accept-Encoding: identity
Content-Length: [content-length]
Authorization: AUTHPARAMS
X-Amz-Date: 20161128T193355Z
User-Agent: aws-cli/1.11.21 Python/2.7.12 Darwin/16.1.0 botocore/1.4.78

{
"computeEnvironments": [
"P3OnDemand"
]
}

Sample Response

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: [content-length]
Connection: keep-alive
Date: Mon, 28 Nov 2016 19:33:56 GMT
x-amzn-RequestId: [request-id]
X-Amzn-Trace-Id: [trace-id]

Examples API Version 2016-08-10 53

AWS Batch API Reference

X-Cache: Miss from cloudfront

Via: 1.1 56908f89e8d17ba579c0607313114955.cloudfront.net (CloudFront)
X-Amz-Cf-Id: FbgslaatWhj_yGhfkSCTPpPtjiuVuFOBns-kK5EsaasYQC5p2FnpiQ==

{
"computeEnvironments": [{
"computeEnvironmentName": "P3OnDemand",
"computeEnvironmentArn": "arn:aws:batch:us-east-1:123456789012:compute-environment/
P3OnDemand",
"ecsClusterArn": "arn:aws:ecs:us-east-1:123456789012:cluster/
P3OnDemand_Batch_2c06f29d-d1fe-3a49-879d-42394c86effc",
"type": "MANAGED",
"state": "ENABLED",
"status": "VALID",
"statusReason": "ComputeEnvironment Healthy",
"computeResources": {
"type": "EC2",
"minvCpus": 0,
"maxvCpus": 128,
"desiredvCpus": 48,
"instanceTypes": ["p3"],
"subnets": ["subnet-220c0e0a", "subnet-1a95556d", "subnet-978f6dce"],
"securityGroupIds": ["sg-cf5093b2"],
"ec2KeyPair": "id_rsa",
"instanceRole": "ecsInstanceRole",
"tags": {
"Name": "Batch Instance - P3OnDemand",
"Department": "Management"
}
},
"serviceRole": "arn:aws:iam::123456789012:role/AWSBatchServiceRole"
}]
}

See Also

For more information about using this API in one of the language-speciﬁc AWS SDKs, see the
following:

• AWS Command Line Interface

• AWS SDK for .NET
• AWS SDK for C++

• AWS SDK for Go v2

• AWS SDK for Java V2
• AWS SDK for JavaScript V3
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3

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.

jobDeﬁnitionName

The name of the job deﬁnition to describe.

Type: String

Required: No
jobDeﬁnitions

A list of up to 100 job deﬁnitions. 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.

DescribeJobDeﬁnitions API Version 2016-08-10 56

AWS Batch API Reference

Type: Array of strings

Required: No
maxResults

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
nextToken

The nextToken value returned from a previous paginated DescribeJobDefinitions

Note
Treat this token as an opaque identiﬁer that's only used to retrieve the next items in a
list and not for other programmatic purposes.

Type: String

Required: No
status

The status used to ﬁlter job deﬁnitions.

Type: String

Required: No

Request Body API Version 2016-08-10 57

AWS Batch API Reference

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" ],

Response Syntax API Version 2016-08-10 58

AWS Batch API Reference

"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,
"repositoryCredentials": {
"credentialsParameter": "string"
},
"resourceRequirements": [
{
"type": "string",
"value": "string"
}
],
"runtimePlatform": {
"cpuArchitecture": "string",
"operatingSystemFamily": "string"
},
"secrets": [
{

Response Syntax API Version 2016-08-10 59

AWS Batch API Reference

"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"
}
]
},
"ecsProperties": {
"taskProperties": [
{
"containers": [
{
"command": [ "string" ],
"dependsOn": [
{
"condition": "string",
"containerName": "string"
}
],

Response Syntax API Version 2016-08-10 60

AWS Batch API Reference

"environment": [
{
"name": "string",
"value": "string"
}
],
"essential": boolean,
"image": "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"
}
]
},
"mountPoints": [
{
"containerPath": "string",
"readOnly": boolean,

Response Syntax API Version 2016-08-10 61

AWS Batch API Reference

"sourceVolume": "string"
}
],
"name": "string",
"privileged": boolean,
"readonlyRootFilesystem": boolean,
"repositoryCredentials": {
"credentialsParameter": "string"
},
"resourceRequirements": [
{
"type": "string",
"value": "string"
}
],
"secrets": [
{
"name": "string",
"valueFrom": "string"
}
],
"ulimits": [
{
"hardLimit": number,
"name": "string",
"softLimit": number
}
],
"user": "string"
}
],
"ephemeralStorage": {
"sizeInGiB": number
},
"executionRoleArn": "string",
"ipcMode": "string",
"networkConfiguration": {
"assignPublicIp": "string"
},
"pidMode": "string",
"platformVersion": "string",
"runtimePlatform": {
"cpuArchitecture": "string",
"operatingSystemFamily": "string"

Response Syntax API Version 2016-08-10 62

AWS Batch API Reference

},
"taskRoleArn": "string",
"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"

Response Syntax API Version 2016-08-10 63

AWS Batch API Reference

}
},
"securityContext": {
"allowPrivilegeEscalation": boolean,
"privileged": boolean,
"readOnlyRootFilesystem": boolean,
"runAsGroup": number,
"runAsNonRoot": boolean,
"runAsUser": number
},
"volumeMounts": [
{
"mountPath": "string",
"name": "string",
"readOnly": boolean
}
]
}
],
"dnsPolicy": "string",
"hostNetwork": boolean,
"imagePullSecrets": [
{
"name": "string"
}
],
"initContainers": [
{
"args": [ "string" ],
"command": [ "string" ],
"env": [
{
"name": "string",
"value": "string"
}
],
"image": "string",
"imagePullPolicy": "string",
"name": "string",
"resources": {
"limits": {
"string" : "string"
},
"requests": {

Response Syntax API Version 2016-08-10 64

AWS Batch API Reference

"string" : "string"
}
},
"securityContext": {
"allowPrivilegeEscalation": boolean,
"privileged": boolean,
"readOnlyRootFilesystem": boolean,
"runAsGroup": number,
"runAsNonRoot": boolean,
"runAsUser": number
},
"volumeMounts": [
{
"mountPath": "string",
"name": "string",
"readOnly": boolean
}
]
}
],
"metadata": {
"labels": {
"string" : "string"
}
},
"serviceAccountName": "string",
"shareProcessNamespace": boolean,
"volumes": [
{
"emptyDir": {
"medium": "string",
"sizeLimit": "string"
},
"hostPath": {
"path": "string"
},
"name": "string",
"secret": {
"optional": boolean,
"secretName": "string"
}
}
]
}

Response Syntax API Version 2016-08-10 65

AWS Batch API Reference

},
"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
}
]

Response Syntax API Version 2016-08-10 66

AWS Batch API Reference

},
"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,
"repositoryCredentials": {
"credentialsParameter": "string"
},
"resourceRequirements": [
{
"type": "string",
"value": "string"
}
],
"runtimePlatform": {
"cpuArchitecture": "string",
"operatingSystemFamily": "string"
},
"secrets": [
{
"name": "string",
"valueFrom": "string"
}

Response Syntax API Version 2016-08-10 67

AWS Batch API Reference

],
"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"
}
]
},
"ecsProperties": {
"taskProperties": [
{
"containers": [
{
"command": [ "string" ],
"dependsOn": [
{
"condition": "string",
"containerName": "string"
}
],
"environment": [
{
"name": "string",

Response Syntax API Version 2016-08-10 68

AWS Batch API Reference

"value": "string"
}
],
"essential": boolean,
"image": "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"
}
]
},
"mountPoints": [
{
"containerPath": "string",
"readOnly": boolean,
"sourceVolume": "string"
}
],

Response Syntax API Version 2016-08-10 69

AWS Batch API Reference

"name": "string",
"privileged": boolean,
"readonlyRootFilesystem": boolean,
"repositoryCredentials": {
"credentialsParameter": "string"
},
"resourceRequirements": [
{
"type": "string",
"value": "string"
}
],
"secrets": [
{
"name": "string",
"valueFrom": "string"
}
],
"ulimits": [
{
"hardLimit": number,
"name": "string",
"softLimit": number
}
],
"user": "string"
}
],
"ephemeralStorage": {
"sizeInGiB": number
},
"executionRoleArn": "string",
"ipcMode": "string",
"networkConfiguration": {
"assignPublicIp": "string"
},
"pidMode": "string",
"platformVersion": "string",
"runtimePlatform": {
"cpuArchitecture": "string",
"operatingSystemFamily": "string"
},
"taskRoleArn": "string",
"volumes": [

Response Syntax API Version 2016-08-10 70

AWS Batch API Reference

{
"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": {

Response Syntax API Version 2016-08-10 71

AWS Batch API Reference

"allowPrivilegeEscalation": boolean,
"privileged": boolean,
"readOnlyRootFilesystem": boolean,
"runAsGroup": number,
"runAsNonRoot": boolean,
"runAsUser": number
},
"volumeMounts": [
{
"mountPath": "string",
"name": "string",
"readOnly": boolean
}
]
}
],
"dnsPolicy": "string",
"hostNetwork": boolean,
"imagePullSecrets": [
{
"name": "string"
}
],
"initContainers": [
{
"args": [ "string" ],
"command": [ "string" ],
"env": [
{
"name": "string",
"value": "string"
}
],
"image": "string",
"imagePullPolicy": "string",
"name": "string",
"resources": {
"limits": {
"string" : "string"
},
"requests": {
"string" : "string"
}
},

Response Syntax API Version 2016-08-10 72

AWS Batch API Reference

"securityContext": {
"allowPrivilegeEscalation": boolean,
"privileged": boolean,
"readOnlyRootFilesystem": boolean,
"runAsGroup": number,
"runAsNonRoot": boolean,
"runAsUser": number
},
"volumeMounts": [
{
"mountPath": "string",
"name": "string",
"readOnly": boolean
}
]
}
],
"metadata": {
"labels": {
"string" : "string"
}
},
"serviceAccountName": "string",
"shareProcessNamespace": boolean,
"volumes": [
{
"emptyDir": {
"medium": "string",
"sizeLimit": "string"
},
"hostPath": {
"path": "string"
},
"name": "string",
"secret": {
"optional": boolean,
"secretName": "string"
}
}
]
}
},
"instanceTypes": [ "string" ],
"targetNodes": "string"

Response Syntax API Version 2016-08-10 73

AWS Batch API Reference

}
],
"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.

jobDeﬁnitions

The list of job deﬁnitions.

Response Elements API Version 2016-08-10 74

AWS Batch API Reference

Type: Array of JobDeﬁnition objects

nextToken

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

Errors
ClientException

HTTP Status Code: 400

ServerException

These errors are usually caused by a server issue.

HTTP Status Code: 500

Example

This example describes all of your active job deﬁnitions.

Errors API Version 2016-08-10 75

AWS Batch API Reference

Sample Request

POST /v1/describejobdefinitions HTTP/1.1

Host: batch.us-east-1.amazonaws.com
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 688936cc730f240888e6a59a81892a3d.cloudfront.net (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": [],

Examples API Version 2016-08-10 76

AWS Batch API Reference

"ulimits": []
}
}]
}

See Also
For more information about using this API in one of the language-speciﬁc AWS SDKs, see the
following:

• AWS Command Line Interface

• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go v2
• AWS SDK for Java V2
• AWS SDK for JavaScript V3
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3

POST /v1/describejobqueues HTTP/1.1

Content-type: application/json

{
"jobQueues": [ "string" ],
"maxResults": number,
"nextToken": "string"
}

URI Request Parameters

The request does not use any URI parameters.

Request Body

The request accepts the following data in JSON format.

jobQueues

A list of up to 100 queue names or full queue Amazon Resource Name (ARN) entries.

Type: Array of strings

Required: No
maxResults

The maximum number of results returned by DescribeJobQueues in paginated output. When

this parameter is used, DescribeJobQueues 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 DescribeJobQueues request with the returned nextToken value. This value
can be between 1 and 100. If this parameter isn't used, then DescribeJobQueues returns up
to 100 results and a nextToken value if applicable.

Type: Integer

DescribeJobQueues API Version 2016-08-10 78

AWS Batch API Reference

Required: No
nextToken

The nextToken value returned from a previous paginated DescribeJobQueues 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.

Note
Treat this token as an opaque identiﬁer that's only used to retrieve the next items in a
list and not for other programmatic purposes.

Type: String

Required: No

Response Syntax

HTTP/1.1 200
Content-type: application/json

{
"jobQueues": [
{
"computeEnvironmentOrder": [
{
"computeEnvironment": "string",
"order": number
}
],
"jobQueueArn": "string",
"jobQueueName": "string",
"jobStateTimeLimitActions": [
{
"action": "string",
"maxTimeSeconds": number,
"reason": "string",
"state": "string"

Response Syntax API Version 2016-08-10 79

AWS Batch API Reference

}
],
"priority": number,
"schedulingPolicyArn": "string",
"state": "string",
"status": "string",
"statusReason": "string",
"tags": {
"string" : "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.

jobQueues

The list of job queues.

Type: Array of JobQueueDetail objects

nextToken

The nextToken value to include in a future DescribeJobQueues request. When the results
of a DescribeJobQueues 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

Errors
ClientException

Response Elements API Version 2016-08-10 80

AWS Batch API Reference

HTTP Status Code: 400

ServerException

These errors are usually caused by a server issue.

HTTP Status Code: 500

Examples

In the following example or examples, the Authorization header contents ( [authorization-

params] ) must be replaced with an AWS Signature Version 4 signature. For more information
about creating these signatures, see Signature Version 4 Signing Process in the AWS General
Reference.

Example

This example describes the HighPriority job queue.

Sample Request

POST /v1/describejobqueues HTTP/1.1

Host: batch.us-east-1.amazonaws.com
Accept-Encoding: identity
Content-Length: [content-length]
Authorization: [authorization-params]
X-Amz-Date: 20161128T194731Z
User-Agent: aws-cli/1.11.21 Python/2.7.12 Darwin/16.1.0 botocore/1.4.78

{
"jobQueues": [
"HighPriority"
]
}

Examples API Version 2016-08-10 81

AWS Batch API Reference

Sample Response

HTTP/1.1 200 OK
Date: Mon, 28 Nov 2016 19:47:32 GMT
Content-Type: application/json
Content-Length: [content-length]
Connection: keep-alive
x-amzn-RequestId: [request-id]
X-Amzn-Trace-Id: [trace-id]
X-Cache: Miss from cloudfront
Via: 1.1 7bfcc2251021d9dc94a87ff179d69731.cloudfront.net (CloudFront)
X-Amz-Cf-Id: dwf7P2pnEYCxN1C3XdApqDtqzLfjpWAjbHvskd9oUqz4OUn9pvtx3Q==

{
"jobQueues": [{
"jobQueueName": "HighPriority",
"jobQueueArn": "arn:aws:batch:us-east-1:123456789012:job-queue/HighPriority",
"state": "ENABLED",
"status": "VALID",
"statusReason": "JobQueue Healthy",
"priority": 10,
"computeEnvironmentOrder": [{
"order": 1,
"computeEnvironment": "arn:aws:batch:us-east-1:123456789012:compute-environment/
C4OnDemand"
}]
}]
}

See Also

For more information about using this API in one of the language-speciﬁc AWS SDKs, see the
following:

• AWS Command Line Interface

• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go v2
• AWS SDK for Java V2
• AWS SDK for JavaScript V3

• AWS SDK for PHP V3

• AWS SDK for Python
• AWS SDK for Ruby V3

POST /v1/describejobs HTTP/1.1

Content-type: application/json

{
"jobs": [ "string" ]
}

URI Request Parameters

The request does not use any URI parameters.

Request Body
The request accepts the following data in JSON format.

jobs

A list of up to 100 job IDs.

Type: Array of strings

Required: Yes

Response Syntax

HTTP/1.1 200
Content-type: application/json

{
"jobs": [
{
"arrayProperties": {
"index": number,
"size": number,
"statusSummary": {

DescribeJobs API Version 2016-08-10 84

AWS Batch API Reference

"string" : number
}
},
"attempts": [
{
"container": {
"containerInstanceArn": "string",
"exitCode": number,
"logStreamName": "string",
"networkInterfaces": [
{
"attachmentId": "string",
"ipv6Address": "string",
"privateIpv4Address": "string"
}
],
"reason": "string",
"taskArn": "string"
},
"startedAt": number,
"statusReason": "string",
"stoppedAt": number,
"taskProperties": [
{
"containerInstanceArn": "string",
"containers": [
{
"exitCode": number,
"logStreamName": "string",
"name": "string",
"networkInterfaces": [
{
"attachmentId": "string",
"ipv6Address": "string",
"privateIpv4Address": "string"
}
],
"reason": "string"
}
],
"taskArn": "string"
}
]
}

Response Syntax API Version 2016-08-10 85

AWS Batch API Reference

],
"container": {
"command": [ "string" ],
"containerInstanceArn": "string",
"environment": [
{
"name": "string",
"value": "string"
}
],
"ephemeralStorage": {
"sizeInGiB": number
},
"executionRoleArn": "string",
"exitCode": number,
"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": {

Response Syntax API Version 2016-08-10 86

AWS Batch API Reference

"string" : "string"
},
"secretOptions": [
{
"name": "string",
"valueFrom": "string"
}
]
},
"logStreamName": "string",
"memory": number,
"mountPoints": [
{
"containerPath": "string",
"readOnly": boolean,
"sourceVolume": "string"
}
],
"networkConfiguration": {
"assignPublicIp": "string"
},
"networkInterfaces": [
{
"attachmentId": "string",
"ipv6Address": "string",
"privateIpv4Address": "string"
}
],
"privileged": boolean,
"readonlyRootFilesystem": boolean,
"reason": "string",
"repositoryCredentials": {
"credentialsParameter": "string"
},
"resourceRequirements": [
{
"type": "string",
"value": "string"
}
],
"runtimePlatform": {
"cpuArchitecture": "string",
"operatingSystemFamily": "string"
},

Response Syntax API Version 2016-08-10 87

AWS Batch API Reference

"secrets": [
{
"name": "string",
"valueFrom": "string"
}
],
"taskArn": "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"
}
]
},
"createdAt": number,
"dependsOn": [
{
"jobId": "string",
"type": "string"
}
],
"ecsProperties": {
"taskProperties": [

Response Syntax API Version 2016-08-10 88

AWS Batch API Reference

{
"containerInstanceArn": "string",
"containers": [
{
"command": [ "string" ],
"dependsOn": [
{
"condition": "string",
"containerName": "string"
}
],
"environment": [
{
"name": "string",
"value": "string"
}
],
"essential": boolean,
"exitCode": number,
"image": "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"

Response Syntax API Version 2016-08-10 89

AWS Batch API Reference

},
"secretOptions": [
{
"name": "string",
"valueFrom": "string"
}
]
},
"logStreamName": "string",
"mountPoints": [
{
"containerPath": "string",
"readOnly": boolean,
"sourceVolume": "string"
}
],
"name": "string",
"networkInterfaces": [
{
"attachmentId": "string",
"ipv6Address": "string",
"privateIpv4Address": "string"
}
],
"privileged": boolean,
"readonlyRootFilesystem": boolean,
"reason": "string",
"repositoryCredentials": {
"credentialsParameter": "string"
},
"resourceRequirements": [
{
"type": "string",
"value": "string"
}
],
"secrets": [
{
"name": "string",
"valueFrom": "string"
}
],
"ulimits": [
{

Response Syntax API Version 2016-08-10 90

AWS Batch API Reference

"hardLimit": number,
"name": "string",
"softLimit": number
}
],
"user": "string"
}
],
"ephemeralStorage": {
"sizeInGiB": number
},
"executionRoleArn": "string",
"ipcMode": "string",
"networkConfiguration": {
"assignPublicIp": "string"
},
"pidMode": "string",
"platformVersion": "string",
"runtimePlatform": {
"cpuArchitecture": "string",
"operatingSystemFamily": "string"
},
"taskArn": "string",
"taskRoleArn": "string",
"volumes": [
{
"efsVolumeConfiguration": {
"authorizationConfig": {
"accessPointId": "string",
"iam": "string"
},
"fileSystemId": "string",
"rootDirectory": "string",
"transitEncryption": "string",
"transitEncryptionPort": number
},
"host": {
"sourcePath": "string"
},
"name": "string"
}
]
}
]

Response Syntax API Version 2016-08-10 91

AWS Batch API Reference

},
"eksAttempts": [
{
"containers": [
{
"exitCode": number,
"name": "string",
"reason": "string"
}
],
"eksClusterArn": "string",
"initContainers": [
{
"exitCode": number,
"name": "string",
"reason": "string"
}
],
"nodeName": "string",
"podName": "string",
"startedAt": number,
"statusReason": "string",
"stoppedAt": number
}
],
"eksProperties": {
"podProperties": {
"containers": [
{
"args": [ "string" ],
"command": [ "string" ],
"env": [
{
"name": "string",
"value": "string"
}
],
"exitCode": number,
"image": "string",
"imagePullPolicy": "string",
"name": "string",
"reason": "string",
"resources": {
"limits": {

Response Syntax API Version 2016-08-10 92

AWS Batch API Reference

"string" : "string"
},
"requests": {
"string" : "string"
}
},
"securityContext": {
"allowPrivilegeEscalation": boolean,
"privileged": boolean,
"readOnlyRootFilesystem": boolean,
"runAsGroup": number,
"runAsNonRoot": boolean,
"runAsUser": number
},
"volumeMounts": [
{
"mountPath": "string",
"name": "string",
"readOnly": boolean
}
]
}
],
"dnsPolicy": "string",
"hostNetwork": boolean,
"imagePullSecrets": [
{
"name": "string"
}
],
"initContainers": [
{
"args": [ "string" ],
"command": [ "string" ],
"env": [
{
"name": "string",
"value": "string"
}
],
"exitCode": number,
"image": "string",
"imagePullPolicy": "string",
"name": "string",

Response Syntax API Version 2016-08-10 93

AWS Batch API Reference

"reason": "string",
"resources": {
"limits": {
"string" : "string"
},
"requests": {
"string" : "string"
}
},
"securityContext": {
"allowPrivilegeEscalation": boolean,
"privileged": boolean,
"readOnlyRootFilesystem": boolean,
"runAsGroup": number,
"runAsNonRoot": boolean,
"runAsUser": number
},
"volumeMounts": [
{
"mountPath": "string",
"name": "string",
"readOnly": boolean
}
]
}
],
"metadata": {
"labels": {
"string" : "string"
}
},
"nodeName": "string",
"podName": "string",
"serviceAccountName": "string",
"shareProcessNamespace": boolean,
"volumes": [
{
"emptyDir": {
"medium": "string",
"sizeLimit": "string"
},
"hostPath": {
"path": "string"
},

Response Syntax API Version 2016-08-10 94

AWS Batch API Reference

"name": "string",
"secret": {
"optional": boolean,
"secretName": "string"
}
}
]
}
},
"isCancelled": boolean,
"isTerminated": boolean,
"jobArn": "string",
"jobDefinition": "string",
"jobId": "string",
"jobName": "string",
"jobQueue": "string",
"nodeDetails": {
"isMainNode": boolean,
"nodeIndex": number
},
"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": [

Response Syntax API Version 2016-08-10 95

AWS Batch API Reference

{
"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,
"repositoryCredentials": {

Response Syntax API Version 2016-08-10 96

AWS Batch API Reference

"credentialsParameter": "string"
},
"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"
}

Response Syntax API Version 2016-08-10 97

AWS Batch API Reference

]
},
"ecsProperties": {
"taskProperties": [
{
"containers": [
{
"command": [ "string" ],
"dependsOn": [
{
"condition": "string",
"containerName": "string"
}
],
"environment": [
{
"name": "string",
"value": "string"
}
],
"essential": boolean,
"image": "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",

Response Syntax API Version 2016-08-10 98

AWS Batch API Reference

"options": {
"string" : "string"
},
"secretOptions": [
{
"name": "string",
"valueFrom": "string"
}
]
},
"mountPoints": [
{
"containerPath": "string",
"readOnly": boolean,
"sourceVolume": "string"
}
],
"name": "string",
"privileged": boolean,
"readonlyRootFilesystem": boolean,
"repositoryCredentials": {
"credentialsParameter": "string"
},
"resourceRequirements": [
{
"type": "string",
"value": "string"
}
],
"secrets": [
{
"name": "string",
"valueFrom": "string"
}
],
"ulimits": [
{
"hardLimit": number,
"name": "string",
"softLimit": number
}
],
"user": "string"
}

Response Syntax API Version 2016-08-10 99

AWS Batch API Reference

],
"ephemeralStorage": {
"sizeInGiB": number
},
"executionRoleArn": "string",
"ipcMode": "string",
"networkConfiguration": {
"assignPublicIp": "string"
},
"pidMode": "string",
"platformVersion": "string",
"runtimePlatform": {
"cpuArchitecture": "string",
"operatingSystemFamily": "string"
},
"taskRoleArn": "string",
"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": [

Response Syntax API Version 2016-08-10 100

AWS Batch API Reference

{
"name": "string",
"value": "string"
}
],
"image": "string",
"imagePullPolicy": "string",
"name": "string",
"resources": {
"limits": {
"string" : "string"
},
"requests": {
"string" : "string"
}
},
"securityContext": {
"allowPrivilegeEscalation": boolean,
"privileged": boolean,
"readOnlyRootFilesystem": boolean,
"runAsGroup": number,
"runAsNonRoot": boolean,
"runAsUser": number
},
"volumeMounts": [
{
"mountPath": "string",
"name": "string",
"readOnly": boolean
}
]
}
],
"dnsPolicy": "string",
"hostNetwork": boolean,
"imagePullSecrets": [
{
"name": "string"
}
],
"initContainers": [
{
"args": [ "string" ],
"command": [ "string" ],

Response Syntax API Version 2016-08-10 101

AWS Batch API Reference

"env": [
{
"name": "string",
"value": "string"
}
],
"image": "string",
"imagePullPolicy": "string",
"name": "string",
"resources": {
"limits": {
"string" : "string"
},
"requests": {
"string" : "string"
}
},
"securityContext": {
"allowPrivilegeEscalation": boolean,
"privileged": boolean,
"readOnlyRootFilesystem": boolean,
"runAsGroup": number,
"runAsNonRoot": boolean,
"runAsUser": number
},
"volumeMounts": [
{
"mountPath": "string",
"name": "string",
"readOnly": boolean
}
]
}
],
"metadata": {
"labels": {
"string" : "string"
}
},
"serviceAccountName": "string",
"shareProcessNamespace": boolean,
"volumes": [
{
"emptyDir": {

Response Syntax API Version 2016-08-10 102

AWS Batch API Reference

"medium": "string",
"sizeLimit": "string"
},
"hostPath": {
"path": "string"
},
"name": "string",
"secret": {
"optional": boolean,
"secretName": "string"
}
}
]
}
},
"instanceTypes": [ "string" ],
"targetNodes": "string"
}
],
"numNodes": number
},
"parameters": {
"string" : "string"
},
"platformCapabilities": [ "string" ],
"propagateTags": boolean,
"retryStrategy": {
"attempts": number,
"evaluateOnExit": [
{
"action": "string",
"onExitCode": "string",
"onReason": "string",
"onStatusReason": "string"
}
]
},
"schedulingPriority": number,
"shareIdentifier": "string",
"startedAt": number,
"status": "string",
"statusReason": "string",
"stoppedAt": number,
"tags": {

Response Syntax API Version 2016-08-10 103

AWS Batch API Reference

"string" : "string"
},
"timeout": {
"attemptDurationSeconds": number
}
}
]
}

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.

jobs

The list of jobs.

Type: Array of JobDetail objects

Errors
ClientException

HTTP Status Code: 400

ServerException

These errors are usually caused by a server issue.

HTTP Status Code: 500

Examples

In the following example or examples, the Authorization header contents ( [authorization-

params] ) must be replaced with an AWS Signature Version 4 signature. For more information

Response Elements API Version 2016-08-10 104

AWS Batch API Reference

about creating these signatures, see Signature Version 4 Signing Process in the AWS General
Reference.

Example

This example describes a job with the speciﬁed job ID.

Sample Request

POST /v1/describejobs HTTP/1.1

Host: batch.us-east-1.amazonaws.com
Accept-Encoding: identity
Content-Length: [content-length]
Authorization: [authorization-params]
X-Amz-Date: 20170327T151323Z
User-Agent: aws-cli/1.11.22 Python/2.7.12 Darwin/16.1.0 botocore/1.4.79

{
"jobs": [
"0668da57-1bcc-478b-bc14-5d4f1c1cef48"
]
}

Sample Response

HTTP/1.1 200 OK
Date: Mon, 27 Mar 2017 15:13:13 GMT
Content-Type: application/json
Content-Length: [content-length]
Connection: keep-alive
x-amzn-RequestId: [request-id]
X-Amzn-Trace-Id: [trace-id]
X-Cache: Miss from cloudfront
Via: 1.1 8a78b675adb2cce925860f2fe4383e71.cloudfront.net (CloudFront)
X-Amz-Cf-Id: TaW8k7yrDyXHgEU2udEEOAbliIY1iPmQr4LpN80ULdqyVGR6qP0q4Q==

Examples API Version 2016-08-10 105

AWS Batch API Reference

"jobs": [
{
"jobName": "EchoAttemptNumber",
"jobId": "0668da57-1bcc-478b-bc14-5d4f1c1cef48",
"jobQueue": "arn:aws:batch:us-east-1:123456789012:job-queue/HighPriority",
"status": "FAILED",
"attempts": [
{
"container": {
"containerInstanceArn": "arn:aws:ecs:us-east-1:123456789012:container-
instance/90bfe527-119c-494a-b8fe-f5999c66d214",
"taskArn": "arn:aws:ecs:us-east-1:123456789012:task/af37d830-6978-4a2b-
b796-e890e9b477b3",
"exitCode": 1
},
"startedAt": 1490627002951,
"stoppedAt": 1490627003065,
"statusReason": "Essential container in task exited"
},
{
"container": {
"containerInstanceArn": "arn:aws:ecs:us-east-1:123456789012:container-
instance/90bfe527-119c-494a-b8fe-f5999c66d214",
"taskArn": "arn:aws:ecs:us-east-1:123456789012:task/3dfd4d0e-
a177-4798-9c13-21b7148217bc",
"exitCode": 2
},
"startedAt": 1490627019948,
"stoppedAt": 1490627020059,
"statusReason": "Essential container in task exited"
},
{
"container": {
"containerInstanceArn": "arn:aws:ecs:us-east-1:123456789012:container-
instance/90bfe527-119c-494a-b8fe-f5999c66d214",
"taskArn": "arn:aws:ecs:us-
east-1:123456789012:task/22857040-182c-4af3-85f5-bb2c71edd282",
"exitCode": 3
},
"startedAt": 1490627034798,
"stoppedAt": 1490627034949,
"statusReason": "Essential container in task exited"
}
],

Examples API Version 2016-08-10 106

AWS Batch API Reference

"statusReason": "Essential container in task exited",

"createdAt": 1490626709525,
"retryStrategy": {
"attempts": 3
},
"startedAt": 1490627034798,
"stoppedAt": 1490627034949,
"dependsOn": [],
"jobDefinition": "arn:aws:batch:us-east-1:123456789012:job-definition/
EchoAttemptNumber:1",
"parameters": {},
"container": {
"image": "amazonlinux",
"vcpus": 1,
"memory": 2,
"command": [
"/bin/bash",
"-c",
"exit $AWS_BATCH_JOB_ATTEMPT"
],
"volumes": [],
"environment": [],
"mountPoints": [],
"ulimits": [],
"exitCode": 3,
"containerInstanceArn": "arn:aws:ecs:us-east-1:123456789012:container-
instance/90bfe527-119c-494a-b8fe-f5999c66d214",
"taskArn": "arn:aws:ecs:us-east-1:123456789012:task/22857040-182c-4af3-85f5-
bb2c71edd282"
}
}
]
}

See Also

For more information about using this API in one of the language-speciﬁc AWS SDKs, see the
following:

• AWS Command Line Interface

• AWS SDK for .NET
• AWS SDK for C++

• AWS SDK for Go v2

• AWS SDK for Java V2
• AWS SDK for JavaScript V3
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3

POST /v1/describeschedulingpolicies HTTP/1.1

Content-type: application/json

{
"arns": [ "string" ]
}

URI Request Parameters

The request does not use any URI parameters.

Request Body

The request accepts the following data in JSON format.

arns

A list of up to 100 scheduling policy Amazon Resource Name (ARN) entries.

Type: Array of strings

Required: Yes

Response Syntax

HTTP/1.1 200
Content-type: application/json

{
"schedulingPolicies": [
{
"arn": "string",
"fairsharePolicy": {
"computeReservation": number,

DescribeSchedulingPolicies API Version 2016-08-10 109

AWS Batch API Reference

"shareDecaySeconds": number,
"shareDistribution": [
{
"shareIdentifier": "string",
"weightFactor": number
}
]
},
"name": "string",
"tags": {
"string" : "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.

schedulingPolicies

The list of scheduling policies.

Type: Array of SchedulingPolicyDetail objects

Errors
ClientException

HTTP Status Code: 400

ServerException

These errors are usually caused by a server issue.

HTTP Status Code: 500

Response Elements API Version 2016-08-10 110

AWS Batch API Reference

Example

This example describes the speciﬁed scheduling policies.

Sample Request

POST /v1/describeschedulingpolicies HTTP/1.1

Host: batch.us-east-1.amazonaws.com
Accept-Encoding: identity
User-Agent: aws-cli/1.20.21 Python/3.6.9 Linux/4.4.0-19041-Microsoft botocore/1.21.21
X-Amz-Date: 20210929T002059Z
X-Amz-Security-Token: [security-token]
Authorization: [authorization-params]
Content-Length: [content-length]

{
"arns": [
"arn:aws:batch:us-east-1:123456789012:scheduling-policy/ExampleFairSharePolicy",
"arn:aws:batch:us-east-1:123456789012:scheduling-policy/ExampleFairSharePolicy2"
]
}

Sample Response

HTTP/1.1 200 OK
Date: Wed, 29 Sep 2021 00:21:00 GMT
Content-Type: application/json
Content-Length: [content-length]
x-amzn-RequestId: [request-id]

Examples API Version 2016-08-10 111

AWS Batch API Reference

Access-Control-Allow-Origin: *
x-amz-apigw-id: [apigw-id]
Access-Control-Expose-Headers: X-amzn-errortype,X-amzn-requestid,X-amzn-errormessage,X-
amzn-trace-id,X-amz-apigw-id,date
X-Amzn-Trace-Id: [trace-id]
Connection: keep-alive

{
"schedulingPolicies" : [ {
"name" : "ExampleFairSharePolicy2",
"arn" : "arn:aws:batch:us-east-1:123456789012:scheduling-policy/
ExampleFairSharePolicy2",
"fairsharePolicy" : {
"shareDecaySeconds" : 3600,
"computeReservation" : 1,
"shareDistribution" : [ {
"shareIdentifier" : "MostImportant",
"weightFactor" : 1.0E-4
}, {
"shareIdentifier" : "LeastImportant",
"weightFactor" : 999.9999
} ]
},
"tags" : {
"Department" : "Documentation",
"Beef" : "Ribs",
"Hot" : "Dogs",
"Pork" : "Shoulder"
}
}, {
"name" : "ExampleFairSharePolicy",
"arn" : "arn:aws:batch:us-east-1:123456789012:scheduling-policy/
ExampleFairSharePolicy",
"fairsharePolicy" : {
"shareDecaySeconds" : 3600,
"computeReservation" : 1,
"shareDistribution" : [ {
"shareIdentifier" : "A1*",
"weightFactor" : 0.1
}, {
"shareIdentifier" : "A2",
"weightFactor" : 0.2
}, {
"shareIdentifier" : "B*",

Examples API Version 2016-08-10 112

AWS Batch API Reference

"weightFactor" : 0.8
}, {
"shareIdentifier" : "C",
"weightFactor" : 1.2
}, {
"shareIdentifier" : "D*",
"weightFactor" : 1.5
}, {
"shareIdentifier" : "E",
"weightFactor" : 1.8
} ]
},
"tags" : {
"Department" : "Engineering",
"Beef" : "Brisket",
"Hot" : "Dog",
"Pork" : "Ribs"
}
} ]
}

See Also
For more information about using this API in one of the language-speciﬁc AWS SDKs, see the
following:

• AWS Command Line Interface

• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go v2
• AWS SDK for Java V2
• AWS SDK for JavaScript V3
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3

POST /v1/getjobqueuesnapshot HTTP/1.1

Content-type: application/json

{
"jobQueue": "string"
}

URI Request Parameters

The request does not use any URI parameters.

Request Body

The request accepts the following data in JSON format.

jobQueue

The job queue’s name or full queue Amazon Resource Name (ARN).

Type: String

Required: Yes

Response Syntax

HTTP/1.1 200
Content-type: application/json

{
"frontOfQueue": {
"jobs": [
{
"earliestTimeAtPosition": number,
"jobArn": "string"

GetJobQueueSnapshot API Version 2016-08-10 114

AWS Batch API Reference

}
],
"lastUpdatedAt": number
}
}

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.

frontOfQueue

The list of the first 100 RUNNABLE jobs in each job queue. For first-in-first-out (FIFO) job
queues, jobs are ordered based on their submission time. For fair share scheduling (FSS) job
queues, jobs are ordered based on their job priority and share usage.

Type: FrontOfQueueDetail object

Errors
ClientException

HTTP Status Code: 400

ServerException

These errors are usually caused by a server issue.

HTTP Status Code: 500

See Also

For more information about using this API in one of the language-speciﬁc AWS SDKs, see the
following:

Response Elements API Version 2016-08-10 115

AWS Batch API Reference

• AWS Command Line Interface

• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go v2
• AWS SDK for Java V2
• AWS SDK for JavaScript V3
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3

You must specify only one of the following items:

• A job queue ID to return a list of jobs in that job queue

• A multi-node parallel job ID to return a list of nodes for that job
• An array job ID to return a list of the children for that job

You can ﬁlter the results by job status with the jobStatus parameter. If you don't specify a status,
only RUNNING jobs are returned.

Request Syntax

POST /v1/listjobs HTTP/1.1

Content-type: application/json

{
"arrayJobId": "string",
"filters": [
{
"name": "string",
"values": [ "string" ]
}
],
"jobQueue": "string",
"jobStatus": "string",
"maxResults": number,
"multiNodeJobId": "string",
"nextToken": "string"
}

URI Request Parameters

The request does not use any URI parameters.

Request Body
The request accepts the following data in JSON format.

ListJobs API Version 2016-08-10 117

AWS Batch API Reference

arrayJobId

The job ID for an array job. Specifying an array job ID with this parameter lists all child jobs
from within the speciﬁed array.

Type: String

Required: No
ﬁlters

The filter to apply to the query. Only one filter can be used at a time. When the filter is used,
jobStatus is ignored. The filter doesn't apply to child jobs in an array or multi-node parallel
(MNP) jobs. The results are sorted by the createdAt field, with the most recent jobs being first.
JOB_NAME

The value of the filter is a case-insensitive match for the job name. If the value ends with an
asterisk (*), the filter matches any job name that begins with the string before the '*'. This
corresponds to the jobName value. For example, test1 matches both Test1 and test1,
and test1* matches both test1 and Test10. When the JOB_NAME filter is used, the
results are grouped by the job name and version.
JOB_DEFINITION

The value for the filter is the name or Amazon Resource Name (ARN) of the job definition.
This corresponds to the jobDefinition value. The value is case sensitive. When the value
for the filter is the job definition name, the results include all the jobs that used any revision
of that job definition name. If the value ends with an asterisk (*), the filter matches any
job definition name that begins with the string before the '*'. For example, jd1 matches
only jd1, and jd1* matches both jd1 and jd1A. The version of the job definition that's
used doesn't affect the sort order. When the JOB_DEFINITION filter is used and the ARN is
used (which is in the form arn:${Partition}:batch:${Region}:${Account}:job-
definition/${JobDefinitionName}:${Revision}), the results include jobs that used
the specified revision of the job definition. Asterisk (*) isn't supported when the ARN is used.
BEFORE_CREATED_AT

The value for the ﬁlter is the time that's before the job was created. This corresponds to the
createdAt value. The value is a string representation of the number of milliseconds since
00:00:00 UTC (midnight) on January 1, 1970.

Request Body API Version 2016-08-10 118

AWS Batch API Reference

AFTER_CREATED_AT

The value for the ﬁlter is the time that's after the job was created. This corresponds to the
createdAt value. The value is a string representation of the number of milliseconds since
00:00:00 UTC (midnight) on January 1, 1970.

Type: Array of KeyValuesPair objects

Required: No
jobQueue

The name or full Amazon Resource Name (ARN) of the job queue used to list jobs.

Type: String

Required: No
jobStatus

The job status used to filter jobs in the specified queue. If the filters parameter is specified,
the jobStatus parameter is ignored and jobs with any status are returned. If you don't specify
a status, only RUNNING jobs are returned.

Type: String

Valid Values: SUBMITTED | PENDING | RUNNABLE | STARTING | RUNNING |

SUCCEEDED | FAILED

Required: No
maxResults

The maximum number of results returned by ListJobs in a paginated output. When this
parameter is used, ListJobs returns up to maxResults results in a single page and a
nextToken response element, if applicable. The remaining results of the initial request can be
seen by sending another ListJobs request with the returned nextToken value.

The following outlines key parameters and limitations:

• The minimum value is 1.
• When --job-status is used, AWS Batch returns up to 1000 values.
• When --filters is used, AWS Batch returns up to 100 values.

Request Body API Version 2016-08-10 119

AWS Batch API Reference

• If neither parameter is used, then ListJobs returns up to 1000 results (jobs that are in the
RUNNING status) and a nextToken value, if applicable.

Type: Integer

Required: No
multiNodeJobId

The job ID for a multi-node parallel job. Specifying a multi-node parallel job ID with this
parameter lists all nodes that are associated with the speciﬁed job.

Type: String

Required: No
nextToken

The nextToken value returned from a previous paginated ListJobs 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.

Note
Treat this token as an opaque identiﬁer that's only used to retrieve the next items in a
list and not for other programmatic purposes.

Type: String

Required: No

Response Syntax

HTTP/1.1 200
Content-type: application/json

{
"jobSummaryList": [
{
"arrayProperties": {

Response Syntax API Version 2016-08-10 120

AWS Batch API Reference

"index": number,
"size": number
},
"container": {
"exitCode": number,
"reason": "string"
},
"createdAt": number,
"jobArn": "string",
"jobDefinition": "string",
"jobId": "string",
"jobName": "string",
"nodeProperties": {
"isMainNode": boolean,
"nodeIndex": number,
"numNodes": number
},
"startedAt": number,
"status": "string",
"statusReason": "string",
"stoppedAt": number
}
],
"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.

jobSummaryList

A list of job summaries that match the request.

Type: Array of JobSummary objects

nextToken

The nextToken value to include in a future ListJobs request. When the results of a
ListJobs 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.

Response Elements API Version 2016-08-10 121

AWS Batch API Reference

Type: String

Errors
ClientException

HTTP Status Code: 400

ServerException

These errors are usually caused by a server issue.

HTTP Status Code: 500

Examples

In the following example or examples, the Authorization header contents ( [authorization-

params] ) must be replaced with an AWS Signature Version 4 signature. For more information
about creating these signatures, see Signature Version 4 Signing Process in the AWS General
Reference.

Example

This example lists the running jobs in the HighPriority job queue.

Sample Request

POST /v1/listjobs HTTP/1.1

Host: batch.us-east-1.amazonaws.com
Accept-Encoding: identity

Errors API Version 2016-08-10 122

AWS Batch API Reference

Content-Length: [content-length]
Authorization: [authorization-params]
X-Amz-Date: 20161129T201622Z
User-Agent: aws-cli/1.11.22 Python/2.7.12 Darwin/16.1.0 botocore/1.4.79

{
"jobQueue": "HighPriority"
}

Sample Response

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: [content-length]
Connection: keep-alive
Date: Tue, 29 Nov 2016 20:16:22 GMT
x-amzn-RequestId: [request-id]
X-Amzn-Trace-Id: [trace-id]
X-Cache: Miss from cloudfront
Via: 1.1 7f3f42df8af148df1f9f1ee7175987ad.cloudfront.net (CloudFront)
X-Amz-Cf-Id: idKR5mD8f7Luom03P9DV1bFGXsq_SIFNy_nMrTCOqZrRc0nXgHqZfg==

{
"jobSummaryList": [{
"jobId": "e66ff5fd-a1ff-4640-b1a2-0b0a142f49bb",
"jobName": "example"
}]
}

Example

This example lists jobs in the HighPriority job queue that are in the SUBMITTED job status.

Sample Request

POST /v1/listjobs HTTP/1.1

Host: batch.us-east-1.amazonaws.com
Accept-Encoding: identity
Content-Length: [content-length]
Authorization: [authorization-params]
X-Amz-Date: 20161129T201642Z
User-Agent: aws-cli/1.11.22 Python/2.7.12 Darwin/16.1.0 botocore/1.4.79

Examples API Version 2016-08-10 123

AWS Batch API Reference

{
"jobQueue": "HighPriority",
"jobStatus": "SUBMITTED"
}

Sample Response

HTTP/1.1 200 OK
Date: Tue, 29 Nov 2016 20:16:42 GMT
Content-Type: application/json
Content-Length: [content-length]
Connection: keep-alive
x-amzn-RequestId: [request-id]
X-Amzn-Trace-Id: [trace-id]
X-Cache: Miss from cloudfront
Via: 1.1 ebc28fb0ad14691ee5d6c1a49f41b878.cloudfront.net (CloudFront)
X-Amz-Cf-Id: Ngsjm0gBg2y4cDFG4uwpAmaKaT6Dejh7oGlVDmewQrUaeW_SPst_Bw==

{
"jobSummaryList": [{
"jobId": "68f0c163-fbd4-44e6-9fd1-25b14a434786",
"jobName": "example"
}]
}

See Also
For more information about using this API in one of the language-speciﬁc AWS SDKs, see the
following:

• AWS Command Line Interface

• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go v2
• AWS SDK for Java V2
• AWS SDK for JavaScript V3
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3

POST /v1/listschedulingpolicies HTTP/1.1

Content-type: application/json

{
"maxResults": number,
"nextToken": "string"
}

URI Request Parameters

The request does not use any URI parameters.

Request Body
The request accepts the following data in JSON format.

maxResults

The maximum number of results that's returned by ListSchedulingPolicies in paginated

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

Type: Integer

Required: No
nextToken

The nextToken value that's returned from a previous paginated ListSchedulingPolicies

ListSchedulingPolicies API Version 2016-08-10 126

AWS Batch API Reference

Note
Treat this token as an opaque identiﬁer that's only used to retrieve the next items in a
list and not for other programmatic purposes.

Type: String

Required: No

Response Syntax

HTTP/1.1 200
Content-type: application/json

{
"nextToken": "string",
"schedulingPolicies": [
{
"arn": "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.

nextToken

The nextToken value to include in a future ListSchedulingPolicies request. When the

results of a ListSchedulingPolicies 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
schedulingPolicies

A list of scheduling policies that match the request.

Response Syntax API Version 2016-08-10 127

AWS Batch API Reference

Type: Array of SchedulingPolicyListingDetail objects

Errors
ClientException

HTTP Status Code: 400

ServerException

These errors are usually caused by a server issue.

HTTP Status Code: 500

Examples

In the following example or examples, the Authorization header contents ( [authorization-

params] ) must be replaced with an AWS Signature Version 4 signature. For more information
about creating these signatures, see Signature Version 4 Signing Process in the AWS General
Reference.

Example

This example lists the scheduling policies.

Sample Request

POST /v1/listschedulingpolicies HTTP/1.1

Host: batch.us-east-1.amazonaws.com
Accept-Encoding: identity

Errors API Version 2016-08-10 128

AWS Batch API Reference

User-Agent: aws-cli/1.20.21 Python/3.6.9 Linux/4.4.0-19041-Microsoft botocore/1.21.21

X-Amz-Date: 20210929T001942Z
X-Amz-Security-Token: [security-token]
Authorization: [authorization-params]
Content-Length: 0

Sample Response

HTTP/1.1 200 OK
Date: Wed, 29 Sep 2021 00:19:43 GMT
Content-Type: application/json
Content-Length: [content-length]
x-amzn-RequestId: [request-id]
Access-Control-Allow-Origin: *
x-amz-apigw-id: [apigw-id]
Access-Control-Expose-Headers: X-amzn-errortype,X-amzn-requestid,X-amzn-errormessage,X-
amzn-trace-id,X-amz-apigw-id,date
X-Amzn-Trace-Id: [trace-id]
Connection: keep-alive

{
"schedulingPolicies": [{
"arn": "arn:aws:batch:us-east-1:123456789012:scheduling-policy/
ExampleFairSharePolicy"
}, {
"arn": "arn:aws:batch:us-east-1:123456789012:scheduling-policy/
ExampleFairSharePolicy2"
}]
}

See Also

For more information about using this API in one of the language-speciﬁc AWS SDKs, see the
following:

• AWS Command Line Interface

• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go v2
• AWS SDK for Java V2

• AWS SDK for JavaScript V3

• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3

GET /v1/tags/resourceArn HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

resourceArn

The Amazon Resource Name (ARN) that identiﬁes the resource that tags are listed for. AWS
Batch resources that support tags are compute environments, jobs, job deﬁnitions, job queues,
and scheduling policies. ARNs for child jobs of array and multi-node parallel (MNP) jobs aren't
supported.

Required: Yes

Request Body

The request does not have a request body.

Response Syntax

HTTP/1.1 200
Content-type: application/json

{
"tags": {
"string" : "string"
}
}

ListTagsForResource API Version 2016-08-10 131

AWS Batch API Reference

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.

tags

The tags for the resource.

Type: String to string map

Map Entries: Maximum number of 50 items.

Key Length Constraints: Minimum length of 1. Maximum length of 128.

Value Length Constraints: Maximum length of 256.

Errors
ClientException

HTTP Status Code: 400

ServerException

These errors are usually caused by a server issue.

HTTP Status Code: 500

Examples

In the following example or examples, the Authorization header contents ( [authorization-

params] ) must be replaced with an AWS Signature Version 4 signature. For more information
about creating these signatures, see Signature Version 4 Signing Process in the AWS General
Reference.

Response Elements API Version 2016-08-10 132

AWS Batch API Reference

Example

This example lists tags on the job deﬁnition with an ARN of "arn:aws:batch:us-
east-1:123456789012:job-deﬁnition/sleep30:1".

Sample Request

GET /v1/tags/arn%3Aaws%3Abatch%3Aus-east-1%3A123456789012%3Ajob-definition
%2Fsleep30%3A1 HTTP/1.1
Host: batch.us-east-1.amazonaws.com
Accept-Encoding: identity
X-Amz-Date: 20200604T172419Z
X-Amz-Security-Token: [security-token]
Authorization: [authorization-params]

Sample Response

HTTP/1.1 200 OK
Date: Thu, 05 Jun 2020 17:24:20 GMT
Content-Type: application/json

x-amzn-RequestId: [request-id]
Access-Control-Allow-Origin: *
x-amz-apigw-id: [apigw-id]
X-Amzn-Trace-Id: [trace-id]
Connection: keep-alive

{
"tags": {
"Stage": "Alpha",
"Department": "Engineering",
"User": "JaneDoe"
}
}

Examples API Version 2016-08-10 133

AWS Batch API Reference

See Also
For more information about using this API in one of the language-speciﬁc AWS SDKs, see the
following:

• AWS Command Line Interface

• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go v2
• AWS SDK for Java V2
• AWS SDK for JavaScript V3
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3

POST /v1/registerjobdefinition HTTP/1.1

Content-type: application/json

{
"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",

RegisterJobDeﬁnition API Version 2016-08-10 135

AWS Batch API Reference

"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,
"repositoryCredentials": {
"credentialsParameter": "string"
},
"resourceRequirements": [
{
"type": "string",
"value": "string"
}
],
"runtimePlatform": {
"cpuArchitecture": "string",
"operatingSystemFamily": "string"
},
"secrets": [

Request Syntax API Version 2016-08-10 136

AWS Batch API Reference

{
"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"
}
]
},
"ecsProperties": {
"taskProperties": [
{
"containers": [
{
"command": [ "string" ],
"dependsOn": [
{
"condition": "string",
"containerName": "string"
}

Request Syntax API Version 2016-08-10 137

AWS Batch API Reference

],
"environment": [
{
"name": "string",
"value": "string"
}
],
"essential": boolean,
"image": "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"
}
]
},
"mountPoints": [
{
"containerPath": "string",

Request Syntax API Version 2016-08-10 138

AWS Batch API Reference

"readOnly": boolean,
"sourceVolume": "string"
}
],
"name": "string",
"privileged": boolean,
"readonlyRootFilesystem": boolean,
"repositoryCredentials": {
"credentialsParameter": "string"
},
"resourceRequirements": [
{
"type": "string",
"value": "string"
}
],
"secrets": [
{
"name": "string",
"valueFrom": "string"
}
],
"ulimits": [
{
"hardLimit": number,
"name": "string",
"softLimit": number
}
],
"user": "string"
}
],
"ephemeralStorage": {
"sizeInGiB": number
},
"executionRoleArn": "string",
"ipcMode": "string",
"networkConfiguration": {
"assignPublicIp": "string"
},
"pidMode": "string",
"platformVersion": "string",
"runtimePlatform": {
"cpuArchitecture": "string",

Request Syntax API Version 2016-08-10 139

AWS Batch API Reference

"operatingSystemFamily": "string"
},
"taskRoleArn": "string",
"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": {

Request Syntax API Version 2016-08-10 140

AWS Batch API Reference

"string" : "string"
}
},
"securityContext": {
"allowPrivilegeEscalation": boolean,
"privileged": boolean,
"readOnlyRootFilesystem": boolean,
"runAsGroup": number,
"runAsNonRoot": boolean,
"runAsUser": number
},
"volumeMounts": [
{
"mountPath": "string",
"name": "string",
"readOnly": boolean
}
]
}
],
"dnsPolicy": "string",
"hostNetwork": boolean,
"imagePullSecrets": [
{
"name": "string"
}
],
"initContainers": [
{
"args": [ "string" ],
"command": [ "string" ],
"env": [
{
"name": "string",
"value": "string"
}
],
"image": "string",
"imagePullPolicy": "string",
"name": "string",
"resources": {
"limits": {
"string" : "string"
},

Request Syntax API Version 2016-08-10 141

AWS Batch API Reference

"requests": {
"string" : "string"
}
},
"securityContext": {
"allowPrivilegeEscalation": boolean,
"privileged": boolean,
"readOnlyRootFilesystem": boolean,
"runAsGroup": number,
"runAsNonRoot": boolean,
"runAsUser": number
},
"volumeMounts": [
{
"mountPath": "string",
"name": "string",
"readOnly": boolean
}
]
}
],
"metadata": {
"labels": {
"string" : "string"
}
},
"serviceAccountName": "string",
"shareProcessNamespace": boolean,
"volumes": [
{
"emptyDir": {
"medium": "string",
"sizeLimit": "string"
},
"hostPath": {
"path": "string"
},
"name": "string",
"secret": {
"optional": boolean,
"secretName": "string"
}
}
]

Request Syntax API Version 2016-08-10 142

AWS Batch API Reference

}
},
"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
}
]

Request Syntax API Version 2016-08-10 143

AWS Batch API Reference

Request Syntax API Version 2016-08-10 144

AWS Batch API Reference

Request Syntax API Version 2016-08-10 145

AWS Batch API Reference

Request Syntax API Version 2016-08-10 146

AWS Batch API Reference

Request Syntax API Version 2016-08-10 147

AWS Batch API Reference

Request Syntax API Version 2016-08-10 148

AWS Batch API Reference

Request Syntax API Version 2016-08-10 149

AWS Batch API Reference

Request Syntax API Version 2016-08-10 150

AWS Batch API Reference

}
],
"numNodes": number
},
"parameters": {
"string" : "string"
},
"platformCapabilities": [ "string" ],
"propagateTags": boolean,
"retryStrategy": {
"attempts": number,
"evaluateOnExit": [
{
"action": "string",
"onExitCode": "string",
"onReason": "string",
"onStatusReason": "string"
}
]
},
"schedulingPriority": number,
"tags": {
"string" : "string"
},
"timeout": {
"attemptDurationSeconds": number
},
"type": "string"
}

URI Request Parameters

The request does not use any URI parameters.

Request Body

The request accepts the following data in JSON format.

containerProperties

An object with properties speciﬁc to Amazon ECS-based single-node container-based

jobs. If the job deﬁnition's type parameter is container, then you must specify either

URI Request Parameters API Version 2016-08-10 151

AWS Batch API Reference

containerProperties or nodeProperties. This must not be speciﬁed for Amazon EKS-

based job deﬁnitions.

Note
If the job runs on Fargate resources, then you must not specify nodeProperties; use
only containerProperties.

Type: ContainerProperties object

Required: No
ecsProperties

An object with properties that are specific to Amazon ECS-based jobs. This must not be
specified for Amazon EKS-based job definitions.

Type: EcsProperties object

Required: No
eksProperties

An object with properties that are specific to Amazon EKS-based jobs. This must not be
specified for Amazon ECS based job definitions.

Type: EksProperties object

Required: No
jobDeﬁnitionName

The name of the job deﬁnition to register. It can be up to 128 letters long. It can contain
uppercase and lowercase letters, numbers, hyphens (-), and underscores (_).

Type: String

Required: Yes
nodeProperties

An object with properties speciﬁc to multi-node parallel jobs. If you specify node properties for
a job, it becomes a multi-node parallel job. For more information, see Multi-node Parallel Jobs
in the AWS Batch User Guide.

Request Body API Version 2016-08-10 152

AWS Batch API Reference

Note
If the job runs on Fargate resources, then you must not specify nodeProperties; use
containerProperties instead.

Note
If the job runs on Amazon EKS resources, then you must not specify nodeProperties.

Type: NodeProperties object

Required: No
parameters

Default parameter substitution placeholders to set in the job definition. Parameters are
specified as a key-value pair mapping. Parameters in a SubmitJob request override any
corresponding parameter defaults from the job definition.

Type: String to string map

Required: No
platformCapabilities

The platform capabilities required by the job deﬁnition. If no value is speciﬁed, it defaults to
EC2. To run the job on Fargate resources, specify FARGATE.

Note
If the job runs on Amazon EKS resources, then you must not specify
platformCapabilities.

Type: Array of strings

Valid Values: EC2 | FARGATE

Required: No

Request Body API Version 2016-08-10 153

AWS Batch API Reference

propagateTags

Specifies whether to propagate the tags from the job or job definition to the corresponding
Amazon ECS task. If no value is specified, the tags are not propagated. Tags can only be
propagated to the tasks during task creation. For tags with the same name, job tags are given
priority over job definitions tags. If the total number of combined tags from the job and job
definition is over 50, the job is moved to the FAILED state.

Note
If the job runs on Amazon EKS resources, then you must not specify propagateTags.

Type: Boolean

Required: No
retryStrategy

The retry strategy to use for failed jobs that are submitted with this job definition. Any retry
strategy that's specified during a SubmitJob operation overrides the retry strategy defined here.
If a job is terminated due to a timeout, it isn't retried.

Type: RetryStrategy object

Required: No
schedulingPriority

The scheduling priority for jobs that are submitted with this job deﬁnition. This only aﬀects
jobs in job queues with a fair share policy. Jobs with a higher scheduling priority are scheduled
before jobs with a lower scheduling priority.

The minimum supported value is 0 and the maximum supported value is 9999.

Type: Integer

Required: No
tags

The tags that you apply to the job deﬁnition to help you categorize and organize your
resources. Each tag consists of a key and an optional value. For more information, see Tagging
AWS Resources in AWS Batch User Guide.

Request Body API Version 2016-08-10 154

AWS Batch API Reference

Type: String to string map

Map Entries: Maximum number of 50 items.

Key Length Constraints: Minimum length of 1. Maximum length of 128.

Value Length Constraints: Maximum length of 256.

Required: No
timeout

The timeout configuration for jobs that are submitted with this job definition, after which AWS
Batch terminates your jobs if they have not finished. If a job is terminated due to a timeout, it
isn't retried. The minimum value for the timeout is 60 seconds. Any timeout configuration that's
specified during a SubmitJob operation overrides the timeout configuration defined here. For
more information, see Job Timeouts in the AWS Batch User Guide.

Type: JobTimeout object

Required: No
type

The type of job deﬁnition. For more information about multi-node parallel jobs, see Creating a
multi-node parallel job deﬁnition in the AWS Batch User Guide.
• If the value is container, then one of the following is required: containerProperties,
ecsProperties, or eksProperties.
• If the value is multinode, then nodeProperties is required.

Note
If the job is run on Fargate resources, then multinode isn't supported.

Type: String

Valid Values: container | multinode

Required: Yes

Request Body API Version 2016-08-10 155

AWS Batch API Reference

Response Syntax

HTTP/1.1 200
Content-type: application/json

{
"jobDefinitionArn": "string",
"jobDefinitionName": "string",
"revision": number
}

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.

jobDeﬁnitionArn

The Amazon Resource Name (ARN) of the job deﬁnition.

Type: String
jobDeﬁnitionName

The name of the job deﬁnition.

Type: String
revision

The revision of the job deﬁnition.

Type: Integer

Errors
ClientException

Response Syntax API Version 2016-08-10 156

AWS Batch API Reference

HTTP Status Code: 400

ServerException

These errors are usually caused by a server issue.

HTTP Status Code: 500

Example

This example registers a job deﬁnition for a simple container job.

Sample Request

POST /v1/registerjobdefinition HTTP/1.1

Host: batch.us-east-1.amazonaws.com
Accept-Encoding: identity
Content-Length: [content-length]
Authorization: [authorization-params]
X-Amz-Date: 20201128T215526Z
User-Agent: aws-cli/1.11.21 Python/2.7.12 Darwin/16.1.0 botocore/1.4.78

{
"containerProperties": {
"image": "busybox",
"command": [
"sleep",
"10"
],

Examples API Version 2016-08-10 157

AWS Batch API Reference

"resourceRequirements": [
{
"type": "MEMORY",
"value": "128"
},
{
"type": "VCPU",
"value": "1"
}
]
},
"type": "container",
"jobDefinitionName": "sleep10"
}

Sample Response

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: [content-length]
Connection: keep-alive
Date: Mon, 28 Nov 2020 21:55:27 GMT
x-amzn-RequestId: [request-id]
X-Amzn-Trace-Id: [trace-id]
X-Cache: Miss from cloudfront
Via: 1.1 7a06af51e583997d8673ab89482dd45a.cloudfront.net (CloudFront)
X-Amz-Cf-Id: Y14HPNWWcKgm1U0wJPfLBzLDvrMSdyuHo4GMi0oQwI0ukruLpi0nFw==

{
"jobDefinitionName": "sleep10",
"jobDefinitionArn": "arn:aws:batch:us-east-1:123456789012:job-definition/sleep10:1",
"revision": 1
}

Example

This example registers a job deﬁnition for a simple container job with retries.

Sample Request

POST /v1/registerjobdefinition HTTP/1.1

Host: batch.us-east-1.amazonaws.com
Accept-Encoding: identity

Examples API Version 2016-08-10 158

AWS Batch API Reference

Content-Length: [content-length]
Authorization: [authorization-params]
X-Amz-Date: 20170327T145208Z
User-Agent: aws-cli/1.11.66 Python/2.7.10 Darwin/16.4.0 botocore/1.5.29

{
"containerProperties": {
"mountPoints": [],
"image": "amazonlinux",
"environment": [],
"command": [
"/bin/bash",
"-c",
"exit $AWS_BATCH_JOB_ATTEMPT"
],
"volumes": [],
"resourceRequirements": [
{
"type": "MEMORY",
"value": "8"
},
{
"type": "VCPU",
"value": "1"
}
],
"ulimits": []
},
"retryStrategy": {
"attempts": 3
},
"jobDefinitionName": "EchoAttemptNumber",
"parameters": {},
"type": "container"
}

Sample Response

HTTP/1.1 200 OK
Date: Mon, 27 Mar 2017 14:51:58 GMT
Content-Type: application/json
Content-Length: [content-length]
Connection: keep-alive

Examples API Version 2016-08-10 159

AWS Batch API Reference

x-amzn-RequestId: [request-id]
X-Amzn-Trace-Id: [trace-id]
X-Cache: Miss from cloudfront
Via: 1.1 861b49a34b383ce3ac4ea8b7117b8953.cloudfront.net (CloudFront)
X-Amz-Cf-Id: l3zCxHtlIx4c1-RN2vkqIlpSbU9tsZNxfMSg6oIf700wg1BX0V5f_A==

{
"jobDefinitionName": "EchoAttemptNumber",
"jobDefinitionArn": "arn:aws:batch:us-east-1:123456789012:job-definition/
EchoAttemptNumber:1",
"revision": 1
}

See Also
For more information about using this API in one of the language-speciﬁc AWS SDKs, see the
following:

• AWS Command Line Interface

• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go v2
• AWS SDK for Java V2
• AWS SDK for JavaScript V3
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3

POST /v1/submitjob HTTP/1.1

Content-type: application/json

{
"arrayProperties": {
"size": number
},
"containerOverrides": {
"command": [ "string" ],
"environment": [
{
"name": "string",
"value": "string"
}
],
"instanceType": "string",
"memory": number,

SubmitJob API Version 2016-08-10 161

AWS Batch API Reference

"resourceRequirements": [
{
"type": "string",
"value": "string"
}
],
"vcpus": number
},
"dependsOn": [
{
"jobId": "string",
"type": "string"
}
],
"ecsPropertiesOverride": {
"taskProperties": [
{
"containers": [
{
"command": [ "string" ],
"environment": [
{
"name": "string",
"value": "string"
}
],
"name": "string",
"resourceRequirements": [
{
"type": "string",
"value": "string"
}
]
}
]
}
]
},
"eksPropertiesOverride": {
"podProperties": {
"containers": [
{
"args": [ "string" ],
"command": [ "string" ],

Request Syntax API Version 2016-08-10 162

AWS Batch API Reference

"env": [
{
"name": "string",
"value": "string"
}
],
"image": "string",
"name": "string",
"resources": {
"limits": {
"string" : "string"
},
"requests": {
"string" : "string"
}
}
}
],
"initContainers": [
{
"args": [ "string" ],
"command": [ "string" ],
"env": [
{
"name": "string",
"value": "string"
}
],
"image": "string",
"name": "string",
"resources": {
"limits": {
"string" : "string"
},
"requests": {
"string" : "string"
}
}
}
],
"metadata": {
"labels": {
"string" : "string"
}

Request Syntax API Version 2016-08-10 163

AWS Batch API Reference

}
}
},
"jobDefinition": "string",
"jobName": "string",
"jobQueue": "string",
"nodeOverrides": {
"nodePropertyOverrides": [
{
"containerOverrides": {
"command": [ "string" ],
"environment": [
{
"name": "string",
"value": "string"
}
],
"instanceType": "string",
"memory": number,
"resourceRequirements": [
{
"type": "string",
"value": "string"
}
],
"vcpus": number
},
"ecsPropertiesOverride": {
"taskProperties": [
{
"containers": [
{
"command": [ "string" ],
"environment": [
{
"name": "string",
"value": "string"
}
],
"name": "string",
"resourceRequirements": [
{
"type": "string",
"value": "string"

Request Syntax API Version 2016-08-10 164

AWS Batch API Reference

}
]
}
]
}
]
},
"eksPropertiesOverride": {
"podProperties": {
"containers": [
{
"args": [ "string" ],
"command": [ "string" ],
"env": [
{
"name": "string",
"value": "string"
}
],
"image": "string",
"name": "string",
"resources": {
"limits": {
"string" : "string"
},
"requests": {
"string" : "string"
}
}
}
],
"initContainers": [
{
"args": [ "string" ],
"command": [ "string" ],
"env": [
{
"name": "string",
"value": "string"
}
],
"image": "string",
"name": "string",
"resources": {

Request Syntax API Version 2016-08-10 165

AWS Batch API Reference

"limits": {
"string" : "string"
},
"requests": {
"string" : "string"
}
}
}
],
"metadata": {
"labels": {
"string" : "string"
}
}
}
},
"instanceTypes": [ "string" ],
"targetNodes": "string"
}
],
"numNodes": number
},
"parameters": {
"string" : "string"
},
"propagateTags": boolean,
"retryStrategy": {
"attempts": number,
"evaluateOnExit": [
{
"action": "string",
"onExitCode": "string",
"onReason": "string",
"onStatusReason": "string"
}
]
},
"schedulingPriorityOverride": number,
"shareIdentifier": "string",
"tags": {
"string" : "string"
},
"timeout": {
"attemptDurationSeconds": number

Request Syntax API Version 2016-08-10 166

AWS Batch API Reference

}
}

URI Request Parameters

The request does not use any URI parameters.

Request Body

The request accepts the following data in JSON format.

arrayProperties

The array properties for the submitted job, such as the size of the array. The array size can be
between 2 and 10,000. If you specify array properties for a job, it becomes an array job. For
more information, see Array Jobs in the AWS Batch User Guide.

Type: ArrayProperties object

Required: No
containerOverrides

An object with properties that override the defaults for the job definition that specify the
name of a container in the specified job definition and the overrides it should receive. You can
override the default command for a container, which is specified in the job definition or the
Docker image, with a command override. You can also override existing environment variables
on a container or add new environment variables to it with an environment override.

Type: ContainerOverrides object

Required: No
dependsOn

A list of dependencies for the job. A job can depend upon a maximum of 20 jobs. You can
specify a SEQUENTIAL type dependency without specifying a job ID for array jobs so that each
child array job completes sequentially, starting at index 0. You can also specify an N_TO_N type
dependency with a job ID for array jobs. In that case, each index child of this job must wait for
the corresponding index child of each dependency to complete before it can begin.

Type: Array of JobDependency objects

URI Request Parameters API Version 2016-08-10 167

AWS Batch API Reference

Required: No
ecsPropertiesOverride

An object, with properties that override defaults for the job deﬁnition, can only be speciﬁed for
jobs that are run on Amazon ECS resources.

Type: EcsPropertiesOverride object

Required: No
eksPropertiesOverride

An object, with properties that override defaults for the job deﬁnition, can only be speciﬁed for
jobs that are run on Amazon EKS resources.

Type: EksPropertiesOverride object

Required: No
jobDeﬁnition

The job deﬁnition used by this job. This value can be one of definition-name, definition-
name:revision, or the Amazon Resource Name (ARN) for the job deﬁnition, with or without
the revision (arn:aws:batch:region:account:job-definition/definition-
name:revision , or arn:aws:batch:region:account:job-definition/definition-
name ).

If the revision is not speciﬁed, then the latest active revision is used.

Type: String

Required: Yes
jobName

The name of the job. It can be up to 128 letters long. The ﬁrst character must be alphanumeric,
can contain uppercase and lowercase letters, numbers, hyphens (-), and underscores (_).

Type: String

Required: Yes
jobQueue

The job queue where the job is submitted. You can specify either the name or the Amazon
Resource Name (ARN) of the queue.

Request Body API Version 2016-08-10 168

AWS Batch API Reference

Type: String

Required: Yes
nodeOverrides

A list of node overrides in JSON format that specify the node range to target and the container
overrides for that node range.

Note
This parameter isn't applicable to jobs that are running on Fargate resources; use
containerOverrides instead.

Type: NodeOverrides object

Required: No
parameters

Additional parameters passed to the job that replace parameter substitution placeholders
that are set in the job definition. Parameters are specified as a key and value pair mapping.
Parameters in a SubmitJob request override any corresponding parameter defaults from the
job definition.

Type: String to string map

Required: No
propagateTags

Specifies whether to propagate the tags from the job or job definition to the corresponding
Amazon ECS task. If no value is specified, the tags aren't propagated. Tags can only be
propagated to the tasks during task creation. For tags with the same name, job tags are given
priority over job definitions tags. If the total number of combined tags from the job and job
definition is over 50, the job is moved to the FAILED state. When specified, this overrides the
tag propagation setting in the job definition.

Type: Boolean

Required: No

Request Body API Version 2016-08-10 169

AWS Batch API Reference

retryStrategy

The retry strategy to use for failed jobs from this SubmitJob operation. When a retry strategy is
specified here, it overrides the retry strategy defined in the job definition.

Type: RetryStrategy object

Required: No
schedulingPriorityOverride

The scheduling priority for the job. This only affects jobs in job queues with a fair share policy.
Jobs with a higher scheduling priority are scheduled before jobs with a lower scheduling
priority. This overrides any scheduling priority in the job definition and works only within a
single share identifier.

The minimum supported value is 0 and the maximum supported value is 9999.

Type: Integer

Required: No
shareIdentiﬁer

The share identiﬁer for the job. Don't specify this parameter if the job queue doesn't have
a scheduling policy. If the job queue has a scheduling policy, then this parameter must be
speciﬁed.

This string is limited to 255 alphanumeric characters, and can be followed by an asterisk (*).

Type: String

Required: No
tags

The tags that you apply to the job request to help you categorize and organize your resources.
Each tag consists of a key and an optional value. For more information, see Tagging AWS
Resources in AWS General Reference.

Type: String to string map

Map Entries: Maximum number of 50 items.

Request Body API Version 2016-08-10 170

AWS Batch API Reference

Key Length Constraints: Minimum length of 1. Maximum length of 128.

Value Length Constraints: Maximum length of 256.

Required: No
timeout

The timeout configuration for this SubmitJob operation. You can specify a timeout duration
after which AWS Batch terminates your jobs if they haven't finished. If a job is terminated
due to a timeout, it isn't retried. The minimum value for the timeout is 60 seconds. This
configuration overrides any timeout configuration specified in the job definition. For array jobs,
child jobs have the same timeout configuration as the parent job. For more information, see Job
Timeouts in the Amazon Elastic Container Service Developer Guide.

Type: JobTimeout object

Required: No

Response Syntax

HTTP/1.1 200
Content-type: application/json

{
"jobArn": "string",
"jobId": "string",
"jobName": "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.

jobArn

The Amazon Resource Name (ARN) for the job.

Type: String

Response Syntax API Version 2016-08-10 171

AWS Batch API Reference

jobId

The unique identiﬁer for the job.

Type: String
jobName

The name of the job.

Type: String

Errors
ClientException

HTTP Status Code: 400

ServerException

These errors are usually caused by a server issue.

HTTP Status Code: 500

Examples

In the following example or examples, the Authorization header contents ( [authorization-

params] ) must be replaced with an AWS Signature Version 4 signature. For more information
about creating these signatures, see Signature Version 4 Signing Process in the AWS General
Reference.

Errors API Version 2016-08-10 172

AWS Batch API Reference

Example

This example submits a simple container job called example to the HighPriority job queue.

Sample Request

POST /v1/submitjob HTTP/1.1

Host: batch.us-east-1.amazonaws.com
Accept-Encoding: identity
Content-Length: [content-length]
Authorization: [authorization-params]
X-Amz-Date: 20161129T201034Z
User-Agent: aws-cli/1.11.22 Python/2.7.12 Darwin/16.1.0 botocore/1.4.79

{
"jobName": "example",
"jobQueue": "HighPriority",
"jobDefinition": "sleep60"
}

Sample Response

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: [content-length]
Connection: keep-alive
Date: Tue, 29 Nov 2016 20:10:34 GMT
x-amzn-RequestId: [request-id]
X-Amzn-Trace-Id: [trace-id]
X-Cache: Miss from cloudfront
Via: 1.1 6ba12aeff47e3e7677e084594bfce5e1.cloudfront.net (CloudFront)
X-Amz-Cf-Id: QoWCvISTvYBbaP2hAoxC8_TWTl2JN-kNASYCjCJ5HztN0e1OuzvpSA==

{
"jobName": "example",
"jobId": "876da822-4198-45f2-a252-6cea32512ea8"
}

See Also
For more information about using this API in one of the language-speciﬁc AWS SDKs, see the
following:

• AWS Command Line Interface

• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go v2
• AWS SDK for Java V2
• AWS SDK for JavaScript V3
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3

POST /v1/tags/resourceArn HTTP/1.1

Content-type: application/json

{
"tags": {
"string" : "string"
}
}

URI Request Parameters

The request uses the following URI parameters.

resourceArn

The Amazon Resource Name (ARN) of the resource that tags are added to. AWS Batch resources
that support tags are compute environments, jobs, job deﬁnitions, job queues, and scheduling
policies. ARNs for child jobs of array and multi-node parallel (MNP) jobs aren't supported.

Required: Yes

Request Body
The request accepts the following data in JSON format.

tags

The tags that you apply to the resource to help you categorize and organize your resources.
Each tag consists of a key and an optional value. For more information, see Tagging AWS
Resources in AWS General Reference.

TagResource API Version 2016-08-10 175

AWS Batch API Reference

Type: String to string map

Map Entries: Maximum number of 50 items.

Key Length Constraints: Minimum length of 1. Maximum length of 128.

Value Length Constraints: Maximum length of 256.

Required: Yes

Response Syntax

HTTP/1.1 200

Response Elements

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

Errors
ClientException

HTTP Status Code: 400

ServerException

These errors are usually caused by a server issue.

HTTP Status Code: 500

Examples

In the following example or examples, the Authorization header contents ( [authorization-

params] ) must be replaced with an AWS Signature Version 4 signature. For more information

Response Syntax API Version 2016-08-10 176

AWS Batch API Reference

about creating these signatures, see Signature Version 4 Signing Process in the AWS General
Reference.

Example

This example adds a tag to the job deﬁnition with an ARN of "arn:aws:batch:us-
east-1:123456789012:job-deﬁnition/sleep30:1".

Sample Request

POST /v1/tags/arn%3Aaws%3Abatch%3Aus-east-1%3A123456789012%3Ajob-definition
%2Fsleep30%3A1 HTTP/1.1
Host: batch.us-east-1.amazonaws.com
Accept-Encoding: identity
X-Amz-Date: 20200604T172359Z
X-Amz-Security-Token: [security-token]
Authorization: [authorization-params]
Content-Length: [length-of-JSON]

{
"tags": {
"Stage": "alpha"
}
}

Sample Response

HTTP/1.1 204 No Content

Date: Thu, 05 Jun 2020 17:24:04 GMT
Content-Type: application/json
Content-Length: 0
x-amzn-RequestId: [request-id]
Access-Control-Allow-Origin: *
x-amz-apigw-id: [apigw-id]
X-Amzn-Trace-Id: [trace-id]

Examples API Version 2016-08-10 177

AWS Batch API Reference

Connection: keep-alive

See Also
For more information about using this API in one of the language-speciﬁc AWS SDKs, see the
following:

• AWS Command Line Interface

• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go v2
• AWS SDK for Java V2
• AWS SDK for JavaScript V3
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3

POST /v1/terminatejob HTTP/1.1

Content-type: application/json

{
"jobId": "string",
"reason": "string"
}

URI Request Parameters

The request does not use any URI parameters.

Request Body

The request accepts the following data in JSON format.

jobId

The AWS Batch job ID of the job to terminate.

Type: String

Required: Yes
reason

A message to attach to the job that explains the reason for canceling it. This message is
returned by future DescribeJobs operations on the job. It is also recorded in the AWS Batch
activity logs.

This parameter has as limit of 1024 characters.

Type: String

TerminateJob API Version 2016-08-10 179

AWS Batch API Reference

Required: Yes

Response Syntax

HTTP/1.1 200

Response Elements

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

Errors
ClientException

HTTP Status Code: 400

ServerException

These errors are usually caused by a server issue.

HTTP Status Code: 500

Examples

In the following example or examples, the Authorization header contents ( [authorization-

params] ) must be replaced with an AWS Signature Version 4 signature. For more information
about creating these signatures, see Signature Version 4 Signing Process in the AWS General
Reference.

Response Syntax API Version 2016-08-10 180

AWS Batch API Reference

Example

This example terminates a job with the speciﬁed job ID.

Sample Request

POST /v1/terminatejob HTTP/1.1

Host: batch.us-east-1.amazonaws.com
Accept-Encoding: identity
Content-Length: [content-length]
Authorization: [authorization-params]
X-Amz-Date: 20161129T202905Z
User-Agent: aws-cli/1.11.22 Python/2.7.12 Darwin/16.1.0 botocore/1.4.79

{
"reason": "Terminating job.",
"jobId": "61e743ed-35e4-48da-b2de-5c8333821c84"
}

Sample Response

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 2
Connection: keep-alive
Date: Tue, 29 Nov 2016 20:29:06 GMT
x-amzn-RequestId: [request-id]
X-Amzn-Trace-Id: [trace-id]
X-Cache: Miss from cloudfront
Via: 1.1 16d2657cebef5191828b055567b4efeb.cloudfront.net (CloudFront)
X-Amz-Cf-Id: 681NTs_bPulMwja2HekWMwngcUzx2a8w_oaG27W0L4Pjct7W1T-Fvw==

{}

See Also

For more information about using this API in one of the language-speciﬁc AWS SDKs, see the
following:

• AWS Command Line Interface

• AWS SDK for .NET

• AWS SDK for C++

• AWS SDK for Go v2
• AWS SDK for Java V2
• AWS SDK for JavaScript V3
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3

DELETE /v1/tags/resourceArn?tagKeys=tagKeys HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

resourceArn

The Amazon Resource Name (ARN) of the resource from which to delete tags. AWS Batch
resources that support tags are compute environments, jobs, job deﬁnitions, job queues, and
scheduling policies. ARNs for child jobs of array and multi-node parallel (MNP) jobs aren't
supported.

Required: Yes
tagKeys

The keys of the tags to be removed.

Array Members: Minimum number of 1 item. Maximum number of 50 items.

Length Constraints: Minimum length of 1. Maximum length of 128.

Required: Yes

Request Body

The request does not have a request body.

Response Syntax

HTTP/1.1 200

UntagResource API Version 2016-08-10 183

AWS Batch API Reference

Response Elements
If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

Errors
ClientException

HTTP Status Code: 400

ServerException

These errors are usually caused by a server issue.

HTTP Status Code: 500

Example

This example removes the "Stage" tag from the job deﬁnition with an ARN of "arn:aws:batch:us-
east-1:123456789012:job-deﬁnition/sleep30:1".

Sample Request

DELETE /v1/tags/arn%3Aaws%3Abatch%3Aus-east-1%3A123456789012%3Ajob-definition
%2Fsleep30%3A1?tagKeys=Stage HTTP/1.1

Response Elements API Version 2016-08-10 184

AWS Batch API Reference

Host: batch.us-east-1.amazonaws.com
Accept-Encoding: identity
X-Amz-Date: 20200604T174552Z
X-Amz-Security-Token: [security-token]
Authorization: [authorization-params]
Content-Length: 0

Sample Response

HTTP/1.1 204 No Content

Date: Thu, 05 Jun 2020 17:45:55 GMT
Content-Type: application/json
Content-Length: 0
x-amzn-RequestId: [request-id]
Access-Control-Allow-Origin: *
x-amz-apigw-id: [apigw-id]
X-Amzn-Trace-Id: [trace-id]
Connection: keep-alive

See Also
For more information about using this API in one of the language-speciﬁc AWS SDKs, see the
following:

• AWS Command Line Interface

• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go v2
• AWS SDK for Java V2
• AWS SDK for JavaScript V3
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3

POST /v1/updatecomputeenvironment HTTP/1.1

Content-type: application/json

{
"computeEnvironment": "string",
"computeResources": {
"allocationStrategy": "string",
"bidPercentage": number,
"desiredvCpus": number,
"ec2Configuration": [
{
"imageIdOverride": "string",
"imageKubernetesVersion": "string",
"imageType": "string"
}
],
"ec2KeyPair": "string",
"imageId": "string",
"instanceRole": "string",
"instanceTypes": [ "string" ],
"launchTemplate": {
"launchTemplateId": "string",
"launchTemplateName": "string",
"version": "string"
},
"maxvCpus": number,
"minvCpus": number,
"placementGroup": "string",
"securityGroupIds": [ "string" ],
"subnets": [ "string" ],
"tags": {
"string" : "string"
},
"type": "string",
"updateToLatestImageVersion": boolean
},
"context": "string",

UpdateComputeEnvironment API Version 2016-08-10 186

AWS Batch API Reference

"serviceRole": "string",
"state": "string",
"unmanagedvCpus": number,
"updatePolicy": {
"jobExecutionTimeoutMinutes": number,
"terminateJobsOnUpdate": boolean
}
}

URI Request Parameters

The request does not use any URI parameters.

Request Body

The request accepts the following data in JSON format.

computeEnvironment

The name or full Amazon Resource Name (ARN) of the compute environment to update.

Type: String

Required: Yes
computeResources

Details of the compute resources managed by the compute environment. Required for a
managed compute environment. For more information, see Compute Environments in the AWS
Batch User Guide.

Type: ComputeResourceUpdate object

Required: No
context

Reserved.

Type: String

Required: No

URI Request Parameters API Version 2016-08-10 187

AWS Batch API Reference

serviceRole

Important
If the compute environment has a service-linked role, it can't be changed to use
a regular IAM role. Likewise, if the compute environment has a regular IAM role,
it can't be changed to use a service-linked role. To update the parameters for
the compute environment that require an infrastructure update to change, the
AWSServiceRoleForBatch service-linked role must be used. For more information, see
Updating compute environments in the AWS Batch User Guide.

If your speciﬁed role has a path other than /, then you must either specify the full role ARN
(recommended) or preﬁx the role name with the path.

Note
Depending on how you created your AWS Batch service role, its ARN might contain the
service-role path preﬁx. When you only specify the name of the service role, AWS
Batch assumes that your ARN doesn't use the service-role path preﬁx. Because of
this, we recommend that you specify the full ARN of your service role when you create
compute environments.

Type: String

Required: No
state

The state of the compute environment. Compute environments in the ENABLED state can
accept jobs from a queue and scale in or out automatically based on the workload demand of
its associated queues.

If the state is ENABLED, then the AWS Batch scheduler can attempt to place jobs from an
associated job queue on the compute resources within the environment. If the compute

Request Body API Version 2016-08-10 188

AWS Batch API Reference

environment is managed, then it can scale its instances out or in automatically, based on the job
queue demand.

Type: String

Valid Values: ENABLED | DISABLED

Required: No
unmanagedvCpus

The maximum number of vCPUs expected to be used for an unmanaged compute environment.
Don't specify this parameter for a managed compute environment. This parameter is only used
for fair share scheduling to reserve vCPU capacity for new share identiﬁers. If this parameter
isn't provided for a fair share job queue, no vCPU capacity is reserved.

Type: Integer

Required: No
updatePolicy

Speciﬁes the updated infrastructure update policy for the compute environment. For more
information about infrastructure updates, see Updating compute environments in the AWS
Batch User Guide.

Type: UpdatePolicy object

Request Body API Version 2016-08-10 189

AWS Batch API Reference

Required: No

Response Syntax

HTTP/1.1 200
Content-type: application/json

{
"computeEnvironmentArn": "string",
"computeEnvironmentName": "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.

computeEnvironmentArn

The Amazon Resource Name (ARN) of the compute environment.

Type: String
computeEnvironmentName

The name of the compute environment. It can be up to 128 characters long. It can contain
uppercase and lowercase letters, numbers, hyphens (-), and underscores (_).

Type: String

Errors
ClientException

HTTP Status Code: 400

Response Syntax API Version 2016-08-10 190

AWS Batch API Reference

ServerException

These errors are usually caused by a server issue.

HTTP Status Code: 500

Example

This example disables the P3OnDemand compute environment so it can be deleted.

Sample Request

POST /v1/updatecomputeenvironment HTTP/1.1

Host: batch.us-east-1.amazonaws.com
Accept-Encoding: identity
Content-Length: [content-length]
Authorization: AUTHPARAMS
X-Amz-Date: 20161128T194248Z
User-Agent: aws-cli/1.11.21 Python/2.7.12 Darwin/16.1.0 botocore/1.4.78

{
"computeEnvironment": "P3OnDemand",
"state": "DISABLED"
}

Sample Response

HTTP/1.1 200 OK

Examples API Version 2016-08-10 191

AWS Batch API Reference

Content-Type: application/json
Content-Length: [content-length]
Connection: keep-alive
Date: Mon, 28 Nov 2016 19:42:49 GMT
x-amzn-RequestId: [request-id]
X-Amzn-Trace-Id: [trace-id]
X-Cache: Miss from cloudfront
Via: 1.1 7f3f42df8af148df1f9f1ee7175987ad.cloudfront.net (CloudFront)
X-Amz-Cf-Id: uxJn0P7cg_1RTxOs15FkCItWfmCeniKMZdXlFWaOfPfjqATHw3j-AA==

{
"computeEnvironmentName": "P3OnDemand",
"computeEnvironmentArn": "arn:aws:batch:us-east-1:123456789012:compute-environment/
P3OnDemand"
}

See Also
For more information about using this API in one of the language-speciﬁc AWS SDKs, see the
following:

• AWS Command Line Interface

• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go v2
• AWS SDK for Java V2
• AWS SDK for JavaScript V3
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3

POST /v1/updatejobqueue HTTP/1.1

Content-type: application/json

{
"computeEnvironmentOrder": [
{
"computeEnvironment": "string",
"order": number
}
],
"jobQueue": "string",
"jobStateTimeLimitActions": [
{
"action": "string",
"maxTimeSeconds": number,
"reason": "string",
"state": "string"
}
],
"priority": number,
"schedulingPolicyArn": "string",
"state": "string"
}

URI Request Parameters

The request does not use any URI parameters.

Request Body
The request accepts the following data in JSON format.

computeEnvironmentOrder

Details the set of compute environments mapped to a job queue and their order relative to each
other. This is one of the parameters used by the job scheduler to determine which compute

UpdateJobQueue API Version 2016-08-10 193

AWS Batch API Reference

environment runs a given job. Compute environments must be in the VALID state before you
can associate them with a job queue. All of the compute environments must be either EC2 (EC2
or SPOT) or Fargate (FARGATE or FARGATE_SPOT). EC2 and Fargate compute environments
can't be mixed.

Note
All compute environments that are associated with a job queue must share the same
architecture. AWS Batch doesn't support mixing compute environment architecture
types in a single job queue.

Type: Array of ComputeEnvironmentOrder objects

Required: No
jobQueue

The name or the Amazon Resource Name (ARN) of the job queue.

Type: String

Required: Yes
jobStateTimeLimitActions

The set of actions that AWS Batch perform on jobs that remain at the head of the job queue
in the speciﬁed state longer than speciﬁed times. AWS Batch will perform each action after
maxTimeSeconds has passed. (Note: The minimum value for maxTimeSeconds is 600 (10
minutes) and its maximum value is 86,400 (24 hours).)

Type: Array of JobStateTimeLimitAction objects

Required: No
priority

The priority of the job queue. Job queues with a higher priority (or a higher integer value
for the priority parameter) are evaluated ﬁrst when associated with the same compute
environment. Priority is determined in descending order. For example, a job queue with a
priority value of 10 is given scheduling preference over a job queue with a priority value of 1.
All of the compute environments must be either EC2 (EC2 or SPOT) or Fargate (FARGATE or
FARGATE_SPOT). EC2 and Fargate compute environments can't be mixed.

Request Body API Version 2016-08-10 194

AWS Batch API Reference

Type: Integer

Required: No
schedulingPolicyArn

Amazon Resource Name (ARN) of the fair share scheduling policy. Once a job queue is
created, the fair share scheduling policy can be replaced but not removed. The format
is aws:Partition:batch:Region:Account:scheduling-policy/Name . For
example, aws:aws:batch:us-west-2:123456789012:scheduling-policy/
MySchedulingPolicy.

Type: String

Required: No
state

Describes the queue's ability to accept new jobs. If the job queue state is ENABLED, it can accept
jobs. If the job queue state is DISABLED, new jobs can't be added to the queue, but jobs already
in the queue can ﬁnish.

Type: String

Valid Values: ENABLED | DISABLED

Required: No

Response Syntax

HTTP/1.1 200
Content-type: application/json

{
"jobQueueArn": "string",
"jobQueueName": "string"
}

Response Elements

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

Response Syntax API Version 2016-08-10 195

AWS Batch API Reference

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

jobQueueArn

The Amazon Resource Name (ARN) of the job queue.

Type: String
jobQueueName

The name of the job queue.

Type: String

Errors
ClientException

HTTP Status Code: 400

ServerException

These errors are usually caused by a server issue.

HTTP Status Code: 500

Errors API Version 2016-08-10 196

AWS Batch API Reference

Example

This example disables a job queue so that it can be deleted.

Sample Request

POST /v1/updatejobqueue HTTP/1.1

Host: batch.us-east-1.amazonaws.com
Accept-Encoding: identity
Content-Length: [content-length]
Authorization: [authorization-params]
X-Amz-Date: 20161128T201802Z
User-Agent: aws-cli/1.11.21 Python/2.7.12 Darwin/16.1.0 botocore/1.4.78

{
"state": "DISABLED",
"jobQueue": "GPGPU"
}

Sample Response

HTTP/1.1 200 OK
Date: Mon, 28 Nov 2016 20:18:03 GMT
Content-Type: application/json
Content-Length: [content-length]
Connection: keep-alive
x-amzn-RequestId: [request-id]
X-Amzn-Trace-Id: [trace-id]
X-Cache: Miss from cloudfront
Via: 1.1 17de248e6d780f737234d37cc490dbe3.cloudfront.net (CloudFront)
X-Amz-Cf-Id: aVju0hE8eLpjSFl8Y3fOuxgOZXdigQlLcDMwO0plxnynw0dEsOsEgw==

{
"jobQueueName": "GPGPU",
"jobQueueArn": "arn:aws:batch:us-east-1:123456789012:job-queue/GPGPU"
}

See Also

For more information about using this API in one of the language-speciﬁc AWS SDKs, see the
following:

• AWS Command Line Interface

• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go v2
• AWS SDK for Java V2
• AWS SDK for JavaScript V3
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3

POST /v1/updateschedulingpolicy HTTP/1.1

Content-type: application/json

{
"arn": "string",
"fairsharePolicy": {
"computeReservation": number,
"shareDecaySeconds": number,
"shareDistribution": [
{
"shareIdentifier": "string",
"weightFactor": number
}
]
}
}

URI Request Parameters

The request does not use any URI parameters.

Request Body

The request accepts the following data in JSON format.

arn

The Amazon Resource Name (ARN) of the scheduling policy to update.

Type: String

Required: Yes
fairsharePolicy

The fair share policy.

UpdateSchedulingPolicy API Version 2016-08-10 199

AWS Batch API Reference

Type: FairsharePolicy object

Required: No

Response Syntax

HTTP/1.1 200

Response Elements
If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

Errors
ClientException

HTTP Status Code: 400

ServerException

These errors are usually caused by a server issue.

HTTP Status Code: 500

Response Syntax API Version 2016-08-10 200

AWS Batch API Reference

Example

This example removes the "Stage" tag from the job deﬁnition with an ARN of "arn:aws:batch:us-
east-1:123456789012:job-deﬁnition/sleep30:1".

Sample Request

POST /v1/updateschedulingpolicy HTTP/1.1

Host: batch.us-east-1.amazonaws.com
Accept-Encoding: identity
User-Agent: aws-cli/1.20.21 Python/3.6.9 Linux/4.4.0-19041-Microsoft botocore/1.21.21
X-Amz-Date: 20210929T022142Z
X-Amz-Security-Token: [security-token]
Authorization: [authorization-params]

{
"arn": "arn:aws:batch:us-east-1:123456789012:scheduling-policy/
ExampleFairSharePolicy3",
"fairsharePolicy": {
"shareDecaySeconds": 3600,
"computeReservation": 1,
"shareDistribution": [
{
"shareIdentifier": "MostImportant",
"weightFactor": 0.0001
},{
"shareIdentifier": "Normal",
"weightFactor": 1.0
},{
"shareIdentifier": "LeastImportant",
"weightFactor": 999.9999
}
]
}
}

Sample Response

HTTP/1.1 200 OK
Date: Wed, 29 Sep 2021 02:21:43 GMT
Content-Type: application/json

Examples API Version 2016-08-10 201

AWS Batch API Reference

Content-Length: 2
x-amzn-RequestId: [request-id]
Access-Control-Allow-Origin: *
x-amz-apigw-id: [apigw-id]
Access-Control-Expose-Headers: X-amzn-errortype,X-amzn-requestid,X-amzn-errormessage,X-
amzn-trace-id,X-amz-apigw-id,date
X-Amzn-Trace-Id: [trace-id]
Connection: keep-alive

{}

See Also
For more information about using this API in one of the language-speciﬁc AWS SDKs, see the
following:

• AWS Command Line Interface

• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go v2
• AWS SDK for Java V2
• AWS SDK for JavaScript V3
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3

The following data types are supported:

• ArrayProperties
• ArrayPropertiesDetail
• ArrayPropertiesSummary
• AttemptContainerDetail
• AttemptDetail
• AttemptEcsTaskDetails
• AttemptTaskContainerDetails
• ComputeEnvironmentDetail
• ComputeEnvironmentOrder
• ComputeResource
• ComputeResourceUpdate
• ContainerDetail
• ContainerOverrides
• ContainerProperties
• ContainerSummary
• Device
• Ec2Conﬁguration
• EcsProperties
• EcsPropertiesDetail
• EcsPropertiesOverride

API Version 2016-08-10 203

AWS Batch API Reference

• EcsTaskDetails
• EcsTaskProperties
• EFSAuthorizationConfig
• EFSVolumeConfiguration
• EksAttemptContainerDetail
• EksAttemptDetail
• EksConfiguration
• EksContainer
• EksContainerDetail
• EksContainerEnvironmentVariable
• EksContainerOverride
• EksContainerResourceRequirements
• EksContainerSecurityContext
• EksContainerVolumeMount
• EksEmptyDir
• EksHostPath
• EksMetadata
• EksPodProperties
• EksPodPropertiesDetail
• EksPodPropertiesOverride
• EksProperties
• EksPropertiesDetail
• EksPropertiesOverride
• EksSecret
• EksVolume
• EphemeralStorage
• EvaluateOnExit
• FairsharePolicy
• FargatePlatformConfiguration
• FrontOfQueueDetail

API Version 2016-08-10 204

AWS Batch API Reference

• FrontOfQueueJobSummary
• Host
• ImagePullSecret
• JobDefinition
• JobDependency
• JobDetail
• JobQueueDetail
• JobStateTimeLimitAction
• JobSummary
• JobTimeout
• KeyValuePair
• KeyValuesPair
• LaunchTemplateSpecification
• LinuxParameters
• LogConfiguration
• MountPoint
• NetworkConfiguration
• NetworkInterface
• NodeDetails
• NodeOverrides
• NodeProperties
• NodePropertiesSummary
• NodePropertyOverride
• NodeRangeProperty
• RepositoryCredentials
• ResourceRequirement
• RetryStrategy
• RuntimePlatform
• SchedulingPolicyDetail
• SchedulingPolicyListingDetail

API Version 2016-08-10 205

AWS Batch API Reference

• Secret
• ShareAttributes
• TaskContainerDependency
• TaskContainerDetails
• TaskContainerOverrides
• TaskContainerProperties
• TaskPropertiesOverride
• Tmpfs
• Ulimit
• UpdatePolicy
• Volume

API Version 2016-08-10 206

AWS Batch API Reference

ArrayProperties
An object that represents an AWS Batch array job.

Contents
size

The size of the array job.

Type: Integer

Required: No

See Also
For more information about using this API in one of the language-speciﬁc AWS SDKs, see the
following:

• AWS SDK for C++

• AWS SDK for Java V2
• AWS SDK for Ruby V3

ArrayProperties API Version 2016-08-10 207

AWS Batch API Reference

ArrayPropertiesDetail
An object that represents the array properties of a job.

Contents
index

The job index within the array that's associated with this job. This parameter is returned for
array job children.

Type: Integer

Required: No
size

The size of the array job. This parameter is returned for parent array jobs.

Type: Integer

Required: No
statusSummary

A summary of the number of array job children in each available job status. This parameter is
returned for parent array jobs.

Type: String to integer map

Required: No

See Also
For more information about using this API in one of the language-speciﬁc AWS SDKs, see the
following:

• AWS SDK for C++

• AWS SDK for Java V2
• AWS SDK for Ruby V3

ArrayPropertiesDetail API Version 2016-08-10 208

AWS Batch API Reference

ArrayPropertiesSummary
An object that represents the array properties of a job.

Contents
index

The job index within the array that's associated with this job. This parameter is returned for
children of array jobs.

Type: Integer

Required: No
size

The size of the array job. This parameter is returned for parent array jobs.

Type: Integer

Required: No

See Also
For more information about using this API in one of the language-speciﬁc AWS SDKs, see the
following:

• AWS SDK for C++

• AWS SDK for Java V2
• AWS SDK for Ruby V3

ArrayPropertiesSummary API Version 2016-08-10 209

AWS Batch API Reference

AttemptContainerDetail
An object that represents the details of a container that's part of a job attempt.

Contents
containerInstanceArn

The Amazon Resource Name (ARN) of the Amazon ECS container instance that hosts the job
attempt.

Type: String

Required: No
exitCode

The exit code for the job attempt. A non-zero exit code is considered failed.

Type: Integer

Required: No
logStreamName

The name of the CloudWatch Logs log stream that's associated with the container. The log
group for AWS Batch jobs is /aws/batch/job. Each container attempt receives a log stream
name when they reach the RUNNING status.

Type: String

Required: No
networkInterfaces

The network interfaces that are associated with the job attempt.

Type: Array of NetworkInterface objects

Required: No
reason

A short (255 max characters) human-readable string to provide additional details for a running
or stopped container.

AttemptContainerDetail API Version 2016-08-10 210

AWS Batch API Reference

Type: String

Required: No
taskArn

The Amazon Resource Name (ARN) of the Amazon ECS task that's associated with the job
attempt. Each container attempt receives a task ARN when they reach the STARTING status.

Type: String

Required: No

See Also
For more information about using this API in one of the language-speciﬁc AWS SDKs, see the
following:

• AWS SDK for C++

• AWS SDK for Java V2
• AWS SDK for Ruby V3

The details for the container in this job attempt.

Type: AttemptContainerDetail object

Required: No
startedAt

The Unix timestamp (in milliseconds) for when the attempt was started (when the attempt
transitioned from the STARTING state to the RUNNING state).

Type: Long

Required: No
statusReason

A short, human-readable string to provide additional details for the current status of the job
attempt.

Type: String

Required: No
stoppedAt

The Unix timestamp (in milliseconds) for when the attempt was stopped (when the attempt
transitioned from the RUNNING state to a terminal state, such as SUCCEEDED or FAILED).

Type: Long

Required: No
taskProperties

The properties for a task deﬁnition that describes the container and volume deﬁnitions of an
Amazon ECS task.

AttemptDetail API Version 2016-08-10 212

AWS Batch API Reference

Type: Array of AttemptEcsTaskDetails objects

Required: No

See Also
For more information about using this API in one of the language-speciﬁc AWS SDKs, see the
following:

• AWS SDK for C++

• AWS SDK for Java V2
• AWS SDK for Ruby V3

A list of containers that are included in the taskProperties list.

Type: Array of AttemptTaskContainerDetails objects

Required: No
taskArn

The ARN of the Amazon ECS task.

Type: String

Required: No

See Also
For more information about using this API in one of the language-speciﬁc AWS SDKs, see the
following:

• AWS SDK for C++

• AWS SDK for Java V2
• AWS SDK for Ruby V3

AttemptEcsTaskDetails API Version 2016-08-10 214

AWS Batch API Reference

AttemptTaskContainerDetails
An object that represents the details of a container that's part of a job attempt.

Contents
exitCode

The exit code for the container’s attempt. A non-zero exit code is considered failed.

Type: Integer

Required: No
logStreamName

The name of the Amazon CloudWatch Logs log stream that's associated with the container.
The log group for AWS Batch jobs is /aws/batch/job. Each container attempt receives a log
stream name when they reach the RUNNING status.

Type: String

Required: No
name

The name of a container.

Type: String

Required: No
networkInterfaces

The network interfaces that are associated with the job attempt.

Type: Array of NetworkInterface objects

Required: No
reason

A short (255 max characters) string that's easy to understand and provides additional details for
a running or stopped container.

AttemptTaskContainerDetails API Version 2016-08-10 215

AWS Batch API Reference

Type: String

Required: No

See Also
For more information about using this API in one of the language-speciﬁc AWS SDKs, see the
following:

• AWS SDK for C++

• AWS SDK for Java V2
• AWS SDK for Ruby V3

The Amazon Resource Name (ARN) of the compute environment.

Type: String

Required: Yes
computeEnvironmentName

The name of the compute environment. It can be up to 128 characters long. It can contain
uppercase and lowercase letters, numbers, hyphens (-), and underscores (_).

Type: String

Required: Yes
computeResources

The compute resources deﬁned for the compute environment. For more information, see
Compute environments in the AWS Batch User Guide.

Type: ComputeResource object

Required: No
containerOrchestrationType

The orchestration type of the compute environment. The valid values are ECS (default) or EKS.

Type: String

Valid Values: ECS | EKS

Required: No
context

Reserved.

ComputeEnvironmentDetail API Version 2016-08-10 217

AWS Batch API Reference

Type: String

Required: No
ecsClusterArn

The Amazon Resource Name (ARN) of the underlying Amazon ECS cluster that the compute
environment uses.

Type: String

Required: No
eksConﬁguration

The conﬁguration for the Amazon EKS cluster that supports the AWS Batch compute
environment. Only specify this parameter if the containerOrchestrationType is EKS.

Type: EksConﬁguration object

Required: No
serviceRole

The service role that's associated with the compute environment that allows AWS Batch to
make calls to AWS API operations on your behalf. For more information, see Batch service IAM
role in the AWS Batch User Guide.

Type: String

Required: No
state

The state of the compute environment. The valid values are ENABLED or DISABLED.

Contents API Version 2016-08-10 218

AWS Batch API Reference

Type: String

Valid Values: ENABLED | DISABLED

Required: No
status

The current status of the compute environment (for example, CREATING or VALID).

Type: String

Valid Values: CREATING | UPDATING | DELETING | DELETED | VALID | INVALID

Required: No
statusReason

A short, human-readable string to provide additional details for the current status of the
compute environment.

Type: String

Required: No
tags

The tags applied to the compute environment.

Type: String to string map

Contents API Version 2016-08-10 219

AWS Batch API Reference

Map Entries: Maximum number of 50 items.

Key Length Constraints: Minimum length of 1. Maximum length of 128.

Value Length Constraints: Maximum length of 256.

Required: No
type

The type of the compute environment: MANAGED or UNMANAGED. For more information, see
Compute environments in the AWS Batch User Guide.

Type: String

Valid Values: MANAGED | UNMANAGED

Required: No
unmanagedvCpus

The maximum number of VCPUs expected to be used for an unmanaged compute environment.

Type: Integer

Required: No
updatePolicy

Speciﬁes the infrastructure update policy for the compute environment. For more information
about infrastructure updates, see Updating compute environments in the AWS Batch User
Guide.

Type: UpdatePolicy object

Required: No
uuid

Unique identiﬁer for the compute environment.

Type: String

Required: No

Contents API Version 2016-08-10 220

AWS Batch API Reference

See Also
For more information about using this API in one of the language-speciﬁc AWS SDKs, see the
following:

• AWS SDK for C++

• AWS SDK for Java V2
• AWS SDK for Ruby V3

The Amazon Resource Name (ARN) of the compute environment.

Type: String

Required: Yes
order

The order of the compute environment. Compute environments are tried in ascending order.
For example, if two compute environments are associated with a job queue, the compute
environment with a lower order integer value is tried for job placement ﬁrst.

Type: Integer

Required: Yes

ComputeEnvironmentOrder API Version 2016-08-10 222

AWS Batch API Reference

See Also
For more information about using this API in one of the language-speciﬁc AWS SDKs, see the
following:

• AWS SDK for C++

• AWS SDK for Java V2
• AWS SDK for Ruby V3

The maximum number of vCPUs that a compute environment can support.

Note
With BEST_FIT_PROGRESSIVE,SPOT_CAPACITY_OPTIMIZED and
SPOT_PRICE_CAPACITY_OPTIMIZED (recommended) strategies using On-Demand
or Spot Instances, and the BEST_FIT strategy using Spot Instances, AWS Batch might
need to exceed maxvCpus to meet your capacity requirements. In this event, AWS Batch
never exceeds maxvCpus by more than a single instance.

Type: Integer

Required: Yes
subnets

The VPC subnets where the compute resources are launched. These subnets must be within the
same VPC. Fargate compute resources can contain up to 16 subnets. For more information, see
VPCs and subnets in the Amazon VPC User Guide.

Note
AWS Batch on Amazon EC2 and AWS Batch on Amazon EKS support Local Zones. For
more information, see Local Zones in the Amazon EC2 User Guide for Linux Instances,
Amazon EKS and AWS Local Zones in the Amazon EKS User Guide and Amazon ECS
clusters in Local Zones, Wavelength Zones, and AWS Outposts in the Amazon ECS
Developer Guide.
AWS Batch on Fargate doesn't currently support Local Zones.

ComputeResource API Version 2016-08-10 224

AWS Batch API Reference

Type: Array of strings

Required: Yes
type

The type of compute environment: EC2, SPOT, FARGATE, or FARGATE_SPOT. For more
information, see Compute environments in the AWS Batch User Guide.

If you choose SPOT, you must also specify an Amazon EC2 Spot Fleet role with the
spotIamFleetRole parameter. For more information, see Amazon EC2 spot ﬂeet role in the
AWS Batch User Guide.

Type: String

Valid Values: EC2 | SPOT | FARGATE | FARGATE_SPOT

Required: Yes
allocationStrategy

The allocation strategy to use for the compute resource if not enough instances of the best
ﬁtting instance type can be allocated. This might be because of availability of the instance type
in the Region or Amazon EC2 service limits. For more information, see Allocation strategies in
the AWS Batch User Guide.

Note
This parameter isn't applicable to jobs that are running on Fargate resources. Don't
specify it.

BEST_FIT (default)

AWS Batch selects an instance type that best ﬁts the needs of the jobs with a preference
for the lowest-cost instance type. If additional instances of the selected instance type aren't
available, AWS Batch waits for the additional instances to be available. If there aren't enough
instances available or the user is reaching Amazon EC2 service limits, additional jobs aren't
run until the currently running jobs are completed. This allocation strategy keeps costs
lower but can limit scaling. If you're using Spot Fleets with BEST_FIT, the Spot Fleet IAM
Role must be speciﬁed. Compute resources that use a BEST_FIT allocation strategy don't

Contents API Version 2016-08-10 225

AWS Batch API Reference

support infrastructure updates and can't update some parameters. For more information,
see Updating compute environments in the AWS Batch User Guide.
BEST_FIT_PROGRESSIVE

AWS Batch selects additional instance types that are large enough to meet the requirements
of the jobs in the queue. Its preference is for instance types with lower cost vCPUs. If
additional instances of the previously selected instance types aren't available, AWS Batch
selects new instance types.
SPOT_CAPACITY_OPTIMIZED

AWS Batch selects one or more instance types that are large enough to meet the
requirements of the jobs in the queue. Its preference is for instance types that are less
likely to be interrupted. This allocation strategy is only available for Spot Instance compute
resources.
SPOT_PRICE_CAPACITY_OPTIMIZED

The price and capacity optimized allocation strategy looks at both price and capacity to
select the Spot Instance pools that are the least likely to be interrupted and have the lowest
possible price. This allocation strategy is only available for Spot Instance compute resources.

With BEST_FIT_PROGRESSIVE,SPOT_CAPACITY_OPTIMIZED and

SPOT_PRICE_CAPACITY_OPTIMIZED (recommended) strategies using On-Demand or Spot
Instances, and the BEST_FIT strategy using Spot Instances, AWS Batch might need to exceed
maxvCpus to meet your capacity requirements. In this event, AWS Batch never exceeds
maxvCpus by more than a single instance.

Type: String

Valid Values: BEST_FIT | BEST_FIT_PROGRESSIVE | SPOT_CAPACITY_OPTIMIZED |

SPOT_PRICE_CAPACITY_OPTIMIZED

Required: No
bidPercentage

The maximum percentage that a Spot Instance price can be when compared with the On-
Demand price for that instance type before instances are launched. For example, if your
maximum percentage is 20%, then the Spot price must be less than 20% of the current On-
Demand price for that Amazon EC2 instance. You always pay the lowest (market) price and

Contents API Version 2016-08-10 226

AWS Batch API Reference

never more than your maximum percentage. If you leave this ﬁeld empty, the default value is
100% of the On-Demand price. For most use cases, we recommend leaving this ﬁeld empty.

Note
This parameter isn't applicable to jobs that are running on Fargate resources. Don't
specify it.

Type: Integer

Required: No
desiredvCpus

The desired number of vCPUS in the compute environment. AWS Batch modiﬁes this value
between the minimum and maximum values based on job queue demand.

Note
This parameter isn't applicable to jobs that are running on Fargate resources. Don't
specify it.

Type: Integer

Required: No
ec2Conﬁguration

Provides information that's used to select Amazon Machine Images (AMIs) for Amazon EC2
instances in the compute environment. If Ec2Configuration isn't speciﬁed, the default is
ECS_AL2.

One or two values can be provided.

Note
This parameter isn't applicable to jobs that are running on Fargate resources. Don't
specify it.

Contents API Version 2016-08-10 227

AWS Batch API Reference

Type: Array of Ec2Conﬁguration objects

Required: No
ec2KeyPair

The Amazon EC2 key pair that's used for instances launched in the compute environment. You
can use this key pair to log in to your instances with SSH.

Note
This parameter isn't applicable to jobs that are running on Fargate resources. Don't
specify it.

Type: String

Required: No
imageId

This member has been deprecated.

The Amazon Machine Image (AMI) ID used for instances launched in the compute environment.
This parameter is overridden by the imageIdOverride member of the Ec2Configuration
structure.

Note
This parameter isn't applicable to jobs that are running on Fargate resources. Don't
specify it.

Note
The AMI that you choose for a compute environment must match the architecture of
the instance types that you intend to use for that compute environment. For example,
if your compute environment uses A1 instance types, the compute resource AMI that
you choose must support ARM instances. Amazon ECS vends both x86 and ARM versions
of the Amazon ECS-optimized Amazon Linux 2 AMI. For more information, see Amazon

Contents API Version 2016-08-10 228

AWS Batch API Reference

ECS-optimized Amazon Linux 2 AMI in the Amazon Elastic Container Service Developer
Guide.

Type: String

Required: No
instanceRole

The Amazon ECS instance proﬁle applied to Amazon EC2 instances in a compute environment.
This parameter is required for Amazon EC2 instances types. You can specify the short name or
full Amazon Resource Name (ARN) of an instance proﬁle. For example, ecsInstanceRole or
arn:aws:iam::<aws_account_id>:instance-profile/ecsInstanceRole . For more
information, see Amazon ECS instance role in the AWS Batch User Guide.

Note
This parameter isn't applicable to jobs that are running on Fargate resources. Don't
specify it.

Type: String

Required: No

instanceTypes

The instances types that can be launched. You can specify instance families to launch any
instance type within those families (for example, c5 or p3), or you can specify speciﬁc sizes
within a family (such as c5.8xlarge). You can also choose optimal to select instance types
(from the C4, M4, and R4 instance families) that match the demand of your job queues.

Note
This parameter isn't applicable to jobs that are running on Fargate resources. Don't
specify it.

Contents API Version 2016-08-10 229

AWS Batch API Reference

Note
When you create a compute environment, the instance types that you select for the
compute environment must share the same architecture. For example, you can't mix x86
and ARM instances in the same compute environment.

Note
Currently, optimal uses instance types from the C4, M4, and R4 instance families. In
Regions that don't have instance types from those instance families, instance types from
the C5, M5, and R5 instance families are used.

Type: Array of strings

Required: No
launchTemplate

The launch template to use for your compute resources. Any other compute resource
parameters that you specify in a CreateComputeEnvironment API operation override the
same parameters in the launch template. You must specify either the launch template ID or
launch template name in the request, but not both. For more information, see Launch template
support in the AWS Batch User Guide.

Note
This parameter isn't applicable to jobs that are running on Fargate resources. Don't
specify it.

Type: LaunchTemplateSpeciﬁcation object

Required: No
minvCpus

The minimum number of vCPUs that a compute environment should maintain (even if the
compute environment is DISABLED).

Contents API Version 2016-08-10 230

AWS Batch API Reference

Note
This parameter isn't applicable to jobs that are running on Fargate resources. Don't
specify it.

Type: Integer

Required: No
placementGroup

The Amazon EC2 placement group to associate with your compute resources. If you intend to
submit multi-node parallel jobs to your compute environment, you should consider creating a
cluster placement group and associate it with your compute resources. This keeps your multi-
node parallel job on a logical grouping of instances within a single Availability Zone with high
network ﬂow potential. For more information, see Placement groups in the Amazon EC2 User
Guide for Linux Instances.

Note
This parameter isn't applicable to jobs that are running on Fargate resources. Don't
specify it.

Type: String

Required: No
securityGroupIds

The Amazon EC2 security groups that are associated with instances launched in the compute
environment. One or more security groups must be speciﬁed, either in securityGroupIds
or using a launch template referenced in launchTemplate. This parameter is required for
jobs that are running on Fargate resources and must contain at least one security group.
Fargate doesn't support launch templates. If security groups are speciﬁed using both
securityGroupIds and launchTemplate, the values in securityGroupIds are used.

Type: Array of strings

Required: No

Contents API Version 2016-08-10 231

AWS Batch API Reference

spotIamFleetRole

The Amazon Resource Name (ARN) of the Amazon EC2 Spot Fleet IAM role applied to a SPOT
compute environment. This role is required if the allocation strategy set to BEST_FIT or if the
allocation strategy isn't speciﬁed. For more information, see Amazon EC2 spot ﬂeet role in the
AWS Batch User Guide.

Note
This parameter isn't applicable to jobs that are running on Fargate resources. Don't
specify it.

Important
To tag your Spot Instances on creation, the Spot Fleet IAM role speciﬁed here must
use the newer AmazonEC2SpotFleetTaggingRole managed policy. The previously
recommended AmazonEC2SpotFleetRole managed policy doesn't have the required
permissions to tag Spot Instances. For more information, see Spot instances not tagged
on creation in the AWS Batch User Guide.

Type: String

Required: No

tags

Key-value pair tags to be applied to Amazon EC2 resources that are launched in the compute
environment. For AWS Batch, these take the form of "String1": "String2", where
String1 is the tag key and String2 is the tag value-for example, { "Name": "Batch
Instance - C4OnDemand" }. This is helpful for recognizing your AWS Batch instances in the
Amazon EC2 console. Updating these tags requires an infrastructure update to the compute
environment. For more information, see Updating compute environments in the AWS Batch
User Guide. These tags aren't seen when using the AWS Batch ListTagsForResource API
operation.

Contents API Version 2016-08-10 232

AWS Batch API Reference

Note
This parameter isn't applicable to jobs that are running on Fargate resources. Don't
specify it.

Type: String to string map

Required: No

See Also
For more information about using this API in one of the language-speciﬁc AWS SDKs, see the
following:

• AWS SDK for C++

• AWS SDK for Java V2
• AWS SDK for Ruby V3

When updating a compute environment, changing the allocation strategy requires an

infrastructure update of the compute environment. For more information, see Updating
compute environments in the AWS Batch User Guide. BEST_FIT isn't supported when updating
a compute environment.

Note
This parameter isn't applicable to jobs that are running on Fargate resources. Don't
specify it.

BEST_FIT_PROGRESSIVE

SPOT_CAPACITY_OPTIMIZED

ComputeResourceUpdate API Version 2016-08-10 234

AWS Batch API Reference

SPOT_PRICE_CAPACITY_OPTIMIZED

With BEST_FIT_PROGRESSIVE,SPOT_CAPACITY_OPTIMIZED and

Type: String

Valid Values: BEST_FIT_PROGRESSIVE | SPOT_CAPACITY_OPTIMIZED |

SPOT_PRICE_CAPACITY_OPTIMIZED

Required: No
bidPercentage

The maximum percentage that a Spot Instance price can be when compared with the On-
Demand price for that instance type before instances are launched. For example, if your
maximum percentage is 20%, the Spot price must be less than 20% of the current On-Demand
price for that Amazon EC2 instance. You always pay the lowest (market) price and never more
than your maximum percentage. For most use cases, we recommend leaving this ﬁeld empty.

When updating a compute environment, changing the bid percentage requires an infrastructure
update of the compute environment. For more information, see Updating compute
environments in the AWS Batch User Guide.

Note
This parameter isn't applicable to jobs that are running on Fargate resources. Don't
specify it.

Type: Integer

Required: No

Contents API Version 2016-08-10 235

AWS Batch API Reference

desiredvCpus

The desired number of vCPUS in the compute environment. AWS Batch modiﬁes this value
between the minimum and maximum values based on job queue demand.

Note
This parameter isn't applicable to jobs that are running on Fargate resources. Don't
specify it.

Note
AWS Batch doesn't support changing the desired number of vCPUs of an existing
compute environment. Don't specify this parameter for compute environments using
Amazon EKS clusters.

Note
When you update the desiredvCpus setting, the value must be between the
minvCpus and maxvCpus values.
Additionally, the updated desiredvCpus value must be greater than or equal to the
current desiredvCpus value. For more information, see Troubleshooting AWS Batch in
the AWS Batch User Guide.

Type: Integer

Required: No
ec2Conﬁguration

Provides information used to select Amazon Machine Images (AMIs) for Amazon EC2 instances
in the compute environment. If Ec2Configuration isn't speciﬁed, the default is ECS_AL2.

When updating a compute environment, changing this setting requires an infrastructure update
of the compute environment. For more information, see Updating compute environments in
the AWS Batch User Guide. To remove the Amazon EC2 conﬁguration and any custom AMI ID
speciﬁed in imageIdOverride, set this value to an empty string.

Contents API Version 2016-08-10 236

AWS Batch API Reference

One or two values can be provided.

Note
This parameter isn't applicable to jobs that are running on Fargate resources. Don't
specify it.

Type: Array of Ec2Conﬁguration objects

Required: No
ec2KeyPair

The Amazon EC2 key pair that's used for instances launched in the compute environment. You
can use this key pair to log in to your instances with SSH. To remove the Amazon EC2 key pair,
set this value to an empty string.

When updating a compute environment, changing the Amazon EC2 key pair requires an
infrastructure update of the compute environment. For more information, see Updating
compute environments in the AWS Batch User Guide.

Note
This parameter isn't applicable to jobs that are running on Fargate resources. Don't
specify it.

Type: String

Required: No
imageId

The Amazon Machine Image (AMI) ID used for instances launched in the compute environment.
This parameter is overridden by the imageIdOverride member of the Ec2Configuration
structure. To remove the custom AMI ID and use the default AMI ID, set this value to an empty
string.

When updating a compute environment, changing the AMI ID requires an infrastructure update
of the compute environment. For more information, see Updating compute environments in the
AWS Batch User Guide.

Contents API Version 2016-08-10 237

AWS Batch API Reference

Note
This parameter isn't applicable to jobs that are running on Fargate resources. Don't
specify it.

Type: String

Required: No
instanceRole

The Amazon ECS instance proﬁle applied to Amazon EC2 instances in a compute environment.
Required for Amazon EC2 instances. You can specify the short name or full Amazon
Resource Name (ARN) of an instance proﬁle. For example, ecsInstanceRole or
arn:aws:iam::<aws_account_id>:instance-profile/ecsInstanceRole . For more
information, see Amazon ECS instance role in the AWS Batch User Guide.

Note
This parameter isn't applicable to jobs that are running on Fargate resources. Don't
specify it.

Type: String

Contents API Version 2016-08-10 238

AWS Batch API Reference

Required: No
instanceTypes

Note
This parameter isn't applicable to jobs that are running on Fargate resources. Don't
specify it.

Type: Array of strings

Required: No
launchTemplate

The updated launch template to use for your compute resources. You must specify either
the launch template ID or launch template name in the request, but not both. For more

Contents API Version 2016-08-10 239

AWS Batch API Reference

information, see Launch template support in the AWS Batch User Guide. To remove the
custom launch template and use the default launch template, set launchTemplateId or
launchTemplateName member of the launch template specification to an empty string.
Removing the launch template from a compute environment will not remove the AMI specified
in the launch template. In order to update the AMI specified in a launch template, the
updateToLatestImageVersion parameter must be set to true.

When updating a compute environment, changing the launch template requires an

infrastructure update of the compute environment. For more information, see Updating
compute environments in the AWS Batch User Guide.

Note
This parameter isn't applicable to jobs that are running on Fargate resources. Don't
specify it.

Type: LaunchTemplateSpeciﬁcation object

Required: No

maxvCpus

The maximum number of Amazon EC2 vCPUs that an environment can reach.

Type: Integer

Required: No

Contents API Version 2016-08-10 240

AWS Batch API Reference

minvCpus

The minimum number of vCPUs that an environment should maintain (even if the compute
environment is DISABLED).

Note
This parameter isn't applicable to jobs that are running on Fargate resources. Don't
specify it.

Type: Integer

Required: No
placementGroup

When updating a compute environment, changing the placement group requires an

infrastructure update of the compute environment. For more information, see Updating
compute environments in the AWS Batch User Guide.

Note
This parameter isn't applicable to jobs that are running on Fargate resources. Don't
specify it.

Type: String

Required: No
securityGroupIds

The Amazon EC2 security groups that are associated with instances launched in the compute
environment. This parameter is required for Fargate compute resources, where it can contain

Contents API Version 2016-08-10 241

AWS Batch API Reference

up to 5 security groups. For Fargate compute resources, providing an empty list is handled as
if this parameter wasn't speciﬁed and no change is made. For Amazon EC2 compute resources,
providing an empty list removes the security groups from the compute resource.

When updating a compute environment, changing the Amazon EC2 security groups requires
an infrastructure update of the compute environment. For more information, see Updating
compute environments in the AWS Batch User Guide.

Type: Array of strings

Required: No
subnets

The VPC subnets where the compute resources are launched. Fargate compute resources
can contain up to 16 subnets. For Fargate compute resources, providing an empty list will be
handled as if this parameter wasn't speciﬁed and no change is made. For Amazon EC2 compute
resources, providing an empty list removes the VPC subnets from the compute resource. For
more information, see VPCs and subnets in the Amazon VPC User Guide.

When updating a compute environment, changing the VPC subnets requires an infrastructure
update of the compute environment. For more information, see Updating compute
environments in the AWS Batch User Guide.

Type: Array of strings

Required: No
tags

Key-value pair tags to be applied to Amazon EC2 resources that are launched in the
compute environment. For AWS Batch, these take the form of "String1": "String2",

Contents API Version 2016-08-10 242

AWS Batch API Reference

where String1 is the tag key and String2 is the tag value-for example, { "Name":
"Batch Instance - C4OnDemand" }. This is helpful for recognizing your Batch
instances in the Amazon EC2 console. These tags aren't seen when using the AWS Batch
ListTagsForResource API operation.

Note
This parameter isn't applicable to jobs that are running on Fargate resources. Don't
specify it.

Type: String to string map

Required: No
type

The type of compute environment: EC2, SPOT, FARGATE, or FARGATE_SPOT. For more
information, see Compute environments in the AWS Batch User Guide.

If you choose SPOT, you must also specify an Amazon EC2 Spot Fleet role with the
spotIamFleetRole parameter. For more information, see Amazon EC2 spot ﬂeet role in the
AWS Batch User Guide.

When updating a compute environment, changing the type of a compute environment requires
an infrastructure update of the compute environment. For more information, see Updating
compute environments in the AWS Batch User Guide.

Type: String

Valid Values: EC2 | SPOT | FARGATE | FARGATE_SPOT

Required: No
updateToLatestImageVersion

Speciﬁes whether the AMI ID is updated to the latest one that's supported by AWS Batch when
the compute environment has an infrastructure update. The default value is false.

Contents API Version 2016-08-10 243

AWS Batch API Reference

Note
An AMI ID can either be specified in the imageId or imageIdOverride parameters
or be determined by the launch template that's specified in the launchTemplate
parameter. If an AMI ID is specified any of these ways, this parameter is ignored.
For more information about to update AMI IDs during an infrastructure update, see
Updating the AMI ID in the AWS Batch User Guide.

Type: Boolean

Required: No

See Also
For more information about using this API in one of the language-speciﬁc AWS SDKs, see the
following:

• AWS SDK for C++

• AWS SDK for Java V2
• AWS SDK for Ruby V3

The command that's passed to the container.

Type: Array of strings

Required: No
containerInstanceArn

The Amazon Resource Name (ARN) of the container instance that the container is running on.

Type: String

Required: No
environment

The environment variables to pass to a container.

Note
Environment variables cannot start with "AWS_BATCH". This naming convention is
reserved for variables that AWS Batch sets.

Type: Array of KeyValuePair objects

Required: No
ephemeralStorage

The amount of ephemeral storage allocated for the task. This parameter is used to expand the
total amount of ephemeral storage available, beyond the default amount, for tasks hosted on
AWS Fargate.

Type: EphemeralStorage object

ContainerDetail API Version 2016-08-10 245

AWS Batch API Reference

Required: No
executionRoleArn

The Amazon Resource Name (ARN) of the execution role that AWS Batch can assume. For more
information, see Batch execution IAM role in the AWS Batch User Guide.

Type: String

Required: No
exitCode

The exit code returned upon completion.

Type: Integer

Required: No
fargatePlatformConﬁguration

The platform conﬁguration for jobs that are running on Fargate resources. Jobs that are running
on Amazon EC2 resources must not specify this parameter.

Type: FargatePlatformConﬁguration object

Required: No
image

The image used to start the container.

Type: String

Required: No
instanceType

The instance type of the underlying host infrastructure of a multi-node parallel job.

Note
This parameter isn't applicable to jobs that are running on Fargate resources.

Type: String

Contents API Version 2016-08-10 246

AWS Batch API Reference

Required: No
jobRoleArn

The Amazon Resource Name (ARN) that's associated with the job when run.

Type: String

Required: No
linuxParameters

Linux-speciﬁc modiﬁcations that are applied to the container, such as details for device
mappings.

Type: LinuxParameters object

Required: No
logConﬁguration

The log conﬁguration speciﬁcation for the container.

This parameter maps to LogConfig in the Create a container section of the Docker Remote
API and the --log-driver option to docker run. By default, containers use the same logging
driver that the Docker daemon uses. However, the container might use a different logging
driver than the Docker daemon by specifying a log driver with this parameter in the container
definition. To use a different logging driver for a container, the log system must be configured
properly on the container instance. Or, alternatively, it must be configured on a different log
server for remote logging options. For more information on the options for different supported
log drivers, see Configure logging drivers in the Docker documentation.

Note
AWS Batch currently supports a subset of the logging drivers available to the Docker
daemon (shown in the LogConﬁguration data type). Additional log drivers might be
available in future releases of the Amazon ECS container agent.

This parameter requires version 1.18 of the Docker Remote API or greater on your container
instance. To check the Docker Remote API version on your container instance, log in to your

Contents API Version 2016-08-10 247

AWS Batch API Reference

container instance and run the following command: sudo docker version | grep
"Server API version"

Note
The Amazon ECS container agent running on a container instance
must register the logging drivers available on that instance with the
ECS_AVAILABLE_LOGGING_DRIVERS environment variable before containers placed
on that instance can use these log conﬁguration options. For more information, see
Amazon ECS container agent conﬁguration in the Amazon Elastic Container Service
Developer Guide.

Type: LogConﬁguration object

Required: No
logStreamName

Type: String

Required: No
memory

For jobs running on Amazon EC2 resources that didn't specify memory requirements using
resourceRequirements, the number of MiB of memory reserved for the job. For other jobs,
including all run on Fargate resources, see resourceRequirements.

Type: Integer

Required: No
mountPoints

The mount points for data volumes in your container.

Type: Array of MountPoint objects

Contents API Version 2016-08-10 248

AWS Batch API Reference

Required: No
networkConﬁguration

The network conﬁguration for jobs that are running on Fargate resources. Jobs that are running
on Amazon EC2 resources must not specify this parameter.

Type: NetworkConﬁguration object

Required: No
networkInterfaces

The network interfaces that are associated with the job.

Type: Array of NetworkInterface objects

Required: No
privileged

When this parameter is true, the container is given elevated permissions on the host container
instance (similar to the root user). The default value is false.

Note
This parameter isn't applicable to jobs that are running on Fargate resources and
shouldn't be provided, or speciﬁed as false.

Type: Boolean

Required: No
readonlyRootFilesystem

When this parameter is true, the container is given read-only access to its root ﬁle system. This
parameter maps to ReadonlyRootfs in the Create a container section of the Docker Remote
API and the --read-only option to docker run.

Type: Boolean

Required: No

Contents API Version 2016-08-10 249

AWS Batch API Reference

reason

A short (255 max characters) human-readable string to provide additional details for a running
or stopped container.

Type: String

Required: No
repositoryCredentials

The private repository authentication credentials to use.

Type: RepositoryCredentials object

Required: No
resourceRequirements

The type and amount of resources to assign to a container. The supported resources include
GPU, MEMORY, and VCPU.

Type: Array of ResourceRequirement objects

Required: No
runtimePlatform

An object that represents the compute environment architecture for AWS Batch jobs on Fargate.

Type: RuntimePlatform object

Required: No
secrets

The secrets to pass to the container. For more information, see Specifying sensitive data in the
AWS Batch User Guide.

Type: Array of Secret objects

Required: No
taskArn

The Amazon Resource Name (ARN) of the Amazon ECS task that's associated with the container
job. Each container attempt receives a task ARN when they reach the STARTING status.

Contents API Version 2016-08-10 250

AWS Batch API Reference

Type: String

Required: No
ulimits

A list of ulimit values to set in the container. This parameter maps to Ulimits in the Create a
container section of the Docker Remote API and the --ulimit option to docker run.

Note
This parameter isn't applicable to jobs that are running on Fargate resources.

Type: Array of Ulimit objects

Required: No
user

The user name to use inside the container. This parameter maps to User in the Create a
container section of the Docker Remote API and the --user option to docker run.

Type: String

Required: No
vcpus

The number of vCPUs reserved for the container. For jobs that run on Amazon EC2 resources,
you can specify the vCPU requirement for the job using resourceRequirements, but you
can't specify the vCPU requirements in both the vcpus and resourceRequirements object.
This parameter maps to CpuShares in the Create a container section of the Docker Remote API
and the --cpu-shares option to docker run. Each vCPU is equivalent to 1,024 CPU shares. You
must specify at least one vCPU. This is required but can be speciﬁed in several places. It must be
speciﬁed for each node at least once.

Note
This parameter isn't applicable to jobs that run on Fargate resources. For jobs that
run on Fargate resources, you must specify the vCPU requirement for the job using
resourceRequirements.

Contents API Version 2016-08-10 251

AWS Batch API Reference

Type: Integer

Required: No
volumes

A list of volumes that are associated with the job.

Type: Array of Volume objects

Required: No

See Also
For more information about using this API in one of the language-speciﬁc AWS SDKs, see the
following:

• AWS SDK for C++

• AWS SDK for Java V2
• AWS SDK for Ruby V3

Type: Array of strings

Required: No
environment

The environment variables to send to the container. You can add new environment variables,
which are added to the container at launch, or you can override the existing environment
variables from the Docker image or the job deﬁnition.

Note
Environment variables cannot start with "AWS_BATCH". This naming convention is
reserved for variables that AWS Batch sets.

Type: Array of KeyValuePair objects

Required: No
instanceType

The instance type to use for a multi-node parallel job.

ContainerOverrides API Version 2016-08-10 253

AWS Batch API Reference

Note
This parameter isn't applicable to single-node container jobs or jobs that run on Fargate
resources, and shouldn't be provided.

Type: String

Required: No
memory

This parameter is deprecated, use resourceRequirements to override the memory

requirements specified in the job definition. It's not supported for jobs running on Fargate
resources. For jobs that run on Amazon EC2 resources, it overrides the memory parameter
set in the job definition, but doesn't override any memory requirement that's specified
in the resourceRequirements structure in the job definition. To override memory
requirements that are specified in the resourceRequirements structure in the job definition,
resourceRequirements must be specified in the SubmitJob request, with type set to
MEMORY and value set to the new value. For more information, see Can't override job definition
resource requirements in the AWS Batch User Guide.

Type: Integer

Required: No
resourceRequirements

The type and amount of resources to assign to a container. This overrides the settings in the job
deﬁnition. The supported resources include GPU, MEMORY, and VCPU.

Type: Array of ResourceRequirement objects

Required: No
vcpus

This parameter is deprecated, use resourceRequirements to override the vcpus parameter

that's set in the job definition. It's not supported for jobs running on Fargate resources. For jobs
that run on Amazon EC2 resources, it overrides the vcpus parameter set in the job definition,
but doesn't override any vCPU requirement specified in the resourceRequirements
structure in the job definition. To override vCPU requirements that are specified in the

Contents API Version 2016-08-10 254

AWS Batch API Reference

resourceRequirements structure in the job deﬁnition, resourceRequirements must be

speciﬁed in the SubmitJob request, with type set to VCPU and value set to the new value.
For more information, see Can't override job deﬁnition resource requirements in the AWS Batch
User Guide.

Type: Integer

Required: No

See Also
For more information about using this API in one of the language-speciﬁc AWS SDKs, see the
following:

• AWS SDK for C++

• AWS SDK for Java V2
• AWS SDK for Ruby V3

Type: Array of strings

Required: No

environment

The environment variables to pass to a container. This parameter maps to Env in the Create a
container section of the Docker Remote API and the --env option to docker run.

Important
We don't recommend using plaintext environment variables for sensitive information,
such as credential data.

Note
Environment variables cannot start with "AWS_BATCH". This naming convention is
reserved for variables that AWS Batch sets.

Type: Array of KeyValuePair objects

Required: No

ContainerProperties API Version 2016-08-10 256

AWS Batch API Reference

ephemeralStorage

The amount of ephemeral storage to allocate for the task. This parameter is used to expand the
total amount of ephemeral storage available, beyond the default amount, for tasks hosted on
AWS Fargate.

Type: EphemeralStorage object

Required: No
executionRoleArn

The Amazon Resource Name (ARN) of the execution role that AWS Batch can assume. For jobs
that run on Fargate resources, you must provide an execution role. For more information, see
AWS Batch execution IAM role in the AWS Batch User Guide.

Type: String

Required: No
fargatePlatformConﬁguration

The platform conﬁguration for jobs that are running on Fargate resources. Jobs that are running
on Amazon EC2 resources must not specify this parameter.

Type: FargatePlatformConﬁguration object

Required: No
image

Required. The image used to start a container. This string is passed directly to the Docker
daemon. Images in the Docker Hub registry are available by default. Other repositories are
speciﬁed with repository-url/image:tag . It can be 255 characters long. It can contain
uppercase and lowercase letters, numbers, hyphens (-), underscores (_), colons (:), periods
(.), forward slashes (/), and number signs (#). This parameter maps to Image in the Create a
container section of the Docker Remote API and the IMAGE parameter of docker run.

Note
Docker image architecture must match the processor architecture of the compute
resources that they're scheduled on. For example, ARM-based Docker images can only
run on ARM-based compute resources.

Contents API Version 2016-08-10 257

AWS Batch API Reference

• Images in Amazon ECR Public repositories use the full registry/repository[:tag]

or registry/repository[@digest] naming conventions. For example,
public.ecr.aws/registry_alias/my-web-app:latest .
• Images in Amazon ECR repositories use the full registry and repository URI (for example,
123456789012.dkr.ecr.<region-name>.amazonaws.com/<repository-name>).
• Images in official repositories on Docker Hub use a single name (for example, ubuntu or
mongo).
• Images in other repositories on Docker Hub are qualified with an organization name (for
example, amazon/amazon-ecs-agent).
• Images in other online repositories are qualified further by a domain name (for example,
quay.io/assemblyline/ubuntu).

Type: String

Required: No
instanceType

The instance type to use for a multi-node parallel job. All node groups in a multi-node parallel
job must use the same instance type.

Note
This parameter isn't applicable to single-node container jobs or jobs that run on Fargate
resources, and shouldn't be provided.

Type: String

Required: No
jobRoleArn

The Amazon Resource Name (ARN) of the IAM role that the container can assume for AWS
permissions. For more information, see IAM roles for tasks in the Amazon Elastic Container
Service Developer Guide.

Type: String

Required: No

Contents API Version 2016-08-10 258

AWS Batch API Reference

linuxParameters

Linux-speciﬁc modiﬁcations that are applied to the container, such as details for device
mappings.

Type: LinuxParameters object

Required: No
logConﬁguration

The log conﬁguration speciﬁcation for the container.

This parameter maps to LogConfig in the Create a container section of the Docker Remote
API and the --log-driver option to docker run. By default, containers use the same logging
driver that the Docker daemon uses. However the container might use a different logging
driver than the Docker daemon by specifying a log driver with this parameter in the container
definition. To use a different logging driver for a container, the log system must be configured
properly on the container instance (or on a different log server for remote logging options).
For more information on the options for different supported log drivers, see Configure logging
drivers in the Docker documentation.

Note
AWS Batch currently supports a subset of the logging drivers available to the Docker
daemon (shown in the LogConﬁguration data type).

This parameter requires version 1.18 of the Docker Remote API or greater on your container
instance. To check the Docker Remote API version on your container instance, log in to your
container instance and run the following command: sudo docker version | grep
"Server API version"

Contents API Version 2016-08-10 259

AWS Batch API Reference

Amazon ECS container agent conﬁguration in the Amazon Elastic Container Service
Developer Guide.

Type: LogConﬁguration object

Required: No
memory

This parameter is deprecated, use resourceRequirements to specify the memory

requirements for the job definition. It's not supported for jobs running on Fargate resources.
For jobs that run on Amazon EC2 resources, it specifies the memory hard limit (in MiB) for a
container. If your container attempts to exceed the specified number, it's terminated. You must
specify at least 4 MiB of memory for a job using this parameter. The memory hard limit can be
specified in several places. It must be specified for each node at least once.

Type: Integer

Required: No
mountPoints

The mount points for data volumes in your container. This parameter maps to Volumes in the
Create a container section of the Docker Remote API and the --volume option to docker run.

Type: Array of MountPoint objects

Required: No
networkConﬁguration

The network conﬁguration for jobs that are running on Fargate resources. Jobs that are running
on Amazon EC2 resources must not specify this parameter.

Type: NetworkConﬁguration object

Required: No
privileged

When this parameter is true, the container is given elevated permissions on the host container
instance (similar to the root user). This parameter maps to Privileged in the Create a

Contents API Version 2016-08-10 260

AWS Batch API Reference

container section of the Docker Remote API and the --privileged option to docker run. The
default value is false.

Note
This parameter isn't applicable to jobs that are running on Fargate resources and
shouldn't be provided, or speciﬁed as false.

Type: Boolean

Required: No
readonlyRootFilesystem

Type: Boolean

Required: No
repositoryCredentials

The private repository authentication credentials to use.

Type: RepositoryCredentials object

Required: No
resourceRequirements

The type and amount of resources to assign to a container. The supported resources include
GPU, MEMORY, and VCPU.

Type: Array of ResourceRequirement objects

Required: No
runtimePlatform

An object that represents the compute environment architecture for AWS Batch jobs on Fargate.

Type: RuntimePlatform object

Contents API Version 2016-08-10 261

AWS Batch API Reference

Required: No
secrets

The secrets for the container. For more information, see Specifying sensitive data in the AWS
Batch User Guide.

Type: Array of Secret objects

Required: No
ulimits

A list of ulimits to set in the container. This parameter maps to Ulimits in the Create a
container section of the Docker Remote API and the --ulimit option to docker run.

Note
This parameter isn't applicable to jobs that are running on Fargate resources and
shouldn't be provided.

Type: Array of Ulimit objects

Required: No
user

The user name to use inside the container. This parameter maps to User in the Create a
container section of the Docker Remote API and the --user option to docker run.

Type: String

Required: No
vcpus

This parameter is deprecated, use resourceRequirements to specify the vCPU requirements

for the job deﬁnition. It's not supported for jobs running on Fargate resources. For jobs running
on Amazon EC2 resources, it speciﬁes the number of vCPUs reserved for the job.

Each vCPU is equivalent to 1,024 CPU shares. This parameter maps to CpuShares in the Create
a container section of the Docker Remote API and the --cpu-shares option to docker run. The

Contents API Version 2016-08-10 262

AWS Batch API Reference

number of vCPUs must be speciﬁed but can be speciﬁed in several places. You must specify it at
least once for each node.

Type: Integer

Required: No
volumes

A list of data volumes used in a job.

Type: Array of Volume objects

Required: No

See Also
For more information about using this API in one of the language-speciﬁc AWS SDKs, see the
following:

• AWS SDK for C++

• AWS SDK for Java V2
• AWS SDK for Ruby V3

The exit code to return upon completion.

Type: Integer

Required: No
reason

A short (255 max characters) human-readable string to provide additional details for a running
or stopped container.

Type: String

Required: No

See Also
For more information about using this API in one of the language-speciﬁc AWS SDKs, see the
following:

• AWS SDK for C++

• AWS SDK for Java V2
• AWS SDK for Ruby V3

ContainerSummary API Version 2016-08-10 264

AWS Batch API Reference

Device
An object that represents a container instance host device.

Note
This object isn't applicable to jobs that are running on Fargate resources and shouldn't be
provided.

Contents
hostPath

The path for the device on the host container instance.

Type: String

Required: Yes

containerPath

The path inside the container that's used to expose the host device. By default, the hostPath
value is used.

Type: String

Required: No

permissions

The explicit permissions to provide to the container for the device. By default, the container has
permissions for read, write, and mknod for the device.

Type: Array of strings

Valid Values: READ | WRITE | MKNOD

Required: No

Device API Version 2016-08-10 265

AWS Batch API Reference

See Also
For more information about using this API in one of the language-speciﬁc AWS SDKs, see the
following:

• AWS SDK for C++

• AWS SDK for Java V2
• AWS SDK for Ruby V3

If the imageIdOverride parameter isn't speciﬁed, then a recent Amazon ECS-optimized

Amazon Linux 2 AMI (ECS_AL2) is used. If a new image type is speciﬁed in an update,
but neither an imageId nor a imageIdOverride parameter is speciﬁed, then the latest
Amazon ECS optimized AMI for that image type that's supported by AWS Batch is used.
ECS_AL2

Amazon Linux 2: Default for all non-GPU instance families.

ECS_AL2_NVIDIA

Amazon Linux 2 (GPU): Default for all GPU instance families (for example P4 and G4) and
can be used for all non AWS Graviton-based instance types.
ECS_AL2023

Amazon Linux 2023: AWS Batch supports Amazon Linux 2023.

Note
Amazon Linux 2023 does not support A1 instances.

Ec2Conﬁguration API Version 2016-08-10 267

AWS Batch API Reference

ECS_AL1

Amazon Linux. Amazon Linux has reached the end-of-life of standard support. For more
information, see Amazon Linux AMI.
EKS

If the imageIdOverride parameter isn't speciﬁed, then a recent Amazon EKS-optimized

Amazon Linux AMI (EKS_AL2) is used. If a new image type is speciﬁed in an update, but
neither an imageId nor a imageIdOverride parameter is speciﬁed, then the latest
Amazon EKS optimized AMI for that image type that AWS Batch supports is used.
EKS_AL2

Amazon Linux 2: Default for all non-GPU instance families.

EKS_AL2_NVIDIA

Amazon Linux 2 (accelerated): Default for all GPU instance families (for example, P4 and
G4) and can be used for all non AWS Graviton-based instance types.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 256.

Required: Yes
imageIdOverride

The AMI ID used for instances launched in the compute environment that match the image
type. This setting overrides the imageId set in the computeResource object.

Type: String

Contents API Version 2016-08-10 268

AWS Batch API Reference

Length Constraints: Minimum length of 1. Maximum length of 256.

Required: No
imageKubernetesVersion

The Kubernetes version for the compute environment. If you don't specify a value, the latest
version that AWS Batch supports is used.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 256.

Required: No

See Also
For more information about using this API in one of the language-speciﬁc AWS SDKs, see the
following:

• AWS SDK for C++

• AWS SDK for Java V2
• AWS SDK for Ruby V3

Type: Array of EcsTaskProperties objects

Required: Yes

See Also
For more information about using this API in one of the language-speciﬁc AWS SDKs, see the
following:

• AWS SDK for C++

• AWS SDK for Java V2
• AWS SDK for Ruby V3

EcsProperties API Version 2016-08-10 270

AWS Batch API Reference

EcsPropertiesDetail
An object that contains the details for the Amazon ECS resources of a job.

Contents
taskProperties

The properties for the Amazon ECS task deﬁnition of a job.

Type: Array of EcsTaskDetails objects

Required: No

See Also
For more information about using this API in one of the language-speciﬁc AWS SDKs, see the
following:

• AWS SDK for C++

• AWS SDK for Java V2
• AWS SDK for Ruby V3

EcsPropertiesDetail API Version 2016-08-10 271

AWS Batch API Reference

EcsPropertiesOverride
An object that contains overrides for the Amazon ECS task deﬁnition of a job.

Contents
taskProperties

The overrides for the Amazon ECS task deﬁnition of a job.

Note
This object is currently limited to one element.

Type: Array of TaskPropertiesOverride objects

Required: No

See Also
For more information about using this API in one of the language-speciﬁc AWS SDKs, see the
following:

• AWS SDK for C++

• AWS SDK for Java V2
• AWS SDK for Ruby V3

EcsPropertiesOverride API Version 2016-08-10 272

AWS Batch API Reference

EcsTaskDetails
The details of a task deﬁnition that describes the container and volume deﬁnitions of an Amazon
ECS task.

Contents
containerInstanceArn

The Amazon Resource Name (ARN) of the container instance that hosts the task.

Type: String

Required: No
containers

A list of containers that are included in the taskProperties list.

Type: Array of TaskContainerDetails objects

Required: No
ephemeralStorage

The amount of ephemeral storage allocated for the task.

Type: EphemeralStorage object

Required: No
executionRoleArn

The Amazon Resource Name (ARN) of the execution role that AWS Batch can assume. For more
information, see Batch execution IAM role in the AWS Batch User Guide.

Type: String

Required: No
ipcMode

The IPC resource namespace to use for the containers in the task.

Type: String

EcsTaskDetails API Version 2016-08-10 273

AWS Batch API Reference

Required: No
networkConﬁguration

The network conﬁguration for jobs that are running on Fargate resources. Jobs that are running
on Amazon EC2 resources must not specify this parameter.

Type: NetworkConﬁguration object

Required: No
pidMode

The process namespace to use for the containers in the task.

Type: String

Required: No
platformVersion

The Fargate platform version where the jobs are running.

Type: String

Required: No
runtimePlatform

An object that represents the compute environment architecture for AWS Batch jobs on Fargate.

Type: RuntimePlatform object

Required: No
taskArn

The ARN of the Amazon ECS task.

Type: String

Required: No
taskRoleArn

Contents API Version 2016-08-10 274

AWS Batch API Reference

Note
This is object is comparable to ContainerProperties:jobRoleArn.

Type: String

Required: No
volumes

A list of data volumes used in a job.

Type: Array of Volume objects

Required: No

See Also
For more information about using this API in one of the language-speciﬁc AWS SDKs, see the
following:

• AWS SDK for C++

• AWS SDK for Java V2
• AWS SDK for Ruby V3

This object is a list of containers.

Type: Array of TaskContainerProperties objects

Required: Yes
ephemeralStorage

The amount of ephemeral storage to allocate for the task. This parameter is used to expand the
total amount of ephemeral storage available, beyond the default amount, for tasks hosted on
AWS Fargate.

Type: EphemeralStorage object

Required: No
executionRoleArn

Type: String

Required: No
ipcMode

The IPC resource namespace to use for the containers in the task. The valid values are host,
task, or none.

If host is speciﬁed, all containers within the tasks that speciﬁed the host IPC mode on the
same container instance share the same IPC resources with the host Amazon EC2 instance.

EcsTaskProperties API Version 2016-08-10 276

AWS Batch API Reference

If task is speciﬁed, all containers within the speciﬁed task share the same IPC resources.

If none is speciﬁed, the IPC resources within the containers of a task are private, and are not
shared with other containers in a task or on the container instance.

If no value is speciﬁed, then the IPC resource namespace sharing depends on the Docker
daemon setting on the container instance. For more information, see IPC settings in the Docker
run reference.

Type: String

Required: No
networkConﬁguration

The network conﬁguration for jobs that are running on Fargate resources. Jobs that are running
on Amazon EC2 resources must not specify this parameter.

Type: NetworkConﬁguration object

Required: No
pidMode

The process namespace to use for the containers in the task. The valid values are host or task.
For example, monitoring sidecars might need pidMode to access information about other
containers running in the same task.

If host is speciﬁed, all containers within the tasks that speciﬁed the host PID mode on the
same container instance share the process namespace with the host Amazon EC2 instance.

If task is speciﬁed, all containers within the speciﬁed task share the same process namespace.

If no value is speciﬁed, the default is a private namespace for each container. For more
information, see PID settings in the Docker run reference.

Type: String

Required: No
platformVersion

The Fargate platform version where the jobs are running. A platform version is speciﬁed only
for jobs that are running on Fargate resources. If one isn't speciﬁed, the LATEST platform

Contents API Version 2016-08-10 277

AWS Batch API Reference

version is used by default. This uses a recent, approved version of the Fargate platform for
compute resources. For more information, see AWS Fargate platform versions in the Amazon
Elastic Container Service Developer Guide.

Type: String

Required: No
runtimePlatform

An object that represents the compute environment architecture for AWS Batch jobs on Fargate.

Type: RuntimePlatform object

Required: No
taskRoleArn

The Amazon Resource Name (ARN) that's associated with the Amazon ECS task.

Note
This is object is comparable to ContainerProperties:jobRoleArn.

Type: String

Required: No
volumes

A list of volumes that are associated with the job.

Type: Array of Volume objects

Required: No

See Also

For more information about using this API in one of the language-speciﬁc AWS SDKs, see the
following:

• AWS SDK for C++

• AWS SDK for Java V2

• AWS SDK for Ruby V3

Valid Values: ENABLED | DISABLED

Required: No

See Also
For more information about using this API in one of the language-speciﬁc AWS SDKs, see the
following:

• AWS SDK for C++

• AWS SDK for Java V2

EFSAuthorizationConﬁg API Version 2016-08-10 280

AWS Batch API Reference

• AWS SDK for Ruby V3

The Amazon EFS ﬁle system ID to use.

Type: String

Required: Yes
authorizationConﬁg

The authorization conﬁguration details for the Amazon EFS ﬁle system.

Type: EFSAuthorizationConﬁg object

Required: No
rootDirectory

The directory within the Amazon EFS ﬁle system to mount as the root directory inside the host.
If this parameter is omitted, the root of the Amazon EFS volume is used instead. Specifying /
has the same eﬀect as omitting this parameter. The maximum length is 4,096 characters.

Important
If an EFS access point is speciﬁed in the authorizationConfig, the root directory
parameter must either be omitted or set to /, which enforces the path set on the
Amazon EFS access point.

Type: String

Required: No
transitEncryption

Determines whether to enable encryption for Amazon EFS data in transit between the Amazon
ECS host and the Amazon EFS server. Transit encryption must be enabled if Amazon EFS IAM

EFSVolumeConﬁguration API Version 2016-08-10 282

AWS Batch API Reference

authorization is used. If this parameter is omitted, the default value of DISABLED is used. For
more information, see Encrypting data in transit in the Amazon Elastic File System User Guide.

Type: String

Valid Values: ENABLED | DISABLED

Required: No
transitEncryptionPort

The port to use when sending encrypted data between the Amazon ECS host and the Amazon
EFS server. If you don't specify a transit encryption port, it uses the port selection strategy
that the Amazon EFS mount helper uses. The value must be between 0 and 65,535. For more
information, see EFS mount helper in the Amazon Elastic File System User Guide.

Type: Integer

Required: No

See Also
For more information about using this API in one of the language-speciﬁc AWS SDKs, see the
following:

• AWS SDK for C++

• AWS SDK for Java V2
• AWS SDK for Ruby V3

The name of a container.

Type: String

Required: No
reason

A short (255 max characters) human-readable string to provide additional details for a running
or stopped container.

Type: String

Required: No

See Also
For more information about using this API in one of the language-speciﬁc AWS SDKs, see the
following:

• AWS SDK for C++

• AWS SDK for Java V2
• AWS SDK for Ruby V3

EksAttemptContainerDetail API Version 2016-08-10 284

AWS Batch API Reference

EksAttemptDetail
An object that represents the details of a job attempt for a job attempt by an Amazon EKS
container.

Contents
containers

The details for the ﬁnal status of the containers for this job attempt.

Type: Array of EksAttemptContainerDetail objects

Required: No
eksClusterArn

The Amazon Resource Name (ARN) of the Amazon EKS cluster.

Type: String

Required: No
initContainers

The details for the init containers.

Type: Array of EksAttemptContainerDetail objects

Required: No
nodeName

The name of the node for this job attempt.

Type: String

Required: No
podName

The name of the pod for this job attempt.

Type: String

Required: No

EksAttemptDetail API Version 2016-08-10 285

AWS Batch API Reference

startedAt

The Unix timestamp (in milliseconds) for when the attempt was started (when the attempt
transitioned from the STARTING state to the RUNNING state).

Type: Long

Required: No
statusReason

A short, human-readable string to provide additional details for the current status of the job
attempt.

Type: String

Required: No
stoppedAt

The Unix timestamp (in milliseconds) for when the attempt was stopped. This happens when
the attempt transitioned from the RUNNING state to a terminal state, such as SUCCEEDED or
FAILED.

Type: Long

Required: No

See Also
For more information about using this API in one of the language-speciﬁc AWS SDKs, see the
following:

• AWS SDK for C++

• AWS SDK for Java V2
• AWS SDK for Ruby V3

• AWS SDK for C++

• AWS SDK for Java V2
• AWS SDK for Ruby V3

EksConﬁguration API Version 2016-08-10 287

AWS Batch API Reference

EksContainer
EKS container properties are used in job definitions for Amazon EKS based job definitions to
describe the properties for a container node in the pod that's launched as part of a job. This can't
be specified for Amazon ECS based job definitions.

Contents
image

The Docker image used to start the container.

Type: String

Required: Yes
args

An array of arguments to the entrypoint. If this isn't speciﬁed, the CMD of the container image is
used. This corresponds to the args member in the Entrypoint portion of the Pod in Kubernetes.
Environment variable references are expanded using the container's environment.

If the referenced environment variable doesn't exist, the reference in the command isn't
changed. For example, if the reference is to "$(NAME1)" and the NAME1 environment variable
doesn't exist, the command string will remain "$(NAME1)." $$ is replaced with $, and the
resulting string isn't expanded. For example, $$(VAR_NAME) is passed as $(VAR_NAME)
whether or not the VAR_NAME environment variable exists. For more information, see
Dockerﬁle reference: CMD and Deﬁne a command and arguments for a pod in the Kubernetes
documentation.

Type: Array of strings

Required: No
command

The entrypoint for the container. This isn't run within a shell. If this isn't speciﬁed, the
ENTRYPOINT of the container image is used. Environment variable references are expanded
using the container's environment.

If the referenced environment variable doesn't exist, the reference in the command isn't
changed. For example, if the reference is to "$(NAME1)" and the NAME1 environment variable

EksContainer API Version 2016-08-10 288

AWS Batch API Reference

doesn't exist, the command string will remain "$(NAME1)." $$ is replaced with $ and the
resulting string isn't expanded. For example, $$(VAR_NAME) will be passed as $(VAR_NAME)
whether or not the VAR_NAME environment variable exists. The entrypoint can't be updated.
For more information, see ENTRYPOINT in the Dockerﬁle reference and Deﬁne a command and
arguments for a container and Entrypoint in the Kubernetes documentation.

Type: Array of strings

Required: No
env

The environment variables to pass to a container.

Note
Environment variables cannot start with "AWS_BATCH". This naming convention is
reserved for variables that AWS Batch sets.

Type: Array of EksContainerEnvironmentVariable objects

Required: No
imagePullPolicy

The image pull policy for the container. Supported values are Always, IfNotPresent,
and Never. This parameter defaults to IfNotPresent. However, if the :latest tag is
speciﬁed, it defaults to Always. For more information, see Updating images in the Kubernetes
documentation.

Type: String

Required: No
name

The name of the container. If the name isn't speciﬁed, the default name "Default" is used.
Each container in a pod must have a unique name.

Type: String

Required: No

Contents API Version 2016-08-10 289

AWS Batch API Reference

resources

The type and amount of resources to assign to a container. The supported resources include
memory, cpu, and nvidia.com/gpu. For more information, see Resource management for
pods and containers in the Kubernetes documentation.

Type: EksContainerResourceRequirements object

Required: No
securityContext

The security context for a job. For more information, see Conﬁgure a security context for a pod
or container in the Kubernetes documentation.

Type: EksContainerSecurityContext object

Required: No
volumeMounts

The volume mounts for the container. AWS Batch supports emptyDir, hostPath, and secret
volume types. For more information about volumes and volume mounts in Kubernetes, see
Volumes in the Kubernetes documentation.

Type: Array of EksContainerVolumeMount objects

Required: No

See Also
For more information about using this API in one of the language-speciﬁc AWS SDKs, see the
following:

• AWS SDK for C++

• AWS SDK for Java V2
• AWS SDK for Ruby V3

Type: Array of strings

Required: No
command

The entrypoint for the container. For more information, see Entrypoint in the Kubernetes
documentation.

Type: Array of strings

Required: No
env

The environment variables to pass to a container.

Note
Environment variables cannot start with "AWS_BATCH". This naming convention is
reserved for variables that AWS Batch sets.

EksContainerDetail API Version 2016-08-10 291

AWS Batch API Reference

Type: Array of EksContainerEnvironmentVariable objects

Required: No
exitCode

The exit code returned for the job attempt. A non-zero exit code is considered failed.

Type: Integer

Required: No
image

The Docker image used to start the container.

Type: String

Required: No
imagePullPolicy

The image pull policy for the container. Supported values are Always, IfNotPresent, and
Never. This parameter defaults to Always if the :latest tag is speciﬁed, IfNotPresent
otherwise. For more information, see Updating images in the Kubernetes documentation.

Type: String

Required: No
name

The name of the container. If the name isn't speciﬁed, the default name "Default" is used.
Each container in a pod must have a unique name.

Type: String

Required: No
reason

A short human-readable string to provide additional details for a running or stopped container.
It can be up to 255 characters long.

Type: String

Required: No

Contents API Version 2016-08-10 292

AWS Batch API Reference

resources

Type: EksContainerResourceRequirements object

Required: No
securityContext

The security context for a job. For more information, see Conﬁgure a security context for a pod
or container in the Kubernetes documentation.

Type: EksContainerSecurityContext object

Required: No
volumeMounts

Type: Array of EksContainerVolumeMount objects

Required: No

See Also
For more information about using this API in one of the language-speciﬁc AWS SDKs, see the
following:

• AWS SDK for C++

• AWS SDK for Java V2
• AWS SDK for Ruby V3

The name of the environment variable.

Type: String

Required: Yes
value

The value of the environment variable.

Type: String

Required: No

See Also
For more information about using this API in one of the language-speciﬁc AWS SDKs, see the
following:

• AWS SDK for C++

• AWS SDK for Java V2
• AWS SDK for Ruby V3

EksContainerEnvironmentVariable API Version 2016-08-10 294

AWS Batch API Reference

EksContainerOverride
Object representing any Kubernetes overrides to a job deﬁnition that's used in a SubmitJob API
operation.

Contents
args

The arguments to the entrypoint to send to the container that overrides the default arguments
from the Docker image or the job definition. For more information, see Dockerfile reference:
CMD and Define a command an arguments for a pod in the Kubernetes documentation.

Type: Array of strings

Required: No
command

The command to send to the container that overrides the default command from the Docker
image or the job deﬁnition.

Type: Array of strings

Required: No
env

The environment variables to send to the container. You can add new environment variables,
which are added to the container at launch. Or, you can override the existing environment
variables from the Docker image or the job deﬁnition.

Note
Environment variables cannot start with "AWS_BATCH". This naming convention is
reserved for variables that AWS Batch sets.

Type: Array of EksContainerEnvironmentVariable objects

Required: No

EksContainerOverride API Version 2016-08-10 295

AWS Batch API Reference

image

The override of the Docker image that's used to start the container.

Type: String

Required: No
name

A pointer to the container that you want to override. The name must match a unique container
name that you wish to override.

Type: String

Required: No
resources

The type and amount of resources to assign to a container. These override the settings in
the job deﬁnition. The supported resources include memory, cpu, and nvidia.com/gpu.
For more information, see Resource management for pods and containers in the Kubernetes
documentation.

Type: EksContainerResourceRequirements object

Required: No

See Also
For more information about using this API in one of the language-speciﬁc AWS SDKs, see the
following:

• AWS SDK for C++

• AWS SDK for Java V2
• AWS SDK for Ruby V3

EksContainerResourceRequirements API Version 2016-08-10 297

AWS Batch API Reference

places, then the value that's speciﬁed in limits must be equal to the value that's speciﬁed
in requests.

Type: String to string map

Value Length Constraints: Minimum length of 1. Maximum length of 256.

Required: No
requests

The type and quantity of the resources to request for the container. The values vary based
on the name that's speciﬁed. Resources can be requested by using either the limits or the
requests objects.
memory

The memory hard limit (in MiB) for the container, using whole integers, with a "Mi" suffix.
If your container attempts to exceed the memory specified, the container is terminated.
You must specify at least 4 MiB of memory for a job. memory can be specified in limits,
requests, or both. If memory is specified in both, then the value that's specified in limits
must be equal to the value that's specified in requests.

Note
If you're trying to maximize your resource utilization by providing your jobs as much
memory as possible for a particular instance type, see Memory management in the
AWS Batch User Guide.

cpu

The number of CPUs that are reserved for the container. Values must be an even multiple of
0.25. cpu can be specified in limits, requests, or both. If cpu is specified in both, then
the value that's specified in limits must be at least as large as the value that's specified in
requests.
nvidia.com/gpu

The number of GPUs that are reserved for the container. Values must be a whole integer.
nvidia.com/gpu can be speciﬁed in limits, requests, or both. If nvidia.com/gpu is

Contents API Version 2016-08-10 298

AWS Batch API Reference

specified in both, then the value that's specified in limits must be equal to the value that's
specified in requests.

Type: String to string map

Value Length Constraints: Minimum length of 1. Maximum length of 256.

Required: No

See Also
For more information about using this API in one of the language-speciﬁc AWS SDKs, see the
following:

• AWS SDK for C++

• AWS SDK for Java V2
• AWS SDK for Ruby V3

EksContainerSecurityContext API Version 2016-08-10 300

AWS Batch API Reference

Type: Long

Required: No
runAsNonRoot

When this parameter is speciﬁed, the container is run as a user with a uid other than 0. If this
parameter isn't speciﬁed, so such rule is enforced. This parameter maps to RunAsUser and
MustRunAsNonRoot policy in the Users and groups pod security policies in the Kubernetes
documentation.

Type: Boolean

Required: No
runAsUser

When this parameter is specified, the container is run as the specified user ID (uid). If this
parameter isn't specified, the default is the user that's specified in the image metadata. This
parameter maps to RunAsUser and MustRanAs policy in the Users and groups pod security
policies in the Kubernetes documentation.

Type: Long

Required: No

See Also
For more information about using this API in one of the language-speciﬁc AWS SDKs, see the
following:

• AWS SDK for C++

• AWS SDK for Java V2
• AWS SDK for Ruby V3

The path on the container where the volume is mounted.

Type: String

Required: No
name

The name the volume mount. This must match the name of one of the volumes in the pod.

Type: String

Required: No
readOnly

If this value is true, the container has read-only access to the volume. Otherwise, the container
can write to the volume. The default value is false.

Type: Boolean

Required: No

See Also
For more information about using this API in one of the language-speciﬁc AWS SDKs, see the
following:

• AWS SDK for C++

• AWS SDK for Java V2
• AWS SDK for Ruby V3

EksContainerVolumeMount API Version 2016-08-10 302

AWS Batch API Reference

EksEmptyDir
Specifies the configuration of a Kubernetes emptyDir volume. An emptyDir volume is first
created when a pod is assigned to a node. It exists as long as that pod is running on that node. The
emptyDir volume is initially empty. All containers in the pod can read and write the files in the
emptyDir volume. However, the emptyDir volume can be mounted at the same or different paths
in each container. When a pod is removed from a node for any reason, the data in the emptyDir is
deleted permanently. For more information, see emptyDir in the Kubernetes documentation.

Contents
medium

The medium to store the volume. The default value is an empty string, which uses the storage
of the node.

(Default) Use the disk storage of the node.

"Memory"

Use the tmpfs volume that's backed by the RAM of the node. Contents of the volume are
lost when the node reboots, and any storage on the volume counts against the container's
memory limit.

Type: String

Required: No

sizeLimit

The maximum size of the volume. By default, there's no maximum size deﬁned.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 256.

Required: No

EksEmptyDir API Version 2016-08-10 303

AWS Batch API Reference

See Also
For more information about using this API in one of the language-speciﬁc AWS SDKs, see the
following:

• AWS SDK for C++

• AWS SDK for Java V2
• AWS SDK for Ruby V3

• AWS SDK for C++

• AWS SDK for Java V2
• AWS SDK for Ruby V3

EksHostPath API Version 2016-08-10 305

AWS Batch API Reference

EksMetadata
Describes and uniquely identiﬁes Kubernetes resources. For example, the compute environment
that a pod runs in or the jobID for a job running in the pod. For more information, see
Understanding Kubernetes Objects in the Kubernetes documentation.

Contents
labels

Key-value pairs used to identify, sort, and organize cube resources. Can contain up to 63
uppercase letters, lowercase letters, numbers, hyphens (-), and underscores (_). Labels can be
added or modiﬁed at any time. Each resource can have multiple labels, but each key must be
unique for a given object.

Type: String to string map

Required: No

See Also
For more information about using this API in one of the language-speciﬁc AWS SDKs, see the
following:

• AWS SDK for C++

• AWS SDK for Java V2
• AWS SDK for Ruby V3

EksMetadata API Version 2016-08-10 306

AWS Batch API Reference

EksPodProperties
The properties for the pod.

Contents
containers

The properties of the container that's used on the Amazon EKS pod.

Type: Array of EksContainer objects

Required: No
dnsPolicy

Valid values: Default | ClusterFirst | ClusterFirstWithHostNet

Type: String

Required: No
hostNetwork

Indicates if the pod uses the hosts' network IP address. The default value is true. Setting this to
false enables the Kubernetes pod networking model. Most AWS Batch workloads are egress-
only and don't require the overhead of IP allocation for each pod for incoming connections. For
more information, see Host namespaces and Pod networking in the Kubernetes documentation.

Type: Boolean

Required: No
imagePullSecrets

References a Kubernetes secret resource. It holds a list of secrets. These secrets help to gain
access to pull an images from a private registry.

ImagePullSecret$name is required when this object is used.

EksPodProperties API Version 2016-08-10 307

AWS Batch API Reference

Type: Array of ImagePullSecret objects

Required: No
initContainers

These containers run before application containers, always runs to completion, and must
complete successfully before the next container starts. These containers are registered with
the Amazon EKS Connector agent and persists the registration information in the Kubernetes
backend data store. For more information, see Init Containers in the Kubernetes documentation.

Note
This object is limited to 10 elements

Type: Array of EksContainer objects

Required: No
metadata

Metadata about the Kubernetes pod. For more information, see Understanding Kubernetes
Objects in the Kubernetes documentation.

Type: EksMetadata object

Required: No
serviceAccountName

The name of the service account that's used to run the pod. For more information, see
Kubernetes service accounts and Conﬁgure a Kubernetes service account to assume an IAM
role in the Amazon EKS User Guide and Conﬁgure service accounts for pods in the Kubernetes
documentation.

Type: String

Required: No
shareProcessNamespace

Indicates if the processes in a container are shared, or visible, to other containers in the same
pod. For more information, see Share Process Namespace between Containers in a Pod.

Contents API Version 2016-08-10 308

AWS Batch API Reference

Type: Boolean

Required: No
volumes

Speciﬁes the volumes for a job deﬁnition that uses Amazon EKS resources.

Type: Array of EksVolume objects

Required: No

See Also
For more information about using this API in one of the language-speciﬁc AWS SDKs, see the
following:

• AWS SDK for C++

• AWS SDK for Java V2
• AWS SDK for Ruby V3

Type: Array of EksContainerDetail objects

Required: No
dnsPolicy

The DNS policy for the pod. The default value is ClusterFirst. If the hostNetwork
parameter is not specified, the default is ClusterFirstWithHostNet. ClusterFirst
indicates that any DNS query that does not match the configured cluster domain suffix is
forwarded to the upstream nameserver inherited from the node. If no value was specified
for dnsPolicy in the RegisterJobDefinition API operation, then no value will be returned for
dnsPolicy by either of DescribeJobDefinitions or DescribeJobs API operations. The pod spec
setting will contain either ClusterFirst or ClusterFirstWithHostNet, depending on
the value of the hostNetwork parameter. For more information, see Pod's DNS policy in the
Kubernetes documentation.

Valid values: Default | ClusterFirst | ClusterFirstWithHostNet

Type: String

Required: No
hostNetwork

Type: Boolean

Required: No

EksPodPropertiesDetail API Version 2016-08-10 310

AWS Batch API Reference

imagePullSecrets

Displays the reference pointer to the Kubernetes secret resource. These secrets help to gain
access to pull an images from a private registry.

Type: Array of ImagePullSecret objects

Required: No
initContainers

The container registered with the Amazon EKS Connector agent and persists the registration
information in the Kubernetes backend data store.

Type: Array of EksContainerDetail objects

Required: No
metadata

Describes and uniquely identiﬁes Kubernetes resources. For example, the compute environment
that a pod runs in or the jobID for a job running in the pod. For more information, see
Understanding Kubernetes Objects in the Kubernetes documentation.

Type: EksMetadata object

Required: No
nodeName

The name of the node for this job.

Type: String

Required: No
podName

The name of the pod for this job.

Type: String

Required: No
serviceAccountName

The name of the service account that's used to run the pod. For more information, see
Kubernetes service accounts and Conﬁgure a Kubernetes service account to assume an IAM

Contents API Version 2016-08-10 311

AWS Batch API Reference

role in the Amazon EKS User Guide and Conﬁgure service accounts for pods in the Kubernetes
documentation.

Type: String

Required: No
shareProcessNamespace

Indicates if the processes in a container are shared, or visible, to other containers in the same
pod. For more information, see Share Process Namespace between Containers in a Pod.

Type: Boolean

Required: No
volumes

Speciﬁes the volumes for a job deﬁnition using Amazon EKS resources.

Type: Array of EksVolume objects

Required: No

See Also
For more information about using this API in one of the language-speciﬁc AWS SDKs, see the
following:

• AWS SDK for C++

• AWS SDK for Java V2
• AWS SDK for Ruby V3

Type: Array of EksContainerOverride objects

Required: No
initContainers

The overrides for the conatainers deﬁned in the Amazon EKS pod. These containers run before
application containers, always runs to completion, and must complete successfully before
the next container starts. These containers are registered with the Amazon EKS Connector
agent and persists the registration information in the Kubernetes backend data store. For more
information, see Init Containers in the Kubernetes documentation.

Note
This object is limited to 10 elements

Type: Array of EksContainerOverride objects

Required: No
metadata

Metadata about the overrides for the container that's used on the Amazon EKS pod.

Type: EksMetadata object

Required: No

See Also
For more information about using this API in one of the language-speciﬁc AWS SDKs, see the
following:

EksPodPropertiesOverride API Version 2016-08-10 313

AWS Batch API Reference

• AWS SDK for C++

• AWS SDK for Java V2
• AWS SDK for Ruby V3

The properties for the Kubernetes pod resources of a job.

Type: EksPodProperties object

Required: No

See Also
For more information about using this API in one of the language-speciﬁc AWS SDKs, see the
following:

• AWS SDK for C++

• AWS SDK for Java V2
• AWS SDK for Ruby V3

EksProperties API Version 2016-08-10 315

AWS Batch API Reference

EksPropertiesDetail
An object that contains the details for the Kubernetes resources of a job.

Contents
podProperties

The properties for the Kubernetes pod resources of a job.

Type: EksPodPropertiesDetail object

Required: No

See Also
For more information about using this API in one of the language-speciﬁc AWS SDKs, see the
following:

• AWS SDK for C++

• AWS SDK for Java V2
• AWS SDK for Ruby V3

EksPropertiesDetail API Version 2016-08-10 316

AWS Batch API Reference

EksPropertiesOverride
An object that contains overrides for the Kubernetes resources of a job.

Contents
podProperties

The overrides for the Kubernetes pod resources of a job.

Type: EksPodPropertiesOverride object

Required: No

See Also
For more information about using this API in one of the language-speciﬁc AWS SDKs, see the
following:

• AWS SDK for C++

• AWS SDK for Java V2
• AWS SDK for Ruby V3

EksPropertiesOverride API Version 2016-08-10 317

AWS Batch API Reference

EksSecret
Speciﬁes the conﬁguration of a Kubernetes secret volume. For more information, see secret in
the Kubernetes documentation.

Contents
secretName

The name of the secret. The name must be allowed as a DNS subdomain name. For more
information, see DNS subdomain names in the Kubernetes documentation.

Type: String

Required: Yes
optional

Speciﬁes whether the secret or the secret's keys must be deﬁned.

Type: Boolean

Required: No

See Also
For more information about using this API in one of the language-speciﬁc AWS SDKs, see the
following:

• AWS SDK for C++

• AWS SDK for Java V2
• AWS SDK for Ruby V3

EksSecret API Version 2016-08-10 318

AWS Batch API Reference

EksVolume
Speciﬁes an Amazon EKS volume for a job deﬁnition.

Contents
name

The name of the volume. The name must be allowed as a DNS subdomain name. For more
information, see DNS subdomain names in the Kubernetes documentation.

Type: String

Required: Yes
emptyDir

Speciﬁes the conﬁguration of a Kubernetes emptyDir volume. For more information, see
emptyDir in the Kubernetes documentation.

Type: EksEmptyDir object

Required: No

hostPath

Speciﬁes the conﬁguration of a Kubernetes hostPath volume. For more information, see
hostPath in the Kubernetes documentation.

Type: EksHostPath object

Required: No

secret

Speciﬁes the conﬁguration of a Kubernetes secret volume. For more information, see secret in
the Kubernetes documentation.

Type: EksSecret object

Required: No

EksVolume API Version 2016-08-10 319

AWS Batch API Reference

See Also
For more information about using this API in one of the language-speciﬁc AWS SDKs, see the
following:

• AWS SDK for C++

• AWS SDK for Java V2
• AWS SDK for Ruby V3

• AWS SDK for C++

• AWS SDK for Java V2
• AWS SDK for Ruby V3

EphemeralStorage API Version 2016-08-10 321

AWS Batch API Reference

EvaluateOnExit
Speciﬁes an array of up to 5 conditions to be met, and an action to take (RETRY or EXIT) if all
conditions are met. If none of the EvaluateOnExit conditions in a RetryStrategy match, then
the job is retried.

Contents
action

Speciﬁes the action to take if all of the speciﬁed conditions (onStatusReason, onReason, and
onExitCode) are met. The values aren't case sensitive.

Type: String

Valid Values: RETRY | EXIT

Required: Yes
onExitCode

Contains a glob pattern to match against the decimal representation of the ExitCode returned
for a job. The pattern can be up to 512 characters long. It can contain only numbers, and can
end with an asterisk (*) so that only the start of the string needs to be an exact match.

The string can contain up to 512 characters.

Type: String

Required: No
onReason

Contains a glob pattern to match against the Reason returned for a job. The pattern can
contain up to 512 characters. It can contain letters, numbers, periods (.), colons (:), and white
space (including spaces and tabs). It can optionally end with an asterisk (*) so that only the start
of the string needs to be an exact match.

Type: String

Required: No

EvaluateOnExit API Version 2016-08-10 322

AWS Batch API Reference

onStatusReason

Contains a glob pattern to match against the StatusReason returned for a job. The pattern
can contain up to 512 characters. It can contain letters, numbers, periods (.), colons (:), and
white spaces (including spaces or tabs). It can optionally end with an asterisk (*) so that only the
start of the string needs to be an exact match.

Type: String

Required: No

See Also
For more information about using this API in one of the language-speciﬁc AWS SDKs, see the
following:

• AWS SDK for C++

• AWS SDK for Java V2
• AWS SDK for Ruby V3

The reserved ratio is (computeReservation/100)^ActiveFairShares where

ActiveFairShares is the number of active fair share identiﬁers.

For example, a computeReservation value of 50 indicates that AWS Batch reserves 50%
of the maximum available vCPU if there's only one fair share identifier. It reserves 25% if
there are two fair share identifiers. It reserves 12.5% if there are three fair share identifiers.
A computeReservation value of 25 indicates that AWS Batch should reserve 25% of the
maximum available vCPU if there's only one fair share identifier, 6.25% if there are two fair
share identifiers, and 1.56% if there are three fair share identifiers.

The minimum value is 0 and the maximum value is 99.

Type: Integer

Required: No
shareDecaySeconds

The amount of time (in seconds) to use to calculate a fair share percentage for each fair share
identiﬁer in use. A value of zero (0) indicates that only current usage is measured. The decay
allows for more recently run jobs to have more weight than jobs that ran earlier. The maximum
supported value is 604800 (1 week).

Type: Integer

Required: No
shareDistribution

An array of SharedIdentifier objects that contain the weights for the fair share identiﬁers
for the fair share policy. Fair share identiﬁers that aren't included have a default weight of 1.0.

FairsharePolicy API Version 2016-08-10 324

AWS Batch API Reference

Type: Array of ShareAttributes objects

Required: No

See Also
For more information about using this API in one of the language-speciﬁc AWS SDKs, see the
following:

• AWS SDK for C++

• AWS SDK for Java V2
• AWS SDK for Ruby V3

• AWS SDK for C++

• AWS SDK for Java V2
• AWS SDK for Ruby V3

FargatePlatformConﬁguration API Version 2016-08-10 326

AWS Batch API Reference

FrontOfQueueDetail
Contains a list of the ﬁrst 100 RUNNABLE jobs associated to a single job queue.

Contents
jobs

The Amazon Resource Names (ARNs) of the first 100 RUNNABLE jobs in a named job queue. For
first-in-first-out (FIFO) job queues, jobs are ordered based on their submission time. For fair
share scheduling (FSS) job queues, jobs are ordered based on their job priority and share usage.

Type: Array of FrontOfQueueJobSummary objects

Required: No
lastUpdatedAt

The Unix timestamp (in milliseconds) for when each of the ﬁrst 100 RUNNABLE jobs were last
updated.

Type: Long

Required: No

See Also
For more information about using this API in one of the language-speciﬁc AWS SDKs, see the
following:

• AWS SDK for C++

• AWS SDK for Java V2
• AWS SDK for Ruby V3

FrontOfQueueDetail API Version 2016-08-10 327

AWS Batch API Reference

FrontOfQueueJobSummary
An object that represents summary details for the ﬁrst 100 RUNNABLE jobs in a job queue.

Contents
earliestTimeAtPosition

The Unix timestamp (in milliseconds) for when the job transitioned to its current position in the
job queue.

Type: Long

Required: No
jobArn

The ARN for a job in a named job queue.

Type: String

Required: No

See Also
For more information about using this API in one of the language-speciﬁc AWS SDKs, see the
following:

• AWS SDK for C++

• AWS SDK for Java V2
• AWS SDK for Ruby V3

FrontOfQueueJobSummary API Version 2016-08-10 328

AWS Batch API Reference

Host
Determine whether your data volume persists on the host container instance and where it's stored.
If this parameter is empty, then the Docker daemon assigns a host path for your data volume.
However, the data isn't guaranteed to persist after the containers that are associated with it stop
running.

Contents
sourcePath

The path on the host container instance that's presented to the container. If this parameter is
empty, then the Docker daemon has assigned a host path for you. If this parameter contains
a ﬁle location, then the data volume persists at the speciﬁed location on the host container
instance until you delete it manually. If the source path location doesn't exist on the host
container instance, the Docker daemon creates it. If the location does exist, the contents of the
source path folder are exported.

Note
This parameter isn't applicable to jobs that run on Fargate resources. Don't provide this
for these jobs.

Type: String

Required: No

See Also
For more information about using this API in one of the language-speciﬁc AWS SDKs, see the
following:

• AWS SDK for C++

• AWS SDK for Java V2
• AWS SDK for Ruby V3

Host API Version 2016-08-10 329

AWS Batch API Reference

ImagePullSecret
References a Kubernetes secret resource. This name of the secret must start and end with an
alphanumeric character, is required to be lowercase, can include periods (.) and hyphens (-), and
can't contain more than 253 characters.

Contents
name

Provides a unique identiﬁer for the ImagePullSecret. This object is required when
EksPodProperties$imagePullSecrets is used.

Type: String

Required: Yes

See Also
For more information about using this API in one of the language-speciﬁc AWS SDKs, see the
following:

• AWS SDK for C++

• AWS SDK for Java V2
• AWS SDK for Ruby V3

ImagePullSecret API Version 2016-08-10 330

AWS Batch API Reference

JobDeﬁnition
An object that represents an AWS Batch job deﬁnition.

Contents
jobDeﬁnitionArn

The Amazon Resource Name (ARN) for the job deﬁnition.

Type: String

Required: Yes
jobDeﬁnitionName

The name of the job deﬁnition.

Type: String

Required: Yes
revision

The revision of the job deﬁnition.

Type: Integer

Required: Yes
type

The type of job deﬁnition. It's either container or multinode. If the job is run on Fargate
resources, then multinode isn't supported. For more information about multi-node parallel
jobs, see Creating a multi-node parallel job deﬁnition in the AWS Batch User Guide.

Type: String

Required: Yes
containerOrchestrationType

The orchestration type of the compute environment. The valid values are ECS (default) or EKS.

Type: String

JobDeﬁnition API Version 2016-08-10 331

AWS Batch API Reference

Valid Values: ECS | EKS

Required: No
containerProperties

An object with properties speciﬁc to Amazon ECS-based jobs. When containerProperties is

used in the job deﬁnition, it can't be used in addition to eksProperties, ecsProperties, or
nodeProperties.

Type: ContainerProperties object

Required: No
ecsProperties

An object that contains the properties for the Amazon ECS resources of a job.When
ecsProperties is used in the job deﬁnition, it can't be used in addition to
containerProperties, eksProperties, or nodeProperties.

Type: EcsProperties object

Required: No
eksProperties

An object with properties that are speciﬁc to Amazon EKS-based jobs. When eksProperties
is used in the job deﬁnition, it can't be used in addition to containerProperties,
ecsProperties, or nodeProperties.

Type: EksProperties object

Required: No
nodeProperties

An object with properties that are speciﬁc to multi-node parallel jobs. When nodeProperties
is used in the job deﬁnition, it can't be used in addition to containerProperties,
ecsProperties, or eksProperties.

Note
If the job runs on Fargate resources, don't specify nodeProperties. Use
containerProperties instead.

Contents API Version 2016-08-10 332

AWS Batch API Reference

Type: NodeProperties object

Required: No
parameters

Default parameters or parameter substitution placeholders that are set in the job definition.
Parameters are specified as a key-value pair mapping. Parameters in a SubmitJob request
override any corresponding parameter defaults from the job definition. For more information
about specifying parameters, see Job definition parameters in the AWS Batch User Guide.

Type: String to string map

Required: No
platformCapabilities

The platform capabilities required by the job deﬁnition. If no value is speciﬁed, it defaults to
EC2. Jobs run on Fargate resources specify FARGATE.

Type: Array of strings

Valid Values: EC2 | FARGATE

Required: No
propagateTags

Specifies whether to propagate the tags from the job or job definition to the corresponding
Amazon ECS task. If no value is specified, the tags aren't propagated. Tags can only be
propagated to the tasks when the tasks are created. For tags with the same name, job tags are
given priority over job definitions tags. If the total number of combined tags from the job and
job definition is over 50, the job is moved to the FAILED state.

Type: Boolean

Required: No
retryStrategy

The retry strategy to use for failed jobs that are submitted with this job deﬁnition.

Type: RetryStrategy object

Required: No

Contents API Version 2016-08-10 333

AWS Batch API Reference

schedulingPriority

The scheduling priority of the job deﬁnition. This only aﬀects jobs in job queues with a fair
share policy. Jobs with a higher scheduling priority are scheduled before jobs with a lower
scheduling priority.

Type: Integer

Required: No
status

The status of the job deﬁnition.

Type: String

Required: No
tags

The tags that are applied to the job deﬁnition.

Type: String to string map

Map Entries: Maximum number of 50 items.

Key Length Constraints: Minimum length of 1. Maximum length of 128.

Value Length Constraints: Maximum length of 256.

Required: No
timeout

The timeout time for jobs that are submitted with this job deﬁnition. After the amount of time
you specify passes, AWS Batch terminates your jobs if they aren't ﬁnished.

Type: JobTimeout object

Required: No

See Also
For more information about using this API in one of the language-speciﬁc AWS SDKs, see the
following:

• AWS SDK for C++

• AWS SDK for Java V2
• AWS SDK for Ruby V3

The type of the job dependency.

Type: String

Valid Values: N_TO_N | SEQUENTIAL

Required: No

See Also
For more information about using this API in one of the language-speciﬁc AWS SDKs, see the
following:

• AWS SDK for C++

• AWS SDK for Java V2
• AWS SDK for Ruby V3

JobDependency API Version 2016-08-10 336

AWS Batch API Reference

JobDetail
An object that represents an AWS Batch job.

Contents
jobDeﬁnition

The Amazon Resource Name (ARN) of the job deﬁnition that this job uses.

Type: String

Required: Yes
jobId

The job ID.

Type: String

Required: Yes
jobName

The job name.

Type: String

Required: Yes
jobQueue

The Amazon Resource Name (ARN) of the job queue that the job is associated with.

Type: String

Required: Yes
startedAt

The Unix timestamp (in milliseconds) for when the job was started. More speciﬁcally, it's when
the job transitioned from the STARTING state to the RUNNING state.

Type: Long

Required: Yes

JobDetail API Version 2016-08-10 337

AWS Batch API Reference

status

The current status for the job.

Note
If your jobs don't progress to STARTING, see Jobs stuck in RUNNABLE status in the
troubleshooting section of the AWS Batch User Guide.

Type: String

Valid Values: SUBMITTED | PENDING | RUNNABLE | STARTING | RUNNING |

SUCCEEDED | FAILED

Required: Yes
arrayProperties

The array properties of the job, if it's an array job.

Type: ArrayPropertiesDetail object

Required: No
attempts

A list of job attempts that are associated with this job.

Type: Array of AttemptDetail objects

Required: No
container

An object that represents the details for the container that's associated with the job. If the
details are for a multiple-container job, this object will be empty.

Type: ContainerDetail object

Required: No
createdAt

The Unix timestamp (in milliseconds) for when the job was created. For non-array jobs and
parent array jobs, this is when the job entered the SUBMITTED state. This is speciﬁcally at the

Contents API Version 2016-08-10 338

AWS Batch API Reference

time SubmitJob was called. For array child jobs, this is when the child job was spawned by its
parent and entered the PENDING state.

Type: Long

Required: No
dependsOn

A list of job IDs that this job depends on.

Type: Array of JobDependency objects

Required: No
ecsProperties

An object with properties that are speciﬁc to Amazon ECS-based jobs.

Type: EcsPropertiesDetail object

Required: No
eksAttempts

A list of job attempts that are associated with this job.

Type: Array of EksAttemptDetail objects

Required: No
eksProperties

An object with various properties that are speciﬁc to Amazon EKS based jobs.

Type: EksPropertiesDetail object

Required: No
isCancelled

Indicates whether the job is canceled.

Type: Boolean

Required: No

Contents API Version 2016-08-10 339

AWS Batch API Reference

isTerminated

Indicates whether the job is terminated.

Type: Boolean

Required: No
jobArn

The Amazon Resource Name (ARN) of the job.

Type: String

Required: No
nodeDetails

An object that represents the details of a node that's associated with a multi-node parallel job.

Type: NodeDetails object

Required: No
nodeProperties

An object that represents the node properties of a multi-node parallel job.

Note
This isn't applicable to jobs that are running on Fargate resources.

Type: NodeProperties object

Required: No
parameters

Additional parameters that are passed to the job that replace parameter substitution
placeholders or override any corresponding parameter defaults from the job deﬁnition.

Type: String to string map

Required: No

Contents API Version 2016-08-10 340

AWS Batch API Reference

platformCapabilities

The platform capabilities required by the job deﬁnition. If no value is speciﬁed, it defaults to
EC2. Jobs run on Fargate resources specify FARGATE.

Type: Array of strings

Valid Values: EC2 | FARGATE

Required: No
propagateTags

Specifies whether to propagate the tags from the job or job definition to the corresponding
Amazon ECS task. If no value is specified, the tags aren't propagated. Tags can only be
propagated to the tasks when the tasks are created. For tags with the same name, job tags are
given priority over job definitions tags. If the total number of combined tags from the job and
job definition is over 50, the job is moved to the FAILED state.

Type: Boolean

Required: No
retryStrategy

The retry strategy to use for this job if an attempt fails.

Type: RetryStrategy object

Required: No
schedulingPriority

The scheduling policy of the job deﬁnition. This only aﬀects jobs in job queues with a fair share
policy. Jobs with a higher scheduling priority are scheduled before jobs with a lower scheduling
priority.

Type: Integer

Required: No
shareIdentiﬁer

The share identiﬁer for the job.

Contents API Version 2016-08-10 341

AWS Batch API Reference

Type: String

Required: No
statusReason

A short, human-readable string to provide more details for the current status of the job.
• CAPACITY:INSUFFICIENT_INSTANCE_CAPACITY - All compute environments have
insuﬃcient capacity to service the job.
• MISCONFIGURATION:COMPUTE_ENVIRONMENT_MAX_RESOURCE - All compute environments
have a maxVcpu setting that is smaller than the job requirements.
• MISCONFIGURATION:JOB_RESOURCE_REQUIREMENT - All compute environments have no
connected instances that meet the job requirements.
• MISCONFIGURATION:SERVICE_ROLE_PERMISSIONS - All compute environments have
problems with the service role permissions.

Type: String

Required: No
stoppedAt

The Unix timestamp (in milliseconds) for when the job was stopped. More speciﬁcally, it's
when the job transitioned from the RUNNING state to a terminal state, such as SUCCEEDED or
FAILED.

Type: Long

Required: No
tags

The tags that are applied to the job.

Type: String to string map

Map Entries: Maximum number of 50 items.

Key Length Constraints: Minimum length of 1. Maximum length of 128.

Value Length Constraints: Maximum length of 256.

Required: No

Contents API Version 2016-08-10 342

AWS Batch API Reference

timeout

The timeout conﬁguration for the job.

Type: JobTimeout object

Required: No

See Also
For more information about using this API in one of the language-speciﬁc AWS SDKs, see the
following:

• AWS SDK for C++

• AWS SDK for Java V2
• AWS SDK for Ruby V3

Type: Array of ComputeEnvironmentOrder objects

Required: Yes
jobQueueArn

The Amazon Resource Name (ARN) of the job queue.

Type: String

Required: Yes
jobQueueName

The job queue name.

Type: String

Required: Yes
priority

The priority of the job queue. Job queues with a higher priority (or a higher integer value
for the priority parameter) are evaluated ﬁrst when associated with the same compute
environment. Priority is determined in descending order. For example, a job queue with a
priority value of 10 is given scheduling preference over a job queue with a priority value of
1. All of the compute environments must be either Amazon EC2 (EC2 or SPOT) or Fargate
(FARGATE or FARGATE_SPOT). Amazon EC2 and Fargate compute environments can't be mixed.

Type: Integer

JobQueueDetail API Version 2016-08-10 344

AWS Batch API Reference

Required: Yes
state

Describes the ability of the queue to accept new jobs. If the job queue state is ENABLED, it can
accept jobs. If the job queue state is DISABLED, new jobs can't be added to the queue, but jobs
already in the queue can ﬁnish.

Type: String

Valid Values: ENABLED | DISABLED

Required: Yes
jobStateTimeLimitActions

Type: Array of JobStateTimeLimitAction objects

Required: No
schedulingPolicyArn

Type: String

Required: No
status

The status of the job queue (for example, CREATING or VALID).

Type: String

Valid Values: CREATING | UPDATING | DELETING | DELETED | VALID | INVALID

Required: No

Contents API Version 2016-08-10 345

AWS Batch API Reference

statusReason

A short, human-readable string to provide additional details for the current status of the job
queue.

Type: String

Required: No
tags

The tags that are applied to the job queue. For more information, see Tagging your AWS Batch
resources in AWS Batch User Guide.

Type: String to string map

Map Entries: Maximum number of 50 items.

Key Length Constraints: Minimum length of 1. Maximum length of 128.

Value Length Constraints: Maximum length of 256.

Required: No

See Also
For more information about using this API in one of the language-speciﬁc AWS SDKs, see the
following:

• AWS SDK for C++

• AWS SDK for Java V2
• AWS SDK for Ruby V3

Valid Values: CANCEL

Required: Yes
maxTimeSeconds

The approximate amount of time, in seconds, that must pass with the job in the speciﬁed state
before the action is taken. The minimum value is 600 (10 minutes) and the maximum value is
86,400 (24 hours).

Type: Integer

Required: Yes
reason

The reason to log for the action being taken.

Type: String

Required: Yes
state

The state of the job needed to trigger the action. The only supported value is RUNNABLE.

Type: String

Valid Values: RUNNABLE

JobStateTimeLimitAction API Version 2016-08-10 347

AWS Batch API Reference

Required: Yes

See Also
For more information about using this API in one of the language-speciﬁc AWS SDKs, see the
following:

• AWS SDK for C++

• AWS SDK for Java V2
• AWS SDK for Ruby V3

The job ID.

Type: String

Required: Yes
jobName

The job name.

Type: String

Required: Yes
arrayProperties

The array properties of the job, if it's an array job.

Type: ArrayPropertiesSummary object

Required: No
container

An object that represents the details of the container that's associated with the job.

Type: ContainerSummary object

Required: No
createdAt

The Unix timestamp (in milliseconds) for when the job was created. For non-array jobs and
parent array jobs, this is when the job entered the SUBMITTED state (at the time SubmitJob was
called). For array child jobs, this is when the child job was spawned by its parent and entered
the PENDING state.

JobSummary API Version 2016-08-10 349

AWS Batch API Reference

Type: Long

Required: No
jobArn

The Amazon Resource Name (ARN) of the job.

Type: String

Required: No
jobDeﬁnition

The Amazon Resource Name (ARN) of the job deﬁnition.

Type: String

Required: No
nodeProperties

The node properties for a single node in a job summary list.

Note
This isn't applicable to jobs that are running on Fargate resources.

Type: NodePropertiesSummary object

Required: No
startedAt

The Unix timestamp for when the job was started. More speciﬁcally, it's when the job
transitioned from the STARTING state to the RUNNING state.

Type: Long

Required: No
status

The current status for the job.

Contents API Version 2016-08-10 350

AWS Batch API Reference

Type: String

Valid Values: SUBMITTED | PENDING | RUNNABLE | STARTING | RUNNING |

SUCCEEDED | FAILED

Required: No
statusReason

A short, human-readable string to provide more details for the current status of the job.

Type: String

Required: No
stoppedAt

The Unix timestamp for when the job was stopped. More speciﬁcally, it's when the job
transitioned from the RUNNING state to a terminal state, such as SUCCEEDED or FAILED.

Type: Long

Required: No

See Also
For more information about using this API in one of the language-speciﬁc AWS SDKs, see the
following:

• AWS SDK for C++

• AWS SDK for Java V2
• AWS SDK for Ruby V3

• AWS SDK for C++

• AWS SDK for Java V2
• AWS SDK for Ruby V3

JobTimeout API Version 2016-08-10 352

AWS Batch API Reference

KeyValuePair
A key-value pair object.

Contents
name

The name of the key-value pair. For environment variables, this is the name of the environment
variable.

Type: String

Required: No
value

The value of the key-value pair. For environment variables, this is the value of the environment
variable.

Type: String

Required: No

See Also
For more information about using this API in one of the language-speciﬁc AWS SDKs, see the
following:

• AWS SDK for C++

• AWS SDK for Java V2
• AWS SDK for Ruby V3

KeyValuePair API Version 2016-08-10 353

AWS Batch API Reference

KeyValuesPair
A ﬁlter name and value pair that's used to return a more speciﬁc list of results from a ListJobs
API operation.

The ﬁlters supported are documented in the ListJobs API operation.

Contents
name

The name of the ﬁlter. Filter names are case sensitive.

Type: String

Required: No
values

The ﬁlter values.

Type: Array of strings

Required: No

See Also
For more information about using this API in one of the language-speciﬁc AWS SDKs, see the
following:

• AWS SDK for C++

• AWS SDK for Java V2
• AWS SDK for Ruby V3

KeyValuesPair API Version 2016-08-10 354

AWS Batch API Reference

LaunchTemplateSpeciﬁcation
An object that represents a launch template that's associated with a compute resource. You must
specify either the launch template ID or launch template name in the request, but not both.

If security groups are speciﬁed using both the securityGroupIds parameter of

CreateComputeEnvironment and the launch template, the values in the securityGroupIds
parameter of CreateComputeEnvironment will be used.

Note
This object isn't applicable to jobs that are running on Fargate resources.

Contents
launchTemplateId

The ID of the launch template.

Type: String

Required: No
launchTemplateName

The name of the launch template.

Type: String

Required: No
version

The version number of the launch template, $Latest, or $Default.

If the value is $Latest, the latest version of the launch template is used. If the value is
$Default, the default version of the launch template is used.

Important
If the AMI ID that's used in a compute environment is from the launch template, the
AMI isn't changed when the compute environment is updated. It's only changed if the

LaunchTemplateSpeciﬁcation API Version 2016-08-10 355

AWS Batch API Reference

updateToLatestImageVersion parameter for the compute environment is set to

true. During an infrastructure update, if either $Latest or $Default is specified, AWS
Batch re-evaluates the launch template version, and it might use a different version
of the launch template. This is the case even if the launch template isn't specified in
the update. When updating a compute environment, changing the launch template
requires an infrastructure update of the compute environment. For more information,
see Updating compute environments in the AWS Batch User Guide.

Default: $Default.

Type: String

Required: No

See Also
For more information about using this API in one of the language-speciﬁc AWS SDKs, see the
following:

• AWS SDK for C++

• AWS SDK for Java V2
• AWS SDK for Ruby V3

Type: Array of Device objects

Required: No
initProcessEnabled

If true, run an init process inside the container that forwards signals and reaps processes.
This parameter maps to the --init option to docker run. This parameter requires version 1.25
of the Docker Remote API or greater on your container instance. To check the Docker Remote
API version on your container instance, log in to your container instance and run the following
command: sudo docker version | grep "Server API version"

Type: Boolean

Required: No
maxSwap

The total amount of swap memory (in MiB) a container can use. This parameter is translated to
the --memory-swap option to docker run where the value is the sum of the container memory
plus the maxSwap value. For more information, see --memory-swap details in the Docker
documentation.

If a maxSwap value of 0 is speciﬁed, the container doesn't use swap. Accepted values are 0 or
any positive integer. If the maxSwap parameter is omitted, the container doesn't use the swap

LinuxParameters API Version 2016-08-10 357

AWS Batch API Reference

conﬁguration for the container instance that it's running on. A maxSwap value must be set for
the swappiness parameter to be used.

Note
This parameter isn't applicable to jobs that are running on Fargate resources. Don't
provide it for these jobs.

Type: Integer

Required: No
sharedMemorySize

The value for the size (in MiB) of the /dev/shm volume. This parameter maps to the --shm-
size option to docker run.

Note
This parameter isn't applicable to jobs that are running on Fargate resources. Don't
provide it for these jobs.

Type: Integer

Required: No
swappiness

You can use this parameter to tune a container's memory swappiness behavior. A swappiness
value of 0 causes swapping to not occur unless absolutely necessary. A swappiness value of
100 causes pages to be swapped aggressively. Valid values are whole numbers between 0 and
100. If the swappiness parameter isn't speciﬁed, a default value of 60 is used. If a value isn't
speciﬁed for maxSwap, then this parameter is ignored. If maxSwap is set to 0, the container
doesn't use swap. This parameter maps to the --memory-swappiness option to docker run.

Consider the following when you use a per-container swap conﬁguration.

• Swap space must be enabled and allocated on the container instance for the containers to
use.

Contents API Version 2016-08-10 358

AWS Batch API Reference

Note
By default, the Amazon ECS optimized AMIs don't have swap enabled. You must
enable swap on the instance to use this feature. For more information, see Instance
store swap volumes in the Amazon EC2 User Guide for Linux Instances or How do I
allocate memory to work as swap space in an Amazon EC2 instance by using a swap
ﬁle?

• The swap space parameters are only supported for job deﬁnitions using EC2 resources.

• If the maxSwap and swappiness parameters are omitted from a job deﬁnition, each
container has a default swappiness value of 60. Moreover, the total swap usage is limited to
two times the memory reservation of the container.

Note
This parameter isn't applicable to jobs that are running on Fargate resources. Don't
provide it for these jobs.

Type: Integer

Required: No

tmpfs

The container path, mount options, and size (in MiB) of the tmpfs mount. This parameter maps
to the --tmpfs option to docker run.

Note
This parameter isn't applicable to jobs that are running on Fargate resources. Don't
provide this parameter for this resource type.

Type: Array of Tmpfs objects

Required: No

Contents API Version 2016-08-10 359

AWS Batch API Reference

See Also
For more information about using this API in one of the language-speciﬁc AWS SDKs, see the
following:

• AWS SDK for C++

• AWS SDK for Java V2
• AWS SDK for Ruby V3

LogConﬁguration API Version 2016-08-10 361

AWS Batch API Reference

json-ﬁle

Speciﬁes the JSON ﬁle logging driver. For more information including usage and options, see
JSON File logging driver in the Docker documentation.
splunk

Speciﬁes the Splunk logging driver. For more information including usage and options, see
Splunk logging driver in the Docker documentation.
syslog

Speciﬁes the syslog logging driver. For more information including usage and options, see
Syslog logging driver in the Docker documentation.

Note
If you have a custom driver that's not listed earlier that you want to work with the
Amazon ECS container agent, you can fork the Amazon ECS container agent project
that's available on GitHub and customize it to work with that driver. We encourage you
to submit pull requests for changes that you want to have included. However, Amazon
Web Services doesn't currently support running modiﬁed copies of this software.

Type: String

Valid Values: json-file | syslog | journald | gelf | fluentd | awslogs |

splunk

Required: Yes
options

The conﬁguration options to send to the log driver. This parameter requires version 1.19 of
the Docker Remote API or greater on your container instance. To check the Docker Remote
API version on your container instance, log in to your container instance and run the following
command: sudo docker version | grep "Server API version"

Contents API Version 2016-08-10 362

AWS Batch API Reference

Type: String to string map

Required: No
secretOptions

The secrets to pass to the log conﬁguration. For more information, see Specifying sensitive data
in the AWS Batch User Guide.

Type: Array of Secret objects

Required: No

See Also
For more information about using this API in one of the language-speciﬁc AWS SDKs, see the
following:

• AWS SDK for C++

• AWS SDK for Java V2
• AWS SDK for Ruby V3

The path on the container where the host volume is mounted.

Type: String

Required: No
readOnly

If this value is true, the container has read-only access to the volume. Otherwise, the container
can write to the volume. The default value is false.

Type: Boolean

Required: No
sourceVolume

The name of the volume to mount.

Type: String

Required: No

See Also

For more information about using this API in one of the language-speciﬁc AWS SDKs, see the
following:

• AWS SDK for C++

• AWS SDK for Java V2
• AWS SDK for Ruby V3

MountPoint API Version 2016-08-10 364

AWS Batch API Reference

Valid Values: ENABLED | DISABLED

Required: No

See Also
For more information about using this API in one of the language-speciﬁc AWS SDKs, see the
following:

• AWS SDK for C++

• AWS SDK for Java V2
• AWS SDK for Ruby V3

NetworkConﬁguration API Version 2016-08-10 366

AWS Batch API Reference

NetworkInterface
An object that represents the elastic network interface for a multi-node parallel job node.

Contents
attachmentId

The attachment ID for the network interface.

Type: String

Required: No
ipv6Address

The private IPv6 address for the network interface.

Type: String

Required: No
privateIpv4Address

The private IPv4 address for the network interface.

Type: String

Required: No

See Also
For more information about using this API in one of the language-speciﬁc AWS SDKs, see the
following:

• AWS SDK for C++

• AWS SDK for Java V2
• AWS SDK for Ruby V3

NetworkInterface API Version 2016-08-10 367

AWS Batch API Reference

NodeDetails
An object that represents the details of a multi-node parallel job node.

Contents
isMainNode

Speciﬁes whether the current node is the main node for a multi-node parallel job.

Type: Boolean

Required: No
nodeIndex

The node index for the node. Node index numbering starts at zero. This index is also available
on the node with the AWS_BATCH_JOB_NODE_INDEX environment variable.

Type: Integer

Required: No

See Also
For more information about using this API in one of the language-speciﬁc AWS SDKs, see the
following:

• AWS SDK for C++

• AWS SDK for Java V2
• AWS SDK for Ruby V3

NodeDetails API Version 2016-08-10 368

AWS Batch API Reference

NodeOverrides
An object that represents any node overrides to a job deﬁnition that's used in a SubmitJob API
operation.

Note
This parameter isn't applicable to jobs that are running on Fargate resources. Don't provide
it for these jobs. Rather, use containerOverrides instead.

Contents
nodePropertyOverrides

The node property overrides for the job.

Type: Array of NodePropertyOverride objects

Required: No

numNodes

The number of nodes to use with a multi-node parallel job. This value overrides the number of
nodes that are speciﬁed in the job deﬁnition. To use this override, you must meet the following
conditions:

• There must be at least one node range in your job deﬁnition that has an open upper
boundary, such as : or n:.

• The lower boundary of the node range that's specified in the job definition must be fewer
than the number of nodes specified in the override.

• The main node index that's specified in the job definition must be fewer than the number of
nodes specified in the override.

Type: Integer

Required: No

NodeOverrides API Version 2016-08-10 369

AWS Batch API Reference

See Also
For more information about using this API in one of the language-speciﬁc AWS SDKs, see the
following:

• AWS SDK for C++

• AWS SDK for Java V2
• AWS SDK for Ruby V3

Type: Array of NodeRangeProperty objects

Required: Yes
numNodes

The number of nodes that are associated with a multi-node parallel job.

Type: Integer

Required: Yes

See Also
For more information about using this API in one of the language-speciﬁc AWS SDKs, see the
following:

• AWS SDK for C++

NodeProperties API Version 2016-08-10 371

AWS Batch API Reference

• AWS SDK for Java V2

• AWS SDK for Ruby V3

• AWS SDK for C++

• AWS SDK for Java V2
• AWS SDK for Ruby V3

NodePropertiesSummary API Version 2016-08-10 373

AWS Batch API Reference

NodePropertyOverride
The object that represents any node overrides to a job deﬁnition that's used in a SubmitJob API
operation.

Contents
targetNodes

The range of nodes, using node index values, that's used to override. A range of 0:3 indicates
nodes with index values of 0 through 3. If the starting range value is omitted (:n), then 0 is
used to start the range. If the ending range value is omitted (n:), then the highest possible
node index is used to end the range.

Type: String

Required: Yes
containerOverrides

The overrides that are sent to a node range.

Type: ContainerOverrides object

Required: No
ecsPropertiesOverride

An object that contains the properties that you want to replace for the existing Amazon ECS
resources of a job.

Type: EcsPropertiesOverride object

Required: No
eksPropertiesOverride

An object that contains the properties that you want to replace for the existing Amazon EKS
resources of a job.

Type: EksPropertiesOverride object

Required: No

NodePropertyOverride API Version 2016-08-10 374

AWS Batch API Reference

instanceTypes

An object that contains the instance types that you want to replace for the existing resources of
a job.

Type: Array of strings

Required: No

See Also
For more information about using this API in one of the language-speciﬁc AWS SDKs, see the
following:

• AWS SDK for C++

• AWS SDK for Java V2
• AWS SDK for Ruby V3

The container details for the node range.

Type: ContainerProperties object

Required: No
ecsProperties

This is an object that represents the properties of the node range for a multi-node parallel job.

Type: EcsProperties object

Required: No
eksProperties

This is an object that represents the properties of the node range for a multi-node parallel job.

Type: EksProperties object

Required: No

NodeRangeProperty API Version 2016-08-10 376

AWS Batch API Reference

instanceTypes

The instance types of the underlying host infrastructure of a multi-node parallel job.

Note
This parameter isn't applicable to jobs that are running on Fargate resources.
In addition, this list object is currently limited to one element.

Type: Array of strings

Required: No

See Also
For more information about using this API in one of the language-speciﬁc AWS SDKs, see the
following:

• AWS SDK for C++

• AWS SDK for Java V2
• AWS SDK for Ruby V3

• AWS SDK for C++

• AWS SDK for Java V2
• AWS SDK for Ruby V3

RepositoryCredentials API Version 2016-08-10 378

AWS Batch API Reference

ResourceRequirement
The type and amount of a resource to assign to a container. The supported resources include GPU,
MEMORY, and VCPU.

Contents
type

The type of resource to assign to a container. The supported resources include GPU, MEMORY,
and VCPU.

Type: String

Valid Values: GPU | VCPU | MEMORY

Required: Yes
value

The quantity of the speciﬁed resource to reserve for the container. The values vary based on the
type speciﬁed.
type="GPU"

The number of physical GPUs to reserve for the container. Make sure that the number of
GPUs reserved for all containers in a job doesn't exceed the number of available GPUs on the
compute resource that the job is launched on.

Note
GPUs aren't available for jobs that are running on Fargate resources.

type="MEMORY"

The memory hard limit (in MiB) present to the container. This parameter is supported
for jobs that are running on Amazon EC2 resources. If your container attempts to exceed
the memory speciﬁed, the container is terminated. This parameter maps to Memory in
the Create a container section of the Docker Remote API and the --memory option to
docker run. You must specify at least 4 MiB of memory for a job. This is required but can be

ResourceRequirement API Version 2016-08-10 379

AWS Batch API Reference

speciﬁed in several places for multi-node parallel (MNP) jobs. It must be speciﬁed for each
node at least once. This parameter maps to Memory in the Create a container section of the
Docker Remote API and the --memory option to docker run.

Note
If you're trying to maximize your resource utilization by providing your jobs as much
memory as possible for a particular instance type, see Memory management in the
AWS Batch User Guide.

For jobs that are running on Fargate resources, then value is the hard limit (in MiB), and
must match one of the supported values and the VCPU values must be one of the values
supported for that memory value.
value = 512

VCPU = 0.25
value = 1024

VCPU = 0.25 or 0.5

value = 2048

VCPU = 0.25, 0.5, or 1

value = 3072

VCPU = 0.5, or 1
value = 4096

VCPU = 0.5, 1, or 2
value = 5120, 6144, or 7168

VCPU = 1 or 2
value = 8192

VCPU = 1, 2, or 4
value = 9216, 10240, 11264, 12288, 13312, 14336, or 15360

VCPU = 2 or 4

Contents API Version 2016-08-10 380

AWS Batch API Reference

value = 16384

VCPU = 2, 4, or 8
value = 17408, 18432, 19456, 21504, 22528, 23552, 25600, 26624, 27648, 29696, or
30720

VCPU = 4
value = 20480, 24576, or 28672

VCPU = 4 or 8
value = 36864, 45056, 53248, or 61440

VCPU = 8
value = 32768, 40960, 49152, or 57344

VCPU = 8 or 16
value = 65536, 73728, 81920, 90112, 98304, 106496, 114688, or 122880

VCPU = 16
type="VCPU"

The number of vCPUs reserved for the container. This parameter maps to CpuShares in
the Create a container section of the Docker Remote API and the --cpu-shares option to
docker run. Each vCPU is equivalent to 1,024 CPU shares. For Amazon EC2 resources, you
must specify at least one vCPU. This is required but can be speciﬁed in several places; it must
be speciﬁed for each node at least once.

The default for the Fargate On-Demand vCPU resource count quota is 6 vCPUs. For more
information about Fargate quotas, see AWS Fargate quotas in the AWS General Reference.

For jobs that are running on Fargate resources, then value must match one of the
supported values and the MEMORY values must be one of the values supported for that VCPU
value. The supported values are 0.25, 0.5, 1, 2, 4, 8, and 16
value = 0.25

MEMORY = 512, 1024, or 2048

value = 0.5

MEMORY = 1024, 2048, 3072, or 4096

Contents API Version 2016-08-10 381

AWS Batch API Reference

value = 1

MEMORY = 2048, 3072, 4096, 5120, 6144, 7168, or 8192

value = 2

MEMORY = 4096, 5120, 6144, 7168, 8192, 9216, 10240, 11264, 12288, 13312, 14336,
15360, or 16384
value = 4

MEMORY = 8192, 9216, 10240, 11264, 12288, 13312, 14336, 15360, 16384, 17408,
18432, 19456, 20480, 21504, 22528, 23552, 24576, 25600, 26624, 27648, 28672,
29696, or 30720
value = 8

MEMORY = 16384, 20480, 24576, 28672, 32768, 36864, 40960, 45056, 49152, 53248,
57344, or 61440
value = 16

MEMORY = 32768, 40960, 49152, 57344, 65536, 73728, 81920, 90112, 98304, 106496,
114688, or 122880

Type: String

Required: Yes

See Also
For more information about using this API in one of the language-speciﬁc AWS SDKs, see the
following:

• AWS SDK for C++

• AWS SDK for Java V2
• AWS SDK for Ruby V3

Type: Array of EvaluateOnExit objects

Required: No

See Also
For more information about using this API in one of the language-speciﬁc AWS SDKs, see the
following:

• AWS SDK for C++

• AWS SDK for Java V2
• AWS SDK for Ruby V3

RetryStrategy API Version 2016-08-10 383

AWS Batch API Reference

RuntimePlatform
An object that represents the compute environment architecture for AWS Batch jobs on Fargate.

Contents
cpuArchitecture

The vCPU architecture. The default value is X86_64. Valid values are X86_64 and ARM64.

Note
This parameter must be set to X86_64 for Windows containers.

Note
Fargate Spot is not supported for ARM64 and Windows-based containers on Fargate.
A job queue will be blocked if a Fargate ARM64 or Windows job is submitted to a job
queue with only Fargate Spot compute environments. However, you can attach both
FARGATE and FARGATE_SPOT compute environments to the same job queue.

Type: String

Required: No
operatingSystemFamily

The operating system for the compute environment. Valid values are: LINUX
(default), WINDOWS_SERVER_2019_CORE, WINDOWS_SERVER_2019_FULL,
WINDOWS_SERVER_2022_CORE, and WINDOWS_SERVER_2022_FULL.

Note
The following parameters can’t be set for Windows containers: linuxParameters,
privileged, user, ulimits, readonlyRootFilesystem, and
efsVolumeConfiguration.

RuntimePlatform API Version 2016-08-10 384

AWS Batch API Reference

Note
The AWS Batch Scheduler checks the compute environments that are attached to the
job queue before registering a task deﬁnition with Fargate. In this scenario, the job
queue is where the job is submitted. If the job requires a Windows container and the
ﬁrst compute environment is LINUX, the compute environment is skipped and the next
compute environment is checked until a Windows-based compute environment is found.

Type: String

Required: No

See Also
For more information about using this API in one of the language-speciﬁc AWS SDKs, see the
following:

• AWS SDK for C++

• AWS SDK for Java V2
• AWS SDK for Ruby V3

The Amazon Resource Name (ARN) of the scheduling policy. An example is

arn:aws:batch:us-east-1:123456789012:scheduling-policy/HighPriority .

Type: String

Required: Yes
name

The name of the scheduling policy.

Type: String

Required: Yes
fairsharePolicy

The fair share policy for the scheduling policy.

Type: FairsharePolicy object

Required: No
tags

The tags that you apply to the scheduling policy to categorize and organize your resources.
Each tag consists of a key and an optional value. For more information, see Tagging AWS
resources in AWS General Reference.

Type: String to string map

Map Entries: Maximum number of 50 items.

Key Length Constraints: Minimum length of 1. Maximum length of 128.

Value Length Constraints: Maximum length of 256.

SchedulingPolicyDetail API Version 2016-08-10 386

AWS Batch API Reference

Required: No

See Also
For more information about using this API in one of the language-speciﬁc AWS SDKs, see the
following:

• AWS SDK for C++

• AWS SDK for Java V2
• AWS SDK for Ruby V3

Amazon Resource Name (ARN) of the scheduling policy.

Type: String

Required: Yes

See Also
For more information about using this API in one of the language-speciﬁc AWS SDKs, see the
following:

• AWS SDK for C++

• AWS SDK for Java V2
• AWS SDK for Ruby V3

SchedulingPolicyListingDetail API Version 2016-08-10 388

AWS Batch API Reference

Secret
An object that represents the secret to expose to your container. Secrets can be exposed to a
container in the following ways:

• To inject sensitive data into your containers as environment variables, use the secrets container
definition parameter.
• To reference sensitive information in the log configuration of a container, use the
secretOptions container definition parameter.

For more information, see Specifying sensitive data in the AWS Batch User Guide.

Contents
name

The name of the secret.

Type: String

Required: Yes
valueFrom

The secret to expose to the container. The supported values are either the full Amazon Resource
Name (ARN) of the AWS Secrets Manager secret or the full ARN of the parameter in the AWS
Systems Manager Parameter Store.

Note
If the AWS Systems Manager Parameter Store parameter exists in the same Region as
the job you're launching, then you can use either the full Amazon Resource Name (ARN)
or name of the parameter. If the parameter exists in a diﬀerent Region, then the full
ARN must be speciﬁed.

Type: String

Required: Yes

Secret API Version 2016-08-10 389

AWS Batch API Reference

See Also
For more information about using this API in one of the language-speciﬁc AWS SDKs, see the
following:

• AWS SDK for C++

• AWS SDK for Java V2
• AWS SDK for Ruby V3

ShareAttributes API Version 2016-08-10 391

AWS Batch API Reference

• AWS SDK for C++

• AWS SDK for Java V2
• AWS SDK for Ruby V3

A unique identiﬁer for the container.

Type: String

Required: No

See Also
For more information about using this API in one of the language-speciﬁc AWS SDKs, see the
following:

• AWS SDK for C++

• AWS SDK for Java V2
• AWS SDK for Ruby V3

TaskContainerDependency API Version 2016-08-10 393

AWS Batch API Reference

TaskContainerDetails
The details for the container in this task attempt.

Contents
command

Type: Array of strings

Required: No
dependsOn

A list of containers that this container depends on.

Type: Array of TaskContainerDependency objects

Required: No
environment

The environment variables to pass to a container. This parameter maps to Env in the Create a
container section of the Docker Remote API and the --env option to docker run.

Important
We don't recommend using plaintext environment variables for sensitive information,
such as credential data.

Type: Array of KeyValuePair objects

Required: No
essential

If the essential parameter of a container is marked as true, and that container fails or stops
for any reason, all other containers that are part of the task are stopped. If the essential

TaskContainerDetails API Version 2016-08-10 394

AWS Batch API Reference

parameter of a container is marked as false, its failure doesn't aﬀect the rest of the containers in
a task. If this parameter is omitted, a container is assumed to be essential.

All jobs must have at least one essential container. If you have an application that's composed
of multiple containers, group containers that are used for a common purpose into components,
and separate the diﬀerent components into multiple task deﬁnitions. For more information, see
Application Architecture in the Amazon Elastic Container Service Developer Guide.

Type: Boolean

Required: No
exitCode

The exit code returned upon completion.

Type: Integer

Required: No
image

The image used to start a container. This string is passed directly to the Docker daemon. By
default, images in the Docker Hub registry are available. Other repositories are speciﬁed with
either repository-url/image:tag or repository-url/image@digest. Up to 255 letters
(uppercase and lowercase), numbers, hyphens, underscores, colons, periods, forward slashes,
and number signs are allowed. This parameter maps to Image in the Create a container section
of the Docker Remote API and the IMAGE parameter of the docker run.

Type: String

Required: No
linuxParameters

Linux-speciﬁc modiﬁcations that are applied to the container, such as Linux kernel capabilities.
For more information, see KernelCapabilities.

Note
This parameter is not supported for Windows containers.

Contents API Version 2016-08-10 395

AWS Batch API Reference

Type: LinuxParameters object

Required: No
logConﬁguration

The log conﬁguration speciﬁcation for the container.

This parameter maps to LogConfig in the Create a container section of the Docker Remote API
and the --log-driver option to docker run.

By default, containers use the same logging driver that the Docker daemon uses. However
the container can use a different logging driver than the Docker daemon by specifying a log
driver with this parameter in the container definition. To use a different logging driver for
a container, the log system must be configured properly on the container instance (or on a
different log server for remote logging options). For more information about the options for
different supported log drivers, see Configure logging drivers in the Docker documentation.

Note
Amazon ECS currently supports a subset of the logging drivers available to the Docker
daemon (shown in the LogConfiguration data type). Additional log drivers may be
available in future releases of the Amazon ECS container agent.

This parameter requires version 1.18 of the Docker Remote API or greater on your container
instance. To check the Docker Remote API version on your container instance, log in to
your container instance and run the following command: sudo docker version --format
'{{.Server.APIVersion}}'

Contents API Version 2016-08-10 396

AWS Batch API Reference

Type: LogConﬁguration object

Required: No
logStreamName

Type: String

Required: No
mountPoints

The mount points for data volumes in your container.

This parameter maps to Volumes in the Create a container section of the Docker Remote API
and the --volume option to docker run.

Windows containers can mount whole directories on the same drive as $env:ProgramData.
Windows containers can't mount directories on a diﬀerent drive, and mount point can't be
across drives.

Type: Array of MountPoint objects

Required: No
name

The name of a container.

Type: String

Required: No
networkInterfaces

The network interfaces that are associated with the job.

Type: Array of NetworkInterface objects

Required: No

Contents API Version 2016-08-10 397

AWS Batch API Reference

privileged

When this parameter is true, the container is given elevated privileges on the host container
instance (similar to the root user). This parameter maps to Privileged in the Create a
container section of the Docker Remote API and the --privileged option to docker run.

Note
This parameter is not supported for Windows containers or tasks run on Fargate.

Type: Boolean

Required: No
readonlyRootFilesystem

Note
This parameter is not supported for Windows containers.

Type: Boolean

Required: No
reason

A short (255 max characters) human-readable string to provide additional details for a running
or stopped container.

Type: String

Required: No
repositoryCredentials

The private repository authentication credentials to use.

Type: RepositoryCredentials object

Contents API Version 2016-08-10 398

AWS Batch API Reference

Required: No
resourceRequirements

The type and amount of a resource to assign to a container. The only supported resource is a
GPU.

Type: Array of ResourceRequirement objects

Required: No
secrets

The secrets to pass to the container. For more information, see Specifying Sensitive Data in the
Amazon Elastic Container Service Developer Guide.

Type: Array of Secret objects

Required: No
ulimits

A list of ulimits to set in the container. If a ulimit value is speciﬁed in a task deﬁnition, it
overrides the default values set by Docker. This parameter maps to Ulimits in the Create a
container section of the Docker Remote API and the --ulimit option to docker run.

Amazon ECS tasks hosted on Fargate use the default resource limit values set by the operating
system with the exception of the noﬁle resource limit parameter which Fargate overrides. The
nofile resource limit sets a restriction on the number of open ﬁles that a container can use.
The default nofile soft limit is 1024 and the default hard limit is 65535.

This parameter requires version 1.18 of the Docker Remote API or greater on your container
instance. To check the Docker Remote API version on your container instance, log in to
your container instance and run the following command: sudo docker version --format
'{{.Server.APIVersion}}'

Note
This parameter is not supported for Windows containers.

Type: Array of Ulimit objects

Contents API Version 2016-08-10 399

AWS Batch API Reference

Required: No
user

The user to use inside the container. This parameter maps to User in the Create a container
section of the Docker Remote API and the --user option to docker run.

Note
When running tasks using the host network mode, don't run containers using the root
user (UID 0). We recommend using a non-root user for better security.

You can specify the user using the following formats. If specifying a UID or GID, you must
specify it as a positive integer.
• user
• user:group
• uid
• uid:gid
• user:gi
• uid:group
•

Note
This parameter is not supported for Windows containers.

Type: String

Required: No

See Also
For more information about using this API in one of the language-speciﬁc AWS SDKs, see the
following:

• AWS SDK for C++

• AWS SDK for Java V2

• AWS SDK for Ruby V3

Type: Array of strings

Required: No

environment

Note
Environment variables cannot start with AWS_BATCH. This naming convention is
reserved for variables that AWS Batch sets.

Type: Array of KeyValuePair objects

Required: No

TaskContainerOverrides API Version 2016-08-10 402

AWS Batch API Reference

name

A pointer to the container that you want to override. The container's name provides a unique
identiﬁer for the container being used.

Type: String

Required: No
resourceRequirements

The type and amount of resources to assign to a container. This overrides the settings in the job
deﬁnition. The supported resources include GPU, MEMORY, and VCPU.

Type: Array of ResourceRequirement objects

Required: No

See Also
For more information about using this API in one of the language-speciﬁc AWS SDKs, see the
following:

• AWS SDK for C++

• AWS SDK for Java V2
• AWS SDK for Ruby V3

Type: Array of strings

Required: No
dependsOn

A list of containers that this container depends on.

Type: Array of TaskContainerDependency objects

Required: No
environment

The environment variables to pass to a container. This parameter maps to Env inthe Create a
container section of the Docker Remote API and the --env parameter to docker run.

TaskContainerProperties API Version 2016-08-10 404

AWS Batch API Reference

Important
We don't recommend using plaintext environment variables for sensitive information,
such as credential data.

Note
Environment variables cannot start with AWS_BATCH. This naming convention is
reserved for variables that AWS Batch sets.

Type: Array of KeyValuePair objects

Required: No
essential

If the essential parameter of a container is marked as true, and that container fails or stops
for any reason, all other containers that are part of the task are stopped. If the essential
parameter of a container is marked as false, its failure doesn't aﬀect the rest of the containers in
a task. If this parameter is omitted, a container is assumed to be essential.

Type: Boolean

Required: No
linuxParameters

Linux-speciﬁc modiﬁcations that are applied to the container, such as Linux kernel capabilities.
For more information, see KernelCapabilities.

Type: LinuxParameters object

Required: No

Contents API Version 2016-08-10 405

AWS Batch API Reference

logConﬁguration

The log conﬁguration speciﬁcation for the container.

This parameter maps to LogConfig in the Create a container section of the Docker Remote API
and the --log-driver option to docker run.

This parameter requires version 1.18 of the Docker Remote API or greater on your container
instance. To check the Docker Remote API version on your container instance, log in to
your container instance and run the following command: sudo docker version --format
'{{.Server.APIVersion}}'

Type: LogConﬁguration object

Required: No

Contents API Version 2016-08-10 406

AWS Batch API Reference

mountPoints

The mount points for data volumes in your container.

This parameter maps to Volumes in the Create a container section of the Docker Remote API
and the --volume option to docker run.

Windows containers can mount whole directories on the same drive as $env:ProgramData.
Windows containers can't mount directories on a diﬀerent drive, and mount point can't be
across drives.

Type: Array of MountPoint objects

Required: No
name

The name of a container. The name can be used as a unique identiﬁer to target your
dependsOn and Overrides objects.

Type: String

Required: No
privileged

Note
This parameter is not supported for Windows containers or tasks run on Fargate.

Type: Boolean

Required: No
readonlyRootFilesystem

Contents API Version 2016-08-10 407

AWS Batch API Reference

Note
This parameter is not supported for Windows containers.

Type: Boolean

Required: No
repositoryCredentials

The private repository authentication credentials to use.

Type: RepositoryCredentials object

Required: No
resourceRequirements

The type and amount of a resource to assign to a container. The only supported resource is a
GPU.

Type: Array of ResourceRequirement objects

Required: No
secrets

The secrets to pass to the container. For more information, see Specifying Sensitive Data in the
Amazon Elastic Container Service Developer Guide.

Type: Array of Secret objects

Required: No
ulimits

Contents API Version 2016-08-10 408

AWS Batch API Reference

This parameter requires version 1.18 of the Docker Remote API or greater on your container
instance. To check the Docker Remote API version on your container instance, log in to
your container instance and run the following command: sudo docker version --format
'{{.Server.APIVersion}}'

Note
This parameter is not supported for Windows containers.

Type: Array of Ulimit objects

Required: No
user

The user to use inside the container. This parameter maps to User in the Create a container
section of the Docker Remote API and the --user option to docker run.

Note
When running tasks using the host network mode, don't run containers using the root
user (UID 0). We recommend using a non-root user for better security.

You can specify the user using the following formats. If specifying a UID or GID, you must
specify it as a positive integer.
• user
• user:group
• uid
• uid:gid
• user:gi
• uid:group

Note
This parameter is not supported for Windows containers.

Contents API Version 2016-08-10 409

AWS Batch API Reference

Type: String

Required: No

See Also
For more information about using this API in one of the language-speciﬁc AWS SDKs, see the
following:

• AWS SDK for C++

• AWS SDK for Java V2
• AWS SDK for Ruby V3

The overrides for the container deﬁnition of a job.

Type: Array of TaskContainerOverrides objects

Required: No

See Also
For more information about using this API in one of the language-speciﬁc AWS SDKs, see the
following:

• AWS SDK for C++

• AWS SDK for Java V2
• AWS SDK for Ruby V3

TaskPropertiesOverride API Version 2016-08-10 411

AWS Batch API Reference

Tmpfs
The container path, mount options, and size of the tmpfs mount.

Note
This object isn't applicable to jobs that are running on Fargate resources.

Contents
containerPath

The absolute ﬁle path in the container where the tmpfs volume is mounted.

Type: String

Required: Yes
size

The size (in MiB) of the tmpfs volume.

Type: Integer

Required: Yes
mountOptions

The list of tmpfs volume mount options.

Type: Array of strings

Required: No

Tmpfs API Version 2016-08-10 412

AWS Batch API Reference

See Also
For more information about using this API in one of the language-speciﬁc AWS SDKs, see the
following:

• AWS SDK for C++

• AWS SDK for Java V2
• AWS SDK for Ruby V3

The hard limit for the ulimit type.

Type: Integer

Required: Yes
name

Type: String

Required: Yes
softLimit

The soft limit for the ulimit type.

Type: Integer

Required: Yes

See Also
For more information about using this API in one of the language-speciﬁc AWS SDKs, see the
following:

• AWS SDK for C++

Ulimit API Version 2016-08-10 414

AWS Batch API Reference

• AWS SDK for Java V2

• AWS SDK for Ruby V3

Valid Range: Minimum value of 1. Maximum value of 360.

Required: No
terminateJobsOnUpdate

Speciﬁes whether jobs are automatically terminated when the computer environment
infrastructure is updated. The default value is false.

Type: Boolean

Required: No

See Also
For more information about using this API in one of the language-speciﬁc AWS SDKs, see the
following:

• AWS SDK for C++

• AWS SDK for Java V2
• AWS SDK for Ruby V3

UpdatePolicy API Version 2016-08-10 416

AWS Batch API Reference

Volume
A data volume that's used in a job's container properties.

Contents
efsVolumeConﬁguration

This parameter is speciﬁed when you're using an Amazon Elastic File System ﬁle system for job
storage. Jobs that are running on Fargate resources must specify a platformVersion of at
least 1.4.0.

Type: EFSVolumeConﬁguration object

Required: No
host

The contents of the host parameter determine whether your data volume persists on the
host container instance and where it's stored. If the host parameter is empty, then the Docker
daemon assigns a host path for your data volume. However, the data isn't guaranteed to persist
after the containers that are associated with it stop running.

Note
This parameter isn't applicable to jobs that are running on Fargate resources and
shouldn't be provided.

Type: Host object

Required: No
name

The name of the volume. It can be up to 255 characters long. It can contain uppercase and
lowercase letters, numbers, hyphens (-), and underscores (_). This name is referenced in the
sourceVolume parameter of container deﬁnition mountPoints.

Type: String

Required: No

Volume API Version 2016-08-10 417

AWS Batch API Reference

See Also
For more information about using this API in one of the language-speciﬁc AWS SDKs, see the
following:

• AWS SDK for C++

• AWS SDK for Java V2
• AWS SDK for Ruby V3

The action to be performed.

Type: string

Required: Yes
Version

The API version that the request is written for, expressed in the format YYYY-MM-DD.

Type: string

Required: Yes
X-Amz-Algorithm

The hash algorithm that you used to create the request signature.

Condition: Specify this parameter when you include authentication information in a query
string instead of in the HTTP authorization header.

Type: string

Valid Values: AWS4-HMAC-SHA256

Required: Conditional
X-Amz-Credential

The credential scope value, which is a string that includes your access key, the date, the region
you are targeting, the service you are requesting, and a termination string ("aws4_request").
The value is expressed in the following format: access_key/YYYYMMDD/region/service/
aws4_request.

API Version 2016-08-10 419

AWS Batch API Reference

For more information, see Create a signed AWS API request in the IAM User Guide.

Condition: Specify this parameter when you include authentication information in a query
string instead of in the HTTP authorization header.

Type: string

Required: Conditional
X-Amz-Date

The date that is used to create the signature. The format must be ISO 8601 basic format
(YYYYMMDD'T'HHMMSS'Z'). For example, the following date time is a valid X-Amz-Date value:
20120325T120000Z.

Condition: X-Amz-Date is optional for all requests; it can be used to override the date used for
signing requests. If the Date header is speciﬁed in the ISO 8601 basic format, X-Amz-Date is not
required. When X-Amz-Date is used, it always overrides the value of the Date header. For more
information, see Elements of an AWS API request signature in the IAM User Guide.

Type: string

Required: Conditional
X-Amz-Security-Token

The temporary security token that was obtained through a call to AWS Security Token Service
(AWS STS). For a list of services that support temporary security credentials from AWS STS, see
AWS services that work with IAM in the IAM User Guide.

Condition: If you're using temporary security credentials from AWS STS, you must include the
security token.

Type: string

Required: Conditional
X-Amz-Signature

Speciﬁes the hex-encoded signature that was calculated from the string to sign and the derived
signing key.

Condition: Specify this parameter when you include authentication information in a query
string instead of in the HTTP authorization header.

API Version 2016-08-10 420

AWS Batch API Reference

Type: string

Required: Conditional
X-Amz-SignedHeaders

Speciﬁes all the HTTP headers that were included as part of the canonical request. For more
information about specifying signed headers, see Create a signed AWS API request in the IAM
User Guide.

Condition: Specify this parameter when you include authentication information in a query
string instead of in the HTTP authorization header.

Type: string

Required: Conditional

API Version 2016-08-10 421

AWS Batch Guide for IT Professionals
No ratings yet
AWS Batch Guide for IT Professionals
8 pages
AWS Batch User Guide
No ratings yet
AWS Batch User Guide
215 pages
Explore AWS Batch - Core Features - Medium
No ratings yet
Explore AWS Batch - Core Features - Medium
15 pages
Spring Batch - Reference
No ratings yet
Spring Batch - Reference
26 pages
BPA v3.1
No ratings yet
BPA v3.1
24 pages
As Api
No ratings yet
As Api
224 pages
Amazon Managed Blockchain - API Referenc
No ratings yet
Amazon Managed Blockchain - API Referenc
102 pages
Datapipeline DG
No ratings yet
Datapipeline DG
337 pages
Aws Iot Analytics API
No ratings yet
Aws Iot Analytics API
185 pages
Apigateway Developer Guide
No ratings yet
Apigateway Developer Guide
263 pages
AWS Batch Processing Architecture
No ratings yet
AWS Batch Processing Architecture
1 page
Codestar Ug
No ratings yet
Codestar Ug
155 pages
VPC Lattice API
No ratings yet
VPC Lattice API
231 pages
Amazon Braket: Developer Guide
No ratings yet
Amazon Braket: Developer Guide
54 pages
Amazon Lex
No ratings yet
Amazon Lex
379 pages
Codepipeline API
No ratings yet
Codepipeline API
353 pages
Amazon MQ DG
No ratings yet
Amazon MQ DG
235 pages
Sqs DG
No ratings yet
Sqs DG
109 pages
AWS Codepipeline-User
No ratings yet
AWS Codepipeline-User
434 pages
Sqs DG PDF
No ratings yet
Sqs DG PDF
199 pages
AWS Certified Solutions Architect Exam Prep
No ratings yet
AWS Certified Solutions Architect Exam Prep
119 pages
© 2020, Amazon Web Services, Inc. or Its Affiliates. All Rights Reserved. Amazon Confidential and Trademark
No ratings yet
© 2020, Amazon Web Services, Inc. or Its Affiliates. All Rights Reserved. Amazon Confidential and Trademark
50 pages
Apigateway DG
No ratings yet
Apigateway DG
842 pages
Amazon API Gateway
0% (1)
Amazon API Gateway
307 pages
Information Available For A Batch Controller
No ratings yet
Information Available For A Batch Controller
3 pages
Handson For AWS-Python
No ratings yet
Handson For AWS-Python
145 pages
Qbusiness API 3
No ratings yet
Qbusiness API 3
590 pages
Azure Batch for Compute Scaling
No ratings yet
Azure Batch for Compute Scaling
3 pages
Aws Cli PDF
No ratings yet
Aws Cli PDF
89 pages
AWS Solutions Architect Cheat Sheet Nov 2024
No ratings yet
AWS Solutions Architect Cheat Sheet Nov 2024
148 pages
Intergraph Batch Services For Windows NT: Quick-Start Guide
No ratings yet
Intergraph Batch Services For Windows NT: Quick-Start Guide
39 pages
Batch
No ratings yet
Batch
39 pages
AWS IoT - API Reference
No ratings yet
AWS IoT - API Reference
1,119 pages
Oracle Workflow API Reference b15855
No ratings yet
Oracle Workflow API Reference b15855
294 pages
Asynchronous Apex API
No ratings yet
Asynchronous Apex API
118 pages
Spring Batch Docs
No ratings yet
Spring Batch Docs
137 pages
SAP Process Batch Management Overview
No ratings yet
SAP Process Batch Management Overview
9 pages
Bulk API Developer Guide: Version 44.0, Winter '19
No ratings yet
Bulk API Developer Guide: Version 44.0, Winter '19
119 pages
Aws Cli
No ratings yet
Aws Cli
92 pages
Control Room API Integration Guide
No ratings yet
Control Room API Integration Guide
6 pages
Amazon Software Testing Insights
No ratings yet
Amazon Software Testing Insights
44 pages
Aws Cli
100% (1)
Aws Cli
218 pages
Spring Batch: Batch Apps & Example
No ratings yet
Spring Batch: Batch Apps & Example
2 pages
MSKDev Guide
No ratings yet
MSKDev Guide
148 pages
AWS Mainframe Modernization
100% (1)
AWS Mainframe Modernization
69 pages
Amazon Aws Lambda-Dg PDF
No ratings yet
Amazon Aws Lambda-Dg PDF
733 pages
09 Azure Batch
No ratings yet
09 Azure Batch
178 pages
AWS Solutions Architect Exam Guide
No ratings yet
AWS Solutions Architect Exam Guide
132 pages
Build A Basic Web Application On AWS
0% (1)
Build A Basic Web Application On AWS
4 pages
Firehose Apiref
No ratings yet
Firehose Apiref
359 pages
Aws Cli PDF
No ratings yet
Aws Cli PDF
94 pages
Chef Courier Product Guide
No ratings yet
Chef Courier Product Guide
11 pages
Iot Api
No ratings yet
Iot Api
1,173 pages
WSO2 API Manager 2.6.0 Guide
No ratings yet
WSO2 API Manager 2.6.0 Guide
18 pages
Red Hat AMQ-7.5-Managing AMQ Broker-en-US
No ratings yet
Red Hat AMQ-7.5-Managing AMQ Broker-en-US
72 pages
Manual CH660-01 (Spare Parts)
100% (1)
Manual CH660-01 (Spare Parts)
34 pages
CRPC Handout 13
No ratings yet
CRPC Handout 13
53 pages
Munga Charles
No ratings yet
Munga Charles
1 page
Assignment Class 11 - ch-1 End of Bipolarity
No ratings yet
Assignment Class 11 - ch-1 End of Bipolarity
6 pages
Accounting Standards Evolution
88% (17)
Accounting Standards Evolution
109 pages
Forensic Ballistics Overall Notes
No ratings yet
Forensic Ballistics Overall Notes
42 pages
Connect To VPN Gate by Using SoftEther VPN (SSL-VPN) PDF
No ratings yet
Connect To VPN Gate by Using SoftEther VPN (SSL-VPN) PDF
4 pages
Vda de Delfin vs. Dellota, G.R. No. 143697, January 28, 2008
100% (1)
Vda de Delfin vs. Dellota, G.R. No. 143697, January 28, 2008
5 pages
Contract Law Study Guide
100% (8)
Contract Law Study Guide
4 pages
MicroTel Service Order Form Sargodha
No ratings yet
MicroTel Service Order Form Sargodha
1 page
Partnership Accounting - Manalo
100% (1)
Partnership Accounting - Manalo
59 pages
2013 Mollan Rojas Contabilidad-General PDF
100% (1)
2013 Mollan Rojas Contabilidad-General PDF
8 pages
IDT 1 Question Paper
No ratings yet
IDT 1 Question Paper
12 pages
Tolstoy-God Sees The Truth But Waits
No ratings yet
Tolstoy-God Sees The Truth But Waits
10 pages
Distance From Previos Stops (Kilometers) : Stops Pick Up Point Remarks Latitude Longitude
No ratings yet
Distance From Previos Stops (Kilometers) : Stops Pick Up Point Remarks Latitude Longitude
5 pages
Xxxxxxxx0239 Oct 2024
No ratings yet
Xxxxxxxx0239 Oct 2024
2 pages
Tally PPT
No ratings yet
Tally PPT
39 pages
Simple 1
No ratings yet
Simple 1
11 pages
Harpia Cub Catalog
No ratings yet
Harpia Cub Catalog
3 pages
Certificados SMGR
No ratings yet
Certificados SMGR
4 pages
The Parable of The Lost Son
No ratings yet
The Parable of The Lost Son
1 page
GE6253 Engineering Mechanics Department of Mechanical, Civil and Chemical Engineering 2016-2017
No ratings yet
GE6253 Engineering Mechanics Department of Mechanical, Civil and Chemical Engineering 2016-2017
24 pages
Defect Liability Period: Mohd Zaki Shamsudin at MD Noor BSB 315 Asset and Space Management
No ratings yet
Defect Liability Period: Mohd Zaki Shamsudin at MD Noor BSB 315 Asset and Space Management
12 pages
ISO 45001: Example Audit Plan
80% (5)
ISO 45001: Example Audit Plan
3 pages
Module 1.4 Revision Notes
No ratings yet
Module 1.4 Revision Notes
10 pages
Tennessee Contractor License Guide
No ratings yet
Tennessee Contractor License Guide
4 pages
Innobuild Company Limited Profile
No ratings yet
Innobuild Company Limited Profile
7 pages
GX-8000 Gas Monitor Maintenance Guide
No ratings yet
GX-8000 Gas Monitor Maintenance Guide
23 pages
Verbiage MT760 - Emirates NBD
100% (1)
Verbiage MT760 - Emirates NBD
2 pages
Humanity Definition
No ratings yet
Humanity Definition
5 pages

Batch Api

Uploaded by

Batch Api

Uploaded by

API Reference

API Version 2016-08-10

AWS Batch: API Reference

API Version 2016-08-10 iii

Response Elements ............................................................................................................................... 29

API Version 2016-08-10 iv

Response Elements ............................................................................................................................... 46

API Version 2016-08-10 v

Response Elements ............................................................................................................................ 104

API Version 2016-08-10 vi

Errors ..................................................................................................................................................... 128

API Version 2016-08-10 vii

Errors ..................................................................................................................................................... 176

API Version 2016-08-10 viii

Errors ..................................................................................................................................................... 196

API Version 2016-08-10 ix

See Also ................................................................................................................................................ 221

API Version 2016-08-10 x

See Also ................................................................................................................................................ 272

API Version 2016-08-10 xi

See Also ................................................................................................................................................ 299

API Version 2016-08-10 xii

See Also ................................................................................................................................................ 318

API Version 2016-08-10 xiii

See Also ................................................................................................................................................ 343

API Version 2016-08-10 xiv

See Also ................................................................................................................................................ 367

API Version 2016-08-10 xv

See Also ................................................................................................................................................ 388

API Version 2016-08-10 xvi

This document was last published on September 11, 2024.

API Version 2016-08-10 1

API Version 2016-08-10 2

POST /v1/canceljob HTTP/1.1

URI Request Parameters

The AWS Batch job ID of the job to cancel.

CancelJob API Version 2016-08-10 3

This parameter has as limit of 1024 characters.

HTTP Status Code: 400

These errors are usually caused by a server issue.

HTTP Status Code: 500

Response Syntax API Version 2016-08-10 4

This example cancels a job with the speciﬁed job ID.

POST /v1/canceljob HTTP/1.1

Examples API Version 2016-08-10 5

• AWS Command Line Interface

See Also API Version 2016-08-10 6

CreateComputeEnvironment API Version 2016-08-10 7

1. Create a new compute environment with the new AMI.

2. Add the compute environment to an existing job queue.

3. Remove the earlier compute environment from your job queue.

• Set the allocation strategy (allocationStrategy) parameter

• Don't specify an AMI ID in imageId, imageIdOverride (in ec2Configuration),

replaced by specifying a diﬀerent launch template, or if the launch template version

POST /v1/createcomputeenvironment HTTP/1.1

Request Syntax API Version 2016-08-10 9

URI Request Parameters

URI Request Parameters API Version 2016-08-10 10

Type: ComputeResource object

Type: EksConﬁguration object

Request Body API Version 2016-08-10 11

Valid Values: ENABLED | DISABLED

Request Body API Version 2016-08-10 12

Type: String to string map

Map Entries: Maximum number of 50 items.

Key Length Constraints: Minimum length of 1. Maximum length of 128.

Value Length Constraints: Maximum length of 256.

Valid Values: MANAGED | UNMANAGED

Request Body API Version 2016-08-10 13

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

The Amazon Resource Name (ARN) of the compute environment.

HTTP Status Code: 400

Response Syntax API Version 2016-08-10 14

These errors are usually caused by a server issue.

HTTP Status Code: 500

In the following example or examples, the Authorization header contents ( [authorization-