@aws-sdk/client-forecast 3.379.1 → 3.385.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 Operation = (typeof Operation)[keyof typeof Operation];
20
20
  */
21
21
  export interface Action {
22
22
  /**
23
+ * @public
23
24
  * <p>The related time series that you are modifying. This value is case insensitive.</p>
24
25
  */
25
26
  AttributeName: string | undefined;
26
27
  /**
28
+ * @public
27
29
  * <p>The operation that is applied to the provided attribute. Operations include:</p>
28
30
  * <ul>
29
31
  * <li>
@@ -46,6 +48,7 @@ export interface Action {
46
48
  */
47
49
  Operation: Operation | string | undefined;
48
50
  /**
51
+ * @public
49
52
  * <p>The value that is applied for the chosen <code>Operation</code>.</p>
50
53
  */
51
54
  Value: number | undefined;
@@ -72,11 +75,13 @@ export interface Action {
72
75
  */
73
76
  export interface AdditionalDataset {
74
77
  /**
78
+ * @public
75
79
  * <p>The name of the additional dataset. Valid names: <code>"holiday"</code> and
76
80
  * <code>"weather"</code>.</p>
77
81
  */
78
82
  Name: string | undefined;
79
83
  /**
84
+ * @public
80
85
  * <p>
81
86
  * <b>Weather Index</b>
82
87
  * </p>
@@ -313,12 +318,14 @@ export interface AdditionalDataset {
313
318
  */
314
319
  export interface AttributeConfig {
315
320
  /**
321
+ * @public
316
322
  * <p>The name of the attribute as specified in the schema. Amazon Forecast supports the
317
323
  * target field of the target time series and the related time series datasets. For
318
324
  * example, for the RETAIL domain, the target is <code>demand</code>.</p>
319
325
  */
320
326
  AttributeName: string | undefined;
321
327
  /**
328
+ * @public
322
329
  * <p>The method parameters (key-value pairs), which are a map of override parameters.
323
330
  * Specify these parameters to override the default values. Related Time Series attributes
324
331
  * do not accept aggregation parameters.</p>
@@ -391,14 +398,17 @@ export interface AttributeConfig {
391
398
  */
392
399
  export interface DataConfig {
393
400
  /**
401
+ * @public
394
402
  * <p>The ARN of the dataset group used to train the predictor.</p>
395
403
  */
396
404
  DatasetGroupArn: string | undefined;
397
405
  /**
406
+ * @public
398
407
  * <p>Aggregation and filling options for attributes in your dataset group.</p>
399
408
  */
400
409
  AttributeConfigs?: AttributeConfig[];
401
410
  /**
411
+ * @public
402
412
  * <p>Additional built-in datasets like Holidays and the Weather Index.</p>
403
413
  */
404
414
  AdditionalDatasets?: AdditionalDataset[];
@@ -411,12 +421,14 @@ export interface DataConfig {
411
421
  */
412
422
  export interface EncryptionConfig {
413
423
  /**
424
+ * @public
414
425
  * <p>The ARN of the IAM role that Amazon Forecast can assume to access the KMS key.</p>
415
426
  * <p>Passing a role across Amazon Web Services accounts is not allowed. If you pass a role that isn't in your
416
427
  * account, you get an <code>InvalidInputException</code> error.</p>
417
428
  */
418
429
  RoleArn: string | undefined;
419
430
  /**
431
+ * @public
420
432
  * <p>The Amazon Resource Name (ARN) of the KMS key.</p>
421
433
  */
422
434
  KMSKeyArn: string | undefined;
@@ -427,6 +439,7 @@ export interface EncryptionConfig {
427
439
  */
428
440
  export interface MonitorConfig {
429
441
  /**
442
+ * @public
430
443
  * <p>The name of the monitor resource.</p>
431
444
  */
432
445
  MonitorName: string | undefined;
@@ -486,11 +499,13 @@ export type OptimizationMetric = (typeof OptimizationMetric)[keyof typeof Optimi
486
499
  */
487
500
  export interface Tag {
488
501
  /**
502
+ * @public
489
503
  * <p>One part of a key-value pair that makes up a tag. A <code>key</code> is a general label
490
504
  * that acts like a category for more specific tag values.</p>
491
505
  */
492
506
  Key: string | undefined;
493
507
  /**
508
+ * @public
494
509
  * <p>The optional part of a key-value pair that makes up a tag. A <code>value</code> acts as a
495
510
  * descriptor within a tag category (key).</p>
496
511
  */
@@ -549,18 +564,22 @@ export type Month = (typeof Month)[keyof typeof Month];
549
564
  */
550
565
  export interface TimeAlignmentBoundary {
551
566
  /**
567
+ * @public
552
568
  * <p>The month to use for time alignment during aggregation. The month must be in uppercase.</p>
553
569
  */
554
570
  Month?: Month | string;
555
571
  /**
572
+ * @public
556
573
  * <p>The day of the month to use for time alignment during aggregation.</p>
557
574
  */
558
575
  DayOfMonth?: number;
559
576
  /**
577
+ * @public
560
578
  * <p>The day of week to use for time alignment during aggregation. The day must be in uppercase.</p>
561
579
  */
562
580
  DayOfWeek?: DayOfWeek | string;
563
581
  /**
582
+ * @public
564
583
  * <p>The hour of day to use for time alignment during aggregation.</p>
565
584
  */
566
585
  Hour?: number;
@@ -570,10 +589,12 @@ export interface TimeAlignmentBoundary {
570
589
  */
571
590
  export interface CreateAutoPredictorRequest {
572
591
  /**
592
+ * @public
573
593
  * <p>A unique name for the predictor</p>
574
594
  */
575
595
  PredictorName: string | undefined;
576
596
  /**
597
+ * @public
577
598
  * <p>The number of time-steps that the model predicts. The forecast horizon is also called
578
599
  * the prediction length.</p>
579
600
  * <p>The maximum forecast horizon is the lesser of 500 time-steps or 1/4 of the
@@ -586,12 +607,14 @@ export interface CreateAutoPredictorRequest {
586
607
  */
587
608
  ForecastHorizon?: number;
588
609
  /**
610
+ * @public
589
611
  * <p>The forecast types used to train a predictor. You can specify up to five forecast
590
612
  * types. Forecast types can be quantiles from 0.01 to 0.99, by increments of 0.01 or
591
613
  * higher. You can also specify the mean forecast with <code>mean</code>.</p>
592
614
  */
593
615
  ForecastTypes?: string[];
594
616
  /**
617
+ * @public
595
618
  * <p>An array of dimension (field) names that specify how to group the generated
596
619
  * forecast.</p>
597
620
  * <p>For example, if you are generating forecasts for item sales across all your stores,
@@ -600,6 +623,7 @@ export interface CreateAutoPredictorRequest {
600
623
  */
601
624
  ForecastDimensions?: string[];
602
625
  /**
626
+ * @public
603
627
  * <p>The frequency of predictions in a forecast.</p>
604
628
  * <p>Valid intervals are an integer followed by Y (Year), M (Month), W (Week), D (Day), H (Hour), and min (Minute). For example,
605
629
  * "1D" indicates every day and "15min" indicates every 15 minutes. You cannot specify a value that would overlap with the next larger frequency. That means, for example, you cannot specify a frequency of 60 minutes, because that is equivalent to 1 hour. The valid values for each frequency are the following:</p>
@@ -631,16 +655,19 @@ export interface CreateAutoPredictorRequest {
631
655
  */
632
656
  ForecastFrequency?: string;
633
657
  /**
658
+ * @public
634
659
  * <p>The data configuration for your dataset group and any additional datasets.</p>
635
660
  */
636
661
  DataConfig?: DataConfig;
637
662
  /**
663
+ * @public
638
664
  * <p>An Key Management Service (KMS) key and an Identity and Access Management (IAM) role that Amazon Forecast can assume to
639
665
  * access the key. You can specify this optional object in the
640
666
  * <a>CreateDataset</a> and <a>CreatePredictor</a> requests.</p>
641
667
  */
642
668
  EncryptionConfig?: EncryptionConfig;
643
669
  /**
670
+ * @public
644
671
  * <p>The ARN of the predictor to retrain or upgrade. This parameter is only used when
645
672
  * retraining or upgrading a predictor. When creating a new predictor, do not specify a
646
673
  * value for this parameter.</p>
@@ -650,14 +677,17 @@ export interface CreateAutoPredictorRequest {
650
677
  */
651
678
  ReferencePredictorArn?: string;
652
679
  /**
680
+ * @public
653
681
  * <p>The accuracy metric used to optimize the predictor.</p>
654
682
  */
655
683
  OptimizationMetric?: OptimizationMetric | string;
656
684
  /**
685
+ * @public
657
686
  * <p>Create an Explainability resource for the predictor.</p>
658
687
  */
659
688
  ExplainPredictor?: boolean;
660
689
  /**
690
+ * @public
661
691
  * <p>Optional metadata to help you categorize and organize your predictors. Each tag
662
692
  * consists of a key and an optional value, both of which you define. Tag keys and values
663
693
  * are case sensitive.</p>
@@ -693,12 +723,14 @@ export interface CreateAutoPredictorRequest {
693
723
  */
694
724
  Tags?: Tag[];
695
725
  /**
726
+ * @public
696
727
  * <p>The configuration details for predictor monitoring. Provide a name for the monitor resource to enable predictor monitoring.</p>
697
728
  * <p>Predictor monitoring allows you to see how your predictor's performance changes over time.
698
729
  * For more information, see <a href="https://docs.aws.amazon.com/forecast/latest/dg/predictor-monitoring.html">Predictor Monitoring</a>.</p>
699
730
  */
700
731
  MonitorConfig?: MonitorConfig;
701
732
  /**
733
+ * @public
702
734
  * <p>The time boundary Forecast uses to align and aggregate any data that doesn't align with your forecast frequency. Provide the unit of time and the time boundary as a key value pair.
703
735
  * For more information on specifying a time boundary, see <a href="https://docs.aws.amazon.com/forecast/latest/dg/data-aggregation.html#specifying-time-boundary">Specifying a Time Boundary</a>.
704
736
  * If you
@@ -711,6 +743,7 @@ export interface CreateAutoPredictorRequest {
711
743
  */
712
744
  export interface CreateAutoPredictorResponse {
713
745
  /**
746
+ * @public
714
747
  * <p>The Amazon Resource Name (ARN) of the predictor.</p>
715
748
  */
716
749
  PredictorArn?: string;
@@ -835,10 +868,12 @@ export type AttributeType = (typeof AttributeType)[keyof typeof AttributeType];
835
868
  */
836
869
  export interface SchemaAttribute {
837
870
  /**
871
+ * @public
838
872
  * <p>The name of the dataset field.</p>
839
873
  */
840
874
  AttributeName?: string;
841
875
  /**
876
+ * @public
842
877
  * <p>The data type of the field.</p>
843
878
  * <p>For a related time series dataset, other than date, item_id, and forecast dimensions attributes, all attributes should be of numerical type (integer/float).</p>
844
879
  */
@@ -850,6 +885,7 @@ export interface SchemaAttribute {
850
885
  */
851
886
  export interface Schema {
852
887
  /**
888
+ * @public
853
889
  * <p>An array of attributes specifying the name and type of each field in a dataset.</p>
854
890
  */
855
891
  Attributes?: SchemaAttribute[];
@@ -859,10 +895,12 @@ export interface Schema {
859
895
  */
860
896
  export interface CreateDatasetRequest {
861
897
  /**
898
+ * @public
862
899
  * <p>A name for the dataset.</p>
863
900
  */
864
901
  DatasetName: string | undefined;
865
902
  /**
903
+ * @public
866
904
  * <p>The domain associated with the dataset. When you add a dataset to a dataset group, this
867
905
  * value and the value specified for the <code>Domain</code> parameter of the <a href="https://docs.aws.amazon.com/forecast/latest/dg/API_CreateDatasetGroup.html">CreateDatasetGroup</a> operation must match.</p>
868
906
  * <p>The <code>Domain</code> and <code>DatasetType</code> that you choose determine the fields
@@ -874,10 +912,12 @@ export interface CreateDatasetRequest {
874
912
  */
875
913
  Domain: Domain | string | undefined;
876
914
  /**
915
+ * @public
877
916
  * <p>The dataset type. Valid values depend on the chosen <code>Domain</code>.</p>
878
917
  */
879
918
  DatasetType: DatasetType | string | undefined;
880
919
  /**
920
+ * @public
881
921
  * <p>The frequency of data collection. This parameter is required for RELATED_TIME_SERIES
882
922
  * datasets.</p>
883
923
  * <p>Valid intervals are an integer followed by Y (Year), M (Month), W (Week), D (Day), H (Hour), and min (Minute). For example,
@@ -906,6 +946,7 @@ export interface CreateDatasetRequest {
906
946
  */
907
947
  DataFrequency?: string;
908
948
  /**
949
+ * @public
909
950
  * <p>The schema for the dataset. The schema attributes and their order must match the fields in
910
951
  * your data. The dataset <code>Domain</code> and <code>DatasetType</code> that you choose
911
952
  * determine the minimum required fields in your training data. For information about the
@@ -914,11 +955,13 @@ export interface CreateDatasetRequest {
914
955
  */
915
956
  Schema: Schema | undefined;
916
957
  /**
958
+ * @public
917
959
  * <p>An Key Management Service (KMS) key and the Identity and Access Management (IAM) role that Amazon Forecast can assume to access
918
960
  * the key.</p>
919
961
  */
920
962
  EncryptionConfig?: EncryptionConfig;
921
963
  /**
964
+ * @public
922
965
  * <p>The optional metadata that you apply to the dataset to help you categorize and organize
923
966
  * them. Each tag consists of a key and an optional value, both of which you define.</p>
924
967
  * <p>The following basic restrictions apply to tags:</p>
@@ -962,6 +1005,7 @@ export interface CreateDatasetRequest {
962
1005
  */
963
1006
  export interface CreateDatasetResponse {
964
1007
  /**
1008
+ * @public
965
1009
  * <p>The Amazon Resource Name (ARN) of the dataset.</p>
966
1010
  */
967
1011
  DatasetArn?: string;
@@ -971,10 +1015,12 @@ export interface CreateDatasetResponse {
971
1015
  */
972
1016
  export interface CreateDatasetGroupRequest {
973
1017
  /**
1018
+ * @public
974
1019
  * <p>A name for the dataset group.</p>
975
1020
  */
976
1021
  DatasetGroupName: string | undefined;
977
1022
  /**
1023
+ * @public
978
1024
  * <p>The domain associated with the dataset group. When you add a dataset to a dataset group,
979
1025
  * this value and the value specified for the <code>Domain</code> parameter of the <a href="https://docs.aws.amazon.com/forecast/latest/dg/API_CreateDataset.html">CreateDataset</a>
980
1026
  * operation must match.</p>
@@ -987,11 +1033,13 @@ export interface CreateDatasetGroupRequest {
987
1033
  */
988
1034
  Domain: Domain | string | undefined;
989
1035
  /**
1036
+ * @public
990
1037
  * <p>An array of Amazon Resource Names (ARNs) of the datasets that you want to include in the
991
1038
  * dataset group.</p>
992
1039
  */
993
1040
  DatasetArns?: string[];
994
1041
  /**
1042
+ * @public
995
1043
  * <p>The optional metadata that you apply to the dataset group to help you categorize and
996
1044
  * organize them. Each tag consists of a key and an optional value, both of which you
997
1045
  * define.</p>
@@ -1036,6 +1084,7 @@ export interface CreateDatasetGroupRequest {
1036
1084
  */
1037
1085
  export interface CreateDatasetGroupResponse {
1038
1086
  /**
1087
+ * @public
1039
1088
  * <p>The Amazon Resource Name (ARN) of the dataset group.</p>
1040
1089
  */
1041
1090
  DatasetGroupArn?: string;
@@ -1048,10 +1097,12 @@ export interface CreateDatasetGroupResponse {
1048
1097
  */
1049
1098
  export interface S3Config {
1050
1099
  /**
1100
+ * @public
1051
1101
  * <p>The path to an Amazon Simple Storage Service (Amazon S3) bucket or file(s) in an Amazon S3 bucket.</p>
1052
1102
  */
1053
1103
  Path: string | undefined;
1054
1104
  /**
1105
+ * @public
1055
1106
  * <p>The ARN of the Identity and Access Management (IAM) role that Amazon Forecast can assume to access the Amazon S3
1056
1107
  * bucket or files. If you provide a value for the <code>KMSKeyArn</code> key, the role must
1057
1108
  * allow access to the key.</p>
@@ -1060,6 +1111,7 @@ export interface S3Config {
1060
1111
  */
1061
1112
  RoleArn: string | undefined;
1062
1113
  /**
1114
+ * @public
1063
1115
  * <p>The Amazon Resource Name (ARN) of an Key Management Service (KMS) key.</p>
1064
1116
  */
1065
1117
  KMSKeyArn?: string;
@@ -1071,6 +1123,7 @@ export interface S3Config {
1071
1123
  */
1072
1124
  export interface DataSource {
1073
1125
  /**
1126
+ * @public
1074
1127
  * <p>The path to the data stored in an Amazon Simple Storage Service (Amazon S3) bucket along with the
1075
1128
  * credentials to access the data.</p>
1076
1129
  */
@@ -1093,17 +1146,20 @@ export type ImportMode = (typeof ImportMode)[keyof typeof ImportMode];
1093
1146
  */
1094
1147
  export interface CreateDatasetImportJobRequest {
1095
1148
  /**
1149
+ * @public
1096
1150
  * <p>The name for the dataset import job. We recommend including the current timestamp in the
1097
1151
  * name, for example, <code>20190721DatasetImport</code>. This can help you avoid getting a
1098
1152
  * <code>ResourceAlreadyExistsException</code> exception.</p>
1099
1153
  */
1100
1154
  DatasetImportJobName: string | undefined;
1101
1155
  /**
1156
+ * @public
1102
1157
  * <p>The Amazon Resource Name (ARN) of the Amazon Forecast dataset that you want to import data
1103
1158
  * to.</p>
1104
1159
  */
1105
1160
  DatasetArn: string | undefined;
1106
1161
  /**
1162
+ * @public
1107
1163
  * <p>The location of the training data to import and an Identity and Access Management (IAM) role that Amazon Forecast
1108
1164
  * can assume to access the data. The training data must be stored in an Amazon S3 bucket.</p>
1109
1165
  * <p>If encryption is used, <code>DataSource</code> must include an Key Management Service (KMS) key and the
@@ -1113,6 +1169,7 @@ export interface CreateDatasetImportJobRequest {
1113
1169
  */
1114
1170
  DataSource: DataSource | undefined;
1115
1171
  /**
1172
+ * @public
1116
1173
  * <p>The format of timestamps in the dataset. The format that you specify depends on the
1117
1174
  * <code>DataFrequency</code> specified when the dataset was created. The following formats are
1118
1175
  * supported</p>
@@ -1132,6 +1189,7 @@ export interface CreateDatasetImportJobRequest {
1132
1189
  */
1133
1190
  TimestampFormat?: string;
1134
1191
  /**
1192
+ * @public
1135
1193
  * <p>A single time zone for every item in your dataset. This option is ideal for datasets
1136
1194
  * with all timestamps within a single time zone, or if all timestamps are normalized to a
1137
1195
  * single time zone. </p>
@@ -1140,12 +1198,14 @@ export interface CreateDatasetImportJobRequest {
1140
1198
  */
1141
1199
  TimeZone?: string;
1142
1200
  /**
1201
+ * @public
1143
1202
  * <p>Automatically derive time zone information from the geolocation attribute. This option
1144
1203
  * is ideal for datasets that contain timestamps in multiple time zones and those
1145
1204
  * timestamps are expressed in local time.</p>
1146
1205
  */
1147
1206
  UseGeolocationForTimeZone?: boolean;
1148
1207
  /**
1208
+ * @public
1149
1209
  * <p>The format of the geolocation attribute. The geolocation attribute can be formatted in
1150
1210
  * one of two ways:</p>
1151
1211
  * <ul>
@@ -1161,6 +1221,7 @@ export interface CreateDatasetImportJobRequest {
1161
1221
  */
1162
1222
  GeolocationFormat?: string;
1163
1223
  /**
1224
+ * @public
1164
1225
  * <p>The optional metadata that you apply to the dataset import job to help you categorize and
1165
1226
  * organize them. Each tag consists of a key and an optional value, both of which you
1166
1227
  * define.</p>
@@ -1200,10 +1261,12 @@ export interface CreateDatasetImportJobRequest {
1200
1261
  */
1201
1262
  Tags?: Tag[];
1202
1263
  /**
1264
+ * @public
1203
1265
  * <p>The format of the imported data, CSV or PARQUET. The default value is CSV.</p>
1204
1266
  */
1205
1267
  Format?: string;
1206
1268
  /**
1269
+ * @public
1207
1270
  * <p>Specifies whether the dataset import job is a <code>FULL</code> or <code>INCREMENTAL</code> import. A <code>FULL</code> dataset import replaces all of the existing data with the newly imported data. An <code>INCREMENTAL</code> import appends the imported data to the existing data.</p>
1208
1271
  */
1209
1272
  ImportMode?: ImportMode | string;
@@ -1213,6 +1276,7 @@ export interface CreateDatasetImportJobRequest {
1213
1276
  */
1214
1277
  export interface CreateDatasetImportJobResponse {
1215
1278
  /**
1279
+ * @public
1216
1280
  * <p>The Amazon Resource Name (ARN) of the dataset import job.</p>
1217
1281
  */
1218
1282
  DatasetImportJobArn?: string;
@@ -1255,6 +1319,7 @@ export type TimeSeriesGranularity = (typeof TimeSeriesGranularity)[keyof typeof
1255
1319
  */
1256
1320
  export interface ExplainabilityConfig {
1257
1321
  /**
1322
+ * @public
1258
1323
  * <p>To create an Explainability for all time series in your datasets, use
1259
1324
  * <code>ALL</code>. To create an Explainability for specific time series in your datasets,
1260
1325
  * use <code>SPECIFIC</code>.</p>
@@ -1263,6 +1328,7 @@ export interface ExplainabilityConfig {
1263
1328
  */
1264
1329
  TimeSeriesGranularity: TimeSeriesGranularity | string | undefined;
1265
1330
  /**
1331
+ * @public
1266
1332
  * <p>To create an Explainability for all time points in your forecast horizon, use
1267
1333
  * <code>ALL</code>. To create an Explainability for specific time points in your
1268
1334
  * forecast horizon, use <code>SPECIFIC</code>.</p>
@@ -1276,33 +1342,40 @@ export interface ExplainabilityConfig {
1276
1342
  */
1277
1343
  export interface CreateExplainabilityRequest {
1278
1344
  /**
1345
+ * @public
1279
1346
  * <p>A unique name for the Explainability.</p>
1280
1347
  */
1281
1348
  ExplainabilityName: string | undefined;
1282
1349
  /**
1350
+ * @public
1283
1351
  * <p>The Amazon Resource Name (ARN) of the Predictor or Forecast used to create the
1284
1352
  * Explainability.</p>
1285
1353
  */
1286
1354
  ResourceArn: string | undefined;
1287
1355
  /**
1356
+ * @public
1288
1357
  * <p>The configuration settings that define the granularity of time series and time points
1289
1358
  * for the Explainability.</p>
1290
1359
  */
1291
1360
  ExplainabilityConfig: ExplainabilityConfig | undefined;
1292
1361
  /**
1362
+ * @public
1293
1363
  * <p>The source of your data, an Identity and Access Management (IAM) role that allows Amazon Forecast to
1294
1364
  * access the data and, optionally, an Key Management Service (KMS) key.</p>
1295
1365
  */
1296
1366
  DataSource?: DataSource;
1297
1367
  /**
1368
+ * @public
1298
1369
  * <p>Defines the fields of a dataset.</p>
1299
1370
  */
1300
1371
  Schema?: Schema;
1301
1372
  /**
1373
+ * @public
1302
1374
  * <p>Create an Explainability visualization that is viewable within the Amazon Web Services console.</p>
1303
1375
  */
1304
1376
  EnableVisualization?: boolean;
1305
1377
  /**
1378
+ * @public
1306
1379
  * <p>If <code>TimePointGranularity</code> is set to <code>SPECIFIC</code>, define the first
1307
1380
  * point for the Explainability.</p>
1308
1381
  * <p>Use the following timestamp format: yyyy-MM-ddTHH:mm:ss (example:
@@ -1310,6 +1383,7 @@ export interface CreateExplainabilityRequest {
1310
1383
  */
1311
1384
  StartDateTime?: string;
1312
1385
  /**
1386
+ * @public
1313
1387
  * <p>If <code>TimePointGranularity</code> is set to <code>SPECIFIC</code>, define the last
1314
1388
  * time point for the Explainability.</p>
1315
1389
  * <p>Use the following timestamp format: yyyy-MM-ddTHH:mm:ss (example:
@@ -1317,6 +1391,7 @@ export interface CreateExplainabilityRequest {
1317
1391
  */
1318
1392
  EndDateTime?: string;
1319
1393
  /**
1394
+ * @public
1320
1395
  * <p>Optional metadata to help you categorize and organize your resources. Each tag
1321
1396
  * consists of a key and an optional value, both of which you define. Tag keys and values
1322
1397
  * are case sensitive.</p>
@@ -1357,6 +1432,7 @@ export interface CreateExplainabilityRequest {
1357
1432
  */
1358
1433
  export interface CreateExplainabilityResponse {
1359
1434
  /**
1435
+ * @public
1360
1436
  * <p>The Amazon Resource Name (ARN) of the Explainability.</p>
1361
1437
  */
1362
1438
  ExplainabilityArn?: string;
@@ -1368,6 +1444,7 @@ export interface CreateExplainabilityResponse {
1368
1444
  */
1369
1445
  export interface DataDestination {
1370
1446
  /**
1447
+ * @public
1371
1448
  * <p>The path to an Amazon Simple Storage Service (Amazon S3) bucket along with the credentials to access the
1372
1449
  * bucket.</p>
1373
1450
  */
@@ -1378,19 +1455,23 @@ export interface DataDestination {
1378
1455
  */
1379
1456
  export interface CreateExplainabilityExportRequest {
1380
1457
  /**
1458
+ * @public
1381
1459
  * <p>A unique name for the Explainability export.</p>
1382
1460
  */
1383
1461
  ExplainabilityExportName: string | undefined;
1384
1462
  /**
1463
+ * @public
1385
1464
  * <p>The Amazon Resource Name (ARN) of the Explainability to export.</p>
1386
1465
  */
1387
1466
  ExplainabilityArn: string | undefined;
1388
1467
  /**
1468
+ * @public
1389
1469
  * <p>The destination for an export job. Provide an S3 path, an Identity and Access Management (IAM) role that allows Amazon Forecast
1390
1470
  * to access the location, and an Key Management Service (KMS) key (optional). </p>
1391
1471
  */
1392
1472
  Destination: DataDestination | undefined;
1393
1473
  /**
1474
+ * @public
1394
1475
  * <p>Optional metadata to help you categorize and organize your resources. Each tag
1395
1476
  * consists of a key and an optional value, both of which you define. Tag keys and values
1396
1477
  * are case sensitive.</p>
@@ -1426,6 +1507,7 @@ export interface CreateExplainabilityExportRequest {
1426
1507
  */
1427
1508
  Tags?: Tag[];
1428
1509
  /**
1510
+ * @public
1429
1511
  * <p>The format of the exported data, CSV or PARQUET.</p>
1430
1512
  */
1431
1513
  Format?: string;
@@ -1435,6 +1517,7 @@ export interface CreateExplainabilityExportRequest {
1435
1517
  */
1436
1518
  export interface CreateExplainabilityExportResponse {
1437
1519
  /**
1520
+ * @public
1438
1521
  * <p>The Amazon Resource Name (ARN) of the export.</p>
1439
1522
  */
1440
1523
  ExplainabilityExportArn?: string;
@@ -1445,15 +1528,18 @@ export interface CreateExplainabilityExportResponse {
1445
1528
  */
1446
1529
  export interface TimeSeriesIdentifiers {
1447
1530
  /**
1531
+ * @public
1448
1532
  * <p>The source of your data, an Identity and Access Management (IAM) role that allows Amazon Forecast to
1449
1533
  * access the data and, optionally, an Key Management Service (KMS) key.</p>
1450
1534
  */
1451
1535
  DataSource?: DataSource;
1452
1536
  /**
1537
+ * @public
1453
1538
  * <p>Defines the fields of a dataset.</p>
1454
1539
  */
1455
1540
  Schema?: Schema;
1456
1541
  /**
1542
+ * @public
1457
1543
  * <p>The format of the data, either CSV or PARQUET.</p>
1458
1544
  */
1459
1545
  Format?: string;
@@ -1482,6 +1568,7 @@ export interface TimeSeriesIdentifiers {
1482
1568
  */
1483
1569
  export interface TimeSeriesSelector {
1484
1570
  /**
1571
+ * @public
1485
1572
  * <p>Details about the import file that contains the time series for which you want to create forecasts.</p>
1486
1573
  */
1487
1574
  TimeSeriesIdentifiers?: TimeSeriesIdentifiers;
@@ -1491,14 +1578,17 @@ export interface TimeSeriesSelector {
1491
1578
  */
1492
1579
  export interface CreateForecastRequest {
1493
1580
  /**
1581
+ * @public
1494
1582
  * <p>A name for the forecast.</p>
1495
1583
  */
1496
1584
  ForecastName: string | undefined;
1497
1585
  /**
1586
+ * @public
1498
1587
  * <p>The Amazon Resource Name (ARN) of the predictor to use to generate the forecast.</p>
1499
1588
  */
1500
1589
  PredictorArn: string | undefined;
1501
1590
  /**
1591
+ * @public
1502
1592
  * <p>The quantiles at which probabilistic forecasts are generated. <b>You
1503
1593
  * can currently specify up to 5 quantiles per forecast</b>. Accepted values include
1504
1594
  * <code>0.01 to 0.99</code> (increments of .01 only) and <code>mean</code>. The mean forecast
@@ -1511,6 +1601,7 @@ export interface CreateForecastRequest {
1511
1601
  */
1512
1602
  ForecastTypes?: string[];
1513
1603
  /**
1604
+ * @public
1514
1605
  * <p>The optional metadata that you apply to the forecast to help you categorize and organize
1515
1606
  * them. Each tag consists of a key and an optional value, both of which you define.</p>
1516
1607
  * <p>The following basic restrictions apply to tags:</p>
@@ -1549,6 +1640,7 @@ export interface CreateForecastRequest {
1549
1640
  */
1550
1641
  Tags?: Tag[];
1551
1642
  /**
1643
+ * @public
1552
1644
  * <p>Defines the set of time series that are used to create the forecasts in a <code>TimeSeriesIdentifiers</code> object.</p>
1553
1645
  * <p>The <code>TimeSeriesIdentifiers</code> object needs the following information:</p>
1554
1646
  * <ul>
@@ -1576,6 +1668,7 @@ export interface CreateForecastRequest {
1576
1668
  */
1577
1669
  export interface CreateForecastResponse {
1578
1670
  /**
1671
+ * @public
1579
1672
  * <p>The Amazon Resource Name (ARN) of the forecast.</p>
1580
1673
  */
1581
1674
  ForecastArn?: string;
@@ -1585,14 +1678,17 @@ export interface CreateForecastResponse {
1585
1678
  */
1586
1679
  export interface CreateForecastExportJobRequest {
1587
1680
  /**
1681
+ * @public
1588
1682
  * <p>The name for the forecast export job.</p>
1589
1683
  */
1590
1684
  ForecastExportJobName: string | undefined;
1591
1685
  /**
1686
+ * @public
1592
1687
  * <p>The Amazon Resource Name (ARN) of the forecast that you want to export.</p>
1593
1688
  */
1594
1689
  ForecastArn: string | undefined;
1595
1690
  /**
1691
+ * @public
1596
1692
  * <p>The location where you want to save the forecast and an Identity and Access Management (IAM) role that
1597
1693
  * Amazon Forecast can assume to access the location. The forecast must be exported to an Amazon S3
1598
1694
  * bucket.</p>
@@ -1601,6 +1697,7 @@ export interface CreateForecastExportJobRequest {
1601
1697
  */
1602
1698
  Destination: DataDestination | undefined;
1603
1699
  /**
1700
+ * @public
1604
1701
  * <p>The optional metadata that you apply to the forecast export job to help you categorize and
1605
1702
  * organize them. Each tag consists of a key and an optional value, both of which you
1606
1703
  * define.</p>
@@ -1640,6 +1737,7 @@ export interface CreateForecastExportJobRequest {
1640
1737
  */
1641
1738
  Tags?: Tag[];
1642
1739
  /**
1740
+ * @public
1643
1741
  * <p>The format of the exported data, CSV or PARQUET. The default value is CSV.</p>
1644
1742
  */
1645
1743
  Format?: string;
@@ -1649,6 +1747,7 @@ export interface CreateForecastExportJobRequest {
1649
1747
  */
1650
1748
  export interface CreateForecastExportJobResponse {
1651
1749
  /**
1750
+ * @public
1652
1751
  * <p>The Amazon Resource Name (ARN) of the export job.</p>
1653
1752
  */
1654
1753
  ForecastExportJobArn?: string;
@@ -1658,14 +1757,17 @@ export interface CreateForecastExportJobResponse {
1658
1757
  */
1659
1758
  export interface CreateMonitorRequest {
1660
1759
  /**
1760
+ * @public
1661
1761
  * <p>The name of the monitor resource.</p>
1662
1762
  */
1663
1763
  MonitorName: string | undefined;
1664
1764
  /**
1765
+ * @public
1665
1766
  * <p>The Amazon Resource Name (ARN) of the predictor to monitor.</p>
1666
1767
  */
1667
1768
  ResourceArn: string | undefined;
1668
1769
  /**
1770
+ * @public
1669
1771
  * <p>A list of <a href="https://docs.aws.amazon.com/forecast/latest/dg/tagging-forecast-resources.html">tags</a> to apply to the monitor resource.</p>
1670
1772
  */
1671
1773
  Tags?: Tag[];
@@ -1675,6 +1777,7 @@ export interface CreateMonitorRequest {
1675
1777
  */
1676
1778
  export interface CreateMonitorResponse {
1677
1779
  /**
1780
+ * @public
1678
1781
  * <p>The Amazon Resource Name (ARN) of the monitor resource.</p>
1679
1782
  */
1680
1783
  MonitorArn?: string;
@@ -1699,11 +1802,13 @@ export type AutoMLOverrideStrategy = (typeof AutoMLOverrideStrategy)[keyof typeo
1699
1802
  */
1700
1803
  export interface EvaluationParameters {
1701
1804
  /**
1805
+ * @public
1702
1806
  * <p>The number of times to split the input data. The default is 1. Valid values are 1 through
1703
1807
  * 5.</p>
1704
1808
  */
1705
1809
  NumberOfBacktestWindows?: number;
1706
1810
  /**
1811
+ * @public
1707
1812
  * <p>The point from the end of the dataset where you want to split the data for model training
1708
1813
  * and testing (evaluation). Specify the value as the number of data points. The default is the
1709
1814
  * value of the forecast horizon. <code>BackTestWindowOffset</code> can be used to mimic a past
@@ -1748,10 +1853,12 @@ export type FeaturizationMethodName = (typeof FeaturizationMethodName)[keyof typ
1748
1853
  */
1749
1854
  export interface FeaturizationMethod {
1750
1855
  /**
1856
+ * @public
1751
1857
  * <p>The name of the method. The "filling" method is the only supported method.</p>
1752
1858
  */
1753
1859
  FeaturizationMethodName: FeaturizationMethodName | string | undefined;
1754
1860
  /**
1861
+ * @public
1755
1862
  * <p>The method parameters (key-value pairs), which are a map of override parameters. Specify
1756
1863
  * these parameters to override the default values. Related Time Series attributes do not accept
1757
1864
  * aggregation parameters.</p>
@@ -1847,6 +1954,7 @@ export interface FeaturizationMethod {
1847
1954
  */
1848
1955
  export interface Featurization {
1849
1956
  /**
1957
+ * @public
1850
1958
  * <p>The name of the schema attribute that specifies the data field to be featurized. Amazon
1851
1959
  * Forecast supports the target field of the <code>TARGET_TIME_SERIES</code> and the
1852
1960
  * <code>RELATED_TIME_SERIES</code> datasets. For example, for the <code>RETAIL</code> domain,
@@ -1855,6 +1963,7 @@ export interface Featurization {
1855
1963
  */
1856
1964
  AttributeName: string | undefined;
1857
1965
  /**
1966
+ * @public
1858
1967
  * <p>An array of one <code>FeaturizationMethod</code> object that specifies the feature
1859
1968
  * transformation method.</p>
1860
1969
  */
@@ -1881,6 +1990,7 @@ export interface Featurization {
1881
1990
  */
1882
1991
  export interface FeaturizationConfig {
1883
1992
  /**
1993
+ * @public
1884
1994
  * <p>The frequency of predictions in a forecast.</p>
1885
1995
  * <p>Valid intervals are an integer followed by Y (Year), M (Month), W (Week), D (Day), H (Hour), and min (Minute). For example,
1886
1996
  * "1D" indicates every day and "15min" indicates every 15 minutes. You cannot specify a value that would overlap with the next larger frequency. That means, for example, you cannot specify a frequency of 60 minutes, because that is equivalent to 1 hour. The valid values for each frequency are the following:</p>
@@ -1912,6 +2022,7 @@ export interface FeaturizationConfig {
1912
2022
  */
1913
2023
  ForecastFrequency: string | undefined;
1914
2024
  /**
2025
+ * @public
1915
2026
  * <p>An array of dimension (field) names that specify how to group the generated
1916
2027
  * forecast.</p>
1917
2028
  * <p>For example, suppose that you are generating a forecast for item sales across all of your
@@ -1925,6 +2036,7 @@ export interface FeaturizationConfig {
1925
2036
  */
1926
2037
  ForecastDimensions?: string[];
1927
2038
  /**
2039
+ * @public
1928
2040
  * <p>An array of featurization (transformation) information for the fields of a dataset.</p>
1929
2041
  */
1930
2042
  Featurizations?: Featurization[];
@@ -1936,10 +2048,12 @@ export interface FeaturizationConfig {
1936
2048
  */
1937
2049
  export interface CategoricalParameterRange {
1938
2050
  /**
2051
+ * @public
1939
2052
  * <p>The name of the categorical hyperparameter to tune.</p>
1940
2053
  */
1941
2054
  Name: string | undefined;
1942
2055
  /**
2056
+ * @public
1943
2057
  * <p>A list of the tunable categories for the hyperparameter.</p>
1944
2058
  */
1945
2059
  Values: string[] | undefined;
@@ -1965,18 +2079,22 @@ export type ScalingType = (typeof ScalingType)[keyof typeof ScalingType];
1965
2079
  */
1966
2080
  export interface ContinuousParameterRange {
1967
2081
  /**
2082
+ * @public
1968
2083
  * <p>The name of the hyperparameter to tune.</p>
1969
2084
  */
1970
2085
  Name: string | undefined;
1971
2086
  /**
2087
+ * @public
1972
2088
  * <p>The maximum tunable value of the hyperparameter.</p>
1973
2089
  */
1974
2090
  MaxValue: number | undefined;
1975
2091
  /**
2092
+ * @public
1976
2093
  * <p>The minimum tunable value of the hyperparameter.</p>
1977
2094
  */
1978
2095
  MinValue: number | undefined;
1979
2096
  /**
2097
+ * @public
1980
2098
  * <p>The scale that hyperparameter tuning uses to search the hyperparameter range.
1981
2099
  * Valid values:</p>
1982
2100
  * <dl>
@@ -2016,18 +2134,22 @@ export interface ContinuousParameterRange {
2016
2134
  */
2017
2135
  export interface IntegerParameterRange {
2018
2136
  /**
2137
+ * @public
2019
2138
  * <p>The name of the hyperparameter to tune.</p>
2020
2139
  */
2021
2140
  Name: string | undefined;
2022
2141
  /**
2142
+ * @public
2023
2143
  * <p>The maximum tunable value of the hyperparameter.</p>
2024
2144
  */
2025
2145
  MaxValue: number | undefined;
2026
2146
  /**
2147
+ * @public
2027
2148
  * <p>The minimum tunable value of the hyperparameter.</p>
2028
2149
  */
2029
2150
  MinValue: number | undefined;
2030
2151
  /**
2152
+ * @public
2031
2153
  * <p>The scale that hyperparameter tuning uses to search the hyperparameter range.
2032
2154
  * Valid values:</p>
2033
2155
  * <dl>
@@ -2068,14 +2190,17 @@ export interface IntegerParameterRange {
2068
2190
  */
2069
2191
  export interface ParameterRanges {
2070
2192
  /**
2193
+ * @public
2071
2194
  * <p>Specifies the tunable range for each categorical hyperparameter.</p>
2072
2195
  */
2073
2196
  CategoricalParameterRanges?: CategoricalParameterRange[];
2074
2197
  /**
2198
+ * @public
2075
2199
  * <p>Specifies the tunable range for each continuous hyperparameter.</p>
2076
2200
  */
2077
2201
  ContinuousParameterRanges?: ContinuousParameterRange[];
2078
2202
  /**
2203
+ * @public
2079
2204
  * <p>Specifies the tunable range for each integer hyperparameter.</p>
2080
2205
  */
2081
2206
  IntegerParameterRanges?: IntegerParameterRange[];
@@ -2094,6 +2219,7 @@ export interface ParameterRanges {
2094
2219
  */
2095
2220
  export interface HyperParameterTuningJobConfig {
2096
2221
  /**
2222
+ * @public
2097
2223
  * <p>Specifies the ranges of valid values for the hyperparameters.</p>
2098
2224
  */
2099
2225
  ParameterRanges?: ParameterRanges;
@@ -2124,11 +2250,13 @@ export interface HyperParameterTuningJobConfig {
2124
2250
  */
2125
2251
  export interface SupplementaryFeature {
2126
2252
  /**
2253
+ * @public
2127
2254
  * <p>The name of the feature. Valid values: <code>"holiday"</code> and
2128
2255
  * <code>"weather"</code>.</p>
2129
2256
  */
2130
2257
  Name: string | undefined;
2131
2258
  /**
2259
+ * @public
2132
2260
  * <p>
2133
2261
  * <b>Weather Index</b>
2134
2262
  * </p>
@@ -2354,10 +2482,12 @@ export interface SupplementaryFeature {
2354
2482
  */
2355
2483
  export interface InputDataConfig {
2356
2484
  /**
2485
+ * @public
2357
2486
  * <p>The Amazon Resource Name (ARN) of the dataset group.</p>
2358
2487
  */
2359
2488
  DatasetGroupArn: string | undefined;
2360
2489
  /**
2490
+ * @public
2361
2491
  * <p>An array of supplementary features. The only supported feature is a holiday
2362
2492
  * calendar.</p>
2363
2493
  */
@@ -2368,10 +2498,12 @@ export interface InputDataConfig {
2368
2498
  */
2369
2499
  export interface CreatePredictorRequest {
2370
2500
  /**
2501
+ * @public
2371
2502
  * <p>A name for the predictor.</p>
2372
2503
  */
2373
2504
  PredictorName: string | undefined;
2374
2505
  /**
2506
+ * @public
2375
2507
  * <p>The Amazon Resource Name (ARN) of the algorithm to use for model training. Required if
2376
2508
  * <code>PerformAutoML</code> is not set to <code>true</code>.</p>
2377
2509
  * <p class="title">
@@ -2412,6 +2544,7 @@ export interface CreatePredictorRequest {
2412
2544
  */
2413
2545
  AlgorithmArn?: string;
2414
2546
  /**
2547
+ * @public
2415
2548
  * <p>Specifies the number of time-steps that the model is trained to predict. The forecast
2416
2549
  * horizon is also called the prediction length.</p>
2417
2550
  * <p>For example, if you configure a dataset for daily data collection (using the
@@ -2422,6 +2555,7 @@ export interface CreatePredictorRequest {
2422
2555
  */
2423
2556
  ForecastHorizon: number | undefined;
2424
2557
  /**
2558
+ * @public
2425
2559
  * <p>Specifies the forecast types used to train a predictor. You can specify up to five
2426
2560
  * forecast types. Forecast types can be quantiles from 0.01 to 0.99, by increments of 0.01 or
2427
2561
  * higher. You can also specify the mean forecast with <code>mean</code>. </p>
@@ -2429,6 +2563,7 @@ export interface CreatePredictorRequest {
2429
2563
  */
2430
2564
  ForecastTypes?: string[];
2431
2565
  /**
2566
+ * @public
2432
2567
  * <p>Whether to perform AutoML. When Amazon Forecast performs AutoML, it evaluates the algorithms it
2433
2568
  * provides and chooses the best algorithm and configuration for your training dataset.</p>
2434
2569
  * <p>The default value is <code>false</code>. In this case, you are required to specify an
@@ -2439,6 +2574,7 @@ export interface CreatePredictorRequest {
2439
2574
  */
2440
2575
  PerformAutoML?: boolean;
2441
2576
  /**
2577
+ * @public
2442
2578
  * <note>
2443
2579
  * <p> The <code>LatencyOptimized</code> AutoML override strategy is only available in private beta.
2444
2580
  * Contact Amazon Web Services Support or your account manager to learn more about access privileges.
@@ -2451,6 +2587,7 @@ export interface CreatePredictorRequest {
2451
2587
  */
2452
2588
  AutoMLOverrideStrategy?: AutoMLOverrideStrategy | string;
2453
2589
  /**
2590
+ * @public
2454
2591
  * <p>Whether to perform hyperparameter optimization (HPO). HPO finds optimal hyperparameter
2455
2592
  * values for your training data. The process of performing HPO is known as running a
2456
2593
  * hyperparameter tuning job.</p>
@@ -2473,18 +2610,21 @@ export interface CreatePredictorRequest {
2473
2610
  */
2474
2611
  PerformHPO?: boolean;
2475
2612
  /**
2613
+ * @public
2476
2614
  * <p>The hyperparameters to override for model training. The hyperparameters that you can
2477
2615
  * override are listed in the individual algorithms. For the list of supported algorithms, see
2478
2616
  * <a>aws-forecast-choosing-recipes</a>.</p>
2479
2617
  */
2480
2618
  TrainingParameters?: Record<string, string>;
2481
2619
  /**
2620
+ * @public
2482
2621
  * <p>Used to override the default evaluation parameters of the specified algorithm. Amazon Forecast
2483
2622
  * evaluates a predictor by splitting a dataset into training data and testing data. The
2484
2623
  * evaluation parameters define how to perform the split and the number of iterations.</p>
2485
2624
  */
2486
2625
  EvaluationParameters?: EvaluationParameters;
2487
2626
  /**
2627
+ * @public
2488
2628
  * <p>Provides hyperparameter override values for the algorithm. If you don't provide this
2489
2629
  * parameter, Amazon Forecast uses default values. The individual algorithms specify which
2490
2630
  * hyperparameters support hyperparameter optimization (HPO). For more information, see <a>aws-forecast-choosing-recipes</a>.</p>
@@ -2493,19 +2633,23 @@ export interface CreatePredictorRequest {
2493
2633
  */
2494
2634
  HPOConfig?: HyperParameterTuningJobConfig;
2495
2635
  /**
2636
+ * @public
2496
2637
  * <p>Describes the dataset group that contains the data to use to train the predictor.</p>
2497
2638
  */
2498
2639
  InputDataConfig: InputDataConfig | undefined;
2499
2640
  /**
2641
+ * @public
2500
2642
  * <p>The featurization configuration.</p>
2501
2643
  */
2502
2644
  FeaturizationConfig: FeaturizationConfig | undefined;
2503
2645
  /**
2646
+ * @public
2504
2647
  * <p>An Key Management Service (KMS) key and the Identity and Access Management (IAM) role that Amazon Forecast can assume to access
2505
2648
  * the key.</p>
2506
2649
  */
2507
2650
  EncryptionConfig?: EncryptionConfig;
2508
2651
  /**
2652
+ * @public
2509
2653
  * <p>The optional metadata that you apply to the predictor to help you categorize and organize
2510
2654
  * them. Each tag consists of a key and an optional value, both of which you define.</p>
2511
2655
  * <p>The following basic restrictions apply to tags:</p>
@@ -2544,6 +2688,7 @@ export interface CreatePredictorRequest {
2544
2688
  */
2545
2689
  Tags?: Tag[];
2546
2690
  /**
2691
+ * @public
2547
2692
  * <p>The accuracy metric used to optimize the predictor.</p>
2548
2693
  */
2549
2694
  OptimizationMetric?: OptimizationMetric | string;
@@ -2553,6 +2698,7 @@ export interface CreatePredictorRequest {
2553
2698
  */
2554
2699
  export interface CreatePredictorResponse {
2555
2700
  /**
2701
+ * @public
2556
2702
  * <p>The Amazon Resource Name (ARN) of the predictor.</p>
2557
2703
  */
2558
2704
  PredictorArn?: string;
@@ -2562,19 +2708,23 @@ export interface CreatePredictorResponse {
2562
2708
  */
2563
2709
  export interface CreatePredictorBacktestExportJobRequest {
2564
2710
  /**
2711
+ * @public
2565
2712
  * <p>The name for the backtest export job.</p>
2566
2713
  */
2567
2714
  PredictorBacktestExportJobName: string | undefined;
2568
2715
  /**
2716
+ * @public
2569
2717
  * <p>The Amazon Resource Name (ARN) of the predictor that you want to export.</p>
2570
2718
  */
2571
2719
  PredictorArn: string | undefined;
2572
2720
  /**
2721
+ * @public
2573
2722
  * <p>The destination for an export job. Provide an S3 path, an Identity and Access Management (IAM) role that allows Amazon Forecast
2574
2723
  * to access the location, and an Key Management Service (KMS) key (optional). </p>
2575
2724
  */
2576
2725
  Destination: DataDestination | undefined;
2577
2726
  /**
2727
+ * @public
2578
2728
  * <p>Optional metadata to help you categorize and organize your backtests. Each tag
2579
2729
  * consists of a key and an optional value, both of which you define. Tag keys and values
2580
2730
  * are case sensitive.</p>
@@ -2610,6 +2760,7 @@ export interface CreatePredictorBacktestExportJobRequest {
2610
2760
  */
2611
2761
  Tags?: Tag[];
2612
2762
  /**
2763
+ * @public
2613
2764
  * <p>The format of the exported data, CSV or PARQUET. The default value is CSV.</p>
2614
2765
  */
2615
2766
  Format?: string;
@@ -2619,6 +2770,7 @@ export interface CreatePredictorBacktestExportJobRequest {
2619
2770
  */
2620
2771
  export interface CreatePredictorBacktestExportJobResponse {
2621
2772
  /**
2773
+ * @public
2622
2774
  * <p>The Amazon Resource Name (ARN) of the predictor backtest export job that you want to
2623
2775
  * export.</p>
2624
2776
  */
@@ -2629,14 +2781,17 @@ export interface CreatePredictorBacktestExportJobResponse {
2629
2781
  */
2630
2782
  export interface CreateWhatIfAnalysisRequest {
2631
2783
  /**
2784
+ * @public
2632
2785
  * <p>The name of the what-if analysis. Each name must be unique.</p>
2633
2786
  */
2634
2787
  WhatIfAnalysisName: string | undefined;
2635
2788
  /**
2789
+ * @public
2636
2790
  * <p>The Amazon Resource Name (ARN) of the baseline forecast.</p>
2637
2791
  */
2638
2792
  ForecastArn: string | undefined;
2639
2793
  /**
2794
+ * @public
2640
2795
  * <p>Defines the set of time series that are used in the what-if analysis with a <code>TimeSeriesIdentifiers</code>
2641
2796
  * object. What-if analyses are performed only for the time series in this object.</p>
2642
2797
  * <p>The <code>TimeSeriesIdentifiers</code> object needs the following information:</p>
@@ -2660,6 +2815,7 @@ export interface CreateWhatIfAnalysisRequest {
2660
2815
  */
2661
2816
  TimeSeriesSelector?: TimeSeriesSelector;
2662
2817
  /**
2818
+ * @public
2663
2819
  * <p>A list of <a href="https://docs.aws.amazon.com/forecast/latest/dg/tagging-forecast-resources.html">tags</a> to apply to the what if forecast.</p>
2664
2820
  */
2665
2821
  Tags?: Tag[];
@@ -2669,6 +2825,7 @@ export interface CreateWhatIfAnalysisRequest {
2669
2825
  */
2670
2826
  export interface CreateWhatIfAnalysisResponse {
2671
2827
  /**
2828
+ * @public
2672
2829
  * <p>The Amazon Resource Name (ARN) of the what-if analysis.</p>
2673
2830
  */
2674
2831
  WhatIfAnalysisArn?: string;
@@ -2683,20 +2840,24 @@ export interface CreateWhatIfAnalysisResponse {
2683
2840
  */
2684
2841
  export interface TimeSeriesReplacementsDataSource {
2685
2842
  /**
2843
+ * @public
2686
2844
  * <p>The path to the file(s) in an Amazon Simple Storage Service (Amazon S3) bucket, and an Identity and Access Management (IAM) role that
2687
2845
  * Amazon Forecast can assume to access the file(s). Optionally, includes an Key Management Service (KMS) key. This
2688
2846
  * object is part of the <a>DataSource</a> object that is submitted in the <a>CreateDatasetImportJob</a> request, and part of the <a>DataDestination</a> object.</p>
2689
2847
  */
2690
2848
  S3Config: S3Config | undefined;
2691
2849
  /**
2850
+ * @public
2692
2851
  * <p>Defines the fields of a dataset.</p>
2693
2852
  */
2694
2853
  Schema: Schema | undefined;
2695
2854
  /**
2855
+ * @public
2696
2856
  * <p>The format of the replacement data, CSV or PARQUET.</p>
2697
2857
  */
2698
2858
  Format?: string;
2699
2859
  /**
2860
+ * @public
2700
2861
  * <p>The timestamp format of the replacement data.</p>
2701
2862
  */
2702
2863
  TimestampFormat?: string;
@@ -2721,14 +2882,17 @@ export type Condition = (typeof Condition)[keyof typeof Condition];
2721
2882
  */
2722
2883
  export interface TimeSeriesCondition {
2723
2884
  /**
2885
+ * @public
2724
2886
  * <p>The item_id, dimension name, IM name, or timestamp that you are modifying.</p>
2725
2887
  */
2726
2888
  AttributeName: string | undefined;
2727
2889
  /**
2890
+ * @public
2728
2891
  * <p>The value that is applied for the chosen <code>Condition</code>.</p>
2729
2892
  */
2730
2893
  AttributeValue: string | undefined;
2731
2894
  /**
2895
+ * @public
2732
2896
  * <p>The condition to apply. Valid values are <code>EQUALS</code>, <code>NOT_EQUALS</code>, <code>LESS_THAN</code> and
2733
2897
  * <code>GREATER_THAN</code>.</p>
2734
2898
  */
@@ -2740,11 +2904,13 @@ export interface TimeSeriesCondition {
2740
2904
  */
2741
2905
  export interface TimeSeriesTransformation {
2742
2906
  /**
2907
+ * @public
2743
2908
  * <p>An array of actions that define a time series and how it is transformed. These transformations create a new
2744
2909
  * time series that is used for the what-if analysis.</p>
2745
2910
  */
2746
2911
  Action?: Action;
2747
2912
  /**
2913
+ * @public
2748
2914
  * <p>An array of conditions that define which members of the related time series are transformed.</p>
2749
2915
  */
2750
2916
  TimeSeriesConditions?: TimeSeriesCondition[];
@@ -2754,18 +2920,22 @@ export interface TimeSeriesTransformation {
2754
2920
  */
2755
2921
  export interface CreateWhatIfForecastRequest {
2756
2922
  /**
2923
+ * @public
2757
2924
  * <p>The name of the what-if forecast. Names must be unique within each what-if analysis.</p>
2758
2925
  */
2759
2926
  WhatIfForecastName: string | undefined;
2760
2927
  /**
2928
+ * @public
2761
2929
  * <p>The Amazon Resource Name (ARN) of the what-if analysis.</p>
2762
2930
  */
2763
2931
  WhatIfAnalysisArn: string | undefined;
2764
2932
  /**
2933
+ * @public
2765
2934
  * <p>The transformations that are applied to the baseline time series. Each transformation contains an action and a set of conditions. An action is applied only when all conditions are met. If no conditions are provided, the action is applied to all items.</p>
2766
2935
  */
2767
2936
  TimeSeriesTransformations?: TimeSeriesTransformation[];
2768
2937
  /**
2938
+ * @public
2769
2939
  * <p>The replacement time series dataset, which contains the rows that you want to change in the related time
2770
2940
  * series dataset. A replacement time series does not need to contain all rows that are in the baseline related time
2771
2941
  * series. Include only the rows (measure-dimension combinations) that you want to include in the what-if
@@ -2777,6 +2947,7 @@ export interface CreateWhatIfForecastRequest {
2777
2947
  */
2778
2948
  TimeSeriesReplacementsDataSource?: TimeSeriesReplacementsDataSource;
2779
2949
  /**
2950
+ * @public
2780
2951
  * <p>A list of <a href="https://docs.aws.amazon.com/forecast/latest/dg/tagging-forecast-resources.html">tags</a> to apply to the what if forecast.</p>
2781
2952
  */
2782
2953
  Tags?: Tag[];
@@ -2786,6 +2957,7 @@ export interface CreateWhatIfForecastRequest {
2786
2957
  */
2787
2958
  export interface CreateWhatIfForecastResponse {
2788
2959
  /**
2960
+ * @public
2789
2961
  * <p>The Amazon Resource Name (ARN) of the what-if forecast.</p>
2790
2962
  */
2791
2963
  WhatIfForecastArn?: string;
@@ -2795,14 +2967,17 @@ export interface CreateWhatIfForecastResponse {
2795
2967
  */
2796
2968
  export interface CreateWhatIfForecastExportRequest {
2797
2969
  /**
2970
+ * @public
2798
2971
  * <p>The name of the what-if forecast to export.</p>
2799
2972
  */
2800
2973
  WhatIfForecastExportName: string | undefined;
2801
2974
  /**
2975
+ * @public
2802
2976
  * <p>The list of what-if forecast Amazon Resource Names (ARNs) to export.</p>
2803
2977
  */
2804
2978
  WhatIfForecastArns: string[] | undefined;
2805
2979
  /**
2980
+ * @public
2806
2981
  * <p>The location where you want to save the forecast and an Identity and Access Management (IAM) role that
2807
2982
  * Amazon Forecast can assume to access the location. The forecast must be exported to an Amazon S3
2808
2983
  * bucket.</p>
@@ -2811,10 +2986,12 @@ export interface CreateWhatIfForecastExportRequest {
2811
2986
  */
2812
2987
  Destination: DataDestination | undefined;
2813
2988
  /**
2989
+ * @public
2814
2990
  * <p>A list of <a href="https://docs.aws.amazon.com/forecast/latest/dg/tagging-forecast-resources.html">tags</a> to apply to the what if forecast.</p>
2815
2991
  */
2816
2992
  Tags?: Tag[];
2817
2993
  /**
2994
+ * @public
2818
2995
  * <p>The format of the exported data, CSV or PARQUET.</p>
2819
2996
  */
2820
2997
  Format?: string;
@@ -2824,6 +3001,7 @@ export interface CreateWhatIfForecastExportRequest {
2824
3001
  */
2825
3002
  export interface CreateWhatIfForecastExportResponse {
2826
3003
  /**
3004
+ * @public
2827
3005
  * <p>The Amazon Resource Name (ARN) of the what-if forecast.</p>
2828
3006
  */
2829
3007
  WhatIfForecastExportArn?: string;
@@ -2833,6 +3011,7 @@ export interface CreateWhatIfForecastExportResponse {
2833
3011
  */
2834
3012
  export interface DeleteDatasetRequest {
2835
3013
  /**
3014
+ * @public
2836
3015
  * <p>The Amazon Resource Name (ARN) of the dataset to delete.</p>
2837
3016
  */
2838
3017
  DatasetArn: string | undefined;
@@ -2842,6 +3021,7 @@ export interface DeleteDatasetRequest {
2842
3021
  */
2843
3022
  export interface DeleteDatasetGroupRequest {
2844
3023
  /**
3024
+ * @public
2845
3025
  * <p>The Amazon Resource Name (ARN) of the dataset group to delete.</p>
2846
3026
  */
2847
3027
  DatasetGroupArn: string | undefined;
@@ -2851,6 +3031,7 @@ export interface DeleteDatasetGroupRequest {
2851
3031
  */
2852
3032
  export interface DeleteDatasetImportJobRequest {
2853
3033
  /**
3034
+ * @public
2854
3035
  * <p>The Amazon Resource Name (ARN) of the dataset import job to delete.</p>
2855
3036
  */
2856
3037
  DatasetImportJobArn: string | undefined;
@@ -2860,6 +3041,7 @@ export interface DeleteDatasetImportJobRequest {
2860
3041
  */
2861
3042
  export interface DeleteExplainabilityRequest {
2862
3043
  /**
3044
+ * @public
2863
3045
  * <p>The Amazon Resource Name (ARN) of the Explainability resource to delete.</p>
2864
3046
  */
2865
3047
  ExplainabilityArn: string | undefined;
@@ -2869,6 +3051,7 @@ export interface DeleteExplainabilityRequest {
2869
3051
  */
2870
3052
  export interface DeleteExplainabilityExportRequest {
2871
3053
  /**
3054
+ * @public
2872
3055
  * <p>The Amazon Resource Name (ARN) of the Explainability export to delete. </p>
2873
3056
  */
2874
3057
  ExplainabilityExportArn: string | undefined;
@@ -2878,6 +3061,7 @@ export interface DeleteExplainabilityExportRequest {
2878
3061
  */
2879
3062
  export interface DeleteForecastRequest {
2880
3063
  /**
3064
+ * @public
2881
3065
  * <p>The Amazon Resource Name (ARN) of the forecast to delete.</p>
2882
3066
  */
2883
3067
  ForecastArn: string | undefined;
@@ -2887,6 +3071,7 @@ export interface DeleteForecastRequest {
2887
3071
  */
2888
3072
  export interface DeleteForecastExportJobRequest {
2889
3073
  /**
3074
+ * @public
2890
3075
  * <p>The Amazon Resource Name (ARN) of the forecast export job to delete.</p>
2891
3076
  */
2892
3077
  ForecastExportJobArn: string | undefined;
@@ -2896,6 +3081,7 @@ export interface DeleteForecastExportJobRequest {
2896
3081
  */
2897
3082
  export interface DeleteMonitorRequest {
2898
3083
  /**
3084
+ * @public
2899
3085
  * <p>The Amazon Resource Name (ARN) of the monitor resource to delete.</p>
2900
3086
  */
2901
3087
  MonitorArn: string | undefined;
@@ -2905,6 +3091,7 @@ export interface DeleteMonitorRequest {
2905
3091
  */
2906
3092
  export interface DeletePredictorRequest {
2907
3093
  /**
3094
+ * @public
2908
3095
  * <p>The Amazon Resource Name (ARN) of the predictor to delete.</p>
2909
3096
  */
2910
3097
  PredictorArn: string | undefined;
@@ -2914,6 +3101,7 @@ export interface DeletePredictorRequest {
2914
3101
  */
2915
3102
  export interface DeletePredictorBacktestExportJobRequest {
2916
3103
  /**
3104
+ * @public
2917
3105
  * <p>The Amazon Resource Name (ARN) of the predictor backtest export job to delete.</p>
2918
3106
  */
2919
3107
  PredictorBacktestExportJobArn: string | undefined;
@@ -2923,6 +3111,7 @@ export interface DeletePredictorBacktestExportJobRequest {
2923
3111
  */
2924
3112
  export interface DeleteResourceTreeRequest {
2925
3113
  /**
3114
+ * @public
2926
3115
  * <p>The Amazon Resource Name (ARN) of the parent resource to delete. All child resources
2927
3116
  * of the parent resource will also be deleted.</p>
2928
3117
  */
@@ -2933,6 +3122,7 @@ export interface DeleteResourceTreeRequest {
2933
3122
  */
2934
3123
  export interface DeleteWhatIfAnalysisRequest {
2935
3124
  /**
3125
+ * @public
2936
3126
  * <p>The Amazon Resource Name (ARN) of the what-if analysis that you want to delete.</p>
2937
3127
  */
2938
3128
  WhatIfAnalysisArn: string | undefined;
@@ -2942,6 +3132,7 @@ export interface DeleteWhatIfAnalysisRequest {
2942
3132
  */
2943
3133
  export interface DeleteWhatIfForecastRequest {
2944
3134
  /**
3135
+ * @public
2945
3136
  * <p>The Amazon Resource Name (ARN) of the what-if forecast that you want to delete.</p>
2946
3137
  */
2947
3138
  WhatIfForecastArn: string | undefined;
@@ -2951,6 +3142,7 @@ export interface DeleteWhatIfForecastRequest {
2951
3142
  */
2952
3143
  export interface DeleteWhatIfForecastExportRequest {
2953
3144
  /**
3145
+ * @public
2954
3146
  * <p>The Amazon Resource Name (ARN) of the what-if forecast export that you want to delete.</p>
2955
3147
  */
2956
3148
  WhatIfForecastExportArn: string | undefined;
@@ -2960,6 +3152,7 @@ export interface DeleteWhatIfForecastExportRequest {
2960
3152
  */
2961
3153
  export interface DescribeAutoPredictorRequest {
2962
3154
  /**
3155
+ * @public
2963
3156
  * <p>The Amazon Resource Name (ARN) of the predictor.</p>
2964
3157
  */
2965
3158
  PredictorArn: string | undefined;
@@ -2970,10 +3163,12 @@ export interface DescribeAutoPredictorRequest {
2970
3163
  */
2971
3164
  export interface ExplainabilityInfo {
2972
3165
  /**
3166
+ * @public
2973
3167
  * <p>The Amazon Resource Name (ARN) of the Explainability.</p>
2974
3168
  */
2975
3169
  ExplainabilityArn?: string;
2976
3170
  /**
3171
+ * @public
2977
3172
  * <p>The status of the Explainability. States include: </p>
2978
3173
  * <ul>
2979
3174
  * <li>
@@ -3008,10 +3203,12 @@ export interface ExplainabilityInfo {
3008
3203
  */
3009
3204
  export interface MonitorInfo {
3010
3205
  /**
3206
+ * @public
3011
3207
  * <p>The Amazon Resource Name (ARN) of the monitor resource.</p>
3012
3208
  */
3013
3209
  MonitorArn?: string;
3014
3210
  /**
3211
+ * @public
3015
3212
  * <p>The status of the monitor. States include:</p>
3016
3213
  * <ul>
3017
3214
  * <li>
@@ -3062,10 +3259,12 @@ export type State = (typeof State)[keyof typeof State];
3062
3259
  */
3063
3260
  export interface ReferencePredictorSummary {
3064
3261
  /**
3262
+ * @public
3065
3263
  * <p>The ARN of the reference predictor.</p>
3066
3264
  */
3067
3265
  Arn?: string;
3068
3266
  /**
3267
+ * @public
3069
3268
  * <p>Whether the reference predictor is <code>Active</code> or <code>Deleted</code>.</p>
3070
3269
  */
3071
3270
  State?: State | string;
@@ -3075,24 +3274,29 @@ export interface ReferencePredictorSummary {
3075
3274
  */
3076
3275
  export interface DescribeAutoPredictorResponse {
3077
3276
  /**
3277
+ * @public
3078
3278
  * <p>The Amazon Resource Name (ARN) of the predictor</p>
3079
3279
  */
3080
3280
  PredictorArn?: string;
3081
3281
  /**
3282
+ * @public
3082
3283
  * <p>The name of the predictor.</p>
3083
3284
  */
3084
3285
  PredictorName?: string;
3085
3286
  /**
3287
+ * @public
3086
3288
  * <p>The number of time-steps that the model predicts. The forecast horizon is also called
3087
3289
  * the prediction length.</p>
3088
3290
  */
3089
3291
  ForecastHorizon?: number;
3090
3292
  /**
3293
+ * @public
3091
3294
  * <p>The forecast types used during predictor training. Default value is
3092
3295
  * ["0.1","0.5","0.9"].</p>
3093
3296
  */
3094
3297
  ForecastTypes?: string[];
3095
3298
  /**
3299
+ * @public
3096
3300
  * <p>The frequency of predictions in a forecast.</p>
3097
3301
  * <p>Valid intervals are Y (Year), M (Month), W (Week), D (Day), H (Hour), 30min (30
3098
3302
  * minutes), 15min (15 minutes), 10min (10 minutes), 5min (5 minutes), and 1min (1 minute).
@@ -3100,36 +3304,43 @@ export interface DescribeAutoPredictorResponse {
3100
3304
  */
3101
3305
  ForecastFrequency?: string;
3102
3306
  /**
3307
+ * @public
3103
3308
  * <p>An array of dimension (field) names that specify the attributes used to group your
3104
3309
  * time series.</p>
3105
3310
  */
3106
3311
  ForecastDimensions?: string[];
3107
3312
  /**
3313
+ * @public
3108
3314
  * <p>An array of the ARNs of the dataset import jobs used to import training data for the
3109
3315
  * predictor.</p>
3110
3316
  */
3111
3317
  DatasetImportJobArns?: string[];
3112
3318
  /**
3319
+ * @public
3113
3320
  * <p>The data configuration for your dataset group and any additional datasets.</p>
3114
3321
  */
3115
3322
  DataConfig?: DataConfig;
3116
3323
  /**
3324
+ * @public
3117
3325
  * <p>An Key Management Service (KMS) key and an Identity and Access Management (IAM) role that Amazon Forecast can assume to
3118
3326
  * access the key. You can specify this optional object in the
3119
3327
  * <a>CreateDataset</a> and <a>CreatePredictor</a> requests.</p>
3120
3328
  */
3121
3329
  EncryptionConfig?: EncryptionConfig;
3122
3330
  /**
3331
+ * @public
3123
3332
  * <p>The ARN and state of the reference predictor. This parameter is only valid for
3124
3333
  * retrained or upgraded predictors.</p>
3125
3334
  */
3126
3335
  ReferencePredictorSummary?: ReferencePredictorSummary;
3127
3336
  /**
3337
+ * @public
3128
3338
  * <p>The estimated time remaining in minutes for the predictor training job to
3129
3339
  * complete.</p>
3130
3340
  */
3131
3341
  EstimatedTimeRemainingInMinutes?: number;
3132
3342
  /**
3343
+ * @public
3133
3344
  * <p>The status of the predictor. States include: </p>
3134
3345
  * <ul>
3135
3346
  * <li>
@@ -3158,14 +3369,17 @@ export interface DescribeAutoPredictorResponse {
3158
3369
  */
3159
3370
  Status?: string;
3160
3371
  /**
3372
+ * @public
3161
3373
  * <p>In the event of an error, a message detailing the cause of the error.</p>
3162
3374
  */
3163
3375
  Message?: string;
3164
3376
  /**
3377
+ * @public
3165
3378
  * <p>The timestamp of the CreateAutoPredictor request.</p>
3166
3379
  */
3167
3380
  CreationTime?: Date;
3168
3381
  /**
3382
+ * @public
3169
3383
  * <p>The last time the resource was modified. The timestamp depends on the status of the
3170
3384
  * job:</p>
3171
3385
  * <ul>
@@ -3194,18 +3408,22 @@ export interface DescribeAutoPredictorResponse {
3194
3408
  */
3195
3409
  LastModificationTime?: Date;
3196
3410
  /**
3411
+ * @public
3197
3412
  * <p>The accuracy metric used to optimize the predictor.</p>
3198
3413
  */
3199
3414
  OptimizationMetric?: OptimizationMetric | string;
3200
3415
  /**
3416
+ * @public
3201
3417
  * <p>Provides the status and ARN of the Predictor Explainability.</p>
3202
3418
  */
3203
3419
  ExplainabilityInfo?: ExplainabilityInfo;
3204
3420
  /**
3421
+ * @public
3205
3422
  * <p>A object with the Amazon Resource Name (ARN) and status of the monitor resource.</p>
3206
3423
  */
3207
3424
  MonitorInfo?: MonitorInfo;
3208
3425
  /**
3426
+ * @public
3209
3427
  * <p>The time boundary Forecast uses when aggregating data.</p>
3210
3428
  */
3211
3429
  TimeAlignmentBoundary?: TimeAlignmentBoundary;
@@ -3215,6 +3433,7 @@ export interface DescribeAutoPredictorResponse {
3215
3433
  */
3216
3434
  export interface DescribeDatasetRequest {
3217
3435
  /**
3436
+ * @public
3218
3437
  * <p>The Amazon Resource Name (ARN) of the dataset.</p>
3219
3438
  */
3220
3439
  DatasetArn: string | undefined;
@@ -3224,22 +3443,27 @@ export interface DescribeDatasetRequest {
3224
3443
  */
3225
3444
  export interface DescribeDatasetResponse {
3226
3445
  /**
3446
+ * @public
3227
3447
  * <p>The Amazon Resource Name (ARN) of the dataset.</p>
3228
3448
  */
3229
3449
  DatasetArn?: string;
3230
3450
  /**
3451
+ * @public
3231
3452
  * <p>The name of the dataset.</p>
3232
3453
  */
3233
3454
  DatasetName?: string;
3234
3455
  /**
3456
+ * @public
3235
3457
  * <p>The domain associated with the dataset.</p>
3236
3458
  */
3237
3459
  Domain?: Domain | string;
3238
3460
  /**
3461
+ * @public
3239
3462
  * <p>The dataset type.</p>
3240
3463
  */
3241
3464
  DatasetType?: DatasetType | string;
3242
3465
  /**
3466
+ * @public
3243
3467
  * <p>The frequency of data collection.</p>
3244
3468
  * <p>Valid intervals are Y (Year), M (Month), W (Week), D (Day), H (Hour), 30min (30 minutes),
3245
3469
  * 15min (15 minutes), 10min (10 minutes), 5min (5 minutes), and 1min (1 minute). For example,
@@ -3247,16 +3471,19 @@ export interface DescribeDatasetResponse {
3247
3471
  */
3248
3472
  DataFrequency?: string;
3249
3473
  /**
3474
+ * @public
3250
3475
  * <p>An array of <code>SchemaAttribute</code> objects that specify the dataset fields. Each
3251
3476
  * <code>SchemaAttribute</code> specifies the name and data type of a field.</p>
3252
3477
  */
3253
3478
  Schema?: Schema;
3254
3479
  /**
3480
+ * @public
3255
3481
  * <p>The Key Management Service (KMS) key and the Identity and Access Management (IAM) role that Amazon Forecast can assume to access
3256
3482
  * the key.</p>
3257
3483
  */
3258
3484
  EncryptionConfig?: EncryptionConfig;
3259
3485
  /**
3486
+ * @public
3260
3487
  * <p>The status of the dataset. States include:</p>
3261
3488
  * <ul>
3262
3489
  * <li>
@@ -3294,10 +3521,12 @@ export interface DescribeDatasetResponse {
3294
3521
  */
3295
3522
  Status?: string;
3296
3523
  /**
3524
+ * @public
3297
3525
  * <p>When the dataset was created.</p>
3298
3526
  */
3299
3527
  CreationTime?: Date;
3300
3528
  /**
3529
+ * @public
3301
3530
  * <p>When you create a dataset, <code>LastModificationTime</code> is the same as
3302
3531
  * <code>CreationTime</code>. While data is being imported to the dataset,
3303
3532
  * <code>LastModificationTime</code> is the current time of the <code>DescribeDataset</code>
@@ -3312,6 +3541,7 @@ export interface DescribeDatasetResponse {
3312
3541
  */
3313
3542
  export interface DescribeDatasetGroupRequest {
3314
3543
  /**
3544
+ * @public
3315
3545
  * <p>The Amazon Resource Name (ARN) of the dataset group.</p>
3316
3546
  */
3317
3547
  DatasetGroupArn: string | undefined;
@@ -3321,23 +3551,28 @@ export interface DescribeDatasetGroupRequest {
3321
3551
  */
3322
3552
  export interface DescribeDatasetGroupResponse {
3323
3553
  /**
3554
+ * @public
3324
3555
  * <p>The name of the dataset group.</p>
3325
3556
  */
3326
3557
  DatasetGroupName?: string;
3327
3558
  /**
3559
+ * @public
3328
3560
  * <p>The ARN of the dataset group.</p>
3329
3561
  */
3330
3562
  DatasetGroupArn?: string;
3331
3563
  /**
3564
+ * @public
3332
3565
  * <p>An array of Amazon Resource Names (ARNs) of the datasets contained in the dataset
3333
3566
  * group.</p>
3334
3567
  */
3335
3568
  DatasetArns?: string[];
3336
3569
  /**
3570
+ * @public
3337
3571
  * <p>The domain associated with the dataset group.</p>
3338
3572
  */
3339
3573
  Domain?: Domain | string;
3340
3574
  /**
3575
+ * @public
3341
3576
  * <p>The status of the dataset group. States include:</p>
3342
3577
  * <ul>
3343
3578
  * <li>
@@ -3373,10 +3608,12 @@ export interface DescribeDatasetGroupResponse {
3373
3608
  */
3374
3609
  Status?: string;
3375
3610
  /**
3611
+ * @public
3376
3612
  * <p>When the dataset group was created.</p>
3377
3613
  */
3378
3614
  CreationTime?: Date;
3379
3615
  /**
3616
+ * @public
3380
3617
  * <p>When the dataset group was created or last updated from a call to the <a href="https://docs.aws.amazon.com/forecast/latest/dg/API_UpdateDatasetGroup.html">UpdateDatasetGroup</a> operation. While the dataset group is being updated,
3381
3618
  * <code>LastModificationTime</code> is the current time of the
3382
3619
  * <code>DescribeDatasetGroup</code> call.</p>
@@ -3388,6 +3625,7 @@ export interface DescribeDatasetGroupResponse {
3388
3625
  */
3389
3626
  export interface DescribeDatasetImportJobRequest {
3390
3627
  /**
3628
+ * @public
3391
3629
  * <p>The Amazon Resource Name (ARN) of the dataset import job.</p>
3392
3630
  */
3393
3631
  DatasetImportJobArn: string | undefined;
@@ -3399,57 +3637,69 @@ export interface DescribeDatasetImportJobRequest {
3399
3637
  */
3400
3638
  export interface Statistics {
3401
3639
  /**
3640
+ * @public
3402
3641
  * <p>The number of values in the field. If the response value is -1, refer to
3403
3642
  * <code>CountLong</code>.</p>
3404
3643
  */
3405
3644
  Count?: number;
3406
3645
  /**
3646
+ * @public
3407
3647
  * <p>The number of distinct values in the field. If the response value is -1, refer to
3408
3648
  * <code>CountDistinctLong</code>.</p>
3409
3649
  */
3410
3650
  CountDistinct?: number;
3411
3651
  /**
3652
+ * @public
3412
3653
  * <p>The number of null values in the field. If the response value is -1, refer to
3413
3654
  * <code>CountNullLong</code>.</p>
3414
3655
  */
3415
3656
  CountNull?: number;
3416
3657
  /**
3658
+ * @public
3417
3659
  * <p>The number of NAN (not a number) values in the field. If the response value is -1, refer
3418
3660
  * to <code>CountNanLong</code>.</p>
3419
3661
  */
3420
3662
  CountNan?: number;
3421
3663
  /**
3664
+ * @public
3422
3665
  * <p>For a numeric field, the minimum value in the field.</p>
3423
3666
  */
3424
3667
  Min?: string;
3425
3668
  /**
3669
+ * @public
3426
3670
  * <p>For a numeric field, the maximum value in the field.</p>
3427
3671
  */
3428
3672
  Max?: string;
3429
3673
  /**
3674
+ * @public
3430
3675
  * <p>For a numeric field, the average value in the field.</p>
3431
3676
  */
3432
3677
  Avg?: number;
3433
3678
  /**
3679
+ * @public
3434
3680
  * <p>For a numeric field, the standard deviation.</p>
3435
3681
  */
3436
3682
  Stddev?: number;
3437
3683
  /**
3684
+ * @public
3438
3685
  * <p>The number of values in the field. <code>CountLong</code> is used instead of
3439
3686
  * <code>Count</code> if the value is greater than 2,147,483,647.</p>
3440
3687
  */
3441
3688
  CountLong?: number;
3442
3689
  /**
3690
+ * @public
3443
3691
  * <p>The number of distinct values in the field. <code>CountDistinctLong</code> is used instead
3444
3692
  * of <code>CountDistinct</code> if the value is greater than 2,147,483,647.</p>
3445
3693
  */
3446
3694
  CountDistinctLong?: number;
3447
3695
  /**
3696
+ * @public
3448
3697
  * <p>The number of null values in the field. <code>CountNullLong</code> is used instead of
3449
3698
  * <code>CountNull</code> if the value is greater than 2,147,483,647.</p>
3450
3699
  */
3451
3700
  CountNullLong?: number;
3452
3701
  /**
3702
+ * @public
3453
3703
  * <p>The number of NAN (not a number) values in the field. <code>CountNanLong</code> is used
3454
3704
  * instead of <code>CountNan</code> if the value is greater than 2,147,483,647.</p>
3455
3705
  */
@@ -3460,19 +3710,23 @@ export interface Statistics {
3460
3710
  */
3461
3711
  export interface DescribeDatasetImportJobResponse {
3462
3712
  /**
3713
+ * @public
3463
3714
  * <p>The name of the dataset import job.</p>
3464
3715
  */
3465
3716
  DatasetImportJobName?: string;
3466
3717
  /**
3718
+ * @public
3467
3719
  * <p>The ARN of the dataset import job.</p>
3468
3720
  */
3469
3721
  DatasetImportJobArn?: string;
3470
3722
  /**
3723
+ * @public
3471
3724
  * <p>The Amazon Resource Name (ARN) of the dataset that the training data was imported
3472
3725
  * to.</p>
3473
3726
  */
3474
3727
  DatasetArn?: string;
3475
3728
  /**
3729
+ * @public
3476
3730
  * <p>The format of timestamps in the dataset. The format that you specify depends on the
3477
3731
  * <code>DataFrequency</code> specified when the dataset was created. The following formats are
3478
3732
  * supported</p>
@@ -3490,38 +3744,46 @@ export interface DescribeDatasetImportJobResponse {
3490
3744
  */
3491
3745
  TimestampFormat?: string;
3492
3746
  /**
3747
+ * @public
3493
3748
  * <p>The single time zone applied to every item in the dataset</p>
3494
3749
  */
3495
3750
  TimeZone?: string;
3496
3751
  /**
3752
+ * @public
3497
3753
  * <p>Whether <code>TimeZone</code> is automatically derived from the geolocation
3498
3754
  * attribute.</p>
3499
3755
  */
3500
3756
  UseGeolocationForTimeZone?: boolean;
3501
3757
  /**
3758
+ * @public
3502
3759
  * <p>The format of the geolocation attribute. Valid Values:<code>"LAT_LONG"</code> and
3503
3760
  * <code>"CC_POSTALCODE"</code>.</p>
3504
3761
  */
3505
3762
  GeolocationFormat?: string;
3506
3763
  /**
3764
+ * @public
3507
3765
  * <p>The location of the training data to import and an Identity and Access Management (IAM) role that Amazon Forecast
3508
3766
  * can assume to access the data.</p>
3509
3767
  * <p>If encryption is used, <code>DataSource</code> includes an Key Management Service (KMS) key.</p>
3510
3768
  */
3511
3769
  DataSource?: DataSource;
3512
3770
  /**
3771
+ * @public
3513
3772
  * <p>The estimated time remaining in minutes for the dataset import job to complete.</p>
3514
3773
  */
3515
3774
  EstimatedTimeRemainingInMinutes?: number;
3516
3775
  /**
3776
+ * @public
3517
3777
  * <p>Statistical information about each field in the input data.</p>
3518
3778
  */
3519
3779
  FieldStatistics?: Record<string, Statistics>;
3520
3780
  /**
3781
+ * @public
3521
3782
  * <p>The size of the dataset in gigabytes (GB) after the import job has finished.</p>
3522
3783
  */
3523
3784
  DataSize?: number;
3524
3785
  /**
3786
+ * @public
3525
3787
  * <p>The status of the dataset import job. States include:</p>
3526
3788
  * <ul>
3527
3789
  * <li>
@@ -3550,14 +3812,17 @@ export interface DescribeDatasetImportJobResponse {
3550
3812
  */
3551
3813
  Status?: string;
3552
3814
  /**
3815
+ * @public
3553
3816
  * <p>If an error occurred, an informational message about the error.</p>
3554
3817
  */
3555
3818
  Message?: string;
3556
3819
  /**
3820
+ * @public
3557
3821
  * <p>When the dataset import job was created.</p>
3558
3822
  */
3559
3823
  CreationTime?: Date;
3560
3824
  /**
3825
+ * @public
3561
3826
  * <p>The last time the resource was modified. The timestamp depends on the status of the
3562
3827
  * job:</p>
3563
3828
  * <ul>
@@ -3586,10 +3851,12 @@ export interface DescribeDatasetImportJobResponse {
3586
3851
  */
3587
3852
  LastModificationTime?: Date;
3588
3853
  /**
3854
+ * @public
3589
3855
  * <p>The format of the imported data, CSV or PARQUET.</p>
3590
3856
  */
3591
3857
  Format?: string;
3592
3858
  /**
3859
+ * @public
3593
3860
  * <p>The import mode of the dataset import job, FULL or INCREMENTAL.</p>
3594
3861
  */
3595
3862
  ImportMode?: ImportMode | string;
@@ -3599,6 +3866,7 @@ export interface DescribeDatasetImportJobResponse {
3599
3866
  */
3600
3867
  export interface DescribeExplainabilityRequest {
3601
3868
  /**
3869
+ * @public
3602
3870
  * <p>The Amazon Resource Name (ARN) of the Explaianability to describe.</p>
3603
3871
  */
3604
3872
  ExplainabilityArn: string | undefined;
@@ -3608,56 +3876,68 @@ export interface DescribeExplainabilityRequest {
3608
3876
  */
3609
3877
  export interface DescribeExplainabilityResponse {
3610
3878
  /**
3879
+ * @public
3611
3880
  * <p>The Amazon Resource Name (ARN) of the Explainability.</p>
3612
3881
  */
3613
3882
  ExplainabilityArn?: string;
3614
3883
  /**
3884
+ * @public
3615
3885
  * <p>The name of the Explainability.</p>
3616
3886
  */
3617
3887
  ExplainabilityName?: string;
3618
3888
  /**
3889
+ * @public
3619
3890
  * <p>The Amazon Resource Name (ARN) of the Predictor or Forecast used to create the
3620
3891
  * Explainability resource.</p>
3621
3892
  */
3622
3893
  ResourceArn?: string;
3623
3894
  /**
3895
+ * @public
3624
3896
  * <p>The configuration settings that define the granularity of time series and time points
3625
3897
  * for the Explainability.</p>
3626
3898
  */
3627
3899
  ExplainabilityConfig?: ExplainabilityConfig;
3628
3900
  /**
3901
+ * @public
3629
3902
  * <p>Whether the visualization was enabled for the Explainability resource.</p>
3630
3903
  */
3631
3904
  EnableVisualization?: boolean;
3632
3905
  /**
3906
+ * @public
3633
3907
  * <p>The source of your data, an Identity and Access Management (IAM) role that allows Amazon Forecast to
3634
3908
  * access the data and, optionally, an Key Management Service (KMS) key.</p>
3635
3909
  */
3636
3910
  DataSource?: DataSource;
3637
3911
  /**
3912
+ * @public
3638
3913
  * <p>Defines the fields of a dataset.</p>
3639
3914
  */
3640
3915
  Schema?: Schema;
3641
3916
  /**
3917
+ * @public
3642
3918
  * <p>If <code>TimePointGranularity</code> is set to <code>SPECIFIC</code>, the first time
3643
3919
  * point in the Explainability.</p>
3644
3920
  */
3645
3921
  StartDateTime?: string;
3646
3922
  /**
3923
+ * @public
3647
3924
  * <p>If <code>TimePointGranularity</code> is set to <code>SPECIFIC</code>, the last time
3648
3925
  * point in the Explainability.</p>
3649
3926
  */
3650
3927
  EndDateTime?: string;
3651
3928
  /**
3929
+ * @public
3652
3930
  * <p>The estimated time remaining in minutes for the <a>CreateExplainability</a>
3653
3931
  * job to complete.</p>
3654
3932
  */
3655
3933
  EstimatedTimeRemainingInMinutes?: number;
3656
3934
  /**
3935
+ * @public
3657
3936
  * <p>If an error occurred, a message about the error.</p>
3658
3937
  */
3659
3938
  Message?: string;
3660
3939
  /**
3940
+ * @public
3661
3941
  * <p>The status of the Explainability resource. States include: </p>
3662
3942
  * <ul>
3663
3943
  * <li>
@@ -3686,10 +3966,12 @@ export interface DescribeExplainabilityResponse {
3686
3966
  */
3687
3967
  Status?: string;
3688
3968
  /**
3969
+ * @public
3689
3970
  * <p>When the Explainability resource was created.</p>
3690
3971
  */
3691
3972
  CreationTime?: Date;
3692
3973
  /**
3974
+ * @public
3693
3975
  * <p>The last time the resource was modified. The timestamp depends on the status of the
3694
3976
  * job:</p>
3695
3977
  * <ul>
@@ -3723,6 +4005,7 @@ export interface DescribeExplainabilityResponse {
3723
4005
  */
3724
4006
  export interface DescribeExplainabilityExportRequest {
3725
4007
  /**
4008
+ * @public
3726
4009
  * <p>The Amazon Resource Name (ARN) of the Explainability export.</p>
3727
4010
  */
3728
4011
  ExplainabilityExportArn: string | undefined;
@@ -3732,27 +4015,33 @@ export interface DescribeExplainabilityExportRequest {
3732
4015
  */
3733
4016
  export interface DescribeExplainabilityExportResponse {
3734
4017
  /**
4018
+ * @public
3735
4019
  * <p>The Amazon Resource Name (ARN) of the Explainability export.</p>
3736
4020
  */
3737
4021
  ExplainabilityExportArn?: string;
3738
4022
  /**
4023
+ * @public
3739
4024
  * <p>The name of the Explainability export.</p>
3740
4025
  */
3741
4026
  ExplainabilityExportName?: string;
3742
4027
  /**
4028
+ * @public
3743
4029
  * <p>The Amazon Resource Name (ARN) of the Explainability export.</p>
3744
4030
  */
3745
4031
  ExplainabilityArn?: string;
3746
4032
  /**
4033
+ * @public
3747
4034
  * <p>The destination for an export job. Provide an S3 path, an Identity and Access Management (IAM) role that allows Amazon Forecast
3748
4035
  * to access the location, and an Key Management Service (KMS) key (optional). </p>
3749
4036
  */
3750
4037
  Destination?: DataDestination;
3751
4038
  /**
4039
+ * @public
3752
4040
  * <p>Information about any errors that occurred during the export.</p>
3753
4041
  */
3754
4042
  Message?: string;
3755
4043
  /**
4044
+ * @public
3756
4045
  * <p>The status of the Explainability export. States include: </p>
3757
4046
  * <ul>
3758
4047
  * <li>
@@ -3781,10 +4070,12 @@ export interface DescribeExplainabilityExportResponse {
3781
4070
  */
3782
4071
  Status?: string;
3783
4072
  /**
4073
+ * @public
3784
4074
  * <p>When the Explainability export was created.</p>
3785
4075
  */
3786
4076
  CreationTime?: Date;
3787
4077
  /**
4078
+ * @public
3788
4079
  * <p>The last time the resource was modified. The timestamp depends on the status of the
3789
4080
  * job:</p>
3790
4081
  * <ul>
@@ -3813,6 +4104,7 @@ export interface DescribeExplainabilityExportResponse {
3813
4104
  */
3814
4105
  LastModificationTime?: Date;
3815
4106
  /**
4107
+ * @public
3816
4108
  * <p>The format of the exported data, CSV or PARQUET.</p>
3817
4109
  */
3818
4110
  Format?: string;
@@ -3822,6 +4114,7 @@ export interface DescribeExplainabilityExportResponse {
3822
4114
  */
3823
4115
  export interface DescribeForecastRequest {
3824
4116
  /**
4117
+ * @public
3825
4118
  * <p>The Amazon Resource Name (ARN) of the forecast.</p>
3826
4119
  */
3827
4120
  ForecastArn: string | undefined;
@@ -3831,30 +4124,37 @@ export interface DescribeForecastRequest {
3831
4124
  */
3832
4125
  export interface DescribeForecastResponse {
3833
4126
  /**
4127
+ * @public
3834
4128
  * <p>The forecast ARN as specified in the request.</p>
3835
4129
  */
3836
4130
  ForecastArn?: string;
3837
4131
  /**
4132
+ * @public
3838
4133
  * <p>The name of the forecast.</p>
3839
4134
  */
3840
4135
  ForecastName?: string;
3841
4136
  /**
4137
+ * @public
3842
4138
  * <p>The quantiles at which probabilistic forecasts were generated.</p>
3843
4139
  */
3844
4140
  ForecastTypes?: string[];
3845
4141
  /**
4142
+ * @public
3846
4143
  * <p>The ARN of the predictor used to generate the forecast.</p>
3847
4144
  */
3848
4145
  PredictorArn?: string;
3849
4146
  /**
4147
+ * @public
3850
4148
  * <p>The ARN of the dataset group that provided the data used to train the predictor.</p>
3851
4149
  */
3852
4150
  DatasetGroupArn?: string;
3853
4151
  /**
4152
+ * @public
3854
4153
  * <p>The estimated time remaining in minutes for the forecast job to complete.</p>
3855
4154
  */
3856
4155
  EstimatedTimeRemainingInMinutes?: number;
3857
4156
  /**
4157
+ * @public
3858
4158
  * <p>The status of the forecast. States include:</p>
3859
4159
  * <ul>
3860
4160
  * <li>
@@ -3887,14 +4187,17 @@ export interface DescribeForecastResponse {
3887
4187
  */
3888
4188
  Status?: string;
3889
4189
  /**
4190
+ * @public
3890
4191
  * <p>If an error occurred, an informational message about the error.</p>
3891
4192
  */
3892
4193
  Message?: string;
3893
4194
  /**
4195
+ * @public
3894
4196
  * <p>When the forecast creation task was created.</p>
3895
4197
  */
3896
4198
  CreationTime?: Date;
3897
4199
  /**
4200
+ * @public
3898
4201
  * <p>The last time the resource was modified. The timestamp depends on the status of the job:</p>
3899
4202
  * <ul>
3900
4203
  * <li>
@@ -3922,6 +4225,7 @@ export interface DescribeForecastResponse {
3922
4225
  */
3923
4226
  LastModificationTime?: Date;
3924
4227
  /**
4228
+ * @public
3925
4229
  * <p>The time series to include in the forecast.</p>
3926
4230
  */
3927
4231
  TimeSeriesSelector?: TimeSeriesSelector;
@@ -3931,6 +4235,7 @@ export interface DescribeForecastResponse {
3931
4235
  */
3932
4236
  export interface DescribeForecastExportJobRequest {
3933
4237
  /**
4238
+ * @public
3934
4239
  * <p>The Amazon Resource Name (ARN) of the forecast export job.</p>
3935
4240
  */
3936
4241
  ForecastExportJobArn: string | undefined;
@@ -3940,26 +4245,32 @@ export interface DescribeForecastExportJobRequest {
3940
4245
  */
3941
4246
  export interface DescribeForecastExportJobResponse {
3942
4247
  /**
4248
+ * @public
3943
4249
  * <p>The ARN of the forecast export job.</p>
3944
4250
  */
3945
4251
  ForecastExportJobArn?: string;
3946
4252
  /**
4253
+ * @public
3947
4254
  * <p>The name of the forecast export job.</p>
3948
4255
  */
3949
4256
  ForecastExportJobName?: string;
3950
4257
  /**
4258
+ * @public
3951
4259
  * <p>The Amazon Resource Name (ARN) of the exported forecast.</p>
3952
4260
  */
3953
4261
  ForecastArn?: string;
3954
4262
  /**
4263
+ * @public
3955
4264
  * <p>The path to the Amazon Simple Storage Service (Amazon S3) bucket where the forecast is exported.</p>
3956
4265
  */
3957
4266
  Destination?: DataDestination;
3958
4267
  /**
4268
+ * @public
3959
4269
  * <p>If an error occurred, an informational message about the error.</p>
3960
4270
  */
3961
4271
  Message?: string;
3962
4272
  /**
4273
+ * @public
3963
4274
  * <p>The status of the forecast export job. States include:</p>
3964
4275
  * <ul>
3965
4276
  * <li>
@@ -3992,10 +4303,12 @@ export interface DescribeForecastExportJobResponse {
3992
4303
  */
3993
4304
  Status?: string;
3994
4305
  /**
4306
+ * @public
3995
4307
  * <p>When the forecast export job was created.</p>
3996
4308
  */
3997
4309
  CreationTime?: Date;
3998
4310
  /**
4311
+ * @public
3999
4312
  * <p>The last time the resource was modified. The timestamp depends on the status of the job:</p>
4000
4313
  * <ul>
4001
4314
  * <li>
@@ -4023,6 +4336,7 @@ export interface DescribeForecastExportJobResponse {
4023
4336
  */
4024
4337
  LastModificationTime?: Date;
4025
4338
  /**
4339
+ * @public
4026
4340
  * <p>The format of the exported data, CSV or PARQUET.</p>
4027
4341
  */
4028
4342
  Format?: string;
@@ -4032,6 +4346,7 @@ export interface DescribeForecastExportJobResponse {
4032
4346
  */
4033
4347
  export interface DescribeMonitorRequest {
4034
4348
  /**
4349
+ * @public
4035
4350
  * <p>The Amazon Resource Name (ARN) of the monitor resource to describe.</p>
4036
4351
  */
4037
4352
  MonitorArn: string | undefined;
@@ -4042,10 +4357,12 @@ export interface DescribeMonitorRequest {
4042
4357
  */
4043
4358
  export interface BaselineMetric {
4044
4359
  /**
4360
+ * @public
4045
4361
  * <p>The name of the metric.</p>
4046
4362
  */
4047
4363
  Name?: string;
4048
4364
  /**
4365
+ * @public
4049
4366
  * <p>The value for the metric.</p>
4050
4367
  */
4051
4368
  Value?: number;
@@ -4056,6 +4373,7 @@ export interface BaselineMetric {
4056
4373
  */
4057
4374
  export interface PredictorBaseline {
4058
4375
  /**
4376
+ * @public
4059
4377
  * <p>The initial <a href="https://docs.aws.amazon.com/forecast/latest/dg/metrics.html">accuracy metrics</a> for the predictor. Use these metrics as a baseline for comparison purposes as you
4060
4378
  * use your predictor and the metrics change.</p>
4061
4379
  */
@@ -4067,6 +4385,7 @@ export interface PredictorBaseline {
4067
4385
  */
4068
4386
  export interface Baseline {
4069
4387
  /**
4388
+ * @public
4070
4389
  * <p>The initial <a href="https://docs.aws.amazon.com/forecast/latest/dg/metrics.html">accuracy metrics</a> for the predictor you are monitoring. Use these metrics as a baseline for comparison purposes as you
4071
4390
  * use your predictor and the metrics change.</p>
4072
4391
  */
@@ -4077,46 +4396,57 @@ export interface Baseline {
4077
4396
  */
4078
4397
  export interface DescribeMonitorResponse {
4079
4398
  /**
4399
+ * @public
4080
4400
  * <p>The name of the monitor.</p>
4081
4401
  */
4082
4402
  MonitorName?: string;
4083
4403
  /**
4404
+ * @public
4084
4405
  * <p>The Amazon Resource Name (ARN) of the monitor resource described.</p>
4085
4406
  */
4086
4407
  MonitorArn?: string;
4087
4408
  /**
4409
+ * @public
4088
4410
  * <p>The Amazon Resource Name (ARN) of the auto predictor being monitored.</p>
4089
4411
  */
4090
4412
  ResourceArn?: string;
4091
4413
  /**
4414
+ * @public
4092
4415
  * <p>The status of the monitor resource.</p>
4093
4416
  */
4094
4417
  Status?: string;
4095
4418
  /**
4419
+ * @public
4096
4420
  * <p>The timestamp of the latest evaluation completed by the monitor.</p>
4097
4421
  */
4098
4422
  LastEvaluationTime?: Date;
4099
4423
  /**
4424
+ * @public
4100
4425
  * <p>The state of the monitor's latest evaluation.</p>
4101
4426
  */
4102
4427
  LastEvaluationState?: string;
4103
4428
  /**
4429
+ * @public
4104
4430
  * <p>Metrics you can use as a baseline for comparison purposes. Use these values you interpret monitoring results for an auto predictor.</p>
4105
4431
  */
4106
4432
  Baseline?: Baseline;
4107
4433
  /**
4434
+ * @public
4108
4435
  * <p>An error message, if any, for the monitor.</p>
4109
4436
  */
4110
4437
  Message?: string;
4111
4438
  /**
4439
+ * @public
4112
4440
  * <p>The timestamp for when the monitor resource was created.</p>
4113
4441
  */
4114
4442
  CreationTime?: Date;
4115
4443
  /**
4444
+ * @public
4116
4445
  * <p>The timestamp of the latest modification to the monitor.</p>
4117
4446
  */
4118
4447
  LastModificationTime?: Date;
4119
4448
  /**
4449
+ * @public
4120
4450
  * <p>The estimated number of minutes remaining before the monitor resource finishes its current evaluation.</p>
4121
4451
  */
4122
4452
  EstimatedEvaluationTimeRemainingInMinutes?: number;
@@ -4126,6 +4456,7 @@ export interface DescribeMonitorResponse {
4126
4456
  */
4127
4457
  export interface DescribePredictorRequest {
4128
4458
  /**
4459
+ * @public
4129
4460
  * <p>The Amazon Resource Name (ARN) of the predictor that you want information about.</p>
4130
4461
  */
4131
4462
  PredictorArn: string | undefined;
@@ -4137,14 +4468,17 @@ export interface DescribePredictorRequest {
4137
4468
  */
4138
4469
  export interface TestWindowSummary {
4139
4470
  /**
4471
+ * @public
4140
4472
  * <p>The time at which the test began.</p>
4141
4473
  */
4142
4474
  TestWindowStart?: Date;
4143
4475
  /**
4476
+ * @public
4144
4477
  * <p>The time at which the test ended.</p>
4145
4478
  */
4146
4479
  TestWindowEnd?: Date;
4147
4480
  /**
4481
+ * @public
4148
4482
  * <p>The status of the test. Possible status values are:</p>
4149
4483
  * <ul>
4150
4484
  * <li>
@@ -4166,6 +4500,7 @@ export interface TestWindowSummary {
4166
4500
  */
4167
4501
  Status?: string;
4168
4502
  /**
4503
+ * @public
4169
4504
  * <p>If the test failed, the reason why it failed.</p>
4170
4505
  */
4171
4506
  Message?: string;
@@ -4176,10 +4511,12 @@ export interface TestWindowSummary {
4176
4511
  */
4177
4512
  export interface PredictorExecution {
4178
4513
  /**
4514
+ * @public
4179
4515
  * <p>The ARN of the algorithm used to test the predictor.</p>
4180
4516
  */
4181
4517
  AlgorithmArn?: string;
4182
4518
  /**
4519
+ * @public
4183
4520
  * <p>An array of test windows used to evaluate the algorithm. The
4184
4521
  * <code>NumberOfBacktestWindows</code> from the
4185
4522
  * object determines the number of windows in the array.</p>
@@ -4194,6 +4531,7 @@ export interface PredictorExecution {
4194
4531
  */
4195
4532
  export interface PredictorExecutionDetails {
4196
4533
  /**
4534
+ * @public
4197
4535
  * <p>An array of the backtests performed to evaluate the accuracy of the predictor against a
4198
4536
  * particular algorithm. The <code>NumberOfBacktestWindows</code> from the object determines the number of windows in the
4199
4537
  * array.</p>
@@ -4205,37 +4543,45 @@ export interface PredictorExecutionDetails {
4205
4543
  */
4206
4544
  export interface DescribePredictorResponse {
4207
4545
  /**
4546
+ * @public
4208
4547
  * <p>The ARN of the predictor.</p>
4209
4548
  */
4210
4549
  PredictorArn?: string;
4211
4550
  /**
4551
+ * @public
4212
4552
  * <p>The name of the predictor.</p>
4213
4553
  */
4214
4554
  PredictorName?: string;
4215
4555
  /**
4556
+ * @public
4216
4557
  * <p>The Amazon Resource Name (ARN) of the algorithm used for model training.</p>
4217
4558
  */
4218
4559
  AlgorithmArn?: string;
4219
4560
  /**
4561
+ * @public
4220
4562
  * <p>When <code>PerformAutoML</code> is specified, the ARN of the chosen algorithm.</p>
4221
4563
  */
4222
4564
  AutoMLAlgorithmArns?: string[];
4223
4565
  /**
4566
+ * @public
4224
4567
  * <p>The number of time-steps of the forecast. The forecast horizon is also called the
4225
4568
  * prediction length.</p>
4226
4569
  */
4227
4570
  ForecastHorizon?: number;
4228
4571
  /**
4572
+ * @public
4229
4573
  * <p>The forecast types used during predictor training. Default value is
4230
4574
  * <code>["0.1","0.5","0.9"]</code>
4231
4575
  * </p>
4232
4576
  */
4233
4577
  ForecastTypes?: string[];
4234
4578
  /**
4579
+ * @public
4235
4580
  * <p>Whether the predictor is set to perform AutoML.</p>
4236
4581
  */
4237
4582
  PerformAutoML?: boolean;
4238
4583
  /**
4584
+ * @public
4239
4585
  * <note>
4240
4586
  * <p> The <code>LatencyOptimized</code> AutoML override strategy is only available in private beta.
4241
4587
  * Contact Amazon Web Services Support or your account manager to learn more about access privileges.
@@ -4247,57 +4593,69 @@ export interface DescribePredictorResponse {
4247
4593
  */
4248
4594
  AutoMLOverrideStrategy?: AutoMLOverrideStrategy | string;
4249
4595
  /**
4596
+ * @public
4250
4597
  * <p>Whether the predictor is set to perform hyperparameter optimization (HPO).</p>
4251
4598
  */
4252
4599
  PerformHPO?: boolean;
4253
4600
  /**
4601
+ * @public
4254
4602
  * <p>The default training parameters or overrides selected during model training. When running
4255
4603
  * AutoML or choosing HPO with CNN-QR or DeepAR+, the optimized values for the chosen
4256
4604
  * hyperparameters are returned. For more information, see <a>aws-forecast-choosing-recipes</a>.</p>
4257
4605
  */
4258
4606
  TrainingParameters?: Record<string, string>;
4259
4607
  /**
4608
+ * @public
4260
4609
  * <p>Used to override the default evaluation parameters of the specified algorithm. Amazon Forecast
4261
4610
  * evaluates a predictor by splitting a dataset into training data and testing data. The
4262
4611
  * evaluation parameters define how to perform the split and the number of iterations.</p>
4263
4612
  */
4264
4613
  EvaluationParameters?: EvaluationParameters;
4265
4614
  /**
4615
+ * @public
4266
4616
  * <p>The hyperparameter override values for the algorithm.</p>
4267
4617
  */
4268
4618
  HPOConfig?: HyperParameterTuningJobConfig;
4269
4619
  /**
4620
+ * @public
4270
4621
  * <p>Describes the dataset group that contains the data to use to train the predictor.</p>
4271
4622
  */
4272
4623
  InputDataConfig?: InputDataConfig;
4273
4624
  /**
4625
+ * @public
4274
4626
  * <p>The featurization configuration.</p>
4275
4627
  */
4276
4628
  FeaturizationConfig?: FeaturizationConfig;
4277
4629
  /**
4630
+ * @public
4278
4631
  * <p>An Key Management Service (KMS) key and the Identity and Access Management (IAM) role that Amazon Forecast can assume to access
4279
4632
  * the key.</p>
4280
4633
  */
4281
4634
  EncryptionConfig?: EncryptionConfig;
4282
4635
  /**
4636
+ * @public
4283
4637
  * <p>Details on the the status and results of the backtests performed to evaluate the accuracy
4284
4638
  * of the predictor. You specify the number of backtests to perform when you call the operation.</p>
4285
4639
  */
4286
4640
  PredictorExecutionDetails?: PredictorExecutionDetails;
4287
4641
  /**
4642
+ * @public
4288
4643
  * <p>The estimated time remaining in minutes for the predictor training job to complete.</p>
4289
4644
  */
4290
4645
  EstimatedTimeRemainingInMinutes?: number;
4291
4646
  /**
4647
+ * @public
4292
4648
  * <p>Whether the predictor was created with <a>CreateAutoPredictor</a>.</p>
4293
4649
  */
4294
4650
  IsAutoPredictor?: boolean;
4295
4651
  /**
4652
+ * @public
4296
4653
  * <p>An array of the ARNs of the dataset import jobs used to import training data for the
4297
4654
  * predictor.</p>
4298
4655
  */
4299
4656
  DatasetImportJobArns?: string[];
4300
4657
  /**
4658
+ * @public
4301
4659
  * <p>The status of the predictor. States include:</p>
4302
4660
  * <ul>
4303
4661
  * <li>
@@ -4330,14 +4688,17 @@ export interface DescribePredictorResponse {
4330
4688
  */
4331
4689
  Status?: string;
4332
4690
  /**
4691
+ * @public
4333
4692
  * <p>If an error occurred, an informational message about the error.</p>
4334
4693
  */
4335
4694
  Message?: string;
4336
4695
  /**
4696
+ * @public
4337
4697
  * <p>When the model training task was created.</p>
4338
4698
  */
4339
4699
  CreationTime?: Date;
4340
4700
  /**
4701
+ * @public
4341
4702
  * <p>The last time the resource was modified. The timestamp depends on the status of the
4342
4703
  * job:</p>
4343
4704
  * <ul>
@@ -4366,6 +4727,7 @@ export interface DescribePredictorResponse {
4366
4727
  */
4367
4728
  LastModificationTime?: Date;
4368
4729
  /**
4730
+ * @public
4369
4731
  * <p>The accuracy metric used to optimize the predictor.</p>
4370
4732
  */
4371
4733
  OptimizationMetric?: OptimizationMetric | string;
@@ -4375,6 +4737,7 @@ export interface DescribePredictorResponse {
4375
4737
  */
4376
4738
  export interface DescribePredictorBacktestExportJobRequest {
4377
4739
  /**
4740
+ * @public
4378
4741
  * <p>The Amazon Resource Name (ARN) of the predictor backtest export job.</p>
4379
4742
  */
4380
4743
  PredictorBacktestExportJobArn: string | undefined;
@@ -4384,27 +4747,33 @@ export interface DescribePredictorBacktestExportJobRequest {
4384
4747
  */
4385
4748
  export interface DescribePredictorBacktestExportJobResponse {
4386
4749
  /**
4750
+ * @public
4387
4751
  * <p>The Amazon Resource Name (ARN) of the predictor backtest export job.</p>
4388
4752
  */
4389
4753
  PredictorBacktestExportJobArn?: string;
4390
4754
  /**
4755
+ * @public
4391
4756
  * <p>The name of the predictor backtest export job.</p>
4392
4757
  */
4393
4758
  PredictorBacktestExportJobName?: string;
4394
4759
  /**
4760
+ * @public
4395
4761
  * <p>The Amazon Resource Name (ARN) of the predictor.</p>
4396
4762
  */
4397
4763
  PredictorArn?: string;
4398
4764
  /**
4765
+ * @public
4399
4766
  * <p>The destination for an export job. Provide an S3 path, an Identity and Access Management (IAM) role that allows Amazon Forecast
4400
4767
  * to access the location, and an Key Management Service (KMS) key (optional). </p>
4401
4768
  */
4402
4769
  Destination?: DataDestination;
4403
4770
  /**
4771
+ * @public
4404
4772
  * <p>Information about any errors that may have occurred during the backtest export.</p>
4405
4773
  */
4406
4774
  Message?: string;
4407
4775
  /**
4776
+ * @public
4408
4777
  * <p>The status of the predictor backtest export job. States include: </p>
4409
4778
  * <ul>
4410
4779
  * <li>
@@ -4433,10 +4802,12 @@ export interface DescribePredictorBacktestExportJobResponse {
4433
4802
  */
4434
4803
  Status?: string;
4435
4804
  /**
4805
+ * @public
4436
4806
  * <p>When the predictor backtest export job was created.</p>
4437
4807
  */
4438
4808
  CreationTime?: Date;
4439
4809
  /**
4810
+ * @public
4440
4811
  * <p>The last time the resource was modified. The timestamp depends on the status of the
4441
4812
  * job:</p>
4442
4813
  * <ul>
@@ -4465,6 +4836,7 @@ export interface DescribePredictorBacktestExportJobResponse {
4465
4836
  */
4466
4837
  LastModificationTime?: Date;
4467
4838
  /**
4839
+ * @public
4468
4840
  * <p>The format of the exported data, CSV or PARQUET.</p>
4469
4841
  */
4470
4842
  Format?: string;
@@ -4474,6 +4846,7 @@ export interface DescribePredictorBacktestExportJobResponse {
4474
4846
  */
4475
4847
  export interface DescribeWhatIfAnalysisRequest {
4476
4848
  /**
4849
+ * @public
4477
4850
  * <p>The Amazon Resource Name (ARN) of the what-if analysis that you are interested in.</p>
4478
4851
  */
4479
4852
  WhatIfAnalysisArn: string | undefined;
@@ -4483,22 +4856,27 @@ export interface DescribeWhatIfAnalysisRequest {
4483
4856
  */
4484
4857
  export interface DescribeWhatIfAnalysisResponse {
4485
4858
  /**
4859
+ * @public
4486
4860
  * <p>The name of the what-if analysis.</p>
4487
4861
  */
4488
4862
  WhatIfAnalysisName?: string;
4489
4863
  /**
4864
+ * @public
4490
4865
  * <p>The Amazon Resource Name (ARN) of the what-if analysis.</p>
4491
4866
  */
4492
4867
  WhatIfAnalysisArn?: string;
4493
4868
  /**
4869
+ * @public
4494
4870
  * <p>The Amazon Resource Name (ARN) of the what-if forecast.</p>
4495
4871
  */
4496
4872
  ForecastArn?: string;
4497
4873
  /**
4874
+ * @public
4498
4875
  * <p>The approximate time remaining to complete the what-if analysis, in minutes.</p>
4499
4876
  */
4500
4877
  EstimatedTimeRemainingInMinutes?: number;
4501
4878
  /**
4879
+ * @public
4502
4880
  * <p>The status of the what-if analysis. States include:</p>
4503
4881
  * <ul>
4504
4882
  * <li>
@@ -4531,14 +4909,17 @@ export interface DescribeWhatIfAnalysisResponse {
4531
4909
  */
4532
4910
  Status?: string;
4533
4911
  /**
4912
+ * @public
4534
4913
  * <p>If an error occurred, an informational message about the error.</p>
4535
4914
  */
4536
4915
  Message?: string;
4537
4916
  /**
4917
+ * @public
4538
4918
  * <p>When the what-if analysis was created.</p>
4539
4919
  */
4540
4920
  CreationTime?: Date;
4541
4921
  /**
4922
+ * @public
4542
4923
  * <p>The last time the resource was modified. The timestamp depends on the status of the job:</p>
4543
4924
  * <ul>
4544
4925
  * <li>
@@ -4566,6 +4947,7 @@ export interface DescribeWhatIfAnalysisResponse {
4566
4947
  */
4567
4948
  LastModificationTime?: Date;
4568
4949
  /**
4950
+ * @public
4569
4951
  * <p>Defines the set of time series that are used to create the forecasts in a <code>TimeSeriesIdentifiers</code> object.</p>
4570
4952
  * <p>The <code>TimeSeriesIdentifiers</code> object needs the following information:</p>
4571
4953
  * <ul>
@@ -4593,6 +4975,7 @@ export interface DescribeWhatIfAnalysisResponse {
4593
4975
  */
4594
4976
  export interface DescribeWhatIfForecastRequest {
4595
4977
  /**
4978
+ * @public
4596
4979
  * <p>The Amazon Resource Name (ARN) of the what-if forecast that you are interested in.</p>
4597
4980
  */
4598
4981
  WhatIfForecastArn: string | undefined;
@@ -4602,22 +4985,27 @@ export interface DescribeWhatIfForecastRequest {
4602
4985
  */
4603
4986
  export interface DescribeWhatIfForecastResponse {
4604
4987
  /**
4988
+ * @public
4605
4989
  * <p>The name of the what-if forecast.</p>
4606
4990
  */
4607
4991
  WhatIfForecastName?: string;
4608
4992
  /**
4993
+ * @public
4609
4994
  * <p>The Amazon Resource Name (ARN) of the what-if forecast.</p>
4610
4995
  */
4611
4996
  WhatIfForecastArn?: string;
4612
4997
  /**
4998
+ * @public
4613
4999
  * <p>The Amazon Resource Name (ARN) of the what-if analysis that contains this forecast.</p>
4614
5000
  */
4615
5001
  WhatIfAnalysisArn?: string;
4616
5002
  /**
5003
+ * @public
4617
5004
  * <p>The approximate time remaining to complete the what-if forecast, in minutes.</p>
4618
5005
  */
4619
5006
  EstimatedTimeRemainingInMinutes?: number;
4620
5007
  /**
5008
+ * @public
4621
5009
  * <p>The status of the what-if forecast. States include:</p>
4622
5010
  * <ul>
4623
5011
  * <li>
@@ -4650,14 +5038,17 @@ export interface DescribeWhatIfForecastResponse {
4650
5038
  */
4651
5039
  Status?: string;
4652
5040
  /**
5041
+ * @public
4653
5042
  * <p>If an error occurred, an informational message about the error.</p>
4654
5043
  */
4655
5044
  Message?: string;
4656
5045
  /**
5046
+ * @public
4657
5047
  * <p>When the what-if forecast was created.</p>
4658
5048
  */
4659
5049
  CreationTime?: Date;
4660
5050
  /**
5051
+ * @public
4661
5052
  * <p>The last time the resource was modified. The timestamp depends on the status of the job:</p>
4662
5053
  * <ul>
4663
5054
  * <li>
@@ -4685,14 +5076,17 @@ export interface DescribeWhatIfForecastResponse {
4685
5076
  */
4686
5077
  LastModificationTime?: Date;
4687
5078
  /**
5079
+ * @public
4688
5080
  * <p>An array of <code>Action</code> and <code>TimeSeriesConditions</code> elements that describe what transformations were applied to which time series.</p>
4689
5081
  */
4690
5082
  TimeSeriesTransformations?: TimeSeriesTransformation[];
4691
5083
  /**
5084
+ * @public
4692
5085
  * <p>An array of <code>S3Config</code>, <code>Schema</code>, and <code>Format</code> elements that describe the replacement time series.</p>
4693
5086
  */
4694
5087
  TimeSeriesReplacementsDataSource?: TimeSeriesReplacementsDataSource;
4695
5088
  /**
5089
+ * @public
4696
5090
  * <p>The quantiles at which probabilistic forecasts are generated. You can specify up to five quantiles per what-if
4697
5091
  * forecast in the <a>CreateWhatIfForecast</a> operation. If you didn't specify quantiles, the default
4698
5092
  * values are <code>["0.1", "0.5", "0.9"]</code>. </p>
@@ -4704,6 +5098,7 @@ export interface DescribeWhatIfForecastResponse {
4704
5098
  */
4705
5099
  export interface DescribeWhatIfForecastExportRequest {
4706
5100
  /**
5101
+ * @public
4707
5102
  * <p>The Amazon Resource Name (ARN) of the what-if forecast export that you are interested in.</p>
4708
5103
  */
4709
5104
  WhatIfForecastExportArn: string | undefined;
@@ -4713,28 +5108,34 @@ export interface DescribeWhatIfForecastExportRequest {
4713
5108
  */
4714
5109
  export interface DescribeWhatIfForecastExportResponse {
4715
5110
  /**
5111
+ * @public
4716
5112
  * <p>The Amazon Resource Name (ARN) of the what-if forecast export.</p>
4717
5113
  */
4718
5114
  WhatIfForecastExportArn?: string;
4719
5115
  /**
5116
+ * @public
4720
5117
  * <p>The name of the what-if forecast export.</p>
4721
5118
  */
4722
5119
  WhatIfForecastExportName?: string;
4723
5120
  /**
5121
+ * @public
4724
5122
  * <p>An array of Amazon Resource Names (ARNs) that represent all of the what-if forecasts exported in this
4725
5123
  * resource.</p>
4726
5124
  */
4727
5125
  WhatIfForecastArns?: string[];
4728
5126
  /**
5127
+ * @public
4729
5128
  * <p>The destination for an export job. Provide an S3 path, an Identity and Access Management (IAM) role that allows Amazon Forecast
4730
5129
  * to access the location, and an Key Management Service (KMS) key (optional). </p>
4731
5130
  */
4732
5131
  Destination?: DataDestination;
4733
5132
  /**
5133
+ * @public
4734
5134
  * <p>If an error occurred, an informational message about the error.</p>
4735
5135
  */
4736
5136
  Message?: string;
4737
5137
  /**
5138
+ * @public
4738
5139
  * <p>The status of the what-if forecast. States include:</p>
4739
5140
  * <ul>
4740
5141
  * <li>
@@ -4767,14 +5168,17 @@ export interface DescribeWhatIfForecastExportResponse {
4767
5168
  */
4768
5169
  Status?: string;
4769
5170
  /**
5171
+ * @public
4770
5172
  * <p>When the what-if forecast export was created.</p>
4771
5173
  */
4772
5174
  CreationTime?: Date;
4773
5175
  /**
5176
+ * @public
4774
5177
  * <p>The approximate time remaining to complete the what-if forecast export, in minutes.</p>
4775
5178
  */
4776
5179
  EstimatedTimeRemainingInMinutes?: number;
4777
5180
  /**
5181
+ * @public
4778
5182
  * <p>The last time the resource was modified. The timestamp depends on the status of the job:</p>
4779
5183
  * <ul>
4780
5184
  * <li>
@@ -4802,6 +5206,7 @@ export interface DescribeWhatIfForecastExportResponse {
4802
5206
  */
4803
5207
  LastModificationTime?: Date;
4804
5208
  /**
5209
+ * @public
4805
5210
  * <p>The format of the exported data, CSV or PARQUET.</p>
4806
5211
  */
4807
5212
  Format?: string;
@@ -4811,6 +5216,7 @@ export interface DescribeWhatIfForecastExportResponse {
4811
5216
  */
4812
5217
  export interface GetAccuracyMetricsRequest {
4813
5218
  /**
5219
+ * @public
4814
5220
  * <p>The Amazon Resource Name (ARN) of the predictor to get metrics for.</p>
4815
5221
  */
4816
5222
  PredictorArn: string | undefined;
@@ -4834,22 +5240,27 @@ export type EvaluationType = (typeof EvaluationType)[keyof typeof EvaluationType
4834
5240
  */
4835
5241
  export interface ErrorMetric {
4836
5242
  /**
5243
+ * @public
4837
5244
  * <p> The Forecast type used to compute WAPE, MAPE, MASE, and RMSE. </p>
4838
5245
  */
4839
5246
  ForecastType?: string;
4840
5247
  /**
5248
+ * @public
4841
5249
  * <p> The weighted absolute percentage error (WAPE). </p>
4842
5250
  */
4843
5251
  WAPE?: number;
4844
5252
  /**
5253
+ * @public
4845
5254
  * <p> The root-mean-square error (RMSE). </p>
4846
5255
  */
4847
5256
  RMSE?: number;
4848
5257
  /**
5258
+ * @public
4849
5259
  * <p>The Mean Absolute Scaled Error (MASE)</p>
4850
5260
  */
4851
5261
  MASE?: number;
4852
5262
  /**
5263
+ * @public
4853
5264
  * <p>The Mean Absolute Percentage Error (MAPE)</p>
4854
5265
  */
4855
5266
  MAPE?: number;
@@ -4860,12 +5271,14 @@ export interface ErrorMetric {
4860
5271
  */
4861
5272
  export interface WeightedQuantileLoss {
4862
5273
  /**
5274
+ * @public
4863
5275
  * <p>The quantile. Quantiles divide a probability distribution into regions of equal
4864
5276
  * probability. For example, if the distribution was divided into 5 regions of equal probability,
4865
5277
  * the quantiles would be 0.2, 0.4, 0.6, and 0.8.</p>
4866
5278
  */
4867
5279
  Quantile?: number;
4868
5280
  /**
5281
+ * @public
4869
5282
  * <p>The difference between the predicted value and the actual value over the quantile,
4870
5283
  * weighted (normalized) by dividing by the sum over all quantiles.</p>
4871
5284
  */
@@ -4878,23 +5291,27 @@ export interface WeightedQuantileLoss {
4878
5291
  */
4879
5292
  export interface Metrics {
4880
5293
  /**
5294
+ * @public
4881
5295
  * @deprecated
4882
5296
  *
4883
5297
  * <p>The root-mean-square error (RMSE).</p>
4884
5298
  */
4885
5299
  RMSE?: number;
4886
5300
  /**
5301
+ * @public
4887
5302
  * <p>An array of weighted quantile losses. Quantiles divide a probability distribution into
4888
5303
  * regions of equal probability. The distribution in this case is the loss function.</p>
4889
5304
  */
4890
5305
  WeightedQuantileLosses?: WeightedQuantileLoss[];
4891
5306
  /**
5307
+ * @public
4892
5308
  * <p> Provides detailed error metrics for each forecast type. Metrics include root-mean
4893
5309
  * square-error (RMSE), mean absolute percentage error (MAPE), mean absolute scaled error (MASE),
4894
5310
  * and weighted average percentage error (WAPE). </p>
4895
5311
  */
4896
5312
  ErrorMetrics?: ErrorMetric[];
4897
5313
  /**
5314
+ * @public
4898
5315
  * <p>The average value of all weighted quantile losses.</p>
4899
5316
  */
4900
5317
  AverageWeightedQuantileLoss?: number;
@@ -4908,18 +5325,22 @@ export interface Metrics {
4908
5325
  */
4909
5326
  export interface WindowSummary {
4910
5327
  /**
5328
+ * @public
4911
5329
  * <p>The timestamp that defines the start of the window.</p>
4912
5330
  */
4913
5331
  TestWindowStart?: Date;
4914
5332
  /**
5333
+ * @public
4915
5334
  * <p>The timestamp that defines the end of the window.</p>
4916
5335
  */
4917
5336
  TestWindowEnd?: Date;
4918
5337
  /**
5338
+ * @public
4919
5339
  * <p>The number of data points within the window.</p>
4920
5340
  */
4921
5341
  ItemCount?: number;
4922
5342
  /**
5343
+ * @public
4923
5344
  * <p>The type of evaluation.</p>
4924
5345
  * <ul>
4925
5346
  * <li>
@@ -4934,6 +5355,7 @@ export interface WindowSummary {
4934
5355
  */
4935
5356
  EvaluationType?: EvaluationType | string;
4936
5357
  /**
5358
+ * @public
4937
5359
  * <p>Provides metrics used to evaluate the performance of a predictor.</p>
4938
5360
  */
4939
5361
  Metrics?: Metrics;
@@ -4944,10 +5366,12 @@ export interface WindowSummary {
4944
5366
  */
4945
5367
  export interface EvaluationResult {
4946
5368
  /**
5369
+ * @public
4947
5370
  * <p>The Amazon Resource Name (ARN) of the algorithm that was evaluated.</p>
4948
5371
  */
4949
5372
  AlgorithmArn?: string;
4950
5373
  /**
5374
+ * @public
4951
5375
  * <p>The array of test windows used for evaluating the algorithm. The
4952
5376
  * <code>NumberOfBacktestWindows</code> from the <a>EvaluationParameters</a> object
4953
5377
  * determines the number of windows in the array.</p>
@@ -4959,14 +5383,17 @@ export interface EvaluationResult {
4959
5383
  */
4960
5384
  export interface GetAccuracyMetricsResponse {
4961
5385
  /**
5386
+ * @public
4962
5387
  * <p>An array of results from evaluating the predictor.</p>
4963
5388
  */
4964
5389
  PredictorEvaluationResults?: EvaluationResult[];
4965
5390
  /**
5391
+ * @public
4966
5392
  * <p>Whether the predictor was created with <a>CreateAutoPredictor</a>.</p>
4967
5393
  */
4968
5394
  IsAutoPredictor?: boolean;
4969
5395
  /**
5396
+ * @public
4970
5397
  * <note>
4971
5398
  * <p> The <code>LatencyOptimized</code> AutoML override strategy is only available in private beta.
4972
5399
  * Contact Amazon Web Services Support or your account manager to learn more about access privileges.
@@ -4978,6 +5405,7 @@ export interface GetAccuracyMetricsResponse {
4978
5405
  */
4979
5406
  AutoMLOverrideStrategy?: AutoMLOverrideStrategy | string;
4980
5407
  /**
5408
+ * @public
4981
5409
  * <p>The accuracy metric used to optimize the predictor.</p>
4982
5410
  */
4983
5411
  OptimizationMetric?: OptimizationMetric | string;
@@ -5000,12 +5428,14 @@ export declare class InvalidNextTokenException extends __BaseException {
5000
5428
  */
5001
5429
  export interface ListDatasetGroupsRequest {
5002
5430
  /**
5431
+ * @public
5003
5432
  * <p>If the result of the previous request was truncated, the response includes a
5004
5433
  * <code>NextToken</code>. To retrieve the next set of results, use the token in the next
5005
5434
  * request. Tokens expire after 24 hours.</p>
5006
5435
  */
5007
5436
  NextToken?: string;
5008
5437
  /**
5438
+ * @public
5009
5439
  * <p>The number of items to return in the response.</p>
5010
5440
  */
5011
5441
  MaxResults?: number;
@@ -5018,18 +5448,22 @@ export interface ListDatasetGroupsRequest {
5018
5448
  */
5019
5449
  export interface DatasetGroupSummary {
5020
5450
  /**
5451
+ * @public
5021
5452
  * <p>The Amazon Resource Name (ARN) of the dataset group.</p>
5022
5453
  */
5023
5454
  DatasetGroupArn?: string;
5024
5455
  /**
5456
+ * @public
5025
5457
  * <p>The name of the dataset group.</p>
5026
5458
  */
5027
5459
  DatasetGroupName?: string;
5028
5460
  /**
5461
+ * @public
5029
5462
  * <p>When the dataset group was created.</p>
5030
5463
  */
5031
5464
  CreationTime?: Date;
5032
5465
  /**
5466
+ * @public
5033
5467
  * <p>When the dataset group was created or last updated from a call to the <a href="https://docs.aws.amazon.com/forecast/latest/dg/API_UpdateDatasetGroup.html">UpdateDatasetGroup</a> operation. While the dataset group is being updated,
5034
5468
  * <code>LastModificationTime</code> is the current time of the <code>ListDatasetGroups</code>
5035
5469
  * call.</p>
@@ -5041,10 +5475,12 @@ export interface DatasetGroupSummary {
5041
5475
  */
5042
5476
  export interface ListDatasetGroupsResponse {
5043
5477
  /**
5478
+ * @public
5044
5479
  * <p>An array of objects that summarize each dataset group's properties.</p>
5045
5480
  */
5046
5481
  DatasetGroups?: DatasetGroupSummary[];
5047
5482
  /**
5483
+ * @public
5048
5484
  * <p>If the response is truncated, Amazon Forecast returns this token. To retrieve the next set of
5049
5485
  * results, use the token in the next request.</p>
5050
5486
  */
@@ -5072,14 +5508,17 @@ export type FilterConditionString = (typeof FilterConditionString)[keyof typeof
5072
5508
  */
5073
5509
  export interface Filter {
5074
5510
  /**
5511
+ * @public
5075
5512
  * <p>The name of the parameter to filter on.</p>
5076
5513
  */
5077
5514
  Key: string | undefined;
5078
5515
  /**
5516
+ * @public
5079
5517
  * <p>The value to match.</p>
5080
5518
  */
5081
5519
  Value: string | undefined;
5082
5520
  /**
5521
+ * @public
5083
5522
  * <p>The condition to apply. To include the objects that match the statement, specify
5084
5523
  * <code>IS</code>. To exclude matching objects, specify <code>IS_NOT</code>.</p>
5085
5524
  */
@@ -5090,16 +5529,19 @@ export interface Filter {
5090
5529
  */
5091
5530
  export interface ListDatasetImportJobsRequest {
5092
5531
  /**
5532
+ * @public
5093
5533
  * <p>If the result of the previous request was truncated, the response includes a
5094
5534
  * <code>NextToken</code>. To retrieve the next set of results, use the token in the next
5095
5535
  * request. Tokens expire after 24 hours.</p>
5096
5536
  */
5097
5537
  NextToken?: string;
5098
5538
  /**
5539
+ * @public
5099
5540
  * <p>The number of items to return in the response.</p>
5100
5541
  */
5101
5542
  MaxResults?: number;
5102
5543
  /**
5544
+ * @public
5103
5545
  * <p>An array of filters. For each filter, you provide a condition and a match statement. The
5104
5546
  * condition is either <code>IS</code> or <code>IS_NOT</code>, which specifies whether to include
5105
5547
  * or exclude the datasets that match the statement from the list, respectively. The match
@@ -5140,20 +5582,24 @@ export interface ListDatasetImportJobsRequest {
5140
5582
  */
5141
5583
  export interface DatasetImportJobSummary {
5142
5584
  /**
5585
+ * @public
5143
5586
  * <p>The Amazon Resource Name (ARN) of the dataset import job.</p>
5144
5587
  */
5145
5588
  DatasetImportJobArn?: string;
5146
5589
  /**
5590
+ * @public
5147
5591
  * <p>The name of the dataset import job.</p>
5148
5592
  */
5149
5593
  DatasetImportJobName?: string;
5150
5594
  /**
5595
+ * @public
5151
5596
  * <p>The location of the training data to import and an Identity and Access Management (IAM) role that Amazon Forecast
5152
5597
  * can assume to access the data. The training data must be stored in an Amazon S3 bucket.</p>
5153
5598
  * <p>If encryption is used, <code>DataSource</code> includes an Key Management Service (KMS) key.</p>
5154
5599
  */
5155
5600
  DataSource?: DataSource;
5156
5601
  /**
5602
+ * @public
5157
5603
  * <p>The status of the dataset import job. States include:</p>
5158
5604
  * <ul>
5159
5605
  * <li>
@@ -5182,14 +5628,17 @@ export interface DatasetImportJobSummary {
5182
5628
  */
5183
5629
  Status?: string;
5184
5630
  /**
5631
+ * @public
5185
5632
  * <p>If an error occurred, an informational message about the error.</p>
5186
5633
  */
5187
5634
  Message?: string;
5188
5635
  /**
5636
+ * @public
5189
5637
  * <p>When the dataset import job was created.</p>
5190
5638
  */
5191
5639
  CreationTime?: Date;
5192
5640
  /**
5641
+ * @public
5193
5642
  * <p>The last time the resource was modified. The timestamp depends on the status of the
5194
5643
  * job:</p>
5195
5644
  * <ul>
@@ -5218,6 +5667,7 @@ export interface DatasetImportJobSummary {
5218
5667
  */
5219
5668
  LastModificationTime?: Date;
5220
5669
  /**
5670
+ * @public
5221
5671
  * <p>The import mode of the dataset import job, FULL or INCREMENTAL.</p>
5222
5672
  */
5223
5673
  ImportMode?: ImportMode | string;
@@ -5227,10 +5677,12 @@ export interface DatasetImportJobSummary {
5227
5677
  */
5228
5678
  export interface ListDatasetImportJobsResponse {
5229
5679
  /**
5680
+ * @public
5230
5681
  * <p>An array of objects that summarize each dataset import job's properties.</p>
5231
5682
  */
5232
5683
  DatasetImportJobs?: DatasetImportJobSummary[];
5233
5684
  /**
5685
+ * @public
5234
5686
  * <p>If the response is truncated, Amazon Forecast returns this token. To retrieve the next set of
5235
5687
  * results, use the token in the next request.</p>
5236
5688
  */
@@ -5241,12 +5693,14 @@ export interface ListDatasetImportJobsResponse {
5241
5693
  */
5242
5694
  export interface ListDatasetsRequest {
5243
5695
  /**
5696
+ * @public
5244
5697
  * <p>If the result of the previous request was truncated, the response includes a
5245
5698
  * <code>NextToken</code>. To retrieve the next set of results, use the token in the next
5246
5699
  * request. Tokens expire after 24 hours.</p>
5247
5700
  */
5248
5701
  NextToken?: string;
5249
5702
  /**
5703
+ * @public
5250
5704
  * <p>The number of items to return in the response.</p>
5251
5705
  */
5252
5706
  MaxResults?: number;
@@ -5259,26 +5713,32 @@ export interface ListDatasetsRequest {
5259
5713
  */
5260
5714
  export interface DatasetSummary {
5261
5715
  /**
5716
+ * @public
5262
5717
  * <p>The Amazon Resource Name (ARN) of the dataset.</p>
5263
5718
  */
5264
5719
  DatasetArn?: string;
5265
5720
  /**
5721
+ * @public
5266
5722
  * <p>The name of the dataset.</p>
5267
5723
  */
5268
5724
  DatasetName?: string;
5269
5725
  /**
5726
+ * @public
5270
5727
  * <p>The dataset type.</p>
5271
5728
  */
5272
5729
  DatasetType?: DatasetType | string;
5273
5730
  /**
5731
+ * @public
5274
5732
  * <p>The domain associated with the dataset.</p>
5275
5733
  */
5276
5734
  Domain?: Domain | string;
5277
5735
  /**
5736
+ * @public
5278
5737
  * <p>When the dataset was created.</p>
5279
5738
  */
5280
5739
  CreationTime?: Date;
5281
5740
  /**
5741
+ * @public
5282
5742
  * <p>When you create a dataset, <code>LastModificationTime</code> is the same as
5283
5743
  * <code>CreationTime</code>. While data is being imported to the dataset,
5284
5744
  * <code>LastModificationTime</code> is the current time of the <code>ListDatasets</code> call.
@@ -5292,10 +5752,12 @@ export interface DatasetSummary {
5292
5752
  */
5293
5753
  export interface ListDatasetsResponse {
5294
5754
  /**
5755
+ * @public
5295
5756
  * <p>An array of objects that summarize each dataset's properties.</p>
5296
5757
  */
5297
5758
  Datasets?: DatasetSummary[];
5298
5759
  /**
5760
+ * @public
5299
5761
  * <p>If the response is truncated, Amazon Forecast returns this token. To retrieve the next set of
5300
5762
  * results, use the token in the next request.</p>
5301
5763
  */
@@ -5306,16 +5768,19 @@ export interface ListDatasetsResponse {
5306
5768
  */
5307
5769
  export interface ListExplainabilitiesRequest {
5308
5770
  /**
5771
+ * @public
5309
5772
  * <p>If the result of the previous request was truncated, the response includes a
5310
5773
  * NextToken. To retrieve the next set of results, use the token in the next request.
5311
5774
  * Tokens expire after 24 hours.</p>
5312
5775
  */
5313
5776
  NextToken?: string;
5314
5777
  /**
5778
+ * @public
5315
5779
  * <p>The number of items returned in the response.</p>
5316
5780
  */
5317
5781
  MaxResults?: number;
5318
5782
  /**
5783
+ * @public
5319
5784
  * <p>An array of filters. For each filter, provide a condition and a match statement. The
5320
5785
  * condition is either <code>IS</code> or <code>IS_NOT</code>, which specifies whether to
5321
5786
  * include or exclude the resources that match the statement from the list. The match
@@ -5350,24 +5815,29 @@ export interface ListExplainabilitiesRequest {
5350
5815
  */
5351
5816
  export interface ExplainabilitySummary {
5352
5817
  /**
5818
+ * @public
5353
5819
  * <p>The Amazon Resource Name (ARN) of the Explainability.</p>
5354
5820
  */
5355
5821
  ExplainabilityArn?: string;
5356
5822
  /**
5823
+ * @public
5357
5824
  * <p>The name of the Explainability.</p>
5358
5825
  */
5359
5826
  ExplainabilityName?: string;
5360
5827
  /**
5828
+ * @public
5361
5829
  * <p>The Amazon Resource Name (ARN) of the Predictor or Forecast used to create the
5362
5830
  * Explainability.</p>
5363
5831
  */
5364
5832
  ResourceArn?: string;
5365
5833
  /**
5834
+ * @public
5366
5835
  * <p>The configuration settings that define the granularity of time series and time points
5367
5836
  * for the Explainability.</p>
5368
5837
  */
5369
5838
  ExplainabilityConfig?: ExplainabilityConfig;
5370
5839
  /**
5840
+ * @public
5371
5841
  * <p>The status of the Explainability. States include: </p>
5372
5842
  * <ul>
5373
5843
  * <li>
@@ -5396,15 +5866,18 @@ export interface ExplainabilitySummary {
5396
5866
  */
5397
5867
  Status?: string;
5398
5868
  /**
5869
+ * @public
5399
5870
  * <p>Information about any errors that may have occurred during the Explainability creation
5400
5871
  * process.</p>
5401
5872
  */
5402
5873
  Message?: string;
5403
5874
  /**
5875
+ * @public
5404
5876
  * <p>When the Explainability was created.</p>
5405
5877
  */
5406
5878
  CreationTime?: Date;
5407
5879
  /**
5880
+ * @public
5408
5881
  * <p>The last time the resource was modified. The timestamp depends on the status of the
5409
5882
  * job:</p>
5410
5883
  * <ul>
@@ -5438,11 +5911,13 @@ export interface ExplainabilitySummary {
5438
5911
  */
5439
5912
  export interface ListExplainabilitiesResponse {
5440
5913
  /**
5914
+ * @public
5441
5915
  * <p>An array of objects that summarize the properties of each Explainability
5442
5916
  * resource.</p>
5443
5917
  */
5444
5918
  Explainabilities?: ExplainabilitySummary[];
5445
5919
  /**
5920
+ * @public
5446
5921
  * <p>Returns this token if the response is truncated. To retrieve the next set of results,
5447
5922
  * use the token in the next request.</p>
5448
5923
  */
@@ -5453,16 +5928,19 @@ export interface ListExplainabilitiesResponse {
5453
5928
  */
5454
5929
  export interface ListExplainabilityExportsRequest {
5455
5930
  /**
5931
+ * @public
5456
5932
  * <p>If the result of the previous request was truncated, the response includes a
5457
5933
  * NextToken. To retrieve the next set of results, use the token in the next request.
5458
5934
  * Tokens expire after 24 hours.</p>
5459
5935
  */
5460
5936
  NextToken?: string;
5461
5937
  /**
5938
+ * @public
5462
5939
  * <p>The number of items to return in the response.</p>
5463
5940
  */
5464
5941
  MaxResults?: number;
5465
5942
  /**
5943
+ * @public
5466
5944
  * <p>An array of filters. For each filter, provide a condition and a match statement. The
5467
5945
  * condition is either <code>IS</code> or <code>IS_NOT</code>, which specifies whether to
5468
5946
  * include or exclude resources that match the statement from the list. The match statement
@@ -5497,19 +5975,23 @@ export interface ListExplainabilityExportsRequest {
5497
5975
  */
5498
5976
  export interface ExplainabilityExportSummary {
5499
5977
  /**
5978
+ * @public
5500
5979
  * <p>The Amazon Resource Name (ARN) of the Explainability export.</p>
5501
5980
  */
5502
5981
  ExplainabilityExportArn?: string;
5503
5982
  /**
5983
+ * @public
5504
5984
  * <p>The name of the Explainability export</p>
5505
5985
  */
5506
5986
  ExplainabilityExportName?: string;
5507
5987
  /**
5988
+ * @public
5508
5989
  * <p>The destination for an export job. Provide an S3 path, an Identity and Access Management (IAM) role that allows Amazon Forecast
5509
5990
  * to access the location, and an Key Management Service (KMS) key (optional). </p>
5510
5991
  */
5511
5992
  Destination?: DataDestination;
5512
5993
  /**
5994
+ * @public
5513
5995
  * <p>The status of the Explainability export. States include: </p>
5514
5996
  * <ul>
5515
5997
  * <li>
@@ -5538,15 +6020,18 @@ export interface ExplainabilityExportSummary {
5538
6020
  */
5539
6021
  Status?: string;
5540
6022
  /**
6023
+ * @public
5541
6024
  * <p>Information about any errors that may have occurred during the Explainability
5542
6025
  * export.</p>
5543
6026
  */
5544
6027
  Message?: string;
5545
6028
  /**
6029
+ * @public
5546
6030
  * <p>When the Explainability was created.</p>
5547
6031
  */
5548
6032
  CreationTime?: Date;
5549
6033
  /**
6034
+ * @public
5550
6035
  * <p>The last time the resource was modified. The timestamp depends on the status of the
5551
6036
  * job:</p>
5552
6037
  * <ul>
@@ -5580,11 +6065,13 @@ export interface ExplainabilityExportSummary {
5580
6065
  */
5581
6066
  export interface ListExplainabilityExportsResponse {
5582
6067
  /**
6068
+ * @public
5583
6069
  * <p>An array of objects that summarize the properties of each Explainability
5584
6070
  * export.</p>
5585
6071
  */
5586
6072
  ExplainabilityExports?: ExplainabilityExportSummary[];
5587
6073
  /**
6074
+ * @public
5588
6075
  * <p>Returns this token if the response is truncated. To retrieve the next set of results,
5589
6076
  * use the token in the next request.</p>
5590
6077
  */
@@ -5595,16 +6082,19 @@ export interface ListExplainabilityExportsResponse {
5595
6082
  */
5596
6083
  export interface ListForecastExportJobsRequest {
5597
6084
  /**
6085
+ * @public
5598
6086
  * <p>If the result of the previous request was truncated, the response includes a
5599
6087
  * <code>NextToken</code>. To retrieve the next set of results, use the token in the next
5600
6088
  * request. Tokens expire after 24 hours.</p>
5601
6089
  */
5602
6090
  NextToken?: string;
5603
6091
  /**
6092
+ * @public
5604
6093
  * <p>The number of items to return in the response.</p>
5605
6094
  */
5606
6095
  MaxResults?: number;
5607
6096
  /**
6097
+ * @public
5608
6098
  * <p>An array of filters. For each filter, you provide a condition and a match statement. The
5609
6099
  * condition is either <code>IS</code> or <code>IS_NOT</code>, which specifies whether to include
5610
6100
  * or exclude the forecast export jobs that match the statement from the list, respectively. The
@@ -5647,18 +6137,22 @@ export interface ListForecastExportJobsRequest {
5647
6137
  */
5648
6138
  export interface ForecastExportJobSummary {
5649
6139
  /**
6140
+ * @public
5650
6141
  * <p>The Amazon Resource Name (ARN) of the forecast export job.</p>
5651
6142
  */
5652
6143
  ForecastExportJobArn?: string;
5653
6144
  /**
6145
+ * @public
5654
6146
  * <p>The name of the forecast export job.</p>
5655
6147
  */
5656
6148
  ForecastExportJobName?: string;
5657
6149
  /**
6150
+ * @public
5658
6151
  * <p>The path to the Amazon Simple Storage Service (Amazon S3) bucket where the forecast is exported.</p>
5659
6152
  */
5660
6153
  Destination?: DataDestination;
5661
6154
  /**
6155
+ * @public
5662
6156
  * <p>The status of the forecast export job. States include:</p>
5663
6157
  * <ul>
5664
6158
  * <li>
@@ -5691,14 +6185,17 @@ export interface ForecastExportJobSummary {
5691
6185
  */
5692
6186
  Status?: string;
5693
6187
  /**
6188
+ * @public
5694
6189
  * <p>If an error occurred, an informational message about the error.</p>
5695
6190
  */
5696
6191
  Message?: string;
5697
6192
  /**
6193
+ * @public
5698
6194
  * <p>When the forecast export job was created.</p>
5699
6195
  */
5700
6196
  CreationTime?: Date;
5701
6197
  /**
6198
+ * @public
5702
6199
  * <p>The last time the resource was modified. The timestamp depends on the status of the job:</p>
5703
6200
  * <ul>
5704
6201
  * <li>
@@ -5731,10 +6228,12 @@ export interface ForecastExportJobSummary {
5731
6228
  */
5732
6229
  export interface ListForecastExportJobsResponse {
5733
6230
  /**
6231
+ * @public
5734
6232
  * <p>An array of objects that summarize each export job's properties.</p>
5735
6233
  */
5736
6234
  ForecastExportJobs?: ForecastExportJobSummary[];
5737
6235
  /**
6236
+ * @public
5738
6237
  * <p>If the response is truncated, Amazon Forecast returns this token. To retrieve the next set of
5739
6238
  * results, use the token in the next request.</p>
5740
6239
  */
@@ -5745,16 +6244,19 @@ export interface ListForecastExportJobsResponse {
5745
6244
  */
5746
6245
  export interface ListForecastsRequest {
5747
6246
  /**
6247
+ * @public
5748
6248
  * <p>If the result of the previous request was truncated, the response includes a
5749
6249
  * <code>NextToken</code>. To retrieve the next set of results, use the token in the next
5750
6250
  * request. Tokens expire after 24 hours.</p>
5751
6251
  */
5752
6252
  NextToken?: string;
5753
6253
  /**
6254
+ * @public
5754
6255
  * <p>The number of items to return in the response.</p>
5755
6256
  */
5756
6257
  MaxResults?: number;
5757
6258
  /**
6259
+ * @public
5758
6260
  * <p>An array of filters. For each filter, you provide a condition and a match statement. The
5759
6261
  * condition is either <code>IS</code> or <code>IS_NOT</code>, which specifies whether to include
5760
6262
  * or exclude the forecasts that match the statement from the list, respectively. The match
@@ -5795,27 +6297,33 @@ export interface ListForecastsRequest {
5795
6297
  */
5796
6298
  export interface ForecastSummary {
5797
6299
  /**
6300
+ * @public
5798
6301
  * <p>The ARN of the forecast.</p>
5799
6302
  */
5800
6303
  ForecastArn?: string;
5801
6304
  /**
6305
+ * @public
5802
6306
  * <p>The name of the forecast.</p>
5803
6307
  */
5804
6308
  ForecastName?: string;
5805
6309
  /**
6310
+ * @public
5806
6311
  * <p>The ARN of the predictor used to generate the forecast.</p>
5807
6312
  */
5808
6313
  PredictorArn?: string;
5809
6314
  /**
6315
+ * @public
5810
6316
  * <p>Whether the Forecast was created from an AutoPredictor.</p>
5811
6317
  */
5812
6318
  CreatedUsingAutoPredictor?: boolean;
5813
6319
  /**
6320
+ * @public
5814
6321
  * <p>The Amazon Resource Name (ARN) of the dataset group that provided the data used to train
5815
6322
  * the predictor.</p>
5816
6323
  */
5817
6324
  DatasetGroupArn?: string;
5818
6325
  /**
6326
+ * @public
5819
6327
  * <p>The status of the forecast. States include:</p>
5820
6328
  * <ul>
5821
6329
  * <li>
@@ -5848,14 +6356,17 @@ export interface ForecastSummary {
5848
6356
  */
5849
6357
  Status?: string;
5850
6358
  /**
6359
+ * @public
5851
6360
  * <p>If an error occurred, an informational message about the error.</p>
5852
6361
  */
5853
6362
  Message?: string;
5854
6363
  /**
6364
+ * @public
5855
6365
  * <p>When the forecast creation task was created.</p>
5856
6366
  */
5857
6367
  CreationTime?: Date;
5858
6368
  /**
6369
+ * @public
5859
6370
  * <p>The last time the resource was modified. The timestamp depends on the status of the job:</p>
5860
6371
  * <ul>
5861
6372
  * <li>
@@ -5888,10 +6399,12 @@ export interface ForecastSummary {
5888
6399
  */
5889
6400
  export interface ListForecastsResponse {
5890
6401
  /**
6402
+ * @public
5891
6403
  * <p>An array of objects that summarize each forecast's properties.</p>
5892
6404
  */
5893
6405
  Forecasts?: ForecastSummary[];
5894
6406
  /**
6407
+ * @public
5895
6408
  * <p>If the response is truncated, Amazon Forecast returns this token. To retrieve the next set
5896
6409
  * of results, use the token in the next request.</p>
5897
6410
  */
@@ -5902,20 +6415,24 @@ export interface ListForecastsResponse {
5902
6415
  */
5903
6416
  export interface ListMonitorEvaluationsRequest {
5904
6417
  /**
6418
+ * @public
5905
6419
  * <p>If the result of the previous request was truncated, the response includes a
5906
6420
  * <code>NextToken</code>. To retrieve the next set of results, use the token in the next
5907
6421
  * request. Tokens expire after 24 hours.</p>
5908
6422
  */
5909
6423
  NextToken?: string;
5910
6424
  /**
6425
+ * @public
5911
6426
  * <p>The maximum number of monitoring results to return.</p>
5912
6427
  */
5913
6428
  MaxResults?: number;
5914
6429
  /**
6430
+ * @public
5915
6431
  * <p>The Amazon Resource Name (ARN) of the monitor resource to get results from.</p>
5916
6432
  */
5917
6433
  MonitorArn: string | undefined;
5918
6434
  /**
6435
+ * @public
5919
6436
  * <p>An array of filters. For each filter, provide a condition and a match statement. The
5920
6437
  * condition is either <code>IS</code> or <code>IS_NOT</code>, which specifies whether to
5921
6438
  * include or exclude the resources that match the statement from the list. The match
@@ -5954,10 +6471,12 @@ export interface ListMonitorEvaluationsRequest {
5954
6471
  */
5955
6472
  export interface MetricResult {
5956
6473
  /**
6474
+ * @public
5957
6475
  * <p>The name of the metric.</p>
5958
6476
  */
5959
6477
  MetricName?: string;
5960
6478
  /**
6479
+ * @public
5961
6480
  * <p>The value for the metric.</p>
5962
6481
  */
5963
6482
  MetricValue?: number;
@@ -5968,14 +6487,17 @@ export interface MetricResult {
5968
6487
  */
5969
6488
  export interface MonitorDataSource {
5970
6489
  /**
6490
+ * @public
5971
6491
  * <p>The Amazon Resource Name (ARN) of the dataset import job used to import the data that initiated the monitor evaluation.</p>
5972
6492
  */
5973
6493
  DatasetImportJobArn?: string;
5974
6494
  /**
6495
+ * @public
5975
6496
  * <p>The Amazon Resource Name (ARN) of the forecast the monitor used during the evaluation.</p>
5976
6497
  */
5977
6498
  ForecastArn?: string;
5978
6499
  /**
6500
+ * @public
5979
6501
  * <p>The Amazon Resource Name (ARN) of the predictor resource you are monitoring.</p>
5980
6502
  */
5981
6503
  PredictorArn?: string;
@@ -5986,10 +6508,12 @@ export interface MonitorDataSource {
5986
6508
  */
5987
6509
  export interface PredictorEvent {
5988
6510
  /**
6511
+ * @public
5989
6512
  * <p>The type of event. For example, <code>Retrain</code>. A retraining event denotes the timepoint when a predictor was retrained. Any monitor results from before the <code>Datetime</code> are from the previous predictor. Any new metrics are for the newly retrained predictor.</p>
5990
6513
  */
5991
6514
  Detail?: string;
5992
6515
  /**
6516
+ * @public
5993
6517
  * <p>The timestamp for when the event occurred.</p>
5994
6518
  */
5995
6519
  Datetime?: Date;
@@ -6000,46 +6524,57 @@ export interface PredictorEvent {
6000
6524
  */
6001
6525
  export interface PredictorMonitorEvaluation {
6002
6526
  /**
6527
+ * @public
6003
6528
  * <p>The Amazon Resource Name (ARN) of the resource to monitor.</p>
6004
6529
  */
6005
6530
  ResourceArn?: string;
6006
6531
  /**
6532
+ * @public
6007
6533
  * <p>The Amazon Resource Name (ARN) of the monitor resource.</p>
6008
6534
  */
6009
6535
  MonitorArn?: string;
6010
6536
  /**
6537
+ * @public
6011
6538
  * <p>The timestamp that indicates when the monitor evaluation was started. </p>
6012
6539
  */
6013
6540
  EvaluationTime?: Date;
6014
6541
  /**
6542
+ * @public
6015
6543
  * <p>The status of the monitor evaluation. The state can be <code>SUCCESS</code> or <code>FAILURE</code>.</p>
6016
6544
  */
6017
6545
  EvaluationState?: string;
6018
6546
  /**
6547
+ * @public
6019
6548
  * <p>The timestamp that indicates the start of the window that is used for monitor evaluation.</p>
6020
6549
  */
6021
6550
  WindowStartDatetime?: Date;
6022
6551
  /**
6552
+ * @public
6023
6553
  * <p>The timestamp that indicates the end of the window that is used for monitor evaluation.</p>
6024
6554
  */
6025
6555
  WindowEndDatetime?: Date;
6026
6556
  /**
6557
+ * @public
6027
6558
  * <p>Provides details about a predictor event, such as a retraining.</p>
6028
6559
  */
6029
6560
  PredictorEvent?: PredictorEvent;
6030
6561
  /**
6562
+ * @public
6031
6563
  * <p>The source of the data the monitor resource used during the evaluation.</p>
6032
6564
  */
6033
6565
  MonitorDataSource?: MonitorDataSource;
6034
6566
  /**
6567
+ * @public
6035
6568
  * <p>A list of metrics Forecast calculated when monitoring a predictor. You can compare the value for each metric in the list to the metric's value in the <a>Baseline</a> to see how your predictor's performance is changing.</p>
6036
6569
  */
6037
6570
  MetricResults?: MetricResult[];
6038
6571
  /**
6572
+ * @public
6039
6573
  * <p>The number of items considered during the evaluation.</p>
6040
6574
  */
6041
6575
  NumItemsEvaluated?: number;
6042
6576
  /**
6577
+ * @public
6043
6578
  * <p>Information about any errors that may have occurred during the monitor evaluation.</p>
6044
6579
  */
6045
6580
  Message?: string;
@@ -6049,11 +6584,13 @@ export interface PredictorMonitorEvaluation {
6049
6584
  */
6050
6585
  export interface ListMonitorEvaluationsResponse {
6051
6586
  /**
6587
+ * @public
6052
6588
  * <p>If the response is truncated, Amazon Forecast returns this token. To retrieve the next set of
6053
6589
  * results, use the token in the next request. Tokens expire after 24 hours.</p>
6054
6590
  */
6055
6591
  NextToken?: string;
6056
6592
  /**
6593
+ * @public
6057
6594
  * <p>The monitoring results and predictor events collected by the monitor resource during different windows of time.</p>
6058
6595
  * <p>For information about monitoring see <a href="https://docs.aws.amazon.com/forecast/latest/dg/predictor-monitoring-results.html">Viewing Monitoring Results</a>. For more information about retrieving monitoring results see <a href="https://docs.aws.amazon.com/forecast/latest/dg/predictor-monitoring-results.html">Viewing Monitoring Results</a>.</p>
6059
6596
  */
@@ -6064,16 +6601,19 @@ export interface ListMonitorEvaluationsResponse {
6064
6601
  */
6065
6602
  export interface ListMonitorsRequest {
6066
6603
  /**
6604
+ * @public
6067
6605
  * <p>If the result of the previous request was truncated, the response includes a
6068
6606
  * <code>NextToken</code>. To retrieve the next set of results, use the token in the next
6069
6607
  * request. Tokens expire after 24 hours.</p>
6070
6608
  */
6071
6609
  NextToken?: string;
6072
6610
  /**
6611
+ * @public
6073
6612
  * <p>The maximum number of monitors to include in the response.</p>
6074
6613
  */
6075
6614
  MaxResults?: number;
6076
6615
  /**
6616
+ * @public
6077
6617
  * <p>An array of filters. For each filter, provide a condition and a match statement. The
6078
6618
  * condition is either <code>IS</code> or <code>IS_NOT</code>, which specifies whether to
6079
6619
  * include or exclude the resources that match the statement from the list. The match
@@ -6112,18 +6652,22 @@ export interface ListMonitorsRequest {
6112
6652
  */
6113
6653
  export interface MonitorSummary {
6114
6654
  /**
6655
+ * @public
6115
6656
  * <p>The Amazon Resource Name (ARN) of the monitor resource.</p>
6116
6657
  */
6117
6658
  MonitorArn?: string;
6118
6659
  /**
6660
+ * @public
6119
6661
  * <p>The name of the monitor resource.</p>
6120
6662
  */
6121
6663
  MonitorName?: string;
6122
6664
  /**
6665
+ * @public
6123
6666
  * <p>The Amazon Resource Name (ARN) of the predictor being monitored.</p>
6124
6667
  */
6125
6668
  ResourceArn?: string;
6126
6669
  /**
6670
+ * @public
6127
6671
  * <p>The status of the monitor. States include:</p>
6128
6672
  * <ul>
6129
6673
  * <li>
@@ -6155,10 +6699,12 @@ export interface MonitorSummary {
6155
6699
  */
6156
6700
  Status?: string;
6157
6701
  /**
6702
+ * @public
6158
6703
  * <p>When the monitor resource was created.</p>
6159
6704
  */
6160
6705
  CreationTime?: Date;
6161
6706
  /**
6707
+ * @public
6162
6708
  * <p>The last time the monitor resource was modified. The timestamp depends on the status of the
6163
6709
  * job:</p>
6164
6710
  * <ul>
@@ -6188,10 +6734,12 @@ export interface MonitorSummary {
6188
6734
  */
6189
6735
  export interface ListMonitorsResponse {
6190
6736
  /**
6737
+ * @public
6191
6738
  * <p>An array of objects that summarize each monitor's properties.</p>
6192
6739
  */
6193
6740
  Monitors?: MonitorSummary[];
6194
6741
  /**
6742
+ * @public
6195
6743
  * <p>If the response is truncated, Amazon Forecast returns this token. To retrieve the next set of
6196
6744
  * results, use the token in the next request.</p>
6197
6745
  */
@@ -6202,16 +6750,19 @@ export interface ListMonitorsResponse {
6202
6750
  */
6203
6751
  export interface ListPredictorBacktestExportJobsRequest {
6204
6752
  /**
6753
+ * @public
6205
6754
  * <p>If the result of the previous request was truncated, the response includes a
6206
6755
  * NextToken. To retrieve the next set of results, use the token in the next request.
6207
6756
  * Tokens expire after 24 hours.</p>
6208
6757
  */
6209
6758
  NextToken?: string;
6210
6759
  /**
6760
+ * @public
6211
6761
  * <p>The number of items to return in the response.</p>
6212
6762
  */
6213
6763
  MaxResults?: number;
6214
6764
  /**
6765
+ * @public
6215
6766
  * <p>An array of filters. For each filter, provide a condition and a match statement. The
6216
6767
  * condition is either <code>IS</code> or <code>IS_NOT</code>, which specifies whether to
6217
6768
  * include or exclude the predictor backtest export jobs that match the statement from the
@@ -6248,19 +6799,23 @@ export interface ListPredictorBacktestExportJobsRequest {
6248
6799
  */
6249
6800
  export interface PredictorBacktestExportJobSummary {
6250
6801
  /**
6802
+ * @public
6251
6803
  * <p>The Amazon Resource Name (ARN) of the predictor backtest export job.</p>
6252
6804
  */
6253
6805
  PredictorBacktestExportJobArn?: string;
6254
6806
  /**
6807
+ * @public
6255
6808
  * <p>The name of the predictor backtest export job.</p>
6256
6809
  */
6257
6810
  PredictorBacktestExportJobName?: string;
6258
6811
  /**
6812
+ * @public
6259
6813
  * <p>The destination for an export job. Provide an S3 path, an Identity and Access Management (IAM) role that allows Amazon Forecast
6260
6814
  * to access the location, and an Key Management Service (KMS) key (optional). </p>
6261
6815
  */
6262
6816
  Destination?: DataDestination;
6263
6817
  /**
6818
+ * @public
6264
6819
  * <p>The status of the predictor backtest export job. States include: </p>
6265
6820
  * <ul>
6266
6821
  * <li>
@@ -6289,14 +6844,17 @@ export interface PredictorBacktestExportJobSummary {
6289
6844
  */
6290
6845
  Status?: string;
6291
6846
  /**
6847
+ * @public
6292
6848
  * <p>Information about any errors that may have occurred during the backtest export.</p>
6293
6849
  */
6294
6850
  Message?: string;
6295
6851
  /**
6852
+ * @public
6296
6853
  * <p>When the predictor backtest export job was created.</p>
6297
6854
  */
6298
6855
  CreationTime?: Date;
6299
6856
  /**
6857
+ * @public
6300
6858
  * <p>The last time the resource was modified. The timestamp depends on the status of the
6301
6859
  * job:</p>
6302
6860
  * <ul>
@@ -6330,11 +6888,13 @@ export interface PredictorBacktestExportJobSummary {
6330
6888
  */
6331
6889
  export interface ListPredictorBacktestExportJobsResponse {
6332
6890
  /**
6891
+ * @public
6333
6892
  * <p>An array of objects that summarize the properties of each predictor backtest export
6334
6893
  * job.</p>
6335
6894
  */
6336
6895
  PredictorBacktestExportJobs?: PredictorBacktestExportJobSummary[];
6337
6896
  /**
6897
+ * @public
6338
6898
  * <p>Returns this token if the response is truncated. To retrieve the next set of results,
6339
6899
  * use the token in the next request.</p>
6340
6900
  */
@@ -6345,16 +6905,19 @@ export interface ListPredictorBacktestExportJobsResponse {
6345
6905
  */
6346
6906
  export interface ListPredictorsRequest {
6347
6907
  /**
6908
+ * @public
6348
6909
  * <p>If the result of the previous request was truncated, the response includes a
6349
6910
  * <code>NextToken</code>. To retrieve the next set of results, use the token in the next
6350
6911
  * request. Tokens expire after 24 hours.</p>
6351
6912
  */
6352
6913
  NextToken?: string;
6353
6914
  /**
6915
+ * @public
6354
6916
  * <p>The number of items to return in the response.</p>
6355
6917
  */
6356
6918
  MaxResults?: number;
6357
6919
  /**
6920
+ * @public
6358
6921
  * <p>An array of filters. For each filter, you provide a condition and a match statement. The
6359
6922
  * condition is either <code>IS</code> or <code>IS_NOT</code>, which specifies whether to include
6360
6923
  * or exclude the predictors that match the statement from the list, respectively. The match
@@ -6394,28 +6957,34 @@ export interface ListPredictorsRequest {
6394
6957
  */
6395
6958
  export interface PredictorSummary {
6396
6959
  /**
6960
+ * @public
6397
6961
  * <p>The ARN of the predictor.</p>
6398
6962
  */
6399
6963
  PredictorArn?: string;
6400
6964
  /**
6965
+ * @public
6401
6966
  * <p>The name of the predictor.</p>
6402
6967
  */
6403
6968
  PredictorName?: string;
6404
6969
  /**
6970
+ * @public
6405
6971
  * <p>The Amazon Resource Name (ARN) of the dataset group that contains the data used to train
6406
6972
  * the predictor.</p>
6407
6973
  */
6408
6974
  DatasetGroupArn?: string;
6409
6975
  /**
6976
+ * @public
6410
6977
  * <p>Whether AutoPredictor was used to create the predictor.</p>
6411
6978
  */
6412
6979
  IsAutoPredictor?: boolean;
6413
6980
  /**
6981
+ * @public
6414
6982
  * <p>A summary of the reference predictor used if the predictor was retrained or
6415
6983
  * upgraded.</p>
6416
6984
  */
6417
6985
  ReferencePredictorSummary?: ReferencePredictorSummary;
6418
6986
  /**
6987
+ * @public
6419
6988
  * <p>The status of the predictor. States include:</p>
6420
6989
  * <ul>
6421
6990
  * <li>
@@ -6448,14 +7017,17 @@ export interface PredictorSummary {
6448
7017
  */
6449
7018
  Status?: string;
6450
7019
  /**
7020
+ * @public
6451
7021
  * <p>If an error occurred, an informational message about the error.</p>
6452
7022
  */
6453
7023
  Message?: string;
6454
7024
  /**
7025
+ * @public
6455
7026
  * <p>When the model training task was created.</p>
6456
7027
  */
6457
7028
  CreationTime?: Date;
6458
7029
  /**
7030
+ * @public
6459
7031
  * <p>The last time the resource was modified. The timestamp depends on the status of the
6460
7032
  * job:</p>
6461
7033
  * <ul>
@@ -6489,10 +7061,12 @@ export interface PredictorSummary {
6489
7061
  */
6490
7062
  export interface ListPredictorsResponse {
6491
7063
  /**
7064
+ * @public
6492
7065
  * <p>An array of objects that summarize each predictor's properties.</p>
6493
7066
  */
6494
7067
  Predictors?: PredictorSummary[];
6495
7068
  /**
7069
+ * @public
6496
7070
  * <p>If the response is truncated, Amazon Forecast returns this token. To retrieve the next set of
6497
7071
  * results, use the token in the next request.</p>
6498
7072
  */
@@ -6503,6 +7077,7 @@ export interface ListPredictorsResponse {
6503
7077
  */
6504
7078
  export interface ListTagsForResourceRequest {
6505
7079
  /**
7080
+ * @public
6506
7081
  * <p>The Amazon Resource Name (ARN) that identifies the resource for which to list the tags.
6507
7082
  * </p>
6508
7083
  */
@@ -6513,6 +7088,7 @@ export interface ListTagsForResourceRequest {
6513
7088
  */
6514
7089
  export interface ListTagsForResourceResponse {
6515
7090
  /**
7091
+ * @public
6516
7092
  * <p>The tags for the resource.</p>
6517
7093
  */
6518
7094
  Tags?: Tag[];
@@ -6522,16 +7098,19 @@ export interface ListTagsForResourceResponse {
6522
7098
  */
6523
7099
  export interface ListWhatIfAnalysesRequest {
6524
7100
  /**
7101
+ * @public
6525
7102
  * <p>If the result of the previous request was truncated, the response includes a
6526
7103
  * <code>NextToken</code>. To retrieve the next set of results, use the token in the next
6527
7104
  * request. Tokens expire after 24 hours.</p>
6528
7105
  */
6529
7106
  NextToken?: string;
6530
7107
  /**
7108
+ * @public
6531
7109
  * <p>The number of items to return in the response.</p>
6532
7110
  */
6533
7111
  MaxResults?: number;
6534
7112
  /**
7113
+ * @public
6535
7114
  * <p>An array of filters. For each filter, you provide a condition and a match statement. The condition is either
6536
7115
  * <code>IS</code> or <code>IS_NOT</code>, which specifies whether to include or exclude the what-if analysis jobs
6537
7116
  * that match the statement from the list, respectively. The match statement consists of a key and a value.</p>
@@ -6570,18 +7149,22 @@ export interface ListWhatIfAnalysesRequest {
6570
7149
  */
6571
7150
  export interface WhatIfAnalysisSummary {
6572
7151
  /**
7152
+ * @public
6573
7153
  * <p>The Amazon Resource Name (ARN) of the what-if analysis.</p>
6574
7154
  */
6575
7155
  WhatIfAnalysisArn?: string;
6576
7156
  /**
7157
+ * @public
6577
7158
  * <p>The name of the what-if analysis.</p>
6578
7159
  */
6579
7160
  WhatIfAnalysisName?: string;
6580
7161
  /**
7162
+ * @public
6581
7163
  * <p>The Amazon Resource Name (ARN) of the baseline forecast that is being used in this what-if analysis.</p>
6582
7164
  */
6583
7165
  ForecastArn?: string;
6584
7166
  /**
7167
+ * @public
6585
7168
  * <p>The status of the what-if analysis. States include:</p>
6586
7169
  * <ul>
6587
7170
  * <li>
@@ -6614,14 +7197,17 @@ export interface WhatIfAnalysisSummary {
6614
7197
  */
6615
7198
  Status?: string;
6616
7199
  /**
7200
+ * @public
6617
7201
  * <p>If an error occurred, an informational message about the error.</p>
6618
7202
  */
6619
7203
  Message?: string;
6620
7204
  /**
7205
+ * @public
6621
7206
  * <p>When the what-if analysis was created.</p>
6622
7207
  */
6623
7208
  CreationTime?: Date;
6624
7209
  /**
7210
+ * @public
6625
7211
  * <p>The last time the resource was modified. The timestamp depends on the status of the job:</p>
6626
7212
  * <ul>
6627
7213
  * <li>
@@ -6654,10 +7240,12 @@ export interface WhatIfAnalysisSummary {
6654
7240
  */
6655
7241
  export interface ListWhatIfAnalysesResponse {
6656
7242
  /**
7243
+ * @public
6657
7244
  * <p>An array of <code>WhatIfAnalysisSummary</code> objects that describe the matched analyses.</p>
6658
7245
  */
6659
7246
  WhatIfAnalyses?: WhatIfAnalysisSummary[];
6660
7247
  /**
7248
+ * @public
6661
7249
  * <p>If the response is truncated, Forecast returns this token. To retrieve the next set of results, use the token in the next request.</p>
6662
7250
  */
6663
7251
  NextToken?: string;
@@ -6667,15 +7255,18 @@ export interface ListWhatIfAnalysesResponse {
6667
7255
  */
6668
7256
  export interface ListWhatIfForecastExportsRequest {
6669
7257
  /**
7258
+ * @public
6670
7259
  * <p>If the result of the previous request was truncated, the response includes a <code>NextToken</code>. To retrieve the next set of results, use the token in the next
6671
7260
  request. Tokens expire after 24 hours.</p>
6672
7261
  */
6673
7262
  NextToken?: string;
6674
7263
  /**
7264
+ * @public
6675
7265
  * <p>The number of items to return in the response.</p>
6676
7266
  */
6677
7267
  MaxResults?: number;
6678
7268
  /**
7269
+ * @public
6679
7270
  * <p>An array of filters. For each filter, you provide a condition and a match statement. The condition is either
6680
7271
  * <code>IS</code> or <code>IS_NOT</code>, which specifies whether to include or exclude the what-if forecast
6681
7272
  * export jobs that match the statement from the list, respectively. The match statement consists of a key and a
@@ -6716,22 +7307,27 @@ export interface ListWhatIfForecastExportsRequest {
6716
7307
  */
6717
7308
  export interface WhatIfForecastExportSummary {
6718
7309
  /**
7310
+ * @public
6719
7311
  * <p>The Amazon Resource Name (ARN) of the what-if forecast export.</p>
6720
7312
  */
6721
7313
  WhatIfForecastExportArn?: string;
6722
7314
  /**
7315
+ * @public
6723
7316
  * <p>An array of Amazon Resource Names (ARNs) that define the what-if forecasts included in the export.</p>
6724
7317
  */
6725
7318
  WhatIfForecastArns?: string[];
6726
7319
  /**
7320
+ * @public
6727
7321
  * <p>The what-if forecast export name.</p>
6728
7322
  */
6729
7323
  WhatIfForecastExportName?: string;
6730
7324
  /**
7325
+ * @public
6731
7326
  * <p>The path to the Amazon Simple Storage Service (Amazon S3) bucket where the forecast is exported.</p>
6732
7327
  */
6733
7328
  Destination?: DataDestination;
6734
7329
  /**
7330
+ * @public
6735
7331
  * <p>The status of the what-if forecast export. States include:</p>
6736
7332
  * <ul>
6737
7333
  * <li>
@@ -6764,14 +7360,17 @@ export interface WhatIfForecastExportSummary {
6764
7360
  */
6765
7361
  Status?: string;
6766
7362
  /**
7363
+ * @public
6767
7364
  * <p>If an error occurred, an informational message about the error.</p>
6768
7365
  */
6769
7366
  Message?: string;
6770
7367
  /**
7368
+ * @public
6771
7369
  * <p>When the what-if forecast export was created.</p>
6772
7370
  */
6773
7371
  CreationTime?: Date;
6774
7372
  /**
7373
+ * @public
6775
7374
  * <p>The last time the resource was modified. The timestamp depends on the status of the job:</p>
6776
7375
  * <ul>
6777
7376
  * <li>
@@ -6804,10 +7403,12 @@ export interface WhatIfForecastExportSummary {
6804
7403
  */
6805
7404
  export interface ListWhatIfForecastExportsResponse {
6806
7405
  /**
7406
+ * @public
6807
7407
  * <p>An array of <code>WhatIfForecastExports</code> objects that describe the matched forecast exports.</p>
6808
7408
  */
6809
7409
  WhatIfForecastExports?: WhatIfForecastExportSummary[];
6810
7410
  /**
7411
+ * @public
6811
7412
  * <p>If the response is truncated, Forecast returns this token. To retrieve the next set of results, use the token in the next request.</p>
6812
7413
  */
6813
7414
  NextToken?: string;
@@ -6817,15 +7418,18 @@ export interface ListWhatIfForecastExportsResponse {
6817
7418
  */
6818
7419
  export interface ListWhatIfForecastsRequest {
6819
7420
  /**
7421
+ * @public
6820
7422
  * <p>If the result of the previous request was truncated, the response includes a <code>NextToken</code>. To retrieve the next set of results, use the token in the next
6821
7423
  request. Tokens expire after 24 hours.</p>
6822
7424
  */
6823
7425
  NextToken?: string;
6824
7426
  /**
7427
+ * @public
6825
7428
  * <p>The number of items to return in the response.</p>
6826
7429
  */
6827
7430
  MaxResults?: number;
6828
7431
  /**
7432
+ * @public
6829
7433
  * <p>An array of filters. For each filter, you provide a condition and a match statement. The condition is either
6830
7434
  * <code>IS</code> or <code>IS_NOT</code>, which specifies whether to include or exclude the what-if forecast
6831
7435
  * export jobs that match the statement from the list, respectively. The match statement consists of a key and a
@@ -6866,18 +7470,22 @@ export interface ListWhatIfForecastsRequest {
6866
7470
  */
6867
7471
  export interface WhatIfForecastSummary {
6868
7472
  /**
7473
+ * @public
6869
7474
  * <p>The Amazon Resource Name (ARN) of the what-if forecast.</p>
6870
7475
  */
6871
7476
  WhatIfForecastArn?: string;
6872
7477
  /**
7478
+ * @public
6873
7479
  * <p>The name of the what-if forecast.</p>
6874
7480
  */
6875
7481
  WhatIfForecastName?: string;
6876
7482
  /**
7483
+ * @public
6877
7484
  * <p>The Amazon Resource Name (ARN) of the what-if analysis that contains this what-if forecast.</p>
6878
7485
  */
6879
7486
  WhatIfAnalysisArn?: string;
6880
7487
  /**
7488
+ * @public
6881
7489
  * <p>The status of the what-if forecast. States include:</p>
6882
7490
  * <ul>
6883
7491
  * <li>
@@ -6910,14 +7518,17 @@ export interface WhatIfForecastSummary {
6910
7518
  */
6911
7519
  Status?: string;
6912
7520
  /**
7521
+ * @public
6913
7522
  * <p>If an error occurred, an informational message about the error.</p>
6914
7523
  */
6915
7524
  Message?: string;
6916
7525
  /**
7526
+ * @public
6917
7527
  * <p>When the what-if forecast was created.</p>
6918
7528
  */
6919
7529
  CreationTime?: Date;
6920
7530
  /**
7531
+ * @public
6921
7532
  * <p>The last time the resource was modified. The timestamp depends on the status of the job:</p>
6922
7533
  * <ul>
6923
7534
  * <li>
@@ -6950,10 +7561,12 @@ export interface WhatIfForecastSummary {
6950
7561
  */
6951
7562
  export interface ListWhatIfForecastsResponse {
6952
7563
  /**
7564
+ * @public
6953
7565
  * <p>An array of <code>WhatIfForecasts</code> objects that describe the matched forecasts.</p>
6954
7566
  */
6955
7567
  WhatIfForecasts?: WhatIfForecastSummary[];
6956
7568
  /**
7569
+ * @public
6957
7570
  * <p>If the result of the previous request was truncated, the response includes a <code>NextToken</code>. To retrieve the next set of results, use the token in the next
6958
7571
  request. Tokens expire after 24 hours.</p>
6959
7572
  */
@@ -6964,6 +7577,7 @@ export interface ListWhatIfForecastsResponse {
6964
7577
  */
6965
7578
  export interface ResumeResourceRequest {
6966
7579
  /**
7580
+ * @public
6967
7581
  * <p>The Amazon Resource Name (ARN) of the monitor resource to resume.</p>
6968
7582
  */
6969
7583
  ResourceArn: string | undefined;
@@ -6973,6 +7587,7 @@ export interface ResumeResourceRequest {
6973
7587
  */
6974
7588
  export interface StopResourceRequest {
6975
7589
  /**
7590
+ * @public
6976
7591
  * <p>The Amazon Resource Name (ARN) that identifies the resource to stop. The supported ARNs
6977
7592
  * are <code>DatasetImportJobArn</code>, <code>PredictorArn</code>,
6978
7593
  * <code>PredictorBacktestExportJobArn</code>, <code>ForecastArn</code>,
@@ -6986,11 +7601,13 @@ export interface StopResourceRequest {
6986
7601
  */
6987
7602
  export interface TagResourceRequest {
6988
7603
  /**
7604
+ * @public
6989
7605
  * <p>The Amazon Resource Name (ARN) that identifies the resource for which to list the tags.
6990
7606
  * </p>
6991
7607
  */
6992
7608
  ResourceArn: string | undefined;
6993
7609
  /**
7610
+ * @public
6994
7611
  * <p>The tags to add to the resource. A tag is an array of key-value pairs.</p>
6995
7612
  * <p>The following basic restrictions apply to tags:</p>
6996
7613
  * <ul>
@@ -7038,11 +7655,13 @@ export interface TagResourceResponse {
7038
7655
  */
7039
7656
  export interface UntagResourceRequest {
7040
7657
  /**
7658
+ * @public
7041
7659
  * <p>The Amazon Resource Name (ARN) that identifies the resource for which to list the tags.
7042
7660
  * </p>
7043
7661
  */
7044
7662
  ResourceArn: string | undefined;
7045
7663
  /**
7664
+ * @public
7046
7665
  * <p>The keys of the tags to be removed.</p>
7047
7666
  */
7048
7667
  TagKeys: string[] | undefined;
@@ -7057,10 +7676,12 @@ export interface UntagResourceResponse {
7057
7676
  */
7058
7677
  export interface UpdateDatasetGroupRequest {
7059
7678
  /**
7679
+ * @public
7060
7680
  * <p>The ARN of the dataset group.</p>
7061
7681
  */
7062
7682
  DatasetGroupArn: string | undefined;
7063
7683
  /**
7684
+ * @public
7064
7685
  * <p>An array of the Amazon Resource Names (ARNs) of the datasets to add to the dataset
7065
7686
  * group.</p>
7066
7687
  */