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

# responses

# `prefect.client.schemas.responses`

## Classes

### `SetStateStatus` <sup>[https://github.com/PrefectHQ/prefect/blob/main/src/prefect/client/schemas/responses.py#L31](https://github.com/PrefectHQ/prefect/blob/main/src/prefect/client/schemas/responses.py#L31)</sup>

Enumerates return statuses for setting run states.

**Methods:**

#### `auto` <sup>[https://github.com/PrefectHQ/prefect/blob/main/src/prefect/utilities/collections.py#L70](https://github.com/PrefectHQ/prefect/blob/main/src/prefect/utilities/collections.py#L70)</sup>

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

Exposes `enum.auto()` to avoid requiring a second import to use `AutoEnum`

### `StateAcceptDetails` <sup>[https://github.com/PrefectHQ/prefect/blob/main/src/prefect/client/schemas/responses.py#L40](https://github.com/PrefectHQ/prefect/blob/main/src/prefect/client/schemas/responses.py#L40)</sup>

Details associated with an ACCEPT state transition.

**Methods:**

#### `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.

### `StateRejectDetails` <sup>[https://github.com/PrefectHQ/prefect/blob/main/src/prefect/client/schemas/responses.py#L52](https://github.com/PrefectHQ/prefect/blob/main/src/prefect/client/schemas/responses.py#L52)</sup>

Details associated with a REJECT state transition.

**Methods:**

#### `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.

### `StateAbortDetails` <sup>[https://github.com/PrefectHQ/prefect/blob/main/src/prefect/client/schemas/responses.py#L67](https://github.com/PrefectHQ/prefect/blob/main/src/prefect/client/schemas/responses.py#L67)</sup>

Details associated with an ABORT state transition.

**Methods:**

#### `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.

### `StateWaitDetails` <sup>[https://github.com/PrefectHQ/prefect/blob/main/src/prefect/client/schemas/responses.py#L82](https://github.com/PrefectHQ/prefect/blob/main/src/prefect/client/schemas/responses.py#L82)</sup>

Details associated with a WAIT state transition.

**Methods:**

#### `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.

### `HistoryResponseState` <sup>[https://github.com/PrefectHQ/prefect/blob/main/src/prefect/client/schemas/responses.py#L104](https://github.com/PrefectHQ/prefect/blob/main/src/prefect/client/schemas/responses.py#L104)</sup>

Represents a single state's history over an interval.

**Methods:**

#### `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.

### `HistoryResponse` <sup>[https://github.com/PrefectHQ/prefect/blob/main/src/prefect/client/schemas/responses.py#L126](https://github.com/PrefectHQ/prefect/blob/main/src/prefect/client/schemas/responses.py#L126)</sup>

Represents a history of aggregation states over an interval

**Methods:**

#### `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.

### `OrchestrationResult` <sup>[https://github.com/PrefectHQ/prefect/blob/main/src/prefect/client/schemas/responses.py#L145](https://github.com/PrefectHQ/prefect/blob/main/src/prefect/client/schemas/responses.py#L145)</sup>

A container for the output of state orchestration.

**Methods:**

#### `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.

### `WorkerFlowRunResponse` <sup>[https://github.com/PrefectHQ/prefect/blob/main/src/prefect/client/schemas/responses.py#L155](https://github.com/PrefectHQ/prefect/blob/main/src/prefect/client/schemas/responses.py#L155)</sup>

**Methods:**

#### `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.

### `FlowRunResponse` <sup>[https://github.com/PrefectHQ/prefect/blob/main/src/prefect/client/schemas/responses.py#L163](https://github.com/PrefectHQ/prefect/blob/main/src/prefect/client/schemas/responses.py#L163)</sup>

### `DeploymentResponse` <sup>[https://github.com/PrefectHQ/prefect/blob/main/src/prefect/client/schemas/responses.py#L319](https://github.com/PrefectHQ/prefect/blob/main/src/prefect/client/schemas/responses.py#L319)</sup>

**Methods:**

#### `as_related_resource` <sup>[https://github.com/PrefectHQ/prefect/blob/main/src/prefect/client/schemas/responses.py#L456](https://github.com/PrefectHQ/prefect/blob/main/src/prefect/client/schemas/responses.py#L456)</sup>

```python theme={null}
as_related_resource(self, role: str = 'deployment') -> 'RelatedResource'
```

### `MinimalConcurrencyLimitResponse` <sup>[https://github.com/PrefectHQ/prefect/blob/main/src/prefect/client/schemas/responses.py#L482](https://github.com/PrefectHQ/prefect/blob/main/src/prefect/client/schemas/responses.py#L482)</sup>

**Methods:**

#### `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.

### `ConcurrencyLimitWithLeaseResponse` <sup>[https://github.com/PrefectHQ/prefect/blob/main/src/prefect/client/schemas/responses.py#L490](https://github.com/PrefectHQ/prefect/blob/main/src/prefect/client/schemas/responses.py#L490)</sup>

**Methods:**

#### `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.

### `GlobalConcurrencyLimitResponse` <sup>[https://github.com/PrefectHQ/prefect/blob/main/src/prefect/client/schemas/responses.py#L497](https://github.com/PrefectHQ/prefect/blob/main/src/prefect/client/schemas/responses.py#L497)</sup>

A response object for global concurrency limits.

### `FlowRunSlotSummary` <sup>[https://github.com/PrefectHQ/prefect/blob/main/src/prefect/client/schemas/responses.py#L516](https://github.com/PrefectHQ/prefect/blob/main/src/prefect/client/schemas/responses.py#L516)</sup>

Summary of a flow run occupying a concurrency slot.

**Methods:**

#### `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.

### `WorkQueueConcurrencyStatusDetail` <sup>[https://github.com/PrefectHQ/prefect/blob/main/src/prefect/client/schemas/responses.py#L533](https://github.com/PrefectHQ/prefect/blob/main/src/prefect/client/schemas/responses.py#L533)</sup>

Per-queue concurrency status with flow run details.

**Methods:**

#### `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.

### `WorkPoolConcurrencyStatus` <sup>[https://github.com/PrefectHQ/prefect/blob/main/src/prefect/client/schemas/responses.py#L544](https://github.com/PrefectHQ/prefect/blob/main/src/prefect/client/schemas/responses.py#L544)</sup>

Paginated pool-level concurrency status with per-queue breakdown.

**Methods:**

#### `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.

### `WorkQueueConcurrencyStatus` <sup>[https://github.com/PrefectHQ/prefect/blob/main/src/prefect/client/schemas/responses.py#L556](https://github.com/PrefectHQ/prefect/blob/main/src/prefect/client/schemas/responses.py#L556)</sup>

Paginated queue-level concurrency status with flow run details.

**Methods:**

#### `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.