ContextQMD
Back to Prefect

Work Queue

docs/v3/api-ref/cli/work-queue.mdx

3.7.9.dev56.7 KB
Original Source

prefect work-queue

command
prefect work-queue [OPTIONS] COMMAND [ARGS]...
<Info> Manage work queues. </Info>

prefect work-queue create

command
prefect work-queue create [OPTIONS] NAME
<Info> Create a work queue. </Info> <AccordionGroup> <Accordion title="Arguments" defaultOpen> <ResponseField name="NAME" type="string" required> The unique name to assign this work queue </ResponseField> </Accordion> <Accordion title="Options" defaultOpen> <ResponseField name="--limit"> The concurrency limit to set on the queue. </ResponseField> <ResponseField name="--pool"> The name of the work pool to create the work queue in. </ResponseField> <ResponseField name="--priority"> The associated priority for the created work queue </ResponseField> </Accordion> </AccordionGroup>

prefect work-queue set-concurrency-limit

command
prefect work-queue set-concurrency-limit [OPTIONS] NAME LIMIT
<Info> Set a concurrency limit on a work queue. </Info> <AccordionGroup> <Accordion title="Arguments" defaultOpen> <ResponseField name="NAME" type="string" required> The name or ID of the work queue </ResponseField> <ResponseField name="LIMIT" type="string" required> The concurrency limit to set on the queue. </ResponseField> </Accordion> <Accordion title="Options" defaultOpen> <ResponseField name="--pool"> The name of the work pool that the work queue belongs to. </ResponseField> </Accordion> </AccordionGroup>

prefect work-queue clear-concurrency-limit

command
prefect work-queue clear-concurrency-limit [OPTIONS] NAME
<Info> Clear any concurrency limits from a work queue. </Info> <AccordionGroup> <Accordion title="Arguments" defaultOpen> <ResponseField name="NAME" type="string" required> The name or ID of the work queue to clear </ResponseField> </Accordion> <Accordion title="Options" defaultOpen> <ResponseField name="--pool"> The name of the work pool that the work queue belongs to. </ResponseField> </Accordion> </AccordionGroup>

prefect work-queue pause

command
prefect work-queue pause [OPTIONS] NAME
<Info> Pause a work queue. </Info> <AccordionGroup> <Accordion title="Arguments" defaultOpen> <ResponseField name="NAME" type="string" required> The name or ID of the work queue to pause </ResponseField> </Accordion> <Accordion title="Options" defaultOpen> <ResponseField name="--pool"> The name of the work pool that the work queue belongs to. </ResponseField> </Accordion> </AccordionGroup>

prefect work-queue resume

command
prefect work-queue resume [OPTIONS] NAME
<Info> Resume a paused work queue. </Info> <AccordionGroup> <Accordion title="Arguments" defaultOpen> <ResponseField name="NAME" type="string" required> The name or ID of the work queue to resume </ResponseField> </Accordion> <Accordion title="Options" defaultOpen> <ResponseField name="--pool"> The name of the work pool that the work queue belongs to. </ResponseField> </Accordion> </AccordionGroup>

prefect work-queue inspect

command
prefect work-queue inspect [OPTIONS] NAME
<Info> Inspect a work queue by ID. </Info> <AccordionGroup> <Accordion title="Arguments" defaultOpen> <ResponseField name="NAME" type="string" required> The name or ID of the work queue to inspect </ResponseField> </Accordion> <Accordion title="Options" defaultOpen> <ResponseField name="--pool"> The name of the work pool that the work queue belongs to. </ResponseField> <ResponseField name="--output"> Specify an output format. Currently supports: json </ResponseField> </Accordion> </AccordionGroup>

prefect work-queue slots

command
prefect work-queue slots [OPTIONS] NAME
<Info> Show concurrency slot utilization for a work queue. </Info> <AccordionGroup> <Accordion title="Arguments" defaultOpen> <ResponseField name="NAME" type="string" required> The name or ID of the work queue. </ResponseField> </Accordion> <Accordion title="Options" defaultOpen> <ResponseField name="--pool"> The name of the work pool that the work queue belongs to. </ResponseField> <ResponseField name="--output"> Specify an output format. Currently supports: json </ResponseField> </Accordion> </AccordionGroup>

prefect work-queue ls

command
prefect work-queue ls [OPTIONS]
<Info> View all work queues. </Info> <AccordionGroup> <Accordion title="Options" defaultOpen> <ResponseField name="--verbose"> Display more information. </ResponseField> <ResponseField name="--match"> Will match work queues with names that start with the specified prefix string </ResponseField> <ResponseField name="--pool"> The name of the work pool containing the work queues to list. </ResponseField> <ResponseField name="--output"> Specify an output format. Currently supports: json </ResponseField> </Accordion> </AccordionGroup>

prefect work-queue preview

command
prefect work-queue preview [OPTIONS] NAME
<Info> Preview a work queue. </Info> <AccordionGroup> <Accordion title="Arguments" defaultOpen> <ResponseField name="NAME" type="string" required> The name or ID of the work queue to preview </ResponseField> </Accordion> <Accordion title="Options" defaultOpen> <ResponseField name="--hours"> The number of hours to look ahead; defaults to 1 hour </ResponseField> <ResponseField name="--pool"> The name of the work pool that the work queue belongs to. </ResponseField> <ResponseField name="--output"> Specify an output format. Currently supports: json </ResponseField> </Accordion> </AccordionGroup>

prefect work-queue delete

command
prefect work-queue delete [OPTIONS] NAME
<Info> Delete a work queue by ID. </Info> <AccordionGroup> <Accordion title="Arguments" defaultOpen> <ResponseField name="NAME" type="string" required> The name or ID of the work queue to delete </ResponseField> </Accordion> <Accordion title="Options" defaultOpen> <ResponseField name="--pool"> The name of the work pool containing the work queue to delete. </ResponseField> </Accordion> </AccordionGroup>

prefect work-queue read-runs

command
prefect work-queue read-runs [OPTIONS] NAME
<Info> Get runs in a work queue.

Note that this will trigger an artificial poll of the work queue. </Info>

<AccordionGroup> <Accordion title="Arguments" defaultOpen> <ResponseField name="NAME" type="string" required> The name or ID of the work queue to poll </ResponseField> </Accordion> <Accordion title="Options" defaultOpen> <ResponseField name="--pool"> The name of the work pool containing the work queue to poll. </ResponseField> </Accordion> </AccordionGroup>