@aws-sdk/client-kafkaconnect 3.296.0 → 3.297.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -13,58 +13,68 @@ import { ListWorkerConfigurationsCommandInput, ListWorkerConfigurationsCommandOu
13
13
  import { UpdateConnectorCommandInput, UpdateConnectorCommandOutput } from "./commands/UpdateConnectorCommand";
14
14
  import { KafkaConnectClient } from "./KafkaConnectClient";
15
15
  /**
16
+ * @public
16
17
  * <p/>
17
18
  */
18
19
  export declare class KafkaConnect extends KafkaConnectClient {
19
20
  /**
21
+ * @public
20
22
  * <p>Creates a connector using the specified properties.</p>
21
23
  */
22
24
  createConnector(args: CreateConnectorCommandInput, options?: __HttpHandlerOptions): Promise<CreateConnectorCommandOutput>;
23
25
  createConnector(args: CreateConnectorCommandInput, cb: (err: any, data?: CreateConnectorCommandOutput) => void): void;
24
26
  createConnector(args: CreateConnectorCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateConnectorCommandOutput) => void): void;
25
27
  /**
28
+ * @public
26
29
  * <p>Creates a custom plugin using the specified properties.</p>
27
30
  */
28
31
  createCustomPlugin(args: CreateCustomPluginCommandInput, options?: __HttpHandlerOptions): Promise<CreateCustomPluginCommandOutput>;
29
32
  createCustomPlugin(args: CreateCustomPluginCommandInput, cb: (err: any, data?: CreateCustomPluginCommandOutput) => void): void;
30
33
  createCustomPlugin(args: CreateCustomPluginCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateCustomPluginCommandOutput) => void): void;
31
34
  /**
35
+ * @public
32
36
  * <p>Creates a worker configuration using the specified properties.</p>
33
37
  */
34
38
  createWorkerConfiguration(args: CreateWorkerConfigurationCommandInput, options?: __HttpHandlerOptions): Promise<CreateWorkerConfigurationCommandOutput>;
35
39
  createWorkerConfiguration(args: CreateWorkerConfigurationCommandInput, cb: (err: any, data?: CreateWorkerConfigurationCommandOutput) => void): void;
36
40
  createWorkerConfiguration(args: CreateWorkerConfigurationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateWorkerConfigurationCommandOutput) => void): void;
37
41
  /**
42
+ * @public
38
43
  * <p>Deletes the specified connector.</p>
39
44
  */
40
45
  deleteConnector(args: DeleteConnectorCommandInput, options?: __HttpHandlerOptions): Promise<DeleteConnectorCommandOutput>;
41
46
  deleteConnector(args: DeleteConnectorCommandInput, cb: (err: any, data?: DeleteConnectorCommandOutput) => void): void;
42
47
  deleteConnector(args: DeleteConnectorCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteConnectorCommandOutput) => void): void;
43
48
  /**
49
+ * @public
44
50
  * <p>Deletes a custom plugin.</p>
45
51
  */
46
52
  deleteCustomPlugin(args: DeleteCustomPluginCommandInput, options?: __HttpHandlerOptions): Promise<DeleteCustomPluginCommandOutput>;
47
53
  deleteCustomPlugin(args: DeleteCustomPluginCommandInput, cb: (err: any, data?: DeleteCustomPluginCommandOutput) => void): void;
48
54
  deleteCustomPlugin(args: DeleteCustomPluginCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteCustomPluginCommandOutput) => void): void;
49
55
  /**
56
+ * @public
50
57
  * <p>Returns summary information about the connector.</p>
51
58
  */
52
59
  describeConnector(args: DescribeConnectorCommandInput, options?: __HttpHandlerOptions): Promise<DescribeConnectorCommandOutput>;
53
60
  describeConnector(args: DescribeConnectorCommandInput, cb: (err: any, data?: DescribeConnectorCommandOutput) => void): void;
54
61
  describeConnector(args: DescribeConnectorCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeConnectorCommandOutput) => void): void;
55
62
  /**
63
+ * @public
56
64
  * <p>A summary description of the custom plugin.</p>
57
65
  */
58
66
  describeCustomPlugin(args: DescribeCustomPluginCommandInput, options?: __HttpHandlerOptions): Promise<DescribeCustomPluginCommandOutput>;
59
67
  describeCustomPlugin(args: DescribeCustomPluginCommandInput, cb: (err: any, data?: DescribeCustomPluginCommandOutput) => void): void;
60
68
  describeCustomPlugin(args: DescribeCustomPluginCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeCustomPluginCommandOutput) => void): void;
61
69
  /**
70
+ * @public
62
71
  * <p>Returns information about a worker configuration.</p>
63
72
  */
64
73
  describeWorkerConfiguration(args: DescribeWorkerConfigurationCommandInput, options?: __HttpHandlerOptions): Promise<DescribeWorkerConfigurationCommandOutput>;
65
74
  describeWorkerConfiguration(args: DescribeWorkerConfigurationCommandInput, cb: (err: any, data?: DescribeWorkerConfigurationCommandOutput) => void): void;
66
75
  describeWorkerConfiguration(args: DescribeWorkerConfigurationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeWorkerConfigurationCommandOutput) => void): void;
67
76
  /**
77
+ * @public
68
78
  * <p>Returns a list of all the connectors in this account and Region. The list is limited to
69
79
  * connectors whose name starts with the specified prefix. The response also includes a
70
80
  * description of each of the listed connectors.</p>
@@ -73,18 +83,21 @@ export declare class KafkaConnect extends KafkaConnectClient {
73
83
  listConnectors(args: ListConnectorsCommandInput, cb: (err: any, data?: ListConnectorsCommandOutput) => void): void;
74
84
  listConnectors(args: ListConnectorsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListConnectorsCommandOutput) => void): void;
75
85
  /**
86
+ * @public
76
87
  * <p>Returns a list of all of the custom plugins in this account and Region.</p>
77
88
  */
78
89
  listCustomPlugins(args: ListCustomPluginsCommandInput, options?: __HttpHandlerOptions): Promise<ListCustomPluginsCommandOutput>;
79
90
  listCustomPlugins(args: ListCustomPluginsCommandInput, cb: (err: any, data?: ListCustomPluginsCommandOutput) => void): void;
80
91
  listCustomPlugins(args: ListCustomPluginsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListCustomPluginsCommandOutput) => void): void;
81
92
  /**
93
+ * @public
82
94
  * <p>Returns a list of all of the worker configurations in this account and Region.</p>
83
95
  */
84
96
  listWorkerConfigurations(args: ListWorkerConfigurationsCommandInput, options?: __HttpHandlerOptions): Promise<ListWorkerConfigurationsCommandOutput>;
85
97
  listWorkerConfigurations(args: ListWorkerConfigurationsCommandInput, cb: (err: any, data?: ListWorkerConfigurationsCommandOutput) => void): void;
86
98
  listWorkerConfigurations(args: ListWorkerConfigurationsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListWorkerConfigurationsCommandOutput) => void): void;
87
99
  /**
100
+ * @public
88
101
  * <p>Updates the specified connector.</p>
89
102
  */
90
103
  updateConnector(args: UpdateConnectorCommandInput, options?: __HttpHandlerOptions): Promise<UpdateConnectorCommandOutput>;
@@ -20,15 +20,24 @@ import { ListCustomPluginsCommandInput, ListCustomPluginsCommandOutput } from ".
20
20
  import { ListWorkerConfigurationsCommandInput, ListWorkerConfigurationsCommandOutput } from "./commands/ListWorkerConfigurationsCommand";
21
21
  import { UpdateConnectorCommandInput, UpdateConnectorCommandOutput } from "./commands/UpdateConnectorCommand";
22
22
  import { ClientInputEndpointParameters, ClientResolvedEndpointParameters, EndpointParameters } from "./endpoint/EndpointParameters";
23
+ /**
24
+ * @public
25
+ */
23
26
  export type ServiceInputTypes = CreateConnectorCommandInput | CreateCustomPluginCommandInput | CreateWorkerConfigurationCommandInput | DeleteConnectorCommandInput | DeleteCustomPluginCommandInput | DescribeConnectorCommandInput | DescribeCustomPluginCommandInput | DescribeWorkerConfigurationCommandInput | ListConnectorsCommandInput | ListCustomPluginsCommandInput | ListWorkerConfigurationsCommandInput | UpdateConnectorCommandInput;
27
+ /**
28
+ * @public
29
+ */
24
30
  export type ServiceOutputTypes = CreateConnectorCommandOutput | CreateCustomPluginCommandOutput | CreateWorkerConfigurationCommandOutput | DeleteConnectorCommandOutput | DeleteCustomPluginCommandOutput | DescribeConnectorCommandOutput | DescribeCustomPluginCommandOutput | DescribeWorkerConfigurationCommandOutput | ListConnectorsCommandOutput | ListCustomPluginsCommandOutput | ListWorkerConfigurationsCommandOutput | UpdateConnectorCommandOutput;
31
+ /**
32
+ * @public
33
+ */
25
34
  export interface ClientDefaults extends Partial<__SmithyResolvedConfiguration<__HttpHandlerOptions>> {
26
35
  /**
27
36
  * The HTTP handler to use. Fetch in browser and Https in Nodejs.
28
37
  */
29
38
  requestHandler?: __HttpHandler;
30
39
  /**
31
- * A constructor for a class implementing the {@link __Checksum} interface
40
+ * A constructor for a class implementing the {@link @aws-sdk/types#ChecksumConstructor} interface
32
41
  * that computes the SHA-256 HMAC or checksum of a string or binary buffer.
33
42
  * @internal
34
43
  */
@@ -118,23 +127,34 @@ export interface ClientDefaults extends Partial<__SmithyResolvedConfiguration<__
118
127
  */
119
128
  logger?: __Logger;
120
129
  /**
121
- * The {@link __DefaultsMode} that will be used to determine how certain default configuration options are resolved in the SDK.
130
+ * The {@link @aws-sdk/smithy-client#DefaultsMode} that will be used to determine how certain default configuration options are resolved in the SDK.
122
131
  */
123
132
  defaultsMode?: __DefaultsMode | __Provider<__DefaultsMode>;
124
133
  }
134
+ /**
135
+ * @public
136
+ */
125
137
  type KafkaConnectClientConfigType = Partial<__SmithyConfiguration<__HttpHandlerOptions>> & ClientDefaults & RegionInputConfig & EndpointInputConfig<EndpointParameters> & RetryInputConfig & HostHeaderInputConfig & AwsAuthInputConfig & UserAgentInputConfig & ClientInputEndpointParameters;
126
138
  /**
127
- * The configuration interface of KafkaConnectClient class constructor that set the region, credentials and other options.
139
+ * @public
140
+ *
141
+ * The configuration interface of KafkaConnectClient class constructor that set the region, credentials and other options.
128
142
  */
129
143
  export interface KafkaConnectClientConfig extends KafkaConnectClientConfigType {
130
144
  }
145
+ /**
146
+ * @public
147
+ */
131
148
  type KafkaConnectClientResolvedConfigType = __SmithyResolvedConfiguration<__HttpHandlerOptions> & Required<ClientDefaults> & RegionResolvedConfig & EndpointResolvedConfig<EndpointParameters> & RetryResolvedConfig & HostHeaderResolvedConfig & AwsAuthResolvedConfig & UserAgentResolvedConfig & ClientResolvedEndpointParameters;
132
149
  /**
133
- * The resolved configuration interface of KafkaConnectClient class. This is resolved and normalized from the {@link KafkaConnectClientConfig | constructor configuration interface}.
150
+ * @public
151
+ *
152
+ * The resolved configuration interface of KafkaConnectClient class. This is resolved and normalized from the {@link KafkaConnectClientConfig | constructor configuration interface}.
134
153
  */
135
154
  export interface KafkaConnectClientResolvedConfig extends KafkaConnectClientResolvedConfigType {
136
155
  }
137
156
  /**
157
+ * @public
138
158
  * <p/>
139
159
  */
140
160
  export declare class KafkaConnectClient extends __Client<__HttpHandlerOptions, ServiceInputTypes, ServiceOutputTypes, KafkaConnectClientResolvedConfig> {
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { KafkaConnectClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../KafkaConnectClient";
5
5
  import { CreateConnectorRequest, CreateConnectorResponse } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link CreateConnectorCommand}.
8
10
  */
9
11
  export interface CreateConnectorCommandInput extends CreateConnectorRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link CreateConnectorCommand}.
13
17
  */
14
18
  export interface CreateConnectorCommandOutput extends CreateConnectorResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Creates a connector using the specified properties.</p>
18
23
  * @example
19
24
  * Use a bare-bones client and the command you need to make an API call.
@@ -25,6 +30,8 @@ export interface CreateConnectorCommandOutput extends CreateConnectorResponse, _
25
30
  * const response = await client.send(command);
26
31
  * ```
27
32
  *
33
+ * @param CreateConnectorCommandInput - {@link CreateConnectorCommandInput}
34
+ * @returns {@link CreateConnectorCommandOutput}
28
35
  * @see {@link CreateConnectorCommandInput} for command's `input` shape.
29
36
  * @see {@link CreateConnectorCommandOutput} for command's `response` shape.
30
37
  * @see {@link KafkaConnectClientResolvedConfig | config} for KafkaConnectClient's `config` shape.
@@ -65,11 +72,20 @@ export interface CreateConnectorCommandOutput extends CreateConnectorResponse, _
65
72
  export declare class CreateConnectorCommand extends $Command<CreateConnectorCommandInput, CreateConnectorCommandOutput, KafkaConnectClientResolvedConfig> {
66
73
  readonly input: CreateConnectorCommandInput;
67
74
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
75
+ /**
76
+ * @public
77
+ */
68
78
  constructor(input: CreateConnectorCommandInput);
69
79
  /**
70
80
  * @internal
71
81
  */
72
82
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: KafkaConnectClientResolvedConfig, options?: __HttpHandlerOptions): Handler<CreateConnectorCommandInput, CreateConnectorCommandOutput>;
83
+ /**
84
+ * @internal
85
+ */
73
86
  private serialize;
87
+ /**
88
+ * @internal
89
+ */
74
90
  private deserialize;
75
91
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { KafkaConnectClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../KafkaConnectClient";
5
5
  import { CreateCustomPluginRequest, CreateCustomPluginResponse } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link CreateCustomPluginCommand}.
8
10
  */
9
11
  export interface CreateCustomPluginCommandInput extends CreateCustomPluginRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link CreateCustomPluginCommand}.
13
17
  */
14
18
  export interface CreateCustomPluginCommandOutput extends CreateCustomPluginResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Creates a custom plugin using the specified properties.</p>
18
23
  * @example
19
24
  * Use a bare-bones client and the command you need to make an API call.
@@ -25,6 +30,8 @@ export interface CreateCustomPluginCommandOutput extends CreateCustomPluginRespo
25
30
  * const response = await client.send(command);
26
31
  * ```
27
32
  *
33
+ * @param CreateCustomPluginCommandInput - {@link CreateCustomPluginCommandInput}
34
+ * @returns {@link CreateCustomPluginCommandOutput}
28
35
  * @see {@link CreateCustomPluginCommandInput} for command's `input` shape.
29
36
  * @see {@link CreateCustomPluginCommandOutput} for command's `response` shape.
30
37
  * @see {@link KafkaConnectClientResolvedConfig | config} for KafkaConnectClient's `config` shape.
@@ -65,11 +72,20 @@ export interface CreateCustomPluginCommandOutput extends CreateCustomPluginRespo
65
72
  export declare class CreateCustomPluginCommand extends $Command<CreateCustomPluginCommandInput, CreateCustomPluginCommandOutput, KafkaConnectClientResolvedConfig> {
66
73
  readonly input: CreateCustomPluginCommandInput;
67
74
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
75
+ /**
76
+ * @public
77
+ */
68
78
  constructor(input: CreateCustomPluginCommandInput);
69
79
  /**
70
80
  * @internal
71
81
  */
72
82
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: KafkaConnectClientResolvedConfig, options?: __HttpHandlerOptions): Handler<CreateCustomPluginCommandInput, CreateCustomPluginCommandOutput>;
83
+ /**
84
+ * @internal
85
+ */
73
86
  private serialize;
87
+ /**
88
+ * @internal
89
+ */
74
90
  private deserialize;
75
91
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { KafkaConnectClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../KafkaConnectClient";
5
5
  import { CreateWorkerConfigurationRequest, CreateWorkerConfigurationResponse } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link CreateWorkerConfigurationCommand}.
8
10
  */
9
11
  export interface CreateWorkerConfigurationCommandInput extends CreateWorkerConfigurationRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link CreateWorkerConfigurationCommand}.
13
17
  */
14
18
  export interface CreateWorkerConfigurationCommandOutput extends CreateWorkerConfigurationResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Creates a worker configuration using the specified properties.</p>
18
23
  * @example
19
24
  * Use a bare-bones client and the command you need to make an API call.
@@ -25,6 +30,8 @@ export interface CreateWorkerConfigurationCommandOutput extends CreateWorkerConf
25
30
  * const response = await client.send(command);
26
31
  * ```
27
32
  *
33
+ * @param CreateWorkerConfigurationCommandInput - {@link CreateWorkerConfigurationCommandInput}
34
+ * @returns {@link CreateWorkerConfigurationCommandOutput}
28
35
  * @see {@link CreateWorkerConfigurationCommandInput} for command's `input` shape.
29
36
  * @see {@link CreateWorkerConfigurationCommandOutput} for command's `response` shape.
30
37
  * @see {@link KafkaConnectClientResolvedConfig | config} for KafkaConnectClient's `config` shape.
@@ -65,11 +72,20 @@ export interface CreateWorkerConfigurationCommandOutput extends CreateWorkerConf
65
72
  export declare class CreateWorkerConfigurationCommand extends $Command<CreateWorkerConfigurationCommandInput, CreateWorkerConfigurationCommandOutput, KafkaConnectClientResolvedConfig> {
66
73
  readonly input: CreateWorkerConfigurationCommandInput;
67
74
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
75
+ /**
76
+ * @public
77
+ */
68
78
  constructor(input: CreateWorkerConfigurationCommandInput);
69
79
  /**
70
80
  * @internal
71
81
  */
72
82
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: KafkaConnectClientResolvedConfig, options?: __HttpHandlerOptions): Handler<CreateWorkerConfigurationCommandInput, CreateWorkerConfigurationCommandOutput>;
83
+ /**
84
+ * @internal
85
+ */
73
86
  private serialize;
87
+ /**
88
+ * @internal
89
+ */
74
90
  private deserialize;
75
91
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { KafkaConnectClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../KafkaConnectClient";
5
5
  import { DeleteConnectorRequest, DeleteConnectorResponse } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link DeleteConnectorCommand}.
8
10
  */
9
11
  export interface DeleteConnectorCommandInput extends DeleteConnectorRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link DeleteConnectorCommand}.
13
17
  */
14
18
  export interface DeleteConnectorCommandOutput extends DeleteConnectorResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Deletes the specified connector.</p>
18
23
  * @example
19
24
  * Use a bare-bones client and the command you need to make an API call.
@@ -25,6 +30,8 @@ export interface DeleteConnectorCommandOutput extends DeleteConnectorResponse, _
25
30
  * const response = await client.send(command);
26
31
  * ```
27
32
  *
33
+ * @param DeleteConnectorCommandInput - {@link DeleteConnectorCommandInput}
34
+ * @returns {@link DeleteConnectorCommandOutput}
28
35
  * @see {@link DeleteConnectorCommandInput} for command's `input` shape.
29
36
  * @see {@link DeleteConnectorCommandOutput} for command's `response` shape.
30
37
  * @see {@link KafkaConnectClientResolvedConfig | config} for KafkaConnectClient's `config` shape.
@@ -61,11 +68,20 @@ export interface DeleteConnectorCommandOutput extends DeleteConnectorResponse, _
61
68
  export declare class DeleteConnectorCommand extends $Command<DeleteConnectorCommandInput, DeleteConnectorCommandOutput, KafkaConnectClientResolvedConfig> {
62
69
  readonly input: DeleteConnectorCommandInput;
63
70
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
71
+ /**
72
+ * @public
73
+ */
64
74
  constructor(input: DeleteConnectorCommandInput);
65
75
  /**
66
76
  * @internal
67
77
  */
68
78
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: KafkaConnectClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DeleteConnectorCommandInput, DeleteConnectorCommandOutput>;
79
+ /**
80
+ * @internal
81
+ */
69
82
  private serialize;
83
+ /**
84
+ * @internal
85
+ */
70
86
  private deserialize;
71
87
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { KafkaConnectClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../KafkaConnectClient";
5
5
  import { DeleteCustomPluginRequest, DeleteCustomPluginResponse } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link DeleteCustomPluginCommand}.
8
10
  */
9
11
  export interface DeleteCustomPluginCommandInput extends DeleteCustomPluginRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link DeleteCustomPluginCommand}.
13
17
  */
14
18
  export interface DeleteCustomPluginCommandOutput extends DeleteCustomPluginResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Deletes a custom plugin.</p>
18
23
  * @example
19
24
  * Use a bare-bones client and the command you need to make an API call.
@@ -25,6 +30,8 @@ export interface DeleteCustomPluginCommandOutput extends DeleteCustomPluginRespo
25
30
  * const response = await client.send(command);
26
31
  * ```
27
32
  *
33
+ * @param DeleteCustomPluginCommandInput - {@link DeleteCustomPluginCommandInput}
34
+ * @returns {@link DeleteCustomPluginCommandOutput}
28
35
  * @see {@link DeleteCustomPluginCommandInput} for command's `input` shape.
29
36
  * @see {@link DeleteCustomPluginCommandOutput} for command's `response` shape.
30
37
  * @see {@link KafkaConnectClientResolvedConfig | config} for KafkaConnectClient's `config` shape.
@@ -61,11 +68,20 @@ export interface DeleteCustomPluginCommandOutput extends DeleteCustomPluginRespo
61
68
  export declare class DeleteCustomPluginCommand extends $Command<DeleteCustomPluginCommandInput, DeleteCustomPluginCommandOutput, KafkaConnectClientResolvedConfig> {
62
69
  readonly input: DeleteCustomPluginCommandInput;
63
70
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
71
+ /**
72
+ * @public
73
+ */
64
74
  constructor(input: DeleteCustomPluginCommandInput);
65
75
  /**
66
76
  * @internal
67
77
  */
68
78
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: KafkaConnectClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DeleteCustomPluginCommandInput, DeleteCustomPluginCommandOutput>;
79
+ /**
80
+ * @internal
81
+ */
69
82
  private serialize;
83
+ /**
84
+ * @internal
85
+ */
70
86
  private deserialize;
71
87
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { KafkaConnectClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../KafkaConnectClient";
5
5
  import { DescribeConnectorRequest, DescribeConnectorResponse } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link DescribeConnectorCommand}.
8
10
  */
9
11
  export interface DescribeConnectorCommandInput extends DescribeConnectorRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link DescribeConnectorCommand}.
13
17
  */
14
18
  export interface DescribeConnectorCommandOutput extends DescribeConnectorResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Returns summary information about the connector.</p>
18
23
  * @example
19
24
  * Use a bare-bones client and the command you need to make an API call.
@@ -25,6 +30,8 @@ export interface DescribeConnectorCommandOutput extends DescribeConnectorRespons
25
30
  * const response = await client.send(command);
26
31
  * ```
27
32
  *
33
+ * @param DescribeConnectorCommandInput - {@link DescribeConnectorCommandInput}
34
+ * @returns {@link DescribeConnectorCommandOutput}
28
35
  * @see {@link DescribeConnectorCommandInput} for command's `input` shape.
29
36
  * @see {@link DescribeConnectorCommandOutput} for command's `response` shape.
30
37
  * @see {@link KafkaConnectClientResolvedConfig | config} for KafkaConnectClient's `config` shape.
@@ -61,11 +68,20 @@ export interface DescribeConnectorCommandOutput extends DescribeConnectorRespons
61
68
  export declare class DescribeConnectorCommand extends $Command<DescribeConnectorCommandInput, DescribeConnectorCommandOutput, KafkaConnectClientResolvedConfig> {
62
69
  readonly input: DescribeConnectorCommandInput;
63
70
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
71
+ /**
72
+ * @public
73
+ */
64
74
  constructor(input: DescribeConnectorCommandInput);
65
75
  /**
66
76
  * @internal
67
77
  */
68
78
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: KafkaConnectClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DescribeConnectorCommandInput, DescribeConnectorCommandOutput>;
79
+ /**
80
+ * @internal
81
+ */
69
82
  private serialize;
83
+ /**
84
+ * @internal
85
+ */
70
86
  private deserialize;
71
87
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { KafkaConnectClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../KafkaConnectClient";
5
5
  import { DescribeCustomPluginRequest, DescribeCustomPluginResponse } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link DescribeCustomPluginCommand}.
8
10
  */
9
11
  export interface DescribeCustomPluginCommandInput extends DescribeCustomPluginRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link DescribeCustomPluginCommand}.
13
17
  */
14
18
  export interface DescribeCustomPluginCommandOutput extends DescribeCustomPluginResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>A summary description of the custom plugin.</p>
18
23
  * @example
19
24
  * Use a bare-bones client and the command you need to make an API call.
@@ -25,6 +30,8 @@ export interface DescribeCustomPluginCommandOutput extends DescribeCustomPluginR
25
30
  * const response = await client.send(command);
26
31
  * ```
27
32
  *
33
+ * @param DescribeCustomPluginCommandInput - {@link DescribeCustomPluginCommandInput}
34
+ * @returns {@link DescribeCustomPluginCommandOutput}
28
35
  * @see {@link DescribeCustomPluginCommandInput} for command's `input` shape.
29
36
  * @see {@link DescribeCustomPluginCommandOutput} for command's `response` shape.
30
37
  * @see {@link KafkaConnectClientResolvedConfig | config} for KafkaConnectClient's `config` shape.
@@ -61,11 +68,20 @@ export interface DescribeCustomPluginCommandOutput extends DescribeCustomPluginR
61
68
  export declare class DescribeCustomPluginCommand extends $Command<DescribeCustomPluginCommandInput, DescribeCustomPluginCommandOutput, KafkaConnectClientResolvedConfig> {
62
69
  readonly input: DescribeCustomPluginCommandInput;
63
70
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
71
+ /**
72
+ * @public
73
+ */
64
74
  constructor(input: DescribeCustomPluginCommandInput);
65
75
  /**
66
76
  * @internal
67
77
  */
68
78
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: KafkaConnectClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DescribeCustomPluginCommandInput, DescribeCustomPluginCommandOutput>;
79
+ /**
80
+ * @internal
81
+ */
69
82
  private serialize;
83
+ /**
84
+ * @internal
85
+ */
70
86
  private deserialize;
71
87
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { KafkaConnectClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../KafkaConnectClient";
5
5
  import { DescribeWorkerConfigurationRequest, DescribeWorkerConfigurationResponse } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link DescribeWorkerConfigurationCommand}.
8
10
  */
9
11
  export interface DescribeWorkerConfigurationCommandInput extends DescribeWorkerConfigurationRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link DescribeWorkerConfigurationCommand}.
13
17
  */
14
18
  export interface DescribeWorkerConfigurationCommandOutput extends DescribeWorkerConfigurationResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Returns information about a worker configuration.</p>
18
23
  * @example
19
24
  * Use a bare-bones client and the command you need to make an API call.
@@ -25,6 +30,8 @@ export interface DescribeWorkerConfigurationCommandOutput extends DescribeWorker
25
30
  * const response = await client.send(command);
26
31
  * ```
27
32
  *
33
+ * @param DescribeWorkerConfigurationCommandInput - {@link DescribeWorkerConfigurationCommandInput}
34
+ * @returns {@link DescribeWorkerConfigurationCommandOutput}
28
35
  * @see {@link DescribeWorkerConfigurationCommandInput} for command's `input` shape.
29
36
  * @see {@link DescribeWorkerConfigurationCommandOutput} for command's `response` shape.
30
37
  * @see {@link KafkaConnectClientResolvedConfig | config} for KafkaConnectClient's `config` shape.
@@ -61,11 +68,20 @@ export interface DescribeWorkerConfigurationCommandOutput extends DescribeWorker
61
68
  export declare class DescribeWorkerConfigurationCommand extends $Command<DescribeWorkerConfigurationCommandInput, DescribeWorkerConfigurationCommandOutput, KafkaConnectClientResolvedConfig> {
62
69
  readonly input: DescribeWorkerConfigurationCommandInput;
63
70
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
71
+ /**
72
+ * @public
73
+ */
64
74
  constructor(input: DescribeWorkerConfigurationCommandInput);
65
75
  /**
66
76
  * @internal
67
77
  */
68
78
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: KafkaConnectClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DescribeWorkerConfigurationCommandInput, DescribeWorkerConfigurationCommandOutput>;
79
+ /**
80
+ * @internal
81
+ */
69
82
  private serialize;
83
+ /**
84
+ * @internal
85
+ */
70
86
  private deserialize;
71
87
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { KafkaConnectClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../KafkaConnectClient";
5
5
  import { ListConnectorsRequest, ListConnectorsResponse } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link ListConnectorsCommand}.
8
10
  */
9
11
  export interface ListConnectorsCommandInput extends ListConnectorsRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link ListConnectorsCommand}.
13
17
  */
14
18
  export interface ListConnectorsCommandOutput extends ListConnectorsResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Returns a list of all the connectors in this account and Region. The list is limited to
18
23
  * connectors whose name starts with the specified prefix. The response also includes a
19
24
  * description of each of the listed connectors.</p>
@@ -27,6 +32,8 @@ export interface ListConnectorsCommandOutput extends ListConnectorsResponse, __M
27
32
  * const response = await client.send(command);
28
33
  * ```
29
34
  *
35
+ * @param ListConnectorsCommandInput - {@link ListConnectorsCommandInput}
36
+ * @returns {@link ListConnectorsCommandOutput}
30
37
  * @see {@link ListConnectorsCommandInput} for command's `input` shape.
31
38
  * @see {@link ListConnectorsCommandOutput} for command's `response` shape.
32
39
  * @see {@link KafkaConnectClientResolvedConfig | config} for KafkaConnectClient's `config` shape.
@@ -63,11 +70,20 @@ export interface ListConnectorsCommandOutput extends ListConnectorsResponse, __M
63
70
  export declare class ListConnectorsCommand extends $Command<ListConnectorsCommandInput, ListConnectorsCommandOutput, KafkaConnectClientResolvedConfig> {
64
71
  readonly input: ListConnectorsCommandInput;
65
72
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
73
+ /**
74
+ * @public
75
+ */
66
76
  constructor(input: ListConnectorsCommandInput);
67
77
  /**
68
78
  * @internal
69
79
  */
70
80
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: KafkaConnectClientResolvedConfig, options?: __HttpHandlerOptions): Handler<ListConnectorsCommandInput, ListConnectorsCommandOutput>;
81
+ /**
82
+ * @internal
83
+ */
71
84
  private serialize;
85
+ /**
86
+ * @internal
87
+ */
72
88
  private deserialize;
73
89
  }