@aws-sdk/client-machine-learning 3.379.1 → 3.382.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.
@@ -20,10 +20,12 @@ export type TaggableResourceType = (typeof TaggableResourceType)[keyof typeof Ta
20
20
  */
21
21
  export interface Tag {
22
22
  /**
23
+ * @public
23
24
  * <p>A unique identifier for the tag. Valid characters include Unicode letters, digits, white space, _, ., /, =, +, -, %, and @.</p>
24
25
  */
25
26
  Key?: string;
26
27
  /**
28
+ * @public
27
29
  * <p>An optional string, typically used to describe or define the tag. Valid characters include Unicode letters, digits, white space, _, ., /, =, +, -, %, and @.</p>
28
30
  */
29
31
  Value?: string;
@@ -33,14 +35,17 @@ export interface Tag {
33
35
  */
34
36
  export interface AddTagsInput {
35
37
  /**
38
+ * @public
36
39
  * <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>
37
40
  */
38
41
  Tags: Tag[] | undefined;
39
42
  /**
43
+ * @public
40
44
  * <p>The ID of the ML object to tag. For example, <code>exampleModelId</code>.</p>
41
45
  */
42
46
  ResourceId: string | undefined;
43
47
  /**
48
+ * @public
44
49
  * <p>The type of the ML object to tag.</p>
45
50
  */
46
51
  ResourceType: TaggableResourceType | string | undefined;
@@ -51,10 +56,12 @@ export interface AddTagsInput {
51
56
  */
52
57
  export interface AddTagsOutput {
53
58
  /**
59
+ * @public
54
60
  * <p>The ID of the ML object that was tagged.</p>
55
61
  */
56
62
  ResourceId?: string;
57
63
  /**
64
+ * @public
58
65
  * <p>The type of the ML object that was tagged.</p>
59
66
  */
60
67
  ResourceType?: TaggableResourceType | string;
@@ -136,23 +143,28 @@ export type Algorithm = (typeof Algorithm)[keyof typeof Algorithm];
136
143
  */
137
144
  export interface CreateBatchPredictionInput {
138
145
  /**
146
+ * @public
139
147
  * <p>A user-supplied ID that uniquely identifies the
140
148
  * <code>BatchPrediction</code>.</p>
141
149
  */
142
150
  BatchPredictionId: string | undefined;
143
151
  /**
152
+ * @public
144
153
  * <p>A user-supplied name or description of the <code>BatchPrediction</code>. <code>BatchPredictionName</code> can only use the UTF-8 character set.</p>
145
154
  */
146
155
  BatchPredictionName?: string;
147
156
  /**
157
+ * @public
148
158
  * <p>The ID of the <code>MLModel</code> that will generate predictions for the group of observations. </p>
149
159
  */
150
160
  MLModelId: string | undefined;
151
161
  /**
162
+ * @public
152
163
  * <p>The ID of the <code>DataSource</code> that points to the group of observations to predict.</p>
153
164
  */
154
165
  BatchPredictionDataSourceId: string | undefined;
155
166
  /**
167
+ * @public
156
168
  * <p>The location of an Amazon Simple Storage Service (Amazon S3) bucket or directory to store the batch prediction results. The following substrings are not allowed in the <code>s3 key</code> portion of the <code>outputURI</code> field: ':', '//', '/./', '/../'.</p>
157
169
  * <p>Amazon ML needs permissions to store and retrieve the logs on your behalf. For information about how to set permissions, see the <a href="https://docs.aws.amazon.com/machine-learning/latest/dg">Amazon Machine Learning Developer Guide</a>.</p>
158
170
  */
@@ -167,6 +179,7 @@ export interface CreateBatchPredictionInput {
167
179
  */
168
180
  export interface CreateBatchPredictionOutput {
169
181
  /**
182
+ * @public
170
183
  * <p>A user-supplied ID that uniquely identifies the <code>BatchPrediction</code>. This value is identical to the value of the
171
184
  * <code>BatchPredictionId</code> in the request.</p>
172
185
  */
@@ -191,11 +204,13 @@ export declare class IdempotentParameterMismatchException extends __BaseExceptio
191
204
  */
192
205
  export interface RDSDatabaseCredentials {
193
206
  /**
207
+ * @public
194
208
  * <p>The username to be used by Amazon ML to connect to database on an Amazon RDS instance.
195
209
  * The username should have sufficient permissions to execute an <code>RDSSelectSqlQuery</code> query.</p>
196
210
  */
197
211
  Username: string | undefined;
198
212
  /**
213
+ * @public
199
214
  * <p>The password to be used by Amazon ML to connect to a database on an RDS DB instance.
200
215
  * The password should have sufficient permissions to execute the <code>RDSSelectQuery</code> query.</p>
201
216
  */
@@ -207,10 +222,12 @@ export interface RDSDatabaseCredentials {
207
222
  */
208
223
  export interface RDSDatabase {
209
224
  /**
225
+ * @public
210
226
  * <p>The ID of an RDS DB instance.</p>
211
227
  */
212
228
  InstanceIdentifier: string | undefined;
213
229
  /**
230
+ * @public
214
231
  * <p>The name of a database hosted on an RDS DB instance.</p>
215
232
  */
216
233
  DatabaseName: string | undefined;
@@ -221,22 +238,27 @@ export interface RDSDatabase {
221
238
  */
222
239
  export interface RDSDataSpec {
223
240
  /**
241
+ * @public
224
242
  * <p>Describes the <code>DatabaseName</code> and <code>InstanceIdentifier</code> of an Amazon RDS database.</p>
225
243
  */
226
244
  DatabaseInformation: RDSDatabase | undefined;
227
245
  /**
246
+ * @public
228
247
  * <p>The query that is used to retrieve the observation data for the <code>DataSource</code>.</p>
229
248
  */
230
249
  SelectSqlQuery: string | undefined;
231
250
  /**
251
+ * @public
232
252
  * <p>The AWS Identity and Access Management (IAM) credentials that are used connect to the Amazon RDS database.</p>
233
253
  */
234
254
  DatabaseCredentials: RDSDatabaseCredentials | undefined;
235
255
  /**
256
+ * @public
236
257
  * <p>The Amazon S3 location for staging Amazon RDS data. The data retrieved from Amazon RDS using <code>SelectSqlQuery</code> is stored in this location.</p>
237
258
  */
238
259
  S3StagingLocation: string | undefined;
239
260
  /**
261
+ * @public
240
262
  * <p>A JSON string that represents the splitting and rearrangement
241
263
  * processing to be applied to a <code>DataSource</code>. If the <code>DataRearrangement</code>
242
264
  * parameter is not provided, all of the input data is used to create the <code>Datasource</code>.</p>
@@ -326,6 +348,7 @@ export interface RDSDataSpec {
326
348
  */
327
349
  DataRearrangement?: string;
328
350
  /**
351
+ * @public
329
352
  * <p>A JSON string that represents the schema for an Amazon RDS
330
353
  * <code>DataSource</code>. The <code>DataSchema</code>
331
354
  * defines the structure of the observation data in the data file(s)
@@ -348,22 +371,27 @@ export interface RDSDataSpec {
348
371
  */
349
372
  DataSchema?: string;
350
373
  /**
374
+ * @public
351
375
  * <p>The Amazon S3 location of the <code>DataSchema</code>. </p>
352
376
  */
353
377
  DataSchemaUri?: string;
354
378
  /**
379
+ * @public
355
380
  * <p>The role (DataPipelineDefaultResourceRole) assumed by an Amazon Elastic Compute Cloud (Amazon EC2) instance to carry out the copy operation from Amazon RDS to an Amazon S3 task. For more information, see <a href="https://docs.aws.amazon.com/datapipeline/latest/DeveloperGuide/dp-iam-roles.html">Role templates</a> for data pipelines.</p>
356
381
  */
357
382
  ResourceRole: string | undefined;
358
383
  /**
384
+ * @public
359
385
  * <p>The role (DataPipelineDefaultRole) assumed by AWS Data Pipeline service to monitor the progress of the copy task from Amazon RDS to Amazon S3. For more information, see <a href="https://docs.aws.amazon.com/datapipeline/latest/DeveloperGuide/dp-iam-roles.html">Role templates</a> for data pipelines.</p>
360
386
  */
361
387
  ServiceRole: string | undefined;
362
388
  /**
389
+ * @public
363
390
  * <p>The subnet ID to be used to access a VPC-based RDS DB instance. This attribute is used by Data Pipeline to carry out the copy task from Amazon RDS to Amazon S3.</p>
364
391
  */
365
392
  SubnetId: string | undefined;
366
393
  /**
394
+ * @public
367
395
  * <p>The security group IDs to be used to access a VPC-based RDS DB instance. Ensure that there are appropriate ingress rules set up to allow access to the RDS DB instance. This attribute is used by Data Pipeline to carry out the copy operation from Amazon RDS to an Amazon S3 task.</p>
368
396
  */
369
397
  SecurityGroupIds: string[] | undefined;
@@ -373,15 +401,18 @@ export interface RDSDataSpec {
373
401
  */
374
402
  export interface CreateDataSourceFromRDSInput {
375
403
  /**
404
+ * @public
376
405
  * <p>A user-supplied ID that uniquely identifies the <code>DataSource</code>. Typically, an Amazon Resource Number (ARN)
377
406
  * becomes the ID for a <code>DataSource</code>.</p>
378
407
  */
379
408
  DataSourceId: string | undefined;
380
409
  /**
410
+ * @public
381
411
  * <p>A user-supplied name or description of the <code>DataSource</code>.</p>
382
412
  */
383
413
  DataSourceName?: string;
384
414
  /**
415
+ * @public
385
416
  * <p>The data specification of an Amazon RDS <code>DataSource</code>:</p>
386
417
  * <ul>
387
418
  * <li>
@@ -433,12 +464,14 @@ export interface CreateDataSourceFromRDSInput {
433
464
  */
434
465
  RDSData: RDSDataSpec | undefined;
435
466
  /**
467
+ * @public
436
468
  * <p>The role that Amazon ML assumes on behalf of the user to create and activate a data
437
469
  * pipeline in the user's account and copy data using the <code>SelectSqlQuery</code> query from Amazon RDS to Amazon S3.</p>
438
470
  * <p></p>
439
471
  */
440
472
  RoleARN: string | undefined;
441
473
  /**
474
+ * @public
442
475
  * <p>The compute statistics for a <code>DataSource</code>. The statistics are generated from the observation data referenced by
443
476
  * a <code>DataSource</code>. Amazon ML uses the statistics internally during <code>MLModel</code> training.
444
477
  * This parameter must be set to <code>true</code> if the <code></code>DataSource<code></code> needs to be used for <code>MLModel</code> training.
@@ -457,6 +490,7 @@ export interface CreateDataSourceFromRDSInput {
457
490
  */
458
491
  export interface CreateDataSourceFromRDSOutput {
459
492
  /**
493
+ * @public
460
494
  * <p>A user-supplied ID that uniquely identifies the datasource. This value should be identical to the value of the
461
495
  * <code>DataSourceID</code> in the request.
462
496
  * </p>
@@ -469,11 +503,13 @@ export interface CreateDataSourceFromRDSOutput {
469
503
  */
470
504
  export interface RedshiftDatabaseCredentials {
471
505
  /**
506
+ * @public
472
507
  * <p>A username to be used by Amazon Machine Learning (Amazon ML)to connect to a database on an Amazon Redshift cluster.
473
508
  * The username should have sufficient permissions to execute the <code>RedshiftSelectSqlQuery</code> query. The username should be valid for an Amazon Redshift <a href="https://docs.aws.amazon.com/redshift/latest/dg/r_CREATE_USER.html">USER</a>.</p>
474
509
  */
475
510
  Username: string | undefined;
476
511
  /**
512
+ * @public
477
513
  * <p>A password to be used by Amazon ML to connect to a database on an Amazon Redshift cluster.
478
514
  * The password should have sufficient permissions to execute a <code>RedshiftSelectSqlQuery</code> query. The password should be valid for an Amazon Redshift <a href="https://docs.aws.amazon.com/redshift/latest/dg/r_CREATE_USER.html">USER</a>.</p>
479
515
  */
@@ -485,10 +521,12 @@ export interface RedshiftDatabaseCredentials {
485
521
  */
486
522
  export interface RedshiftDatabase {
487
523
  /**
524
+ * @public
488
525
  * <p>The name of a database hosted on an Amazon Redshift cluster.</p>
489
526
  */
490
527
  DatabaseName: string | undefined;
491
528
  /**
529
+ * @public
492
530
  * <p>The ID of an Amazon Redshift cluster.</p>
493
531
  */
494
532
  ClusterIdentifier: string | undefined;
@@ -499,22 +537,27 @@ export interface RedshiftDatabase {
499
537
  */
500
538
  export interface RedshiftDataSpec {
501
539
  /**
540
+ * @public
502
541
  * <p>Describes the <code>DatabaseName</code> and <code>ClusterIdentifier</code> for an Amazon Redshift <code>DataSource</code>.</p>
503
542
  */
504
543
  DatabaseInformation: RedshiftDatabase | undefined;
505
544
  /**
545
+ * @public
506
546
  * <p>Describes the SQL Query to execute on an Amazon Redshift database for an Amazon Redshift <code>DataSource</code>.</p>
507
547
  */
508
548
  SelectSqlQuery: string | undefined;
509
549
  /**
550
+ * @public
510
551
  * <p>Describes AWS Identity and Access Management (IAM) credentials that are used connect to the Amazon Redshift database.</p>
511
552
  */
512
553
  DatabaseCredentials: RedshiftDatabaseCredentials | undefined;
513
554
  /**
555
+ * @public
514
556
  * <p>Describes an Amazon S3 location to store the result set of the <code>SelectSqlQuery</code> query.</p>
515
557
  */
516
558
  S3StagingLocation: string | undefined;
517
559
  /**
560
+ * @public
518
561
  * <p>A JSON string that represents the splitting and rearrangement
519
562
  * processing to be applied to a <code>DataSource</code>. If the <code>DataRearrangement</code>
520
563
  * parameter is not provided, all of the input data is used to create the <code>Datasource</code>.</p>
@@ -604,6 +647,7 @@ export interface RedshiftDataSpec {
604
647
  */
605
648
  DataRearrangement?: string;
606
649
  /**
650
+ * @public
607
651
  * <p>A JSON string that represents the schema for an Amazon Redshift
608
652
  * <code>DataSource</code>. The <code>DataSchema</code>
609
653
  * defines the structure of the observation data in the data file(s)
@@ -625,6 +669,7 @@ export interface RedshiftDataSpec {
625
669
  */
626
670
  DataSchema?: string;
627
671
  /**
672
+ * @public
628
673
  * <p>Describes the schema location for an Amazon Redshift <code>DataSource</code>.</p>
629
674
  */
630
675
  DataSchemaUri?: string;
@@ -634,14 +679,17 @@ export interface RedshiftDataSpec {
634
679
  */
635
680
  export interface CreateDataSourceFromRedshiftInput {
636
681
  /**
682
+ * @public
637
683
  * <p>A user-supplied ID that uniquely identifies the <code>DataSource</code>.</p>
638
684
  */
639
685
  DataSourceId: string | undefined;
640
686
  /**
687
+ * @public
641
688
  * <p>A user-supplied name or description of the <code>DataSource</code>. </p>
642
689
  */
643
690
  DataSourceName?: string;
644
691
  /**
692
+ * @public
645
693
  * <p>The data specification of an Amazon Redshift <code>DataSource</code>:</p>
646
694
  * <ul>
647
695
  * <li>
@@ -685,6 +733,7 @@ export interface CreateDataSourceFromRedshiftInput {
685
733
  */
686
734
  DataSpec: RedshiftDataSpec | undefined;
687
735
  /**
736
+ * @public
688
737
  * <p>A fully specified role Amazon Resource Name (ARN). Amazon ML assumes the role on behalf of the user to create the following:</p>
689
738
  *
690
739
  * <ul>
@@ -699,6 +748,7 @@ export interface CreateDataSourceFromRedshiftInput {
699
748
  */
700
749
  RoleARN: string | undefined;
701
750
  /**
751
+ * @public
702
752
  * <p>The compute statistics for a <code>DataSource</code>. The statistics are generated from the observation data referenced by
703
753
  * a <code>DataSource</code>. Amazon ML uses the statistics internally during <code>MLModel</code> training.
704
754
  * This parameter must be set to <code>true</code> if the <code>DataSource</code> needs to
@@ -714,6 +764,7 @@ export interface CreateDataSourceFromRedshiftInput {
714
764
  */
715
765
  export interface CreateDataSourceFromRedshiftOutput {
716
766
  /**
767
+ * @public
717
768
  * <p>A user-supplied ID that uniquely identifies the datasource. This value should be identical to the value of the
718
769
  * <code>DataSourceID</code> in the request.
719
770
  * </p>
@@ -726,11 +777,13 @@ export interface CreateDataSourceFromRedshiftOutput {
726
777
  */
727
778
  export interface S3DataSpec {
728
779
  /**
780
+ * @public
729
781
  * <p>The location of the data file(s) used by a <code>DataSource</code>. The URI specifies a data file or
730
782
  * an Amazon Simple Storage Service (Amazon S3) directory or bucket containing data files.</p>
731
783
  */
732
784
  DataLocationS3: string | undefined;
733
785
  /**
786
+ * @public
734
787
  * <p>A JSON string that represents the splitting and rearrangement
735
788
  * processing to be applied to a <code>DataSource</code>. If the <code>DataRearrangement</code>
736
789
  * parameter is not provided, all of the input data is used to create the <code>Datasource</code>.</p>
@@ -820,6 +873,7 @@ export interface S3DataSpec {
820
873
  */
821
874
  DataRearrangement?: string;
822
875
  /**
876
+ * @public
823
877
  * <p> A JSON string that represents the schema for an Amazon S3
824
878
  * <code>DataSource</code>. The <code>DataSchema</code>
825
879
  * defines the structure of the observation data in the data file(s)
@@ -840,6 +894,7 @@ export interface S3DataSpec {
840
894
  */
841
895
  DataSchema?: string;
842
896
  /**
897
+ * @public
843
898
  * <p>Describes the schema location in Amazon S3. You must provide either the
844
899
  * <code>DataSchema</code> or the <code>DataSchemaLocationS3</code>.</p>
845
900
  */
@@ -850,14 +905,17 @@ export interface S3DataSpec {
850
905
  */
851
906
  export interface CreateDataSourceFromS3Input {
852
907
  /**
908
+ * @public
853
909
  * <p>A user-supplied identifier that uniquely identifies the <code>DataSource</code>. </p>
854
910
  */
855
911
  DataSourceId: string | undefined;
856
912
  /**
913
+ * @public
857
914
  * <p>A user-supplied name or description of the <code>DataSource</code>. </p>
858
915
  */
859
916
  DataSourceName?: string;
860
917
  /**
918
+ * @public
861
919
  * <p>The data specification of a <code>DataSource</code>:</p>
862
920
  * <ul>
863
921
  * <li>
@@ -879,6 +937,7 @@ export interface CreateDataSourceFromS3Input {
879
937
  */
880
938
  DataSpec: S3DataSpec | undefined;
881
939
  /**
940
+ * @public
882
941
  * <p>The compute statistics for a <code>DataSource</code>. The statistics are generated from the observation data referenced by
883
942
  * a <code>DataSource</code>. Amazon ML uses the statistics internally during <code>MLModel</code> training.
884
943
  * This parameter must be set to <code>true</code> if the <code></code>DataSource<code></code> needs to be used for <code>MLModel</code> training.</p>
@@ -893,6 +952,7 @@ export interface CreateDataSourceFromS3Input {
893
952
  */
894
953
  export interface CreateDataSourceFromS3Output {
895
954
  /**
955
+ * @public
896
956
  * <p>A user-supplied ID that uniquely identifies the <code>DataSource</code>. This value should be identical to the value of the
897
957
  * <code>DataSourceID</code> in the request.
898
958
  * </p>
@@ -904,19 +964,23 @@ export interface CreateDataSourceFromS3Output {
904
964
  */
905
965
  export interface CreateEvaluationInput {
906
966
  /**
967
+ * @public
907
968
  * <p>A user-supplied ID that uniquely identifies the <code>Evaluation</code>.</p>
908
969
  */
909
970
  EvaluationId: string | undefined;
910
971
  /**
972
+ * @public
911
973
  * <p>A user-supplied name or description of the <code>Evaluation</code>.</p>
912
974
  */
913
975
  EvaluationName?: string;
914
976
  /**
977
+ * @public
915
978
  * <p>The ID of the <code>MLModel</code> to evaluate.</p>
916
979
  * <p>The schema used in creating the <code>MLModel</code> must match the schema of the <code>DataSource</code> used in the <code>Evaluation</code>.</p>
917
980
  */
918
981
  MLModelId: string | undefined;
919
982
  /**
983
+ * @public
920
984
  * <p>The ID of the <code>DataSource</code> for the evaluation. The schema of the <code>DataSource</code>
921
985
  * must match the schema used to create the <code>MLModel</code>.</p>
922
986
  */
@@ -933,6 +997,7 @@ export interface CreateEvaluationInput {
933
997
  */
934
998
  export interface CreateEvaluationOutput {
935
999
  /**
1000
+ * @public
936
1001
  * <p>The user-supplied ID that uniquely identifies the <code>Evaluation</code>. This value should be identical to the value of the
937
1002
  * <code>EvaluationId</code> in the request.</p>
938
1003
  */
@@ -956,14 +1021,17 @@ export type MLModelType = (typeof MLModelType)[keyof typeof MLModelType];
956
1021
  */
957
1022
  export interface CreateMLModelInput {
958
1023
  /**
1024
+ * @public
959
1025
  * <p>A user-supplied ID that uniquely identifies the <code>MLModel</code>.</p>
960
1026
  */
961
1027
  MLModelId: string | undefined;
962
1028
  /**
1029
+ * @public
963
1030
  * <p>A user-supplied name or description of the <code>MLModel</code>.</p>
964
1031
  */
965
1032
  MLModelName?: string;
966
1033
  /**
1034
+ * @public
967
1035
  * <p>The category of supervised learning that this <code>MLModel</code> will address. Choose from the following types:</p>
968
1036
  * <ul>
969
1037
  * <li>
@@ -980,6 +1048,7 @@ export interface CreateMLModelInput {
980
1048
  */
981
1049
  MLModelType: MLModelType | string | undefined;
982
1050
  /**
1051
+ * @public
983
1052
  * <p>A list of the training parameters in the <code>MLModel</code>. The list is implemented as
984
1053
  * a map of key-value pairs.</p>
985
1054
  * <p>The following is the current set of training parameters:</p>
@@ -1028,15 +1097,18 @@ export interface CreateMLModelInput {
1028
1097
  */
1029
1098
  Parameters?: Record<string, string>;
1030
1099
  /**
1100
+ * @public
1031
1101
  * <p>The <code>DataSource</code> that points to the training data.</p>
1032
1102
  */
1033
1103
  TrainingDataSourceId: string | undefined;
1034
1104
  /**
1105
+ * @public
1035
1106
  * <p>The data recipe for creating the <code>MLModel</code>. You must specify either the recipe
1036
1107
  * or its URI. If you don't specify a recipe or its URI, Amazon ML creates a default.</p>
1037
1108
  */
1038
1109
  Recipe?: string;
1039
1110
  /**
1111
+ * @public
1040
1112
  * <p>The Amazon Simple Storage Service (Amazon S3) location and file name that contains the <code>MLModel</code> recipe. You must specify either the recipe or its URI. If you don't specify a recipe or its URI, Amazon ML creates a default.</p>
1041
1113
  */
1042
1114
  RecipeUri?: string;
@@ -1050,6 +1122,7 @@ export interface CreateMLModelInput {
1050
1122
  */
1051
1123
  export interface CreateMLModelOutput {
1052
1124
  /**
1125
+ * @public
1053
1126
  * <p>A user-supplied ID that uniquely identifies the <code>MLModel</code>. This value should be identical to the value of the
1054
1127
  * <code>MLModelId</code> in the request.
1055
1128
  * </p>
@@ -1061,6 +1134,7 @@ export interface CreateMLModelOutput {
1061
1134
  */
1062
1135
  export interface CreateRealtimeEndpointInput {
1063
1136
  /**
1137
+ * @public
1064
1138
  * <p>The ID assigned to the <code>MLModel</code> during creation.</p>
1065
1139
  */
1066
1140
  MLModelId: string | undefined;
@@ -1085,20 +1159,24 @@ export type RealtimeEndpointStatus = (typeof RealtimeEndpointStatus)[keyof typeo
1085
1159
  */
1086
1160
  export interface RealtimeEndpointInfo {
1087
1161
  /**
1162
+ * @public
1088
1163
  * <p> The maximum processing rate for the real-time endpoint for <code>MLModel</code>, measured in incoming requests per second.</p>
1089
1164
  */
1090
1165
  PeakRequestsPerSecond?: number;
1091
1166
  /**
1167
+ * @public
1092
1168
  * <p>The time that the request to create the real-time endpoint for the <code>MLModel</code> was received. The time is expressed in epoch time.</p>
1093
1169
  */
1094
1170
  CreatedAt?: Date;
1095
1171
  /**
1172
+ * @public
1096
1173
  * <p>The URI that specifies where to send real-time prediction requests for the <code>MLModel</code>.</p>
1097
1174
  * <p>
1098
1175
  * <b>Note:</b> The application must wait until the real-time endpoint is ready before using this URI.</p>
1099
1176
  */
1100
1177
  EndpointUrl?: string;
1101
1178
  /**
1179
+ * @public
1102
1180
  * <p> The current status of the real-time endpoint for the <code>MLModel</code>. This element can have one of the following values: </p>
1103
1181
  * <ul>
1104
1182
  * <li>
@@ -1126,11 +1204,13 @@ export interface RealtimeEndpointInfo {
1126
1204
  */
1127
1205
  export interface CreateRealtimeEndpointOutput {
1128
1206
  /**
1207
+ * @public
1129
1208
  * <p>A user-supplied ID that uniquely identifies the <code>MLModel</code>. This value should be identical to the value of the
1130
1209
  * <code>MLModelId</code> in the request.</p>
1131
1210
  */
1132
1211
  MLModelId?: string;
1133
1212
  /**
1213
+ * @public
1134
1214
  * <p>The endpoint information of the <code>MLModel</code>
1135
1215
  * </p>
1136
1216
  */
@@ -1141,6 +1221,7 @@ export interface CreateRealtimeEndpointOutput {
1141
1221
  */
1142
1222
  export interface DeleteBatchPredictionInput {
1143
1223
  /**
1224
+ * @public
1144
1225
  * <p>A user-supplied ID that uniquely identifies the <code>BatchPrediction</code>.</p>
1145
1226
  */
1146
1227
  BatchPredictionId: string | undefined;
@@ -1153,6 +1234,7 @@ export interface DeleteBatchPredictionInput {
1153
1234
  */
1154
1235
  export interface DeleteBatchPredictionOutput {
1155
1236
  /**
1237
+ * @public
1156
1238
  * <p>A user-supplied ID that uniquely identifies the <code>BatchPrediction</code>. This value should be identical to the value of the <code>BatchPredictionID</code> in the request.</p>
1157
1239
  */
1158
1240
  BatchPredictionId?: string;
@@ -1162,6 +1244,7 @@ export interface DeleteBatchPredictionOutput {
1162
1244
  */
1163
1245
  export interface DeleteDataSourceInput {
1164
1246
  /**
1247
+ * @public
1165
1248
  * <p>A user-supplied ID that uniquely identifies the <code>DataSource</code>.</p>
1166
1249
  */
1167
1250
  DataSourceId: string | undefined;
@@ -1172,6 +1255,7 @@ export interface DeleteDataSourceInput {
1172
1255
  */
1173
1256
  export interface DeleteDataSourceOutput {
1174
1257
  /**
1258
+ * @public
1175
1259
  * <p>A user-supplied ID that uniquely identifies the <code>DataSource</code>. This value should be identical to the value of the <code>DataSourceID</code> in the request.</p>
1176
1260
  */
1177
1261
  DataSourceId?: string;
@@ -1181,6 +1265,7 @@ export interface DeleteDataSourceOutput {
1181
1265
  */
1182
1266
  export interface DeleteEvaluationInput {
1183
1267
  /**
1268
+ * @public
1184
1269
  * <p>A user-supplied ID that uniquely identifies the <code>Evaluation</code> to delete.</p>
1185
1270
  */
1186
1271
  EvaluationId: string | undefined;
@@ -1193,6 +1278,7 @@ export interface DeleteEvaluationInput {
1193
1278
  */
1194
1279
  export interface DeleteEvaluationOutput {
1195
1280
  /**
1281
+ * @public
1196
1282
  * <p>A user-supplied ID that uniquely identifies the <code>Evaluation</code>. This value should be identical to the value of the <code>EvaluationId</code> in the request.</p>
1197
1283
  */
1198
1284
  EvaluationId?: string;
@@ -1202,6 +1288,7 @@ export interface DeleteEvaluationOutput {
1202
1288
  */
1203
1289
  export interface DeleteMLModelInput {
1204
1290
  /**
1291
+ * @public
1205
1292
  * <p>A user-supplied ID that uniquely identifies the <code>MLModel</code>.</p>
1206
1293
  */
1207
1294
  MLModelId: string | undefined;
@@ -1214,6 +1301,7 @@ export interface DeleteMLModelInput {
1214
1301
  */
1215
1302
  export interface DeleteMLModelOutput {
1216
1303
  /**
1304
+ * @public
1217
1305
  * <p>A user-supplied ID that uniquely identifies the <code>MLModel</code>. This value should be identical to the value of the <code>MLModelID</code> in the request.</p>
1218
1306
  */
1219
1307
  MLModelId?: string;
@@ -1223,6 +1311,7 @@ export interface DeleteMLModelOutput {
1223
1311
  */
1224
1312
  export interface DeleteRealtimeEndpointInput {
1225
1313
  /**
1314
+ * @public
1226
1315
  * <p>The ID assigned to the <code>MLModel</code> during creation.</p>
1227
1316
  */
1228
1317
  MLModelId: string | undefined;
@@ -1234,11 +1323,13 @@ export interface DeleteRealtimeEndpointInput {
1234
1323
  */
1235
1324
  export interface DeleteRealtimeEndpointOutput {
1236
1325
  /**
1326
+ * @public
1237
1327
  * <p>A user-supplied ID that uniquely identifies the <code>MLModel</code>. This value should be identical to the value of the
1238
1328
  * <code>MLModelId</code> in the request.</p>
1239
1329
  */
1240
1330
  MLModelId?: string;
1241
1331
  /**
1332
+ * @public
1242
1333
  * <p>The endpoint information of the <code>MLModel</code>
1243
1334
  * </p>
1244
1335
  */
@@ -1249,14 +1340,17 @@ export interface DeleteRealtimeEndpointOutput {
1249
1340
  */
1250
1341
  export interface DeleteTagsInput {
1251
1342
  /**
1343
+ * @public
1252
1344
  * <p>One or more tags to delete.</p>
1253
1345
  */
1254
1346
  TagKeys: string[] | undefined;
1255
1347
  /**
1348
+ * @public
1256
1349
  * <p>The ID of the tagged ML object. For example, <code>exampleModelId</code>.</p>
1257
1350
  */
1258
1351
  ResourceId: string | undefined;
1259
1352
  /**
1353
+ * @public
1260
1354
  * <p>The type of the tagged ML object.</p>
1261
1355
  */
1262
1356
  ResourceType: TaggableResourceType | string | undefined;
@@ -1267,10 +1361,12 @@ export interface DeleteTagsInput {
1267
1361
  */
1268
1362
  export interface DeleteTagsOutput {
1269
1363
  /**
1364
+ * @public
1270
1365
  * <p>The ID of the ML object from which tags were deleted.</p>
1271
1366
  */
1272
1367
  ResourceId?: string;
1273
1368
  /**
1369
+ * @public
1274
1370
  * <p>The type of the ML object from which tags were deleted.</p>
1275
1371
  */
1276
1372
  ResourceType?: TaggableResourceType | string;
@@ -1310,6 +1406,7 @@ export type SortOrder = (typeof SortOrder)[keyof typeof SortOrder];
1310
1406
  */
1311
1407
  export interface DescribeBatchPredictionsInput {
1312
1408
  /**
1409
+ * @public
1313
1410
  * <p>Use one of the following variables to filter a list of <code>BatchPrediction</code>:</p>
1314
1411
  * <ul>
1315
1412
  * <li>
@@ -1346,34 +1443,41 @@ export interface DescribeBatchPredictionsInput {
1346
1443
  */
1347
1444
  FilterVariable?: BatchPredictionFilterVariable | string;
1348
1445
  /**
1446
+ * @public
1349
1447
  * <p>The equal to operator. The <code>BatchPrediction</code> results will have
1350
1448
  * <code>FilterVariable</code> values that exactly match the value specified with <code>EQ</code>.</p>
1351
1449
  */
1352
1450
  EQ?: string;
1353
1451
  /**
1452
+ * @public
1354
1453
  * <p>The greater than operator. The <code>BatchPrediction</code> results will
1355
1454
  * have <code>FilterVariable</code> values that are greater than the value specified with <code>GT</code>.</p>
1356
1455
  */
1357
1456
  GT?: string;
1358
1457
  /**
1458
+ * @public
1359
1459
  * <p>The less than operator. The <code>BatchPrediction</code> results will
1360
1460
  * have <code>FilterVariable</code> values that are less than the value specified with <code>LT</code>.</p>
1361
1461
  */
1362
1462
  LT?: string;
1363
1463
  /**
1464
+ * @public
1364
1465
  * <p>The greater than or equal to operator. The <code>BatchPrediction</code> results will have <code>FilterVariable</code> values that are greater than or equal to the value specified with <code>GE</code>.
1365
1466
  * </p>
1366
1467
  */
1367
1468
  GE?: string;
1368
1469
  /**
1470
+ * @public
1369
1471
  * <p>The less than or equal to operator. The <code>BatchPrediction</code> results will have <code>FilterVariable</code> values that are less than or equal to the value specified with <code>LE</code>.</p>
1370
1472
  */
1371
1473
  LE?: string;
1372
1474
  /**
1475
+ * @public
1373
1476
  * <p>The not equal to operator. The <code>BatchPrediction</code> results will have <code>FilterVariable</code> values not equal to the value specified with <code>NE</code>.</p>
1374
1477
  */
1375
1478
  NE?: string;
1376
1479
  /**
1480
+ * @public
1377
1481
  * <p>A string that is found at the beginning of a variable, such as <code>Name</code> or <code>Id</code>.</p>
1378
1482
  * <p>For example, a <code>Batch Prediction</code> operation could have the <code>Name</code>
1379
1483
  * <code>2014-09-09-HolidayGiftMailer</code>. To search for
@@ -1395,6 +1499,7 @@ export interface DescribeBatchPredictionsInput {
1395
1499
  */
1396
1500
  Prefix?: string;
1397
1501
  /**
1502
+ * @public
1398
1503
  * <p>A two-value parameter that determines the sequence of the resulting list of <code>MLModel</code>s.</p>
1399
1504
  * <ul>
1400
1505
  * <li>
@@ -1410,10 +1515,12 @@ export interface DescribeBatchPredictionsInput {
1410
1515
  */
1411
1516
  SortOrder?: SortOrder | string;
1412
1517
  /**
1518
+ * @public
1413
1519
  * <p>An ID of the page in the paginated results.</p>
1414
1520
  */
1415
1521
  NextToken?: string;
1416
1522
  /**
1523
+ * @public
1417
1524
  * <p>The number of pages of information to include in the result. The range of acceptable values is <code>1</code> through <code>100</code>. The default value is <code>100</code>.</p>
1418
1525
  */
1419
1526
  Limit?: number;
@@ -1441,40 +1548,49 @@ export type EntityStatus = (typeof EntityStatus)[keyof typeof EntityStatus];
1441
1548
  */
1442
1549
  export interface BatchPrediction {
1443
1550
  /**
1551
+ * @public
1444
1552
  * <p>The ID assigned to the <code>BatchPrediction</code> at creation. This value should be identical to the value of the <code>BatchPredictionID</code>
1445
1553
  * in the request.
1446
1554
  * </p>
1447
1555
  */
1448
1556
  BatchPredictionId?: string;
1449
1557
  /**
1558
+ * @public
1450
1559
  * <p>The ID of the <code>MLModel</code> that generated predictions for the <code>BatchPrediction</code> request.</p>
1451
1560
  */
1452
1561
  MLModelId?: string;
1453
1562
  /**
1563
+ * @public
1454
1564
  * <p>The ID of the <code>DataSource</code> that points to the group of observations to predict.</p>
1455
1565
  */
1456
1566
  BatchPredictionDataSourceId?: string;
1457
1567
  /**
1568
+ * @public
1458
1569
  * <p>The location of the data file or directory in Amazon Simple Storage Service (Amazon S3).</p>
1459
1570
  */
1460
1571
  InputDataLocationS3?: string;
1461
1572
  /**
1573
+ * @public
1462
1574
  * <p>The AWS user account that invoked the <code>BatchPrediction</code>. The account type can be either an AWS root account or an AWS Identity and Access Management (IAM) user account.</p>
1463
1575
  */
1464
1576
  CreatedByIamUser?: string;
1465
1577
  /**
1578
+ * @public
1466
1579
  * <p>The time that the <code>BatchPrediction</code> was created. The time is expressed in epoch time.</p>
1467
1580
  */
1468
1581
  CreatedAt?: Date;
1469
1582
  /**
1583
+ * @public
1470
1584
  * <p>The time of the most recent edit to the <code>BatchPrediction</code>. The time is expressed in epoch time.</p>
1471
1585
  */
1472
1586
  LastUpdatedAt?: Date;
1473
1587
  /**
1588
+ * @public
1474
1589
  * <p>A user-supplied name or description of the <code>BatchPrediction</code>.</p>
1475
1590
  */
1476
1591
  Name?: string;
1477
1592
  /**
1593
+ * @public
1478
1594
  * <p>The status of the <code>BatchPrediction</code>. This element can have one of the following values:</p>
1479
1595
  * <ul>
1480
1596
  * <li>
@@ -1501,30 +1617,37 @@ export interface BatchPrediction {
1501
1617
  */
1502
1618
  Status?: EntityStatus | string;
1503
1619
  /**
1620
+ * @public
1504
1621
  * <p>The location of an Amazon S3 bucket or directory to receive the operation results. The following substrings are not allowed in the <code>s3 key</code> portion of the <code>outputURI</code> field: ':', '//', '/./', '/../'.</p>
1505
1622
  */
1506
1623
  OutputUri?: string;
1507
1624
  /**
1625
+ * @public
1508
1626
  * <p>A description of the most recent details about processing the batch prediction request.</p>
1509
1627
  */
1510
1628
  Message?: string;
1511
1629
  /**
1630
+ * @public
1512
1631
  * <p>Long integer type that is a 64-bit signed number.</p>
1513
1632
  */
1514
1633
  ComputeTime?: number;
1515
1634
  /**
1635
+ * @public
1516
1636
  * <p>A timestamp represented in epoch time.</p>
1517
1637
  */
1518
1638
  FinishedAt?: Date;
1519
1639
  /**
1640
+ * @public
1520
1641
  * <p>A timestamp represented in epoch time.</p>
1521
1642
  */
1522
1643
  StartedAt?: Date;
1523
1644
  /**
1645
+ * @public
1524
1646
  * <p>Long integer type that is a 64-bit signed number.</p>
1525
1647
  */
1526
1648
  TotalRecordCount?: number;
1527
1649
  /**
1650
+ * @public
1528
1651
  * <p>Long integer type that is a 64-bit signed number.</p>
1529
1652
  */
1530
1653
  InvalidRecordCount?: number;
@@ -1535,11 +1658,13 @@ export interface BatchPrediction {
1535
1658
  */
1536
1659
  export interface DescribeBatchPredictionsOutput {
1537
1660
  /**
1661
+ * @public
1538
1662
  * <p>A list of <code>BatchPrediction</code> objects that meet the search criteria.
1539
1663
  * </p>
1540
1664
  */
1541
1665
  Results?: BatchPrediction[];
1542
1666
  /**
1667
+ * @public
1543
1668
  * <p>The ID of the next page in the paginated results that indicates at least one more page follows.</p>
1544
1669
  */
1545
1670
  NextToken?: string;
@@ -1565,6 +1690,7 @@ export type DataSourceFilterVariable = (typeof DataSourceFilterVariable)[keyof t
1565
1690
  */
1566
1691
  export interface DescribeDataSourcesInput {
1567
1692
  /**
1693
+ * @public
1568
1694
  * <p>Use one of the following variables to filter a list of <code>DataSource</code>:</p>
1569
1695
  * <ul>
1570
1696
  * <li>
@@ -1592,34 +1718,41 @@ export interface DescribeDataSourcesInput {
1592
1718
  */
1593
1719
  FilterVariable?: DataSourceFilterVariable | string;
1594
1720
  /**
1721
+ * @public
1595
1722
  * <p>The equal to operator. The <code>DataSource</code> results will have
1596
1723
  * <code>FilterVariable</code> values that exactly match the value specified with <code>EQ</code>.</p>
1597
1724
  */
1598
1725
  EQ?: string;
1599
1726
  /**
1727
+ * @public
1600
1728
  * <p>The greater than operator. The <code>DataSource</code> results will
1601
1729
  * have <code>FilterVariable</code> values that are greater than the value specified with <code>GT</code>.</p>
1602
1730
  */
1603
1731
  GT?: string;
1604
1732
  /**
1733
+ * @public
1605
1734
  * <p>The less than operator. The <code>DataSource</code> results will
1606
1735
  * have <code>FilterVariable</code> values that are less than the value specified with <code>LT</code>.</p>
1607
1736
  */
1608
1737
  LT?: string;
1609
1738
  /**
1739
+ * @public
1610
1740
  * <p>The greater than or equal to operator. The <code>DataSource</code> results will have <code>FilterVariable</code> values that are greater than or equal to the value specified with <code>GE</code>.
1611
1741
  * </p>
1612
1742
  */
1613
1743
  GE?: string;
1614
1744
  /**
1745
+ * @public
1615
1746
  * <p>The less than or equal to operator. The <code>DataSource</code> results will have <code>FilterVariable</code> values that are less than or equal to the value specified with <code>LE</code>.</p>
1616
1747
  */
1617
1748
  LE?: string;
1618
1749
  /**
1750
+ * @public
1619
1751
  * <p>The not equal to operator. The <code>DataSource</code> results will have <code>FilterVariable</code> values not equal to the value specified with <code>NE</code>.</p>
1620
1752
  */
1621
1753
  NE?: string;
1622
1754
  /**
1755
+ * @public
1623
1756
  * <p>A string that is found at the beginning of a variable, such as <code>Name</code> or <code>Id</code>.</p>
1624
1757
  * <p>For example, a <code>DataSource</code> could have the <code>Name</code>
1625
1758
  * <code>2014-09-09-HolidayGiftMailer</code>. To search for
@@ -1641,6 +1774,7 @@ export interface DescribeDataSourcesInput {
1641
1774
  */
1642
1775
  Prefix?: string;
1643
1776
  /**
1777
+ * @public
1644
1778
  * <p>A two-value parameter that determines the sequence of the resulting list of <code>DataSource</code>.</p>
1645
1779
  * <ul>
1646
1780
  * <li>
@@ -1656,10 +1790,12 @@ export interface DescribeDataSourcesInput {
1656
1790
  */
1657
1791
  SortOrder?: SortOrder | string;
1658
1792
  /**
1793
+ * @public
1659
1794
  * <p>The ID of the page in the paginated results.</p>
1660
1795
  */
1661
1796
  NextToken?: string;
1662
1797
  /**
1798
+ * @public
1663
1799
  * <p> The maximum number of <code>DataSource</code> to include in the result.</p>
1664
1800
  */
1665
1801
  Limit?: number;
@@ -1670,27 +1806,33 @@ export interface DescribeDataSourcesInput {
1670
1806
  */
1671
1807
  export interface RDSMetadata {
1672
1808
  /**
1809
+ * @public
1673
1810
  * <p>The database details required to connect to an Amazon RDS.</p>
1674
1811
  */
1675
1812
  Database?: RDSDatabase;
1676
1813
  /**
1814
+ * @public
1677
1815
  * <p>The username to be used by Amazon ML to connect to database on an Amazon RDS instance.
1678
1816
  * The username should have sufficient permissions to execute an <code>RDSSelectSqlQuery</code> query.</p>
1679
1817
  */
1680
1818
  DatabaseUserName?: string;
1681
1819
  /**
1820
+ * @public
1682
1821
  * <p>The SQL query that is supplied during <a>CreateDataSourceFromRDS</a>. Returns only if <code>Verbose</code> is true in <code>GetDataSourceInput</code>. </p>
1683
1822
  */
1684
1823
  SelectSqlQuery?: string;
1685
1824
  /**
1825
+ * @public
1686
1826
  * <p>The role (DataPipelineDefaultResourceRole) assumed by an Amazon EC2 instance to carry out the copy task from Amazon RDS to Amazon S3. For more information, see <a href="https://docs.aws.amazon.com/datapipeline/latest/DeveloperGuide/dp-iam-roles.html">Role templates</a> for data pipelines.</p>
1687
1827
  */
1688
1828
  ResourceRole?: string;
1689
1829
  /**
1830
+ * @public
1690
1831
  * <p>The role (DataPipelineDefaultRole) assumed by the Data Pipeline service to monitor the progress of the copy task from Amazon RDS to Amazon S3. For more information, see <a href="https://docs.aws.amazon.com/datapipeline/latest/DeveloperGuide/dp-iam-roles.html">Role templates</a> for data pipelines.</p>
1691
1832
  */
1692
1833
  ServiceRole?: string;
1693
1834
  /**
1835
+ * @public
1694
1836
  * <p>The ID of the Data Pipeline instance that is used to carry to copy data from Amazon RDS to Amazon S3. You can use the ID to find details about the instance in the Data Pipeline console.</p>
1695
1837
  */
1696
1838
  DataPipelineId?: string;
@@ -1701,15 +1843,18 @@ export interface RDSMetadata {
1701
1843
  */
1702
1844
  export interface RedshiftMetadata {
1703
1845
  /**
1846
+ * @public
1704
1847
  * <p>Describes the database details required to connect to an Amazon Redshift database.</p>
1705
1848
  */
1706
1849
  RedshiftDatabase?: RedshiftDatabase;
1707
1850
  /**
1851
+ * @public
1708
1852
  * <p>A username to be used by Amazon Machine Learning (Amazon ML)to connect to a database on an Amazon Redshift cluster.
1709
1853
  * The username should have sufficient permissions to execute the <code>RedshiftSelectSqlQuery</code> query. The username should be valid for an Amazon Redshift <a href="https://docs.aws.amazon.com/redshift/latest/dg/r_CREATE_USER.html">USER</a>.</p>
1710
1854
  */
1711
1855
  DatabaseUserName?: string;
1712
1856
  /**
1857
+ * @public
1713
1858
  * <p> The SQL query that is specified during <a>CreateDataSourceFromRedshift</a>. Returns only if <code>Verbose</code> is true in GetDataSourceInput. </p>
1714
1859
  */
1715
1860
  SelectSqlQuery?: string;
@@ -1721,44 +1866,54 @@ export interface RedshiftMetadata {
1721
1866
  */
1722
1867
  export interface DataSource {
1723
1868
  /**
1869
+ * @public
1724
1870
  * <p>The ID that is assigned to the <code>DataSource</code> during creation.</p>
1725
1871
  */
1726
1872
  DataSourceId?: string;
1727
1873
  /**
1874
+ * @public
1728
1875
  * <p>The location and name of the data in Amazon Simple Storage Service (Amazon S3) that is used by a <code>DataSource</code>.</p>
1729
1876
  */
1730
1877
  DataLocationS3?: string;
1731
1878
  /**
1879
+ * @public
1732
1880
  * <p>A JSON string that represents the splitting and rearrangement requirement used when this <code>DataSource</code>
1733
1881
  * was created.</p>
1734
1882
  */
1735
1883
  DataRearrangement?: string;
1736
1884
  /**
1885
+ * @public
1737
1886
  * <p>The AWS user account from which the <code>DataSource</code> was created. The account type can be either an AWS root account or an AWS Identity and Access Management (IAM) user account.</p>
1738
1887
  */
1739
1888
  CreatedByIamUser?: string;
1740
1889
  /**
1890
+ * @public
1741
1891
  * <p>The time that the <code>DataSource</code> was created. The time is expressed in epoch time.</p>
1742
1892
  */
1743
1893
  CreatedAt?: Date;
1744
1894
  /**
1895
+ * @public
1745
1896
  * <p>The time of the most recent edit to the
1746
1897
  * <code>BatchPrediction</code>. The time is expressed in epoch time.</p>
1747
1898
  */
1748
1899
  LastUpdatedAt?: Date;
1749
1900
  /**
1901
+ * @public
1750
1902
  * <p>The total number of observations contained in the data files that the <code>DataSource</code> references.</p>
1751
1903
  */
1752
1904
  DataSizeInBytes?: number;
1753
1905
  /**
1906
+ * @public
1754
1907
  * <p>The number of data files referenced by the <code>DataSource</code>.</p>
1755
1908
  */
1756
1909
  NumberOfFiles?: number;
1757
1910
  /**
1911
+ * @public
1758
1912
  * <p>A user-supplied name or description of the <code>DataSource</code>.</p>
1759
1913
  */
1760
1914
  Name?: string;
1761
1915
  /**
1916
+ * @public
1762
1917
  * <p>The current status of the <code>DataSource</code>. This element can have one of the following values: </p>
1763
1918
  * <ul>
1764
1919
  * <li>
@@ -1780,36 +1935,44 @@ export interface DataSource {
1780
1935
  */
1781
1936
  Status?: EntityStatus | string;
1782
1937
  /**
1938
+ * @public
1783
1939
  * <p>A description of the most recent details about creating the <code>DataSource</code>.</p>
1784
1940
  */
1785
1941
  Message?: string;
1786
1942
  /**
1943
+ * @public
1787
1944
  * <p>Describes the <code>DataSource</code> details specific to Amazon Redshift.</p>
1788
1945
  */
1789
1946
  RedshiftMetadata?: RedshiftMetadata;
1790
1947
  /**
1948
+ * @public
1791
1949
  * <p>The datasource details that are specific to Amazon RDS.</p>
1792
1950
  */
1793
1951
  RDSMetadata?: RDSMetadata;
1794
1952
  /**
1953
+ * @public
1795
1954
  * <p>The Amazon Resource Name (ARN) of an <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/roles-toplevel.html#roles-about-termsandconcepts">AWS IAM Role</a>, such as the following: arn:aws:iam::account:role/rolename. </p>
1796
1955
  */
1797
1956
  RoleARN?: string;
1798
1957
  /**
1958
+ * @public
1799
1959
  * <p>
1800
1960
  * The parameter is <code>true</code> if statistics need to be generated from the observation data.
1801
1961
  * </p>
1802
1962
  */
1803
1963
  ComputeStatistics?: boolean;
1804
1964
  /**
1965
+ * @public
1805
1966
  * <p>Long integer type that is a 64-bit signed number.</p>
1806
1967
  */
1807
1968
  ComputeTime?: number;
1808
1969
  /**
1970
+ * @public
1809
1971
  * <p>A timestamp represented in epoch time.</p>
1810
1972
  */
1811
1973
  FinishedAt?: Date;
1812
1974
  /**
1975
+ * @public
1813
1976
  * <p>A timestamp represented in epoch time.</p>
1814
1977
  */
1815
1978
  StartedAt?: Date;
@@ -1820,11 +1983,13 @@ export interface DataSource {
1820
1983
  */
1821
1984
  export interface DescribeDataSourcesOutput {
1822
1985
  /**
1986
+ * @public
1823
1987
  * <p>A list of <code>DataSource</code> that meet the search criteria.
1824
1988
  * </p>
1825
1989
  */
1826
1990
  Results?: DataSource[];
1827
1991
  /**
1992
+ * @public
1828
1993
  * <p>An ID of the next page in the paginated results that indicates at least one more page follows.</p>
1829
1994
  */
1830
1995
  NextToken?: string;
@@ -1852,6 +2017,7 @@ export type EvaluationFilterVariable = (typeof EvaluationFilterVariable)[keyof t
1852
2017
  */
1853
2018
  export interface DescribeEvaluationsInput {
1854
2019
  /**
2020
+ * @public
1855
2021
  * <p>Use one of the following variable to filter a list of <code>Evaluation</code> objects:</p>
1856
2022
  * <ul>
1857
2023
  * <li>
@@ -1888,34 +2054,41 @@ export interface DescribeEvaluationsInput {
1888
2054
  */
1889
2055
  FilterVariable?: EvaluationFilterVariable | string;
1890
2056
  /**
2057
+ * @public
1891
2058
  * <p>The equal to operator. The <code>Evaluation</code> results will have
1892
2059
  * <code>FilterVariable</code> values that exactly match the value specified with <code>EQ</code>.</p>
1893
2060
  */
1894
2061
  EQ?: string;
1895
2062
  /**
2063
+ * @public
1896
2064
  * <p>The greater than operator. The <code>Evaluation</code> results will
1897
2065
  * have <code>FilterVariable</code> values that are greater than the value specified with <code>GT</code>.</p>
1898
2066
  */
1899
2067
  GT?: string;
1900
2068
  /**
2069
+ * @public
1901
2070
  * <p>The less than operator. The <code>Evaluation</code> results will
1902
2071
  * have <code>FilterVariable</code> values that are less than the value specified with <code>LT</code>.</p>
1903
2072
  */
1904
2073
  LT?: string;
1905
2074
  /**
2075
+ * @public
1906
2076
  * <p>The greater than or equal to operator. The <code>Evaluation</code> results will have <code>FilterVariable</code> values that are greater than or equal to the value specified with <code>GE</code>.
1907
2077
  * </p>
1908
2078
  */
1909
2079
  GE?: string;
1910
2080
  /**
2081
+ * @public
1911
2082
  * <p>The less than or equal to operator. The <code>Evaluation</code> results will have <code>FilterVariable</code> values that are less than or equal to the value specified with <code>LE</code>.</p>
1912
2083
  */
1913
2084
  LE?: string;
1914
2085
  /**
2086
+ * @public
1915
2087
  * <p>The not equal to operator. The <code>Evaluation</code> results will have <code>FilterVariable</code> values not equal to the value specified with <code>NE</code>.</p>
1916
2088
  */
1917
2089
  NE?: string;
1918
2090
  /**
2091
+ * @public
1919
2092
  * <p>A string that is found at the beginning of a variable, such as <code>Name</code> or <code>Id</code>.</p>
1920
2093
  * <p>For example, an <code>Evaluation</code> could have the <code>Name</code>
1921
2094
  * <code>2014-09-09-HolidayGiftMailer</code>. To search for
@@ -1937,6 +2110,7 @@ export interface DescribeEvaluationsInput {
1937
2110
  */
1938
2111
  Prefix?: string;
1939
2112
  /**
2113
+ * @public
1940
2114
  * <p>A two-value parameter that determines the sequence of the resulting list of <code>Evaluation</code>.</p>
1941
2115
  * <ul>
1942
2116
  * <li>
@@ -1952,10 +2126,12 @@ export interface DescribeEvaluationsInput {
1952
2126
  */
1953
2127
  SortOrder?: SortOrder | string;
1954
2128
  /**
2129
+ * @public
1955
2130
  * <p>The ID of the page in the paginated results.</p>
1956
2131
  */
1957
2132
  NextToken?: string;
1958
2133
  /**
2134
+ * @public
1959
2135
  * <p> The maximum number of <code>Evaluation</code> to include in the result.</p>
1960
2136
  */
1961
2137
  Limit?: number;
@@ -1990,38 +2166,47 @@ export interface PerformanceMetrics {
1990
2166
  */
1991
2167
  export interface Evaluation {
1992
2168
  /**
2169
+ * @public
1993
2170
  * <p>The ID that is assigned to the <code>Evaluation</code> at creation.</p>
1994
2171
  */
1995
2172
  EvaluationId?: string;
1996
2173
  /**
2174
+ * @public
1997
2175
  * <p>The ID of the <code>MLModel</code> that is the focus of the evaluation.</p>
1998
2176
  */
1999
2177
  MLModelId?: string;
2000
2178
  /**
2179
+ * @public
2001
2180
  * <p>The ID of the <code>DataSource</code> that is used to evaluate the <code>MLModel</code>.</p>
2002
2181
  */
2003
2182
  EvaluationDataSourceId?: string;
2004
2183
  /**
2184
+ * @public
2005
2185
  * <p>The location and name of the data in Amazon Simple Storage Server (Amazon S3) that is used in the evaluation.</p>
2006
2186
  */
2007
2187
  InputDataLocationS3?: string;
2008
2188
  /**
2189
+ * @public
2009
2190
  * <p>The AWS user account that invoked the evaluation. The account type can be either an AWS root account or an AWS Identity and Access Management (IAM) user account.</p>
2010
2191
  */
2011
2192
  CreatedByIamUser?: string;
2012
2193
  /**
2194
+ * @public
2013
2195
  * <p>The time that the <code>Evaluation</code> was created. The time is expressed in epoch time.</p>
2014
2196
  */
2015
2197
  CreatedAt?: Date;
2016
2198
  /**
2199
+ * @public
2017
2200
  * <p>The time of the most recent edit to the <code>Evaluation</code>. The time is expressed in epoch time.</p>
2018
2201
  */
2019
2202
  LastUpdatedAt?: Date;
2020
2203
  /**
2204
+ * @public
2021
2205
  * <p>A user-supplied name or description of the <code>Evaluation</code>. </p>
2022
2206
  */
2023
2207
  Name?: string;
2024
2208
  /**
2209
+ * @public
2025
2210
  * <p>The status of the evaluation. This element can have one of the following values:</p>
2026
2211
  * <ul>
2027
2212
  * <li>
@@ -2048,6 +2233,7 @@ export interface Evaluation {
2048
2233
  */
2049
2234
  Status?: EntityStatus | string;
2050
2235
  /**
2236
+ * @public
2051
2237
  * <p>Measurements of how well the <code>MLModel</code> performed, using observations referenced
2052
2238
  * by the <code>DataSource</code>. One of the following metrics is returned, based on the type of the <code>MLModel</code>:
2053
2239
  * </p>
@@ -2068,18 +2254,22 @@ export interface Evaluation {
2068
2254
  */
2069
2255
  PerformanceMetrics?: PerformanceMetrics;
2070
2256
  /**
2257
+ * @public
2071
2258
  * <p>A description of the most recent details about evaluating the <code>MLModel</code>.</p>
2072
2259
  */
2073
2260
  Message?: string;
2074
2261
  /**
2262
+ * @public
2075
2263
  * <p>Long integer type that is a 64-bit signed number.</p>
2076
2264
  */
2077
2265
  ComputeTime?: number;
2078
2266
  /**
2267
+ * @public
2079
2268
  * <p>A timestamp represented in epoch time.</p>
2080
2269
  */
2081
2270
  FinishedAt?: Date;
2082
2271
  /**
2272
+ * @public
2083
2273
  * <p>A timestamp represented in epoch time.</p>
2084
2274
  */
2085
2275
  StartedAt?: Date;
@@ -2090,11 +2280,13 @@ export interface Evaluation {
2090
2280
  */
2091
2281
  export interface DescribeEvaluationsOutput {
2092
2282
  /**
2283
+ * @public
2093
2284
  * <p>A list of <code>Evaluation</code> that meet the search criteria.
2094
2285
  * </p>
2095
2286
  */
2096
2287
  Results?: Evaluation[];
2097
2288
  /**
2289
+ * @public
2098
2290
  * <p>The ID of the next page in the paginated results that indicates at least one more page follows.</p>
2099
2291
  */
2100
2292
  NextToken?: string;
@@ -2124,6 +2316,7 @@ export type MLModelFilterVariable = (typeof MLModelFilterVariable)[keyof typeof
2124
2316
  */
2125
2317
  export interface DescribeMLModelsInput {
2126
2318
  /**
2319
+ * @public
2127
2320
  * <p>Use one of the following variables to filter a list of <code>MLModel</code>:</p>
2128
2321
  * <ul>
2129
2322
  * <li>
@@ -2168,34 +2361,41 @@ export interface DescribeMLModelsInput {
2168
2361
  */
2169
2362
  FilterVariable?: MLModelFilterVariable | string;
2170
2363
  /**
2364
+ * @public
2171
2365
  * <p>The equal to operator. The <code>MLModel</code> results will have
2172
2366
  * <code>FilterVariable</code> values that exactly match the value specified with <code>EQ</code>.</p>
2173
2367
  */
2174
2368
  EQ?: string;
2175
2369
  /**
2370
+ * @public
2176
2371
  * <p>The greater than operator. The <code>MLModel</code> results will
2177
2372
  * have <code>FilterVariable</code> values that are greater than the value specified with <code>GT</code>.</p>
2178
2373
  */
2179
2374
  GT?: string;
2180
2375
  /**
2376
+ * @public
2181
2377
  * <p>The less than operator. The <code>MLModel</code> results will
2182
2378
  * have <code>FilterVariable</code> values that are less than the value specified with <code>LT</code>.</p>
2183
2379
  */
2184
2380
  LT?: string;
2185
2381
  /**
2382
+ * @public
2186
2383
  * <p>The greater than or equal to operator. The <code>MLModel</code> results will have <code>FilterVariable</code> values that are greater than or equal to the value specified with <code>GE</code>.
2187
2384
  * </p>
2188
2385
  */
2189
2386
  GE?: string;
2190
2387
  /**
2388
+ * @public
2191
2389
  * <p>The less than or equal to operator. The <code>MLModel</code> results will have <code>FilterVariable</code> values that are less than or equal to the value specified with <code>LE</code>.</p>
2192
2390
  */
2193
2391
  LE?: string;
2194
2392
  /**
2393
+ * @public
2195
2394
  * <p>The not equal to operator. The <code>MLModel</code> results will have <code>FilterVariable</code> values not equal to the value specified with <code>NE</code>.</p>
2196
2395
  */
2197
2396
  NE?: string;
2198
2397
  /**
2398
+ * @public
2199
2399
  * <p>A string that is found at the beginning of a variable, such as <code>Name</code> or <code>Id</code>.</p>
2200
2400
  * <p>For example, an <code>MLModel</code> could have the <code>Name</code>
2201
2401
  * <code>2014-09-09-HolidayGiftMailer</code>. To search for
@@ -2217,6 +2417,7 @@ export interface DescribeMLModelsInput {
2217
2417
  */
2218
2418
  Prefix?: string;
2219
2419
  /**
2420
+ * @public
2220
2421
  * <p>A two-value parameter that determines the sequence of the resulting list of <code>MLModel</code>.</p>
2221
2422
  * <ul>
2222
2423
  * <li>
@@ -2232,10 +2433,12 @@ export interface DescribeMLModelsInput {
2232
2433
  */
2233
2434
  SortOrder?: SortOrder | string;
2234
2435
  /**
2436
+ * @public
2235
2437
  * <p>The ID of the page in the paginated results.</p>
2236
2438
  */
2237
2439
  NextToken?: string;
2238
2440
  /**
2441
+ * @public
2239
2442
  * <p>The number of pages of information to include in the result. The range of acceptable values is <code>1</code> through <code>100</code>. The default value is <code>100</code>.</p>
2240
2443
  */
2241
2444
  Limit?: number;
@@ -2247,30 +2450,37 @@ export interface DescribeMLModelsInput {
2247
2450
  */
2248
2451
  export interface MLModel {
2249
2452
  /**
2453
+ * @public
2250
2454
  * <p>The ID assigned to the <code>MLModel</code> at creation.</p>
2251
2455
  */
2252
2456
  MLModelId?: string;
2253
2457
  /**
2458
+ * @public
2254
2459
  * <p>The ID of the training <code>DataSource</code>. The <code>CreateMLModel</code> operation uses the <code>TrainingDataSourceId</code>.</p>
2255
2460
  */
2256
2461
  TrainingDataSourceId?: string;
2257
2462
  /**
2463
+ * @public
2258
2464
  * <p>The AWS user account from which the <code>MLModel</code> was created. The account type can be either an AWS root account or an AWS Identity and Access Management (IAM) user account.</p>
2259
2465
  */
2260
2466
  CreatedByIamUser?: string;
2261
2467
  /**
2468
+ * @public
2262
2469
  * <p>The time that the <code>MLModel</code> was created. The time is expressed in epoch time.</p>
2263
2470
  */
2264
2471
  CreatedAt?: Date;
2265
2472
  /**
2473
+ * @public
2266
2474
  * <p>The time of the most recent edit to the <code>MLModel</code>. The time is expressed in epoch time.</p>
2267
2475
  */
2268
2476
  LastUpdatedAt?: Date;
2269
2477
  /**
2478
+ * @public
2270
2479
  * <p>A user-supplied name or description of the <code>MLModel</code>.</p>
2271
2480
  */
2272
2481
  Name?: string;
2273
2482
  /**
2483
+ * @public
2274
2484
  * <p>The current status of an <code>MLModel</code>. This element can have one of the following values: </p>
2275
2485
  * <ul>
2276
2486
  * <li>
@@ -2299,14 +2509,17 @@ export interface MLModel {
2299
2509
  */
2300
2510
  Status?: EntityStatus | string;
2301
2511
  /**
2512
+ * @public
2302
2513
  * <p>Long integer type that is a 64-bit signed number.</p>
2303
2514
  */
2304
2515
  SizeInBytes?: number;
2305
2516
  /**
2517
+ * @public
2306
2518
  * <p>The current endpoint of the <code>MLModel</code>.</p>
2307
2519
  */
2308
2520
  EndpointInfo?: RealtimeEndpointInfo;
2309
2521
  /**
2522
+ * @public
2310
2523
  * <p>A list of the training parameters in the <code>MLModel</code>. The list is implemented as
2311
2524
  * a map of key-value pairs.</p>
2312
2525
  * <p>The following is the current set of training parameters:</p>
@@ -2355,10 +2568,12 @@ export interface MLModel {
2355
2568
  */
2356
2569
  TrainingParameters?: Record<string, string>;
2357
2570
  /**
2571
+ * @public
2358
2572
  * <p>The location of the data file or directory in Amazon Simple Storage Service (Amazon S3).</p>
2359
2573
  */
2360
2574
  InputDataLocationS3?: string;
2361
2575
  /**
2576
+ * @public
2362
2577
  * <p>The algorithm used to train the <code>MLModel</code>. The following algorithm is supported:</p>
2363
2578
  * <ul>
2364
2579
  * <li>
@@ -2369,6 +2584,7 @@ export interface MLModel {
2369
2584
  */
2370
2585
  Algorithm?: Algorithm | string;
2371
2586
  /**
2587
+ * @public
2372
2588
  * <p>Identifies the <code>MLModel</code> category. The following are the available types:</p>
2373
2589
  * <ul>
2374
2590
  * <li>
@@ -2391,22 +2607,27 @@ export interface MLModel {
2391
2607
  MLModelType?: MLModelType | string;
2392
2608
  ScoreThreshold?: number;
2393
2609
  /**
2610
+ * @public
2394
2611
  * <p>The time of the most recent edit to the <code>ScoreThreshold</code>. The time is expressed in epoch time.</p>
2395
2612
  */
2396
2613
  ScoreThresholdLastUpdatedAt?: Date;
2397
2614
  /**
2615
+ * @public
2398
2616
  * <p>A description of the most recent details about accessing the <code>MLModel</code>.</p>
2399
2617
  */
2400
2618
  Message?: string;
2401
2619
  /**
2620
+ * @public
2402
2621
  * <p>Long integer type that is a 64-bit signed number.</p>
2403
2622
  */
2404
2623
  ComputeTime?: number;
2405
2624
  /**
2625
+ * @public
2406
2626
  * <p>A timestamp represented in epoch time.</p>
2407
2627
  */
2408
2628
  FinishedAt?: Date;
2409
2629
  /**
2630
+ * @public
2410
2631
  * <p>A timestamp represented in epoch time.</p>
2411
2632
  */
2412
2633
  StartedAt?: Date;
@@ -2417,10 +2638,12 @@ export interface MLModel {
2417
2638
  */
2418
2639
  export interface DescribeMLModelsOutput {
2419
2640
  /**
2641
+ * @public
2420
2642
  * <p>A list of <code>MLModel</code> that meet the search criteria.</p>
2421
2643
  */
2422
2644
  Results?: MLModel[];
2423
2645
  /**
2646
+ * @public
2424
2647
  * <p>The ID of the next page in the paginated results that indicates at least one more page follows.</p>
2425
2648
  */
2426
2649
  NextToken?: string;
@@ -2430,10 +2653,12 @@ export interface DescribeMLModelsOutput {
2430
2653
  */
2431
2654
  export interface DescribeTagsInput {
2432
2655
  /**
2656
+ * @public
2433
2657
  * <p>The ID of the ML object. For example, <code>exampleModelId</code>. </p>
2434
2658
  */
2435
2659
  ResourceId: string | undefined;
2436
2660
  /**
2661
+ * @public
2437
2662
  * <p>The type of the ML object.</p>
2438
2663
  */
2439
2664
  ResourceType: TaggableResourceType | string | undefined;
@@ -2444,14 +2669,17 @@ export interface DescribeTagsInput {
2444
2669
  */
2445
2670
  export interface DescribeTagsOutput {
2446
2671
  /**
2672
+ * @public
2447
2673
  * <p>The ID of the tagged ML object.</p>
2448
2674
  */
2449
2675
  ResourceId?: string;
2450
2676
  /**
2677
+ * @public
2451
2678
  * <p>The type of the tagged ML object.</p>
2452
2679
  */
2453
2680
  ResourceType?: TaggableResourceType | string;
2454
2681
  /**
2682
+ * @public
2455
2683
  * <p>A list of tags associated with the ML object.</p>
2456
2684
  */
2457
2685
  Tags?: Tag[];
@@ -2461,6 +2689,7 @@ export interface DescribeTagsOutput {
2461
2689
  */
2462
2690
  export interface GetBatchPredictionInput {
2463
2691
  /**
2692
+ * @public
2464
2693
  * <p>An ID assigned to the <code>BatchPrediction</code> at creation.</p>
2465
2694
  */
2466
2695
  BatchPredictionId: string | undefined;
@@ -2471,40 +2700,49 @@ export interface GetBatchPredictionInput {
2471
2700
  */
2472
2701
  export interface GetBatchPredictionOutput {
2473
2702
  /**
2703
+ * @public
2474
2704
  * <p>An ID assigned to the <code>BatchPrediction</code> at creation. This value should be identical to the value of the <code>BatchPredictionID</code>
2475
2705
  * in the request.</p>
2476
2706
  */
2477
2707
  BatchPredictionId?: string;
2478
2708
  /**
2709
+ * @public
2479
2710
  * <p>The ID of the <code>MLModel</code> that generated predictions for the <code>BatchPrediction</code> request.</p>
2480
2711
  */
2481
2712
  MLModelId?: string;
2482
2713
  /**
2714
+ * @public
2483
2715
  * <p>The ID of the <code>DataSource</code> that was used to create the <code>BatchPrediction</code>.
2484
2716
  * </p>
2485
2717
  */
2486
2718
  BatchPredictionDataSourceId?: string;
2487
2719
  /**
2720
+ * @public
2488
2721
  * <p>The location of the data file or directory in Amazon Simple Storage Service (Amazon S3).</p>
2489
2722
  */
2490
2723
  InputDataLocationS3?: string;
2491
2724
  /**
2725
+ * @public
2492
2726
  * <p>The AWS user account that invoked the <code>BatchPrediction</code>. The account type can be either an AWS root account or an AWS Identity and Access Management (IAM) user account.</p>
2493
2727
  */
2494
2728
  CreatedByIamUser?: string;
2495
2729
  /**
2730
+ * @public
2496
2731
  * <p>The time when the <code>BatchPrediction</code> was created. The time is expressed in epoch time.</p>
2497
2732
  */
2498
2733
  CreatedAt?: Date;
2499
2734
  /**
2735
+ * @public
2500
2736
  * <p>The time of the most recent edit to <code>BatchPrediction</code>. The time is expressed in epoch time.</p>
2501
2737
  */
2502
2738
  LastUpdatedAt?: Date;
2503
2739
  /**
2740
+ * @public
2504
2741
  * <p>A user-supplied name or description of the <code>BatchPrediction</code>.</p>
2505
2742
  */
2506
2743
  Name?: string;
2507
2744
  /**
2745
+ * @public
2508
2746
  * <p>The status of the <code>BatchPrediction</code>, which can be one of the following values:</p>
2509
2747
  * <ul>
2510
2748
  * <li>
@@ -2531,34 +2769,42 @@ export interface GetBatchPredictionOutput {
2531
2769
  */
2532
2770
  Status?: EntityStatus | string;
2533
2771
  /**
2772
+ * @public
2534
2773
  * <p>The location of an Amazon S3 bucket or directory to receive the operation results.</p>
2535
2774
  */
2536
2775
  OutputUri?: string;
2537
2776
  /**
2777
+ * @public
2538
2778
  * <p>A link to the file that contains logs of the <code>CreateBatchPrediction</code> operation.</p>
2539
2779
  */
2540
2780
  LogUri?: string;
2541
2781
  /**
2782
+ * @public
2542
2783
  * <p>A description of the most recent details about processing the batch prediction request.</p>
2543
2784
  */
2544
2785
  Message?: string;
2545
2786
  /**
2787
+ * @public
2546
2788
  * <p>The approximate CPU time in milliseconds that Amazon Machine Learning spent processing the <code>BatchPrediction</code>, normalized and scaled on computation resources. <code>ComputeTime</code> is only available if the <code>BatchPrediction</code> is in the <code>COMPLETED</code> state.</p>
2547
2789
  */
2548
2790
  ComputeTime?: number;
2549
2791
  /**
2792
+ * @public
2550
2793
  * <p>The epoch time when Amazon Machine Learning marked the <code>BatchPrediction</code> as <code>COMPLETED</code> or <code>FAILED</code>. <code>FinishedAt</code> is only available when the <code>BatchPrediction</code> is in the <code>COMPLETED</code> or <code>FAILED</code> state.</p>
2551
2794
  */
2552
2795
  FinishedAt?: Date;
2553
2796
  /**
2797
+ * @public
2554
2798
  * <p>The epoch time when Amazon Machine Learning marked the <code>BatchPrediction</code> as <code>INPROGRESS</code>. <code>StartedAt</code> isn't available if the <code>BatchPrediction</code> is in the <code>PENDING</code> state.</p>
2555
2799
  */
2556
2800
  StartedAt?: Date;
2557
2801
  /**
2802
+ * @public
2558
2803
  * <p>The number of total records that Amazon Machine Learning saw while processing the <code>BatchPrediction</code>.</p>
2559
2804
  */
2560
2805
  TotalRecordCount?: number;
2561
2806
  /**
2807
+ * @public
2562
2808
  * <p>The number of invalid records that Amazon Machine Learning saw while processing the <code>BatchPrediction</code>.</p>
2563
2809
  */
2564
2810
  InvalidRecordCount?: number;
@@ -2568,10 +2814,12 @@ export interface GetBatchPredictionOutput {
2568
2814
  */
2569
2815
  export interface GetDataSourceInput {
2570
2816
  /**
2817
+ * @public
2571
2818
  * <p>The ID assigned to the <code>DataSource</code> at creation.</p>
2572
2819
  */
2573
2820
  DataSourceId: string | undefined;
2574
2821
  /**
2822
+ * @public
2575
2823
  * <p>Specifies whether the <code>GetDataSource</code> operation should return <code>DataSourceSchema</code>.</p>
2576
2824
  * <p>If true, <code>DataSourceSchema</code> is returned.</p>
2577
2825
  * <p>If false, <code>DataSourceSchema</code> is not returned.</p>
@@ -2584,43 +2832,53 @@ export interface GetDataSourceInput {
2584
2832
  */
2585
2833
  export interface GetDataSourceOutput {
2586
2834
  /**
2835
+ * @public
2587
2836
  * <p>The ID assigned to the <code>DataSource</code> at creation. This value should be identical to the value of the <code>DataSourceId</code> in the request.</p>
2588
2837
  */
2589
2838
  DataSourceId?: string;
2590
2839
  /**
2840
+ * @public
2591
2841
  * <p>The location of the data file or directory in Amazon Simple Storage Service (Amazon S3).</p>
2592
2842
  */
2593
2843
  DataLocationS3?: string;
2594
2844
  /**
2845
+ * @public
2595
2846
  * <p>A JSON string that represents the splitting and rearrangement requirement used when this <code>DataSource</code>
2596
2847
  * was created.</p>
2597
2848
  */
2598
2849
  DataRearrangement?: string;
2599
2850
  /**
2851
+ * @public
2600
2852
  * <p>The AWS user account from which the <code>DataSource</code> was created. The account type can be either an AWS root account or an AWS Identity and Access Management (IAM) user account.</p>
2601
2853
  */
2602
2854
  CreatedByIamUser?: string;
2603
2855
  /**
2856
+ * @public
2604
2857
  * <p>The time that the <code>DataSource</code> was created. The time is expressed in epoch time.</p>
2605
2858
  */
2606
2859
  CreatedAt?: Date;
2607
2860
  /**
2861
+ * @public
2608
2862
  * <p>The time of the most recent edit to the <code>DataSource</code>. The time is expressed in epoch time.</p>
2609
2863
  */
2610
2864
  LastUpdatedAt?: Date;
2611
2865
  /**
2866
+ * @public
2612
2867
  * <p>The total size of observations in the data files.</p>
2613
2868
  */
2614
2869
  DataSizeInBytes?: number;
2615
2870
  /**
2871
+ * @public
2616
2872
  * <p>The number of data files referenced by the <code>DataSource</code>.</p>
2617
2873
  */
2618
2874
  NumberOfFiles?: number;
2619
2875
  /**
2876
+ * @public
2620
2877
  * <p>A user-supplied name or description of the <code>DataSource</code>.</p>
2621
2878
  */
2622
2879
  Name?: string;
2623
2880
  /**
2881
+ * @public
2624
2882
  * <p>The current status of the <code>DataSource</code>. This element can have one of the following values:</p>
2625
2883
  * <ul>
2626
2884
  * <li>
@@ -2647,44 +2905,54 @@ export interface GetDataSourceOutput {
2647
2905
  */
2648
2906
  Status?: EntityStatus | string;
2649
2907
  /**
2908
+ * @public
2650
2909
  * <p>A link to the file containing logs of <code>CreateDataSourceFrom*</code> operations.</p>
2651
2910
  */
2652
2911
  LogUri?: string;
2653
2912
  /**
2913
+ * @public
2654
2914
  * <p>The user-supplied description of the most recent details about creating the <code>DataSource</code>.</p>
2655
2915
  */
2656
2916
  Message?: string;
2657
2917
  /**
2918
+ * @public
2658
2919
  * <p>Describes the <code>DataSource</code> details specific to Amazon Redshift.</p>
2659
2920
  */
2660
2921
  RedshiftMetadata?: RedshiftMetadata;
2661
2922
  /**
2923
+ * @public
2662
2924
  * <p>The datasource details that are specific to Amazon RDS.</p>
2663
2925
  */
2664
2926
  RDSMetadata?: RDSMetadata;
2665
2927
  /**
2928
+ * @public
2666
2929
  * <p>The Amazon Resource Name (ARN) of an <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/roles-toplevel.html#roles-about-termsandconcepts">AWS IAM Role</a>, such as the following: arn:aws:iam::account:role/rolename. </p>
2667
2930
  */
2668
2931
  RoleARN?: string;
2669
2932
  /**
2933
+ * @public
2670
2934
  * <p>
2671
2935
  * The parameter is <code>true</code> if statistics need to be generated from the observation data.
2672
2936
  * </p>
2673
2937
  */
2674
2938
  ComputeStatistics?: boolean;
2675
2939
  /**
2940
+ * @public
2676
2941
  * <p>The approximate CPU time in milliseconds that Amazon Machine Learning spent processing the <code>DataSource</code>, normalized and scaled on computation resources. <code>ComputeTime</code> is only available if the <code>DataSource</code> is in the <code>COMPLETED</code> state and the <code>ComputeStatistics</code> is set to true.</p>
2677
2942
  */
2678
2943
  ComputeTime?: number;
2679
2944
  /**
2945
+ * @public
2680
2946
  * <p>The epoch time when Amazon Machine Learning marked the <code>DataSource</code> as <code>COMPLETED</code> or <code>FAILED</code>. <code>FinishedAt</code> is only available when the <code>DataSource</code> is in the <code>COMPLETED</code> or <code>FAILED</code> state.</p>
2681
2947
  */
2682
2948
  FinishedAt?: Date;
2683
2949
  /**
2950
+ * @public
2684
2951
  * <p>The epoch time when Amazon Machine Learning marked the <code>DataSource</code> as <code>INPROGRESS</code>. <code>StartedAt</code> isn't available if the <code>DataSource</code> is in the <code>PENDING</code> state.</p>
2685
2952
  */
2686
2953
  StartedAt?: Date;
2687
2954
  /**
2955
+ * @public
2688
2956
  * <p>The schema used by all of the data files of this <code>DataSource</code>.</p>
2689
2957
  * <p>
2690
2958
  * <b>Note:</b> This parameter is provided as part of the verbose format.</p>
@@ -2696,6 +2964,7 @@ export interface GetDataSourceOutput {
2696
2964
  */
2697
2965
  export interface GetEvaluationInput {
2698
2966
  /**
2967
+ * @public
2699
2968
  * <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>
2700
2969
  */
2701
2970
  EvaluationId: string | undefined;
@@ -2706,38 +2975,47 @@ export interface GetEvaluationInput {
2706
2975
  */
2707
2976
  export interface GetEvaluationOutput {
2708
2977
  /**
2978
+ * @public
2709
2979
  * <p>The evaluation ID which is same as the <code>EvaluationId</code> in the request.</p>
2710
2980
  */
2711
2981
  EvaluationId?: string;
2712
2982
  /**
2983
+ * @public
2713
2984
  * <p>The ID of the <code>MLModel</code> that was the focus of the evaluation.</p>
2714
2985
  */
2715
2986
  MLModelId?: string;
2716
2987
  /**
2988
+ * @public
2717
2989
  * <p>The <code>DataSource</code> used for this evaluation.</p>
2718
2990
  */
2719
2991
  EvaluationDataSourceId?: string;
2720
2992
  /**
2993
+ * @public
2721
2994
  * <p>The location of the data file or directory in Amazon Simple Storage Service (Amazon S3).</p>
2722
2995
  */
2723
2996
  InputDataLocationS3?: string;
2724
2997
  /**
2998
+ * @public
2725
2999
  * <p>The AWS user account that invoked the evaluation. The account type can be either an AWS root account or an AWS Identity and Access Management (IAM) user account.</p>
2726
3000
  */
2727
3001
  CreatedByIamUser?: string;
2728
3002
  /**
3003
+ * @public
2729
3004
  * <p>The time that the <code>Evaluation</code> was created. The time is expressed in epoch time.</p>
2730
3005
  */
2731
3006
  CreatedAt?: Date;
2732
3007
  /**
3008
+ * @public
2733
3009
  * <p>The time of the most recent edit to the <code>Evaluation</code>. The time is expressed in epoch time.</p>
2734
3010
  */
2735
3011
  LastUpdatedAt?: Date;
2736
3012
  /**
3013
+ * @public
2737
3014
  * <p>A user-supplied name or description of the <code>Evaluation</code>. </p>
2738
3015
  */
2739
3016
  Name?: string;
2740
3017
  /**
3018
+ * @public
2741
3019
  * <p>The status of the evaluation. This element can have one of the following values:</p>
2742
3020
  * <ul>
2743
3021
  * <li>
@@ -2764,6 +3042,7 @@ export interface GetEvaluationOutput {
2764
3042
  */
2765
3043
  Status?: EntityStatus | string;
2766
3044
  /**
3045
+ * @public
2767
3046
  * <p>Measurements of how well the <code>MLModel</code> performed using observations referenced by the <code>DataSource</code>. One of the following metric is returned based on the type of the <code>MLModel</code>:
2768
3047
  * </p>
2769
3048
  * <ul>
@@ -2783,22 +3062,27 @@ export interface GetEvaluationOutput {
2783
3062
  */
2784
3063
  PerformanceMetrics?: PerformanceMetrics;
2785
3064
  /**
3065
+ * @public
2786
3066
  * <p>A link to the file that contains logs of the <code>CreateEvaluation</code> operation.</p>
2787
3067
  */
2788
3068
  LogUri?: string;
2789
3069
  /**
3070
+ * @public
2790
3071
  * <p>A description of the most recent details about evaluating the <code>MLModel</code>.</p>
2791
3072
  */
2792
3073
  Message?: string;
2793
3074
  /**
3075
+ * @public
2794
3076
  * <p>The approximate CPU time in milliseconds that Amazon Machine Learning spent processing the <code>Evaluation</code>, normalized and scaled on computation resources. <code>ComputeTime</code> is only available if the <code>Evaluation</code> is in the <code>COMPLETED</code> state.</p>
2795
3077
  */
2796
3078
  ComputeTime?: number;
2797
3079
  /**
3080
+ * @public
2798
3081
  * <p>The epoch time when Amazon Machine Learning marked the <code>Evaluation</code> as <code>COMPLETED</code> or <code>FAILED</code>. <code>FinishedAt</code> is only available when the <code>Evaluation</code> is in the <code>COMPLETED</code> or <code>FAILED</code> state.</p>
2799
3082
  */
2800
3083
  FinishedAt?: Date;
2801
3084
  /**
3085
+ * @public
2802
3086
  * <p>The epoch time when Amazon Machine Learning marked the <code>Evaluation</code> as <code>INPROGRESS</code>. <code>StartedAt</code> isn't available if the <code>Evaluation</code> is in the <code>PENDING</code> state.</p>
2803
3087
  */
2804
3088
  StartedAt?: Date;
@@ -2808,10 +3092,12 @@ export interface GetEvaluationOutput {
2808
3092
  */
2809
3093
  export interface GetMLModelInput {
2810
3094
  /**
3095
+ * @public
2811
3096
  * <p>The ID assigned to the <code>MLModel</code> at creation.</p>
2812
3097
  */
2813
3098
  MLModelId: string | undefined;
2814
3099
  /**
3100
+ * @public
2815
3101
  * <p>Specifies whether the <code>GetMLModel</code> operation should return <code>Recipe</code>.</p>
2816
3102
  * <p>If true, <code>Recipe</code> is returned.</p>
2817
3103
  * <p>If false, <code>Recipe</code> is not returned.</p>
@@ -2824,31 +3110,38 @@ export interface GetMLModelInput {
2824
3110
  */
2825
3111
  export interface GetMLModelOutput {
2826
3112
  /**
3113
+ * @public
2827
3114
  * <p>The MLModel ID,
2828
3115
  * which is same as the <code>MLModelId</code> in the request.</p>
2829
3116
  */
2830
3117
  MLModelId?: string;
2831
3118
  /**
3119
+ * @public
2832
3120
  * <p>The ID of the training <code>DataSource</code>.</p>
2833
3121
  */
2834
3122
  TrainingDataSourceId?: string;
2835
3123
  /**
3124
+ * @public
2836
3125
  * <p>The AWS user account from which the <code>MLModel</code> was created. The account type can be either an AWS root account or an AWS Identity and Access Management (IAM) user account.</p>
2837
3126
  */
2838
3127
  CreatedByIamUser?: string;
2839
3128
  /**
3129
+ * @public
2840
3130
  * <p>The time that the <code>MLModel</code> was created. The time is expressed in epoch time.</p>
2841
3131
  */
2842
3132
  CreatedAt?: Date;
2843
3133
  /**
3134
+ * @public
2844
3135
  * <p>The time of the most recent edit to the <code>MLModel</code>. The time is expressed in epoch time.</p>
2845
3136
  */
2846
3137
  LastUpdatedAt?: Date;
2847
3138
  /**
3139
+ * @public
2848
3140
  * <p>A user-supplied name or description of the <code>MLModel</code>.</p>
2849
3141
  */
2850
3142
  Name?: string;
2851
3143
  /**
3144
+ * @public
2852
3145
  * <p>The current status of the <code>MLModel</code>. This element can have one of the following values:</p>
2853
3146
  * <ul>
2854
3147
  * <li>
@@ -2877,15 +3170,18 @@ export interface GetMLModelOutput {
2877
3170
  */
2878
3171
  Status?: EntityStatus | string;
2879
3172
  /**
3173
+ * @public
2880
3174
  * <p>Long integer type that is a 64-bit signed number.</p>
2881
3175
  */
2882
3176
  SizeInBytes?: number;
2883
3177
  /**
3178
+ * @public
2884
3179
  * <p>The current endpoint of the <code>MLModel</code>
2885
3180
  * </p>
2886
3181
  */
2887
3182
  EndpointInfo?: RealtimeEndpointInfo;
2888
3183
  /**
3184
+ * @public
2889
3185
  * <p>A list of the training parameters in the <code>MLModel</code>. The list is implemented as
2890
3186
  * a map of key-value pairs.</p>
2891
3187
  * <p>The following is the current set of training parameters:</p>
@@ -2934,10 +3230,12 @@ export interface GetMLModelOutput {
2934
3230
  */
2935
3231
  TrainingParameters?: Record<string, string>;
2936
3232
  /**
3233
+ * @public
2937
3234
  * <p>The location of the data file or directory in Amazon Simple Storage Service (Amazon S3).</p>
2938
3235
  */
2939
3236
  InputDataLocationS3?: string;
2940
3237
  /**
3238
+ * @public
2941
3239
  * <p>Identifies the <code>MLModel</code> category. The following are the available types: </p>
2942
3240
  * <ul>
2943
3241
  * <li>
@@ -2953,6 +3251,7 @@ export interface GetMLModelOutput {
2953
3251
  */
2954
3252
  MLModelType?: MLModelType | string;
2955
3253
  /**
3254
+ * @public
2956
3255
  * <p>The scoring threshold is used in binary classification <code>MLModel</code>
2957
3256
  * models. It marks the boundary between a positive prediction and a
2958
3257
  * negative prediction.</p>
@@ -2962,30 +3261,37 @@ export interface GetMLModelOutput {
2962
3261
  */
2963
3262
  ScoreThreshold?: number;
2964
3263
  /**
3264
+ * @public
2965
3265
  * <p>The time of the most recent edit to the <code>ScoreThreshold</code>. The time is expressed in epoch time.</p>
2966
3266
  */
2967
3267
  ScoreThresholdLastUpdatedAt?: Date;
2968
3268
  /**
3269
+ * @public
2969
3270
  * <p>A link to the file that contains logs of the <code>CreateMLModel</code> operation.</p>
2970
3271
  */
2971
3272
  LogUri?: string;
2972
3273
  /**
3274
+ * @public
2973
3275
  * <p>A description of the most recent details about accessing the <code>MLModel</code>.</p>
2974
3276
  */
2975
3277
  Message?: string;
2976
3278
  /**
3279
+ * @public
2977
3280
  * <p>The approximate CPU time in milliseconds that Amazon Machine Learning spent processing the <code>MLModel</code>, normalized and scaled on computation resources. <code>ComputeTime</code> is only available if the <code>MLModel</code> is in the <code>COMPLETED</code> state.</p>
2978
3281
  */
2979
3282
  ComputeTime?: number;
2980
3283
  /**
3284
+ * @public
2981
3285
  * <p>The epoch time when Amazon Machine Learning marked the <code>MLModel</code> as <code>COMPLETED</code> or <code>FAILED</code>. <code>FinishedAt</code> is only available when the <code>MLModel</code> is in the <code>COMPLETED</code> or <code>FAILED</code> state.</p>
2982
3286
  */
2983
3287
  FinishedAt?: Date;
2984
3288
  /**
3289
+ * @public
2985
3290
  * <p>The epoch time when Amazon Machine Learning marked the <code>MLModel</code> as <code>INPROGRESS</code>. <code>StartedAt</code> isn't available if the <code>MLModel</code> is in the <code>PENDING</code> state.</p>
2986
3291
  */
2987
3292
  StartedAt?: Date;
2988
3293
  /**
3294
+ * @public
2989
3295
  * <p>The recipe to use when training the <code>MLModel</code>. The <code>Recipe</code>
2990
3296
  * provides detailed information about the observation data to use during training, and
2991
3297
  * manipulations to perform on the observation data during training.</p>
@@ -2994,6 +3300,7 @@ export interface GetMLModelOutput {
2994
3300
  */
2995
3301
  Recipe?: string;
2996
3302
  /**
3303
+ * @public
2997
3304
  * <p>The schema used by all of the data files referenced by the <code>DataSource</code>.</p>
2998
3305
  * <p>
2999
3306
  * <b>Note:</b> This parameter is provided as part of the verbose format.</p>
@@ -3018,10 +3325,12 @@ export declare class LimitExceededException extends __BaseException {
3018
3325
  */
3019
3326
  export interface PredictInput {
3020
3327
  /**
3328
+ * @public
3021
3329
  * <p>A unique identifier of the <code>MLModel</code>.</p>
3022
3330
  */
3023
3331
  MLModelId: string | undefined;
3024
3332
  /**
3333
+ * @public
3025
3334
  * <p>A map of variable name-value pairs that represent an observation.</p>
3026
3335
  */
3027
3336
  Record: Record<string, string> | undefined;
@@ -3084,20 +3393,24 @@ export type DetailsAttributes = (typeof DetailsAttributes)[keyof typeof DetailsA
3084
3393
  */
3085
3394
  export interface Prediction {
3086
3395
  /**
3396
+ * @public
3087
3397
  * <p>The prediction label for either a <code>BINARY</code> or <code>MULTICLASS</code>
3088
3398
  * <code>MLModel</code>.</p>
3089
3399
  */
3090
3400
  predictedLabel?: string;
3091
3401
  /**
3402
+ * @public
3092
3403
  * <p>The prediction value for <code>REGRESSION</code>
3093
3404
  * <code>MLModel</code>.</p>
3094
3405
  */
3095
3406
  predictedValue?: number;
3096
3407
  /**
3408
+ * @public
3097
3409
  * <p>Provides the raw classification score corresponding to each label.</p>
3098
3410
  */
3099
3411
  predictedScores?: Record<string, number>;
3100
3412
  /**
3413
+ * @public
3101
3414
  * <p>Provides any additional details regarding the prediction.</p>
3102
3415
  */
3103
3416
  details?: Record<string, string>;
@@ -3107,6 +3420,7 @@ export interface Prediction {
3107
3420
  */
3108
3421
  export interface PredictOutput {
3109
3422
  /**
3423
+ * @public
3110
3424
  * <p>The output from a <code>Predict</code> operation: </p>
3111
3425
  *
3112
3426
  * <ul>
@@ -3143,10 +3457,12 @@ export interface PredictOutput {
3143
3457
  */
3144
3458
  export interface UpdateBatchPredictionInput {
3145
3459
  /**
3460
+ * @public
3146
3461
  * <p>The ID assigned to the <code>BatchPrediction</code> during creation.</p>
3147
3462
  */
3148
3463
  BatchPredictionId: string | undefined;
3149
3464
  /**
3465
+ * @public
3150
3466
  * <p>A new user-supplied name or description of the <code>BatchPrediction</code>.</p>
3151
3467
  */
3152
3468
  BatchPredictionName: string | undefined;
@@ -3158,6 +3474,7 @@ export interface UpdateBatchPredictionInput {
3158
3474
  */
3159
3475
  export interface UpdateBatchPredictionOutput {
3160
3476
  /**
3477
+ * @public
3161
3478
  * <p>The ID assigned to the <code>BatchPrediction</code> during creation. This value should be identical to the value
3162
3479
  * of the <code>BatchPredictionId</code> in the request.</p>
3163
3480
  */
@@ -3168,10 +3485,12 @@ export interface UpdateBatchPredictionOutput {
3168
3485
  */
3169
3486
  export interface UpdateDataSourceInput {
3170
3487
  /**
3488
+ * @public
3171
3489
  * <p>The ID assigned to the <code>DataSource</code> during creation.</p>
3172
3490
  */
3173
3491
  DataSourceId: string | undefined;
3174
3492
  /**
3493
+ * @public
3175
3494
  * <p>A new user-supplied name or description of the <code>DataSource</code> that will replace the current description. </p>
3176
3495
  */
3177
3496
  DataSourceName: string | undefined;
@@ -3183,6 +3502,7 @@ export interface UpdateDataSourceInput {
3183
3502
  */
3184
3503
  export interface UpdateDataSourceOutput {
3185
3504
  /**
3505
+ * @public
3186
3506
  * <p>The ID assigned to the <code>DataSource</code> during creation. This value should be identical to the value
3187
3507
  * of the <code>DataSourceID</code> in the request.</p>
3188
3508
  */
@@ -3193,10 +3513,12 @@ export interface UpdateDataSourceOutput {
3193
3513
  */
3194
3514
  export interface UpdateEvaluationInput {
3195
3515
  /**
3516
+ * @public
3196
3517
  * <p>The ID assigned to the <code>Evaluation</code> during creation.</p>
3197
3518
  */
3198
3519
  EvaluationId: string | undefined;
3199
3520
  /**
3521
+ * @public
3200
3522
  * <p>A new user-supplied name or description of the <code>Evaluation</code> that will replace the current content. </p>
3201
3523
  */
3202
3524
  EvaluationName: string | undefined;
@@ -3208,6 +3530,7 @@ export interface UpdateEvaluationInput {
3208
3530
  */
3209
3531
  export interface UpdateEvaluationOutput {
3210
3532
  /**
3533
+ * @public
3211
3534
  * <p>The ID assigned to the <code>Evaluation</code> during creation. This value should be identical to the value
3212
3535
  * of the <code>Evaluation</code> in the request.</p>
3213
3536
  */
@@ -3218,14 +3541,17 @@ export interface UpdateEvaluationOutput {
3218
3541
  */
3219
3542
  export interface UpdateMLModelInput {
3220
3543
  /**
3544
+ * @public
3221
3545
  * <p>The ID assigned to the <code>MLModel</code> during creation.</p>
3222
3546
  */
3223
3547
  MLModelId: string | undefined;
3224
3548
  /**
3549
+ * @public
3225
3550
  * <p>A user-supplied name or description of the <code>MLModel</code>.</p>
3226
3551
  */
3227
3552
  MLModelName?: string;
3228
3553
  /**
3554
+ * @public
3229
3555
  * <p>The <code>ScoreThreshold</code> used in binary classification <code>MLModel</code> that marks the boundary between a positive prediction and a negative prediction.</p>
3230
3556
  * <p>Output values greater than or equal to the <code>ScoreThreshold</code> receive a positive result from the <code>MLModel</code>, such as <code>true</code>. Output values less than the <code>ScoreThreshold</code> receive a negative response from the <code>MLModel</code>, such as <code>false</code>.</p>
3231
3557
  */
@@ -3238,6 +3564,7 @@ export interface UpdateMLModelInput {
3238
3564
  */
3239
3565
  export interface UpdateMLModelOutput {
3240
3566
  /**
3567
+ * @public
3241
3568
  * <p>The ID assigned to the <code>MLModel</code> during creation. This value should be identical to the value
3242
3569
  * of the <code>MLModelID</code> in the request.</p>
3243
3570
  */