aip_sdk.list_suts

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

List registered SUTs.

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

• project_id str | None: Scope the listing to this project, which determines its workspace. Not combinable with workspace_id.
• page int: Page number (1-based).
• per_page int: Items per page (max 100).
• client APIClient | None: Optional API client.
• workspace_id str | None: Return only SUTs in this workspace.
• all_workspaces bool: Read across every workspace you can access.

Returns

• list[SutInstance]: List of SutInstance objects.

Raises

• AuthError: If credentials are missing or invalid.
• 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.

Examples:

suts = aip.list_suts()
suts = aip.list_suts(project_id="proj_123")