@aws-sdk/client-forecast 3.154.0 → 3.155.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 (84) hide show
  1. package/CHANGELOG.md +11 -0
  2. package/dist-cjs/Forecast.js +180 -0
  3. package/dist-cjs/commands/CreateWhatIfAnalysisCommand.js +36 -0
  4. package/dist-cjs/commands/CreateWhatIfForecastCommand.js +36 -0
  5. package/dist-cjs/commands/CreateWhatIfForecastExportCommand.js +36 -0
  6. package/dist-cjs/commands/DeleteWhatIfAnalysisCommand.js +36 -0
  7. package/dist-cjs/commands/DeleteWhatIfForecastCommand.js +36 -0
  8. package/dist-cjs/commands/DeleteWhatIfForecastExportCommand.js +36 -0
  9. package/dist-cjs/commands/DescribeWhatIfAnalysisCommand.js +36 -0
  10. package/dist-cjs/commands/DescribeWhatIfForecastCommand.js +36 -0
  11. package/dist-cjs/commands/DescribeWhatIfForecastExportCommand.js +36 -0
  12. package/dist-cjs/commands/ListWhatIfAnalysesCommand.js +36 -0
  13. package/dist-cjs/commands/ListWhatIfForecastExportsCommand.js +36 -0
  14. package/dist-cjs/commands/ListWhatIfForecastsCommand.js +36 -0
  15. package/dist-cjs/commands/index.js +12 -0
  16. package/dist-cjs/models/models_0.js +133 -4
  17. package/dist-cjs/pagination/ListWhatIfAnalysesPaginator.js +36 -0
  18. package/dist-cjs/pagination/ListWhatIfForecastExportsPaginator.js +36 -0
  19. package/dist-cjs/pagination/ListWhatIfForecastsPaginator.js +36 -0
  20. package/dist-cjs/pagination/index.js +3 -0
  21. package/dist-cjs/protocols/Aws_json1_1.js +1007 -26
  22. package/dist-es/Forecast.js +180 -0
  23. package/dist-es/commands/CreateWhatIfAnalysisCommand.js +39 -0
  24. package/dist-es/commands/CreateWhatIfForecastCommand.js +39 -0
  25. package/dist-es/commands/CreateWhatIfForecastExportCommand.js +39 -0
  26. package/dist-es/commands/DeleteWhatIfAnalysisCommand.js +39 -0
  27. package/dist-es/commands/DeleteWhatIfForecastCommand.js +39 -0
  28. package/dist-es/commands/DeleteWhatIfForecastExportCommand.js +39 -0
  29. package/dist-es/commands/DescribeWhatIfAnalysisCommand.js +39 -0
  30. package/dist-es/commands/DescribeWhatIfForecastCommand.js +39 -0
  31. package/dist-es/commands/DescribeWhatIfForecastExportCommand.js +39 -0
  32. package/dist-es/commands/ListWhatIfAnalysesCommand.js +39 -0
  33. package/dist-es/commands/ListWhatIfForecastExportsCommand.js +39 -0
  34. package/dist-es/commands/ListWhatIfForecastsCommand.js +39 -0
  35. package/dist-es/commands/index.js +12 -0
  36. package/dist-es/models/models_0.js +42 -0
  37. package/dist-es/pagination/ListWhatIfAnalysesPaginator.js +75 -0
  38. package/dist-es/pagination/ListWhatIfForecastExportsPaginator.js +75 -0
  39. package/dist-es/pagination/ListWhatIfForecastsPaginator.js +75 -0
  40. package/dist-es/pagination/index.js +3 -0
  41. package/dist-es/protocols/Aws_json1_1.js +1318 -145
  42. package/dist-types/Forecast.d.ts +183 -0
  43. package/dist-types/ForecastClient.d.ts +14 -2
  44. package/dist-types/commands/CreateWhatIfAnalysisCommand.d.ts +46 -0
  45. package/dist-types/commands/CreateWhatIfForecastCommand.d.ts +36 -0
  46. package/dist-types/commands/CreateWhatIfForecastExportCommand.d.ts +51 -0
  47. package/dist-types/commands/DeleteWhatIfAnalysisCommand.d.ts +37 -0
  48. package/dist-types/commands/DeleteWhatIfForecastCommand.d.ts +37 -0
  49. package/dist-types/commands/DeleteWhatIfForecastExportCommand.d.ts +36 -0
  50. package/dist-types/commands/DescribeWhatIfAnalysisCommand.d.ts +57 -0
  51. package/dist-types/commands/DescribeWhatIfForecastCommand.d.ts +57 -0
  52. package/dist-types/commands/DescribeWhatIfForecastExportCommand.d.ts +57 -0
  53. package/dist-types/commands/ListWhatIfAnalysesCommand.d.ts +35 -0
  54. package/dist-types/commands/ListWhatIfForecastExportsCommand.d.ts +35 -0
  55. package/dist-types/commands/ListWhatIfForecastsCommand.d.ts +35 -0
  56. package/dist-types/commands/index.d.ts +12 -0
  57. package/dist-types/models/models_0.d.ts +1918 -840
  58. package/dist-types/pagination/ListWhatIfAnalysesPaginator.d.ts +4 -0
  59. package/dist-types/pagination/ListWhatIfForecastExportsPaginator.d.ts +4 -0
  60. package/dist-types/pagination/ListWhatIfForecastsPaginator.d.ts +4 -0
  61. package/dist-types/pagination/index.d.ts +3 -0
  62. package/dist-types/protocols/Aws_json1_1.d.ts +36 -0
  63. package/dist-types/ts3.4/Forecast.d.ts +60 -0
  64. package/dist-types/ts3.4/ForecastClient.d.ts +14 -2
  65. package/dist-types/ts3.4/commands/CreateWhatIfAnalysisCommand.d.ts +17 -0
  66. package/dist-types/ts3.4/commands/CreateWhatIfForecastCommand.d.ts +17 -0
  67. package/dist-types/ts3.4/commands/CreateWhatIfForecastExportCommand.d.ts +17 -0
  68. package/dist-types/ts3.4/commands/DeleteWhatIfAnalysisCommand.d.ts +17 -0
  69. package/dist-types/ts3.4/commands/DeleteWhatIfForecastCommand.d.ts +17 -0
  70. package/dist-types/ts3.4/commands/DeleteWhatIfForecastExportCommand.d.ts +17 -0
  71. package/dist-types/ts3.4/commands/DescribeWhatIfAnalysisCommand.d.ts +17 -0
  72. package/dist-types/ts3.4/commands/DescribeWhatIfForecastCommand.d.ts +17 -0
  73. package/dist-types/ts3.4/commands/DescribeWhatIfForecastExportCommand.d.ts +17 -0
  74. package/dist-types/ts3.4/commands/ListWhatIfAnalysesCommand.d.ts +17 -0
  75. package/dist-types/ts3.4/commands/ListWhatIfForecastExportsCommand.d.ts +17 -0
  76. package/dist-types/ts3.4/commands/ListWhatIfForecastsCommand.d.ts +17 -0
  77. package/dist-types/ts3.4/commands/index.d.ts +12 -0
  78. package/dist-types/ts3.4/models/models_0.d.ts +335 -0
  79. package/dist-types/ts3.4/pagination/ListWhatIfAnalysesPaginator.d.ts +4 -0
  80. package/dist-types/ts3.4/pagination/ListWhatIfForecastExportsPaginator.d.ts +4 -0
  81. package/dist-types/ts3.4/pagination/ListWhatIfForecastsPaginator.d.ts +4 -0
  82. package/dist-types/ts3.4/pagination/index.d.ts +3 -0
  83. package/dist-types/ts3.4/protocols/Aws_json1_1.d.ts +36 -0
  84. package/package.json +1 -1
@@ -1,5 +1,46 @@
1
1
  import { ExceptionOptionType as __ExceptionOptionType } from "@aws-sdk/smithy-client";
2
2
  import { ForecastServiceException as __BaseException } from "./ForecastServiceException";
3
+ export declare enum Operation {
4
+ ADD = "ADD",
5
+ DIVIDE = "DIVIDE",
6
+ MULTIPLY = "MULTIPLY",
7
+ SUBTRACT = "SUBTRACT"
8
+ }
9
+ /**
10
+ * <p>Defines the modifications that you are making to an attribute for a what-if forecast. For example, you can use this operation to create a what-if forecast that investigates a 10% off sale on all shoes. To do this, you specify <code>"AttributeName": "shoes"</code>, <code>"Operation": "MULTIPLY"</code>, and <code>"Value": "0.90"</code>. Pair this operation with the <a>TimeSeriesCondition</a> operation within the <a>CreateWhatIfForecastRequest$TimeSeriesTransformations</a> operation to define a subset of attribute items that are modified.</p>
11
+ */
12
+ export interface Action {
13
+ /**
14
+ * <p>The related time series that you are modifying. This value is case insensitive.</p>
15
+ */
16
+ AttributeName: string | undefined;
17
+ /**
18
+ * <p>The operation that is applied to the provided attribute. Operations include:</p>
19
+ * <ul>
20
+ * <li>
21
+ * <p>
22
+ * <code>ADD</code> - adds <code>Value</code> to all rows of <code>AttributeName</code>.</p>
23
+ * </li>
24
+ * <li>
25
+ * <p>
26
+ * <code>SUBTRACT</code> - subtracts <code>Value</code> from all rows of <code>AttributeName</code>.</p>
27
+ * </li>
28
+ * <li>
29
+ * <p>
30
+ * <code>MULTIPLY</code> - multiplies all rows of <code>AttributeName</code> by <code>Value</code>.</p>
31
+ * </li>
32
+ * <li>
33
+ * <p>
34
+ * <code>DIVIDE</code> - divides all rows of <code>AttributeName</code> by <code>Value</code>.</p>
35
+ * </li>
36
+ * </ul>
37
+ */
38
+ Operation: Operation | string | undefined;
39
+ /**
40
+ * <p>The value that is applied for the chosen <code>Operation</code>.</p>
41
+ */
42
+ Value: number | undefined;
43
+ }
3
44
  /**
4
45
  * <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
46
  * <p>
@@ -2318,6 +2359,175 @@ export interface CreatePredictorBacktestExportJobResponse {
2318
2359
  */
2319
2360
  PredictorBacktestExportJobArn?: string;
2320
2361
  }
2362
+ export interface CreateWhatIfAnalysisRequest {
2363
+ /**
2364
+ * <p>The name of the what-if analysis. Each name must be unique.</p>
2365
+ */
2366
+ WhatIfAnalysisName: string | undefined;
2367
+ /**
2368
+ * <p>The Amazon Resource Name (ARN) of the baseline forecast.</p>
2369
+ */
2370
+ ForecastArn: string | undefined;
2371
+ /**
2372
+ * <p>Defines the set of time series that are used in the what-if analysis with a <code>TimeSeriesIdentifiers</code>
2373
+ * object. What-if analyses are performed only for the time series in this object.</p>
2374
+ * <p>The <code>TimeSeriesIdentifiers</code> object needs the following information:</p>
2375
+ * <ul>
2376
+ * <li>
2377
+ * <p>
2378
+ * <code>DataSource</code>
2379
+ * </p>
2380
+ * </li>
2381
+ * <li>
2382
+ * <p>
2383
+ * <code>Format</code>
2384
+ * </p>
2385
+ * </li>
2386
+ * <li>
2387
+ * <p>
2388
+ * <code>Schema</code>
2389
+ * </p>
2390
+ * </li>
2391
+ * </ul>
2392
+ */
2393
+ TimeSeriesSelector?: TimeSeriesSelector;
2394
+ /**
2395
+ * <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>
2396
+ */
2397
+ Tags?: Tag[];
2398
+ }
2399
+ export interface CreateWhatIfAnalysisResponse {
2400
+ /**
2401
+ * <p>The Amazon Resource Name (ARN) of the what-if analysis.</p>
2402
+ */
2403
+ WhatIfAnalysisArn?: string;
2404
+ }
2405
+ /**
2406
+ * <p>A replacement dataset is a modified version of the baseline related time series that contains only the values that you want to include in a what-if forecast. The replacement dataset must contain the forecast dimensions and item identifiers in the baseline related time series as well as at least 1 changed time series. This dataset is merged with the baseline related time series to create a transformed dataset that is used for the what-if forecast.</p>
2407
+ */
2408
+ export interface TimeSeriesReplacementsDataSource {
2409
+ /**
2410
+ * <p>The path to the file(s) in an Amazon Simple Storage Service (Amazon S3) bucket, and an AWS Identity and Access Management (IAM) role that
2411
+ * Amazon Forecast can assume to access the file(s). Optionally, includes an AWS Key Management Service (KMS) key. This
2412
+ * 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>
2413
+ */
2414
+ S3Config: S3Config | undefined;
2415
+ /**
2416
+ * <p>Defines the fields of a dataset.</p>
2417
+ */
2418
+ Schema: Schema | undefined;
2419
+ /**
2420
+ * <p>The format of the replacement data, CSV or PARQUET.</p>
2421
+ */
2422
+ Format?: string;
2423
+ /**
2424
+ * <p>The timestamp format of the replacement data.</p>
2425
+ */
2426
+ TimestampFormat?: string;
2427
+ }
2428
+ export declare enum Condition {
2429
+ EQUALS = "EQUALS",
2430
+ GREATER_THAN = "GREATER_THAN",
2431
+ LESS_THAN = "LESS_THAN",
2432
+ NOT_EQUALS = "NOT_EQUALS"
2433
+ }
2434
+ /**
2435
+ * <p>Creates a subset of items within an attribute that are modified. For example, you can use this operation to create a subset of items that cost $5 or less. To do this, you specify <code>"AttributeName": "price"</code>, <code>"AttributeValue": "5"</code>, and <code>"Condition": "LESS_THAN"</code>. Pair this operation with the <a>Action</a> operation within the <a>CreateWhatIfForecastRequest$TimeSeriesTransformations</a> operation to define how the attribute is modified.</p>
2436
+ */
2437
+ export interface TimeSeriesCondition {
2438
+ /**
2439
+ * <p>The item_id, dimension name, IM name, or timestamp that you are modifying.</p>
2440
+ */
2441
+ AttributeName: string | undefined;
2442
+ /**
2443
+ * <p>The value that is applied for the chosen <code>Condition</code>.</p>
2444
+ */
2445
+ AttributeValue: string | undefined;
2446
+ /**
2447
+ * <p>The condition to apply. Valid values are <code>EQUALS</code>, <code>NOT_EQUALS</code>, <code>LESS_THAN</code> and
2448
+ * <code>GREATER_THAN</code>.</p>
2449
+ */
2450
+ Condition: Condition | string | undefined;
2451
+ }
2452
+ /**
2453
+ * <p>A transformation function is a pair of operations that select and modify the rows in a related time series. You select the rows that you want with a condition operation and you modify the rows with a transformation operation. All conditions are joined with an AND operation, meaning that all conditions must be true for the transformation to be applied. Transformations are applied in the order that they are listed.</p>
2454
+ */
2455
+ export interface TimeSeriesTransformation {
2456
+ /**
2457
+ * <p>An array of actions that define a time series and how it is transformed. These transformations create a new
2458
+ * time series that is used for the what-if analysis.</p>
2459
+ */
2460
+ Action?: Action;
2461
+ /**
2462
+ * <p>An array of conditions that define which members of the related time series are transformed.</p>
2463
+ */
2464
+ TimeSeriesConditions?: TimeSeriesCondition[];
2465
+ }
2466
+ export interface CreateWhatIfForecastRequest {
2467
+ /**
2468
+ * <p>The name of the what-if forecast. Names must be unique within each what-if analysis.</p>
2469
+ */
2470
+ WhatIfForecastName: string | undefined;
2471
+ /**
2472
+ * <p>The Amazon Resource Name (ARN) of the what-if analysis.</p>
2473
+ */
2474
+ WhatIfAnalysisArn: string | undefined;
2475
+ /**
2476
+ * <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>
2477
+ */
2478
+ TimeSeriesTransformations?: TimeSeriesTransformation[];
2479
+ /**
2480
+ * <p>The replacement time series dataset, which contains the rows that you want to change in the related time series dataset. A replacement time
2481
+ * series does not need to contain all rows that are in the baseline related time series. Include only the rows
2482
+ * (measure-dimension combinations) that you want to include in the what-if forecast. This dataset is merged with the
2483
+ * original time series to create a transformed dataset that is used for the what-if analysis.</p>
2484
+ * <p>This dataset should contain the items to modify (such as item_id or workforce_type), any relevant dimensions, the timestamp column, and at least one of the related time series columns. This file should not contain duplicate timestamps for the same time series.</p>
2485
+ * <p>Timestamps and item_ids not included in this dataset are not included in the what-if analysis. </p>
2486
+ */
2487
+ TimeSeriesReplacementsDataSource?: TimeSeriesReplacementsDataSource;
2488
+ /**
2489
+ * <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>
2490
+ */
2491
+ Tags?: Tag[];
2492
+ }
2493
+ export interface CreateWhatIfForecastResponse {
2494
+ /**
2495
+ * <p>The Amazon Resource Name (ARN) of the what-if forecast.</p>
2496
+ */
2497
+ WhatIfForecastArn?: string;
2498
+ }
2499
+ export interface CreateWhatIfForecastExportRequest {
2500
+ /**
2501
+ * <p>The name of the what-if forecast to export.</p>
2502
+ */
2503
+ WhatIfForecastExportName: string | undefined;
2504
+ /**
2505
+ * <p>The list of what-if forecast Amazon Resource Names (ARNs) to export.</p>
2506
+ */
2507
+ WhatIfForecastArns: string[] | undefined;
2508
+ /**
2509
+ * <p>The location where you want to save the forecast and an AWS Identity and Access Management (IAM) role that
2510
+ * Amazon Forecast can assume to access the location. The forecast must be exported to an Amazon S3
2511
+ * bucket.</p>
2512
+ * <p>If encryption is used, <code>Destination</code> must include an AWS Key Management Service (KMS) key. The
2513
+ * IAM role must allow Amazon Forecast permission to access the key.</p>
2514
+ */
2515
+ Destination: DataDestination | undefined;
2516
+ /**
2517
+ * <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>
2518
+ */
2519
+ Tags?: Tag[];
2520
+ /**
2521
+ * <p>The format of the exported data, CSV or PARQUET.</p>
2522
+ */
2523
+ Format?: string;
2524
+ }
2525
+ export interface CreateWhatIfForecastExportResponse {
2526
+ /**
2527
+ * <p>The Amazon Resource Name (ARN) of the what-if forecast.</p>
2528
+ */
2529
+ WhatIfForecastExportArn?: string;
2530
+ }
2321
2531
  export interface DeleteDatasetRequest {
2322
2532
  /**
2323
2533
  * <p>The Amazon Resource Name (ARN) of the dataset to delete.</p>
@@ -2385,6 +2595,24 @@ export interface DeleteResourceTreeRequest {
2385
2595
  */
2386
2596
  ResourceArn: string | undefined;
2387
2597
  }
2598
+ export interface DeleteWhatIfAnalysisRequest {
2599
+ /**
2600
+ * <p>The Amazon Resource Name (ARN) of the what-if analysis that you want to delete.</p>
2601
+ */
2602
+ WhatIfAnalysisArn: string | undefined;
2603
+ }
2604
+ export interface DeleteWhatIfForecastRequest {
2605
+ /**
2606
+ * <p>The Amazon Resource Name (ARN) of the what-if forecast that you want to delete.</p>
2607
+ */
2608
+ WhatIfForecastArn: string | undefined;
2609
+ }
2610
+ export interface DeleteWhatIfForecastExportRequest {
2611
+ /**
2612
+ * <p>The Amazon Resource Name (ARN) of the what-if forecast export that you want to delete.</p>
2613
+ */
2614
+ WhatIfForecastExportArn: string | undefined;
2615
+ }
2388
2616
  export interface DescribeAutoPredictorRequest {
2389
2617
  /**
2390
2618
  * <p>The Amazon Resource Name (ARN) of the predictor.</p>
@@ -3811,315 +4039,144 @@ export interface DescribePredictorBacktestExportJobResponse {
3811
4039
  */
3812
4040
  Format?: string;
3813
4041
  }
3814
- export interface GetAccuracyMetricsRequest {
3815
- /**
3816
- * <p>The Amazon Resource Name (ARN) of the predictor to get metrics for.</p>
3817
- */
3818
- PredictorArn: string | undefined;
3819
- }
3820
- export declare enum EvaluationType {
3821
- COMPUTED = "COMPUTED",
3822
- SUMMARY = "SUMMARY"
3823
- }
3824
- /**
3825
- * <p> Provides detailed error metrics to evaluate the performance of a predictor. This object
3826
- * is part of the <a>Metrics</a> object. </p>
3827
- */
3828
- export interface ErrorMetric {
3829
- /**
3830
- * <p> The Forecast type used to compute WAPE, MAPE, MASE, and RMSE. </p>
3831
- */
3832
- ForecastType?: string;
3833
- /**
3834
- * <p> The weighted absolute percentage error (WAPE). </p>
3835
- */
3836
- WAPE?: number;
3837
- /**
3838
- * <p> The root-mean-square error (RMSE). </p>
3839
- */
3840
- RMSE?: number;
3841
- /**
3842
- * <p>The Mean Absolute Scaled Error (MASE)</p>
3843
- */
3844
- MASE?: number;
3845
- /**
3846
- * <p>The Mean Absolute Percentage Error (MAPE)</p>
3847
- */
3848
- MAPE?: number;
3849
- }
3850
- /**
3851
- * <p>The weighted loss value for a quantile. This object is part of the <a>Metrics</a> object.</p>
3852
- */
3853
- export interface WeightedQuantileLoss {
3854
- /**
3855
- * <p>The quantile. Quantiles divide a probability distribution into regions of equal
3856
- * probability. For example, if the distribution was divided into 5 regions of equal probability,
3857
- * the quantiles would be 0.2, 0.4, 0.6, and 0.8.</p>
3858
- */
3859
- Quantile?: number;
4042
+ export interface DescribeWhatIfAnalysisRequest {
3860
4043
  /**
3861
- * <p>The difference between the predicted value and the actual value over the quantile,
3862
- * weighted (normalized) by dividing by the sum over all quantiles.</p>
4044
+ * <p>The Amazon Resource Name (ARN) of the what-if analysis that you are interested in.</p>
3863
4045
  */
3864
- LossValue?: number;
4046
+ WhatIfAnalysisArn: string | undefined;
3865
4047
  }
3866
- /**
3867
- * <p>Provides metrics that are used to evaluate the performance of a predictor. This object is
3868
- * part of the <a>WindowSummary</a> object.</p>
3869
- */
3870
- export interface Metrics {
4048
+ export interface DescribeWhatIfAnalysisResponse {
3871
4049
  /**
3872
- * @deprecated
3873
- *
3874
- * <p>The root-mean-square error (RMSE).</p>
4050
+ * <p>The name of the what-if analysis.</p>
3875
4051
  */
3876
- RMSE?: number;
4052
+ WhatIfAnalysisName?: string;
3877
4053
  /**
3878
- * <p>An array of weighted quantile losses. Quantiles divide a probability distribution into
3879
- * regions of equal probability. The distribution in this case is the loss function.</p>
4054
+ * <p>The Amazon Resource Name (ARN) of the what-if analysis.</p>
3880
4055
  */
3881
- WeightedQuantileLosses?: WeightedQuantileLoss[];
4056
+ WhatIfAnalysisArn?: string;
3882
4057
  /**
3883
- * <p> Provides detailed error metrics for each forecast type. Metrics include root-mean
3884
- * square-error (RMSE), mean absolute percentage error (MAPE), mean absolute scaled error (MASE),
3885
- * and weighted average percentage error (WAPE). </p>
4058
+ * <p>The Amazon Resource Name (ARN) of the what-if forecast.</p>
3886
4059
  */
3887
- ErrorMetrics?: ErrorMetric[];
4060
+ ForecastArn?: string;
3888
4061
  /**
3889
- * <p>The average value of all weighted quantile losses.</p>
4062
+ * <p>The approximate time remaining to complete the what-if analysis, in minutes.</p>
3890
4063
  */
3891
- AverageWeightedQuantileLoss?: number;
3892
- }
3893
- /**
3894
- * <p>The metrics for a time range within the evaluation portion of a dataset. This object is
3895
- * part of the <a>EvaluationResult</a> object.</p>
3896
- * <p>The <code>TestWindowStart</code> and <code>TestWindowEnd</code> parameters are determined
3897
- * by the <code>BackTestWindowOffset</code> parameter of the <a>EvaluationParameters</a> object.</p>
3898
- */
3899
- export interface WindowSummary {
4064
+ EstimatedTimeRemainingInMinutes?: number;
3900
4065
  /**
3901
- * <p>The timestamp that defines the start of the window.</p>
4066
+ * <p>The status of the what-if analysis. States include:</p>
4067
+ * <ul>
4068
+ * <li>
4069
+ * <p>
4070
+ * <code>ACTIVE</code>
4071
+ * </p>
4072
+ * </li>
4073
+ * <li>
4074
+ * <p>
4075
+ * <code>CREATE_PENDING</code>, <code>CREATE_IN_PROGRESS</code>,
4076
+ * <code>CREATE_FAILED</code>
4077
+ * </p>
4078
+ * </li>
4079
+ * <li>
4080
+ * <p>
4081
+ * <code>CREATE_STOPPING</code>, <code>CREATE_STOPPED</code>
4082
+ * </p>
4083
+ * </li>
4084
+ * <li>
4085
+ * <p>
4086
+ * <code>DELETE_PENDING</code>, <code>DELETE_IN_PROGRESS</code>,
4087
+ * <code>DELETE_FAILED</code>
4088
+ * </p>
4089
+ * </li>
4090
+ * </ul>
4091
+ * <note>
4092
+ * <p>The <code>Status</code> of the what-if analysis must be <code>ACTIVE</code> before you can access the
4093
+ * analysis.</p>
4094
+ * </note>
3902
4095
  */
3903
- TestWindowStart?: Date;
4096
+ Status?: string;
3904
4097
  /**
3905
- * <p>The timestamp that defines the end of the window.</p>
4098
+ * <p>If an error occurred, an informational message about the error.</p>
3906
4099
  */
3907
- TestWindowEnd?: Date;
4100
+ Message?: string;
3908
4101
  /**
3909
- * <p>The number of data points within the window.</p>
4102
+ * <p>When the what-if analysis was created.</p>
3910
4103
  */
3911
- ItemCount?: number;
4104
+ CreationTime?: Date;
3912
4105
  /**
3913
- * <p>The type of evaluation.</p>
4106
+ * <p>The last time the resource was modified. The timestamp depends on the status of the job:</p>
3914
4107
  * <ul>
3915
4108
  * <li>
3916
4109
  * <p>
3917
- * <code>SUMMARY</code> - The average metrics across all windows.</p>
4110
+ * <code>CREATE_PENDING</code> - The <code>CreationTime</code>.</p>
3918
4111
  * </li>
3919
4112
  * <li>
3920
4113
  * <p>
3921
- * <code>COMPUTED</code> - The metrics for the specified window.</p>
4114
+ * <code>CREATE_IN_PROGRESS</code> - The current timestamp.</p>
4115
+ * </li>
4116
+ * <li>
4117
+ * <p>
4118
+ * <code>CREATE_STOPPING</code> - The current timestamp.</p>
4119
+ * </li>
4120
+ * <li>
4121
+ * <p>
4122
+ * <code>CREATE_STOPPED</code> - When the job stopped.</p>
4123
+ * </li>
4124
+ * <li>
4125
+ * <p>
4126
+ * <code>ACTIVE</code> or <code>CREATE_FAILED</code> - When the job finished or
4127
+ * failed.</p>
3922
4128
  * </li>
3923
4129
  * </ul>
3924
4130
  */
3925
- EvaluationType?: EvaluationType | string;
3926
- /**
3927
- * <p>Provides metrics used to evaluate the performance of a predictor.</p>
3928
- */
3929
- Metrics?: Metrics;
3930
- }
3931
- /**
3932
- * <p>The results of evaluating an algorithm. Returned as part of the <a>GetAccuracyMetrics</a> response.</p>
3933
- */
3934
- export interface EvaluationResult {
3935
- /**
3936
- * <p>The Amazon Resource Name (ARN) of the algorithm that was evaluated.</p>
3937
- */
3938
- AlgorithmArn?: string;
3939
- /**
3940
- * <p>The array of test windows used for evaluating the algorithm. The
3941
- * <code>NumberOfBacktestWindows</code> from the <a>EvaluationParameters</a> object
3942
- * determines the number of windows in the array.</p>
3943
- */
3944
- TestWindows?: WindowSummary[];
3945
- }
3946
- export interface GetAccuracyMetricsResponse {
3947
- /**
3948
- * <p>An array of results from evaluating the predictor.</p>
3949
- */
3950
- PredictorEvaluationResults?: EvaluationResult[];
3951
- /**
3952
- * <p>Whether the predictor was created with <a>CreateAutoPredictor</a>.</p>
3953
- */
3954
- IsAutoPredictor?: boolean;
3955
- /**
3956
- * <note>
3957
- * <p> The <code>LatencyOptimized</code> AutoML override strategy is only available in private beta.
3958
- * Contact AWS Support or your account manager to learn more about access privileges.
3959
- * </p>
3960
- * </note>
3961
- * <p>The AutoML strategy used to train the predictor. Unless <code>LatencyOptimized</code>
3962
- * is specified, the AutoML strategy optimizes predictor accuracy.</p>
3963
- * <p>This parameter is only valid for predictors trained using AutoML.</p>
3964
- */
3965
- AutoMLOverrideStrategy?: AutoMLOverrideStrategy | string;
3966
- /**
3967
- * <p>The accuracy metric used to optimize the predictor.</p>
3968
- */
3969
- OptimizationMetric?: OptimizationMetric | string;
3970
- }
3971
- /**
3972
- * <p>The token is not valid. Tokens expire after 24 hours.</p>
3973
- */
3974
- export declare class InvalidNextTokenException extends __BaseException {
3975
- readonly name: "InvalidNextTokenException";
3976
- readonly $fault: "client";
3977
- Message?: string;
3978
- /**
3979
- * @internal
3980
- */
3981
- constructor(opts: __ExceptionOptionType<InvalidNextTokenException, __BaseException>);
3982
- }
3983
- export interface ListDatasetGroupsRequest {
3984
- /**
3985
- * <p>If the result of the previous request was truncated, the response includes a
3986
- * <code>NextToken</code>. To retrieve the next set of results, use the token in the next
3987
- * request. Tokens expire after 24 hours.</p>
3988
- */
3989
- NextToken?: string;
3990
- /**
3991
- * <p>The number of items to return in the response.</p>
3992
- */
3993
- MaxResults?: number;
3994
- }
3995
- /**
3996
- * <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
3997
- * get the complete set of properties, call the <a href="https://docs.aws.amazon.com/forecast/latest/dg/API_DescribeDatasetGroup.html">DescribeDatasetGroup</a>
3998
- * operation, and provide the <code>DatasetGroupArn</code>.</p>
3999
- */
4000
- export interface DatasetGroupSummary {
4001
- /**
4002
- * <p>The Amazon Resource Name (ARN) of the dataset group.</p>
4003
- */
4004
- DatasetGroupArn?: string;
4005
- /**
4006
- * <p>The name of the dataset group.</p>
4007
- */
4008
- DatasetGroupName?: string;
4009
- /**
4010
- * <p>When the dataset group was created.</p>
4011
- */
4012
- CreationTime?: Date;
4013
- /**
4014
- * <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,
4015
- * <code>LastModificationTime</code> is the current time of the <code>ListDatasetGroups</code>
4016
- * call.</p>
4017
- */
4018
4131
  LastModificationTime?: Date;
4019
- }
4020
- export interface ListDatasetGroupsResponse {
4021
- /**
4022
- * <p>An array of objects that summarize each dataset group's properties.</p>
4023
- */
4024
- DatasetGroups?: DatasetGroupSummary[];
4025
- /**
4026
- * <p>If the response is truncated, Amazon Forecast returns this token. To retrieve the next set of
4027
- * results, use the token in the next request.</p>
4028
- */
4029
- NextToken?: string;
4030
- }
4031
- export declare enum FilterConditionString {
4032
- IS = "IS",
4033
- IS_NOT = "IS_NOT"
4034
- }
4035
- /**
4036
- * <p>Describes a filter for choosing a subset of objects. Each filter consists of a
4037
- * condition and a match statement. The condition is either <code>IS</code> or
4038
- * <code>IS_NOT</code>, which specifies whether to include or exclude
4039
- * the objects that match the statement, respectively. The match statement consists of a key and a
4040
- * value.</p>
4041
- */
4042
- export interface Filter {
4043
- /**
4044
- * <p>The name of the parameter to filter on.</p>
4045
- */
4046
- Key: string | undefined;
4047
- /**
4048
- * <p>The value to match.</p>
4049
- */
4050
- Value: string | undefined;
4051
- /**
4052
- * <p>The condition to apply. To include the objects that match the statement, specify
4053
- * <code>IS</code>. To exclude matching objects, specify <code>IS_NOT</code>.</p>
4054
- */
4055
- Condition: FilterConditionString | string | undefined;
4056
- }
4057
- export interface ListDatasetImportJobsRequest {
4058
- /**
4059
- * <p>If the result of the previous request was truncated, the response includes a
4060
- * <code>NextToken</code>. To retrieve the next set of results, use the token in the next
4061
- * request. Tokens expire after 24 hours.</p>
4062
- */
4063
- NextToken?: string;
4064
- /**
4065
- * <p>The number of items to return in the response.</p>
4066
- */
4067
- MaxResults?: number;
4068
4132
  /**
4069
- * <p>An array of filters. For each filter, you provide a condition and a match statement. The
4070
- * condition is either <code>IS</code> or <code>IS_NOT</code>, which specifies whether to include
4071
- * or exclude the datasets that match the statement from the list, respectively. The match
4072
- * statement consists of a key and a value.</p>
4073
- * <p>
4074
- * <b>Filter properties</b>
4075
- * </p>
4133
+ * <p>Defines the set of time series that are used to create the forecasts in a <code>TimeSeriesIdentifiers</code> object.</p>
4134
+ * <p>The <code>TimeSeriesIdentifiers</code> object needs the following information:</p>
4076
4135
  * <ul>
4077
4136
  * <li>
4078
4137
  * <p>
4079
- * <code>Condition</code> - The condition to apply. Valid values are <code>IS</code> and
4080
- * <code>IS_NOT</code>. To include the datasets that match the statement, specify
4081
- * <code>IS</code>. To exclude matching datasets, specify <code>IS_NOT</code>.</p>
4138
+ * <code>DataSource</code>
4139
+ * </p>
4082
4140
  * </li>
4083
4141
  * <li>
4084
4142
  * <p>
4085
- * <code>Key</code> - The name of the parameter to filter on. Valid values are
4086
- * <code>DatasetArn</code> and <code>Status</code>.</p>
4143
+ * <code>Format</code>
4144
+ * </p>
4087
4145
  * </li>
4088
4146
  * <li>
4089
4147
  * <p>
4090
- * <code>Value</code> - The value to match.</p>
4148
+ * <code>Schema</code>
4149
+ * </p>
4091
4150
  * </li>
4092
4151
  * </ul>
4093
- * <p>For example, to list all dataset import jobs whose status is ACTIVE, you specify the
4094
- * following filter:</p>
4095
- * <p>
4096
- * <code>"Filters": [ { "Condition": "IS", "Key": "Status", "Value": "ACTIVE" } ]</code>
4097
- * </p>
4098
4152
  */
4099
- Filters?: Filter[];
4153
+ TimeSeriesSelector?: TimeSeriesSelector;
4100
4154
  }
4101
- /**
4102
- * <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
4103
- * <a href="https://docs.aws.amazon.com/forecast/latest/dg/API_DescribeDatasetImportJob.html">DescribeDatasetImportJob</a> operation, and provide the
4104
- * <code>DatasetImportJobArn</code>.</p>
4105
- */
4106
- export interface DatasetImportJobSummary {
4155
+ export interface DescribeWhatIfForecastRequest {
4107
4156
  /**
4108
- * <p>The Amazon Resource Name (ARN) of the dataset import job.</p>
4157
+ * <p>The Amazon Resource Name (ARN) of the what-if forecast that you are interested in.</p>
4109
4158
  */
4110
- DatasetImportJobArn?: string;
4159
+ WhatIfForecastArn: string | undefined;
4160
+ }
4161
+ export interface DescribeWhatIfForecastResponse {
4111
4162
  /**
4112
- * <p>The name of the dataset import job.</p>
4163
+ * <p>The name of the what-if forecast.</p>
4113
4164
  */
4114
- DatasetImportJobName?: string;
4165
+ WhatIfForecastName?: string;
4115
4166
  /**
4116
- * <p>The location of the training data to import and an AWS Identity and Access Management (IAM) role that Amazon Forecast
4117
- * can assume to access the data. The training data must be stored in an Amazon S3 bucket.</p>
4118
- * <p>If encryption is used, <code>DataSource</code> includes an AWS Key Management Service (KMS) key.</p>
4167
+ * <p>The Amazon Resource Name (ARN) of the what-if forecast.</p>
4119
4168
  */
4120
- DataSource?: DataSource;
4169
+ WhatIfForecastArn?: string;
4121
4170
  /**
4122
- * <p>The status of the dataset import job. States include:</p>
4171
+ * <p>The Amazon Resource Name (ARN) of the what-if analysis that contains this forecast.</p>
4172
+ */
4173
+ WhatIfAnalysisArn?: string;
4174
+ /**
4175
+ * <p>The approximate time remaining to complete the what-if forecast, in minutes.</p>
4176
+ */
4177
+ EstimatedTimeRemainingInMinutes?: number;
4178
+ /**
4179
+ * <p>The status of the what-if forecast. States include:</p>
4123
4180
  * <ul>
4124
4181
  * <li>
4125
4182
  * <p>
@@ -4129,21 +4186,25 @@ export interface DatasetImportJobSummary {
4129
4186
  * <li>
4130
4187
  * <p>
4131
4188
  * <code>CREATE_PENDING</code>, <code>CREATE_IN_PROGRESS</code>,
4132
- * <code>CREATE_FAILED</code>
4189
+ * <code>CREATE_FAILED</code>
4133
4190
  * </p>
4134
4191
  * </li>
4135
4192
  * <li>
4136
4193
  * <p>
4137
- * <code>DELETE_PENDING</code>, <code>DELETE_IN_PROGRESS</code>,
4138
- * <code>DELETE_FAILED</code>
4194
+ * <code>CREATE_STOPPING</code>, <code>CREATE_STOPPED</code>
4139
4195
  * </p>
4140
4196
  * </li>
4141
4197
  * <li>
4142
4198
  * <p>
4143
- * <code>CREATE_STOPPING</code>, <code>CREATE_STOPPED</code>
4199
+ * <code>DELETE_PENDING</code>, <code>DELETE_IN_PROGRESS</code>,
4200
+ * <code>DELETE_FAILED</code>
4144
4201
  * </p>
4145
4202
  * </li>
4146
4203
  * </ul>
4204
+ * <note>
4205
+ * <p>The <code>Status</code> of the what-if forecast must be <code>ACTIVE</code> before you can access the
4206
+ * forecast.</p>
4207
+ * </note>
4147
4208
  */
4148
4209
  Status?: string;
4149
4210
  /**
@@ -4151,12 +4212,11 @@ export interface DatasetImportJobSummary {
4151
4212
  */
4152
4213
  Message?: string;
4153
4214
  /**
4154
- * <p>When the dataset import job was created.</p>
4215
+ * <p>When the what-if forecast was created.</p>
4155
4216
  */
4156
4217
  CreationTime?: Date;
4157
4218
  /**
4158
- * <p>The last time the resource was modified. The timestamp depends on the status of the
4159
- * job:</p>
4219
+ * <p>The last time the resource was modified. The timestamp depends on the status of the job:</p>
4160
4220
  * <ul>
4161
4221
  * <li>
4162
4222
  * <p>
@@ -4182,356 +4242,1417 @@ export interface DatasetImportJobSummary {
4182
4242
  * </ul>
4183
4243
  */
4184
4244
  LastModificationTime?: Date;
4185
- }
4186
- export interface ListDatasetImportJobsResponse {
4187
4245
  /**
4188
- * <p>An array of objects that summarize each dataset import job's properties.</p>
4246
+ * <p>An array of <code>Action</code> and <code>TimeSeriesConditions</code> elements that describe what transformations were applied to which time series.</p>
4189
4247
  */
4190
- DatasetImportJobs?: DatasetImportJobSummary[];
4248
+ TimeSeriesTransformations?: TimeSeriesTransformation[];
4191
4249
  /**
4192
- * <p>If the response is truncated, Amazon Forecast returns this token. To retrieve the next set of
4193
- * results, use the token in the next request.</p>
4250
+ * <p>An array of <code>S3Config</code>, <code>Schema</code>, and <code>Format</code> elements that describe the replacement time series.</p>
4194
4251
  */
4195
- NextToken?: string;
4196
- }
4197
- export interface ListDatasetsRequest {
4252
+ TimeSeriesReplacementsDataSource?: TimeSeriesReplacementsDataSource;
4198
4253
  /**
4199
- * <p>If the result of the previous request was truncated, the response includes a
4200
- * <code>NextToken</code>. To retrieve the next set of results, use the token in the next
4201
- * request. Tokens expire after 24 hours.</p>
4254
+ * <p>The quantiles at which probabilistic forecasts are generated. You can specify up to 5 quantiles per what-if forecast in the <a>CreateWhatIfForecast</a> operation. If you didn't specify quantiles, the default values are <code>["0.1", "0.5", "0.9"]</code>. </p>
4202
4255
  */
4203
- NextToken?: string;
4256
+ ForecastTypes?: string[];
4257
+ }
4258
+ export interface DescribeWhatIfForecastExportRequest {
4204
4259
  /**
4205
- * <p>The number of items to return in the response.</p>
4260
+ * <p>The Amazon Resource Name (ARN) of the what-if forecast export that you are interested in.</p>
4206
4261
  */
4207
- MaxResults?: number;
4262
+ WhatIfForecastExportArn: string | undefined;
4208
4263
  }
4209
- /**
4210
- * <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
4211
- * complete set of properties, call the <a href="https://docs.aws.amazon.com/forecast/latest/dg/API_DescribeDataset.html">DescribeDataset</a> operation, and
4212
- * provide the <code>DatasetArn</code>.</p>
4213
- */
4214
- export interface DatasetSummary {
4264
+ export interface DescribeWhatIfForecastExportResponse {
4215
4265
  /**
4216
- * <p>The Amazon Resource Name (ARN) of the dataset.</p>
4266
+ * <p>The Amazon Resource Name (ARN) of the what-if forecast export.</p>
4217
4267
  */
4218
- DatasetArn?: string;
4268
+ WhatIfForecastExportArn?: string;
4219
4269
  /**
4220
- * <p>The name of the dataset.</p>
4270
+ * <p>The name of the what-if forecast export.</p>
4221
4271
  */
4222
- DatasetName?: string;
4272
+ WhatIfForecastExportName?: string;
4223
4273
  /**
4224
- * <p>The dataset type.</p>
4274
+ * <p>An array of Amazon Resource Names (ARNs) that represent all of the what-if forecasts exported in this
4275
+ * resource.</p>
4225
4276
  */
4226
- DatasetType?: DatasetType | string;
4277
+ WhatIfForecastArns?: string[];
4227
4278
  /**
4228
- * <p>The domain associated with the dataset.</p>
4279
+ * <p>The destination for an export job. Provide an S3 path, an AWS Identity and Access Management (IAM) role that allows Amazon Forecast
4280
+ * to access the location, and an AWS Key Management Service (KMS) key (optional). </p>
4229
4281
  */
4230
- Domain?: Domain | string;
4282
+ Destination?: DataDestination;
4231
4283
  /**
4232
- * <p>When the dataset was created.</p>
4284
+ * <p>If an error occurred, an informational message about the error.</p>
4285
+ */
4286
+ Message?: string;
4287
+ /**
4288
+ * <p>The status of the what-if forecast. States include:</p>
4289
+ * <ul>
4290
+ * <li>
4291
+ * <p>
4292
+ * <code>ACTIVE</code>
4293
+ * </p>
4294
+ * </li>
4295
+ * <li>
4296
+ * <p>
4297
+ * <code>CREATE_PENDING</code>, <code>CREATE_IN_PROGRESS</code>,
4298
+ * <code>CREATE_FAILED</code>
4299
+ * </p>
4300
+ * </li>
4301
+ * <li>
4302
+ * <p>
4303
+ * <code>CREATE_STOPPING</code>, <code>CREATE_STOPPED</code>
4304
+ * </p>
4305
+ * </li>
4306
+ * <li>
4307
+ * <p>
4308
+ * <code>DELETE_PENDING</code>, <code>DELETE_IN_PROGRESS</code>,
4309
+ * <code>DELETE_FAILED</code>
4310
+ * </p>
4311
+ * </li>
4312
+ * </ul>
4313
+ * <note>
4314
+ * <p>The <code>Status</code> of the what-if forecast export must be <code>ACTIVE</code> before you can access the
4315
+ * forecast export.</p>
4316
+ * </note>
4317
+ */
4318
+ Status?: string;
4319
+ /**
4320
+ * <p>When the what-if forecast export was created.</p>
4321
+ */
4322
+ CreationTime?: Date;
4323
+ /**
4324
+ * <p>The approximate time remaining to complete the what-if forecast export, in minutes.</p>
4325
+ */
4326
+ EstimatedTimeRemainingInMinutes?: number;
4327
+ /**
4328
+ * <p>The last time the resource was modified. The timestamp depends on the status of the job:</p>
4329
+ * <ul>
4330
+ * <li>
4331
+ * <p>
4332
+ * <code>CREATE_PENDING</code> - The <code>CreationTime</code>.</p>
4333
+ * </li>
4334
+ * <li>
4335
+ * <p>
4336
+ * <code>CREATE_IN_PROGRESS</code> - The current timestamp.</p>
4337
+ * </li>
4338
+ * <li>
4339
+ * <p>
4340
+ * <code>CREATE_STOPPING</code> - The current timestamp.</p>
4341
+ * </li>
4342
+ * <li>
4343
+ * <p>
4344
+ * <code>CREATE_STOPPED</code> - When the job stopped.</p>
4345
+ * </li>
4346
+ * <li>
4347
+ * <p>
4348
+ * <code>ACTIVE</code> or <code>CREATE_FAILED</code> - When the job finished or
4349
+ * failed.</p>
4350
+ * </li>
4351
+ * </ul>
4352
+ */
4353
+ LastModificationTime?: Date;
4354
+ /**
4355
+ * <p>The format of the exported data, CSV or PARQUET.</p>
4356
+ */
4357
+ Format?: string;
4358
+ }
4359
+ export interface GetAccuracyMetricsRequest {
4360
+ /**
4361
+ * <p>The Amazon Resource Name (ARN) of the predictor to get metrics for.</p>
4362
+ */
4363
+ PredictorArn: string | undefined;
4364
+ }
4365
+ export declare enum EvaluationType {
4366
+ COMPUTED = "COMPUTED",
4367
+ SUMMARY = "SUMMARY"
4368
+ }
4369
+ /**
4370
+ * <p> Provides detailed error metrics to evaluate the performance of a predictor. This object
4371
+ * is part of the <a>Metrics</a> object. </p>
4372
+ */
4373
+ export interface ErrorMetric {
4374
+ /**
4375
+ * <p> The Forecast type used to compute WAPE, MAPE, MASE, and RMSE. </p>
4376
+ */
4377
+ ForecastType?: string;
4378
+ /**
4379
+ * <p> The weighted absolute percentage error (WAPE). </p>
4380
+ */
4381
+ WAPE?: number;
4382
+ /**
4383
+ * <p> The root-mean-square error (RMSE). </p>
4384
+ */
4385
+ RMSE?: number;
4386
+ /**
4387
+ * <p>The Mean Absolute Scaled Error (MASE)</p>
4388
+ */
4389
+ MASE?: number;
4390
+ /**
4391
+ * <p>The Mean Absolute Percentage Error (MAPE)</p>
4392
+ */
4393
+ MAPE?: number;
4394
+ }
4395
+ /**
4396
+ * <p>The weighted loss value for a quantile. This object is part of the <a>Metrics</a> object.</p>
4397
+ */
4398
+ export interface WeightedQuantileLoss {
4399
+ /**
4400
+ * <p>The quantile. Quantiles divide a probability distribution into regions of equal
4401
+ * probability. For example, if the distribution was divided into 5 regions of equal probability,
4402
+ * the quantiles would be 0.2, 0.4, 0.6, and 0.8.</p>
4403
+ */
4404
+ Quantile?: number;
4405
+ /**
4406
+ * <p>The difference between the predicted value and the actual value over the quantile,
4407
+ * weighted (normalized) by dividing by the sum over all quantiles.</p>
4408
+ */
4409
+ LossValue?: number;
4410
+ }
4411
+ /**
4412
+ * <p>Provides metrics that are used to evaluate the performance of a predictor. This object is
4413
+ * part of the <a>WindowSummary</a> object.</p>
4414
+ */
4415
+ export interface Metrics {
4416
+ /**
4417
+ * @deprecated
4418
+ *
4419
+ * <p>The root-mean-square error (RMSE).</p>
4420
+ */
4421
+ RMSE?: number;
4422
+ /**
4423
+ * <p>An array of weighted quantile losses. Quantiles divide a probability distribution into
4424
+ * regions of equal probability. The distribution in this case is the loss function.</p>
4425
+ */
4426
+ WeightedQuantileLosses?: WeightedQuantileLoss[];
4427
+ /**
4428
+ * <p> Provides detailed error metrics for each forecast type. Metrics include root-mean
4429
+ * square-error (RMSE), mean absolute percentage error (MAPE), mean absolute scaled error (MASE),
4430
+ * and weighted average percentage error (WAPE). </p>
4431
+ */
4432
+ ErrorMetrics?: ErrorMetric[];
4433
+ /**
4434
+ * <p>The average value of all weighted quantile losses.</p>
4435
+ */
4436
+ AverageWeightedQuantileLoss?: number;
4437
+ }
4438
+ /**
4439
+ * <p>The metrics for a time range within the evaluation portion of a dataset. This object is
4440
+ * part of the <a>EvaluationResult</a> object.</p>
4441
+ * <p>The <code>TestWindowStart</code> and <code>TestWindowEnd</code> parameters are determined
4442
+ * by the <code>BackTestWindowOffset</code> parameter of the <a>EvaluationParameters</a> object.</p>
4443
+ */
4444
+ export interface WindowSummary {
4445
+ /**
4446
+ * <p>The timestamp that defines the start of the window.</p>
4447
+ */
4448
+ TestWindowStart?: Date;
4449
+ /**
4450
+ * <p>The timestamp that defines the end of the window.</p>
4451
+ */
4452
+ TestWindowEnd?: Date;
4453
+ /**
4454
+ * <p>The number of data points within the window.</p>
4455
+ */
4456
+ ItemCount?: number;
4457
+ /**
4458
+ * <p>The type of evaluation.</p>
4459
+ * <ul>
4460
+ * <li>
4461
+ * <p>
4462
+ * <code>SUMMARY</code> - The average metrics across all windows.</p>
4463
+ * </li>
4464
+ * <li>
4465
+ * <p>
4466
+ * <code>COMPUTED</code> - The metrics for the specified window.</p>
4467
+ * </li>
4468
+ * </ul>
4469
+ */
4470
+ EvaluationType?: EvaluationType | string;
4471
+ /**
4472
+ * <p>Provides metrics used to evaluate the performance of a predictor.</p>
4473
+ */
4474
+ Metrics?: Metrics;
4475
+ }
4476
+ /**
4477
+ * <p>The results of evaluating an algorithm. Returned as part of the <a>GetAccuracyMetrics</a> response.</p>
4478
+ */
4479
+ export interface EvaluationResult {
4480
+ /**
4481
+ * <p>The Amazon Resource Name (ARN) of the algorithm that was evaluated.</p>
4482
+ */
4483
+ AlgorithmArn?: string;
4484
+ /**
4485
+ * <p>The array of test windows used for evaluating the algorithm. The
4486
+ * <code>NumberOfBacktestWindows</code> from the <a>EvaluationParameters</a> object
4487
+ * determines the number of windows in the array.</p>
4488
+ */
4489
+ TestWindows?: WindowSummary[];
4490
+ }
4491
+ export interface GetAccuracyMetricsResponse {
4492
+ /**
4493
+ * <p>An array of results from evaluating the predictor.</p>
4494
+ */
4495
+ PredictorEvaluationResults?: EvaluationResult[];
4496
+ /**
4497
+ * <p>Whether the predictor was created with <a>CreateAutoPredictor</a>.</p>
4498
+ */
4499
+ IsAutoPredictor?: boolean;
4500
+ /**
4501
+ * <note>
4502
+ * <p> The <code>LatencyOptimized</code> AutoML override strategy is only available in private beta.
4503
+ * Contact AWS Support or your account manager to learn more about access privileges.
4504
+ * </p>
4505
+ * </note>
4506
+ * <p>The AutoML strategy used to train the predictor. Unless <code>LatencyOptimized</code>
4507
+ * is specified, the AutoML strategy optimizes predictor accuracy.</p>
4508
+ * <p>This parameter is only valid for predictors trained using AutoML.</p>
4509
+ */
4510
+ AutoMLOverrideStrategy?: AutoMLOverrideStrategy | string;
4511
+ /**
4512
+ * <p>The accuracy metric used to optimize the predictor.</p>
4513
+ */
4514
+ OptimizationMetric?: OptimizationMetric | string;
4515
+ }
4516
+ /**
4517
+ * <p>The token is not valid. Tokens expire after 24 hours.</p>
4518
+ */
4519
+ export declare class InvalidNextTokenException extends __BaseException {
4520
+ readonly name: "InvalidNextTokenException";
4521
+ readonly $fault: "client";
4522
+ Message?: string;
4523
+ /**
4524
+ * @internal
4525
+ */
4526
+ constructor(opts: __ExceptionOptionType<InvalidNextTokenException, __BaseException>);
4527
+ }
4528
+ export interface ListDatasetGroupsRequest {
4529
+ /**
4530
+ * <p>If the result of the previous request was truncated, the response includes a
4531
+ * <code>NextToken</code>. To retrieve the next set of results, use the token in the next
4532
+ * request. Tokens expire after 24 hours.</p>
4533
+ */
4534
+ NextToken?: string;
4535
+ /**
4536
+ * <p>The number of items to return in the response.</p>
4537
+ */
4538
+ MaxResults?: number;
4539
+ }
4540
+ /**
4541
+ * <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
4542
+ * get the complete set of properties, call the <a href="https://docs.aws.amazon.com/forecast/latest/dg/API_DescribeDatasetGroup.html">DescribeDatasetGroup</a>
4543
+ * operation, and provide the <code>DatasetGroupArn</code>.</p>
4544
+ */
4545
+ export interface DatasetGroupSummary {
4546
+ /**
4547
+ * <p>The Amazon Resource Name (ARN) of the dataset group.</p>
4548
+ */
4549
+ DatasetGroupArn?: string;
4550
+ /**
4551
+ * <p>The name of the dataset group.</p>
4552
+ */
4553
+ DatasetGroupName?: string;
4554
+ /**
4555
+ * <p>When the dataset group was created.</p>
4556
+ */
4557
+ CreationTime?: Date;
4558
+ /**
4559
+ * <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,
4560
+ * <code>LastModificationTime</code> is the current time of the <code>ListDatasetGroups</code>
4561
+ * call.</p>
4562
+ */
4563
+ LastModificationTime?: Date;
4564
+ }
4565
+ export interface ListDatasetGroupsResponse {
4566
+ /**
4567
+ * <p>An array of objects that summarize each dataset group's properties.</p>
4568
+ */
4569
+ DatasetGroups?: DatasetGroupSummary[];
4570
+ /**
4571
+ * <p>If the response is truncated, Amazon Forecast returns this token. To retrieve the next set of
4572
+ * results, use the token in the next request.</p>
4573
+ */
4574
+ NextToken?: string;
4575
+ }
4576
+ export declare enum FilterConditionString {
4577
+ IS = "IS",
4578
+ IS_NOT = "IS_NOT"
4579
+ }
4580
+ /**
4581
+ * <p>Describes a filter for choosing a subset of objects. Each filter consists of a
4582
+ * condition and a match statement. The condition is either <code>IS</code> or
4583
+ * <code>IS_NOT</code>, which specifies whether to include or exclude
4584
+ * the objects that match the statement, respectively. The match statement consists of a key and a
4585
+ * value.</p>
4586
+ */
4587
+ export interface Filter {
4588
+ /**
4589
+ * <p>The name of the parameter to filter on.</p>
4590
+ */
4591
+ Key: string | undefined;
4592
+ /**
4593
+ * <p>The value to match.</p>
4594
+ */
4595
+ Value: string | undefined;
4596
+ /**
4597
+ * <p>The condition to apply. To include the objects that match the statement, specify
4598
+ * <code>IS</code>. To exclude matching objects, specify <code>IS_NOT</code>.</p>
4599
+ */
4600
+ Condition: FilterConditionString | string | undefined;
4601
+ }
4602
+ export interface ListDatasetImportJobsRequest {
4603
+ /**
4604
+ * <p>If the result of the previous request was truncated, the response includes a
4605
+ * <code>NextToken</code>. To retrieve the next set of results, use the token in the next
4606
+ * request. Tokens expire after 24 hours.</p>
4607
+ */
4608
+ NextToken?: string;
4609
+ /**
4610
+ * <p>The number of items to return in the response.</p>
4611
+ */
4612
+ MaxResults?: number;
4613
+ /**
4614
+ * <p>An array of filters. For each filter, you provide a condition and a match statement. The
4615
+ * condition is either <code>IS</code> or <code>IS_NOT</code>, which specifies whether to include
4616
+ * or exclude the datasets that match the statement from the list, respectively. The match
4617
+ * statement consists of a key and a value.</p>
4618
+ * <p>
4619
+ * <b>Filter properties</b>
4620
+ * </p>
4621
+ * <ul>
4622
+ * <li>
4623
+ * <p>
4624
+ * <code>Condition</code> - The condition to apply. Valid values are <code>IS</code> and
4625
+ * <code>IS_NOT</code>. To include the datasets that match the statement, specify
4626
+ * <code>IS</code>. To exclude matching datasets, specify <code>IS_NOT</code>.</p>
4627
+ * </li>
4628
+ * <li>
4629
+ * <p>
4630
+ * <code>Key</code> - The name of the parameter to filter on. Valid values are
4631
+ * <code>DatasetArn</code> and <code>Status</code>.</p>
4632
+ * </li>
4633
+ * <li>
4634
+ * <p>
4635
+ * <code>Value</code> - The value to match.</p>
4636
+ * </li>
4637
+ * </ul>
4638
+ * <p>For example, to list all dataset import jobs whose status is ACTIVE, you specify the
4639
+ * following filter:</p>
4640
+ * <p>
4641
+ * <code>"Filters": [ { "Condition": "IS", "Key": "Status", "Value": "ACTIVE" } ]</code>
4642
+ * </p>
4643
+ */
4644
+ Filters?: Filter[];
4645
+ }
4646
+ /**
4647
+ * <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
4648
+ * <a href="https://docs.aws.amazon.com/forecast/latest/dg/API_DescribeDatasetImportJob.html">DescribeDatasetImportJob</a> operation, and provide the
4649
+ * <code>DatasetImportJobArn</code>.</p>
4650
+ */
4651
+ export interface DatasetImportJobSummary {
4652
+ /**
4653
+ * <p>The Amazon Resource Name (ARN) of the dataset import job.</p>
4654
+ */
4655
+ DatasetImportJobArn?: string;
4656
+ /**
4657
+ * <p>The name of the dataset import job.</p>
4658
+ */
4659
+ DatasetImportJobName?: string;
4660
+ /**
4661
+ * <p>The location of the training data to import and an AWS Identity and Access Management (IAM) role that Amazon Forecast
4662
+ * can assume to access the data. The training data must be stored in an Amazon S3 bucket.</p>
4663
+ * <p>If encryption is used, <code>DataSource</code> includes an AWS Key Management Service (KMS) key.</p>
4664
+ */
4665
+ DataSource?: DataSource;
4666
+ /**
4667
+ * <p>The status of the dataset import job. States include:</p>
4668
+ * <ul>
4669
+ * <li>
4670
+ * <p>
4671
+ * <code>ACTIVE</code>
4672
+ * </p>
4673
+ * </li>
4674
+ * <li>
4675
+ * <p>
4676
+ * <code>CREATE_PENDING</code>, <code>CREATE_IN_PROGRESS</code>,
4677
+ * <code>CREATE_FAILED</code>
4678
+ * </p>
4679
+ * </li>
4680
+ * <li>
4681
+ * <p>
4682
+ * <code>DELETE_PENDING</code>, <code>DELETE_IN_PROGRESS</code>,
4683
+ * <code>DELETE_FAILED</code>
4684
+ * </p>
4685
+ * </li>
4686
+ * <li>
4687
+ * <p>
4688
+ * <code>CREATE_STOPPING</code>, <code>CREATE_STOPPED</code>
4689
+ * </p>
4690
+ * </li>
4691
+ * </ul>
4692
+ */
4693
+ Status?: string;
4694
+ /**
4695
+ * <p>If an error occurred, an informational message about the error.</p>
4696
+ */
4697
+ Message?: string;
4698
+ /**
4699
+ * <p>When the dataset import job was created.</p>
4700
+ */
4701
+ CreationTime?: Date;
4702
+ /**
4703
+ * <p>The last time the resource was modified. The timestamp depends on the status of the
4704
+ * job:</p>
4705
+ * <ul>
4706
+ * <li>
4707
+ * <p>
4708
+ * <code>CREATE_PENDING</code> - The <code>CreationTime</code>.</p>
4709
+ * </li>
4710
+ * <li>
4711
+ * <p>
4712
+ * <code>CREATE_IN_PROGRESS</code> - The current timestamp.</p>
4713
+ * </li>
4714
+ * <li>
4715
+ * <p>
4716
+ * <code>CREATE_STOPPING</code> - The current timestamp.</p>
4717
+ * </li>
4718
+ * <li>
4719
+ * <p>
4720
+ * <code>CREATE_STOPPED</code> - When the job stopped.</p>
4721
+ * </li>
4722
+ * <li>
4723
+ * <p>
4724
+ * <code>ACTIVE</code> or <code>CREATE_FAILED</code> - When the job finished or
4725
+ * failed.</p>
4726
+ * </li>
4727
+ * </ul>
4728
+ */
4729
+ LastModificationTime?: Date;
4730
+ }
4731
+ export interface ListDatasetImportJobsResponse {
4732
+ /**
4733
+ * <p>An array of objects that summarize each dataset import job's properties.</p>
4734
+ */
4735
+ DatasetImportJobs?: DatasetImportJobSummary[];
4736
+ /**
4737
+ * <p>If the response is truncated, Amazon Forecast returns this token. To retrieve the next set of
4738
+ * results, use the token in the next request.</p>
4739
+ */
4740
+ NextToken?: string;
4741
+ }
4742
+ export interface ListDatasetsRequest {
4743
+ /**
4744
+ * <p>If the result of the previous request was truncated, the response includes a
4745
+ * <code>NextToken</code>. To retrieve the next set of results, use the token in the next
4746
+ * request. Tokens expire after 24 hours.</p>
4747
+ */
4748
+ NextToken?: string;
4749
+ /**
4750
+ * <p>The number of items to return in the response.</p>
4751
+ */
4752
+ MaxResults?: number;
4753
+ }
4754
+ /**
4755
+ * <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
4756
+ * complete set of properties, call the <a href="https://docs.aws.amazon.com/forecast/latest/dg/API_DescribeDataset.html">DescribeDataset</a> operation, and
4757
+ * provide the <code>DatasetArn</code>.</p>
4758
+ */
4759
+ export interface DatasetSummary {
4760
+ /**
4761
+ * <p>The Amazon Resource Name (ARN) of the dataset.</p>
4762
+ */
4763
+ DatasetArn?: string;
4764
+ /**
4765
+ * <p>The name of the dataset.</p>
4766
+ */
4767
+ DatasetName?: string;
4768
+ /**
4769
+ * <p>The dataset type.</p>
4770
+ */
4771
+ DatasetType?: DatasetType | string;
4772
+ /**
4773
+ * <p>The domain associated with the dataset.</p>
4774
+ */
4775
+ Domain?: Domain | string;
4776
+ /**
4777
+ * <p>When the dataset was created.</p>
4778
+ */
4779
+ CreationTime?: Date;
4780
+ /**
4781
+ * <p>When you create a dataset, <code>LastModificationTime</code> is the same as
4782
+ * <code>CreationTime</code>. While data is being imported to the dataset,
4783
+ * <code>LastModificationTime</code> is the current time of the <code>ListDatasets</code> call.
4784
+ * After a <a href="https://docs.aws.amazon.com/forecast/latest/dg/API_CreateDatasetImportJob.html">CreateDatasetImportJob</a> operation has finished, <code>LastModificationTime</code> is
4785
+ * when the import job completed or failed.</p>
4786
+ */
4787
+ LastModificationTime?: Date;
4788
+ }
4789
+ export interface ListDatasetsResponse {
4790
+ /**
4791
+ * <p>An array of objects that summarize each dataset's properties.</p>
4792
+ */
4793
+ Datasets?: DatasetSummary[];
4794
+ /**
4795
+ * <p>If the response is truncated, Amazon Forecast returns this token. To retrieve the next set of
4796
+ * results, use the token in the next request.</p>
4797
+ */
4798
+ NextToken?: string;
4799
+ }
4800
+ export interface ListExplainabilitiesRequest {
4801
+ /**
4802
+ * <p>If the result of the previous request was truncated, the response includes a
4803
+ * NextToken. To retrieve the next set of results, use the token in the next request.
4804
+ * Tokens expire after 24 hours.</p>
4805
+ */
4806
+ NextToken?: string;
4807
+ /**
4808
+ * <p>The number of items returned in the response.</p>
4809
+ */
4810
+ MaxResults?: number;
4811
+ /**
4812
+ * <p>An array of filters. For each filter, provide a condition and a match statement. The
4813
+ * condition is either <code>IS</code> or <code>IS_NOT</code>, which specifies whether to
4814
+ * include or exclude the resources that match the statement from the list. The match
4815
+ * statement consists of a key and a value.</p>
4816
+ * <p>
4817
+ * <b>Filter properties</b>
4818
+ * </p>
4819
+ * <ul>
4820
+ * <li>
4821
+ * <p>
4822
+ * <code>Condition</code> - The condition to apply. Valid values are
4823
+ * <code>IS</code> and <code>IS_NOT</code>.</p>
4824
+ * </li>
4825
+ * <li>
4826
+ * <p>
4827
+ * <code>Key</code> - The name of the parameter to filter on. Valid values are
4828
+ * <code>ResourceArn</code> and <code>Status</code>.</p>
4829
+ * </li>
4830
+ * <li>
4831
+ * <p>
4832
+ * <code>Value</code> - The value to match.</p>
4833
+ * </li>
4834
+ * </ul>
4835
+ */
4836
+ Filters?: Filter[];
4837
+ }
4838
+ /**
4839
+ * <p>Provides a summary of the Explainability properties used in the <a>ListExplainabilities</a> operation. To get a complete set of properties,
4840
+ * call the <a>DescribeExplainability</a> operation, and provide the listed
4841
+ * <code>ExplainabilityArn</code>.</p>
4842
+ */
4843
+ export interface ExplainabilitySummary {
4844
+ /**
4845
+ * <p>The Amazon Resource Name (ARN) of the Explainability.</p>
4846
+ */
4847
+ ExplainabilityArn?: string;
4848
+ /**
4849
+ * <p>The name of the Explainability.</p>
4850
+ */
4851
+ ExplainabilityName?: string;
4852
+ /**
4853
+ * <p>The Amazon Resource Name (ARN) of the Predictor or Forecast used to create the
4854
+ * Explainability.</p>
4855
+ */
4856
+ ResourceArn?: string;
4857
+ /**
4858
+ * <p>The configuration settings that define the granularity of time series and time points
4859
+ * for the Explainability.</p>
4860
+ */
4861
+ ExplainabilityConfig?: ExplainabilityConfig;
4862
+ /**
4863
+ * <p>The status of the Explainability. States include: </p>
4864
+ * <ul>
4865
+ * <li>
4866
+ * <p>
4867
+ * <code>ACTIVE</code>
4868
+ * </p>
4869
+ * </li>
4870
+ * <li>
4871
+ * <p>
4872
+ * <code>CREATE_PENDING</code>, <code>CREATE_IN_PROGRESS</code>,
4873
+ * <code>CREATE_FAILED</code>
4874
+ * </p>
4875
+ * </li>
4876
+ * <li>
4877
+ * <p>
4878
+ * <code>CREATE_STOPPING</code>, <code>CREATE_STOPPED</code>
4879
+ * </p>
4880
+ * </li>
4881
+ * <li>
4882
+ * <p>
4883
+ * <code>DELETE_PENDING</code>, <code>DELETE_IN_PROGRESS</code>,
4884
+ * <code>DELETE_FAILED</code>
4885
+ * </p>
4886
+ * </li>
4887
+ * </ul>
4888
+ */
4889
+ Status?: string;
4890
+ /**
4891
+ * <p>Information about any errors that may have occurred during the Explainability creation
4892
+ * process.</p>
4893
+ */
4894
+ Message?: string;
4895
+ /**
4896
+ * <p>When the Explainability was created.</p>
4897
+ */
4898
+ CreationTime?: Date;
4899
+ /**
4900
+ * <p>The last time the resource was modified. The timestamp depends on the status of the
4901
+ * job:</p>
4902
+ * <ul>
4903
+ * <li>
4904
+ * <p>
4905
+ * <code>CREATE_PENDING</code> - The <code>CreationTime</code>.</p>
4906
+ * </li>
4907
+ * <li>
4908
+ * <p>
4909
+ * <code>CREATE_IN_PROGRESS</code> - The current timestamp.</p>
4910
+ * </li>
4911
+ * <li>
4912
+ * <p>
4913
+ * <code>CREATE_STOPPING</code> - The current timestamp.</p>
4914
+ * </li>
4915
+ * <li>
4916
+ * <p>
4917
+ * <code>CREATE_STOPPED</code> - When the job stopped.</p>
4918
+ * </li>
4919
+ * <li>
4920
+ * <p>
4921
+ * <code>ACTIVE</code> or <code>CREATE_FAILED</code> - When the job finished or
4922
+ * failed.</p>
4923
+ * </li>
4924
+ * </ul>
4925
+ */
4926
+ LastModificationTime?: Date;
4927
+ }
4928
+ export interface ListExplainabilitiesResponse {
4929
+ /**
4930
+ * <p>An array of objects that summarize the properties of each Explainability
4931
+ * resource.</p>
4932
+ */
4933
+ Explainabilities?: ExplainabilitySummary[];
4934
+ /**
4935
+ * <p>Returns this token if the response is truncated. To retrieve the next set of results,
4936
+ * use the token in the next request.</p>
4937
+ */
4938
+ NextToken?: string;
4939
+ }
4940
+ export interface ListExplainabilityExportsRequest {
4941
+ /**
4942
+ * <p>If the result of the previous request was truncated, the response includes a
4943
+ * NextToken. To retrieve the next set of results, use the token in the next request.
4944
+ * Tokens expire after 24 hours.</p>
4945
+ */
4946
+ NextToken?: string;
4947
+ /**
4948
+ * <p>The number of items to return in the response.</p>
4949
+ */
4950
+ MaxResults?: number;
4951
+ /**
4952
+ * <p>An array of filters. For each filter, provide a condition and a match statement. The
4953
+ * condition is either <code>IS</code> or <code>IS_NOT</code>, which specifies whether to
4954
+ * include or exclude resources that match the statement from the list. The match statement
4955
+ * consists of a key and a value.</p>
4956
+ * <p>
4957
+ * <b>Filter properties</b>
4958
+ * </p>
4959
+ * <ul>
4960
+ * <li>
4961
+ * <p>
4962
+ * <code>Condition</code> - The condition to apply. Valid values are
4963
+ * <code>IS</code> and <code>IS_NOT</code>.</p>
4964
+ * </li>
4965
+ * <li>
4966
+ * <p>
4967
+ * <code>Key</code> - The name of the parameter to filter on. Valid values are
4968
+ * <code>ResourceArn</code> and <code>Status</code>.</p>
4969
+ * </li>
4970
+ * <li>
4971
+ * <p>
4972
+ * <code>Value</code> - The value to match.</p>
4973
+ * </li>
4974
+ * </ul>
4975
+ */
4976
+ Filters?: Filter[];
4977
+ }
4978
+ /**
4979
+ * <p>Provides a summary of the Explainability export properties used in the <a>ListExplainabilityExports</a> operation. To get a complete set of
4980
+ * properties, call the <a>DescribeExplainabilityExport</a> operation, and
4981
+ * provide the <code>ExplainabilityExportArn</code>.</p>
4982
+ */
4983
+ export interface ExplainabilityExportSummary {
4984
+ /**
4985
+ * <p>The Amazon Resource Name (ARN) of the Explainability export.</p>
4986
+ */
4987
+ ExplainabilityExportArn?: string;
4988
+ /**
4989
+ * <p>The name of the Explainability export</p>
4990
+ */
4991
+ ExplainabilityExportName?: string;
4992
+ /**
4993
+ * <p>The destination for an export job. Provide an S3 path, an AWS Identity and Access Management (IAM) role that allows Amazon Forecast
4994
+ * to access the location, and an AWS Key Management Service (KMS) key (optional). </p>
4995
+ */
4996
+ Destination?: DataDestination;
4997
+ /**
4998
+ * <p>The status of the Explainability export. States include: </p>
4999
+ * <ul>
5000
+ * <li>
5001
+ * <p>
5002
+ * <code>ACTIVE</code>
5003
+ * </p>
5004
+ * </li>
5005
+ * <li>
5006
+ * <p>
5007
+ * <code>CREATE_PENDING</code>, <code>CREATE_IN_PROGRESS</code>,
5008
+ * <code>CREATE_FAILED</code>
5009
+ * </p>
5010
+ * </li>
5011
+ * <li>
5012
+ * <p>
5013
+ * <code>CREATE_STOPPING</code>, <code>CREATE_STOPPED</code>
5014
+ * </p>
5015
+ * </li>
5016
+ * <li>
5017
+ * <p>
5018
+ * <code>DELETE_PENDING</code>, <code>DELETE_IN_PROGRESS</code>,
5019
+ * <code>DELETE_FAILED</code>
5020
+ * </p>
5021
+ * </li>
5022
+ * </ul>
5023
+ */
5024
+ Status?: string;
5025
+ /**
5026
+ * <p>Information about any errors that may have occurred during the Explainability
5027
+ * export.</p>
5028
+ */
5029
+ Message?: string;
5030
+ /**
5031
+ * <p>When the Explainability was created.</p>
4233
5032
  */
4234
5033
  CreationTime?: Date;
4235
5034
  /**
4236
- * <p>When you create a dataset, <code>LastModificationTime</code> is the same as
4237
- * <code>CreationTime</code>. While data is being imported to the dataset,
4238
- * <code>LastModificationTime</code> is the current time of the <code>ListDatasets</code> call.
4239
- * After a <a href="https://docs.aws.amazon.com/forecast/latest/dg/API_CreateDatasetImportJob.html">CreateDatasetImportJob</a> operation has finished, <code>LastModificationTime</code> is
4240
- * when the import job completed or failed.</p>
5035
+ * <p>The last time the resource was modified. The timestamp depends on the status of the
5036
+ * job:</p>
5037
+ * <ul>
5038
+ * <li>
5039
+ * <p>
5040
+ * <code>CREATE_PENDING</code> - The <code>CreationTime</code>.</p>
5041
+ * </li>
5042
+ * <li>
5043
+ * <p>
5044
+ * <code>CREATE_IN_PROGRESS</code> - The current timestamp.</p>
5045
+ * </li>
5046
+ * <li>
5047
+ * <p>
5048
+ * <code>CREATE_STOPPING</code> - The current timestamp.</p>
5049
+ * </li>
5050
+ * <li>
5051
+ * <p>
5052
+ * <code>CREATE_STOPPED</code> - When the job stopped.</p>
5053
+ * </li>
5054
+ * <li>
5055
+ * <p>
5056
+ * <code>ACTIVE</code> or <code>CREATE_FAILED</code> - When the job finished or
5057
+ * failed.</p>
5058
+ * </li>
5059
+ * </ul>
4241
5060
  */
4242
5061
  LastModificationTime?: Date;
4243
5062
  }
4244
- export interface ListDatasetsResponse {
5063
+ export interface ListExplainabilityExportsResponse {
4245
5064
  /**
4246
- * <p>An array of objects that summarize each dataset's properties.</p>
5065
+ * <p>An array of objects that summarize the properties of each Explainability
5066
+ * export.</p>
4247
5067
  */
4248
- Datasets?: DatasetSummary[];
5068
+ ExplainabilityExports?: ExplainabilityExportSummary[];
5069
+ /**
5070
+ * <p>Returns this token if the response is truncated. To retrieve the next set of results,
5071
+ * use the token in the next request.</p>
5072
+ */
5073
+ NextToken?: string;
5074
+ }
5075
+ export interface ListForecastExportJobsRequest {
5076
+ /**
5077
+ * <p>If the result of the previous request was truncated, the response includes a
5078
+ * <code>NextToken</code>. To retrieve the next set of results, use the token in the next
5079
+ * request. Tokens expire after 24 hours.</p>
5080
+ */
5081
+ NextToken?: string;
5082
+ /**
5083
+ * <p>The number of items to return in the response.</p>
5084
+ */
5085
+ MaxResults?: number;
5086
+ /**
5087
+ * <p>An array of filters. For each filter, you provide a condition and a match statement. The
5088
+ * condition is either <code>IS</code> or <code>IS_NOT</code>, which specifies whether to include
5089
+ * or exclude the forecast export jobs that match the statement from the list, respectively. The
5090
+ * match statement consists of a key and a value.</p>
5091
+ * <p>
5092
+ * <b>Filter properties</b>
5093
+ * </p>
5094
+ * <ul>
5095
+ * <li>
5096
+ * <p>
5097
+ * <code>Condition</code> - The condition to apply. Valid values are <code>IS</code> and
5098
+ * <code>IS_NOT</code>. To include the forecast export jobs that match the statement,
5099
+ * specify <code>IS</code>. To exclude matching forecast export jobs, specify
5100
+ * <code>IS_NOT</code>.</p>
5101
+ * </li>
5102
+ * <li>
5103
+ * <p>
5104
+ * <code>Key</code> - The name of the parameter to filter on. Valid values are
5105
+ * <code>ForecastArn</code> and <code>Status</code>.</p>
5106
+ * </li>
5107
+ * <li>
5108
+ * <p>
5109
+ * <code>Value</code> - The value to match.</p>
5110
+ * </li>
5111
+ * </ul>
5112
+ * <p>For example, to list all jobs that export a forecast named
5113
+ * <i>electricityforecast</i>, specify the following filter:</p>
5114
+ * <p>
5115
+ * <code>"Filters": [ { "Condition": "IS", "Key": "ForecastArn", "Value":
5116
+ * "arn:aws:forecast:us-west-2:<acct-id>:forecast/electricityforecast" } ]</code>
5117
+ * </p>
5118
+ */
5119
+ Filters?: Filter[];
5120
+ }
5121
+ /**
5122
+ * <p>Provides a summary of the forecast export job properties used in the <a>ListForecastExportJobs</a> operation. To get the complete set of properties, call
5123
+ * the <a>DescribeForecastExportJob</a> operation, and provide the listed
5124
+ * <code>ForecastExportJobArn</code>.</p>
5125
+ */
5126
+ export interface ForecastExportJobSummary {
5127
+ /**
5128
+ * <p>The Amazon Resource Name (ARN) of the forecast export job.</p>
5129
+ */
5130
+ ForecastExportJobArn?: string;
5131
+ /**
5132
+ * <p>The name of the forecast export job.</p>
5133
+ */
5134
+ ForecastExportJobName?: string;
5135
+ /**
5136
+ * <p>The path to the Amazon Simple Storage Service (Amazon S3) bucket where the forecast is exported.</p>
5137
+ */
5138
+ Destination?: DataDestination;
5139
+ /**
5140
+ * <p>The status of the forecast export job. States include:</p>
5141
+ * <ul>
5142
+ * <li>
5143
+ * <p>
5144
+ * <code>ACTIVE</code>
5145
+ * </p>
5146
+ * </li>
5147
+ * <li>
5148
+ * <p>
5149
+ * <code>CREATE_PENDING</code>, <code>CREATE_IN_PROGRESS</code>,
5150
+ * <code>CREATE_FAILED</code>
5151
+ * </p>
5152
+ * </li>
5153
+ * <li>
5154
+ * <p>
5155
+ * <code>CREATE_STOPPING</code>, <code>CREATE_STOPPED</code>
5156
+ * </p>
5157
+ * </li>
5158
+ * <li>
5159
+ * <p>
5160
+ * <code>DELETE_PENDING</code>, <code>DELETE_IN_PROGRESS</code>,
5161
+ * <code>DELETE_FAILED</code>
5162
+ * </p>
5163
+ * </li>
5164
+ * </ul>
5165
+ * <note>
5166
+ * <p>The <code>Status</code> of the forecast export job must be <code>ACTIVE</code> before
5167
+ * you can access the forecast in your S3 bucket.</p>
5168
+ * </note>
5169
+ */
5170
+ Status?: string;
5171
+ /**
5172
+ * <p>If an error occurred, an informational message about the error.</p>
5173
+ */
5174
+ Message?: string;
5175
+ /**
5176
+ * <p>When the forecast export job was created.</p>
5177
+ */
5178
+ CreationTime?: Date;
5179
+ /**
5180
+ * <p>The last time the resource was modified. The timestamp depends on the status of the job:</p>
5181
+ * <ul>
5182
+ * <li>
5183
+ * <p>
5184
+ * <code>CREATE_PENDING</code> - The <code>CreationTime</code>.</p>
5185
+ * </li>
5186
+ * <li>
5187
+ * <p>
5188
+ * <code>CREATE_IN_PROGRESS</code> - The current timestamp.</p>
5189
+ * </li>
5190
+ * <li>
5191
+ * <p>
5192
+ * <code>CREATE_STOPPING</code> - The current timestamp.</p>
5193
+ * </li>
5194
+ * <li>
5195
+ * <p>
5196
+ * <code>CREATE_STOPPED</code> - When the job stopped.</p>
5197
+ * </li>
5198
+ * <li>
5199
+ * <p>
5200
+ * <code>ACTIVE</code> or <code>CREATE_FAILED</code> - When the job finished or
5201
+ * failed.</p>
5202
+ * </li>
5203
+ * </ul>
5204
+ */
5205
+ LastModificationTime?: Date;
5206
+ }
5207
+ export interface ListForecastExportJobsResponse {
5208
+ /**
5209
+ * <p>An array of objects that summarize each export job's properties.</p>
5210
+ */
5211
+ ForecastExportJobs?: ForecastExportJobSummary[];
4249
5212
  /**
4250
5213
  * <p>If the response is truncated, Amazon Forecast returns this token. To retrieve the next set of
4251
5214
  * results, use the token in the next request.</p>
4252
5215
  */
4253
5216
  NextToken?: string;
4254
5217
  }
4255
- export interface ListExplainabilitiesRequest {
5218
+ export interface ListForecastsRequest {
4256
5219
  /**
4257
5220
  * <p>If the result of the previous request was truncated, the response includes a
4258
- * NextToken. To retrieve the next set of results, use the token in the next request.
4259
- * Tokens expire after 24 hours.</p>
5221
+ * <code>NextToken</code>. To retrieve the next set of results, use the token in the next
5222
+ * request. Tokens expire after 24 hours.</p>
4260
5223
  */
4261
5224
  NextToken?: string;
4262
5225
  /**
4263
- * <p>The number of items returned in the response.</p>
5226
+ * <p>The number of items to return in the response.</p>
4264
5227
  */
4265
5228
  MaxResults?: number;
4266
5229
  /**
4267
- * <p>An array of filters. For each filter, provide a condition and a match statement. The
4268
- * condition is either <code>IS</code> or <code>IS_NOT</code>, which specifies whether to
4269
- * include or exclude the resources that match the statement from the list. The match
4270
- * statement consists of a key and a value.</p>
4271
- * <p>
5230
+ * <p>An array of filters. For each filter, you provide a condition and a match statement. The
5231
+ * condition is either <code>IS</code> or <code>IS_NOT</code>, which specifies whether to include
5232
+ * or exclude the forecasts that match the statement from the list, respectively. The match
5233
+ * statement consists of a key and a value.</p>
5234
+ * <p>
4272
5235
  * <b>Filter properties</b>
4273
- * </p>
4274
- * <ul>
5236
+ * </p>
5237
+ * <ul>
4275
5238
  * <li>
4276
- * <p>
4277
- * <code>Condition</code> - The condition to apply. Valid values are
4278
- * <code>IS</code> and <code>IS_NOT</code>.</p>
5239
+ * <p>
5240
+ * <code>Condition</code> - The condition to apply. Valid values are <code>IS</code> and
5241
+ * <code>IS_NOT</code>. To include the forecasts that match the statement, specify
5242
+ * <code>IS</code>. To exclude matching forecasts, specify <code>IS_NOT</code>.</p>
4279
5243
  * </li>
4280
5244
  * <li>
4281
- * <p>
5245
+ * <p>
4282
5246
  * <code>Key</code> - The name of the parameter to filter on. Valid values are
4283
- * <code>ResourceArn</code> and <code>Status</code>.</p>
5247
+ * <code>DatasetGroupArn</code>, <code>PredictorArn</code>, and <code>Status</code>.</p>
4284
5248
  * </li>
4285
5249
  * <li>
4286
- * <p>
5250
+ * <p>
4287
5251
  * <code>Value</code> - The value to match.</p>
4288
5252
  * </li>
4289
5253
  * </ul>
5254
+ * <p>For example, to list all forecasts whose status is not ACTIVE, you would specify:</p>
5255
+ * <p>
5256
+ * <code>"Filters": [ { "Condition": "IS_NOT", "Key": "Status", "Value": "ACTIVE" }
5257
+ * ]</code>
5258
+ * </p>
4290
5259
  */
4291
5260
  Filters?: Filter[];
4292
5261
  }
4293
5262
  /**
4294
- * <p>Provides a summary of the Explainability properties used in the <a>ListExplainabilities</a> operation. To get a complete set of properties,
4295
- * call the <a>DescribeExplainability</a> operation, and provide the listed
4296
- * <code>ExplainabilityArn</code>.</p>
5263
+ * <p>Provides a summary of the forecast properties used in the <a>ListForecasts</a>
5264
+ * operation. To get the complete set of properties, call the <a>DescribeForecast</a>
5265
+ * operation, and provide the <code>ForecastArn</code> that is listed in the summary.</p>
4297
5266
  */
4298
- export interface ExplainabilitySummary {
5267
+ export interface ForecastSummary {
4299
5268
  /**
4300
- * <p>The Amazon Resource Name (ARN) of the Explainability.</p>
5269
+ * <p>The ARN of the forecast.</p>
4301
5270
  */
4302
- ExplainabilityArn?: string;
5271
+ ForecastArn?: string;
4303
5272
  /**
4304
- * <p>The name of the Explainability.</p>
5273
+ * <p>The name of the forecast.</p>
4305
5274
  */
4306
- ExplainabilityName?: string;
5275
+ ForecastName?: string;
4307
5276
  /**
4308
- * <p>The Amazon Resource Name (ARN) of the Predictor or Forecast used to create the
4309
- * Explainability.</p>
5277
+ * <p>The ARN of the predictor used to generate the forecast.</p>
4310
5278
  */
4311
- ResourceArn?: string;
5279
+ PredictorArn?: string;
4312
5280
  /**
4313
- * <p>The configuration settings that define the granularity of time series and time points
4314
- * for the Explainability.</p>
5281
+ * <p>Whether the Forecast was created from an AutoPredictor.</p>
4315
5282
  */
4316
- ExplainabilityConfig?: ExplainabilityConfig;
5283
+ CreatedUsingAutoPredictor?: boolean;
4317
5284
  /**
4318
- * <p>The status of the Explainability. States include: </p>
4319
- * <ul>
5285
+ * <p>The Amazon Resource Name (ARN) of the dataset group that provided the data used to train
5286
+ * the predictor.</p>
5287
+ */
5288
+ DatasetGroupArn?: string;
5289
+ /**
5290
+ * <p>The status of the forecast. States include:</p>
5291
+ * <ul>
4320
5292
  * <li>
4321
- * <p>
4322
- * <code>ACTIVE</code>
4323
- * </p>
5293
+ * <p>
5294
+ * <code>ACTIVE</code>
5295
+ * </p>
4324
5296
  * </li>
4325
5297
  * <li>
4326
- * <p>
5298
+ * <p>
4327
5299
  * <code>CREATE_PENDING</code>, <code>CREATE_IN_PROGRESS</code>,
4328
- * <code>CREATE_FAILED</code>
5300
+ * <code>CREATE_FAILED</code>
4329
5301
  * </p>
4330
5302
  * </li>
4331
5303
  * <li>
4332
- * <p>
4333
- * <code>CREATE_STOPPING</code>, <code>CREATE_STOPPED</code>
4334
- * </p>
5304
+ * <p>
5305
+ * <code>CREATE_STOPPING</code>, <code>CREATE_STOPPED</code>
5306
+ * </p>
4335
5307
  * </li>
4336
5308
  * <li>
4337
- * <p>
5309
+ * <p>
4338
5310
  * <code>DELETE_PENDING</code>, <code>DELETE_IN_PROGRESS</code>,
4339
- * <code>DELETE_FAILED</code>
5311
+ * <code>DELETE_FAILED</code>
4340
5312
  * </p>
4341
5313
  * </li>
4342
5314
  * </ul>
5315
+ * <note>
5316
+ * <p>The <code>Status</code> of the forecast must be <code>ACTIVE</code> before you can query
5317
+ * or export the forecast.</p>
5318
+ * </note>
4343
5319
  */
4344
5320
  Status?: string;
4345
5321
  /**
4346
- * <p>Information about any errors that may have occurred during the Explainability creation
4347
- * process.</p>
5322
+ * <p>If an error occurred, an informational message about the error.</p>
4348
5323
  */
4349
5324
  Message?: string;
4350
5325
  /**
4351
- * <p>When the Explainability was created.</p>
5326
+ * <p>When the forecast creation task was created.</p>
4352
5327
  */
4353
5328
  CreationTime?: Date;
4354
5329
  /**
4355
- * <p>The last time the resource was modified. The timestamp depends on the status of the
4356
- * job:</p>
4357
- * <ul>
5330
+ * <p>The last time the resource was modified. The timestamp depends on the status of the job:</p>
5331
+ * <ul>
4358
5332
  * <li>
4359
- * <p>
5333
+ * <p>
4360
5334
  * <code>CREATE_PENDING</code> - The <code>CreationTime</code>.</p>
4361
5335
  * </li>
4362
5336
  * <li>
4363
- * <p>
5337
+ * <p>
4364
5338
  * <code>CREATE_IN_PROGRESS</code> - The current timestamp.</p>
4365
5339
  * </li>
4366
5340
  * <li>
4367
- * <p>
5341
+ * <p>
4368
5342
  * <code>CREATE_STOPPING</code> - The current timestamp.</p>
4369
5343
  * </li>
4370
5344
  * <li>
4371
- * <p>
5345
+ * <p>
4372
5346
  * <code>CREATE_STOPPED</code> - When the job stopped.</p>
4373
5347
  * </li>
4374
5348
  * <li>
4375
- * <p>
5349
+ * <p>
4376
5350
  * <code>ACTIVE</code> or <code>CREATE_FAILED</code> - When the job finished or
4377
- * failed.</p>
5351
+ * failed.</p>
4378
5352
  * </li>
4379
5353
  * </ul>
4380
5354
  */
4381
5355
  LastModificationTime?: Date;
4382
5356
  }
4383
- export interface ListExplainabilitiesResponse {
5357
+ export interface ListForecastsResponse {
4384
5358
  /**
4385
- * <p>An array of objects that summarize the properties of each Explainability
4386
- * resource.</p>
5359
+ * <p>An array of objects that summarize each forecast's properties.</p>
4387
5360
  */
4388
- Explainabilities?: ExplainabilitySummary[];
5361
+ Forecasts?: ForecastSummary[];
4389
5362
  /**
4390
- * <p>Returns this token if the response is truncated. To retrieve the next set of results,
4391
- * use the token in the next request.</p>
5363
+ * <p>If the response is truncated, Amazon Forecast returns this token. To retrieve the next set
5364
+ * of results, use the token in the next request.</p>
4392
5365
  */
4393
5366
  NextToken?: string;
4394
5367
  }
4395
- export interface ListExplainabilityExportsRequest {
5368
+ export interface ListMonitorEvaluationsRequest {
4396
5369
  /**
4397
5370
  * <p>If the result of the previous request was truncated, the response includes a
4398
- * NextToken. To retrieve the next set of results, use the token in the next request.
4399
- * Tokens expire after 24 hours.</p>
5371
+ * <code>NextToken</code>. To retrieve the next set of results, use the token in the next
5372
+ * request. Tokens expire after 24 hours.</p>
4400
5373
  */
4401
5374
  NextToken?: string;
4402
5375
  /**
4403
- * <p>The number of items to return in the response.</p>
5376
+ * <p>The maximum number of monitoring results to return.</p>
4404
5377
  */
4405
5378
  MaxResults?: number;
5379
+ /**
5380
+ * <p>The Amazon Resource Name (ARN) of the monitor resource to get results from.</p>
5381
+ */
5382
+ MonitorArn: string | undefined;
4406
5383
  /**
4407
5384
  * <p>An array of filters. For each filter, provide a condition and a match statement. The
4408
- * condition is either <code>IS</code> or <code>IS_NOT</code>, which specifies whether to
4409
- * include or exclude resources that match the statement from the list. The match statement
4410
- * consists of a key and a value.</p>
4411
- * <p>
5385
+ * condition is either <code>IS</code> or <code>IS_NOT</code>, which specifies whether to
5386
+ * include or exclude the resources that match the statement from the list. The match
5387
+ * statement consists of a key and a value.</p>
5388
+ * <p>
4412
5389
  * <b>Filter properties</b>
4413
- * </p>
4414
- * <ul>
5390
+ * </p>
5391
+ * <ul>
5392
+ * <li>
5393
+ * <p>
5394
+ * <code>Condition</code> - The condition to apply. Valid values are
5395
+ * <code>IS</code> and <code>IS_NOT</code>.</p>
5396
+ * </li>
5397
+ * <li>
5398
+ * <p>
5399
+ * <code>Key</code> - The name of the parameter to filter on. The only valid value is
5400
+ * <code>EvaluationState</code>.</p>
5401
+ * </li>
5402
+ * <li>
5403
+ * <p>
5404
+ * <code>Value</code> - The value to match. Valid values are only <code>SUCCESS</code> or <code>FAILURE</code>.</p>
5405
+ * </li>
5406
+ * </ul>
5407
+ * <p>For example, to list only successful monitor evaluations, you would specify:</p>
5408
+ * <p>
5409
+ * <code>"Filters": [ { "Condition": "IS", "Key": "EvaluationState", "Value": "SUCCESS" } ]</code>
5410
+ * </p>
5411
+ */
5412
+ Filters?: Filter[];
5413
+ }
5414
+ /**
5415
+ * <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>
5416
+ * <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>
5417
+ * </p>
5418
+ */
5419
+ export interface MetricResult {
5420
+ /**
5421
+ * <p>The name of the metric.</p>
5422
+ */
5423
+ MetricName?: string;
5424
+ /**
5425
+ * <p>The value for the metric.</p>
5426
+ */
5427
+ MetricValue?: number;
5428
+ }
5429
+ /**
5430
+ * <p>The source of the data the monitor used during the evaluation.</p>
5431
+ */
5432
+ export interface MonitorDataSource {
5433
+ /**
5434
+ * <p>The Amazon Resource Name (ARN) of the dataset import job used to import the data that initiated the monitor evaluation.</p>
5435
+ */
5436
+ DatasetImportJobArn?: string;
5437
+ /**
5438
+ * <p>The Amazon Resource Name (ARN) of the forecast the monitor used during the evaluation.</p>
5439
+ */
5440
+ ForecastArn?: string;
5441
+ /**
5442
+ * <p>The Amazon Resource Name (ARN) of the predictor resource you are monitoring.</p>
5443
+ */
5444
+ PredictorArn?: string;
5445
+ }
5446
+ /**
5447
+ * <p>Provides details about a predictor event, such as a retraining.</p>
5448
+ */
5449
+ export interface PredictorEvent {
5450
+ /**
5451
+ * <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>
5452
+ */
5453
+ Detail?: string;
5454
+ /**
5455
+ * <p>The timestamp for when the event occurred.</p>
5456
+ */
5457
+ Datetime?: Date;
5458
+ }
5459
+ /**
5460
+ * <p>Describes the results of a monitor evaluation.</p>
5461
+ */
5462
+ export interface PredictorMonitorEvaluation {
5463
+ /**
5464
+ * <p>The Amazon Resource Name (ARN) of the resource to monitor.</p>
5465
+ */
5466
+ ResourceArn?: string;
5467
+ /**
5468
+ * <p>The Amazon Resource Name (ARN) of the monitor resource.</p>
5469
+ */
5470
+ MonitorArn?: string;
5471
+ /**
5472
+ * <p>The timestamp that indicates when the monitor evaluation was started. </p>
5473
+ */
5474
+ EvaluationTime?: Date;
5475
+ /**
5476
+ * <p>The status of the monitor evaluation. The state can be <code>SUCCESS</code> or <code>FAILURE</code>.</p>
5477
+ */
5478
+ EvaluationState?: string;
5479
+ /**
5480
+ * <p>The timestamp that indicates the start of the window that is used for monitor evaluation.</p>
5481
+ */
5482
+ WindowStartDatetime?: Date;
5483
+ /**
5484
+ * <p>The timestamp that indicates the end of the window that is used for monitor evaluation.</p>
5485
+ */
5486
+ WindowEndDatetime?: Date;
5487
+ /**
5488
+ * <p>Provides details about a predictor event, such as a retraining.</p>
5489
+ */
5490
+ PredictorEvent?: PredictorEvent;
5491
+ /**
5492
+ * <p>The source of the data the monitor resource used during the evaluation.</p>
5493
+ */
5494
+ MonitorDataSource?: MonitorDataSource;
5495
+ /**
5496
+ * <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>
5497
+ */
5498
+ MetricResults?: MetricResult[];
5499
+ /**
5500
+ * <p>The number of items considered during the evaluation.</p>
5501
+ */
5502
+ NumItemsEvaluated?: number;
5503
+ /**
5504
+ * <p>Information about any errors that may have occurred during the monitor evaluation.</p>
5505
+ */
5506
+ Message?: string;
5507
+ }
5508
+ export interface ListMonitorEvaluationsResponse {
5509
+ /**
5510
+ * <p>If the response is truncated, Amazon Forecast returns this token. To retrieve the next set of
5511
+ * results, use the token in the next request. Tokens expire after 24 hours.</p>
5512
+ */
5513
+ NextToken?: string;
5514
+ /**
5515
+ * <p>The monitoring results and predictor events collected by the monitor resource during different windows of time.</p>
5516
+ * <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>
5517
+ */
5518
+ PredictorMonitorEvaluations?: PredictorMonitorEvaluation[];
5519
+ }
5520
+ export interface ListMonitorsRequest {
5521
+ /**
5522
+ * <p>If the result of the previous request was truncated, the response includes a
5523
+ * <code>NextToken</code>. To retrieve the next set of results, use the token in the next
5524
+ * request. Tokens expire after 24 hours.</p>
5525
+ */
5526
+ NextToken?: string;
5527
+ /**
5528
+ * <p>The maximum number of monitors to include in the response.</p>
5529
+ */
5530
+ MaxResults?: number;
5531
+ /**
5532
+ * <p>An array of filters. For each filter, provide a condition and a match statement. The
5533
+ * condition is either <code>IS</code> or <code>IS_NOT</code>, which specifies whether to
5534
+ * include or exclude the resources that match the statement from the list. The match
5535
+ * statement consists of a key and a value.</p>
5536
+ * <p>
5537
+ * <b>Filter properties</b>
5538
+ * </p>
5539
+ * <ul>
4415
5540
  * <li>
4416
- * <p>
5541
+ * <p>
4417
5542
  * <code>Condition</code> - The condition to apply. Valid values are
4418
- * <code>IS</code> and <code>IS_NOT</code>.</p>
5543
+ * <code>IS</code> and <code>IS_NOT</code>.</p>
4419
5544
  * </li>
4420
5545
  * <li>
4421
- * <p>
4422
- * <code>Key</code> - The name of the parameter to filter on. Valid values are
4423
- * <code>ResourceArn</code> and <code>Status</code>.</p>
5546
+ * <p>
5547
+ * <code>Key</code> - The name of the parameter to filter on. The only valid value is
5548
+ * <code>Status</code>.</p>
4424
5549
  * </li>
4425
5550
  * <li>
4426
- * <p>
5551
+ * <p>
4427
5552
  * <code>Value</code> - The value to match.</p>
4428
5553
  * </li>
4429
5554
  * </ul>
5555
+ * <p>For example, to list all monitors who's status is ACTIVE, you would specify:</p>
5556
+ * <p>
5557
+ * <code>"Filters": [ { "Condition": "IS", "Key": "Status", "Value": "ACTIVE" } ]</code>
5558
+ * </p>
4430
5559
  */
4431
5560
  Filters?: Filter[];
4432
5561
  }
4433
5562
  /**
4434
- * <p>Provides a summary of the Explainability export properties used in the <a>ListExplainabilityExports</a> operation. To get a complete set of
4435
- * properties, call the <a>DescribeExplainabilityExport</a> operation, and
4436
- * provide the <code>ExplainabilityExportArn</code>.</p>
5563
+ * <p>Provides a summary of the monitor properties used in the <a>ListMonitors</a> operation. To get a complete set of properties,
5564
+ * call the <a>DescribeMonitor</a> operation, and provide the listed
5565
+ * <code>MonitorArn</code>.</p>
4437
5566
  */
4438
- export interface ExplainabilityExportSummary {
5567
+ export interface MonitorSummary {
4439
5568
  /**
4440
- * <p>The Amazon Resource Name (ARN) of the Explainability export.</p>
5569
+ * <p>The Amazon Resource Name (ARN) of the monitor resource.</p>
4441
5570
  */
4442
- ExplainabilityExportArn?: string;
5571
+ MonitorArn?: string;
4443
5572
  /**
4444
- * <p>The name of the Explainability export</p>
5573
+ * <p>The name of the monitor resource.</p>
4445
5574
  */
4446
- ExplainabilityExportName?: string;
5575
+ MonitorName?: string;
4447
5576
  /**
4448
- * <p>The destination for an export job. Provide an S3 path, an AWS Identity and Access Management (IAM) role that allows Amazon Forecast
4449
- * to access the location, and an AWS Key Management Service (KMS) key (optional). </p>
5577
+ * <p>The Amazon Resource Name (ARN) of the predictor being monitored.</p>
4450
5578
  */
4451
- Destination?: DataDestination;
5579
+ ResourceArn?: string;
4452
5580
  /**
4453
- * <p>The status of the Explainability export. States include: </p>
4454
- * <ul>
5581
+ * <p>The status of the monitor. States include:</p>
5582
+ * <ul>
4455
5583
  * <li>
4456
- * <p>
4457
- * <code>ACTIVE</code>
4458
- * </p>
5584
+ * <p>
5585
+ * <code>ACTIVE</code>
5586
+ * </p>
4459
5587
  * </li>
4460
5588
  * <li>
4461
- * <p>
4462
- * <code>CREATE_PENDING</code>, <code>CREATE_IN_PROGRESS</code>,
4463
- * <code>CREATE_FAILED</code>
5589
+ * <p>
5590
+ * <code>ACTIVE_STOPPING</code>, <code>ACTIVE_STOPPED</code>
4464
5591
  * </p>
4465
5592
  * </li>
4466
5593
  * <li>
4467
- * <p>
4468
- * <code>CREATE_STOPPING</code>, <code>CREATE_STOPPED</code>
4469
- * </p>
5594
+ * <p>
5595
+ * <code>UPDATE_IN_PROGRESS</code>
5596
+ * </p>
4470
5597
  * </li>
4471
5598
  * <li>
4472
- * <p>
4473
- * <code>DELETE_PENDING</code>, <code>DELETE_IN_PROGRESS</code>,
4474
- * <code>DELETE_FAILED</code>
5599
+ * <p>
5600
+ * <code>CREATE_PENDING</code>, <code>CREATE_IN_PROGRESS</code>, <code>CREATE_FAILED</code>
5601
+ * </p>
5602
+ * </li>
5603
+ * <li>
5604
+ * <p>
5605
+ * <code>DELETE_PENDING</code>, <code>DELETE_IN_PROGRESS</code>, <code>DELETE_FAILED</code>
4475
5606
  * </p>
4476
5607
  * </li>
4477
5608
  * </ul>
4478
5609
  */
4479
5610
  Status?: string;
4480
5611
  /**
4481
- * <p>Information about any errors that may have occurred during the Explainability
4482
- * export.</p>
4483
- */
4484
- Message?: string;
4485
- /**
4486
- * <p>When the Explainability was created.</p>
5612
+ * <p>When the monitor resource was created.</p>
4487
5613
  */
4488
5614
  CreationTime?: Date;
4489
5615
  /**
4490
- * <p>The last time the resource was modified. The timestamp depends on the status of the
4491
- * job:</p>
4492
- * <ul>
5616
+ * <p>The last time the monitor resource was modified. The timestamp depends on the status of the
5617
+ * job:</p>
5618
+ * <ul>
4493
5619
  * <li>
4494
- * <p>
5620
+ * <p>
4495
5621
  * <code>CREATE_PENDING</code> - The <code>CreationTime</code>.</p>
4496
5622
  * </li>
4497
5623
  * <li>
4498
- * <p>
5624
+ * <p>
4499
5625
  * <code>CREATE_IN_PROGRESS</code> - The current timestamp.</p>
4500
5626
  * </li>
4501
5627
  * <li>
4502
- * <p>
4503
- * <code>CREATE_STOPPING</code> - The current timestamp.</p>
4504
- * </li>
4505
- * <li>
4506
- * <p>
4507
- * <code>CREATE_STOPPED</code> - When the job stopped.</p>
5628
+ * <p>
5629
+ * <code>STOPPED</code> - When the resource stopped.</p>
4508
5630
  * </li>
4509
5631
  * <li>
4510
- * <p>
4511
- * <code>ACTIVE</code> or <code>CREATE_FAILED</code> - When the job finished or
4512
- * failed.</p>
5632
+ * <p>
5633
+ * <code>ACTIVE</code> or <code>CREATE_FAILED</code> - When the monitor creation finished or
5634
+ * failed.</p>
4513
5635
  * </li>
4514
5636
  * </ul>
4515
5637
  */
4516
5638
  LastModificationTime?: Date;
4517
5639
  }
4518
- export interface ListExplainabilityExportsResponse {
5640
+ export interface ListMonitorsResponse {
4519
5641
  /**
4520
- * <p>An array of objects that summarize the properties of each Explainability
4521
- * export.</p>
5642
+ * <p>An array of objects that summarize each monitor's properties.</p>
4522
5643
  */
4523
- ExplainabilityExports?: ExplainabilityExportSummary[];
5644
+ Monitors?: MonitorSummary[];
4524
5645
  /**
4525
- * <p>Returns this token if the response is truncated. To retrieve the next set of results,
4526
- * use the token in the next request.</p>
5646
+ * <p>If the response is truncated, Amazon Forecast returns this token. To retrieve the next set of
5647
+ * results, use the token in the next request.</p>
4527
5648
  */
4528
5649
  NextToken?: string;
4529
5650
  }
4530
- export interface ListForecastExportJobsRequest {
5651
+ export interface ListPredictorBacktestExportJobsRequest {
4531
5652
  /**
4532
5653
  * <p>If the result of the previous request was truncated, the response includes a
4533
- * <code>NextToken</code>. To retrieve the next set of results, use the token in the next
4534
- * request. Tokens expire after 24 hours.</p>
5654
+ * NextToken. To retrieve the next set of results, use the token in the next request.
5655
+ * Tokens expire after 24 hours.</p>
4535
5656
  */
4536
5657
  NextToken?: string;
4537
5658
  /**
@@ -4539,138 +5660,131 @@ export interface ListForecastExportJobsRequest {
4539
5660
  */
4540
5661
  MaxResults?: number;
4541
5662
  /**
4542
- * <p>An array of filters. For each filter, you provide a condition and a match statement. The
4543
- * condition is either <code>IS</code> or <code>IS_NOT</code>, which specifies whether to include
4544
- * or exclude the forecast export jobs that match the statement from the list, respectively. The
4545
- * match statement consists of a key and a value.</p>
4546
- * <p>
5663
+ * <p>An array of filters. For each filter, provide a condition and a match statement. The
5664
+ * condition is either <code>IS</code> or <code>IS_NOT</code>, which specifies whether to
5665
+ * include or exclude the predictor backtest export jobs that match the statement from the
5666
+ * list. The match statement consists of a key and a value.</p>
5667
+ * <p>
4547
5668
  * <b>Filter properties</b>
4548
- * </p>
4549
- * <ul>
5669
+ * </p>
5670
+ * <ul>
4550
5671
  * <li>
4551
- * <p>
4552
- * <code>Condition</code> - The condition to apply. Valid values are <code>IS</code> and
4553
- * <code>IS_NOT</code>. To include the forecast export jobs that match the statement,
4554
- * specify <code>IS</code>. To exclude matching forecast export jobs, specify
4555
- * <code>IS_NOT</code>.</p>
5672
+ * <p>
5673
+ * <code>Condition</code> - The condition to apply. Valid values are
5674
+ * <code>IS</code> and <code>IS_NOT</code>. To include the predictor backtest
5675
+ * export jobs that match the statement, specify <code>IS</code>. To exclude
5676
+ * matching predictor backtest export jobs, specify <code>IS_NOT</code>.</p>
4556
5677
  * </li>
4557
5678
  * <li>
4558
- * <p>
5679
+ * <p>
4559
5680
  * <code>Key</code> - The name of the parameter to filter on. Valid values are
4560
- * <code>ForecastArn</code> and <code>Status</code>.</p>
5681
+ * <code>PredictorArn</code> and <code>Status</code>.</p>
4561
5682
  * </li>
4562
5683
  * <li>
4563
- * <p>
5684
+ * <p>
4564
5685
  * <code>Value</code> - The value to match.</p>
4565
5686
  * </li>
4566
5687
  * </ul>
4567
- * <p>For example, to list all jobs that export a forecast named
4568
- * <i>electricityforecast</i>, specify the following filter:</p>
4569
- * <p>
4570
- * <code>"Filters": [ { "Condition": "IS", "Key": "ForecastArn", "Value":
4571
- * "arn:aws:forecast:us-west-2:<acct-id>:forecast/electricityforecast" } ]</code>
4572
- * </p>
4573
5688
  */
4574
5689
  Filters?: Filter[];
4575
5690
  }
4576
5691
  /**
4577
- * <p>Provides a summary of the forecast export job properties used in the <a>ListForecastExportJobs</a> operation. To get the complete set of properties, call
4578
- * the <a>DescribeForecastExportJob</a> operation, and provide the listed
4579
- * <code>ForecastExportJobArn</code>.</p>
5692
+ * <p>Provides a summary of the predictor backtest export job properties used in the <a>ListPredictorBacktestExportJobs</a> operation. To get a complete set of
5693
+ * properties, call the <a>DescribePredictorBacktestExportJob</a> operation, and
5694
+ * provide the listed <code>PredictorBacktestExportJobArn</code>.</p>
4580
5695
  */
4581
- export interface ForecastExportJobSummary {
5696
+ export interface PredictorBacktestExportJobSummary {
4582
5697
  /**
4583
- * <p>The Amazon Resource Name (ARN) of the forecast export job.</p>
5698
+ * <p>The Amazon Resource Name (ARN) of the predictor backtest export job.</p>
4584
5699
  */
4585
- ForecastExportJobArn?: string;
5700
+ PredictorBacktestExportJobArn?: string;
4586
5701
  /**
4587
- * <p>The name of the forecast export job.</p>
5702
+ * <p>The name of the predictor backtest export job.</p>
4588
5703
  */
4589
- ForecastExportJobName?: string;
5704
+ PredictorBacktestExportJobName?: string;
4590
5705
  /**
4591
- * <p>The path to the Amazon Simple Storage Service (Amazon S3) bucket where the forecast is exported.</p>
5706
+ * <p>The destination for an export job. Provide an S3 path, an AWS Identity and Access Management (IAM) role that allows Amazon Forecast
5707
+ * to access the location, and an AWS Key Management Service (KMS) key (optional). </p>
4592
5708
  */
4593
5709
  Destination?: DataDestination;
4594
5710
  /**
4595
- * <p>The status of the forecast export job. States include:</p>
4596
- * <ul>
5711
+ * <p>The status of the predictor backtest export job. States include: </p>
5712
+ * <ul>
4597
5713
  * <li>
4598
- * <p>
5714
+ * <p>
4599
5715
  * <code>ACTIVE</code>
4600
5716
  * </p>
4601
5717
  * </li>
4602
5718
  * <li>
4603
- * <p>
5719
+ * <p>
4604
5720
  * <code>CREATE_PENDING</code>, <code>CREATE_IN_PROGRESS</code>,
4605
- * <code>CREATE_FAILED</code>
5721
+ * <code>CREATE_FAILED</code>
4606
5722
  * </p>
4607
5723
  * </li>
4608
5724
  * <li>
4609
- * <p>
4610
- * <code>CREATE_STOPPING</code>, <code>CREATE_STOPPED</code>
4611
- * </p>
5725
+ * <p>
5726
+ * <code>CREATE_STOPPING</code>, <code>CREATE_STOPPED</code>
5727
+ * </p>
4612
5728
  * </li>
4613
5729
  * <li>
4614
- * <p>
5730
+ * <p>
4615
5731
  * <code>DELETE_PENDING</code>, <code>DELETE_IN_PROGRESS</code>,
4616
- * <code>DELETE_FAILED</code>
5732
+ * <code>DELETE_FAILED</code>
4617
5733
  * </p>
4618
5734
  * </li>
4619
5735
  * </ul>
4620
- * <note>
4621
- * <p>The <code>Status</code> of the forecast export job must be <code>ACTIVE</code> before
4622
- * you can access the forecast in your S3 bucket.</p>
4623
- * </note>
4624
5736
  */
4625
5737
  Status?: string;
4626
5738
  /**
4627
- * <p>If an error occurred, an informational message about the error.</p>
5739
+ * <p>Information about any errors that may have occurred during the backtest export.</p>
4628
5740
  */
4629
5741
  Message?: string;
4630
5742
  /**
4631
- * <p>When the forecast export job was created.</p>
5743
+ * <p>When the predictor backtest export job was created.</p>
4632
5744
  */
4633
5745
  CreationTime?: Date;
4634
5746
  /**
4635
- * <p>The last time the resource was modified. The timestamp depends on the status of the job:</p>
4636
- * <ul>
5747
+ * <p>The last time the resource was modified. The timestamp depends on the status of the
5748
+ * job:</p>
5749
+ * <ul>
4637
5750
  * <li>
4638
- * <p>
5751
+ * <p>
4639
5752
  * <code>CREATE_PENDING</code> - The <code>CreationTime</code>.</p>
4640
5753
  * </li>
4641
5754
  * <li>
4642
- * <p>
5755
+ * <p>
4643
5756
  * <code>CREATE_IN_PROGRESS</code> - The current timestamp.</p>
4644
5757
  * </li>
4645
5758
  * <li>
4646
- * <p>
5759
+ * <p>
4647
5760
  * <code>CREATE_STOPPING</code> - The current timestamp.</p>
4648
5761
  * </li>
4649
5762
  * <li>
4650
- * <p>
5763
+ * <p>
4651
5764
  * <code>CREATE_STOPPED</code> - When the job stopped.</p>
4652
5765
  * </li>
4653
5766
  * <li>
4654
- * <p>
5767
+ * <p>
4655
5768
  * <code>ACTIVE</code> or <code>CREATE_FAILED</code> - When the job finished or
4656
- * failed.</p>
5769
+ * failed.</p>
4657
5770
  * </li>
4658
5771
  * </ul>
4659
5772
  */
4660
5773
  LastModificationTime?: Date;
4661
5774
  }
4662
- export interface ListForecastExportJobsResponse {
5775
+ export interface ListPredictorBacktestExportJobsResponse {
4663
5776
  /**
4664
- * <p>An array of objects that summarize each export job's properties.</p>
5777
+ * <p>An array of objects that summarize the properties of each predictor backtest export
5778
+ * job.</p>
4665
5779
  */
4666
- ForecastExportJobs?: ForecastExportJobSummary[];
5780
+ PredictorBacktestExportJobs?: PredictorBacktestExportJobSummary[];
4667
5781
  /**
4668
- * <p>If the response is truncated, Amazon Forecast returns this token. To retrieve the next set of
4669
- * results, use the token in the next request.</p>
5782
+ * <p>Returns this token if the response is truncated. To retrieve the next set of results,
5783
+ * use the token in the next request.</p>
4670
5784
  */
4671
5785
  NextToken?: string;
4672
5786
  }
4673
- export interface ListForecastsRequest {
5787
+ export interface ListPredictorsRequest {
4674
5788
  /**
4675
5789
  * <p>If the result of the previous request was truncated, the response includes a
4676
5790
  * <code>NextToken</code>. To retrieve the next set of results, use the token in the next
@@ -4684,7 +5798,7 @@ export interface ListForecastsRequest {
4684
5798
  /**
4685
5799
  * <p>An array of filters. For each filter, you provide a condition and a match statement. The
4686
5800
  * condition is either <code>IS</code> or <code>IS_NOT</code>, which specifies whether to include
4687
- * or exclude the forecasts that match the statement from the list, respectively. The match
5801
+ * or exclude the predictors that match the statement from the list, respectively. The match
4688
5802
  * statement consists of a key and a value.</p>
4689
5803
  * <p>
4690
5804
  * <b>Filter properties</b>
@@ -4693,56 +5807,56 @@ export interface ListForecastsRequest {
4693
5807
  * <li>
4694
5808
  * <p>
4695
5809
  * <code>Condition</code> - The condition to apply. Valid values are <code>IS</code> and
4696
- * <code>IS_NOT</code>. To include the forecasts that match the statement, specify
4697
- * <code>IS</code>. To exclude matching forecasts, specify <code>IS_NOT</code>.</p>
5810
+ * <code>IS_NOT</code>. To include the predictors that match the statement, specify
5811
+ * <code>IS</code>. To exclude matching predictors, specify <code>IS_NOT</code>.</p>
4698
5812
  * </li>
4699
5813
  * <li>
4700
5814
  * <p>
4701
5815
  * <code>Key</code> - The name of the parameter to filter on. Valid values are
4702
- * <code>DatasetGroupArn</code>, <code>PredictorArn</code>, and <code>Status</code>.</p>
5816
+ * <code>DatasetGroupArn</code> and <code>Status</code>.</p>
4703
5817
  * </li>
4704
5818
  * <li>
4705
5819
  * <p>
4706
5820
  * <code>Value</code> - The value to match.</p>
4707
5821
  * </li>
4708
5822
  * </ul>
4709
- * <p>For example, to list all forecasts whose status is not ACTIVE, you would specify:</p>
5823
+ * <p>For example, to list all predictors whose status is ACTIVE, you would specify:</p>
4710
5824
  * <p>
4711
- * <code>"Filters": [ { "Condition": "IS_NOT", "Key": "Status", "Value": "ACTIVE" }
5825
+ * <code>"Filters": [ { "Condition": "IS", "Key": "Status", "Value": "ACTIVE" }
4712
5826
  * ]</code>
4713
5827
  * </p>
4714
5828
  */
4715
5829
  Filters?: Filter[];
4716
5830
  }
4717
5831
  /**
4718
- * <p>Provides a summary of the forecast properties used in the <a>ListForecasts</a>
4719
- * operation. To get the complete set of properties, call the <a>DescribeForecast</a>
4720
- * operation, and provide the <code>ForecastArn</code> that is listed in the summary.</p>
4721
- */
4722
- export interface ForecastSummary {
4723
- /**
4724
- * <p>The ARN of the forecast.</p>
4725
- */
4726
- ForecastArn?: string;
4727
- /**
4728
- * <p>The name of the forecast.</p>
4729
- */
4730
- ForecastName?: string;
5832
+ * <p>Provides a summary of the predictor properties that are used in the <a>ListPredictors</a> operation. To get the complete set of properties, call the <a>DescribePredictor</a> operation, and provide the listed
5833
+ * <code>PredictorArn</code>.</p>
5834
+ */
5835
+ export interface PredictorSummary {
4731
5836
  /**
4732
- * <p>The ARN of the predictor used to generate the forecast.</p>
5837
+ * <p>The ARN of the predictor.</p>
4733
5838
  */
4734
5839
  PredictorArn?: string;
4735
5840
  /**
4736
- * <p>Whether the Forecast was created from an AutoPredictor.</p>
5841
+ * <p>The name of the predictor.</p>
4737
5842
  */
4738
- CreatedUsingAutoPredictor?: boolean;
5843
+ PredictorName?: string;
4739
5844
  /**
4740
- * <p>The Amazon Resource Name (ARN) of the dataset group that provided the data used to train
5845
+ * <p>The Amazon Resource Name (ARN) of the dataset group that contains the data used to train
4741
5846
  * the predictor.</p>
4742
5847
  */
4743
5848
  DatasetGroupArn?: string;
4744
5849
  /**
4745
- * <p>The status of the forecast. States include:</p>
5850
+ * <p>Whether AutoPredictor was used to create the predictor.</p>
5851
+ */
5852
+ IsAutoPredictor?: boolean;
5853
+ /**
5854
+ * <p>A summary of the reference predictor used if the predictor was retrained or
5855
+ * upgraded.</p>
5856
+ */
5857
+ ReferencePredictorSummary?: ReferencePredictorSummary;
5858
+ /**
5859
+ * <p>The status of the predictor. States include:</p>
4746
5860
  * <ul>
4747
5861
  * <li>
4748
5862
  * <p>
@@ -4752,24 +5866,24 @@ export interface ForecastSummary {
4752
5866
  * <li>
4753
5867
  * <p>
4754
5868
  * <code>CREATE_PENDING</code>, <code>CREATE_IN_PROGRESS</code>,
4755
- * <code>CREATE_FAILED</code>
5869
+ * <code>CREATE_FAILED</code>
4756
5870
  * </p>
4757
5871
  * </li>
4758
5872
  * <li>
4759
5873
  * <p>
4760
- * <code>CREATE_STOPPING</code>, <code>CREATE_STOPPED</code>
5874
+ * <code>DELETE_PENDING</code>, <code>DELETE_IN_PROGRESS</code>,
5875
+ * <code>DELETE_FAILED</code>
4761
5876
  * </p>
4762
5877
  * </li>
4763
5878
  * <li>
4764
5879
  * <p>
4765
- * <code>DELETE_PENDING</code>, <code>DELETE_IN_PROGRESS</code>,
4766
- * <code>DELETE_FAILED</code>
5880
+ * <code>CREATE_STOPPING</code>, <code>CREATE_STOPPED</code>
4767
5881
  * </p>
4768
5882
  * </li>
4769
5883
  * </ul>
4770
5884
  * <note>
4771
- * <p>The <code>Status</code> of the forecast must be <code>ACTIVE</code> before you can query
4772
- * or export the forecast.</p>
5885
+ * <p>The <code>Status</code> of the predictor must be <code>ACTIVE</code> before you can use
5886
+ * the predictor to create a forecast.</p>
4773
5887
  * </note>
4774
5888
  */
4775
5889
  Status?: string;
@@ -4778,11 +5892,12 @@ export interface ForecastSummary {
4778
5892
  */
4779
5893
  Message?: string;
4780
5894
  /**
4781
- * <p>When the forecast creation task was created.</p>
5895
+ * <p>When the model training task was created.</p>
4782
5896
  */
4783
5897
  CreationTime?: Date;
4784
5898
  /**
4785
- * <p>The last time the resource was modified. The timestamp depends on the status of the job:</p>
5899
+ * <p>The last time the resource was modified. The timestamp depends on the status of the
5900
+ * job:</p>
4786
5901
  * <ul>
4787
5902
  * <li>
4788
5903
  * <p>
@@ -4809,231 +5924,92 @@ export interface ForecastSummary {
4809
5924
  */
4810
5925
  LastModificationTime?: Date;
4811
5926
  }
4812
- export interface ListForecastsResponse {
4813
- /**
4814
- * <p>An array of objects that summarize each forecast's properties.</p>
4815
- */
4816
- Forecasts?: ForecastSummary[];
5927
+ export interface ListPredictorsResponse {
4817
5928
  /**
4818
- * <p>If the response is truncated, Amazon Forecast returns this token. To retrieve the next set
4819
- * of results, use the token in the next request.</p>
5929
+ * <p>An array of objects that summarize each predictor's properties.</p>
4820
5930
  */
4821
- NextToken?: string;
4822
- }
4823
- export interface ListMonitorEvaluationsRequest {
5931
+ Predictors?: PredictorSummary[];
4824
5932
  /**
4825
- * <p>If the result of the previous request was truncated, the response includes a
4826
- * <code>NextToken</code>. To retrieve the next set of results, use the token in the next
4827
- * request. Tokens expire after 24 hours.</p>
5933
+ * <p>If the response is truncated, Amazon Forecast returns this token. To retrieve the next set of
5934
+ * results, use the token in the next request.</p>
4828
5935
  */
4829
5936
  NextToken?: string;
4830
- /**
4831
- * <p>The maximum number of monitoring results to return.</p>
4832
- */
4833
- MaxResults?: number;
4834
- /**
4835
- * <p>The Amazon Resource Name (ARN) of the monitor resource to get results from.</p>
4836
- */
4837
- MonitorArn: string | undefined;
4838
- /**
4839
- * <p>An array of filters. For each filter, provide a condition and a match statement. The
4840
- * condition is either <code>IS</code> or <code>IS_NOT</code>, which specifies whether to
4841
- * include or exclude the resources that match the statement from the list. The match
4842
- * statement consists of a key and a value.</p>
4843
- * <p>
4844
- * <b>Filter properties</b>
4845
- * </p>
4846
- * <ul>
4847
- * <li>
4848
- * <p>
4849
- * <code>Condition</code> - The condition to apply. Valid values are
4850
- * <code>IS</code> and <code>IS_NOT</code>.</p>
4851
- * </li>
4852
- * <li>
4853
- * <p>
4854
- * <code>Key</code> - The name of the parameter to filter on. The only valid value is
4855
- * <code>EvaluationState</code>.</p>
4856
- * </li>
4857
- * <li>
4858
- * <p>
4859
- * <code>Value</code> - The value to match. Valid values are only <code>SUCCESS</code> or <code>FAILURE</code>.</p>
4860
- * </li>
4861
- * </ul>
4862
- * <p>For example, to list only successful monitor evaluations, you would specify:</p>
4863
- * <p>
4864
- * <code>"Filters": [ { "Condition": "IS", "Key": "EvaluationState", "Value": "SUCCESS" } ]</code>
4865
- * </p>
4866
- */
4867
- Filters?: Filter[];
4868
- }
4869
- /**
4870
- * <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>
4871
- * <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>
4872
- * </p>
4873
- */
4874
- export interface MetricResult {
4875
- /**
4876
- * <p>The name of the metric.</p>
4877
- */
4878
- MetricName?: string;
4879
- /**
4880
- * <p>The value for the metric.</p>
4881
- */
4882
- MetricValue?: number;
4883
- }
4884
- /**
4885
- * <p>The source of the data the monitor used during the evaluation.</p>
4886
- */
4887
- export interface MonitorDataSource {
4888
- /**
4889
- * <p>The Amazon Resource Name (ARN) of the dataset import job used to import the data that initiated the monitor evaluation.</p>
4890
- */
4891
- DatasetImportJobArn?: string;
4892
- /**
4893
- * <p>The Amazon Resource Name (ARN) of the forecast the monitor used during the evaluation.</p>
4894
- */
4895
- ForecastArn?: string;
4896
- /**
4897
- * <p>The Amazon Resource Name (ARN) of the predictor resource you are monitoring.</p>
4898
- */
4899
- PredictorArn?: string;
4900
- }
4901
- /**
4902
- * <p>Provides details about a predictor event, such as a retraining.</p>
4903
- */
4904
- export interface PredictorEvent {
4905
- /**
4906
- * <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>
4907
- */
4908
- Detail?: string;
4909
- /**
4910
- * <p>The timestamp for when the event occurred.</p>
4911
- */
4912
- Datetime?: Date;
4913
5937
  }
4914
- /**
4915
- * <p>Describes the results of a monitor evaluation.</p>
4916
- */
4917
- export interface PredictorMonitorEvaluation {
4918
- /**
4919
- * <p>The Amazon Resource Name (ARN) of the resource to monitor.</p>
4920
- */
4921
- ResourceArn?: string;
4922
- /**
4923
- * <p>The Amazon Resource Name (ARN) of the monitor resource.</p>
4924
- */
4925
- MonitorArn?: string;
4926
- /**
4927
- * <p>The timestamp that indicates when the monitor evaluation was started. </p>
4928
- */
4929
- EvaluationTime?: Date;
4930
- /**
4931
- * <p>The status of the monitor evaluation. The state can be <code>SUCCESS</code> or <code>FAILURE</code>.</p>
4932
- */
4933
- EvaluationState?: string;
4934
- /**
4935
- * <p>The timestamp that indicates the start of the window that is used for monitor evaluation.</p>
4936
- */
4937
- WindowStartDatetime?: Date;
4938
- /**
4939
- * <p>The timestamp that indicates the end of the window that is used for monitor evaluation.</p>
4940
- */
4941
- WindowEndDatetime?: Date;
4942
- /**
4943
- * <p>Provides details about a predictor event, such as a retraining.</p>
4944
- */
4945
- PredictorEvent?: PredictorEvent;
4946
- /**
4947
- * <p>The source of the data the monitor resource used during the evaluation.</p>
4948
- */
4949
- MonitorDataSource?: MonitorDataSource;
4950
- /**
4951
- * <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>
4952
- */
4953
- MetricResults?: MetricResult[];
4954
- /**
4955
- * <p>The number of items considered during the evaluation.</p>
4956
- */
4957
- NumItemsEvaluated?: number;
5938
+ export interface ListTagsForResourceRequest {
4958
5939
  /**
4959
- * <p>Information about any errors that may have occurred during the monitor evaluation.</p>
5940
+ * <p>The Amazon Resource Name (ARN) that identifies the resource for which to list the tags.
5941
+ * </p>
4960
5942
  */
4961
- Message?: string;
5943
+ ResourceArn: string | undefined;
4962
5944
  }
4963
- export interface ListMonitorEvaluationsResponse {
4964
- /**
4965
- * <p>If the response is truncated, Amazon Forecast returns this token. To retrieve the next set of
4966
- * results, use the token in the next request. Tokens expire after 24 hours.</p>
4967
- */
4968
- NextToken?: string;
5945
+ export interface ListTagsForResourceResponse {
4969
5946
  /**
4970
- * <p>The monitoring results and predictor events collected by the monitor resource during different windows of time.</p>
4971
- * <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>
5947
+ * <p>The tags for the resource.</p>
4972
5948
  */
4973
- PredictorMonitorEvaluations?: PredictorMonitorEvaluation[];
5949
+ Tags?: Tag[];
4974
5950
  }
4975
- export interface ListMonitorsRequest {
5951
+ export interface ListWhatIfAnalysesRequest {
4976
5952
  /**
4977
5953
  * <p>If the result of the previous request was truncated, the response includes a
4978
- * <code>NextToken</code>. To retrieve the next set of results, use the token in the next
4979
- * request. Tokens expire after 24 hours.</p>
5954
+ * <code>NextToken</code>. To retrieve the next set of results, use the token in the next
5955
+ * request. Tokens expire after 24 hours.</p>
4980
5956
  */
4981
5957
  NextToken?: string;
4982
5958
  /**
4983
- * <p>The maximum number of monitors to include in the response.</p>
5959
+ * <p>The number of items to return in the response.</p>
4984
5960
  */
4985
5961
  MaxResults?: number;
4986
5962
  /**
4987
- * <p>An array of filters. For each filter, provide a condition and a match statement. The
4988
- * condition is either <code>IS</code> or <code>IS_NOT</code>, which specifies whether to
4989
- * include or exclude the resources that match the statement from the list. The match
4990
- * statement consists of a key and a value.</p>
5963
+ * <p>An array of filters. For each filter, you provide a condition and a match statement. The condition is either
5964
+ * <code>IS</code> or <code>IS_NOT</code>, which specifies whether to include or exclude the what-if analysis jobs
5965
+ * that match the statement from the list, respectively. The match statement consists of a key and a value.</p>
4991
5966
  * <p>
4992
5967
  * <b>Filter properties</b>
4993
5968
  * </p>
4994
5969
  * <ul>
4995
5970
  * <li>
4996
5971
  * <p>
4997
- * <code>Condition</code> - The condition to apply. Valid values are
4998
- * <code>IS</code> and <code>IS_NOT</code>.</p>
5972
+ * <code>Condition</code> - The condition to apply. Valid values are <code>IS</code> and
5973
+ * <code>IS_NOT</code>. To include the what-if analysis jobs that match the statement, specify <code>IS</code>.
5974
+ * To exclude matching what-if analysis jobs, specify <code>IS_NOT</code>.</p>
4999
5975
  * </li>
5000
5976
  * <li>
5001
5977
  * <p>
5002
- * <code>Key</code> - The name of the parameter to filter on. The only valid value is
5003
- * <code>Status</code>.</p>
5978
+ * <code>Key</code> - The name of the parameter to filter on. Valid values are
5979
+ * <code>WhatIfAnalysisArn</code> and <code>Status</code>.</p>
5004
5980
  * </li>
5005
5981
  * <li>
5006
5982
  * <p>
5007
5983
  * <code>Value</code> - The value to match.</p>
5008
5984
  * </li>
5009
5985
  * </ul>
5010
- * <p>For example, to list all monitors who's status is ACTIVE, you would specify:</p>
5986
+ * <p>For example, to list all jobs that export a forecast named
5987
+ * <i>electricityWhatIf</i>, specify the following filter:</p>
5011
5988
  * <p>
5012
- * <code>"Filters": [ { "Condition": "IS", "Key": "Status", "Value": "ACTIVE" } ]</code>
5989
+ * <code>"Filters": [ { "Condition": "IS", "Key": "WhatIfAnalysisArn", "Value":
5990
+ * "arn:aws:forecast:us-west-2:<acct-id>:forecast/electricityWhatIf" } ]</code>
5013
5991
  * </p>
5014
5992
  */
5015
5993
  Filters?: Filter[];
5016
5994
  }
5017
5995
  /**
5018
- * <p>Provides a summary of the monitor properties used in the <a>ListMonitors</a> operation. To get a complete set of properties,
5019
- * call the <a>DescribeMonitor</a> operation, and provide the listed
5020
- * <code>MonitorArn</code>.</p>
5996
+ * <p>Provides a summary of the what-if analysis properties used in the <a>ListWhatIfAnalyses</a> operation. To get the complete set of properties, call the <a>DescribeWhatIfAnalysis</a> operation, and provide the <code>WhatIfAnalysisArn</code> that is listed in the summary.</p>
5021
5997
  */
5022
- export interface MonitorSummary {
5998
+ export interface WhatIfAnalysisSummary {
5023
5999
  /**
5024
- * <p>The Amazon Resource Name (ARN) of the monitor resource.</p>
6000
+ * <p>The Amazon Resource Name (ARN) of the what-if analysis.</p>
5025
6001
  */
5026
- MonitorArn?: string;
6002
+ WhatIfAnalysisArn?: string;
5027
6003
  /**
5028
- * <p>The name of the monitor resource.</p>
6004
+ * <p>The name of the what-if analysis.</p>
5029
6005
  */
5030
- MonitorName?: string;
6006
+ WhatIfAnalysisName?: string;
5031
6007
  /**
5032
- * <p>The Amazon Resource Name (ARN) of the predictor being monitored.</p>
6008
+ * <p>The Amazon Resource Name (ARN) of the baseline forecast that is being used in this what-if analysis.</p>
5033
6009
  */
5034
- ResourceArn?: string;
6010
+ ForecastArn?: string;
5035
6011
  /**
5036
- * <p>The status of the monitor. States include:</p>
6012
+ * <p>The status of the what-if analysis. States include:</p>
5037
6013
  * <ul>
5038
6014
  * <li>
5039
6015
  * <p>
@@ -5042,34 +6018,38 @@ export interface MonitorSummary {
5042
6018
  * </li>
5043
6019
  * <li>
5044
6020
  * <p>
5045
- * <code>ACTIVE_STOPPING</code>, <code>ACTIVE_STOPPED</code>
5046
- * </p>
5047
- * </li>
5048
- * <li>
5049
- * <p>
5050
- * <code>UPDATE_IN_PROGRESS</code>
6021
+ * <code>CREATE_PENDING</code>, <code>CREATE_IN_PROGRESS</code>,
6022
+ * <code>CREATE_FAILED</code>
5051
6023
  * </p>
5052
6024
  * </li>
5053
6025
  * <li>
5054
6026
  * <p>
5055
- * <code>CREATE_PENDING</code>, <code>CREATE_IN_PROGRESS</code>, <code>CREATE_FAILED</code>
6027
+ * <code>CREATE_STOPPING</code>, <code>CREATE_STOPPED</code>
5056
6028
  * </p>
5057
6029
  * </li>
5058
6030
  * <li>
5059
6031
  * <p>
5060
- * <code>DELETE_PENDING</code>, <code>DELETE_IN_PROGRESS</code>, <code>DELETE_FAILED</code>
6032
+ * <code>DELETE_PENDING</code>, <code>DELETE_IN_PROGRESS</code>,
6033
+ * <code>DELETE_FAILED</code>
5061
6034
  * </p>
5062
6035
  * </li>
5063
6036
  * </ul>
6037
+ * <note>
6038
+ * <p>The <code>Status</code> of the what-if analysis must be <code>ACTIVE</code> before you can access the
6039
+ * analysis.</p>
6040
+ * </note>
5064
6041
  */
5065
6042
  Status?: string;
5066
6043
  /**
5067
- * <p>When the monitor resource was created.</p>
6044
+ * <p>If an error occurred, an informational message about the error.</p>
6045
+ */
6046
+ Message?: string;
6047
+ /**
6048
+ * <p>When the what-if analysis was created.</p>
5068
6049
  */
5069
6050
  CreationTime?: Date;
5070
6051
  /**
5071
- * <p>The last time the monitor resource was modified. The timestamp depends on the status of the
5072
- * job:</p>
6052
+ * <p>The last time the resource was modified. The timestamp depends on the status of the job:</p>
5073
6053
  * <ul>
5074
6054
  * <li>
5075
6055
  * <p>
@@ -5081,33 +6061,35 @@ export interface MonitorSummary {
5081
6061
  * </li>
5082
6062
  * <li>
5083
6063
  * <p>
5084
- * <code>STOPPED</code> - When the resource stopped.</p>
6064
+ * <code>CREATE_STOPPING</code> - The current timestamp.</p>
5085
6065
  * </li>
5086
6066
  * <li>
5087
6067
  * <p>
5088
- * <code>ACTIVE</code> or <code>CREATE_FAILED</code> - When the monitor creation finished or
5089
- * failed.</p>
6068
+ * <code>CREATE_STOPPED</code> - When the job stopped.</p>
6069
+ * </li>
6070
+ * <li>
6071
+ * <p>
6072
+ * <code>ACTIVE</code> or <code>CREATE_FAILED</code> - When the job finished or
6073
+ * failed.</p>
5090
6074
  * </li>
5091
6075
  * </ul>
5092
6076
  */
5093
6077
  LastModificationTime?: Date;
5094
6078
  }
5095
- export interface ListMonitorsResponse {
6079
+ export interface ListWhatIfAnalysesResponse {
5096
6080
  /**
5097
- * <p>An array of objects that summarize each monitor's properties.</p>
6081
+ * <p>An array of <code>WhatIfAnalysisSummary</code> objects that describe the matched analyses.</p>
5098
6082
  */
5099
- Monitors?: MonitorSummary[];
6083
+ WhatIfAnalyses?: WhatIfAnalysisSummary[];
5100
6084
  /**
5101
- * <p>If the response is truncated, Amazon Forecast returns this token. To retrieve the next set of
5102
- * results, use the token in the next request.</p>
6085
+ * <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>
5103
6086
  */
5104
6087
  NextToken?: string;
5105
6088
  }
5106
- export interface ListPredictorBacktestExportJobsRequest {
6089
+ export interface ListWhatIfForecastExportsRequest {
5107
6090
  /**
5108
- * <p>If the result of the previous request was truncated, the response includes a
5109
- * NextToken. To retrieve the next set of results, use the token in the next request.
5110
- * Tokens expire after 24 hours.</p>
6091
+ * <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
6092
+ request. Tokens expire after 24 hours.</p>
5111
6093
  */
5112
6094
  NextToken?: string;
5113
6095
  /**
@@ -5115,135 +6097,142 @@ export interface ListPredictorBacktestExportJobsRequest {
5115
6097
  */
5116
6098
  MaxResults?: number;
5117
6099
  /**
5118
- * <p>An array of filters. For each filter, provide a condition and a match statement. The
5119
- * condition is either <code>IS</code> or <code>IS_NOT</code>, which specifies whether to
5120
- * include or exclude the predictor backtest export jobs that match the statement from the
5121
- * list. The match statement consists of a key and a value.</p>
5122
- * <p>
6100
+ * <p>An array of filters. For each filter, you provide a condition and a match statement. The condition is either
6101
+ * <code>IS</code> or <code>IS_NOT</code>, which specifies whether to include or exclude the what-if forecast
6102
+ * export jobs that match the statement from the list, respectively. The match statement consists of a key and a
6103
+ * value.</p>
6104
+ * <p>
5123
6105
  * <b>Filter properties</b>
5124
- * </p>
5125
- * <ul>
6106
+ * </p>
6107
+ * <ul>
5126
6108
  * <li>
5127
- * <p>
5128
- * <code>Condition</code> - The condition to apply. Valid values are
5129
- * <code>IS</code> and <code>IS_NOT</code>. To include the predictor backtest
5130
- * export jobs that match the statement, specify <code>IS</code>. To exclude
5131
- * matching predictor backtest export jobs, specify <code>IS_NOT</code>.</p>
6109
+ * <p>
6110
+ * <code>Condition</code> - The condition to apply. Valid values are <code>IS</code> and
6111
+ * <code>IS_NOT</code>. To include the forecast export jobs that match the statement,
6112
+ * specify <code>IS</code>. To exclude matching forecast export jobs, specify
6113
+ * <code>IS_NOT</code>.</p>
5132
6114
  * </li>
5133
6115
  * <li>
5134
- * <p>
6116
+ * <p>
5135
6117
  * <code>Key</code> - The name of the parameter to filter on. Valid values are
5136
- * <code>PredictorArn</code> and <code>Status</code>.</p>
6118
+ * <code>WhatIfForecastExportArn</code> and <code>Status</code>.</p>
5137
6119
  * </li>
5138
6120
  * <li>
5139
- * <p>
6121
+ * <p>
5140
6122
  * <code>Value</code> - The value to match.</p>
5141
6123
  * </li>
5142
6124
  * </ul>
6125
+ * <p>For example, to list all jobs that export a forecast named
6126
+ * <i>electricityWIFExport</i>, specify the following filter:</p>
6127
+ * <p>
6128
+ * <code>"Filters": [ { "Condition": "IS", "Key": "WhatIfForecastExportArn", "Value":
6129
+ * "arn:aws:forecast:us-west-2:<acct-id>:forecast/electricityWIFExport" } ]</code>
6130
+ * </p>
5143
6131
  */
5144
6132
  Filters?: Filter[];
5145
6133
  }
5146
6134
  /**
5147
- * <p>Provides a summary of the predictor backtest export job properties used in the <a>ListPredictorBacktestExportJobs</a> operation. To get a complete set of
5148
- * properties, call the <a>DescribePredictorBacktestExportJob</a> operation, and
5149
- * provide the listed <code>PredictorBacktestExportJobArn</code>.</p>
6135
+ * <p>Provides a summary of the what-if forecast export properties used in the <a>ListWhatIfForecastExports</a> operation. To get the complete set of properties, call the <a>DescribeWhatIfForecastExport</a> operation, and provide the <code>WhatIfForecastExportArn</code> that is listed in the summary.</p>
5150
6136
  */
5151
- export interface PredictorBacktestExportJobSummary {
6137
+ export interface WhatIfForecastExportSummary {
5152
6138
  /**
5153
- * <p>The Amazon Resource Name (ARN) of the predictor backtest export job.</p>
6139
+ * <p>The Amazon Resource Name (ARN) of the what-if forecast export.</p>
5154
6140
  */
5155
- PredictorBacktestExportJobArn?: string;
6141
+ WhatIfForecastExportArn?: string;
5156
6142
  /**
5157
- * <p>The name of the predictor backtest export job.</p>
6143
+ * <p>An array of Amazon Resource Names (ARNs) that define the what-if forecasts included in the export.</p>
5158
6144
  */
5159
- PredictorBacktestExportJobName?: string;
6145
+ WhatIfForecastArns?: string[];
5160
6146
  /**
5161
- * <p>The destination for an export job. Provide an S3 path, an AWS Identity and Access Management (IAM) role that allows Amazon Forecast
5162
- * to access the location, and an AWS Key Management Service (KMS) key (optional). </p>
6147
+ * <p>The what-if forecast export name.</p>
6148
+ */
6149
+ WhatIfForecastExportName?: string;
6150
+ /**
6151
+ * <p>The path to the Amazon Simple Storage Service (Amazon S3) bucket where the forecast is exported.</p>
5163
6152
  */
5164
6153
  Destination?: DataDestination;
5165
6154
  /**
5166
- * <p>The status of the predictor backtest export job. States include: </p>
5167
- * <ul>
6155
+ * <p>The status of the what-if forecast export. States include:</p>
6156
+ * <ul>
5168
6157
  * <li>
5169
- * <p>
6158
+ * <p>
5170
6159
  * <code>ACTIVE</code>
5171
6160
  * </p>
5172
6161
  * </li>
5173
6162
  * <li>
5174
- * <p>
6163
+ * <p>
5175
6164
  * <code>CREATE_PENDING</code>, <code>CREATE_IN_PROGRESS</code>,
5176
- * <code>CREATE_FAILED</code>
6165
+ * <code>CREATE_FAILED</code>
5177
6166
  * </p>
5178
6167
  * </li>
5179
6168
  * <li>
5180
- * <p>
5181
- * <code>CREATE_STOPPING</code>, <code>CREATE_STOPPED</code>
5182
- * </p>
6169
+ * <p>
6170
+ * <code>CREATE_STOPPING</code>, <code>CREATE_STOPPED</code>
6171
+ * </p>
5183
6172
  * </li>
5184
6173
  * <li>
5185
- * <p>
6174
+ * <p>
5186
6175
  * <code>DELETE_PENDING</code>, <code>DELETE_IN_PROGRESS</code>,
5187
- * <code>DELETE_FAILED</code>
6176
+ * <code>DELETE_FAILED</code>
5188
6177
  * </p>
5189
6178
  * </li>
5190
6179
  * </ul>
6180
+ * <note>
6181
+ * <p>The <code>Status</code> of the what-if analysis must be <code>ACTIVE</code> before you can access the
6182
+ * analysis.</p>
6183
+ * </note>
5191
6184
  */
5192
6185
  Status?: string;
5193
6186
  /**
5194
- * <p>Information about any errors that may have occurred during the backtest export.</p>
6187
+ * <p>If an error occurred, an informational message about the error.</p>
5195
6188
  */
5196
6189
  Message?: string;
5197
6190
  /**
5198
- * <p>When the predictor backtest export job was created.</p>
6191
+ * <p>When the what-if forecast export was created.</p>
5199
6192
  */
5200
6193
  CreationTime?: Date;
5201
6194
  /**
5202
- * <p>The last time the resource was modified. The timestamp depends on the status of the
5203
- * job:</p>
5204
- * <ul>
6195
+ * <p>The last time the resource was modified. The timestamp depends on the status of the job:</p>
6196
+ * <ul>
5205
6197
  * <li>
5206
- * <p>
6198
+ * <p>
5207
6199
  * <code>CREATE_PENDING</code> - The <code>CreationTime</code>.</p>
5208
6200
  * </li>
5209
6201
  * <li>
5210
- * <p>
6202
+ * <p>
5211
6203
  * <code>CREATE_IN_PROGRESS</code> - The current timestamp.</p>
5212
6204
  * </li>
5213
6205
  * <li>
5214
- * <p>
6206
+ * <p>
5215
6207
  * <code>CREATE_STOPPING</code> - The current timestamp.</p>
5216
6208
  * </li>
5217
6209
  * <li>
5218
- * <p>
6210
+ * <p>
5219
6211
  * <code>CREATE_STOPPED</code> - When the job stopped.</p>
5220
6212
  * </li>
5221
6213
  * <li>
5222
- * <p>
6214
+ * <p>
5223
6215
  * <code>ACTIVE</code> or <code>CREATE_FAILED</code> - When the job finished or
5224
- * failed.</p>
6216
+ * failed.</p>
5225
6217
  * </li>
5226
6218
  * </ul>
5227
6219
  */
5228
6220
  LastModificationTime?: Date;
5229
6221
  }
5230
- export interface ListPredictorBacktestExportJobsResponse {
6222
+ export interface ListWhatIfForecastExportsResponse {
5231
6223
  /**
5232
- * <p>An array of objects that summarize the properties of each predictor backtest export
5233
- * job.</p>
6224
+ * <p>An array of <code>WhatIfForecastExports</code> objects that describe the matched forecast exports.</p>
5234
6225
  */
5235
- PredictorBacktestExportJobs?: PredictorBacktestExportJobSummary[];
6226
+ WhatIfForecastExports?: WhatIfForecastExportSummary[];
5236
6227
  /**
5237
- * <p>Returns this token if the response is truncated. To retrieve the next set of results,
5238
- * use the token in the next request.</p>
6228
+ * <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>
5239
6229
  */
5240
6230
  NextToken?: string;
5241
6231
  }
5242
- export interface ListPredictorsRequest {
6232
+ export interface ListWhatIfForecastsRequest {
5243
6233
  /**
5244
- * <p>If the result of the previous request was truncated, the response includes a
5245
- * <code>NextToken</code>. To retrieve the next set of results, use the token in the next
5246
- * request. Tokens expire after 24 hours.</p>
6234
+ * <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
6235
+ request. Tokens expire after 24 hours.</p>
5247
6236
  */
5248
6237
  NextToken?: string;
5249
6238
  /**
@@ -5251,10 +6240,10 @@ export interface ListPredictorsRequest {
5251
6240
  */
5252
6241
  MaxResults?: number;
5253
6242
  /**
5254
- * <p>An array of filters. For each filter, you provide a condition and a match statement. The
5255
- * condition is either <code>IS</code> or <code>IS_NOT</code>, which specifies whether to include
5256
- * or exclude the predictors that match the statement from the list, respectively. The match
5257
- * statement consists of a key and a value.</p>
6243
+ * <p>An array of filters. For each filter, you provide a condition and a match statement. The condition is either
6244
+ * <code>IS</code> or <code>IS_NOT</code>, which specifies whether to include or exclude the what-if forecast
6245
+ * export jobs that match the statement from the list, respectively. The match statement consists of a key and a
6246
+ * value.</p>
5258
6247
  * <p>
5259
6248
  * <b>Filter properties</b>
5260
6249
  * </p>
@@ -5262,56 +6251,47 @@ export interface ListPredictorsRequest {
5262
6251
  * <li>
5263
6252
  * <p>
5264
6253
  * <code>Condition</code> - The condition to apply. Valid values are <code>IS</code> and
5265
- * <code>IS_NOT</code>. To include the predictors that match the statement, specify
5266
- * <code>IS</code>. To exclude matching predictors, specify <code>IS_NOT</code>.</p>
6254
+ * <code>IS_NOT</code>. To include the forecast export jobs that match the statement,
6255
+ * specify <code>IS</code>. To exclude matching forecast export jobs, specify
6256
+ * <code>IS_NOT</code>.</p>
5267
6257
  * </li>
5268
6258
  * <li>
5269
6259
  * <p>
5270
6260
  * <code>Key</code> - The name of the parameter to filter on. Valid values are
5271
- * <code>DatasetGroupArn</code> and <code>Status</code>.</p>
6261
+ * <code>WhatIfForecastArn</code> and <code>Status</code>.</p>
5272
6262
  * </li>
5273
6263
  * <li>
5274
6264
  * <p>
5275
6265
  * <code>Value</code> - The value to match.</p>
5276
6266
  * </li>
5277
6267
  * </ul>
5278
- * <p>For example, to list all predictors whose status is ACTIVE, you would specify:</p>
6268
+ * <p>For example, to list all jobs that export a forecast named
6269
+ * <i>electricityWhatIfForecast</i>, specify the following filter:</p>
5279
6270
  * <p>
5280
- * <code>"Filters": [ { "Condition": "IS", "Key": "Status", "Value": "ACTIVE" }
5281
- * ]</code>
6271
+ * <code>"Filters": [ { "Condition": "IS", "Key": "WhatIfForecastArn", "Value":
6272
+ * "arn:aws:forecast:us-west-2:<acct-id>:forecast/electricityWhatIfForecast" } ]</code>
5282
6273
  * </p>
5283
6274
  */
5284
6275
  Filters?: Filter[];
5285
6276
  }
5286
6277
  /**
5287
- * <p>Provides a summary of the predictor properties that are used in the <a>ListPredictors</a> operation. To get the complete set of properties, call the <a>DescribePredictor</a> operation, and provide the listed
5288
- * <code>PredictorArn</code>.</p>
6278
+ * <p>Provides a summary of the what-if forecast properties used in the <a>ListWhatIfForecasts</a> operation. To get the complete set of properties, call the <a>DescribeWhatIfForecast</a> operation, and provide the <code>WhatIfForecastArn</code> that is listed in the summary.</p>
5289
6279
  */
5290
- export interface PredictorSummary {
5291
- /**
5292
- * <p>The ARN of the predictor.</p>
5293
- */
5294
- PredictorArn?: string;
5295
- /**
5296
- * <p>The name of the predictor.</p>
5297
- */
5298
- PredictorName?: string;
6280
+ export interface WhatIfForecastSummary {
5299
6281
  /**
5300
- * <p>The Amazon Resource Name (ARN) of the dataset group that contains the data used to train
5301
- * the predictor.</p>
6282
+ * <p>The Amazon Resource Name (ARN) of the what-if forecast.</p>
5302
6283
  */
5303
- DatasetGroupArn?: string;
6284
+ WhatIfForecastArn?: string;
5304
6285
  /**
5305
- * <p>Whether AutoPredictor was used to create the predictor.</p>
6286
+ * <p>The name of the what-if forecast.</p>
5306
6287
  */
5307
- IsAutoPredictor?: boolean;
6288
+ WhatIfForecastName?: string;
5308
6289
  /**
5309
- * <p>A summary of the reference predictor used if the predictor was retrained or
5310
- * upgraded.</p>
6290
+ * <p>The Amazon Resource Name (ARN) of the what-if analysis that contains this what-if forecast.</p>
5311
6291
  */
5312
- ReferencePredictorSummary?: ReferencePredictorSummary;
6292
+ WhatIfAnalysisArn?: string;
5313
6293
  /**
5314
- * <p>The status of the predictor. States include:</p>
6294
+ * <p>The status of the what-if forecast. States include:</p>
5315
6295
  * <ul>
5316
6296
  * <li>
5317
6297
  * <p>
@@ -5321,24 +6301,24 @@ export interface PredictorSummary {
5321
6301
  * <li>
5322
6302
  * <p>
5323
6303
  * <code>CREATE_PENDING</code>, <code>CREATE_IN_PROGRESS</code>,
5324
- * <code>CREATE_FAILED</code>
6304
+ * <code>CREATE_FAILED</code>
5325
6305
  * </p>
5326
6306
  * </li>
5327
6307
  * <li>
5328
6308
  * <p>
5329
- * <code>DELETE_PENDING</code>, <code>DELETE_IN_PROGRESS</code>,
5330
- * <code>DELETE_FAILED</code>
6309
+ * <code>CREATE_STOPPING</code>, <code>CREATE_STOPPED</code>
5331
6310
  * </p>
5332
6311
  * </li>
5333
6312
  * <li>
5334
6313
  * <p>
5335
- * <code>CREATE_STOPPING</code>, <code>CREATE_STOPPED</code>
6314
+ * <code>DELETE_PENDING</code>, <code>DELETE_IN_PROGRESS</code>,
6315
+ * <code>DELETE_FAILED</code>
5336
6316
  * </p>
5337
6317
  * </li>
5338
6318
  * </ul>
5339
6319
  * <note>
5340
- * <p>The <code>Status</code> of the predictor must be <code>ACTIVE</code> before you can use
5341
- * the predictor to create a forecast.</p>
6320
+ * <p>The <code>Status</code> of the what-if analysis must be <code>ACTIVE</code> before you can access the
6321
+ * analysis.</p>
5342
6322
  * </note>
5343
6323
  */
5344
6324
  Status?: string;
@@ -5347,12 +6327,11 @@ export interface PredictorSummary {
5347
6327
  */
5348
6328
  Message?: string;
5349
6329
  /**
5350
- * <p>When the model training task was created.</p>
6330
+ * <p>When the what-if forecast was created.</p>
5351
6331
  */
5352
6332
  CreationTime?: Date;
5353
6333
  /**
5354
- * <p>The last time the resource was modified. The timestamp depends on the status of the
5355
- * job:</p>
6334
+ * <p>The last time the resource was modified. The timestamp depends on the status of the job:</p>
5356
6335
  * <ul>
5357
6336
  * <li>
5358
6337
  * <p>
@@ -5379,30 +6358,17 @@ export interface PredictorSummary {
5379
6358
  */
5380
6359
  LastModificationTime?: Date;
5381
6360
  }
5382
- export interface ListPredictorsResponse {
6361
+ export interface ListWhatIfForecastsResponse {
5383
6362
  /**
5384
- * <p>An array of objects that summarize each predictor's properties.</p>
6363
+ * <p>An array of <code>WhatIfForecasts</code> objects that describe the matched forecasts.</p>
5385
6364
  */
5386
- Predictors?: PredictorSummary[];
6365
+ WhatIfForecasts?: WhatIfForecastSummary[];
5387
6366
  /**
5388
- * <p>If the response is truncated, Amazon Forecast returns this token. To retrieve the next set of
5389
- * results, use the token in the next request.</p>
6367
+ * <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
6368
+ request. Tokens expire after 24 hours.</p>
5390
6369
  */
5391
6370
  NextToken?: string;
5392
6371
  }
5393
- export interface ListTagsForResourceRequest {
5394
- /**
5395
- * <p>The Amazon Resource Name (ARN) that identifies the resource for which to list the tags.
5396
- * </p>
5397
- */
5398
- ResourceArn: string | undefined;
5399
- }
5400
- export interface ListTagsForResourceResponse {
5401
- /**
5402
- * <p>The tags for the resource.</p>
5403
- */
5404
- Tags?: Tag[];
5405
- }
5406
6372
  export interface ResumeResourceRequest {
5407
6373
  /**
5408
6374
  * <p>The Amazon Resource Name (ARN) of the monitor resource to resume.</p>
@@ -5491,6 +6457,10 @@ export interface UpdateDatasetGroupRequest {
5491
6457
  }
5492
6458
  export interface UpdateDatasetGroupResponse {
5493
6459
  }
6460
+ /**
6461
+ * @internal
6462
+ */
6463
+ export declare const ActionFilterSensitiveLog: (obj: Action) => any;
5494
6464
  /**
5495
6465
  * @internal
5496
6466
  */
@@ -5683,6 +6653,42 @@ export declare const CreatePredictorBacktestExportJobRequestFilterSensitiveLog:
5683
6653
  * @internal
5684
6654
  */
5685
6655
  export declare const CreatePredictorBacktestExportJobResponseFilterSensitiveLog: (obj: CreatePredictorBacktestExportJobResponse) => any;
6656
+ /**
6657
+ * @internal
6658
+ */
6659
+ export declare const CreateWhatIfAnalysisRequestFilterSensitiveLog: (obj: CreateWhatIfAnalysisRequest) => any;
6660
+ /**
6661
+ * @internal
6662
+ */
6663
+ export declare const CreateWhatIfAnalysisResponseFilterSensitiveLog: (obj: CreateWhatIfAnalysisResponse) => any;
6664
+ /**
6665
+ * @internal
6666
+ */
6667
+ export declare const TimeSeriesReplacementsDataSourceFilterSensitiveLog: (obj: TimeSeriesReplacementsDataSource) => any;
6668
+ /**
6669
+ * @internal
6670
+ */
6671
+ export declare const TimeSeriesConditionFilterSensitiveLog: (obj: TimeSeriesCondition) => any;
6672
+ /**
6673
+ * @internal
6674
+ */
6675
+ export declare const TimeSeriesTransformationFilterSensitiveLog: (obj: TimeSeriesTransformation) => any;
6676
+ /**
6677
+ * @internal
6678
+ */
6679
+ export declare const CreateWhatIfForecastRequestFilterSensitiveLog: (obj: CreateWhatIfForecastRequest) => any;
6680
+ /**
6681
+ * @internal
6682
+ */
6683
+ export declare const CreateWhatIfForecastResponseFilterSensitiveLog: (obj: CreateWhatIfForecastResponse) => any;
6684
+ /**
6685
+ * @internal
6686
+ */
6687
+ export declare const CreateWhatIfForecastExportRequestFilterSensitiveLog: (obj: CreateWhatIfForecastExportRequest) => any;
6688
+ /**
6689
+ * @internal
6690
+ */
6691
+ export declare const CreateWhatIfForecastExportResponseFilterSensitiveLog: (obj: CreateWhatIfForecastExportResponse) => any;
5686
6692
  /**
5687
6693
  * @internal
5688
6694
  */
@@ -5727,6 +6733,18 @@ export declare const DeletePredictorBacktestExportJobRequestFilterSensitiveLog:
5727
6733
  * @internal
5728
6734
  */
5729
6735
  export declare const DeleteResourceTreeRequestFilterSensitiveLog: (obj: DeleteResourceTreeRequest) => any;
6736
+ /**
6737
+ * @internal
6738
+ */
6739
+ export declare const DeleteWhatIfAnalysisRequestFilterSensitiveLog: (obj: DeleteWhatIfAnalysisRequest) => any;
6740
+ /**
6741
+ * @internal
6742
+ */
6743
+ export declare const DeleteWhatIfForecastRequestFilterSensitiveLog: (obj: DeleteWhatIfForecastRequest) => any;
6744
+ /**
6745
+ * @internal
6746
+ */
6747
+ export declare const DeleteWhatIfForecastExportRequestFilterSensitiveLog: (obj: DeleteWhatIfForecastExportRequest) => any;
5730
6748
  /**
5731
6749
  * @internal
5732
6750
  */
@@ -5855,6 +6873,30 @@ export declare const DescribePredictorBacktestExportJobRequestFilterSensitiveLog
5855
6873
  * @internal
5856
6874
  */
5857
6875
  export declare const DescribePredictorBacktestExportJobResponseFilterSensitiveLog: (obj: DescribePredictorBacktestExportJobResponse) => any;
6876
+ /**
6877
+ * @internal
6878
+ */
6879
+ export declare const DescribeWhatIfAnalysisRequestFilterSensitiveLog: (obj: DescribeWhatIfAnalysisRequest) => any;
6880
+ /**
6881
+ * @internal
6882
+ */
6883
+ export declare const DescribeWhatIfAnalysisResponseFilterSensitiveLog: (obj: DescribeWhatIfAnalysisResponse) => any;
6884
+ /**
6885
+ * @internal
6886
+ */
6887
+ export declare const DescribeWhatIfForecastRequestFilterSensitiveLog: (obj: DescribeWhatIfForecastRequest) => any;
6888
+ /**
6889
+ * @internal
6890
+ */
6891
+ export declare const DescribeWhatIfForecastResponseFilterSensitiveLog: (obj: DescribeWhatIfForecastResponse) => any;
6892
+ /**
6893
+ * @internal
6894
+ */
6895
+ export declare const DescribeWhatIfForecastExportRequestFilterSensitiveLog: (obj: DescribeWhatIfForecastExportRequest) => any;
6896
+ /**
6897
+ * @internal
6898
+ */
6899
+ export declare const DescribeWhatIfForecastExportResponseFilterSensitiveLog: (obj: DescribeWhatIfForecastExportResponse) => any;
5858
6900
  /**
5859
6901
  * @internal
5860
6902
  */
@@ -6039,6 +7081,42 @@ export declare const ListTagsForResourceRequestFilterSensitiveLog: (obj: ListTag
6039
7081
  * @internal
6040
7082
  */
6041
7083
  export declare const ListTagsForResourceResponseFilterSensitiveLog: (obj: ListTagsForResourceResponse) => any;
7084
+ /**
7085
+ * @internal
7086
+ */
7087
+ export declare const ListWhatIfAnalysesRequestFilterSensitiveLog: (obj: ListWhatIfAnalysesRequest) => any;
7088
+ /**
7089
+ * @internal
7090
+ */
7091
+ export declare const WhatIfAnalysisSummaryFilterSensitiveLog: (obj: WhatIfAnalysisSummary) => any;
7092
+ /**
7093
+ * @internal
7094
+ */
7095
+ export declare const ListWhatIfAnalysesResponseFilterSensitiveLog: (obj: ListWhatIfAnalysesResponse) => any;
7096
+ /**
7097
+ * @internal
7098
+ */
7099
+ export declare const ListWhatIfForecastExportsRequestFilterSensitiveLog: (obj: ListWhatIfForecastExportsRequest) => any;
7100
+ /**
7101
+ * @internal
7102
+ */
7103
+ export declare const WhatIfForecastExportSummaryFilterSensitiveLog: (obj: WhatIfForecastExportSummary) => any;
7104
+ /**
7105
+ * @internal
7106
+ */
7107
+ export declare const ListWhatIfForecastExportsResponseFilterSensitiveLog: (obj: ListWhatIfForecastExportsResponse) => any;
7108
+ /**
7109
+ * @internal
7110
+ */
7111
+ export declare const ListWhatIfForecastsRequestFilterSensitiveLog: (obj: ListWhatIfForecastsRequest) => any;
7112
+ /**
7113
+ * @internal
7114
+ */
7115
+ export declare const WhatIfForecastSummaryFilterSensitiveLog: (obj: WhatIfForecastSummary) => any;
7116
+ /**
7117
+ * @internal
7118
+ */
7119
+ export declare const ListWhatIfForecastsResponseFilterSensitiveLog: (obj: ListWhatIfForecastsResponse) => any;
6042
7120
  /**
6043
7121
  * @internal
6044
7122
  */