Table of Contents
KafkaConnect.Client¶A low-level client representing Managed Streaming for Kafka Connect
import boto3
client = boto3.client('kafkaconnect')
These are the available methods:
can_paginate()close()create_connector()create_custom_plugin()create_worker_configuration()delete_connector()delete_custom_plugin()describe_connector()describe_custom_plugin()describe_worker_configuration()get_paginator()get_waiter()list_connectors()list_custom_plugins()list_worker_configurations()update_connector()can_paginate(operation_name)¶Check if an operation can be paginated.
create_foo, and you'd normally invoke the
operation as client.create_foo(**kwargs), if the
create_foo operation can be paginated, you can use the
call client.get_paginator("create_foo").True if the operation can be paginated,
False otherwise.close()¶Closes underlying endpoint connections.
create_connector(**kwargs)¶Creates a connector using the specified properties.
See also: AWS API Documentation
Request Syntax
response = client.create_connector(
capacity={
'autoScaling': {
'maxWorkerCount': 123,
'mcuCount': 123,
'minWorkerCount': 123,
'scaleInPolicy': {
'cpuUtilizationPercentage': 123
},
'scaleOutPolicy': {
'cpuUtilizationPercentage': 123
}
},
'provisionedCapacity': {
'mcuCount': 123,
'workerCount': 123
}
},
connectorConfiguration={
'string': 'string'
},
connectorDescription='string',
connectorName='string',
kafkaCluster={
'apacheKafkaCluster': {
'bootstrapServers': 'string',
'vpc': {
'securityGroups': [
'string',
],
'subnets': [
'string',
]
}
}
},
kafkaClusterClientAuthentication={
'authenticationType': 'NONE'|'IAM'
},
kafkaClusterEncryptionInTransit={
'encryptionType': 'PLAINTEXT'|'TLS'
},
kafkaConnectVersion='string',
logDelivery={
'workerLogDelivery': {
'cloudWatchLogs': {
'enabled': True|False,
'logGroup': 'string'
},
'firehose': {
'deliveryStream': 'string',
'enabled': True|False
},
's3': {
'bucket': 'string',
'enabled': True|False,
'prefix': 'string'
}
}
},
plugins=[
{
'customPlugin': {
'customPluginArn': 'string',
'revision': 123
}
},
],
serviceExecutionRoleArn='string',
workerConfiguration={
'revision': 123,
'workerConfigurationArn': 'string'
}
)
[REQUIRED]
Information about the capacity allocated to the connector. Exactly one of the two properties must be specified.
Information about the auto scaling parameters for the connector.
The maximum number of workers allocated to the connector.
The number of microcontroller units (MCUs) allocated to each connector worker. The valid values are 1,2,4,8.
The minimum number of workers allocated to the connector.
The sacle-in policy for the connector.
Specifies the CPU utilization percentage threshold at which you want connector scale in to be triggered.
The sacle-out policy for the connector.
The CPU utilization percentage threshold at which you want connector scale out to be triggered.
Details about a fixed capacity allocated to a connector.
The number of microcontroller units (MCUs) allocated to each connector worker. The valid values are 1,2,4,8.
The number of workers that are allocated to the connector.
[REQUIRED]
A map of keys to values that represent the configuration for the connector.
[REQUIRED]
The name of the connector.
[REQUIRED]
Specifies which Apache Kafka cluster to connect to.
The Apache Kafka cluster to which the connector is connected.
The bootstrap servers of the cluster.
Details of an Amazon VPC which has network connectivity to the Apache Kafka cluster.
The security groups for the connector.
The subnets for the connector.
[REQUIRED]
Details of the client authentication used by the Apache Kafka cluster.
The type of client authentication used to connect to the Apache Kafka cluster. Value NONE means that no client authentication is used.
[REQUIRED]
Details of encryption in transit to the Apache Kafka cluster.
The type of encryption in transit to the Apache Kafka cluster.
[REQUIRED]
The version of Kafka Connect. It has to be compatible with both the Apache Kafka cluster's version and the plugins.
Details about log delivery.
The workers can send worker logs to different destination types. This configuration specifies the details of these destinations.
Details about delivering logs to Amazon CloudWatch Logs.
Whether log delivery to Amazon CloudWatch Logs is enabled.
The name of the CloudWatch log group that is the destination for log delivery.
Details about delivering logs to Amazon Kinesis Data Firehose.
The name of the Kinesis Data Firehose delivery stream that is the destination for log delivery.
Specifies whether connector logs get delivered to Amazon Kinesis Data Firehose.
Details about delivering logs to Amazon S3.
The name of the S3 bucket that is the destination for log delivery.
Specifies whether connector logs get sent to the specified Amazon S3 destination.
The S3 prefix that is the destination for log delivery.
[REQUIRED]
Specifies which plugins to use for the connector.
A plugin is an AWS resource that contains the code that defines your connector logic.
Details about a custom plugin.
The Amazon Resource Name (ARN) of the custom plugin.
The revision of the custom plugin.
[REQUIRED]
The Amazon Resource Name (ARN) of the IAM role used by the connector to access the Amazon Web Services resources that it needs. The types of resources depends on the logic of the connector. For example, a connector that has Amazon S3 as a destination must have permissions that allow it to write to the S3 destination bucket.
Specifies which worker configuration to use with the connector.
The revision of the worker configuration.
The Amazon Resource Name (ARN) of the worker configuration.
dict
Response Syntax
{
'connectorArn': 'string',
'connectorName': 'string',
'connectorState': 'RUNNING'|'CREATING'|'UPDATING'|'DELETING'|'FAILED'
}
Response Structure
(dict) --
connectorArn (string) --
The Amazon Resource Name (ARN) that Amazon assigned to the connector.
connectorName (string) --
The name of the connector.
connectorState (string) --
The state of the connector.
Exceptions
KafkaConnect.Client.exceptions.NotFoundExceptionKafkaConnect.Client.exceptions.ConflictExceptionKafkaConnect.Client.exceptions.BadRequestExceptionKafkaConnect.Client.exceptions.ForbiddenExceptionKafkaConnect.Client.exceptions.ServiceUnavailableExceptionKafkaConnect.Client.exceptions.TooManyRequestsExceptionKafkaConnect.Client.exceptions.UnauthorizedExceptionKafkaConnect.Client.exceptions.InternalServerErrorExceptioncreate_custom_plugin(**kwargs)¶Creates a custom plugin using the specified properties.
See also: AWS API Documentation
Request Syntax
response = client.create_custom_plugin(
contentType='JAR'|'ZIP',
description='string',
location={
's3Location': {
'bucketArn': 'string',
'fileKey': 'string',
'objectVersion': 'string'
}
},
name='string'
)
[REQUIRED]
The type of the plugin file.
[REQUIRED]
Information about the location of a custom plugin.
The S3 bucket Amazon Resource Name (ARN), file key, and object version of the plugin file stored in Amazon S3.
The Amazon Resource Name (ARN) of an S3 bucket.
The file key for an object in an S3 bucket.
The version of an object in an S3 bucket.
[REQUIRED]
The name of the custom plugin.
dict
Response Syntax
{
'customPluginArn': 'string',
'customPluginState': 'CREATING'|'CREATE_FAILED'|'ACTIVE'|'UPDATING'|'UPDATE_FAILED'|'DELETING',
'name': 'string',
'revision': 123
}
Response Structure
(dict) --
customPluginArn (string) --
The Amazon Resource Name (ARN) that Amazon assigned to the custom plugin.
customPluginState (string) --
The state of the custom plugin.
name (string) --
The name of the custom plugin.
revision (integer) --
The revision of the custom plugin.
Exceptions
KafkaConnect.Client.exceptions.NotFoundExceptionKafkaConnect.Client.exceptions.ConflictExceptionKafkaConnect.Client.exceptions.BadRequestExceptionKafkaConnect.Client.exceptions.ForbiddenExceptionKafkaConnect.Client.exceptions.ServiceUnavailableExceptionKafkaConnect.Client.exceptions.TooManyRequestsExceptionKafkaConnect.Client.exceptions.UnauthorizedExceptionKafkaConnect.Client.exceptions.InternalServerErrorExceptioncreate_worker_configuration(**kwargs)¶Creates a worker configuration using the specified properties.
See also: AWS API Documentation
Request Syntax
response = client.create_worker_configuration(
description='string',
name='string',
propertiesFileContent='string'
)
[REQUIRED]
The name of the worker configuration.
[REQUIRED]
Base64 encoded contents of connect-distributed.properties file.
dict
Response Syntax
{
'creationTime': datetime(2015, 1, 1),
'latestRevision': {
'creationTime': datetime(2015, 1, 1),
'description': 'string',
'revision': 123
},
'name': 'string',
'workerConfigurationArn': 'string'
}
Response Structure
(dict) --
creationTime (datetime) --
The time that the worker configuration was created.
latestRevision (dict) --
The latest revision of the worker configuration.
creationTime (datetime) --
The time that a worker configuration revision was created.
description (string) --
The description of a worker configuration revision.
revision (integer) --
The revision of a worker configuration.
name (string) --
The name of the worker configuration.
workerConfigurationArn (string) --
The Amazon Resource Name (ARN) that Amazon assigned to the worker configuration.
Exceptions
KafkaConnect.Client.exceptions.NotFoundExceptionKafkaConnect.Client.exceptions.ConflictExceptionKafkaConnect.Client.exceptions.BadRequestExceptionKafkaConnect.Client.exceptions.ForbiddenExceptionKafkaConnect.Client.exceptions.ServiceUnavailableExceptionKafkaConnect.Client.exceptions.TooManyRequestsExceptionKafkaConnect.Client.exceptions.UnauthorizedExceptionKafkaConnect.Client.exceptions.InternalServerErrorExceptiondelete_connector(**kwargs)¶Deletes the specified connector.
See also: AWS API Documentation
Request Syntax
response = client.delete_connector(
connectorArn='string',
currentVersion='string'
)
[REQUIRED]
The Amazon Resource Name (ARN) of the connector that you want to delete.
dict
Response Syntax
{
'connectorArn': 'string',
'connectorState': 'RUNNING'|'CREATING'|'UPDATING'|'DELETING'|'FAILED'
}
Response Structure
(dict) --
connectorArn (string) --
The Amazon Resource Name (ARN) of the connector that you requested to delete.
connectorState (string) --
The state of the connector that you requested to delete.
Exceptions
KafkaConnect.Client.exceptions.NotFoundExceptionKafkaConnect.Client.exceptions.BadRequestExceptionKafkaConnect.Client.exceptions.ForbiddenExceptionKafkaConnect.Client.exceptions.ServiceUnavailableExceptionKafkaConnect.Client.exceptions.TooManyRequestsExceptionKafkaConnect.Client.exceptions.UnauthorizedExceptionKafkaConnect.Client.exceptions.InternalServerErrorExceptiondelete_custom_plugin(**kwargs)¶Deletes a custom plugin.
See also: AWS API Documentation
Request Syntax
response = client.delete_custom_plugin(
customPluginArn='string'
)
[REQUIRED]
The Amazon Resource Name (ARN) of the custom plugin that you want to delete.
{
'customPluginArn': 'string',
'customPluginState': 'CREATING'|'CREATE_FAILED'|'ACTIVE'|'UPDATING'|'UPDATE_FAILED'|'DELETING'
}
Response Structure
The Amazon Resource Name (ARN) of the custom plugin that you requested to delete.
The state of the custom plugin.
Exceptions
KafkaConnect.Client.exceptions.NotFoundExceptionKafkaConnect.Client.exceptions.BadRequestExceptionKafkaConnect.Client.exceptions.ForbiddenExceptionKafkaConnect.Client.exceptions.ServiceUnavailableExceptionKafkaConnect.Client.exceptions.TooManyRequestsExceptionKafkaConnect.Client.exceptions.UnauthorizedExceptionKafkaConnect.Client.exceptions.InternalServerErrorExceptiondescribe_connector(**kwargs)¶Returns summary information about the connector.
See also: AWS API Documentation
Request Syntax
response = client.describe_connector(
connectorArn='string'
)
[REQUIRED]
The Amazon Resource Name (ARN) of the connector that you want to describe.
{
'capacity': {
'autoScaling': {
'maxWorkerCount': 123,
'mcuCount': 123,
'minWorkerCount': 123,
'scaleInPolicy': {
'cpuUtilizationPercentage': 123
},
'scaleOutPolicy': {
'cpuUtilizationPercentage': 123
}
},
'provisionedCapacity': {
'mcuCount': 123,
'workerCount': 123
}
},
'connectorArn': 'string',
'connectorConfiguration': {
'string': 'string'
},
'connectorDescription': 'string',
'connectorName': 'string',
'connectorState': 'RUNNING'|'CREATING'|'UPDATING'|'DELETING'|'FAILED',
'creationTime': datetime(2015, 1, 1),
'currentVersion': 'string',
'kafkaCluster': {
'apacheKafkaCluster': {
'bootstrapServers': 'string',
'vpc': {
'securityGroups': [
'string',
],
'subnets': [
'string',
]
}
}
},
'kafkaClusterClientAuthentication': {
'authenticationType': 'NONE'|'IAM'
},
'kafkaClusterEncryptionInTransit': {
'encryptionType': 'PLAINTEXT'|'TLS'
},
'kafkaConnectVersion': 'string',
'logDelivery': {
'workerLogDelivery': {
'cloudWatchLogs': {
'enabled': True|False,
'logGroup': 'string'
},
'firehose': {
'deliveryStream': 'string',
'enabled': True|False
},
's3': {
'bucket': 'string',
'enabled': True|False,
'prefix': 'string'
}
}
},
'plugins': [
{
'customPlugin': {
'customPluginArn': 'string',
'revision': 123
}
},
],
'serviceExecutionRoleArn': 'string',
'stateDescription': {
'code': 'string',
'message': 'string'
},
'workerConfiguration': {
'revision': 123,
'workerConfigurationArn': 'string'
}
}
Response Structure
Information about the capacity of the connector, whether it is auto scaled or provisioned.
Describes the connector's auto scaling capacity.
The maximum number of workers allocated to the connector.
The number of microcontroller units (MCUs) allocated to each connector worker. The valid values are 1,2,4,8.
The minimum number of workers allocated to the connector.
The sacle-in policy for the connector.
Specifies the CPU utilization percentage threshold at which you want connector scale in to be triggered.
The sacle-out policy for the connector.>
The CPU utilization percentage threshold at which you want connector scale out to be triggered.
Describes a connector's provisioned capacity.
The number of microcontroller units (MCUs) allocated to each connector worker. The valid values are 1,2,4,8.
The number of workers that are allocated to the connector.
The Amazon Resource Name (ARN) of the connector.
A map of keys to values that represent the configuration for the connector.
A summary description of the connector.
The name of the connector.
The state of the connector.
The time the connector was created.
The current version of the connector.
The Apache Kafka cluster that the connector is connected to.
The Apache Kafka cluster to which the connector is connected.
The bootstrap servers of the cluster.
Details of an Amazon VPC which has network connectivity to the Apache Kafka cluster.
The security groups for the connector.
The subnets for the connector.
The type of client authentication used to connect to the Apache Kafka cluster. The value is NONE when no client authentication is used.
The type of client authentication used to connect to the Apache Kafka cluster. Value NONE means that no client authentication is used.
Details of encryption in transit to the Apache Kafka cluster.
The type of encryption in transit to the Apache Kafka cluster.
The version of Kafka Connect. It has to be compatible with both the Apache Kafka cluster's version and the plugins.
Details about delivering logs to Amazon CloudWatch Logs.
The workers can send worker logs to different destination types. This configuration specifies the details of these destinations.
Details about delivering logs to Amazon CloudWatch Logs.
Whether log delivery to Amazon CloudWatch Logs is enabled.
The name of the CloudWatch log group that is the destination for log delivery.
Details about delivering logs to Amazon Kinesis Data Firehose.
The name of the Kinesis Data Firehose delivery stream that is the destination for log delivery.
Specifies whether connector logs get delivered to Amazon Kinesis Data Firehose.
Details about delivering logs to Amazon S3.
The name of the S3 bucket that is the destination for log delivery.
Specifies whether connector logs get sent to the specified Amazon S3 destination.
The S3 prefix that is the destination for log delivery.
Specifies which plugins were used for this connector.
The description of the plugin.
Details about a custom plugin.
The Amazon Resource Name (ARN) of the custom plugin.
The revision of the custom plugin.
The Amazon Resource Name (ARN) of the IAM role used by the connector to access Amazon Web Services resources.
Details about the state of a connector.
A code that describes the state of a resource.
A message that describes the state of a resource.
Specifies which worker configuration was used for the connector.
The revision of the worker configuration.
The Amazon Resource Name (ARN) of the worker configuration.
Exceptions
KafkaConnect.Client.exceptions.NotFoundExceptionKafkaConnect.Client.exceptions.BadRequestExceptionKafkaConnect.Client.exceptions.ForbiddenExceptionKafkaConnect.Client.exceptions.ServiceUnavailableExceptionKafkaConnect.Client.exceptions.TooManyRequestsExceptionKafkaConnect.Client.exceptions.UnauthorizedExceptionKafkaConnect.Client.exceptions.InternalServerErrorExceptiondescribe_custom_plugin(**kwargs)¶A summary description of the custom plugin.
See also: AWS API Documentation
Request Syntax
response = client.describe_custom_plugin(
customPluginArn='string'
)
[REQUIRED]
Returns information about a custom plugin.
{
'creationTime': datetime(2015, 1, 1),
'customPluginArn': 'string',
'customPluginState': 'CREATING'|'CREATE_FAILED'|'ACTIVE'|'UPDATING'|'UPDATE_FAILED'|'DELETING',
'description': 'string',
'latestRevision': {
'contentType': 'JAR'|'ZIP',
'creationTime': datetime(2015, 1, 1),
'description': 'string',
'fileDescription': {
'fileMd5': 'string',
'fileSize': 123
},
'location': {
's3Location': {
'bucketArn': 'string',
'fileKey': 'string',
'objectVersion': 'string'
}
},
'revision': 123
},
'name': 'string',
'stateDescription': {
'code': 'string',
'message': 'string'
}
}
Response Structure
The time that the custom plugin was created.
The Amazon Resource Name (ARN) of the custom plugin.
The state of the custom plugin.
The description of the custom plugin.
The latest successfully created revision of the custom plugin. If there are no successfully created revisions, this field will be absent.
The format of the plugin file.
The time that the custom plugin was created.
The description of the custom plugin.
Details about the custom plugin file.
The hex-encoded MD5 checksum of the custom plugin file. You can use it to validate the file.
The size in bytes of the custom plugin file. You can use it to validate the file.
Information about the location of the custom plugin.
The S3 bucket Amazon Resource Name (ARN), file key, and object version of the plugin file stored in Amazon S3.
The Amazon Resource Name (ARN) of an S3 bucket.
The file key for an object in an S3 bucket.
The version of an object in an S3 bucket.
The revision of the custom plugin.
The name of the custom plugin.
Details about the state of a custom plugin.
A code that describes the state of a resource.
A message that describes the state of a resource.
Exceptions
KafkaConnect.Client.exceptions.NotFoundExceptionKafkaConnect.Client.exceptions.BadRequestExceptionKafkaConnect.Client.exceptions.ForbiddenExceptionKafkaConnect.Client.exceptions.ServiceUnavailableExceptionKafkaConnect.Client.exceptions.TooManyRequestsExceptionKafkaConnect.Client.exceptions.UnauthorizedExceptionKafkaConnect.Client.exceptions.InternalServerErrorExceptiondescribe_worker_configuration(**kwargs)¶Returns information about a worker configuration.
See also: AWS API Documentation
Request Syntax
response = client.describe_worker_configuration(
workerConfigurationArn='string'
)
[REQUIRED]
The Amazon Resource Name (ARN) of the worker configuration that you want to get information about.
{
'creationTime': datetime(2015, 1, 1),
'description': 'string',
'latestRevision': {
'creationTime': datetime(2015, 1, 1),
'description': 'string',
'propertiesFileContent': 'string',
'revision': 123
},
'name': 'string',
'workerConfigurationArn': 'string'
}
Response Structure
The time that the worker configuration was created.
The description of the worker configuration.
The latest revision of the custom configuration.
The time that the worker configuration was created.
The description of the worker configuration revision.
Base64 encoded contents of the connect-distributed.properties file.
The description of a revision of the worker configuration.
The name of the worker configuration.
The Amazon Resource Name (ARN) of the custom configuration.
Exceptions
KafkaConnect.Client.exceptions.NotFoundExceptionKafkaConnect.Client.exceptions.BadRequestExceptionKafkaConnect.Client.exceptions.ForbiddenExceptionKafkaConnect.Client.exceptions.ServiceUnavailableExceptionKafkaConnect.Client.exceptions.TooManyRequestsExceptionKafkaConnect.Client.exceptions.UnauthorizedExceptionKafkaConnect.Client.exceptions.InternalServerErrorExceptionget_paginator(operation_name)¶Create a paginator for an operation.
create_foo, and you'd normally invoke the
operation as client.create_foo(**kwargs), if the
create_foo operation can be paginated, you can use the
call client.get_paginator("create_foo").client.can_paginate method to
check if an operation is pageable.get_waiter(waiter_name)¶Returns an object that can wait for some condition.
list_connectors(**kwargs)¶Returns a list of all the connectors in this account and Region. The list is limited to connectors whose name starts with the specified prefix. The response also includes a description of each of the listed connectors.
See also: AWS API Documentation
Request Syntax
response = client.list_connectors(
connectorNamePrefix='string',
maxResults=123,
nextToken='string'
)
dict
Response Syntax
{
'connectors': [
{
'capacity': {
'autoScaling': {
'maxWorkerCount': 123,
'mcuCount': 123,
'minWorkerCount': 123,
'scaleInPolicy': {
'cpuUtilizationPercentage': 123
},
'scaleOutPolicy': {
'cpuUtilizationPercentage': 123
}
},
'provisionedCapacity': {
'mcuCount': 123,
'workerCount': 123
}
},
'connectorArn': 'string',
'connectorDescription': 'string',
'connectorName': 'string',
'connectorState': 'RUNNING'|'CREATING'|'UPDATING'|'DELETING'|'FAILED',
'creationTime': datetime(2015, 1, 1),
'currentVersion': 'string',
'kafkaCluster': {
'apacheKafkaCluster': {
'bootstrapServers': 'string',
'vpc': {
'securityGroups': [
'string',
],
'subnets': [
'string',
]
}
}
},
'kafkaClusterClientAuthentication': {
'authenticationType': 'NONE'|'IAM'
},
'kafkaClusterEncryptionInTransit': {
'encryptionType': 'PLAINTEXT'|'TLS'
},
'kafkaConnectVersion': 'string',
'logDelivery': {
'workerLogDelivery': {
'cloudWatchLogs': {
'enabled': True|False,
'logGroup': 'string'
},
'firehose': {
'deliveryStream': 'string',
'enabled': True|False
},
's3': {
'bucket': 'string',
'enabled': True|False,
'prefix': 'string'
}
}
},
'plugins': [
{
'customPlugin': {
'customPluginArn': 'string',
'revision': 123
}
},
],
'serviceExecutionRoleArn': 'string',
'workerConfiguration': {
'revision': 123,
'workerConfigurationArn': 'string'
}
},
],
'nextToken': 'string'
}
Response Structure
(dict) --
connectors (list) --
An array of connector descriptions.
(dict) --
Summary of a connector.
capacity (dict) --
The connector's compute capacity settings.
autoScaling (dict) --
Describes the connector's auto scaling capacity.
maxWorkerCount (integer) --
The maximum number of workers allocated to the connector.
mcuCount (integer) --
The number of microcontroller units (MCUs) allocated to each connector worker. The valid values are 1,2,4,8.
minWorkerCount (integer) --
The minimum number of workers allocated to the connector.
scaleInPolicy (dict) --
The sacle-in policy for the connector.
cpuUtilizationPercentage (integer) --
Specifies the CPU utilization percentage threshold at which you want connector scale in to be triggered.
scaleOutPolicy (dict) --
The sacle-out policy for the connector.>
cpuUtilizationPercentage (integer) --
The CPU utilization percentage threshold at which you want connector scale out to be triggered.
provisionedCapacity (dict) --
Describes a connector's provisioned capacity.
mcuCount (integer) --
The number of microcontroller units (MCUs) allocated to each connector worker. The valid values are 1,2,4,8.
workerCount (integer) --
The number of workers that are allocated to the connector.
connectorArn (string) --
The Amazon Resource Name (ARN) of the connector.
connectorDescription (string) --
The description of the connector.
connectorName (string) --
The name of the connector.
connectorState (string) --
The state of the connector.
creationTime (datetime) --
The time that the connector was created.
currentVersion (string) --
The current version of the connector.
kafkaCluster (dict) --
The details of the Apache Kafka cluster to which the connector is connected.
apacheKafkaCluster (dict) --
The Apache Kafka cluster to which the connector is connected.
bootstrapServers (string) --
The bootstrap servers of the cluster.
vpc (dict) --
Details of an Amazon VPC which has network connectivity to the Apache Kafka cluster.
securityGroups (list) --
The security groups for the connector.
subnets (list) --
The subnets for the connector.
kafkaClusterClientAuthentication (dict) --
The type of client authentication used to connect to the Apache Kafka cluster. The value is NONE when no client authentication is used.
authenticationType (string) --
The type of client authentication used to connect to the Apache Kafka cluster. Value NONE means that no client authentication is used.
kafkaClusterEncryptionInTransit (dict) --
Details of encryption in transit to the Apache Kafka cluster.
encryptionType (string) --
The type of encryption in transit to the Apache Kafka cluster.
kafkaConnectVersion (string) --
The version of Kafka Connect. It has to be compatible with both the Apache Kafka cluster's version and the plugins.
logDelivery (dict) --
The settings for delivering connector logs to Amazon CloudWatch Logs.
workerLogDelivery (dict) --
The workers can send worker logs to different destination types. This configuration specifies the details of these destinations.
cloudWatchLogs (dict) --
Details about delivering logs to Amazon CloudWatch Logs.
enabled (boolean) --
Whether log delivery to Amazon CloudWatch Logs is enabled.
logGroup (string) --
The name of the CloudWatch log group that is the destination for log delivery.
firehose (dict) --
Details about delivering logs to Amazon Kinesis Data Firehose.
deliveryStream (string) --
The name of the Kinesis Data Firehose delivery stream that is the destination for log delivery.
enabled (boolean) --
Specifies whether connector logs get delivered to Amazon Kinesis Data Firehose.
s3 (dict) --
Details about delivering logs to Amazon S3.
bucket (string) --
The name of the S3 bucket that is the destination for log delivery.
enabled (boolean) --
Specifies whether connector logs get sent to the specified Amazon S3 destination.
prefix (string) --
The S3 prefix that is the destination for log delivery.
plugins (list) --
Specifies which plugins were used for this connector.
(dict) --
The description of the plugin.
customPlugin (dict) --
Details about a custom plugin.
customPluginArn (string) --
The Amazon Resource Name (ARN) of the custom plugin.
revision (integer) --
The revision of the custom plugin.
serviceExecutionRoleArn (string) --
The Amazon Resource Name (ARN) of the IAM role used by the connector to access Amazon Web Services resources.
workerConfiguration (dict) --
The worker configurations that are in use with the connector.
revision (integer) --
The revision of the worker configuration.
workerConfigurationArn (string) --
The Amazon Resource Name (ARN) of the worker configuration.
nextToken (string) --
If the response of a ListConnectors operation is truncated, it will include a NextToken. Send this NextToken in a subsequent request to continue listing from where it left off.
Exceptions
KafkaConnect.Client.exceptions.NotFoundExceptionKafkaConnect.Client.exceptions.BadRequestExceptionKafkaConnect.Client.exceptions.ForbiddenExceptionKafkaConnect.Client.exceptions.ServiceUnavailableExceptionKafkaConnect.Client.exceptions.TooManyRequestsExceptionKafkaConnect.Client.exceptions.UnauthorizedExceptionKafkaConnect.Client.exceptions.InternalServerErrorExceptionlist_custom_plugins(**kwargs)¶Returns a list of all of the custom plugins in this account and Region.
See also: AWS API Documentation
Request Syntax
response = client.list_custom_plugins(
maxResults=123,
nextToken='string'
)
dict
Response Syntax
{
'customPlugins': [
{
'creationTime': datetime(2015, 1, 1),
'customPluginArn': 'string',
'customPluginState': 'CREATING'|'CREATE_FAILED'|'ACTIVE'|'UPDATING'|'UPDATE_FAILED'|'DELETING',
'description': 'string',
'latestRevision': {
'contentType': 'JAR'|'ZIP',
'creationTime': datetime(2015, 1, 1),
'description': 'string',
'fileDescription': {
'fileMd5': 'string',
'fileSize': 123
},
'location': {
's3Location': {
'bucketArn': 'string',
'fileKey': 'string',
'objectVersion': 'string'
}
},
'revision': 123
},
'name': 'string'
},
],
'nextToken': 'string'
}
Response Structure
(dict) --
customPlugins (list) --
An array of custom plugin descriptions.
(dict) --
A summary of the custom plugin.
creationTime (datetime) --
The time that the custom plugin was created.
customPluginArn (string) --
The Amazon Resource Name (ARN) of the custom plugin.
customPluginState (string) --
The state of the custom plugin.
description (string) --
A description of the custom plugin.
latestRevision (dict) --
The latest revision of the custom plugin.
contentType (string) --
The format of the plugin file.
creationTime (datetime) --
The time that the custom plugin was created.
description (string) --
The description of the custom plugin.
fileDescription (dict) --
Details about the custom plugin file.
fileMd5 (string) --
The hex-encoded MD5 checksum of the custom plugin file. You can use it to validate the file.
fileSize (integer) --
The size in bytes of the custom plugin file. You can use it to validate the file.
location (dict) --
Information about the location of the custom plugin.
s3Location (dict) --
The S3 bucket Amazon Resource Name (ARN), file key, and object version of the plugin file stored in Amazon S3.
bucketArn (string) --
The Amazon Resource Name (ARN) of an S3 bucket.
fileKey (string) --
The file key for an object in an S3 bucket.
objectVersion (string) --
The version of an object in an S3 bucket.
revision (integer) --
The revision of the custom plugin.
name (string) --
The name of the custom plugin.
nextToken (string) --
If the response of a ListCustomPlugins operation is truncated, it will include a NextToken. Send this NextToken in a subsequent request to continue listing from where the previous operation left off.
Exceptions
KafkaConnect.Client.exceptions.NotFoundExceptionKafkaConnect.Client.exceptions.BadRequestExceptionKafkaConnect.Client.exceptions.ForbiddenExceptionKafkaConnect.Client.exceptions.ServiceUnavailableExceptionKafkaConnect.Client.exceptions.TooManyRequestsExceptionKafkaConnect.Client.exceptions.UnauthorizedExceptionKafkaConnect.Client.exceptions.InternalServerErrorExceptionlist_worker_configurations(**kwargs)¶Returns a list of all of the worker configurations in this account and Region.
See also: AWS API Documentation
Request Syntax
response = client.list_worker_configurations(
maxResults=123,
nextToken='string'
)
dict
Response Syntax
{
'nextToken': 'string',
'workerConfigurations': [
{
'creationTime': datetime(2015, 1, 1),
'description': 'string',
'latestRevision': {
'creationTime': datetime(2015, 1, 1),
'description': 'string',
'revision': 123
},
'name': 'string',
'workerConfigurationArn': 'string'
},
]
}
Response Structure
(dict) --
nextToken (string) --
If the response of a ListWorkerConfigurations operation is truncated, it will include a NextToken. Send this NextToken in a subsequent request to continue listing from where the previous operation left off.
workerConfigurations (list) --
An array of worker configuration descriptions.
(dict) --
The summary of a worker configuration.
creationTime (datetime) --
The time that a worker configuration was created.
description (string) --
The description of a worker configuration.
latestRevision (dict) --
The latest revision of a worker configuration.
creationTime (datetime) --
The time that a worker configuration revision was created.
description (string) --
The description of a worker configuration revision.
revision (integer) --
The revision of a worker configuration.
name (string) --
The name of the worker configuration.
workerConfigurationArn (string) --
The Amazon Resource Name (ARN) of the worker configuration.
Exceptions
KafkaConnect.Client.exceptions.NotFoundExceptionKafkaConnect.Client.exceptions.BadRequestExceptionKafkaConnect.Client.exceptions.ForbiddenExceptionKafkaConnect.Client.exceptions.ServiceUnavailableExceptionKafkaConnect.Client.exceptions.TooManyRequestsExceptionKafkaConnect.Client.exceptions.UnauthorizedExceptionKafkaConnect.Client.exceptions.InternalServerErrorExceptionupdate_connector(**kwargs)¶Updates the specified connector.
See also: AWS API Documentation
Request Syntax
response = client.update_connector(
capacity={
'autoScaling': {
'maxWorkerCount': 123,
'mcuCount': 123,
'minWorkerCount': 123,
'scaleInPolicy': {
'cpuUtilizationPercentage': 123
},
'scaleOutPolicy': {
'cpuUtilizationPercentage': 123
}
},
'provisionedCapacity': {
'mcuCount': 123,
'workerCount': 123
}
},
connectorArn='string',
currentVersion='string'
)
[REQUIRED]
The target capacity.
The target auto scaling setting.
The target maximum number of workers allocated to the connector.
The target number of microcontroller units (MCUs) allocated to each connector worker. The valid values are 1,2,4,8.
The target minimum number of workers allocated to the connector.
The target sacle-in policy for the connector.
The target CPU utilization percentage threshold at which you want connector scale in to be triggered.
The target sacle-out policy for the connector.
The target CPU utilization percentage threshold at which you want connector scale out to be triggered.
The target settings for provisioned capacity.
The number of microcontroller units (MCUs) allocated to each connector worker. The valid values are 1,2,4,8.
The number of workers that are allocated to the connector.
[REQUIRED]
The Amazon Resource Name (ARN) of the connector that you want to update.
[REQUIRED]
The current version of the connector that you want to update.
dict
Response Syntax
{
'connectorArn': 'string',
'connectorState': 'RUNNING'|'CREATING'|'UPDATING'|'DELETING'|'FAILED'
}
Response Structure
(dict) --
connectorArn (string) --
The Amazon Resource Name (ARN) of the connector.
connectorState (string) --
The state of the connector.
Exceptions
KafkaConnect.Client.exceptions.NotFoundExceptionKafkaConnect.Client.exceptions.BadRequestExceptionKafkaConnect.Client.exceptions.ForbiddenExceptionKafkaConnect.Client.exceptions.ServiceUnavailableExceptionKafkaConnect.Client.exceptions.TooManyRequestsExceptionKafkaConnect.Client.exceptions.UnauthorizedExceptionKafkaConnect.Client.exceptions.InternalServerErrorExceptionThe available paginators are:
KafkaConnect.Paginator.ListConnectorsKafkaConnect.Paginator.ListCustomPluginsKafkaConnect.Paginator.ListWorkerConfigurationsKafkaConnect.Paginator.ListConnectors¶paginator = client.get_paginator('list_connectors')
paginate(**kwargs)¶Creates an iterator that will paginate through responses from KafkaConnect.Client.list_connectors().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
connectorNamePrefix='string',
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'connectors': [
{
'capacity': {
'autoScaling': {
'maxWorkerCount': 123,
'mcuCount': 123,
'minWorkerCount': 123,
'scaleInPolicy': {
'cpuUtilizationPercentage': 123
},
'scaleOutPolicy': {
'cpuUtilizationPercentage': 123
}
},
'provisionedCapacity': {
'mcuCount': 123,
'workerCount': 123
}
},
'connectorArn': 'string',
'connectorDescription': 'string',
'connectorName': 'string',
'connectorState': 'RUNNING'|'CREATING'|'UPDATING'|'DELETING'|'FAILED',
'creationTime': datetime(2015, 1, 1),
'currentVersion': 'string',
'kafkaCluster': {
'apacheKafkaCluster': {
'bootstrapServers': 'string',
'vpc': {
'securityGroups': [
'string',
],
'subnets': [
'string',
]
}
}
},
'kafkaClusterClientAuthentication': {
'authenticationType': 'NONE'|'IAM'
},
'kafkaClusterEncryptionInTransit': {
'encryptionType': 'PLAINTEXT'|'TLS'
},
'kafkaConnectVersion': 'string',
'logDelivery': {
'workerLogDelivery': {
'cloudWatchLogs': {
'enabled': True|False,
'logGroup': 'string'
},
'firehose': {
'deliveryStream': 'string',
'enabled': True|False
},
's3': {
'bucket': 'string',
'enabled': True|False,
'prefix': 'string'
}
}
},
'plugins': [
{
'customPlugin': {
'customPluginArn': 'string',
'revision': 123
}
},
],
'serviceExecutionRoleArn': 'string',
'workerConfiguration': {
'revision': 123,
'workerConfigurationArn': 'string'
}
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
connectors (list) --
An array of connector descriptions.
(dict) --
Summary of a connector.
capacity (dict) --
The connector's compute capacity settings.
autoScaling (dict) --
Describes the connector's auto scaling capacity.
maxWorkerCount (integer) --
The maximum number of workers allocated to the connector.
mcuCount (integer) --
The number of microcontroller units (MCUs) allocated to each connector worker. The valid values are 1,2,4,8.
minWorkerCount (integer) --
The minimum number of workers allocated to the connector.
scaleInPolicy (dict) --
The sacle-in policy for the connector.
cpuUtilizationPercentage (integer) --
Specifies the CPU utilization percentage threshold at which you want connector scale in to be triggered.
scaleOutPolicy (dict) --
The sacle-out policy for the connector.>
cpuUtilizationPercentage (integer) --
The CPU utilization percentage threshold at which you want connector scale out to be triggered.
provisionedCapacity (dict) --
Describes a connector's provisioned capacity.
mcuCount (integer) --
The number of microcontroller units (MCUs) allocated to each connector worker. The valid values are 1,2,4,8.
workerCount (integer) --
The number of workers that are allocated to the connector.
connectorArn (string) --
The Amazon Resource Name (ARN) of the connector.
connectorDescription (string) --
The description of the connector.
connectorName (string) --
The name of the connector.
connectorState (string) --
The state of the connector.
creationTime (datetime) --
The time that the connector was created.
currentVersion (string) --
The current version of the connector.
kafkaCluster (dict) --
The details of the Apache Kafka cluster to which the connector is connected.
apacheKafkaCluster (dict) --
The Apache Kafka cluster to which the connector is connected.
bootstrapServers (string) --
The bootstrap servers of the cluster.
vpc (dict) --
Details of an Amazon VPC which has network connectivity to the Apache Kafka cluster.
securityGroups (list) --
The security groups for the connector.
subnets (list) --
The subnets for the connector.
kafkaClusterClientAuthentication (dict) --
The type of client authentication used to connect to the Apache Kafka cluster. The value is NONE when no client authentication is used.
authenticationType (string) --
The type of client authentication used to connect to the Apache Kafka cluster. Value NONE means that no client authentication is used.
kafkaClusterEncryptionInTransit (dict) --
Details of encryption in transit to the Apache Kafka cluster.
encryptionType (string) --
The type of encryption in transit to the Apache Kafka cluster.
kafkaConnectVersion (string) --
The version of Kafka Connect. It has to be compatible with both the Apache Kafka cluster's version and the plugins.
logDelivery (dict) --
The settings for delivering connector logs to Amazon CloudWatch Logs.
workerLogDelivery (dict) --
The workers can send worker logs to different destination types. This configuration specifies the details of these destinations.
cloudWatchLogs (dict) --
Details about delivering logs to Amazon CloudWatch Logs.
enabled (boolean) --
Whether log delivery to Amazon CloudWatch Logs is enabled.
logGroup (string) --
The name of the CloudWatch log group that is the destination for log delivery.
firehose (dict) --
Details about delivering logs to Amazon Kinesis Data Firehose.
deliveryStream (string) --
The name of the Kinesis Data Firehose delivery stream that is the destination for log delivery.
enabled (boolean) --
Specifies whether connector logs get delivered to Amazon Kinesis Data Firehose.
s3 (dict) --
Details about delivering logs to Amazon S3.
bucket (string) --
The name of the S3 bucket that is the destination for log delivery.
enabled (boolean) --
Specifies whether connector logs get sent to the specified Amazon S3 destination.
prefix (string) --
The S3 prefix that is the destination for log delivery.
plugins (list) --
Specifies which plugins were used for this connector.
(dict) --
The description of the plugin.
customPlugin (dict) --
Details about a custom plugin.
customPluginArn (string) --
The Amazon Resource Name (ARN) of the custom plugin.
revision (integer) --
The revision of the custom plugin.
serviceExecutionRoleArn (string) --
The Amazon Resource Name (ARN) of the IAM role used by the connector to access Amazon Web Services resources.
workerConfiguration (dict) --
The worker configurations that are in use with the connector.
revision (integer) --
The revision of the worker configuration.
workerConfigurationArn (string) --
The Amazon Resource Name (ARN) of the worker configuration.
NextToken (string) --
A token to resume pagination.
KafkaConnect.Paginator.ListCustomPlugins¶paginator = client.get_paginator('list_custom_plugins')
paginate(**kwargs)¶Creates an iterator that will paginate through responses from KafkaConnect.Client.list_custom_plugins().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
{
'customPlugins': [
{
'creationTime': datetime(2015, 1, 1),
'customPluginArn': 'string',
'customPluginState': 'CREATING'|'CREATE_FAILED'|'ACTIVE'|'UPDATING'|'UPDATE_FAILED'|'DELETING',
'description': 'string',
'latestRevision': {
'contentType': 'JAR'|'ZIP',
'creationTime': datetime(2015, 1, 1),
'description': 'string',
'fileDescription': {
'fileMd5': 'string',
'fileSize': 123
},
'location': {
's3Location': {
'bucketArn': 'string',
'fileKey': 'string',
'objectVersion': 'string'
}
},
'revision': 123
},
'name': 'string'
},
],
'NextToken': 'string'
}
Response Structure
An array of custom plugin descriptions.
A summary of the custom plugin.
The time that the custom plugin was created.
The Amazon Resource Name (ARN) of the custom plugin.
The state of the custom plugin.
A description of the custom plugin.
The latest revision of the custom plugin.
The format of the plugin file.
The time that the custom plugin was created.
The description of the custom plugin.
Details about the custom plugin file.
The hex-encoded MD5 checksum of the custom plugin file. You can use it to validate the file.
The size in bytes of the custom plugin file. You can use it to validate the file.
Information about the location of the custom plugin.
The S3 bucket Amazon Resource Name (ARN), file key, and object version of the plugin file stored in Amazon S3.
The Amazon Resource Name (ARN) of an S3 bucket.
The file key for an object in an S3 bucket.
The version of an object in an S3 bucket.
The revision of the custom plugin.
The name of the custom plugin.
A token to resume pagination.
KafkaConnect.Paginator.ListWorkerConfigurations¶paginator = client.get_paginator('list_worker_configurations')
paginate(**kwargs)¶Creates an iterator that will paginate through responses from KafkaConnect.Client.list_worker_configurations().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
{
'workerConfigurations': [
{
'creationTime': datetime(2015, 1, 1),
'description': 'string',
'latestRevision': {
'creationTime': datetime(2015, 1, 1),
'description': 'string',
'revision': 123
},
'name': 'string',
'workerConfigurationArn': 'string'
},
],
'NextToken': 'string'
}
Response Structure
An array of worker configuration descriptions.
The summary of a worker configuration.
The time that a worker configuration was created.
The description of a worker configuration.
The latest revision of a worker configuration.
The time that a worker configuration revision was created.
The description of a worker configuration revision.
The revision of a worker configuration.
The name of the worker configuration.
The Amazon Resource Name (ARN) of the worker configuration.
A token to resume pagination.