Skip to content

KafkaConnect module#

Index > KafkaConnect

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

How to install#

You can generate type annotations for boto3 package locally with mypy_boto3_builder. Use uv for build isolation.

  1. Run mypy-boto3-builder in your package root directory: uvx --with 'boto3==1.36.2' mypy_boto3_builder
  2. Select boto3-stubs AWS SDK.
  3. Add KafkaConnect service.
  4. Use provided commands to install generated packages.

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

Usage#

Code samples can be found in Examples.

KafkaConnectClient#

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")

Paginators#

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

# ListConnectorOperationsPaginator usage example

from boto3.session import Session

from mypy_boto3_kafkaconnect.paginator import ListConnectorOperationsPaginator

def get_list_connector_operations_paginator() -> ListConnectorOperationsPaginator:
    return Session().client("kafkaconnect").get_paginator("list_connector_operations"))

Literals#

Type annotations for literals used in methods and schema.

# ConnectorOperationStateType usage example

from mypy_boto3_kafkaconnect.literals import ConnectorOperationStateType

def get_value() -> ConnectorOperationStateType:
    return "PENDING"