JobDetail - AWS Batch
ContentsSee Also

JobDetail

An object representing an AWS Batch job.

Contents

arrayProperties

The array properties of the job, if it is an array job.

Type: ArrayPropertiesDetail object

Required: No

attempts

A list of job attempts associated with this job.

Type: Array of AttemptDetail objects

Required: No

container

An object representing the details of the container that's associated with the job.

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 (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.

Type: Long

Required: No

dependsOn

A list of job IDs that this job depends on.

Type: Array of JobDependency objects

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 that's used by this job.

Type: String

Required: Yes

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 object

Required: No

nodeProperties

An object representing 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 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 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 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

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 object

Required: No

See Also

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