@aws-sdk/client-kafkaconnect 3.296.0 → 3.298.0

package/dist-types/commands/DeleteConnectorCommand.d.ts

@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
 import { KafkaConnectClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../KafkaConnectClient";
 import { DeleteConnectorRequest, DeleteConnectorResponse } from "../models/models_0";
 /**
+ * @public
+ *
  * The input for {@link DeleteConnectorCommand}.
  */
 export interface DeleteConnectorCommandInput extends DeleteConnectorRequest {
 }
 /**
+ * @public
+ *
  * The output of {@link DeleteConnectorCommand}.
  */
 export interface DeleteConnectorCommandOutput extends DeleteConnectorResponse, __MetadataBearer {
 }
 /**
+ * @public
  * <p>Deletes the specified connector.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
@@ -25,6 +30,8 @@ export interface DeleteConnectorCommandOutput extends DeleteConnectorResponse, _
  * const response = await client.send(command);
  * ```
  *
+ * @param DeleteConnectorCommandInput - {@link DeleteConnectorCommandInput}
+ * @returns {@link DeleteConnectorCommandOutput}
  * @see {@link DeleteConnectorCommandInput} for command's `input` shape.
  * @see {@link DeleteConnectorCommandOutput} for command's `response` shape.
  * @see {@link KafkaConnectClientResolvedConfig | config} for KafkaConnectClient's `config` shape.
@@ -61,11 +68,20 @@ export interface DeleteConnectorCommandOutput extends DeleteConnectorResponse, _
 export declare class DeleteConnectorCommand extends $Command<DeleteConnectorCommandInput, DeleteConnectorCommandOutput, KafkaConnectClientResolvedConfig> {
     readonly input: DeleteConnectorCommandInput;
     static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
     constructor(input: DeleteConnectorCommandInput);
     /**
      * @internal
      */
     resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: KafkaConnectClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DeleteConnectorCommandInput, DeleteConnectorCommandOutput>;
+    /**
+     * @internal
+     */
     private serialize;
+    /**
+     * @internal
+     */
     private deserialize;
 }

package/dist-types/commands/DeleteCustomPluginCommand.d.ts

@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
 import { KafkaConnectClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../KafkaConnectClient";
 import { DeleteCustomPluginRequest, DeleteCustomPluginResponse } from "../models/models_0";
 /**
+ * @public
+ *
  * The input for {@link DeleteCustomPluginCommand}.
  */
 export interface DeleteCustomPluginCommandInput extends DeleteCustomPluginRequest {
 }
 /**
+ * @public
+ *
  * The output of {@link DeleteCustomPluginCommand}.
  */
 export interface DeleteCustomPluginCommandOutput extends DeleteCustomPluginResponse, __MetadataBearer {
 }
 /**
+ * @public
  * <p>Deletes a custom plugin.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
@@ -25,6 +30,8 @@ export interface DeleteCustomPluginCommandOutput extends DeleteCustomPluginRespo
  * const response = await client.send(command);
  * ```
  *
+ * @param DeleteCustomPluginCommandInput - {@link DeleteCustomPluginCommandInput}
+ * @returns {@link DeleteCustomPluginCommandOutput}
  * @see {@link DeleteCustomPluginCommandInput} for command's `input` shape.
  * @see {@link DeleteCustomPluginCommandOutput} for command's `response` shape.
  * @see {@link KafkaConnectClientResolvedConfig | config} for KafkaConnectClient's `config` shape.
@@ -61,11 +68,20 @@ export interface DeleteCustomPluginCommandOutput extends DeleteCustomPluginRespo
 export declare class DeleteCustomPluginCommand extends $Command<DeleteCustomPluginCommandInput, DeleteCustomPluginCommandOutput, KafkaConnectClientResolvedConfig> {
     readonly input: DeleteCustomPluginCommandInput;
     static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
     constructor(input: DeleteCustomPluginCommandInput);
     /**
      * @internal
      */
     resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: KafkaConnectClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DeleteCustomPluginCommandInput, DeleteCustomPluginCommandOutput>;
+    /**
+     * @internal
+     */
     private serialize;
+    /**
+     * @internal
+     */
     private deserialize;
 }

package/dist-types/commands/DescribeConnectorCommand.d.ts

@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
 import { KafkaConnectClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../KafkaConnectClient";
 import { DescribeConnectorRequest, DescribeConnectorResponse } from "../models/models_0";
 /**
+ * @public
+ *
  * The input for {@link DescribeConnectorCommand}.
  */
 export interface DescribeConnectorCommandInput extends DescribeConnectorRequest {
 }
 /**
+ * @public
+ *
  * The output of {@link DescribeConnectorCommand}.
  */
 export interface DescribeConnectorCommandOutput extends DescribeConnectorResponse, __MetadataBearer {
 }
 /**
+ * @public
  * <p>Returns summary information about the connector.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
@@ -25,6 +30,8 @@ export interface DescribeConnectorCommandOutput extends DescribeConnectorRespons
  * const response = await client.send(command);
  * ```
  *
+ * @param DescribeConnectorCommandInput - {@link DescribeConnectorCommandInput}
+ * @returns {@link DescribeConnectorCommandOutput}
  * @see {@link DescribeConnectorCommandInput} for command's `input` shape.
  * @see {@link DescribeConnectorCommandOutput} for command's `response` shape.
  * @see {@link KafkaConnectClientResolvedConfig | config} for KafkaConnectClient's `config` shape.
@@ -61,11 +68,20 @@ export interface DescribeConnectorCommandOutput extends DescribeConnectorRespons
 export declare class DescribeConnectorCommand extends $Command<DescribeConnectorCommandInput, DescribeConnectorCommandOutput, KafkaConnectClientResolvedConfig> {
     readonly input: DescribeConnectorCommandInput;
     static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
     constructor(input: DescribeConnectorCommandInput);
     /**
      * @internal
      */
     resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: KafkaConnectClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DescribeConnectorCommandInput, DescribeConnectorCommandOutput>;
+    /**
+     * @internal
+     */
     private serialize;
+    /**
+     * @internal
+     */
     private deserialize;
 }

package/dist-types/commands/DescribeCustomPluginCommand.d.ts

@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
 import { KafkaConnectClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../KafkaConnectClient";
 import { DescribeCustomPluginRequest, DescribeCustomPluginResponse } from "../models/models_0";
 /**
+ * @public
+ *
  * The input for {@link DescribeCustomPluginCommand}.
  */
 export interface DescribeCustomPluginCommandInput extends DescribeCustomPluginRequest {
 }
 /**
+ * @public
+ *
  * The output of {@link DescribeCustomPluginCommand}.
  */
 export interface DescribeCustomPluginCommandOutput extends DescribeCustomPluginResponse, __MetadataBearer {
 }
 /**
+ * @public
  * <p>A summary description of the custom plugin.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
@@ -25,6 +30,8 @@ export interface DescribeCustomPluginCommandOutput extends DescribeCustomPluginR
  * const response = await client.send(command);
  * ```
  *
+ * @param DescribeCustomPluginCommandInput - {@link DescribeCustomPluginCommandInput}
+ * @returns {@link DescribeCustomPluginCommandOutput}
  * @see {@link DescribeCustomPluginCommandInput} for command's `input` shape.
  * @see {@link DescribeCustomPluginCommandOutput} for command's `response` shape.
  * @see {@link KafkaConnectClientResolvedConfig | config} for KafkaConnectClient's `config` shape.
@@ -61,11 +68,20 @@ export interface DescribeCustomPluginCommandOutput extends DescribeCustomPluginR
 export declare class DescribeCustomPluginCommand extends $Command<DescribeCustomPluginCommandInput, DescribeCustomPluginCommandOutput, KafkaConnectClientResolvedConfig> {
     readonly input: DescribeCustomPluginCommandInput;
     static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
     constructor(input: DescribeCustomPluginCommandInput);
     /**
      * @internal
      */
     resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: KafkaConnectClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DescribeCustomPluginCommandInput, DescribeCustomPluginCommandOutput>;
+    /**
+     * @internal
+     */
     private serialize;
+    /**
+     * @internal
+     */
     private deserialize;
 }

package/dist-types/commands/DescribeWorkerConfigurationCommand.d.ts

@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
 import { KafkaConnectClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../KafkaConnectClient";
 import { DescribeWorkerConfigurationRequest, DescribeWorkerConfigurationResponse } from "../models/models_0";
 /**
+ * @public
+ *
  * The input for {@link DescribeWorkerConfigurationCommand}.
  */
 export interface DescribeWorkerConfigurationCommandInput extends DescribeWorkerConfigurationRequest {
 }
 /**
+ * @public
+ *
  * The output of {@link DescribeWorkerConfigurationCommand}.
  */
 export interface DescribeWorkerConfigurationCommandOutput extends DescribeWorkerConfigurationResponse, __MetadataBearer {
 }
 /**
+ * @public
  * <p>Returns information about a worker configuration.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
@@ -25,6 +30,8 @@ export interface DescribeWorkerConfigurationCommandOutput extends DescribeWorker
  * const response = await client.send(command);
  * ```
  *
+ * @param DescribeWorkerConfigurationCommandInput - {@link DescribeWorkerConfigurationCommandInput}
+ * @returns {@link DescribeWorkerConfigurationCommandOutput}
  * @see {@link DescribeWorkerConfigurationCommandInput} for command's `input` shape.
  * @see {@link DescribeWorkerConfigurationCommandOutput} for command's `response` shape.
  * @see {@link KafkaConnectClientResolvedConfig | config} for KafkaConnectClient's `config` shape.
@@ -61,11 +68,20 @@ export interface DescribeWorkerConfigurationCommandOutput extends DescribeWorker
 export declare class DescribeWorkerConfigurationCommand extends $Command<DescribeWorkerConfigurationCommandInput, DescribeWorkerConfigurationCommandOutput, KafkaConnectClientResolvedConfig> {
     readonly input: DescribeWorkerConfigurationCommandInput;
     static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
     constructor(input: DescribeWorkerConfigurationCommandInput);
     /**
      * @internal
      */
     resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: KafkaConnectClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DescribeWorkerConfigurationCommandInput, DescribeWorkerConfigurationCommandOutput>;
+    /**
+     * @internal
+     */
     private serialize;
+    /**
+     * @internal
+     */
     private deserialize;
 }

package/dist-types/commands/ListConnectorsCommand.d.ts

@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
 import { KafkaConnectClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../KafkaConnectClient";
 import { ListConnectorsRequest, ListConnectorsResponse } from "../models/models_0";
 /**
+ * @public
+ *
  * The input for {@link ListConnectorsCommand}.
  */
 export interface ListConnectorsCommandInput extends ListConnectorsRequest {
 }
 /**
+ * @public
+ *
  * The output of {@link ListConnectorsCommand}.
  */
 export interface ListConnectorsCommandOutput extends ListConnectorsResponse, __MetadataBearer {
 }
 /**
+ * @public
  * <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>
@@ -27,6 +32,8 @@ export interface ListConnectorsCommandOutput extends ListConnectorsResponse, __M
  * const response = await client.send(command);
  * ```
  *
+ * @param ListConnectorsCommandInput - {@link ListConnectorsCommandInput}
+ * @returns {@link ListConnectorsCommandOutput}
  * @see {@link ListConnectorsCommandInput} for command's `input` shape.
  * @see {@link ListConnectorsCommandOutput} for command's `response` shape.
  * @see {@link KafkaConnectClientResolvedConfig | config} for KafkaConnectClient's `config` shape.
@@ -63,11 +70,20 @@ export interface ListConnectorsCommandOutput extends ListConnectorsResponse, __M
 export declare class ListConnectorsCommand extends $Command<ListConnectorsCommandInput, ListConnectorsCommandOutput, KafkaConnectClientResolvedConfig> {
     readonly input: ListConnectorsCommandInput;
     static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
     constructor(input: ListConnectorsCommandInput);
     /**
      * @internal
      */
     resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: KafkaConnectClientResolvedConfig, options?: __HttpHandlerOptions): Handler<ListConnectorsCommandInput, ListConnectorsCommandOutput>;
+    /**
+     * @internal
+     */
     private serialize;
+    /**
+     * @internal
+     */
     private deserialize;
 }

package/dist-types/commands/ListCustomPluginsCommand.d.ts

@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
 import { KafkaConnectClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../KafkaConnectClient";
 import { ListCustomPluginsRequest, ListCustomPluginsResponse } from "../models/models_0";
 /**
+ * @public
+ *
  * The input for {@link ListCustomPluginsCommand}.
  */
 export interface ListCustomPluginsCommandInput extends ListCustomPluginsRequest {
 }
 /**
+ * @public
+ *
  * The output of {@link ListCustomPluginsCommand}.
  */
 export interface ListCustomPluginsCommandOutput extends ListCustomPluginsResponse, __MetadataBearer {
 }
 /**
+ * @public
  * <p>Returns a list of all of the custom plugins in this account and Region.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
@@ -25,6 +30,8 @@ export interface ListCustomPluginsCommandOutput extends ListCustomPluginsRespons
  * const response = await client.send(command);
  * ```
  *
+ * @param ListCustomPluginsCommandInput - {@link ListCustomPluginsCommandInput}
+ * @returns {@link ListCustomPluginsCommandOutput}
  * @see {@link ListCustomPluginsCommandInput} for command's `input` shape.
  * @see {@link ListCustomPluginsCommandOutput} for command's `response` shape.
  * @see {@link KafkaConnectClientResolvedConfig | config} for KafkaConnectClient's `config` shape.
@@ -61,11 +68,20 @@ export interface ListCustomPluginsCommandOutput extends ListCustomPluginsRespons
 export declare class ListCustomPluginsCommand extends $Command<ListCustomPluginsCommandInput, ListCustomPluginsCommandOutput, KafkaConnectClientResolvedConfig> {
     readonly input: ListCustomPluginsCommandInput;
     static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
     constructor(input: ListCustomPluginsCommandInput);
     /**
      * @internal
      */
     resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: KafkaConnectClientResolvedConfig, options?: __HttpHandlerOptions): Handler<ListCustomPluginsCommandInput, ListCustomPluginsCommandOutput>;
+    /**
+     * @internal
+     */
     private serialize;
+    /**
+     * @internal
+     */
     private deserialize;
 }

package/dist-types/commands/ListWorkerConfigurationsCommand.d.ts

@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
 import { KafkaConnectClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../KafkaConnectClient";
 import { ListWorkerConfigurationsRequest, ListWorkerConfigurationsResponse } from "../models/models_0";
 /**
+ * @public
+ *
  * The input for {@link ListWorkerConfigurationsCommand}.
  */
 export interface ListWorkerConfigurationsCommandInput extends ListWorkerConfigurationsRequest {
 }
 /**
+ * @public
+ *
  * The output of {@link ListWorkerConfigurationsCommand}.
  */
 export interface ListWorkerConfigurationsCommandOutput extends ListWorkerConfigurationsResponse, __MetadataBearer {
 }
 /**
+ * @public
  * <p>Returns a list of all of the worker configurations in this account and Region.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
@@ -25,6 +30,8 @@ export interface ListWorkerConfigurationsCommandOutput extends ListWorkerConfigu
  * const response = await client.send(command);
  * ```
  *
+ * @param ListWorkerConfigurationsCommandInput - {@link ListWorkerConfigurationsCommandInput}
+ * @returns {@link ListWorkerConfigurationsCommandOutput}
  * @see {@link ListWorkerConfigurationsCommandInput} for command's `input` shape.
  * @see {@link ListWorkerConfigurationsCommandOutput} for command's `response` shape.
  * @see {@link KafkaConnectClientResolvedConfig | config} for KafkaConnectClient's `config` shape.
@@ -61,11 +68,20 @@ export interface ListWorkerConfigurationsCommandOutput extends ListWorkerConfigu
 export declare class ListWorkerConfigurationsCommand extends $Command<ListWorkerConfigurationsCommandInput, ListWorkerConfigurationsCommandOutput, KafkaConnectClientResolvedConfig> {
     readonly input: ListWorkerConfigurationsCommandInput;
     static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
     constructor(input: ListWorkerConfigurationsCommandInput);
     /**
      * @internal
      */
     resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: KafkaConnectClientResolvedConfig, options?: __HttpHandlerOptions): Handler<ListWorkerConfigurationsCommandInput, ListWorkerConfigurationsCommandOutput>;
+    /**
+     * @internal
+     */
     private serialize;
+    /**
+     * @internal
+     */
     private deserialize;
 }

package/dist-types/commands/UpdateConnectorCommand.d.ts

@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
 import { KafkaConnectClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../KafkaConnectClient";
 import { UpdateConnectorRequest, UpdateConnectorResponse } from "../models/models_0";
 /**
+ * @public
+ *
  * The input for {@link UpdateConnectorCommand}.
  */
 export interface UpdateConnectorCommandInput extends UpdateConnectorRequest {
 }
 /**
+ * @public
+ *
  * The output of {@link UpdateConnectorCommand}.
  */
 export interface UpdateConnectorCommandOutput extends UpdateConnectorResponse, __MetadataBearer {
 }
 /**
+ * @public
  * <p>Updates the specified connector.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
@@ -25,6 +30,8 @@ export interface UpdateConnectorCommandOutput extends UpdateConnectorResponse, _
  * const response = await client.send(command);
  * ```
  *
+ * @param UpdateConnectorCommandInput - {@link UpdateConnectorCommandInput}
+ * @returns {@link UpdateConnectorCommandOutput}
  * @see {@link UpdateConnectorCommandInput} for command's `input` shape.
  * @see {@link UpdateConnectorCommandOutput} for command's `response` shape.
  * @see {@link KafkaConnectClientResolvedConfig | config} for KafkaConnectClient's `config` shape.
@@ -61,11 +68,20 @@ export interface UpdateConnectorCommandOutput extends UpdateConnectorResponse, _
 export declare class UpdateConnectorCommand extends $Command<UpdateConnectorCommandInput, UpdateConnectorCommandOutput, KafkaConnectClientResolvedConfig> {
     readonly input: UpdateConnectorCommandInput;
     static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
     constructor(input: UpdateConnectorCommandInput);
     /**
      * @internal
      */
     resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: KafkaConnectClientResolvedConfig, options?: __HttpHandlerOptions): Handler<UpdateConnectorCommandInput, UpdateConnectorCommandOutput>;
+    /**
+     * @internal
+     */
     private serialize;
+    /**
+     * @internal
+     */
     private deserialize;
 }

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

@@ -1,5 +1,7 @@
 import { ServiceException as __ServiceException, ServiceExceptionOptions as __ServiceExceptionOptions } from "@aws-sdk/smithy-client";
 /**
+ * @public
+ *
  * Base exception class for all service exceptions from KafkaConnect service.
  */
 export declare class KafkaConnectServiceException extends __ServiceException {