@aws-sdk/client-machine-learning 3.295.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 +31 -31
@@ -1,5 +1,8 @@
1
1
  import { ExceptionOptionType as __ExceptionOptionType } from "@aws-sdk/smithy-client";
2
2
  import { MachineLearningServiceException as __BaseException } from "./MachineLearningServiceException";
3
+ /**
4
+ * @public
5
+ */
3
6
  export declare enum TaggableResourceType {
4
7
  BATCH_PREDICTION = "BatchPrediction",
5
8
  DATASOURCE = "DataSource",
@@ -7,6 +10,7 @@ export declare enum TaggableResourceType {
7
10
  ML_MODEL = "MLModel"
8
11
  }
9
12
  /**
13
+ * @public
10
14
  * <p>A custom key-value pair associated with an ML object, such as an ML model.</p>
11
15
  */
12
16
  export interface Tag {
@@ -19,6 +23,9 @@ export interface Tag {
19
23
  */
20
24
  Value?: string;
21
25
  }
26
+ /**
27
+ * @public
28
+ */
22
29
  export interface AddTagsInput {
23
30
  /**
24
31
  * <p>The key-value pairs to use to create tags. If you specify a key without specifying a value, Amazon ML creates a tag with the specified key and a value of null.</p>
@@ -34,6 +41,7 @@ export interface AddTagsInput {
34
41
  ResourceType: TaggableResourceType | string | undefined;
35
42
  }
36
43
  /**
44
+ * @public
37
45
  * <p>Amazon ML returns the following elements.</p>
38
46
  */
39
47
  export interface AddTagsOutput {
@@ -47,6 +55,7 @@ export interface AddTagsOutput {
47
55
  ResourceType?: TaggableResourceType | string;
48
56
  }
49
57
  /**
58
+ * @public
50
59
  * <p>An error on the server occurred when trying to process a request.</p>
51
60
  */
52
61
  export declare class InternalServerException extends __BaseException {
@@ -59,6 +68,7 @@ export declare class InternalServerException extends __BaseException {
59
68
  constructor(opts: __ExceptionOptionType<InternalServerException, __BaseException>);
60
69
  }
61
70
  /**
71
+ * @public
62
72
  * <p>An error on the client occurred. Typically, the cause is an invalid input value.</p>
63
73
  */
64
74
  export declare class InvalidInputException extends __BaseException {
@@ -70,6 +80,9 @@ export declare class InvalidInputException extends __BaseException {
70
80
  */
71
81
  constructor(opts: __ExceptionOptionType<InvalidInputException, __BaseException>);
72
82
  }
83
+ /**
84
+ * @public
85
+ */
73
86
  export declare class InvalidTagException extends __BaseException {
74
87
  readonly name: "InvalidTagException";
75
88
  readonly $fault: "client";
@@ -79,6 +92,7 @@ export declare class InvalidTagException extends __BaseException {
79
92
  constructor(opts: __ExceptionOptionType<InvalidTagException, __BaseException>);
80
93
  }
81
94
  /**
95
+ * @public
82
96
  * <p>A specified resource cannot be located.</p>
83
97
  */
84
98
  export declare class ResourceNotFoundException extends __BaseException {
@@ -90,6 +104,9 @@ export declare class ResourceNotFoundException extends __BaseException {
90
104
  */
91
105
  constructor(opts: __ExceptionOptionType<ResourceNotFoundException, __BaseException>);
92
106
  }
107
+ /**
108
+ * @public
109
+ */
93
110
  export declare class TagLimitExceededException extends __BaseException {
94
111
  readonly name: "TagLimitExceededException";
95
112
  readonly $fault: "client";
@@ -98,9 +115,15 @@ export declare class TagLimitExceededException extends __BaseException {
98
115
  */
99
116
  constructor(opts: __ExceptionOptionType<TagLimitExceededException, __BaseException>);
100
117
  }
118
+ /**
119
+ * @public
120
+ */
101
121
  export declare enum Algorithm {
102
122
  SGD = "sgd"
103
123
  }
124
+ /**
125
+ * @public
126
+ */
104
127
  export interface CreateBatchPredictionInput {
105
128
  /**
106
129
  * <p>A user-supplied ID that uniquely identifies the
@@ -126,6 +149,7 @@ export interface CreateBatchPredictionInput {
126
149
  OutputUri: string | undefined;
127
150
  }
128
151
  /**
152
+ * @public
129
153
  * <p> Represents the output of a <code>CreateBatchPrediction</code> operation, and is an acknowledgement that Amazon ML received the request.</p>
130
154
  * <p>The <code>CreateBatchPrediction</code> operation is asynchronous. You can poll for status updates by using the <code>>GetBatchPrediction</code>
131
155
  * operation and checking the <code>Status</code> parameter of the result.
@@ -139,6 +163,7 @@ export interface CreateBatchPredictionOutput {
139
163
  BatchPredictionId?: string;
140
164
  }
141
165
  /**
166
+ * @public
142
167
  * <p>A second request to use or change an object was not allowed. This can result from retrying a request using a parameter that was not present in the original request.</p>
143
168
  */
144
169
  export declare class IdempotentParameterMismatchException extends __BaseException {
@@ -151,6 +176,7 @@ export declare class IdempotentParameterMismatchException extends __BaseExceptio
151
176
  constructor(opts: __ExceptionOptionType<IdempotentParameterMismatchException, __BaseException>);
152
177
  }
153
178
  /**
179
+ * @public
154
180
  * <p>The database credentials to connect to a database on an RDS DB instance.</p>
155
181
  */
156
182
  export interface RDSDatabaseCredentials {
@@ -166,6 +192,7 @@ export interface RDSDatabaseCredentials {
166
192
  Password: string | undefined;
167
193
  }
168
194
  /**
195
+ * @public
169
196
  * <p>The database details of an Amazon RDS database.</p>
170
197
  */
171
198
  export interface RDSDatabase {
@@ -179,6 +206,7 @@ export interface RDSDatabase {
179
206
  DatabaseName: string | undefined;
180
207
  }
181
208
  /**
209
+ * @public
182
210
  * <p>The data specification of an Amazon Relational Database Service (Amazon RDS) <code>DataSource</code>.</p>
183
211
  */
184
212
  export interface RDSDataSpec {
@@ -242,9 +270,9 @@ export interface RDSDataSpec {
242
270
  * <code>complement</code> parameter.</p>
243
271
  *
244
272
  * <p>For example, the following two datasources do not share any data, and can be used to train and evaluate a model. The first datasource has 25 percent of the data, and the second one has 75 percent of the data.</p>
245
- * <p>Datasource for evaluation: <code>{"splitting":{"percentBegin":0, "percentEnd":25}}</code>
273
+ * <p>Datasource for evaluation: <code>\{"splitting":\{"percentBegin":0, "percentEnd":25\}\}</code>
246
274
  * </p>
247
- * <p>Datasource for training: <code>{"splitting":{"percentBegin":0, "percentEnd":25, "complement":"true"}}</code>
275
+ * <p>Datasource for training: <code>\{"splitting":\{"percentBegin":0, "percentEnd":25, "complement":"true"\}\}</code>
248
276
  * </p>
249
277
  * </li>
250
278
  * <li>
@@ -260,9 +288,9 @@ export interface RDSDataSpec {
260
288
  *
261
289
  * <p>The following two <code>DataRearrangement</code> lines are examples of sequentially ordered
262
290
  * training and evaluation datasources:</p>
263
- * <p>Datasource for evaluation: <code>{"splitting":{"percentBegin":70, "percentEnd":100, "strategy":"sequential"}}</code>
291
+ * <p>Datasource for evaluation: <code>\{"splitting":\{"percentBegin":70, "percentEnd":100, "strategy":"sequential"\}\}</code>
264
292
  * </p>
265
- * <p>Datasource for training: <code>{"splitting":{"percentBegin":70, "percentEnd":100, "strategy":"sequential", "complement":"true"}}</code>
293
+ * <p>Datasource for training: <code>\{"splitting":\{"percentBegin":70, "percentEnd":100, "strategy":"sequential", "complement":"true"\}\}</code>
266
294
  * </p>
267
295
  *
268
296
  * <p>To randomly split the input data into the proportions indicated by the percentBegin and percentEnd
@@ -279,9 +307,9 @@ export interface RDSDataSpec {
279
307
  * training and evaluation datasources containing non-similar data records.</p>
280
308
  * <p>The following two <code>DataRearrangement</code> lines are examples of non-sequentially ordered
281
309
  * training and evaluation datasources:</p>
282
- * <p>Datasource for evaluation: <code>{"splitting":{"percentBegin":70, "percentEnd":100, "strategy":"random", "randomSeed"="s3://my_s3_path/bucket/file.csv"}}</code>
310
+ * <p>Datasource for evaluation: <code>\{"splitting":\{"percentBegin":70, "percentEnd":100, "strategy":"random", "randomSeed"="s3://my_s3_path/bucket/file.csv"\}\}</code>
283
311
  * </p>
284
- * <p>Datasource for training: <code>{"splitting":{"percentBegin":70, "percentEnd":100, "strategy":"random", "randomSeed"="s3://my_s3_path/bucket/file.csv", "complement":"true"}}</code>
312
+ * <p>Datasource for training: <code>\{"splitting":\{"percentBegin":70, "percentEnd":100, "strategy":"random", "randomSeed"="s3://my_s3_path/bucket/file.csv", "complement":"true"\}\}</code>
285
313
  * </p>
286
314
  * </li>
287
315
  * </ul>
@@ -298,15 +326,15 @@ export interface RDSDataSpec {
298
326
  * <p>Define your <code>DataSchema</code> as a series of key-value pairs. <code>attributes</code>
299
327
  * and <code>excludedVariableNames</code> have an array of key-value pairs
300
328
  * for their value. Use the following format to define your <code>DataSchema</code>.</p>
301
- * <p>{ "version": "1.0",</p>
329
+ * <p>\{ "version": "1.0",</p>
302
330
  * <p>"recordAnnotationFieldName": "F1",</p>
303
331
  * <p>"recordWeightFieldName": "F2",</p>
304
332
  * <p>"targetFieldName": "F3",</p>
305
333
  * <p>"dataFormat": "CSV",</p>
306
334
  * <p>"dataFileContainsHeader": true,</p>
307
335
  * <p>"attributes": [</p>
308
- * <p>{ "fieldName": "F1", "fieldType": "TEXT" }, { "fieldName": "F2", "fieldType": "NUMERIC" }, { "fieldName": "F3", "fieldType": "CATEGORICAL" }, { "fieldName": "F4", "fieldType": "NUMERIC" }, { "fieldName": "F5", "fieldType": "CATEGORICAL" }, { "fieldName": "F6", "fieldType": "TEXT" }, { "fieldName": "F7", "fieldType": "WEIGHTED_INT_SEQUENCE" }, { "fieldName": "F8", "fieldType": "WEIGHTED_STRING_SEQUENCE" } ],</p>
309
- * <p>"excludedVariableNames": [ "F6" ] }</p>
336
+ * <p>\{ "fieldName": "F1", "fieldType": "TEXT" \}, \{ "fieldName": "F2", "fieldType": "NUMERIC" \}, \{ "fieldName": "F3", "fieldType": "CATEGORICAL" \}, \{ "fieldName": "F4", "fieldType": "NUMERIC" \}, \{ "fieldName": "F5", "fieldType": "CATEGORICAL" \}, \{ "fieldName": "F6", "fieldType": "TEXT" \}, \{ "fieldName": "F7", "fieldType": "WEIGHTED_INT_SEQUENCE" \}, \{ "fieldName": "F8", "fieldType": "WEIGHTED_STRING_SEQUENCE" \} ],</p>
337
+ * <p>"excludedVariableNames": [ "F6" ] \}</p>
310
338
  */
311
339
  DataSchema?: string;
312
340
  /**
@@ -330,6 +358,9 @@ export interface RDSDataSpec {
330
358
  */
331
359
  SecurityGroupIds: string[] | undefined;
332
360
  }
361
+ /**
362
+ * @public
363
+ */
333
364
  export interface CreateDataSourceFromRDSInput {
334
365
  /**
335
366
  * <p>A user-supplied ID that uniquely identifies the <code>DataSource</code>. Typically, an Amazon Resource Number (ARN)
@@ -385,7 +416,7 @@ export interface CreateDataSourceFromRDSInput {
385
416
  * <li>
386
417
  * <p>DataRearrangement - A JSON string that represents the splitting and rearrangement requirements for the <code>Datasource</code>. </p>
387
418
  * <p> Sample -
388
- * <code> "{\"splitting\":{\"percentBegin\":10,\"percentEnd\":60}}"</code>
419
+ * <code> "\{\"splitting\":\{\"percentBegin\":10,\"percentEnd\":60\}\}"</code>
389
420
  * </p>
390
421
  * </li>
391
422
  * </ul>
@@ -406,6 +437,7 @@ export interface CreateDataSourceFromRDSInput {
406
437
  ComputeStatistics?: boolean;
407
438
  }
408
439
  /**
440
+ * @public
409
441
  * <p> Represents the output of a <code>CreateDataSourceFromRDS</code> operation, and is an acknowledgement that Amazon ML received the request.</p>
410
442
  * <p>The <code>CreateDataSourceFromRDS</code>> operation is asynchronous. You can poll for updates by using
411
443
  * the <code>GetBatchPrediction</code> operation and checking the <code>Status</code> parameter. You can
@@ -422,6 +454,7 @@ export interface CreateDataSourceFromRDSOutput {
422
454
  DataSourceId?: string;
423
455
  }
424
456
  /**
457
+ * @public
425
458
  * <p>Describes the database credentials for connecting to a database on an Amazon Redshift cluster.</p>
426
459
  */
427
460
  export interface RedshiftDatabaseCredentials {
@@ -437,6 +470,7 @@ export interface RedshiftDatabaseCredentials {
437
470
  Password: string | undefined;
438
471
  }
439
472
  /**
473
+ * @public
440
474
  * <p>Describes the database details required to connect to an Amazon Redshift database.</p>
441
475
  */
442
476
  export interface RedshiftDatabase {
@@ -450,6 +484,7 @@ export interface RedshiftDatabase {
450
484
  ClusterIdentifier: string | undefined;
451
485
  }
452
486
  /**
487
+ * @public
453
488
  * <p>Describes the data specification of an Amazon Redshift <code>DataSource</code>.</p>
454
489
  */
455
490
  export interface RedshiftDataSpec {
@@ -513,9 +548,9 @@ export interface RedshiftDataSpec {
513
548
  * <code>complement</code> parameter.</p>
514
549
  *
515
550
  * <p>For example, the following two datasources do not share any data, and can be used to train and evaluate a model. The first datasource has 25 percent of the data, and the second one has 75 percent of the data.</p>
516
- * <p>Datasource for evaluation: <code>{"splitting":{"percentBegin":0, "percentEnd":25}}</code>
551
+ * <p>Datasource for evaluation: <code>\{"splitting":\{"percentBegin":0, "percentEnd":25\}\}</code>
517
552
  * </p>
518
- * <p>Datasource for training: <code>{"splitting":{"percentBegin":0, "percentEnd":25, "complement":"true"}}</code>
553
+ * <p>Datasource for training: <code>\{"splitting":\{"percentBegin":0, "percentEnd":25, "complement":"true"\}\}</code>
519
554
  * </p>
520
555
  * </li>
521
556
  * <li>
@@ -531,9 +566,9 @@ export interface RedshiftDataSpec {
531
566
  *
532
567
  * <p>The following two <code>DataRearrangement</code> lines are examples of sequentially ordered
533
568
  * training and evaluation datasources:</p>
534
- * <p>Datasource for evaluation: <code>{"splitting":{"percentBegin":70, "percentEnd":100, "strategy":"sequential"}}</code>
569
+ * <p>Datasource for evaluation: <code>\{"splitting":\{"percentBegin":70, "percentEnd":100, "strategy":"sequential"\}\}</code>
535
570
  * </p>
536
- * <p>Datasource for training: <code>{"splitting":{"percentBegin":70, "percentEnd":100, "strategy":"sequential", "complement":"true"}}</code>
571
+ * <p>Datasource for training: <code>\{"splitting":\{"percentBegin":70, "percentEnd":100, "strategy":"sequential", "complement":"true"\}\}</code>
537
572
  * </p>
538
573
  *
539
574
  * <p>To randomly split the input data into the proportions indicated by the percentBegin and percentEnd
@@ -550,9 +585,9 @@ export interface RedshiftDataSpec {
550
585
  * training and evaluation datasources containing non-similar data records.</p>
551
586
  * <p>The following two <code>DataRearrangement</code> lines are examples of non-sequentially ordered
552
587
  * training and evaluation datasources:</p>
553
- * <p>Datasource for evaluation: <code>{"splitting":{"percentBegin":70, "percentEnd":100, "strategy":"random", "randomSeed"="s3://my_s3_path/bucket/file.csv"}}</code>
588
+ * <p>Datasource for evaluation: <code>\{"splitting":\{"percentBegin":70, "percentEnd":100, "strategy":"random", "randomSeed"="s3://my_s3_path/bucket/file.csv"\}\}</code>
554
589
  * </p>
555
- * <p>Datasource for training: <code>{"splitting":{"percentBegin":70, "percentEnd":100, "strategy":"random", "randomSeed"="s3://my_s3_path/bucket/file.csv", "complement":"true"}}</code>
590
+ * <p>Datasource for training: <code>\{"splitting":\{"percentBegin":70, "percentEnd":100, "strategy":"random", "randomSeed"="s3://my_s3_path/bucket/file.csv", "complement":"true"\}\}</code>
556
591
  * </p>
557
592
  * </li>
558
593
  * </ul>
@@ -568,15 +603,15 @@ export interface RedshiftDataSpec {
568
603
  * <p>Define your <code>DataSchema</code> as a series of key-value pairs. <code>attributes</code>
569
604
  * and <code>excludedVariableNames</code> have an array of key-value pairs
570
605
  * for their value. Use the following format to define your <code>DataSchema</code>.</p>
571
- * <p>{ "version": "1.0",</p>
606
+ * <p>\{ "version": "1.0",</p>
572
607
  * <p>"recordAnnotationFieldName": "F1",</p>
573
608
  * <p>"recordWeightFieldName": "F2",</p>
574
609
  * <p>"targetFieldName": "F3",</p>
575
610
  * <p>"dataFormat": "CSV",</p>
576
611
  * <p>"dataFileContainsHeader": true,</p>
577
612
  * <p>"attributes": [</p>
578
- * <p>{ "fieldName": "F1", "fieldType": "TEXT" }, { "fieldName": "F2", "fieldType": "NUMERIC" }, { "fieldName": "F3", "fieldType": "CATEGORICAL" }, { "fieldName": "F4", "fieldType": "NUMERIC" }, { "fieldName": "F5", "fieldType": "CATEGORICAL" }, { "fieldName": "F6", "fieldType": "TEXT" }, { "fieldName": "F7", "fieldType": "WEIGHTED_INT_SEQUENCE" }, { "fieldName": "F8", "fieldType": "WEIGHTED_STRING_SEQUENCE" } ],</p>
579
- * <p>"excludedVariableNames": [ "F6" ] }</p>
613
+ * <p>\{ "fieldName": "F1", "fieldType": "TEXT" \}, \{ "fieldName": "F2", "fieldType": "NUMERIC" \}, \{ "fieldName": "F3", "fieldType": "CATEGORICAL" \}, \{ "fieldName": "F4", "fieldType": "NUMERIC" \}, \{ "fieldName": "F5", "fieldType": "CATEGORICAL" \}, \{ "fieldName": "F6", "fieldType": "TEXT" \}, \{ "fieldName": "F7", "fieldType": "WEIGHTED_INT_SEQUENCE" \}, \{ "fieldName": "F8", "fieldType": "WEIGHTED_STRING_SEQUENCE" \} ],</p>
614
+ * <p>"excludedVariableNames": [ "F6" ] \}</p>
580
615
  */
581
616
  DataSchema?: string;
582
617
  /**
@@ -584,6 +619,9 @@ export interface RedshiftDataSpec {
584
619
  */
585
620
  DataSchemaUri?: string;
586
621
  }
622
+ /**
623
+ * @public
624
+ */
587
625
  export interface CreateDataSourceFromRedshiftInput {
588
626
  /**
589
627
  * <p>A user-supplied ID that uniquely identifies the <code>DataSource</code>.</p>
@@ -630,7 +668,7 @@ export interface CreateDataSourceFromRedshiftInput {
630
668
  * <li>
631
669
  * <p>DataRearrangement - A JSON string that represents the splitting and rearrangement requirements for the <code>DataSource</code>.</p>
632
670
  * <p> Sample -
633
- * <code> "{\"splitting\":{\"percentBegin\":10,\"percentEnd\":60}}"</code>
671
+ * <code> "\{\"splitting\":\{\"percentBegin\":10,\"percentEnd\":60\}\}"</code>
634
672
  * </p>
635
673
  * </li>
636
674
  * </ul>
@@ -659,6 +697,7 @@ export interface CreateDataSourceFromRedshiftInput {
659
697
  ComputeStatistics?: boolean;
660
698
  }
661
699
  /**
700
+ * @public
662
701
  * <p> Represents the output of a <code>CreateDataSourceFromRedshift</code> operation, and is an acknowledgement that Amazon ML received the request.</p>
663
702
  * <p>The <code>CreateDataSourceFromRedshift</code> operation is asynchronous. You can poll for updates by using
664
703
  * the <code>GetBatchPrediction</code> operation and checking the <code>Status</code> parameter. </p>
@@ -672,6 +711,7 @@ export interface CreateDataSourceFromRedshiftOutput {
672
711
  DataSourceId?: string;
673
712
  }
674
713
  /**
714
+ * @public
675
715
  * <p> Describes the data specification of a <code>DataSource</code>.</p>
676
716
  */
677
717
  export interface S3DataSpec {
@@ -724,9 +764,9 @@ export interface S3DataSpec {
724
764
  * <code>complement</code> parameter.</p>
725
765
  *
726
766
  * <p>For example, the following two datasources do not share any data, and can be used to train and evaluate a model. The first datasource has 25 percent of the data, and the second one has 75 percent of the data.</p>
727
- * <p>Datasource for evaluation: <code>{"splitting":{"percentBegin":0, "percentEnd":25}}</code>
767
+ * <p>Datasource for evaluation: <code>\{"splitting":\{"percentBegin":0, "percentEnd":25\}\}</code>
728
768
  * </p>
729
- * <p>Datasource for training: <code>{"splitting":{"percentBegin":0, "percentEnd":25, "complement":"true"}}</code>
769
+ * <p>Datasource for training: <code>\{"splitting":\{"percentBegin":0, "percentEnd":25, "complement":"true"\}\}</code>
730
770
  * </p>
731
771
  * </li>
732
772
  * <li>
@@ -742,9 +782,9 @@ export interface S3DataSpec {
742
782
  *
743
783
  * <p>The following two <code>DataRearrangement</code> lines are examples of sequentially ordered
744
784
  * training and evaluation datasources:</p>
745
- * <p>Datasource for evaluation: <code>{"splitting":{"percentBegin":70, "percentEnd":100, "strategy":"sequential"}}</code>
785
+ * <p>Datasource for evaluation: <code>\{"splitting":\{"percentBegin":70, "percentEnd":100, "strategy":"sequential"\}\}</code>
746
786
  * </p>
747
- * <p>Datasource for training: <code>{"splitting":{"percentBegin":70, "percentEnd":100, "strategy":"sequential", "complement":"true"}}</code>
787
+ * <p>Datasource for training: <code>\{"splitting":\{"percentBegin":70, "percentEnd":100, "strategy":"sequential", "complement":"true"\}\}</code>
748
788
  * </p>
749
789
  *
750
790
  * <p>To randomly split the input data into the proportions indicated by the percentBegin and percentEnd
@@ -761,9 +801,9 @@ export interface S3DataSpec {
761
801
  * training and evaluation datasources containing non-similar data records.</p>
762
802
  * <p>The following two <code>DataRearrangement</code> lines are examples of non-sequentially ordered
763
803
  * training and evaluation datasources:</p>
764
- * <p>Datasource for evaluation: <code>{"splitting":{"percentBegin":70, "percentEnd":100, "strategy":"random", "randomSeed"="s3://my_s3_path/bucket/file.csv"}}</code>
804
+ * <p>Datasource for evaluation: <code>\{"splitting":\{"percentBegin":70, "percentEnd":100, "strategy":"random", "randomSeed"="s3://my_s3_path/bucket/file.csv"\}\}</code>
765
805
  * </p>
766
- * <p>Datasource for training: <code>{"splitting":{"percentBegin":70, "percentEnd":100, "strategy":"random", "randomSeed"="s3://my_s3_path/bucket/file.csv", "complement":"true"}}</code>
806
+ * <p>Datasource for training: <code>\{"splitting":\{"percentBegin":70, "percentEnd":100, "strategy":"random", "randomSeed"="s3://my_s3_path/bucket/file.csv", "complement":"true"\}\}</code>
767
807
  * </p>
768
808
  * </li>
769
809
  * </ul>
@@ -778,15 +818,15 @@ export interface S3DataSpec {
778
818
  * <p>Define your <code>DataSchema</code> as a series of key-value pairs. <code>attributes</code>
779
819
  * and <code>excludedVariableNames</code> have an array of key-value pairs
780
820
  * for their value. Use the following format to define your <code>DataSchema</code>.</p>
781
- * <p>{ "version": "1.0",</p>
821
+ * <p>\{ "version": "1.0",</p>
782
822
  * <p>"recordAnnotationFieldName": "F1",</p>
783
823
  * <p>"recordWeightFieldName": "F2",</p>
784
824
  * <p>"targetFieldName": "F3",</p>
785
825
  * <p>"dataFormat": "CSV",</p>
786
826
  * <p>"dataFileContainsHeader": true,</p>
787
827
  * <p>"attributes": [</p>
788
- * <p>{ "fieldName": "F1", "fieldType": "TEXT" }, { "fieldName": "F2", "fieldType": "NUMERIC" }, { "fieldName": "F3", "fieldType": "CATEGORICAL" }, { "fieldName": "F4", "fieldType": "NUMERIC" }, { "fieldName": "F5", "fieldType": "CATEGORICAL" }, { "fieldName": "F6", "fieldType": "TEXT" }, { "fieldName": "F7", "fieldType": "WEIGHTED_INT_SEQUENCE" }, { "fieldName": "F8", "fieldType": "WEIGHTED_STRING_SEQUENCE" } ],</p>
789
- * <p>"excludedVariableNames": [ "F6" ] }</p>
828
+ * <p>\{ "fieldName": "F1", "fieldType": "TEXT" \}, \{ "fieldName": "F2", "fieldType": "NUMERIC" \}, \{ "fieldName": "F3", "fieldType": "CATEGORICAL" \}, \{ "fieldName": "F4", "fieldType": "NUMERIC" \}, \{ "fieldName": "F5", "fieldType": "CATEGORICAL" \}, \{ "fieldName": "F6", "fieldType": "TEXT" \}, \{ "fieldName": "F7", "fieldType": "WEIGHTED_INT_SEQUENCE" \}, \{ "fieldName": "F8", "fieldType": "WEIGHTED_STRING_SEQUENCE" \} ],</p>
829
+ * <p>"excludedVariableNames": [ "F6" ] \}</p>
790
830
  */
791
831
  DataSchema?: string;
792
832
  /**
@@ -795,6 +835,9 @@ export interface S3DataSpec {
795
835
  */
796
836
  DataSchemaLocationS3?: string;
797
837
  }
838
+ /**
839
+ * @public
840
+ */
798
841
  export interface CreateDataSourceFromS3Input {
799
842
  /**
800
843
  * <p>A user-supplied identifier that uniquely identifies the <code>DataSource</code>. </p>
@@ -819,7 +862,7 @@ export interface CreateDataSourceFromS3Input {
819
862
  * <li>
820
863
  * <p>DataRearrangement - A JSON string that represents the splitting and rearrangement requirements for the <code>Datasource</code>. </p>
821
864
  * <p> Sample -
822
- * <code> "{\"splitting\":{\"percentBegin\":10,\"percentEnd\":60}}"</code>
865
+ * <code> "\{\"splitting\":\{\"percentBegin\":10,\"percentEnd\":60\}\}"</code>
823
866
  * </p>
824
867
  * </li>
825
868
  * </ul>
@@ -833,6 +876,7 @@ export interface CreateDataSourceFromS3Input {
833
876
  ComputeStatistics?: boolean;
834
877
  }
835
878
  /**
879
+ * @public
836
880
  * <p> Represents the output of a <code>CreateDataSourceFromS3</code> operation, and is an acknowledgement that Amazon ML received the request.</p>
837
881
  * <p>The <code>CreateDataSourceFromS3</code> operation is asynchronous. You can poll for updates by using
838
882
  * the <code>GetBatchPrediction</code> operation and checking the <code>Status</code> parameter. </p>
@@ -845,6 +889,9 @@ export interface CreateDataSourceFromS3Output {
845
889
  */
846
890
  DataSourceId?: string;
847
891
  }
892
+ /**
893
+ * @public
894
+ */
848
895
  export interface CreateEvaluationInput {
849
896
  /**
850
897
  * <p>A user-supplied ID that uniquely identifies the <code>Evaluation</code>.</p>
@@ -866,6 +913,7 @@ export interface CreateEvaluationInput {
866
913
  EvaluationDataSourceId: string | undefined;
867
914
  }
868
915
  /**
916
+ * @public
869
917
  * <p> Represents the output of a <code>CreateEvaluation</code> operation, and is an acknowledgement that Amazon ML received the request.</p>
870
918
  * <p>
871
919
  * <code>CreateEvaluation</code> operation is asynchronous. You can poll for status updates
@@ -880,11 +928,17 @@ export interface CreateEvaluationOutput {
880
928
  */
881
929
  EvaluationId?: string;
882
930
  }
931
+ /**
932
+ * @public
933
+ */
883
934
  export declare enum MLModelType {
884
935
  BINARY = "BINARY",
885
936
  MULTICLASS = "MULTICLASS",
886
937
  REGRESSION = "REGRESSION"
887
938
  }
939
+ /**
940
+ * @public
941
+ */
888
942
  export interface CreateMLModelInput {
889
943
  /**
890
944
  * <p>A user-supplied ID that uniquely identifies the <code>MLModel</code>.</p>
@@ -973,6 +1027,7 @@ export interface CreateMLModelInput {
973
1027
  RecipeUri?: string;
974
1028
  }
975
1029
  /**
1030
+ * @public
976
1031
  * <p> Represents the output of a <code>CreateMLModel</code> operation, and is an acknowledgement that Amazon ML received the request.</p>
977
1032
  * <p>The <code>CreateMLModel</code> operation is asynchronous. You can poll for status updates by using the
978
1033
  * <code>GetMLModel</code> operation and checking the <code>Status</code> parameter.
@@ -986,12 +1041,18 @@ export interface CreateMLModelOutput {
986
1041
  */
987
1042
  MLModelId?: string;
988
1043
  }
1044
+ /**
1045
+ * @public
1046
+ */
989
1047
  export interface CreateRealtimeEndpointInput {
990
1048
  /**
991
1049
  * <p>The ID assigned to the <code>MLModel</code> during creation.</p>
992
1050
  */
993
1051
  MLModelId: string | undefined;
994
1052
  }
1053
+ /**
1054
+ * @public
1055
+ */
995
1056
  export declare enum RealtimeEndpointStatus {
996
1057
  FAILED = "FAILED",
997
1058
  NONE = "NONE",
@@ -999,6 +1060,7 @@ export declare enum RealtimeEndpointStatus {
999
1060
  UPDATING = "UPDATING"
1000
1061
  }
1001
1062
  /**
1063
+ * @public
1002
1064
  * <p> Describes the real-time endpoint information for an <code>MLModel</code>.</p>
1003
1065
  */
1004
1066
  export interface RealtimeEndpointInfo {
@@ -1036,6 +1098,7 @@ export interface RealtimeEndpointInfo {
1036
1098
  EndpointStatus?: RealtimeEndpointStatus | string;
1037
1099
  }
1038
1100
  /**
1101
+ * @public
1039
1102
  * <p>Represents the output of an <code>CreateRealtimeEndpoint</code> operation.</p>
1040
1103
  * <p>The result contains the <code>MLModelId</code> and the endpoint information for the <code>MLModel</code>.</p>
1041
1104
  * <p>
@@ -1053,6 +1116,9 @@ export interface CreateRealtimeEndpointOutput {
1053
1116
  */
1054
1117
  RealtimeEndpointInfo?: RealtimeEndpointInfo;
1055
1118
  }
1119
+ /**
1120
+ * @public
1121
+ */
1056
1122
  export interface DeleteBatchPredictionInput {
1057
1123
  /**
1058
1124
  * <p>A user-supplied ID that uniquely identifies the <code>BatchPrediction</code>.</p>
@@ -1060,6 +1126,7 @@ export interface DeleteBatchPredictionInput {
1060
1126
  BatchPredictionId: string | undefined;
1061
1127
  }
1062
1128
  /**
1129
+ * @public
1063
1130
  * <p> Represents the output of a <code>DeleteBatchPrediction</code> operation.</p>
1064
1131
  * <p>You can use the <code>GetBatchPrediction</code> operation and check the value of the <code>Status</code> parameter to see whether a
1065
1132
  * <code>BatchPrediction</code> is marked as <code>DELETED</code>.</p>
@@ -1070,6 +1137,9 @@ export interface DeleteBatchPredictionOutput {
1070
1137
  */
1071
1138
  BatchPredictionId?: string;
1072
1139
  }
1140
+ /**
1141
+ * @public
1142
+ */
1073
1143
  export interface DeleteDataSourceInput {
1074
1144
  /**
1075
1145
  * <p>A user-supplied ID that uniquely identifies the <code>DataSource</code>.</p>
@@ -1077,6 +1147,7 @@ export interface DeleteDataSourceInput {
1077
1147
  DataSourceId: string | undefined;
1078
1148
  }
1079
1149
  /**
1150
+ * @public
1080
1151
  * <p> Represents the output of a <code>DeleteDataSource</code> operation.</p>
1081
1152
  */
1082
1153
  export interface DeleteDataSourceOutput {
@@ -1085,6 +1156,9 @@ export interface DeleteDataSourceOutput {
1085
1156
  */
1086
1157
  DataSourceId?: string;
1087
1158
  }
1159
+ /**
1160
+ * @public
1161
+ */
1088
1162
  export interface DeleteEvaluationInput {
1089
1163
  /**
1090
1164
  * <p>A user-supplied ID that uniquely identifies the <code>Evaluation</code> to delete.</p>
@@ -1092,6 +1166,7 @@ export interface DeleteEvaluationInput {
1092
1166
  EvaluationId: string | undefined;
1093
1167
  }
1094
1168
  /**
1169
+ * @public
1095
1170
  * <p> Represents the output of a <code>DeleteEvaluation</code> operation. The output indicates that Amazon Machine Learning (Amazon ML) received the request.</p>
1096
1171
  * <p>You can use the <code>GetEvaluation</code> operation and check the value of the <code>Status</code> parameter to see whether an
1097
1172
  * <code>Evaluation</code> is marked as <code>DELETED</code>.</p>
@@ -1102,6 +1177,9 @@ export interface DeleteEvaluationOutput {
1102
1177
  */
1103
1178
  EvaluationId?: string;
1104
1179
  }
1180
+ /**
1181
+ * @public
1182
+ */
1105
1183
  export interface DeleteMLModelInput {
1106
1184
  /**
1107
1185
  * <p>A user-supplied ID that uniquely identifies the <code>MLModel</code>.</p>
@@ -1109,6 +1187,7 @@ export interface DeleteMLModelInput {
1109
1187
  MLModelId: string | undefined;
1110
1188
  }
1111
1189
  /**
1190
+ * @public
1112
1191
  * <p>Represents the output of a <code>DeleteMLModel</code> operation.</p>
1113
1192
  * <p>You can use the <code>GetMLModel</code> operation and check the value of the <code>Status</code> parameter to see whether an
1114
1193
  * <code>MLModel</code> is marked as <code>DELETED</code>.</p>
@@ -1119,6 +1198,9 @@ export interface DeleteMLModelOutput {
1119
1198
  */
1120
1199
  MLModelId?: string;
1121
1200
  }
1201
+ /**
1202
+ * @public
1203
+ */
1122
1204
  export interface DeleteRealtimeEndpointInput {
1123
1205
  /**
1124
1206
  * <p>The ID assigned to the <code>MLModel</code> during creation.</p>
@@ -1126,6 +1208,7 @@ export interface DeleteRealtimeEndpointInput {
1126
1208
  MLModelId: string | undefined;
1127
1209
  }
1128
1210
  /**
1211
+ * @public
1129
1212
  * <p>Represents the output of an <code>DeleteRealtimeEndpoint</code> operation.</p>
1130
1213
  * <p>The result contains the <code>MLModelId</code> and the endpoint information for the <code>MLModel</code>. </p>
1131
1214
  */
@@ -1141,6 +1224,9 @@ export interface DeleteRealtimeEndpointOutput {
1141
1224
  */
1142
1225
  RealtimeEndpointInfo?: RealtimeEndpointInfo;
1143
1226
  }
1227
+ /**
1228
+ * @public
1229
+ */
1144
1230
  export interface DeleteTagsInput {
1145
1231
  /**
1146
1232
  * <p>One or more tags to delete.</p>
@@ -1156,6 +1242,7 @@ export interface DeleteTagsInput {
1156
1242
  ResourceType: TaggableResourceType | string | undefined;
1157
1243
  }
1158
1244
  /**
1245
+ * @public
1159
1246
  * <p>Amazon ML returns the following elements.</p>
1160
1247
  */
1161
1248
  export interface DeleteTagsOutput {
@@ -1168,6 +1255,9 @@ export interface DeleteTagsOutput {
1168
1255
  */
1169
1256
  ResourceType?: TaggableResourceType | string;
1170
1257
  }
1258
+ /**
1259
+ * @public
1260
+ */
1171
1261
  export declare enum BatchPredictionFilterVariable {
1172
1262
  CREATED_AT = "CreatedAt",
1173
1263
  DATASOURCE_ID = "DataSourceId",
@@ -1178,10 +1268,16 @@ export declare enum BatchPredictionFilterVariable {
1178
1268
  NAME = "Name",
1179
1269
  STATUS = "Status"
1180
1270
  }
1271
+ /**
1272
+ * @public
1273
+ */
1181
1274
  export declare enum SortOrder {
1182
1275
  ASC = "asc",
1183
1276
  DSC = "dsc"
1184
1277
  }
1278
+ /**
1279
+ * @public
1280
+ */
1185
1281
  export interface DescribeBatchPredictionsInput {
1186
1282
  /**
1187
1283
  * <p>Use one of the following variables to filter a list of <code>BatchPrediction</code>:</p>
@@ -1292,6 +1388,9 @@ export interface DescribeBatchPredictionsInput {
1292
1388
  */
1293
1389
  Limit?: number;
1294
1390
  }
1391
+ /**
1392
+ * @public
1393
+ */
1295
1394
  export declare enum EntityStatus {
1296
1395
  COMPLETED = "COMPLETED",
1297
1396
  DELETED = "DELETED",
@@ -1300,6 +1399,7 @@ export declare enum EntityStatus {
1300
1399
  PENDING = "PENDING"
1301
1400
  }
1302
1401
  /**
1402
+ * @public
1303
1403
  * <p> Represents the output of a <code>GetBatchPrediction</code> operation.</p>
1304
1404
  * <p> The content consists of the detailed metadata, the status, and the data file information of a
1305
1405
  * <code>Batch Prediction</code>.</p>
@@ -1395,6 +1495,7 @@ export interface BatchPrediction {
1395
1495
  InvalidRecordCount?: number;
1396
1496
  }
1397
1497
  /**
1498
+ * @public
1398
1499
  * <p>Represents the output of a <code>DescribeBatchPredictions</code> operation. The content is essentially a list of <code>BatchPrediction</code>s.</p>
1399
1500
  */
1400
1501
  export interface DescribeBatchPredictionsOutput {
@@ -1408,6 +1509,9 @@ export interface DescribeBatchPredictionsOutput {
1408
1509
  */
1409
1510
  NextToken?: string;
1410
1511
  }
1512
+ /**
1513
+ * @public
1514
+ */
1411
1515
  export declare enum DataSourceFilterVariable {
1412
1516
  CREATED_AT = "CreatedAt",
1413
1517
  DATA_URI = "DataLocationS3",
@@ -1416,6 +1520,9 @@ export declare enum DataSourceFilterVariable {
1416
1520
  NAME = "Name",
1417
1521
  STATUS = "Status"
1418
1522
  }
1523
+ /**
1524
+ * @public
1525
+ */
1419
1526
  export interface DescribeDataSourcesInput {
1420
1527
  /**
1421
1528
  * <p>Use one of the following variables to filter a list of <code>DataSource</code>:</p>
@@ -1518,6 +1625,7 @@ export interface DescribeDataSourcesInput {
1518
1625
  Limit?: number;
1519
1626
  }
1520
1627
  /**
1628
+ * @public
1521
1629
  * <p>The datasource details that are specific to Amazon RDS.</p>
1522
1630
  */
1523
1631
  export interface RDSMetadata {
@@ -1548,6 +1656,7 @@ export interface RDSMetadata {
1548
1656
  DataPipelineId?: string;
1549
1657
  }
1550
1658
  /**
1659
+ * @public
1551
1660
  * <p>Describes the <code>DataSource</code> details specific to Amazon Redshift.</p>
1552
1661
  */
1553
1662
  export interface RedshiftMetadata {
@@ -1566,6 +1675,7 @@ export interface RedshiftMetadata {
1566
1675
  SelectSqlQuery?: string;
1567
1676
  }
1568
1677
  /**
1678
+ * @public
1569
1679
  * <p> Represents the output of the <code>GetDataSource</code> operation. </p>
1570
1680
  * <p> The content consists of the detailed metadata and data file information and the current status of the <code>DataSource</code>. </p>
1571
1681
  */
@@ -1665,6 +1775,7 @@ export interface DataSource {
1665
1775
  StartedAt?: Date;
1666
1776
  }
1667
1777
  /**
1778
+ * @public
1668
1779
  * <p>Represents the query results from a <a>DescribeDataSources</a> operation. The content is essentially a list of <code>DataSource</code>.</p>
1669
1780
  */
1670
1781
  export interface DescribeDataSourcesOutput {
@@ -1678,6 +1789,9 @@ export interface DescribeDataSourcesOutput {
1678
1789
  */
1679
1790
  NextToken?: string;
1680
1791
  }
1792
+ /**
1793
+ * @public
1794
+ */
1681
1795
  export declare enum EvaluationFilterVariable {
1682
1796
  CREATED_AT = "CreatedAt",
1683
1797
  DATASOURCE_ID = "DataSourceId",
@@ -1688,6 +1802,9 @@ export declare enum EvaluationFilterVariable {
1688
1802
  NAME = "Name",
1689
1803
  STATUS = "Status"
1690
1804
  }
1805
+ /**
1806
+ * @public
1807
+ */
1691
1808
  export interface DescribeEvaluationsInput {
1692
1809
  /**
1693
1810
  * <p>Use one of the following variable to filter a list of <code>Evaluation</code> objects:</p>
@@ -1799,6 +1916,7 @@ export interface DescribeEvaluationsInput {
1799
1916
  Limit?: number;
1800
1917
  }
1801
1918
  /**
1919
+ * @public
1802
1920
  * <p>Measurements of how well the <code>MLModel</code> performed on known observations. One of the following metrics is returned, based on the type of the <code>MLModel</code>:
1803
1921
  * </p>
1804
1922
  * <ul>
@@ -1820,6 +1938,7 @@ export interface PerformanceMetrics {
1820
1938
  Properties?: Record<string, string>;
1821
1939
  }
1822
1940
  /**
1941
+ * @public
1823
1942
  * <p> Represents the output of <code>GetEvaluation</code> operation. </p>
1824
1943
  * <p>The content consists of the detailed metadata and data file information and the current status of the
1825
1944
  * <code>Evaluation</code>.</p>
@@ -1921,6 +2040,7 @@ export interface Evaluation {
1921
2040
  StartedAt?: Date;
1922
2041
  }
1923
2042
  /**
2043
+ * @public
1924
2044
  * <p>Represents the query results from a <code>DescribeEvaluations</code> operation. The content is essentially a list of <code>Evaluation</code>.</p>
1925
2045
  */
1926
2046
  export interface DescribeEvaluationsOutput {
@@ -1934,6 +2054,9 @@ export interface DescribeEvaluationsOutput {
1934
2054
  */
1935
2055
  NextToken?: string;
1936
2056
  }
2057
+ /**
2058
+ * @public
2059
+ */
1937
2060
  export declare enum MLModelFilterVariable {
1938
2061
  ALGORITHM = "Algorithm",
1939
2062
  CREATED_AT = "CreatedAt",
@@ -1946,6 +2069,9 @@ export declare enum MLModelFilterVariable {
1946
2069
  TRAINING_DATASOURCE_ID = "TrainingDataSourceId",
1947
2070
  TRAINING_DATA_URI = "TrainingDataURI"
1948
2071
  }
2072
+ /**
2073
+ * @public
2074
+ */
1949
2075
  export interface DescribeMLModelsInput {
1950
2076
  /**
1951
2077
  * <p>Use one of the following variables to filter a list of <code>MLModel</code>:</p>
@@ -2065,6 +2191,7 @@ export interface DescribeMLModelsInput {
2065
2191
  Limit?: number;
2066
2192
  }
2067
2193
  /**
2194
+ * @public
2068
2195
  * <p> Represents the output of a <code>GetMLModel</code> operation. </p>
2069
2196
  * <p>The content consists of the detailed metadata and the current status of the <code>MLModel</code>.</p>
2070
2197
  */
@@ -2235,6 +2362,7 @@ export interface MLModel {
2235
2362
  StartedAt?: Date;
2236
2363
  }
2237
2364
  /**
2365
+ * @public
2238
2366
  * <p>Represents the output of a <code>DescribeMLModels</code> operation. The content is essentially a list of <code>MLModel</code>.</p>
2239
2367
  */
2240
2368
  export interface DescribeMLModelsOutput {
@@ -2247,6 +2375,9 @@ export interface DescribeMLModelsOutput {
2247
2375
  */
2248
2376
  NextToken?: string;
2249
2377
  }
2378
+ /**
2379
+ * @public
2380
+ */
2250
2381
  export interface DescribeTagsInput {
2251
2382
  /**
2252
2383
  * <p>The ID of the ML object. For example, <code>exampleModelId</code>. </p>
@@ -2258,6 +2389,7 @@ export interface DescribeTagsInput {
2258
2389
  ResourceType: TaggableResourceType | string | undefined;
2259
2390
  }
2260
2391
  /**
2392
+ * @public
2261
2393
  * <p>Amazon ML returns the following elements.</p>
2262
2394
  */
2263
2395
  export interface DescribeTagsOutput {
@@ -2274,6 +2406,9 @@ export interface DescribeTagsOutput {
2274
2406
  */
2275
2407
  Tags?: Tag[];
2276
2408
  }
2409
+ /**
2410
+ * @public
2411
+ */
2277
2412
  export interface GetBatchPredictionInput {
2278
2413
  /**
2279
2414
  * <p>An ID assigned to the <code>BatchPrediction</code> at creation.</p>
@@ -2281,6 +2416,7 @@ export interface GetBatchPredictionInput {
2281
2416
  BatchPredictionId: string | undefined;
2282
2417
  }
2283
2418
  /**
2419
+ * @public
2284
2420
  * <p>Represents the output of a <code>GetBatchPrediction</code> operation and describes a <code>BatchPrediction</code>.</p>
2285
2421
  */
2286
2422
  export interface GetBatchPredictionOutput {
@@ -2377,6 +2513,9 @@ export interface GetBatchPredictionOutput {
2377
2513
  */
2378
2514
  InvalidRecordCount?: number;
2379
2515
  }
2516
+ /**
2517
+ * @public
2518
+ */
2380
2519
  export interface GetDataSourceInput {
2381
2520
  /**
2382
2521
  * <p>The ID assigned to the <code>DataSource</code> at creation.</p>
@@ -2390,6 +2529,7 @@ export interface GetDataSourceInput {
2390
2529
  Verbose?: boolean;
2391
2530
  }
2392
2531
  /**
2532
+ * @public
2393
2533
  * <p>Represents the output of a <code>GetDataSource</code> operation and describes a <code>DataSource</code>.</p>
2394
2534
  */
2395
2535
  export interface GetDataSourceOutput {
@@ -2501,6 +2641,9 @@ export interface GetDataSourceOutput {
2501
2641
  */
2502
2642
  DataSourceSchema?: string;
2503
2643
  }
2644
+ /**
2645
+ * @public
2646
+ */
2504
2647
  export interface GetEvaluationInput {
2505
2648
  /**
2506
2649
  * <p>The ID of the <code>Evaluation</code> to retrieve. The evaluation of each <code>MLModel</code> is recorded and cataloged. The ID provides the means to access the information. </p>
@@ -2508,6 +2651,7 @@ export interface GetEvaluationInput {
2508
2651
  EvaluationId: string | undefined;
2509
2652
  }
2510
2653
  /**
2654
+ * @public
2511
2655
  * <p>Represents the output of a <code>GetEvaluation</code> operation and describes an <code>Evaluation</code>.</p>
2512
2656
  */
2513
2657
  export interface GetEvaluationOutput {
@@ -2609,6 +2753,9 @@ export interface GetEvaluationOutput {
2609
2753
  */
2610
2754
  StartedAt?: Date;
2611
2755
  }
2756
+ /**
2757
+ * @public
2758
+ */
2612
2759
  export interface GetMLModelInput {
2613
2760
  /**
2614
2761
  * <p>The ID assigned to the <code>MLModel</code> at creation.</p>
@@ -2622,6 +2769,7 @@ export interface GetMLModelInput {
2622
2769
  Verbose?: boolean;
2623
2770
  }
2624
2771
  /**
2772
+ * @public
2625
2773
  * <p>Represents the output of a <code>GetMLModel</code> operation, and provides detailed information about a <code>MLModel</code>.</p>
2626
2774
  */
2627
2775
  export interface GetMLModelOutput {
@@ -2803,6 +2951,7 @@ export interface GetMLModelOutput {
2803
2951
  Schema?: string;
2804
2952
  }
2805
2953
  /**
2954
+ * @public
2806
2955
  * <p>The subscriber exceeded the maximum number of operations. This exception can occur when listing objects such as <code>DataSource</code>.</p>
2807
2956
  */
2808
2957
  export declare class LimitExceededException extends __BaseException {
@@ -2814,6 +2963,9 @@ export declare class LimitExceededException extends __BaseException {
2814
2963
  */
2815
2964
  constructor(opts: __ExceptionOptionType<LimitExceededException, __BaseException>);
2816
2965
  }
2966
+ /**
2967
+ * @public
2968
+ */
2817
2969
  export interface PredictInput {
2818
2970
  /**
2819
2971
  * <p>A unique identifier of the <code>MLModel</code>.</p>
@@ -2826,6 +2978,7 @@ export interface PredictInput {
2826
2978
  PredictEndpoint: string | undefined;
2827
2979
  }
2828
2980
  /**
2981
+ * @public
2829
2982
  * <p>The exception is thrown when a predict request is made to an unmounted <code>MLModel</code>.</p>
2830
2983
  */
2831
2984
  export declare class PredictorNotMountedException extends __BaseException {
@@ -2836,11 +2989,15 @@ export declare class PredictorNotMountedException extends __BaseException {
2836
2989
  */
2837
2990
  constructor(opts: __ExceptionOptionType<PredictorNotMountedException, __BaseException>);
2838
2991
  }
2992
+ /**
2993
+ * @public
2994
+ */
2839
2995
  export declare enum DetailsAttributes {
2840
2996
  ALGORITHM = "Algorithm",
2841
2997
  PREDICTIVE_MODEL_TYPE = "PredictiveModelType"
2842
2998
  }
2843
2999
  /**
3000
+ * @public
2844
3001
  * <p>The output from a <code>Predict</code> operation: </p>
2845
3002
  *
2846
3003
  * <ul>
@@ -2890,6 +3047,9 @@ export interface Prediction {
2890
3047
  */
2891
3048
  details?: Record<string, string>;
2892
3049
  }
3050
+ /**
3051
+ * @public
3052
+ */
2893
3053
  export interface PredictOutput {
2894
3054
  /**
2895
3055
  * <p>The output from a <code>Predict</code> operation: </p>
@@ -2923,6 +3083,9 @@ export interface PredictOutput {
2923
3083
  */
2924
3084
  Prediction?: Prediction;
2925
3085
  }
3086
+ /**
3087
+ * @public
3088
+ */
2926
3089
  export interface UpdateBatchPredictionInput {
2927
3090
  /**
2928
3091
  * <p>The ID assigned to the <code>BatchPrediction</code> during creation.</p>
@@ -2934,6 +3097,7 @@ export interface UpdateBatchPredictionInput {
2934
3097
  BatchPredictionName: string | undefined;
2935
3098
  }
2936
3099
  /**
3100
+ * @public
2937
3101
  * <p>Represents the output of an <code>UpdateBatchPrediction</code> operation.</p>
2938
3102
  * <p>You can see the updated content by using the <code>GetBatchPrediction</code> operation.</p>
2939
3103
  */
@@ -2944,6 +3108,9 @@ export interface UpdateBatchPredictionOutput {
2944
3108
  */
2945
3109
  BatchPredictionId?: string;
2946
3110
  }
3111
+ /**
3112
+ * @public
3113
+ */
2947
3114
  export interface UpdateDataSourceInput {
2948
3115
  /**
2949
3116
  * <p>The ID assigned to the <code>DataSource</code> during creation.</p>
@@ -2955,6 +3122,7 @@ export interface UpdateDataSourceInput {
2955
3122
  DataSourceName: string | undefined;
2956
3123
  }
2957
3124
  /**
3125
+ * @public
2958
3126
  * <p>Represents the output of an <code>UpdateDataSource</code> operation.</p>
2959
3127
  * <p>You can see the updated content by using the <code>GetBatchPrediction</code> operation.</p>
2960
3128
  */
@@ -2965,6 +3133,9 @@ export interface UpdateDataSourceOutput {
2965
3133
  */
2966
3134
  DataSourceId?: string;
2967
3135
  }
3136
+ /**
3137
+ * @public
3138
+ */
2968
3139
  export interface UpdateEvaluationInput {
2969
3140
  /**
2970
3141
  * <p>The ID assigned to the <code>Evaluation</code> during creation.</p>
@@ -2976,6 +3147,7 @@ export interface UpdateEvaluationInput {
2976
3147
  EvaluationName: string | undefined;
2977
3148
  }
2978
3149
  /**
3150
+ * @public
2979
3151
  * <p>Represents the output of an <code>UpdateEvaluation</code> operation.</p>
2980
3152
  * <p>You can see the updated content by using the <code>GetEvaluation</code> operation.</p>
2981
3153
  */
@@ -2986,6 +3158,9 @@ export interface UpdateEvaluationOutput {
2986
3158
  */
2987
3159
  EvaluationId?: string;
2988
3160
  }
3161
+ /**
3162
+ * @public
3163
+ */
2989
3164
  export interface UpdateMLModelInput {
2990
3165
  /**
2991
3166
  * <p>The ID assigned to the <code>MLModel</code> during creation.</p>
@@ -3002,6 +3177,7 @@ export interface UpdateMLModelInput {
3002
3177
  ScoreThreshold?: number;
3003
3178
  }
3004
3179
  /**
3180
+ * @public
3005
3181
  * <p>Represents the output of an <code>UpdateMLModel</code> operation.</p>
3006
3182
  * <p>You can see the updated content by using the <code>GetMLModel</code> operation.</p>
3007
3183
  */