JobDefinition
An object representing an Amazon 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.
Note If the job runs on Fargate resources, then you must not specify
nodeProperties
; usecontainerProperties
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 Amazon 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 specifyFARGATE
.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 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.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 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 configuration for jobs that are submitted with this job definition. You can specify a timeout duration after which Amazon Batch terminates your jobs if they haven't finished.
Type: JobTimeout object
Required: No
- type
-
The type of job definition, either
container
ormultinode
. If the job is run on Fargate resources, thenmultinode
isn't supported. For more information about multi-node parallel jobs, see Creating a multi-node parallel job definition in the Amazon Batch User Guide.Type: String
Required: Yes
See Also
For more information about using this API in one of the language-specific Amazon SDKs, see the following: