@aws-sdk/client-forecast 3.43.0 → 3.47.1

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 (35) hide show
  1. package/CHANGELOG.md +47 -0
  2. package/dist-cjs/endpoints.js +1 -12
  3. package/dist-cjs/models/models_0.js +3 -39
  4. package/dist-cjs/protocols/Aws_json1_1.js +3 -0
  5. package/dist-cjs/runtimeConfig.browser.js +7 -2
  6. package/dist-cjs/runtimeConfig.js +9 -3
  7. package/dist-es/endpoints.js +1 -12
  8. package/dist-es/models/models_0.js +0 -24
  9. package/dist-es/protocols/Aws_json1_1.js +3 -0
  10. package/dist-es/runtimeConfig.browser.js +12 -3
  11. package/dist-es/runtimeConfig.js +13 -6
  12. package/dist-types/Forecast.d.ts +34 -27
  13. package/dist-types/ForecastClient.d.ts +5 -1
  14. package/dist-types/commands/CreateAutoPredictorCommand.d.ts +1 -1
  15. package/dist-types/commands/CreateExplainabilityCommand.d.ts +1 -1
  16. package/dist-types/commands/CreatePredictorBacktestExportJobCommand.d.ts +4 -4
  17. package/dist-types/commands/CreatePredictorCommand.d.ts +1 -1
  18. package/dist-types/commands/DeleteExplainabilityExportCommand.d.ts +1 -1
  19. package/dist-types/commands/DeletePredictorCommand.d.ts +2 -3
  20. package/dist-types/commands/DescribePredictorBacktestExportJobCommand.d.ts +1 -1
  21. package/dist-types/commands/DescribePredictorCommand.d.ts +1 -2
  22. package/dist-types/commands/ListPredictorBacktestExportJobsCommand.d.ts +4 -4
  23. package/dist-types/commands/ListPredictorsCommand.d.ts +5 -5
  24. package/dist-types/commands/StopResourceCommand.d.ts +9 -3
  25. package/dist-types/commands/TagResourceCommand.d.ts +4 -1
  26. package/dist-types/models/models_0.d.ts +305 -176
  27. package/dist-types/runtimeConfig.browser.d.ts +3 -2
  28. package/dist-types/runtimeConfig.d.ts +4 -3
  29. package/dist-types/runtimeConfig.native.d.ts +1 -0
  30. package/dist-types/ts3.4/ForecastClient.d.ts +3 -1
  31. package/dist-types/ts3.4/models/models_0.d.ts +8 -24
  32. package/dist-types/ts3.4/runtimeConfig.browser.d.ts +3 -2
  33. package/dist-types/ts3.4/runtimeConfig.d.ts +4 -3
  34. package/dist-types/ts3.4/runtimeConfig.native.d.ts +1 -0
  35. package/package.json +39 -46
@@ -77,7 +77,7 @@ export interface CreateExplainabilityCommandOutput extends CreateExplainabilityR
77
77
  * <b>CreateExplainability with a Forecast ARN</b>
78
78
  * </p>
79
79
  * <note>
80
- * <p>You can specify a maximum of 50 time series and 1500 time points.</p>
80
+ * <p>You can specify a maximum of 50 time series and 500 time points.</p>
81
81
  * </note>
82
82
  * <p>The following parameters are required when providing a Predictor ARN:</p>
83
83
  * <ul>
@@ -7,8 +7,8 @@ export interface CreatePredictorBacktestExportJobCommandInput extends CreatePred
7
7
  export interface CreatePredictorBacktestExportJobCommandOutput extends CreatePredictorBacktestExportJobResponse, __MetadataBearer {
8
8
  }
9
9
  /**
10
- * <p>Exports backtest forecasts and accuracy metrics generated by the <a>CreatePredictor</a> operation. Two folders containing CSV files are exported
11
- * to your specified S3 bucket.</p>
10
+ * <p>Exports backtest forecasts and accuracy metrics generated by the <a>CreateAutoPredictor</a> or <a>CreatePredictor</a> operations. Two
11
+ * folders containing CSV files are exported to your specified S3 bucket.</p>
12
12
  * <p> The export file names will match the following conventions:</p>
13
13
  * <p>
14
14
  * <code><ExportJobName>_<ExportTimestamp>_<PartNumber>.csv</code>
@@ -19,8 +19,8 @@ export interface CreatePredictorBacktestExportJobCommandOutput extends CreatePre
19
19
  * bucket and an AWS Identity and Access Management (IAM) role that Amazon Forecast can assume to access the Amazon S3
20
20
  * bucket. For more information, see <a>aws-forecast-iam-roles</a>.</p>
21
21
  * <note>
22
- * <p>The <code>Status</code> of the export job must be <code>ACTIVE</code> before
23
- * you can access the export in your Amazon S3 bucket. To get the status, use the <a>DescribePredictorBacktestExportJob</a> operation.</p>
22
+ * <p>The <code>Status</code> of the export job must be <code>ACTIVE</code> before you
23
+ * can access the export in your Amazon S3 bucket. To get the status, use the <a>DescribePredictorBacktestExportJob</a> operation.</p>
24
24
  * </note>
25
25
  * @example
26
26
  * Use a bare-bones client and the command you need to make an API call.
@@ -10,7 +10,7 @@ export interface CreatePredictorCommandOutput extends CreatePredictorResponse, _
10
10
  * <note>
11
11
  * <p> This operation creates a legacy predictor that does not include all the predictor
12
12
  * functionalities provided by Amazon Forecast. To create a predictor that is compatible with all
13
- * aspects of Forecast, use CreateAutoPredictor.</p>
13
+ * aspects of Forecast, use <a>CreateAutoPredictor</a>.</p>
14
14
  * </note>
15
15
  * <p>Creates an Amazon Forecast predictor.</p>
16
16
  * <p>In the request, provide a dataset group and either specify an algorithm or let Amazon Forecast
@@ -7,7 +7,7 @@ export interface DeleteExplainabilityExportCommandInput extends DeleteExplainabi
7
7
  export interface DeleteExplainabilityExportCommandOutput extends __MetadataBearer {
8
8
  }
9
9
  /**
10
- * <p>Deletes an Explainability export job.</p>
10
+ * <p>Deletes an Explainability export.</p>
11
11
  * @example
12
12
  * Use a bare-bones client and the command you need to make an API call.
13
13
  * ```javascript
@@ -7,9 +7,8 @@ export interface DeletePredictorCommandInput extends DeletePredictorRequest {
7
7
  export interface DeletePredictorCommandOutput extends __MetadataBearer {
8
8
  }
9
9
  /**
10
- * <p>Deletes a predictor created using the <a>CreatePredictor</a> operation. You can
11
- * delete only predictor that have a status of <code>ACTIVE</code> or <code>CREATE_FAILED</code>.
12
- * To get the status, use the <a>DescribePredictor</a> operation.</p>
10
+ * <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
11
+ * <code>ACTIVE</code> or <code>CREATE_FAILED</code>. To get the status, use the <a>DescribePredictor</a> operation.</p>
13
12
  * @example
14
13
  * Use a bare-bones client and the command you need to make an API call.
15
14
  * ```javascript
@@ -9,7 +9,7 @@ export interface DescribePredictorBacktestExportJobCommandOutput extends Describ
9
9
  /**
10
10
  * <p>Describes a predictor backtest export job created using the <a>CreatePredictorBacktestExportJob</a> operation.</p>
11
11
  * <p>In addition to listing the properties provided by the user in the
12
- * <code>CreatePredictorBacktestExportJob</code> request, this operation lists the
12
+ * <code>CreatePredictorBacktestExportJob</code> request, this operation lists the
13
13
  * following properties:</p>
14
14
  * <ul>
15
15
  * <li>
@@ -9,8 +9,7 @@ export interface DescribePredictorCommandOutput extends DescribePredictorRespons
9
9
  /**
10
10
  * <note>
11
11
  * <p> This operation is only valid for legacy predictors created with CreatePredictor. If you
12
- * are not using a legacy predictor, use DescribeAutoPredictor.</p>
13
- * <p>To upgrade a legacy predictor to AutoPredictor, see Upgrading to AutoPredictor.</p>
12
+ * are not using a legacy predictor, use <a>DescribeAutoPredictor</a>.</p>
14
13
  * </note>
15
14
  * <p>Describes a predictor created using the <a>CreatePredictor</a>
16
15
  * operation.</p>
@@ -7,10 +7,10 @@ export interface ListPredictorBacktestExportJobsCommandInput extends ListPredict
7
7
  export interface ListPredictorBacktestExportJobsCommandOutput extends ListPredictorBacktestExportJobsResponse, __MetadataBearer {
8
8
  }
9
9
  /**
10
- * <p>Returns a list of predictor backtest export jobs created using the <a>CreatePredictorBacktestExportJob</a> operation. This operation returns a summary
11
- * for each backtest export job. You can filter the list using an array of <a>Filter</a> objects.</p>
12
- * <p>To retrieve the complete set of properties for a particular backtest export job, use the
13
- * ARN with the <a>DescribePredictorBacktestExportJob</a> operation.</p>
10
+ * <p>Returns a list of predictor backtest export jobs created using the <a>CreatePredictorBacktestExportJob</a> operation. This operation returns a
11
+ * summary for each backtest export job. You can filter the list using an array of <a>Filter</a> objects.</p>
12
+ * <p>To retrieve the complete set of properties for a particular backtest export job, use
13
+ * the ARN with the <a>DescribePredictorBacktestExportJob</a> operation.</p>
14
14
  * @example
15
15
  * Use a bare-bones client and the command you need to make an API call.
16
16
  * ```javascript
@@ -7,11 +7,11 @@ export interface ListPredictorsCommandInput extends ListPredictorsRequest {
7
7
  export interface ListPredictorsCommandOutput extends ListPredictorsResponse, __MetadataBearer {
8
8
  }
9
9
  /**
10
- * <p>Returns a list of predictors created using the <a>CreatePredictor</a>
11
- * operation. For each predictor, this operation returns a summary of its properties, including
12
- * its Amazon Resource Name (ARN). You can retrieve the complete set of properties by using the
13
- * ARN with the <a>DescribePredictor</a> operation. You can filter the list using an
14
- * array of <a>Filter</a> objects.</p>
10
+ * <p>Returns a list of predictors created using the <a>CreateAutoPredictor</a> or
11
+ * <a>CreatePredictor</a> operations. For each predictor, this operation returns a
12
+ * summary of its properties, including its Amazon Resource Name (ARN). </p>
13
+ * <p>You can retrieve the complete set of properties by using the ARN with the <a>DescribeAutoPredictor</a> and <a>DescribePredictor</a> operations. You
14
+ * can filter the list using an array of <a>Filter</a> objects.</p>
15
15
  * @example
16
16
  * Use a bare-bones client and the command you need to make an API call.
17
17
  * ```javascript
@@ -8,9 +8,9 @@ export interface StopResourceCommandOutput extends __MetadataBearer {
8
8
  }
9
9
  /**
10
10
  * <p>Stops a resource.</p>
11
- * <p>The resource undergoes the following states:
12
- * <code>CREATE_STOPPING</code> and <code>CREATE_STOPPED</code>. You cannot resume
13
- * a resource once it has been stopped.</p>
11
+ * <p>The resource undergoes the following states: <code>CREATE_STOPPING</code> and
12
+ * <code>CREATE_STOPPED</code>. You cannot resume a resource once it has been
13
+ * stopped.</p>
14
14
  * <p>This operation can be applied to the following resources (and their corresponding child
15
15
  * resources):</p>
16
16
  * <ul>
@@ -29,6 +29,12 @@ export interface StopResourceCommandOutput extends __MetadataBearer {
29
29
  * <li>
30
30
  * <p>Predictor Backtest Export Job</p>
31
31
  * </li>
32
+ * <li>
33
+ * <p>Explainability Job</p>
34
+ * </li>
35
+ * <li>
36
+ * <p>Explainability Export Job</p>
37
+ * </li>
32
38
  * </ul>
33
39
  * @example
34
40
  * Use a bare-bones client and the command you need to make an API call.
@@ -7,7 +7,10 @@ export interface TagResourceCommandInput extends TagResourceRequest {
7
7
  export interface TagResourceCommandOutput extends TagResourceResponse, __MetadataBearer {
8
8
  }
9
9
  /**
10
- * <p>Associates the specified tags to a resource with the specified <code>resourceArn</code>. If existing tags on a resource are not specified in the request parameters, they are not changed. When a resource is deleted, the tags associated with that resource are also deleted.</p>
10
+ * <p>Associates the specified tags to a resource with the specified <code>resourceArn</code>.
11
+ * If existing tags on a resource are not specified in the request parameters, they are not
12
+ * changed. When a resource is deleted, the tags associated with that resource are also
13
+ * deleted.</p>
11
14
  * @example
12
15
  * Use a bare-bones client and the command you need to make an API call.
13
16
  * ```javascript