@aws-sdk/client-kafkaconnect 3.295.0 → 3.297.0

package/dist-types/models/models_0.d.ts

@@ -1,6 +1,7 @@
 import { ExceptionOptionType as __ExceptionOptionType } from "@aws-sdk/smithy-client";
 import { KafkaConnectServiceException as __BaseException } from "./KafkaConnectServiceException";
 /**
+ * @public
  * <p>The description of the scale-in policy for the connector.</p>
  */
 export interface ScaleInPolicyDescription {
@@ -11,6 +12,7 @@ export interface ScaleInPolicyDescription {
     cpuUtilizationPercentage?: number;
 }
 /**
+ * @public
  * <p>The description of the scale-out policy for the connector.</p>
  */
 export interface ScaleOutPolicyDescription {
@@ -21,6 +23,7 @@ export interface ScaleOutPolicyDescription {
     cpuUtilizationPercentage?: number;
 }
 /**
+ * @public
  * <p>Information about the auto scaling parameters for the connector.</p>
  */
 export interface AutoScalingDescription {
@@ -47,6 +50,7 @@ export interface AutoScalingDescription {
     scaleOutPolicy?: ScaleOutPolicyDescription;
 }
 /**
+ * @public
  * <p>The description of a connector's provisioned capacity.</p>
  */
 export interface ProvisionedCapacityDescription {
@@ -61,6 +65,7 @@ export interface ProvisionedCapacityDescription {
     workerCount?: number;
 }
 /**
+ * @public
  * <p>A description of the connector's capacity.</p>
  */
 export interface CapacityDescription {
@@ -73,6 +78,9 @@ export interface CapacityDescription {
      */
     provisionedCapacity?: ProvisionedCapacityDescription;
 }
+/**
+ * @public
+ */
 export declare enum ConnectorState {
     CREATING = "CREATING",
     DELETING = "DELETING",
@@ -81,6 +89,7 @@ export declare enum ConnectorState {
     UPDATING = "UPDATING"
 }
 /**
+ * @public
  * <p>The description of the VPC in which the connector resides.</p>
  */
 export interface VpcDescription {
@@ -94,6 +103,7 @@ export interface VpcDescription {
     subnets?: string[];
 }
 /**
+ * @public
  * <p>The description of the Apache Kafka cluster to which the connector is connected.</p>
  */
 export interface ApacheKafkaClusterDescription {
@@ -108,6 +118,7 @@ export interface ApacheKafkaClusterDescription {
     vpc?: VpcDescription;
 }
 /**
+ * @public
  * <p>Details of how to connect to the Apache Kafka cluster.</p>
  */
 export interface KafkaClusterDescription {
@@ -116,11 +127,15 @@ export interface KafkaClusterDescription {
      */
     apacheKafkaCluster?: ApacheKafkaClusterDescription;
 }
+/**
+ * @public
+ */
 export declare enum KafkaClusterClientAuthenticationType {
     IAM = "IAM",
     NONE = "NONE"
 }
 /**
+ * @public
  * <p>The client authentication information used in order to authenticate with the Apache
  *          Kafka cluster.</p>
  */
@@ -131,11 +146,15 @@ export interface KafkaClusterClientAuthenticationDescription {
      */
     authenticationType?: KafkaClusterClientAuthenticationType | string;
 }
+/**
+ * @public
+ */
 export declare enum KafkaClusterEncryptionInTransitType {
     PLAINTEXT = "PLAINTEXT",
     TLS = "TLS"
 }
 /**
+ * @public
  * <p>The description of the encryption in transit to the Apache Kafka cluster.</p>
  */
 export interface KafkaClusterEncryptionInTransitDescription {
@@ -145,6 +164,7 @@ export interface KafkaClusterEncryptionInTransitDescription {
     encryptionType?: KafkaClusterEncryptionInTransitType | string;
 }
 /**
+ * @public
  * <p>A description of the log delivery settings.</p>
  */
 export interface CloudWatchLogsLogDeliveryDescription {
@@ -158,6 +178,7 @@ export interface CloudWatchLogsLogDeliveryDescription {
     logGroup?: string;
 }
 /**
+ * @public
  * <p>A description of the settings for delivering logs to Amazon Kinesis Data
  *          Firehose.</p>
  */
@@ -173,6 +194,7 @@ export interface FirehoseLogDeliveryDescription {
     enabled?: boolean;
 }
 /**
+ * @public
  * <p>The description of the details about delivering logs to Amazon S3.</p>
  */
 export interface S3LogDeliveryDescription {
@@ -190,6 +212,7 @@ export interface S3LogDeliveryDescription {
     prefix?: string;
 }
 /**
+ * @public
  * <p>Workers can send worker logs to different destination types. This configuration
  *          specifies the details of these destinations.</p>
  */
@@ -208,6 +231,7 @@ export interface WorkerLogDeliveryDescription {
     s3?: S3LogDeliveryDescription;
 }
 /**
+ * @public
  * <p>The description of the log delivery settings.</p>
  */
 export interface LogDeliveryDescription {
@@ -218,6 +242,7 @@ export interface LogDeliveryDescription {
     workerLogDelivery?: WorkerLogDeliveryDescription;
 }
 /**
+ * @public
  * <p>Details about a custom plugin.</p>
  */
 export interface CustomPluginDescription {
@@ -231,6 +256,7 @@ export interface CustomPluginDescription {
     revision?: number;
 }
 /**
+ * @public
  * <p>The description of the plugin.</p>
  */
 export interface PluginDescription {
@@ -240,6 +266,7 @@ export interface PluginDescription {
     customPlugin?: CustomPluginDescription;
 }
 /**
+ * @public
  * <p>The description of the worker configuration.</p>
  */
 export interface WorkerConfigurationDescription {
@@ -253,6 +280,7 @@ export interface WorkerConfigurationDescription {
     workerConfigurationArn?: string;
 }
 /**
+ * @public
  * <p>Summary of a connector.</p>
  */
 export interface ConnectorSummary {
@@ -320,6 +348,9 @@ export interface ConnectorSummary {
      */
     workerConfiguration?: WorkerConfigurationDescription;
 }
+/**
+ * @public
+ */
 export declare enum CustomPluginState {
     ACTIVE = "ACTIVE",
     CREATE_FAILED = "CREATE_FAILED",
@@ -328,11 +359,15 @@ export declare enum CustomPluginState {
     UPDATE_FAILED = "UPDATE_FAILED",
     UPDATING = "UPDATING"
 }
+/**
+ * @public
+ */
 export declare enum CustomPluginContentType {
     JAR = "JAR",
     ZIP = "ZIP"
 }
 /**
+ * @public
  * <p>Details about a custom plugin file.</p>
  */
 export interface CustomPluginFileDescription {
@@ -347,6 +382,7 @@ export interface CustomPluginFileDescription {
     fileSize?: number;
 }
 /**
+ * @public
  * <p>The description of the location of an object in Amazon S3.</p>
  */
 export interface S3LocationDescription {
@@ -364,6 +400,7 @@ export interface S3LocationDescription {
     objectVersion?: string;
 }
 /**
+ * @public
  * <p>Information about the location of a custom plugin.</p>
  */
 export interface CustomPluginLocationDescription {
@@ -374,6 +411,7 @@ export interface CustomPluginLocationDescription {
     s3Location?: S3LocationDescription;
 }
 /**
+ * @public
  * <p>Details about the revision of a custom plugin.</p>
  */
 export interface CustomPluginRevisionSummary {
@@ -403,6 +441,7 @@ export interface CustomPluginRevisionSummary {
     revision?: number;
 }
 /**
+ * @public
  * <p>A summary of the custom plugin.</p>
  */
 export interface CustomPluginSummary {
@@ -432,6 +471,7 @@ export interface CustomPluginSummary {
     name?: string;
 }
 /**
+ * @public
  * <p>A plugin is an AWS resource that contains the code that defines a connector's
  *          logic.</p>
  */
@@ -446,6 +486,7 @@ export interface CustomPlugin {
     revision: number | undefined;
 }
 /**
+ * @public
  * <p>A plugin is an AWS resource that contains the code that defines your connector logic.
  *       </p>
  */
@@ -456,6 +497,7 @@ export interface Plugin {
     customPlugin: CustomPlugin | undefined;
 }
 /**
+ * @public
  * <p>The summary of a worker configuration revision.</p>
  */
 export interface WorkerConfigurationRevisionSummary {
@@ -473,6 +515,7 @@ export interface WorkerConfigurationRevisionSummary {
     revision?: number;
 }
 /**
+ * @public
  * <p>The summary of a worker configuration.</p>
  */
 export interface WorkerConfigurationSummary {
@@ -498,6 +541,7 @@ export interface WorkerConfigurationSummary {
     workerConfigurationArn?: string;
 }
 /**
+ * @public
  * <p>Information about the VPC in which the connector resides.</p>
  */
 export interface Vpc {
@@ -511,6 +555,7 @@ export interface Vpc {
     subnets: string[] | undefined;
 }
 /**
+ * @public
  * <p>The details of the Apache Kafka cluster to which the connector is connected.</p>
  */
 export interface ApacheKafkaCluster {
@@ -525,6 +570,7 @@ export interface ApacheKafkaCluster {
     vpc: Vpc | undefined;
 }
 /**
+ * @public
  * <p>The scale-in policy for the connector.</p>
  */
 export interface ScaleInPolicy {
@@ -535,6 +581,7 @@ export interface ScaleInPolicy {
     cpuUtilizationPercentage: number | undefined;
 }
 /**
+ * @public
  * <p>The scale-out policy for the connector.</p>
  */
 export interface ScaleOutPolicy {
@@ -545,6 +592,7 @@ export interface ScaleOutPolicy {
     cpuUtilizationPercentage: number | undefined;
 }
 /**
+ * @public
  * <p>Specifies how the connector scales.</p>
  */
 export interface AutoScaling {
@@ -571,6 +619,7 @@ export interface AutoScaling {
     scaleOutPolicy?: ScaleOutPolicy;
 }
 /**
+ * @public
  * <p>An update to the connector's scale-in policy.</p>
  */
 export interface ScaleInPolicyUpdate {
@@ -581,6 +630,7 @@ export interface ScaleInPolicyUpdate {
     cpuUtilizationPercentage: number | undefined;
 }
 /**
+ * @public
  * <p>An update to the connector's scale-out policy.</p>
  */
 export interface ScaleOutPolicyUpdate {
@@ -591,6 +641,7 @@ export interface ScaleOutPolicyUpdate {
     cpuUtilizationPercentage: number | undefined;
 }
 /**
+ * @public
  * <p>The updates to the auto scaling parameters for the connector.</p>
  */
 export interface AutoScalingUpdate {
@@ -617,6 +668,7 @@ export interface AutoScalingUpdate {
     scaleOutPolicy: ScaleOutPolicyUpdate | undefined;
 }
 /**
+ * @public
  * <p>HTTP Status Code 400: Bad request due to incorrect input. Correct your request and then
  *          retry it.</p>
  */
@@ -629,6 +681,7 @@ export declare class BadRequestException extends __BaseException {
     constructor(opts: __ExceptionOptionType<BadRequestException, __BaseException>);
 }
 /**
+ * @public
  * <p>Details about a connector's provisioned capacity.</p>
  */
 export interface ProvisionedCapacity {
@@ -643,6 +696,7 @@ export interface ProvisionedCapacity {
     workerCount: number | undefined;
 }
 /**
+ * @public
  * <p>Information about the capacity of the connector, whether it is auto scaled or
  *          provisioned.</p>
  */
@@ -657,6 +711,7 @@ export interface Capacity {
     provisionedCapacity?: ProvisionedCapacity;
 }
 /**
+ * @public
  * <p>An update to a connector's fixed capacity.</p>
  */
 export interface ProvisionedCapacityUpdate {
@@ -671,6 +726,7 @@ export interface ProvisionedCapacityUpdate {
     workerCount: number | undefined;
 }
 /**
+ * @public
  * <p>The target capacity for the connector. The capacity can be auto scaled or
  *          provisioned.</p>
  */
@@ -685,6 +741,7 @@ export interface CapacityUpdate {
     provisionedCapacity?: ProvisionedCapacityUpdate;
 }
 /**
+ * @public
  * <p>The settings for delivering connector logs to Amazon CloudWatch Logs.</p>
  */
 export interface CloudWatchLogsLogDelivery {
@@ -698,6 +755,7 @@ export interface CloudWatchLogsLogDelivery {
     logGroup?: string;
 }
 /**
+ * @public
  * <p>HTTP Status Code 409: Conflict. A resource with this name already exists. Retry your
  *          request with another name.</p>
  */
@@ -710,6 +768,7 @@ export declare class ConflictException extends __BaseException {
     constructor(opts: __ExceptionOptionType<ConflictException, __BaseException>);
 }
 /**
+ * @public
  * <p>The details of the Apache Kafka cluster to which the connector is connected.</p>
  */
 export interface KafkaCluster {
@@ -719,6 +778,7 @@ export interface KafkaCluster {
     apacheKafkaCluster: ApacheKafkaCluster | undefined;
 }
 /**
+ * @public
  * <p>The client authentication information used in order to authenticate with the Apache
  *          Kafka cluster.</p>
  */
@@ -730,6 +790,7 @@ export interface KafkaClusterClientAuthentication {
     authenticationType: KafkaClusterClientAuthenticationType | string | undefined;
 }
 /**
+ * @public
  * <p>Details of encryption in transit to the Apache Kafka cluster.</p>
  */
 export interface KafkaClusterEncryptionInTransit {
@@ -739,6 +800,7 @@ export interface KafkaClusterEncryptionInTransit {
     encryptionType: KafkaClusterEncryptionInTransitType | string | undefined;
 }
 /**
+ * @public
  * <p>The settings for delivering logs to Amazon Kinesis Data Firehose.</p>
  */
 export interface FirehoseLogDelivery {
@@ -753,6 +815,7 @@ export interface FirehoseLogDelivery {
     enabled: boolean | undefined;
 }
 /**
+ * @public
  * <p>Details about delivering logs to Amazon S3.</p>
  */
 export interface S3LogDelivery {
@@ -770,6 +833,7 @@ export interface S3LogDelivery {
     prefix?: string;
 }
 /**
+ * @public
  * <p>Workers can send worker logs to different destination types. This configuration
  *          specifies the details of these destinations.</p>
  */
@@ -788,6 +852,7 @@ export interface WorkerLogDelivery {
     s3?: S3LogDelivery;
 }
 /**
+ * @public
  * <p>Details about log delivery.</p>
  */
 export interface LogDelivery {
@@ -798,6 +863,7 @@ export interface LogDelivery {
     workerLogDelivery: WorkerLogDelivery | undefined;
 }
 /**
+ * @public
  * <p>The configuration of the workers, which are the processes that run the connector
  *          logic.</p>
  */
@@ -811,6 +877,9 @@ export interface WorkerConfiguration {
      */
     workerConfigurationArn: string | undefined;
 }
+/**
+ * @public
+ */
 export interface CreateConnectorRequest {
     /**
      * <p>Information about the capacity allocated to the connector. Exactly one of the two
@@ -866,6 +935,9 @@ export interface CreateConnectorRequest {
      */
     workerConfiguration?: WorkerConfiguration;
 }
+/**
+ * @public
+ */
 export interface CreateConnectorResponse {
     /**
      * <p>The Amazon Resource Name (ARN) that Amazon assigned to the connector.</p>
@@ -881,6 +953,7 @@ export interface CreateConnectorResponse {
     connectorState?: ConnectorState | string;
 }
 /**
+ * @public
  * <p>HTTP Status Code 403: Access forbidden. Correct your credentials and then retry your
  *          request.</p>
  */
@@ -893,6 +966,7 @@ export declare class ForbiddenException extends __BaseException {
     constructor(opts: __ExceptionOptionType<ForbiddenException, __BaseException>);
 }
 /**
+ * @public
  * <p>HTTP Status Code 500: Unexpected internal server error. Retrying your request might
  *          resolve the issue.</p>
  */
@@ -905,6 +979,7 @@ export declare class InternalServerErrorException extends __BaseException {
     constructor(opts: __ExceptionOptionType<InternalServerErrorException, __BaseException>);
 }
 /**
+ * @public
  * <p>HTTP Status Code 404: Resource not found due to incorrect input. Correct your request
  *          and then retry it.</p>
  */
@@ -917,6 +992,7 @@ export declare class NotFoundException extends __BaseException {
     constructor(opts: __ExceptionOptionType<NotFoundException, __BaseException>);
 }
 /**
+ * @public
  * <p>HTTP Status Code 503: Service Unavailable. Retrying your request in some time might
  *          resolve the issue.</p>
  */
@@ -929,6 +1005,7 @@ export declare class ServiceUnavailableException extends __BaseException {
     constructor(opts: __ExceptionOptionType<ServiceUnavailableException, __BaseException>);
 }
 /**
+ * @public
  * <p>HTTP Status Code 429: Limit exceeded. Resource limit reached.</p>
  */
 export declare class TooManyRequestsException extends __BaseException {
@@ -940,6 +1017,7 @@ export declare class TooManyRequestsException extends __BaseException {
     constructor(opts: __ExceptionOptionType<TooManyRequestsException, __BaseException>);
 }
 /**
+ * @public
  * <p>HTTP Status Code 401: Unauthorized request. The provided credentials couldn't be
  *          validated.</p>
  */
@@ -952,6 +1030,7 @@ export declare class UnauthorizedException extends __BaseException {
     constructor(opts: __ExceptionOptionType<UnauthorizedException, __BaseException>);
 }
 /**
+ * @public
  * <p>The location of an object in Amazon S3.</p>
  */
 export interface S3Location {
@@ -969,6 +1048,7 @@ export interface S3Location {
     objectVersion?: string;
 }
 /**
+ * @public
  * <p>Information about the location of a custom plugin.</p>
  */
 export interface CustomPluginLocation {
@@ -978,6 +1058,9 @@ export interface CustomPluginLocation {
      */
     s3Location: S3Location | undefined;
 }
+/**
+ * @public
+ */
 export interface CreateCustomPluginRequest {
     /**
      * <p>The type of the plugin file.</p>
@@ -996,6 +1079,9 @@ export interface CreateCustomPluginRequest {
      */
     name: string | undefined;
 }
+/**
+ * @public
+ */
 export interface CreateCustomPluginResponse {
     /**
      * <p>The Amazon Resource Name (ARN) that Amazon assigned to the custom plugin.</p>
@@ -1014,6 +1100,9 @@ export interface CreateCustomPluginResponse {
      */
     revision?: number;
 }
+/**
+ * @public
+ */
 export interface CreateWorkerConfigurationRequest {
     /**
      * <p>A summary description of the worker configuration.</p>
@@ -1028,6 +1117,9 @@ export interface CreateWorkerConfigurationRequest {
      */
     propertiesFileContent: string | undefined;
 }
+/**
+ * @public
+ */
 export interface CreateWorkerConfigurationResponse {
     /**
      * <p>The time that the worker configuration was created.</p>
@@ -1046,6 +1138,9 @@ export interface CreateWorkerConfigurationResponse {
      */
     workerConfigurationArn?: string;
 }
+/**
+ * @public
+ */
 export interface DeleteConnectorRequest {
     /**
      * <p>The Amazon Resource Name (ARN) of the connector that you want to delete.</p>
@@ -1056,6 +1151,9 @@ export interface DeleteConnectorRequest {
      */
     currentVersion?: string;
 }
+/**
+ * @public
+ */
 export interface DeleteConnectorResponse {
     /**
      * <p>The Amazon Resource Name (ARN) of the connector that you requested to delete.</p>
@@ -1066,12 +1164,18 @@ export interface DeleteConnectorResponse {
      */
     connectorState?: ConnectorState | string;
 }
+/**
+ * @public
+ */
 export interface DeleteCustomPluginRequest {
     /**
      * <p>The Amazon Resource Name (ARN) of the custom plugin that you want to delete.</p>
      */
     customPluginArn: string | undefined;
 }
+/**
+ * @public
+ */
 export interface DeleteCustomPluginResponse {
     /**
      * <p>The Amazon Resource Name (ARN) of the custom plugin that you requested to delete.</p>
@@ -1082,6 +1186,9 @@ export interface DeleteCustomPluginResponse {
      */
     customPluginState?: CustomPluginState | string;
 }
+/**
+ * @public
+ */
 export interface DescribeConnectorRequest {
     /**
      * <p>The Amazon Resource Name (ARN) of the connector that you want to describe.</p>
@@ -1089,6 +1196,7 @@ export interface DescribeConnectorRequest {
     connectorArn: string | undefined;
 }
 /**
+ * @public
  * <p>Details about the state of a resource.</p>
  */
 export interface StateDescription {
@@ -1101,6 +1209,9 @@ export interface StateDescription {
      */
     message?: string;
 }
+/**
+ * @public
+ */
 export interface DescribeConnectorResponse {
     /**
      * <p>Information about the capacity of the connector, whether it is auto scaled or
@@ -1175,12 +1286,18 @@ export interface DescribeConnectorResponse {
      */
     stateDescription?: StateDescription;
 }
+/**
+ * @public
+ */
 export interface DescribeCustomPluginRequest {
     /**
      * <p>Returns information about a custom plugin.</p>
      */
     customPluginArn: string | undefined;
 }
+/**
+ * @public
+ */
 export interface DescribeCustomPluginResponse {
     /**
      * <p>The time that the custom plugin was created.</p>
@@ -1212,6 +1329,9 @@ export interface DescribeCustomPluginResponse {
      */
     stateDescription?: StateDescription;
 }
+/**
+ * @public
+ */
 export interface DescribeWorkerConfigurationRequest {
     /**
      * <p>The Amazon Resource Name (ARN) of the worker configuration that you want to get
@@ -1220,6 +1340,7 @@ export interface DescribeWorkerConfigurationRequest {
     workerConfigurationArn: string | undefined;
 }
 /**
+ * @public
  * <p>The description of the worker configuration revision.</p>
  */
 export interface WorkerConfigurationRevisionDescription {
@@ -1240,6 +1361,9 @@ export interface WorkerConfigurationRevisionDescription {
      */
     revision?: number;
 }
+/**
+ * @public
+ */
 export interface DescribeWorkerConfigurationResponse {
     /**
      * <p>The time that the worker configuration was created.</p>
@@ -1262,6 +1386,9 @@ export interface DescribeWorkerConfigurationResponse {
      */
     workerConfigurationArn?: string;
 }
+/**
+ * @public
+ */
 export interface ListConnectorsRequest {
     /**
      * <p>The name prefix that you want to use to search for and list connectors.</p>
@@ -1278,6 +1405,9 @@ export interface ListConnectorsRequest {
      */
     nextToken?: string;
 }
+/**
+ * @public
+ */
 export interface ListConnectorsResponse {
     /**
      * <p>An array of connector descriptions.</p>
@@ -1290,6 +1420,9 @@ export interface ListConnectorsResponse {
      */
     nextToken?: string;
 }
+/**
+ * @public
+ */
 export interface ListCustomPluginsRequest {
     /**
      * <p>The maximum number of custom plugins to list in one response.</p>
@@ -1302,6 +1435,9 @@ export interface ListCustomPluginsRequest {
      */
     nextToken?: string;
 }
+/**
+ * @public
+ */
 export interface ListCustomPluginsResponse {
     /**
      * <p>An array of custom plugin descriptions.</p>
@@ -1314,6 +1450,9 @@ export interface ListCustomPluginsResponse {
      */
     nextToken?: string;
 }
+/**
+ * @public
+ */
 export interface ListWorkerConfigurationsRequest {
     /**
      * <p>The maximum number of worker configurations to list in one response.</p>
@@ -1326,6 +1465,9 @@ export interface ListWorkerConfigurationsRequest {
      */
     nextToken?: string;
 }
+/**
+ * @public
+ */
 export interface ListWorkerConfigurationsResponse {
     /**
      * <p>If the response of a ListWorkerConfigurations operation is truncated, it will include a
@@ -1338,6 +1480,9 @@ export interface ListWorkerConfigurationsResponse {
      */
     workerConfigurations?: WorkerConfigurationSummary[];
 }
+/**
+ * @public
+ */
 export interface UpdateConnectorRequest {
     /**
      * <p>The target capacity.</p>
@@ -1352,6 +1497,9 @@ export interface UpdateConnectorRequest {
      */
     currentVersion: string | undefined;
 }
+/**
+ * @public
+ */
 export interface UpdateConnectorResponse {
     /**
      * <p>The Amazon Resource Name (ARN) of the connector.</p>