Skip to content

Type definitions#

Index > Kafka > Type definitions

Auto-generated documentation for Kafka type annotations stubs module mypy-boto3-kafka.

BlobTypeDef#

# BlobTypeDef definition

BlobTypeDef = Union[
    str,
    bytes,
    IO[Any],
    StreamingBody,
]

AmazonMskClusterTypeDef#

# AmazonMskClusterTypeDef definition

class AmazonMskClusterTypeDef(TypedDict):
    MskClusterArn: str,

BatchAssociateScramSecretRequestRequestTypeDef#

# BatchAssociateScramSecretRequestRequestTypeDef definition

class BatchAssociateScramSecretRequestRequestTypeDef(TypedDict):
    ClusterArn: str,
    SecretArnList: Sequence[str],

ResponseMetadataTypeDef#

# ResponseMetadataTypeDef definition

class ResponseMetadataTypeDef(TypedDict):
    RequestId: str,
    HostId: str,
    HTTPStatusCode: int,
    HTTPHeaders: Dict[str, str],
    RetryAttempts: int,

UnprocessedScramSecretTypeDef#

# UnprocessedScramSecretTypeDef definition

class UnprocessedScramSecretTypeDef(TypedDict):
    ErrorCode: NotRequired[str],
    ErrorMessage: NotRequired[str],
    SecretArn: NotRequired[str],

BatchDisassociateScramSecretRequestRequestTypeDef#

# BatchDisassociateScramSecretRequestRequestTypeDef definition

class BatchDisassociateScramSecretRequestRequestTypeDef(TypedDict):
    ClusterArn: str,
    SecretArnList: Sequence[str],

ProvisionedThroughputTypeDef#

# ProvisionedThroughputTypeDef definition

class ProvisionedThroughputTypeDef(TypedDict):
    Enabled: NotRequired[bool],
    VolumeThroughput: NotRequired[int],

CloudWatchLogsTypeDef#

# CloudWatchLogsTypeDef definition

class CloudWatchLogsTypeDef(TypedDict):
    Enabled: bool,
    LogGroup: NotRequired[str],

FirehoseTypeDef#

# FirehoseTypeDef definition

class FirehoseTypeDef(TypedDict):
    Enabled: bool,
    DeliveryStream: NotRequired[str],

S3TypeDef#

# S3TypeDef definition

class S3TypeDef(TypedDict):
    Enabled: bool,
    Bucket: NotRequired[str],
    Prefix: NotRequired[str],

BrokerSoftwareInfoTypeDef#

# BrokerSoftwareInfoTypeDef definition

class BrokerSoftwareInfoTypeDef(TypedDict):
    ConfigurationArn: NotRequired[str],
    ConfigurationRevision: NotRequired[int],
    KafkaVersion: NotRequired[str],

TlsPaginatorTypeDef#

# TlsPaginatorTypeDef definition

class TlsPaginatorTypeDef(TypedDict):
    CertificateAuthorityArnList: NotRequired[List[str]],
    Enabled: NotRequired[bool],

UnauthenticatedTypeDef#

# UnauthenticatedTypeDef definition

class UnauthenticatedTypeDef(TypedDict):
    Enabled: NotRequired[bool],

TlsTypeDef#

# TlsTypeDef definition

class TlsTypeDef(TypedDict):
    CertificateAuthorityArnList: NotRequired[Sequence[str]],
    Enabled: NotRequired[bool],

ClientVpcConnectionTypeDef#

# ClientVpcConnectionTypeDef definition

class ClientVpcConnectionTypeDef(TypedDict):
    VpcConnectionArn: str,
    Authentication: NotRequired[str],
    CreationTime: NotRequired[datetime],
    State: NotRequired[VpcConnectionStateType],  # (1)
    Owner: NotRequired[str],
  1. See VpcConnectionStateType

StateInfoTypeDef#

# StateInfoTypeDef definition

class StateInfoTypeDef(TypedDict):
    Code: NotRequired[str],
    Message: NotRequired[str],

ErrorInfoTypeDef#

# ErrorInfoTypeDef definition

class ErrorInfoTypeDef(TypedDict):
    ErrorCode: NotRequired[str],
    ErrorString: NotRequired[str],

ClusterOperationStepInfoTypeDef#

# ClusterOperationStepInfoTypeDef definition

class ClusterOperationStepInfoTypeDef(TypedDict):
    StepStatus: NotRequired[str],

ClusterOperationV2SummaryTypeDef#

# ClusterOperationV2SummaryTypeDef definition

class ClusterOperationV2SummaryTypeDef(TypedDict):
    ClusterArn: NotRequired[str],
    ClusterType: NotRequired[ClusterTypeType],  # (1)
    StartTime: NotRequired[datetime],
    EndTime: NotRequired[datetime],
    OperationArn: NotRequired[str],
    OperationState: NotRequired[str],
    OperationType: NotRequired[str],
  1. See ClusterTypeType

CompatibleKafkaVersionTypeDef#

# CompatibleKafkaVersionTypeDef definition

class CompatibleKafkaVersionTypeDef(TypedDict):
    SourceVersion: NotRequired[str],
    TargetVersions: NotRequired[List[str]],

ConfigurationInfoTypeDef#

# ConfigurationInfoTypeDef definition

class ConfigurationInfoTypeDef(TypedDict):
    Arn: str,
    Revision: int,

ConfigurationRevisionTypeDef#

# ConfigurationRevisionTypeDef definition

class ConfigurationRevisionTypeDef(TypedDict):
    CreationTime: datetime,
    Revision: int,
    Description: NotRequired[str],

PublicAccessTypeDef#

# PublicAccessTypeDef definition

class PublicAccessTypeDef(TypedDict):
    Type: NotRequired[str],

ConsumerGroupReplicationTypeDef#

# ConsumerGroupReplicationTypeDef definition

class ConsumerGroupReplicationTypeDef(TypedDict):
    ConsumerGroupsToReplicate: Sequence[str],
    ConsumerGroupsToExclude: NotRequired[Sequence[str]],
    DetectAndCopyNewConsumerGroups: NotRequired[bool],
    SynchroniseConsumerGroupOffsets: NotRequired[bool],

ConsumerGroupReplicationUpdateTypeDef#

# ConsumerGroupReplicationUpdateTypeDef definition

class ConsumerGroupReplicationUpdateTypeDef(TypedDict):
    ConsumerGroupsToExclude: Sequence[str],
    ConsumerGroupsToReplicate: Sequence[str],
    DetectAndCopyNewConsumerGroups: bool,
    SynchroniseConsumerGroupOffsets: bool,

CreateVpcConnectionRequestRequestTypeDef#

# CreateVpcConnectionRequestRequestTypeDef definition

class CreateVpcConnectionRequestRequestTypeDef(TypedDict):
    TargetClusterArn: str,
    Authentication: str,
    VpcId: str,
    ClientSubnets: Sequence[str],
    SecurityGroups: Sequence[str],
    Tags: NotRequired[Mapping[str, str]],

DeleteClusterPolicyRequestRequestTypeDef#

# DeleteClusterPolicyRequestRequestTypeDef definition

class DeleteClusterPolicyRequestRequestTypeDef(TypedDict):
    ClusterArn: str,

DeleteClusterRequestRequestTypeDef#

# DeleteClusterRequestRequestTypeDef definition

class DeleteClusterRequestRequestTypeDef(TypedDict):
    ClusterArn: str,
    CurrentVersion: NotRequired[str],

DeleteConfigurationRequestRequestTypeDef#

# DeleteConfigurationRequestRequestTypeDef definition

class DeleteConfigurationRequestRequestTypeDef(TypedDict):
    Arn: str,

DeleteReplicatorRequestRequestTypeDef#

# DeleteReplicatorRequestRequestTypeDef definition

class DeleteReplicatorRequestRequestTypeDef(TypedDict):
    ReplicatorArn: str,
    CurrentVersion: NotRequired[str],

DeleteVpcConnectionRequestRequestTypeDef#

# DeleteVpcConnectionRequestRequestTypeDef definition

class DeleteVpcConnectionRequestRequestTypeDef(TypedDict):
    Arn: str,

DescribeClusterOperationRequestRequestTypeDef#

# DescribeClusterOperationRequestRequestTypeDef definition

class DescribeClusterOperationRequestRequestTypeDef(TypedDict):
    ClusterOperationArn: str,

DescribeClusterOperationV2RequestRequestTypeDef#

# DescribeClusterOperationV2RequestRequestTypeDef definition

class DescribeClusterOperationV2RequestRequestTypeDef(TypedDict):
    ClusterOperationArn: str,

DescribeClusterRequestRequestTypeDef#

# DescribeClusterRequestRequestTypeDef definition

class DescribeClusterRequestRequestTypeDef(TypedDict):
    ClusterArn: str,

DescribeClusterV2RequestRequestTypeDef#

# DescribeClusterV2RequestRequestTypeDef definition

class DescribeClusterV2RequestRequestTypeDef(TypedDict):
    ClusterArn: str,

DescribeConfigurationRequestRequestTypeDef#

# DescribeConfigurationRequestRequestTypeDef definition

class DescribeConfigurationRequestRequestTypeDef(TypedDict):
    Arn: str,

DescribeConfigurationRevisionRequestRequestTypeDef#

# DescribeConfigurationRevisionRequestRequestTypeDef definition

class DescribeConfigurationRevisionRequestRequestTypeDef(TypedDict):
    Arn: str,
    Revision: int,

DescribeReplicatorRequestRequestTypeDef#

# DescribeReplicatorRequestRequestTypeDef definition

class DescribeReplicatorRequestRequestTypeDef(TypedDict):
    ReplicatorArn: str,

ReplicationStateInfoTypeDef#

# ReplicationStateInfoTypeDef definition

class ReplicationStateInfoTypeDef(TypedDict):
    Code: NotRequired[str],
    Message: NotRequired[str],

DescribeVpcConnectionRequestRequestTypeDef#

# DescribeVpcConnectionRequestRequestTypeDef definition

class DescribeVpcConnectionRequestRequestTypeDef(TypedDict):
    Arn: str,

EncryptionAtRestTypeDef#

# EncryptionAtRestTypeDef definition

class EncryptionAtRestTypeDef(TypedDict):
    DataVolumeKMSKeyId: str,

EncryptionInTransitTypeDef#

# EncryptionInTransitTypeDef definition

class EncryptionInTransitTypeDef(TypedDict):
    ClientBroker: NotRequired[ClientBrokerType],  # (1)
    InCluster: NotRequired[bool],
  1. See ClientBrokerType

GetBootstrapBrokersRequestRequestTypeDef#

# GetBootstrapBrokersRequestRequestTypeDef definition

class GetBootstrapBrokersRequestRequestTypeDef(TypedDict):
    ClusterArn: str,

GetClusterPolicyRequestRequestTypeDef#

# GetClusterPolicyRequestRequestTypeDef definition

class GetClusterPolicyRequestRequestTypeDef(TypedDict):
    ClusterArn: str,

GetCompatibleKafkaVersionsRequestRequestTypeDef#

# GetCompatibleKafkaVersionsRequestRequestTypeDef definition

class GetCompatibleKafkaVersionsRequestRequestTypeDef(TypedDict):
    ClusterArn: NotRequired[str],

IamTypeDef#

# IamTypeDef definition

class IamTypeDef(TypedDict):
    Enabled: NotRequired[bool],

JmxExporterInfoTypeDef#

# JmxExporterInfoTypeDef definition

class JmxExporterInfoTypeDef(TypedDict):
    EnabledInBroker: bool,

JmxExporterTypeDef#

# JmxExporterTypeDef definition

class JmxExporterTypeDef(TypedDict):
    EnabledInBroker: bool,

KafkaClusterClientVpcConfigTypeDef#

# KafkaClusterClientVpcConfigTypeDef definition

class KafkaClusterClientVpcConfigTypeDef(TypedDict):
    SubnetIds: Sequence[str],
    SecurityGroupIds: NotRequired[Sequence[str]],

KafkaVersionTypeDef#

# KafkaVersionTypeDef definition

class KafkaVersionTypeDef(TypedDict):
    Version: NotRequired[str],
    Status: NotRequired[KafkaVersionStatusType],  # (1)
  1. See KafkaVersionStatusType

PaginatorConfigTypeDef#

# PaginatorConfigTypeDef definition

class PaginatorConfigTypeDef(TypedDict):
    MaxItems: NotRequired[int],
    PageSize: NotRequired[int],
    StartingToken: NotRequired[str],

ListClientVpcConnectionsRequestRequestTypeDef#

# ListClientVpcConnectionsRequestRequestTypeDef definition

class ListClientVpcConnectionsRequestRequestTypeDef(TypedDict):
    ClusterArn: str,
    MaxResults: NotRequired[int],
    NextToken: NotRequired[str],

ListClusterOperationsRequestRequestTypeDef#

# ListClusterOperationsRequestRequestTypeDef definition

class ListClusterOperationsRequestRequestTypeDef(TypedDict):
    ClusterArn: str,
    MaxResults: NotRequired[int],
    NextToken: NotRequired[str],

ListClusterOperationsV2RequestRequestTypeDef#

# ListClusterOperationsV2RequestRequestTypeDef definition

class ListClusterOperationsV2RequestRequestTypeDef(TypedDict):
    ClusterArn: str,
    MaxResults: NotRequired[int],
    NextToken: NotRequired[str],

ListClustersRequestRequestTypeDef#

# ListClustersRequestRequestTypeDef definition

class ListClustersRequestRequestTypeDef(TypedDict):
    ClusterNameFilter: NotRequired[str],
    MaxResults: NotRequired[int],
    NextToken: NotRequired[str],

ListClustersV2RequestRequestTypeDef#

# ListClustersV2RequestRequestTypeDef definition

class ListClustersV2RequestRequestTypeDef(TypedDict):
    ClusterNameFilter: NotRequired[str],
    ClusterTypeFilter: NotRequired[str],
    MaxResults: NotRequired[int],
    NextToken: NotRequired[str],

ListConfigurationRevisionsRequestRequestTypeDef#

# ListConfigurationRevisionsRequestRequestTypeDef definition

class ListConfigurationRevisionsRequestRequestTypeDef(TypedDict):
    Arn: str,
    MaxResults: NotRequired[int],
    NextToken: NotRequired[str],

ListConfigurationsRequestRequestTypeDef#

# ListConfigurationsRequestRequestTypeDef definition

class ListConfigurationsRequestRequestTypeDef(TypedDict):
    MaxResults: NotRequired[int],
    NextToken: NotRequired[str],

ListKafkaVersionsRequestRequestTypeDef#

# ListKafkaVersionsRequestRequestTypeDef definition

class ListKafkaVersionsRequestRequestTypeDef(TypedDict):
    MaxResults: NotRequired[int],
    NextToken: NotRequired[str],

ListNodesRequestRequestTypeDef#

# ListNodesRequestRequestTypeDef definition

class ListNodesRequestRequestTypeDef(TypedDict):
    ClusterArn: str,
    MaxResults: NotRequired[int],
    NextToken: NotRequired[str],

ListReplicatorsRequestRequestTypeDef#