prefect.events.actions

Classes

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

An Action that may be performed when an Automation is triggered

Methods:

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

describe_for_cli(self) -> str

A human-readable description of the action

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

model_validate_list(cls, obj: Any) -> list[Self]

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

reset_fields(self: Self) -> Self

Reset the fields of the model that are in the _reset_fields set.

Returns:

• A new instance of the model with the reset fields.

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

Do nothing when an Automation is triggered

Methods:

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

describe_for_cli(self) -> str

A human-readable description of the action

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

Base class for Actions that operate on Deployments and need to infer them from events

Methods:

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

describe_for_cli(self) -> str

A human-readable description of the action

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

selected_deployment_requires_id(self)

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

Runs the given deployment with the given parameters

Methods:

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

selected_deployment_requires_id(self)

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

Pauses the given Deployment

Methods:

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

selected_deployment_requires_id(self)

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

Resumes the given Deployment

Methods:

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

selected_deployment_requires_id(self)

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

Changes the state of a flow run associated with the trigger

Methods:

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

describe_for_cli(self) -> str

A human-readable description of the action

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

Cancels a flow run associated with the trigger

Methods:

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

describe_for_cli(self) -> str

A human-readable description of the action

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

Resumes a flow run associated with the trigger

Methods:

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

describe_for_cli(self) -> str

A human-readable description of the action

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

Suspends a flow run associated with the trigger

Methods:

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

describe_for_cli(self) -> str

A human-readable description of the action

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

Call a webhook when an Automation is triggered.

Methods:

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

describe_for_cli(self) -> str

A human-readable description of the action

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

Send a notification when an Automation is triggered

Methods:

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

describe_for_cli(self) -> str

A human-readable description of the action

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

Base class for Actions that operate on Work Pools and need to infer them from events

Methods:

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

describe_for_cli(self) -> str

A human-readable description of the action

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

Pauses a Work Pool

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

Resumes a Work Pool

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

Base class for Actions that operate on Work Queues and need to infer them from events

Methods:

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

describe_for_cli(self) -> str

A human-readable description of the action

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

selected_work_queue_requires_id(self) -> Self

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

Pauses a Work Queue

Methods:

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

selected_work_queue_requires_id(self) -> Self

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

Resumes a Work Queue

Methods:

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

selected_work_queue_requires_id(self) -> Self

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

Base class for Actions that operate on Automations and need to infer them from events

Methods:

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

describe_for_cli(self) -> str

A human-readable description of the action

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

selected_automation_requires_id(self) -> Self

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

Pauses a Work Queue

Methods:

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

selected_automation_requires_id(self) -> Self

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

Resumes a Work Queue

Methods:

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

selected_automation_requires_id(self) -> Self

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

Declares an incident for the triggering event. Only available on Prefect Cloud

Methods:

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

describe_for_cli(self) -> str

A human-readable description of the action