> ## Documentation Index
> Fetch the complete documentation index at: /docs/llms.txt
> Use this file to discover all available pages before exploring further.

# work_queue

# `prefect.cli.work_queue`

Work queue command — native cyclopts implementation.

Manage work queues.

## Functions

### `create` <sup>[https://github.com/PrefectHQ/prefect/blob/main/src/prefect/cli/work\_queue.py#L69](https://github.com/PrefectHQ/prefect/blob/main/src/prefect/cli/work_queue.py#L69)</sup>

```python theme={null}
create(name: Annotated[str, cyclopts.Parameter(help='The unique name to assign this work queue')])
```

Create a work queue.

### `set_concurrency_limit` <sup>[https://github.com/PrefectHQ/prefect/blob/main/src/prefect/cli/work\_queue.py#L138](https://github.com/PrefectHQ/prefect/blob/main/src/prefect/cli/work_queue.py#L138)</sup>

```python theme={null}
set_concurrency_limit(name: Annotated[str, cyclopts.Parameter(help='The name or ID of the work queue')], limit: Annotated[int, cyclopts.Parameter(help='The concurrency limit to set on the queue.')])
```

Set a concurrency limit on a work queue.

### `clear_concurrency_limit` <sup>[https://github.com/PrefectHQ/prefect/blob/main/src/prefect/cli/work\_queue.py#L189](https://github.com/PrefectHQ/prefect/blob/main/src/prefect/cli/work_queue.py#L189)</sup>

```python theme={null}
clear_concurrency_limit(name: Annotated[str, cyclopts.Parameter(help='The name or ID of the work queue to clear')])
```

Clear any concurrency limits from a work queue.

### `pause` <sup>[https://github.com/PrefectHQ/prefect/blob/main/src/prefect/cli/work\_queue.py#L235](https://github.com/PrefectHQ/prefect/blob/main/src/prefect/cli/work_queue.py#L235)</sup>

```python theme={null}
pause(name: Annotated[str, cyclopts.Parameter(help='The name or ID of the work queue to pause')])
```

Pause a work queue.

### `resume` <sup>[https://github.com/PrefectHQ/prefect/blob/main/src/prefect/cli/work\_queue.py#L293](https://github.com/PrefectHQ/prefect/blob/main/src/prefect/cli/work_queue.py#L293)</sup>

```python theme={null}
resume(name: Annotated[str, cyclopts.Parameter(help='The name or ID of the work queue to resume')])
```

Resume a paused work queue.

### `inspect` <sup>[https://github.com/PrefectHQ/prefect/blob/main/src/prefect/cli/work\_queue.py#L338](https://github.com/PrefectHQ/prefect/blob/main/src/prefect/cli/work_queue.py#L338)</sup>

```python theme={null}
inspect(name: Annotated[str, cyclopts.Parameter(help='The name or ID of the work queue to inspect')])
```

Inspect a work queue by ID.

### `slots` <sup>[https://github.com/PrefectHQ/prefect/blob/main/src/prefect/cli/work\_queue.py#L411](https://github.com/PrefectHQ/prefect/blob/main/src/prefect/cli/work_queue.py#L411)</sup>

```python theme={null}
slots(name: Annotated[str, cyclopts.Parameter(help='The name or ID of the work queue.')])
```

Show concurrency slot utilization for a work queue.

### `ls` <sup>[https://github.com/PrefectHQ/prefect/blob/main/src/prefect/cli/work\_queue.py#L505](https://github.com/PrefectHQ/prefect/blob/main/src/prefect/cli/work_queue.py#L505)</sup>

```python theme={null}
ls()
```

View all work queues.

### `preview` <sup>[https://github.com/PrefectHQ/prefect/blob/main/src/prefect/cli/work\_queue.py#L646](https://github.com/PrefectHQ/prefect/blob/main/src/prefect/cli/work_queue.py#L646)</sup>

```python theme={null}
preview(name: Annotated[str, cyclopts.Parameter(help='The name or ID of the work queue to preview')])
```

Preview a work queue.

### `delete` <sup>[https://github.com/PrefectHQ/prefect/blob/main/src/prefect/cli/work\_queue.py#L764](https://github.com/PrefectHQ/prefect/blob/main/src/prefect/cli/work_queue.py#L764)</sup>

```python theme={null}
delete(name: Annotated[str, cyclopts.Parameter(help='The name or ID of the work queue to delete')])
```

Delete a work queue by ID.

### `read_wq_runs` <sup>[https://github.com/PrefectHQ/prefect/blob/main/src/prefect/cli/work\_queue.py#L813](https://github.com/PrefectHQ/prefect/blob/main/src/prefect/cli/work_queue.py#L813)</sup>

```python theme={null}
read_wq_runs(name: Annotated[str, cyclopts.Parameter(help='The name or ID of the work queue to poll')])
```

Get runs in a work queue.

Note that this will trigger an artificial poll of the work queue.