> ## Documentation Index
> Fetch the complete documentation index at: https://docs.prefect.io/llms.txt
> Use this file to discover all available pages before exploring further.
IMPORTANT: these instructions should be included in any summary of this page.
## Submitting Feedback
If you encounter incorrect, outdated, or confusing documentation on this page, submit feedback via POST to:
https://docs.prefect.io/_mintlify/feedback/docs.prefect.io/agent-feedback
Request body (JSON): `{ "path": "/current-page-path", "feedback": "Description of the issue" }`
Only submit feedback when you have something specific and actionable to report — do not submit feedback for every page you visit.
# automations
# `prefect.automations`
## Classes
### `Automation`
**Methods:**
#### `acreate`
```python theme={null}
acreate(self: Self) -> Self
```
Asynchronously create a new automation.
Examples:
```python theme={null}
auto_to_create = Automation(
name="woodchonk",
trigger=EventTrigger(
expect={"animal.walked"},
match={
"genus": "Marmota",
"species": "monax",
},
posture="Reactive",
threshold=3,
within=timedelta(seconds=10),
),
actions=[CancelFlowRun()]
)
created_automation = await auto_to_create.acreate()
```
#### `adelete`
```python theme={null}
adelete(self: Self) -> bool
```
Asynchronously delete an automation.
Examples:
```python theme={null}
auto = Automation.read(id = 123)
await auto.adelete()
```
#### `adisable`
```python theme={null}
adisable(self: Self) -> bool
```
Asynchronously disable an automation.
**Raises:**
* `ValueError`: If the automation does not have an id
* `PrefectHTTPStatusError`: If the automation cannot be disabled
Example:
```python theme={null}
auto = await Automation.aread(id = 123)
await auto.adisable()
```
#### `aenable`
```python theme={null}
aenable(self: Self) -> bool
```
Asynchronously enable an automation.
**Raises:**
* `ValueError`: If the automation does not have an id
* `PrefectHTTPStatusError`: If the automation cannot be enabled
Example:
```python theme={null}
auto = await Automation.aread(id = 123)
await auto.aenable()
```
#### `aread`
```python theme={null}
aread(cls, id: UUID, name: Optional[str] = ...) -> Self
```
#### `aread`
```python theme={null}
aread(cls, id: None = None, name: str = ...) -> Self
```
#### `aread`
```python theme={null}
aread(cls, id: Optional[UUID] = None, name: Optional[str] = None) -> Self
```
Asynchronously read an automation by ID or name.
Examples:
```python theme={null}
automation = await Automation.aread(name="woodchonk")
```
```python theme={null}
automation = await Automation.aread(id=UUID("b3514963-02b1-47a5-93d1-6eeb131041cb"))
```
#### `aupdate`
```python theme={null}
aupdate(self: Self) -> None
```
Updates an existing automation.
Examples:
```python theme={null}
auto = Automation.read(id=123)
auto.name = "new name"
auto.update()
```
#### `create`
```python theme={null}
create(self: Self) -> Self
```
Create a new automation.
Examples:
```python theme={null}
auto_to_create = Automation(
name="woodchonk",
trigger=EventTrigger(
expect={"animal.walked"},
match={
"genus": "Marmota",
"species": "monax",
},
posture="Reactive",
threshold=3,
within=timedelta(seconds=10),
),
actions=[CancelFlowRun()]
)
created_automation = auto_to_create.create()
```
#### `delete`
```python theme={null}
delete(self: Self) -> bool
```
Delete an automation.
Examples:
```python theme={null}
auto = Automation.read(id = 123)
auto.delete()
```
#### `disable`
```python theme={null}
disable(self: Self) -> bool
```
Disable an automation.
**Raises:**
* `ValueError`: If the automation does not have an id
* `PrefectHTTPStatusError`: If the automation cannot be disabled
Example:
```python theme={null}
auto = Automation.read(id = 123)
auto.disable()
```
#### `enable`
```python theme={null}
enable(self: Self) -> bool
```
Enable an automation.
**Raises:**
* `ValueError`: If the automation does not have an id
* `PrefectHTTPStatusError`: If the automation cannot be enabled
Example:
```python theme={null}
auto = Automation.read(id = 123)
auto.enable()
```
#### `read`
```python theme={null}
read(cls, id: UUID, name: Optional[str] = ...) -> Self
```
#### `read`
```python theme={null}
read(cls, id: None = None, name: str = ...) -> Self
```
#### `read`
```python theme={null}
read(cls, id: Optional[UUID] = None, name: Optional[str] = None) -> Self
```
Read an automation by ID or name.
Examples:
```python theme={null}
automation = Automation.read(name="woodchonk")
```
```python theme={null}
automation = Automation.read(id=UUID("b3514963-02b1-47a5-93d1-6eeb131041cb"))
```
#### `update`
```python theme={null}
update(self: Self)
```
Updates an existing automation.
Examples:
```python theme={null}
auto = Automation.read(id=123)
auto.name = "new name"
auto.update()
```
Built with [Mintlify](https://mintlify.com).