Skip to content

Type definitions#

Index > KafkaConnect > Type definitions

Auto-generated documentation for KafkaConnect type annotations stubs module mypy-boto3-kafkaconnect.

VpcDescriptionTypeDef#

# VpcDescriptionTypeDef definition

class VpcDescriptionTypeDef(TypedDict):
    securityGroups: NotRequired[List[str]],
    subnets: NotRequired[List[str]],

VpcTypeDef#

# VpcTypeDef definition

class VpcTypeDef(TypedDict):
    subnets: Sequence[str],
    securityGroups: NotRequired[Sequence[str]],

ScaleInPolicyDescriptionTypeDef#

# ScaleInPolicyDescriptionTypeDef definition

class ScaleInPolicyDescriptionTypeDef(TypedDict):
    cpuUtilizationPercentage: NotRequired[int],

ScaleOutPolicyDescriptionTypeDef#

# ScaleOutPolicyDescriptionTypeDef definition

class ScaleOutPolicyDescriptionTypeDef(TypedDict):
    cpuUtilizationPercentage: NotRequired[int],

ScaleInPolicyTypeDef#

# ScaleInPolicyTypeDef definition

class ScaleInPolicyTypeDef(TypedDict):
    cpuUtilizationPercentage: int,

ScaleOutPolicyTypeDef#

# ScaleOutPolicyTypeDef definition

class ScaleOutPolicyTypeDef(TypedDict):
    cpuUtilizationPercentage: int,

ScaleInPolicyUpdateTypeDef#

# ScaleInPolicyUpdateTypeDef definition

class ScaleInPolicyUpdateTypeDef(TypedDict):
    cpuUtilizationPercentage: int,

ScaleOutPolicyUpdateTypeDef#

# ScaleOutPolicyUpdateTypeDef definition

class ScaleOutPolicyUpdateTypeDef(TypedDict):
    cpuUtilizationPercentage: int,

ProvisionedCapacityDescriptionTypeDef#

# ProvisionedCapacityDescriptionTypeDef definition

class ProvisionedCapacityDescriptionTypeDef(TypedDict):
    mcuCount: NotRequired[int],
    workerCount: NotRequired[int],

ProvisionedCapacityTypeDef#

# ProvisionedCapacityTypeDef definition

class ProvisionedCapacityTypeDef(TypedDict):
    mcuCount: int,
    workerCount: int,

ProvisionedCapacityUpdateTypeDef#

# ProvisionedCapacityUpdateTypeDef definition

class ProvisionedCapacityUpdateTypeDef(TypedDict):
    mcuCount: int,
    workerCount: int,

CloudWatchLogsLogDeliveryDescriptionTypeDef#

# CloudWatchLogsLogDeliveryDescriptionTypeDef definition

class CloudWatchLogsLogDeliveryDescriptionTypeDef(TypedDict):
    enabled: NotRequired[bool],
    logGroup: NotRequired[str],

CloudWatchLogsLogDeliveryTypeDef#

# CloudWatchLogsLogDeliveryTypeDef definition

class CloudWatchLogsLogDeliveryTypeDef(TypedDict):
    enabled: bool,
    logGroup: NotRequired[str],

KafkaClusterClientAuthenticationDescriptionTypeDef#

# KafkaClusterClientAuthenticationDescriptionTypeDef definition

class KafkaClusterClientAuthenticationDescriptionTypeDef(TypedDict):
    authenticationType: NotRequired[KafkaClusterClientAuthenticationTypeType],  # (1)
  1. See KafkaClusterClientAuthenticationTypeType

KafkaClusterEncryptionInTransitDescriptionTypeDef#

# KafkaClusterEncryptionInTransitDescriptionTypeDef definition

class KafkaClusterEncryptionInTransitDescriptionTypeDef(TypedDict):
    encryptionType: NotRequired[KafkaClusterEncryptionInTransitTypeType],  # (1)
  1. See KafkaClusterEncryptionInTransitTypeType

WorkerConfigurationDescriptionTypeDef#

# WorkerConfigurationDescriptionTypeDef definition

class WorkerConfigurationDescriptionTypeDef(TypedDict):
    revision: NotRequired[int],
    workerConfigurationArn: NotRequired[str],

KafkaClusterClientAuthenticationTypeDef#

# KafkaClusterClientAuthenticationTypeDef definition

class KafkaClusterClientAuthenticationTypeDef(TypedDict):
    authenticationType: KafkaClusterClientAuthenticationTypeType,  # (1)
  1. See KafkaClusterClientAuthenticationTypeType

KafkaClusterEncryptionInTransitTypeDef#

# KafkaClusterEncryptionInTransitTypeDef definition

class KafkaClusterEncryptionInTransitTypeDef(TypedDict):
    encryptionType: KafkaClusterEncryptionInTransitTypeType,  # (1)
  1. See KafkaClusterEncryptionInTransitTypeType

WorkerConfigurationTypeDef#

# WorkerConfigurationTypeDef definition

class WorkerConfigurationTypeDef(TypedDict):
    revision: int,
    workerConfigurationArn: str,

ResponseMetadataTypeDef#

# ResponseMetadataTypeDef definition

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

CreateWorkerConfigurationRequestRequestTypeDef#

# CreateWorkerConfigurationRequestRequestTypeDef definition

class CreateWorkerConfigurationRequestRequestTypeDef(TypedDict):
    name: str,
    propertiesFileContent: str,
    description: NotRequired[str],
    tags: NotRequired[Mapping[str, str]],

WorkerConfigurationRevisionSummaryTypeDef#

# WorkerConfigurationRevisionSummaryTypeDef definition

class WorkerConfigurationRevisionSummaryTypeDef(TypedDict):
    creationTime: NotRequired[datetime],
    description: NotRequired[str],
    revision: NotRequired[int],

CustomPluginDescriptionTypeDef#

# CustomPluginDescriptionTypeDef definition

class CustomPluginDescriptionTypeDef(TypedDict):
    customPluginArn: NotRequired[str],
    revision: NotRequired[int],

CustomPluginFileDescriptionTypeDef#

# CustomPluginFileDescriptionTypeDef definition

class CustomPluginFileDescriptionTypeDef(TypedDict):
    fileMd5: NotRequired[str],
    fileSize: NotRequired[int],

S3LocationDescriptionTypeDef#

# S3LocationDescriptionTypeDef definition

class S3LocationDescriptionTypeDef(TypedDict):
    bucketArn: NotRequired[str],
    fileKey: NotRequired[str],
    objectVersion: NotRequired[str],

S3LocationTypeDef#

# S3LocationTypeDef definition

class S3LocationTypeDef(TypedDict):
    bucketArn: str,
    fileKey: str,
    objectVersion: NotRequired[str],

CustomPluginTypeDef#

# CustomPluginTypeDef definition

class CustomPluginTypeDef(TypedDict):
    customPluginArn: str,
    revision: int,

DeleteConnectorRequestRequestTypeDef#

# DeleteConnectorRequestRequestTypeDef definition

class DeleteConnectorRequestRequestTypeDef(TypedDict):
    connectorArn: str,
    currentVersion: NotRequired[str],

DeleteCustomPluginRequestRequestTypeDef#

# DeleteCustomPluginRequestRequestTypeDef definition

class DeleteCustomPluginRequestRequestTypeDef(TypedDict):
    customPluginArn: str,

DeleteWorkerConfigurationRequestRequestTypeDef#

# DeleteWorkerConfigurationRequestRequestTypeDef definition

class DeleteWorkerConfigurationRequestRequestTypeDef(TypedDict):
    workerConfigurationArn: str,

DescribeConnectorRequestRequestTypeDef#

# DescribeConnectorRequestRequestTypeDef definition

class DescribeConnectorRequestRequestTypeDef(TypedDict):
    connectorArn: str,

StateDescriptionTypeDef#

# StateDescriptionTypeDef definition

class StateDescriptionTypeDef(TypedDict):
    code: NotRequired[str],
    message: NotRequired[str],

DescribeCustomPluginRequestRequestTypeDef#

# DescribeCustomPluginRequestRequestTypeDef definition

class DescribeCustomPluginRequestRequestTypeDef(TypedDict):
    customPluginArn: str,

DescribeWorkerConfigurationRequestRequestTypeDef#

# DescribeWorkerConfigurationRequestRequestTypeDef definition

class DescribeWorkerConfigurationRequestRequestTypeDef(TypedDict):
    workerConfigurationArn: str,

WorkerConfigurationRevisionDescriptionTypeDef#

# WorkerConfigurationRevisionDescriptionTypeDef definition

class WorkerConfigurationRevisionDescriptionTypeDef(TypedDict):
    creationTime: NotRequired[datetime],
    description: NotRequired[str],
    propertiesFileContent: NotRequired[str],
    revision: NotRequired[int],

FirehoseLogDeliveryDescriptionTypeDef#

# FirehoseLogDeliveryDescriptionTypeDef definition

class FirehoseLogDeliveryDescriptionTypeDef(TypedDict):
    deliveryStream: NotRequired[str],
    enabled: NotRequired[bool],

FirehoseLogDeliveryTypeDef#

# FirehoseLogDeliveryTypeDef definition

class FirehoseLogDeliveryTypeDef(TypedDict):
    enabled: bool,
    deliveryStream: NotRequired[str],

PaginatorConfigTypeDef#

# PaginatorConfigTypeDef definition

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

ListConnectorsRequestRequestTypeDef#

# ListConnectorsRequestRequestTypeDef definition

class ListConnectorsRequestRequestTypeDef(TypedDict):
    connectorNamePrefix: NotRequired[str],
    maxResults: NotRequired[int],
    nextToken: NotRequired[str],

ListCustomPluginsRequestRequestTypeDef#

# ListCustomPluginsRequestRequestTypeDef definition

class ListCustomPluginsRequestRequestTypeDef(TypedDict):
    maxResults: NotRequired[int],
    namePrefix: NotRequired[str],
    nextToken: NotRequired[str],

ListTagsForResourceRequestRequestTypeDef#

# ListTagsForResourceRequestRequestTypeDef definition

class ListTagsForResourceRequestRequestTypeDef(TypedDict):
    resourceArn: str,

ListWorkerConfigurationsRequestRequestTypeDef#

# ListWorkerConfigurationsRequestRequestTypeDef definition

class ListWorkerConfigurationsRequestRequestTypeDef(TypedDict):
    maxResults: NotRequired[int],
    namePrefix: NotRequired[str],
    nextToken: NotRequired[str],

S3LogDeliveryDescriptionTypeDef#

# S3LogDeliveryDescriptionTypeDef definition

class S3LogDeliveryDescriptionTypeDef(TypedDict):
    bucket: NotRequired[str],
    enabled: NotRequired[bool],
    prefix: NotRequired[str],

S3LogDeliveryTypeDef#

# S3LogDeliveryTypeDef definition

class S3LogDeliveryTypeDef(TypedDict):
    enabled: bool,
    bucket: NotRequired[str],
    prefix: NotRequired[str],

TagResourceRequestRequestTypeDef#

# TagResourceRequestRequestTypeDef definition

class TagResourceRequestRequestTypeDef(TypedDict):
    resourceArn: str,
    tags: Mapping[str, str],

UntagResourceRequestRequestTypeDef#

# UntagResourceRequestRequestTypeDef definition

class UntagResourceRequestRequestTypeDef(TypedDict):
    resourceArn: str,
    tagKeys: Sequence[str],

ApacheKafkaClusterDescriptionTypeDef#

# ApacheKafkaClusterDescriptionTypeDef definition

class ApacheKafkaClusterDescriptionTypeDef(TypedDict):
    bootstrapServers: NotRequired[str],
    vpc: NotRequired[VpcDescriptionTypeDef],  # (1)
  1. See VpcDescriptionTypeDef

ApacheKafkaClusterTypeDef#

# ApacheKafkaClusterTypeDef definition

class ApacheKafkaClusterTypeDef(TypedDict):
    bootstrapServers: str,
    vpc: VpcTypeDef,  # (1)
  1. See VpcTypeDef

AutoScalingDescriptionTypeDef#

# AutoScalingDescriptionTypeDef definition

class AutoScalingDescriptionTypeDef(TypedDict):
    maxWorkerCount: NotRequired[int],
    mcuCount: NotRequired[int],
    minWorkerCount: NotRequired[int],
    scaleInPolicy: NotRequired[ScaleInPolicyDescriptionTypeDef],  # (1)
    scaleOutPolicy: NotRequired[ScaleOutPolicyDescriptionTypeDef],  # (2)
  1. See ScaleInPolicyDescriptionTypeDef
  2. See ScaleOutPolicyDescriptionTypeDef

AutoScalingTypeDef#

# AutoScalingTypeDef definition

class AutoScalingTypeDef(TypedDict):
    maxWorkerCount: int,
    mcuCount: int,
    minWorkerCount: int,
    scaleInPolicy: NotRequired[ScaleInPolicyTypeDef],  # (1)
    scaleOutPolicy: NotRequired[ScaleOutPolicyTypeDef],  # (2)
  1. See ScaleInPolicyTypeDef
  2. See ScaleOutPolicyTypeDef

AutoScalingUpdateTypeDef#

# AutoScalingUpdateTypeDef definition

class AutoScalingUpdateTypeDef(TypedDict):
    maxWorkerCount: int,
    mcuCount: int,
    minWorkerCount: int,
    scaleInPolicy: ScaleInPolicyUpdateTypeDef,  # (1)
    scaleOutPolicy: ScaleOutPolicyUpdateTypeDef,  # (2)
  1. See ScaleInPolicyUpdateTypeDef
  2. See ScaleOutPolicyUpdateTypeDef

CreateConnectorResponseTypeDef#

# CreateConnectorResponseTypeDef definition

class CreateConnectorResponseTypeDef(TypedDict):
    connectorArn: str,
    connectorName: str,
    connectorState: ConnectorStateType,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See ConnectorStateType
  2. See ResponseMetadataTypeDef

CreateCustomPluginResponseTypeDef#

# CreateCustomPluginResponseTypeDef definition

class CreateCustomPluginResponseTypeDef(TypedDict):
    customPluginArn: str,
    customPluginState: CustomPluginStateType,  # (1)
    name: str,
    revision: int,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See CustomPluginStateType
  2. See ResponseMetadataTypeDef

DeleteConnectorResponseTypeDef#

# DeleteConnectorResponseTypeDef definition

class DeleteConnectorResponseTypeDef(TypedDict):
    connectorArn: str,
    connectorState: ConnectorStateType,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See ConnectorStateType
  2. See ResponseMetadataTypeDef

DeleteCustomPluginResponseTypeDef#

# DeleteCustomPluginResponseTypeDef definition

class DeleteCustomPluginResponseTypeDef(TypedDict):
    customPluginArn: str,
    customPluginState: CustomPluginStateType,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See CustomPluginStateType
  2. See ResponseMetadataTypeDef

DeleteWorkerConfigurationResponseTypeDef#

# DeleteWorkerConfigurationResponseTypeDef definition

class DeleteWorkerConfigurationResponseTypeDef(TypedDict):
    workerConfigurationArn: str,
    workerConfigurationState: WorkerConfigurationStateType,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See WorkerConfigurationStateType
  2. See ResponseMetadataTypeDef

ListTagsForResourceResponseTypeDef#

# ListTagsForResourceResponseTypeDef definition

class ListTagsForResourceResponseTypeDef(TypedDict):
    tags: Dict[str, str],
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

UpdateConnectorResponseTypeDef#

# UpdateConnectorResponseTypeDef definition

class UpdateConnectorResponseTypeDef(TypedDict):
    connectorArn: str,
    connectorState: ConnectorStateType,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See ConnectorStateType
  2. See ResponseMetadataTypeDef

CreateWorkerConfigurationResponseTypeDef#

# CreateWorkerConfigurationResponseTypeDef definition

class CreateWorkerConfigurationResponseTypeDef(TypedDict):
    creationTime: datetime,
    latestRevision: WorkerConfigurationRevisionSummaryTypeDef,  # (1)
    name: str,
    workerConfigurationArn: str,
    workerConfigurationState: WorkerConfigurationStateType,  # (2)
    ResponseMetadata: ResponseMetadataTypeDef,  # (3)
  1. See WorkerConfigurationRevisionSummaryTypeDef
  2. See WorkerConfigurationStateType
  3. See ResponseMetadataTypeDef

WorkerConfigurationSummaryTypeDef#

# WorkerConfigurationSummaryTypeDef definition

class WorkerConfigurationSummaryTypeDef(TypedDict):
    creationTime: NotRequired[datetime],
    description: NotRequired[str],
    latestRevision: NotRequired[WorkerConfigurationRevisionSummaryTypeDef],  # (1)
    name: NotRequired[str],
    workerConfigurationArn: NotRequired[str],
    workerConfigurationState: NotRequired[WorkerConfigurationStateType],  # (2)
  1. See WorkerConfigurationRevisionSummaryTypeDef
  2. See WorkerConfigurationStateType

PluginDescriptionTypeDef#

# PluginDescriptionTypeDef definition

class PluginDescriptionTypeDef(TypedDict):
    customPlugin: NotRequired[CustomPluginDescriptionTypeDef],  # (1)
  1. See CustomPluginDescriptionTypeDef

CustomPluginLocationDescriptionTypeDef#

# CustomPluginLocationDescriptionTypeDef definition

class CustomPluginLocationDescriptionTypeDef(TypedDict):
    s3Location: NotRequired[S3LocationDescriptionTypeDef],  # (1)
  1. See S3LocationDescriptionTypeDef

CustomPluginLocationTypeDef#

# CustomPluginLocationTypeDef definition

class CustomPluginLocationTypeDef(TypedDict):
    s3Location: S3LocationTypeDef,  # (1)
  1. See S3LocationTypeDef

PluginTypeDef#

# PluginTypeDef definition

class PluginTypeDef(TypedDict):
    customPlugin: CustomPluginTypeDef,  # (1)
  1. See CustomPluginTypeDef

DescribeWorkerConfigurationResponseTypeDef#

# DescribeWorkerConfigurationResponseTypeDef definition

class DescribeWorkerConfigurationResponseTypeDef(TypedDict):
    creationTime: datetime,
    description: str,
    latestRevision: WorkerConfigurationRevisionDescriptionTypeDef,  # (1)
    name: str,
    workerConfigurationArn: str,
    workerConfigurationState: WorkerConfigurationStateType,  # (2)
    ResponseMetadata: ResponseMetadataTypeDef,  # (3)
  1. See WorkerConfigurationRevisionDescriptionTypeDef
  2. See WorkerConfigurationStateType
  3. See