Kafka module
Index > Kafka
Auto-generated documentation for Kafka type annotations stubs module types-aiobotocore-kafka.
How to install
From PyPI with pip
Install types-aioboto3
for Kafka
service.
# install with aioboto3 type annotations
python -m pip install 'types-aioboto3[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-aioboto3-lite[kafka]'
# standalone installation
python -m pip install types-aiobotocore-kafka
How to uninstall
Usage
Code samples can be found in Examples.
KafkaClient
Type annotations and code completion for session.client("kafka")
as KafkaClient
boto3 documentation
Usage example
from aioboto3.session import Session
from types_aiobotocore_kafka.client import KafkaClient
session = Session()
async with session.client("kafka") as client:
client: KafkaClient
Paginators
Type annotations and code completion for
paginators
from session.client("kafka").get_paginator("...")
.
Usage example
from types_aiobotocore_kafka.paginator import ListClusterOperationsPaginator
def get_list_cluster_operations_paginator() -> ListClusterOperationsPaginator:
return client.get_paginator("list_cluster_operations"))
- ListClusterOperationsPaginator
- ListClustersPaginator
- ListClustersV2Paginator
- ListConfigurationRevisionsPaginator
- ListConfigurationsPaginator
- ListKafkaVersionsPaginator
- ListNodesPaginator
- ListScramSecretsPaginator
Literals
Type annotations for literals used in methods and schema.
Usage example
from types_aiobotocore_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
- KafkaServiceName
- ServiceName
- ResourceServiceName
- PaginatorName
- RegionName
Typed dictionaries
Type annotations for typed dictionaries used in methods and schema.
Usage example
from types_aiobotocore_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
- BatchAssociateScramSecretResponseTypeDef
- BatchDisassociateScramSecretResponseTypeDef
- BrokerEBSVolumeInfoTypeDef
- EBSStorageInfoTypeDef
- 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