Skip to content

Paginators#

Index > DocDB > Paginators

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

DescribeCertificatesPaginator#

Type annotations and code completion for boto3.client("docdb").get_paginator("describe_certificates"). boto3 documentation

# DescribeCertificatesPaginator usage example

from boto3.session import Session

from mypy_boto3_docdb.paginator import DescribeCertificatesPaginator

def get_describe_certificates_paginator() -> DescribeCertificatesPaginator:
    return Session().client("docdb").get_paginator("describe_certificates")
# DescribeCertificatesPaginator usage example with type annotations

from boto3.session import Session

from mypy_boto3_docdb.paginator import DescribeCertificatesPaginator

session = Session()

client = Session().client("docdb")  # (1)
paginator: DescribeCertificatesPaginator = client.get_paginator("describe_certificates")  # (2)
for item in paginator.paginate(...):
    print(item)  # (3)
  1. client: DocDBClient
  2. paginator: DescribeCertificatesPaginator
  3. item: CertificateMessageTypeDef

paginate#

Type annotations and code completion for DescribeCertificatesPaginator.paginate method.

# paginate method definition

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

kwargs: DescribeCertificatesMessageDescribeCertificatesPaginateTypeDef = {  # (1)
    "CertificateIdentifier": ...,
}

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

DescribeDBClusterParameterGroupsPaginator#

Type annotations and code completion for boto3.client("docdb").get_paginator("describe_db_cluster_parameter_groups"). boto3 documentation

# DescribeDBClusterParameterGroupsPaginator usage example

from boto3.session import Session

from mypy_boto3_docdb.paginator import DescribeDBClusterParameterGroupsPaginator

def get_describe_db_cluster_parameter_groups_paginator() -> DescribeDBClusterParameterGroupsPaginator:
    return Session().client("docdb").get_paginator("describe_db_cluster_parameter_groups")
# DescribeDBClusterParameterGroupsPaginator usage example with type annotations

from boto3.session import Session

from mypy_boto3_docdb.paginator import DescribeDBClusterParameterGroupsPaginator

session = Session()

client = Session().client("docdb")  # (1)
paginator: DescribeDBClusterParameterGroupsPaginator = client.get_paginator("describe_db_cluster_parameter_groups")  # (2)
for item in paginator.paginate(...):
    print(item)  # (3)
  1. client: DocDBClient
  2. paginator: DescribeDBClusterParameterGroupsPaginator
  3. item: DBClusterParameterGroupsMessageTypeDef

paginate#

Type annotations and code completion for DescribeDBClusterParameterGroupsPaginator.paginate method.

# paginate method definition

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

kwargs: DescribeDBClusterParameterGroupsMessageDescribeDBClusterParameterGroupsPaginateTypeDef = {  # (1)
    "DBClusterParameterGroupName": ...,
}

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

DescribeDBClusterParametersPaginator#

Type annotations and code completion for boto3.client("docdb").get_paginator("describe_db_cluster_parameters"). boto3 documentation

# DescribeDBClusterParametersPaginator usage example

from boto3.session import Session

from mypy_boto3_docdb.paginator import DescribeDBClusterParametersPaginator

def get_describe_db_cluster_parameters_paginator() -> DescribeDBClusterParametersPaginator:
    return Session().client("docdb").get_paginator("describe_db_cluster_parameters")
# DescribeDBClusterParametersPaginator usage example with type annotations

from boto3.session import Session

from mypy_boto3_docdb.paginator import DescribeDBClusterParametersPaginator

session = Session()

client = Session().client("docdb")  # (1)
paginator: DescribeDBClusterParametersPaginator = client.get_paginator("describe_db_cluster_parameters")  # (2)
for item in paginator.paginate(...):
    print(item)  # (3)
  1. client: DocDBClient
  2. paginator: DescribeDBClusterParametersPaginator
  3. item: DBClusterParameterGroupDetailsTypeDef

paginate#

Type annotations and code completion for DescribeDBClusterParametersPaginator.paginate method.

# paginate method definition

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

kwargs: DescribeDBClusterParametersMessageDescribeDBClusterParametersPaginateTypeDef = {  # (1)
    "DBClusterParameterGroupName": ...,
}

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

DescribeDBClusterSnapshotsPaginator#

Type annotations and code completion for boto3.client("docdb").get_paginator("describe_db_cluster_snapshots"). boto3 documentation

# DescribeDBClusterSnapshotsPaginator usage example

from boto3.session import Session

from mypy_boto3_docdb.paginator import DescribeDBClusterSnapshotsPaginator

def get_describe_db_cluster_snapshots_paginator() -> DescribeDBClusterSnapshotsPaginator:
    return Session().client("docdb").get_paginator("describe_db_cluster_snapshots")
# DescribeDBClusterSnapshotsPaginator usage example with type annotations

from boto3.session import Session

from mypy_boto3_docdb.paginator import DescribeDBClusterSnapshotsPaginator

session = Session()

client = Session().client("docdb")  # (1)
paginator: DescribeDBClusterSnapshotsPaginator = client.get_paginator("describe_db_cluster_snapshots")  # (2)
for item in paginator.paginate(...):
    print(item)  # (3)
  1. client: DocDBClient
  2. paginator: DescribeDBClusterSnapshotsPaginator
  3. item: DBClusterSnapshotMessageTypeDef

paginate#

Type annotations and code completion for DescribeDBClusterSnapshotsPaginator.paginate method.

# paginate method definition

def paginate(
    self,
    *,
    DBClusterIdentifier: str = ...,
    DBClusterSnapshotIdentifier: str = ...,
    SnapshotType: str = ...,
    Filters: Sequence[FilterTypeDef] = ...,  # (1)
    IncludeShared: bool = ...,
    IncludePublic: bool = ...,
    PaginationConfig: PaginatorConfigTypeDef = ...,  # (2)
) -> _PageIterator[DBClusterSnapshotMessageTypeDef]:  # (3)
    ...
  1. See FilterTypeDef
  2. See PaginatorConfigTypeDef
  3. See DBClusterSnapshotMessageTypeDef 
# paginate method usage example with argument unpacking

kwargs: DescribeDBClusterSnapshotsMessageDescribeDBClusterSnapshotsPaginateTypeDef = {  # (1)
    "DBClusterIdentifier": ...,
}

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

DescribeDBClustersPaginator#

Type annotations and code completion for boto3.client("docdb").get_paginator("describe_db_clusters"). boto3 documentation

# DescribeDBClustersPaginator usage example

from boto3.session import Session

from mypy_boto3_docdb.paginator import DescribeDBClustersPaginator

def get_describe_db_clusters_paginator() -> DescribeDBClustersPaginator:
    return Session().client("docdb").get_paginator("describe_db_clusters")
# DescribeDBClustersPaginator usage example with type annotations

from boto3.session import Session

from mypy_boto3_docdb.paginator import DescribeDBClustersPaginator

session = Session()

client = Session().client("docdb")  # (1)
paginator: DescribeDBClustersPaginator = client.get_paginator("describe_db_clusters")  # (2)
for item in paginator.paginate(...):
    print(item)  # (3)
  1. client: DocDBClient
  2. paginator: DescribeDBClustersPaginator
  3. item: DBClusterMessageTypeDef

paginate#

Type annotations and code completion for DescribeDBClustersPaginator.paginate method.

# paginate method definition

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

kwargs: DescribeDBClustersMessageDescribeDBClustersPaginateTypeDef = {  # (1)
    "DBClusterIdentifier": ...,
}

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

DescribeDBEngineVersions