Skip to content

Paginators

Index > Kafka > Paginators

Auto-generated documentation for Kafka type annotations stubs module types-aiobotocore-kafka.

ListClusterOperationsPaginator

Type annotations and code completion for session.client("kafka").get_paginator("list_cluster_operations"). boto3 documentation

Usage example
from aioboto3.session import Session

from types_aiobotocore_kafka.paginator import ListClusterOperationsPaginator

session = Session()

session = get_session()
async with session.client("kafka") as client:  # (1)
    paginator: ListClusterOperationsPaginator = client.get_paginator("list_cluster_operations")  # (2)
    async for item in paginator.paginate(...):
        item: ListClusterOperationsResponseTypeDef
        print(item)  # (3)
  1. client: KafkaClient
  2. paginator: ListClusterOperationsPaginator
  3. item: ListClusterOperationsResponseTypeDef

paginate

Type annotations and code completion for ListClusterOperationsPaginator.paginate method.

Method definition
def paginate(
    self,
    *,
    ClusterArn: str,
    PaginationConfig: PaginatorConfigTypeDef = ...,  # (1)
) -> AsyncIterator[ListClusterOperationsResponseTypeDef]:  # (2)
    ...
  1. See PaginatorConfigTypeDef
  2. See ListClusterOperationsResponseTypeDef
Usage example with kwargs
kwargs: ListClusterOperationsRequestListClusterOperationsPaginateTypeDef = {  # (1)
    "ClusterArn": ...,
}

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

ListClustersPaginator

Type annotations and code completion for session.client("kafka").get_paginator("list_clusters"). boto3 documentation

Usage example
from aioboto3.session import Session

from types_aiobotocore_kafka.paginator import ListClustersPaginator

session = Session()

session = get_session()
async with session.client("kafka") as client:  # (1)
    paginator: ListClustersPaginator = client.get_paginator("list_clusters")  # (2)
    async for item in paginator.paginate(...):
        item: ListClustersResponseTypeDef
        print(item)  # (3)
  1. client: KafkaClient
  2. paginator: ListClustersPaginator
  3. item: ListClustersResponseTypeDef

paginate

Type annotations and code completion for ListClustersPaginator.paginate method.

Method definition
def paginate(
    self,
    *,
    ClusterNameFilter: str = ...,
    PaginationConfig: PaginatorConfigTypeDef = ...,  # (1)
) -> AsyncIterator[ListClustersResponseTypeDef]:  # (2)
    ...
  1. See PaginatorConfigTypeDef
  2. See ListClustersResponseTypeDef
Usage example with kwargs
kwargs: ListClustersRequestListClustersPaginateTypeDef = {  # (1)
    "ClusterNameFilter": ...,
}

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

ListClustersV2Paginator

Type annotations and code completion for session.client("kafka").get_paginator("list_clusters_v2"). boto3 documentation

Usage example
from aioboto3.session import Session

from types_aiobotocore_kafka.paginator import ListClustersV2Paginator

session = Session()

session = get_session()
async with session.client("kafka") as client:  # (1)
    paginator: ListClustersV2Paginator = client.get_paginator("list_clusters_v2")  # (2)
    async for item in paginator.paginate(...):
        item: ListClustersV2ResponseTypeDef
        print(item)  # (3)
  1. client: KafkaClient
  2. paginator: ListClustersV2Paginator
  3. item: ListClustersV2ResponseTypeDef

paginate

Type annotations and code completion for ListClustersV2Paginator.paginate method.

Method definition
def paginate(
    self,
    *,
    ClusterNameFilter: str = ...,
    ClusterTypeFilter: str = ...,
    PaginationConfig: PaginatorConfigTypeDef = ...,  # (1)
) -> AsyncIterator[ListClustersV2ResponseTypeDef]:  # (2)
    ...
  1. See PaginatorConfigTypeDef
  2. See ListClustersV2ResponseTypeDef
Usage example with kwargs
kwargs: ListClustersV2RequestListClustersV2PaginateTypeDef = {  # (1)
    "ClusterNameFilter": ...,
}

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

ListConfigurationRevisionsPaginator

Type annotations and code completion for session.client("kafka").get_paginator("list_configuration_revisions"). boto3 documentation

Usage example
from aioboto3.session import Session

from types_aiobotocore_kafka.paginator import ListConfigurationRevisionsPaginator

session = Session()

session = get_session()
async with session.client("kafka") as client:  # (1)
    paginator: ListConfigurationRevisionsPaginator = client.get_paginator("list_configuration_revisions")  # (2)
    async for item in paginator.paginate(...):
        item: ListConfigurationRevisionsResponseTypeDef
        print(item)  # (3)
  1. client: KafkaClient
  2. paginator: ListConfigurationRevisionsPaginator
  3. item: ListConfigurationRevisionsResponseTypeDef

paginate

Type annotations and code completion for ListConfigurationRevisionsPaginator.paginate method.

Method definition
def paginate(
    self,
    *,
    Arn: str,
    PaginationConfig: PaginatorConfigTypeDef = ...,  # (1)
) -> AsyncIterator[ListConfigurationRevisionsResponseTypeDef]:  # (2)
    ...
  1. See PaginatorConfigTypeDef
  2. See ListConfigurationRevisionsResponseTypeDef
Usage example with kwargs
kwargs: ListConfigurationRevisionsRequestListConfigurationRevisionsPaginateTypeDef = {  # (1)
    "Arn": ...,
}

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

ListConfigurationsPaginator

Type annotations and code completion for session.client("kafka").get_paginator("list_configurations"). boto3 documentation

Usage example
from aioboto3.session import Session

from types_aiobotocore_kafka.paginator import ListConfigurationsPaginator

session = Session()

session = get_session()
async with session.client("kafka") as client:  # (1)
    paginator: ListConfigurationsPaginator = client.get_paginator("list_configurations")  # (2)
    async for item in paginator.paginate(...):
        item: ListConfigurationsResponseTypeDef
        print(item)  # (3)
  1. client: KafkaClient
  2. paginator: ListConfigurationsPaginator
  3. item: ListConfigurationsResponseTypeDef

paginate

Type annotations and code completion for ListConfigurationsPaginator.paginate method.

Method definition
def paginate(
    self,
    *,
    PaginationConfig: PaginatorConfigTypeDef = ...,  # (1)
) -> AsyncIterator[ListConfigurationsResponseTypeDef]:  # (2)
    ...
  1. See PaginatorConfigTypeDef
  2. See ListConfigurationsResponseTypeDef
Usage example with kwargs
kwargs: ListConfigurationsRequestListConfigurationsPaginateTypeDef = {  # (1)
    "PaginationConfig": ...,
}

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

ListKafkaVersionsPaginator

Type annotations and code completion for session.client("kafka").get_paginator("list_kafka_versions"). boto3 documentation

Usage example
from aioboto3.session import Session

from types_aiobotocore_kafka.paginator import ListKafkaVersionsPaginator

session = Session()

session = get_session()
async with session.client("kafka") as client:  # (1)
    paginator: ListKafkaVersionsPaginator = client.get_paginator("list_kafka_versions")  # (2)
    async for item in paginator.paginate(...):
        item: ListKafkaVersionsResponseTypeDef
        print(item)  # (3)
  1. client: KafkaClient
  2. paginator: ListKafkaVersionsPaginator
  3. item: ListKafkaVersionsResponseTypeDef

paginate

Type annotations and code completion for ListKafkaVersionsPaginator.paginate method.

Method definition
def paginate(
    self,
    *,
    PaginationConfig: PaginatorConfigTypeDef = ...,  # (1)
) -> AsyncIterator[ListKafkaVersionsResponseTypeDef]:  # (2)
    ...
  1. See PaginatorConfigTypeDef
  2. See ListKafkaVersionsResponseTypeDef
Usage example with kwargs
kwargs: ListKafkaVersionsRequestListKafkaVersionsPaginateTypeDef = {  # (1)
    "PaginationConfig": ...,
}

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

ListNodesPaginator

Type annotations and code completion for session.client("kafka").get_paginator("list_nodes"). boto3 documentation

Usage example
from aioboto3.session import Session

from types_aiobotocore_kafka.paginator import ListNodesPaginator

session = Session()

session = get_session()
async with session.client("kafka") as client:  # (1)
    paginator: ListNodesPaginator = client.get_paginator("list_nodes")  # (2)
    async for item in paginator.paginate(...):
        item: ListNodesResponseTypeDef
        print(item)  # (3)
  1. client: KafkaClient
  2. paginator: ListNodesPaginator
  3. item: ListNodesResponseTypeDef

paginate

Type annotations and code completion for ListNodesPaginator.paginate method.

Method definition
def paginate(
    self,
    *,
    ClusterArn: str,
    PaginationConfig: PaginatorConfigTypeDef = ...,  # (1)
) -> AsyncIterator[ListNodesResponseTypeDef]:  # (2)
    ...
  1. See PaginatorConfigTypeDef
  2. See ListNodesResponseTypeDef
Usage example with kwargs
kwargs: ListNodesRequestListNodesPaginateTypeDef = {  # (1)
    "ClusterArn": ...,
}

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

ListScramSecretsPaginator

Type annotations and code completion for session.client("kafka").get_paginator("list_scram_secrets"). boto3 documentation

Usage example
from aioboto3.session import Session

from types_aiobotocore_kafka.paginator import ListScramSecretsPaginator

session = Session()

session = get_session()
async with session.client("kafka") as client:  # (1)
    paginator: ListScramSecretsPaginator = client.get_paginator("list_scram_secrets")  # (2)
    async for item in paginator.paginate(...):
        item: ListScramSecretsResponseTypeDef
        print(item)  # (3)
  1. client: KafkaClient
  2. paginator: ListScramSecretsPaginator
  3. item: ListScramSecretsResponseTypeDef

paginate

Type annotations and code completion for ListScramSecretsPaginator.paginate method.

Method definition
def paginate(
    self,
    *,
    ClusterArn: str,
    PaginationConfig: PaginatorConfigTypeDef = ...,  # (1)
) -> AsyncIterator[ListScramSecretsResponseTypeDef]:  # (2)
    ...
  1. See PaginatorConfigTypeDef
  2. See ListScramSecretsResponseTypeDef
Usage example with kwargs
kwargs: ListScramSecretsRequestListScramSecretsPaginateTypeDef = {  # (1)
    "ClusterArn": ...,
}

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