Skip to content

Paginators#

Index > FSx > Paginators

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

DescribeBackupsPaginator#

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

# DescribeBackupsPaginator usage example

from boto3.session import Session

from types_boto3_fsx.paginator import DescribeBackupsPaginator

def get_describe_backups_paginator() -> DescribeBackupsPaginator:
    return Session().client("fsx").get_paginator("describe_backups")
# DescribeBackupsPaginator usage example with type annotations

from boto3.session import Session

from types_boto3_fsx.paginator import DescribeBackupsPaginator

session = Session()

client = Session().client("fsx")  # (1)
paginator: DescribeBackupsPaginator = client.get_paginator("describe_backups")  # (2)
for item in paginator.paginate(...):
    print(item)  # (3)
  1. client: FSxClient
  2. paginator: DescribeBackupsPaginator
  3. item: PageIterator[DescribeBackupsResponsePaginatorTypeDef]

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)
) -> botocore.paginate.PageIterator[DescribeBackupsResponsePaginatorTypeDef]:  # (3)
    ...
  1. See Sequence[FilterTypeDef]
  2. See PaginatorConfigTypeDef
  3. See PageIterator[DescribeBackupsResponsePaginatorTypeDef]
# paginate method usage example with argument unpacking

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

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

DescribeFileSystemsPaginator#

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

# DescribeFileSystemsPaginator usage example

from boto3.session import Session

from types_boto3_fsx.paginator import DescribeFileSystemsPaginator

def get_describe_file_systems_paginator() -> DescribeFileSystemsPaginator:
    return Session().client("fsx").get_paginator("describe_file_systems")
# DescribeFileSystemsPaginator usage example with type annotations

from boto3.session import Session

from types_boto3_fsx.paginator import DescribeFileSystemsPaginator

session = Session()

client = Session().client("fsx")  # (1)
paginator: DescribeFileSystemsPaginator = client.get_paginator("describe_file_systems")  # (2)
for item in paginator.paginate(...):
    print(item)  # (3)
  1. client: FSxClient
  2. paginator: DescribeFileSystemsPaginator
  3. item: PageIterator[DescribeFileSystemsResponsePaginatorTypeDef]

paginate#

Type annotations and code completion for DescribeFileSystemsPaginator.paginate method.

# paginate method definition

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

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

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

DescribeS3AccessPointAttachmentsPaginator#

Type annotations and code completion for boto3.client("fsx").get_paginator("describe_s3_access_point_attachments"). boto3 documentation

# DescribeS3AccessPointAttachmentsPaginator usage example

from boto3.session import Session

from types_boto3_fsx.paginator import DescribeS3AccessPointAttachmentsPaginator

def get_describe_s3_access_point_attachments_paginator() -> DescribeS3AccessPointAttachmentsPaginator:
    return Session().client("fsx").get_paginator("describe_s3_access_point_attachments")
# DescribeS3AccessPointAttachmentsPaginator usage example with type annotations

from boto3.session import Session

from types_boto3_fsx.paginator import DescribeS3AccessPointAttachmentsPaginator

session = Session()

client = Session().client("fsx")  # (1)
paginator: DescribeS3AccessPointAttachmentsPaginator = client.get_paginator("describe_s3_access_point_attachments")  # (2)
for item in paginator.paginate(...):
    print(item)  # (3)
  1. client: FSxClient
  2. paginator: DescribeS3AccessPointAttachmentsPaginator
  3. item: PageIterator[DescribeS3AccessPointAttachmentsResponseTypeDef]

paginate#

Type annotations and code completion for DescribeS3AccessPointAttachmentsPaginator.paginate method.

# paginate method definition

def paginate(
    self,
    *,
    Names: Sequence[str] = ...,
    Filters: Sequence[S3AccessPointAttachmentsFilterTypeDef] = ...,  # (1)
    PaginationConfig: PaginatorConfigTypeDef = ...,  # (2)
) -> botocore.paginate.PageIterator[DescribeS3AccessPointAttachmentsResponseTypeDef]:  # (3)
    ...
  1. See Sequence[S3AccessPointAttachmentsFilterTypeDef]
  2. See PaginatorConfigTypeDef
  3. See PageIterator[DescribeS3AccessPointAttachmentsResponseTypeDef]
# paginate method usage example with argument unpacking

kwargs: DescribeS3AccessPointAttachmentsRequestPaginateTypeDef = {  # (1)
    "Names": ...,
}

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

DescribeSnapshotsPaginator#

Type annotations and code completion for boto3.client("fsx").get_paginator("describe_snapshots"). boto3 documentation

# DescribeSnapshotsPaginator usage example

from boto3.session import Session

from types_boto3_fsx.paginator import DescribeSnapshotsPaginator

def get_describe_snapshots_paginator() -> DescribeSnapshotsPaginator:
    return Session().client("fsx").get_paginator("describe_snapshots")
# DescribeSnapshotsPaginator usage example with type annotations

from boto3.session import Session

from types_boto3_fsx.paginator import DescribeSnapshotsPaginator

session = Session()

client = Session().client("fsx")  # (1)
paginator: DescribeSnapshotsPaginator = client.get_paginator("describe_snapshots")  # (2)
for item in paginator.paginate(...):
    print(item)  # (3)
  1. client: FSxClient
  2. paginator: DescribeSnapshotsPaginator
  3. item: PageIterator[DescribeSnapshotsResponsePaginatorTypeDef]

paginate#

Type annotations and code completion for DescribeSnapshotsPaginator.paginate method.

# paginate method definition

def paginate(
    self,
    *,
    SnapshotIds: Sequence[str] = ...,
    Filters: Sequence[SnapshotFilterTypeDef] = ...,  # (1)
    IncludeShared: bool = ...,
    PaginationConfig: PaginatorConfigTypeDef = ...,  # (2)
) -> botocore.paginate.PageIterator[DescribeSnapshotsResponsePaginatorTypeDef]:  # (3)
    ...
  1. See Sequence[SnapshotFilterTypeDef]
  2. See PaginatorConfigTypeDef
  3. See PageIterator[DescribeSnapshotsResponsePaginatorTypeDef]
# paginate method usage example with argument unpacking

kwargs: DescribeSnapshotsRequestPaginateTypeDef = {  # (1)
    "SnapshotIds": ...,
}

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

DescribeStorageVirtualMachinesPaginator#

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

# DescribeStorageVirtualMachinesPaginator usage example

from boto3.session import Session

from types_boto3_fsx.paginator import DescribeStorageVirtualMachinesPaginator

def get_describe_storage_virtual_machines_paginator() -> DescribeStorageVirtualMachinesPaginator:
    return Session().client("fsx").get_paginator("describe_storage_virtual_machines")
# DescribeStorageVirtualMachinesPaginator usage example with type annotations

from boto3.session import Session

from types_boto3_fsx.paginator import DescribeStorageVirtualMachinesPaginator

session = Session()

client = Session().client("fsx")  # (1)
paginator: DescribeStorageVirtualMachinesPaginator = client.get_paginator("describe_storage_virtual_machines")  # (2)
for item in paginator.paginate(...):
    print(item)  # (3)
  1. client: FSxClient
  2. paginator: DescribeStorageVirtualMachinesPaginator
  3. item: PageIterator[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)
) -> botocore.paginate.PageIterator[DescribeStorageVirtualMachinesResponseTypeDef]:  # (3)
    ...
  1. See Sequence[StorageVirtualMachineFilterTypeDef]
  2. See PaginatorConfigTypeDef
  3. See PageIterator[DescribeStorageVirtualMachinesResponseTypeDef]
# paginate method usage example with argument unpacking

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

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

DescribeVolumesPaginator#

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

# DescribeVolumesPaginator usage example

from boto3.session import Session

from types_boto3_fsx.paginator import DescribeVolumesPaginator

def get_describe_volumes_paginator() -> DescribeVolumesPaginator:
    return Session().client("fsx").get_paginator("describe_volumes")
# DescribeVolumesPaginator usage example with type annotations

from boto3.session import Session

from types_boto3_fsx.paginator import DescribeVolumesPaginator

session = Session()

client = Session().client("fsx")  # (1)
paginator: DescribeVolumesPaginator = client.get_paginator("describe_volumes")  # (2)
for item in paginator.paginate(...):
    print(item)  # (3)
  1. client: FSxClient
  2. paginator: DescribeVolumesPaginator
  3. item: PageIterator[DescribeVolumesResponsePaginatorTypeDef]

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)
) -> botocore.paginate.PageIterator[DescribeVolumesResponsePaginatorTypeDef]:  # (3)
    ...
  1. See Sequence[VolumeFilterTypeDef]
  2. See PaginatorConfigTypeDef
  3. See PageIterator[DescribeVolumesResponsePaginatorTypeDef]
# paginate method usage example with argument unpacking

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

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

ListTagsForResourcePaginator#

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

# ListTagsForResourcePaginator usage example

from boto3.session import Session

from types_boto3_fsx.paginator import ListTagsForResourcePaginator

def get_list_tags_for_resource_paginator() -> ListTagsForResourcePaginator:
    return Session().client("fsx").get_paginator("list_tags_for_resource")
# ListTagsForResourcePaginator usage example with type annotations

from boto3.session import Session

from types_boto3_fsx.paginator import ListTagsForResourcePaginator

session = Session()

client = Session().client("fsx")  # (1)
paginator: ListTagsForResourcePaginator = client.get_paginator("list_tags_for_resource")  # (2)
for item in paginator.paginate(...):
    print(item)  # (3)
  1. client: FSxClient
  2. paginator: ListTagsForResourcePaginator
  3. item: PageIterator[ListTagsForResourceResponseTypeDef]

paginate#

Type annotations and code completion for ListTagsForResourcePaginator.paginate method.

# paginate method definition

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

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

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