Skip to content

KafkaConnect module#

Index > KafkaConnect

Auto-generated documentation for KafkaConnect type annotations stubs module mypy-boto3-kafkaconnect.

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 KafkaConnect.

From PyPI with pip#

Install boto3-stubs for KafkaConnect service.

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

# 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[kafkaconnect]'

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

How to uninstall#

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


Code samples can be found in Examples.


Type annotations and code completion for boto3.client("kafkaconnect") as KafkaConnectClient boto3 documentation

# KafkaConnectClient usage example

from boto3.session import Session

from mypy_boto3_kafkaconnect.client import KafkaConnectClient

def get_client() -> KafkaConnectClient:
    return Session().client("kafkaconnect")


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

# ListConnectorsPaginator usage example

from boto3.session import Session

from mypy_boto3_kafkaconnect.paginator import ListConnectorsPaginator

def get_list_connectors_paginator() -> ListConnectorsPaginator:
    return Session().client("kafkaconnect").get_paginator("list_connectors"))


Type annotations for literals used in methods and schemas.

# ConnectorStateType usage example

from mypy_boto3_kafkaconnect.literals import ConnectorStateType

def get_value() -> ConnectorStateType:
    return "CREATING"

Typed dictionaries#

Type annotations for typed dictionaries used in methods and schema.

# VpcDescriptionTypeDef usage example

from mypy_boto3_kafkaconnect.type_defs import VpcDescriptionTypeDef

def get_value() -> VpcDescriptionTypeDef:
    return {
        "securityGroups": ...,