@aws-sdk/client-machine-learning 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.
Files changed (38) hide show
  1. package/dist-types/MachineLearning.d.ts +29 -0
  2. package/dist-types/MachineLearningClient.d.ts +24 -4
  3. package/dist-types/commands/AddTagsCommand.d.ts +16 -0
  4. package/dist-types/commands/CreateBatchPredictionCommand.d.ts +16 -0
  5. package/dist-types/commands/CreateDataSourceFromRDSCommand.d.ts +16 -0
  6. package/dist-types/commands/CreateDataSourceFromRedshiftCommand.d.ts +16 -0
  7. package/dist-types/commands/CreateDataSourceFromS3Command.d.ts +16 -0
  8. package/dist-types/commands/CreateEvaluationCommand.d.ts +16 -0
  9. package/dist-types/commands/CreateMLModelCommand.d.ts +16 -0
  10. package/dist-types/commands/CreateRealtimeEndpointCommand.d.ts +16 -0
  11. package/dist-types/commands/DeleteBatchPredictionCommand.d.ts +16 -0
  12. package/dist-types/commands/DeleteDataSourceCommand.d.ts +16 -0
  13. package/dist-types/commands/DeleteEvaluationCommand.d.ts +16 -0
  14. package/dist-types/commands/DeleteMLModelCommand.d.ts +16 -0
  15. package/dist-types/commands/DeleteRealtimeEndpointCommand.d.ts +16 -0
  16. package/dist-types/commands/DeleteTagsCommand.d.ts +16 -0
  17. package/dist-types/commands/DescribeBatchPredictionsCommand.d.ts +16 -0
  18. package/dist-types/commands/DescribeDataSourcesCommand.d.ts +16 -0
  19. package/dist-types/commands/DescribeEvaluationsCommand.d.ts +16 -0
  20. package/dist-types/commands/DescribeMLModelsCommand.d.ts +16 -0
  21. package/dist-types/commands/DescribeTagsCommand.d.ts +16 -0
  22. package/dist-types/commands/GetBatchPredictionCommand.d.ts +16 -0
  23. package/dist-types/commands/GetDataSourceCommand.d.ts +16 -0
  24. package/dist-types/commands/GetEvaluationCommand.d.ts +16 -0
  25. package/dist-types/commands/GetMLModelCommand.d.ts +16 -0
  26. package/dist-types/commands/PredictCommand.d.ts +16 -0
  27. package/dist-types/commands/UpdateBatchPredictionCommand.d.ts +16 -0
  28. package/dist-types/commands/UpdateDataSourceCommand.d.ts +16 -0
  29. package/dist-types/commands/UpdateEvaluationCommand.d.ts +16 -0
  30. package/dist-types/commands/UpdateMLModelCommand.d.ts +16 -0
  31. package/dist-types/models/MachineLearningServiceException.d.ts +2 -0
  32. package/dist-types/models/models_0.d.ts +206 -30
  33. package/dist-types/pagination/DescribeBatchPredictionsPaginator.d.ts +3 -0
  34. package/dist-types/pagination/DescribeDataSourcesPaginator.d.ts +3 -0
  35. package/dist-types/pagination/DescribeEvaluationsPaginator.d.ts +3 -0
  36. package/dist-types/pagination/DescribeMLModelsPaginator.d.ts +3 -0
  37. package/dist-types/pagination/Interfaces.d.ts +3 -0
  38. package/package.json +3 -3
@@ -29,11 +29,13 @@ import { UpdateEvaluationCommandInput, UpdateEvaluationCommandOutput } from "./c
29
29
  import { UpdateMLModelCommandInput, UpdateMLModelCommandOutput } from "./commands/UpdateMLModelCommand";
30
30
  import { MachineLearningClient } from "./MachineLearningClient";
31
31
  /**
32
+ * @public
32
33
  * Definition of the public APIs
33
34
  * exposed by Amazon Machine Learning
34
35
  */
35
36
  export declare class MachineLearning extends MachineLearningClient {
36
37
  /**
38
+ * @public
37
39
  * <p>Adds one or more tags to an object, up to a limit of 10. Each tag consists of a key
38
40
  * and an optional value. If you add a tag using a key that is already associated with the ML object,
39
41
  * <code>AddTags</code> updates the tag's value.</p>
@@ -42,6 +44,7 @@ export declare class MachineLearning extends MachineLearningClient {
42
44
  addTags(args: AddTagsCommandInput, cb: (err: any, data?: AddTagsCommandOutput) => void): void;
43
45
  addTags(args: AddTagsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: AddTagsCommandOutput) => void): void;
44
46
  /**
47
+ * @public
45
48
  * <p>Generates predictions for a group of observations. The observations to process exist in one or more data files referenced
46
49
  * by a <code>DataSource</code>. This operation creates a new <code>BatchPrediction</code>, and uses an <code>MLModel</code> and the data
47
50
  * files referenced by the <code>DataSource</code> as information sources.
@@ -59,6 +62,7 @@ export declare class MachineLearning extends MachineLearningClient {
59
62
  createBatchPrediction(args: CreateBatchPredictionCommandInput, cb: (err: any, data?: CreateBatchPredictionCommandOutput) => void): void;
60
63
  createBatchPrediction(args: CreateBatchPredictionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateBatchPredictionCommandOutput) => void): void;
61
64
  /**
65
+ * @public
62
66
  * <p>Creates a <code>DataSource</code> object from an <a href="http://aws.amazon.com/rds/"> Amazon Relational Database Service</a> (Amazon RDS). A <code>DataSource</code> references data that can be used to perform <code>CreateMLModel</code>, <code>CreateEvaluation</code>, or <code>CreateBatchPrediction</code> operations.</p>
63
67
  *
64
68
  * <p>
@@ -76,6 +80,7 @@ export declare class MachineLearning extends MachineLearningClient {
76
80
  createDataSourceFromRDS(args: CreateDataSourceFromRDSCommandInput, cb: (err: any, data?: CreateDataSourceFromRDSCommandOutput) => void): void;
77
81
  createDataSourceFromRDS(args: CreateDataSourceFromRDSCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateDataSourceFromRDSCommandOutput) => void): void;
78
82
  /**
83
+ * @public
79
84
  * <p>Creates a <code>DataSource</code> from a database hosted on an Amazon Redshift cluster. A
80
85
  * <code>DataSource</code> references data that can be used to perform either <code>CreateMLModel</code>, <code>CreateEvaluation</code>, or <code>CreateBatchPrediction</code>
81
86
  * operations.</p>
@@ -114,6 +119,7 @@ export declare class MachineLearning extends MachineLearningClient {
114
119
  createDataSourceFromRedshift(args: CreateDataSourceFromRedshiftCommandInput, cb: (err: any, data?: CreateDataSourceFromRedshiftCommandOutput) => void): void;
115
120
  createDataSourceFromRedshift(args: CreateDataSourceFromRedshiftCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateDataSourceFromRedshiftCommandOutput) => void): void;
116
121
  /**
122
+ * @public
117
123
  * <p>Creates a <code>DataSource</code> object. A <code>DataSource</code> references data that
118
124
  * can be used to perform <code>CreateMLModel</code>, <code>CreateEvaluation</code>, or
119
125
  * <code>CreateBatchPrediction</code> operations.</p>
@@ -150,6 +156,7 @@ export declare class MachineLearning extends MachineLearningClient {
150
156
  createDataSourceFromS3(args: CreateDataSourceFromS3CommandInput, cb: (err: any, data?: CreateDataSourceFromS3CommandOutput) => void): void;
151
157
  createDataSourceFromS3(args: CreateDataSourceFromS3CommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateDataSourceFromS3CommandOutput) => void): void;
152
158
  /**
159
+ * @public
153
160
  * <p>Creates a new <code>Evaluation</code> of an <code>MLModel</code>. An <code>MLModel</code> is evaluated on a set of observations associated to a <code>DataSource</code>. Like a <code>DataSource</code>
154
161
  * for an <code>MLModel</code>, the <code>DataSource</code> for an <code>Evaluation</code> contains values for the <code>Target Variable</code>. The <code>Evaluation</code> compares the predicted result for each observation to the actual outcome and provides a
155
162
  * summary so that you know how effective the <code>MLModel</code> functions on the test
@@ -167,6 +174,7 @@ export declare class MachineLearning extends MachineLearningClient {
167
174
  createEvaluation(args: CreateEvaluationCommandInput, cb: (err: any, data?: CreateEvaluationCommandOutput) => void): void;
168
175
  createEvaluation(args: CreateEvaluationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateEvaluationCommandOutput) => void): void;
169
176
  /**
177
+ * @public
170
178
  * <p>Creates a new <code>MLModel</code> using the <code>DataSource</code> and the recipe as
171
179
  * information sources. </p>
172
180
  * <p>An <code>MLModel</code> is nearly immutable. Users can update only the
@@ -192,12 +200,14 @@ export declare class MachineLearning extends MachineLearningClient {
192
200
  createMLModel(args: CreateMLModelCommandInput, cb: (err: any, data?: CreateMLModelCommandOutput) => void): void;
193
201
  createMLModel(args: CreateMLModelCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateMLModelCommandOutput) => void): void;
194
202
  /**
203
+ * @public
195
204
  * <p>Creates a real-time endpoint for the <code>MLModel</code>. The endpoint contains the URI of the <code>MLModel</code>; that is, the location to send real-time prediction requests for the specified <code>MLModel</code>.</p>
196
205
  */
197
206
  createRealtimeEndpoint(args: CreateRealtimeEndpointCommandInput, options?: __HttpHandlerOptions): Promise<CreateRealtimeEndpointCommandOutput>;
198
207
  createRealtimeEndpoint(args: CreateRealtimeEndpointCommandInput, cb: (err: any, data?: CreateRealtimeEndpointCommandOutput) => void): void;
199
208
  createRealtimeEndpoint(args: CreateRealtimeEndpointCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateRealtimeEndpointCommandOutput) => void): void;
200
209
  /**
210
+ * @public
201
211
  * <p>Assigns the DELETED status to a <code>BatchPrediction</code>, rendering it unusable.</p>
202
212
  * <p>After using the <code>DeleteBatchPrediction</code> operation, you can use the <a>GetBatchPrediction</a>
203
213
  * operation to verify that the status of the <code>BatchPrediction</code> changed to DELETED.</p>
@@ -209,6 +219,7 @@ export declare class MachineLearning extends MachineLearningClient {
209
219
  deleteBatchPrediction(args: DeleteBatchPredictionCommandInput, cb: (err: any, data?: DeleteBatchPredictionCommandOutput) => void): void;
210
220
  deleteBatchPrediction(args: DeleteBatchPredictionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteBatchPredictionCommandOutput) => void): void;
211
221
  /**
222
+ * @public
212
223
  * <p>Assigns the DELETED status to a <code>DataSource</code>, rendering it unusable.</p>
213
224
  * <p>After using the <code>DeleteDataSource</code> operation, you can use the <a>GetDataSource</a> operation to verify that the status of the <code>DataSource</code> changed to DELETED.</p>
214
225
  * <p>
@@ -218,6 +229,7 @@ export declare class MachineLearning extends MachineLearningClient {
218
229
  deleteDataSource(args: DeleteDataSourceCommandInput, cb: (err: any, data?: DeleteDataSourceCommandOutput) => void): void;
219
230
  deleteDataSource(args: DeleteDataSourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteDataSourceCommandOutput) => void): void;
220
231
  /**
232
+ * @public
221
233
  * <p>Assigns the <code>DELETED</code> status to an <code>Evaluation</code>, rendering it unusable.</p>
222
234
  *
223
235
  * <p>After invoking the <code>DeleteEvaluation</code> operation, you can use the
@@ -229,6 +241,7 @@ export declare class MachineLearning extends MachineLearningClient {
229
241
  deleteEvaluation(args: DeleteEvaluationCommandInput, cb: (err: any, data?: DeleteEvaluationCommandOutput) => void): void;
230
242
  deleteEvaluation(args: DeleteEvaluationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteEvaluationCommandOutput) => void): void;
231
243
  /**
244
+ * @public
232
245
  * <p>Assigns the <code>DELETED</code> status to an <code>MLModel</code>, rendering it unusable.</p>
233
246
  * <p>After using the <code>DeleteMLModel</code> operation, you can use the
234
247
  * <code>GetMLModel</code> operation to verify that the status of the <code>MLModel</code> changed to DELETED.</p>
@@ -240,12 +253,14 @@ export declare class MachineLearning extends MachineLearningClient {
240
253
  deleteMLModel(args: DeleteMLModelCommandInput, cb: (err: any, data?: DeleteMLModelCommandOutput) => void): void;
241
254
  deleteMLModel(args: DeleteMLModelCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteMLModelCommandOutput) => void): void;
242
255
  /**
256
+ * @public
243
257
  * <p>Deletes a real time endpoint of an <code>MLModel</code>.</p>
244
258
  */
245
259
  deleteRealtimeEndpoint(args: DeleteRealtimeEndpointCommandInput, options?: __HttpHandlerOptions): Promise<DeleteRealtimeEndpointCommandOutput>;
246
260
  deleteRealtimeEndpoint(args: DeleteRealtimeEndpointCommandInput, cb: (err: any, data?: DeleteRealtimeEndpointCommandOutput) => void): void;
247
261
  deleteRealtimeEndpoint(args: DeleteRealtimeEndpointCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteRealtimeEndpointCommandOutput) => void): void;
248
262
  /**
263
+ * @public
249
264
  * <p>Deletes the specified tags associated with an ML object. After this operation is complete, you can't recover deleted tags.</p>
250
265
  * <p>If you specify a tag that doesn't exist, Amazon ML ignores it.</p>
251
266
  */
@@ -253,36 +268,42 @@ export declare class MachineLearning extends MachineLearningClient {
253
268
  deleteTags(args: DeleteTagsCommandInput, cb: (err: any, data?: DeleteTagsCommandOutput) => void): void;
254
269
  deleteTags(args: DeleteTagsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteTagsCommandOutput) => void): void;
255
270
  /**
271
+ * @public
256
272
  * <p>Returns a list of <code>BatchPrediction</code> operations that match the search criteria in the request.</p>
257
273
  */
258
274
  describeBatchPredictions(args: DescribeBatchPredictionsCommandInput, options?: __HttpHandlerOptions): Promise<DescribeBatchPredictionsCommandOutput>;
259
275
  describeBatchPredictions(args: DescribeBatchPredictionsCommandInput, cb: (err: any, data?: DescribeBatchPredictionsCommandOutput) => void): void;
260
276
  describeBatchPredictions(args: DescribeBatchPredictionsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeBatchPredictionsCommandOutput) => void): void;
261
277
  /**
278
+ * @public
262
279
  * <p>Returns a list of <code>DataSource</code> that match the search criteria in the request.</p>
263
280
  */
264
281
  describeDataSources(args: DescribeDataSourcesCommandInput, options?: __HttpHandlerOptions): Promise<DescribeDataSourcesCommandOutput>;
265
282
  describeDataSources(args: DescribeDataSourcesCommandInput, cb: (err: any, data?: DescribeDataSourcesCommandOutput) => void): void;
266
283
  describeDataSources(args: DescribeDataSourcesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeDataSourcesCommandOutput) => void): void;
267
284
  /**
285
+ * @public
268
286
  * <p>Returns a list of <code>DescribeEvaluations</code> that match the search criteria in the request.</p>
269
287
  */
270
288
  describeEvaluations(args: DescribeEvaluationsCommandInput, options?: __HttpHandlerOptions): Promise<DescribeEvaluationsCommandOutput>;
271
289
  describeEvaluations(args: DescribeEvaluationsCommandInput, cb: (err: any, data?: DescribeEvaluationsCommandOutput) => void): void;
272
290
  describeEvaluations(args: DescribeEvaluationsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeEvaluationsCommandOutput) => void): void;
273
291
  /**
292
+ * @public
274
293
  * <p>Returns a list of <code>MLModel</code> that match the search criteria in the request.</p>
275
294
  */
276
295
  describeMLModels(args: DescribeMLModelsCommandInput, options?: __HttpHandlerOptions): Promise<DescribeMLModelsCommandOutput>;
277
296
  describeMLModels(args: DescribeMLModelsCommandInput, cb: (err: any, data?: DescribeMLModelsCommandOutput) => void): void;
278
297
  describeMLModels(args: DescribeMLModelsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeMLModelsCommandOutput) => void): void;
279
298
  /**
299
+ * @public
280
300
  * <p>Describes one or more of the tags for your Amazon ML object.</p>
281
301
  */
282
302
  describeTags(args: DescribeTagsCommandInput, options?: __HttpHandlerOptions): Promise<DescribeTagsCommandOutput>;
283
303
  describeTags(args: DescribeTagsCommandInput, cb: (err: any, data?: DescribeTagsCommandOutput) => void): void;
284
304
  describeTags(args: DescribeTagsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeTagsCommandOutput) => void): void;
285
305
  /**
306
+ * @public
286
307
  * <p>Returns a <code>BatchPrediction</code> that includes detailed metadata, status, and data file information for a
287
308
  * <code>Batch Prediction</code> request.</p>
288
309
  */
@@ -290,6 +311,7 @@ export declare class MachineLearning extends MachineLearningClient {
290
311
  getBatchPrediction(args: GetBatchPredictionCommandInput, cb: (err: any, data?: GetBatchPredictionCommandOutput) => void): void;
291
312
  getBatchPrediction(args: GetBatchPredictionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetBatchPredictionCommandOutput) => void): void;
292
313
  /**
314
+ * @public
293
315
  * <p>Returns a <code>DataSource</code> that includes metadata and data file information, as well as the current status of the <code>DataSource</code>.</p>
294
316
  * <p>
295
317
  * <code>GetDataSource</code> provides results in normal or verbose format. The verbose format
@@ -299,12 +321,14 @@ export declare class MachineLearning extends MachineLearningClient {
299
321
  getDataSource(args: GetDataSourceCommandInput, cb: (err: any, data?: GetDataSourceCommandOutput) => void): void;
300
322
  getDataSource(args: GetDataSourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetDataSourceCommandOutput) => void): void;
301
323
  /**
324
+ * @public
302
325
  * <p>Returns an <code>Evaluation</code> that includes metadata as well as the current status of the <code>Evaluation</code>.</p>
303
326
  */
304
327
  getEvaluation(args: GetEvaluationCommandInput, options?: __HttpHandlerOptions): Promise<GetEvaluationCommandOutput>;
305
328
  getEvaluation(args: GetEvaluationCommandInput, cb: (err: any, data?: GetEvaluationCommandOutput) => void): void;
306
329
  getEvaluation(args: GetEvaluationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetEvaluationCommandOutput) => void): void;
307
330
  /**
331
+ * @public
308
332
  * <p>Returns an <code>MLModel</code> that includes detailed metadata, data source information, and the current status of the <code>MLModel</code>.</p>
309
333
  * <p>
310
334
  * <code>GetMLModel</code> provides results in normal or verbose format. </p>
@@ -313,6 +337,7 @@ export declare class MachineLearning extends MachineLearningClient {
313
337
  getMLModel(args: GetMLModelCommandInput, cb: (err: any, data?: GetMLModelCommandOutput) => void): void;
314
338
  getMLModel(args: GetMLModelCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetMLModelCommandOutput) => void): void;
315
339
  /**
340
+ * @public
316
341
  * <p>Generates a prediction for the observation using the specified <code>ML Model</code>.</p>
317
342
  * <p>
318
343
  * <b>Note:</b> Not all response parameters will be populated. Whether a
@@ -322,6 +347,7 @@ export declare class MachineLearning extends MachineLearningClient {
322
347
  predict(args: PredictCommandInput, cb: (err: any, data?: PredictCommandOutput) => void): void;
323
348
  predict(args: PredictCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PredictCommandOutput) => void): void;
324
349
  /**
350
+ * @public
325
351
  * <p>Updates the <code>BatchPredictionName</code> of a <code>BatchPrediction</code>.</p>
326
352
  * <p>You can use the <code>GetBatchPrediction</code> operation to view the contents of the updated data element.</p>
327
353
  */
@@ -329,6 +355,7 @@ export declare class MachineLearning extends MachineLearningClient {
329
355
  updateBatchPrediction(args: UpdateBatchPredictionCommandInput, cb: (err: any, data?: UpdateBatchPredictionCommandOutput) => void): void;
330
356
  updateBatchPrediction(args: UpdateBatchPredictionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateBatchPredictionCommandOutput) => void): void;
331
357
  /**
358
+ * @public
332
359
  * <p>Updates the <code>DataSourceName</code> of a <code>DataSource</code>.</p>
333
360
  * <p>You can use the <code>GetDataSource</code> operation to view the contents of the updated data element.</p>
334
361
  */
@@ -336,6 +363,7 @@ export declare class MachineLearning extends MachineLearningClient {
336
363
  updateDataSource(args: UpdateDataSourceCommandInput, cb: (err: any, data?: UpdateDataSourceCommandOutput) => void): void;
337
364
  updateDataSource(args: UpdateDataSourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateDataSourceCommandOutput) => void): void;
338
365
  /**
366
+ * @public
339
367
  * <p>Updates the <code>EvaluationName</code> of an <code>Evaluation</code>.</p>
340
368
  * <p>You can use the <code>GetEvaluation</code> operation to view the contents of the updated data element.</p>
341
369
  */
@@ -343,6 +371,7 @@ export declare class MachineLearning extends MachineLearningClient {
343
371
  updateEvaluation(args: UpdateEvaluationCommandInput, cb: (err: any, data?: UpdateEvaluationCommandOutput) => void): void;
344
372
  updateEvaluation(args: UpdateEvaluationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateEvaluationCommandOutput) => void): void;
345
373
  /**
374
+ * @public
346
375
  * <p>Updates the <code>MLModelName</code> and the <code>ScoreThreshold</code> of an <code>MLModel</code>.</p>
347
376
  * <p>You can use the <code>GetMLModel</code> operation to view the contents of the updated data element.</p>
348
377
  */
@@ -36,15 +36,24 @@ import { UpdateDataSourceCommandInput, UpdateDataSourceCommandOutput } from "./c
36
36
  import { UpdateEvaluationCommandInput, UpdateEvaluationCommandOutput } from "./commands/UpdateEvaluationCommand";
37
37
  import { UpdateMLModelCommandInput, UpdateMLModelCommandOutput } from "./commands/UpdateMLModelCommand";
38
38
  import { ClientInputEndpointParameters, ClientResolvedEndpointParameters, EndpointParameters } from "./endpoint/EndpointParameters";
39
+ /**
40
+ * @public
41
+ */
39
42
  export type ServiceInputTypes = AddTagsCommandInput | CreateBatchPredictionCommandInput | CreateDataSourceFromRDSCommandInput | CreateDataSourceFromRedshiftCommandInput | CreateDataSourceFromS3CommandInput | CreateEvaluationCommandInput | CreateMLModelCommandInput | CreateRealtimeEndpointCommandInput | DeleteBatchPredictionCommandInput | DeleteDataSourceCommandInput | DeleteEvaluationCommandInput | DeleteMLModelCommandInput | DeleteRealtimeEndpointCommandInput | DeleteTagsCommandInput | DescribeBatchPredictionsCommandInput | DescribeDataSourcesCommandInput | DescribeEvaluationsCommandInput | DescribeMLModelsCommandInput | DescribeTagsCommandInput | GetBatchPredictionCommandInput | GetDataSourceCommandInput | GetEvaluationCommandInput | GetMLModelCommandInput | PredictCommandInput | UpdateBatchPredictionCommandInput | UpdateDataSourceCommandInput | UpdateEvaluationCommandInput | UpdateMLModelCommandInput;
43
+ /**
44
+ * @public
45
+ */
40
46
  export type ServiceOutputTypes = AddTagsCommandOutput | CreateBatchPredictionCommandOutput | CreateDataSourceFromRDSCommandOutput | CreateDataSourceFromRedshiftCommandOutput | CreateDataSourceFromS3CommandOutput | CreateEvaluationCommandOutput | CreateMLModelCommandOutput | CreateRealtimeEndpointCommandOutput | DeleteBatchPredictionCommandOutput | DeleteDataSourceCommandOutput | DeleteEvaluationCommandOutput | DeleteMLModelCommandOutput | DeleteRealtimeEndpointCommandOutput | DeleteTagsCommandOutput | DescribeBatchPredictionsCommandOutput | DescribeDataSourcesCommandOutput | DescribeEvaluationsCommandOutput | DescribeMLModelsCommandOutput | DescribeTagsCommandOutput | GetBatchPredictionCommandOutput | GetDataSourceCommandOutput | GetEvaluationCommandOutput | GetMLModelCommandOutput | PredictCommandOutput | UpdateBatchPredictionCommandOutput | UpdateDataSourceCommandOutput | UpdateEvaluationCommandOutput | UpdateMLModelCommandOutput;
47
+ /**
48
+ * @public
49
+ */
41
50
  export interface ClientDefaults extends Partial<__SmithyResolvedConfiguration<__HttpHandlerOptions>> {
42
51
  /**
43
52
  * The HTTP handler to use. Fetch in browser and Https in Nodejs.
44
53
  */
45
54
  requestHandler?: __HttpHandler;
46
55
  /**
47
- * A constructor for a class implementing the {@link __Checksum} interface
56
+ * A constructor for a class implementing the {@link @aws-sdk/types#ChecksumConstructor} interface
48
57
  * that computes the SHA-256 HMAC or checksum of a string or binary buffer.
49
58
  * @internal
50
59
  */
@@ -134,23 +143,34 @@ export interface ClientDefaults extends Partial<__SmithyResolvedConfiguration<__
134
143
  */
135
144
  logger?: __Logger;
136
145
  /**
137
- * The {@link __DefaultsMode} that will be used to determine how certain default configuration options are resolved in the SDK.
146
+ * The {@link @aws-sdk/smithy-client#DefaultsMode} that will be used to determine how certain default configuration options are resolved in the SDK.
138
147
  */
139
148
  defaultsMode?: __DefaultsMode | __Provider<__DefaultsMode>;
140
149
  }
150
+ /**
151
+ * @public
152
+ */
141
153
  type MachineLearningClientConfigType = Partial<__SmithyConfiguration<__HttpHandlerOptions>> & ClientDefaults & RegionInputConfig & EndpointInputConfig<EndpointParameters> & RetryInputConfig & HostHeaderInputConfig & AwsAuthInputConfig & UserAgentInputConfig & ClientInputEndpointParameters;
142
154
  /**
143
- * The configuration interface of MachineLearningClient class constructor that set the region, credentials and other options.
155
+ * @public
156
+ *
157
+ * The configuration interface of MachineLearningClient class constructor that set the region, credentials and other options.
144
158
  */
145
159
  export interface MachineLearningClientConfig extends MachineLearningClientConfigType {
146
160
  }
161
+ /**
162
+ * @public
163
+ */
147
164
  type MachineLearningClientResolvedConfigType = __SmithyResolvedConfiguration<__HttpHandlerOptions> & Required<ClientDefaults> & RegionResolvedConfig & EndpointResolvedConfig<EndpointParameters> & RetryResolvedConfig & HostHeaderResolvedConfig & AwsAuthResolvedConfig & UserAgentResolvedConfig & ClientResolvedEndpointParameters;
148
165
  /**
149
- * The resolved configuration interface of MachineLearningClient class. This is resolved and normalized from the {@link MachineLearningClientConfig | constructor configuration interface}.
166
+ * @public
167
+ *
168
+ * The resolved configuration interface of MachineLearningClient class. This is resolved and normalized from the {@link MachineLearningClientConfig | constructor configuration interface}.
150
169
  */
151
170
  export interface MachineLearningClientResolvedConfig extends MachineLearningClientResolvedConfigType {
152
171
  }
153
172
  /**
173
+ * @public
154
174
  * Definition of the public APIs
155
175
  * exposed by Amazon Machine Learning
156
176
  */
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { MachineLearningClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../MachineLearningClient";
5
5
  import { AddTagsInput, AddTagsOutput } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link AddTagsCommand}.
8
10
  */
9
11
  export interface AddTagsCommandInput extends AddTagsInput {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link AddTagsCommand}.
13
17
  */
14
18
  export interface AddTagsCommandOutput extends AddTagsOutput, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Adds one or more tags to an object, up to a limit of 10. Each tag consists of a key
18
23
  * and an optional value. If you add a tag using a key that is already associated with the ML object,
19
24
  * <code>AddTags</code> updates the tag's value.</p>
@@ -27,6 +32,8 @@ export interface AddTagsCommandOutput extends AddTagsOutput, __MetadataBearer {
27
32
  * const response = await client.send(command);
28
33
  * ```
29
34
  *
35
+ * @param AddTagsCommandInput - {@link AddTagsCommandInput}
36
+ * @returns {@link AddTagsCommandOutput}
30
37
  * @see {@link AddTagsCommandInput} for command's `input` shape.
31
38
  * @see {@link AddTagsCommandOutput} for command's `response` shape.
32
39
  * @see {@link MachineLearningClientResolvedConfig | config} for MachineLearningClient's `config` shape.
@@ -49,11 +56,20 @@ export interface AddTagsCommandOutput extends AddTagsOutput, __MetadataBearer {
49
56
  export declare class AddTagsCommand extends $Command<AddTagsCommandInput, AddTagsCommandOutput, MachineLearningClientResolvedConfig> {
50
57
  readonly input: AddTagsCommandInput;
51
58
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
59
+ /**
60
+ * @public
61
+ */
52
62
  constructor(input: AddTagsCommandInput);
53
63
  /**
54
64
  * @internal
55
65
  */
56
66
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: MachineLearningClientResolvedConfig, options?: __HttpHandlerOptions): Handler<AddTagsCommandInput, AddTagsCommandOutput>;
67
+ /**
68
+ * @internal
69
+ */
57
70
  private serialize;
71
+ /**
72
+ * @internal
73
+ */
58
74
  private deserialize;
59
75
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { MachineLearningClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../MachineLearningClient";
5
5
  import { CreateBatchPredictionInput, CreateBatchPredictionOutput } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link CreateBatchPredictionCommand}.
8
10
  */
9
11
  export interface CreateBatchPredictionCommandInput extends CreateBatchPredictionInput {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link CreateBatchPredictionCommand}.
13
17
  */
14
18
  export interface CreateBatchPredictionCommandOutput extends CreateBatchPredictionOutput, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Generates predictions for a group of observations. The observations to process exist in one or more data files referenced
18
23
  * by a <code>DataSource</code>. This operation creates a new <code>BatchPrediction</code>, and uses an <code>MLModel</code> and the data
19
24
  * files referenced by the <code>DataSource</code> as information sources.
@@ -36,6 +41,8 @@ export interface CreateBatchPredictionCommandOutput extends CreateBatchPredictio
36
41
  * const response = await client.send(command);
37
42
  * ```
38
43
  *
44
+ * @param CreateBatchPredictionCommandInput - {@link CreateBatchPredictionCommandInput}
45
+ * @returns {@link CreateBatchPredictionCommandOutput}
39
46
  * @see {@link CreateBatchPredictionCommandInput} for command's `input` shape.
40
47
  * @see {@link CreateBatchPredictionCommandOutput} for command's `response` shape.
41
48
  * @see {@link MachineLearningClientResolvedConfig | config} for MachineLearningClient's `config` shape.
@@ -54,11 +61,20 @@ export interface CreateBatchPredictionCommandOutput extends CreateBatchPredictio
54
61
  export declare class CreateBatchPredictionCommand extends $Command<CreateBatchPredictionCommandInput, CreateBatchPredictionCommandOutput, MachineLearningClientResolvedConfig> {
55
62
  readonly input: CreateBatchPredictionCommandInput;
56
63
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
64
+ /**
65
+ * @public
66
+ */
57
67
  constructor(input: CreateBatchPredictionCommandInput);
58
68
  /**
59
69
  * @internal
60
70
  */
61
71
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: MachineLearningClientResolvedConfig, options?: __HttpHandlerOptions): Handler<CreateBatchPredictionCommandInput, CreateBatchPredictionCommandOutput>;
72
+ /**
73
+ * @internal
74
+ */
62
75
  private serialize;
76
+ /**
77
+ * @internal
78
+ */
63
79
  private deserialize;
64
80
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { MachineLearningClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../MachineLearningClient";
5
5
  import { CreateDataSourceFromRDSInput, CreateDataSourceFromRDSOutput } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link CreateDataSourceFromRDSCommand}.
8
10
  */
9
11
  export interface CreateDataSourceFromRDSCommandInput extends CreateDataSourceFromRDSInput {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link CreateDataSourceFromRDSCommand}.
13
17
  */
14
18
  export interface CreateDataSourceFromRDSCommandOutput extends CreateDataSourceFromRDSOutput, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Creates a <code>DataSource</code> object from an <a href="http://aws.amazon.com/rds/"> Amazon Relational Database Service</a> (Amazon RDS). A <code>DataSource</code> references data that can be used to perform <code>CreateMLModel</code>, <code>CreateEvaluation</code>, or <code>CreateBatchPrediction</code> operations.</p>
18
23
  *
19
24
  * <p>
@@ -36,6 +41,8 @@ export interface CreateDataSourceFromRDSCommandOutput extends CreateDataSourceFr
36
41
  * const response = await client.send(command);
37
42
  * ```
38
43
  *
44
+ * @param CreateDataSourceFromRDSCommandInput - {@link CreateDataSourceFromRDSCommandInput}
45
+ * @returns {@link CreateDataSourceFromRDSCommandOutput}
39
46
  * @see {@link CreateDataSourceFromRDSCommandInput} for command's `input` shape.
40
47
  * @see {@link CreateDataSourceFromRDSCommandOutput} for command's `response` shape.
41
48
  * @see {@link MachineLearningClientResolvedConfig | config} for MachineLearningClient's `config` shape.
@@ -54,11 +61,20 @@ export interface CreateDataSourceFromRDSCommandOutput extends CreateDataSourceFr
54
61
  export declare class CreateDataSourceFromRDSCommand extends $Command<CreateDataSourceFromRDSCommandInput, CreateDataSourceFromRDSCommandOutput, MachineLearningClientResolvedConfig> {
55
62
  readonly input: CreateDataSourceFromRDSCommandInput;
56
63
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
64
+ /**
65
+ * @public
66
+ */
57
67
  constructor(input: CreateDataSourceFromRDSCommandInput);
58
68
  /**
59
69
  * @internal
60
70
  */
61
71
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: MachineLearningClientResolvedConfig, options?: __HttpHandlerOptions): Handler<CreateDataSourceFromRDSCommandInput, CreateDataSourceFromRDSCommandOutput>;
72
+ /**
73
+ * @internal
74
+ */
62
75
  private serialize;
76
+ /**
77
+ * @internal
78
+ */
63
79
  private deserialize;
64
80
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { MachineLearningClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../MachineLearningClient";
5
5
  import { CreateDataSourceFromRedshiftInput, CreateDataSourceFromRedshiftOutput } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link CreateDataSourceFromRedshiftCommand}.
8
10
  */
9
11
  export interface CreateDataSourceFromRedshiftCommandInput extends CreateDataSourceFromRedshiftInput {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link CreateDataSourceFromRedshiftCommand}.
13
17
  */
14
18
  export interface CreateDataSourceFromRedshiftCommandOutput extends CreateDataSourceFromRedshiftOutput, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Creates a <code>DataSource</code> from a database hosted on an Amazon Redshift cluster. A
18
23
  * <code>DataSource</code> references data that can be used to perform either <code>CreateMLModel</code>, <code>CreateEvaluation</code>, or <code>CreateBatchPrediction</code>
19
24
  * operations.</p>
@@ -57,6 +62,8 @@ export interface CreateDataSourceFromRedshiftCommandOutput extends CreateDataSou
57
62
  * const response = await client.send(command);
58
63
  * ```
59
64
  *
65
+ * @param CreateDataSourceFromRedshiftCommandInput - {@link CreateDataSourceFromRedshiftCommandInput}
66
+ * @returns {@link CreateDataSourceFromRedshiftCommandOutput}
60
67
  * @see {@link CreateDataSourceFromRedshiftCommandInput} for command's `input` shape.
61
68
  * @see {@link CreateDataSourceFromRedshiftCommandOutput} for command's `response` shape.
62
69
  * @see {@link MachineLearningClientResolvedConfig | config} for MachineLearningClient's `config` shape.
@@ -75,11 +82,20 @@ export interface CreateDataSourceFromRedshiftCommandOutput extends CreateDataSou
75
82
  export declare class CreateDataSourceFromRedshiftCommand extends $Command<CreateDataSourceFromRedshiftCommandInput, CreateDataSourceFromRedshiftCommandOutput, MachineLearningClientResolvedConfig> {
76
83
  readonly input: CreateDataSourceFromRedshiftCommandInput;
77
84
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
85
+ /**
86
+ * @public
87
+ */
78
88
  constructor(input: CreateDataSourceFromRedshiftCommandInput);
79
89
  /**
80
90
  * @internal
81
91
  */
82
92
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: MachineLearningClientResolvedConfig, options?: __HttpHandlerOptions): Handler<CreateDataSourceFromRedshiftCommandInput, CreateDataSourceFromRedshiftCommandOutput>;
93
+ /**
94
+ * @internal
95
+ */
83
96
  private serialize;
97
+ /**
98
+ * @internal
99
+ */
84
100
  private deserialize;
85
101
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { MachineLearningClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../MachineLearningClient";
5
5
  import { CreateDataSourceFromS3Input, CreateDataSourceFromS3Output } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link CreateDataSourceFromS3Command}.
8
10
  */
9
11
  export interface CreateDataSourceFromS3CommandInput extends CreateDataSourceFromS3Input {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link CreateDataSourceFromS3Command}.
13
17
  */
14
18
  export interface CreateDataSourceFromS3CommandOutput extends CreateDataSourceFromS3Output, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Creates a <code>DataSource</code> object. A <code>DataSource</code> references data that
18
23
  * can be used to perform <code>CreateMLModel</code>, <code>CreateEvaluation</code>, or
19
24
  * <code>CreateBatchPrediction</code> operations.</p>
@@ -55,6 +60,8 @@ export interface CreateDataSourceFromS3CommandOutput extends CreateDataSourceFro
55
60
  * const response = await client.send(command);
56
61
  * ```
57
62
  *
63
+ * @param CreateDataSourceFromS3CommandInput - {@link CreateDataSourceFromS3CommandInput}
64
+ * @returns {@link CreateDataSourceFromS3CommandOutput}
58
65
  * @see {@link CreateDataSourceFromS3CommandInput} for command's `input` shape.
59
66
  * @see {@link CreateDataSourceFromS3CommandOutput} for command's `response` shape.
60
67
  * @see {@link MachineLearningClientResolvedConfig | config} for MachineLearningClient's `config` shape.
@@ -73,11 +80,20 @@ export interface CreateDataSourceFromS3CommandOutput extends CreateDataSourceFro
73
80
  export declare class CreateDataSourceFromS3Command extends $Command<CreateDataSourceFromS3CommandInput, CreateDataSourceFromS3CommandOutput, MachineLearningClientResolvedConfig> {
74
81
  readonly input: CreateDataSourceFromS3CommandInput;
75
82
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
83
+ /**
84
+ * @public
85
+ */
76
86
  constructor(input: CreateDataSourceFromS3CommandInput);
77
87
  /**
78
88
  * @internal
79
89
  */
80
90
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: MachineLearningClientResolvedConfig, options?: __HttpHandlerOptions): Handler<CreateDataSourceFromS3CommandInput, CreateDataSourceFromS3CommandOutput>;
91
+ /**
92
+ * @internal
93
+ */
81
94
  private serialize;
95
+ /**
96
+ * @internal
97
+ */
82
98
  private deserialize;
83
99
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { MachineLearningClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../MachineLearningClient";
5
5
  import { CreateEvaluationInput, CreateEvaluationOutput } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link CreateEvaluationCommand}.
8
10
  */
9
11
  export interface CreateEvaluationCommandInput extends CreateEvaluationInput {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link CreateEvaluationCommand}.
13
17
  */
14
18
  export interface CreateEvaluationCommandOutput extends CreateEvaluationOutput, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Creates a new <code>Evaluation</code> of an <code>MLModel</code>. An <code>MLModel</code> is evaluated on a set of observations associated to a <code>DataSource</code>. Like a <code>DataSource</code>
18
23
  * for an <code>MLModel</code>, the <code>DataSource</code> for an <code>Evaluation</code> contains values for the <code>Target Variable</code>. The <code>Evaluation</code> compares the predicted result for each observation to the actual outcome and provides a
19
24
  * summary so that you know how effective the <code>MLModel</code> functions on the test
@@ -36,6 +41,8 @@ export interface CreateEvaluationCommandOutput extends CreateEvaluationOutput, _
36
41
  * const response = await client.send(command);
37
42
  * ```
38
43
  *
44
+ * @param CreateEvaluationCommandInput - {@link CreateEvaluationCommandInput}
45
+ * @returns {@link CreateEvaluationCommandOutput}
39
46
  * @see {@link CreateEvaluationCommandInput} for command's `input` shape.
40
47
  * @see {@link CreateEvaluationCommandOutput} for command's `response` shape.
41
48
  * @see {@link MachineLearningClientResolvedConfig | config} for MachineLearningClient's `config` shape.
@@ -54,11 +61,20 @@ export interface CreateEvaluationCommandOutput extends CreateEvaluationOutput, _
54
61
  export declare class CreateEvaluationCommand extends $Command<CreateEvaluationCommandInput, CreateEvaluationCommandOutput, MachineLearningClientResolvedConfig> {
55
62
  readonly input: CreateEvaluationCommandInput;
56
63
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
64
+ /**
65
+ * @public
66
+ */
57
67
  constructor(input: CreateEvaluationCommandInput);
58
68
  /**
59
69
  * @internal
60
70
  */
61
71
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: MachineLearningClientResolvedConfig, options?: __HttpHandlerOptions): Handler<CreateEvaluationCommandInput, CreateEvaluationCommandOutput>;
72
+ /**
73
+ * @internal
74
+ */
62
75
  private serialize;
76
+ /**
77
+ * @internal
78
+ */
63
79
  private deserialize;
64
80
  }