Job Status
batch.describe_jobs
ActionAmazon Web Servicesconnection required
Calls the AWS batch API (SigV4).
Read a Batch job's status.
Connection
- Required
- Yes — the node will not save without one
- Auth type
- API key
- Providers
- AWS Batch
- Secret shape
- {"access_key_id", "secret_access_key"}
- Config it needs
- region
- Resolved by
- config.connection_id, else node.connection_id
Configuration
2 fields, 1 required. A dotted path is a nested object and name[] an array of objects — the editor renders the same tree.
| Field | Type | Required | Default | Constraints | Example |
|---|---|---|---|---|---|
region AWS region (overrides the connection). | string | No | — | — | — |
job_id Job id from submit_job. | string | Yes | — | — | — |
Output
One shape.
result
| Field | Type | Example |
|---|---|---|
job_id | string | — |
job_name | string | — |
status | string | — |
status_reason | string | — |
started_at When the job started, epoch milliseconds. | number | — |
stopped_at When the job stopped, epoch milliseconds. | number | — |
created_at When the job was submitted, epoch milliseconds. | number | — |
job_arn Full ARN — what a tagging or cross-account step takes. | string | — |
job_queue ARN of the queue the job ran on. | string | — |
job_definition ARN of the job definition it ran. | string | — |
container_exit_code The container's exit code. | number | — |
container_reason Why the container stopped. | string | — |
log_stream_name CloudWatch Logs stream holding the job's output. | string | — |
task_arn ECS task that ran the job. | string | — |
container_instance_arn Container instance the task ran on. | string | — |
is_cancelled True when the job was cancelled, not failed. | boolean | — |
is_terminated True when the job was terminated, not failed. | boolean | — |
tags Job tags. | object | — |
{
"container_exit_code": 0,
"container_instance_arn": "",
"container_reason": "",
"created_at": 0,
"is_cancelled": false,
"is_terminated": false,
"job_arn": "",
"job_definition": "",
"job_id": "",
"job_name": "",
"job_queue": "",
"log_stream_name": "",
"started_at": 0,
"status": "",
"status_reason": "",
"stopped_at": 0,
"tags": {},
"task_arn": ""
}Related AWS Batch nodes
See Job Status run in a workflow.
In a technical demo we add the AWS Batch connection, drop the node on the canvas and let Workflow Health pre-flight it before the first real run.