JobDefinition - AWS Batch

JobDefinition

An object that represents an AWS Batch job definition.

Contents

containerOrchestrationType

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

Type: String

Valid Values: ECS | EKS

Required: No

containerProperties

An object with various properties specific to Amazon ECS based jobs. Valid values are containerProperties, eksProperties, and nodeProperties. Only one can be specified.

Type: ContainerProperties object

Required: No

eksProperties

An object with various properties that are specific to Amazon EKS based jobs. Valid values are containerProperties, eksProperties, and nodeProperties. Only one can be specified.

Type: EksProperties 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 that are specific to multi-node parallel jobs. Valid values are containerProperties, eksProperties, and nodeProperties. Only one can be specified.

Note

If the job runs on Fargate resources, don't specify nodeProperties. Use containerProperties instead.

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 definition. If no value is specified, 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 definition.

Type: RetryStrategy object

Required: No

revision

The revision of the job definition.

Type: Integer

Required: Yes

schedulingPriority

The scheduling priority of the job definition. 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.

Type: Integer

Required: No

status

The status of the job definition.

Type: String

Required: No

tags

The tags that are applied to the job definition.

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 definition. After the amount of time you specify passes, AWS Batch terminates your jobs if they aren't finished.

Type: JobTimeout object

Required: No

type

The type of job definition. 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 definition in the AWS Batch User Guide.

Type: String

Required: Yes

See Also

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