Skip to content

Paginators#

Index > DocDBElastic > Paginators

Auto-generated documentation for DocDBElastic type annotations stubs module mypy-boto3-docdb-elastic.

ListClusterSnapshotsPaginator#

Type annotations and code completion for boto3.client("docdb-elastic").get_paginator("list_cluster_snapshots"). boto3 documentation

# ListClusterSnapshotsPaginator usage example

from boto3.session import Session

from mypy_boto3_docdb_elastic.paginator import ListClusterSnapshotsPaginator

def get_list_cluster_snapshots_paginator() -> ListClusterSnapshotsPaginator:
    return Session().client("docdb-elastic").get_paginator("list_cluster_snapshots")
# ListClusterSnapshotsPaginator usage example with type annotations

from boto3.session import Session

from mypy_boto3_docdb_elastic.paginator import ListClusterSnapshotsPaginator

session = Session()

client = Session().client("docdb-elastic")  # (1)
paginator: ListClusterSnapshotsPaginator = client.get_paginator("list_cluster_snapshots")  # (2)
for item in paginator.paginate(...):
    print(item)  # (3)
  1. client: DocDBElasticClient
  2. paginator: ListClusterSnapshotsPaginator
  3. item: ListClusterSnapshotsOutputTypeDef

paginate#

Type annotations and code completion for ListClusterSnapshotsPaginator.paginate method.

# paginate method definition

def paginate(
    self,
    *,
    clusterArn: str = ...,
    snapshotType: str = ...,
    PaginationConfig: PaginatorConfigTypeDef = ...,  # (1)
) -> _PageIterator[ListClusterSnapshotsOutputTypeDef]:  # (2)
    ...
  1. See PaginatorConfigTypeDef
  2. See ListClusterSnapshotsOutputTypeDef
# paginate method usage example with argument unpacking

kwargs: ListClusterSnapshotsInputListClusterSnapshotsPaginateTypeDef = {  # (1)
    "clusterArn": ...,
}

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

ListClustersPaginator#

Type annotations and code completion for boto3.client("docdb-elastic").get_paginator("list_clusters"). boto3 documentation

# ListClustersPaginator usage example

from boto3.session import Session

from mypy_boto3_docdb_elastic.paginator import ListClustersPaginator

def get_list_clusters_paginator() -> ListClustersPaginator:
    return Session().client("docdb-elastic").get_paginator("list_clusters")
# ListClustersPaginator usage example with type annotations

from boto3.session import Session

from mypy_boto3_docdb_elastic.paginator import ListClustersPaginator

session = Session()

client = Session().client("docdb-elastic")  # (1)
paginator: ListClustersPaginator = client.get_paginator("list_clusters")  # (2)
for item in paginator.paginate(...):
    print(item)  # (3)
  1. client: DocDBElasticClient
  2. paginator: ListClustersPaginator
  3. item: ListClustersOutputTypeDef

paginate#

Type annotations and code completion for ListClustersPaginator.paginate method.

# paginate method definition

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

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

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