Skip to main content

​
prefect automation

prefect automation [OPTIONS] COMMAND [ARGS]...
Manage automations.

​
prefect automation ls

prefect automation ls [OPTIONS]
List all automations.

​
prefect automation inspect

prefect automation inspect [OPTIONS] [NAME]
Inspect an automation.Arguments:name: the name of the automation to inspectid: the id of the automation to inspectyaml: output as YAMLjson: output as JSONExamples:$ prefect automation inspect "my-automation"$ prefect automation inspect --id "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa"$ prefect automation inspect "my-automation" --yaml$ prefect automation inspect "my-automation" --output json $ prefect automation inspect "my-automation" --output yaml

Arguments

​
NAME
string
An automation’s name

Options

​
--id
An automation’s id
​
--yaml
Output as YAML
​
--json
Output as JSON
​
--output
Specify an output format. Currently supports: json, yaml

​
prefect automation resume

prefect automation resume [OPTIONS] [NAME]
Resume an automation.Arguments:name: the name of the automation to resumeid: the id of the automation to resumeExamples:$ prefect automation resume "my-automation"$ prefect automation resume --id "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa"

Arguments

​
NAME
string
An automation’s name

Options

​
--id
An automation’s id

​
prefect automation enable

prefect automation enable [OPTIONS] [NAME]
Resume an automation.Arguments:name: the name of the automation to resumeid: the id of the automation to resumeExamples:$ prefect automation resume "my-automation"$ prefect automation resume --id "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa"

Arguments

​
NAME
string
An automation’s name

Options

​
--id
An automation’s id

​
prefect automation pause

prefect automation pause [OPTIONS] [NAME]
Pause an automation.Arguments:name: the name of the automation to pauseid: the id of the automation to pauseExamples:$ prefect automation pause "my-automation"$ prefect automation pause --id "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa"

Arguments

​
NAME
string
An automation’s name

Options

​
--id
An automation’s id

​
prefect automation disable

prefect automation disable [OPTIONS] [NAME]
Pause an automation.Arguments:name: the name of the automation to pauseid: the id of the automation to pauseExamples:$ prefect automation pause "my-automation"$ prefect automation pause --id "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa"

Arguments

​
NAME
string
An automation’s name

Options

​
--id
An automation’s id

​
prefect automation delete

prefect automation delete [OPTIONS] [NAME]
Delete an automation.

Arguments

​
NAME
string
An automation’s name

Options

​
--id
An automation’s id
​
--all
Delete all automations
Example:$ prefect automation delete "my-automation" $ prefect automation delete --id "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa" $ prefect automation delete --all

​
prefect automation create

prefect automation create [OPTIONS]
Create one or more automations from a file or JSON string.

Options

​
--from-file
Path to YAML or JSON file containing automation(s)
​
--from-json
JSON string containing automation(s)
Example:$ 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", ...}]'
⌘I