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

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.

Usage example

client = boto3.client("kafkaconnect")

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

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

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

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

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)
    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

Usage example with kwargs

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

Method definition

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

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

Usage example with kwargs

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

Method definition

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

1. See CreateWorkerConfigurationResponseTypeDef

Usage example with kwargs

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

Method definition

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

1. See DeleteConnectorResponseTypeDef

Usage example with kwargs

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

Method definition

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

1. See DeleteCustomPluginResponseTypeDef

Usage example with kwargs

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

parent.delete_custom_plugin(**kwargs)

1. See DeleteCustomPluginRequestRequestTypeDef

describe_connector

Returns summary information about the connector.

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

Method definition

def describe_connector(
    self,
    *,
    connectorArn: str,
) -> DescribeConnectorResponseTypeDef:  # (1)
    ...

1. See DescribeConnectorResponseTypeDef

Usage example with kwargs

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

Method definition

def describe_custom_plugin(
    self,
    *,
    customPluginArn: str,
) -> DescribeCustomPluginResponseTypeDef:  # (1)
    ...

1. See DescribeCustomPluginResponseTypeDef

Usage example with kwargs

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

Method definition

def describe_worker_configuration(
    self,
    *,
    workerConfigurationArn: str,
) -> DescribeWorkerConfigurationResponseTypeDef:  # (1)
    ...

1. See DescribeWorkerConfigurationResponseTypeDef

Usage example with kwargs

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

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

Method definition

def list_connectors(
    self,
    *,
    connectorNamePrefix: str = ...,
    maxResults: int = ...,
    nextToken: str = ...,
) -> ListConnectorsResponseTypeDef:  # (1)
    ...

1. See ListConnectorsResponseTypeDef

Usage example with kwargs

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

Method definition

def list_custom_plugins(
    self,
    *,
    maxResults: int = ...,
    nextToken: str = ...,
) -> ListCustomPluginsResponseTypeDef:  # (1)
    ...

1. See ListCustomPluginsResponseTypeDef

Usage example with kwargs

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

parent.list_custom_plugins(**kwargs)

1. See ListCustomPluginsRequestRequestTypeDef

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

Method definition

def list_worker_configurations(
    self,
    *,
    maxResults: int = ...,
    nextToken: str = ...,
) -> ListWorkerConfigurationsResponseTypeDef:  # (1)
    ...

1. See ListWorkerConfigurationsResponseTypeDef

Usage example with kwargs

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

parent.list_worker_configurations(**kwargs)

1. See ListWorkerConfigurationsRequestRequestTypeDef

update_connector

Updates the specified connector.

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

Method definition

def update_connector(
    self,
    *,
    capacity: CapacityUpdateTypeDef,  # (1)
    connectorArn: str,
    currentVersion: str,
) -> UpdateConnectorResponseTypeDef:  # (2)
    ...

1. See CapacityUpdateTypeDef
2. See UpdateConnectorResponseTypeDef

Usage example with kwargs

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.

• client.get_paginator("list_connectors") -> ListConnectorsPaginator
• client.get_paginator("list_custom_plugins") -> ListCustomPluginsPaginator
• client.get_paginator("list_worker_configurations") -> ListWorkerConfigurationsPaginator