Skip to main content

prefect work-pool

Manage work pools.

prefect work-pool storage

EXPERIMENTAL: Manage work pool storage.

prefect work-pool storage configure

EXPERIMENTAL: Configure work pool storage.

prefect work-pool storage configure s3

EXPERIMENTAL: Configure AWS S3 storage for a work pool.

Arguments

string
required
The name of the work pool to configure storage for.

Options

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

prefect work-pool storage configure gcs

EXPERIMENTAL: Configure Google Cloud storage for a work pool.

Arguments

string
required
The name of the work pool to configure storage for.

Options

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

prefect work-pool storage configure azure-blob-storage

EXPERIMENTAL: Configure Azure Blob Storage for a work pool.

Arguments

string
required
The name of the work pool to configure storage for.

Options

The name of the Azure Blob Storage container to use.
The name of the Azure Blob Storage credentials block to use.
Shared executable or path for upload and execution.
Append one argv token to the shared launcher. Repeat per token.
Replace the shared executable or path for upload only.
Append one upload-only argv token. Extends the shared launcher.
Replace the shared executable or path for execution only.
Append one execution-only argv token. Extends the shared launcher.
Example:

prefect work-pool storage inspect

EXPERIMENTAL: Inspect the storage configuration for a work pool.

Arguments

string
required
The name of the work pool to display storage configuration for.

Options

Specify an output format. Currently supports: json
Example:

prefect work-pool create

Create a new work pool or update an existing one.

Arguments

string
required
The name of the work pool.

Options

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.
Whether or not to create the work pool in a paused state.
The type of work pool to create.
Whether or not to use the created work pool as the local default for deployment.
Whether or not to provision infrastructure for the work pool if supported for the given work pool type.
Whether or not to overwrite an existing work pool with the same name.
Example:

prefect work-pool ls

List work pools.

Options

Show additional information about work pools.
Specify an output format. Currently supports: json
Example:

prefect work-pool inspect

Inspect a work pool.

Arguments

string
required
The name of the work pool to inspect.

Options

Specify an output format. Currently supports: json
Example:

prefect work-pool slots

Show concurrency slot utilization for a work pool.

Arguments

string
required
The name of the work pool.

Options

Specify an output format. Currently supports: json

prefect work-pool pause

Pause a work pool.

Arguments

string
required
The name of the work pool to pause.
Example:

prefect work-pool resume

Resume a work pool.

Arguments

string
required
The name of the work pool to resume.
Example:

prefect work-pool update

Update a work pool.

Arguments

string
required
The name of the work pool to update.

Options

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

prefect work-pool provision-infrastructure

Provision infrastructure for a work pool.

Arguments

string
required
The name of the work pool to provision infrastructure for.
Example:

prefect work-pool provision-infra

Provision infrastructure for a work pool.

Arguments

string
required
The name of the work pool to provision infrastructure for.
Example:

prefect work-pool delete

Delete a work pool.

Arguments

string
required
The name of the work pool to delete.
Example:

prefect work-pool set-concurrency-limit

Set the concurrency limit for a work pool.

Arguments

string
required
The name of the work pool to update.
string
required
The new concurrency limit for the work pool.
Example:

prefect work-pool clear-concurrency-limit

Clear the concurrency limit for a work pool.

Arguments

string
required
The name of the work pool to update.
Example:

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

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

Options

The type of work pool for which to get the default base job template.
If set, write the output to a file.
Example:

prefect work-pool preview

Preview the work pool’s scheduled work for all queues.

Arguments

string
The name or ID of the work pool to preview

Options

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