Skip to content

Kafka module#

Index > Kafka

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

How to install#

VSCode extension#

Add AWS Boto3 extension to your VSCode and run AWS boto3: Quick Start command.

Click Modify and select boto3 common and Kafka.

From PyPI with pip#

Install boto3-stubs for Kafka service.

# install with boto3 type annotations
python -m pip install 'boto3-stubs[kafka]'


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


# standalone installation
python -m pip install mypy-boto3-kafka

How to uninstall#

python -m pip uninstall -y mypy-boto3-kafka

Usage#

Code samples can be found in Examples.

KafkaClient#

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

# KafkaClient usage example

from boto3.session import Session

from mypy_boto3_kafka.client import KafkaClient

def get_client() -> KafkaClient:
    return Session().client("kafka")

Paginators#

Type annotations and code completion for paginators from boto3.client("kafka").get_paginator("...").

# ListClientVpcConnectionsPaginator usage example

from boto3.session import Session

from mypy_boto3_kafka.paginator import ListClientVpcConnectionsPaginator

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

Literals#

Type annotations for literals used in methods and schemas.

# BrokerAZDistributionType usage example

from mypy_boto3_kafka.literals import BrokerAZDistributionType

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

Typed dictionaries#

Type annotations for typed dictionaries used in methods and schema.

# BatchAssociateScramSecretRequestRequestTypeDef usage example

from mypy_boto3_kafka.type_defs import BatchAssociateScramSecretRequestRequestTypeDef

def get_value() -> BatchAssociateScramSecretRequestRequestTypeDef:
    return {
        "ClusterArn": ...,
        "SecretArnList": ...,
    }