Documentation

An object that represents an Batch job.

See: newJobDetail smart constructor.

Create a value of JobDetail with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:arrayProperties:JobDetail', jobDetail_arrayProperties - The array properties of the job, if it's an array job.

JobDetail, jobDetail_attempts - A list of job attempts that are associated with this job.

JobDetail, jobDetail_container - An object that represents the details for the container that's associated with the job.

$sel:createdAt:JobDetail', jobDetail_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. This is specifically 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.

$sel:dependsOn:JobDetail', jobDetail_dependsOn - A list of job IDs that this job depends on.

$sel:eksAttempts:JobDetail', jobDetail_eksAttempts - A list of job attempts that are associated with this job.

$sel:eksProperties:JobDetail', jobDetail_eksProperties - An object with various properties that are specific to Amazon EKS based jobs. Only one of container, eksProperties, or nodeDetails is specified.

$sel:isCancelled:JobDetail', jobDetail_isCancelled - Indicates whether the job is canceled.

$sel:isTerminated:JobDetail', jobDetail_isTerminated - Indicates whether the job is terminated.

$sel:jobArn:JobDetail', jobDetail_jobArn - The Amazon Resource Name (ARN) of the job.

$sel:nodeDetails:JobDetail', jobDetail_nodeDetails - An object that represents the details of a node that's associated with a multi-node parallel job.

$sel:nodeProperties:JobDetail', jobDetail_nodeProperties - An object that represents the node properties of a multi-node parallel job.

This isn't applicable to jobs that are running on Fargate resources.

$sel:parameters:JobDetail', jobDetail_parameters - Additional parameters that are passed to the job that replace parameter substitution placeholders or override any corresponding parameter defaults from the job definition.

$sel:platformCapabilities:JobDetail', jobDetail_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.

$sel:propagateTags:JobDetail', jobDetail_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.

$sel:retryStrategy:JobDetail', jobDetail_retryStrategy - The retry strategy to use for this job if an attempt fails.

$sel:schedulingPriority:JobDetail', jobDetail_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.

$sel:shareIdentifier:JobDetail', jobDetail_shareIdentifier - The share identifier for the job.

JobDetail, jobDetail_startedAt - The Unix timestamp (in milliseconds) for when the job was started. More specifically, it's 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.

JobDetail, jobDetail_statusReason - A short, human-readable string to provide more details for the current status of the job.

JobDetail, jobDetail_stoppedAt - The Unix timestamp (in milliseconds) for when the job was stopped. More specifically, it's when the job transitioned from the RUNNING state to a terminal state, such as SUCCEEDED or FAILED.

$sel:tags:JobDetail', jobDetail_tags - The tags that are applied to the job.

$sel:timeout:JobDetail', jobDetail_timeout - The timeout configuration for the job.

$sel:jobName:JobDetail', jobDetail_jobName - The job name.

JobDetail, jobDetail_jobId - The job ID.

$sel:jobQueue:JobDetail', jobDetail_jobQueue - The Amazon Resource Name (ARN) of the job queue that the job is associated with.

$sel:status:JobDetail', jobDetail_status - The current status for the job.

If your jobs don't progress to STARTING, see Jobs stuck in RUNNABLE status in the troubleshooting section of the Batch User Guide.

$sel:jobDefinition:JobDetail', jobDetail_jobDefinition - The Amazon Resource Name (ARN) of the job definition that this job uses.

The array properties of the job, if it's an array job.

A list of job attempts that are associated with this job.

An object that represents the details for the container that's associated with the job.

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. This is specifically 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.

A list of job IDs that this job depends on.

A list of job attempts that are associated with this job.

An object with various properties that are specific to Amazon EKS based jobs. Only one of container, eksProperties, or nodeDetails is specified.

Indicates whether the job is canceled.

Indicates whether the job is terminated.

The Amazon Resource Name (ARN) of the job.

An object that represents the details of a node that's associated with a multi-node parallel job.

An object that represents the node properties of a multi-node parallel job.

This isn't applicable to jobs that are running on Fargate resources.

Additional parameters that are passed to the job that replace parameter substitution placeholders or override any corresponding parameter defaults from the job definition.

The platform capabilities required by the job definition. If no value is specified, it defaults to EC2. Jobs run on Fargate resources specify FARGATE.

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.

The retry strategy to use for this job if an attempt fails.

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.

The share identifier for the job.

The Unix timestamp (in milliseconds) for when the job was started. More specifically, it's 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.

A short, human-readable string to provide more details for the current status of the job.

The Unix timestamp (in milliseconds) for when the job was stopped. More specifically, it's when the job transitioned from the RUNNING state to a terminal state, such as SUCCEEDED or FAILED.

The tags that are applied to the job.

The timeout configuration for the job.

The job name.

The job ID.

The Amazon Resource Name (ARN) of the job queue that the job is associated with.

The current status for the job.

If your jobs don't progress to STARTING, see Jobs stuck in RUNNABLE status in the troubleshooting section of the Batch User Guide.

The Amazon Resource Name (ARN) of the job definition that this job uses.