Skip to main content
Version: june-2022

tctl batch

How to run a tctl batch command.

A tctl batch command enables you to affect multiple existing Workflow Executions with a single command. A batch job runs in the background and affects Workflow Executions one at a time.

Use tctl batch start to start a batch job.

When starting a batch job, you must provide a List Filter and the type of batch job that should occur. Batch jobs run in the background and affect Workflow Executions one at a time.

The List Filter identifies the set of Workflow Executions to be affected by the batch job. The tctl batch start command shows you how many Workflow Executions will be affected by the batch job and asks you to confirm before proceeding.

The batch type determines what other parameters you must provide and what is being affected. There are three types of batch jobs:

  • Signal: Send a Signal to the set of Workflow Executions that the List Filter specifies.
  • Cancel: Cancel the set of Workflow Executions that the List Filter specifies.
  • Terminate: Terminate the set of Workflow Executions that the List Filter specifies.

A successfully started batch job returns a Job ID. You can use this Job ID in the tctl batch describe command, which describes the progress of a specific batch job.

You can also use the Job ID to terminate the batch job itself. Terminating a batch job does not roll back the operations already performed by the batch job.

tctl batch commands