Skip to content

Paginators#

Index > Kafka > Paginators

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

ListClientVpcConnectionsPaginator#

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

# ListClientVpcConnectionsPaginator usage example

from boto3.session import Session

from types_boto3_kafka.paginator import ListClientVpcConnectionsPaginator

def get_list_client_vpc_connections_paginator() -> ListClientVpcConnectionsPaginator:
    return Session().client("kafka").get_paginator("list_client_vpc_connections")
# ListClientVpcConnectionsPaginator usage example with type annotations

from boto3.session import Session

from types_boto3_kafka.paginator import ListClientVpcConnectionsPaginator

session = Session()

client = Session().client("kafka")  # (1)
paginator: ListClientVpcConnectionsPaginator = client.get_paginator("list_client_vpc_connections")  # (2)
for item in paginator.paginate(...):
    print(item)  # (3)
  1. client: KafkaClient
  2. paginator: ListClientVpcConnectionsPaginator
  3. item: ListClientVpcConnectionsResponseTypeDef

paginate#

Type annotations and code completion for ListClientVpcConnectionsPaginator.paginate method.

# paginate method definition

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

kwargs: ListClientVpcConnectionsRequestPaginateTypeDef = {  # (1)
    "ClusterArn": ...,
}

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

ListClusterOperationsPaginator#

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

# ListClusterOperationsPaginator usage example

from boto3.session import Session

from types_boto3_kafka.paginator import ListClusterOperationsPaginator

def get_list_cluster_operations_paginator() -> ListClusterOperationsPaginator:
    return Session().client("kafka").get_paginator("list_cluster_operations")
# ListClusterOperationsPaginator usage example with type annotations

from boto3.session import Session

from types_boto3_kafka.paginator import ListClusterOperationsPaginator

session = Session()

client = Session().client("kafka")  # (1)
paginator: ListClusterOperationsPaginator = client.get_paginator("list_cluster_operations")  # (2)
for item in paginator.paginate(...):
    print(item)  # (3)
  1. client: KafkaClient
  2. paginator: ListClusterOperationsPaginator
  3. item: ListClusterOperationsResponseTypeDef

paginate#

Type annotations and code completion for ListClusterOperationsPaginator.paginate method.

# paginate method definition

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

kwargs: ListClusterOperationsRequestPaginateTypeDef = {  # (1)
    "ClusterArn": ...,
}

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

ListClusterOperationsV2Paginator#

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

# ListClusterOperationsV2Paginator usage example

from boto3.session import Session

from types_boto3_kafka.paginator import ListClusterOperationsV2Paginator

def get_list_cluster_operations_v2_paginator() -> ListClusterOperationsV2Paginator:
    return Session().client("kafka").get_paginator("list_cluster_operations_v2")
# ListClusterOperationsV2Paginator usage example with type annotations

from boto3.session import Session

from types_boto3_kafka.paginator import ListClusterOperationsV2Paginator

session = Session()

client = Session().client("kafka")  # (1)
paginator: ListClusterOperationsV2Paginator = client.get_paginator("list_cluster_operations_v2")  # (2)
for item in paginator.paginate(...):
    print(item)  # (3)
  1. client: KafkaClient
  2. paginator: ListClusterOperationsV2Paginator
  3. item: ListClusterOperationsV2ResponseTypeDef

paginate#

Type annotations and code completion for ListClusterOperationsV2Paginator.paginate method.

# paginate method definition

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

kwargs: ListClusterOperationsV2RequestPaginateTypeDef = {  # (1)
    "ClusterArn": ...,
}

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

ListClustersPaginator#

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

# ListClustersPaginator usage example

from boto3.session import Session

from types_boto3_kafka.paginator import ListClustersPaginator

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

from boto3.session import Session

from types_boto3_kafka.paginator import ListClustersPaginator

session = Session()

client = Session().client("kafka")  # (1)
paginator: ListClustersPaginator = client.get_paginator("list_clusters")  # (2)
for item in paginator.paginate(...):
    print(item)  # (3)
  1. client: KafkaClient
  2. paginator: ListClustersPaginator
  3. item: ListClustersResponseTypeDef

paginate#

Type annotations and code completion for ListClustersPaginator.paginate method.

# paginate method definition

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

kwargs: ListClustersRequestPaginateTypeDef = {  # (1)
    "ClusterNameFilter": ...,
}

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

ListClustersV2Paginator#

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

# ListClustersV2Paginator usage example

from boto3.session import Session

from types_boto3_kafka.paginator import ListClustersV2Paginator

def get_list_clusters_v2_paginator() -> ListClustersV2Paginator:
    return Session().client("kafka").get_paginator("list_clusters_v2")
# ListClustersV2Paginator usage example with type annotations

from boto3.session import Session

from types_boto3_kafka.paginator import ListClustersV2Paginator

session = Session()

client = Session().client("kafka")  # (1)
paginator: ListClustersV2Paginator = client.get_paginator("list_clusters_v2")  # (2)
for item in paginator.paginate(...):
    print(item)  # (3)
  1. client: KafkaClient
  2. paginator: ListClustersV2Paginator
  3. item: ListClustersV2ResponseTypeDef

paginate#

Type annotations and code completion for ListClustersV2Paginator.paginate method.

# paginate method definition

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

kwargs: ListClustersV2RequestPaginateTypeDef = {  # (1)
    "ClusterNameFilter": ...,
}

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

ListConfigurationRevisionsPaginator#

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

# ListConfigurationRevisionsPaginator usage example

from boto3.session import Session

from types_boto3_kafka.paginator import ListConfigurationRevisionsPaginator

def get_list_configuration_revisions_paginator() -> ListConfigurationRevisionsPaginator:
    return Session().client("kafka").get_paginator("list_configuration_revisions")
# ListConfigurationRevisionsPaginator usage example with type annotations

from boto3.session import Session

from types_boto3_kafka.paginator import ListConfigurationRevisionsPaginator

session = Session()

client = Session().client("kafka")  # (1)
paginator: ListConfigurationRevisionsPaginator = client.get_paginator("list_configuration_revisions")  # (2)
for item in paginator.paginate(...):
    print(item)  # (3)
  1. client: KafkaClient
  2. paginator: ListConfigurationRevisionsPaginator
  3. item: ListConfigurationRevisionsResponseTypeDef

paginate#

Type annotations and code completion for ListConfigurationRevisionsPaginator.paginate method.

# paginate method definition

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

kwargs: ListConfigurationRevisionsRequestPaginateTypeDef = {  # (1)
    "Arn": ...,
}

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

ListConfigurationsPaginator#

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

# ListConfigurationsPaginator usage example

from boto3.session import Session

from types_boto3_kafka.paginator import ListConfigurationsPaginator

def get_list_configurations_paginator() -> ListConfigurationsPaginator:
    return Session().client("kafka").get_paginator("list_configurations")
# ListConfigurationsPaginator usage example with type annotations

from boto3.session import Session

from types_boto3_kafka.paginator import ListConfigurationsPaginator

session = Session()

client = Session().client("kafka")  # (1)
paginator: ListConfigurationsPaginator = client.get_paginator("list_configurations")  # (2)
for item in paginator.paginate(...):
    print(item)  # (3)
  1. client: KafkaClient
  2. paginator: ListConfigurationsPaginator
  3. item: ListConfigurationsResponseTypeDef

paginate#

Type annotations and code completion for ListConfigurationsPaginator.paginate method.

# paginate method definition

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

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

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

ListKafkaVersionsPaginator#

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

# ListKafkaVersionsPaginator usage example

from boto3.session import Session

from types_boto3_kafka.paginator import ListKafkaVersionsPaginator

def get_list_kafka_versions_paginator() -> ListKafkaVersionsPaginator:
    return Session().client("kafka").get_paginator("list_kafka_versions")
# ListKafkaVersionsPaginator usage example with type annotations

from boto3.session import Session

from types_boto3_kafka.paginator import ListKafkaVersionsPaginator

session = Session()

client = Session().client("kafka")  # (1)
paginator: ListKafkaVersionsPaginator = client.get_paginator("list_kafka_versions")  # (2)
for item in paginator.paginate(...):
    print(item)  # (3)
  1. client: KafkaClient
  2. paginator: ListKafkaVersionsPaginator
  3. item: ListKafkaVersionsResponseTypeDef

paginate#

Type annotations and code completion for ListKafkaVersionsPaginator.paginate method.

# paginate method definition

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

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

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

ListNodesPaginator#

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

# ListNodesPaginator usage example

from boto3.session import Session

from types_boto3_kafka.paginator import ListNodesPaginator

def get_list_nodes_paginator() -> ListNodesPaginator:
    return Session().client("kafka").get_paginator("list_nodes")
# ListNodesPaginator usage example with type annotations

from boto3.session import Session

from types_boto3_kafka.paginator import ListNodesPaginator

session = Session()

client = Session().client("kafka")  # (1)
paginator: ListNodesPaginator = client.get_paginator("list_nodes")  # (2)
for item in paginator.paginate(...):
    print(item)  # (3)
  1. client: KafkaClient
  2. paginator: ListNodesPaginator
  3. item: ListNodesResponseTypeDef

paginate#

Type annotations and code completion for ListNodesPaginator.paginate method.

# paginate method definition

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

kwargs: ListNodesRequestPaginateTypeDef = {  # (1)
    "ClusterArn": ...,
}

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

ListReplicatorsPaginator#

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

# ListReplicatorsPaginator usage example

from boto3.session import Session

from types_boto3_kafka.paginator import ListReplicatorsPaginator

def get_list_replicators_paginator() -> ListReplicatorsPaginator:
    return Session().client("kafka").get_paginator("list_replicators")
# ListReplicatorsPaginator usage example with type annotations

from boto3.session import Session

from types_boto3_kafka.paginator import ListReplicatorsPaginator

session = Session()

client = Session().client("kafka")  # (1)
paginator: ListReplicatorsPaginator = client.get_paginator("list_replicators")  # (2)
for item in paginator.paginate(...):
    print(item)  # (3)
  1. client: KafkaClient
  2. paginator: ListReplicatorsPaginator
  3. item: ListReplicatorsResponseTypeDef

paginate#

Type annotations and code completion for ListReplicatorsPaginator.paginate method.

# paginate method definition

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

kwargs: ListReplicatorsRequestPaginateTypeDef = {  # (1)
    "ReplicatorNameFilter": ...,
}

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

ListScramSecretsPaginator#

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

# ListScramSecretsPaginator usage example

from boto3.session import Session

from types_boto3_kafka.paginator import ListScramSecretsPaginator

def get_list_scram_secrets_paginator() -> ListScramSecretsPaginator:
    return Session().client("kafka").get_paginator("list_scram_secrets")
# ListScramSecretsPaginator usage example with type annotations

from boto3.session import Session

from types_boto3_kafka.paginator import ListScramSecretsPaginator

session = Session()

client = Session().client("kafka")  # (1)
paginator: ListScramSecretsPaginator = client.get_paginator("list_scram_secrets")  # (2)
for item in paginator.paginate(...):
    print(item)  # (3)
  1. client: KafkaClient
  2. paginator: ListScramSecretsPaginator
  3. item: ListScramSecretsResponseTypeDef

paginate#

Type annotations and code completion for ListScramSecretsPaginator.paginate method.

# paginate method definition

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

kwargs: ListScramSecretsRequestPaginateTypeDef = {  # (1)
    "ClusterArn": ...,
}

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

ListVpcConnectionsPaginator#

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

# ListVpcConnectionsPaginator usage example

from boto3.session import Session

from types_boto3_kafka.paginator import ListVpcConnectionsPaginator

def get_list_vpc_connections_paginator() -> ListVpcConnectionsPaginator:
    return Session().client("kafka").get_paginator("list_vpc_connections")
# ListVpcConnectionsPaginator usage example with type annotations

from boto3.session import Session

from types_boto3_kafka.paginator import ListVpcConnectionsPaginator

session = Session()

client = Session().client("kafka")  # (1)
paginator: ListVpcConnectionsPaginator = client.get_paginator("list_vpc_connections")  # (2)
for item in paginator.paginate(...):
    print(item)  # (3)
  1. client: KafkaClient
  2. paginator: ListVpcConnectionsPaginator
  3. item: ListVpcConnectionsResponseTypeDef

paginate#

Type annotations and code completion for ListVpcConnectionsPaginator.paginate method.

# paginate method definition

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

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

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