Skip to content

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,
) -> DeleteWorkerConfigurationResponseTypeDef:  # (1)
    ...
  1. See DeleteWorkerConfigurationResponseTypeDef 
# delete_worker_configuration method usage example with argument unpacking

kwargs: DeleteWorkerConfigurationRequestRequestTypeDef = {  # (1)
    "workerConfigurationArn": ...,
}

parent.delete_worker_configuration(**kwargs)
  1. See DeleteWorkerConfigurationRequestRequestTypeDef

describe_connector#

Returns summary information about the connector.

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

# describe_connector method definition

def describe_connector(
    self,
    *,
    connectorArn: str,
) -> DescribeConnectorResponseTypeDef:  # (1)
    ...
  1. See DescribeConnectorResponseTypeDef 
# describe_connector method usage example with argument unpacking

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

parent.describe_connector(**kwargs)
  1. See DescribeConnectorRequestRequestTypeDef

describe_custom_plugin#

A summary description of the custom plugin.

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

# describe_custom_plugin method definition

def describe_custom_plugin(
    self,
    *,
    customPluginArn: str,
) -> DescribeCustomPluginResponseTypeDef:  # (1)
    ...
  1. See DescribeCustomPluginResponseTypeDef 
# describe_custom_plugin method usage example with argument unpacking

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

parent.describe_custom_plugin(**kwargs)
  1. See DescribeCustomPluginRequestRequestTypeDef

describe_worker_configuration#

Returns information about a worker configuration.

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

# describe_worker_configuration method definition

def describe_worker_configuration(
    self,
    *,
    workerConfigurationArn: str,
) -> DescribeWorkerConfigurationResponseTypeDef:  # (1)
    ...
  1. See DescribeWorkerConfigurationResponseTypeDef 
# describe_worker_configuration method usage example with argument unpacking

kwargs: DescribeWorkerConfigurationRequestRequestTypeDef = {  # (1)
    "workerConfigurationArn": ...,
}

parent.describe_worker_configuration(**kwargs)
  1. See DescribeWorkerConfigurationRequestRequestTypeDef

generate_presigned_url#

Generate a presigned url given a client, its method, and arguments.

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

# generate_presigned_url method definition

def generate_presigned_url(
    self,
    ClientMethod: str,
    Params: Mapping[str, Any] = ...,
    ExpiresIn: int = 3600,
    HttpMethod: str = ...,
) -> str:
    ...

list_connectors#

Returns a list of all the connectors in this account and Region.

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

# list_connectors method definition

def list_connectors(
    self,
    *,
    connectorNamePrefix: str = ...,
    maxResults: int = ...,
    nextToken: str = ...,
) -> ListConnectorsResponseTypeDef:  # (1)
    ...
  1. See ListConnectorsResponseTypeDef 
# list_connectors method usage example with argument unpacking

kwargs: ListConnectorsRequestRequestTypeDef = {  # (1)
    "connectorNamePrefix": ...,
}

parent.list_connectors(**kwargs)
  1. See ListConnectorsRequestRequestTypeDef

list_custom_plugins#

Returns a list of all of the custom plugins in this account and Region.

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

# list_custom_plugins method definition

def list_custom_plugins(
    self,
    *,
    maxResults: int = ...,
    namePrefix: str = ...,
    nextToken: str = ...,
) -> ListCustomPluginsResponseTypeDef:  # (1)
    ...
  1. See ListCustomPluginsResponseTypeDef 
# list_custom_plugins method usage example with argument unpacking

kwargs: ListCustomPluginsRequestRequestTypeDef = {  # (1)
    "maxResults": ...,
}

parent.list_custom_plugins(**kwargs)
  1. See ListCustomPluginsRequestRequestTypeDef

list_tags_for_resource#

Lists all the tags attached to the specified resource.

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

# list_tags_for_resource method definition

def list_tags_for_resource(
    self,
    *,
    resourceArn: str,
) -> ListTagsForResourceResponseTypeDef:  # (1)
    ...
  1. See ListTagsForResourceResponseTypeDef 
# list_tags_for_resource method usage example with argument unpacking

kwargs: ListTagsForResourceRequestRequestTypeDef = {  # (1)
    "resourceArn": ...,
}

parent.list_tags_for_resource(**kwargs)
  1. See ListTagsForResourceRequestRequestTypeDef

list_worker_configurations#

Returns a list of all of the worker configurations in this account and Region.

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

# list_worker_configurations method definition

def list_worker_configurations(
    self,
    *,
    maxResults: int = ...,
    namePrefix: str = ...,
    nextToken: str = ...,
) -> ListWorkerConfigurationsResponseTypeDef:  # (1)
    ...
  1. See ListWorkerConfigurationsResponseTypeDef 
# list_worker_configurations method usage example with argument unpacking

kwargs: ListWorkerConfigurationsRequestRequestTypeDef = {  # (1)
    "maxResults": ...,
}

parent.list_worker_configurations(**kwargs)
  1. See ListWorkerConfigurationsRequestRequestTypeDef

tag_resource#

Attaches tags to the specified resource.

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

# tag_resource method definition

def tag_resource(
    self,
    *,
    resourceArn: str,
    tags: Mapping[str, str],
) -> Dict[str, Any]:
    ...
# tag_resource method usage example with argument unpacking

kwargs: TagResourceRequestRequestTypeDef = {  # (1)
    "resourceArn": ...,
    "tags": ...,
}

parent.tag_resource(**kwargs)
  1. See TagResourceRequestRequestTypeDef

untag_resource#

Removes tags from the specified resource.

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

# untag_resource method definition

def untag_resource(
    self,
    *,
    resourceArn: str,
    tagKeys: Sequence[str],
) -> Dict[str, Any]:
    ...
# untag_resource method usage example with argument unpacking

kwargs: UntagResourceRequestRequestTypeDef = {  # (1)
    "resourceArn": ...,
    "tagKeys": ...,
}

parent.untag_resource(**kwargs)
  1. See UntagResourceRequestRequestTypeDef

update_connector#

Updates the specified connector.

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

# update_connector method definition

def update_connector(
    self,
    *,
    capacity: CapacityUpdateTypeDef,  # (1)
    connectorArn: str,
    currentVersion: str,
) -> UpdateConnectorResponseTypeDef:  # (2)
    ...
  1. See CapacityUpdateTypeDef
  2. See UpdateConnectorResponseTypeDef 
# update_connector method usage example with argument unpacking

kwargs: UpdateConnectorRequestRequestTypeDef = {  # (1)
    "capacity": ...,
    "connectorArn": ...,
    "currentVersion": ...,
}

parent.update_connector(**kwargs)
  1. See UpdateConnectorRequestRequestTypeDef

get_paginator#

Type annotations and code completion for boto3.client("kafkaconnect").get_paginator method with overloads.