Skip to content

Paginators#

Index > FSx > Paginators

Auto-generated documentation for FSx type annotations stubs module types-aiobotocore-fsx.

DescribeBackupsPaginator#

Type annotations and code completion for session.create_client("fsx").get_paginator("describe_backups"). boto3 documentation

# DescribeBackupsPaginator usage example

from aiobotocore.session import get_session

from types_aiobotocore_fsx.paginator import DescribeBackupsPaginator

session = get_session()
async with session.create_client("fsx") as client:  # (1)
    paginator: DescribeBackupsPaginator = client.get_paginator("describe_backups")  # (2)
    async for item in paginator.paginate(...):
        item: DescribeBackupsResponseTypeDef
        print(item)  # (3)
  1. client: FSxClient
  2. paginator: DescribeBackupsPaginator
  3. item: DescribeBackupsResponseTypeDef

paginate#

Type annotations and code completion for DescribeBackupsPaginator.paginate method.

# paginate method definition

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

kwargs: DescribeBackupsRequestDescribeBackupsPaginateTypeDef = {  # (1)
    "BackupIds": ...,
}

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

DescribeFileSystemsPaginator#

Type annotations and code completion for session.create_client("fsx").get_paginator("describe_file_systems"). boto3 documentation

# DescribeFileSystemsPaginator usage example

from aiobotocore.session import get_session

from types_aiobotocore_fsx.paginator import DescribeFileSystemsPaginator

session = get_session()
async with session.create_client("fsx") as client:  # (1)
    paginator: DescribeFileSystemsPaginator = client.get_paginator("describe_file_systems")  # (2)
    async for item in paginator.paginate(...):
        item: DescribeFileSystemsResponseTypeDef
        print(item)  # (3)
  1. client: FSxClient
  2. paginator: DescribeFileSystemsPaginator
  3. item: DescribeFileSystemsResponseTypeDef

paginate#

Type annotations and code completion for DescribeFileSystemsPaginator.paginate method.

# paginate method definition

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

kwargs: DescribeFileSystemsRequestDescribeFileSystemsPaginateTypeDef = {  # (1)
    "FileSystemIds": ...,
}

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

DescribeStorageVirtualMachinesPaginator#

Type annotations and code completion for session.create_client("fsx").get_paginator("describe_storage_virtual_machines"). boto3 documentation

# DescribeStorageVirtualMachinesPaginator usage example

from aiobotocore.session import get_session

from types_aiobotocore_fsx.paginator import DescribeStorageVirtualMachinesPaginator

session = get_session()
async with session.create_client("fsx") as client:  # (1)
    paginator: DescribeStorageVirtualMachinesPaginator = client.get_paginator("describe_storage_virtual_machines")  # (2)
    async for item in paginator.paginate(...):
        item: DescribeStorageVirtualMachinesResponseTypeDef
        print(item)  # (3)
  1. client: FSxClient
  2. paginator: DescribeStorageVirtualMachinesPaginator
  3. item: DescribeStorageVirtualMachinesResponseTypeDef

paginate#

Type annotations and code completion for DescribeStorageVirtualMachinesPaginator.paginate method.

# paginate method definition

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

kwargs: DescribeStorageVirtualMachinesRequestDescribeStorageVirtualMachinesPaginateTypeDef = {  # (1)
    "StorageVirtualMachineIds": ...,
}

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

DescribeVolumesPaginator#

Type annotations and code completion for session.create_client("fsx").get_paginator("describe_volumes"). boto3 documentation

# DescribeVolumesPaginator usage example

from aiobotocore.session import get_session

from types_aiobotocore_fsx.paginator import DescribeVolumesPaginator

session = get_session()
async with session.create_client("fsx") as client:  # (1)
    paginator: DescribeVolumesPaginator = client.get_paginator("describe_volumes")  # (2)
    async for item in paginator.paginate(...):
        item: DescribeVolumesResponseTypeDef
        print(item)  # (3)
  1. client: FSxClient
  2. paginator: DescribeVolumesPaginator
  3. item: DescribeVolumesResponseTypeDef

paginate#

Type annotations and code completion for DescribeVolumesPaginator.paginate method.

# paginate method definition

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

kwargs: DescribeVolumesRequestDescribeVolumesPaginateTypeDef = {  # (1)
    "VolumeIds": ...,
}

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

ListTagsForResourcePaginator#

Type annotations and code completion for session.create_client("fsx").get_paginator("list_tags_for_resource"). boto3 documentation

# ListTagsForResourcePaginator usage example

from aiobotocore.session import get_session

from types_aiobotocore_fsx.paginator import ListTagsForResourcePaginator

session = get_session()
async with session.create_client("fsx") as client:  # (1)
    paginator: ListTagsForResourcePaginator = client.get_paginator("list_tags_for_resource")  # (2)
    async for item in paginator.paginate(...):
        item: ListTagsForResourceResponseTypeDef
        print(item)  # (3)
  1. client: FSxClient
  2. paginator: ListTagsForResourcePaginator
  3. item: ListTagsForResourceResponseTypeDef

paginate#

Type annotations and code completion for ListTagsForResourcePaginator.paginate method.

# paginate method definition

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

kwargs: ListTagsForResourceRequestListTagsForResourcePaginateTypeDef = {  # (1)
    "ResourceARN": ...,
}

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