Skip to content

iter_list_sessions async

iter_list_sessions(
    portal_id: PortalId,
    *,
    config_overrides: Optional[AsyncWorkSpacesWebClientConfig] = None,
    username: Optional[Username] = None,
    session_id: Optional[SessionId] = None,
    sort_by: Optional[SessionSortBy] = None,
    status: Optional[SessionStatus] = None,
    max_results: Optional[MaxResults] = None,
    next_token: Optional[PaginationToken] = None,
) -> AsyncIterator[SessionSummary]
Source code in docs_src/capo_workspaces_web/_services/async_work_spaces_web.py
async def iter_list_sessions(
    self,
    portal_id: "capo_workspaces_web.types.portal_id.PortalId",
    *,
    config_overrides: Optional[AsyncWorkSpacesWebClientConfig] = None,
    username: Optional["capo_workspaces_web.types.username.Username"] = None,
    session_id: Optional["capo_workspaces_web.types.session_id.SessionId"] = None,
    sort_by: Optional[
        "capo_workspaces_web.types.session_sort_by.SessionSortBy"
    ] = None,
    status: Optional[
        "capo_workspaces_web.types.session_status.SessionStatus"
    ] = None,
    max_results: Optional[
        "capo_workspaces_web.types.max_results.MaxResults"
    ] = None,
    next_token: Optional[
        "capo_workspaces_web.types.pagination_token.PaginationToken"
    ] = None,
) -> "AsyncIterator[capo_workspaces_web.types.session_summary.SessionSummary]":
    _token = next_token
    while True:
        _response = await self.list_sessions(
            portal_id,
            config_overrides=config_overrides,
            username=username,
            session_id=session_id,
            sort_by=sort_by,
            status=status,
            max_results=max_results,
            next_token=_token,
        )
        _page = _resolve_path(_response, ("sessions",))
        for _item in _page or []:
            yield _item
        _token = _resolve_path(_response, ("next_token",))
        if not _token:
            break