Account is a representation of an account.

AccountMembershipFilter defines the search filter payload when searching for workspace roles by name.

AccountResponse is the data about an account returned by the Accounts API.

AccountRole is a representation of an account role.

AccountRoleFilter defines the search filter payload when searching for workspace roles by name.

AccountSettings is a representation of an account's settings.

AccountSettingsUpdate is the data sent when updating an account's settings.

AccountUpdate is the data sent when updating an account.

BaseModel is embedded in all other types and defines fields common to all Prefect data models.

BlockDocumentAccess is the API object representing a block document's current access control levels by actor (user/team/service account) and role (manage/view).

BlockDocumentAccessUpsert is the create/update request payload to modify a block document's current access control levels, meaning it contains the list of actors/teams + their respective access to a given block document.

BlockSchema is a representation of a block schema.

BlockSchemaFilter defines the search filter payload when searching for block schemas by slug.

BlockType is a representation of a block type.

Deployment is a representation of a deployment.

DeploymentAccess is a representation of a deployment access.

DeploymentAccessControl is a definition of deployment access control.

DeploymentAccessControlSet is a definition of deployment access control.

DeploymentAccessSet is a subset of DeploymentAccess used when setting deployment access control.

DeploymentCreate is a subset of Deployment used when creating deployments.

DeploymentFilter defines the search filter payload when searching for deployements by name.

DeploymentUpdate is a subset of Deployment used when updating deployments.

Flow is a representation of a flow.

FlowCreate is a subset of Flow used when creating flows.

FlowFilter defines the search filter payload when searching for flows by name.

FlowUpdate is a subset of Flow used when updating flows.

ServiceAccount is a representation of a created service account (from a Create response).

Represents an api_key block received from a List/Filter response, which excludes the actual key.

ServiceAccountFilter defines the search filter payload when searching for service accounts by name.

ServiceAccountNoKey is a representation of Service Account details obtained from a List/Filter and excludes the actual key value for the api_key.

Team is a representation of an team.

TeamFilter defines the search filter payload when searching for team by name.

Variable is a representation of a variable.

VariableCreate is a subset of Variable used when creating variables.

VariableFilter defines filters when searching for variables.

VariableFilterID defines filter criteria searching on variable IDs.

VariableFilterName defines filter criteria searching on variable names.

VariableFilterSettings defines settings when searching for variables.

VariableFilterTags defines filter criteria searching on variable IDs.

VariableFilterValue defines filter criteria searching on variable values.

VariableUpdate is a subset of Variable used when updating variables.

WorkPool is a representation of a work pool.

WorkPoolCreate is a subset of WorkPool used when creating pools.

WorkPoolFilter defines filters when searching for work pools.

WorkPoolUpdate is a subset of WorkPool used when updating pools.

Workspace is a representation of a workspace.

WorkspaceAccess is a representation of a workspace access.

WorkspaceAccessUpsert defines the payload when upserting a workspace access request.

WorkspaceCreate is a subset of Workspace used when creating workspaces.

WorkspaceFilter defines the search filter payload when searching for workspaces by name.

WorkspaceRole is a representation of a workspace role.

WorkspaceRoleFilter defines the search filter payload when searching for workspace roles by name.

WorkspaceRoleUpsert defines the request payload when creating or updating a workspace role.

WorkspaceUpdate is a subset of Workspace used when updating workspaces.

AccountsClient is a client for working with accounts.

BlockSchemaClient is a client for working with block schemas.

BlockTypeClient is a client for working with block types.

DeploymentAccessClient is a client for working with deployment access.

DeploymentsClient is a client for working with deployemts.

FlowsClient is a client for working with flows.

PrefectClient returns clients for different aspects of our API.

TeamsClient is a client for working with teams.

VariablesClient is a client for working with variables.

WorkPoolsClient is a client for working with work pools.

WorkspacesClient is a client for working with workspaces.

AccessActorType represents an enum of type values used in our Access APIs.

{ "ecs": {...} }.

{ "prefect": {...}, "prefect-aws": {...} }.