Skip to content

Kafka module#

Index > Kafka

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

How to install#

From PyPI with pip#

Install types-aiobotocore for Kafka service.

# install with aiobotocore type annotations
python -m pip install 'types-aiobotocore[kafka]'


# Lite version does not provide session.client/resource overloads
# it is more RAM-friendly, but requires explicit type annotations
python -m pip install 'types-aiobotocore-lite[kafka]'


# standalone installation
python -m pip install types-aiobotocore-kafka

How to uninstall#

python -m pip uninstall -y types-aiobotocore-kafka

Usage#

Code samples can be found in Examples.

KafkaClient#

Type annotations and code completion for session.create_client("kafka") as KafkaClient boto3 documentation

# KafkaClient usage example

from aiobotocore.session import get_session

from types_aiobotocore_kafka.client import KafkaClient


session = get_session()
async with session.create_client("kafka") as client:
    client: KafkaClient

Paginators#

Type annotations and code completion for paginators from session.create_client("kafka").get_paginator("...").

# ListClientVpcConnectionsPaginator usage example

from types_aiobotocore_kafka.paginator import ListClientVpcConnectionsPaginator

def get_list_client_vpc_connections_paginator() -> ListClientVpcConnectionsPaginator:
    return client.get_paginator("list_client_vpc_connections"))

Literals#

Type annotations for literals used in methods and schema.

# BrokerAZDistributionType usage example

from types_aiobotocore_kafka.literals import BrokerAZDistributionType

def get_value() -> BrokerAZDistributionType:
    return "DEFAULT"

Type definitions#

Type annotations for type definitions used in methods and schema.