work_pool

prefect.cli.work_pool

Work pool command — native cyclopts implementation.

Manage work pools.

Functions

create

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

Create a new work pool or update an existing one.

ls

ls()

List work pools.

inspect

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

Inspect a work pool.

pause

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

Pause a work pool.

resume

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

Resume a work pool.

update

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

Update a work pool.

provision_infrastructure_cmd

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

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

Delete a work pool.

set_concurrency_limit

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

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

get_default_base_job_template()

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

preview

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

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

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

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

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.