@aws-sdk/client-forecast 3.28.0 → 3.32.0

package/models/models_0.ts

@@ -1509,6 +1509,14 @@ export namespace InputDataConfig {
   });
 }
 
+export enum OptimizationMetric {
+  AverageWeightedQuantileLoss = "AverageWeightedQuantileLoss",
+  MAPE = "MAPE",
+  MASE = "MASE",
+  RMSE = "RMSE",
+  WAPE = "WAPE",
+}
+
 export interface CreatePredictorRequest {
   /**
    * <p>A name for the predictor.</p>
@@ -1588,7 +1596,12 @@ export interface CreatePredictorRequest {
   PerformAutoML?: boolean;
 
   /**
-   * <p>Used to overide the default AutoML strategy, which is to optimize predictor accuracy.
+   * <note>
+   *             <p> The <code>LatencyOptimized</code> AutoML override strategy is only available in private beta.
+   *                 Contact AWS Support or your account manager to learn more about access privileges.
+   *             </p>
+   *         </note>
+   *         <p>Used to overide the default AutoML strategy, which is to optimize predictor accuracy.
    *             To apply an AutoML strategy that minimizes training time, use
    *                 <code>LatencyOptimized</code>.</p>
    *         <p>This parameter is only valid for predictors trained using AutoML.</p>
@@ -1685,6 +1698,11 @@ export interface CreatePredictorRequest {
    *          </ul>
    */
   Tags?: Tag[];
+
+  /**
+   * <p>The accuracy metric used to optimize the predictor.</p>
+   */
+  OptimizationMetric?: OptimizationMetric | string;
 }
 
 export namespace CreatePredictorRequest {
@@ -2785,7 +2803,12 @@ export interface DescribePredictorResponse {
   PerformAutoML?: boolean;
 
   /**
-   * <p>The AutoML strategy used to train the predictor. Unless <code>LatencyOptimized</code>
+   * <note>
+   *             <p> The <code>LatencyOptimized</code> AutoML override strategy is only available in private beta.
+   *                 Contact AWS Support or your account manager to learn more about access privileges.
+   *             </p>
+   *         </note>
+   *         <p>The AutoML strategy used to train the predictor. Unless <code>LatencyOptimized</code>
    *             is specified, the AutoML strategy optimizes predictor accuracy.</p>
    *         <p>This parameter is only valid for predictors trained using AutoML.</p>
    */
@@ -2923,6 +2946,11 @@ export interface DescribePredictorResponse {
    *          </ul>
    */
   LastModificationTime?: Date;
+
+  /**
+   * <p>The accuracy metric used to optimize the predictor.</p>
+   */
+  OptimizationMetric?: OptimizationMetric | string;
 }
 
 export namespace DescribePredictorResponse {
@@ -3071,32 +3099,34 @@ export enum EvaluationType {
 }
 
 /**
- * <p>
- *       Provides detailed error metrics to evaluate the performance of a predictor. This object is
- *       part of the <a>Metrics</a> object.
- *     </p>
+ * <p> Provides detailed error metrics to evaluate the performance of a predictor. This object
+ *       is part of the <a>Metrics</a> object. </p>
  */
 export interface ErrorMetric {
   /**
-   * <p>
-   *       The Forecast type used to compute WAPE and RMSE.
-   *     </p>
+   * <p> The Forecast type used to compute WAPE, MAPE, MASE, and RMSE. </p>
    */
   ForecastType?: string;
 
   /**
-   * <p>
-   *       The weighted absolute percentage error (WAPE).
-   *     </p>
+   * <p> The weighted absolute percentage error (WAPE). </p>
    */
   WAPE?: number;
 
   /**
-   * <p>
-   *       The root-mean-square error (RMSE).
-   *     </p>
+   * <p> The root-mean-square error (RMSE). </p>
    */
   RMSE?: number;
+
+  /**
+   * <p>The Mean Absolute Scaled Error (MASE)</p>
+   */
+  MASE?: number;
+
+  /**
+   * <p>The Mean Absolute Percentage Error (MAPE)</p>
+   */
+  MAPE?: number;
 }
 
 export namespace ErrorMetric {
@@ -3109,14 +3139,13 @@ export namespace ErrorMetric {
 }
 
 /**
- * <p>The weighted loss value for a quantile. This object is part of the
- *       <a>Metrics</a> object.</p>
+ * <p>The weighted loss value for a quantile. This object is part of the <a>Metrics</a> object.</p>
  */
 export interface WeightedQuantileLoss {
   /**
    * <p>The quantile. Quantiles divide a probability distribution into regions of equal
-   *       probability. For example, if the distribution was divided into 5 regions of equal
-   *       probability, the quantiles would be 0.2, 0.4, 0.6, and 0.8.</p>
+   *       probability. For example, if the distribution was divided into 5 regions of equal probability,
+   *       the quantiles would be 0.2, 0.4, 0.6, and 0.8.</p>
    */
   Quantile?: number;
 
@@ -3137,8 +3166,8 @@ export namespace WeightedQuantileLoss {
 }
 
 /**
- * <p>Provides metrics that are used to evaluate the performance of a predictor. This object
- *       is part of the <a>WindowSummary</a> object.</p>
+ * <p>Provides metrics that are used to evaluate the performance of a predictor. This object is
+ *       part of the <a>WindowSummary</a> object.</p>
  */
 export interface Metrics {
   /**
@@ -3155,12 +3184,16 @@ export interface Metrics {
   WeightedQuantileLosses?: WeightedQuantileLoss[];
 
   /**
-   * <p>
-   *       Provides detailed error metrics on forecast type, root-mean square-error (RMSE), and weighted
-   *       average percentage error (WAPE).
-   *     </p>
+   * <p> Provides detailed error metrics for each forecast type. Metrics include root-mean
+   *       square-error (RMSE), mean absolute percentage error (MAPE), mean absolute scaled error (MASE),
+   *       and weighted average percentage error (WAPE). </p>
    */
   ErrorMetrics?: ErrorMetric[];
+
+  /**
+   * <p>The average value of all weighted quantile losses.</p>
+   */
+  AverageWeightedQuantileLoss?: number;
 }
 
 export namespace Metrics {
@@ -3173,11 +3206,10 @@ export namespace Metrics {
 }
 
 /**
- * <p>The metrics for a time range within the evaluation portion of a dataset. This object
- *       is part of the <a>EvaluationResult</a> object.</p>
- *          <p>The <code>TestWindowStart</code> and <code>TestWindowEnd</code> parameters are
- *       determined by the <code>BackTestWindowOffset</code> parameter of the
- *       <a>EvaluationParameters</a> object.</p>
+ * <p>The metrics for a time range within the evaluation portion of a dataset. This object is
+ *       part of the <a>EvaluationResult</a> object.</p>
+ *          <p>The <code>TestWindowStart</code> and <code>TestWindowEnd</code> parameters are determined
+ *       by the <code>BackTestWindowOffset</code> parameter of the <a>EvaluationParameters</a> object.</p>
  */
 export interface WindowSummary {
   /**
@@ -3226,8 +3258,7 @@ export namespace WindowSummary {
 }
 
 /**
- * <p>The results of evaluating an algorithm. Returned as part of the
- *       <a>GetAccuracyMetrics</a> response.</p>
+ * <p>The results of evaluating an algorithm. Returned as part of the <a>GetAccuracyMetrics</a> response.</p>
  */
 export interface EvaluationResult {
   /**
@@ -3237,8 +3268,8 @@ export interface EvaluationResult {
 
   /**
    * <p>The array of test windows used for evaluating the algorithm. The
-   *       <code>NumberOfBacktestWindows</code> from the <a>EvaluationParameters</a>
-   *       object determines the number of windows in the array.</p>
+   *         <code>NumberOfBacktestWindows</code> from the <a>EvaluationParameters</a> object
+   *       determines the number of windows in the array.</p>
    */
   TestWindows?: WindowSummary[];
 }
@@ -3259,11 +3290,21 @@ export interface GetAccuracyMetricsResponse {
   PredictorEvaluationResults?: EvaluationResult[];
 
   /**
-   * <p>The AutoML strategy used to train the predictor. Unless <code>LatencyOptimized</code>
+   * <note>
+   *             <p> The <code>LatencyOptimized</code> AutoML override strategy is only available in private beta.
+   *                 Contact AWS Support or your account manager to learn more about access privileges.
+   *             </p>
+   *         </note>
+   *         <p>The AutoML strategy used to train the predictor. Unless <code>LatencyOptimized</code>
    *             is specified, the AutoML strategy optimizes predictor accuracy.</p>
    *         <p>This parameter is only valid for predictors trained using AutoML.</p>
    */
   AutoMLOverrideStrategy?: AutoMLOverrideStrategy | string;
+
+  /**
+   * <p>The accuracy metric used to optimize the predictor.</p>
+   */
+  OptimizationMetric?: OptimizationMetric | string;
 }
 
 export namespace GetAccuracyMetricsResponse {

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@aws-sdk/client-forecast",
   "description": "AWS SDK for JavaScript Forecast Client for Node.js, Browser and React Native",
-  "version": "3.28.0",
+  "version": "3.32.0",
   "scripts": {
     "clean": "yarn remove-definitions && yarn remove-dist && yarn remove-documentation",
     "build-documentation": "yarn remove-documentation && typedoc ./",
@@ -27,45 +27,45 @@
   "dependencies": {
     "@aws-crypto/sha256-browser": "^1.0.0",
     "@aws-crypto/sha256-js": "^1.0.0",
-    "@aws-sdk/client-sts": "3.28.0",
-    "@aws-sdk/config-resolver": "3.28.0",
-    "@aws-sdk/credential-provider-node": "3.28.0",
-    "@aws-sdk/fetch-http-handler": "3.25.0",
-    "@aws-sdk/hash-node": "3.25.0",
-    "@aws-sdk/invalid-dependency": "3.25.0",
-    "@aws-sdk/middleware-content-length": "3.25.0",
-    "@aws-sdk/middleware-host-header": "3.25.0",
-    "@aws-sdk/middleware-logger": "3.25.0",
-    "@aws-sdk/middleware-retry": "3.28.0",
-    "@aws-sdk/middleware-serde": "3.25.0",
-    "@aws-sdk/middleware-signing": "3.28.0",
-    "@aws-sdk/middleware-stack": "3.25.0",
-    "@aws-sdk/middleware-user-agent": "3.25.0",
-    "@aws-sdk/node-config-provider": "3.28.0",
-    "@aws-sdk/node-http-handler": "3.25.0",
-    "@aws-sdk/protocol-http": "3.25.0",
-    "@aws-sdk/smithy-client": "3.28.0",
-    "@aws-sdk/types": "3.25.0",
-    "@aws-sdk/url-parser": "3.25.0",
-    "@aws-sdk/util-base64-browser": "3.23.0",
-    "@aws-sdk/util-base64-node": "3.23.0",
-    "@aws-sdk/util-body-length-browser": "3.23.0",
-    "@aws-sdk/util-body-length-node": "3.23.0",
-    "@aws-sdk/util-user-agent-browser": "3.25.0",
-    "@aws-sdk/util-user-agent-node": "3.28.0",
-    "@aws-sdk/util-utf8-browser": "3.23.0",
-    "@aws-sdk/util-utf8-node": "3.23.0",
+    "@aws-sdk/client-sts": "3.32.0",
+    "@aws-sdk/config-resolver": "3.32.0",
+    "@aws-sdk/credential-provider-node": "3.32.0",
+    "@aws-sdk/fetch-http-handler": "3.32.0",
+    "@aws-sdk/hash-node": "3.32.0",
+    "@aws-sdk/invalid-dependency": "3.32.0",
+    "@aws-sdk/middleware-content-length": "3.32.0",
+    "@aws-sdk/middleware-host-header": "3.32.0",
+    "@aws-sdk/middleware-logger": "3.32.0",
+    "@aws-sdk/middleware-retry": "3.32.0",
+    "@aws-sdk/middleware-serde": "3.32.0",
+    "@aws-sdk/middleware-signing": "3.32.0",
+    "@aws-sdk/middleware-stack": "3.32.0",
+    "@aws-sdk/middleware-user-agent": "3.32.0",
+    "@aws-sdk/node-config-provider": "3.32.0",
+    "@aws-sdk/node-http-handler": "3.32.0",
+    "@aws-sdk/protocol-http": "3.32.0",
+    "@aws-sdk/smithy-client": "3.32.0",
+    "@aws-sdk/types": "3.32.0",
+    "@aws-sdk/url-parser": "3.32.0",
+    "@aws-sdk/util-base64-browser": "3.32.0",
+    "@aws-sdk/util-base64-node": "3.32.0",
+    "@aws-sdk/util-body-length-browser": "3.32.0",
+    "@aws-sdk/util-body-length-node": "3.32.0",
+    "@aws-sdk/util-user-agent-browser": "3.32.0",
+    "@aws-sdk/util-user-agent-node": "3.32.0",
+    "@aws-sdk/util-utf8-browser": "3.32.0",
+    "@aws-sdk/util-utf8-node": "3.32.0",
     "tslib": "^2.3.0"
   },
   "devDependencies": {
-    "@aws-sdk/client-documentation-generator": "3.23.0",
+    "@aws-sdk/client-documentation-generator": "3.32.0",
     "@types/node": "^12.7.5",
     "downlevel-dts": "0.7.0",
     "jest": "^26.1.0",
     "rimraf": "^3.0.0",
     "ts-jest": "^26.4.1",
     "typedoc": "^0.19.2",
-    "typescript": "~4.3.2"
+    "typescript": "~4.3.5"
   },
   "engines": {
     "node": ">=10.0.0"