AWS Batch
API Reference (API Version 2016-08-10)

The AWS Documentation website is getting a new look!
Try it now and let us know what you think. Switch to the new look >>

You can return to the original look by selecting English in the language selector above.

JobDefinition

An object representing an AWS Batch job definition.

Contents

containerProperties

An object with various properties specific to container-based jobs.

Type: ContainerProperties object

Required: No

jobDefinitionArn

The Amazon Resource Name (ARN) for the job definition.

Type: String

Required: Yes

jobDefinitionName

The name of the job definition.

Type: String

Required: Yes

nodeProperties

An object with various properties specific to multi-node parallel jobs.

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

retryStrategy

The retry strategy to use for failed jobs that are submitted with this job definition.

Type: RetryStrategy object

Required: No

revision

The revision of the job definition.

Type: Integer

Required: Yes

status

The status of the job definition.

Type: String

Required: No

timeout

The timeout configuration for jobs that are submitted with this job definition. You can specify a timeout duration after which AWS Batch terminates your jobs if they have not finished.

Type: JobTimeout object

Required: No

type

The type of job definition.

Type: String

Required: Yes

See Also

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

On this page: