Skip to main content

​
prefect work-queue

Manage work queues.

​
prefect work-queue create

Create a work queue.

Arguments

​
NAME
string
required
The unique name to assign this work queue [required]

Options

​
-l
The concurrency limit to set on the queue.
​
-p
The name of the work pool to create the work queue in.
​
-q
The associated priority for the created work queue

​
prefect work-queue set-concurrency-limit

Set a concurrency limit on a work queue.

Arguments

​
NAME
string
required
The name or ID of the work queue [required]
​
LIMIT
string
required
The concurrency limit to set on the queue. [required]

Options

​
-p
The name of the work pool that the work queue belongs to.

​
prefect work-queue clear-concurrency-limit

Clear any concurrency limits from a work queue.

Arguments

​
NAME
string
required
The name or ID of the work queue to clear [required]

Options

​
-p
The name of the work pool that the work queue belongs to.

​
prefect work-queue pause

Pause a work queue.

Arguments

​
NAME
string
required
The name or ID of the work queue to pause [required]

Options

​
-p
The name of the work pool that the work queue belongs to.

​
prefect work-queue resume

Resume a paused work queue.

Arguments

​
NAME
string
required
The name or ID of the work queue to resume [required]

Options

​
-p
The name of the work pool that the work queue belongs to.

​
prefect work-queue inspect

Inspect a work queue by ID.

Arguments

​
NAME
string
The name or ID of the work queue to inspect

Options

​
-p
The name of the work pool that the work queue belongs to.
​
--output
Specify an output format. Currently supports: json

​
prefect work-queue ls

View all work queues.

Options

​
--verbose
Display more information.
​
--match
Will match work queues with names that start with the specified prefix string
​
-p
The name of the work pool containing the work queues to list.

​
prefect work-queue preview

Preview a work queue.

Arguments

​
NAME
string
The name or ID of the work queue to preview

Options

​
-h
The number of hours to look ahead; defaults to 1 hour
​
-p
The name of the work pool that the work queue belongs to.

​
prefect work-queue delete

Delete a work queue by ID.

Arguments

​
NAME
string
required
The name or ID of the work queue to delete [required]

Options

​
-p
The name of the work pool containing the work queue to delete.

​
prefect work-queue read-runs

Get runs in a work queue. Note that this will trigger an artificial poll of the work queue.

Arguments

​
NAME
string
required
The name or ID of the work queue to poll [required]

Options

​
-p
The name of the work pool containing the work queue to poll.