Paginators

Index > WorkSpacesWeb > Paginators

Auto-generated documentation for WorkSpacesWeb type annotations stubs module mypy-boto3-workspaces-web.

ListSessionsPaginator

Type annotations and code completion for boto3.client("workspaces-web").get_paginator("list_sessions"). boto3 documentation

# ListSessionsPaginator usage example

from boto3.session import Session

from mypy_boto3_workspaces_web.paginator import ListSessionsPaginator

def get_list_sessions_paginator() -> ListSessionsPaginator:
    return Session().client("workspaces-web").get_paginator("list_sessions")

# ListSessionsPaginator usage example with type annotations

from boto3.session import Session

from mypy_boto3_workspaces_web.paginator import ListSessionsPaginator

session = Session()

client = Session().client("workspaces-web")  # (1)
paginator: ListSessionsPaginator = client.get_paginator("list_sessions")  # (2)
for item in paginator.paginate(...):
    print(item)  # (3)

1. client: WorkSpacesWebClient
2. paginator: ListSessionsPaginator
3. item: ListSessionsResponseTypeDef

paginate

Type annotations and code completion for ListSessionsPaginator.paginate method.

# paginate method definition

def paginate(
    self,
    *,
    portalId: str,
    sessionId: str = ...,
    sortBy: SessionSortByType = ...,  # (1)
    status: SessionStatusType = ...,  # (2)
    username: str = ...,
    PaginationConfig: PaginatorConfigTypeDef = ...,  # (3)
) -> _PageIterator[ListSessionsResponseTypeDef]:  # (4)
    ...

1. See SessionSortByType
2. See SessionStatusType
3. See PaginatorConfigTypeDef
4. See ListSessionsResponseTypeDef

# paginate method usage example with argument unpacking

kwargs: ListSessionsRequestListSessionsPaginateTypeDef = {  # (1)
    "portalId": ...,
}

parent.paginate(**kwargs)

1. See ListSessionsRequestListSessionsPaginateTypeDef