Paginators

Index > CloudHSMV2 > Paginators

Auto-generated documentation for CloudHSMV2 type annotations stubs module mypy-boto3-cloudhsmv2.

DescribeBackupsPaginator

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

# DescribeBackupsPaginator usage example

from boto3.session import Session

from mypy_boto3_cloudhsmv2.paginator import DescribeBackupsPaginator

def get_describe_backups_paginator() -> DescribeBackupsPaginator:
    return Session().client("cloudhsmv2").get_paginator("describe_backups")

# DescribeBackupsPaginator usage example with type annotations

from boto3.session import Session

from mypy_boto3_cloudhsmv2.paginator import DescribeBackupsPaginator

session = Session()

client = Session().client("cloudhsmv2")  # (1)
paginator: DescribeBackupsPaginator = client.get_paginator("describe_backups")  # (2)
for item in paginator.paginate(...):
    print(item)  # (3)

1. client: CloudHSMV2Client
2. paginator: DescribeBackupsPaginator
3. item: DescribeBackupsResponseTypeDef

paginate

Type annotations and code completion for DescribeBackupsPaginator.paginate method.

# paginate method definition

def paginate(
    self,
    *,
    Filters: Mapping[str, Sequence[str]] = ...,
    Shared: bool = ...,
    SortAscending: bool = ...,
    PaginationConfig: PaginatorConfigTypeDef = ...,  # (1)
) -> _PageIterator[DescribeBackupsResponseTypeDef]:  # (2)
    ...

1. See PaginatorConfigTypeDef
2. See DescribeBackupsResponseTypeDef

# paginate method usage example with argument unpacking

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

parent.paginate(**kwargs)

1. See DescribeBackupsRequestDescribeBackupsPaginateTypeDef

DescribeClustersPaginator

Type annotations and code completion for boto3.client("cloudhsmv2").get_paginator("describe_clusters"). boto3 documentation

# DescribeClustersPaginator usage example

from boto3.session import Session

from mypy_boto3_cloudhsmv2.paginator import DescribeClustersPaginator

def get_describe_clusters_paginator() -> DescribeClustersPaginator:
    return Session().client("cloudhsmv2").get_paginator("describe_clusters")

# DescribeClustersPaginator usage example with type annotations

from boto3.session import Session

from mypy_boto3_cloudhsmv2.paginator import DescribeClustersPaginator

session = Session()

client = Session().client("cloudhsmv2")  # (1)
paginator: DescribeClustersPaginator = client.get_paginator("describe_clusters")  # (2)
for item in paginator.paginate(...):
    print(item)  # (3)

1. client: CloudHSMV2Client
2. paginator: DescribeClustersPaginator
3. item: DescribeClustersResponseTypeDef

paginate

Type annotations and code completion for DescribeClustersPaginator.paginate method.

# paginate method definition

def paginate(
    self,
    *,
    Filters: Mapping[str, Sequence[str]] = ...,
    PaginationConfig: PaginatorConfigTypeDef = ...,  # (1)
) -> _PageIterator[DescribeClustersResponseTypeDef]:  # (2)
    ...

1. See PaginatorConfigTypeDef
2. See DescribeClustersResponseTypeDef

# paginate method usage example with argument unpacking

kwargs: DescribeClustersRequestDescribeClustersPaginateTypeDef = {  # (1)
    "Filters": ...,
}

parent.paginate(**kwargs)

1. See DescribeClustersRequestDescribeClustersPaginateTypeDef

ListTagsPaginator

Type annotations and code completion for boto3.client("cloudhsmv2").get_paginator("list_tags"). boto3 documentation

# ListTagsPaginator usage example

from boto3.session import Session

from mypy_boto3_cloudhsmv2.paginator import ListTagsPaginator

def get_list_tags_paginator() -> ListTagsPaginator:
    return Session().client("cloudhsmv2").get_paginator("list_tags")

# ListTagsPaginator usage example with type annotations

from boto3.session import Session

from mypy_boto3_cloudhsmv2.paginator import ListTagsPaginator

session = Session()

client = Session().client("cloudhsmv2")  # (1)
paginator: ListTagsPaginator = client.get_paginator("list_tags")  # (2)
for item in paginator.paginate(...):
    print(item)  # (3)

1. client: CloudHSMV2Client
2. paginator: ListTagsPaginator
3. item: ListTagsResponseTypeDef

paginate

Type annotations and code completion for ListTagsPaginator.paginate method.

# paginate method definition

def paginate(
    self,
    *,
    ResourceId: str,
    PaginationConfig: PaginatorConfigTypeDef = ...,  # (1)
) -> _PageIterator[ListTagsResponseTypeDef]:  # (2)
    ...

1. See PaginatorConfigTypeDef
2. See ListTagsResponseTypeDef

# paginate method usage example with argument unpacking

kwargs: ListTagsRequestListTagsPaginateTypeDef = {  # (1)
    "ResourceId": ...,
}

parent.paginate(**kwargs)

1. See ListTagsRequestListTagsPaginateTypeDef