Kafka module#
Index > Kafka
Auto-generated documentation for Kafka type annotations stubs module types-boto3-kafka.
How to install#
Generate locally (recommended)#
You can generate type annotations for boto3
package locally with mypy-boto3-builder
.
Use uv for build isolation.
- Run mypy-boto3-builder in your package root directory:
uvx --with 'boto3==1.36.26' mypy-boto3-builder
- Select
boto3
AWS SDK. - Add
Kafka
service. - 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 Kafka
.
From PyPI with pip#
Install types-boto3
for Kafka
service.
# install with boto3 type annotations
python -m pip install 'types-boto3[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-boto3-lite[kafka]'
# standalone installation
python -m pip install types-boto3-kafka
How to uninstall#
python -m pip uninstall -y types-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 types_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 types_boto3_kafka.paginator import ListClientVpcConnectionsPaginator
def get_list_client_vpc_connections_paginator() -> ListClientVpcConnectionsPaginator:
return Session().client("kafka").get_paginator("list_client_vpc_connections"))
- ListClientVpcConnectionsPaginator
- ListClusterOperationsPaginator
- ListClusterOperationsV2Paginator
- ListClustersPaginator
- ListClustersV2Paginator
- ListConfigurationRevisionsPaginator
- ListConfigurationsPaginator
- ListKafkaVersionsPaginator
- ListNodesPaginator
- ListReplicatorsPaginator
- ListScramSecretsPaginator
- ListVpcConnectionsPaginator
Literals#
Type annotations for literals used in methods and schema.
# BrokerAZDistributionType usage example
from types_boto3_kafka.literals import BrokerAZDistributionType
def get_value() -> BrokerAZDistributionType:
return "DEFAULT"
- BrokerAZDistributionType
- ClientBrokerType
- ClusterStateType
- ClusterTypeType
- ConfigurationStateType
- CustomerActionStatusType
- EnhancedMonitoringType
- KafkaVersionStatusType
- ListClientVpcConnectionsPaginatorName
- ListClusterOperationsPaginatorName
- ListClusterOperationsV2PaginatorName
- ListClustersPaginatorName
- ListClustersV2PaginatorName
- ListConfigurationRevisionsPaginatorName
- ListConfigurationsPaginatorName
- ListKafkaVersionsPaginatorName
- ListNodesPaginatorName
- ListReplicatorsPaginatorName
- ListScramSecretsPaginatorName
- ListVpcConnectionsPaginatorName
- NodeTypeType
- ReplicationStartingPositionTypeType
- ReplicationTopicNameConfigurationTypeType
- ReplicatorStateType
- StorageModeType
- TargetCompressionTypeType
- UserIdentityTypeType
- VpcConnectionStateType
- KafkaServiceName
- ServiceName
- ResourceServiceName
- PaginatorName
- RegionName
Type definitions#
Type annotations for type definitions used in methods and schema.
- AmazonMskClusterTypeDef
- BatchAssociateScramSecretRequestTypeDef
- ResponseMetadataTypeDef
- UnprocessedScramSecretTypeDef
- BatchDisassociateScramSecretRequestTypeDef
- BlobTypeDef
- BrokerCountUpdateInfoTypeDef
- ProvisionedThroughputTypeDef
- CloudWatchLogsTypeDef
- FirehoseTypeDef
- S3TypeDef
- BrokerSoftwareInfoTypeDef
- TlsOutputTypeDef
- UnauthenticatedTypeDef
- ClientVpcConnectionTypeDef
- StateInfoTypeDef
- ErrorInfoTypeDef
- ClusterOperationStepInfoTypeDef
- ClusterOperationV2SummaryTypeDef
- CompatibleKafkaVersionTypeDef
- ConfigurationInfoTypeDef
- ConfigurationRevisionTypeDef
- PublicAccessTypeDef
- ConsumerGroupReplicationOutputTypeDef
- ConsumerGroupReplicationTypeDef
- ConsumerGroupReplicationUpdateTypeDef
- ControllerNodeInfoTypeDef
- CreateVpcConnectionRequestTypeDef
- DeleteClusterPolicyRequestTypeDef
- DeleteClusterRequestTypeDef
- DeleteConfigurationRequestTypeDef
- DeleteReplicatorRequestTypeDef
- DeleteVpcConnectionRequestTypeDef
- DescribeClusterOperationRequestTypeDef
- DescribeClusterOperationV2RequestTypeDef
- DescribeClusterRequestTypeDef
- DescribeClusterV2RequestTypeDef
- DescribeConfigurationRequestTypeDef
- DescribeConfigurationRevisionRequestTypeDef
- DescribeReplicatorRequestTypeDef
- ReplicationStateInfoTypeDef
- DescribeVpcConnectionRequestTypeDef
- EncryptionAtRestTypeDef
- EncryptionInTransitTypeDef
- GetBootstrapBrokersRequestTypeDef
- GetClusterPolicyRequestTypeDef
- GetCompatibleKafkaVersionsRequestTypeDef
- IamTypeDef
- JmxExporterInfoTypeDef
- JmxExporterTypeDef
- KafkaClusterClientVpcConfigOutputTypeDef
- KafkaClusterClientVpcConfigTypeDef
- KafkaVersionTypeDef
- PaginatorConfigTypeDef
- ListClientVpcConnectionsRequestTypeDef
- ListClusterOperationsRequestTypeDef
- ListClusterOperationsV2RequestTypeDef
- ListClustersRequestTypeDef
- ListClustersV2RequestTypeDef
- ListConfigurationRevisionsRequestTypeDef
- ListConfigurationsRequestTypeDef
- ListKafkaVersionsRequestTypeDef
- ListNodesRequestTypeDef
- ListReplicatorsRequestTypeDef
- ListScramSecretsRequestTypeDef
- ListTagsForResourceRequestTypeDef
- ListVpcConnectionsRequestTypeDef
- VpcConnectionTypeDef
- NodeExporterInfoTypeDef
- NodeExporterTypeDef
- ZookeeperNodeInfoTypeDef
- PutClusterPolicyRequestTypeDef
- RebootBrokerRequestTypeDef
- RejectClientVpcConnectionRequestTypeDef
- ReplicationInfoSummaryTypeDef
- ReplicationStartingPositionTypeDef
- ReplicationTopicNameConfigurationTypeDef
- ScramTypeDef
- VpcConfigOutputTypeDef
- TagResourceRequestTypeDef
- TlsTypeDef
- TopicReplicationUpdateTypeDef
- UntagResourceRequestTypeDef
- UpdateBrokerCountRequestTypeDef
- UpdateBrokerTypeRequestTypeDef
- UserIdentityTypeDef
- VpcConfigTypeDef
- VpcConnectivityTlsTypeDef
- VpcConnectivityIamTypeDef
- VpcConnectivityScramTypeDef
- KafkaClusterSummaryTypeDef
- CreateClusterResponseTypeDef
- CreateClusterV2ResponseTypeDef
- CreateReplicatorResponseTypeDef
- CreateVpcConnectionResponseTypeDef
- DeleteClusterResponseTypeDef
- DeleteConfigurationResponseTypeDef
- DeleteReplicatorResponseTypeDef
- DeleteVpcConnectionResponseTypeDef
- DescribeConfigurationRevisionResponseTypeDef
- DescribeVpcConnectionResponseTypeDef
- EmptyResponseMetadataTypeDef
- GetBootstrapBrokersResponseTypeDef
- GetClusterPolicyResponseTypeDef
- ListScramSecretsResponseTypeDef
- ListTagsForResourceResponseTypeDef
- PutClusterPolicyResponseTypeDef
- RebootBrokerResponseTypeDef
- UpdateBrokerCountResponseTypeDef
- UpdateBrokerStorageResponseTypeDef
- UpdateBrokerTypeResponseTypeDef
- UpdateClusterConfigurationResponseTypeDef
- UpdateClusterKafkaVersionResponseTypeDef
- UpdateConnectivityResponseTypeDef
- UpdateMonitoringResponseTypeDef
- UpdateReplicationInfoResponseTypeDef
- UpdateSecurityResponseTypeDef
- UpdateStorageResponseTypeDef
- BatchAssociateScramSecretResponseTypeDef
- BatchDisassociateScramSecretResponseTypeDef
- CreateConfigurationRequestTypeDef
- UpdateConfigurationRequestTypeDef
- BrokerEBSVolumeInfoTypeDef
- EBSStorageInfoTypeDef
- UpdateStorageRequestTypeDef
- BrokerLogsTypeDef
- BrokerNodeInfoTypeDef
- ListClientVpcConnectionsResponseTypeDef
- ClusterOperationStepTypeDef
- ListClusterOperationsV2ResponseTypeDef
- GetCompatibleKafkaVersionsResponseTypeDef
- UpdateClusterConfigurationRequestTypeDef
- UpdateClusterKafkaVersionRequestTypeDef
- ConfigurationTypeDef
- CreateConfigurationResponseTypeDef
- DescribeConfigurationResponseTypeDef
- ListConfigurationRevisionsResponseTypeDef
- UpdateConfigurationResponseTypeDef
- ConsumerGroupReplicationUnionTypeDef
- EncryptionInfoTypeDef
- ServerlessSaslTypeDef
- KafkaClusterDescriptionTypeDef
- KafkaClusterClientVpcConfigUnionTypeDef
- ListKafkaVersionsResponseTypeDef
- ListClientVpcConnectionsRequestPaginateTypeDef
- ListClusterOperationsRequestPaginateTypeDef
- ListClusterOperationsV2RequestPaginateTypeDef
- ListClustersRequestPaginateTypeDef
- ListClustersV2RequestPaginateTypeDef
- ListConfigurationRevisionsRequestPaginateTypeDef
- ListConfigurationsRequestPaginateTypeDef
- ListKafkaVersionsRequestPaginateTypeDef
- ListNodesRequestPaginateTypeDef
- ListReplicatorsRequestPaginateTypeDef
- ListScramSecretsRequestPaginateTypeDef
- ListVpcConnectionsRequestPaginateTypeDef
- ListVpcConnectionsResponseTypeDef
- PrometheusInfoTypeDef
- PrometheusTypeDef
- TopicReplicationOutputTypeDef
- TopicReplicationTypeDef
- SaslTypeDef
- TlsUnionTypeDef
- UpdateReplicationInfoRequestTypeDef
- VpcConnectionInfoServerlessTypeDef
- VpcConnectionInfoTypeDef
- VpcConfigUnionTypeDef
- VpcConnectivitySaslTypeDef
- ReplicatorSummaryTypeDef
- UpdateBrokerStorageRequestTypeDef
- StorageInfoTypeDef
- LoggingInfoTypeDef
- NodeInfoTypeDef
- ListConfigurationsResponseTypeDef
- ServerlessClientAuthenticationTypeDef
- KafkaClusterTypeDef
- OpenMonitoringInfoTypeDef
- OpenMonitoringTypeDef
- ReplicationInfoDescriptionTypeDef
- TopicReplicationUnionTypeDef
- ClientAuthenticationOutputTypeDef
- ClientAuthenticationTypeDef
- ClusterOperationV2ServerlessTypeDef
- VpcConnectivityClientAuthenticationTypeDef
- ListReplicatorsResponseTypeDef
- ListNodesResponseTypeDef
- ServerlessRequestTypeDef
- ServerlessTypeDef
- UpdateMonitoringRequestTypeDef
- DescribeReplicatorResponseTypeDef
- ReplicationInfoTypeDef
- ClientAuthenticationUnionTypeDef
- VpcConnectivityTypeDef
- CreateReplicatorRequestTypeDef
- UpdateSecurityRequestTypeDef
- ConnectivityInfoTypeDef
- BrokerNodeGroupInfoOutputTypeDef
- BrokerNodeGroupInfoTypeDef
- MutableClusterInfoTypeDef
- UpdateConnectivityRequestTypeDef
- ClusterInfoTypeDef
- ProvisionedTypeDef
- BrokerNodeGroupInfoUnionTypeDef
- ClusterOperationInfoTypeDef
- ClusterOperationV2ProvisionedTypeDef
- DescribeClusterResponseTypeDef
- ListClustersResponseTypeDef
- ClusterTypeDef
- CreateClusterRequestTypeDef
- ProvisionedRequestTypeDef
- DescribeClusterOperationResponseTypeDef
- ListClusterOperationsResponseTypeDef
- ClusterOperationV2TypeDef
- DescribeClusterV2ResponseTypeDef
- ListClustersV2ResponseTypeDef
- CreateClusterV2RequestTypeDef
- DescribeClusterOperationV2ResponseTypeDef