Try it now and let us know what you think. Switch to the new look >>
You can return to the original look by selecting English in the language selector above.
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 is associated with the job.
Type: ContainerDetail object
Required: No
- createdAt
-
The Unix timestamp (in seconds and milliseconds) for when the job was created. For non-array jobs and parent array jobs, this is when the job entered the
SUBMITTEDstate (at the time SubmitJob was called). For array child jobs, this is when the child job was spawned by its parent and entered thePENDINGstate.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
- nodeDetails
-
An object representing the details of a node that is 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.
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
- 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 job transitioned from the
STARTINGstate to theRUNNINGstate).Type: Long
Required: Yes
- status
-
The current status for the job.
Note
If your jobs do not 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 | FAILEDRequired: 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 job transitioned from the
RUNNINGstate to a terminal state, such asSUCCEEDEDorFAILED).Type: Long
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:
