prefect.cli.work_pool

Work pool command — native cyclopts implementation.

Manage work pools.

Functions

create ^{<a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/cli/work_pool.py#L297" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a>}

create(name: Annotated[str, cyclopts.Parameter(help='The name of the work pool.')])

Create a new work pool or update an existing one.

Examples:

# 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 ^{<a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/cli/work_pool.py#L518" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a>}

ls()

List work pools.

Examples:

$ prefect work-pool ls

inspect ^{<a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/cli/work_pool.py#L603" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a>}

inspect(name: Annotated[str, cyclopts.Parameter(help='The name of the work pool to inspect.')])

Inspect a work pool.

Examples:

$ prefect work-pool inspect "my-pool"
$ prefect work-pool inspect "my-pool" --output json

slots ^{<a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/cli/work_pool.py#L648" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a>}

slots(name: Annotated[str, cyclopts.Parameter(help='The name of the work pool.')])

Show concurrency slot utilization for a work pool.

pause ^{<a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/cli/work_pool.py#L757" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a>}

pause(name: Annotated[str, cyclopts.Parameter(help='The name of the work pool to pause.')])

Pause a work pool.

Examples:

$ prefect work-pool pause "my-pool"

resume ^{<a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/cli/work_pool.py#L787" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a>}

resume(name: Annotated[str, cyclopts.Parameter(help='The name of the work pool to resume.')])

Resume a work pool.

Examples:

$ prefect work-pool resume "my-pool"

update ^{<a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/cli/work_pool.py#L817" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a>}

update(name: Annotated[str, cyclopts.Parameter(help='The name of the work pool to update.')])

Update a work pool.

Examples:

$ prefect work-pool update "my-pool"

provision_infrastructure_cmd ^{<a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/cli/work_pool.py#L887" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a>}

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:

$ prefect work-pool provision-infrastructure "my-pool"
$ prefect work-pool provision-infra "my-pool"

delete ^{<a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/cli/work_pool.py#L960" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a>}

delete(name: Annotated[str, cyclopts.Parameter(help='The name of the work pool to delete.')])

Delete a work pool.

Examples:

$ prefect work-pool delete "my-pool"

set_concurrency_limit ^{<a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/cli/work_pool.py#L994" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a>}

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:

$ prefect work-pool set-concurrency-limit "my-pool" 10

clear_concurrency_limit ^{<a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/cli/work_pool.py#L1029" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a>}

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:

$ prefect work-pool clear-concurrency-limit "my-pool"

get_default_base_job_template ^{<a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/cli/work_pool.py#L1059" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a>}

get_default_base_job_template()

Get the default base job template for a given work pool type.

Examples:

$ prefect work-pool get-default-base-job-template --type kubernetes

preview ^{<a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/cli/work_pool.py#L1109" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a>}

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:

$ prefect work-pool preview "my-pool" --hours 24

storage_inspect ^{<a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/cli/work_pool.py#L1240" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a>}

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:

$ prefect work-pool storage inspect "my-pool"
$ prefect work-pool storage inspect "my-pool" --output json

storage_configure_s3 ^{<a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/cli/work_pool.py#L1397" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a>}

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:

$ prefect work-pool storage configure s3 "my-pool" --bucket my-bucket --aws-credentials-block-name my-credentials

storage_configure_gcs ^{<a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/cli/work_pool.py#L1539" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a>}

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:

$ prefect work-pool storage configure gcs "my-pool" --bucket my-bucket --gcp-credentials-block-name my-credentials

storage_configure_azure_blob_storage ^{<a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/cli/work_pool.py#L1687" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a>}

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:

$ prefect work-pool storage configure azure-blob-storage "my-pool" --container my-container --azure-blob-storage-credentials-block-name my-credentials