prefect block

prefect block [OPTIONS] COMMAND [ARGS]...

Manage blocks.

prefect block register

prefect block register [OPTIONS]

Register blocks types within a module or file.

This makes the blocks available for configuration via the UI. If a block type has already been registered, its registration will be updated to match the block’s current definition.

 Examples:  Register block types in a Python module: $ prefect block register -m prefect_aws.credentials  Register block types in a .py file: $ prefect block register -f my_blocks.py

Options

--module

Python module containing block types to be registered

--file

Path to .py file containing block types to be registered

prefect block ls

prefect block ls [OPTIONS]

View all configured blocks.

Options

--output

Specify an output format. Currently supports: json

prefect block delete

prefect block delete [OPTIONS] [SLUG]

Delete a configured block.

Arguments

SLUG · string

A block slug. Formatted as ‘<BLOCK_TYPE_SLUG>/<BLOCK_NAME>’

Options

--id

A block id.

prefect block create

prefect block create [OPTIONS] BLOCK_TYPE_SLUG

Generate a link to the Prefect UI to create a block.

Arguments

BLOCK_TYPE_SLUG · string · required

A block type slug. View available types with: prefect block type ls [required]

prefect block inspect

prefect block inspect [OPTIONS] [SLUG]

Displays details about a configured block.

Arguments

SLUG · string

A Block slug: <BLOCK_TYPE_SLUG>/<BLOCK_NAME>

Options

--id

A Block id to search for if no slug is given

prefect block types

prefect block types [OPTIONS] COMMAND [ARGS]...

Inspect and delete block types.

prefect block types ls

prefect block types ls [OPTIONS]

List all block types.

Options

--output

Specify an output format. Currently supports: json

prefect block types inspect

prefect block types inspect [OPTIONS] SLUG

Display details about a block type.

Arguments

SLUG · string · required

A block type slug [required]

prefect block types delete

prefect block types delete [OPTIONS] SLUG

Delete an unprotected Block Type.

Arguments

SLUG · string · required

A Block type slug [required]

prefect block type

prefect block type [OPTIONS] COMMAND [ARGS]...

Inspect and delete block types.

prefect block type ls

prefect block type ls [OPTIONS]

List all block types.

Options

--output

Specify an output format. Currently supports: json

prefect block type inspect

prefect block type inspect [OPTIONS] SLUG

Display details about a block type.

Arguments

SLUG · string · required

A block type slug [required]

prefect block type delete

prefect block type delete [OPTIONS] SLUG

Delete an unprotected Block Type.

Arguments

SLUG · string · required

A Block type slug [required]