iter_describe_workspaces `async` ¶

iter_describe_workspaces(
    *,
    config_overrides: Optional[AsyncWorkSpacesClientConfig] = None,
    workspace_ids: Optional[WorkspaceIdList] = None,
    directory_id: Optional[DirectoryId] = None,
    user_name: Optional[UserName] = None,
    bundle_id: Optional[BundleId] = None,
    limit: Optional[Limit] = None,
    next_token: Optional[PaginationToken] = None,
    workspace_name: Optional[WorkspaceName] = None,
) -> AsyncIterator[Workspace]

Source code in docs_src/capo_workspaces/_services/async_work_spaces.py

async def iter_describe_workspaces(
    self,
    *,
    config_overrides: Optional[AsyncWorkSpacesClientConfig] = None,
    workspace_ids: Optional[
        "capo_workspaces.types.workspace_id_list.WorkspaceIdList"
    ] = None,
    directory_id: Optional["capo_workspaces.types.directory_id.DirectoryId"] = None,
    user_name: Optional["capo_workspaces.types.user_name.UserName"] = None,
    bundle_id: Optional["capo_workspaces.types.bundle_id.BundleId"] = None,
    limit: Optional["capo_workspaces.types.limit.Limit"] = None,
    next_token: Optional[
        "capo_workspaces.types.pagination_token.PaginationToken"
    ] = None,
    workspace_name: Optional[
        "capo_workspaces.types.workspace_name.WorkspaceName"
    ] = None,
) -> "AsyncIterator[capo_workspaces.types.workspace.Workspace]":
    _token = next_token
    while True:
        _response = await self.describe_workspaces(
            config_overrides=config_overrides,
            workspace_ids=workspace_ids,
            directory_id=directory_id,
            user_name=user_name,
            bundle_id=bundle_id,
            limit=limit,
            next_token=_token,
            workspace_name=workspace_name,
        )
        _page = _resolve_path(_response, ("workspaces",))
        for _item in _page or []:
            yield _item
        _token = _resolve_path(_response, ("next_token",))
        if not _token:
            break

iter_describe_workspaces async ¶

iter_describe_workspaces `async` ¶