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

#  

# `prefect work-pool`

```command theme={null}
prefect work-pool [OPTIONS] COMMAND [ARGS]...
```

> [!NOTE]
>
> Manage work pools.

## `prefect work-pool storage`

```command theme={null}
prefect work-pool storage [OPTIONS] COMMAND [ARGS]...
```

> [!NOTE]
>
> EXPERIMENTAL: Manage work pool storage.

### `prefect work-pool storage configure`

```command theme={null}
prefect work-pool storage configure [OPTIONS] COMMAND [ARGS]...
```

> [!NOTE]
>
> EXPERIMENTAL: Configure work pool storage.

#### `prefect work-pool storage configure s3`

```command theme={null}
prefect work-pool storage configure s3 [OPTIONS] WORK_POOL_NAME
```

> [!NOTE]
>
> EXPERIMENTAL: Configure AWS S3 storage for a work pool.

> **Arguments**
>
> **WORK\_POOL\_NAME** `string` *required*
>
> The name of the work pool to configure storage for.

> **Options**
>
> **--bucket**
>
> The name of the S3 bucket to use.
>
> **--aws-credentials-block-name**
>
> The name of the AWS credentials block to use.
>
> **--launcher**
>
> Shared executable or path for upload and execution.
>
> **--launcher-arg**
>
> Append one argv token to the shared launcher. Repeat per token.
>
> **--upload-launcher**
>
> Replace the shared executable or path for upload only.
>
> **--upload-launcher-arg**
>
> Append one upload-only argv token. Extends the shared launcher.
>
> **--execution-launcher**
>
> Replace the shared executable or path for execution only.
>
> **--execution-launcher-arg**
>
> Append one execution-only argv token. Extends the shared launcher.

> [!NOTE]
>
> **Example:**
>
> ```bash theme={null}
> $ prefect work-pool storage configure s3 "my-pool" --bucket my-bucket --aws-credentials-block-name my-credentials
> ```

#### `prefect work-pool storage configure gcs`

```command theme={null}
prefect work-pool storage configure gcs [OPTIONS] WORK_POOL_NAME
```

> [!NOTE]
>
> EXPERIMENTAL: Configure Google Cloud storage for a work pool.

> **Arguments**
>
> **WORK\_POOL\_NAME** `string` *required*
>
> The name of the work pool to configure storage for.

> **Options**
>
> **--bucket**
>
> The name of the Google Cloud Storage bucket to use.
>
> **--gcp-credentials-block-name**
>
> The name of the Google Cloud credentials block to use.
>
> **--launcher**
>
> Shared executable or path for upload and execution.
>
> **--launcher-arg**
>
> Append one argv token to the shared launcher. Repeat per token.
>
> **--upload-launcher**
>
> Replace the shared executable or path for upload only.
>
> **--upload-launcher-arg**
>
> Append one upload-only argv token. Extends the shared launcher.
>
> **--execution-launcher**
>
> Replace the shared executable or path for execution only.
>
> **--execution-launcher-arg**
>
> Append one execution-only argv token. Extends the shared launcher.

> [!NOTE]
>
> **Example:**
>
> ```bash theme={null}
> $ prefect work-pool storage configure gcs "my-pool" --bucket my-bucket --gcp-credentials-block-name my-credentials
> ```

#### `prefect work-pool storage configure azure-blob-storage`

```command theme={null}
prefect work-pool storage configure azure-blob-storage [OPTIONS] WORK_POOL_NAME
```

> [!NOTE]
>
> EXPERIMENTAL: Configure Azure Blob Storage for a work pool.

> **Arguments**
>
> **WORK\_POOL\_NAME** `string` *required*
>
> The name of the work pool to configure storage for.

> **Options**
>
> **--container**
>
> The name of the Azure Blob Storage container to use.
>
> **--azure-blob-storage-credentials-block-name**
>
> The name of the Azure Blob Storage credentials block to use.
>
> **--launcher**
>
> Shared executable or path for upload and execution.
>
> **--launcher-arg**
>
> Append one argv token to the shared launcher. Repeat per token.
>
> **--upload-launcher**
>
> Replace the shared executable or path for upload only.
>
> **--upload-launcher-arg**
>
> Append one upload-only argv token. Extends the shared launcher.
>
> **--execution-launcher**
>
> Replace the shared executable or path for execution only.
>
> **--execution-launcher-arg**
>
> Append one execution-only argv token. Extends the shared launcher.

> [!NOTE]
>
> **Example:**
>
> ```bash theme={null}
> $ prefect work-pool storage configure azure-blob-storage "my-pool" --container my-container --azure-blob-storage-credentials-block-name my-credentials
> ```

### `prefect work-pool storage inspect`

```command theme={null}
prefect work-pool storage inspect [OPTIONS] WORK_POOL_NAME
```

> [!NOTE]
>
> EXPERIMENTAL: Inspect the storage configuration for a work pool.

> **Arguments**
>
> **WORK\_POOL\_NAME** `string` *required*
>
> The name of the work pool to display storage configuration for.

> **Options**
>
> **--output**
>
> Specify an output format. Currently supports: json

> [!NOTE]
>
> **Example:**
>
> ```bash theme={null}
> $ prefect work-pool storage inspect "my-pool"
> $ prefect work-pool storage inspect "my-pool" --output json
> ```

## `prefect work-pool create`

```command theme={null}
prefect work-pool create [OPTIONS] NAME
```

> [!NOTE]
>
> Create a new work pool or update an existing one.

> **Arguments**
>
> **NAME** `string` *required*
>
> The name of the work pool.

> **Options**
>
> **--base-job-template**
>
> The path to a JSON file containing the base job template to use. If unspecified, Prefect will use the default base job template for the given worker type.
>
> **--paused**
>
> Whether or not to create the work pool in a paused state.
>
> **--type**
>
> The type of work pool to create.
>
> **--set-as-default**
>
> Whether or not to use the created work pool as the local default for deployment.
>
> **--provision-infrastructure**
>
> Whether or not to provision infrastructure for the work pool if supported for the given work pool type.
>
> **--overwrite**
>
> Whether or not to overwrite an existing work pool with the same name.

> [!NOTE]
>
> **Example:**
>
> ```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
> ```

## `prefect work-pool ls`

```command theme={null}
prefect work-pool ls [OPTIONS]
```

> [!NOTE]
>
> List work pools.

> **Options**
>
> **--verbose**
>
> Show additional information about work pools.
>
> **--output**
>
> Specify an output format. Currently supports: json

> [!NOTE]
>
> **Example:**
>
> ```bash theme={null}
> $ prefect work-pool ls
> ```

## `prefect work-pool inspect`

```command theme={null}
prefect work-pool inspect [OPTIONS] NAME
```

> [!NOTE]
>
> Inspect a work pool.

> **Arguments**
>
> **NAME** `string` *required*
>
> The name of the work pool to inspect.

> **Options**
>
> **--output**
>
> Specify an output format. Currently supports: json

> [!NOTE]
>
> **Example:**
>
> ```bash theme={null}
> $ prefect work-pool inspect "my-pool"
> $ prefect work-pool inspect "my-pool" --output json
> ```

## `prefect work-pool slots`

```command theme={null}
prefect work-pool slots [OPTIONS] NAME
```

> [!NOTE]
>
> Show concurrency slot utilization for a work pool.

> **Arguments**
>
> **NAME** `string` *required*
>
> The name of the work pool.

> **Options**
>
> **--output**
>
> Specify an output format. Currently supports: json

## `prefect work-pool pause`

```command theme={null}
prefect work-pool pause [OPTIONS] NAME
```

> [!NOTE]
>
> Pause a work pool.

> **Arguments**
>
> **NAME** `string` *required*
>
> The name of the work pool to pause.

> [!NOTE]
>
> **Example:**
>
> ```bash theme={null}
> $ prefect work-pool pause "my-pool"
> ```

## `prefect work-pool resume`

```command theme={null}
prefect work-pool resume [OPTIONS] NAME
```

> [!NOTE]
>
> Resume a work pool.

> **Arguments**
>
> **NAME** `string` *required*
>
> The name of the work pool to resume.

> [!NOTE]
>
> **Example:**
>
> ```bash theme={null}
> $ prefect work-pool resume "my-pool"
> ```

## `prefect work-pool update`

```command theme={null}
prefect work-pool update [OPTIONS] NAME
```

> [!NOTE]
>
> Update a work pool.

> **Arguments**
>
> **NAME** `string` *required*
>
> The name of the work pool to update.

> **Options**
>
> **--base-job-template**
>
> The path to a JSON file containing the base job template to use. If None, the base job template will not be modified.
>
> **--concurrency-limit**
>
> The concurrency limit for the work pool. If None, the concurrency limit will not be modified.
>
> **--description**
>
> The description for the work pool. If None, the description will not be modified.

> [!NOTE]
>
> **Example:**
>
> ```bash theme={null}
> $ prefect work-pool update "my-pool"
> ```

## `prefect work-pool provision-infrastructure`

```command theme={null}
prefect work-pool provision-infrastructure [OPTIONS] NAME
```

> [!NOTE]
>
> Provision infrastructure for a work pool.

> **Arguments**
>
> **NAME** `string` *required*
>
> The name of the work pool to provision infrastructure for.

> [!NOTE]
>
> **Example:**
>
> ```bash theme={null}
> $ prefect work-pool provision-infrastructure "my-pool"
> $ prefect work-pool provision-infra "my-pool"
> ```

## `prefect work-pool provision-infra`

```command theme={null}
prefect work-pool provision-infra [OPTIONS] NAME
```

> [!NOTE]
>
> Provision infrastructure for a work pool.

> **Arguments**
>
> **NAME** `string` *required*
>
> The name of the work pool to provision infrastructure for.

> [!NOTE]
>
> **Example:**
>
> ```bash theme={null}
> $ prefect work-pool provision-infrastructure "my-pool"
> $ prefect work-pool provision-infra "my-pool"
> ```

## `prefect work-pool delete`

```command theme={null}
prefect work-pool delete [OPTIONS] NAME
```

> [!NOTE]
>
> Delete a work pool.

> **Arguments**
>
> **NAME** `string` *required*
>
> The name of the work pool to delete.

> [!NOTE]
>
> **Example:**
>
> ```bash theme={null}
> $ prefect work-pool delete "my-pool"
> ```

## `prefect work-pool set-concurrency-limit`

```command theme={null}
prefect work-pool set-concurrency-limit [OPTIONS] NAME CONCURRENCY_LIMIT
```

> [!NOTE]
>
> Set the concurrency limit for a work pool.

> **Arguments**
>
> **NAME** `string` *required*
>
> The name of the work pool to update.
>
> **CONCURRENCY\_LIMIT** `string` *required*
>
> The new concurrency limit for the work pool.

> [!NOTE]
>
> **Example:**
>
> ```bash theme={null}
> $ prefect work-pool set-concurrency-limit "my-pool" 10
> ```

## `prefect work-pool clear-concurrency-limit`

```command theme={null}
prefect work-pool clear-concurrency-limit [OPTIONS] NAME
```

> [!NOTE]
>
> Clear the concurrency limit for a work pool.

> **Arguments**
>
> **NAME** `string` *required*
>
> The name of the work pool to update.

> [!NOTE]
>
> **Example:**
>
> ```bash theme={null}
> $ prefect work-pool clear-concurrency-limit "my-pool"
> ```

## `prefect work-pool get-default-base-job-template`

```command theme={null}
prefect work-pool get-default-base-job-template [OPTIONS]
```

> [!NOTE]
>
> Get the default base job template for a given work pool type.

> **Options**
>
> **--type**
>
> The type of work pool for which to get the default base job template.
>
> **--file**
>
> If set, write the output to a file.

> [!NOTE]
>
> **Example:**
>
> ```bash theme={null}
> $ prefect work-pool get-default-base-job-template --type kubernetes
> ```

## `prefect work-pool preview`

```command theme={null}
prefect work-pool preview [OPTIONS] [NAME]
```

> [!NOTE]
>
> Preview the work pool's scheduled work for all queues.

> **Arguments**
>
> **NAME** `string`
>
> The name or ID of the work pool to preview

> **Options**
>
> **--hours**
>
> The number of hours to look ahead; defaults to 1 hour
>
> **--output**
>
> Specify an output format. Currently supports: json

> [!NOTE]
>
> **Example:**
>
> ```bash theme={null}
> $ prefect work-pool preview "my-pool" --hours 24
> ```