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

# actions

# `prefect.client.schemas.actions`

## Classes

### `StateCreate` <sup>[https://github.com/PrefectHQ/prefect/blob/main/src/prefect/client/schemas/actions.py#L68](https://github.com/PrefectHQ/prefect/blob/main/src/prefect/client/schemas/actions.py#L68)</sup>

Data used by the Prefect REST API to create a new state.

### `FlowCreate` <sup>[https://github.com/PrefectHQ/prefect/blob/main/src/prefect/client/schemas/actions.py#L80](https://github.com/PrefectHQ/prefect/blob/main/src/prefect/client/schemas/actions.py#L80)</sup>

Data used by the Prefect REST API to create a flow.

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

Data used by the Prefect REST API to update a flow.

### `DeploymentScheduleCreate` <sup>[https://github.com/PrefectHQ/prefect/blob/main/src/prefect/client/schemas/actions.py#L118](https://github.com/PrefectHQ/prefect/blob/main/src/prefect/client/schemas/actions.py#L118)</sup>

**Methods:**

#### `from_schedule` <sup>[https://github.com/PrefectHQ/prefect/blob/main/src/prefect/client/schemas/actions.py#L160](https://github.com/PrefectHQ/prefect/blob/main/src/prefect/client/schemas/actions.py#L160)</sup>

```python theme={null}
from_schedule(cls, schedule: Schedule) -> 'DeploymentScheduleCreate'
```

#### `validate_active` <sup>[https://github.com/PrefectHQ/prefect/blob/main/src/prefect/client/schemas/actions.py#L144](https://github.com/PrefectHQ/prefect/blob/main/src/prefect/client/schemas/actions.py#L144)</sup>

```python theme={null}
validate_active(cls, v: Any, handler: Callable[[Any], Any]) -> bool
```

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

```python theme={null}
validate_max_scheduled_runs(cls, v: Optional[int]) -> Optional[int]
```

### `DeploymentScheduleUpdate` <sup>[https://github.com/PrefectHQ/prefect/blob/main/src/prefect/client/schemas/actions.py#L199](https://github.com/PrefectHQ/prefect/blob/main/src/prefect/client/schemas/actions.py#L199)</sup>

**Methods:**

#### `validate_max_scheduled_runs` <sup>[https://github.com/PrefectHQ/prefect/blob/main/src/prefect/client/schemas/actions.py#L226](https://github.com/PrefectHQ/prefect/blob/main/src/prefect/client/schemas/actions.py#L226)</sup>

```python theme={null}
validate_max_scheduled_runs(cls, v: Optional[int]) -> Optional[int]
```

### `DeploymentCreate` <sup>[https://github.com/PrefectHQ/prefect/blob/main/src/prefect/client/schemas/actions.py#L232](https://github.com/PrefectHQ/prefect/blob/main/src/prefect/client/schemas/actions.py#L232)</sup>

Data used by the Prefect REST API to create a deployment.

**Methods:**

#### `check_valid_configuration` <sup>[https://github.com/PrefectHQ/prefect/blob/main/src/prefect/client/schemas/actions.py#L312](https://github.com/PrefectHQ/prefect/blob/main/src/prefect/client/schemas/actions.py#L312)</sup>

```python theme={null}
check_valid_configuration(self, base_job_template: dict[str, Any]) -> None
```

Check that the combination of base\_job\_template defaults
and job\_variables conforms to the specified schema.

#### `convert_to_strings` <sup>[https://github.com/PrefectHQ/prefect/blob/main/src/prefect/client/schemas/actions.py#L242](https://github.com/PrefectHQ/prefect/blob/main/src/prefect/client/schemas/actions.py#L242)</sup>

```python theme={null}
convert_to_strings(cls, values: Optional[Union[str, list[str]]]) -> Union[str, list[str]]
```

#### `remove_old_fields` <sup>[https://github.com/PrefectHQ/prefect/blob/main/src/prefect/client/schemas/actions.py#L237](https://github.com/PrefectHQ/prefect/blob/main/src/prefect/client/schemas/actions.py#L237)</sup>

```python theme={null}
remove_old_fields(cls, values: dict[str, Any]) -> dict[str, Any]
```

### `DeploymentUpdate` <sup>[https://github.com/PrefectHQ/prefect/blob/main/src/prefect/client/schemas/actions.py#L339](https://github.com/PrefectHQ/prefect/blob/main/src/prefect/client/schemas/actions.py#L339)</sup>

Data used by the Prefect REST API to update a deployment.

**Methods:**

#### `check_valid_configuration` <sup>[https://github.com/PrefectHQ/prefect/blob/main/src/prefect/client/schemas/actions.py#L397](https://github.com/PrefectHQ/prefect/blob/main/src/prefect/client/schemas/actions.py#L397)</sup>

```python theme={null}
check_valid_configuration(self, base_job_template: dict[str, Any]) -> None
```

Check that the combination of base\_job\_template defaults
and job\_variables conforms to the specified schema.

#### `remove_old_fields` <sup>[https://github.com/PrefectHQ/prefect/blob/main/src/prefect/client/schemas/actions.py#L344](https://github.com/PrefectHQ/prefect/blob/main/src/prefect/client/schemas/actions.py#L344)</sup>

```python theme={null}
remove_old_fields(cls, values: dict[str, Any]) -> dict[str, Any]
```

### `DeploymentBranch` <sup>[https://github.com/PrefectHQ/prefect/blob/main/src/prefect/client/schemas/actions.py#L425](https://github.com/PrefectHQ/prefect/blob/main/src/prefect/client/schemas/actions.py#L425)</sup>

**Methods:**

#### `validate_branch_length` <sup>[https://github.com/PrefectHQ/prefect/blob/main/src/prefect/client/schemas/actions.py#L438](https://github.com/PrefectHQ/prefect/blob/main/src/prefect/client/schemas/actions.py#L438)</sup>

```python theme={null}
validate_branch_length(cls, v: str) -> str
```

### `FlowRunUpdate` <sup>[https://github.com/PrefectHQ/prefect/blob/main/src/prefect/client/schemas/actions.py#L444](https://github.com/PrefectHQ/prefect/blob/main/src/prefect/client/schemas/actions.py#L444)</sup>

Data used by the Prefect REST API to update a flow run.

### `TaskRunCreate` <sup>[https://github.com/PrefectHQ/prefect/blob/main/src/prefect/client/schemas/actions.py#L458](https://github.com/PrefectHQ/prefect/blob/main/src/prefect/client/schemas/actions.py#L458)</sup>

Data used by the Prefect REST API to create a task run

### `TaskRunUpdate` <sup>[https://github.com/PrefectHQ/prefect/blob/main/src/prefect/client/schemas/actions.py#L503](https://github.com/PrefectHQ/prefect/blob/main/src/prefect/client/schemas/actions.py#L503)</sup>

Data used by the Prefect REST API to update a task run

### `FlowRunCreate` <sup>[https://github.com/PrefectHQ/prefect/blob/main/src/prefect/client/schemas/actions.py#L509](https://github.com/PrefectHQ/prefect/blob/main/src/prefect/client/schemas/actions.py#L509)</sup>

Data used by the Prefect REST API to create a flow run.

### `DeploymentFlowRunCreate` <sup>[https://github.com/PrefectHQ/prefect/blob/main/src/prefect/client/schemas/actions.py#L541](https://github.com/PrefectHQ/prefect/blob/main/src/prefect/client/schemas/actions.py#L541)</sup>

Data used by the Prefect REST API to create a flow run from a deployment.

**Methods:**

#### `convert_parameters_to_plain_data` <sup>[https://github.com/PrefectHQ/prefect/blob/main/src/prefect/client/schemas/actions.py#L572](https://github.com/PrefectHQ/prefect/blob/main/src/prefect/client/schemas/actions.py#L572)</sup>

```python theme={null}
convert_parameters_to_plain_data(cls, values: dict[str, Any]) -> dict[str, Any]
```

#### `serialize_parameters` <sup>[https://github.com/PrefectHQ/prefect/blob/main/src/prefect/client/schemas/actions.py#L586](https://github.com/PrefectHQ/prefect/blob/main/src/prefect/client/schemas/actions.py#L586)</sup>

```python theme={null}
serialize_parameters(self, value: dict[str, Any]) -> dict[str, Any]
```

Serialize datetime types as ISO strings instead of timestamps.

PrefectBaseModel has ser\_json\_timedelta='float' to serialize timedeltas as floats,
but this also causes datetime/date/time to serialize as timestamps. This serializer
overrides that behavior for datetime types while preserving float serialization for
timedeltas.

### `SavedSearchCreate` <sup>[https://github.com/PrefectHQ/prefect/blob/main/src/prefect/client/schemas/actions.py#L607](https://github.com/PrefectHQ/prefect/blob/main/src/prefect/client/schemas/actions.py#L607)</sup>

Data used by the Prefect REST API to create a saved search.

### `ConcurrencyLimitCreate` <sup>[https://github.com/PrefectHQ/prefect/blob/main/src/prefect/client/schemas/actions.py#L616](https://github.com/PrefectHQ/prefect/blob/main/src/prefect/client/schemas/actions.py#L616)</sup>

Data used by the Prefect REST API to create a concurrency limit.

### `ConcurrencyLimitV2Create` <sup>[https://github.com/PrefectHQ/prefect/blob/main/src/prefect/client/schemas/actions.py#L625](https://github.com/PrefectHQ/prefect/blob/main/src/prefect/client/schemas/actions.py#L625)</sup>

Data used by the Prefect REST API to create a v2 concurrency limit.

### `ConcurrencyLimitV2Update` <sup>[https://github.com/PrefectHQ/prefect/blob/main/src/prefect/client/schemas/actions.py#L645](https://github.com/PrefectHQ/prefect/blob/main/src/prefect/client/schemas/actions.py#L645)</sup>

Data used by the Prefect REST API to update a v2 concurrency limit.

### `BlockTypeCreate` <sup>[https://github.com/PrefectHQ/prefect/blob/main/src/prefect/client/schemas/actions.py#L656](https://github.com/PrefectHQ/prefect/blob/main/src/prefect/client/schemas/actions.py#L656)</sup>

Data used by the Prefect REST API to create a block type.

### `BlockTypeUpdate` <sup>[https://github.com/PrefectHQ/prefect/blob/main/src/prefect/client/schemas/actions.py#L677](https://github.com/PrefectHQ/prefect/blob/main/src/prefect/client/schemas/actions.py#L677)</sup>

Data used by the Prefect REST API to update a block type.

**Methods:**

#### `updatable_fields` <sup>[https://github.com/PrefectHQ/prefect/blob/main/src/prefect/client/schemas/actions.py#L686](https://github.com/PrefectHQ/prefect/blob/main/src/prefect/client/schemas/actions.py#L686)</sup>

```python theme={null}
updatable_fields(cls) -> set[str]
```

### `BlockSchemaCreate` <sup>[https://github.com/PrefectHQ/prefect/blob/main/src/prefect/client/schemas/actions.py#L690](https://github.com/PrefectHQ/prefect/blob/main/src/prefect/client/schemas/actions.py#L690)</sup>

Data used by the Prefect REST API to create a block schema.

### `BlockDocumentCreate` <sup>[https://github.com/PrefectHQ/prefect/blob/main/src/prefect/client/schemas/actions.py#L707](https://github.com/PrefectHQ/prefect/blob/main/src/prefect/client/schemas/actions.py#L707)</sup>

Data used by the Prefect REST API to create a block document.

**Methods:**

#### `validate_name_is_present_if_not_anonymous` <sup>[https://github.com/PrefectHQ/prefect/blob/main/src/prefect/client/schemas/actions.py#L731](https://github.com/PrefectHQ/prefect/blob/main/src/prefect/client/schemas/actions.py#L731)</sup>

```python theme={null}
validate_name_is_present_if_not_anonymous(cls, values: dict[str, Any]) -> dict[str, Any]
```

### `BlockDocumentUpdate` <sup>[https://github.com/PrefectHQ/prefect/blob/main/src/prefect/client/schemas/actions.py#L737](https://github.com/PrefectHQ/prefect/blob/main/src/prefect/client/schemas/actions.py#L737)</sup>

Data used by the Prefect REST API to update a block document.

### `BlockDocumentReferenceCreate` <sup>[https://github.com/PrefectHQ/prefect/blob/main/src/prefect/client/schemas/actions.py#L752](https://github.com/PrefectHQ/prefect/blob/main/src/prefect/client/schemas/actions.py#L752)</sup>

Data used to create block document reference.

### `LogCreate` <sup>[https://github.com/PrefectHQ/prefect/blob/main/src/prefect/client/schemas/actions.py#L767](https://github.com/PrefectHQ/prefect/blob/main/src/prefect/client/schemas/actions.py#L767)</sup>

Data used by the Prefect REST API to create a log.

**Methods:**

#### `model_dump` <sup>[https://github.com/PrefectHQ/prefect/blob/main/src/prefect/client/schemas/actions.py#L778](https://github.com/PrefectHQ/prefect/blob/main/src/prefect/client/schemas/actions.py#L778)</sup>

```python theme={null}
model_dump(self, *args: Any, **kwargs: Any) -> dict[str, Any]
```

The worker\_id field is only included in logs sent to Prefect Cloud.
If it's unset, we should not include it in the log payload.

### `WorkPoolCreate` <sup>[https://github.com/PrefectHQ/prefect/blob/main/src/prefect/client/schemas/actions.py#L789](https://github.com/PrefectHQ/prefect/blob/main/src/prefect/client/schemas/actions.py#L789)</sup>

Data used by the Prefect REST API to create a work pool.

### `WorkPoolUpdate` <sup>[https://github.com/PrefectHQ/prefect/blob/main/src/prefect/client/schemas/actions.py#L816](https://github.com/PrefectHQ/prefect/blob/main/src/prefect/client/schemas/actions.py#L816)</sup>

Data used by the Prefect REST API to update a work pool.

### `WorkQueueCreate` <sup>[https://github.com/PrefectHQ/prefect/blob/main/src/prefect/client/schemas/actions.py#L829](https://github.com/PrefectHQ/prefect/blob/main/src/prefect/client/schemas/actions.py#L829)</sup>

Data used by the Prefect REST API to create a work queue.

### `WorkQueueUpdate` <sup>[https://github.com/PrefectHQ/prefect/blob/main/src/prefect/client/schemas/actions.py#L858](https://github.com/PrefectHQ/prefect/blob/main/src/prefect/client/schemas/actions.py#L858)</sup>

Data used by the Prefect REST API to update a work queue.

### `ArtifactCreate` <sup>[https://github.com/PrefectHQ/prefect/blob/main/src/prefect/client/schemas/actions.py#L881](https://github.com/PrefectHQ/prefect/blob/main/src/prefect/client/schemas/actions.py#L881)</sup>

Data used by the Prefect REST API to create an artifact.

### `ArtifactUpdate` <sup>[https://github.com/PrefectHQ/prefect/blob/main/src/prefect/client/schemas/actions.py#L893](https://github.com/PrefectHQ/prefect/blob/main/src/prefect/client/schemas/actions.py#L893)</sup>

Data used by the Prefect REST API to update an artifact.

### `VariableCreate` <sup>[https://github.com/PrefectHQ/prefect/blob/main/src/prefect/client/schemas/actions.py#L901](https://github.com/PrefectHQ/prefect/blob/main/src/prefect/client/schemas/actions.py#L901)</sup>

Data used by the Prefect REST API to create a Variable.

### `VariableUpdate` <sup>[https://github.com/PrefectHQ/prefect/blob/main/src/prefect/client/schemas/actions.py#L913](https://github.com/PrefectHQ/prefect/blob/main/src/prefect/client/schemas/actions.py#L913)</sup>

Data used by the Prefect REST API to update a Variable.

### `GlobalConcurrencyLimitCreate` <sup>[https://github.com/PrefectHQ/prefect/blob/main/src/prefect/client/schemas/actions.py#L925](https://github.com/PrefectHQ/prefect/blob/main/src/prefect/client/schemas/actions.py#L925)</sup>

Data used by the Prefect REST API to create a global concurrency limit.

### `GlobalConcurrencyLimitUpdate` <sup>[https://github.com/PrefectHQ/prefect/blob/main/src/prefect/client/schemas/actions.py#L952](https://github.com/PrefectHQ/prefect/blob/main/src/prefect/client/schemas/actions.py#L952)</sup>

Data used by the Prefect REST API to update a global concurrency limit.