@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
@@ -10,6 +10,9 @@ import { CreateForecastExportJobCommandInput, CreateForecastExportJobCommandOutp
10
10
  import { CreateMonitorCommandInput, CreateMonitorCommandOutput } from "./commands/CreateMonitorCommand";
11
11
  import { CreatePredictorBacktestExportJobCommandInput, CreatePredictorBacktestExportJobCommandOutput } from "./commands/CreatePredictorBacktestExportJobCommand";
12
12
  import { CreatePredictorCommandInput, CreatePredictorCommandOutput } from "./commands/CreatePredictorCommand";
13
+ import { CreateWhatIfAnalysisCommandInput, CreateWhatIfAnalysisCommandOutput } from "./commands/CreateWhatIfAnalysisCommand";
14
+ import { CreateWhatIfForecastCommandInput, CreateWhatIfForecastCommandOutput } from "./commands/CreateWhatIfForecastCommand";
15
+ import { CreateWhatIfForecastExportCommandInput, CreateWhatIfForecastExportCommandOutput } from "./commands/CreateWhatIfForecastExportCommand";
13
16
  import { DeleteDatasetCommandInput, DeleteDatasetCommandOutput } from "./commands/DeleteDatasetCommand";
14
17
  import { DeleteDatasetGroupCommandInput, DeleteDatasetGroupCommandOutput } from "./commands/DeleteDatasetGroupCommand";
15
18
  import { DeleteDatasetImportJobCommandInput, DeleteDatasetImportJobCommandOutput } from "./commands/DeleteDatasetImportJobCommand";
@@ -21,6 +24,9 @@ import { DeleteMonitorCommandInput, DeleteMonitorCommandOutput } from "./command
21
24
  import { DeletePredictorBacktestExportJobCommandInput, DeletePredictorBacktestExportJobCommandOutput } from "./commands/DeletePredictorBacktestExportJobCommand";
22
25
  import { DeletePredictorCommandInput, DeletePredictorCommandOutput } from "./commands/DeletePredictorCommand";
23
26
  import { DeleteResourceTreeCommandInput, DeleteResourceTreeCommandOutput } from "./commands/DeleteResourceTreeCommand";
27
+ import { DeleteWhatIfAnalysisCommandInput, DeleteWhatIfAnalysisCommandOutput } from "./commands/DeleteWhatIfAnalysisCommand";
28
+ import { DeleteWhatIfForecastCommandInput, DeleteWhatIfForecastCommandOutput } from "./commands/DeleteWhatIfForecastCommand";
29
+ import { DeleteWhatIfForecastExportCommandInput, DeleteWhatIfForecastExportCommandOutput } from "./commands/DeleteWhatIfForecastExportCommand";
24
30
  import { DescribeAutoPredictorCommandInput, DescribeAutoPredictorCommandOutput } from "./commands/DescribeAutoPredictorCommand";
25
31
  import { DescribeDatasetCommandInput, DescribeDatasetCommandOutput } from "./commands/DescribeDatasetCommand";
26
32
  import { DescribeDatasetGroupCommandInput, DescribeDatasetGroupCommandOutput } from "./commands/DescribeDatasetGroupCommand";
@@ -32,6 +38,9 @@ import { DescribeForecastExportJobCommandInput, DescribeForecastExportJobCommand
32
38
  import { DescribeMonitorCommandInput, DescribeMonitorCommandOutput } from "./commands/DescribeMonitorCommand";
33
39
  import { DescribePredictorBacktestExportJobCommandInput, DescribePredictorBacktestExportJobCommandOutput } from "./commands/DescribePredictorBacktestExportJobCommand";
34
40
  import { DescribePredictorCommandInput, DescribePredictorCommandOutput } from "./commands/DescribePredictorCommand";
41
+ import { DescribeWhatIfAnalysisCommandInput, DescribeWhatIfAnalysisCommandOutput } from "./commands/DescribeWhatIfAnalysisCommand";
42
+ import { DescribeWhatIfForecastCommandInput, DescribeWhatIfForecastCommandOutput } from "./commands/DescribeWhatIfForecastCommand";
43
+ import { DescribeWhatIfForecastExportCommandInput, DescribeWhatIfForecastExportCommandOutput } from "./commands/DescribeWhatIfForecastExportCommand";
35
44
  import { GetAccuracyMetricsCommandInput, GetAccuracyMetricsCommandOutput } from "./commands/GetAccuracyMetricsCommand";
36
45
  import { ListDatasetGroupsCommandInput, ListDatasetGroupsCommandOutput } from "./commands/ListDatasetGroupsCommand";
37
46
  import { ListDatasetImportJobsCommandInput, ListDatasetImportJobsCommandOutput } from "./commands/ListDatasetImportJobsCommand";
@@ -45,6 +54,9 @@ import { ListMonitorsCommandInput, ListMonitorsCommandOutput } from "./commands/
45
54
  import { ListPredictorBacktestExportJobsCommandInput, ListPredictorBacktestExportJobsCommandOutput } from "./commands/ListPredictorBacktestExportJobsCommand";
46
55
  import { ListPredictorsCommandInput, ListPredictorsCommandOutput } from "./commands/ListPredictorsCommand";
47
56
  import { ListTagsForResourceCommandInput, ListTagsForResourceCommandOutput } from "./commands/ListTagsForResourceCommand";
57
+ import { ListWhatIfAnalysesCommandInput, ListWhatIfAnalysesCommandOutput } from "./commands/ListWhatIfAnalysesCommand";
58
+ import { ListWhatIfForecastExportsCommandInput, ListWhatIfForecastExportsCommandOutput } from "./commands/ListWhatIfForecastExportsCommand";
59
+ import { ListWhatIfForecastsCommandInput, ListWhatIfForecastsCommandOutput } from "./commands/ListWhatIfForecastsCommand";
48
60
  import { ResumeResourceCommandInput, ResumeResourceCommandOutput } from "./commands/ResumeResourceCommand";
49
61
  import { StopResourceCommandInput, StopResourceCommandOutput } from "./commands/StopResourceCommand";
50
62
  import { TagResourceCommandInput, TagResourceCommandOutput } from "./commands/TagResourceCommand";
@@ -474,6 +486,52 @@ export declare class Forecast extends ForecastClient {
474
486
  createPredictorBacktestExportJob(args: CreatePredictorBacktestExportJobCommandInput, options?: __HttpHandlerOptions): Promise<CreatePredictorBacktestExportJobCommandOutput>;
475
487
  createPredictorBacktestExportJob(args: CreatePredictorBacktestExportJobCommandInput, cb: (err: any, data?: CreatePredictorBacktestExportJobCommandOutput) => void): void;
476
488
  createPredictorBacktestExportJob(args: CreatePredictorBacktestExportJobCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreatePredictorBacktestExportJobCommandOutput) => void): void;
489
+ /**
490
+ * <p>What-if analysis is a scenario modeling technique where you make a hypothetical change to a time series and
491
+ * compare the forecasts generated by these changes against the baseline, unchanged time series. It is important to
492
+ * remember that the purpose of a what-if analysis is to understand how a forecast can change given different
493
+ * modifications to the baseline time series.</p>
494
+ * <p>For example, imagine you are a clothing retailer who is considering an end of season sale to clear space for
495
+ * new styles. After creating a baseline forecast, you can use a what-if analysis to investigate how different sales
496
+ * tactics might affect your goals. You could create a scenario where everything is given a 25% markdown and another
497
+ * where everything is given a fixed dollar markdown. You can create a scenario where the sale lasts for 1 week and
498
+ * another where the sale lasts for 1 month. Your what-if analysis enables you to compare many different scenarios
499
+ * against each other.</p>
500
+ * <p>Note that a what-if analysis is meant to display what the forecasting model has learned and how it will behave in the scenarios that you are evaluating. Do not blindly use the results of the what-if analysis to make business decisions. For instance, forecasts might not be accurate for novel scenarios where there is no reference available to determine whether a forecast is good.</p>
501
+ * <p>The <a>TimeSeriesSelector</a> object defines the items that you want in the what-if analysis.</p>
502
+ */
503
+ createWhatIfAnalysis(args: CreateWhatIfAnalysisCommandInput, options?: __HttpHandlerOptions): Promise<CreateWhatIfAnalysisCommandOutput>;
504
+ createWhatIfAnalysis(args: CreateWhatIfAnalysisCommandInput, cb: (err: any, data?: CreateWhatIfAnalysisCommandOutput) => void): void;
505
+ createWhatIfAnalysis(args: CreateWhatIfAnalysisCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateWhatIfAnalysisCommandOutput) => void): void;
506
+ /**
507
+ * <p>A what-if forecast is a forecast that is created from a modified version of the baseline forecast. Each
508
+ * what-if forecast incorporates either a replacement dataset or a set of transformations to the original dataset. </p>
509
+ */
510
+ createWhatIfForecast(args: CreateWhatIfForecastCommandInput, options?: __HttpHandlerOptions): Promise<CreateWhatIfForecastCommandOutput>;
511
+ createWhatIfForecast(args: CreateWhatIfForecastCommandInput, cb: (err: any, data?: CreateWhatIfForecastCommandOutput) => void): void;
512
+ createWhatIfForecast(args: CreateWhatIfForecastCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateWhatIfForecastCommandOutput) => void): void;
513
+ /**
514
+ * <p>Exports a forecast created by the <a>CreateWhatIfForecast</a> operation to your
515
+ * Amazon Simple Storage Service (Amazon S3) bucket. The forecast file name will match the following conventions:</p>
516
+ * <p>
517
+ * <code>≈<ForecastExportJobName>_<ExportTimestamp>_<PartNumber></code>
518
+ * </p>
519
+ * <p>The <ExportTimestamp> component is in Java SimpleDateFormat
520
+ * (yyyy-MM-ddTHH-mm-ssZ).</p>
521
+ * <p>You must specify a <a>DataDestination</a> object that includes an AWS Identity and Access Management
522
+ * (IAM) role that Amazon Forecast can assume to access the Amazon S3 bucket. For more information, see
523
+ * <a>aws-forecast-iam-roles</a>.</p>
524
+ * <p>For more information, see <a>howitworks-forecast</a>.</p>
525
+ * <p>To get a list of all your what-if forecast export jobs, use the <a>ListWhatIfForecastExports</a>
526
+ * operation.</p>
527
+ * <note>
528
+ * <p>The <code>Status</code> of the forecast export job must be <code>ACTIVE</code> before
529
+ * you can access the forecast in your Amazon S3 bucket. To get the status, use the <a>DescribeWhatIfForecastExport</a> operation.</p>
530
+ * </note>
531
+ */
532
+ createWhatIfForecastExport(args: CreateWhatIfForecastExportCommandInput, options?: __HttpHandlerOptions): Promise<CreateWhatIfForecastExportCommandOutput>;
533
+ createWhatIfForecastExport(args: CreateWhatIfForecastExportCommandInput, cb: (err: any, data?: CreateWhatIfForecastExportCommandOutput) => void): void;
534
+ createWhatIfForecastExport(args: CreateWhatIfForecastExportCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateWhatIfForecastExportCommandOutput) => void): void;
477
535
  /**
478
536
  * <p>Deletes an Amazon Forecast dataset that was created using the <a href="https://docs.aws.amazon.com/forecast/latest/dg/API_CreateDataset.html">CreateDataset</a> operation. You can
479
537
  * only delete datasets that have a status of <code>ACTIVE</code> or <code>CREATE_FAILED</code>.
@@ -593,6 +651,29 @@ export declare class Forecast extends ForecastClient {
593
651
  deleteResourceTree(args: DeleteResourceTreeCommandInput, options?: __HttpHandlerOptions): Promise<DeleteResourceTreeCommandOutput>;
594
652
  deleteResourceTree(args: DeleteResourceTreeCommandInput, cb: (err: any, data?: DeleteResourceTreeCommandOutput) => void): void;
595
653
  deleteResourceTree(args: DeleteResourceTreeCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteResourceTreeCommandOutput) => void): void;
654
+ /**
655
+ * <p>Deletes a what-if analysis created using the <a>CreateWhatIfAnalysis</a>
656
+ * operation. You can delete only what-if analyses that have a status of <code>ACTIVE</code> or <code>CREATE_FAILED</code>. To get the status, use the <a>DescribeWhatIfAnalysis</a> operation. </p>
657
+ * <p>You can't delete a what-if analysis while any of its forecasts are being exported.</p>
658
+ */
659
+ deleteWhatIfAnalysis(args: DeleteWhatIfAnalysisCommandInput, options?: __HttpHandlerOptions): Promise<DeleteWhatIfAnalysisCommandOutput>;
660
+ deleteWhatIfAnalysis(args: DeleteWhatIfAnalysisCommandInput, cb: (err: any, data?: DeleteWhatIfAnalysisCommandOutput) => void): void;
661
+ deleteWhatIfAnalysis(args: DeleteWhatIfAnalysisCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteWhatIfAnalysisCommandOutput) => void): void;
662
+ /**
663
+ * <p>Deletes a what-if forecast created using the <a>CreateWhatIfForecast</a>
664
+ * operation. You can delete only what-if forecasts that have a status of <code>ACTIVE</code> or <code>CREATE_FAILED</code>. To get the status, use the <a>DescribeWhatIfForecast</a> operation. </p>
665
+ * <p>You can't delete a what-if forecast while it is being exported. After a what-if forecast is deleted, you can no longer query the what-if analysis.</p>
666
+ */
667
+ deleteWhatIfForecast(args: DeleteWhatIfForecastCommandInput, options?: __HttpHandlerOptions): Promise<DeleteWhatIfForecastCommandOutput>;
668
+ deleteWhatIfForecast(args: DeleteWhatIfForecastCommandInput, cb: (err: any, data?: DeleteWhatIfForecastCommandOutput) => void): void;
669
+ deleteWhatIfForecast(args: DeleteWhatIfForecastCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteWhatIfForecastCommandOutput) => void): void;
670
+ /**
671
+ * <p>Deletes a what-if forecast export created using the <a>CreateWhatIfForecastExport</a>
672
+ * operation. You can delete only what-if forecast exports that have a status of <code>ACTIVE</code> or <code>CREATE_FAILED</code>. To get the status, use the <a>DescribeWhatIfForecastExport</a> operation. </p>
673
+ */
674
+ deleteWhatIfForecastExport(args: DeleteWhatIfForecastExportCommandInput, options?: __HttpHandlerOptions): Promise<DeleteWhatIfForecastExportCommandOutput>;
675
+ deleteWhatIfForecastExport(args: DeleteWhatIfForecastExportCommandInput, cb: (err: any, data?: DeleteWhatIfForecastExportCommandOutput) => void): void;
676
+ deleteWhatIfForecastExport(args: DeleteWhatIfForecastExportCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteWhatIfForecastExportCommandOutput) => void): void;
596
677
  /**
597
678
  * <p>Describes a predictor created using the CreateAutoPredictor operation.</p>
598
679
  */
@@ -887,6 +968,90 @@ export declare class Forecast extends ForecastClient {
887
968
  describePredictorBacktestExportJob(args: DescribePredictorBacktestExportJobCommandInput, options?: __HttpHandlerOptions): Promise<DescribePredictorBacktestExportJobCommandOutput>;
888
969
  describePredictorBacktestExportJob(args: DescribePredictorBacktestExportJobCommandInput, cb: (err: any, data?: DescribePredictorBacktestExportJobCommandOutput) => void): void;
889
970
  describePredictorBacktestExportJob(args: DescribePredictorBacktestExportJobCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribePredictorBacktestExportJobCommandOutput) => void): void;
971
+ /**
972
+ * <p>Describes the what-if analysis created using the <a>CreateWhatIfAnalysis</a> operation.</p>
973
+ * <p>In addition to listing the properties provided in the <code>CreateWhatIfAnalysis</code> request, this operation lists the following properties:</p>
974
+ * <ul>
975
+ * <li>
976
+ * <p>
977
+ * <code>CreationTime</code>
978
+ * </p>
979
+ * </li>
980
+ * <li>
981
+ * <p>
982
+ * <code>LastModificationTime</code>
983
+ * </p>
984
+ * </li>
985
+ * <li>
986
+ * <p>
987
+ * <code>Message</code> - If an error occurred, information about the error.</p>
988
+ * </li>
989
+ * <li>
990
+ * <p>
991
+ * <code>Status</code>
992
+ * </p>
993
+ * </li>
994
+ * </ul>
995
+ */
996
+ describeWhatIfAnalysis(args: DescribeWhatIfAnalysisCommandInput, options?: __HttpHandlerOptions): Promise<DescribeWhatIfAnalysisCommandOutput>;
997
+ describeWhatIfAnalysis(args: DescribeWhatIfAnalysisCommandInput, cb: (err: any, data?: DescribeWhatIfAnalysisCommandOutput) => void): void;
998
+ describeWhatIfAnalysis(args: DescribeWhatIfAnalysisCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeWhatIfAnalysisCommandOutput) => void): void;
999
+ /**
1000
+ * <p>Describes the what-if forecast created using the <a>CreateWhatIfForecast</a> operation.</p>
1001
+ * <p>In addition to listing the properties provided in the <code>CreateWhatIfForecast</code> request, this operation lists the following properties:</p>
1002
+ * <ul>
1003
+ * <li>
1004
+ * <p>
1005
+ * <code>CreationTime</code>
1006
+ * </p>
1007
+ * </li>
1008
+ * <li>
1009
+ * <p>
1010
+ * <code>LastModificationTime</code>
1011
+ * </p>
1012
+ * </li>
1013
+ * <li>
1014
+ * <p>
1015
+ * <code>Message</code> - If an error occurred, information about the error.</p>
1016
+ * </li>
1017
+ * <li>
1018
+ * <p>
1019
+ * <code>Status</code>
1020
+ * </p>
1021
+ * </li>
1022
+ * </ul>
1023
+ */
1024
+ describeWhatIfForecast(args: DescribeWhatIfForecastCommandInput, options?: __HttpHandlerOptions): Promise<DescribeWhatIfForecastCommandOutput>;
1025
+ describeWhatIfForecast(args: DescribeWhatIfForecastCommandInput, cb: (err: any, data?: DescribeWhatIfForecastCommandOutput) => void): void;
1026
+ describeWhatIfForecast(args: DescribeWhatIfForecastCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeWhatIfForecastCommandOutput) => void): void;
1027
+ /**
1028
+ * <p>Describes the what-if forecast export created using the <a>CreateWhatIfForecastExport</a> operation.</p>
1029
+ * <p>In addition to listing the properties provided in the <code>CreateWhatIfForecastExport</code> request, this operation lists the following properties:</p>
1030
+ * <ul>
1031
+ * <li>
1032
+ * <p>
1033
+ * <code>CreationTime</code>
1034
+ * </p>
1035
+ * </li>
1036
+ * <li>
1037
+ * <p>
1038
+ * <code>LastModificationTime</code>
1039
+ * </p>
1040
+ * </li>
1041
+ * <li>
1042
+ * <p>
1043
+ * <code>Message</code> - If an error occurred, information about the error.</p>
1044
+ * </li>
1045
+ * <li>
1046
+ * <p>
1047
+ * <code>Status</code>
1048
+ * </p>
1049
+ * </li>
1050
+ * </ul>
1051
+ */
1052
+ describeWhatIfForecastExport(args: DescribeWhatIfForecastExportCommandInput, options?: __HttpHandlerOptions): Promise<DescribeWhatIfForecastExportCommandOutput>;
1053
+ describeWhatIfForecastExport(args: DescribeWhatIfForecastExportCommandInput, cb: (err: any, data?: DescribeWhatIfForecastExportCommandOutput) => void): void;
1054
+ describeWhatIfForecastExport(args: DescribeWhatIfForecastExportCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeWhatIfForecastExportCommandOutput) => void): void;
890
1055
  /**
891
1056
  * <p>Provides metrics on the accuracy of the models that were trained by the <a>CreatePredictor</a> operation. Use metrics to see how well the model performed and
892
1057
  * to decide whether to use the predictor to generate a forecast. For more information, see
@@ -1017,6 +1182,24 @@ export declare class Forecast extends ForecastClient {
1017
1182
  listTagsForResource(args: ListTagsForResourceCommandInput, options?: __HttpHandlerOptions): Promise<ListTagsForResourceCommandOutput>;
1018
1183
  listTagsForResource(args: ListTagsForResourceCommandInput, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void): void;
1019
1184
  listTagsForResource(args: ListTagsForResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void): void;
1185
+ /**
1186
+ * <p>Returns a list of what-if analyses created using the <a>CreateWhatIfAnalysis</a> operation. For each what-if analysis, this operation returns a summary of its properties, including its Amazon Resource Name (ARN). You can retrieve the complete set of properties by using the what-if analysis ARN with the <a>DescribeWhatIfAnalysis</a> operation.</p>
1187
+ */
1188
+ listWhatIfAnalyses(args: ListWhatIfAnalysesCommandInput, options?: __HttpHandlerOptions): Promise<ListWhatIfAnalysesCommandOutput>;
1189
+ listWhatIfAnalyses(args: ListWhatIfAnalysesCommandInput, cb: (err: any, data?: ListWhatIfAnalysesCommandOutput) => void): void;
1190
+ listWhatIfAnalyses(args: ListWhatIfAnalysesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListWhatIfAnalysesCommandOutput) => void): void;
1191
+ /**
1192
+ * <p>Returns a list of what-if forecast exports created using the <a>CreateWhatIfForecastExport</a> operation. For each what-if forecast export, this operation returns a summary of its properties, including its Amazon Resource Name (ARN). You can retrieve the complete set of properties by using the what-if forecast export ARN with the <a>DescribeWhatIfForecastExport</a> operation.</p>
1193
+ */
1194
+ listWhatIfForecastExports(args: ListWhatIfForecastExportsCommandInput, options?: __HttpHandlerOptions): Promise<ListWhatIfForecastExportsCommandOutput>;
1195
+ listWhatIfForecastExports(args: ListWhatIfForecastExportsCommandInput, cb: (err: any, data?: ListWhatIfForecastExportsCommandOutput) => void): void;
1196
+ listWhatIfForecastExports(args: ListWhatIfForecastExportsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListWhatIfForecastExportsCommandOutput) => void): void;
1197
+ /**
1198
+ * <p>Returns a list of what-if forecasts created using the <a>CreateWhatIfForecast</a> operation. For each what-if forecast, this operation returns a summary of its properties, including its Amazon Resource Name (ARN). You can retrieve the complete set of properties by using the what-if forecast ARN with the <a>DescribeWhatIfForecast</a> operation.</p>
1199
+ */
1200
+ listWhatIfForecasts(args: ListWhatIfForecastsCommandInput, options?: __HttpHandlerOptions): Promise<ListWhatIfForecastsCommandOutput>;
1201
+ listWhatIfForecasts(args: ListWhatIfForecastsCommandInput, cb: (err: any, data?: ListWhatIfForecastsCommandOutput) => void): void;
1202
+ listWhatIfForecasts(args: ListWhatIfForecastsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListWhatIfForecastsCommandOutput) => void): void;
1020
1203
  /**
1021
1204
  * <p>Resumes a stopped monitor resource.</p>
1022
1205
  */
@@ -17,6 +17,9 @@ import { CreateForecastExportJobCommandInput, CreateForecastExportJobCommandOutp
17
17
  import { CreateMonitorCommandInput, CreateMonitorCommandOutput } from "./commands/CreateMonitorCommand";
18
18
  import { CreatePredictorBacktestExportJobCommandInput, CreatePredictorBacktestExportJobCommandOutput } from "./commands/CreatePredictorBacktestExportJobCommand";
19
19
  import { CreatePredictorCommandInput, CreatePredictorCommandOutput } from "./commands/CreatePredictorCommand";
20
+ import { CreateWhatIfAnalysisCommandInput, CreateWhatIfAnalysisCommandOutput } from "./commands/CreateWhatIfAnalysisCommand";
21
+ import { CreateWhatIfForecastCommandInput, CreateWhatIfForecastCommandOutput } from "./commands/CreateWhatIfForecastCommand";
22
+ import { CreateWhatIfForecastExportCommandInput, CreateWhatIfForecastExportCommandOutput } from "./commands/CreateWhatIfForecastExportCommand";
20
23
  import { DeleteDatasetCommandInput, DeleteDatasetCommandOutput } from "./commands/DeleteDatasetCommand";
21
24
  import { DeleteDatasetGroupCommandInput, DeleteDatasetGroupCommandOutput } from "./commands/DeleteDatasetGroupCommand";
22
25
  import { DeleteDatasetImportJobCommandInput, DeleteDatasetImportJobCommandOutput } from "./commands/DeleteDatasetImportJobCommand";
@@ -28,6 +31,9 @@ import { DeleteMonitorCommandInput, DeleteMonitorCommandOutput } from "./command
28
31
  import { DeletePredictorBacktestExportJobCommandInput, DeletePredictorBacktestExportJobCommandOutput } from "./commands/DeletePredictorBacktestExportJobCommand";
29
32
  import { DeletePredictorCommandInput, DeletePredictorCommandOutput } from "./commands/DeletePredictorCommand";
30
33
  import { DeleteResourceTreeCommandInput, DeleteResourceTreeCommandOutput } from "./commands/DeleteResourceTreeCommand";
34
+ import { DeleteWhatIfAnalysisCommandInput, DeleteWhatIfAnalysisCommandOutput } from "./commands/DeleteWhatIfAnalysisCommand";
35
+ import { DeleteWhatIfForecastCommandInput, DeleteWhatIfForecastCommandOutput } from "./commands/DeleteWhatIfForecastCommand";
36
+ import { DeleteWhatIfForecastExportCommandInput, DeleteWhatIfForecastExportCommandOutput } from "./commands/DeleteWhatIfForecastExportCommand";
31
37
  import { DescribeAutoPredictorCommandInput, DescribeAutoPredictorCommandOutput } from "./commands/DescribeAutoPredictorCommand";
32
38
  import { DescribeDatasetCommandInput, DescribeDatasetCommandOutput } from "./commands/DescribeDatasetCommand";
33
39
  import { DescribeDatasetGroupCommandInput, DescribeDatasetGroupCommandOutput } from "./commands/DescribeDatasetGroupCommand";
@@ -39,6 +45,9 @@ import { DescribeForecastExportJobCommandInput, DescribeForecastExportJobCommand
39
45
  import { DescribeMonitorCommandInput, DescribeMonitorCommandOutput } from "./commands/DescribeMonitorCommand";
40
46
  import { DescribePredictorBacktestExportJobCommandInput, DescribePredictorBacktestExportJobCommandOutput } from "./commands/DescribePredictorBacktestExportJobCommand";
41
47
  import { DescribePredictorCommandInput, DescribePredictorCommandOutput } from "./commands/DescribePredictorCommand";
48
+ import { DescribeWhatIfAnalysisCommandInput, DescribeWhatIfAnalysisCommandOutput } from "./commands/DescribeWhatIfAnalysisCommand";
49
+ import { DescribeWhatIfForecastCommandInput, DescribeWhatIfForecastCommandOutput } from "./commands/DescribeWhatIfForecastCommand";
50
+ import { DescribeWhatIfForecastExportCommandInput, DescribeWhatIfForecastExportCommandOutput } from "./commands/DescribeWhatIfForecastExportCommand";
42
51
  import { GetAccuracyMetricsCommandInput, GetAccuracyMetricsCommandOutput } from "./commands/GetAccuracyMetricsCommand";
43
52
  import { ListDatasetGroupsCommandInput, ListDatasetGroupsCommandOutput } from "./commands/ListDatasetGroupsCommand";
44
53
  import { ListDatasetImportJobsCommandInput, ListDatasetImportJobsCommandOutput } from "./commands/ListDatasetImportJobsCommand";
@@ -52,13 +61,16 @@ import { ListMonitorsCommandInput, ListMonitorsCommandOutput } from "./commands/
52
61
  import { ListPredictorBacktestExportJobsCommandInput, ListPredictorBacktestExportJobsCommandOutput } from "./commands/ListPredictorBacktestExportJobsCommand";
53
62
  import { ListPredictorsCommandInput, ListPredictorsCommandOutput } from "./commands/ListPredictorsCommand";
54
63
  import { ListTagsForResourceCommandInput, ListTagsForResourceCommandOutput } from "./commands/ListTagsForResourceCommand";
64
+ import { ListWhatIfAnalysesCommandInput, ListWhatIfAnalysesCommandOutput } from "./commands/ListWhatIfAnalysesCommand";
65
+ import { ListWhatIfForecastExportsCommandInput, ListWhatIfForecastExportsCommandOutput } from "./commands/ListWhatIfForecastExportsCommand";
66
+ import { ListWhatIfForecastsCommandInput, ListWhatIfForecastsCommandOutput } from "./commands/ListWhatIfForecastsCommand";
55
67
  import { ResumeResourceCommandInput, ResumeResourceCommandOutput } from "./commands/ResumeResourceCommand";
56
68
  import { StopResourceCommandInput, StopResourceCommandOutput } from "./commands/StopResourceCommand";
57
69
  import { TagResourceCommandInput, TagResourceCommandOutput } from "./commands/TagResourceCommand";
58
70
  import { UntagResourceCommandInput, UntagResourceCommandOutput } from "./commands/UntagResourceCommand";
59
71
  import { UpdateDatasetGroupCommandInput, UpdateDatasetGroupCommandOutput } from "./commands/UpdateDatasetGroupCommand";
60
- export declare type ServiceInputTypes = CreateAutoPredictorCommandInput | CreateDatasetCommandInput | CreateDatasetGroupCommandInput | CreateDatasetImportJobCommandInput | CreateExplainabilityCommandInput | CreateExplainabilityExportCommandInput | CreateForecastCommandInput | CreateForecastExportJobCommandInput | CreateMonitorCommandInput | CreatePredictorBacktestExportJobCommandInput | CreatePredictorCommandInput | DeleteDatasetCommandInput | DeleteDatasetGroupCommandInput | DeleteDatasetImportJobCommandInput | DeleteExplainabilityCommandInput | DeleteExplainabilityExportCommandInput | DeleteForecastCommandInput | DeleteForecastExportJobCommandInput | DeleteMonitorCommandInput | DeletePredictorBacktestExportJobCommandInput | DeletePredictorCommandInput | DeleteResourceTreeCommandInput | DescribeAutoPredictorCommandInput | DescribeDatasetCommandInput | DescribeDatasetGroupCommandInput | DescribeDatasetImportJobCommandInput | DescribeExplainabilityCommandInput | DescribeExplainabilityExportCommandInput | DescribeForecastCommandInput | DescribeForecastExportJobCommandInput | DescribeMonitorCommandInput | DescribePredictorBacktestExportJobCommandInput | DescribePredictorCommandInput | GetAccuracyMetricsCommandInput | ListDatasetGroupsCommandInput | ListDatasetImportJobsCommandInput | ListDatasetsCommandInput | ListExplainabilitiesCommandInput | ListExplainabilityExportsCommandInput | ListForecastExportJobsCommandInput | ListForecastsCommandInput | ListMonitorEvaluationsCommandInput | ListMonitorsCommandInput | ListPredictorBacktestExportJobsCommandInput | ListPredictorsCommandInput | ListTagsForResourceCommandInput | ResumeResourceCommandInput | StopResourceCommandInput | TagResourceCommandInput | UntagResourceCommandInput | UpdateDatasetGroupCommandInput;
61
- export declare type ServiceOutputTypes = CreateAutoPredictorCommandOutput | CreateDatasetCommandOutput | CreateDatasetGroupCommandOutput | CreateDatasetImportJobCommandOutput | CreateExplainabilityCommandOutput | CreateExplainabilityExportCommandOutput | CreateForecastCommandOutput | CreateForecastExportJobCommandOutput | CreateMonitorCommandOutput | CreatePredictorBacktestExportJobCommandOutput | CreatePredictorCommandOutput | DeleteDatasetCommandOutput | DeleteDatasetGroupCommandOutput | DeleteDatasetImportJobCommandOutput | DeleteExplainabilityCommandOutput | DeleteExplainabilityExportCommandOutput | DeleteForecastCommandOutput | DeleteForecastExportJobCommandOutput | DeleteMonitorCommandOutput | DeletePredictorBacktestExportJobCommandOutput | DeletePredictorCommandOutput | DeleteResourceTreeCommandOutput | DescribeAutoPredictorCommandOutput | DescribeDatasetCommandOutput | DescribeDatasetGroupCommandOutput | DescribeDatasetImportJobCommandOutput | DescribeExplainabilityCommandOutput | DescribeExplainabilityExportCommandOutput | DescribeForecastCommandOutput | DescribeForecastExportJobCommandOutput | DescribeMonitorCommandOutput | DescribePredictorBacktestExportJobCommandOutput | DescribePredictorCommandOutput | GetAccuracyMetricsCommandOutput | ListDatasetGroupsCommandOutput | ListDatasetImportJobsCommandOutput | ListDatasetsCommandOutput | ListExplainabilitiesCommandOutput | ListExplainabilityExportsCommandOutput | ListForecastExportJobsCommandOutput | ListForecastsCommandOutput | ListMonitorEvaluationsCommandOutput | ListMonitorsCommandOutput | ListPredictorBacktestExportJobsCommandOutput | ListPredictorsCommandOutput | ListTagsForResourceCommandOutput | ResumeResourceCommandOutput | StopResourceCommandOutput | TagResourceCommandOutput | UntagResourceCommandOutput | UpdateDatasetGroupCommandOutput;
72
+ export declare type ServiceInputTypes = CreateAutoPredictorCommandInput | CreateDatasetCommandInput | CreateDatasetGroupCommandInput | CreateDatasetImportJobCommandInput | CreateExplainabilityCommandInput | CreateExplainabilityExportCommandInput | CreateForecastCommandInput | CreateForecastExportJobCommandInput | CreateMonitorCommandInput | CreatePredictorBacktestExportJobCommandInput | CreatePredictorCommandInput | CreateWhatIfAnalysisCommandInput | CreateWhatIfForecastCommandInput | CreateWhatIfForecastExportCommandInput | DeleteDatasetCommandInput | DeleteDatasetGroupCommandInput | DeleteDatasetImportJobCommandInput | DeleteExplainabilityCommandInput | DeleteExplainabilityExportCommandInput | DeleteForecastCommandInput | DeleteForecastExportJobCommandInput | DeleteMonitorCommandInput | DeletePredictorBacktestExportJobCommandInput | DeletePredictorCommandInput | DeleteResourceTreeCommandInput | DeleteWhatIfAnalysisCommandInput | DeleteWhatIfForecastCommandInput | DeleteWhatIfForecastExportCommandInput | DescribeAutoPredictorCommandInput | DescribeDatasetCommandInput | DescribeDatasetGroupCommandInput | DescribeDatasetImportJobCommandInput | DescribeExplainabilityCommandInput | DescribeExplainabilityExportCommandInput | DescribeForecastCommandInput | DescribeForecastExportJobCommandInput | DescribeMonitorCommandInput | DescribePredictorBacktestExportJobCommandInput | DescribePredictorCommandInput | DescribeWhatIfAnalysisCommandInput | DescribeWhatIfForecastCommandInput | DescribeWhatIfForecastExportCommandInput | GetAccuracyMetricsCommandInput | ListDatasetGroupsCommandInput | ListDatasetImportJobsCommandInput | ListDatasetsCommandInput | ListExplainabilitiesCommandInput | ListExplainabilityExportsCommandInput | ListForecastExportJobsCommandInput | ListForecastsCommandInput | ListMonitorEvaluationsCommandInput | ListMonitorsCommandInput | ListPredictorBacktestExportJobsCommandInput | ListPredictorsCommandInput | ListTagsForResourceCommandInput | ListWhatIfAnalysesCommandInput | ListWhatIfForecastExportsCommandInput | ListWhatIfForecastsCommandInput | ResumeResourceCommandInput | StopResourceCommandInput | TagResourceCommandInput | UntagResourceCommandInput | UpdateDatasetGroupCommandInput;
73
+ export declare type ServiceOutputTypes = CreateAutoPredictorCommandOutput | CreateDatasetCommandOutput | CreateDatasetGroupCommandOutput | CreateDatasetImportJobCommandOutput | CreateExplainabilityCommandOutput | CreateExplainabilityExportCommandOutput | CreateForecastCommandOutput | CreateForecastExportJobCommandOutput | CreateMonitorCommandOutput | CreatePredictorBacktestExportJobCommandOutput | CreatePredictorCommandOutput | CreateWhatIfAnalysisCommandOutput | CreateWhatIfForecastCommandOutput | CreateWhatIfForecastExportCommandOutput | DeleteDatasetCommandOutput | DeleteDatasetGroupCommandOutput | DeleteDatasetImportJobCommandOutput | DeleteExplainabilityCommandOutput | DeleteExplainabilityExportCommandOutput | DeleteForecastCommandOutput | DeleteForecastExportJobCommandOutput | DeleteMonitorCommandOutput | DeletePredictorBacktestExportJobCommandOutput | DeletePredictorCommandOutput | DeleteResourceTreeCommandOutput | DeleteWhatIfAnalysisCommandOutput | DeleteWhatIfForecastCommandOutput | DeleteWhatIfForecastExportCommandOutput | DescribeAutoPredictorCommandOutput | DescribeDatasetCommandOutput | DescribeDatasetGroupCommandOutput | DescribeDatasetImportJobCommandOutput | DescribeExplainabilityCommandOutput | DescribeExplainabilityExportCommandOutput | DescribeForecastCommandOutput | DescribeForecastExportJobCommandOutput | DescribeMonitorCommandOutput | DescribePredictorBacktestExportJobCommandOutput | DescribePredictorCommandOutput | DescribeWhatIfAnalysisCommandOutput | DescribeWhatIfForecastCommandOutput | DescribeWhatIfForecastExportCommandOutput | GetAccuracyMetricsCommandOutput | ListDatasetGroupsCommandOutput | ListDatasetImportJobsCommandOutput | ListDatasetsCommandOutput | ListExplainabilitiesCommandOutput | ListExplainabilityExportsCommandOutput | ListForecastExportJobsCommandOutput | ListForecastsCommandOutput | ListMonitorEvaluationsCommandOutput | ListMonitorsCommandOutput | ListPredictorBacktestExportJobsCommandOutput | ListPredictorsCommandOutput | ListTagsForResourceCommandOutput | ListWhatIfAnalysesCommandOutput | ListWhatIfForecastExportsCommandOutput | ListWhatIfForecastsCommandOutput | ResumeResourceCommandOutput | StopResourceCommandOutput | TagResourceCommandOutput | UntagResourceCommandOutput | UpdateDatasetGroupCommandOutput;
62
74
  export interface ClientDefaults extends Partial<__SmithyResolvedConfiguration<__HttpHandlerOptions>> {
63
75
  /**
64
76
  * The HTTP handler to use. Fetch in browser and Https in Nodejs.
@@ -0,0 +1,46 @@
1
+ import { Command as $Command } from "@aws-sdk/smithy-client";
2
+ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer, MiddlewareStack } from "@aws-sdk/types";
3
+ import { ForecastClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ForecastClient";
4
+ import { CreateWhatIfAnalysisRequest, CreateWhatIfAnalysisResponse } from "../models/models_0";
5
+ export interface CreateWhatIfAnalysisCommandInput extends CreateWhatIfAnalysisRequest {
6
+ }
7
+ export interface CreateWhatIfAnalysisCommandOutput extends CreateWhatIfAnalysisResponse, __MetadataBearer {
8
+ }
9
+ /**
10
+ * <p>What-if analysis is a scenario modeling technique where you make a hypothetical change to a time series and
11
+ * compare the forecasts generated by these changes against the baseline, unchanged time series. It is important to
12
+ * remember that the purpose of a what-if analysis is to understand how a forecast can change given different
13
+ * modifications to the baseline time series.</p>
14
+ * <p>For example, imagine you are a clothing retailer who is considering an end of season sale to clear space for
15
+ * new styles. After creating a baseline forecast, you can use a what-if analysis to investigate how different sales
16
+ * tactics might affect your goals. You could create a scenario where everything is given a 25% markdown and another
17
+ * where everything is given a fixed dollar markdown. You can create a scenario where the sale lasts for 1 week and
18
+ * another where the sale lasts for 1 month. Your what-if analysis enables you to compare many different scenarios
19
+ * against each other.</p>
20
+ * <p>Note that a what-if analysis is meant to display what the forecasting model has learned and how it will behave in the scenarios that you are evaluating. Do not blindly use the results of the what-if analysis to make business decisions. For instance, forecasts might not be accurate for novel scenarios where there is no reference available to determine whether a forecast is good.</p>
21
+ * <p>The <a>TimeSeriesSelector</a> object defines the items that you want in the what-if analysis.</p>
22
+ * @example
23
+ * Use a bare-bones client and the command you need to make an API call.
24
+ * ```javascript
25
+ * import { ForecastClient, CreateWhatIfAnalysisCommand } from "@aws-sdk/client-forecast"; // ES Modules import
26
+ * // const { ForecastClient, CreateWhatIfAnalysisCommand } = require("@aws-sdk/client-forecast"); // CommonJS import
27
+ * const client = new ForecastClient(config);
28
+ * const command = new CreateWhatIfAnalysisCommand(input);
29
+ * const response = await client.send(command);
30
+ * ```
31
+ *
32
+ * @see {@link CreateWhatIfAnalysisCommandInput} for command's `input` shape.
33
+ * @see {@link CreateWhatIfAnalysisCommandOutput} for command's `response` shape.
34
+ * @see {@link ForecastClientResolvedConfig | config} for ForecastClient's `config` shape.
35
+ *
36
+ */
37
+ export declare class CreateWhatIfAnalysisCommand extends $Command<CreateWhatIfAnalysisCommandInput, CreateWhatIfAnalysisCommandOutput, ForecastClientResolvedConfig> {
38
+ readonly input: CreateWhatIfAnalysisCommandInput;
39
+ constructor(input: CreateWhatIfAnalysisCommandInput);
40
+ /**
41
+ * @internal
42
+ */
43
+ resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: ForecastClientResolvedConfig, options?: __HttpHandlerOptions): Handler<CreateWhatIfAnalysisCommandInput, CreateWhatIfAnalysisCommandOutput>;
44
+ private serialize;
45
+ private deserialize;
46
+ }
@@ -0,0 +1,36 @@
1
+ import { Command as $Command } from "@aws-sdk/smithy-client";
2
+ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer, MiddlewareStack } from "@aws-sdk/types";
3
+ import { ForecastClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ForecastClient";
4
+ import { CreateWhatIfForecastRequest, CreateWhatIfForecastResponse } from "../models/models_0";
5
+ export interface CreateWhatIfForecastCommandInput extends CreateWhatIfForecastRequest {
6
+ }
7
+ export interface CreateWhatIfForecastCommandOutput extends CreateWhatIfForecastResponse, __MetadataBearer {
8
+ }
9
+ /**
10
+ * <p>A what-if forecast is a forecast that is created from a modified version of the baseline forecast. Each
11
+ * what-if forecast incorporates either a replacement dataset or a set of transformations to the original dataset. </p>
12
+ * @example
13
+ * Use a bare-bones client and the command you need to make an API call.
14
+ * ```javascript
15
+ * import { ForecastClient, CreateWhatIfForecastCommand } from "@aws-sdk/client-forecast"; // ES Modules import
16
+ * // const { ForecastClient, CreateWhatIfForecastCommand } = require("@aws-sdk/client-forecast"); // CommonJS import
17
+ * const client = new ForecastClient(config);
18
+ * const command = new CreateWhatIfForecastCommand(input);
19
+ * const response = await client.send(command);
20
+ * ```
21
+ *
22
+ * @see {@link CreateWhatIfForecastCommandInput} for command's `input` shape.
23
+ * @see {@link CreateWhatIfForecastCommandOutput} for command's `response` shape.
24
+ * @see {@link ForecastClientResolvedConfig | config} for ForecastClient's `config` shape.
25
+ *
26
+ */
27
+ export declare class CreateWhatIfForecastCommand extends $Command<CreateWhatIfForecastCommandInput, CreateWhatIfForecastCommandOutput, ForecastClientResolvedConfig> {
28
+ readonly input: CreateWhatIfForecastCommandInput;
29
+ constructor(input: CreateWhatIfForecastCommandInput);
30
+ /**
31
+ * @internal
32
+ */
33
+ resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: ForecastClientResolvedConfig, options?: __HttpHandlerOptions): Handler<CreateWhatIfForecastCommandInput, CreateWhatIfForecastCommandOutput>;
34
+ private serialize;
35
+ private deserialize;
36
+ }
@@ -0,0 +1,51 @@
1
+ import { Command as $Command } from "@aws-sdk/smithy-client";
2
+ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer, MiddlewareStack } from "@aws-sdk/types";
3
+ import { ForecastClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ForecastClient";
4
+ import { CreateWhatIfForecastExportRequest, CreateWhatIfForecastExportResponse } from "../models/models_0";
5
+ export interface CreateWhatIfForecastExportCommandInput extends CreateWhatIfForecastExportRequest {
6
+ }
7
+ export interface CreateWhatIfForecastExportCommandOutput extends CreateWhatIfForecastExportResponse, __MetadataBearer {
8
+ }
9
+ /**
10
+ * <p>Exports a forecast created by the <a>CreateWhatIfForecast</a> operation to your
11
+ * Amazon Simple Storage Service (Amazon S3) bucket. The forecast file name will match the following conventions:</p>
12
+ * <p>
13
+ * <code>≈<ForecastExportJobName>_<ExportTimestamp>_<PartNumber></code>
14
+ * </p>
15
+ * <p>The <ExportTimestamp> component is in Java SimpleDateFormat
16
+ * (yyyy-MM-ddTHH-mm-ssZ).</p>
17
+ * <p>You must specify a <a>DataDestination</a> object that includes an AWS Identity and Access Management
18
+ * (IAM) role that Amazon Forecast can assume to access the Amazon S3 bucket. For more information, see
19
+ * <a>aws-forecast-iam-roles</a>.</p>
20
+ * <p>For more information, see <a>howitworks-forecast</a>.</p>
21
+ * <p>To get a list of all your what-if forecast export jobs, use the <a>ListWhatIfForecastExports</a>
22
+ * operation.</p>
23
+ * <note>
24
+ * <p>The <code>Status</code> of the forecast export job must be <code>ACTIVE</code> before
25
+ * you can access the forecast in your Amazon S3 bucket. To get the status, use the <a>DescribeWhatIfForecastExport</a> operation.</p>
26
+ * </note>
27
+ * @example
28
+ * Use a bare-bones client and the command you need to make an API call.
29
+ * ```javascript
30
+ * import { ForecastClient, CreateWhatIfForecastExportCommand } from "@aws-sdk/client-forecast"; // ES Modules import
31
+ * // const { ForecastClient, CreateWhatIfForecastExportCommand } = require("@aws-sdk/client-forecast"); // CommonJS import
32
+ * const client = new ForecastClient(config);
33
+ * const command = new CreateWhatIfForecastExportCommand(input);
34
+ * const response = await client.send(command);
35
+ * ```
36
+ *
37
+ * @see {@link CreateWhatIfForecastExportCommandInput} for command's `input` shape.
38
+ * @see {@link CreateWhatIfForecastExportCommandOutput} for command's `response` shape.
39
+ * @see {@link ForecastClientResolvedConfig | config} for ForecastClient's `config` shape.
40
+ *
41
+ */
42
+ export declare class CreateWhatIfForecastExportCommand extends $Command<CreateWhatIfForecastExportCommandInput, CreateWhatIfForecastExportCommandOutput, ForecastClientResolvedConfig> {
43
+ readonly input: CreateWhatIfForecastExportCommandInput;
44
+ constructor(input: CreateWhatIfForecastExportCommandInput);
45
+ /**
46
+ * @internal
47
+ */
48
+ resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: ForecastClientResolvedConfig, options?: __HttpHandlerOptions): Handler<CreateWhatIfForecastExportCommandInput, CreateWhatIfForecastExportCommandOutput>;
49
+ private serialize;
50
+ private deserialize;
51
+ }
@@ -0,0 +1,37 @@
1
+ import { Command as $Command } from "@aws-sdk/smithy-client";
2
+ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer, MiddlewareStack } from "@aws-sdk/types";
3
+ import { ForecastClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ForecastClient";
4
+ import { DeleteWhatIfAnalysisRequest } from "../models/models_0";
5
+ export interface DeleteWhatIfAnalysisCommandInput extends DeleteWhatIfAnalysisRequest {
6
+ }
7
+ export interface DeleteWhatIfAnalysisCommandOutput extends __MetadataBearer {
8
+ }
9
+ /**
10
+ * <p>Deletes a what-if analysis created using the <a>CreateWhatIfAnalysis</a>
11
+ * operation. You can delete only what-if analyses that have a status of <code>ACTIVE</code> or <code>CREATE_FAILED</code>. To get the status, use the <a>DescribeWhatIfAnalysis</a> operation. </p>
12
+ * <p>You can't delete a what-if analysis while any of its forecasts are being exported.</p>
13
+ * @example
14
+ * Use a bare-bones client and the command you need to make an API call.
15
+ * ```javascript
16
+ * import { ForecastClient, DeleteWhatIfAnalysisCommand } from "@aws-sdk/client-forecast"; // ES Modules import
17
+ * // const { ForecastClient, DeleteWhatIfAnalysisCommand } = require("@aws-sdk/client-forecast"); // CommonJS import
18
+ * const client = new ForecastClient(config);
19
+ * const command = new DeleteWhatIfAnalysisCommand(input);
20
+ * const response = await client.send(command);
21
+ * ```
22
+ *
23
+ * @see {@link DeleteWhatIfAnalysisCommandInput} for command's `input` shape.
24
+ * @see {@link DeleteWhatIfAnalysisCommandOutput} for command's `response` shape.
25
+ * @see {@link ForecastClientResolvedConfig | config} for ForecastClient's `config` shape.
26
+ *
27
+ */
28
+ export declare class DeleteWhatIfAnalysisCommand extends $Command<DeleteWhatIfAnalysisCommandInput, DeleteWhatIfAnalysisCommandOutput, ForecastClientResolvedConfig> {
29
+ readonly input: DeleteWhatIfAnalysisCommandInput;
30
+ constructor(input: DeleteWhatIfAnalysisCommandInput);
31
+ /**
32
+ * @internal
33
+ */
34
+ resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: ForecastClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DeleteWhatIfAnalysisCommandInput, DeleteWhatIfAnalysisCommandOutput>;
35
+ private serialize;
36
+ private deserialize;
37
+ }
@@ -0,0 +1,37 @@
1
+ import { Command as $Command } from "@aws-sdk/smithy-client";
2
+ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer, MiddlewareStack } from "@aws-sdk/types";
3
+ import { ForecastClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ForecastClient";
4
+ import { DeleteWhatIfForecastRequest } from "../models/models_0";
5
+ export interface DeleteWhatIfForecastCommandInput extends DeleteWhatIfForecastRequest {
6
+ }
7
+ export interface DeleteWhatIfForecastCommandOutput extends __MetadataBearer {
8
+ }
9
+ /**
10
+ * <p>Deletes a what-if forecast created using the <a>CreateWhatIfForecast</a>
11
+ * operation. You can delete only what-if forecasts that have a status of <code>ACTIVE</code> or <code>CREATE_FAILED</code>. To get the status, use the <a>DescribeWhatIfForecast</a> operation. </p>
12
+ * <p>You can't delete a what-if forecast while it is being exported. After a what-if forecast is deleted, you can no longer query the what-if analysis.</p>
13
+ * @example
14
+ * Use a bare-bones client and the command you need to make an API call.
15
+ * ```javascript
16
+ * import { ForecastClient, DeleteWhatIfForecastCommand } from "@aws-sdk/client-forecast"; // ES Modules import
17
+ * // const { ForecastClient, DeleteWhatIfForecastCommand } = require("@aws-sdk/client-forecast"); // CommonJS import
18
+ * const client = new ForecastClient(config);
19
+ * const command = new DeleteWhatIfForecastCommand(input);
20
+ * const response = await client.send(command);
21
+ * ```
22
+ *
23
+ * @see {@link DeleteWhatIfForecastCommandInput} for command's `input` shape.
24
+ * @see {@link DeleteWhatIfForecastCommandOutput} for command's `response` shape.
25
+ * @see {@link ForecastClientResolvedConfig | config} for ForecastClient's `config` shape.
26
+ *
27
+ */
28
+ export declare class DeleteWhatIfForecastCommand extends $Command<DeleteWhatIfForecastCommandInput, DeleteWhatIfForecastCommandOutput, ForecastClientResolvedConfig> {
29
+ readonly input: DeleteWhatIfForecastCommandInput;
30
+ constructor(input: DeleteWhatIfForecastCommandInput);
31
+ /**
32
+ * @internal
33
+ */
34
+ resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: ForecastClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DeleteWhatIfForecastCommandInput, DeleteWhatIfForecastCommandOutput>;
35
+ private serialize;
36
+ private deserialize;
37
+ }
@@ -0,0 +1,36 @@
1
+ import { Command as $Command } from "@aws-sdk/smithy-client";
2
+ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer, MiddlewareStack } from "@aws-sdk/types";
3
+ import { ForecastClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ForecastClient";
4
+ import { DeleteWhatIfForecastExportRequest } from "../models/models_0";
5
+ export interface DeleteWhatIfForecastExportCommandInput extends DeleteWhatIfForecastExportRequest {
6
+ }
7
+ export interface DeleteWhatIfForecastExportCommandOutput extends __MetadataBearer {
8
+ }
9
+ /**
10
+ * <p>Deletes a what-if forecast export created using the <a>CreateWhatIfForecastExport</a>
11
+ * operation. You can delete only what-if forecast exports that have a status of <code>ACTIVE</code> or <code>CREATE_FAILED</code>. To get the status, use the <a>DescribeWhatIfForecastExport</a> operation. </p>
12
+ * @example
13
+ * Use a bare-bones client and the command you need to make an API call.
14
+ * ```javascript
15
+ * import { ForecastClient, DeleteWhatIfForecastExportCommand } from "@aws-sdk/client-forecast"; // ES Modules import
16
+ * // const { ForecastClient, DeleteWhatIfForecastExportCommand } = require("@aws-sdk/client-forecast"); // CommonJS import
17
+ * const client = new ForecastClient(config);
18
+ * const command = new DeleteWhatIfForecastExportCommand(input);
19
+ * const response = await client.send(command);
20
+ * ```
21
+ *
22
+ * @see {@link DeleteWhatIfForecastExportCommandInput} for command's `input` shape.
23
+ * @see {@link DeleteWhatIfForecastExportCommandOutput} for command's `response` shape.
24
+ * @see {@link ForecastClientResolvedConfig | config} for ForecastClient's `config` shape.
25
+ *
26
+ */
27
+ export declare class DeleteWhatIfForecastExportCommand extends $Command<DeleteWhatIfForecastExportCommandInput, DeleteWhatIfForecastExportCommandOutput, ForecastClientResolvedConfig> {
28
+ readonly input: DeleteWhatIfForecastExportCommandInput;
29
+ constructor(input: DeleteWhatIfForecastExportCommandInput);
30
+ /**
31
+ * @internal
32
+ */
33
+ resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: ForecastClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DeleteWhatIfForecastExportCommandInput, DeleteWhatIfForecastExportCommandOutput>;
34
+ private serialize;
35
+ private deserialize;
36
+ }
@@ -0,0 +1,57 @@
1
+ import { Command as $Command } from "@aws-sdk/smithy-client";
2
+ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer, MiddlewareStack } from "@aws-sdk/types";
3
+ import { ForecastClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ForecastClient";
4
+ import { DescribeWhatIfAnalysisRequest, DescribeWhatIfAnalysisResponse } from "../models/models_0";
5
+ export interface DescribeWhatIfAnalysisCommandInput extends DescribeWhatIfAnalysisRequest {
6
+ }
7
+ export interface DescribeWhatIfAnalysisCommandOutput extends DescribeWhatIfAnalysisResponse, __MetadataBearer {
8
+ }
9
+ /**
10
+ * <p>Describes the what-if analysis created using the <a>CreateWhatIfAnalysis</a> operation.</p>
11
+ * <p>In addition to listing the properties provided in the <code>CreateWhatIfAnalysis</code> request, this operation lists the following properties:</p>
12
+ * <ul>
13
+ * <li>
14
+ * <p>
15
+ * <code>CreationTime</code>
16
+ * </p>
17
+ * </li>
18
+ * <li>
19
+ * <p>
20
+ * <code>LastModificationTime</code>
21
+ * </p>
22
+ * </li>
23
+ * <li>
24
+ * <p>
25
+ * <code>Message</code> - If an error occurred, information about the error.</p>
26
+ * </li>
27
+ * <li>
28
+ * <p>
29
+ * <code>Status</code>
30
+ * </p>
31
+ * </li>
32
+ * </ul>
33
+ * @example
34
+ * Use a bare-bones client and the command you need to make an API call.
35
+ * ```javascript
36
+ * import { ForecastClient, DescribeWhatIfAnalysisCommand } from "@aws-sdk/client-forecast"; // ES Modules import
37
+ * // const { ForecastClient, DescribeWhatIfAnalysisCommand } = require("@aws-sdk/client-forecast"); // CommonJS import
38
+ * const client = new ForecastClient(config);
39
+ * const command = new DescribeWhatIfAnalysisCommand(input);
40
+ * const response = await client.send(command);
41
+ * ```
42
+ *
43
+ * @see {@link DescribeWhatIfAnalysisCommandInput} for command's `input` shape.
44
+ * @see {@link DescribeWhatIfAnalysisCommandOutput} for command's `response` shape.
45
+ * @see {@link ForecastClientResolvedConfig | config} for ForecastClient's `config` shape.
46
+ *
47
+ */
48
+ export declare class DescribeWhatIfAnalysisCommand extends $Command<DescribeWhatIfAnalysisCommandInput, DescribeWhatIfAnalysisCommandOutput, ForecastClientResolvedConfig> {
49
+ readonly input: DescribeWhatIfAnalysisCommandInput;
50
+ constructor(input: DescribeWhatIfAnalysisCommandInput);
51
+ /**
52
+ * @internal
53
+ */
54
+ resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: ForecastClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DescribeWhatIfAnalysisCommandInput, DescribeWhatIfAnalysisCommandOutput>;
55
+ private serialize;
56
+ private deserialize;
57
+ }