"documentation":"<p>Returns information about a worker configuration.</p>"
},
"ListConnectors":{
"name":"ListConnectors",
"http":{
"method":"GET",
"requestUri":"/v1/connectors",
"responseCode":200
},
"input":{"shape":"ListConnectorsRequest"},
"output":{"shape":"ListConnectorsResponse"},
"errors":[
{"shape":"NotFoundException"},
{"shape":"BadRequestException"},
{"shape":"ForbiddenException"},
{"shape":"ServiceUnavailableException"},
{"shape":"TooManyRequestsException"},
{"shape":"UnauthorizedException"},
{"shape":"InternalServerErrorException"}
],
"documentation":"<p>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.</p>"
},
"ListCustomPlugins":{
"name":"ListCustomPlugins",
"http":{
"method":"GET",
"requestUri":"/v1/custom-plugins",
"responseCode":200
},
"input":{"shape":"ListCustomPluginsRequest"},
"output":{"shape":"ListCustomPluginsResponse"},
"errors":[
{"shape":"NotFoundException"},
{"shape":"BadRequestException"},
{"shape":"ForbiddenException"},
{"shape":"ServiceUnavailableException"},
{"shape":"TooManyRequestsException"},
{"shape":"UnauthorizedException"},
{"shape":"InternalServerErrorException"}
],
"documentation":"<p>Returns a list of all of the custom plugins in this account and Region.</p>"
"documentation":"<p>The type of client authentication used to connect to the Apache Kafka cluster. The value is NONE when no client authentication is used.</p>"
"documentation":"<p>A map of keys to values that represent the configuration for the connector.</p>"
},
"connectorDescription":{
"shape":"__stringMax1024",
"documentation":"<p>A summary description of the connector.</p>"
},
"connectorName":{
"shape":"__stringMin1Max128",
"documentation":"<p>The name of the connector.</p>"
},
"kafkaCluster":{
"shape":"KafkaCluster",
"documentation":"<p>Specifies which Apache Kafka cluster to connect to.</p>"
},
"kafkaClusterClientAuthentication":{
"shape":"KafkaClusterClientAuthentication",
"documentation":"<p>Details of the client authentication used by the Apache Kafka cluster.</p>"
},
"kafkaClusterEncryptionInTransit":{
"shape":"KafkaClusterEncryptionInTransit",
"documentation":"<p>Details of encryption in transit to the Apache Kafka cluster.</p>"
},
"kafkaConnectVersion":{
"shape":"__string",
"documentation":"<p>The version of Kafka Connect. It has to be compatible with both the Apache Kafka cluster's version and the plugins.</p>"
},
"logDelivery":{
"shape":"LogDelivery",
"documentation":"<p>Details about log delivery.</p>"
},
"plugins":{
"shape":"__listOfPlugin",
"documentation":"<p>Specifies which plugins to use for the connector.</p>"
},
"serviceExecutionRoleArn":{
"shape":"__string",
"documentation":"<p>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.</p>"
},
"workerConfiguration":{
"shape":"WorkerConfiguration",
"documentation":"<p>Specifies which worker configuration to use with the connector.</p>"
}
}
},
"CreateConnectorResponse":{
"type":"structure",
"members":{
"connectorArn":{
"shape":"__string",
"documentation":"<p>The Amazon Resource Name (ARN) that Amazon assigned to the connector.</p>"
},
"connectorName":{
"shape":"__string",
"documentation":"<p>The name of the connector.</p>"
},
"connectorState":{
"shape":"ConnectorState",
"documentation":"<p>The state of the connector.</p>"
}
}
},
"CreateCustomPluginRequest":{
"type":"structure",
"required":[
"contentType",
"location",
"name"
],
"members":{
"contentType":{
"shape":"CustomPluginContentType",
"documentation":"<p>The type of the plugin file.</p>"
},
"description":{
"shape":"__stringMax1024",
"documentation":"<p>A summary description of the custom plugin.</p>"
},
"location":{
"shape":"CustomPluginLocation",
"documentation":"<p>Information about the location of a custom plugin.</p>"
},
"name":{
"shape":"__stringMin1Max128",
"documentation":"<p>The name of the custom plugin.</p>"
}
}
},
"CreateCustomPluginResponse":{
"type":"structure",
"members":{
"customPluginArn":{
"shape":"__string",
"documentation":"<p>The Amazon Resource Name (ARN) that Amazon assigned to the custom plugin.</p>"
},
"customPluginState":{
"shape":"CustomPluginState",
"documentation":"<p>The state of the custom plugin.</p>"
},
"name":{
"shape":"__string",
"documentation":"<p>The name of the custom plugin.</p>"
},
"revision":{
"shape":"__long",
"documentation":"<p>The revision of the custom plugin.</p>"
}
}
},
"CreateWorkerConfigurationRequest":{
"type":"structure",
"required":[
"name",
"propertiesFileContent"
],
"members":{
"description":{
"shape":"__stringMax1024",
"documentation":"<p>A summary description of the worker configuration.</p>"
},
"name":{
"shape":"__stringMin1Max128",
"documentation":"<p>The name of the worker configuration.</p>"
"documentation":"<p>The type of client authentication used to connect to the Apache Kafka cluster. The value is NONE when no client authentication is used.</p>"
"documentation":"<p>Specifies which worker configuration was used for the connector.</p>"
}
}
},
"DescribeCustomPluginRequest":{
"type":"structure",
"required":["customPluginArn"],
"members":{
"customPluginArn":{
"shape":"__string",
"documentation":"<p>Returns information about a custom plugin.</p>",
"location":"uri",
"locationName":"customPluginArn"
}
}
},
"DescribeCustomPluginResponse":{
"type":"structure",
"members":{
"creationTime":{
"shape":"__timestampIso8601",
"documentation":"<p>The time that the custom plugin was created.</p>"
},
"customPluginArn":{
"shape":"__string",
"documentation":"<p>The Amazon Resource Name (ARN) of the custom plugin.</p>"
},
"customPluginState":{
"shape":"CustomPluginState",
"documentation":"<p>The state of the custom plugin.</p>"
},
"description":{
"shape":"__string",
"documentation":"<p>The description of the custom plugin.</p>"
},
"latestRevision":{
"shape":"CustomPluginRevisionSummary",
"documentation":"<p>The latest successfully created revision of the custom plugin. If there are no successfully created revisions, this field will be absent.</p>"
},
"name":{
"shape":"__string",
"documentation":"<p>The name of the custom plugin.</p>"
"documentation":"<p>The Amazon Resource Name (ARN) of the worker configuration that you want to get information about.</p>",
"location":"uri",
"locationName":"workerConfigurationArn"
}
}
},
"DescribeWorkerConfigurationResponse":{
"type":"structure",
"members":{
"creationTime":{
"shape":"__timestampIso8601",
"documentation":"<p>The time that the worker configuration was created.</p>"
},
"description":{
"shape":"__string",
"documentation":"<p>The description of the worker configuration.</p>"
},
"latestRevision":{
"shape":"WorkerConfigurationRevisionDescription",
"documentation":"<p>The latest revision of the custom configuration.</p>"
},
"name":{
"shape":"__string",
"documentation":"<p>The name of the worker configuration.</p>"
},
"workerConfigurationArn":{
"shape":"__string",
"documentation":"<p>The Amazon Resource Name (ARN) of the custom configuration.</p>"
}
}
},
"FirehoseLogDelivery":{
"type":"structure",
"required":["enabled"],
"members":{
"deliveryStream":{
"shape":"__string",
"documentation":"<p>The name of the Kinesis Data Firehose delivery stream that is the destination for log delivery.</p>"
},
"enabled":{
"shape":"__boolean",
"documentation":"<p>Specifies whether connector logs get delivered to Amazon Kinesis Data Firehose.</p>"
}
},
"documentation":"<p>The settings for delivering logs to Amazon Kinesis Data Firehose.</p>"
},
"FirehoseLogDeliveryDescription":{
"type":"structure",
"members":{
"deliveryStream":{
"shape":"__string",
"documentation":"<p>The name of the Kinesis Data Firehose delivery stream that is the destination for log delivery.</p>"
},
"enabled":{
"shape":"__boolean",
"documentation":"<p>Specifies whether connector logs get delivered to Amazon Kinesis Data Firehose.</p>"
}
},
"documentation":"<p>A description of the settings for delivering logs to Amazon Kinesis Data Firehose.</p>"
},
"ForbiddenException":{
"type":"structure",
"members":{
"message":{"shape":"__string"}
},
"documentation":"<p>HTTP Status Code 403: Access forbidden. Correct your credentials and then retry your request.</p>",
"error":{
"httpStatusCode":403,
"senderFault":true
},
"exception":true
},
"InternalServerErrorException":{
"type":"structure",
"members":{
"message":{"shape":"__string"}
},
"documentation":"<p>HTTP Status Code 500: Unexpected internal server error. Retrying your request might resolve the issue.</p>",
"error":{"httpStatusCode":500},
"exception":true,
"fault":true
},
"KafkaCluster":{
"type":"structure",
"required":["apacheKafkaCluster"],
"members":{
"apacheKafkaCluster":{
"shape":"ApacheKafkaCluster",
"documentation":"<p>The Apache Kafka cluster to which the connector is connected.</p>"
}
},
"documentation":"<p>The details of the Apache Kafka cluster to which the connector is connected.</p>"
},
"KafkaClusterClientAuthentication":{
"type":"structure",
"required":["authenticationType"],
"members":{
"authenticationType":{
"shape":"KafkaClusterClientAuthenticationType",
"documentation":"<p>The type of client authentication used to connect to the Apache Kafka cluster. Value NONE means that no client authentication is used.</p>"
}
},
"documentation":"<p>The client authentication information used in order to authenticate with the Apache Kafka cluster.</p>"
},
"KafkaClusterClientAuthenticationDescription":{
"type":"structure",
"members":{
"authenticationType":{
"shape":"KafkaClusterClientAuthenticationType",
"documentation":"<p>The type of client authentication used to connect to the Apache Kafka cluster. Value NONE means that no client authentication is used.</p>"
}
},
"documentation":"<p>The client authentication information used in order to authenticate with the Apache Kafka cluster.</p>"
},
"KafkaClusterClientAuthenticationType":{
"type":"string",
"enum":[
"NONE",
"IAM"
]
},
"KafkaClusterDescription":{
"type":"structure",
"members":{
"apacheKafkaCluster":{
"shape":"ApacheKafkaClusterDescription",
"documentation":"<p>The Apache Kafka cluster to which the connector is connected.</p>"
}
},
"documentation":"<p>Details of how to connect to the Apache Kafka cluster.</p>"
},
"KafkaClusterEncryptionInTransit":{
"type":"structure",
"required":["encryptionType"],
"members":{
"encryptionType":{
"shape":"KafkaClusterEncryptionInTransitType",
"documentation":"<p>The type of encryption in transit to the Apache Kafka cluster.</p>"
}
},
"documentation":"<p>Details of encryption in transit to the Apache Kafka cluster.</p>"
},
"KafkaClusterEncryptionInTransitDescription":{
"type":"structure",
"members":{
"encryptionType":{
"shape":"KafkaClusterEncryptionInTransitType",
"documentation":"<p>The type of encryption in transit to the Apache Kafka cluster.</p>"
}
},
"documentation":"<p>The description of the encryption in transit to the Apache Kafka cluster.</p>"
},
"KafkaClusterEncryptionInTransitType":{
"type":"string",
"enum":[
"PLAINTEXT",
"TLS"
]
},
"ListConnectorsRequest":{
"type":"structure",
"members":{
"connectorNamePrefix":{
"shape":"__string",
"documentation":"<p>The name prefix that you want to use to search for and list connectors.</p>",
"location":"querystring",
"locationName":"connectorNamePrefix"
},
"maxResults":{
"shape":"MaxResults",
"documentation":"<p>The maximum number of connectors to list in one response.</p>",
"location":"querystring",
"locationName":"maxResults"
},
"nextToken":{
"shape":"__string",
"documentation":"<p>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 the previous operation left off.</p>",
"location":"querystring",
"locationName":"nextToken"
}
}
},
"ListConnectorsResponse":{
"type":"structure",
"members":{
"connectors":{
"shape":"__listOfConnectorSummary",
"documentation":"<p>An array of connector descriptions.</p>"
},
"nextToken":{
"shape":"__string",
"documentation":"<p>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.</p>"
}
}
},
"ListCustomPluginsRequest":{
"type":"structure",
"members":{
"maxResults":{
"shape":"MaxResults",
"documentation":"<p>The maximum number of custom plugins to list in one response.</p>",
"location":"querystring",
"locationName":"maxResults"
},
"nextToken":{
"shape":"__string",
"documentation":"<p>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.</p>",
"location":"querystring",
"locationName":"nextToken"
}
}
},
"ListCustomPluginsResponse":{
"type":"structure",
"members":{
"customPlugins":{
"shape":"__listOfCustomPluginSummary",
"documentation":"<p>An array of custom plugin descriptions.</p>"
},
"nextToken":{
"shape":"__string",
"documentation":"<p>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.</p>"
}
}
},
"ListWorkerConfigurationsRequest":{
"type":"structure",
"members":{
"maxResults":{
"shape":"MaxResults",
"documentation":"<p>The maximum number of worker configurations to list in one response.</p>",
"location":"querystring",
"locationName":"maxResults"
},
"nextToken":{
"shape":"__string",
"documentation":"<p>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.</p>",
"location":"querystring",
"locationName":"nextToken"
}
}
},
"ListWorkerConfigurationsResponse":{
"type":"structure",
"members":{
"nextToken":{
"shape":"__string",
"documentation":"<p>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.</p>"
},
"workerConfigurations":{
"shape":"__listOfWorkerConfigurationSummary",
"documentation":"<p>An array of worker configuration descriptions.</p>"
}
}
},
"LogDelivery":{
"type":"structure",
"required":["workerLogDelivery"],
"members":{
"workerLogDelivery":{
"shape":"WorkerLogDelivery",
"documentation":"<p>The workers can send worker logs to different destination types. This configuration specifies the details of these destinations.</p>"
}
},
"documentation":"<p>Details about log delivery.</p>"
},
"LogDeliveryDescription":{
"type":"structure",
"members":{
"workerLogDelivery":{
"shape":"WorkerLogDeliveryDescription",
"documentation":"<p>The workers can send worker logs to different destination types. This configuration specifies the details of these destinations.</p>"
}
},
"documentation":"<p>The description of the log delivery settings.</p>"
},
"MaxResults":{
"type":"integer",
"max":100,
"min":1
},
"NotFoundException":{
"type":"structure",
"members":{
"message":{"shape":"__string"}
},
"documentation":"<p>HTTP Status Code 404: Resource not found due to incorrect input. Correct your request and then retry it.</p>",
"error":{
"httpStatusCode":404,
"senderFault":true
},
"exception":true
},
"Plugin":{
"type":"structure",
"required":["customPlugin"],
"members":{
"customPlugin":{
"shape":"CustomPlugin",
"documentation":"<p>Details about a custom plugin.</p>"
}
},
"documentation":"<p>A plugin is an AWS resource that contains the code that defines your connector logic. </p>"
},
"PluginDescription":{
"type":"structure",
"members":{
"customPlugin":{
"shape":"CustomPluginDescription",
"documentation":"<p>Details about a custom plugin.</p>"
}
},
"documentation":"<p>The description of the plugin.</p>"
},
"ProvisionedCapacity":{
"type":"structure",
"required":[
"mcuCount",
"workerCount"
],
"members":{
"mcuCount":{
"shape":"__integerMin1Max8",
"documentation":"<p>The number of microcontroller units (MCUs) allocated to each connector worker. The valid values are 1,2,4,8.</p>"
},
"workerCount":{
"shape":"__integerMin1Max10",
"documentation":"<p>The number of workers that are allocated to the connector.</p>"
}
},
"documentation":"<p>Details about a connector's provisioned capacity.</p>"
},
"ProvisionedCapacityDescription":{
"type":"structure",
"members":{
"mcuCount":{
"shape":"__integer",
"documentation":"<p>The number of microcontroller units (MCUs) allocated to each connector worker. The valid values are 1,2,4,8.</p>"
},
"workerCount":{
"shape":"__integer",
"documentation":"<p>The number of workers that are allocated to the connector.</p>"
}
},
"documentation":"<p>The description of a connector's provisioned capacity.</p>"
},
"ProvisionedCapacityUpdate":{
"type":"structure",
"required":[
"mcuCount",
"workerCount"
],
"members":{
"mcuCount":{
"shape":"__integerMin1Max8",
"documentation":"<p>The number of microcontroller units (MCUs) allocated to each connector worker. The valid values are 1,2,4,8.</p>"
},
"workerCount":{
"shape":"__integerMin1Max10",
"documentation":"<p>The number of workers that are allocated to the connector.</p>"
}
},
"documentation":"<p>An update to a connector's fixed capacity.</p>"
},
"S3Location":{
"type":"structure",
"required":[
"bucketArn",
"fileKey"
],
"members":{
"bucketArn":{
"shape":"__string",
"documentation":"<p>The Amazon Resource Name (ARN) of an S3 bucket.</p>"
},
"fileKey":{
"shape":"__string",
"documentation":"<p>The file key for an object in an S3 bucket.</p>"
},
"objectVersion":{
"shape":"__string",
"documentation":"<p>The version of an object in an S3 bucket.</p>"
}
},
"documentation":"<p>The location of an object in Amazon S3.</p>"
},
"S3LocationDescription":{
"type":"structure",
"members":{
"bucketArn":{
"shape":"__string",
"documentation":"<p>The Amazon Resource Name (ARN) of an S3 bucket.</p>"
},
"fileKey":{
"shape":"__string",
"documentation":"<p>The file key for an object in an S3 bucket.</p>"
},
"objectVersion":{
"shape":"__string",
"documentation":"<p>The version of an object in an S3 bucket.</p>"
}
},
"documentation":"<p>The description of the location of an object in Amazon S3.</p>"
},
"S3LogDelivery":{
"type":"structure",
"required":["enabled"],
"members":{
"bucket":{
"shape":"__string",
"documentation":"<p>The name of the S3 bucket that is the destination for log delivery.</p>"
},
"enabled":{
"shape":"__boolean",
"documentation":"<p>Specifies whether connector logs get sent to the specified Amazon S3 destination.</p>"
},
"prefix":{
"shape":"__string",
"documentation":"<p>The S3 prefix that is the destination for log delivery.</p>"
}
},
"documentation":"<p>Details about delivering logs to Amazon S3.</p>"
},
"S3LogDeliveryDescription":{
"type":"structure",
"members":{
"bucket":{
"shape":"__string",
"documentation":"<p>The name of the S3 bucket that is the destination for log delivery.</p>"
},
"enabled":{
"shape":"__boolean",
"documentation":"<p>Specifies whether connector logs get sent to the specified Amazon S3 destination.</p>"
},
"prefix":{
"shape":"__string",
"documentation":"<p>The S3 prefix that is the destination for log delivery.</p>"
}
},
"documentation":"<p>The description of the details about delivering logs to Amazon S3.</p>"
},
"ScaleInPolicy":{
"type":"structure",
"required":["cpuUtilizationPercentage"],
"members":{
"cpuUtilizationPercentage":{
"shape":"__integerMin1Max100",
"documentation":"<p>Specifies the CPU utilization percentage threshold at which you want connector scale in to be triggered.</p>"
}
},
"documentation":"<p>The scale-in policy for the connector.</p>"
},
"ScaleInPolicyDescription":{
"type":"structure",
"members":{
"cpuUtilizationPercentage":{
"shape":"__integer",
"documentation":"<p>Specifies the CPU utilization percentage threshold at which you want connector scale in to be triggered.</p>"
}
},
"documentation":"<p>The description of the scale-in policy for the connector.</p>"
},
"ScaleInPolicyUpdate":{
"type":"structure",
"required":["cpuUtilizationPercentage"],
"members":{
"cpuUtilizationPercentage":{
"shape":"__integerMin1Max100",
"documentation":"<p>The target CPU utilization percentage threshold at which you want connector scale in to be triggered.</p>"
}
},
"documentation":"<p>An update to the connector's scale-in policy.</p>"
},
"ScaleOutPolicy":{
"type":"structure",
"required":["cpuUtilizationPercentage"],
"members":{
"cpuUtilizationPercentage":{
"shape":"__integerMin1Max100",
"documentation":"<p>The CPU utilization percentage threshold at which you want connector scale out to be triggered.</p>"
}
},
"documentation":"<p>The scale-out policy for the connector.</p>"
},
"ScaleOutPolicyDescription":{
"type":"structure",
"members":{
"cpuUtilizationPercentage":{
"shape":"__integer",
"documentation":"<p>The CPU utilization percentage threshold at which you want connector scale out to be triggered.</p>"
}
},
"documentation":"<p>The description of the scale-out policy for the connector.</p>"
},
"ScaleOutPolicyUpdate":{
"type":"structure",
"required":["cpuUtilizationPercentage"],
"members":{
"cpuUtilizationPercentage":{
"shape":"__integerMin1Max100",
"documentation":"<p>The target CPU utilization percentage threshold at which you want connector scale out to be triggered.</p>"
}
},
"documentation":"<p>An update to the connector's scale-out policy.</p>"
},
"ServiceUnavailableException":{
"type":"structure",
"members":{
"message":{"shape":"__string"}
},
"documentation":"<p>HTTP Status Code 503: Service Unavailable. Retrying your request in some time might resolve the issue.</p>",