aip_sdk.list_sdg_adapters

aip_sdk.list_sdg_adapters(page: int = 1, per_page: int = 100, *, workspace_id: str | None = None, client: APIClient | None = None, all_workspaces: bool = False) -> list[SdgAdapterInstance]

List registered SDG adapters.

Reads your session's workspace unless you name one, and raises if none is set. Pass all_workspaces=True to read across every workspace you can access.

Parameters

• page int: Page number (1-indexed).
• per_page int: Results per page.
• workspace_id str | None: Filter to adapters registered in this workspace.
• client APIClient | None: Optional pre-configured API client.
• all_workspaces bool: Read across every workspace you can access.

Returns

• list[SdgAdapterInstance]: List of SdgAdapterInstance objects.

Raises

• ForbiddenError: If workspace_id names a workspace you cannot access.
• InvalidArgumentError: If both workspace_id and all_workspaces are given.
• NoWorkspaceSelectedError: No workspace was passed, none is configured for the session, and all_workspaces was not set.

Example:

adapters = aip.list_sdg_adapters()
for a in adapters:
    print(a.name, a.version)