JobDetail - Amazon Batch
ContentsSee Also
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China (PDF).

JobDetail

An object that represents an Amazon Batch job.

Contents

jobDefinition

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

Type: String

Required: Yes

jobId

The job ID.

Type: String

Required: Yes

jobName

The job name.

Type: String

Required: Yes

jobQueue

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

Type: String

Required: Yes

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.

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 Amazon Batch User Guide.

Type: String

Valid Values: SUBMITTED | PENDING | RUNNABLE | STARTING | RUNNING | SUCCEEDED | FAILED

Required: Yes

arrayProperties

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

Type: ArrayPropertiesDetail object

Required: No

attempts

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

Type: Array of AttemptDetail objects

Required: No

container

An object that represents the details for the container that's associated with the job. If the details are for a multiple-container job, this object will be empty.

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

Type: Long

Required: No

dependsOn

A list of job IDs that this job depends on.

Type: Array of JobDependency objects

Required: No

ecsProperties

An object with properties that are specific to Amazon ECS-based jobs.

Type: EcsPropertiesDetail object

Required: No

eksAttempts

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

Type: Array of EksAttemptDetail objects

Required: No

eksProperties

An object with various properties that are specific to Amazon EKS based jobs.

Type: EksPropertiesDetail object

Required: No

isCancelled

Indicates whether the job is canceled.

Type: Boolean

Required: No

isTerminated

Indicates whether the job is terminated.

Type: Boolean

Required: No

jobArn

The Amazon Resource Name (ARN) of the job.

Type: String

Required: No

nodeDetails

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

Type: NodeDetails object

Required: No

nodeProperties

An object that represents 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 that are 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 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.

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

statusReason

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

  • CAPACITY:INSUFFICIENT_INSTANCE_CAPACITY - All compute environments have insufficient capacity to service the job.

  • MISCONFIGURATION:COMPUTE_ENVIRONMENT_MAX_RESOURCE - All compute environments have a maxVcpu setting that is smaller than the job requirements.

  • MISCONFIGURATION:JOB_RESOURCE_REQUIREMENT - All compute environments have no connected instances that meet the job requirements.

  • MISCONFIGURATION:SERVICE_ROLE_PERMISSIONS - All compute environments have problems with the service role permissions.

Type: String

Required: No

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.

Type: Long

Required: No

tags

The tags that are 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 Amazon SDKs, see the following: