prefect.automations

Classes

Automation ^{<a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/automations.py#L78" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a>}

Methods:

acreate ^{<a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/automations.py#L81" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a>}

acreate(self: Self) -> Self

Asynchronously create a new automation.

Examples:

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 ^{<a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/automations.py#L273" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a>}

adelete(self: Self) -> bool

Asynchronously delete an automation.

Examples:

auto = Automation.read(id = 123)
await auto.adelete()

adisable ^{<a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/automations.py#L320" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a>}

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:

auto = await Automation.aread(id = 123)
await auto.adisable()

aenable ^{<a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/automations.py#L374" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a>}

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:

auto = await Automation.aread(id = 123)
await auto.aenable()

aread ^{<a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/automations.py#L182" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a>}

aread(cls, id: UUID, name: Optional[str] = ...) -> Self

aread ^{<a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/automations.py#L186" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a>}

aread(cls, id: None = None, name: str = ...) -> Self

aread ^{<a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/automations.py#L189" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a>}

aread(cls, id: Optional[UUID] = None, name: Optional[str] = None) -> Self

Asynchronously read an automation by ID or name.

Examples:

automation = await Automation.aread(name="woodchonk")

automation = await Automation.aread(id=UUID("b3514963-02b1-47a5-93d1-6eeb131041cb"))

aupdate ^{<a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/automations.py#L140" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a>}

aupdate(self: Self) -> None

Updates an existing automation.

Examples:

auto = Automation.read(id=123)
auto.name = "new name"
auto.update()

create ^{<a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/automations.py#L111" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a>}

create(self: Self) -> Self

Create a new automation.

Examples:

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 ^{<a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/automations.py#L297" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a>}

delete(self: Self) -> bool

Delete an automation.

Examples:

auto = Automation.read(id = 123)
auto.delete()

disable ^{<a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/automations.py#L347" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a>}

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:

auto = Automation.read(id = 123)
auto.disable()

enable ^{<a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/automations.py#L401" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a>}

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:

auto = Automation.read(id = 123)
auto.enable()

read ^{<a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/automations.py#L228" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a>}

read(cls, id: UUID, name: Optional[str] = ...) -> Self

read ^{<a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/automations.py#L232" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a>}

read(cls, id: None = None, name: str = ...) -> Self

read ^{<a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/automations.py#L236" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a>}

read(cls, id: Optional[UUID] = None, name: Optional[str] = None) -> Self

Read an automation by ID or name.

Examples:

automation = Automation.read(name="woodchonk")

automation = Automation.read(id=UUID("b3514963-02b1-47a5-93d1-6eeb131041cb"))

update ^{<a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/automations.py#L160" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a>}

update(self: Self)

Updates an existing automation.

Examples:

auto = Automation.read(id=123)
auto.name = "new name"
auto.update()