> ## Documentation Index
> Fetch the complete documentation index at: https://docs.prefect.io/llms.txt
> Use this file to discover all available pages before exploring further.
# work_pool
# `prefect.cli.work_pool`
Work pool command — native cyclopts implementation.
Manage work pools.
## Functions
### `create`
```python theme={null}
create(name: Annotated[str, cyclopts.Parameter(help='The name of the work pool.')])
```
Create a new work pool or update an existing one.
**Examples:**
```bash theme={null}
# Create a Kubernetes work pool in a paused state
$ prefect work-pool create "my-pool" --type kubernetes --paused
# Create a Docker work pool with a custom base job template
$ prefect work-pool create "my-pool" --type docker --base-job-template ./base-job-template.json
# Update an existing work pool
$ prefect work-pool create "existing-pool" --base-job-template ./base-job-template.json --overwrite
```
### `ls`
```python theme={null}
ls()
```
List work pools.
**Examples:**
```bash theme={null}
$ prefect work-pool ls
```
### `inspect`
```python theme={null}
inspect(name: Annotated[str, cyclopts.Parameter(help='The name of the work pool to inspect.')])
```
Inspect a work pool.
**Examples:**
```bash theme={null}
$ prefect work-pool inspect "my-pool"
$ prefect work-pool inspect "my-pool" --output json
```
### `slots`
```python theme={null}
slots(name: Annotated[str, cyclopts.Parameter(help='The name of the work pool.')])
```
Show concurrency slot utilization for a work pool.
### `pause`
```python theme={null}
pause(name: Annotated[str, cyclopts.Parameter(help='The name of the work pool to pause.')])
```
Pause a work pool.
**Examples:**
```bash theme={null}
$ prefect work-pool pause "my-pool"
```
### `resume`
```python theme={null}
resume(name: Annotated[str, cyclopts.Parameter(help='The name of the work pool to resume.')])
```
Resume a work pool.
**Examples:**
```bash theme={null}
$ prefect work-pool resume "my-pool"
```
### `update`
```python theme={null}
update(name: Annotated[str, cyclopts.Parameter(help='The name of the work pool to update.')])
```
Update a work pool.
**Examples:**
```bash theme={null}
$ prefect work-pool update "my-pool"
```
### `provision_infrastructure_cmd`
```python theme={null}
provision_infrastructure_cmd(name: Annotated[str, cyclopts.Parameter(help='The name of the work pool to provision infrastructure for.')])
```
Provision infrastructure for a work pool.
**Examples:**
```bash theme={null}
$ prefect work-pool provision-infrastructure "my-pool"
$ prefect work-pool provision-infra "my-pool"
```
### `delete`
```python theme={null}
delete(name: Annotated[str, cyclopts.Parameter(help='The name of the work pool to delete.')])
```
Delete a work pool.
**Examples:**
```bash theme={null}
$ prefect work-pool delete "my-pool"
```
### `set_concurrency_limit`
```python theme={null}
set_concurrency_limit(name: Annotated[str, cyclopts.Parameter(help='The name of the work pool to update.')], concurrency_limit: Annotated[int, cyclopts.Parameter(help='The new concurrency limit for the work pool.')])
```
Set the concurrency limit for a work pool.
**Examples:**
```bash theme={null}
$ prefect work-pool set-concurrency-limit "my-pool" 10
```
### `clear_concurrency_limit`
```python theme={null}
clear_concurrency_limit(name: Annotated[str, cyclopts.Parameter(help='The name of the work pool to update.')])
```
Clear the concurrency limit for a work pool.
**Examples:**
```bash theme={null}
$ prefect work-pool clear-concurrency-limit "my-pool"
```
### `get_default_base_job_template`
```python theme={null}
get_default_base_job_template()
```
Get the default base job template for a given work pool type.
**Examples:**
```bash theme={null}
$ prefect work-pool get-default-base-job-template --type kubernetes
```
### `preview`
```python theme={null}
preview(name: Annotated[Optional[str], cyclopts.Parameter(help='The name or ID of the work pool to preview')] = None)
```
Preview the work pool's scheduled work for all queues.
**Examples:**
```bash theme={null}
$ prefect work-pool preview "my-pool" --hours 24
```
### `storage_inspect`
```python theme={null}
storage_inspect(work_pool_name: Annotated[str, cyclopts.Parameter(help='The name of the work pool to display storage configuration for.')])
```
EXPERIMENTAL: Inspect the storage configuration for a work pool.
**Examples:**
```bash theme={null}
$ prefect work-pool storage inspect "my-pool"
$ prefect work-pool storage inspect "my-pool" --output json
```
### `storage_configure_s3`
```python theme={null}
storage_configure_s3(work_pool_name: Annotated[str, cyclopts.Parameter(help='The name of the work pool to configure storage for.')])
```
EXPERIMENTAL: Configure AWS S3 storage for a work pool.
**Examples:**
```bash theme={null}
$ prefect work-pool storage configure s3 "my-pool" --bucket my-bucket --aws-credentials-block-name my-credentials
```
### `storage_configure_gcs`
```python theme={null}
storage_configure_gcs(work_pool_name: Annotated[str, cyclopts.Parameter(help='The name of the work pool to configure storage for.')])
```
EXPERIMENTAL: Configure Google Cloud storage for a work pool.
**Examples:**
```bash theme={null}
$ prefect work-pool storage configure gcs "my-pool" --bucket my-bucket --gcp-credentials-block-name my-credentials
```
### `storage_configure_azure_blob_storage`
```python theme={null}
storage_configure_azure_blob_storage(work_pool_name: Annotated[str, cyclopts.Parameter(help='The name of the work pool to configure storage for.')])
```
EXPERIMENTAL: Configure Azure Blob Storage for a work pool.
**Examples:**
```bash theme={null}
$ prefect work-pool storage configure azure-blob-storage "my-pool" --container my-container --azure-blob-storage-credentials-block-name my-credentials
```