Documentation

An object representing 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:stoppedAt:JobDetail', jobDetail_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).

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

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

$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 (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:retryStrategy:JobDetail', jobDetail_retryStrategy - The retry strategy to use for this job if an attempt fails.

$sel:attempts:JobDetail', jobDetail_attempts - A list of job attempts associated with this job.

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

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

$sel:container:JobDetail', jobDetail_container - An object representing the details of the container that's associated with the job.

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

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

$sel:statusReason:JobDetail', jobDetail_statusReason - A short, human-readable string to provide additional details about the current status of the job.

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

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

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

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

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

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

$sel:jobId:JobDetail', jobDetail_jobId - The ID for the job.

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

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

The Amazon Resource Name (ARN) of the job.

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.

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.

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

A list of job attempts associated with this job.

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

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.

A list of job IDs that this job depends on.

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

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

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

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

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

The timeout configuration for the job.

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

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

The tags applied to the job.

The name of the job.

The ID for the job.

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