prefect.client.cloud

Functions

get_cloud_client ^{<a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/client/cloud.py#L40" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a>}

get_cloud_client(host: Optional[str] = None, api_key: Optional[str] = None, httpx_settings: Optional[dict[str, Any]] = None, infer_cloud_url: bool = False) -> 'CloudClient'

Needs a docstring.

Classes

CloudUnauthorizedError ^{<a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/client/cloud.py#L68" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a>}

Raised when the CloudClient receives a 401 or 403 from the Cloud API.

CloudClient ^{<a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/client/cloud.py#L74" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a>}

Methods:

account_base_url ^{<a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/client/cloud.py#L103" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a>}

account_base_url(self) -> str

api_healthcheck ^{<a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/client/cloud.py#L116" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a>}

api_healthcheck(self) -> None

Attempts to connect to the Cloud API and raises the encountered exception if not successful.

If successful, returns None.

check_ip_allowlist_access ^{<a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/client/cloud.py#L168" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a>}

check_ip_allowlist_access(self) -> IPAllowlistMyAccessResponse

get ^{<a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/client/cloud.py#L188" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a>}

get(self, route: str, **kwargs: Any) -> Any

raw_request ^{<a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/client/cloud.py#L191" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a>}

raw_request(self, method: str, path: str, params: dict[str, Any] | None = None, path_params: dict[str, Any] | None = None, **kwargs: Any) -> httpx.Response

Make a raw HTTP request and return the Response object.

Unlike request(), this does not parse JSON or raise special exceptions, returning the raw httpx.Response for direct access to headers, status, etc.

Args:

• method: HTTP method (GET, POST, etc.)
• path: API path/route
• params: Query parameters
• path_params: Path parameters for formatting
• **kwargs: Additional arguments passed to httpx (json, headers, etc.)

Returns:

• Raw httpx.Response object

read_account_ip_allowlist ^{<a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/client/cloud.py#L157" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a>}

read_account_ip_allowlist(self) -> IPAllowlist

read_account_settings ^{<a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/client/cloud.py#L146" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a>}

read_account_settings(self) -> dict[str, Any]

read_current_workspace ^{<a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/client/cloud.py#L132" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a>}

read_current_workspace(self) -> Workspace

read_worker_metadata ^{<a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/client/cloud.py#L140" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a>}

read_worker_metadata(self) -> dict[str, Any]

read_workspaces ^{<a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/client/cloud.py#L126" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a>}

read_workspaces(self) -> list[Workspace]

request ^{<a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/client/cloud.py#L220" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a>}

request(self, method: str, route: str, **kwargs: Any) -> Any

update_account_ip_allowlist ^{<a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/client/cloud.py#L161" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a>}

update_account_ip_allowlist(self, updated_allowlist: IPAllowlist) -> None

update_account_settings ^{<a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/client/cloud.py#L150" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a>}

update_account_settings(self, settings: dict[str, Any]) -> None

workspace_base_url ^{<a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/client/cloud.py#L110" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a>}

workspace_base_url(self) -> str