prefect.server.events.actions

The actions consumer watches for actions that have been triggered by Automations and carries them out. Also includes the various concrete subtypes of Actions

Functions

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

record_action_happening(id: UUID) -> None

Record that an action has happened, with an expiration of an hour.

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

action_has_already_happened(id: UUID) -> bool

Check if the action has already happened

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

consumer() -> AsyncGenerator[MessageHandler, None]

Classes

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

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

An Action that may be performed when an Automation is triggered

Methods:

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

act(self, triggered_action: 'TriggeredAction') -> None

Perform the requested Action

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

fail(self, triggered_action: 'TriggeredAction', reason: str) -> None

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

logging_context(self, triggered_action: 'TriggeredAction') -> Dict[str, Any]

Common logging context for all actions

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.

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

succeed(self, triggered_action: 'TriggeredAction') -> None

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

Do nothing when an Automation is triggered

Methods:

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

act(self, triggered_action: 'TriggeredAction') -> None

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

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

Methods:

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

act(self, triggered_action: 'TriggeredAction') -> None

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

create_event(self, triggered_action: 'TriggeredAction') -> 'Event'

Create an event from the TriggeredAction

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

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

Base class for Actions that require data from an external source such as the Orchestration API

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

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

events_api_client(self, triggered_action: 'TriggeredAction') -> PrefectServerEventsAPIClient

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

orchestration_client(self, triggered_action: 'TriggeredAction') -> 'OrchestrationClient'

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

reason_from_response(self, response: Response) -> str

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

Base class for Actions that use Jinja templates supplied by the user and are rendered with a context containing data from the triggered action, and the orchestration API.

Methods:

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

events_api_client(self, triggered_action: 'TriggeredAction') -> PrefectServerEventsAPIClient

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

instantiate_object(self, model: Type[PrefectBaseModel], data: Dict[str, Any], triggered_action: 'TriggeredAction', resource: Optional['Resource'] = None) -> PrefectBaseModel

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

orchestration_client(self, triggered_action: 'TriggeredAction') -> 'OrchestrationClient'

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

reason_from_response(self, response: Response) -> str

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

templates_in_dictionary(cls, dict_: dict[Any, Any | dict[Any, Any]]) -> list[tuple[dict[Any, Any], dict[Any, str]]]

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

validate_template(cls, template: str, field_name: str) -> str

DeploymentAction ^{<a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/server/events/actions.py#L700" 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:

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

deployment_id_to_use(self, triggered_action: 'TriggeredAction') -> UUID

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/server/events/actions.py#L719" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a>}

selected_deployment_requires_id(self) -> Self

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

Executes a command against a matching deployment

Methods:

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

act(self, triggered_action: 'TriggeredAction') -> None

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

command(self, orchestration: 'OrchestrationClient', deployment_id: UUID, triggered_action: 'TriggeredAction') -> Response

Execute the deployment command

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

events_api_client(self, triggered_action: 'TriggeredAction') -> PrefectServerEventsAPIClient

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

orchestration_client(self, triggered_action: 'TriggeredAction') -> 'OrchestrationClient'

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

reason_from_response(self, response: Response) -> str

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/server/events/actions.py#L789" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a>}

Runs the given deployment with the given parameters

Methods:

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

act(self, triggered_action: 'TriggeredAction') -> None

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

command(self, orchestration: 'OrchestrationClient', deployment_id: UUID, triggered_action: 'TriggeredAction') -> Response

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

command(self, orchestration: 'OrchestrationClient', deployment_id: UUID, triggered_action: 'TriggeredAction') -> Response

Execute the deployment command

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

instantiate_object(self, model: Type[PrefectBaseModel], data: Dict[str, Any], triggered_action: 'TriggeredAction', resource: Optional['Resource'] = None) -> PrefectBaseModel

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

render_parameters(self, triggered_action: 'TriggeredAction') -> Dict[str, Any]

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

templates_in_dictionary(cls, dict_: dict[Any, Any | dict[Any, Any]]) -> list[tuple[dict[Any, Any], dict[Any, str]]]

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

validate_parameters(cls, value: dict[str, Any] | None) -> dict[str, Any] | None

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

validate_template(cls, template: str, field_name: str) -> str

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

Pauses the given Deployment

Methods:

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

act(self, triggered_action: 'TriggeredAction') -> None

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

command(self, orchestration: 'OrchestrationClient', deployment_id: UUID, triggered_action: 'TriggeredAction') -> Response

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

command(self, orchestration: 'OrchestrationClient', deployment_id: UUID, triggered_action: 'TriggeredAction') -> Response

Execute the deployment command

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

Resumes the given Deployment

Methods:

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

act(self, triggered_action: 'TriggeredAction') -> None

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

command(self, orchestration: 'OrchestrationClient', deployment_id: UUID, triggered_action: 'TriggeredAction') -> Response

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

command(self, orchestration: 'OrchestrationClient', deployment_id: UUID, triggered_action: 'TriggeredAction') -> Response

Execute the deployment command

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

An action that operates on a flow run

Methods:

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

events_api_client(self, triggered_action: 'TriggeredAction') -> PrefectServerEventsAPIClient

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

flow_run(self, triggered_action: 'TriggeredAction') -> UUID

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

orchestration_client(self, triggered_action: 'TriggeredAction') -> 'OrchestrationClient'

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

reason_from_response(self, response: Response) -> str

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

Changes the state of a flow run associated with the trigger

Methods:

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

act(self, triggered_action: 'TriggeredAction') -> None

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

flow_run(self, triggered_action: 'TriggeredAction') -> UUID

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

new_state(self, triggered_action: 'TriggeredAction') -> StateCreate

Return the new state for the flow run

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

Changes the state of a flow run associated with the trigger

Methods:

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

act(self, triggered_action: 'TriggeredAction') -> None

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

new_state(self, triggered_action: 'TriggeredAction') -> StateCreate

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

new_state(self, triggered_action: 'TriggeredAction') -> StateCreate

Return the new state for the flow run

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

Cancels a flow run associated with the trigger

Methods:

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

act(self, triggered_action: 'TriggeredAction') -> None

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

new_state(self, triggered_action: 'TriggeredAction') -> StateCreate

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

new_state(self, triggered_action: 'TriggeredAction') -> StateCreate

Return the new state for the flow run

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

Suspends a flow run associated with the trigger

Methods:

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

act(self, triggered_action: 'TriggeredAction') -> None

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

new_state(self, triggered_action: 'TriggeredAction') -> StateCreate

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

new_state(self, triggered_action: 'TriggeredAction') -> StateCreate

Return the new state for the flow run

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

Resumes a paused or suspended flow run associated with the trigger

Methods:

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

act(self, triggered_action: 'TriggeredAction') -> None

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

flow_run(self, triggered_action: 'TriggeredAction') -> UUID

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

Call a webhook when an Automation is triggered.

Methods:

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

act(self, triggered_action: 'TriggeredAction') -> None

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

ensure_payload_is_a_string(cls, value: Union[str, Dict[str, Any], None]) -> Optional[str]

Temporary measure while we migrate payloads from being a dictionary to a string template. This covers both reading from the database where values may currently be a dictionary, as well as the API, where older versions of the frontend may be sending a JSON object with the single "message" key.

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

instantiate_object(self, model: Type[PrefectBaseModel], data: Dict[str, Any], triggered_action: 'TriggeredAction', resource: Optional['Resource'] = None) -> PrefectBaseModel

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

templates_in_dictionary(cls, dict_: dict[Any, Any | dict[Any, Any]]) -> list[tuple[dict[Any, Any], dict[Any, str]]]

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

validate_payload_templates(cls, value: Optional[str]) -> Optional[str]

Validate user-provided payload template.

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

validate_template(cls, template: str, field_name: str) -> str

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

Send a notification when an Automation is triggered

Methods:

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

act(self, triggered_action: 'TriggeredAction') -> None

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

instantiate_object(self, model: Type[PrefectBaseModel], data: Dict[str, Any], triggered_action: 'TriggeredAction', resource: Optional['Resource'] = None) -> PrefectBaseModel

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

is_valid_template(cls, value: str, info: ValidationInfo) -> str

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

render(self, triggered_action: 'TriggeredAction') -> List[str]

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

templates_in_dictionary(cls, dict_: dict[Any, Any | dict[Any, Any]]) -> list[tuple[dict[Any, Any], dict[Any, str]]]

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

validate_template(cls, template: str, field_name: str) -> str

WorkPoolAction ^{<a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/server/events/actions.py#L1417" 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

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

selected_work_pool_requires_id(self) -> Self

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

work_pool_id_to_use(self, triggered_action: 'TriggeredAction') -> UUID

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

Methods:

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

act(self, triggered_action: 'TriggeredAction') -> None

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

command(self, orchestration: 'OrchestrationClient', work_pool: WorkPool, triggered_action: 'TriggeredAction') -> Response

Issue the command to the Work Pool

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

events_api_client(self, triggered_action: 'TriggeredAction') -> PrefectServerEventsAPIClient

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

orchestration_client(self, triggered_action: 'TriggeredAction') -> 'OrchestrationClient'

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

reason_from_response(self, response: Response) -> str

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

target_work_pool(self, triggered_action: 'TriggeredAction') -> WorkPool

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

Pauses a Work Pool

Methods:

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

act(self, triggered_action: 'TriggeredAction') -> None

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

command(self, orchestration: 'OrchestrationClient', work_pool: WorkPool, triggered_action: 'TriggeredAction') -> Response

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

command(self, orchestration: 'OrchestrationClient', work_pool: WorkPool, triggered_action: 'TriggeredAction') -> Response

Issue the command to the Work Pool

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

target_work_pool(self, triggered_action: 'TriggeredAction') -> WorkPool

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

Resumes a Work Pool

Methods:

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

act(self, triggered_action: 'TriggeredAction') -> None

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

command(self, orchestration: 'OrchestrationClient', work_pool: WorkPool, triggered_action: 'TriggeredAction') -> Response

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

command(self, orchestration: 'OrchestrationClient', work_pool: WorkPool, triggered_action: 'TriggeredAction') -> Response

Issue the command to the Work Pool

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

target_work_pool(self, triggered_action: 'TriggeredAction') -> WorkPool

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

selected_work_queue_requires_id(self) -> Self

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

work_queue_id_to_use(self, triggered_action: 'TriggeredAction') -> UUID

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

Methods:

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

act(self, triggered_action: 'TriggeredAction') -> None

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

command(self, orchestration: 'OrchestrationClient', work_queue_id: UUID, triggered_action: 'TriggeredAction') -> Response

Issue the command to the Work Queue

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

events_api_client(self, triggered_action: 'TriggeredAction') -> PrefectServerEventsAPIClient

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

orchestration_client(self, triggered_action: 'TriggeredAction') -> 'OrchestrationClient'

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

reason_from_response(self, response: Response) -> str

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/server/events/actions.py#L1638" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a>}

Pauses a Work Queue

Methods:

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

act(self, triggered_action: 'TriggeredAction') -> None

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

command(self, orchestration: 'OrchestrationClient', work_queue_id: UUID, triggered_action: 'TriggeredAction') -> Response

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

command(self, orchestration: 'OrchestrationClient', work_queue_id: UUID, triggered_action: 'TriggeredAction') -> Response

Issue the command to the Work Queue

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

Resumes a Work Queue

Methods:

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

act(self, triggered_action: 'TriggeredAction') -> None

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

command(self, orchestration: 'OrchestrationClient', work_queue_id: UUID, triggered_action: 'TriggeredAction') -> Response

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

command(self, orchestration: 'OrchestrationClient', work_queue_id: UUID, triggered_action: 'TriggeredAction') -> Response

Issue the command to the Work Queue

AutomationAction ^{<a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/server/events/actions.py#L1670" 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:

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

automation_id_to_use(self, triggered_action: 'TriggeredAction') -> UUID

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/server/events/actions.py#L1689" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a>}

selected_automation_requires_id(self) -> Self

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

Methods:

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

act(self, triggered_action: 'TriggeredAction') -> None

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

command(self, events: PrefectServerEventsAPIClient, automation_id: UUID, triggered_action: 'TriggeredAction') -> Response

Issue the command to the Work Queue

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

events_api_client(self, triggered_action: 'TriggeredAction') -> PrefectServerEventsAPIClient

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

orchestration_client(self, triggered_action: 'TriggeredAction') -> 'OrchestrationClient'

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

reason_from_response(self, response: Response) -> str

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/server/events/actions.py#L1755" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a>}

Pauses a Work Queue

Methods:

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

act(self, triggered_action: 'TriggeredAction') -> None

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

command(self, events: PrefectServerEventsAPIClient, automation_id: UUID, triggered_action: 'TriggeredAction') -> Response

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

command(self, events: PrefectServerEventsAPIClient, automation_id: UUID, triggered_action: 'TriggeredAction') -> Response

Issue the command to the Work Queue

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

Resumes a Work Queue

Methods:

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

act(self, triggered_action: 'TriggeredAction') -> None

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

command(self, events: PrefectServerEventsAPIClient, automation_id: UUID, triggered_action: 'TriggeredAction') -> Response

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

command(self, events: PrefectServerEventsAPIClient, automation_id: UUID, triggered_action: 'TriggeredAction') -> Response

Issue the command to the Work Queue