Typed dictionaries
Auto-generated documentation for Kafka type annotations stubs module mypy-boto3-kafka.
BatchAssociateScramSecretRequestRequestTypeDef
Usage Example
from mypy_boto3_kafka.type_defs import BatchAssociateScramSecretRequestRequestTypeDef
def get_value() -> BatchAssociateScramSecretRequestRequestTypeDef:
return {
"ClusterArn": ...,
"SecretArnList": ...,
}
Definition
class BatchAssociateScramSecretRequestRequestTypeDef(TypedDict):
ClusterArn: str,
SecretArnList: Sequence[str],
ResponseMetadataTypeDef
Usage Example
from mypy_boto3_kafka.type_defs import ResponseMetadataTypeDef
def get_value() -> ResponseMetadataTypeDef:
return {
"RequestId": ...,
"HostId": ...,
"HTTPStatusCode": ...,
"HTTPHeaders": ...,
"RetryAttempts": ...,
}
Definition
class ResponseMetadataTypeDef(TypedDict):
RequestId: str,
HostId: str,
HTTPStatusCode: int,
HTTPHeaders: Dict[str, str],
RetryAttempts: int,
UnprocessedScramSecretTypeDef
Usage Example
from mypy_boto3_kafka.type_defs import UnprocessedScramSecretTypeDef
def get_value() -> UnprocessedScramSecretTypeDef:
return {
"ErrorCode": ...,
}
Definition
class UnprocessedScramSecretTypeDef(TypedDict):
ErrorCode: NotRequired[str],
ErrorMessage: NotRequired[str],
SecretArn: NotRequired[str],
BatchDisassociateScramSecretRequestRequestTypeDef
Usage Example
from mypy_boto3_kafka.type_defs import BatchDisassociateScramSecretRequestRequestTypeDef
def get_value() -> BatchDisassociateScramSecretRequestRequestTypeDef:
return {
"ClusterArn": ...,
"SecretArnList": ...,
}
Definition
class BatchDisassociateScramSecretRequestRequestTypeDef(TypedDict):
ClusterArn: str,
SecretArnList: Sequence[str],
ProvisionedThroughputTypeDef
Usage Example
from mypy_boto3_kafka.type_defs import ProvisionedThroughputTypeDef
def get_value() -> ProvisionedThroughputTypeDef:
return {
"Enabled": ...,
}
Definition
class ProvisionedThroughputTypeDef(TypedDict):
Enabled: NotRequired[bool],
VolumeThroughput: NotRequired[int],
CloudWatchLogsTypeDef
Usage Example
from mypy_boto3_kafka.type_defs import CloudWatchLogsTypeDef
def get_value() -> CloudWatchLogsTypeDef:
return {
"Enabled": ...,
}
FirehoseTypeDef
Usage Example
from mypy_boto3_kafka.type_defs import FirehoseTypeDef
def get_value() -> FirehoseTypeDef:
return {
"Enabled": ...,
}
S3TypeDef
Usage Example
from mypy_boto3_kafka.type_defs import S3TypeDef
def get_value() -> S3TypeDef:
return {
"Enabled": ...,
}
Definition
class S3TypeDef(TypedDict):
Enabled: bool,
Bucket: NotRequired[str],
Prefix: NotRequired[str],
BrokerSoftwareInfoTypeDef
Usage Example
from mypy_boto3_kafka.type_defs import BrokerSoftwareInfoTypeDef
def get_value() -> BrokerSoftwareInfoTypeDef:
return {
"ConfigurationArn": ...,
}
Definition
class BrokerSoftwareInfoTypeDef(TypedDict):
ConfigurationArn: NotRequired[str],
ConfigurationRevision: NotRequired[int],
KafkaVersion: NotRequired[str],
TlsTypeDef
Usage Example
from mypy_boto3_kafka.type_defs import TlsTypeDef
def get_value() -> TlsTypeDef:
return {
"CertificateAuthorityArnList": ...,
}
Definition
class TlsTypeDef(TypedDict):
CertificateAuthorityArnList: NotRequired[Sequence[str]],
Enabled: NotRequired[bool],
UnauthenticatedTypeDef
Usage Example
from mypy_boto3_kafka.type_defs import UnauthenticatedTypeDef
def get_value() -> UnauthenticatedTypeDef:
return {
"Enabled": ...,
}
StateInfoTypeDef
Usage Example
from mypy_boto3_kafka.type_defs import StateInfoTypeDef
def get_value() -> StateInfoTypeDef:
return {
"Code": ...,
}
ErrorInfoTypeDef
Usage Example
from mypy_boto3_kafka.type_defs import ErrorInfoTypeDef
def get_value() -> ErrorInfoTypeDef:
return {
"ErrorCode": ...,
}
Definition
class ErrorInfoTypeDef(TypedDict):
ErrorCode: NotRequired[str],
ErrorString: NotRequired[str],
ClusterOperationStepInfoTypeDef
Usage Example
from mypy_boto3_kafka.type_defs import ClusterOperationStepInfoTypeDef
def get_value() -> ClusterOperationStepInfoTypeDef:
return {
"StepStatus": ...,
}
CompatibleKafkaVersionTypeDef
Usage Example
from mypy_boto3_kafka.type_defs import CompatibleKafkaVersionTypeDef
def get_value() -> CompatibleKafkaVersionTypeDef:
return {
"SourceVersion": ...,
}
Definition
class CompatibleKafkaVersionTypeDef(TypedDict):
SourceVersion: NotRequired[str],
TargetVersions: NotRequired[List[str]],
ConfigurationInfoTypeDef
Usage Example
from mypy_boto3_kafka.type_defs import ConfigurationInfoTypeDef
def get_value() -> ConfigurationInfoTypeDef:
return {
"Arn": ...,
"Revision": ...,
}
ConfigurationRevisionTypeDef
Usage Example
from mypy_boto3_kafka.type_defs import ConfigurationRevisionTypeDef
def get_value() -> ConfigurationRevisionTypeDef:
return {
"CreationTime": ...,
"Revision": ...,
}
Definition
class ConfigurationRevisionTypeDef(TypedDict):
CreationTime: datetime,
Revision: int,
Description: NotRequired[str],
PublicAccessTypeDef
Usage Example
from mypy_boto3_kafka.type_defs import PublicAccessTypeDef
def get_value() -> PublicAccessTypeDef:
return {
"Type": ...,
}
CreateConfigurationRequestRequestTypeDef
Usage Example
from mypy_boto3_kafka.type_defs import CreateConfigurationRequestRequestTypeDef
def get_value() -> CreateConfigurationRequestRequestTypeDef:
return {
"Name": ...,
"ServerProperties": ...,
}
Definition
class CreateConfigurationRequestRequestTypeDef(TypedDict):
Name: str,
ServerProperties: Union[str, bytes, IO[Any], StreamingBody],
Description: NotRequired[str],
KafkaVersions: NotRequired[Sequence[str]],
DeleteClusterRequestRequestTypeDef
Usage Example
from mypy_boto3_kafka.type_defs import DeleteClusterRequestRequestTypeDef
def get_value() -> DeleteClusterRequestRequestTypeDef:
return {
"ClusterArn": ...,
}
Definition
class DeleteClusterRequestRequestTypeDef(TypedDict):
ClusterArn: str,
CurrentVersion: NotRequired[str],
DeleteConfigurationRequestRequestTypeDef
Usage Example
from mypy_boto3_kafka.type_defs import DeleteConfigurationRequestRequestTypeDef
def get_value() -> DeleteConfigurationRequestRequestTypeDef:
return {
"Arn": ...,
}
DescribeClusterOperationRequestRequestTypeDef
Usage Example
from mypy_boto3_kafka.type_defs import DescribeClusterOperationRequestRequestTypeDef
def get_value() -> DescribeClusterOperationRequestRequestTypeDef:
return {
"ClusterOperationArn": ...,
}
DescribeClusterRequestRequestTypeDef
Usage Example
from mypy_boto3_kafka.type_defs import DescribeClusterRequestRequestTypeDef
def get_value() -> DescribeClusterRequestRequestTypeDef:
return {
"ClusterArn": ...,
}
DescribeClusterV2RequestRequestTypeDef
Usage Example
from mypy_boto3_kafka.type_defs import DescribeClusterV2RequestRequestTypeDef
def get_value() -> DescribeClusterV2RequestRequestTypeDef:
return {
"ClusterArn": ...,
}
DescribeConfigurationRequestRequestTypeDef
Usage Example
from mypy_boto3_kafka.type_defs import DescribeConfigurationRequestRequestTypeDef
def get_value() -> DescribeConfigurationRequestRequestTypeDef:
return {
"Arn": ...,
}
DescribeConfigurationRevisionRequestRequestTypeDef
Usage Example
from mypy_boto3_kafka.type_defs import DescribeConfigurationRevisionRequestRequestTypeDef
def get_value() -> DescribeConfigurationRevisionRequestRequestTypeDef:
return {
"Arn": ...,
"Revision": ...,
}
Definition
class DescribeConfigurationRevisionRequestRequestTypeDef(TypedDict):
Arn: str,
Revision: int,
EncryptionAtRestTypeDef
Usage Example
from mypy_boto3_kafka.type_defs import EncryptionAtRestTypeDef
def get_value() -> EncryptionAtRestTypeDef:
return {
"DataVolumeKMSKeyId": ...,
}
EncryptionInTransitTypeDef
Usage Example
from mypy_boto3_kafka.type_defs import EncryptionInTransitTypeDef
def get_value() -> EncryptionInTransitTypeDef:
return {
"ClientBroker": ...,
}
Definition
class EncryptionInTransitTypeDef(TypedDict):
ClientBroker: NotRequired[ClientBrokerType], # (1)
InCluster: NotRequired[bool],
- See ClientBrokerType
GetBootstrapBrokersRequestRequestTypeDef
Usage Example
from mypy_boto3_kafka.type_defs import GetBootstrapBrokersRequestRequestTypeDef
def get_value() -> GetBootstrapBrokersRequestRequestTypeDef:
return {
"ClusterArn": ...,
}
GetCompatibleKafkaVersionsRequestRequestTypeDef
Usage Example
from mypy_boto3_kafka.type_defs import GetCompatibleKafkaVersionsRequestRequestTypeDef
def get_value() -> GetCompatibleKafkaVersionsRequestRequestTypeDef:
return {
"ClusterArn": ...,
}
Definition
class GetCompatibleKafkaVersionsRequestRequestTypeDef(TypedDict):
ClusterArn: NotRequired[str],
IamTypeDef
Usage Example
from mypy_boto3_kafka.type_defs import IamTypeDef
def get_value() -> IamTypeDef:
return {
"Enabled": ...,
}
JmxExporterInfoTypeDef
Usage Example
from mypy_boto3_kafka.type_defs import JmxExporterInfoTypeDef
def get_value() -> JmxExporterInfoTypeDef:
return {
"EnabledInBroker": ...,
}
JmxExporterTypeDef
Usage Example
from mypy_boto3_kafka.type_defs import JmxExporterTypeDef
def get_value() -> JmxExporterTypeDef:
return {
"EnabledInBroker": ...,
}
KafkaVersionTypeDef
Usage Example
from mypy_boto3_kafka.type_defs import KafkaVersionTypeDef
def get_value() -> KafkaVersionTypeDef:
return {
"Version": ...,
}
Definition
class KafkaVersionTypeDef(TypedDict):
Version: NotRequired[str],
Status: NotRequired[KafkaVersionStatusType], # (1)
PaginatorConfigTypeDef
Usage Example
from mypy_boto3_kafka.type_defs import PaginatorConfigTypeDef
def get_value() -> PaginatorConfigTypeDef:
return {
"MaxItems": ...,
}
Definition
class PaginatorConfigTypeDef(TypedDict):
MaxItems: NotRequired[int],
PageSize: NotRequired[int],
StartingToken: NotRequired[str],
ListClusterOperationsRequestRequestTypeDef
Usage Example
from mypy_boto3_kafka.type_defs import ListClusterOperationsRequestRequestTypeDef
def get_value() -> ListClusterOperationsRequestRequestTypeDef:
return {
"ClusterArn": ...,
}
Definition
class ListClusterOperationsRequestRequestTypeDef(TypedDict):
ClusterArn: str,
MaxResults: NotRequired[int],
NextToken: NotRequired[str],
ListClustersRequestRequestTypeDef
Usage Example
from mypy_boto3_kafka.type_defs import ListClustersRequestRequestTypeDef
def get_value() -> ListClustersRequestRequestTypeDef:
return {
"ClusterNameFilter": ...,
}
Definition
class ListClustersRequestRequestTypeDef(TypedDict):
ClusterNameFilter: NotRequired[str],
MaxResults: NotRequired[int],
NextToken: NotRequired[str],
ListClustersV2RequestRequestTypeDef
Usage Example
from mypy_boto3_kafka.type_defs import ListClustersV2RequestRequestTypeDef
def get_value() -> ListClustersV2RequestRequestTypeDef:
return {
"ClusterNameFilter": ...,
}
Definition
class ListClustersV2RequestRequestTypeDef(TypedDict):
ClusterNameFilter: NotRequired[str],
ClusterTypeFilter: NotRequired[str],
MaxResults: NotRequired[int],
NextToken: NotRequired[str],
ListConfigurationRevisionsRequestRequestTypeDef
Usage Example
from mypy_boto3_kafka.type_defs import ListConfigurationRevisionsRequestRequestTypeDef
def get_value() -> ListConfigurationRevisionsRequestRequestTypeDef:
return {
"Arn": ...,
}
Definition
class ListConfigurationRevisionsRequestRequestTypeDef(TypedDict):
Arn: str,
MaxResults: NotRequired[int],
NextToken: NotRequired[str],
ListConfigurationsRequestRequestTypeDef
Usage Example
from mypy_boto3_kafka.type_defs import ListConfigurationsRequestRequestTypeDef
def get_value() -> ListConfigurationsRequestRequestTypeDef:
return {
"MaxResults": ...,
}
Definition
class ListConfigurationsRequestRequestTypeDef(TypedDict):
MaxResults: NotRequired[int],
NextToken: NotRequired[str],
ListKafkaVersionsRequestRequestTypeDef
Usage Example
from mypy_boto3_kafka.type_defs import ListKafkaVersionsRequestRequestTypeDef
def get_value() -> ListKafkaVersionsRequestRequestTypeDef:
return {
"MaxResults": ...,
}
Definition
class ListKafkaVersionsRequestRequestTypeDef(TypedDict):
MaxResults: NotRequired[int],
NextToken: NotRequired[str],
ListNodesRequestRequestTypeDef
Usage Example
from mypy_boto3_kafka.type_defs import ListNodesRequestRequestTypeDef
def get_value() -> ListNodesRequestRequestTypeDef:
return {
"ClusterArn": ...,
}
Definition
class ListNodesRequestRequestTypeDef(TypedDict):
ClusterArn: str,
MaxResults: NotRequired[int],
NextToken: NotRequired[str],
ListScramSecretsRequestRequestTypeDef
Usage Example
from mypy_boto3_kafka.type_defs import ListScramSecretsRequestRequestTypeDef
def get_value() -> ListScramSecretsRequestRequestTypeDef:
return {
"ClusterArn": ...,
}
Definition
class ListScramSecretsRequestRequestTypeDef(TypedDict):
ClusterArn: str,
MaxResults: NotRequired[int],
NextToken: NotRequired[str],
ListTagsForResourceRequestRequestTypeDef
Usage Example
from mypy_boto3_kafka.type_defs import ListTagsForResourceRequestRequestTypeDef
def get_value() -> ListTagsForResourceRequestRequestTypeDef:
return {
"ResourceArn": ...,
}
NodeExporterInfoTypeDef
Usage Example
from mypy_boto3_kafka.type_defs import NodeExporterInfoTypeDef
def get_value() -> NodeExporterInfoTypeDef:
return {
"EnabledInBroker": ...,
}
NodeExporterTypeDef
Usage Example
from mypy_boto3_kafka.type_defs import NodeExporterTypeDef
def get_value() -> NodeExporterTypeDef:
return {
"EnabledInBroker": ...,
}
ZookeeperNodeInfoTypeDef
Usage Example
from mypy_boto3_kafka.type_defs import ZookeeperNodeInfoTypeDef
def get_value() -> ZookeeperNodeInfoTypeDef:
return {
"AttachedENIId": ...,
}
Definition
class ZookeeperNodeInfoTypeDef(TypedDict):
AttachedENIId: NotRequired[str],
ClientVpcIpAddress: NotRequired[str],
Endpoints: NotRequired[List[str]],
ZookeeperId: NotRequired[float],
ZookeeperVersion: NotRequired[str],
RebootBrokerRequestRequestTypeDef
Usage Example
from mypy_boto3_kafka.type_defs import RebootBrokerRequestRequestTypeDef
def get_value() -> RebootBrokerRequestRequestTypeDef:
return {
"BrokerIds": ...,
"ClusterArn": ...,
}
Definition
class RebootBrokerRequestRequestTypeDef(TypedDict):
BrokerIds: Sequence[str],
ClusterArn: str,
ScramTypeDef
Usage Example
from mypy_boto3_kafka.type_defs import ScramTypeDef
def get_value() -> ScramTypeDef:
return {
"Enabled": ...,
}
VpcConfigTypeDef
Usage Example
from mypy_boto3_kafka.type_defs import VpcConfigTypeDef
def get_value() -> VpcConfigTypeDef:
return {
"SubnetIds": ...,
}
Definition
class VpcConfigTypeDef(TypedDict):
SubnetIds: Sequence[str],
SecurityGroupIds: NotRequired[Sequence[str]],
TagResourceRequestRequestTypeDef
Usage Example
from mypy_boto3_kafka.type_defs import TagResourceRequestRequestTypeDef
def get_value() -> TagResourceRequestRequestTypeDef:
return {
"ResourceArn": ...,
"Tags": ...,
}
Definition
class TagResourceRequestRequestTypeDef(TypedDict):
ResourceArn: str,
Tags: Mapping[str, str],
UntagResourceRequestRequestTypeDef
Usage Example
from mypy_boto3_kafka.type_defs import UntagResourceRequestRequestTypeDef
def get_value() -> UntagResourceRequestRequestTypeDef:
return {
"ResourceArn": ...,
"TagKeys": ...,
}
Definition
class UntagResourceRequestRequestTypeDef(TypedDict):
ResourceArn: str,
TagKeys: Sequence[str],
UpdateBrokerCountRequestRequestTypeDef
Usage Example
from mypy_boto3_kafka.type_defs import UpdateBrokerCountRequestRequestTypeDef
def get_value() -> UpdateBrokerCountRequestRequestTypeDef:
return {
"ClusterArn": ...,
"CurrentVersion": ...,
"TargetNumberOfBrokerNodes": ...,
}
Definition
class UpdateBrokerCountRequestRequestTypeDef(TypedDict):
ClusterArn: str,
CurrentVersion: str,
TargetNumberOfBrokerNodes: int,
UpdateBrokerTypeRequestRequestTypeDef
Usage Example
from mypy_boto3_kafka.type_defs import UpdateBrokerTypeRequestRequestTypeDef
def get_value() -> UpdateBrokerTypeRequestRequestTypeDef:
return {
"ClusterArn": ...,
"CurrentVersion": ...,
"TargetInstanceType": ...,
}
Definition
class UpdateBrokerTypeRequestRequestTypeDef(TypedDict):
ClusterArn: str,
CurrentVersion: str,
TargetInstanceType: str,
UpdateConfigurationRequestRequestTypeDef
Usage Example
from mypy_boto3_kafka.type_defs import UpdateConfigurationRequestRequestTypeDef
def get_value() -> UpdateConfigurationRequestRequestTypeDef:
return {
"Arn": ...,
"ServerProperties": ...,
}
Definition
class UpdateConfigurationRequestRequestTypeDef(TypedDict):
Arn: str,
ServerProperties: Union[str, bytes, IO[Any], StreamingBody],
Description: NotRequired[str],
CreateClusterResponseTypeDef
Usage Example
from mypy_boto3_kafka.type_defs import CreateClusterResponseTypeDef
def get_value() -> CreateClusterResponseTypeDef:
return {
"ClusterArn": ...,
"ClusterName": ...,
"State": ...,
"ResponseMetadata": ...,
}
Definition
class CreateClusterResponseTypeDef(TypedDict):
ClusterArn: str,
ClusterName: str,
State: ClusterStateType, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
CreateClusterV2ResponseTypeDef
Usage Example
from mypy_boto3_kafka.type_defs import CreateClusterV2ResponseTypeDef
def get_value() -> CreateClusterV2ResponseTypeDef:
return {
"ClusterArn": ...,
"ClusterName": ...,
"State": ...,
"ClusterType": ...,
"ResponseMetadata": ...,
}
Definition
class CreateClusterV2ResponseTypeDef(TypedDict):
ClusterArn: str,
ClusterName: str,
State: ClusterStateType, # (1)
ClusterType: ClusterTypeType, # (2)
ResponseMetadata: ResponseMetadataTypeDef, # (3)
- See ClusterStateType
- See ClusterTypeType
- See ResponseMetadataTypeDef
DeleteClusterResponseTypeDef
Usage Example
from mypy_boto3_kafka.type_defs import DeleteClusterResponseTypeDef
def get_value() -> DeleteClusterResponseTypeDef:
return {
"ClusterArn": ...,
"State": ...,
"ResponseMetadata": ...,
}
Definition
class DeleteClusterResponseTypeDef(TypedDict):
ClusterArn: str,
State: ClusterStateType, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
DeleteConfigurationResponseTypeDef
Usage Example
from mypy_boto3_kafka.type_defs import DeleteConfigurationResponseTypeDef
def get_value() -> DeleteConfigurationResponseTypeDef:
return {
"Arn": ...,
"State": ...,
"ResponseMetadata": ...,
}
Definition
class DeleteConfigurationResponseTypeDef(TypedDict):
Arn: str,
State: ConfigurationStateType, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
DescribeConfigurationRevisionResponseTypeDef
Usage Example
from mypy_boto3_kafka.type_defs import DescribeConfigurationRevisionResponseTypeDef
def get_value() -> DescribeConfigurationRevisionResponseTypeDef:
return {
"Arn": ...,
"CreationTime": ...,
"Description": ...,
"Revision": ...,
"ServerProperties": ...,
"ResponseMetadata": ...,
}
Definition
class DescribeConfigurationRevisionResponseTypeDef(TypedDict):
Arn: str,
CreationTime: datetime,
Description: str,
Revision: int,
ServerProperties: bytes,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
EmptyResponseMetadataTypeDef
Usage Example
from mypy_boto3_kafka.type_defs import EmptyResponseMetadataTypeDef
def get_value() -> EmptyResponseMetadataTypeDef:
return {
"ResponseMetadata": ...,
}
Definition
class EmptyResponseMetadataTypeDef(TypedDict):
ResponseMetadata: ResponseMetadataTypeDef, # (1)
GetBootstrapBrokersResponseTypeDef
Usage Example
from mypy_boto3_kafka.type_defs import GetBootstrapBrokersResponseTypeDef
def get_value() -> GetBootstrapBrokersResponseTypeDef:
return {
"BootstrapBrokerString": ...,
"BootstrapBrokerStringTls": ...,
"BootstrapBrokerStringSaslScram": ...,
"BootstrapBrokerStringSaslIam": ...,
"BootstrapBrokerStringPublicTls": ...,
"BootstrapBrokerStringPublicSaslScram": ...,
"BootstrapBrokerStringPublicSaslIam": ...,
"ResponseMetadata": ...,
}
Definition
class GetBootstrapBrokersResponseTypeDef(TypedDict):
BootstrapBrokerString: str,
BootstrapBrokerStringTls: str,
BootstrapBrokerStringSaslScram: str,
BootstrapBrokerStringSaslIam: str,
BootstrapBrokerStringPublicTls: str,
BootstrapBrokerStringPublicSaslScram: str,
BootstrapBrokerStringPublicSaslIam: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
ListScramSecretsResponseTypeDef
Usage Example
from mypy_boto3_kafka.type_defs import ListScramSecretsResponseTypeDef
def get_value() -> ListScramSecretsResponseTypeDef:
return {
"NextToken": ...,
"SecretArnList": ...,
"ResponseMetadata": ...,
}
Definition
class ListScramSecretsResponseTypeDef(TypedDict):
NextToken: str,
SecretArnList: List[str],
ResponseMetadata: ResponseMetadataTypeDef, # (1)
ListTagsForResourceResponseTypeDef
Usage Example
from mypy_boto3_kafka.type_defs import ListTagsForResourceResponseTypeDef
def get_value() -> ListTagsForResourceResponseTypeDef:
return {
"Tags": ...,
"ResponseMetadata": ...,
}
Definition
class ListTagsForResourceResponseTypeDef(TypedDict):
Tags: Dict[str, str],
ResponseMetadata: ResponseMetadataTypeDef, # (1)
RebootBrokerResponseTypeDef
Usage Example
from mypy_boto3_kafka.type_defs import RebootBrokerResponseTypeDef
def get_value() -> RebootBrokerResponseTypeDef:
return {
"ClusterArn": ...,
"ClusterOperationArn": ...,
"ResponseMetadata": ...,
}
Definition
class RebootBrokerResponseTypeDef(TypedDict):
ClusterArn: str,
ClusterOperationArn: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
UpdateBrokerCountResponseTypeDef
Usage Example
from mypy_boto3_kafka.type_defs import UpdateBrokerCountResponseTypeDef
def get_value() -> UpdateBrokerCountResponseTypeDef:
return {
"ClusterArn": ...,
"ClusterOperationArn": ...,
"ResponseMetadata": ...,
}
Definition
class UpdateBrokerCountResponseTypeDef(TypedDict):
ClusterArn: str,
ClusterOperationArn: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
UpdateBrokerStorageResponseTypeDef
Usage Example
from mypy_boto3_kafka.type_defs import UpdateBrokerStorageResponseTypeDef
def get_value() -> UpdateBrokerStorageResponseTypeDef:
return {
"ClusterArn": ...,
"ClusterOperationArn": ...,
"ResponseMetadata": ...,
}
Definition
class UpdateBrokerStorageResponseTypeDef(TypedDict):
ClusterArn: str,
ClusterOperationArn: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
UpdateBrokerTypeResponseTypeDef
Usage Example
from mypy_boto3_kafka.type_defs import UpdateBrokerTypeResponseTypeDef
def get_value() -> UpdateBrokerTypeResponseTypeDef:
return {
"ClusterArn": ...,
"ClusterOperationArn": ...,
"ResponseMetadata": ...,
}
Definition
class UpdateBrokerTypeResponseTypeDef(TypedDict):
ClusterArn: str,
ClusterOperationArn: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
UpdateClusterConfigurationResponseTypeDef
Usage Example
from mypy_boto3_kafka.type_defs import UpdateClusterConfigurationResponseTypeDef
def get_value() -> UpdateClusterConfigurationResponseTypeDef:
return {
"ClusterArn": ...,
"ClusterOperationArn": ...,
"ResponseMetadata": ...,
}
Definition
class UpdateClusterConfigurationResponseTypeDef(TypedDict):
ClusterArn: str,
ClusterOperationArn: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
UpdateClusterKafkaVersionResponseTypeDef
Usage Example
from mypy_boto3_kafka.type_defs import UpdateClusterKafkaVersionResponseTypeDef
def get_value() -> UpdateClusterKafkaVersionResponseTypeDef:
return {
"ClusterArn": ...,
"ClusterOperationArn": ...,
"ResponseMetadata": ...,
}
Definition
class UpdateClusterKafkaVersionResponseTypeDef(TypedDict):
ClusterArn: str,
ClusterOperationArn: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
UpdateConnectivityResponseTypeDef
Usage Example
from mypy_boto3_kafka.type_defs import UpdateConnectivityResponseTypeDef
def get_value() -> UpdateConnectivityResponseTypeDef:
return {
"ClusterArn": ...,
"ClusterOperationArn": ...,
"ResponseMetadata": ...,
}
Definition
class UpdateConnectivityResponseTypeDef(TypedDict):
ClusterArn: str,
ClusterOperationArn: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
UpdateMonitoringResponseTypeDef
Usage Example
from mypy_boto3_kafka.type_defs import UpdateMonitoringResponseTypeDef
def get_value() -> UpdateMonitoringResponseTypeDef:
return {
"ClusterArn": ...,
"ClusterOperationArn": ...,
"ResponseMetadata": ...,
}
Definition
class UpdateMonitoringResponseTypeDef(TypedDict):
ClusterArn: str,
ClusterOperationArn: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
UpdateSecurityResponseTypeDef
Usage Example
from mypy_boto3_kafka.type_defs import UpdateSecurityResponseTypeDef
def get_value() -> UpdateSecurityResponseTypeDef:
return {
"ClusterArn": ...,
"ClusterOperationArn": ...,
"ResponseMetadata": ...,
}
Definition
class UpdateSecurityResponseTypeDef(TypedDict):
ClusterArn: str,
ClusterOperationArn: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
UpdateStorageResponseTypeDef
Usage Example
from mypy_boto3_kafka.type_defs import UpdateStorageResponseTypeDef
def get_value() -> UpdateStorageResponseTypeDef:
return {
"ClusterArn": ...,
"ClusterOperationArn": ...,
"ResponseMetadata": ...,
}
Definition
class UpdateStorageResponseTypeDef(TypedDict):
ClusterArn: str,
ClusterOperationArn: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
BatchAssociateScramSecretResponseTypeDef
Usage Example
from mypy_boto3_kafka.type_defs import BatchAssociateScramSecretResponseTypeDef
def get_value() -> BatchAssociateScramSecretResponseTypeDef:
return {
"ClusterArn": ...,
"UnprocessedScramSecrets": ...,
"ResponseMetadata": ...,
}
Definition
class BatchAssociateScramSecretResponseTypeDef(TypedDict):
ClusterArn: str,
UnprocessedScramSecrets: List[UnprocessedScramSecretTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
BatchDisassociateScramSecretResponseTypeDef
Usage Example
from mypy_boto3_kafka.type_defs import BatchDisassociateScramSecretResponseTypeDef
def get_value() -> BatchDisassociateScramSecretResponseTypeDef:
return {
"ClusterArn": ...,
"UnprocessedScramSecrets": ...,
"ResponseMetadata": ...,
}
Definition
class BatchDisassociateScramSecretResponseTypeDef(TypedDict):
ClusterArn: str,
UnprocessedScramSecrets: List[UnprocessedScramSecretTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
BrokerEBSVolumeInfoTypeDef
Usage Example
from mypy_boto3_kafka.type_defs import BrokerEBSVolumeInfoTypeDef
def get_value() -> BrokerEBSVolumeInfoTypeDef:
return {
"KafkaBrokerNodeId": ...,
}
Definition
class BrokerEBSVolumeInfoTypeDef(TypedDict):
KafkaBrokerNodeId: str,
ProvisionedThroughput: NotRequired[ProvisionedThroughputTypeDef], # (1)
VolumeSizeGB: NotRequired[int],
EBSStorageInfoTypeDef
Usage Example
from mypy_boto3_kafka.type_defs import EBSStorageInfoTypeDef
def get_value() -> EBSStorageInfoTypeDef:
return {
"ProvisionedThroughput": ...,
}
Definition
class EBSStorageInfoTypeDef(TypedDict):
ProvisionedThroughput: NotRequired[ProvisionedThroughputTypeDef], # (1)
VolumeSize: NotRequired[int],
UpdateStorageRequestRequestTypeDef
Usage Example
from mypy_boto3_kafka.type_defs import UpdateStorageRequestRequestTypeDef
def get_value() -> UpdateStorageRequestRequestTypeDef:
return {
"ClusterArn": ...,
"CurrentVersion": ...,
}
Definition
class UpdateStorageRequestRequestTypeDef(TypedDict):
ClusterArn: str,
CurrentVersion: str,
ProvisionedThroughput: NotRequired[ProvisionedThroughputTypeDef], # (1)
StorageMode: NotRequired[StorageModeType], # (2)
VolumeSizeGB: NotRequired[int],
BrokerLogsTypeDef
Usage Example
from mypy_boto3_kafka.type_defs import BrokerLogsTypeDef
def get_value() -> BrokerLogsTypeDef:
return {
"CloudWatchLogs": ...,
}
Definition
class BrokerLogsTypeDef(TypedDict):
CloudWatchLogs: NotRequired[CloudWatchLogsTypeDef], # (1)
Firehose: NotRequired[FirehoseTypeDef], # (2)
S3: NotRequired[S3TypeDef], # (3)
- See CloudWatchLogsTypeDef
- See FirehoseTypeDef
- See S3TypeDef
BrokerNodeInfoTypeDef
Usage Example
from mypy_boto3_kafka.type_defs import BrokerNodeInfoTypeDef
def get_value() -> BrokerNodeInfoTypeDef:
return {
"AttachedENIId": ...,
}
Definition
class BrokerNodeInfoTypeDef(TypedDict):
AttachedENIId: NotRequired[str],
BrokerId: NotRequired[float],
ClientSubnet: NotRequired[str],
ClientVpcIpAddress: NotRequired[str],
CurrentBrokerSoftwareInfo: NotRequired[BrokerSoftwareInfoTypeDef], # (1)
Endpoints: NotRequired[List[str]],
ClusterOperationStepTypeDef
Usage Example
from mypy_boto3_kafka.type_defs import ClusterOperationStepTypeDef
def get_value() -> ClusterOperationStepTypeDef:
return {
"StepInfo": ...,
}
Definition
class ClusterOperationStepTypeDef(TypedDict):
StepInfo: NotRequired[ClusterOperationStepInfoTypeDef], # (1)
StepName: NotRequired[str],
GetCompatibleKafkaVersionsResponseTypeDef
Usage Example
from mypy_boto3_kafka.type_defs import GetCompatibleKafkaVersionsResponseTypeDef
def get_value() -> GetCompatibleKafkaVersionsResponseTypeDef:
return {
"CompatibleKafkaVersions": ...,
"ResponseMetadata": ...,
}
Definition
class GetCompatibleKafkaVersionsResponseTypeDef(TypedDict):
CompatibleKafkaVersions: List[CompatibleKafkaVersionTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
UpdateClusterConfigurationRequestRequestTypeDef
Usage Example
from mypy_boto3_kafka.type_defs import UpdateClusterConfigurationRequestRequestTypeDef
def get_value() -> UpdateClusterConfigurationRequestRequestTypeDef:
return {
"ClusterArn": ...,
"ConfigurationInfo": ...,
"CurrentVersion": ...,
}
Definition
class UpdateClusterConfigurationRequestRequestTypeDef(TypedDict):
ClusterArn: str,
ConfigurationInfo: ConfigurationInfoTypeDef, # (1)
CurrentVersion: str,
UpdateClusterKafkaVersionRequestRequestTypeDef
Usage Example
from mypy_boto3_kafka.type_defs import UpdateClusterKafkaVersionRequestRequestTypeDef
def get_value() -> UpdateClusterKafkaVersionRequestRequestTypeDef:
return {
"ClusterArn": ...,
"CurrentVersion": ...,
"TargetKafkaVersion": ...,
}
Definition
class UpdateClusterKafkaVersionRequestRequestTypeDef(TypedDict):
ClusterArn: str,
CurrentVersion: str,
TargetKafkaVersion: str,
ConfigurationInfo: NotRequired[ConfigurationInfoTypeDef], # (1)
ConfigurationTypeDef
Usage Example
from mypy_boto3_kafka.type_defs import ConfigurationTypeDef
def get_value() -> ConfigurationTypeDef:
return {
"Arn": ...,
"CreationTime": ...,
"Description": ...,
"KafkaVersions": ...,
"LatestRevision": ...,
"Name": ...,
"State": ...,
}
Definition
class ConfigurationTypeDef(TypedDict):
Arn: str,
CreationTime: datetime,
Description: str,
KafkaVersions: List[str],
LatestRevision: ConfigurationRevisionTypeDef, # (1)
Name: str,
State: ConfigurationStateType, # (2)
CreateConfigurationResponseTypeDef
Usage Example
from mypy_boto3_kafka.type_defs import CreateConfigurationResponseTypeDef
def get_value() -> CreateConfigurationResponseTypeDef:
return {
"Arn": ...,
"CreationTime": ...,
"LatestRevision": ...,
"Name": ...,
"State": ...,
"ResponseMetadata": ...,
}
Definition
class CreateConfigurationResponseTypeDef(TypedDict):
Arn: str,
CreationTime: datetime,
LatestRevision: ConfigurationRevisionTypeDef, # (1)
Name: str,
State: ConfigurationStateType, # (2)
ResponseMetadata: ResponseMetadataTypeDef, # (3)
DescribeConfigurationResponseTypeDef
Usage Example
from mypy_boto3_kafka.type_defs import DescribeConfigurationResponseTypeDef
def get_value() -> DescribeConfigurationResponseTypeDef:
return {
"Arn": ...,
"CreationTime": ...,
"Description": ...,
"KafkaVersions": ...,
"LatestRevision": ...,
"Name": ...,
"State": ...,
"ResponseMetadata": ...,
}
Definition
class DescribeConfigurationResponseTypeDef(TypedDict):
Arn: str,
CreationTime: datetime,
Description: str,
KafkaVersions: List[str],
LatestRevision: ConfigurationRevisionTypeDef, # (1)
Name: str,
State: ConfigurationStateType, # (2)
ResponseMetadata: ResponseMetadataTypeDef, # (3)
ListConfigurationRevisionsResponseTypeDef
Usage Example
from mypy_boto3_kafka.type_defs import ListConfigurationRevisionsResponseTypeDef
def get_value() -> ListConfigurationRevisionsResponseTypeDef:
return {
"NextToken": ...,
"Revisions": ...,
"ResponseMetadata": ...,
}
Definition
class ListConfigurationRevisionsResponseTypeDef(TypedDict):
NextToken: str,
Revisions: List[ConfigurationRevisionTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
UpdateConfigurationResponseTypeDef
Usage Example
from mypy_boto3_kafka.type_defs import UpdateConfigurationResponseTypeDef
def get_value() -> UpdateConfigurationResponseTypeDef:
return {
"Arn": ...,
"LatestRevision": ...,
"ResponseMetadata": ...,
}
Definition
class UpdateConfigurationResponseTypeDef(TypedDict):
Arn: str,
LatestRevision: ConfigurationRevisionTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
ConnectivityInfoTypeDef
Usage Example
from mypy_boto3_kafka.type_defs import ConnectivityInfoTypeDef
def get_value() -> ConnectivityInfoTypeDef:
return {
"PublicAccess": ...,
}
Definition
class ConnectivityInfoTypeDef(TypedDict):
PublicAccess: NotRequired[PublicAccessTypeDef], # (1)
EncryptionInfoTypeDef
Usage Example
from mypy_boto3_kafka.type_defs import EncryptionInfoTypeDef
def get_value() -> EncryptionInfoTypeDef:
return {
"EncryptionAtRest": ...,
}
Definition
class EncryptionInfoTypeDef(TypedDict):
EncryptionAtRest: NotRequired[EncryptionAtRestTypeDef], # (1)
EncryptionInTransit: NotRequired[EncryptionInTransitTypeDef], # (2)
ServerlessSaslTypeDef
Usage Example
from mypy_boto3_kafka.type_defs import ServerlessSaslTypeDef
def get_value() -> ServerlessSaslTypeDef:
return {
"Iam": ...,
}
- See IamTypeDef
ListKafkaVersionsResponseTypeDef
Usage Example
from mypy_boto3_kafka.type_defs import ListKafkaVersionsResponseTypeDef
def get_value() -> ListKafkaVersionsResponseTypeDef:
return {
"KafkaVersions": ...,
"NextToken": ...,
"ResponseMetadata": ...,
}
Definition
class ListKafkaVersionsResponseTypeDef(TypedDict):
KafkaVersions: List[KafkaVersionTypeDef], # (1)
NextToken: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
ListClusterOperationsRequestListClusterOperationsPaginateTypeDef
Usage Example
from mypy_boto3_kafka.type_defs import ListClusterOperationsRequestListClusterOperationsPaginateTypeDef
def get_value() -> ListClusterOperationsRequestListClusterOperationsPaginateTypeDef:
return {
"ClusterArn": ...,
}
Definition
class ListClusterOperationsRequestListClusterOperationsPaginateTypeDef(TypedDict):
ClusterArn: str,
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (1)
ListClustersRequestListClustersPaginateTypeDef
Usage Example
from mypy_boto3_kafka.type_defs import ListClustersRequestListClustersPaginateTypeDef
def get_value() -> ListClustersRequestListClustersPaginateTypeDef:
return {
"ClusterNameFilter": ...,
}
Definition
class ListClustersRequestListClustersPaginateTypeDef(TypedDict):
ClusterNameFilter: NotRequired[str],
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (1)
ListClustersV2RequestListClustersV2PaginateTypeDef
Usage Example
from mypy_boto3_kafka.type_defs import ListClustersV2RequestListClustersV2PaginateTypeDef
def get_value() -> ListClustersV2RequestListClustersV2PaginateTypeDef:
return {
"ClusterNameFilter": ...,
}
Definition
class ListClustersV2RequestListClustersV2PaginateTypeDef(TypedDict):
ClusterNameFilter: NotRequired[str],
ClusterTypeFilter: NotRequired[str],
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (1)
ListConfigurationRevisionsRequestListConfigurationRevisionsPaginateTypeDef
Usage Example
from mypy_boto3_kafka.type_defs import ListConfigurationRevisionsRequestListConfigurationRevisionsPaginateTypeDef
def get_value() -> ListConfigurationRevisionsRequestListConfigurationRevisionsPaginateTypeDef:
return {
"Arn": ...,
}
Definition
class ListConfigurationRevisionsRequestListConfigurationRevisionsPaginateTypeDef(TypedDict):
Arn: str,
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (1)
ListConfigurationsRequestListConfigurationsPaginateTypeDef
Usage Example
from mypy_boto3_kafka.type_defs import ListConfigurationsRequestListConfigurationsPaginateTypeDef
def get_value() -> ListConfigurationsRequestListConfigurationsPaginateTypeDef:
return {
"PaginationConfig": ...,
}
Definition
class ListConfigurationsRequestListConfigurationsPaginateTypeDef(TypedDict):
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (1)
ListKafkaVersionsRequestListKafkaVersionsPaginateTypeDef
Usage Example
from mypy_boto3_kafka.type_defs import ListKafkaVersionsRequestListKafkaVersionsPaginateTypeDef
def get_value() -> ListKafkaVersionsRequestListKafkaVersionsPaginateTypeDef:
return {
"PaginationConfig": ...,
}
Definition
class ListKafkaVersionsRequestListKafkaVersionsPaginateTypeDef(TypedDict):
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (1)
ListNodesRequestListNodesPaginateTypeDef
Usage Example
from mypy_boto3_kafka.type_defs import ListNodesRequestListNodesPaginateTypeDef
def get_value() -> ListNodesRequestListNodesPaginateTypeDef:
return {
"ClusterArn": ...,
}
Definition
class ListNodesRequestListNodesPaginateTypeDef(TypedDict):
ClusterArn: str,
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (1)
ListScramSecretsRequestListScramSecretsPaginateTypeDef
Usage Example
from mypy_boto3_kafka.type_defs import ListScramSecretsRequestListScramSecretsPaginateTypeDef
def get_value() -> ListScramSecretsRequestListScramSecretsPaginateTypeDef:
return {
"ClusterArn": ...,
}
Definition
class ListScramSecretsRequestListScramSecretsPaginateTypeDef(TypedDict):
ClusterArn: str,
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (1)
PrometheusInfoTypeDef
Usage Example
from mypy_boto3_kafka.type_defs import PrometheusInfoTypeDef
def get_value() -> PrometheusInfoTypeDef:
return {
"JmxExporter": ...,
}
Definition
class PrometheusInfoTypeDef(TypedDict):
JmxExporter: NotRequired[JmxExporterInfoTypeDef], # (1)
NodeExporter: NotRequired[NodeExporterInfoTypeDef], # (2)
PrometheusTypeDef
Usage Example
from mypy_boto3_kafka.type_defs import PrometheusTypeDef
def get_value() -> PrometheusTypeDef:
return {
"JmxExporter": ...,
}
Definition
class PrometheusTypeDef(TypedDict):
JmxExporter: NotRequired[JmxExporterTypeDef], # (1)
NodeExporter: NotRequired[NodeExporterTypeDef], # (2)
SaslTypeDef
Usage Example
from mypy_boto3_kafka.type_defs import SaslTypeDef
def get_value() -> SaslTypeDef:
return {
"Scram": ...,
}
Definition
class SaslTypeDef(TypedDict):
Scram: NotRequired[ScramTypeDef], # (1)
Iam: NotRequired[IamTypeDef], # (2)
- See ScramTypeDef
- See IamTypeDef
UpdateBrokerStorageRequestRequestTypeDef
Usage Example
from mypy_boto3_kafka.type_defs import UpdateBrokerStorageRequestRequestTypeDef
def get_value() -> UpdateBrokerStorageRequestRequestTypeDef:
return {
"ClusterArn": ...,
"CurrentVersion": ...,
"TargetBrokerEBSVolumeInfo": ...,
}
Definition
class UpdateBrokerStorageRequestRequestTypeDef(TypedDict):
ClusterArn: str,
CurrentVersion: str,
TargetBrokerEBSVolumeInfo: Sequence[BrokerEBSVolumeInfoTypeDef], # (1)
StorageInfoTypeDef
Usage Example
from mypy_boto3_kafka.type_defs import StorageInfoTypeDef
def get_value() -> StorageInfoTypeDef:
return {
"EbsStorageInfo": ...,
}
Definition
class StorageInfoTypeDef(TypedDict):
EbsStorageInfo: NotRequired[EBSStorageInfoTypeDef], # (1)
LoggingInfoTypeDef
Usage Example
from mypy_boto3_kafka.type_defs import LoggingInfoTypeDef
def get_value() -> LoggingInfoTypeDef:
return {
"BrokerLogs": ...,
}
NodeInfoTypeDef
Usage Example
from mypy_boto3_kafka.type_defs import NodeInfoTypeDef
def get_value() -> NodeInfoTypeDef:
return {
"AddedToClusterTime": ...,
}
Definition
class NodeInfoTypeDef(TypedDict):
AddedToClusterTime: NotRequired[str],
BrokerNodeInfo: NotRequired[BrokerNodeInfoTypeDef], # (1)
InstanceType: NotRequired[str],
NodeARN: NotRequired[str],
NodeType: NotRequired[NodeTypeType], # (2)
ZookeeperNodeInfo: NotRequired[ZookeeperNodeInfoTypeDef], # (3)
ListConfigurationsResponseTypeDef
Usage Example
from mypy_boto3_kafka.type_defs import ListConfigurationsResponseTypeDef
def get_value() -> ListConfigurationsResponseTypeDef:
return {
"Configurations": ...,
"NextToken": ...,
"ResponseMetadata": ...,
}
Definition
class ListConfigurationsResponseTypeDef(TypedDict):
Configurations: List[ConfigurationTypeDef], # (1)
NextToken: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
UpdateConnectivityRequestRequestTypeDef
Usage Example
from mypy_boto3_kafka.type_defs import UpdateConnectivityRequestRequestTypeDef
def get_value() -> UpdateConnectivityRequestRequestTypeDef:
return {
"ClusterArn": ...,
"ConnectivityInfo": ...,
"CurrentVersion": ...,
}
Definition
class UpdateConnectivityRequestRequestTypeDef(TypedDict):
ClusterArn: str,
ConnectivityInfo: ConnectivityInfoTypeDef, # (1)
CurrentVersion: str,
ServerlessClientAuthenticationTypeDef
Usage Example
from mypy_boto3_kafka.type_defs import ServerlessClientAuthenticationTypeDef
def get_value() -> ServerlessClientAuthenticationTypeDef:
return {
"Sasl": ...,
}
Definition
class ServerlessClientAuthenticationTypeDef(TypedDict):
Sasl: NotRequired[ServerlessSaslTypeDef], # (1)
OpenMonitoringInfoTypeDef
Usage Example
from mypy_boto3_kafka.type_defs import OpenMonitoringInfoTypeDef
def get_value() -> OpenMonitoringInfoTypeDef:
return {
"Prometheus": ...,
}
OpenMonitoringTypeDef
Usage Example
from mypy_boto3_kafka.type_defs import OpenMonitoringTypeDef
def get_value() -> OpenMonitoringTypeDef:
return {
"Prometheus": ...,
}
ClientAuthenticationTypeDef
Usage Example
from mypy_boto3_kafka.type_defs import ClientAuthenticationTypeDef
def get_value() -> ClientAuthenticationTypeDef:
return {
"Sasl": ...,
}
Definition
class ClientAuthenticationTypeDef(TypedDict):
Sasl: NotRequired[SaslTypeDef], # (1)
Tls: NotRequired[TlsTypeDef], # (2)
Unauthenticated: NotRequired[UnauthenticatedTypeDef], # (3)
- See SaslTypeDef
- See TlsTypeDef
- See UnauthenticatedTypeDef
BrokerNodeGroupInfoTypeDef
Usage Example
from mypy_boto3_kafka.type_defs import BrokerNodeGroupInfoTypeDef
def get_value() -> BrokerNodeGroupInfoTypeDef:
return {
"ClientSubnets": ...,
"InstanceType": ...,
}
Definition
class BrokerNodeGroupInfoTypeDef(TypedDict):
ClientSubnets: Sequence[str],
InstanceType: str,
BrokerAZDistribution: NotRequired[BrokerAZDistributionType], # (1)
SecurityGroups: NotRequired[Sequence[str]],
StorageInfo: NotRequired[StorageInfoTypeDef], # (2)
ConnectivityInfo: NotRequired[ConnectivityInfoTypeDef], # (3)
ListNodesResponseTypeDef
Usage Example
from mypy_boto3_kafka.type_defs import ListNodesResponseTypeDef
def get_value() -> ListNodesResponseTypeDef:
return {
"NextToken": ...,
"NodeInfoList": ...,
"ResponseMetadata": ...,
}
Definition
class ListNodesResponseTypeDef(TypedDict):
NextToken: str,
NodeInfoList: List[NodeInfoTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
ServerlessRequestTypeDef
Usage Example
from mypy_boto3_kafka.type_defs import ServerlessRequestTypeDef
def get_value() -> ServerlessRequestTypeDef:
return {
"VpcConfigs": ...,
}
Definition
class ServerlessRequestTypeDef(TypedDict):
VpcConfigs: Sequence[VpcConfigTypeDef], # (1)
ClientAuthentication: NotRequired[ServerlessClientAuthenticationTypeDef], # (2)
ServerlessTypeDef
Usage Example
from mypy_boto3_kafka.type_defs import ServerlessTypeDef
def get_value() -> ServerlessTypeDef:
return {
"VpcConfigs": ...,
}
Definition
class ServerlessTypeDef(TypedDict):
VpcConfigs: List[VpcConfigTypeDef], # (1)
ClientAuthentication: NotRequired[ServerlessClientAuthenticationTypeDef], # (2)
UpdateMonitoringRequestRequestTypeDef
Usage Example
from mypy_boto3_kafka.type_defs import UpdateMonitoringRequestRequestTypeDef
def get_value() -> UpdateMonitoringRequestRequestTypeDef:
return {
"ClusterArn": ...,
"CurrentVersion": ...,
}
Definition
class UpdateMonitoringRequestRequestTypeDef(TypedDict):
ClusterArn: str,
CurrentVersion: str,
EnhancedMonitoring: NotRequired[EnhancedMonitoringType], # (1)
OpenMonitoring: NotRequired[OpenMonitoringInfoTypeDef], # (2)
LoggingInfo: NotRequired[LoggingInfoTypeDef], # (3)
MutableClusterInfoTypeDef
Usage Example
from mypy_boto3_kafka.type_defs import MutableClusterInfoTypeDef
def get_value() -> MutableClusterInfoTypeDef:
return {
"BrokerEBSVolumeInfo": ...,
}
Definition
class MutableClusterInfoTypeDef(TypedDict):
BrokerEBSVolumeInfo: NotRequired[List[BrokerEBSVolumeInfoTypeDef]], # (1)
ConfigurationInfo: NotRequired[ConfigurationInfoTypeDef], # (2)
NumberOfBrokerNodes: NotRequired[int],
EnhancedMonitoring: NotRequired[EnhancedMonitoringType], # (3)
OpenMonitoring: NotRequired[OpenMonitoringTypeDef], # (4)
KafkaVersion: NotRequired[str],
LoggingInfo: NotRequired[LoggingInfoTypeDef], # (5)
InstanceType: NotRequired[str],
ClientAuthentication: NotRequired[ClientAuthenticationTypeDef], # (6)
EncryptionInfo: NotRequired[EncryptionInfoTypeDef], # (7)
ConnectivityInfo: NotRequired[ConnectivityInfoTypeDef], # (8)
StorageMode: NotRequired[StorageModeType], # (9)
- See BrokerEBSVolumeInfoTypeDef
- See ConfigurationInfoTypeDef
- See EnhancedMonitoringType
- See OpenMonitoringTypeDef
- See LoggingInfoTypeDef
- See ClientAuthenticationTypeDef
- See EncryptionInfoTypeDef
- See ConnectivityInfoTypeDef
- See StorageModeType
UpdateSecurityRequestRequestTypeDef
Usage Example
from mypy_boto3_kafka.type_defs import UpdateSecurityRequestRequestTypeDef
def get_value() -> UpdateSecurityRequestRequestTypeDef:
return {
"ClusterArn": ...,
"CurrentVersion": ...,
}
Definition
class UpdateSecurityRequestRequestTypeDef(TypedDict):
ClusterArn: str,
CurrentVersion: str,
ClientAuthentication: NotRequired[ClientAuthenticationTypeDef], # (1)
EncryptionInfo: NotRequired[EncryptionInfoTypeDef], # (2)
ClusterInfoTypeDef
Usage Example
from mypy_boto3_kafka.type_defs import ClusterInfoTypeDef
def get_value() -> ClusterInfoTypeDef:
return {
"ActiveOperationArn": ...,
}
Definition
class ClusterInfoTypeDef(TypedDict):
ActiveOperationArn: NotRequired[str],
BrokerNodeGroupInfo: NotRequired[BrokerNodeGroupInfoTypeDef], # (1)
ClientAuthentication: NotRequired[ClientAuthenticationTypeDef], # (2)
ClusterArn: NotRequired[str],
ClusterName: NotRequired[str],
CreationTime: NotRequired[datetime],
CurrentBrokerSoftwareInfo: NotRequired[BrokerSoftwareInfoTypeDef], # (3)
CurrentVersion: NotRequired[str],
EncryptionInfo: NotRequired[EncryptionInfoTypeDef], # (4)
EnhancedMonitoring: NotRequired[EnhancedMonitoringType], # (5)
OpenMonitoring: NotRequired[OpenMonitoringTypeDef], # (6)
LoggingInfo: NotRequired[LoggingInfoTypeDef], # (7)
NumberOfBrokerNodes: NotRequired[int],
State: NotRequired[ClusterStateType], # (8)
StateInfo: NotRequired[StateInfoTypeDef], # (9)
Tags: NotRequired[Dict[str, str]],
ZookeeperConnectString: NotRequired[str],
ZookeeperConnectStringTls: NotRequired[str],
StorageMode: NotRequired[StorageModeType], # (10)
- See BrokerNodeGroupInfoTypeDef
- See ClientAuthenticationTypeDef
- See BrokerSoftwareInfoTypeDef
- See EncryptionInfoTypeDef
- See EnhancedMonitoringType
- See OpenMonitoringTypeDef
- See LoggingInfoTypeDef
- See ClusterStateType
- See StateInfoTypeDef
- See StorageModeType
CreateClusterRequestRequestTypeDef
Usage Example
from mypy_boto3_kafka.type_defs import CreateClusterRequestRequestTypeDef
def get_value() -> CreateClusterRequestRequestTypeDef:
return {
"BrokerNodeGroupInfo": ...,
"ClusterName": ...,
"KafkaVersion": ...,
"NumberOfBrokerNodes": ...,
}
Definition
class CreateClusterRequestRequestTypeDef(TypedDict):
BrokerNodeGroupInfo: BrokerNodeGroupInfoTypeDef, # (1)
ClusterName: str,
KafkaVersion: str,
NumberOfBrokerNodes: int,
ClientAuthentication: NotRequired[ClientAuthenticationTypeDef], # (2)
ConfigurationInfo: NotRequired[ConfigurationInfoTypeDef], # (3)
EncryptionInfo: NotRequired[EncryptionInfoTypeDef], # (4)
EnhancedMonitoring: NotRequired[EnhancedMonitoringType], # (5)
OpenMonitoring: NotRequired[OpenMonitoringInfoTypeDef], # (6)
LoggingInfo: NotRequired[LoggingInfoTypeDef], # (7)
Tags: NotRequired[Mapping[str, str]],
StorageMode: NotRequired[StorageModeType], # (8)
- See BrokerNodeGroupInfoTypeDef
- See ClientAuthenticationTypeDef
- See ConfigurationInfoTypeDef
- See EncryptionInfoTypeDef
- See EnhancedMonitoringType
- See OpenMonitoringInfoTypeDef
- See LoggingInfoTypeDef
- See StorageModeType
ProvisionedRequestTypeDef
Usage Example
from mypy_boto3_kafka.type_defs import ProvisionedRequestTypeDef
def get_value() -> ProvisionedRequestTypeDef:
return {
"BrokerNodeGroupInfo": ...,
"KafkaVersion": ...,
"NumberOfBrokerNodes": ...,
}
Definition
class ProvisionedRequestTypeDef(TypedDict):
BrokerNodeGroupInfo: BrokerNodeGroupInfoTypeDef, # (1)
KafkaVersion: str,
NumberOfBrokerNodes: int,
ClientAuthentication: NotRequired[ClientAuthenticationTypeDef], # (2)
ConfigurationInfo: NotRequired[ConfigurationInfoTypeDef], # (3)
EncryptionInfo: NotRequired[EncryptionInfoTypeDef], # (4)
EnhancedMonitoring: NotRequired[EnhancedMonitoringType], # (5)
OpenMonitoring: NotRequired[OpenMonitoringInfoTypeDef], # (6)
LoggingInfo: NotRequired[LoggingInfoTypeDef], # (7)
StorageMode: NotRequired[StorageModeType], # (8)
- See BrokerNodeGroupInfoTypeDef
- See ClientAuthenticationTypeDef
- See ConfigurationInfoTypeDef
- See EncryptionInfoTypeDef
- See EnhancedMonitoringType
- See OpenMonitoringInfoTypeDef
- See LoggingInfoTypeDef
- See StorageModeType
ProvisionedTypeDef
Usage Example
from mypy_boto3_kafka.type_defs import ProvisionedTypeDef
def get_value() -> ProvisionedTypeDef:
return {
"BrokerNodeGroupInfo": ...,
"NumberOfBrokerNodes": ...,
}
Definition
class ProvisionedTypeDef(TypedDict):
BrokerNodeGroupInfo: BrokerNodeGroupInfoTypeDef, # (1)
NumberOfBrokerNodes: int,
CurrentBrokerSoftwareInfo: NotRequired[BrokerSoftwareInfoTypeDef], # (2)
ClientAuthentication: NotRequired[ClientAuthenticationTypeDef], # (3)
EncryptionInfo: NotRequired[EncryptionInfoTypeDef], # (4)
EnhancedMonitoring: NotRequired[EnhancedMonitoringType], # (5)
OpenMonitoring: NotRequired[OpenMonitoringInfoTypeDef], # (6)
LoggingInfo: NotRequired[LoggingInfoTypeDef], # (7)
ZookeeperConnectString: NotRequired[str],
ZookeeperConnectStringTls: NotRequired[str],
StorageMode: NotRequired[StorageModeType], # (8)
- See BrokerNodeGroupInfoTypeDef
- See BrokerSoftwareInfoTypeDef
- See ClientAuthenticationTypeDef
- See EncryptionInfoTypeDef
- See EnhancedMonitoringType
- See OpenMonitoringInfoTypeDef
- See LoggingInfoTypeDef
- See StorageModeType
ClusterOperationInfoTypeDef
Usage Example
from mypy_boto3_kafka.type_defs import ClusterOperationInfoTypeDef
def get_value() -> ClusterOperationInfoTypeDef:
return {
"ClientRequestId": ...,
}
Definition
class ClusterOperationInfoTypeDef(TypedDict):
ClientRequestId: NotRequired[str],
ClusterArn: NotRequired[str],
CreationTime: NotRequired[datetime],
EndTime: NotRequired[datetime],
ErrorInfo: NotRequired[ErrorInfoTypeDef], # (1)
OperationArn: NotRequired[str],
OperationState: NotRequired[str],
OperationSteps: NotRequired[List[ClusterOperationStepTypeDef]], # (2)
OperationType: NotRequired[str],
SourceClusterInfo: NotRequired[MutableClusterInfoTypeDef], # (3)
TargetClusterInfo: NotRequired[MutableClusterInfoTypeDef], # (3)
- See ErrorInfoTypeDef
- See ClusterOperationStepTypeDef
- See MutableClusterInfoTypeDef
- See MutableClusterInfoTypeDef
DescribeClusterResponseTypeDef
Usage Example
from mypy_boto3_kafka.type_defs import DescribeClusterResponseTypeDef
def get_value() -> DescribeClusterResponseTypeDef:
return {
"ClusterInfo": ...,
"ResponseMetadata": ...,
}
Definition
class DescribeClusterResponseTypeDef(TypedDict):
ClusterInfo: ClusterInfoTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
ListClustersResponseTypeDef
Usage Example
from mypy_boto3_kafka.type_defs import ListClustersResponseTypeDef
def get_value() -> ListClustersResponseTypeDef:
return {
"ClusterInfoList": ...,
"NextToken": ...,
"ResponseMetadata": ...,
}
Definition
class ListClustersResponseTypeDef(TypedDict):
ClusterInfoList: List[ClusterInfoTypeDef], # (1)
NextToken: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
CreateClusterV2RequestRequestTypeDef
Usage Example
from mypy_boto3_kafka.type_defs import CreateClusterV2RequestRequestTypeDef
def get_value() -> CreateClusterV2RequestRequestTypeDef:
return {
"ClusterName": ...,
}
Definition
class CreateClusterV2RequestRequestTypeDef(TypedDict):
ClusterName: str,
Tags: NotRequired[Mapping[str, str]],
Provisioned: NotRequired[ProvisionedRequestTypeDef], # (1)
Serverless: NotRequired[ServerlessRequestTypeDef], # (2)
ClusterTypeDef
Usage Example
from mypy_boto3_kafka.type_defs import ClusterTypeDef
def get_value() -> ClusterTypeDef:
return {
"ActiveOperationArn": ...,
}
Definition
class ClusterTypeDef(TypedDict):
ActiveOperationArn: NotRequired[str],
ClusterType: NotRequired[ClusterTypeType], # (1)
ClusterArn: NotRequired[str],
ClusterName: NotRequired[str],
CreationTime: NotRequired[datetime],
CurrentVersion: NotRequired[str],
State: NotRequired[ClusterStateType], # (2)
StateInfo: NotRequired[StateInfoTypeDef], # (3)
Tags: NotRequired[Dict[str, str]],
Provisioned: NotRequired[ProvisionedTypeDef], # (4)
Serverless: NotRequired[ServerlessTypeDef], # (5)
- See ClusterTypeType
- See ClusterStateType
- See StateInfoTypeDef
- See ProvisionedTypeDef
- See ServerlessTypeDef
DescribeClusterOperationResponseTypeDef
Usage Example
from mypy_boto3_kafka.type_defs import DescribeClusterOperationResponseTypeDef
def get_value() -> DescribeClusterOperationResponseTypeDef:
return {
"ClusterOperationInfo": ...,
"ResponseMetadata": ...,
}
Definition
class DescribeClusterOperationResponseTypeDef(TypedDict):
ClusterOperationInfo: ClusterOperationInfoTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
ListClusterOperationsResponseTypeDef
Usage Example
from mypy_boto3_kafka.type_defs import ListClusterOperationsResponseTypeDef
def get_value() -> ListClusterOperationsResponseTypeDef:
return {
"ClusterOperationInfoList": ...,
"NextToken": ...,
"ResponseMetadata": ...,
}
Definition
class ListClusterOperationsResponseTypeDef(TypedDict):
ClusterOperationInfoList: List[ClusterOperationInfoTypeDef], # (1)
NextToken: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
DescribeClusterV2ResponseTypeDef
Usage Example
from mypy_boto3_kafka.type_defs import DescribeClusterV2ResponseTypeDef
def get_value() -> DescribeClusterV2ResponseTypeDef:
return {
"ClusterInfo": ...,
"ResponseMetadata": ...,
}
Definition
class DescribeClusterV2ResponseTypeDef(TypedDict):
ClusterInfo: ClusterTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
ListClustersV2ResponseTypeDef
Usage Example
from mypy_boto3_kafka.type_defs import ListClustersV2ResponseTypeDef
def get_value() -> ListClustersV2ResponseTypeDef:
return {
"ClusterInfoList": ...,
"NextToken": ...,
"ResponseMetadata": ...,
}