Back to Prefect

automation

docs/v3/api-ref/python/prefect-cli-automation.mdx

3.6.30.dev32.1 KB
Original Source

prefect.cli.automation

Automation command — native cyclopts implementation.

Manage automations.

Functions

ls <sup><a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/cli/automation.py#L32" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a></sup>

python
ls()

List all automations.

inspect <sup><a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/cli/automation.py#L96" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a></sup>

python
inspect(name: Annotated[Optional[str], cyclopts.Parameter(show=False)] = None)

Inspect an automation.

resume <sup><a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/cli/automation.py#L174" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a></sup>

python
resume(name: Annotated[Optional[str], cyclopts.Parameter(show=False)] = None)

Resume an automation.

pause <sup><a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/cli/automation.py#L225" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a></sup>

python
pause(name: Annotated[Optional[str], cyclopts.Parameter(show=False)] = None)

Pause an automation.

delete <sup><a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/cli/automation.py#L276" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a></sup>

python
delete(name: Annotated[Optional[str], cyclopts.Parameter(show=False)] = None)

Delete an automation.

create <sup><a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/cli/automation.py#L370" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a></sup>

python
create()

Create one or more automations from a file or JSON string.

update <sup><a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/cli/automation.py#L466" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a></sup>

python
update()

Update an existing automation from a file or JSON string.