@aws-sdk/client-forecast 3.261.0 → 3.263.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 (28) hide show
  1. package/dist-cjs/endpoint/ruleset.js +3 -3
  2. package/dist-cjs/models/models_0.js +9 -4
  3. package/dist-cjs/protocols/Aws_json1_1.js +3 -0
  4. package/dist-es/endpoint/ruleset.js +3 -3
  5. package/dist-es/models/models_0.js +5 -0
  6. package/dist-es/protocols/Aws_json1_1.js +3 -0
  7. package/dist-types/Forecast.d.ts +102 -108
  8. package/dist-types/commands/CreateAutoPredictorCommand.d.ts +16 -18
  9. package/dist-types/commands/CreateDatasetImportJobCommand.d.ts +2 -2
  10. package/dist-types/commands/CreateExplainabilityCommand.d.ts +39 -39
  11. package/dist-types/commands/CreateExplainabilityExportCommand.d.ts +4 -4
  12. package/dist-types/commands/CreateForecastExportJobCommand.d.ts +1 -1
  13. package/dist-types/commands/CreatePredictorBacktestExportJobCommand.d.ts +7 -7
  14. package/dist-types/commands/CreatePredictorCommand.d.ts +0 -3
  15. package/dist-types/commands/CreateWhatIfAnalysisCommand.d.ts +7 -6
  16. package/dist-types/commands/CreateWhatIfForecastExportCommand.d.ts +1 -1
  17. package/dist-types/commands/DeleteExplainabilityCommand.d.ts +1 -1
  18. package/dist-types/commands/DeleteResourceTreeCommand.d.ts +9 -10
  19. package/dist-types/commands/DescribePredictorBacktestExportJobCommand.d.ts +12 -12
  20. package/dist-types/commands/GetAccuracyMetricsCommand.d.ts +0 -1
  21. package/dist-types/commands/ListExplainabilitiesCommand.d.ts +1 -1
  22. package/dist-types/commands/ListExplainabilityExportsCommand.d.ts +1 -1
  23. package/dist-types/commands/ListPredictorBacktestExportJobsCommand.d.ts +1 -1
  24. package/dist-types/endpoint/EndpointParameters.d.ts +1 -1
  25. package/dist-types/models/models_0.d.ts +448 -369
  26. package/dist-types/ts3.4/endpoint/EndpointParameters.d.ts +1 -1
  27. package/dist-types/ts3.4/models/models_0.d.ts +7 -0
  28. package/package.json +2 -2
@@ -69,55 +69,53 @@ import { ForecastClient } from "./ForecastClient";
69
69
  export declare class Forecast extends ForecastClient {
70
70
  /**
71
71
  * <p>Creates an Amazon Forecast predictor.</p>
72
- * <p>Amazon Forecast creates predictors with AutoPredictor, which involves applying the
72
+ * <p>Amazon Forecast creates predictors with AutoPredictor, which involves applying the
73
73
  * optimal combination of algorithms to each time series in your datasets. You can use
74
74
  * <a>CreateAutoPredictor</a> to create new predictors or upgrade/retrain
75
75
  * existing predictors.</p>
76
- *
77
- * <p>
76
+ * <p>
78
77
  * <b>Creating new predictors</b>
79
78
  * </p>
80
- *
81
- * <p>The following parameters are required when creating a new predictor:</p>
82
- * <ul>
79
+ * <p>The following parameters are required when creating a new predictor:</p>
80
+ * <ul>
83
81
  * <li>
84
- * <p>
82
+ * <p>
85
83
  * <code>PredictorName</code> - A unique name for the predictor.</p>
86
84
  * </li>
87
85
  * <li>
88
- * <p>
86
+ * <p>
89
87
  * <code>DatasetGroupArn</code> - The ARN of the dataset group used to train the
90
88
  * predictor.</p>
91
89
  * </li>
92
90
  * <li>
93
- * <p>
91
+ * <p>
94
92
  * <code>ForecastFrequency</code> - The granularity of your forecasts (hourly,
95
93
  * daily, weekly, etc).</p>
96
94
  * </li>
97
95
  * <li>
98
- * <p>
96
+ * <p>
99
97
  * <code>ForecastHorizon</code> - The number of time-steps that the model
100
98
  * predicts. The forecast horizon is also called the prediction length.</p>
101
99
  * </li>
102
100
  * </ul>
103
- * <p>When creating a new predictor, do not specify a value for
101
+ * <p>When creating a new predictor, do not specify a value for
104
102
  * <code>ReferencePredictorArn</code>.</p>
105
- * <p>
103
+ * <p>
106
104
  * <b>Upgrading and retraining predictors</b>
107
- * </p>
108
- * <p>The following parameters are required when retraining or upgrading a predictor:</p>
109
- * <ul>
105
+ * </p>
106
+ * <p>The following parameters are required when retraining or upgrading a predictor:</p>
107
+ * <ul>
110
108
  * <li>
111
- * <p>
109
+ * <p>
112
110
  * <code>PredictorName</code> - A unique name for the predictor.</p>
113
111
  * </li>
114
112
  * <li>
115
- * <p>
113
+ * <p>
116
114
  * <code>ReferencePredictorArn</code> - The ARN of the predictor to retrain or
117
115
  * upgrade.</p>
118
116
  * </li>
119
117
  * </ul>
120
- * <p>When upgrading or retraining a predictor, only specify values for the
118
+ * <p>When upgrading or retraining a predictor, only specify values for the
121
119
  * <code>ReferencePredictorArn</code> and <code>PredictorName</code>. </p>
122
120
  */
123
121
  createAutoPredictor(args: CreateAutoPredictorCommandInput, options?: __HttpHandlerOptions): Promise<CreateAutoPredictorCommandOutput>;
@@ -190,8 +188,8 @@ export declare class Forecast extends ForecastClient {
190
188
  * training data in an Amazon Simple Storage Service (Amazon S3) bucket and the Amazon Resource Name (ARN) of the dataset
191
189
  * that you want to import the data to.</p>
192
190
  * <p>You must specify a <a href="https://docs.aws.amazon.com/forecast/latest/dg/API_DataSource.html">DataSource</a> object that includes an
193
- * AWS Identity and Access Management (IAM) role that Amazon Forecast can assume to access the data, as Amazon Forecast makes a copy
194
- * of your data and processes it in an internal AWS system. For more information, see <a href="https://docs.aws.amazon.com/forecast/latest/dg/aws-forecast-iam-roles.html">Set up
191
+ * Identity and Access Management (IAM) role that Amazon Forecast can assume to access the data, as Amazon Forecast makes a copy
192
+ * of your data and processes it in an internal Amazon Web Services system. For more information, see <a href="https://docs.aws.amazon.com/forecast/latest/dg/aws-forecast-iam-roles.html">Set up
195
193
  * permissions</a>.</p>
196
194
  * <p>The training data must be in CSV or Parquet format. The delimiter must be a comma (,).</p>
197
195
  * <p>You can specify the path to a specific file, the S3 bucket, or to a folder in the S3
@@ -211,118 +209,118 @@ export declare class Forecast extends ForecastClient {
211
209
  * <note>
212
210
  * <p>Explainability is only available for Forecasts and Predictors generated from an
213
211
  * AutoPredictor (<a>CreateAutoPredictor</a>)</p>
214
- * </note>
215
- * <p>Creates an Amazon Forecast Explainability.</p>
216
- * <p>Explainability helps you better understand how the attributes in your datasets impact
212
+ * </note>
213
+ * <p>Creates an Amazon Forecast Explainability.</p>
214
+ * <p>Explainability helps you better understand how the attributes in your datasets impact
217
215
  * forecast. Amazon Forecast uses a metric called Impact scores to quantify the relative
218
216
  * impact of each attribute and determine whether they increase or decrease forecast
219
217
  * values.</p>
220
- * <p>To enable Forecast Explainability, your predictor must include at least one of the
218
+ * <p>To enable Forecast Explainability, your predictor must include at least one of the
221
219
  * following: related time series, item metadata, or additional datasets like Holidays and
222
220
  * the Weather Index.</p>
223
- * <p>CreateExplainability accepts either a Predictor ARN or Forecast ARN. To receive
221
+ * <p>CreateExplainability accepts either a Predictor ARN or Forecast ARN. To receive
224
222
  * aggregated Impact scores for all time series and time points in your datasets, provide a
225
223
  * Predictor ARN. To receive Impact scores for specific time series and time points,
226
224
  * provide a Forecast ARN.</p>
227
- * <p>
225
+ * <p>
228
226
  * <b>CreateExplainability with a Predictor ARN</b>
229
- * </p>
230
- * <note>
227
+ * </p>
228
+ * <note>
231
229
  * <p>You can only have one Explainability resource per predictor. If you already
232
230
  * enabled <code>ExplainPredictor</code> in <a>CreateAutoPredictor</a>, that
233
231
  * predictor already has an Explainability resource.</p>
234
- * </note>
235
- * <p>The following parameters are required when providing a Predictor ARN:</p>
236
- * <ul>
232
+ * </note>
233
+ * <p>The following parameters are required when providing a Predictor ARN:</p>
234
+ * <ul>
237
235
  * <li>
238
- * <p>
236
+ * <p>
239
237
  * <code>ExplainabilityName</code> - A unique name for the Explainability.</p>
240
238
  * </li>
241
239
  * <li>
242
- * <p>
240
+ * <p>
243
241
  * <code>ResourceArn</code> - The Arn of the predictor.</p>
244
242
  * </li>
245
243
  * <li>
246
- * <p>
244
+ * <p>
247
245
  * <code>TimePointGranularity</code> - Must be set to “ALL”.</p>
248
246
  * </li>
249
247
  * <li>
250
- * <p>
248
+ * <p>
251
249
  * <code>TimeSeriesGranularity</code> - Must be set to “ALL”.</p>
252
250
  * </li>
253
251
  * </ul>
254
- * <p>Do not specify a value for the following parameters:</p>
255
- * <ul>
252
+ * <p>Do not specify a value for the following parameters:</p>
253
+ * <ul>
256
254
  * <li>
257
- * <p>
255
+ * <p>
258
256
  * <code>DataSource</code> - Only valid when TimeSeriesGranularity is
259
257
  * “SPECIFIC”.</p>
260
258
  * </li>
261
259
  * <li>
262
- * <p>
260
+ * <p>
263
261
  * <code>Schema</code> - Only valid when TimeSeriesGranularity is
264
262
  * “SPECIFIC”.</p>
265
263
  * </li>
266
264
  * <li>
267
- * <p>
265
+ * <p>
268
266
  * <code>StartDateTime</code> - Only valid when TimePointGranularity is
269
267
  * “SPECIFIC”.</p>
270
268
  * </li>
271
269
  * <li>
272
- * <p>
270
+ * <p>
273
271
  * <code>EndDateTime</code> - Only valid when TimePointGranularity is
274
272
  * “SPECIFIC”.</p>
275
273
  * </li>
276
274
  * </ul>
277
- * <p>
275
+ * <p>
278
276
  * <b>CreateExplainability with a Forecast ARN</b>
279
- * </p>
280
- * <note>
277
+ * </p>
278
+ * <note>
281
279
  * <p>You can specify a maximum of 50 time series and 500 time points.</p>
282
- * </note>
283
- * <p>The following parameters are required when providing a Predictor ARN:</p>
284
- * <ul>
280
+ * </note>
281
+ * <p>The following parameters are required when providing a Predictor ARN:</p>
282
+ * <ul>
285
283
  * <li>
286
- * <p>
284
+ * <p>
287
285
  * <code>ExplainabilityName</code> - A unique name for the Explainability.</p>
288
286
  * </li>
289
287
  * <li>
290
- * <p>
288
+ * <p>
291
289
  * <code>ResourceArn</code> - The Arn of the forecast.</p>
292
290
  * </li>
293
291
  * <li>
294
- * <p>
292
+ * <p>
295
293
  * <code>TimePointGranularity</code> - Either “ALL” or “SPECIFIC”.</p>
296
294
  * </li>
297
295
  * <li>
298
- * <p>
296
+ * <p>
299
297
  * <code>TimeSeriesGranularity</code> - Either “ALL” or “SPECIFIC”.</p>
300
298
  * </li>
301
299
  * </ul>
302
- * <p>If you set TimeSeriesGranularity to “SPECIFIC”, you must also provide the
300
+ * <p>If you set TimeSeriesGranularity to “SPECIFIC”, you must also provide the
303
301
  * following:</p>
304
- * <ul>
302
+ * <ul>
305
303
  * <li>
306
- * <p>
304
+ * <p>
307
305
  * <code>DataSource</code> - The S3 location of the CSV file specifying your time
308
306
  * series.</p>
309
307
  * </li>
310
308
  * <li>
311
- * <p>
309
+ * <p>
312
310
  * <code>Schema</code> - The Schema defines the attributes and attribute types
313
311
  * listed in the Data Source.</p>
314
312
  * </li>
315
313
  * </ul>
316
- * <p>If you set TimePointGranularity to “SPECIFIC”, you must also provide the
314
+ * <p>If you set TimePointGranularity to “SPECIFIC”, you must also provide the
317
315
  * following:</p>
318
- * <ul>
316
+ * <ul>
319
317
  * <li>
320
- * <p>
318
+ * <p>
321
319
  * <code>StartDateTime</code> - The first timestamp in the range of time
322
320
  * points.</p>
323
321
  * </li>
324
322
  * <li>
325
- * <p>
323
+ * <p>
326
324
  * <code>EndDateTime</code> - The last timestamp in the range of time
327
325
  * points.</p>
328
326
  * </li>
@@ -334,13 +332,13 @@ export declare class Forecast extends ForecastClient {
334
332
  /**
335
333
  * <p>Exports an Explainability resource created by the <a>CreateExplainability</a> operation. Exported files are exported to an Amazon Simple Storage Service (Amazon
336
334
  * S3) bucket.</p>
337
- * <p>You must specify a <a>DataDestination</a> object that includes an Amazon S3
338
- * bucket and an AWS Identity and Access Management (IAM) role that Amazon Forecast can assume to access the Amazon S3
335
+ * <p>You must specify a <a>DataDestination</a> object that includes an Amazon S3
336
+ * bucket and an Identity and Access Management (IAM) role that Amazon Forecast can assume to access the Amazon S3
339
337
  * bucket. For more information, see <a>aws-forecast-iam-roles</a>.</p>
340
- * <note>
338
+ * <note>
341
339
  * <p>The <code>Status</code> of the export job must be <code>ACTIVE</code> before you
342
340
  * can access the export in your Amazon S3 bucket. To get the status, use the <a>DescribeExplainabilityExport</a> operation.</p>
343
- * </note>
341
+ * </note>
344
342
  */
345
343
  createExplainabilityExport(args: CreateExplainabilityExportCommandInput, options?: __HttpHandlerOptions): Promise<CreateExplainabilityExportCommandOutput>;
346
344
  createExplainabilityExport(args: CreateExplainabilityExportCommandInput, cb: (err: any, data?: CreateExplainabilityExportCommandOutput) => void): void;
@@ -377,7 +375,7 @@ export declare class Forecast extends ForecastClient {
377
375
  * <p><ForecastExportJobName>_<ExportTimestamp>_<PartNumber></p>
378
376
  * <p>where the <ExportTimestamp> component is in Java SimpleDateFormat
379
377
  * (yyyy-MM-ddTHH-mm-ssZ).</p>
380
- * <p>You must specify a <a>DataDestination</a> object that includes an AWS Identity and Access Management
378
+ * <p>You must specify a <a>DataDestination</a> object that includes an Identity and Access Management
381
379
  * (IAM) role that Amazon Forecast can assume to access the Amazon S3 bucket. For more information, see
382
380
  * <a>aws-forecast-iam-roles</a>.</p>
383
381
  * <p>For more information, see <a>howitworks-forecast</a>.</p>
@@ -452,9 +450,6 @@ export declare class Forecast extends ForecastClient {
452
450
  * </p>
453
451
  * </li>
454
452
  * </ul>
455
- *
456
- *
457
- *
458
453
  * <p>To get a list of all of your predictors, use the <a>ListPredictors</a>
459
454
  * operation.</p>
460
455
  * <note>
@@ -469,19 +464,19 @@ export declare class Forecast extends ForecastClient {
469
464
  /**
470
465
  * <p>Exports backtest forecasts and accuracy metrics generated by the <a>CreateAutoPredictor</a> or <a>CreatePredictor</a> operations. Two
471
466
  * folders containing CSV or Parquet files are exported to your specified S3 bucket.</p>
472
- * <p> The export file names will match the following conventions:</p>
473
- * <p>
467
+ * <p> The export file names will match the following conventions:</p>
468
+ * <p>
474
469
  * <code><ExportJobName>_<ExportTimestamp>_<PartNumber>.csv</code>
475
470
  * </p>
476
- * <p>The <ExportTimestamp> component is in Java SimpleDate format
471
+ * <p>The <ExportTimestamp> component is in Java SimpleDate format
477
472
  * (yyyy-MM-ddTHH-mm-ssZ).</p>
478
- * <p>You must specify a <a>DataDestination</a> object that includes an Amazon S3
479
- * bucket and an AWS Identity and Access Management (IAM) role that Amazon Forecast can assume to access the Amazon S3
473
+ * <p>You must specify a <a>DataDestination</a> object that includes an Amazon S3
474
+ * bucket and an Identity and Access Management (IAM) role that Amazon Forecast can assume to access the Amazon S3
480
475
  * bucket. For more information, see <a>aws-forecast-iam-roles</a>.</p>
481
- * <note>
476
+ * <note>
482
477
  * <p>The <code>Status</code> of the export job must be <code>ACTIVE</code> before you
483
478
  * can access the export in your Amazon S3 bucket. To get the status, use the <a>DescribePredictorBacktestExportJob</a> operation.</p>
484
- * </note>
479
+ * </note>
485
480
  */
486
481
  createPredictorBacktestExportJob(args: CreatePredictorBacktestExportJobCommandInput, options?: __HttpHandlerOptions): Promise<CreatePredictorBacktestExportJobCommandOutput>;
487
482
  createPredictorBacktestExportJob(args: CreatePredictorBacktestExportJobCommandInput, cb: (err: any, data?: CreatePredictorBacktestExportJobCommandOutput) => void): void;
@@ -491,12 +486,13 @@ export declare class Forecast extends ForecastClient {
491
486
  * compare the forecasts generated by these changes against the baseline, unchanged time series. It is important to
492
487
  * remember that the purpose of a what-if analysis is to understand how a forecast can change given different
493
488
  * 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>
489
+ * <p>For example, imagine you are a clothing retailer who is considering an end of season sale
490
+ * to clear space for new styles. After creating a baseline forecast, you can use a what-if
491
+ * analysis to investigate how different sales tactics might affect your goals.</p>
492
+ * <p>You could create a scenario where everything is given a 25% markdown, and another where
493
+ * everything is given a fixed dollar markdown. You could create a scenario where the sale lasts for one week and
494
+ * another where the sale lasts for one month.
495
+ * With a what-if analysis, you can compare many different scenarios against each other.</p>
500
496
  * <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
497
  * <p>The <a>TimeSeriesSelector</a> object defines the items that you want in the what-if analysis.</p>
502
498
  */
@@ -518,7 +514,7 @@ export declare class Forecast extends ForecastClient {
518
514
  * </p>
519
515
  * <p>The <ExportTimestamp> component is in Java SimpleDateFormat
520
516
  * (yyyy-MM-ddTHH-mm-ssZ).</p>
521
- * <p>You must specify a <a>DataDestination</a> object that includes an AWS Identity and Access Management
517
+ * <p>You must specify a <a>DataDestination</a> object that includes an Identity and Access Management
522
518
  * (IAM) role that Amazon Forecast can assume to access the Amazon S3 bucket. For more information, see
523
519
  * <a>aws-forecast-iam-roles</a>.</p>
524
520
  * <p>For more information, see <a>howitworks-forecast</a>.</p>
@@ -565,7 +561,7 @@ export declare class Forecast extends ForecastClient {
565
561
  deleteDatasetImportJob(args: DeleteDatasetImportJobCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteDatasetImportJobCommandOutput) => void): void;
566
562
  /**
567
563
  * <p>Deletes an Explainability resource.</p>
568
- * <p>You can delete only predictor that have a status of <code>ACTIVE</code> or
564
+ * <p>You can delete only predictor that have a status of <code>ACTIVE</code> or
569
565
  * <code>CREATE_FAILED</code>. To get the status, use the <a>DescribeExplainability</a> operation.</p>
570
566
  */
571
567
  deleteExplainability(args: DeleteExplainabilityCommandInput, options?: __HttpHandlerOptions): Promise<DeleteExplainabilityCommandOutput>;
@@ -617,36 +613,35 @@ export declare class Forecast extends ForecastClient {
617
613
  /**
618
614
  * <p>Deletes an entire resource tree. This operation will delete the parent resource and
619
615
  * its child resources.</p>
620
- * <p>Child resources are resources that were created from another resource. For example,
616
+ * <p>Child resources are resources that were created from another resource. For example,
621
617
  * when a forecast is generated from a predictor, the forecast is the child resource and
622
618
  * the predictor is the parent resource.</p>
623
- * <p>Amazon Forecast resources possess the following parent-child resource hierarchies:</p>
624
- *
625
- * <ul>
619
+ * <p>Amazon Forecast resources possess the following parent-child resource hierarchies:</p>
620
+ * <ul>
626
621
  * <li>
627
- * <p>
622
+ * <p>
628
623
  * <b>Dataset</b>: dataset import jobs</p>
629
624
  * </li>
630
625
  * <li>
631
- * <p>
626
+ * <p>
632
627
  * <b>Dataset Group</b>: predictors, predictor backtest
633
628
  * export jobs, forecasts, forecast export jobs</p>
634
629
  * </li>
635
630
  * <li>
636
- * <p>
631
+ * <p>
637
632
  * <b>Predictor</b>: predictor backtest export jobs,
638
633
  * forecasts, forecast export jobs</p>
639
634
  * </li>
640
635
  * <li>
641
- * <p>
636
+ * <p>
642
637
  * <b>Forecast</b>: forecast export jobs</p>
643
638
  * </li>
644
639
  * </ul>
645
- * <note>
640
+ * <note>
646
641
  * <p>
647
642
  * <code>DeleteResourceTree</code> will only delete Amazon Forecast resources, and will not
648
643
  * delete datasets or exported files stored in Amazon S3. </p>
649
- * </note>
644
+ * </note>
650
645
  */
651
646
  deleteResourceTree(args: DeleteResourceTreeCommandInput, options?: __HttpHandlerOptions): Promise<DeleteResourceTreeCommandOutput>;
652
647
  deleteResourceTree(args: DeleteResourceTreeCommandInput, cb: (err: any, data?: DeleteResourceTreeCommandOutput) => void): void;
@@ -940,27 +935,27 @@ export declare class Forecast extends ForecastClient {
940
935
  describePredictor(args: DescribePredictorCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribePredictorCommandOutput) => void): void;
941
936
  /**
942
937
  * <p>Describes a predictor backtest export job created using the <a>CreatePredictorBacktestExportJob</a> operation.</p>
943
- * <p>In addition to listing the properties provided by the user in the
938
+ * <p>In addition to listing the properties provided by the user in the
944
939
  * <code>CreatePredictorBacktestExportJob</code> request, this operation lists the
945
940
  * following properties:</p>
946
- * <ul>
941
+ * <ul>
947
942
  * <li>
948
- * <p>
949
- * <code>CreationTime</code>
950
- * </p>
943
+ * <p>
944
+ * <code>CreationTime</code>
945
+ * </p>
951
946
  * </li>
952
947
  * <li>
953
- * <p>
954
- * <code>LastModificationTime</code>
955
- * </p>
948
+ * <p>
949
+ * <code>LastModificationTime</code>
950
+ * </p>
956
951
  * </li>
957
952
  * <li>
958
- * <p>
959
- * <code>Status</code>
960
- * </p>
953
+ * <p>
954
+ * <code>Status</code>
955
+ * </p>
961
956
  * </li>
962
957
  * <li>
963
- * <p>
958
+ * <p>
964
959
  * <code>Message</code> (if an error occurred)</p>
965
960
  * </li>
966
961
  * </ul>
@@ -1065,7 +1060,6 @@ export declare class Forecast extends ForecastClient {
1065
1060
  * metrics. If you want all items to contribute, specify <code>zero</code>. If you want only
1066
1061
  * those items that have complete data in the range being evaluated to contribute, specify
1067
1062
  * <code>nan</code>. For more information, see <a>FeaturizationMethod</a>.</p>
1068
- *
1069
1063
  * <note>
1070
1064
  * <p>Before you can get accuracy metrics, the <code>Status</code> of the predictor must be
1071
1065
  * <code>ACTIVE</code>, signifying that training has completed. To get the status, use the
@@ -1107,7 +1101,7 @@ export declare class Forecast extends ForecastClient {
1107
1101
  * <p>Returns a list of Explainability resources created using the <a>CreateExplainability</a> operation. This operation returns a summary for
1108
1102
  * each Explainability. You can filter the list using an array of <a>Filter</a>
1109
1103
  * objects.</p>
1110
- * <p>To retrieve the complete set of properties for a particular Explainability resource,
1104
+ * <p>To retrieve the complete set of properties for a particular Explainability resource,
1111
1105
  * use the ARN with the <a>DescribeExplainability</a> operation.</p>
1112
1106
  */
1113
1107
  listExplainabilities(args: ListExplainabilitiesCommandInput, options?: __HttpHandlerOptions): Promise<ListExplainabilitiesCommandOutput>;
@@ -1116,7 +1110,7 @@ export declare class Forecast extends ForecastClient {
1116
1110
  /**
1117
1111
  * <p>Returns a list of Explainability exports created using the <a>CreateExplainabilityExport</a> operation. This operation returns a summary
1118
1112
  * for each Explainability export. You can filter the list using an array of <a>Filter</a> objects.</p>
1119
- * <p>To retrieve the complete set of properties for a particular Explainability export, use
1113
+ * <p>To retrieve the complete set of properties for a particular Explainability export, use
1120
1114
  * the ARN with the <a>DescribeExplainability</a> operation.</p>
1121
1115
  */
1122
1116
  listExplainabilityExports(args: ListExplainabilityExportsCommandInput, options?: __HttpHandlerOptions): Promise<ListExplainabilityExportsCommandOutput>;
@@ -1160,7 +1154,7 @@ export declare class Forecast extends ForecastClient {
1160
1154
  /**
1161
1155
  * <p>Returns a list of predictor backtest export jobs created using the <a>CreatePredictorBacktestExportJob</a> operation. This operation returns a
1162
1156
  * summary for each backtest export job. You can filter the list using an array of <a>Filter</a> objects.</p>
1163
- * <p>To retrieve the complete set of properties for a particular backtest export job, use
1157
+ * <p>To retrieve the complete set of properties for a particular backtest export job, use
1164
1158
  * the ARN with the <a>DescribePredictorBacktestExportJob</a> operation.</p>
1165
1159
  */
1166
1160
  listPredictorBacktestExportJobs(args: ListPredictorBacktestExportJobsCommandInput, options?: __HttpHandlerOptions): Promise<ListPredictorBacktestExportJobsCommandOutput>;
@@ -9,55 +9,53 @@ export interface CreateAutoPredictorCommandOutput extends CreateAutoPredictorRes
9
9
  }
10
10
  /**
11
11
  * <p>Creates an Amazon Forecast predictor.</p>
12
- * <p>Amazon Forecast creates predictors with AutoPredictor, which involves applying the
12
+ * <p>Amazon Forecast creates predictors with AutoPredictor, which involves applying the
13
13
  * optimal combination of algorithms to each time series in your datasets. You can use
14
14
  * <a>CreateAutoPredictor</a> to create new predictors or upgrade/retrain
15
15
  * existing predictors.</p>
16
- *
17
- * <p>
16
+ * <p>
18
17
  * <b>Creating new predictors</b>
19
18
  * </p>
20
- *
21
- * <p>The following parameters are required when creating a new predictor:</p>
22
- * <ul>
19
+ * <p>The following parameters are required when creating a new predictor:</p>
20
+ * <ul>
23
21
  * <li>
24
- * <p>
22
+ * <p>
25
23
  * <code>PredictorName</code> - A unique name for the predictor.</p>
26
24
  * </li>
27
25
  * <li>
28
- * <p>
26
+ * <p>
29
27
  * <code>DatasetGroupArn</code> - The ARN of the dataset group used to train the
30
28
  * predictor.</p>
31
29
  * </li>
32
30
  * <li>
33
- * <p>
31
+ * <p>
34
32
  * <code>ForecastFrequency</code> - The granularity of your forecasts (hourly,
35
33
  * daily, weekly, etc).</p>
36
34
  * </li>
37
35
  * <li>
38
- * <p>
36
+ * <p>
39
37
  * <code>ForecastHorizon</code> - The number of time-steps that the model
40
38
  * predicts. The forecast horizon is also called the prediction length.</p>
41
39
  * </li>
42
40
  * </ul>
43
- * <p>When creating a new predictor, do not specify a value for
41
+ * <p>When creating a new predictor, do not specify a value for
44
42
  * <code>ReferencePredictorArn</code>.</p>
45
- * <p>
43
+ * <p>
46
44
  * <b>Upgrading and retraining predictors</b>
47
- * </p>
48
- * <p>The following parameters are required when retraining or upgrading a predictor:</p>
49
- * <ul>
45
+ * </p>
46
+ * <p>The following parameters are required when retraining or upgrading a predictor:</p>
47
+ * <ul>
50
48
  * <li>
51
- * <p>
49
+ * <p>
52
50
  * <code>PredictorName</code> - A unique name for the predictor.</p>
53
51
  * </li>
54
52
  * <li>
55
- * <p>
53
+ * <p>
56
54
  * <code>ReferencePredictorArn</code> - The ARN of the predictor to retrain or
57
55
  * upgrade.</p>
58
56
  * </li>
59
57
  * </ul>
60
- * <p>When upgrading or retraining a predictor, only specify values for the
58
+ * <p>When upgrading or retraining a predictor, only specify values for the
61
59
  * <code>ReferencePredictorArn</code> and <code>PredictorName</code>. </p>
62
60
  * @example
63
61
  * Use a bare-bones client and the command you need to make an API call.
@@ -12,8 +12,8 @@ export interface CreateDatasetImportJobCommandOutput extends CreateDatasetImport
12
12
  * training data in an Amazon Simple Storage Service (Amazon S3) bucket and the Amazon Resource Name (ARN) of the dataset
13
13
  * that you want to import the data to.</p>
14
14
  * <p>You must specify a <a href="https://docs.aws.amazon.com/forecast/latest/dg/API_DataSource.html">DataSource</a> object that includes an
15
- * AWS Identity and Access Management (IAM) role that Amazon Forecast can assume to access the data, as Amazon Forecast makes a copy
16
- * of your data and processes it in an internal AWS system. For more information, see <a href="https://docs.aws.amazon.com/forecast/latest/dg/aws-forecast-iam-roles.html">Set up
15
+ * Identity and Access Management (IAM) role that Amazon Forecast can assume to access the data, as Amazon Forecast makes a copy
16
+ * of your data and processes it in an internal Amazon Web Services system. For more information, see <a href="https://docs.aws.amazon.com/forecast/latest/dg/aws-forecast-iam-roles.html">Set up
17
17
  * permissions</a>.</p>
18
18
  * <p>The training data must be in CSV or Parquet format. The delimiter must be a comma (,).</p>
19
19
  * <p>You can specify the path to a specific file, the S3 bucket, or to a folder in the S3