Appearance
runner.execution-launch-ec2-vm ​
Launch one runner execution on a raw EC2 VM
Overview ​
| Property | Value |
|---|---|
| Workflow type | Linear |
| Library | App-runners-aws |
| Version | 1.0 |
Input Schema ​
| Field | Type | Required | Default | Description |
|---|---|---|---|---|
runner_group_uuid | uuid | Yes | — | Runner group UUID |
organization_uuid | uuid | No | — | Organization UUID |
runner_execution_uuid | uuid | No | — | Existing execution UUID to reuse |
command | json | No | — | Command to run (generic mode) |
environment | dict | No | — | Extra environment variables. Sensitive (SECRET-HANDLING-001): values are vaulted rather than persisted in workflow state_data, and only the key names are recorded on the execution record |
extra_tags | dict | No | — | Additional EC2 instance tags |
gh_workflow_run_ref | integer | No | — | GitHub workflow_run reference that triggered this launch |
Output Schema ​
| Field | Type | Required | Default | Description |
|---|---|---|---|---|
runner_group_uuid | uuid | No | — | UUID of the RunnerGroup this workflow operates on, picked from the organization's list of runner groups. Optional on this shared passthrough schema because the same field also appears as an output-only echo. |
organization_uuid | uuid | No | — | UUID of the caller's organization, injected server-side from the authenticated request; scopes the operation to the correct tenant. |
registry_account_uuid | uuid | No | — | UUID of the container registry account this runner group resolves images against, picked from the organization's registry accounts. Optional — falls back to default/unauthenticated image resolution when absent. |
actor_uuid | uuid | No | — | UUID of the user or service actor who triggered this action, injected server-side from the authenticated request when available; used for audit/attribution only. |
workflow_run_id | string | No | — | — |
workflow_run_uuid | string | No | — | Legacy alias of workflow_run_id: an internal engine correlation/run identifier for this DAG execution (ADR-015/E1 plumbing), not a foreign key to any business entity. No list/query workflow applies — this is engine-generated, never user-supplied. |
workflow_uuid | string | No | — | Engine workflow-run identifier associated with this record; not a platform entity foreign key despite the name. No list/query workflow applies — this is engine-generated, never user-supplied. |
status | string | No | — | — |
outcome | string | No | — | — |
initiated_at | string | No | — | — |
completed_at | string | No | — | — |
failed_at | string | No | — | — |
failure_reason | string | No | — | — |
error | string | No | — | — |
error_type | string | No | — | — |
reason | string | No | — | — |
failed_step | json | No | — | — |
failed_layer | json | No | — | — |
failed_at_state | json | No | — | — |
compensation_trigger | json | No | — | — |
comp_current_layer | json | No | — | — |
comp_queue | json | No | — | — |
comp_retry_count | json | No | — | — |
primitive_input | json | No | — | — |
primitive_output | json | No | — | — |
runner_execution_uuid | json | No | — | — |
old_runner_execution_uuid | json | No | — | — |
new_runner_execution_uuid | json | No | — | — |
registration_token | json | No | — | Credential-bearing field (SECRET-HANDLING-001): vaulted by SensitiveDataMiddleware instead of being persisted in cleartext state_data / event history. |
provider_execution_ref | json | No | — | — |
command | json | No | — | — |
environment | json | No | — | Credential-bearing field (SECRET-HANDLING-001): vaulted by SensitiveDataMiddleware instead of being persisted in cleartext state_data / event history. |
extra_tags | json | No | — | — |
new_events_count | json | No | — | — |
step_output | json | No | — | — |
gh_workflow_run_ref | json | No | — | — |
environment_keys | json | No | — | — |
States ​
| State | Initial | Terminal | Success | Auto-advance | Description |
|---|---|---|---|---|---|
initiated | Yes | No | — | prepare | — |
getting_registration_token | No | No | — | launch_execution | — |
launching_execution | No | No | — | complete | — |
preparing | No | No | — | get_registration_token | — |
completed | No | Yes | Yes | — | — |
failed | No | Yes | No | — | — |
State Diagram ​
Transitions ​
| From | Action | To | Description |
|---|---|---|---|
initiated | prepare | preparing | — |
preparing | get_registration_token | getting_registration_token | — |
getting_registration_token | launch_execution | launching_execution | — |
launching_execution | complete | completed | — |
* (any state) | fail | failed | — |
API Usage ​
bash
POST /api/workflows/start
Content-Type: application/json
{
"workflow_type": "runner.execution-launch-ec2-vm",
"initial_data": {
"runner_group_uuid": "value"
}
}