KafkaConnectClient#
Index > KafkaConnect > KafkaConnectClient
Auto-generated documentation for KafkaConnect type annotations stubs module types-aiobotocore-kafkaconnect.
KafkaConnectClient#
Type annotations and code completion for session.create_client("kafkaconnect")
boto3 documentation
KafkaConnectClient usage example
from aiobotocore.session import get_session
from types_aiobotocore_kafkaconnect.client import KafkaConnectClient
session = get_session()
async with session.create_client("kafkaconnect") as client:
client: KafkaConnectClient
Exceptions#
aiobotocore
client exceptions are generated in runtime.
This class provides code completion for session.create_client("kafkaconnect").exceptions
structure.
KafkaConnectClient.exceptions usage example
async with session.create_client("kafkaconnect") as client:
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)
KafkaConnectClient usage type checking example
from types_aiobotocore_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 session.create_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 session.create_client("kafkaconnect").close
method.
boto3 documentation
# close method definition
await def close(
self,
) -> None:
...
create_connector#
Creates a connector using the specified properties.
Type annotations and code completion for session.create_client("kafkaconnect").create_connector
method.
boto3 documentation
# create_connector method definition
await 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)
...
- See CapacityTypeDef
- See KafkaClusterTypeDef
- See KafkaClusterClientAuthenticationTypeDef
- See KafkaClusterEncryptionInTransitTypeDef
- See PluginTypeDef
- See LogDeliveryTypeDef
- See WorkerConfigurationTypeDef
- 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)
create_custom_plugin#
Creates a custom plugin using the specified properties.
Type annotations and code completion for session.create_client("kafkaconnect").create_custom_plugin
method.
boto3 documentation
# create_custom_plugin method definition
await def create_custom_plugin(
self,
*,
contentType: CustomPluginContentTypeType, # (1)
location: CustomPluginLocationTypeDef, # (2)
name: str,
description: str = ...,
) -> CreateCustomPluginResponseTypeDef: # (3)
...
- See CustomPluginContentTypeType
- See CustomPluginLocationTypeDef
- See CreateCustomPluginResponseTypeDef
# create_custom_plugin method usage example with argument unpacking
kwargs: CreateCustomPluginRequestRequestTypeDef = { # (1)
"contentType": ...,
"location": ...,
"name": ...,
}
parent.create_custom_plugin(**kwargs)
create_worker_configuration#
Creates a worker configuration using the specified properties.
Type annotations and code completion for session.create_client("kafkaconnect").create_worker_configuration
method.
boto3 documentation
# create_worker_configuration method definition
await def create_worker_configuration(
self,
*,
name: str,
propertiesFileContent: str,
description: str = ...,
) -> CreateWorkerConfigurationResponseTypeDef: # (1)
...
# create_worker_configuration method usage example with argument unpacking
kwargs: CreateWorkerConfigurationRequestRequestTypeDef = { # (1)
"name": ...,
"propertiesFileContent": ...,
}
parent.create_worker_configuration(**kwargs)
delete_connector#
Deletes the specified connector.
Type annotations and code completion for session.create_client("kafkaconnect").delete_connector
method.
boto3 documentation
# delete_connector method definition
await def delete_connector(
self,
*,
connectorArn: str,
currentVersion: str = ...,
) -> DeleteConnectorResponseTypeDef: # (1)
...
# delete_connector method usage example with argument unpacking
kwargs: DeleteConnectorRequestRequestTypeDef = { # (1)
"connectorArn": ...,
}
parent.delete_connector(**kwargs)
delete_custom_plugin#
Deletes a custom plugin.
Type annotations and code completion for session.create_client("kafkaconnect").delete_custom_plugin
method.
boto3 documentation
# delete_custom_plugin method definition
await def delete_custom_plugin(
self,
*,
customPluginArn: str,
) -> DeleteCustomPluginResponseTypeDef: # (1)
...
# delete_custom_plugin method usage example with argument unpacking
kwargs: DeleteCustomPluginRequestRequestTypeDef = { # (1)
"customPluginArn": ...,
}
parent.delete_custom_plugin(**kwargs)
describe_connector#
Returns summary information about the connector.
Type annotations and code completion for session.create_client("kafkaconnect").describe_connector
method.
boto3 documentation
# describe_connector method definition
await def describe_connector(
self,
*,
connectorArn: str,
) -> DescribeConnectorResponseTypeDef: # (1)
...
# describe_connector method usage example with argument unpacking
kwargs: DescribeConnectorRequestRequestTypeDef = { # (1)
"connectorArn": ...,
}
parent.describe_connector(**kwargs)
describe_custom_plugin#
A summary description of the custom plugin.
Type annotations and code completion for session.create_client("kafkaconnect").describe_custom_plugin
method.
boto3 documentation
# describe_custom_plugin method definition
await def describe_custom_plugin(
self,
*,
customPluginArn: str,
) -> DescribeCustomPluginResponseTypeDef: # (1)
...
# describe_custom_plugin method usage example with argument unpacking
kwargs: DescribeCustomPluginRequestRequestTypeDef = { # (1)
"customPluginArn": ...,
}
parent.describe_custom_plugin(**kwargs)
describe_worker_configuration#
Returns information about a worker configuration.
Type annotations and code completion for session.create_client("kafkaconnect").describe_worker_configuration
method.
boto3 documentation
# describe_worker_configuration method definition
await def describe_worker_configuration(
self,
*,
workerConfigurationArn: str,
) -> DescribeWorkerConfigurationResponseTypeDef: # (1)
...
# describe_worker_configuration method usage example with argument unpacking
kwargs: DescribeWorkerConfigurationRequestRequestTypeDef = { # (1)
"workerConfigurationArn": ...,
}
parent.describe_worker_configuration(**kwargs)
generate_presigned_url#
Generate a presigned url given a client, its method, and arguments.
Type annotations and code completion for session.create_client("kafkaconnect").generate_presigned_url
method.
boto3 documentation
# generate_presigned_url method definition
await 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 session.create_client("kafkaconnect").list_connectors
method.
boto3 documentation
# list_connectors method definition
await def list_connectors(
self,
*,
connectorNamePrefix: str = ...,
maxResults: int = ...,
nextToken: str = ...,
) -> ListConnectorsResponseTypeDef: # (1)
...
# list_connectors method usage example with argument unpacking
kwargs: ListConnectorsRequestRequestTypeDef = { # (1)
"connectorNamePrefix": ...,
}
parent.list_connectors(**kwargs)
list_custom_plugins#
Returns a list of all of the custom plugins in this account and Region.
Type annotations and code completion for session.create_client("kafkaconnect").list_custom_plugins
method.
boto3 documentation
# list_custom_plugins method definition
await def list_custom_plugins(
self,
*,
maxResults: int = ...,
nextToken: str = ...,
) -> ListCustomPluginsResponseTypeDef: # (1)
...
# list_custom_plugins method usage example with argument unpacking
kwargs: ListCustomPluginsRequestRequestTypeDef = { # (1)
"maxResults": ...,
}
parent.list_custom_plugins(**kwargs)
list_worker_configurations#
Returns a list of all of the worker configurations in this account and Region.
Type annotations and code completion for session.create_client("kafkaconnect").list_worker_configurations
method.
boto3 documentation
# list_worker_configurations method definition
await def list_worker_configurations(
self,
*,
maxResults: int = ...,
nextToken: str = ...,
) -> ListWorkerConfigurationsResponseTypeDef: # (1)
...
# list_worker_configurations method usage example with argument unpacking
kwargs: ListWorkerConfigurationsRequestRequestTypeDef = { # (1)
"maxResults": ...,
}
parent.list_worker_configurations(**kwargs)
update_connector#
Updates the specified connector.
Type annotations and code completion for session.create_client("kafkaconnect").update_connector
method.
boto3 documentation
# update_connector method definition
await def update_connector(
self,
*,
capacity: CapacityUpdateTypeDef, # (1)
connectorArn: str,
currentVersion: str,
) -> UpdateConnectorResponseTypeDef: # (2)
...
# update_connector method usage example with argument unpacking
kwargs: UpdateConnectorRequestRequestTypeDef = { # (1)
"capacity": ...,
"connectorArn": ...,
"currentVersion": ...,
}
parent.update_connector(**kwargs)
__aenter__#
Type annotations and code completion for session.create_client("kafkaconnect").__aenter__
method.
boto3 documentation
# __aenter__ method definition
await def __aenter__(
self,
) -> KafkaConnectClient:
...
__aexit__#
Type annotations and code completion for session.create_client("kafkaconnect").__aexit__
method.
boto3 documentation
# __aexit__ method definition
await def __aexit__(
self,
exc_type: Any,
exc_val: Any,
exc_tb: Any,
) -> Any:
...
get_paginator#
Type annotations and code completion for session.create_client("kafkaconnect").get_paginator
method with overloads.
client.get_paginator("list_connectors")
-> ListConnectorsPaginatorclient.get_paginator("list_custom_plugins")
-> ListCustomPluginsPaginatorclient.get_paginator("list_worker_configurations")
-> ListWorkerConfigurationsPaginator