block

prefect.cli.block

Block command — native cyclopts implementation.

Manage blocks and block types.

Functions

register

register()

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:

$ prefect block register -f my_blocks.py
$ prefect block register -m prefect_aws.credentials

block_ls

block_ls()

View all configured blocks.

block_delete

block_delete(slug: Annotated[Optional[str], cyclopts.Parameter(help="A block slug. Formatted as '<BLOCK_TYPE_SLUG>/<BLOCK_NAME>'")] = None)

Delete a configured block.

block_create

block_create(block_type_slug: Annotated[str, cyclopts.Parameter(help='A block type slug. View available types with: prefect block type ls', show_default=False)])

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

block_inspect

block_inspect(slug: Annotated[Optional[str], cyclopts.Parameter(help='A Block slug: <BLOCK_TYPE_SLUG>/<BLOCK_NAME>')] = None)

Displays details about a configured block.

list_types

list_types()

List all block types.

blocktype_inspect

blocktype_inspect(slug: Annotated[str, cyclopts.Parameter(help='A block type slug')])

Display details about a block type.

blocktype_delete

blocktype_delete(slug: Annotated[str, cyclopts.Parameter(help='A Block type slug')])

Delete an unprotected Block Type.