prefect work-queue

prefect work-queue [OPTIONS] COMMAND [ARGS]...

Manage work queues.

prefect work-queue create

prefect work-queue create [OPTIONS] NAME

Create a work queue.

Arguments

NAME · string · required

The unique name to assign this work queue

Options

--limit

The concurrency limit to set on the queue.

--pool

The name of the work pool to create the work queue in.

--priority

The associated priority for the created work queue

prefect work-queue set-concurrency-limit

prefect work-queue set-concurrency-limit [OPTIONS] NAME LIMIT

Set a concurrency limit on a work queue.

Arguments

NAME · string · required

The name or ID of the work queue

LIMIT · string · required

The concurrency limit to set on the queue.

Options

--pool

The name of the work pool that the work queue belongs to.

prefect work-queue clear-concurrency-limit

prefect work-queue clear-concurrency-limit [OPTIONS] NAME

Clear any concurrency limits from a work queue.

Arguments

NAME · string · required

The name or ID of the work queue to clear

Options

--pool

The name of the work pool that the work queue belongs to.

prefect work-queue pause

prefect work-queue pause [OPTIONS] NAME

Pause a work queue.

Arguments

NAME · string · required

The name or ID of the work queue to pause

Options

--pool

The name of the work pool that the work queue belongs to.

prefect work-queue resume

prefect work-queue resume [OPTIONS] NAME

Resume a paused work queue.

Arguments

NAME · string · required

The name or ID of the work queue to resume

Options

--pool

The name of the work pool that the work queue belongs to.

prefect work-queue inspect

prefect work-queue inspect [OPTIONS] NAME

Inspect a work queue by ID.

Arguments

NAME · string · required

The name or ID of the work queue to inspect

Options

--pool

The name of the work pool that the work queue belongs to.

--output

Specify an output format. Currently supports: json

prefect work-queue slots

prefect work-queue slots [OPTIONS] NAME

Show concurrency slot utilization for a work queue.

Arguments

NAME · string · required

The name or ID of the work queue.

Options

--pool

The name of the work pool that the work queue belongs to.

--output

Specify an output format. Currently supports: json

prefect work-queue ls

prefect work-queue ls [OPTIONS]

View all work queues.

Options

--verbose

Display more information.

--match

Will match work queues with names that start with the specified prefix string

--pool

The name of the work pool containing the work queues to list.

--output

Specify an output format. Currently supports: json

prefect work-queue preview

prefect work-queue preview [OPTIONS] NAME

Preview a work queue.

Arguments

NAME · string · required

The name or ID of the work queue to preview

Options

--hours

The number of hours to look ahead; defaults to 1 hour

--pool

The name of the work pool that the work queue belongs to.

--output

Specify an output format. Currently supports: json

prefect work-queue delete

prefect work-queue delete [OPTIONS] NAME

Delete a work queue by ID.

Arguments

NAME · string · required

The name or ID of the work queue to delete

Options

--pool

The name of the work pool containing the work queue to delete.

prefect work-queue read-runs

prefect work-queue read-runs [OPTIONS] NAME

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

Options

--pool

The name of the work pool containing the work queue to poll.