Run and cancel
Running a cloud-native workflow is a real cloud operation. The CLI shows the
request first and does nothing until you add --apply.
Run a workflow
Section titled “Run a workflow”-
Find the workflow ULID:
Terminal window ayx one workflows list -
Preview the request:
Terminal window ayx -o json one workflows run <workflow-ulid> -
Check the workflow id, then queue it:
Terminal window ayx -o json one workflows run <workflow-ulid> --apply --yes
The applied response comes from the Workflow Service. Keep the returned run/job id; it identifies this particular execution.
Runtime parameters
Section titled “Runtime parameters”If the workflow supports runtime overrides or input parameters, pass a JSON
file, inline non-secret JSON, or - for piped stdin. Prefer a local file or
stdin for anything sensitive:
ayx -o json one workflows run <workflow-ulid> --body run-input.jsonayx -o json one workflows run <workflow-ulid> --body run-input.json --apply --yesInline JSON is visible in shell history and process listings. Do not put credentials in inline arguments; use the secret store and connection configuration for credentials.
Do not put tokens or other secrets in the body file. Use the normal secret store and connection configuration for credentials.
Cancel a run
Section titled “Cancel a run”Use the run/job id returned by run, not the workflow definition ULID:
ayx -o json one workflows cancel <run-id>ayx -o json one workflows cancel <run-id> --apply --yesCancellation is also confirmation-gated when applied. It targets the
cloud-native Workflow Service and never treats the run id as a legacy
/v4/jobGroups id. Some workspaces may not have the provider’s WFS Jobs
capability enabled; in that case the API returns a clear provider error and
the run must be managed through the workspace’s supported execution surface.
Test a disposable copy
Section titled “Test a disposable copy”For a release check, use the opt-in canary test. It copies a workflow, previews and runs the copy, tries cancellation with the returned run/job id, and deletes the copy by id:
AYX_ONE_LIVE_CRUD=1 \AYX_ONE_LIVE_WORKFLOW_RUN=1 \AYX_ONE_LIVE_PROFILE=local-dev \AYX_ONE_LIVE_WORKFLOW_ID='<known-runnable-workflow-ulid>' \cargo test -p ayx-rs --test one_live_crud --locked -- --nocaptureUse a small workflow that is safe to run in the validation workspace. If WFS Jobs is disabled, the test records cancellation as a workspace capability block and still removes the disposable copy.
Safety reminders
Section titled “Safety reminders”- Omitting
--applyis a safe preview and makes no server request. - Use
--yesonly in a reviewed script or CI job. - A workflow may still fail after it is queued because its permissions, connections, datasets, or execution engine are not ready.
- Run and cancellation responses are provider-shaped JSON; use
-o jsonwhen a script needs the returned identifier.