> ## Documentation Index
> Fetch the complete documentation index at: /docs/llms.txt
> Use this file to discover all available pages before exploring further.

# actions

# `prefect.events.actions`

## Classes

### `Action` <sup>[https://github.com/PrefectHQ/prefect/blob/main/src/prefect/events/actions.py#L21](https://github.com/PrefectHQ/prefect/blob/main/src/prefect/events/actions.py#L21)</sup>

An Action that may be performed when an Automation is triggered

**Methods:**

#### `describe_for_cli` <sup>[https://github.com/PrefectHQ/prefect/blob/main/src/prefect/events/actions.py#L26](https://github.com/PrefectHQ/prefect/blob/main/src/prefect/events/actions.py#L26)</sup>

```python theme={null}
describe_for_cli(self) -> str
```

A human-readable description of the action

#### `model_validate_list` <sup>[https://github.com/PrefectHQ/prefect/blob/main/src/prefect/\_internal/schemas/bases.py#L56](https://github.com/PrefectHQ/prefect/blob/main/src/prefect/_internal/schemas/bases.py#L56)</sup>

```python theme={null}
model_validate_list(cls, obj: Any) -> list[Self]
```

#### `reset_fields` <sup>[https://github.com/PrefectHQ/prefect/blob/main/src/prefect/\_internal/schemas/bases.py#L85](https://github.com/PrefectHQ/prefect/blob/main/src/prefect/_internal/schemas/bases.py#L85)</sup>

```python theme={null}
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` <sup>[https://github.com/PrefectHQ/prefect/blob/main/src/prefect/events/actions.py#L31](https://github.com/PrefectHQ/prefect/blob/main/src/prefect/events/actions.py#L31)</sup>

Do nothing when an Automation is triggered

**Methods:**

#### `describe_for_cli` <sup>[https://github.com/PrefectHQ/prefect/blob/main/src/prefect/events/actions.py#L26](https://github.com/PrefectHQ/prefect/blob/main/src/prefect/events/actions.py#L26)</sup>

```python theme={null}
describe_for_cli(self) -> str
```

A human-readable description of the action

### `DeploymentAction` <sup>[https://github.com/PrefectHQ/prefect/blob/main/src/prefect/events/actions.py#L37](https://github.com/PrefectHQ/prefect/blob/main/src/prefect/events/actions.py#L37)</sup>

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

**Methods:**

#### `describe_for_cli` <sup>[https://github.com/PrefectHQ/prefect/blob/main/src/prefect/events/actions.py#L26](https://github.com/PrefectHQ/prefect/blob/main/src/prefect/events/actions.py#L26)</sup>

```python theme={null}
describe_for_cli(self) -> str
```

A human-readable description of the action

#### `selected_deployment_requires_id` <sup>[https://github.com/PrefectHQ/prefect/blob/main/src/prefect/events/actions.py#L56](https://github.com/PrefectHQ/prefect/blob/main/src/prefect/events/actions.py#L56)</sup>

```python theme={null}
selected_deployment_requires_id(self)
```

### `RunDeployment` <sup>[https://github.com/PrefectHQ/prefect/blob/main/src/prefect/events/actions.py#L67](https://github.com/PrefectHQ/prefect/blob/main/src/prefect/events/actions.py#L67)</sup>

Runs the given deployment with the given parameters

**Methods:**

#### `selected_deployment_requires_id` <sup>[https://github.com/PrefectHQ/prefect/blob/main/src/prefect/events/actions.py#L56](https://github.com/PrefectHQ/prefect/blob/main/src/prefect/events/actions.py#L56)</sup>

```python theme={null}
selected_deployment_requires_id(self)
```

### `PauseDeployment` <sup>[https://github.com/PrefectHQ/prefect/blob/main/src/prefect/events/actions.py#L95](https://github.com/PrefectHQ/prefect/blob/main/src/prefect/events/actions.py#L95)</sup>

Pauses the given Deployment

**Methods:**

#### `selected_deployment_requires_id` <sup>[https://github.com/PrefectHQ/prefect/blob/main/src/prefect/events/actions.py#L56](https://github.com/PrefectHQ/prefect/blob/main/src/prefect/events/actions.py#L56)</sup>

```python theme={null}
selected_deployment_requires_id(self)
```

### `ResumeDeployment` <sup>[https://github.com/PrefectHQ/prefect/blob/main/src/prefect/events/actions.py#L101](https://github.com/PrefectHQ/prefect/blob/main/src/prefect/events/actions.py#L101)</sup>

Resumes the given Deployment

**Methods:**

#### `selected_deployment_requires_id` <sup>[https://github.com/PrefectHQ/prefect/blob/main/src/prefect/events/actions.py#L56](https://github.com/PrefectHQ/prefect/blob/main/src/prefect/events/actions.py#L56)</sup>

```python theme={null}
selected_deployment_requires_id(self)
```

### `ChangeFlowRunState` <sup>[https://github.com/PrefectHQ/prefect/blob/main/src/prefect/events/actions.py#L107](https://github.com/PrefectHQ/prefect/blob/main/src/prefect/events/actions.py#L107)</sup>

Changes the state of a flow run associated with the trigger

**Methods:**

#### `describe_for_cli` <sup>[https://github.com/PrefectHQ/prefect/blob/main/src/prefect/events/actions.py#L26](https://github.com/PrefectHQ/prefect/blob/main/src/prefect/events/actions.py#L26)</sup>

```python theme={null}
describe_for_cli(self) -> str
```

A human-readable description of the action

### `CancelFlowRun` <sup>[https://github.com/PrefectHQ/prefect/blob/main/src/prefect/events/actions.py#L130](https://github.com/PrefectHQ/prefect/blob/main/src/prefect/events/actions.py#L130)</sup>

Cancels a flow run associated with the trigger

**Methods:**

#### `describe_for_cli` <sup>[https://github.com/PrefectHQ/prefect/blob/main/src/prefect/events/actions.py#L26](https://github.com/PrefectHQ/prefect/blob/main/src/prefect/events/actions.py#L26)</sup>

```python theme={null}
describe_for_cli(self) -> str
```

A human-readable description of the action

### `DeleteFlowRun` <sup>[https://github.com/PrefectHQ/prefect/blob/main/src/prefect/events/actions.py#L136](https://github.com/PrefectHQ/prefect/blob/main/src/prefect/events/actions.py#L136)</sup>

Deletes a flow run associated with the trigger

**Methods:**

#### `describe_for_cli` <sup>[https://github.com/PrefectHQ/prefect/blob/main/src/prefect/events/actions.py#L26](https://github.com/PrefectHQ/prefect/blob/main/src/prefect/events/actions.py#L26)</sup>

```python theme={null}
describe_for_cli(self) -> str
```

A human-readable description of the action

### `ResumeFlowRun` <sup>[https://github.com/PrefectHQ/prefect/blob/main/src/prefect/events/actions.py#L142](https://github.com/PrefectHQ/prefect/blob/main/src/prefect/events/actions.py#L142)</sup>

Resumes a flow run associated with the trigger

**Methods:**

#### `describe_for_cli` <sup>[https://github.com/PrefectHQ/prefect/blob/main/src/prefect/events/actions.py#L26](https://github.com/PrefectHQ/prefect/blob/main/src/prefect/events/actions.py#L26)</sup>

```python theme={null}
describe_for_cli(self) -> str
```

A human-readable description of the action

### `SuspendFlowRun` <sup>[https://github.com/PrefectHQ/prefect/blob/main/src/prefect/events/actions.py#L148](https://github.com/PrefectHQ/prefect/blob/main/src/prefect/events/actions.py#L148)</sup>

Suspends a flow run associated with the trigger

**Methods:**

#### `describe_for_cli` <sup>[https://github.com/PrefectHQ/prefect/blob/main/src/prefect/events/actions.py#L26](https://github.com/PrefectHQ/prefect/blob/main/src/prefect/events/actions.py#L26)</sup>

```python theme={null}
describe_for_cli(self) -> str
```

A human-readable description of the action

### `CallWebhook` <sup>[https://github.com/PrefectHQ/prefect/blob/main/src/prefect/events/actions.py#L154](https://github.com/PrefectHQ/prefect/blob/main/src/prefect/events/actions.py#L154)</sup>

Call a webhook when an Automation is triggered.

**Methods:**

#### `describe_for_cli` <sup>[https://github.com/PrefectHQ/prefect/blob/main/src/prefect/events/actions.py#L26](https://github.com/PrefectHQ/prefect/blob/main/src/prefect/events/actions.py#L26)</sup>

```python theme={null}
describe_for_cli(self) -> str
```

A human-readable description of the action

### `SendNotification` <sup>[https://github.com/PrefectHQ/prefect/blob/main/src/prefect/events/actions.py#L167](https://github.com/PrefectHQ/prefect/blob/main/src/prefect/events/actions.py#L167)</sup>

Send a notification when an Automation is triggered

**Methods:**

#### `describe_for_cli` <sup>[https://github.com/PrefectHQ/prefect/blob/main/src/prefect/events/actions.py#L26](https://github.com/PrefectHQ/prefect/blob/main/src/prefect/events/actions.py#L26)</sup>

```python theme={null}
describe_for_cli(self) -> str
```

A human-readable description of the action

### `WorkPoolAction` <sup>[https://github.com/PrefectHQ/prefect/blob/main/src/prefect/events/actions.py#L178](https://github.com/PrefectHQ/prefect/blob/main/src/prefect/events/actions.py#L178)</sup>

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

**Methods:**

#### `describe_for_cli` <sup>[https://github.com/PrefectHQ/prefect/blob/main/src/prefect/events/actions.py#L26](https://github.com/PrefectHQ/prefect/blob/main/src/prefect/events/actions.py#L26)</sup>

```python theme={null}
describe_for_cli(self) -> str
```

A human-readable description of the action

### `PauseWorkPool` <sup>[https://github.com/PrefectHQ/prefect/blob/main/src/prefect/events/actions.py#L198](https://github.com/PrefectHQ/prefect/blob/main/src/prefect/events/actions.py#L198)</sup>

Pauses a Work Pool

### `ResumeWorkPool` <sup>[https://github.com/PrefectHQ/prefect/blob/main/src/prefect/events/actions.py#L204](https://github.com/PrefectHQ/prefect/blob/main/src/prefect/events/actions.py#L204)</sup>

Resumes a Work Pool

### `WorkQueueAction` <sup>[https://github.com/PrefectHQ/prefect/blob/main/src/prefect/events/actions.py#L210](https://github.com/PrefectHQ/prefect/blob/main/src/prefect/events/actions.py#L210)</sup>

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

**Methods:**

#### `describe_for_cli` <sup>[https://github.com/PrefectHQ/prefect/blob/main/src/prefect/events/actions.py#L26](https://github.com/PrefectHQ/prefect/blob/main/src/prefect/events/actions.py#L26)</sup>

```python theme={null}
describe_for_cli(self) -> str
```

A human-readable description of the action

#### `selected_work_queue_requires_id` <sup>[https://github.com/PrefectHQ/prefect/blob/main/src/prefect/events/actions.py#L229](https://github.com/PrefectHQ/prefect/blob/main/src/prefect/events/actions.py#L229)</sup>

```python theme={null}
selected_work_queue_requires_id(self) -> Self
```

### `PauseWorkQueue` <sup>[https://github.com/PrefectHQ/prefect/blob/main/src/prefect/events/actions.py#L240](https://github.com/PrefectHQ/prefect/blob/main/src/prefect/events/actions.py#L240)</sup>

Pauses a Work Queue

**Methods:**

#### `selected_work_queue_requires_id` <sup>[https://github.com/PrefectHQ/prefect/blob/main/src/prefect/events/actions.py#L229](https://github.com/PrefectHQ/prefect/blob/main/src/prefect/events/actions.py#L229)</sup>

```python theme={null}
selected_work_queue_requires_id(self) -> Self
```

### `ResumeWorkQueue` <sup>[https://github.com/PrefectHQ/prefect/blob/main/src/prefect/events/actions.py#L246](https://github.com/PrefectHQ/prefect/blob/main/src/prefect/events/actions.py#L246)</sup>

Resumes a Work Queue

**Methods:**

#### `selected_work_queue_requires_id` <sup>[https://github.com/PrefectHQ/prefect/blob/main/src/prefect/events/actions.py#L229](https://github.com/PrefectHQ/prefect/blob/main/src/prefect/events/actions.py#L229)</sup>

```python theme={null}
selected_work_queue_requires_id(self) -> Self
```

### `AutomationAction` <sup>[https://github.com/PrefectHQ/prefect/blob/main/src/prefect/events/actions.py#L252](https://github.com/PrefectHQ/prefect/blob/main/src/prefect/events/actions.py#L252)</sup>

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

**Methods:**

#### `describe_for_cli` <sup>[https://github.com/PrefectHQ/prefect/blob/main/src/prefect/events/actions.py#L26](https://github.com/PrefectHQ/prefect/blob/main/src/prefect/events/actions.py#L26)</sup>

```python theme={null}
describe_for_cli(self) -> str
```

A human-readable description of the action

#### `selected_automation_requires_id` <sup>[https://github.com/PrefectHQ/prefect/blob/main/src/prefect/events/actions.py#L271](https://github.com/PrefectHQ/prefect/blob/main/src/prefect/events/actions.py#L271)</sup>

```python theme={null}
selected_automation_requires_id(self) -> Self
```

### `PauseAutomation` <sup>[https://github.com/PrefectHQ/prefect/blob/main/src/prefect/events/actions.py#L282](https://github.com/PrefectHQ/prefect/blob/main/src/prefect/events/actions.py#L282)</sup>

Pauses a Work Queue

**Methods:**

#### `selected_automation_requires_id` <sup>[https://github.com/PrefectHQ/prefect/blob/main/src/prefect/events/actions.py#L271](https://github.com/PrefectHQ/prefect/blob/main/src/prefect/events/actions.py#L271)</sup>

```python theme={null}
selected_automation_requires_id(self) -> Self
```

### `ResumeAutomation` <sup>[https://github.com/PrefectHQ/prefect/blob/main/src/prefect/events/actions.py#L288](https://github.com/PrefectHQ/prefect/blob/main/src/prefect/events/actions.py#L288)</sup>

Resumes a Work Queue

**Methods:**

#### `selected_automation_requires_id` <sup>[https://github.com/PrefectHQ/prefect/blob/main/src/prefect/events/actions.py#L271](https://github.com/PrefectHQ/prefect/blob/main/src/prefect/events/actions.py#L271)</sup>

```python theme={null}
selected_automation_requires_id(self) -> Self
```

### `DeclareIncident` <sup>[https://github.com/PrefectHQ/prefect/blob/main/src/prefect/events/actions.py#L294](https://github.com/PrefectHQ/prefect/blob/main/src/prefect/events/actions.py#L294)</sup>

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

**Methods:**

#### `describe_for_cli` <sup>[https://github.com/PrefectHQ/prefect/blob/main/src/prefect/events/actions.py#L26](https://github.com/PrefectHQ/prefect/blob/main/src/prefect/events/actions.py#L26)</sup>

```python theme={null}
describe_for_cli(self) -> str
```

A human-readable description of the action

### `UnknownAction` <sup>[https://github.com/PrefectHQ/prefect/blob/main/src/prefect/events/actions.py#L330](https://github.com/PrefectHQ/prefect/blob/main/src/prefect/events/actions.py#L330)</sup>

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` <sup>[https://github.com/PrefectHQ/prefect/blob/main/src/prefect/events/actions.py#L26](https://github.com/PrefectHQ/prefect/blob/main/src/prefect/events/actions.py#L26)</sup>

```python theme={null}
describe_for_cli(self) -> str
```

A human-readable description of the action