JobDefinition
An object representing an AWS Batch job definition.
Contents
containerProperties
An object with various properties specific to container-based jobs.
Type: ContainerProperties (p. 138) 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.
NoteIf the job runs on Fargate resources, then you must not specify nodeProperties; use containerProperties instead.
Type: NodeProperties (p. 180) 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
Contents
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 (p. 187) 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 AWS Batch terminates your jobs if they haven't finished.
Type: JobTimeout (p. 166) object
See Also
Required: No type
The type of job definition, 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:
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3
JobDependency
JobDependency
An object representing an AWS Batch job dependency.
Contents
jobId
The job ID of the AWS Batch job associated with this dependency.
Type: String Required: No type
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-specific AWS SDKs, see the following:
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3
JobDetail
JobDetail
An object representing an AWS Batch job.
Contents
arrayProperties
The array properties of the job, if it is an array job.
Type: ArrayPropertiesDetail (p. 115) object Required: No
attempts
A list of job attempts associated with this job.
Type: Array of AttemptDetail (p. 119) objects Required: No
container
An object representing the details of the container that's associated with the job.
Type: ContainerDetail (p. 131) 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 (p. 85) 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 (p. 157) objects Required: No
jobArn
The Amazon Resource Name (ARN) of the job.
Type: String Required: No jobDefinition
The job definition that's used by this job.
Type: String Required: Yes
Contents
jobId
The ID for the job.
Type: String Required: Yes jobName
The name of the job.
Type: String Required: Yes jobQueue
The Amazon Resource Name (ARN) of the job queue that the job is associated with.
Type: String Required: Yes nodeDetails
An object representing the details of a node that's associated with a multi-node parallel job.
Type: NodeDetails (p. 178) object Required: No
nodeProperties
An object representing the node properties of a multi-node parallel job.
NoteThis isn't applicable to jobs that are running on Fargate resources.
Type: NodeProperties (p. 180) object Required: No
parameters
Additional parameters passed to the job that replace parameter substitution placeholders or override any corresponding parameter defaults from the job definition.
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
Contents
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 this job if an attempt fails.
Type: RetryStrategy (p. 187) object Required: No
schedulingPriority
The scheduling policy 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 shareIdentifier
The share identifier for the job.
Type: String Required: No startedAt
The Unix timestamp (in milliseconds) for when the job was started (when the job transitioned from the STARTING state to the RUNNING state). This parameter isn't provided for child jobs of array jobs or multi-node parallel jobs.
Type: Long Required: Yes 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 statusReason
A short, human-readable string to provide additional details about the current status of the job.
Type: String Required: No
See Also
stoppedAt
The Unix timestamp (in milliseconds) for when the job was stopped (when the job transitioned from the RUNNING state to a terminal state, such as SUCCEEDED or FAILED).
Type: Long Required: No tags
The tags 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 timeout
The timeout configuration for the job.
Type: JobTimeout (p. 166) object Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3
JobQueueDetail
JobQueueDetail
An object representing the details of an AWS Batch job queue.
Contents
computeEnvironmentOrder
The compute environments that are attached to the job queue and the order that job placement is preferred. Compute environments are selected for job placement in ascending order.
Type: Array of ComputeEnvironmentOrder (p. 123) objects Required: Yes
jobQueueArn
The Amazon Resource Name (ARN) of the job queue.
Type: String Required: Yes jobQueueName
The name of the job queue.
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 first 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 scheduling policy. The format is
aws:Partition:batch:Region:Account:scheduling-policy/Name . For example, aws:aws:batch:us-west-2:012345678910:scheduling-policy/MySchedulingPolicy.
Type: String Required: No state
Describes the ability of the queue to accept new jobs. If the job queue state is ENABLED, it's 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 finish.
Type: String
Valid Values: ENABLED | DISABLED
See Also
Required: Yes status
The status of the job queue (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 about the current status of the job queue.
Type: String Required: No tags
The tags 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-specific AWS SDKs, see the following:
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3
JobSummary
JobSummary
An object representing summary details of a job.
Contents
arrayProperties
The array properties of the job, if it is an array job.
Type: ArrayPropertiesSummary (p. 116) object Required: No
container
An object representing the details of the container that's associated with the job.
Type: ContainerSummary (p. 143) 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 (p. 85) 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 jobArn
The Amazon Resource Name (ARN) of the job.
Type: String Required: No jobDefinition
The Amazon Resource Name (ARN) of the job definition.
Type: String Required: No jobId
The ID of the job.
Type: String Required: Yes jobName
The name of the job.
Type: String Required: Yes
See Also
nodeProperties
The node properties for a single node in a job summary list.
NoteThis isn't applicable to jobs that are running on Fargate resources.
Type: NodePropertiesSummary (p. 181) object Required: No
startedAt
The Unix timestamp for when the job was started (when the job transitioned from the STARTING state to the RUNNING state).
Type: Long Required: No status
The current status for the job.
Type: String
Valid Values: SUBMITTED | PENDING | RUNNABLE | STARTING | RUNNING | SUCCEEDED | FAILED
Required: No statusReason
A short, human-readable string to provide additional details about the current status of the job.
Type: String Required: No stoppedAt
The Unix timestamp for when the job was stopped (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-specific AWS SDKs, see the following:
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3
JobTimeout
JobTimeout
An object representing a job timeout configuration.
Contents
attemptDurationSeconds
The time duration in seconds (measured from the job attempt's startedAt timestamp) after which AWS Batch terminates your jobs if they have not finished. The minimum value for the timeout is 60 seconds.
Type: Integer Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3
KeyValuePair
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-specific AWS SDKs, see the following:
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3
KeyValuesPair
KeyValuesPair
A filter name and value pair that's used to return a more specific list of results from a ListJobs API operation.
The filters supported are documented in the ListJobs API operation.
Contents
name
The name of the filter. Filter names are case sensitive.
Type: String Required: No values
The filter values.
Type: Array of strings Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3