Menu
AWS Batch
API Reference (API Version 2016-08-10)

JobDetail

An object representing an AWS Batch job.

Contents

arrayProperties

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 is associated with the job.

Type: ContainerDetail object

Required: No

createdAt

The Unix timestamp (in seconds and milliseconds) for when the job was created (when the task entered the PENDING state).

Type: Long

Required: No

dependsOn

A list of job names or IDs on which this job depends.

Type: Array of JobDependency objects

Required: No

jobDefinition

The job definition that is 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 with which the job is associated.

Type: String

Required: Yes

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

retryStrategy

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

Type: RetryStrategy object

Required: No

startedAt

The Unix timestamp (in seconds and milliseconds) for when the job was started (when the task transitioned from the PENDING state to the RUNNING state).

Type: Long

Required: Yes

status

The current status for the job.

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 seconds and milliseconds) for when the job was stopped (when the task transitioned from the RUNNING state to the STOPPED state).

Type: Long

Required: No

See Also

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

On this page: