Describe Execution
step_functions.describe_execution
ActionAmazon Web Servicesconnection required
Calls the AWS step_functions API (SigV4).
Read an execution's status and output.
Connection
- Required
- Yes — the node will not save without one
- Auth type
- API key
- Providers
- AWS Step Functions
- 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 | — | — | — |
execution_arn Id of the execution to act on, from its Step Functions URL or console — not its name. | string | Yes | — | — | — |
Output
One shape.
result
| Field | Type | Example |
|---|---|---|
execution_arn | string | — |
state_machine_arn The state machine this execution belongs to; the execution ARN does not contain it. | string | — |
status | string | — |
output | string | — |
start_date When the execution started, epoch seconds. | number | — |
stop_date When the execution finished, epoch seconds; null while it is running. | number | — |
{
"execution_arn": "",
"output": "",
"start_date": 0,
"state_machine_arn": "",
"status": "",
"stop_date": 0
}Notes
- Poll this after start_execution; pair with control.delay.
Related AWS Step Functions nodes
See Describe Execution run in a workflow.
In a technical demo we add the AWS Step Functions connection, drop the node on the canvas and let Workflow Health pre-flight it before the first real run.