@aws-sdk/client-forecast 3.95.0 → 3.100.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (81) hide show
  1. package/CHANGELOG.md +30 -0
  2. package/dist-cjs/Forecast.js +90 -0
  3. package/dist-cjs/commands/CreateMonitorCommand.js +36 -0
  4. package/dist-cjs/commands/DeleteMonitorCommand.js +36 -0
  5. package/dist-cjs/commands/DescribeMonitorCommand.js +36 -0
  6. package/dist-cjs/commands/ListMonitorEvaluationsCommand.js +36 -0
  7. package/dist-cjs/commands/ListMonitorsCommand.js +36 -0
  8. package/dist-cjs/commands/ResumeResourceCommand.js +36 -0
  9. package/dist-cjs/commands/index.js +6 -0
  10. package/dist-cjs/models/models_0.js +156 -3
  11. package/dist-cjs/pagination/ListExplainabilitiesPaginator.js +36 -0
  12. package/dist-cjs/pagination/ListExplainabilityExportsPaginator.js +36 -0
  13. package/dist-cjs/pagination/ListMonitorEvaluationsPaginator.js +36 -0
  14. package/dist-cjs/pagination/ListMonitorsPaginator.js +36 -0
  15. package/dist-cjs/pagination/index.js +4 -0
  16. package/dist-cjs/protocols/Aws_json1_1.js +562 -2
  17. package/dist-cjs/runtimeConfig.js +2 -0
  18. package/dist-es/Forecast.js +90 -0
  19. package/dist-es/commands/CreateMonitorCommand.js +39 -0
  20. package/dist-es/commands/DeleteMonitorCommand.js +39 -0
  21. package/dist-es/commands/DescribeMonitorCommand.js +39 -0
  22. package/dist-es/commands/ListMonitorEvaluationsCommand.js +39 -0
  23. package/dist-es/commands/ListMonitorsCommand.js +39 -0
  24. package/dist-es/commands/ResumeResourceCommand.js +39 -0
  25. package/dist-es/commands/index.js +6 -0
  26. package/dist-es/models/models_0.js +109 -0
  27. package/dist-es/pagination/ListExplainabilitiesPaginator.js +75 -0
  28. package/dist-es/pagination/ListExplainabilityExportsPaginator.js +75 -0
  29. package/dist-es/pagination/ListMonitorEvaluationsPaginator.js +75 -0
  30. package/dist-es/pagination/ListMonitorsPaginator.js +75 -0
  31. package/dist-es/pagination/index.js +4 -0
  32. package/dist-es/protocols/Aws_json1_1.js +642 -2
  33. package/dist-es/runtimeConfig.js +2 -0
  34. package/dist-types/Forecast.d.ts +134 -45
  35. package/dist-types/ForecastClient.d.ts +8 -2
  36. package/dist-types/commands/CreateAutoPredictorCommand.d.ts +7 -5
  37. package/dist-types/commands/CreateDatasetCommand.d.ts +4 -4
  38. package/dist-types/commands/CreateDatasetGroupCommand.d.ts +4 -4
  39. package/dist-types/commands/CreateDatasetImportJobCommand.d.ts +5 -4
  40. package/dist-types/commands/CreateExplainabilityCommand.d.ts +2 -2
  41. package/dist-types/commands/CreateMonitorCommand.d.ts +37 -0
  42. package/dist-types/commands/DeleteDatasetCommand.d.ts +5 -6
  43. package/dist-types/commands/DeleteDatasetGroupCommand.d.ts +2 -2
  44. package/dist-types/commands/DeleteDatasetImportJobCommand.d.ts +3 -2
  45. package/dist-types/commands/DeleteMonitorCommand.d.ts +35 -0
  46. package/dist-types/commands/DescribeDatasetCommand.d.ts +1 -2
  47. package/dist-types/commands/DescribeDatasetGroupCommand.d.ts +1 -1
  48. package/dist-types/commands/DescribeDatasetImportJobCommand.d.ts +1 -1
  49. package/dist-types/commands/DescribeMonitorCommand.d.ts +72 -0
  50. package/dist-types/commands/ListDatasetGroupsCommand.d.ts +5 -4
  51. package/dist-types/commands/ListDatasetImportJobsCommand.d.ts +5 -4
  52. package/dist-types/commands/ListDatasetsCommand.d.ts +3 -3
  53. package/dist-types/commands/ListMonitorEvaluationsCommand.d.ts +38 -0
  54. package/dist-types/commands/ListMonitorsCommand.d.ts +36 -0
  55. package/dist-types/commands/ResumeResourceCommand.d.ts +35 -0
  56. package/dist-types/commands/UpdateDatasetGroupCommand.d.ts +1 -1
  57. package/dist-types/commands/index.d.ts +6 -0
  58. package/dist-types/models/models_0.d.ts +736 -62
  59. package/dist-types/pagination/ListExplainabilitiesPaginator.d.ts +4 -0
  60. package/dist-types/pagination/ListExplainabilityExportsPaginator.d.ts +4 -0
  61. package/dist-types/pagination/ListMonitorEvaluationsPaginator.d.ts +4 -0
  62. package/dist-types/pagination/ListMonitorsPaginator.d.ts +4 -0
  63. package/dist-types/pagination/index.d.ts +4 -0
  64. package/dist-types/protocols/Aws_json1_1.d.ts +18 -0
  65. package/dist-types/ts3.4/Forecast.d.ts +30 -0
  66. package/dist-types/ts3.4/ForecastClient.d.ts +8 -2
  67. package/dist-types/ts3.4/commands/CreateMonitorCommand.d.ts +17 -0
  68. package/dist-types/ts3.4/commands/DeleteMonitorCommand.d.ts +17 -0
  69. package/dist-types/ts3.4/commands/DescribeMonitorCommand.d.ts +17 -0
  70. package/dist-types/ts3.4/commands/ListMonitorEvaluationsCommand.d.ts +17 -0
  71. package/dist-types/ts3.4/commands/ListMonitorsCommand.d.ts +17 -0
  72. package/dist-types/ts3.4/commands/ResumeResourceCommand.d.ts +17 -0
  73. package/dist-types/ts3.4/commands/index.d.ts +6 -0
  74. package/dist-types/ts3.4/models/models_0.d.ts +296 -0
  75. package/dist-types/ts3.4/pagination/ListExplainabilitiesPaginator.d.ts +4 -0
  76. package/dist-types/ts3.4/pagination/ListExplainabilityExportsPaginator.d.ts +4 -0
  77. package/dist-types/ts3.4/pagination/ListMonitorEvaluationsPaginator.d.ts +4 -0
  78. package/dist-types/ts3.4/pagination/ListMonitorsPaginator.d.ts +4 -0
  79. package/dist-types/ts3.4/pagination/index.d.ts +4 -0
  80. package/dist-types/ts3.4/protocols/Aws_json1_1.d.ts +18 -0
  81. package/package.json +6 -6
@@ -4,7 +4,7 @@ import { ForecastServiceException as __BaseException } from "./ForecastServiceEx
4
4
  * <p>Describes an additional dataset. This object is part of the <a>DataConfig</a> object. Forecast supports the Weather Index and Holidays additional datasets.</p>
5
5
  * <p>
6
6
  * <b>Weather Index</b>
7
- * </p>
7
+ * </p>
8
8
  * <p>The Amazon Forecast Weather Index is a built-in dataset that incorporates historical and
9
9
  * projected weather information into your model. The Weather Index supplements your
10
10
  * datasets with over two years of historical weather data and up to 14 days of projected
@@ -12,7 +12,7 @@ import { ForecastServiceException as __BaseException } from "./ForecastServiceEx
12
12
  * Weather Index</a>.</p>
13
13
  * <p>
14
14
  * <b>Holidays</b>
15
- * </p>
15
+ * </p>
16
16
  * <p>Holidays is a built-in dataset that incorporates national holiday information into
17
17
  * your model. It provides native support for the holiday calendars of 66 countries. To
18
18
  * view the holiday calendars, refer to the <a href="http://jollyday.sourceforge.net/data.html">Jollyday</a> library. For more
@@ -28,14 +28,18 @@ export interface AdditionalDataset {
28
28
  /**
29
29
  * <p>
30
30
  * <b>Weather Index</b>
31
- * </p>
31
+ * </p>
32
32
  * <p>To enable the Weather Index, do not specify a value for
33
33
  * <code>Configuration</code>.</p>
34
34
  * <p>
35
35
  * <b>Holidays</b>
36
36
  * </p>
37
- * <p>To enable Holidays, set <code>CountryCode</code> to one of the following two-letter country
38
- * codes:</p>
37
+ *
38
+ * <p>
39
+ * <b>Holidays</b>
40
+ * </p>
41
+ * <p>To enable Holidays, set <code>CountryCode</code> to one of the following two-letter
42
+ * country codes:</p>
39
43
  * <ul>
40
44
  * <li>
41
45
  * <p>"AL" - ALBANIA</p>
@@ -252,17 +256,17 @@ export declare namespace AdditionalDataset {
252
256
  * <p>The following is an example using the RETAIL domain:</p>
253
257
  * <p>
254
258
  * <code>{</code>
255
- * </p>
259
+ * </p>
256
260
  * <p>
257
261
  * <code>"AttributeName": "demand",</code>
258
- * </p>
262
+ * </p>
259
263
  * <p>
260
264
  * <code>"Transformations": {"aggregation": "sum", "middlefill": "zero", "backfill":
261
265
  * "zero"}</code>
262
- * </p>
266
+ * </p>
263
267
  * <p>
264
268
  * <code>}</code>
265
- * </p>
269
+ * </p>
266
270
  */
267
271
  export interface AttributeConfig {
268
272
  /**
@@ -393,6 +397,21 @@ export declare namespace EncryptionConfig {
393
397
  */
394
398
  const filterSensitiveLog: (obj: EncryptionConfig) => any;
395
399
  }
400
+ /**
401
+ * <p>The configuration details for the predictor monitor.</p>
402
+ */
403
+ export interface MonitorConfig {
404
+ /**
405
+ * <p>The name of the monitor resource.</p>
406
+ */
407
+ MonitorName: string | undefined;
408
+ }
409
+ export declare namespace MonitorConfig {
410
+ /**
411
+ * @internal
412
+ */
413
+ const filterSensitiveLog: (obj: MonitorConfig) => any;
414
+ }
396
415
  export declare enum OptimizationMetric {
397
416
  AverageWeightedQuantileLoss = "AverageWeightedQuantileLoss",
398
417
  MAPE = "MAPE",
@@ -455,6 +474,65 @@ export declare namespace Tag {
455
474
  */
456
475
  const filterSensitiveLog: (obj: Tag) => any;
457
476
  }
477
+ export declare enum DayOfWeek {
478
+ FRIDAY = "FRIDAY",
479
+ MONDAY = "MONDAY",
480
+ SATURDAY = "SATURDAY",
481
+ SUNDAY = "SUNDAY",
482
+ THURSDAY = "THURSDAY",
483
+ TUESDAY = "TUESDAY",
484
+ WEDNESDAY = "WEDNESDAY"
485
+ }
486
+ export declare enum Month {
487
+ APRIL = "APRIL",
488
+ AUGUST = "AUGUST",
489
+ DECEMBER = "DECEMBER",
490
+ FEBRUARY = "FEBRUARY",
491
+ JANUARY = "JANUARY",
492
+ JULY = "JULY",
493
+ JUNE = "JUNE",
494
+ MARCH = "MARCH",
495
+ MAY = "MAY",
496
+ NOVEMBER = "NOVEMBER",
497
+ OCTOBER = "OCTOBER",
498
+ SEPTEMBER = "SEPTEMBER"
499
+ }
500
+ /**
501
+ * <p>The time boundary Forecast uses to align and aggregate your data to match your forecast frequency. Provide the unit of time and the time boundary as a key value pair. If you
502
+ * don't provide a time boundary, Forecast uses a set of <a href="https://docs.aws.amazon.com/forecast/latest/dg/data-aggregation.html#default-time-boundaries">Default Time Boundaries</a>.
503
+ * </p>
504
+ *
505
+ * <p>For more information about aggregation,
506
+ * see <a href="https://docs.aws.amazon.com/forecast/latest/dg/data-aggregation.html">Data Aggregation for Different Forecast Frequencies</a>.
507
+ * For more information setting a custom time boundary,
508
+ * see <a href="https://docs.aws.amazon.com/forecast/latest/dg/data-aggregation.html#specifying-time-boundary">Specifying a Time Boundary</a>.
509
+ *
510
+ * </p>
511
+ */
512
+ export interface TimeAlignmentBoundary {
513
+ /**
514
+ * <p>The month to use for time alignment during aggregation. The month must be in uppercase.</p>
515
+ */
516
+ Month?: Month | string;
517
+ /**
518
+ * <p>The day of the month to use for time alignment during aggregation.</p>
519
+ */
520
+ DayOfMonth?: number;
521
+ /**
522
+ * <p>The day of week to use for time alignment during aggregation. The day must be in uppercase.</p>
523
+ */
524
+ DayOfWeek?: DayOfWeek | string;
525
+ /**
526
+ * <p>The hour of day to use for time alignment during aggregation.</p>
527
+ */
528
+ Hour?: number;
529
+ }
530
+ export declare namespace TimeAlignmentBoundary {
531
+ /**
532
+ * @internal
533
+ */
534
+ const filterSensitiveLog: (obj: TimeAlignmentBoundary) => any;
535
+ }
458
536
  export interface CreateAutoPredictorRequest {
459
537
  /**
460
538
  * <p>A unique name for the predictor</p>
@@ -463,6 +541,13 @@ export interface CreateAutoPredictorRequest {
463
541
  /**
464
542
  * <p>The number of time-steps that the model predicts. The forecast horizon is also called
465
543
  * the prediction length.</p>
544
+ * <p>The maximum forecast horizon is the lesser of 500 time-steps or 1/4 of the
545
+ * TARGET_TIME_SERIES dataset length. If you are retraining an existing AutoPredictor, then
546
+ * the maximum forecast horizon is the lesser of 500 time-steps or 1/3 of the
547
+ * TARGET_TIME_SERIES dataset length.</p>
548
+ * <p>If you are upgrading to an AutoPredictor or retraining an existing AutoPredictor, you
549
+ * cannot update the forecast horizon parameter. You can meet this requirement by providing
550
+ * longer time-series in the dataset.</p>
466
551
  */
467
552
  ForecastHorizon?: number;
468
553
  /**
@@ -552,6 +637,19 @@ export interface CreateAutoPredictorRequest {
552
637
  * </ul>
553
638
  */
554
639
  Tags?: Tag[];
640
+ /**
641
+ * <p>The configuration details for predictor monitoring. Provide a name for the monitor resource to enable predictor monitoring.</p>
642
+ * <p>Predictor monitoring allows you to see how your predictor's performance changes over time.
643
+ * For more information, see <a href="https://docs.aws.amazon.com/forecast/latest/dg/predictor-monitoring.html">Predictor Monitoring</a>.</p>
644
+ */
645
+ MonitorConfig?: MonitorConfig;
646
+ /**
647
+ * <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.
648
+ * 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>.
649
+ * If you
650
+ * don't provide a time boundary, Forecast uses a set of <a href="https://docs.aws.amazon.com/forecast/latest/dg/data-aggregation.html#default-time-boundaries">Default Time Boundaries</a>.</p>
651
+ */
652
+ TimeAlignmentBoundary?: TimeAlignmentBoundary;
555
653
  }
556
654
  export declare namespace CreateAutoPredictorRequest {
557
655
  /**
@@ -656,7 +754,7 @@ export declare enum AttributeType {
656
754
  }
657
755
  /**
658
756
  * <p>An attribute of a schema, which defines a dataset field. A schema attribute is required
659
- * for every field in a dataset. The <a>Schema</a> object contains an array of
757
+ * for every field in a dataset. The <a href="https://docs.aws.amazon.com/forecast/latest/dg/API_Schema.html">Schema</a> object contains an array of
660
758
  * <code>SchemaAttribute</code> objects.</p>
661
759
  */
662
760
  export interface SchemaAttribute {
@@ -666,6 +764,7 @@ export interface SchemaAttribute {
666
764
  AttributeName?: string;
667
765
  /**
668
766
  * <p>The data type of the field.</p>
767
+ * <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>
669
768
  */
670
769
  AttributeType?: AttributeType | string;
671
770
  }
@@ -697,12 +796,13 @@ export interface CreateDatasetRequest {
697
796
  DatasetName: string | undefined;
698
797
  /**
699
798
  * <p>The domain associated with the dataset. When you add a dataset to a dataset group, this
700
- * value and the value specified for the <code>Domain</code> parameter of the <a>CreateDatasetGroup</a> operation must match.</p>
799
+ * 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>
701
800
  * <p>The <code>Domain</code> and <code>DatasetType</code> that you choose determine the fields
702
801
  * that must be present in the training data that you import to the dataset. For example, if you
703
802
  * choose the <code>RETAIL</code> domain and <code>TARGET_TIME_SERIES</code> as the
704
803
  * <code>DatasetType</code>, Amazon Forecast requires <code>item_id</code>, <code>timestamp</code>,
705
- * and <code>demand</code> fields to be present in your data. For more information, see <a>howitworks-datasets-groups</a>.</p>
804
+ * and <code>demand</code> fields to be present in your data. For more information, see <a href="https://docs.aws.amazon.com/forecast/latest/dg/howitworks-datasets-groups.html">Importing
805
+ * datasets</a>.</p>
706
806
  */
707
807
  Domain: Domain | string | undefined;
708
808
  /**
@@ -721,7 +821,8 @@ export interface CreateDatasetRequest {
721
821
  * <p>The schema for the dataset. The schema attributes and their order must match the fields in
722
822
  * your data. The dataset <code>Domain</code> and <code>DatasetType</code> that you choose
723
823
  * determine the minimum required fields in your training data. For information about the
724
- * required fields for a specific dataset domain and type, see <a>howitworks-domains-ds-types</a>.</p>
824
+ * required fields for a specific dataset domain and type, see <a href="https://docs.aws.amazon.com/forecast/latest/dg/howitworks-domains-ds-types.html">Dataset Domains and Dataset
825
+ * Types</a>.</p>
725
826
  */
726
827
  Schema: Schema | undefined;
727
828
  /**
@@ -793,13 +894,14 @@ export interface CreateDatasetGroupRequest {
793
894
  DatasetGroupName: string | undefined;
794
895
  /**
795
896
  * <p>The domain associated with the dataset group. When you add a dataset to a dataset group,
796
- * this value and the value specified for the <code>Domain</code> parameter of the <a>CreateDataset</a> operation must match.</p>
897
+ * 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>
898
+ * operation must match.</p>
797
899
  * <p>The <code>Domain</code> and <code>DatasetType</code> that you choose determine the fields
798
900
  * that must be present in training data that you import to a dataset. For example, if you choose
799
901
  * the <code>RETAIL</code> domain and <code>TARGET_TIME_SERIES</code> as the
800
902
  * <code>DatasetType</code>, Amazon Forecast requires that <code>item_id</code>,
801
903
  * <code>timestamp</code>, and <code>demand</code> fields are present in your data. For more
802
- * information, see <a>howitworks-datasets-groups</a>.</p>
904
+ * information, see <a href="https://docs.aws.amazon.com/forecast/latest/dg/howitworks-datasets-groups.html">Dataset groups</a>.</p>
803
905
  */
804
906
  Domain: Domain | string | undefined;
805
907
  /**
@@ -928,7 +1030,8 @@ export interface CreateDatasetImportJobRequest {
928
1030
  * can assume to access the data. The training data must be stored in an Amazon S3 bucket.</p>
929
1031
  * <p>If encryption is used, <code>DataSource</code> must include an AWS Key Management Service (KMS) key and the
930
1032
  * IAM role must allow Amazon Forecast permission to access the key. The KMS key and IAM role must
931
- * match those specified in the <code>EncryptionConfig</code> parameter of the <a>CreateDataset</a> operation.</p>
1033
+ * match those specified in the <code>EncryptionConfig</code> parameter of the <a href="https://docs.aws.amazon.com/forecast/latest/dg/API_CreateDataset.html">CreateDataset</a>
1034
+ * operation.</p>
932
1035
  */
933
1036
  DataSource: DataSource | undefined;
934
1037
  /**
@@ -1052,8 +1155,9 @@ export declare enum TimeSeriesGranularity {
1052
1155
  * <code>TimePointGranularity</code> and <code>TimeSeriesGranularity</code> to “ALL”.
1053
1156
  * When creating Predictor Explainability, Amazon Forecast considers all time series and
1054
1157
  * time points.</p>
1055
- * <p>If you provide a forecast ARN for <code>ResourceArn</code>, you can set <code>TimePointGranularity</code> and
1056
- * <code>TimeSeriesGranularity</code> to either “ALL” or “Specific”.</p>
1158
+ * <p>If you provide a forecast ARN for <code>ResourceArn</code>, you can set
1159
+ * <code>TimePointGranularity</code> and <code>TimeSeriesGranularity</code> to either
1160
+ * “ALL” or “Specific”.</p>
1057
1161
  */
1058
1162
  export interface ExplainabilityConfig {
1059
1163
  /**
@@ -1104,19 +1208,21 @@ export interface CreateExplainabilityRequest {
1104
1208
  */
1105
1209
  Schema?: Schema;
1106
1210
  /**
1107
- * <p>Create an Expainability visualization that is viewable within the AWS console.</p>
1211
+ * <p>Create an Explainability visualization that is viewable within the AWS console.</p>
1108
1212
  */
1109
1213
  EnableVisualization?: boolean;
1110
1214
  /**
1111
1215
  * <p>If <code>TimePointGranularity</code> is set to <code>SPECIFIC</code>, define the first
1112
1216
  * point for the Explainability.</p>
1113
- * <p>Use the following timestamp format: yyyy-MM-ddTHH:mm:ss (example: 2015-01-01T20:00:00)</p>
1217
+ * <p>Use the following timestamp format: yyyy-MM-ddTHH:mm:ss (example:
1218
+ * 2015-01-01T20:00:00)</p>
1114
1219
  */
1115
1220
  StartDateTime?: string;
1116
1221
  /**
1117
1222
  * <p>If <code>TimePointGranularity</code> is set to <code>SPECIFIC</code>, define the last
1118
1223
  * time point for the Explainability.</p>
1119
- * <p>Use the following timestamp format: yyyy-MM-ddTHH:mm:ss (example: 2015-01-01T20:00:00)</p>
1224
+ * <p>Use the following timestamp format: yyyy-MM-ddTHH:mm:ss (example:
1225
+ * 2015-01-01T20:00:00)</p>
1120
1226
  */
1121
1227
  EndDateTime?: string;
1122
1228
  /**
@@ -1272,7 +1378,11 @@ export interface CreateForecastRequest {
1272
1378
  * can currently specify up to 5 quantiles per forecast</b>. Accepted values include
1273
1379
  * <code>0.01 to 0.99</code> (increments of .01 only) and <code>mean</code>. The mean forecast
1274
1380
  * is different from the median (0.50) when the distribution is not symmetric (for example, Beta
1275
- * and Negative Binomial). The default value is <code>["0.1", "0.5", "0.9"]</code>.</p>
1381
+ * and Negative Binomial).
1382
+ * </p>
1383
+ * <p>The default quantiles are the quantiles you specified during predictor creation.
1384
+ * If you didn't specify quantiles, the default values are <code>["0.1", "0.5", "0.9"]</code>.
1385
+ * </p>
1276
1386
  */
1277
1387
  ForecastTypes?: string[];
1278
1388
  /**
@@ -1407,6 +1517,38 @@ export declare namespace CreateForecastExportJobResponse {
1407
1517
  */
1408
1518
  const filterSensitiveLog: (obj: CreateForecastExportJobResponse) => any;
1409
1519
  }
1520
+ export interface CreateMonitorRequest {
1521
+ /**
1522
+ * <p>The name of the monitor resource.</p>
1523
+ */
1524
+ MonitorName: string | undefined;
1525
+ /**
1526
+ * <p>The Amazon Resource Name (ARN) of the predictor to monitor.</p>
1527
+ */
1528
+ ResourceArn: string | undefined;
1529
+ /**
1530
+ * <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>
1531
+ */
1532
+ Tags?: Tag[];
1533
+ }
1534
+ export declare namespace CreateMonitorRequest {
1535
+ /**
1536
+ * @internal
1537
+ */
1538
+ const filterSensitiveLog: (obj: CreateMonitorRequest) => any;
1539
+ }
1540
+ export interface CreateMonitorResponse {
1541
+ /**
1542
+ * <p>The Amazon Resource Name (ARN) of the monitor resource.</p>
1543
+ */
1544
+ MonitorArn?: string;
1545
+ }
1546
+ export declare namespace CreateMonitorResponse {
1547
+ /**
1548
+ * @internal
1549
+ */
1550
+ const filterSensitiveLog: (obj: CreateMonitorResponse) => any;
1551
+ }
1410
1552
  export declare enum AutoMLOverrideStrategy {
1411
1553
  AccuracyOptimized = "AccuracyOptimized",
1412
1554
  LatencyOptimized = "LatencyOptimized"
@@ -2461,6 +2603,18 @@ export declare namespace DeleteForecastExportJobRequest {
2461
2603
  */
2462
2604
  const filterSensitiveLog: (obj: DeleteForecastExportJobRequest) => any;
2463
2605
  }
2606
+ export interface DeleteMonitorRequest {
2607
+ /**
2608
+ * <p>The Amazon Resource Name (ARN) of the monitor resource to delete.</p>
2609
+ */
2610
+ MonitorArn: string | undefined;
2611
+ }
2612
+ export declare namespace DeleteMonitorRequest {
2613
+ /**
2614
+ * @internal
2615
+ */
2616
+ const filterSensitiveLog: (obj: DeleteMonitorRequest) => any;
2617
+ }
2464
2618
  export interface DeletePredictorRequest {
2465
2619
  /**
2466
2620
  * <p>The Amazon Resource Name (ARN) of the predictor to delete.</p>
@@ -2523,13 +2677,13 @@ export interface ExplainabilityInfo {
2523
2677
  * <ul>
2524
2678
  * <li>
2525
2679
  * <p>
2526
- * <code>ACTIVE</code>
2527
- * </p>
2680
+ * <code>ACTIVE</code>
2681
+ * </p>
2528
2682
  * </li>
2529
2683
  * <li>
2530
2684
  * <p>
2531
2685
  * <code>CREATE_PENDING</code>, <code>CREATE_IN_PROGRESS</code>,
2532
- * <code>CREATE_FAILED</code>
2686
+ * <code>CREATE_FAILED</code>
2533
2687
  * </p>
2534
2688
  * </li>
2535
2689
  * <li>
@@ -2540,7 +2694,7 @@ export interface ExplainabilityInfo {
2540
2694
  * <li>
2541
2695
  * <p>
2542
2696
  * <code>DELETE_PENDING</code>, <code>DELETE_IN_PROGRESS</code>,
2543
- * <code>DELETE_FAILED</code>
2697
+ * <code>DELETE_FAILED</code>
2544
2698
  * </p>
2545
2699
  * </li>
2546
2700
  * </ul>
@@ -2553,6 +2707,52 @@ export declare namespace ExplainabilityInfo {
2553
2707
  */
2554
2708
  const filterSensitiveLog: (obj: ExplainabilityInfo) => any;
2555
2709
  }
2710
+ /**
2711
+ * <p>Provides information about the monitor resource.</p>
2712
+ */
2713
+ export interface MonitorInfo {
2714
+ /**
2715
+ * <p>The Amazon Resource Name (ARN) of the monitor resource.</p>
2716
+ */
2717
+ MonitorArn?: string;
2718
+ /**
2719
+ * <p>The status of the monitor. States include:</p>
2720
+ * <ul>
2721
+ * <li>
2722
+ * <p>
2723
+ * <code>ACTIVE</code>
2724
+ * </p>
2725
+ * </li>
2726
+ * <li>
2727
+ * <p>
2728
+ * <code>ACTIVE_STOPPING</code>, <code>ACTIVE_STOPPED</code>
2729
+ * </p>
2730
+ * </li>
2731
+ * <li>
2732
+ * <p>
2733
+ * <code>UPDATE_IN_PROGRESS</code>
2734
+ * </p>
2735
+ * </li>
2736
+ * <li>
2737
+ * <p>
2738
+ * <code>CREATE_PENDING</code>, <code>CREATE_IN_PROGRESS</code>, <code>CREATE_FAILED</code>
2739
+ * </p>
2740
+ * </li>
2741
+ * <li>
2742
+ * <p>
2743
+ * <code>DELETE_PENDING</code>, <code>DELETE_IN_PROGRESS</code>, <code>DELETE_FAILED</code>
2744
+ * </p>
2745
+ * </li>
2746
+ * </ul>
2747
+ */
2748
+ Status?: string;
2749
+ }
2750
+ export declare namespace MonitorInfo {
2751
+ /**
2752
+ * @internal
2753
+ */
2754
+ const filterSensitiveLog: (obj: MonitorInfo) => any;
2755
+ }
2556
2756
  export declare enum State {
2557
2757
  Active = "Active",
2558
2758
  Deleted = "Deleted"
@@ -2604,7 +2804,8 @@ export interface DescribeAutoPredictorResponse {
2604
2804
  */
2605
2805
  ForecastFrequency?: string;
2606
2806
  /**
2607
- * <p>An array of dimension (field) names that specify the attributes used to group your time series.</p>
2807
+ * <p>An array of dimension (field) names that specify the attributes used to group your
2808
+ * time series.</p>
2608
2809
  */
2609
2810
  ForecastDimensions?: string[];
2610
2811
  /**
@@ -2637,8 +2838,8 @@ export interface DescribeAutoPredictorResponse {
2637
2838
  * <ul>
2638
2839
  * <li>
2639
2840
  * <p>
2640
- * <code>ACTIVE</code>
2641
- * </p>
2841
+ * <code>ACTIVE</code>
2842
+ * </p>
2642
2843
  * </li>
2643
2844
  * <li>
2644
2845
  * <p>
@@ -2704,6 +2905,14 @@ export interface DescribeAutoPredictorResponse {
2704
2905
  * <p>Provides the status and ARN of the Predictor Explainability.</p>
2705
2906
  */
2706
2907
  ExplainabilityInfo?: ExplainabilityInfo;
2908
+ /**
2909
+ * <p>A object with the Amazon Resource Name (ARN) and status of the monitor resource.</p>
2910
+ */
2911
+ MonitorInfo?: MonitorInfo;
2912
+ /**
2913
+ * <p>The time boundary Forecast uses when aggregating data.</p>
2914
+ */
2915
+ TimeAlignmentBoundary?: TimeAlignmentBoundary;
2707
2916
  }
2708
2917
  export declare namespace DescribeAutoPredictorResponse {
2709
2918
  /**
@@ -2785,9 +2994,9 @@ export interface DescribeDatasetResponse {
2785
2994
  * </li>
2786
2995
  * </ul>
2787
2996
  * <p>The <code>UPDATE</code> states apply while data is imported to the dataset from a call to
2788
- * the <a>CreateDatasetImportJob</a> operation and reflect the status of the dataset
2789
- * import job. For example, when the import job status is <code>CREATE_IN_PROGRESS</code>, the
2790
- * status of the dataset is <code>UPDATE_IN_PROGRESS</code>.</p>
2997
+ * the <a href="https://docs.aws.amazon.com/forecast/latest/dg/API_CreateDatasetImportJob.html">CreateDatasetImportJob</a> operation and reflect the status of the dataset import job.
2998
+ * For example, when the import job status is <code>CREATE_IN_PROGRESS</code>, the status of the
2999
+ * dataset is <code>UPDATE_IN_PROGRESS</code>.</p>
2791
3000
  * <note>
2792
3001
  * <p>The <code>Status</code> of the dataset must be <code>ACTIVE</code> before you can import
2793
3002
  * training data.</p>
@@ -2802,8 +3011,9 @@ export interface DescribeDatasetResponse {
2802
3011
  * <p>When you create a dataset, <code>LastModificationTime</code> is the same as
2803
3012
  * <code>CreationTime</code>. While data is being imported to the dataset,
2804
3013
  * <code>LastModificationTime</code> is the current time of the <code>DescribeDataset</code>
2805
- * call. After a <a>CreateDatasetImportJob</a> operation has finished,
2806
- * <code>LastModificationTime</code> is when the import job completed or failed.</p>
3014
+ * call. After a <a href="https://docs.aws.amazon.com/forecast/latest/dg/API_CreateDatasetImportJob.html">CreateDatasetImportJob</a>
3015
+ * operation has finished, <code>LastModificationTime</code> is when the import job completed or
3016
+ * failed.</p>
2807
3017
  */
2808
3018
  LastModificationTime?: Date;
2809
3019
  }
@@ -2870,7 +3080,8 @@ export interface DescribeDatasetGroupResponse {
2870
3080
  * </p>
2871
3081
  * </li>
2872
3082
  * </ul>
2873
- * <p>The <code>UPDATE</code> states apply when you call the <a>UpdateDatasetGroup</a> operation.</p>
3083
+ * <p>The <code>UPDATE</code> states apply when you call the <a href="https://docs.aws.amazon.com/forecast/latest/dg/API_UpdateDatasetGroup.html">UpdateDatasetGroup</a>
3084
+ * operation.</p>
2874
3085
  * <note>
2875
3086
  * <p>The <code>Status</code> of the dataset group must be <code>ACTIVE</code> before you can
2876
3087
  * use the dataset group to create a predictor.</p>
@@ -2882,7 +3093,7 @@ export interface DescribeDatasetGroupResponse {
2882
3093
  */
2883
3094
  CreationTime?: Date;
2884
3095
  /**
2885
- * <p>When the dataset group was created or last updated from a call to the <a>UpdateDatasetGroup</a> operation. While the dataset group is being updated,
3096
+ * <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,
2886
3097
  * <code>LastModificationTime</code> is the current time of the
2887
3098
  * <code>DescribeDatasetGroup</code> call.</p>
2888
3099
  */
@@ -2908,7 +3119,7 @@ export declare namespace DescribeDatasetImportJobRequest {
2908
3119
  }
2909
3120
  /**
2910
3121
  * <p>Provides statistics for each data field imported into to an Amazon Forecast dataset with
2911
- * the <a>CreateDatasetImportJob</a> operation.</p>
3122
+ * the <a href="https://docs.aws.amazon.com/forecast/latest/dg/API_CreateDatasetImportJob.html">CreateDatasetImportJob</a> operation.</p>
2912
3123
  */
2913
3124
  export interface Statistics {
2914
3125
  /**
@@ -2918,17 +3129,17 @@ export interface Statistics {
2918
3129
  Count?: number;
2919
3130
  /**
2920
3131
  * <p>The number of distinct values in the field. If the response value is -1, refer to
2921
- * <code>CountDistinctLong</code>.</p>
3132
+ * <code>CountDistinctLong</code>.</p>
2922
3133
  */
2923
3134
  CountDistinct?: number;
2924
3135
  /**
2925
3136
  * <p>The number of null values in the field. If the response value is -1, refer to
2926
- * <code>CountNullLong</code>.</p>
3137
+ * <code>CountNullLong</code>.</p>
2927
3138
  */
2928
3139
  CountNull?: number;
2929
3140
  /**
2930
- * <p>The number of NAN (not a number) values in the field. If the response value is -1, refer to
2931
- * <code>CountNanLong</code>.</p>
3141
+ * <p>The number of NAN (not a number) values in the field. If the response value is -1, refer
3142
+ * to <code>CountNanLong</code>.</p>
2932
3143
  */
2933
3144
  CountNan?: number;
2934
3145
  /**
@@ -3178,8 +3389,8 @@ export interface DescribeExplainabilityResponse {
3178
3389
  * <ul>
3179
3390
  * <li>
3180
3391
  * <p>
3181
- * <code>ACTIVE</code>
3182
- * </p>
3392
+ * <code>ACTIVE</code>
3393
+ * </p>
3183
3394
  * </li>
3184
3395
  * <li>
3185
3396
  * <p>
@@ -3279,8 +3490,8 @@ export interface DescribeExplainabilityExportResponse {
3279
3490
  * <ul>
3280
3491
  * <li>
3281
3492
  * <p>
3282
- * <code>ACTIVE</code>
3283
- * </p>
3493
+ * <code>ACTIVE</code>
3494
+ * </p>
3284
3495
  * </li>
3285
3496
  * <li>
3286
3497
  * <p>
@@ -3555,6 +3766,121 @@ export declare namespace DescribeForecastExportJobResponse {
3555
3766
  */
3556
3767
  const filterSensitiveLog: (obj: DescribeForecastExportJobResponse) => any;
3557
3768
  }
3769
+ export interface DescribeMonitorRequest {
3770
+ /**
3771
+ * <p>The Amazon Resource Name (ARN) of the monitor resource to describe.</p>
3772
+ */
3773
+ MonitorArn: string | undefined;
3774
+ }
3775
+ export declare namespace DescribeMonitorRequest {
3776
+ /**
3777
+ * @internal
3778
+ */
3779
+ const filterSensitiveLog: (obj: DescribeMonitorRequest) => any;
3780
+ }
3781
+ /**
3782
+ * <p>An individual metric that you can use for comparison as you evaluate your monitoring results.</p>
3783
+ */
3784
+ export interface BaselineMetric {
3785
+ /**
3786
+ * <p>The name of the metric.</p>
3787
+ */
3788
+ Name?: string;
3789
+ /**
3790
+ * <p>The value for the metric.</p>
3791
+ */
3792
+ Value?: number;
3793
+ }
3794
+ export declare namespace BaselineMetric {
3795
+ /**
3796
+ * @internal
3797
+ */
3798
+ const filterSensitiveLog: (obj: BaselineMetric) => any;
3799
+ }
3800
+ /**
3801
+ * <p>Metrics you can use as a baseline for comparison purposes. Use these metrics when you interpret monitoring results for an auto predictor.</p>
3802
+ */
3803
+ export interface PredictorBaseline {
3804
+ /**
3805
+ * <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
3806
+ * use your predictor and the metrics change.</p>
3807
+ */
3808
+ BaselineMetrics?: BaselineMetric[];
3809
+ }
3810
+ export declare namespace PredictorBaseline {
3811
+ /**
3812
+ * @internal
3813
+ */
3814
+ const filterSensitiveLog: (obj: PredictorBaseline) => any;
3815
+ }
3816
+ /**
3817
+ * <p>Metrics you can use as a baseline for comparison purposes. Use these metrics when you interpret monitoring results for an auto predictor.</p>
3818
+ */
3819
+ export interface Baseline {
3820
+ /**
3821
+ * <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
3822
+ * use your predictor and the metrics change.</p>
3823
+ */
3824
+ PredictorBaseline?: PredictorBaseline;
3825
+ }
3826
+ export declare namespace Baseline {
3827
+ /**
3828
+ * @internal
3829
+ */
3830
+ const filterSensitiveLog: (obj: Baseline) => any;
3831
+ }
3832
+ export interface DescribeMonitorResponse {
3833
+ /**
3834
+ * <p>The name of the monitor.</p>
3835
+ */
3836
+ MonitorName?: string;
3837
+ /**
3838
+ * <p>The Amazon Resource Name (ARN) of the monitor resource described.</p>
3839
+ */
3840
+ MonitorArn?: string;
3841
+ /**
3842
+ * <p>The Amazon Resource Name (ARN) of the auto predictor being monitored.</p>
3843
+ */
3844
+ ResourceArn?: string;
3845
+ /**
3846
+ * <p>The status of the monitor resource.</p>
3847
+ */
3848
+ Status?: string;
3849
+ /**
3850
+ * <p>The timestamp of the latest evaluation completed by the monitor.</p>
3851
+ */
3852
+ LastEvaluationTime?: Date;
3853
+ /**
3854
+ * <p>The state of the monitor's latest evaluation.</p>
3855
+ */
3856
+ LastEvaluationState?: string;
3857
+ /**
3858
+ * <p>Metrics you can use as a baseline for comparison purposes. Use these values you interpret monitoring results for an auto predictor.</p>
3859
+ */
3860
+ Baseline?: Baseline;
3861
+ /**
3862
+ * <p>An error message, if any, for the monitor.</p>
3863
+ */
3864
+ Message?: string;
3865
+ /**
3866
+ * <p>The timestamp for when the monitor resource was created.</p>
3867
+ */
3868
+ CreationTime?: Date;
3869
+ /**
3870
+ * <p>The timestamp of the latest modification to the monitor.</p>
3871
+ */
3872
+ LastModificationTime?: Date;
3873
+ /**
3874
+ * <p>The estimated number of minutes remaining before the monitor resource finishes its current evaluation.</p>
3875
+ */
3876
+ EstimatedEvaluationTimeRemainingInMinutes?: number;
3877
+ }
3878
+ export declare namespace DescribeMonitorResponse {
3879
+ /**
3880
+ * @internal
3881
+ */
3882
+ const filterSensitiveLog: (obj: DescribeMonitorResponse) => any;
3883
+ }
3558
3884
  export interface DescribePredictorRequest {
3559
3885
  /**
3560
3886
  * <p>The Amazon Resource Name (ARN) of the predictor that you want information about.</p>
@@ -4158,9 +4484,9 @@ export declare namespace ListDatasetGroupsRequest {
4158
4484
  const filterSensitiveLog: (obj: ListDatasetGroupsRequest) => any;
4159
4485
  }
4160
4486
  /**
4161
- * <p>Provides a summary of the dataset group properties used in the <a>ListDatasetGroups</a> operation. To get the complete set of properties, call the
4162
- * <a>DescribeDatasetGroup</a> operation, and provide the
4163
- * <code>DatasetGroupArn</code>.</p>
4487
+ * <p>Provides a summary of the dataset group properties used in the <a href="https://docs.aws.amazon.com/forecast/latest/dg/API_ListDatasetGroups.html">ListDatasetGroups</a> operation. To
4488
+ * get the complete set of properties, call the <a href="https://docs.aws.amazon.com/forecast/latest/dg/API_DescribeDatasetGroup.html">DescribeDatasetGroup</a>
4489
+ * operation, and provide the <code>DatasetGroupArn</code>.</p>
4164
4490
  */
4165
4491
  export interface DatasetGroupSummary {
4166
4492
  /**
@@ -4176,7 +4502,7 @@ export interface DatasetGroupSummary {
4176
4502
  */
4177
4503
  CreationTime?: Date;
4178
4504
  /**
4179
- * <p>When the dataset group was created or last updated from a call to the <a>UpdateDatasetGroup</a> operation. While the dataset group is being updated,
4505
+ * <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,
4180
4506
  * <code>LastModificationTime</code> is the current time of the <code>ListDatasetGroups</code>
4181
4507
  * call.</p>
4182
4508
  */
@@ -4276,8 +4602,7 @@ export interface ListDatasetImportJobsRequest {
4276
4602
  * <p>For example, to list all dataset import jobs whose status is ACTIVE, you specify the
4277
4603
  * following filter:</p>
4278
4604
  * <p>
4279
- * <code>"Filters": [ { "Condition": "IS", "Key": "Status", "Value": "ACTIVE" }
4280
- * ]</code>
4605
+ * <code>"Filters": [ { "Condition": "IS", "Key": "Status", "Value": "ACTIVE" } ]</code>
4281
4606
  * </p>
4282
4607
  */
4283
4608
  Filters?: Filter[];
@@ -4289,8 +4614,8 @@ export declare namespace ListDatasetImportJobsRequest {
4289
4614
  const filterSensitiveLog: (obj: ListDatasetImportJobsRequest) => any;
4290
4615
  }
4291
4616
  /**
4292
- * <p>Provides a summary of the dataset import job properties used in the <a>ListDatasetImportJobs</a> operation. To get the complete set of properties, call the
4293
- * <a>DescribeDatasetImportJob</a> operation, and provide the
4617
+ * <p>Provides a summary of the dataset import job properties used in the <a href="https://docs.aws.amazon.com/forecast/latest/dg/API_ListDatasetImportJobs.html">ListDatasetImportJobs</a> operation. To get the complete set of properties, call the
4618
+ * <a href="https://docs.aws.amazon.com/forecast/latest/dg/API_DescribeDatasetImportJob.html">DescribeDatasetImportJob</a> operation, and provide the
4294
4619
  * <code>DatasetImportJobArn</code>.</p>
4295
4620
  */
4296
4621
  export interface DatasetImportJobSummary {
@@ -4415,9 +4740,9 @@ export declare namespace ListDatasetsRequest {
4415
4740
  const filterSensitiveLog: (obj: ListDatasetsRequest) => any;
4416
4741
  }
4417
4742
  /**
4418
- * <p>Provides a summary of the dataset properties used in the <a>ListDatasets</a>
4419
- * operation. To get the complete set of properties, call the <a>DescribeDataset</a>
4420
- * operation, and provide the <code>DatasetArn</code>.</p>
4743
+ * <p>Provides a summary of the dataset properties used in the <a href="https://docs.aws.amazon.com/forecast/latest/dg/API_ListDatasets.html">ListDatasets</a> operation. To get the
4744
+ * complete set of properties, call the <a href="https://docs.aws.amazon.com/forecast/latest/dg/API_DescribeDataset.html">DescribeDataset</a> operation, and
4745
+ * provide the <code>DatasetArn</code>.</p>
4421
4746
  */
4422
4747
  export interface DatasetSummary {
4423
4748
  /**
@@ -4444,8 +4769,8 @@ export interface DatasetSummary {
4444
4769
  * <p>When you create a dataset, <code>LastModificationTime</code> is the same as
4445
4770
  * <code>CreationTime</code>. While data is being imported to the dataset,
4446
4771
  * <code>LastModificationTime</code> is the current time of the <code>ListDatasets</code> call.
4447
- * After a <a>CreateDatasetImportJob</a> operation has finished,
4448
- * <code>LastModificationTime</code> is when the import job completed or failed.</p>
4772
+ * After a <a href="https://docs.aws.amazon.com/forecast/latest/dg/API_CreateDatasetImportJob.html">CreateDatasetImportJob</a> operation has finished, <code>LastModificationTime</code> is
4773
+ * when the import job completed or failed.</p>
4449
4774
  */
4450
4775
  LastModificationTime?: Date;
4451
4776
  }
@@ -4545,8 +4870,8 @@ export interface ExplainabilitySummary {
4545
4870
  * <ul>
4546
4871
  * <li>
4547
4872
  * <p>
4548
- * <code>ACTIVE</code>
4549
- * </p>
4873
+ * <code>ACTIVE</code>
4874
+ * </p>
4550
4875
  * </li>
4551
4876
  * <li>
4552
4877
  * <p>
@@ -4698,8 +5023,8 @@ export interface ExplainabilityExportSummary {
4698
5023
  * <ul>
4699
5024
  * <li>
4700
5025
  * <p>
4701
- * <code>ACTIVE</code>
4702
- * </p>
5026
+ * <code>ACTIVE</code>
5027
+ * </p>
4703
5028
  * </li>
4704
5029
  * <li>
4705
5030
  * <p>
@@ -5112,6 +5437,343 @@ export declare namespace ListForecastsResponse {
5112
5437
  */
5113
5438
  const filterSensitiveLog: (obj: ListForecastsResponse) => any;
5114
5439
  }
5440
+ export interface ListMonitorEvaluationsRequest {
5441
+ /**
5442
+ * <p>If the result of the previous request was truncated, the response includes a
5443
+ * <code>NextToken</code>. To retrieve the next set of results, use the token in the next
5444
+ * request. Tokens expire after 24 hours.</p>
5445
+ */
5446
+ NextToken?: string;
5447
+ /**
5448
+ * <p>The maximum number of monitoring results to return.</p>
5449
+ */
5450
+ MaxResults?: number;
5451
+ /**
5452
+ * <p>The Amazon Resource Name (ARN) of the monitor resource to get results from.</p>
5453
+ */
5454
+ MonitorArn: string | undefined;
5455
+ /**
5456
+ * <p>An array of filters. For each filter, provide a condition and a match statement. The
5457
+ * condition is either <code>IS</code> or <code>IS_NOT</code>, which specifies whether to
5458
+ * include or exclude the resources that match the statement from the list. The match
5459
+ * statement consists of a key and a value.</p>
5460
+ * <p>
5461
+ * <b>Filter properties</b>
5462
+ * </p>
5463
+ * <ul>
5464
+ * <li>
5465
+ * <p>
5466
+ * <code>Condition</code> - The condition to apply. Valid values are
5467
+ * <code>IS</code> and <code>IS_NOT</code>.</p>
5468
+ * </li>
5469
+ * <li>
5470
+ * <p>
5471
+ * <code>Key</code> - The name of the parameter to filter on. The only valid value is
5472
+ * <code>EvaluationState</code>.</p>
5473
+ * </li>
5474
+ * <li>
5475
+ * <p>
5476
+ * <code>Value</code> - The value to match. Valid values are only <code>SUCCESS</code> or <code>FAILURE</code>.</p>
5477
+ * </li>
5478
+ * </ul>
5479
+ * <p>For example, to list only successful monitor evaluations, you would specify:</p>
5480
+ * <p>
5481
+ * <code>"Filters": [ { "Condition": "IS", "Key": "EvaluationState", "Value": "SUCCESS" } ]</code>
5482
+ * </p>
5483
+ */
5484
+ Filters?: Filter[];
5485
+ }
5486
+ export declare namespace ListMonitorEvaluationsRequest {
5487
+ /**
5488
+ * @internal
5489
+ */
5490
+ const filterSensitiveLog: (obj: ListMonitorEvaluationsRequest) => any;
5491
+ }
5492
+ /**
5493
+ * <p>An individual metric Forecast calculated when monitoring predictor usage. You can compare the value for this metric to the metric's value in the <a>Baseline</a> to see how your predictor's performance is changing.</p>
5494
+ * <p>For more information about metrics generated by Forecast see <a href="https://docs.aws.amazon.com/forecast/latest/dg/metrics.html">Evaluating Predictor Accuracy</a>
5495
+ * </p>
5496
+ */
5497
+ export interface MetricResult {
5498
+ /**
5499
+ * <p>The name of the metric.</p>
5500
+ */
5501
+ MetricName?: string;
5502
+ /**
5503
+ * <p>The value for the metric.</p>
5504
+ */
5505
+ MetricValue?: number;
5506
+ }
5507
+ export declare namespace MetricResult {
5508
+ /**
5509
+ * @internal
5510
+ */
5511
+ const filterSensitiveLog: (obj: MetricResult) => any;
5512
+ }
5513
+ /**
5514
+ * <p>The source of the data the monitor used during the evaluation.</p>
5515
+ */
5516
+ export interface MonitorDataSource {
5517
+ /**
5518
+ * <p>The Amazon Resource Name (ARN) of the dataset import job used to import the data that initiated the monitor evaluation.</p>
5519
+ */
5520
+ DatasetImportJobArn?: string;
5521
+ /**
5522
+ * <p>The Amazon Resource Name (ARN) of the forecast the monitor used during the evaluation.</p>
5523
+ */
5524
+ ForecastArn?: string;
5525
+ /**
5526
+ * <p>The Amazon Resource Name (ARN) of the predictor resource you are monitoring.</p>
5527
+ */
5528
+ PredictorArn?: string;
5529
+ }
5530
+ export declare namespace MonitorDataSource {
5531
+ /**
5532
+ * @internal
5533
+ */
5534
+ const filterSensitiveLog: (obj: MonitorDataSource) => any;
5535
+ }
5536
+ /**
5537
+ * <p>Provides details about a predictor event, such as a retraining.</p>
5538
+ */
5539
+ export interface PredictorEvent {
5540
+ /**
5541
+ * <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>
5542
+ */
5543
+ Detail?: string;
5544
+ /**
5545
+ * <p>The timestamp for when the event occurred.</p>
5546
+ */
5547
+ Datetime?: Date;
5548
+ }
5549
+ export declare namespace PredictorEvent {
5550
+ /**
5551
+ * @internal
5552
+ */
5553
+ const filterSensitiveLog: (obj: PredictorEvent) => any;
5554
+ }
5555
+ /**
5556
+ * <p>Describes the results of a monitor evaluation.</p>
5557
+ */
5558
+ export interface PredictorMonitorEvaluation {
5559
+ /**
5560
+ * <p>The Amazon Resource Name (ARN) of the resource to monitor.</p>
5561
+ */
5562
+ ResourceArn?: string;
5563
+ /**
5564
+ * <p>The Amazon Resource Name (ARN) of the monitor resource.</p>
5565
+ */
5566
+ MonitorArn?: string;
5567
+ /**
5568
+ * <p>The timestamp that indicates when the monitor evaluation was started. </p>
5569
+ */
5570
+ EvaluationTime?: Date;
5571
+ /**
5572
+ * <p>The status of the monitor evaluation. The state can be <code>SUCCESS</code> or <code>FAILURE</code>.</p>
5573
+ */
5574
+ EvaluationState?: string;
5575
+ /**
5576
+ * <p>The timestamp that indicates the start of the window that is used for monitor evaluation.</p>
5577
+ */
5578
+ WindowStartDatetime?: Date;
5579
+ /**
5580
+ * <p>The timestamp that indicates the end of the window that is used for monitor evaluation.</p>
5581
+ */
5582
+ WindowEndDatetime?: Date;
5583
+ /**
5584
+ * <p>Provides details about a predictor event, such as a retraining.</p>
5585
+ */
5586
+ PredictorEvent?: PredictorEvent;
5587
+ /**
5588
+ * <p>The source of the data the monitor resource used during the evaluation.</p>
5589
+ */
5590
+ MonitorDataSource?: MonitorDataSource;
5591
+ /**
5592
+ * <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>
5593
+ */
5594
+ MetricResults?: MetricResult[];
5595
+ /**
5596
+ * <p>The number of items considered during the evaluation.</p>
5597
+ */
5598
+ NumItemsEvaluated?: number;
5599
+ /**
5600
+ * <p>Information about any errors that may have occurred during the monitor evaluation.</p>
5601
+ */
5602
+ Message?: string;
5603
+ }
5604
+ export declare namespace PredictorMonitorEvaluation {
5605
+ /**
5606
+ * @internal
5607
+ */
5608
+ const filterSensitiveLog: (obj: PredictorMonitorEvaluation) => any;
5609
+ }
5610
+ export interface ListMonitorEvaluationsResponse {
5611
+ /**
5612
+ * <p>If the response is truncated, Amazon Forecast returns this token. To retrieve the next set of
5613
+ * results, use the token in the next request. Tokens expire after 24 hours.</p>
5614
+ */
5615
+ NextToken?: string;
5616
+ /**
5617
+ * <p>The monitoring results and predictor events collected by the monitor resource during different windows of time.</p>
5618
+ * <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>
5619
+ */
5620
+ PredictorMonitorEvaluations?: PredictorMonitorEvaluation[];
5621
+ }
5622
+ export declare namespace ListMonitorEvaluationsResponse {
5623
+ /**
5624
+ * @internal
5625
+ */
5626
+ const filterSensitiveLog: (obj: ListMonitorEvaluationsResponse) => any;
5627
+ }
5628
+ export interface ListMonitorsRequest {
5629
+ /**
5630
+ * <p>If the result of the previous request was truncated, the response includes a
5631
+ * <code>NextToken</code>. To retrieve the next set of results, use the token in the next
5632
+ * request. Tokens expire after 24 hours.</p>
5633
+ */
5634
+ NextToken?: string;
5635
+ /**
5636
+ * <p>The maximum number of monitors to include in the response.</p>
5637
+ */
5638
+ MaxResults?: number;
5639
+ /**
5640
+ * <p>An array of filters. For each filter, provide a condition and a match statement. The
5641
+ * condition is either <code>IS</code> or <code>IS_NOT</code>, which specifies whether to
5642
+ * include or exclude the resources that match the statement from the list. The match
5643
+ * statement consists of a key and a value.</p>
5644
+ * <p>
5645
+ * <b>Filter properties</b>
5646
+ * </p>
5647
+ * <ul>
5648
+ * <li>
5649
+ * <p>
5650
+ * <code>Condition</code> - The condition to apply. Valid values are
5651
+ * <code>IS</code> and <code>IS_NOT</code>.</p>
5652
+ * </li>
5653
+ * <li>
5654
+ * <p>
5655
+ * <code>Key</code> - The name of the parameter to filter on. The only valid value is
5656
+ * <code>Status</code>.</p>
5657
+ * </li>
5658
+ * <li>
5659
+ * <p>
5660
+ * <code>Value</code> - The value to match.</p>
5661
+ * </li>
5662
+ * </ul>
5663
+ * <p>For example, to list all monitors who's status is ACTIVE, you would specify:</p>
5664
+ * <p>
5665
+ * <code>"Filters": [ { "Condition": "IS", "Key": "Status", "Value": "ACTIVE" } ]</code>
5666
+ * </p>
5667
+ */
5668
+ Filters?: Filter[];
5669
+ }
5670
+ export declare namespace ListMonitorsRequest {
5671
+ /**
5672
+ * @internal
5673
+ */
5674
+ const filterSensitiveLog: (obj: ListMonitorsRequest) => any;
5675
+ }
5676
+ /**
5677
+ * <p>Provides a summary of the monitor properties used in the <a>ListMonitors</a> operation. To get a complete set of properties,
5678
+ * call the <a>DescribeMonitor</a> operation, and provide the listed
5679
+ * <code>MonitorArn</code>.</p>
5680
+ */
5681
+ export interface MonitorSummary {
5682
+ /**
5683
+ * <p>The Amazon Resource Name (ARN) of the monitor resource.</p>
5684
+ */
5685
+ MonitorArn?: string;
5686
+ /**
5687
+ * <p>The name of the monitor resource.</p>
5688
+ */
5689
+ MonitorName?: string;
5690
+ /**
5691
+ * <p>The Amazon Resource Name (ARN) of the predictor being monitored.</p>
5692
+ */
5693
+ ResourceArn?: string;
5694
+ /**
5695
+ * <p>The status of the monitor. States include:</p>
5696
+ * <ul>
5697
+ * <li>
5698
+ * <p>
5699
+ * <code>ACTIVE</code>
5700
+ * </p>
5701
+ * </li>
5702
+ * <li>
5703
+ * <p>
5704
+ * <code>ACTIVE_STOPPING</code>, <code>ACTIVE_STOPPED</code>
5705
+ * </p>
5706
+ * </li>
5707
+ * <li>
5708
+ * <p>
5709
+ * <code>UPDATE_IN_PROGRESS</code>
5710
+ * </p>
5711
+ * </li>
5712
+ * <li>
5713
+ * <p>
5714
+ * <code>CREATE_PENDING</code>, <code>CREATE_IN_PROGRESS</code>, <code>CREATE_FAILED</code>
5715
+ * </p>
5716
+ * </li>
5717
+ * <li>
5718
+ * <p>
5719
+ * <code>DELETE_PENDING</code>, <code>DELETE_IN_PROGRESS</code>, <code>DELETE_FAILED</code>
5720
+ * </p>
5721
+ * </li>
5722
+ * </ul>
5723
+ */
5724
+ Status?: string;
5725
+ /**
5726
+ * <p>When the monitor resource was created.</p>
5727
+ */
5728
+ CreationTime?: Date;
5729
+ /**
5730
+ * <p>The last time the monitor resource was modified. The timestamp depends on the status of the
5731
+ * job:</p>
5732
+ * <ul>
5733
+ * <li>
5734
+ * <p>
5735
+ * <code>CREATE_PENDING</code> - The <code>CreationTime</code>.</p>
5736
+ * </li>
5737
+ * <li>
5738
+ * <p>
5739
+ * <code>CREATE_IN_PROGRESS</code> - The current timestamp.</p>
5740
+ * </li>
5741
+ * <li>
5742
+ * <p>
5743
+ * <code>STOPPED</code> - When the resource stopped.</p>
5744
+ * </li>
5745
+ * <li>
5746
+ * <p>
5747
+ * <code>ACTIVE</code> or <code>CREATE_FAILED</code> - When the monitor creation finished or
5748
+ * failed.</p>
5749
+ * </li>
5750
+ * </ul>
5751
+ */
5752
+ LastModificationTime?: Date;
5753
+ }
5754
+ export declare namespace MonitorSummary {
5755
+ /**
5756
+ * @internal
5757
+ */
5758
+ const filterSensitiveLog: (obj: MonitorSummary) => any;
5759
+ }
5760
+ export interface ListMonitorsResponse {
5761
+ /**
5762
+ * <p>An array of objects that summarize each monitor's properties.</p>
5763
+ */
5764
+ Monitors?: MonitorSummary[];
5765
+ /**
5766
+ * <p>If the response is truncated, Amazon Forecast returns this token. To retrieve the next set of
5767
+ * results, use the token in the next request.</p>
5768
+ */
5769
+ NextToken?: string;
5770
+ }
5771
+ export declare namespace ListMonitorsResponse {
5772
+ /**
5773
+ * @internal
5774
+ */
5775
+ const filterSensitiveLog: (obj: ListMonitorsResponse) => any;
5776
+ }
5115
5777
  export interface ListPredictorBacktestExportJobsRequest {
5116
5778
  /**
5117
5779
  * <p>If the result of the previous request was truncated, the response includes a
@@ -5460,6 +6122,18 @@ export declare namespace ListTagsForResourceResponse {
5460
6122
  */
5461
6123
  const filterSensitiveLog: (obj: ListTagsForResourceResponse) => any;
5462
6124
  }
6125
+ export interface ResumeResourceRequest {
6126
+ /**
6127
+ * <p>The Amazon Resource Name (ARN) of the monitor resource to resume.</p>
6128
+ */
6129
+ ResourceArn: string | undefined;
6130
+ }
6131
+ export declare namespace ResumeResourceRequest {
6132
+ /**
6133
+ * @internal
6134
+ */
6135
+ const filterSensitiveLog: (obj: ResumeResourceRequest) => any;
6136
+ }
5463
6137
  export interface StopResourceRequest {
5464
6138
  /**
5465
6139
  * <p>The Amazon Resource Name (ARN) that identifies the resource to stop. The supported ARNs