automation

prefect.cli.automation

Automation command — native cyclopts implementation.

Manage automations.

Functions

ls

ls()

List all automations.

inspect

inspect(name: Annotated[Optional[str], cyclopts.Parameter(show=False, help="An automation's name.")] = None)

Inspect an automation.

Examples:

$ 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)

Resume an automation.

Examples:

$ 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)

Pause an automation.

Examples:

$ 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)

Delete an automation.

Examples:

$ prefect automation delete "my-automation"
$ prefect automation delete --id "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa"
$ prefect automation delete --all

create

create()

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

Examples:

$ 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()

Update an existing automation from a file or JSON string.

Examples:

$ 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": [...]}'