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
Usage
Code samples can be found in Examples.
KafkaClient
Type annotations and code completion for boto3.client("kafka")
as KafkaClient
boto3 documentation
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("...")
.
Usage example
from boto3.session import Session
from mypy_boto3_kafka.paginator import ListClusterOperationsPaginator
def get_list_cluster_operations_paginator() -> ListClusterOperationsPaginator:
return Session().client("kafka").get_paginator("list_cluster_operations"))
- ListClusterOperationsPaginator
- ListClustersPaginator
- ListClustersV2Paginator
- ListConfigurationRevisionsPaginator
- ListConfigurationsPaginator
- ListKafkaVersionsPaginator
- ListNodesPaginator
- ListScramSecretsPaginator
Literals
Type annotations for literals used in methods and schemas.
Usage example
from mypy_boto3_kafka.literals import BrokerAZDistributionType
def get_value() -> BrokerAZDistributionType:
return "DEFAULT"
- BrokerAZDistributionType
- ClientBrokerType
- ClusterStateType
- ClusterTypeType
- ConfigurationStateType
- EnhancedMonitoringType
- KafkaVersionStatusType
- ListClusterOperationsPaginatorName
- ListClustersPaginatorName
- ListClustersV2PaginatorName
- ListConfigurationRevisionsPaginatorName
- ListConfigurationsPaginatorName
- ListKafkaVersionsPaginatorName
- ListNodesPaginatorName
- ListScramSecretsPaginatorName
- NodeTypeType
- StorageModeType
- KafkaServiceName
- ServiceName
- ResourceServiceName
- PaginatorName
- RegionName
Typed dictionaries
Type annotations for typed dictionaries used in methods and schema.
Usage example
from mypy_boto3_kafka.type_defs import BatchAssociateScramSecretRequestRequestTypeDef
def get_value() -> BatchAssociateScramSecretRequestRequestTypeDef:
return {
"ClusterArn": ...,
"SecretArnList": ...,
}
- BatchAssociateScramSecretRequestRequestTypeDef
- ResponseMetadataTypeDef
- UnprocessedScramSecretTypeDef
- BatchDisassociateScramSecretRequestRequestTypeDef
- ProvisionedThroughputTypeDef
- CloudWatchLogsTypeDef
- FirehoseTypeDef
- S3TypeDef
- BrokerSoftwareInfoTypeDef
- TlsTypeDef
- UnauthenticatedTypeDef
- StateInfoTypeDef
- ErrorInfoTypeDef
- ClusterOperationStepInfoTypeDef
- CompatibleKafkaVersionTypeDef
- ConfigurationInfoTypeDef
- ConfigurationRevisionTypeDef
- PublicAccessTypeDef
- CreateConfigurationRequestRequestTypeDef
- DeleteClusterRequestRequestTypeDef
- DeleteConfigurationRequestRequestTypeDef
- DescribeClusterOperationRequestRequestTypeDef
- DescribeClusterRequestRequestTypeDef
- DescribeClusterV2RequestRequestTypeDef
- DescribeConfigurationRequestRequestTypeDef
- DescribeConfigurationRevisionRequestRequestTypeDef
- EncryptionAtRestTypeDef
- EncryptionInTransitTypeDef
- GetBootstrapBrokersRequestRequestTypeDef
- GetCompatibleKafkaVersionsRequestRequestTypeDef
- IamTypeDef
- JmxExporterInfoTypeDef
- JmxExporterTypeDef
- KafkaVersionTypeDef
- PaginatorConfigTypeDef
- ListClusterOperationsRequestRequestTypeDef
- ListClustersRequestRequestTypeDef
- ListClustersV2RequestRequestTypeDef
- ListConfigurationRevisionsRequestRequestTypeDef
- ListConfigurationsRequestRequestTypeDef
- ListKafkaVersionsRequestRequestTypeDef
- ListNodesRequestRequestTypeDef
- ListScramSecretsRequestRequestTypeDef
- ListTagsForResourceRequestRequestTypeDef
- NodeExporterInfoTypeDef
- NodeExporterTypeDef
- ZookeeperNodeInfoTypeDef
- RebootBrokerRequestRequestTypeDef
- ScramTypeDef
- VpcConfigTypeDef
- TagResourceRequestRequestTypeDef
- UntagResourceRequestRequestTypeDef
- UpdateBrokerCountRequestRequestTypeDef
- UpdateBrokerTypeRequestRequestTypeDef
- UpdateConfigurationRequestRequestTypeDef
- CreateClusterResponseTypeDef
- CreateClusterV2ResponseTypeDef
- DeleteClusterResponseTypeDef
- DeleteConfigurationResponseTypeDef
- DescribeConfigurationRevisionResponseTypeDef
- EmptyResponseMetadataTypeDef
- GetBootstrapBrokersResponseTypeDef
- ListScramSecretsResponseTypeDef
- ListTagsForResourceResponseTypeDef
- RebootBrokerResponseTypeDef
- UpdateBrokerCountResponseTypeDef
- UpdateBrokerStorageResponseTypeDef
- UpdateBrokerTypeResponseTypeDef
- UpdateClusterConfigurationResponseTypeDef
- UpdateClusterKafkaVersionResponseTypeDef
- UpdateConnectivityResponseTypeDef
- UpdateMonitoringResponseTypeDef
- UpdateSecurityResponseTypeDef
- UpdateStorageResponseTypeDef
- BatchAssociateScramSecretResponseTypeDef
- BatchDisassociateScramSecretResponseTypeDef
- BrokerEBSVolumeInfoTypeDef
- EBSStorageInfoTypeDef
- UpdateStorageRequestRequestTypeDef
- BrokerLogsTypeDef
- BrokerNodeInfoTypeDef
- ClusterOperationStepTypeDef
- GetCompatibleKafkaVersionsResponseTypeDef
- UpdateClusterConfigurationRequestRequestTypeDef
- UpdateClusterKafkaVersionRequestRequestTypeDef
- ConfigurationTypeDef
- CreateConfigurationResponseTypeDef
- DescribeConfigurationResponseTypeDef
- ListConfigurationRevisionsResponseTypeDef
- UpdateConfigurationResponseTypeDef
- ConnectivityInfoTypeDef
- EncryptionInfoTypeDef
- ServerlessSaslTypeDef
- ListKafkaVersionsResponseTypeDef
- ListClusterOperationsRequestListClusterOperationsPaginateTypeDef
- ListClustersRequestListClustersPaginateTypeDef
- ListClustersV2RequestListClustersV2PaginateTypeDef
- ListConfigurationRevisionsRequestListConfigurationRevisionsPaginateTypeDef
- ListConfigurationsRequestListConfigurationsPaginateTypeDef
- ListKafkaVersionsRequestListKafkaVersionsPaginateTypeDef
- ListNodesRequestListNodesPaginateTypeDef
- ListScramSecretsRequestListScramSecretsPaginateTypeDef
- PrometheusInfoTypeDef
- PrometheusTypeDef
- SaslTypeDef
- UpdateBrokerStorageRequestRequestTypeDef
- StorageInfoTypeDef
- LoggingInfoTypeDef
- NodeInfoTypeDef
- ListConfigurationsResponseTypeDef
- UpdateConnectivityRequestRequestTypeDef
- ServerlessClientAuthenticationTypeDef
- OpenMonitoringInfoTypeDef
- OpenMonitoringTypeDef
- ClientAuthenticationTypeDef
- BrokerNodeGroupInfoTypeDef
- ListNodesResponseTypeDef
- ServerlessRequestTypeDef
- ServerlessTypeDef
- UpdateMonitoringRequestRequestTypeDef
- MutableClusterInfoTypeDef
- UpdateSecurityRequestRequestTypeDef
- ClusterInfoTypeDef
- CreateClusterRequestRequestTypeDef
- ProvisionedRequestTypeDef
- ProvisionedTypeDef
- ClusterOperationInfoTypeDef
- DescribeClusterResponseTypeDef
- ListClustersResponseTypeDef
- CreateClusterV2RequestRequestTypeDef
- ClusterTypeDef
- DescribeClusterOperationResponseTypeDef
- ListClusterOperationsResponseTypeDef
- DescribeClusterV2ResponseTypeDef
- ListClustersV2ResponseTypeDef