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.

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

ls()

List work pools.

inspect ^{<a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/cli/work_pool.py#L584" 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.

slots ^{<a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/cli/work_pool.py#L622" 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#L731" 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.

resume ^{<a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/cli/work_pool.py#L755" 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.

update ^{<a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/cli/work_pool.py#L779" 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.

provision_infrastructure_cmd ^{<a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/cli/work_pool.py#L843" 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.

delete ^{<a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/cli/work_pool.py#L909" 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.

set_concurrency_limit ^{<a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/cli/work_pool.py#L937" 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.

clear_concurrency_limit ^{<a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/cli/work_pool.py#L966" 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.

get_default_base_job_template ^{<a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/cli/work_pool.py#L990" 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.

preview ^{<a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/cli/work_pool.py#L1034" 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.

storage_inspect ^{<a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/cli/work_pool.py#L1159" 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.

storage_configure_s3 ^{<a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/cli/work_pool.py#L1309" 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.

storage_configure_gcs ^{<a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/cli/work_pool.py#L1443" 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.

storage_configure_azure_blob_storage ^{<a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/cli/work_pool.py#L1583" 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.