Documentation IndexFetch the complete documentation index at: /llms.txtUse this file to discover all available pages before exploring further.
Fetch the complete documentation index at: /llms.txt
Use this file to discover all available pages before exploring further.
prefect.cli.automation
ls
ls()
inspect
inspect(name: Annotated[Optional[str], cyclopts.Parameter(show=False, help="An automation's name.")] = None)
$ prefect automation inspect "my-automation" $ prefect automation inspect --id "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa" $ prefect automation inspect "my-automation" --output json $ prefect automation inspect "my-automation" --output yaml
resume
resume(name: Annotated[Optional[str], cyclopts.Parameter(show=False, help="An automation's name.")] = None)
$ prefect automation resume "my-automation" $ prefect automation resume --id "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa"
pause
pause(name: Annotated[Optional[str], cyclopts.Parameter(show=False, help="An automation's name.")] = None)
$ prefect automation pause "my-automation" $ prefect automation pause --id "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa"
delete
delete(name: Annotated[Optional[str], cyclopts.Parameter(show=False, help="An automation's name.")] = None)
$ prefect automation delete "my-automation" $ prefect automation delete --id "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa" $ prefect automation delete --all
create
create()
$ prefect automation create --from-file automation.yaml $ prefect automation create -f automation.json $ prefect automation create --from-json '{"name": "my-automation", "trigger": {...}, "actions": [...]}' $ prefect automation create -j '[{"name": "auto1", ...}, {"name": "auto2", ...}]'
update
update()
$ prefect automation update --id "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa" --from-file automation.yaml $ prefect automation update --id "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa" -f automation.json $ prefect automation update --id "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa" --from-json '{"name": "updated-automation", "trigger": {...}, "actions": [...]}'
Was this page helpful?