`prefect.events.actions`

Classes

`Action`

An Action that may be performed when an Automation is triggered Methods:

`describe_for_cli`

describe_for_cli(self) -> str

A human-readable description of the action

`model_validate_list`

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

`reset_fields`

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`

Do nothing when an Automation is triggered Methods:

`describe_for_cli`

describe_for_cli(self) -> str

A human-readable description of the action

`DeploymentAction`

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

`describe_for_cli`

describe_for_cli(self) -> str

A human-readable description of the action

`selected_deployment_requires_id`

selected_deployment_requires_id(self)

`RunDeployment`

Runs the given deployment with the given parameters Methods:

`selected_deployment_requires_id`

selected_deployment_requires_id(self)

`PauseDeployment`

Pauses the given Deployment Methods:

`selected_deployment_requires_id`

selected_deployment_requires_id(self)

`ResumeDeployment`

Resumes the given Deployment Methods:

`selected_deployment_requires_id`

selected_deployment_requires_id(self)

`ChangeFlowRunState`

Changes the state of a flow run associated with the trigger Methods:

`describe_for_cli`

describe_for_cli(self) -> str

A human-readable description of the action

`CancelFlowRun`

Cancels a flow run associated with the trigger Methods:

`describe_for_cli`

describe_for_cli(self) -> str

A human-readable description of the action

`DeleteFlowRun`

Deletes a flow run associated with the trigger Methods:

`describe_for_cli`

describe_for_cli(self) -> str

A human-readable description of the action

`ResumeFlowRun`

Resumes a flow run associated with the trigger Methods:

`describe_for_cli`

describe_for_cli(self) -> str

A human-readable description of the action

`SuspendFlowRun`

Suspends a flow run associated with the trigger Methods:

`describe_for_cli`

describe_for_cli(self) -> str

A human-readable description of the action

`CallWebhook`

Call a webhook when an Automation is triggered. Methods:

`describe_for_cli`

describe_for_cli(self) -> str

A human-readable description of the action

`SendNotification`

Send a notification when an Automation is triggered Methods:

`describe_for_cli`

describe_for_cli(self) -> str

A human-readable description of the action

`WorkPoolAction`

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

`describe_for_cli`

describe_for_cli(self) -> str

A human-readable description of the action

`PauseWorkPool`

Pauses a Work Pool

`ResumeWorkPool`

Resumes a Work Pool

`WorkQueueAction`

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

`describe_for_cli`

describe_for_cli(self) -> str

A human-readable description of the action

`selected_work_queue_requires_id`

selected_work_queue_requires_id(self) -> Self

`PauseWorkQueue`

Pauses a Work Queue Methods:

`selected_work_queue_requires_id`

selected_work_queue_requires_id(self) -> Self

`ResumeWorkQueue`

Resumes a Work Queue Methods:

`selected_work_queue_requires_id`

selected_work_queue_requires_id(self) -> Self

`AutomationAction`

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

`describe_for_cli`

describe_for_cli(self) -> str

A human-readable description of the action

`selected_automation_requires_id`

selected_automation_requires_id(self) -> Self

`PauseAutomation`

Pauses a Work Queue Methods:

`selected_automation_requires_id`

selected_automation_requires_id(self) -> Self

`ResumeAutomation`

Resumes a Work Queue Methods:

`selected_automation_requires_id`

selected_automation_requires_id(self) -> Self

`DeclareIncident`

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

`describe_for_cli`

describe_for_cli(self) -> str

A human-readable description of the action

`UnknownAction`

An action whose type this version of Prefect does not recognize. Prefect Cloud can add action types before a client release knows about them. Reading an automation that uses one of these types returns this model instead of failing. The model keeps every field of the action, so updating the automation sends the action back unchanged. Methods:

`describe_for_cli`

describe_for_cli(self) -> str

A human-readable description of the action

​prefect.events.actions

​Classes

​Action

​describe_for_cli

​model_validate_list

​reset_fields

​DoNothing

​describe_for_cli

​DeploymentAction

​describe_for_cli

​selected_deployment_requires_id

​RunDeployment

​selected_deployment_requires_id

​PauseDeployment

​selected_deployment_requires_id

​ResumeDeployment

​selected_deployment_requires_id

​ChangeFlowRunState

​describe_for_cli

​CancelFlowRun

​describe_for_cli

​DeleteFlowRun

​describe_for_cli

​ResumeFlowRun

​describe_for_cli

​SuspendFlowRun

​describe_for_cli

​CallWebhook

​describe_for_cli

​SendNotification

​describe_for_cli

​WorkPoolAction

​describe_for_cli

​PauseWorkPool

​ResumeWorkPool

​WorkQueueAction

​describe_for_cli

​selected_work_queue_requires_id

​PauseWorkQueue

​selected_work_queue_requires_id

​ResumeWorkQueue

​selected_work_queue_requires_id

​AutomationAction

​describe_for_cli

​selected_automation_requires_id

​PauseAutomation

​selected_automation_requires_id

​ResumeAutomation

​selected_automation_requires_id

​DeclareIncident

​describe_for_cli

​UnknownAction

​describe_for_cli

`prefect.events.actions`

Classes

`Action`

`describe_for_cli`

`model_validate_list`

`reset_fields`

`DoNothing`

`describe_for_cli`

`DeploymentAction`

`describe_for_cli`

`selected_deployment_requires_id`

`RunDeployment`

`selected_deployment_requires_id`

`PauseDeployment`

`selected_deployment_requires_id`

`ResumeDeployment`

`selected_deployment_requires_id`

`ChangeFlowRunState`

`describe_for_cli`

`CancelFlowRun`

`describe_for_cli`

`DeleteFlowRun`

`describe_for_cli`

`ResumeFlowRun`

`describe_for_cli`

`SuspendFlowRun`

`describe_for_cli`

`CallWebhook`

`describe_for_cli`

`SendNotification`

`describe_for_cli`

`WorkPoolAction`

`describe_for_cli`

`PauseWorkPool`

`ResumeWorkPool`

`WorkQueueAction`

`describe_for_cli`

`selected_work_queue_requires_id`

`PauseWorkQueue`

`selected_work_queue_requires_id`

`ResumeWorkQueue`

`selected_work_queue_requires_id`

`AutomationAction`

`describe_for_cli`

`selected_automation_requires_id`

`PauseAutomation`

`selected_automation_requires_id`

`ResumeAutomation`

`selected_automation_requires_id`

`DeclareIncident`

`describe_for_cli`

`UnknownAction`

`describe_for_cli`