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.

NAME
string
required

The unique name to assign this work queue [required]

-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

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

Set a concurrency limit on a work queue.

NAME
string
required

The name or ID of the work queue [required]

LIMIT
string
required

The concurrency limit to set on the queue. [required]

-p

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.

NAME
string
required

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

-p

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.

NAME
string
required

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

-p

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.

NAME
string
required

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

-p

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.

NAME
string

The name or ID of the work queue to inspect

-p

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

prefect work-queue ls

prefect work-queue ls [OPTIONS]

View all work queues.

--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

prefect work-queue preview [OPTIONS] [NAME]

Preview a work queue.

NAME
string

The name or ID of the work queue to preview

-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

prefect work-queue delete [OPTIONS] NAME

Delete a work queue by ID.

NAME
string
required

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

-p

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.

NAME
string
required

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

-p

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