tctl workflow cancel

The tctl workflow cancel command cancels a Workflow Execution.

Canceling a running Workflow Execution records a WorkflowExecutionCancelRequested event in the History. A new command task will be scheduled. After cancellation, the Workflow Execution can perform cleanup work.

See also tctl workflow terminate.

tctl workflow cancel [<modifiers>]

The following modifiers control the behavior of the command.

--workflow_id

Specify a Workflow Id.

Aliases: --wid, -w

Example

tctl workflow cancel --workflow_id <id>

--run_id

Specify a Run Id.

Aliases: --rid, -r

Example

tctl workflow cancel --run_id <id>