Skip to content

Paginators#

Index > WorkSpaces > Paginators

Auto-generated documentation for WorkSpaces type annotations stubs module types-aiobotocore-workspaces.

DescribeAccountModificationsPaginator#

Type annotations and code completion for session.create_client("workspaces").get_paginator("describe_account_modifications"). boto3 documentation

# DescribeAccountModificationsPaginator usage example

from aiobotocore.session import get_session

from types_aiobotocore_workspaces.paginator import DescribeAccountModificationsPaginator

session = get_session()
async with session.create_client("workspaces") as client:  # (1)
    paginator: DescribeAccountModificationsPaginator = client.get_paginator("describe_account_modifications")  # (2)
    async for item in paginator.paginate(...):
        item: DescribeAccountModificationsResultTypeDef
        print(item)  # (3)
  1. client: WorkSpacesClient
  2. paginator: DescribeAccountModificationsPaginator
  3. item: DescribeAccountModificationsResultTypeDef

paginate#

Type annotations and code completion for DescribeAccountModificationsPaginator.paginate method.

# paginate method definition

def paginate(
    self,
    *,
    PaginationConfig: PaginatorConfigTypeDef = ...,  # (1)
) -> AsyncIterator[DescribeAccountModificationsResultTypeDef]:  # (2)
    ...
  1. See PaginatorConfigTypeDef
  2. See DescribeAccountModificationsResultTypeDef 
# paginate method usage example with argument unpacking

kwargs: DescribeAccountModificationsRequestDescribeAccountModificationsPaginateTypeDef = {  # (1)
    "PaginationConfig": ...,
}

parent.paginate(**kwargs)
  1. See DescribeAccountModificationsRequestDescribeAccountModificationsPaginateTypeDef

DescribeIpGroupsPaginator#

Type annotations and code completion for session.create_client("workspaces").get_paginator("describe_ip_groups"). boto3 documentation

# DescribeIpGroupsPaginator usage example

from aiobotocore.session import get_session

from types_aiobotocore_workspaces.paginator import DescribeIpGroupsPaginator

session = get_session()
async with session.create_client("workspaces") as client:  # (1)
    paginator: DescribeIpGroupsPaginator = client.get_paginator("describe_ip_groups")  # (2)
    async for item in paginator.paginate(...):
        item: DescribeIpGroupsResultTypeDef
        print(item)  # (3)
  1. client: WorkSpacesClient
  2. paginator: DescribeIpGroupsPaginator
  3. item: DescribeIpGroupsResultTypeDef

paginate#

Type annotations and code completion for DescribeIpGroupsPaginator.paginate method.

# paginate method definition

def paginate(
    self,
    *,
    GroupIds: Sequence[str] = ...,
    PaginationConfig: PaginatorConfigTypeDef = ...,  # (1)
) -> AsyncIterator[DescribeIpGroupsResultTypeDef]:  # (2)
    ...
  1. See PaginatorConfigTypeDef
  2. See DescribeIpGroupsResultTypeDef 
# paginate method usage example with argument unpacking

kwargs: DescribeIpGroupsRequestDescribeIpGroupsPaginateTypeDef = {  # (1)
    "GroupIds": ...,
}

parent.paginate(**kwargs)
  1. See DescribeIpGroupsRequestDescribeIpGroupsPaginateTypeDef

DescribeWorkspaceBundlesPaginator#

Type annotations and code completion for session.create_client("workspaces").get_paginator("describe_workspace_bundles"). boto3 documentation

# DescribeWorkspaceBundlesPaginator usage example

from aiobotocore.session import get_session

from types_aiobotocore_workspaces.paginator import DescribeWorkspaceBundlesPaginator

session = get_session()
async with session.create_client("workspaces") as client:  # (1)
    paginator: DescribeWorkspaceBundlesPaginator = client.get_paginator("describe_workspace_bundles")  # (2)
    async for item in paginator.paginate(...):
        item: DescribeWorkspaceBundlesResultTypeDef
        print(item)  # (3)
  1. client: WorkSpacesClient
  2. paginator: DescribeWorkspaceBundlesPaginator
  3. item: DescribeWorkspaceBundlesResultTypeDef

paginate#

Type annotations and code completion for DescribeWorkspaceBundlesPaginator.paginate method.

# paginate method definition

def paginate(
    self,
    *,
    BundleIds: Sequence[str] = ...,
    Owner: str = ...,
    PaginationConfig: PaginatorConfigTypeDef = ...,  # (1)
) -> AsyncIterator[DescribeWorkspaceBundlesResultTypeDef]:  # (2)
    ...
  1. See PaginatorConfigTypeDef
  2. See DescribeWorkspaceBundlesResultTypeDef 
# paginate method usage example with argument unpacking

kwargs: DescribeWorkspaceBundlesRequestDescribeWorkspaceBundlesPaginateTypeDef = {  # (1)
    "BundleIds": ...,
}

parent.paginate(**kwargs)
  1. See DescribeWorkspaceBundlesRequestDescribeWorkspaceBundlesPaginateTypeDef

DescribeWorkspaceDirectoriesPaginator#

Type annotations and code completion for session.create_client("workspaces").get_paginator("describe_workspace_directories"). boto3 documentation

# DescribeWorkspaceDirectoriesPaginator usage example

from aiobotocore.session import get_session

from types_aiobotocore_workspaces.paginator import DescribeWorkspaceDirectoriesPaginator

session = get_session()
async with session.create_client("workspaces") as client:  # (1)
    paginator: DescribeWorkspaceDirectoriesPaginator = client.get_paginator("describe_workspace_directories")  # (2)
    async for item in paginator.paginate(...):
        item: DescribeWorkspaceDirectoriesResultTypeDef
        print(item)  # (3)
  1. client: WorkSpacesClient
  2. paginator: DescribeWorkspaceDirectoriesPaginator
  3. item: DescribeWorkspaceDirectoriesResultTypeDef

paginate#

Type annotations and code completion for DescribeWorkspaceDirectoriesPaginator.paginate method.

# paginate method definition

def paginate(
    self,
    *,
    DirectoryIds: Sequence[str] = ...,
    Limit: int = ...,
    PaginationConfig: PaginatorConfigTypeDef = ...,  # (1)
) -> AsyncIterator[DescribeWorkspaceDirectoriesResultTypeDef]:  # (2)
    ...
  1. See PaginatorConfigTypeDef
  2. See DescribeWorkspaceDirectoriesResultTypeDef 
# paginate method usage example with argument unpacking

kwargs: DescribeWorkspaceDirectoriesRequestDescribeWorkspaceDirectoriesPaginateTypeDef = {  # (1)
    "DirectoryIds": ...,
}

parent.paginate(**kwargs)
  1. See DescribeWorkspaceDirectoriesRequestDescribeWorkspaceDirectoriesPaginateTypeDef

DescribeWorkspaceImagesPaginator#

Type annotations and code completion for session.create_client("workspaces").get_paginator("describe_workspace_images"). boto3 documentation

# DescribeWorkspaceImagesPaginator usage example

from aiobotocore.session import get_session

from types_aiobotocore_workspaces.paginator import DescribeWorkspaceImagesPaginator

session = get_session()
async with session.create_client("workspaces") as client:  # (1)
    paginator: DescribeWorkspaceImagesPaginator = client.get_paginator("describe_workspace_images")  # (2)
    async for item in paginator.paginate(...):
        item: DescribeWorkspaceImagesResultTypeDef
        print(item)  # (3)
  1. client: WorkSpacesClient
  2. paginator: DescribeWorkspaceImagesPaginator
  3. item: DescribeWorkspaceImagesResultTypeDef

paginate#

Type annotations and code completion for DescribeWorkspaceImagesPaginator.paginate method.

# paginate method definition

def paginate(
    self,
    *,
    ImageIds: Sequence[str] = ...,
    ImageType: ImageTypeType = ...,  # (1)
    PaginationConfig: PaginatorConfigTypeDef = ...,  # (2)
) -> AsyncIterator[DescribeWorkspaceImagesResultTypeDef]:  # (3)
    ...
  1. See ImageTypeType
  2. See PaginatorConfigTypeDef
  3. See DescribeWorkspaceImagesResultTypeDef 
# paginate method usage example with argument unpacking

kwargs: DescribeWorkspaceImagesRequestDescribeWorkspaceImagesPaginateTypeDef = {  # (1)
    "ImageIds": ...,
}

parent.paginate(**kwargs)
  1. See DescribeWorkspaceImagesRequestDescribeWorkspaceImagesPaginateTypeDef

DescribeWorkspacesPaginator#

Type annotations and code completion for session.create_client("workspaces").get_paginator("describe_workspaces"). boto3 documentation

# DescribeWorkspacesPaginator usage example

from aiobotocore.session import get_session

from types_aiobotocore_workspaces.paginator import DescribeWorkspacesPaginator

session = get_session()
async with session.create_client("workspaces") as client:  # (1)
    paginator: DescribeWorkspacesPaginator = client.get_paginator("describe_workspaces")  # (2)
    async for item in paginator.paginate(...):
        item: DescribeWorkspacesResultTypeDef
        print(item)  # (3)
  1. client: WorkSpacesClient
  2. paginator: DescribeWorkspacesPaginator
  3. item: DescribeWorkspacesResultTypeDef

paginate#

Type annotations and code completion for DescribeWorkspacesPaginator.paginate method.

# paginate method definition

def paginate(
    self,
    *,
    WorkspaceIds: Sequence[str] = ...,
    DirectoryId: str = ...,
    UserName: str = ...,
    BundleId: str = ...,
    PaginationConfig: PaginatorConfigTypeDef = ...,  # (1)
) -> AsyncIterator[DescribeWorkspacesResultTypeDef]:  # (2)
    ...
  1. See PaginatorConfigTypeDef
  2. See DescribeWorkspacesResultTypeDef 
# paginate method usage example with argument unpacking

kwargs: DescribeWorkspacesRequestDescribeWorkspacesPaginateTypeDef = {  # (1)
    "WorkspaceIds": ...,
}

parent.paginate(**kwargs)
  1. See DescribeWorkspacesRequestDescribeWorkspacesPaginateTypeDef

DescribeWorkspacesConnectionStatusPaginator#

Type annotations and code completion for session.create_client("workspaces").get_paginator("describe_workspaces_connection_status"). boto3 documentation

# DescribeWorkspacesConnectionStatusPaginator usage example

from aiobotocore.session import get_session

from types_aiobotocore_workspaces.paginator import DescribeWorkspacesConnectionStatusPaginator

session = get_session()
async with session.create_client("workspaces") as client:  # (1)
    paginator: DescribeWorkspacesConnectionStatusPaginator = client.get_paginator("describe_workspaces_connection_status")  # (2)
    async for item in paginator.paginate(...):
        item: DescribeWorkspacesConnectionStatusResultTypeDef
        print(item)  # (3)
  1. client: WorkSpacesClient
  2. paginator: DescribeWorkspacesConnectionStatusPaginator
  3. item: DescribeWorkspacesConnectionStatusResultTypeDef

paginate#

Type annotations and code completion for DescribeWorkspacesConnectionStatusPaginator.paginate method.

# paginate method definition

def paginate(
    self,
    *,
    WorkspaceIds: Sequence[str] = ...,
    PaginationConfig: PaginatorConfigTypeDef = ...,  # (1)
) -> AsyncIterator[DescribeWorkspacesConnectionStatusResultTypeDef]:  # (2)
    ...
  1. See PaginatorConfigTypeDef
  2. See DescribeWorkspacesConnectionStatusResultTypeDef 
# paginate method usage example with argument unpacking

kwargs: DescribeWorkspacesConnectionStatusRequestDescribeWorkspacesConnectionStatusPaginateTypeDef = {  # (1)
    "WorkspaceIds": ...,
}

parent.paginate(**kwargs)
  1. See DescribeWorkspacesConnectionStatusRequestDescribeWorkspacesConnectionStatusPaginateTypeDef

ListAvailableManagementCidrRangesPaginator#

Type annotations and code completion for session.create_client("workspaces").get_paginator("list_available_management_cidr_ranges"). boto3 documentation

# ListAvailableManagementCidrRangesPaginator usage example

from aiobotocore.session import get_session

from types_aiobotocore_workspaces.paginator import ListAvailableManagementCidrRangesPaginator

session = get_session()
async with session.create_client("workspaces") as client:  # (1)
    paginator: ListAvailableManagementCidrRangesPaginator = client.get_paginator("list_available_management_cidr_ranges")  # (2)
    async for item in paginator.paginate(...):
        item: ListAvailableManagementCidrRangesResultTypeDef
        print(item)  # (3)
  1. client: WorkSpacesClient
  2. paginator: ListAvailableManagementCidrRangesPaginator
  3. item: ListAvailableManagementCidrRangesResultTypeDef

paginate#

Type annotations and code completion for ListAvailableManagementCidrRangesPaginator.paginate method.

# paginate method definition

def paginate(
    self,
    *,
    ManagementCidrRangeConstraint: str,
    PaginationConfig: PaginatorConfigTypeDef = ...,  # (1)
) -> AsyncIterator[ListAvailableManagementCidrRangesResultTypeDef]:  # (2)
    ...
  1. See PaginatorConfigTypeDef
  2. See ListAvailableManagementCidrRangesResultTypeDef 
# paginate method usage example with argument unpacking

kwargs: ListAvailableManagementCidrRangesRequestListAvailableManagementCidrRangesPaginateTypeDef = {  # (1)
    "ManagementCidrRangeConstraint": ...,
}

parent.paginate(**kwargs)
  1. See ListAvailableManagementCidrRangesRequestListAvailableManagementCidrRangesPaginateTypeDef