Skip to content

Paginators#

Index > WorkSpaces > Paginators

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

DescribeAccountModificationsPaginator#

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

# DescribeAccountModificationsPaginator usage example

from boto3.session import Session

from mypy_boto3_workspaces.paginator import DescribeAccountModificationsPaginator

def get_describe_account_modifications_paginator() -> DescribeAccountModificationsPaginator:
    return Session().client("workspaces").get_paginator("describe_account_modifications")
# DescribeAccountModificationsPaginator usage example with type annotations

from boto3.session import Session

from mypy_boto3_workspaces.paginator import DescribeAccountModificationsPaginator

session = Session()

client = Session().client("workspaces")  # (1)
paginator: DescribeAccountModificationsPaginator = client.get_paginator("describe_account_modifications")  # (2)
for item in paginator.paginate(...):
    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)
) -> _PageIterator[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 boto3.client("workspaces").get_paginator("describe_ip_groups"). boto3 documentation

# DescribeIpGroupsPaginator usage example

from boto3.session import Session

from mypy_boto3_workspaces.paginator import DescribeIpGroupsPaginator

def get_describe_ip_groups_paginator() -> DescribeIpGroupsPaginator:
    return Session().client("workspaces").get_paginator("describe_ip_groups")
# DescribeIpGroupsPaginator usage example with type annotations

from boto3.session import Session

from mypy_boto3_workspaces.paginator import DescribeIpGroupsPaginator

session = Session()

client = Session().client("workspaces")  # (1)
paginator: DescribeIpGroupsPaginator = client.get_paginator("describe_ip_groups")  # (2)
for item in paginator.paginate(...):
    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)
) -> _PageIterator[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 boto3.client("workspaces").get_paginator("describe_workspace_bundles"). boto3 documentation

# DescribeWorkspaceBundlesPaginator usage example

from boto3.session import Session

from mypy_boto3_workspaces.paginator import DescribeWorkspaceBundlesPaginator

def get_describe_workspace_bundles_paginator() -> DescribeWorkspaceBundlesPaginator:
    return Session().client("workspaces").get_paginator("describe_workspace_bundles")
# DescribeWorkspaceBundlesPaginator usage example with type annotations

from boto3.session import Session

from mypy_boto3_workspaces.paginator import DescribeWorkspaceBundlesPaginator

session = Session()

client = Session().client("workspaces")  # (1)
paginator: DescribeWorkspaceBundlesPaginator = client.get_paginator("describe_workspace_bundles")  # (2)
for item in paginator.paginate(...):
    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)
) -> _PageIterator[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 boto3.client("workspaces").get_paginator("describe_workspace_directories"). boto3 documentation

# DescribeWorkspaceDirectoriesPaginator usage example

from boto3.session import Session

from mypy_boto3_workspaces.paginator import DescribeWorkspaceDirectoriesPaginator

def get_describe_workspace_directories_paginator() -> DescribeWorkspaceDirectoriesPaginator:
    return Session().client("workspaces").get_paginator("describe_workspace_directories")
# DescribeWorkspaceDirectoriesPaginator usage example with type annotations

from boto3.session import Session

from mypy_boto3_workspaces.paginator import DescribeWorkspaceDirectoriesPaginator

session = Session()

client = Session().client("workspaces")  # (1)
paginator: DescribeWorkspaceDirectoriesPaginator = client.get_paginator("describe_workspace_directories")  # (2)
for item in paginator.paginate(...):
    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] = ...,
    WorkspaceDirectoryNames: Sequence[str] = ...,
    Limit: int = ...,
    Filters: Sequence[DescribeWorkspaceDirectoriesFilterTypeDef] = ...,  # (1)
    PaginationConfig: PaginatorConfigTypeDef = ...,  # (2)
) -> _PageIterator[DescribeWorkspaceDirectoriesResultTypeDef]:  # (3)
    ...
  1. See DescribeWorkspaceDirectoriesFilterTypeDef
  2. See PaginatorConfigTypeDef
  3. 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 boto3.client("workspaces").get_paginator("describe_workspace_images"). boto3 documentation

# DescribeWorkspaceImagesPaginator usage example

from boto3.session import Session

from mypy_boto3_workspaces.paginator import DescribeWorkspaceImagesPaginator

def get_describe_workspace_images_paginator() -> DescribeWorkspaceImagesPaginator:
    return Session().client("workspaces").get_paginator("describe_workspace_images")
# DescribeWorkspaceImagesPaginator usage example with type annotations

from boto3.session import Session

from mypy_boto3_workspaces.paginator import DescribeWorkspaceImagesPaginator

session = Session()

client = Session().client("workspaces")  # (1)
paginator: DescribeWorkspaceImagesPaginator = client.get_paginator("describe_workspace_images")  # (2)
for item in paginator.paginate(...):
    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)
) -> _PageIterator[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 boto3.client("workspaces").get_paginator("describe_workspaces"). boto3 documentation

# DescribeWorkspacesPaginator usage example

from boto3.session import Session

from mypy_boto3_workspaces.paginator import DescribeWorkspacesPaginator

def get_describe_workspaces_paginator() -> DescribeWorkspacesPaginator:
    return Session().client("workspaces").get_paginator("describe_workspaces")
# DescribeWorkspacesPaginator usage example with type annotations

from boto3.session import Session

from mypy_boto3_workspaces.paginator import DescribeWorkspacesPaginator

session = Session()

client = Session().client("workspaces")  # (1)
paginator: DescribeWorkspacesPaginator = client.get_paginator("describe_workspaces")  # (2)
for item in paginator.paginate(...):
    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 = ...,
    WorkspaceName: str = ...,
    PaginationConfig: PaginatorConfigTypeDef = ...,  # (1)
) -> _PageIterator[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 boto3.client("workspaces").get_paginator("describe_workspaces_connection_status"). boto3 documentation

# DescribeWorkspacesConnectionStatusPaginator usage example

from boto3.session import Session

from mypy_boto3_workspaces.paginator import DescribeWorkspacesConnectionStatusPaginator

def get_describe_workspaces_connection_status_paginator() -> DescribeWorkspacesConnectionStatusPaginator:
    return Session().client("workspaces").get_paginator("describe_workspaces_connection_status")
# DescribeWorkspacesConnectionStatusPaginator usage example with type annotations

from boto3.session import Session

from mypy_boto3_workspaces.paginator import DescribeWorkspacesConnectionStatusPaginator

session = Session()

client = Session().client("workspaces")  # (1)
paginator: DescribeWorkspacesConnectionStatusPaginator = client.get_paginator("describe_workspaces_connection_status")  # (2)
for item in paginator.paginate(...):
    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)
) -> _PageIterator[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

ListAccountLinksPaginator#

Type annotations and code completion for boto3.client("workspaces").get_paginator("list_account_links"). boto3 documentation

# ListAccountLinksPaginator usage example

from boto3.session import Session

from mypy_boto3_workspaces.paginator import ListAccountLinksPaginator

def get_list_account_links_paginator() -> ListAccountLinksPaginator:
    return Session().client("workspaces").get_paginator("list_account_links")
# ListAccountLinksPaginator usage example with type annotations

from boto3.session import Session

from mypy_boto3_workspaces.paginator import ListAccountLinksPaginator

session = Session()

client = Session().client("workspaces")  # (1)
paginator: ListAccountLinksPaginator = client.get_paginator("list_account_links")  # (2)
for item in paginator.paginate(...):
    print(item)  # (3)
  1. client: WorkSpacesClient
  2. paginator: ListAccountLinksPaginator
  3. item: ListAccountLinksResultTypeDef

paginate#

Type annotations and code completion for ListAccountLinksPaginator.paginate method.

# paginate method definition

def paginate(
    self,
    *,
    LinkStatusFilter: Sequence[AccountLinkStatusEnumType] = ...,  # (1)
    PaginationConfig: PaginatorConfigTypeDef = ...,  # (2)
) -> _PageIterator[ListAccountLinksResultTypeDef]:  # (3)
    ...
  1. See AccountLinkStatusEnumType
  2. See PaginatorConfigTypeDef
  3. See ListAccountLinksResultTypeDef 
# paginate method usage example with argument unpacking

kwargs: ListAccountLinksRequestListAccountLinksPaginateTypeDef = {  # (1)
    "LinkStatusFilter": ...,
}

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

ListAvailableManagementCidrRangesPaginator#

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

# ListAvailableManagementCidrRangesPaginator usage example

from boto3.session import Session

from mypy_boto3_workspaces.paginator import ListAvailableManagementCidrRangesPaginator

def get_list_available_management_cidr_ranges_paginator() -> ListAvailableManagementCidrRangesPaginator:
    return Session().client("workspaces").get_paginator("list_available_management_cidr_ranges")
# ListAvailableManagementCidrRangesPaginator usage example with type annotations

from boto3.session import Session

from mypy_boto3_workspaces.paginator import ListAvailableManagementCidrRangesPaginator

session = Session()

client = Session().client("workspaces")  # (1)
paginator: ListAvailableManagementCidrRangesPaginator = client.get_paginator("list_available_management_cidr_ranges")  # (2)
for item in paginator.paginate(...):
    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)
) -> _PageIterator[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