Stop Execution

step_functions.stop_execution
ActionAmazon Web Servicesconnection required

Calls the AWS step_functions API (SigV4).

Stop a running execution.

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

4 fields, 1 required. A dotted path is a nested object and name[] an array of objects — the editor renders the same tree.

FieldTypeRequiredDefaultConstraintsExample
region
AWS region (overrides the connection).
stringNo———
execution_arn
Id of the execution to act on, from its Step Functions URL or console — not its name.
stringYes———
error
Error name recorded on the execution.
stringNo———
cause
Human-readable cause.
stringNo———

Output

One shape.

result

FieldTypeExample
ok
boolean—
stop_date
When the execution was stopped, epoch seconds.
number—
{
  "ok": false,
  "stop_date": 0
}

Related AWS Step Functions nodes

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