@aws-sdk/client-forecast 3.295.0 → 3.297.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 (83) hide show
  1. package/dist-types/Forecast.d.ts +64 -0
  2. package/dist-types/ForecastClient.d.ts +24 -4
  3. package/dist-types/commands/CreateAutoPredictorCommand.d.ts +16 -0
  4. package/dist-types/commands/CreateDatasetCommand.d.ts +16 -0
  5. package/dist-types/commands/CreateDatasetGroupCommand.d.ts +16 -0
  6. package/dist-types/commands/CreateDatasetImportJobCommand.d.ts +16 -0
  7. package/dist-types/commands/CreateExplainabilityCommand.d.ts +16 -0
  8. package/dist-types/commands/CreateExplainabilityExportCommand.d.ts +16 -0
  9. package/dist-types/commands/CreateForecastCommand.d.ts +16 -0
  10. package/dist-types/commands/CreateForecastExportJobCommand.d.ts +16 -0
  11. package/dist-types/commands/CreateMonitorCommand.d.ts +16 -0
  12. package/dist-types/commands/CreatePredictorBacktestExportJobCommand.d.ts +16 -0
  13. package/dist-types/commands/CreatePredictorCommand.d.ts +16 -0
  14. package/dist-types/commands/CreateWhatIfAnalysisCommand.d.ts +16 -0
  15. package/dist-types/commands/CreateWhatIfForecastCommand.d.ts +16 -0
  16. package/dist-types/commands/CreateWhatIfForecastExportCommand.d.ts +16 -0
  17. package/dist-types/commands/DeleteDatasetCommand.d.ts +16 -0
  18. package/dist-types/commands/DeleteDatasetGroupCommand.d.ts +16 -0
  19. package/dist-types/commands/DeleteDatasetImportJobCommand.d.ts +16 -0
  20. package/dist-types/commands/DeleteExplainabilityCommand.d.ts +16 -0
  21. package/dist-types/commands/DeleteExplainabilityExportCommand.d.ts +16 -0
  22. package/dist-types/commands/DeleteForecastCommand.d.ts +16 -0
  23. package/dist-types/commands/DeleteForecastExportJobCommand.d.ts +16 -0
  24. package/dist-types/commands/DeleteMonitorCommand.d.ts +16 -0
  25. package/dist-types/commands/DeletePredictorBacktestExportJobCommand.d.ts +16 -0
  26. package/dist-types/commands/DeletePredictorCommand.d.ts +16 -0
  27. package/dist-types/commands/DeleteResourceTreeCommand.d.ts +16 -0
  28. package/dist-types/commands/DeleteWhatIfAnalysisCommand.d.ts +16 -0
  29. package/dist-types/commands/DeleteWhatIfForecastCommand.d.ts +16 -0
  30. package/dist-types/commands/DeleteWhatIfForecastExportCommand.d.ts +16 -0
  31. package/dist-types/commands/DescribeAutoPredictorCommand.d.ts +16 -0
  32. package/dist-types/commands/DescribeDatasetCommand.d.ts +16 -0
  33. package/dist-types/commands/DescribeDatasetGroupCommand.d.ts +16 -0
  34. package/dist-types/commands/DescribeDatasetImportJobCommand.d.ts +16 -0
  35. package/dist-types/commands/DescribeExplainabilityCommand.d.ts +16 -0
  36. package/dist-types/commands/DescribeExplainabilityExportCommand.d.ts +16 -0
  37. package/dist-types/commands/DescribeForecastCommand.d.ts +16 -0
  38. package/dist-types/commands/DescribeForecastExportJobCommand.d.ts +16 -0
  39. package/dist-types/commands/DescribeMonitorCommand.d.ts +16 -0
  40. package/dist-types/commands/DescribePredictorBacktestExportJobCommand.d.ts +16 -0
  41. package/dist-types/commands/DescribePredictorCommand.d.ts +16 -0
  42. package/dist-types/commands/DescribeWhatIfAnalysisCommand.d.ts +16 -0
  43. package/dist-types/commands/DescribeWhatIfForecastCommand.d.ts +16 -0
  44. package/dist-types/commands/DescribeWhatIfForecastExportCommand.d.ts +16 -0
  45. package/dist-types/commands/GetAccuracyMetricsCommand.d.ts +16 -0
  46. package/dist-types/commands/ListDatasetGroupsCommand.d.ts +16 -0
  47. package/dist-types/commands/ListDatasetImportJobsCommand.d.ts +16 -0
  48. package/dist-types/commands/ListDatasetsCommand.d.ts +16 -0
  49. package/dist-types/commands/ListExplainabilitiesCommand.d.ts +16 -0
  50. package/dist-types/commands/ListExplainabilityExportsCommand.d.ts +16 -0
  51. package/dist-types/commands/ListForecastExportJobsCommand.d.ts +16 -0
  52. package/dist-types/commands/ListForecastsCommand.d.ts +16 -0
  53. package/dist-types/commands/ListMonitorEvaluationsCommand.d.ts +16 -0
  54. package/dist-types/commands/ListMonitorsCommand.d.ts +16 -0
  55. package/dist-types/commands/ListPredictorBacktestExportJobsCommand.d.ts +16 -0
  56. package/dist-types/commands/ListPredictorsCommand.d.ts +16 -0
  57. package/dist-types/commands/ListTagsForResourceCommand.d.ts +16 -0
  58. package/dist-types/commands/ListWhatIfAnalysesCommand.d.ts +16 -0
  59. package/dist-types/commands/ListWhatIfForecastExportsCommand.d.ts +16 -0
  60. package/dist-types/commands/ListWhatIfForecastsCommand.d.ts +16 -0
  61. package/dist-types/commands/ResumeResourceCommand.d.ts +16 -0
  62. package/dist-types/commands/StopResourceCommand.d.ts +16 -0
  63. package/dist-types/commands/TagResourceCommand.d.ts +16 -0
  64. package/dist-types/commands/UntagResourceCommand.d.ts +16 -0
  65. package/dist-types/commands/UpdateDatasetGroupCommand.d.ts +16 -0
  66. package/dist-types/models/ForecastServiceException.d.ts +2 -0
  67. package/dist-types/models/models_0.d.ts +477 -27
  68. package/dist-types/pagination/Interfaces.d.ts +3 -0
  69. package/dist-types/pagination/ListDatasetGroupsPaginator.d.ts +3 -0
  70. package/dist-types/pagination/ListDatasetImportJobsPaginator.d.ts +3 -0
  71. package/dist-types/pagination/ListDatasetsPaginator.d.ts +3 -0
  72. package/dist-types/pagination/ListExplainabilitiesPaginator.d.ts +3 -0
  73. package/dist-types/pagination/ListExplainabilityExportsPaginator.d.ts +3 -0
  74. package/dist-types/pagination/ListForecastExportJobsPaginator.d.ts +3 -0
  75. package/dist-types/pagination/ListForecastsPaginator.d.ts +3 -0
  76. package/dist-types/pagination/ListMonitorEvaluationsPaginator.d.ts +3 -0
  77. package/dist-types/pagination/ListMonitorsPaginator.d.ts +3 -0
  78. package/dist-types/pagination/ListPredictorBacktestExportJobsPaginator.d.ts +3 -0
  79. package/dist-types/pagination/ListPredictorsPaginator.d.ts +3 -0
  80. package/dist-types/pagination/ListWhatIfAnalysesPaginator.d.ts +3 -0
  81. package/dist-types/pagination/ListWhatIfForecastExportsPaginator.d.ts +3 -0
  82. package/dist-types/pagination/ListWhatIfForecastsPaginator.d.ts +3 -0
  83. package/package.json +29 -29
@@ -64,10 +64,12 @@ import { UntagResourceCommandInput, UntagResourceCommandOutput } from "./command
64
64
  import { UpdateDatasetGroupCommandInput, UpdateDatasetGroupCommandOutput } from "./commands/UpdateDatasetGroupCommand";
65
65
  import { ForecastClient } from "./ForecastClient";
66
66
  /**
67
+ * @public
67
68
  * <p>Provides APIs for creating and managing Amazon Forecast resources.</p>
68
69
  */
69
70
  export declare class Forecast extends ForecastClient {
70
71
  /**
72
+ * @public
71
73
  * <p>Creates an Amazon Forecast predictor.</p>
72
74
  * <p>Amazon Forecast creates predictors with AutoPredictor, which involves applying the
73
75
  * optimal combination of algorithms to each time series in your datasets. You can use
@@ -122,6 +124,7 @@ export declare class Forecast extends ForecastClient {
122
124
  createAutoPredictor(args: CreateAutoPredictorCommandInput, cb: (err: any, data?: CreateAutoPredictorCommandOutput) => void): void;
123
125
  createAutoPredictor(args: CreateAutoPredictorCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateAutoPredictorCommandOutput) => void): void;
124
126
  /**
127
+ * @public
125
128
  * <p>Creates an Amazon Forecast dataset. The information about the dataset that you provide helps
126
129
  * Forecast understand how to consume the data for model training. This includes the
127
130
  * following:</p>
@@ -169,6 +172,7 @@ export declare class Forecast extends ForecastClient {
169
172
  createDataset(args: CreateDatasetCommandInput, cb: (err: any, data?: CreateDatasetCommandOutput) => void): void;
170
173
  createDataset(args: CreateDatasetCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateDatasetCommandOutput) => void): void;
171
174
  /**
175
+ * @public
172
176
  * <p>Creates a dataset group, which holds a collection of related datasets. You can add
173
177
  * datasets to the dataset group when you create the dataset group, or later by using the <a href="https://docs.aws.amazon.com/forecast/latest/dg/API_UpdateDatasetGroup.html">UpdateDatasetGroup</a> operation.</p>
174
178
  * <p>After creating a dataset group and adding datasets, you use the dataset group when you
@@ -184,6 +188,7 @@ export declare class Forecast extends ForecastClient {
184
188
  createDatasetGroup(args: CreateDatasetGroupCommandInput, cb: (err: any, data?: CreateDatasetGroupCommandOutput) => void): void;
185
189
  createDatasetGroup(args: CreateDatasetGroupCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateDatasetGroupCommandOutput) => void): void;
186
190
  /**
191
+ * @public
187
192
  * <p>Imports your training data to an Amazon Forecast dataset. You provide the location of your
188
193
  * training data in an Amazon Simple Storage Service (Amazon S3) bucket and the Amazon Resource Name (ARN) of the dataset
189
194
  * that you want to import the data to.</p>
@@ -206,6 +211,7 @@ export declare class Forecast extends ForecastClient {
206
211
  createDatasetImportJob(args: CreateDatasetImportJobCommandInput, cb: (err: any, data?: CreateDatasetImportJobCommandOutput) => void): void;
207
212
  createDatasetImportJob(args: CreateDatasetImportJobCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateDatasetImportJobCommandOutput) => void): void;
208
213
  /**
214
+ * @public
209
215
  * <note>
210
216
  * <p>Explainability is only available for Forecasts and Predictors generated from an
211
217
  * AutoPredictor (<a>CreateAutoPredictor</a>)</p>
@@ -330,6 +336,7 @@ export declare class Forecast extends ForecastClient {
330
336
  createExplainability(args: CreateExplainabilityCommandInput, cb: (err: any, data?: CreateExplainabilityCommandOutput) => void): void;
331
337
  createExplainability(args: CreateExplainabilityCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateExplainabilityCommandOutput) => void): void;
332
338
  /**
339
+ * @public
333
340
  * <p>Exports an Explainability resource created by the <a>CreateExplainability</a> operation. Exported files are exported to an Amazon Simple Storage Service (Amazon
334
341
  * S3) bucket.</p>
335
342
  * <p>You must specify a <a>DataDestination</a> object that includes an Amazon S3
@@ -344,6 +351,7 @@ export declare class Forecast extends ForecastClient {
344
351
  createExplainabilityExport(args: CreateExplainabilityExportCommandInput, cb: (err: any, data?: CreateExplainabilityExportCommandOutput) => void): void;
345
352
  createExplainabilityExport(args: CreateExplainabilityExportCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateExplainabilityExportCommandOutput) => void): void;
346
353
  /**
354
+ * @public
347
355
  * <p>Creates a forecast for each item in the <code>TARGET_TIME_SERIES</code> dataset that was
348
356
  * used to train the predictor. This is known as inference. To retrieve the forecast for a single
349
357
  * item at low latency, use the operation. To
@@ -370,6 +378,7 @@ export declare class Forecast extends ForecastClient {
370
378
  createForecast(args: CreateForecastCommandInput, cb: (err: any, data?: CreateForecastCommandOutput) => void): void;
371
379
  createForecast(args: CreateForecastCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateForecastCommandOutput) => void): void;
372
380
  /**
381
+ * @public
373
382
  * <p>Exports a forecast created by the <a>CreateForecast</a> operation to your
374
383
  * Amazon Simple Storage Service (Amazon S3) bucket. The forecast file name will match the following conventions:</p>
375
384
  * <p><ForecastExportJobName>_<ExportTimestamp>_<PartNumber></p>
@@ -389,6 +398,7 @@ export declare class Forecast extends ForecastClient {
389
398
  createForecastExportJob(args: CreateForecastExportJobCommandInput, cb: (err: any, data?: CreateForecastExportJobCommandOutput) => void): void;
390
399
  createForecastExportJob(args: CreateForecastExportJobCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateForecastExportJobCommandOutput) => void): void;
391
400
  /**
401
+ * @public
392
402
  * <p>Creates a predictor monitor resource for an existing auto predictor. Predictor monitoring allows you to see how your predictor's performance changes over time.
393
403
  * For more information, see <a href="https://docs.aws.amazon.com/forecast/latest/dg/predictor-monitoring.html">Predictor Monitoring</a>.
394
404
  * </p>
@@ -397,6 +407,7 @@ export declare class Forecast extends ForecastClient {
397
407
  createMonitor(args: CreateMonitorCommandInput, cb: (err: any, data?: CreateMonitorCommandOutput) => void): void;
398
408
  createMonitor(args: CreateMonitorCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateMonitorCommandOutput) => void): void;
399
409
  /**
410
+ * @public
400
411
  * <note>
401
412
  * <p> This operation creates a legacy predictor that does not include all the predictor
402
413
  * functionalities provided by Amazon Forecast. To create a predictor that is compatible with all
@@ -462,6 +473,7 @@ export declare class Forecast extends ForecastClient {
462
473
  createPredictor(args: CreatePredictorCommandInput, cb: (err: any, data?: CreatePredictorCommandOutput) => void): void;
463
474
  createPredictor(args: CreatePredictorCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreatePredictorCommandOutput) => void): void;
464
475
  /**
476
+ * @public
465
477
  * <p>Exports backtest forecasts and accuracy metrics generated by the <a>CreateAutoPredictor</a> or <a>CreatePredictor</a> operations. Two
466
478
  * folders containing CSV or Parquet files are exported to your specified S3 bucket.</p>
467
479
  * <p> The export file names will match the following conventions:</p>
@@ -482,6 +494,7 @@ export declare class Forecast extends ForecastClient {
482
494
  createPredictorBacktestExportJob(args: CreatePredictorBacktestExportJobCommandInput, cb: (err: any, data?: CreatePredictorBacktestExportJobCommandOutput) => void): void;
483
495
  createPredictorBacktestExportJob(args: CreatePredictorBacktestExportJobCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreatePredictorBacktestExportJobCommandOutput) => void): void;
484
496
  /**
497
+ * @public
485
498
  * <p>What-if analysis is a scenario modeling technique where you make a hypothetical change to a time series and
486
499
  * compare the forecasts generated by these changes against the baseline, unchanged time series. It is important to
487
500
  * remember that the purpose of a what-if analysis is to understand how a forecast can change given different
@@ -500,6 +513,7 @@ export declare class Forecast extends ForecastClient {
500
513
  createWhatIfAnalysis(args: CreateWhatIfAnalysisCommandInput, cb: (err: any, data?: CreateWhatIfAnalysisCommandOutput) => void): void;
501
514
  createWhatIfAnalysis(args: CreateWhatIfAnalysisCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateWhatIfAnalysisCommandOutput) => void): void;
502
515
  /**
516
+ * @public
503
517
  * <p>A what-if forecast is a forecast that is created from a modified version of the baseline forecast. Each
504
518
  * what-if forecast incorporates either a replacement dataset or a set of transformations to the original dataset. </p>
505
519
  */
@@ -507,6 +521,7 @@ export declare class Forecast extends ForecastClient {
507
521
  createWhatIfForecast(args: CreateWhatIfForecastCommandInput, cb: (err: any, data?: CreateWhatIfForecastCommandOutput) => void): void;
508
522
  createWhatIfForecast(args: CreateWhatIfForecastCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateWhatIfForecastCommandOutput) => void): void;
509
523
  /**
524
+ * @public
510
525
  * <p>Exports a forecast created by the <a>CreateWhatIfForecast</a> operation to your
511
526
  * Amazon Simple Storage Service (Amazon S3) bucket. The forecast file name will match the following conventions:</p>
512
527
  * <p>
@@ -529,6 +544,7 @@ export declare class Forecast extends ForecastClient {
529
544
  createWhatIfForecastExport(args: CreateWhatIfForecastExportCommandInput, cb: (err: any, data?: CreateWhatIfForecastExportCommandOutput) => void): void;
530
545
  createWhatIfForecastExport(args: CreateWhatIfForecastExportCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateWhatIfForecastExportCommandOutput) => void): void;
531
546
  /**
547
+ * @public
532
548
  * <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
533
549
  * only delete datasets that have a status of <code>ACTIVE</code> or <code>CREATE_FAILED</code>.
534
550
  * To get the status use the <a href="https://docs.aws.amazon.com/forecast/latest/dg/API_DescribeDataset.html">DescribeDataset</a> operation.</p>
@@ -542,6 +558,7 @@ export declare class Forecast extends ForecastClient {
542
558
  deleteDataset(args: DeleteDatasetCommandInput, cb: (err: any, data?: DeleteDatasetCommandOutput) => void): void;
543
559
  deleteDataset(args: DeleteDatasetCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteDatasetCommandOutput) => void): void;
544
560
  /**
561
+ * @public
545
562
  * <p>Deletes a dataset group created using the <a href="https://docs.aws.amazon.com/forecast/latest/dg/API_CreateDatasetGroup.html">CreateDatasetGroup</a> operation.
546
563
  * You can only delete dataset groups that have a status of <code>ACTIVE</code>,
547
564
  * <code>CREATE_FAILED</code>, or <code>UPDATE_FAILED</code>. To get the status, use the <a href="https://docs.aws.amazon.com/forecast/latest/dg/API_DescribeDatasetGroup.html">DescribeDatasetGroup</a> operation.</p>
@@ -551,6 +568,7 @@ export declare class Forecast extends ForecastClient {
551
568
  deleteDatasetGroup(args: DeleteDatasetGroupCommandInput, cb: (err: any, data?: DeleteDatasetGroupCommandOutput) => void): void;
552
569
  deleteDatasetGroup(args: DeleteDatasetGroupCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteDatasetGroupCommandOutput) => void): void;
553
570
  /**
571
+ * @public
554
572
  * <p>Deletes a dataset import job created using the <a href="https://docs.aws.amazon.com/forecast/latest/dg/API_CreateDatasetImportJob.html">CreateDatasetImportJob</a>
555
573
  * operation. You can delete only dataset import jobs that have a status of <code>ACTIVE</code>
556
574
  * or <code>CREATE_FAILED</code>. To get the status, use the <a href="https://docs.aws.amazon.com/forecast/latest/dg/API_DescribeDatasetImportJob.html">DescribeDatasetImportJob</a>
@@ -560,6 +578,7 @@ export declare class Forecast extends ForecastClient {
560
578
  deleteDatasetImportJob(args: DeleteDatasetImportJobCommandInput, cb: (err: any, data?: DeleteDatasetImportJobCommandOutput) => void): void;
561
579
  deleteDatasetImportJob(args: DeleteDatasetImportJobCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteDatasetImportJobCommandOutput) => void): void;
562
580
  /**
581
+ * @public
563
582
  * <p>Deletes an Explainability resource.</p>
564
583
  * <p>You can delete only predictor that have a status of <code>ACTIVE</code> or
565
584
  * <code>CREATE_FAILED</code>. To get the status, use the <a>DescribeExplainability</a> operation.</p>
@@ -568,12 +587,14 @@ export declare class Forecast extends ForecastClient {
568
587
  deleteExplainability(args: DeleteExplainabilityCommandInput, cb: (err: any, data?: DeleteExplainabilityCommandOutput) => void): void;
569
588
  deleteExplainability(args: DeleteExplainabilityCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteExplainabilityCommandOutput) => void): void;
570
589
  /**
590
+ * @public
571
591
  * <p>Deletes an Explainability export.</p>
572
592
  */
573
593
  deleteExplainabilityExport(args: DeleteExplainabilityExportCommandInput, options?: __HttpHandlerOptions): Promise<DeleteExplainabilityExportCommandOutput>;
574
594
  deleteExplainabilityExport(args: DeleteExplainabilityExportCommandInput, cb: (err: any, data?: DeleteExplainabilityExportCommandOutput) => void): void;
575
595
  deleteExplainabilityExport(args: DeleteExplainabilityExportCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteExplainabilityExportCommandOutput) => void): void;
576
596
  /**
597
+ * @public
577
598
  * <p>Deletes a forecast created using the <a>CreateForecast</a> operation. You can
578
599
  * delete only forecasts that have a status of <code>ACTIVE</code> or <code>CREATE_FAILED</code>.
579
600
  * To get the status, use the <a>DescribeForecast</a> operation.</p>
@@ -584,6 +605,7 @@ export declare class Forecast extends ForecastClient {
584
605
  deleteForecast(args: DeleteForecastCommandInput, cb: (err: any, data?: DeleteForecastCommandOutput) => void): void;
585
606
  deleteForecast(args: DeleteForecastCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteForecastCommandOutput) => void): void;
586
607
  /**
608
+ * @public
587
609
  * <p>Deletes a forecast export job created using the <a>CreateForecastExportJob</a>
588
610
  * operation. You can delete only export jobs that have a status of <code>ACTIVE</code> or
589
611
  * <code>CREATE_FAILED</code>. To get the status, use the <a>DescribeForecastExportJob</a> operation.</p>
@@ -592,12 +614,14 @@ export declare class Forecast extends ForecastClient {
592
614
  deleteForecastExportJob(args: DeleteForecastExportJobCommandInput, cb: (err: any, data?: DeleteForecastExportJobCommandOutput) => void): void;
593
615
  deleteForecastExportJob(args: DeleteForecastExportJobCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteForecastExportJobCommandOutput) => void): void;
594
616
  /**
617
+ * @public
595
618
  * <p>Deletes a monitor resource. You can only delete a monitor resource with a status of <code>ACTIVE</code>, <code>ACTIVE_STOPPED</code>, <code>CREATE_FAILED</code>, or <code>CREATE_STOPPED</code>.</p>
596
619
  */
597
620
  deleteMonitor(args: DeleteMonitorCommandInput, options?: __HttpHandlerOptions): Promise<DeleteMonitorCommandOutput>;
598
621
  deleteMonitor(args: DeleteMonitorCommandInput, cb: (err: any, data?: DeleteMonitorCommandOutput) => void): void;
599
622
  deleteMonitor(args: DeleteMonitorCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteMonitorCommandOutput) => void): void;
600
623
  /**
624
+ * @public
601
625
  * <p>Deletes a predictor created using the <a>DescribePredictor</a> or <a>CreatePredictor</a> operations. You can delete only predictor that have a status of
602
626
  * <code>ACTIVE</code> or <code>CREATE_FAILED</code>. To get the status, use the <a>DescribePredictor</a> operation.</p>
603
627
  */
@@ -605,12 +629,14 @@ export declare class Forecast extends ForecastClient {
605
629
  deletePredictor(args: DeletePredictorCommandInput, cb: (err: any, data?: DeletePredictorCommandOutput) => void): void;
606
630
  deletePredictor(args: DeletePredictorCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeletePredictorCommandOutput) => void): void;
607
631
  /**
632
+ * @public
608
633
  * <p>Deletes a predictor backtest export job.</p>
609
634
  */
610
635
  deletePredictorBacktestExportJob(args: DeletePredictorBacktestExportJobCommandInput, options?: __HttpHandlerOptions): Promise<DeletePredictorBacktestExportJobCommandOutput>;
611
636
  deletePredictorBacktestExportJob(args: DeletePredictorBacktestExportJobCommandInput, cb: (err: any, data?: DeletePredictorBacktestExportJobCommandOutput) => void): void;
612
637
  deletePredictorBacktestExportJob(args: DeletePredictorBacktestExportJobCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeletePredictorBacktestExportJobCommandOutput) => void): void;
613
638
  /**
639
+ * @public
614
640
  * <p>Deletes an entire resource tree. This operation will delete the parent resource and
615
641
  * its child resources.</p>
616
642
  * <p>Child resources are resources that were created from another resource. For example,
@@ -647,6 +673,7 @@ export declare class Forecast extends ForecastClient {
647
673
  deleteResourceTree(args: DeleteResourceTreeCommandInput, cb: (err: any, data?: DeleteResourceTreeCommandOutput) => void): void;
648
674
  deleteResourceTree(args: DeleteResourceTreeCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteResourceTreeCommandOutput) => void): void;
649
675
  /**
676
+ * @public
650
677
  * <p>Deletes a what-if analysis created using the <a>CreateWhatIfAnalysis</a>
651
678
  * 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>
652
679
  * <p>You can't delete a what-if analysis while any of its forecasts are being exported.</p>
@@ -655,6 +682,7 @@ export declare class Forecast extends ForecastClient {
655
682
  deleteWhatIfAnalysis(args: DeleteWhatIfAnalysisCommandInput, cb: (err: any, data?: DeleteWhatIfAnalysisCommandOutput) => void): void;
656
683
  deleteWhatIfAnalysis(args: DeleteWhatIfAnalysisCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteWhatIfAnalysisCommandOutput) => void): void;
657
684
  /**
685
+ * @public
658
686
  * <p>Deletes a what-if forecast created using the <a>CreateWhatIfForecast</a>
659
687
  * 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>
660
688
  * <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>
@@ -663,6 +691,7 @@ export declare class Forecast extends ForecastClient {
663
691
  deleteWhatIfForecast(args: DeleteWhatIfForecastCommandInput, cb: (err: any, data?: DeleteWhatIfForecastCommandOutput) => void): void;
664
692
  deleteWhatIfForecast(args: DeleteWhatIfForecastCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteWhatIfForecastCommandOutput) => void): void;
665
693
  /**
694
+ * @public
666
695
  * <p>Deletes a what-if forecast export created using the <a>CreateWhatIfForecastExport</a>
667
696
  * 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>
668
697
  */
@@ -670,12 +699,14 @@ export declare class Forecast extends ForecastClient {
670
699
  deleteWhatIfForecastExport(args: DeleteWhatIfForecastExportCommandInput, cb: (err: any, data?: DeleteWhatIfForecastExportCommandOutput) => void): void;
671
700
  deleteWhatIfForecastExport(args: DeleteWhatIfForecastExportCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteWhatIfForecastExportCommandOutput) => void): void;
672
701
  /**
702
+ * @public
673
703
  * <p>Describes a predictor created using the CreateAutoPredictor operation.</p>
674
704
  */
675
705
  describeAutoPredictor(args: DescribeAutoPredictorCommandInput, options?: __HttpHandlerOptions): Promise<DescribeAutoPredictorCommandOutput>;
676
706
  describeAutoPredictor(args: DescribeAutoPredictorCommandInput, cb: (err: any, data?: DescribeAutoPredictorCommandOutput) => void): void;
677
707
  describeAutoPredictor(args: DescribeAutoPredictorCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeAutoPredictorCommandOutput) => void): void;
678
708
  /**
709
+ * @public
679
710
  * <p>Describes an Amazon Forecast dataset created using the <a href="https://docs.aws.amazon.com/forecast/latest/dg/API_CreateDataset.html">CreateDataset</a> operation.</p>
680
711
  * <p>In addition to listing the parameters specified in the <code>CreateDataset</code> request,
681
712
  * this operation includes the following dataset properties:</p>
@@ -701,6 +732,7 @@ export declare class Forecast extends ForecastClient {
701
732
  describeDataset(args: DescribeDatasetCommandInput, cb: (err: any, data?: DescribeDatasetCommandOutput) => void): void;
702
733
  describeDataset(args: DescribeDatasetCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeDatasetCommandOutput) => void): void;
703
734
  /**
735
+ * @public
704
736
  * <p>Describes a dataset group created using the <a href="https://docs.aws.amazon.com/forecast/latest/dg/API_CreateDatasetGroup.html">CreateDatasetGroup</a>
705
737
  * operation.</p>
706
738
  * <p>In addition to listing the parameters provided in the <code>CreateDatasetGroup</code>
@@ -731,6 +763,7 @@ export declare class Forecast extends ForecastClient {
731
763
  describeDatasetGroup(args: DescribeDatasetGroupCommandInput, cb: (err: any, data?: DescribeDatasetGroupCommandOutput) => void): void;
732
764
  describeDatasetGroup(args: DescribeDatasetGroupCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeDatasetGroupCommandOutput) => void): void;
733
765
  /**
766
+ * @public
734
767
  * <p>Describes a dataset import job created using the <a href="https://docs.aws.amazon.com/forecast/latest/dg/API_CreateDatasetImportJob.html">CreateDatasetImportJob</a>
735
768
  * operation.</p>
736
769
  * <p>In addition to listing the parameters provided in the <code>CreateDatasetImportJob</code>
@@ -771,18 +804,21 @@ export declare class Forecast extends ForecastClient {
771
804
  describeDatasetImportJob(args: DescribeDatasetImportJobCommandInput, cb: (err: any, data?: DescribeDatasetImportJobCommandOutput) => void): void;
772
805
  describeDatasetImportJob(args: DescribeDatasetImportJobCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeDatasetImportJobCommandOutput) => void): void;
773
806
  /**
807
+ * @public
774
808
  * <p>Describes an Explainability resource created using the <a>CreateExplainability</a> operation.</p>
775
809
  */
776
810
  describeExplainability(args: DescribeExplainabilityCommandInput, options?: __HttpHandlerOptions): Promise<DescribeExplainabilityCommandOutput>;
777
811
  describeExplainability(args: DescribeExplainabilityCommandInput, cb: (err: any, data?: DescribeExplainabilityCommandOutput) => void): void;
778
812
  describeExplainability(args: DescribeExplainabilityCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeExplainabilityCommandOutput) => void): void;
779
813
  /**
814
+ * @public
780
815
  * <p>Describes an Explainability export created using the <a>CreateExplainabilityExport</a> operation.</p>
781
816
  */
782
817
  describeExplainabilityExport(args: DescribeExplainabilityExportCommandInput, options?: __HttpHandlerOptions): Promise<DescribeExplainabilityExportCommandOutput>;
783
818
  describeExplainabilityExport(args: DescribeExplainabilityExportCommandInput, cb: (err: any, data?: DescribeExplainabilityExportCommandOutput) => void): void;
784
819
  describeExplainabilityExport(args: DescribeExplainabilityExportCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeExplainabilityExportCommandOutput) => void): void;
785
820
  /**
821
+ * @public
786
822
  * <p>Describes a forecast created using the <a>CreateForecast</a> operation.</p>
787
823
  * <p>In addition to listing the properties provided in the <code>CreateForecast</code> request,
788
824
  * this operation lists the following properties:</p>
@@ -817,6 +853,7 @@ export declare class Forecast extends ForecastClient {
817
853
  describeForecast(args: DescribeForecastCommandInput, cb: (err: any, data?: DescribeForecastCommandOutput) => void): void;
818
854
  describeForecast(args: DescribeForecastCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeForecastCommandOutput) => void): void;
819
855
  /**
856
+ * @public
820
857
  * <p>Describes a forecast export job created using the <a>CreateForecastExportJob</a> operation.</p>
821
858
  * <p>In addition to listing the properties provided by the user in the
822
859
  * <code>CreateForecastExportJob</code> request, this operation lists the following
@@ -847,6 +884,7 @@ export declare class Forecast extends ForecastClient {
847
884
  describeForecastExportJob(args: DescribeForecastExportJobCommandInput, cb: (err: any, data?: DescribeForecastExportJobCommandOutput) => void): void;
848
885
  describeForecastExportJob(args: DescribeForecastExportJobCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeForecastExportJobCommandOutput) => void): void;
849
886
  /**
887
+ * @public
850
888
  * <p>Describes a monitor resource. In addition to listing the properties provided in the <a>CreateMonitor</a> request, this operation lists the following properties:</p>
851
889
  * <ul>
852
890
  * <li>
@@ -890,6 +928,7 @@ export declare class Forecast extends ForecastClient {
890
928
  describeMonitor(args: DescribeMonitorCommandInput, cb: (err: any, data?: DescribeMonitorCommandOutput) => void): void;
891
929
  describeMonitor(args: DescribeMonitorCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeMonitorCommandOutput) => void): void;
892
930
  /**
931
+ * @public
893
932
  * <note>
894
933
  * <p> This operation is only valid for legacy predictors created with CreatePredictor. If you
895
934
  * are not using a legacy predictor, use <a>DescribeAutoPredictor</a>.</p>
@@ -934,6 +973,7 @@ export declare class Forecast extends ForecastClient {
934
973
  describePredictor(args: DescribePredictorCommandInput, cb: (err: any, data?: DescribePredictorCommandOutput) => void): void;
935
974
  describePredictor(args: DescribePredictorCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribePredictorCommandOutput) => void): void;
936
975
  /**
976
+ * @public
937
977
  * <p>Describes a predictor backtest export job created using the <a>CreatePredictorBacktestExportJob</a> operation.</p>
938
978
  * <p>In addition to listing the properties provided by the user in the
939
979
  * <code>CreatePredictorBacktestExportJob</code> request, this operation lists the
@@ -964,6 +1004,7 @@ export declare class Forecast extends ForecastClient {
964
1004
  describePredictorBacktestExportJob(args: DescribePredictorBacktestExportJobCommandInput, cb: (err: any, data?: DescribePredictorBacktestExportJobCommandOutput) => void): void;
965
1005
  describePredictorBacktestExportJob(args: DescribePredictorBacktestExportJobCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribePredictorBacktestExportJobCommandOutput) => void): void;
966
1006
  /**
1007
+ * @public
967
1008
  * <p>Describes the what-if analysis created using the <a>CreateWhatIfAnalysis</a> operation.</p>
968
1009
  * <p>In addition to listing the properties provided in the <code>CreateWhatIfAnalysis</code> request, this operation lists the following properties:</p>
969
1010
  * <ul>
@@ -992,6 +1033,7 @@ export declare class Forecast extends ForecastClient {
992
1033
  describeWhatIfAnalysis(args: DescribeWhatIfAnalysisCommandInput, cb: (err: any, data?: DescribeWhatIfAnalysisCommandOutput) => void): void;
993
1034
  describeWhatIfAnalysis(args: DescribeWhatIfAnalysisCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeWhatIfAnalysisCommandOutput) => void): void;
994
1035
  /**
1036
+ * @public
995
1037
  * <p>Describes the what-if forecast created using the <a>CreateWhatIfForecast</a> operation.</p>
996
1038
  * <p>In addition to listing the properties provided in the <code>CreateWhatIfForecast</code> request, this operation lists the following properties:</p>
997
1039
  * <ul>
@@ -1020,6 +1062,7 @@ export declare class Forecast extends ForecastClient {
1020
1062
  describeWhatIfForecast(args: DescribeWhatIfForecastCommandInput, cb: (err: any, data?: DescribeWhatIfForecastCommandOutput) => void): void;
1021
1063
  describeWhatIfForecast(args: DescribeWhatIfForecastCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeWhatIfForecastCommandOutput) => void): void;
1022
1064
  /**
1065
+ * @public
1023
1066
  * <p>Describes the what-if forecast export created using the <a>CreateWhatIfForecastExport</a> operation.</p>
1024
1067
  * <p>In addition to listing the properties provided in the <code>CreateWhatIfForecastExport</code> request, this operation lists the following properties:</p>
1025
1068
  * <ul>
@@ -1048,6 +1091,7 @@ export declare class Forecast extends ForecastClient {
1048
1091
  describeWhatIfForecastExport(args: DescribeWhatIfForecastExportCommandInput, cb: (err: any, data?: DescribeWhatIfForecastExportCommandOutput) => void): void;
1049
1092
  describeWhatIfForecastExport(args: DescribeWhatIfForecastExportCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeWhatIfForecastExportCommandOutput) => void): void;
1050
1093
  /**
1094
+ * @public
1051
1095
  * <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
1052
1096
  * to decide whether to use the predictor to generate a forecast. For more information, see
1053
1097
  * <a href="https://docs.aws.amazon.com/forecast/latest/dg/metrics.html">Predictor
@@ -1070,6 +1114,7 @@ export declare class Forecast extends ForecastClient {
1070
1114
  getAccuracyMetrics(args: GetAccuracyMetricsCommandInput, cb: (err: any, data?: GetAccuracyMetricsCommandOutput) => void): void;
1071
1115
  getAccuracyMetrics(args: GetAccuracyMetricsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetAccuracyMetricsCommandOutput) => void): void;
1072
1116
  /**
1117
+ * @public
1073
1118
  * <p>Returns a list of dataset groups created using the <a href="https://docs.aws.amazon.com/forecast/latest/dg/API_CreateDatasetGroup.html">CreateDatasetGroup</a> operation.
1074
1119
  * For each dataset group, this operation returns a summary of its properties, including its
1075
1120
  * Amazon Resource Name (ARN). You can retrieve the complete set of properties by using the
@@ -1080,6 +1125,7 @@ export declare class Forecast extends ForecastClient {
1080
1125
  listDatasetGroups(args: ListDatasetGroupsCommandInput, cb: (err: any, data?: ListDatasetGroupsCommandOutput) => void): void;
1081
1126
  listDatasetGroups(args: ListDatasetGroupsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListDatasetGroupsCommandOutput) => void): void;
1082
1127
  /**
1128
+ * @public
1083
1129
  * <p>Returns a list of dataset import jobs created using the <a href="https://docs.aws.amazon.com/forecast/latest/dg/API_CreateDatasetImportJob.html">CreateDatasetImportJob</a>
1084
1130
  * operation. For each import job, this operation returns a summary of its properties, including
1085
1131
  * its Amazon Resource Name (ARN). You can retrieve the complete set of properties by using the
@@ -1090,6 +1136,7 @@ export declare class Forecast extends ForecastClient {
1090
1136
  listDatasetImportJobs(args: ListDatasetImportJobsCommandInput, cb: (err: any, data?: ListDatasetImportJobsCommandOutput) => void): void;
1091
1137
  listDatasetImportJobs(args: ListDatasetImportJobsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListDatasetImportJobsCommandOutput) => void): void;
1092
1138
  /**
1139
+ * @public
1093
1140
  * <p>Returns a list of datasets created using the <a href="https://docs.aws.amazon.com/forecast/latest/dg/API_CreateDataset.html">CreateDataset</a> operation. For each
1094
1141
  * dataset, a summary of its properties, including its Amazon Resource Name (ARN), is returned.
1095
1142
  * To retrieve the complete set of properties, use the ARN with the <a href="https://docs.aws.amazon.com/forecast/latest/dg/API_DescribeDataset.html">DescribeDataset</a> operation.</p>
@@ -1098,6 +1145,7 @@ export declare class Forecast extends ForecastClient {
1098
1145
  listDatasets(args: ListDatasetsCommandInput, cb: (err: any, data?: ListDatasetsCommandOutput) => void): void;
1099
1146
  listDatasets(args: ListDatasetsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListDatasetsCommandOutput) => void): void;
1100
1147
  /**
1148
+ * @public
1101
1149
  * <p>Returns a list of Explainability resources created using the <a>CreateExplainability</a> operation. This operation returns a summary for
1102
1150
  * each Explainability. You can filter the list using an array of <a>Filter</a>
1103
1151
  * objects.</p>
@@ -1108,6 +1156,7 @@ export declare class Forecast extends ForecastClient {
1108
1156
  listExplainabilities(args: ListExplainabilitiesCommandInput, cb: (err: any, data?: ListExplainabilitiesCommandOutput) => void): void;
1109
1157
  listExplainabilities(args: ListExplainabilitiesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListExplainabilitiesCommandOutput) => void): void;
1110
1158
  /**
1159
+ * @public
1111
1160
  * <p>Returns a list of Explainability exports created using the <a>CreateExplainabilityExport</a> operation. This operation returns a summary
1112
1161
  * for each Explainability export. You can filter the list using an array of <a>Filter</a> objects.</p>
1113
1162
  * <p>To retrieve the complete set of properties for a particular Explainability export, use
@@ -1117,6 +1166,7 @@ export declare class Forecast extends ForecastClient {
1117
1166
  listExplainabilityExports(args: ListExplainabilityExportsCommandInput, cb: (err: any, data?: ListExplainabilityExportsCommandOutput) => void): void;
1118
1167
  listExplainabilityExports(args: ListExplainabilityExportsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListExplainabilityExportsCommandOutput) => void): void;
1119
1168
  /**
1169
+ * @public
1120
1170
  * <p>Returns a list of forecast export jobs created using the <a>CreateForecastExportJob</a> operation. For each forecast export job, this operation
1121
1171
  * returns a summary of its properties, including its Amazon Resource Name (ARN). To retrieve the
1122
1172
  * complete set of properties, use the ARN with the <a>DescribeForecastExportJob</a>
@@ -1126,6 +1176,7 @@ export declare class Forecast extends ForecastClient {
1126
1176
  listForecastExportJobs(args: ListForecastExportJobsCommandInput, cb: (err: any, data?: ListForecastExportJobsCommandOutput) => void): void;
1127
1177
  listForecastExportJobs(args: ListForecastExportJobsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListForecastExportJobsCommandOutput) => void): void;
1128
1178
  /**
1179
+ * @public
1129
1180
  * <p>Returns a list of forecasts created using the <a>CreateForecast</a> operation.
1130
1181
  * For each forecast, this operation returns a summary of its properties, including its Amazon
1131
1182
  * Resource Name (ARN). To retrieve the complete set of properties, specify the ARN with the
@@ -1136,6 +1187,7 @@ export declare class Forecast extends ForecastClient {
1136
1187
  listForecasts(args: ListForecastsCommandInput, cb: (err: any, data?: ListForecastsCommandOutput) => void): void;
1137
1188
  listForecasts(args: ListForecastsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListForecastsCommandOutput) => void): void;
1138
1189
  /**
1190
+ * @public
1139
1191
  * <p>Returns a list of the monitoring evaluation results and predictor events collected by
1140
1192
  * the monitor resource during different windows of time.</p>
1141
1193
  * <p>For information about monitoring see <a>predictor-monitoring</a>. For
@@ -1145,6 +1197,7 @@ export declare class Forecast extends ForecastClient {
1145
1197
  listMonitorEvaluations(args: ListMonitorEvaluationsCommandInput, cb: (err: any, data?: ListMonitorEvaluationsCommandOutput) => void): void;
1146
1198
  listMonitorEvaluations(args: ListMonitorEvaluationsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListMonitorEvaluationsCommandOutput) => void): void;
1147
1199
  /**
1200
+ * @public
1148
1201
  * <p>Returns a list of monitors created with the <a>CreateMonitor</a> operation and <a>CreateAutoPredictor</a> operation. For each monitor resource, this operation returns of a summary of its properties, including its Amazon Resource Name (ARN). You
1149
1202
  * can retrieve a complete set of properties of a monitor resource by specify the monitor's ARN in the <a>DescribeMonitor</a> operation.</p>
1150
1203
  */
@@ -1152,6 +1205,7 @@ export declare class Forecast extends ForecastClient {
1152
1205
  listMonitors(args: ListMonitorsCommandInput, cb: (err: any, data?: ListMonitorsCommandOutput) => void): void;
1153
1206
  listMonitors(args: ListMonitorsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListMonitorsCommandOutput) => void): void;
1154
1207
  /**
1208
+ * @public
1155
1209
  * <p>Returns a list of predictor backtest export jobs created using the <a>CreatePredictorBacktestExportJob</a> operation. This operation returns a
1156
1210
  * summary for each backtest export job. You can filter the list using an array of <a>Filter</a> objects.</p>
1157
1211
  * <p>To retrieve the complete set of properties for a particular backtest export job, use
@@ -1161,6 +1215,7 @@ export declare class Forecast extends ForecastClient {
1161
1215
  listPredictorBacktestExportJobs(args: ListPredictorBacktestExportJobsCommandInput, cb: (err: any, data?: ListPredictorBacktestExportJobsCommandOutput) => void): void;
1162
1216
  listPredictorBacktestExportJobs(args: ListPredictorBacktestExportJobsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListPredictorBacktestExportJobsCommandOutput) => void): void;
1163
1217
  /**
1218
+ * @public
1164
1219
  * <p>Returns a list of predictors created using the <a>CreateAutoPredictor</a> or
1165
1220
  * <a>CreatePredictor</a> operations. For each predictor, this operation returns a
1166
1221
  * summary of its properties, including its Amazon Resource Name (ARN). </p>
@@ -1171,36 +1226,42 @@ export declare class Forecast extends ForecastClient {
1171
1226
  listPredictors(args: ListPredictorsCommandInput, cb: (err: any, data?: ListPredictorsCommandOutput) => void): void;
1172
1227
  listPredictors(args: ListPredictorsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListPredictorsCommandOutput) => void): void;
1173
1228
  /**
1229
+ * @public
1174
1230
  * <p>Lists the tags for an Amazon Forecast resource.</p>
1175
1231
  */
1176
1232
  listTagsForResource(args: ListTagsForResourceCommandInput, options?: __HttpHandlerOptions): Promise<ListTagsForResourceCommandOutput>;
1177
1233
  listTagsForResource(args: ListTagsForResourceCommandInput, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void): void;
1178
1234
  listTagsForResource(args: ListTagsForResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void): void;
1179
1235
  /**
1236
+ * @public
1180
1237
  * <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>
1181
1238
  */
1182
1239
  listWhatIfAnalyses(args: ListWhatIfAnalysesCommandInput, options?: __HttpHandlerOptions): Promise<ListWhatIfAnalysesCommandOutput>;
1183
1240
  listWhatIfAnalyses(args: ListWhatIfAnalysesCommandInput, cb: (err: any, data?: ListWhatIfAnalysesCommandOutput) => void): void;
1184
1241
  listWhatIfAnalyses(args: ListWhatIfAnalysesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListWhatIfAnalysesCommandOutput) => void): void;
1185
1242
  /**
1243
+ * @public
1186
1244
  * <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>
1187
1245
  */
1188
1246
  listWhatIfForecastExports(args: ListWhatIfForecastExportsCommandInput, options?: __HttpHandlerOptions): Promise<ListWhatIfForecastExportsCommandOutput>;
1189
1247
  listWhatIfForecastExports(args: ListWhatIfForecastExportsCommandInput, cb: (err: any, data?: ListWhatIfForecastExportsCommandOutput) => void): void;
1190
1248
  listWhatIfForecastExports(args: ListWhatIfForecastExportsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListWhatIfForecastExportsCommandOutput) => void): void;
1191
1249
  /**
1250
+ * @public
1192
1251
  * <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>
1193
1252
  */
1194
1253
  listWhatIfForecasts(args: ListWhatIfForecastsCommandInput, options?: __HttpHandlerOptions): Promise<ListWhatIfForecastsCommandOutput>;
1195
1254
  listWhatIfForecasts(args: ListWhatIfForecastsCommandInput, cb: (err: any, data?: ListWhatIfForecastsCommandOutput) => void): void;
1196
1255
  listWhatIfForecasts(args: ListWhatIfForecastsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListWhatIfForecastsCommandOutput) => void): void;
1197
1256
  /**
1257
+ * @public
1198
1258
  * <p>Resumes a stopped monitor resource.</p>
1199
1259
  */
1200
1260
  resumeResource(args: ResumeResourceCommandInput, options?: __HttpHandlerOptions): Promise<ResumeResourceCommandOutput>;
1201
1261
  resumeResource(args: ResumeResourceCommandInput, cb: (err: any, data?: ResumeResourceCommandOutput) => void): void;
1202
1262
  resumeResource(args: ResumeResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ResumeResourceCommandOutput) => void): void;
1203
1263
  /**
1264
+ * @public
1204
1265
  * <p>Stops a resource.</p>
1205
1266
  * <p>The resource undergoes the following states: <code>CREATE_STOPPING</code> and
1206
1267
  * <code>CREATE_STOPPED</code>. You cannot resume a resource once it has been
@@ -1235,6 +1296,7 @@ export declare class Forecast extends ForecastClient {
1235
1296
  stopResource(args: StopResourceCommandInput, cb: (err: any, data?: StopResourceCommandOutput) => void): void;
1236
1297
  stopResource(args: StopResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StopResourceCommandOutput) => void): void;
1237
1298
  /**
1299
+ * @public
1238
1300
  * <p>Associates the specified tags to a resource with the specified <code>resourceArn</code>.
1239
1301
  * If existing tags on a resource are not specified in the request parameters, they are not
1240
1302
  * changed. When a resource is deleted, the tags associated with that resource are also
@@ -1244,12 +1306,14 @@ export declare class Forecast extends ForecastClient {
1244
1306
  tagResource(args: TagResourceCommandInput, cb: (err: any, data?: TagResourceCommandOutput) => void): void;
1245
1307
  tagResource(args: TagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: TagResourceCommandOutput) => void): void;
1246
1308
  /**
1309
+ * @public
1247
1310
  * <p>Deletes the specified tags from a resource.</p>
1248
1311
  */
1249
1312
  untagResource(args: UntagResourceCommandInput, options?: __HttpHandlerOptions): Promise<UntagResourceCommandOutput>;
1250
1313
  untagResource(args: UntagResourceCommandInput, cb: (err: any, data?: UntagResourceCommandOutput) => void): void;
1251
1314
  untagResource(args: UntagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UntagResourceCommandOutput) => void): void;
1252
1315
  /**
1316
+ * @public
1253
1317
  * <p>Replaces the datasets in a dataset group with the specified datasets.</p>
1254
1318
  * <note>
1255
1319
  * <p>The <code>Status</code> of the dataset group must be <code>ACTIVE</code> before you can
@@ -71,15 +71,24 @@ import { TagResourceCommandInput, TagResourceCommandOutput } from "./commands/Ta
71
71
  import { UntagResourceCommandInput, UntagResourceCommandOutput } from "./commands/UntagResourceCommand";
72
72
  import { UpdateDatasetGroupCommandInput, UpdateDatasetGroupCommandOutput } from "./commands/UpdateDatasetGroupCommand";
73
73
  import { ClientInputEndpointParameters, ClientResolvedEndpointParameters, EndpointParameters } from "./endpoint/EndpointParameters";
74
+ /**
75
+ * @public
76
+ */
74
77
  export 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;
78
+ /**
79
+ * @public
80
+ */
75
81
  export 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;
82
+ /**
83
+ * @public
84
+ */
76
85
  export interface ClientDefaults extends Partial<__SmithyResolvedConfiguration<__HttpHandlerOptions>> {
77
86
  /**
78
87
  * The HTTP handler to use. Fetch in browser and Https in Nodejs.
79
88
  */
80
89
  requestHandler?: __HttpHandler;
81
90
  /**
82
- * A constructor for a class implementing the {@link __Checksum} interface
91
+ * A constructor for a class implementing the {@link @aws-sdk/types#ChecksumConstructor} interface
83
92
  * that computes the SHA-256 HMAC or checksum of a string or binary buffer.
84
93
  * @internal
85
94
  */
@@ -169,23 +178,34 @@ export interface ClientDefaults extends Partial<__SmithyResolvedConfiguration<__
169
178
  */
170
179
  logger?: __Logger;
171
180
  /**
172
- * The {@link __DefaultsMode} that will be used to determine how certain default configuration options are resolved in the SDK.
181
+ * The {@link @aws-sdk/smithy-client#DefaultsMode} that will be used to determine how certain default configuration options are resolved in the SDK.
173
182
  */
174
183
  defaultsMode?: __DefaultsMode | __Provider<__DefaultsMode>;
175
184
  }
185
+ /**
186
+ * @public
187
+ */
176
188
  type ForecastClientConfigType = Partial<__SmithyConfiguration<__HttpHandlerOptions>> & ClientDefaults & RegionInputConfig & EndpointInputConfig<EndpointParameters> & RetryInputConfig & HostHeaderInputConfig & AwsAuthInputConfig & UserAgentInputConfig & ClientInputEndpointParameters;
177
189
  /**
178
- * The configuration interface of ForecastClient class constructor that set the region, credentials and other options.
190
+ * @public
191
+ *
192
+ * The configuration interface of ForecastClient class constructor that set the region, credentials and other options.
179
193
  */
180
194
  export interface ForecastClientConfig extends ForecastClientConfigType {
181
195
  }
196
+ /**
197
+ * @public
198
+ */
182
199
  type ForecastClientResolvedConfigType = __SmithyResolvedConfiguration<__HttpHandlerOptions> & Required<ClientDefaults> & RegionResolvedConfig & EndpointResolvedConfig<EndpointParameters> & RetryResolvedConfig & HostHeaderResolvedConfig & AwsAuthResolvedConfig & UserAgentResolvedConfig & ClientResolvedEndpointParameters;
183
200
  /**
184
- * The resolved configuration interface of ForecastClient class. This is resolved and normalized from the {@link ForecastClientConfig | constructor configuration interface}.
201
+ * @public
202
+ *
203
+ * The resolved configuration interface of ForecastClient class. This is resolved and normalized from the {@link ForecastClientConfig | constructor configuration interface}.
185
204
  */
186
205
  export interface ForecastClientResolvedConfig extends ForecastClientResolvedConfigType {
187
206
  }
188
207
  /**
208
+ * @public
189
209
  * <p>Provides APIs for creating and managing Amazon Forecast resources.</p>
190
210
  */
191
211
  export declare class ForecastClient extends __Client<__HttpHandlerOptions, ServiceInputTypes, ServiceOutputTypes, ForecastClientResolvedConfig> {
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { ForecastClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ForecastClient";
5
5
  import { CreateAutoPredictorRequest, CreateAutoPredictorResponse } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link CreateAutoPredictorCommand}.
8
10
  */
9
11
  export interface CreateAutoPredictorCommandInput extends CreateAutoPredictorRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link CreateAutoPredictorCommand}.
13
17
  */
14
18
  export interface CreateAutoPredictorCommandOutput extends CreateAutoPredictorResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Creates an Amazon Forecast predictor.</p>
18
23
  * <p>Amazon Forecast creates predictors with AutoPredictor, which involves applying the
19
24
  * optimal combination of algorithms to each time series in your datasets. You can use
@@ -73,6 +78,8 @@ export interface CreateAutoPredictorCommandOutput extends CreateAutoPredictorRes
73
78
  * const response = await client.send(command);
74
79
  * ```
75
80
  *
81
+ * @param CreateAutoPredictorCommandInput - {@link CreateAutoPredictorCommandInput}
82
+ * @returns {@link CreateAutoPredictorCommandOutput}
76
83
  * @see {@link CreateAutoPredictorCommandInput} for command's `input` shape.
77
84
  * @see {@link CreateAutoPredictorCommandOutput} for command's `response` shape.
78
85
  * @see {@link ForecastClientResolvedConfig | config} for ForecastClient's `config` shape.
@@ -99,11 +106,20 @@ export interface CreateAutoPredictorCommandOutput extends CreateAutoPredictorRes
99
106
  export declare class CreateAutoPredictorCommand extends $Command<CreateAutoPredictorCommandInput, CreateAutoPredictorCommandOutput, ForecastClientResolvedConfig> {
100
107
  readonly input: CreateAutoPredictorCommandInput;
101
108
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
109
+ /**
110
+ * @public
111
+ */
102
112
  constructor(input: CreateAutoPredictorCommandInput);
103
113
  /**
104
114
  * @internal
105
115
  */
106
116
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: ForecastClientResolvedConfig, options?: __HttpHandlerOptions): Handler<CreateAutoPredictorCommandInput, CreateAutoPredictorCommandOutput>;
117
+ /**
118
+ * @internal
119
+ */
107
120
  private serialize;
121
+ /**
122
+ * @internal
123
+ */
108
124
  private deserialize;
109
125
  }