KafkaConnectClient

Index > KafkaConnect > KafkaConnectClient

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

KafkaConnectClient

Type annotations and code completion for boto3.client("kafkaconnect"). boto3 documentation

# KafkaConnectClient usage example

from boto3.session import Session
from mypy_boto3_kafkaconnect.client import KafkaConnectClient

def get_kafkaconnect_client() -> KafkaConnectClient:
    return Session().client("kafkaconnect")

Exceptions

boto3 client exceptions are generated in runtime. This class provides code completion for boto3.client("kafkaconnect").exceptions structure.

# Exceptions.exceptions usage example

client = boto3.client("kafkaconnect")

try:
    do_something(client)
except (
    client.exceptions.BadRequestException,
    client.exceptions.ClientError,
    client.exceptions.ConflictException,
    client.exceptions.ForbiddenException,
    client.exceptions.InternalServerErrorException,
    client.exceptions.NotFoundException,
    client.exceptions.ServiceUnavailableException,
    client.exceptions.TooManyRequestsException,
    client.exceptions.UnauthorizedException,
) as e:
    print(e)

# Exceptions.exceptions type checking example

from mypy_boto3_kafkaconnect.client import Exceptions

def handle_error(exc: Exceptions.BadRequestException) -> None:
    ...

Methods

can_paginate

Check if an operation can be paginated.

Type annotations and code completion for boto3.client("kafkaconnect").can_paginate method. boto3 documentation

# can_paginate method definition

def can_paginate(
    self,
    operation_name: str,
) -> bool:
    ...

close

Closes underlying endpoint connections.

Type annotations and code completion for boto3.client("kafkaconnect").close method. boto3 documentation

# close method definition

def close(
    self,
) -> None:
    ...

create_connector

Creates a connector using the specified properties.

Type annotations and code completion for boto3.client("kafkaconnect").create_connector method. boto3 documentation

# create_connector method definition

def create_connector(
    self,
    *,
    capacity: CapacityTypeDef,  # (1)
    connectorConfiguration: Mapping[str, str],
    connectorName: str,
    kafkaCluster: KafkaClusterTypeDef,  # (2)
    kafkaClusterClientAuthentication: KafkaClusterClientAuthenticationTypeDef,  # (3)
    kafkaClusterEncryptionInTransit: KafkaClusterEncryptionInTransitTypeDef,  # (4)
    kafkaConnectVersion: str,
    plugins: Sequence[PluginTypeDef],  # (5)
    serviceExecutionRoleArn: str,
    connectorDescription: str = ...,
    logDelivery: LogDeliveryTypeDef = ...,  # (6)
    tags: Mapping[str, str] = ...,
    workerConfiguration: WorkerConfigurationTypeDef = ...,  # (7)
) -> CreateConnectorResponseTypeDef:  # (8)
    ...

1. See CapacityTypeDef
2. See KafkaClusterTypeDef
3. See KafkaClusterClientAuthenticationTypeDef
4. See KafkaClusterEncryptionInTransitTypeDef
5. See PluginTypeDef
6. See LogDeliveryTypeDef
7. See WorkerConfigurationTypeDef
8. See CreateConnectorResponseTypeDef

# create_connector method usage example with argument unpacking

kwargs: CreateConnectorRequestRequestTypeDef = {  # (1)
    "capacity": ...,
    "connectorConfiguration": ...,
    "connectorName": ...,
    "kafkaCluster": ...,
    "kafkaClusterClientAuthentication": ...,
    "kafkaClusterEncryptionInTransit": ...,
    "kafkaConnectVersion": ...,
    "plugins": ...,
    "serviceExecutionRoleArn": ...,
}

parent.create_connector(**kwargs)

1. See CreateConnectorRequestRequestTypeDef

create_custom_plugin

Creates a custom plugin using the specified properties.

Type annotations and code completion for boto3.client("kafkaconnect").create_custom_plugin method. boto3 documentation

# create_custom_plugin method definition

def create_custom_plugin(
    self,
    *,
    contentType: CustomPluginContentTypeType,  # (1)
    location: CustomPluginLocationTypeDef,  # (2)
    name: str,
    description: str = ...,
    tags: Mapping[str, str] = ...,
) -> CreateCustomPluginResponseTypeDef:  # (3)
    ...

1. See CustomPluginContentTypeType
2. See CustomPluginLocationTypeDef
3. See CreateCustomPluginResponseTypeDef

# create_custom_plugin method usage example with argument unpacking

kwargs: CreateCustomPluginRequestRequestTypeDef = {  # (1)
    "contentType": ...,
    "location": ...,
    "name": ...,
}

parent.create_custom_plugin(**kwargs)

1. See CreateCustomPluginRequestRequestTypeDef

create_worker_configuration

Creates a worker configuration using the specified properties.

Type annotations and code completion for boto3.client("kafkaconnect").create_worker_configuration method. boto3 documentation

# create_worker_configuration method definition

def create_worker_configuration(
    self,
    *,
    name: str,
    propertiesFileContent: str,
    description: str = ...,
    tags: Mapping[str, str] = ...,
) -> CreateWorkerConfigurationResponseTypeDef:  # (1)
    ...

1. See CreateWorkerConfigurationResponseTypeDef

# create_worker_configuration method usage example with argument unpacking

kwargs: CreateWorkerConfigurationRequestRequestTypeDef = {  # (1)
    "name": ...,
    "propertiesFileContent": ...,
}

parent.create_worker_configuration(**kwargs)

1. See CreateWorkerConfigurationRequestRequestTypeDef

delete_connector

Deletes the specified connector.

Type annotations and code completion for boto3.client("kafkaconnect").delete_connector method. boto3 documentation

# delete_connector method definition

def delete_connector(
    self,
    *,
    connectorArn: str,
    currentVersion: str = ...,
) -> DeleteConnectorResponseTypeDef:  # (1)
    ...

1. See DeleteConnectorResponseTypeDef

# delete_connector method usage example with argument unpacking

kwargs: DeleteConnectorRequestRequestTypeDef = {  # (1)
    "connectorArn": ...,
}

parent.delete_connector(**kwargs)

1. See DeleteConnectorRequestRequestTypeDef

delete_custom_plugin

Deletes a custom plugin.

Type annotations and code completion for boto3.client("kafkaconnect").delete_custom_plugin method. boto3 documentation

# delete_custom_plugin method definition

def delete_custom_plugin(
    self,
    *,
    customPluginArn: str,
) -> DeleteCustomPluginResponseTypeDef:  # (1)
    ...

1. See DeleteCustomPluginResponseTypeDef

# delete_custom_plugin method usage example with argument unpacking

kwargs: DeleteCustomPluginRequestRequestTypeDef = {  # (1)
    "customPluginArn": ...,
}

parent.delete_custom_plugin(**kwargs)

1. See DeleteCustomPluginRequestRequestTypeDef

delete_worker_configuration

Deletes the specified worker configuration.

Type annotations and code completion for boto3.client("kafkaconnect").delete_worker_configuration method. boto3 documentation

# delete_worker_configuration method definition

def delete_worker_configuration(
    self,
    *,
    workerConfigurationArn: str,
) -> DeleteWorkerConfigurationResponse