Paginators

Index > Kafka > Paginators

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

ListClusterOperationsPaginator

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

Usage example

from boto3.session import Session

from mypy_boto3_kafka.paginator import ListClusterOperationsPaginator

def get_list_cluster_operations_paginator() -> ListClusterOperationsPaginator:
    return Session().client("kafka").get_paginator("list_cluster_operations")

Usage example

from boto3.session import Session

from mypy_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.

Method definition

def paginate(
    self,
    *,
    ClusterArn: str,
    PaginationConfig: PaginatorConfigTypeDef = ...,  # (1)
) -> _PageIterator[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 boto3.client("kafka").get_paginator("list_clusters"). boto3 documentation

Usage example

from boto3.session import Session

from mypy_boto3_kafka.paginator import ListClustersPaginator

def get_list_clusters_paginator() -> ListClustersPaginator:
    return Session().client("kafka").get_paginator("list_clusters")

Usage example

from boto3.session import Session

from mypy_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.

Method definition

def paginate(
    self,
    *,
    ClusterNameFilter: str = ...,
    PaginationConfig: PaginatorConfigTypeDef = ...,  # (1)
) -> _PageIterator[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 boto3.client("kafka").get_paginator("list_clusters_v2"). boto3 documentation

Usage example

from boto3.session import Session

from mypy_boto3_kafka.paginator import ListClustersV2Paginator

def get_list_clusters_v2_paginator() -> ListClustersV2Paginator:
    return Session().client("kafka").get_paginator("list_clusters_v2")

Usage example

from boto3.session import Session

from mypy_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.

Method definition

def paginate(
    self,
    *,
    ClusterNameFilter: str = ...,
    ClusterTypeFilter: str = ...,
    PaginationConfig: PaginatorConfigTypeDef = ...,  # (1)
) -> _PageIterator[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 boto3.client("kafka").get_paginator("list_configuration_revisions"). boto3 documentation

Usage example

from boto3.session import Session

from mypy_boto3_kafka.paginator import ListConfigurationRevisionsPaginator

def get_list_configuration_revisions_paginator() -> ListConfigurationRevisionsPaginator:
    return Session().client("kafka").get_paginator("list_configuration_revisions")

Usage example

from boto3.session import Session

from mypy_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.

Method definition

def paginate(
    self,
    *,
    Arn: str,
    PaginationConfig: PaginatorConfigTypeDef = ...,  # (1)
) -> _PageIterator[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 boto3.client("kafka").get_paginator("list_configurations"). boto3 documentation

Usage example

from boto3.session import Session

from mypy_boto3_kafka.paginator import ListConfigurationsPaginator

def get_list_configurations_paginator() -> ListConfigurationsPaginator:
    return Session().client("kafka").get_paginator("list_configurations")

Usage example

from boto3.session import Session

from mypy_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.

Method definition

def paginate(
    self,
    *,
    PaginationConfig: PaginatorConfigTypeDef = ...,  # (1)
) -> _PageIterator[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 boto3.client("kafka").get_paginator("list_kafka_versions"). boto3 documentation

Usage example

from boto3.session import Session

from mypy_boto3_kafka.paginator import ListKafkaVersionsPaginator

def get_list_kafka_versions_paginator() -> ListKafkaVersionsPaginator:
    return Session().client("kafka").get_paginator("list_kafka_versions")

Usage example

from boto3.session import Session

from mypy_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.

Method definition

def paginate(
    self,
    *,
    PaginationConfig: PaginatorConfigTypeDef = ...,  # (1)
) -> _PageIterator[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 boto3.client("kafka").get_paginator("list_nodes"). boto3 documentation

Usage example

from boto3.session import Session

from mypy_boto3_kafka.paginator import ListNodesPaginator

def get_list_nodes_paginator() -> ListNodesPaginator:
    return Session().client("kafka").get_paginator("list_nodes")

Usage example

from boto3.session import Session

from mypy_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.

Method definition

def paginate(
    self,
    *,
    ClusterArn: str,
    PaginationConfig: PaginatorConfigTypeDef = ...,  # (1)
) -> _PageIterator[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 boto3.client("kafka").get_paginator("list_scram_secrets"). boto3 documentation

Usage example

from boto3.session import Session

from mypy_boto3_kafka.paginator import ListScramSecretsPaginator

def get_list_scram_secrets_paginator() -> ListScramSecretsPaginator:
    return Session().client("kafka").get_paginator("list_scram_secrets")

Usage example

from boto3.session import Session

from mypy_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.

Method definition

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

1. See PaginatorConfigTypeDef
2. See ListScramSecretsResponseTypeDef

Usage example with kwargs

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

parent.paginate(**kwargs)

1. See ListScramSecretsRequestListScramSecretsPaginateTypeDef