@aws-sdk/client-forecast 3.42.0 → 3.43.0

package/dist-types/Forecast.d.ts

@@ -1,7 +1,10 @@
 import { HttpHandlerOptions as __HttpHandlerOptions } from "@aws-sdk/types";
+import { CreateAutoPredictorCommandInput, CreateAutoPredictorCommandOutput } from "./commands/CreateAutoPredictorCommand";
 import { CreateDatasetCommandInput, CreateDatasetCommandOutput } from "./commands/CreateDatasetCommand";
 import { CreateDatasetGroupCommandInput, CreateDatasetGroupCommandOutput } from "./commands/CreateDatasetGroupCommand";
 import { CreateDatasetImportJobCommandInput, CreateDatasetImportJobCommandOutput } from "./commands/CreateDatasetImportJobCommand";
+import { CreateExplainabilityCommandInput, CreateExplainabilityCommandOutput } from "./commands/CreateExplainabilityCommand";
+import { CreateExplainabilityExportCommandInput, CreateExplainabilityExportCommandOutput } from "./commands/CreateExplainabilityExportCommand";
 import { CreateForecastCommandInput, CreateForecastCommandOutput } from "./commands/CreateForecastCommand";
 import { CreateForecastExportJobCommandInput, CreateForecastExportJobCommandOutput } from "./commands/CreateForecastExportJobCommand";
 import { CreatePredictorBacktestExportJobCommandInput, CreatePredictorBacktestExportJobCommandOutput } from "./commands/CreatePredictorBacktestExportJobCommand";
@@ -9,14 +12,19 @@ import { CreatePredictorCommandInput, CreatePredictorCommandOutput } from "./com
 import { DeleteDatasetCommandInput, DeleteDatasetCommandOutput } from "./commands/DeleteDatasetCommand";
 import { DeleteDatasetGroupCommandInput, DeleteDatasetGroupCommandOutput } from "./commands/DeleteDatasetGroupCommand";
 import { DeleteDatasetImportJobCommandInput, DeleteDatasetImportJobCommandOutput } from "./commands/DeleteDatasetImportJobCommand";
+import { DeleteExplainabilityCommandInput, DeleteExplainabilityCommandOutput } from "./commands/DeleteExplainabilityCommand";
+import { DeleteExplainabilityExportCommandInput, DeleteExplainabilityExportCommandOutput } from "./commands/DeleteExplainabilityExportCommand";
 import { DeleteForecastCommandInput, DeleteForecastCommandOutput } from "./commands/DeleteForecastCommand";
 import { DeleteForecastExportJobCommandInput, DeleteForecastExportJobCommandOutput } from "./commands/DeleteForecastExportJobCommand";
 import { DeletePredictorBacktestExportJobCommandInput, DeletePredictorBacktestExportJobCommandOutput } from "./commands/DeletePredictorBacktestExportJobCommand";
 import { DeletePredictorCommandInput, DeletePredictorCommandOutput } from "./commands/DeletePredictorCommand";
 import { DeleteResourceTreeCommandInput, DeleteResourceTreeCommandOutput } from "./commands/DeleteResourceTreeCommand";
+import { DescribeAutoPredictorCommandInput, DescribeAutoPredictorCommandOutput } from "./commands/DescribeAutoPredictorCommand";
 import { DescribeDatasetCommandInput, DescribeDatasetCommandOutput } from "./commands/DescribeDatasetCommand";
 import { DescribeDatasetGroupCommandInput, DescribeDatasetGroupCommandOutput } from "./commands/DescribeDatasetGroupCommand";
 import { DescribeDatasetImportJobCommandInput, DescribeDatasetImportJobCommandOutput } from "./commands/DescribeDatasetImportJobCommand";
+import { DescribeExplainabilityCommandInput, DescribeExplainabilityCommandOutput } from "./commands/DescribeExplainabilityCommand";
+import { DescribeExplainabilityExportCommandInput, DescribeExplainabilityExportCommandOutput } from "./commands/DescribeExplainabilityExportCommand";
 import { DescribeForecastCommandInput, DescribeForecastCommandOutput } from "./commands/DescribeForecastCommand";
 import { DescribeForecastExportJobCommandInput, DescribeForecastExportJobCommandOutput } from "./commands/DescribeForecastExportJobCommand";
 import { DescribePredictorBacktestExportJobCommandInput, DescribePredictorBacktestExportJobCommandOutput } from "./commands/DescribePredictorBacktestExportJobCommand";
@@ -25,6 +33,8 @@ import { GetAccuracyMetricsCommandInput, GetAccuracyMetricsCommandOutput } from
 import { ListDatasetGroupsCommandInput, ListDatasetGroupsCommandOutput } from "./commands/ListDatasetGroupsCommand";
 import { ListDatasetImportJobsCommandInput, ListDatasetImportJobsCommandOutput } from "./commands/ListDatasetImportJobsCommand";
 import { ListDatasetsCommandInput, ListDatasetsCommandOutput } from "./commands/ListDatasetsCommand";
+import { ListExplainabilitiesCommandInput, ListExplainabilitiesCommandOutput } from "./commands/ListExplainabilitiesCommand";
+import { ListExplainabilityExportsCommandInput, ListExplainabilityExportsCommandOutput } from "./commands/ListExplainabilityExportsCommand";
 import { ListForecastExportJobsCommandInput, ListForecastExportJobsCommandOutput } from "./commands/ListForecastExportJobsCommand";
 import { ListForecastsCommandInput, ListForecastsCommandOutput } from "./commands/ListForecastsCommand";
 import { ListPredictorBacktestExportJobsCommandInput, ListPredictorBacktestExportJobsCommandOutput } from "./commands/ListPredictorBacktestExportJobsCommand";
@@ -39,6 +49,60 @@ import { ForecastClient } from "./ForecastClient";
  * <p>Provides APIs for creating and managing Amazon Forecast resources.</p>
  */
 export declare class Forecast extends ForecastClient {
+    /**
+     * <p>Creates an Amazon Forecast predictor.</p>
+     *         <p>Amazon Forecast creates predictors with AutoPredictor, which involves applying the
+     *             optimal combination of algorithms to each time series in your datasets. You can use
+     *             CreateAutoPredictor to create new predictors or upgrade/retrain existing
+     *             predictors.</p>
+     *         <p>
+     *             <b>Creating new predictors</b>
+     *          </p>
+     *         <p>The following parameters are required when creating a new predictor:</p>
+     *         <ul>
+     *             <li>
+     *                 <p>
+     *                   <code>PredictorName</code> - A unique name for the predictor.</p>
+     *             </li>
+     *             <li>
+     *                 <p>
+     *                   <code>DatasetGroupArn</code> - The ARN of the dataset group used to train the
+     *                     predictor.</p>
+     *             </li>
+     *             <li>
+     *                 <p>
+     *                   <code>ForecastFrequency</code> - The granularity of your forecasts (hourly,
+     *                     daily, weekly, etc).</p>
+     *             </li>
+     *             <li>
+     *                 <p>
+     *                   <code>ForecastHorizon</code> - The number of time steps being
+     *                     forecasted.</p>
+     *             </li>
+     *          </ul>
+     *         <p>When creating a new predictor, do not specify a value for
+     *                 <code>ReferencePredictorArn</code>.</p>
+     *         <p>
+     *             <b>Upgrading and retraining predictors</b>
+     *          </p>
+     *         <p>The following parameters are required when retraining or upgrading a predictor:</p>
+     *         <ul>
+     *             <li>
+     *                 <p>
+     *                   <code>PredictorName</code> - A unique name for the predictor.</p>
+     *             </li>
+     *             <li>
+     *                 <p>
+     *                   <code>ReferencePredictorArn</code> - The ARN of the predictor to retrain or
+     *                     upgrade.</p>
+     *             </li>
+     *          </ul>
+     *         <p>When upgrading or retraining a predictor, only specify values for the
+     *                 <code>ReferencePredictorArn</code> and <code>PredictorName</code>. </p>
+     */
+    createAutoPredictor(args: CreateAutoPredictorCommandInput, options?: __HttpHandlerOptions): Promise<CreateAutoPredictorCommandOutput>;
+    createAutoPredictor(args: CreateAutoPredictorCommandInput, cb: (err: any, data?: CreateAutoPredictorCommandOutput) => void): void;
+    createAutoPredictor(args: CreateAutoPredictorCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateAutoPredictorCommandOutput) => void): void;
     /**
      * <p>Creates an Amazon Forecast dataset. The information about the dataset that you provide helps
      *       Forecast understand how to consume the data for model training. This includes the
@@ -126,6 +190,144 @@ export declare class Forecast extends ForecastClient {
     createDatasetImportJob(args: CreateDatasetImportJobCommandInput, options?: __HttpHandlerOptions): Promise<CreateDatasetImportJobCommandOutput>;
     createDatasetImportJob(args: CreateDatasetImportJobCommandInput, cb: (err: any, data?: CreateDatasetImportJobCommandOutput) => void): void;
     createDatasetImportJob(args: CreateDatasetImportJobCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateDatasetImportJobCommandOutput) => void): void;
+    /**
+     * <note>
+     *             <p>Explainability is only available for Forecasts and Predictors generated from an
+     *                 AutoPredictor (<a>CreateAutoPredictor</a>)</p>
+     *         </note>
+     *         <p>Creates an Amazon Forecast Explainability.</p>
+     *         <p>Explainability helps you better understand how the attributes in your datasets impact
+     *             forecast. Amazon Forecast uses a metric called Impact scores to quantify the relative
+     *             impact of each attribute and determine whether they increase or decrease forecast
+     *             values.</p>
+     *         <p>To enable Forecast Explainability, your predictor must include at least one of the
+     *             following: related time series, item metadata, or additional datasets like Holidays and
+     *             the Weather Index.</p>
+     *         <p>CreateExplainability accepts either a Predictor ARN or Forecast ARN. To receive
+     *             aggregated Impact scores for all time series and time points in your datasets, provide a
+     *             Predictor ARN. To receive Impact scores for specific time series and time points,
+     *             provide a Forecast ARN.</p>
+     *         <p>
+     *             <b>CreateExplainability with a Predictor ARN</b>
+     *          </p>
+     *         <note>
+     *             <p>You can only have one Explainability resource per predictor. If you already
+     *                 enabled <code>ExplainPredictor</code> in <a>CreateAutoPredictor</a>, that
+     *                 predictor already has an Explainability resource.</p>
+     *         </note>
+     *         <p>The following parameters are required when providing a Predictor ARN:</p>
+     *         <ul>
+     *             <li>
+     *                 <p>
+     *                   <code>ExplainabilityName</code> - A unique name for the Explainability.</p>
+     *             </li>
+     *             <li>
+     *                 <p>
+     *                   <code>ResourceArn</code> - The Arn of the predictor.</p>
+     *             </li>
+     *             <li>
+     *                 <p>
+     *                   <code>TimePointGranularity</code> - Must be set to “ALL”.</p>
+     *             </li>
+     *             <li>
+     *                 <p>
+     *                   <code>TimeSeriesGranularity</code> - Must be set to “ALL”.</p>
+     *             </li>
+     *          </ul>
+     *         <p>Do not specify a value for the following parameters:</p>
+     *         <ul>
+     *             <li>
+     *                 <p>
+     *                   <code>DataSource</code> - Only valid when TimeSeriesGranularity is
+     *                     “SPECIFIC”.</p>
+     *             </li>
+     *             <li>
+     *                 <p>
+     *                   <code>Schema</code> - Only valid when TimeSeriesGranularity is
+     *                     “SPECIFIC”.</p>
+     *             </li>
+     *             <li>
+     *                 <p>
+     *                   <code>StartDateTime</code> - Only valid when TimePointGranularity is
+     *                     “SPECIFIC”.</p>
+     *             </li>
+     *             <li>
+     *                 <p>
+     *                   <code>EndDateTime</code> - Only valid when TimePointGranularity is
+     *                     “SPECIFIC”.</p>
+     *             </li>
+     *          </ul>
+     *         <p>
+     *             <b>CreateExplainability with a Forecast ARN</b>
+     *          </p>
+     *         <note>
+     *             <p>You can specify a maximum of 50 time series and 1500 time points.</p>
+     *         </note>
+     *         <p>The following parameters are required when providing a Predictor ARN:</p>
+     *         <ul>
+     *             <li>
+     *                 <p>
+     *                   <code>ExplainabilityName</code> - A unique name for the Explainability.</p>
+     *             </li>
+     *             <li>
+     *                 <p>
+     *                   <code>ResourceArn</code> - The Arn of the forecast.</p>
+     *             </li>
+     *             <li>
+     *                 <p>
+     *                   <code>TimePointGranularity</code> - Either “ALL” or “SPECIFIC”.</p>
+     *             </li>
+     *             <li>
+     *                 <p>
+     *                   <code>TimeSeriesGranularity</code> - Either “ALL” or “SPECIFIC”.</p>
+     *             </li>
+     *          </ul>
+     *         <p>If you set TimeSeriesGranularity to “SPECIFIC”, you must also provide the
+     *             following:</p>
+     *         <ul>
+     *             <li>
+     *                 <p>
+     *                   <code>DataSource</code> - The S3 location of the CSV file specifying your time
+     *                     series.</p>
+     *             </li>
+     *             <li>
+     *                 <p>
+     *                   <code>Schema</code> - The Schema defines the attributes and attribute types
+     *                     listed in the Data Source.</p>
+     *             </li>
+     *          </ul>
+     *         <p>If you set TimePointGranularity to “SPECIFIC”, you must also provide the
+     *             following:</p>
+     *         <ul>
+     *             <li>
+     *                 <p>
+     *                   <code>StartDateTime</code> - The first timestamp in the range of time
+     *                     points.</p>
+     *             </li>
+     *             <li>
+     *                 <p>
+     *                   <code>EndDateTime</code> - The last timestamp in the range of time
+     *                     points.</p>
+     *             </li>
+     *          </ul>
+     */
+    createExplainability(args: CreateExplainabilityCommandInput, options?: __HttpHandlerOptions): Promise<CreateExplainabilityCommandOutput>;
+    createExplainability(args: CreateExplainabilityCommandInput, cb: (err: any, data?: CreateExplainabilityCommandOutput) => void): void;
+    createExplainability(args: CreateExplainabilityCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateExplainabilityCommandOutput) => void): void;
+    /**
+     * <p>Exports an Explainability resource created by the <a>CreateExplainability</a> operation. Exported files are exported to an Amazon Simple Storage Service (Amazon
+     *             S3) bucket.</p>
+     *         <p>You must specify a <a>DataDestination</a> object that includes an Amazon S3
+     *             bucket and an AWS Identity and Access Management (IAM) role that Amazon Forecast can assume to access the Amazon S3
+     *             bucket. For more information, see <a>aws-forecast-iam-roles</a>.</p>
+     *         <note>
+     *             <p>The <code>Status</code> of the export job must be <code>ACTIVE</code> before you
+     *                 can access the export in your Amazon S3 bucket. To get the status, use the <a>DescribeExplainabilityExport</a> operation.</p>
+     *         </note>
+     */
+    createExplainabilityExport(args: CreateExplainabilityExportCommandInput, options?: __HttpHandlerOptions): Promise<CreateExplainabilityExportCommandOutput>;
+    createExplainabilityExport(args: CreateExplainabilityExportCommandInput, cb: (err: any, data?: CreateExplainabilityExportCommandOutput) => void): void;
+    createExplainabilityExport(args: CreateExplainabilityExportCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateExplainabilityExportCommandOutput) => void): void;
     /**
      * <p>Creates a forecast for each item in the <code>TARGET_TIME_SERIES</code> dataset that was
      *       used to train the predictor. This is known as inference. To retrieve the forecast for a single
@@ -170,35 +372,36 @@ export declare class Forecast extends ForecastClient {
     createForecastExportJob(args: CreateForecastExportJobCommandInput, cb: (err: any, data?: CreateForecastExportJobCommandOutput) => void): void;
     createForecastExportJob(args: CreateForecastExportJobCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateForecastExportJobCommandOutput) => void): void;
     /**
-     * <p>Creates an Amazon Forecast predictor.</p>
-     *          <p>In the request, provide a dataset group and either specify an algorithm or let
-     *       Amazon Forecast choose an algorithm for you using AutoML. If you specify an algorithm, you also can
-     *       override algorithm-specific hyperparameters.</p>
-     *          <p>Amazon Forecast uses the algorithm to train a predictor using the latest version of the
-     *       datasets in the specified dataset group. You can then generate a
-     *       forecast using the <a>CreateForecast</a> operation.</p>
-     *          <p>
-     *       To see the evaluation metrics, use the <a>GetAccuracyMetrics</a> operation.
-     *     </p>
-     *          <p>You can specify a featurization configuration to fill and aggregate the data
-     *       fields in the <code>TARGET_TIME_SERIES</code> dataset to improve model training. For more
-     *       information, see <a>FeaturizationConfig</a>.</p>
+     * <note>
+     *             <p> This operation creates a legacy predictor that does not include all the predictor
+     *         functionalities provided by Amazon Forecast. To create a predictor that is compatible with all
+     *         aspects of Forecast, use CreateAutoPredictor.</p>
+     *          </note>
+     *          <p>Creates an Amazon Forecast predictor.</p>
+     *          <p>In the request, provide a dataset group and either specify an algorithm or let Amazon Forecast
+     *       choose an algorithm for you using AutoML. If you specify an algorithm, you also can override
+     *       algorithm-specific hyperparameters.</p>
+     *          <p>Amazon Forecast uses the algorithm to train a predictor using the latest version of the datasets
+     *       in the specified dataset group. You can then generate a forecast using the <a>CreateForecast</a> operation.</p>
+     *          <p> To see the evaluation metrics, use the <a>GetAccuracyMetrics</a> operation. </p>
+     *          <p>You can specify a featurization configuration to fill and aggregate the data fields in the
+     *         <code>TARGET_TIME_SERIES</code> dataset to improve model training. For more information, see
+     *         <a>FeaturizationConfig</a>.</p>
      *          <p>For RELATED_TIME_SERIES datasets, <code>CreatePredictor</code> verifies that the
      *         <code>DataFrequency</code> specified when the dataset was created matches the
      *         <code>ForecastFrequency</code>. TARGET_TIME_SERIES datasets don't have this restriction.
      *       Amazon Forecast also verifies the delimiter and timestamp format. For more information, see <a>howitworks-datasets-groups</a>.</p>
      *          <p>By default, predictors are trained and evaluated at the 0.1 (P10), 0.5 (P50), and 0.9
-     *       (P90) quantiles. You can choose custom forecast types to train and evaluate your predictor
-     *       by setting the <code>ForecastTypes</code>.
-     *     </p>
+     *       (P90) quantiles. You can choose custom forecast types to train and evaluate your predictor by
+     *       setting the <code>ForecastTypes</code>. </p>
      *          <p>
      *             <b>AutoML</b>
      *          </p>
      *          <p>If you want Amazon Forecast to evaluate each algorithm and choose the one that minimizes the
      *         <code>objective function</code>, set <code>PerformAutoML</code> to <code>true</code>. The
      *         <code>objective function</code> is defined as the mean of the weighted losses over the
-     *       forecast types. By default, these are the p10, p50, and p90
-     *       quantile losses. For more information, see <a>EvaluationResult</a>.</p>
+     *       forecast types. By default, these are the p10, p50, and p90 quantile losses. For more
+     *       information, see <a>EvaluationResult</a>.</p>
      *          <p>When AutoML is enabled, the following properties are disallowed:</p>
      *          <ul>
      *             <li>
@@ -287,6 +490,20 @@ export declare class Forecast extends ForecastClient {
     deleteDatasetImportJob(args: DeleteDatasetImportJobCommandInput, options?: __HttpHandlerOptions): Promise<DeleteDatasetImportJobCommandOutput>;
     deleteDatasetImportJob(args: DeleteDatasetImportJobCommandInput, cb: (err: any, data?: DeleteDatasetImportJobCommandOutput) => void): void;
     deleteDatasetImportJob(args: DeleteDatasetImportJobCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteDatasetImportJobCommandOutput) => void): void;
+    /**
+     * <p>Deletes an Explainability resource.</p>
+     *         <p>You can delete only predictor that have a status of <code>ACTIVE</code> or
+     *                 <code>CREATE_FAILED</code>. To get the status, use the <a>DescribeExplainability</a> operation.</p>
+     */
+    deleteExplainability(args: DeleteExplainabilityCommandInput, options?: __HttpHandlerOptions): Promise<DeleteExplainabilityCommandOutput>;
+    deleteExplainability(args: DeleteExplainabilityCommandInput, cb: (err: any, data?: DeleteExplainabilityCommandOutput) => void): void;
+    deleteExplainability(args: DeleteExplainabilityCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteExplainabilityCommandOutput) => void): void;
+    /**
+     * <p>Deletes an Explainability export job.</p>
+     */
+    deleteExplainabilityExport(args: DeleteExplainabilityExportCommandInput, options?: __HttpHandlerOptions): Promise<DeleteExplainabilityExportCommandOutput>;
+    deleteExplainabilityExport(args: DeleteExplainabilityExportCommandInput, cb: (err: any, data?: DeleteExplainabilityExportCommandOutput) => void): void;
+    deleteExplainabilityExport(args: DeleteExplainabilityExportCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteExplainabilityExportCommandOutput) => void): void;
     /**
      * <p>Deletes a forecast created using the <a>CreateForecast</a> operation. You can
      *       delete only forecasts that have a status of <code>ACTIVE</code> or <code>CREATE_FAILED</code>.
@@ -356,6 +573,12 @@ export declare class Forecast extends ForecastClient {
     deleteResourceTree(args: DeleteResourceTreeCommandInput, options?: __HttpHandlerOptions): Promise<DeleteResourceTreeCommandOutput>;
     deleteResourceTree(args: DeleteResourceTreeCommandInput, cb: (err: any, data?: DeleteResourceTreeCommandOutput) => void): void;
     deleteResourceTree(args: DeleteResourceTreeCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteResourceTreeCommandOutput) => void): void;
+    /**
+     * <p>Describes a predictor created using the CreateAutoPredictor operation.</p>
+     */
+    describeAutoPredictor(args: DescribeAutoPredictorCommandInput, options?: __HttpHandlerOptions): Promise<DescribeAutoPredictorCommandOutput>;
+    describeAutoPredictor(args: DescribeAutoPredictorCommandInput, cb: (err: any, data?: DescribeAutoPredictorCommandOutput) => void): void;
+    describeAutoPredictor(args: DescribeAutoPredictorCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeAutoPredictorCommandOutput) => void): void;
     /**
      * <p>Describes an Amazon Forecast dataset created using the <a>CreateDataset</a>
      *       operation.</p>
@@ -452,6 +675,18 @@ export declare class Forecast extends ForecastClient {
     describeDatasetImportJob(args: DescribeDatasetImportJobCommandInput, options?: __HttpHandlerOptions): Promise<DescribeDatasetImportJobCommandOutput>;
     describeDatasetImportJob(args: DescribeDatasetImportJobCommandInput, cb: (err: any, data?: DescribeDatasetImportJobCommandOutput) => void): void;
     describeDatasetImportJob(args: DescribeDatasetImportJobCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeDatasetImportJobCommandOutput) => void): void;
+    /**
+     * <p>Describes an Explainability resource created using the <a>CreateExplainability</a> operation.</p>
+     */
+    describeExplainability(args: DescribeExplainabilityCommandInput, options?: __HttpHandlerOptions): Promise<DescribeExplainabilityCommandOutput>;
+    describeExplainability(args: DescribeExplainabilityCommandInput, cb: (err: any, data?: DescribeExplainabilityCommandOutput) => void): void;
+    describeExplainability(args: DescribeExplainabilityCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeExplainabilityCommandOutput) => void): void;
+    /**
+     * <p>Describes an Explainability export created using the <a>CreateExplainabilityExport</a> operation.</p>
+     */
+    describeExplainabilityExport(args: DescribeExplainabilityExportCommandInput, options?: __HttpHandlerOptions): Promise<DescribeExplainabilityExportCommandOutput>;
+    describeExplainabilityExport(args: DescribeExplainabilityExportCommandInput, cb: (err: any, data?: DescribeExplainabilityExportCommandOutput) => void): void;
+    describeExplainabilityExport(args: DescribeExplainabilityExportCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeExplainabilityExportCommandOutput) => void): void;
     /**
      * <p>Describes a forecast created using the <a>CreateForecast</a> operation.</p>
      *          <p>In addition to listing the properties provided in the <code>CreateForecast</code> request,
@@ -517,7 +752,12 @@ export declare class Forecast extends ForecastClient {
     describeForecastExportJob(args: DescribeForecastExportJobCommandInput, cb: (err: any, data?: DescribeForecastExportJobCommandOutput) => void): void;
     describeForecastExportJob(args: DescribeForecastExportJobCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeForecastExportJobCommandOutput) => void): void;
     /**
-     * <p>Describes a predictor created using the <a>CreatePredictor</a>
+     * <note>
+     *             <p> This operation is only valid for legacy predictors created with CreatePredictor. If you
+     *         are not using a legacy predictor, use DescribeAutoPredictor.</p>
+     *             <p>To upgrade a legacy predictor to AutoPredictor, see Upgrading to AutoPredictor.</p>
+     *          </note>
+     *          <p>Describes a predictor created using the <a>CreatePredictor</a>
      *       operation.</p>
      *          <p>In addition to listing the properties provided in the <code>CreatePredictor</code>
      *       request, this operation lists the following properties:</p>
@@ -635,6 +875,25 @@ export declare class Forecast extends ForecastClient {
     listDatasets(args: ListDatasetsCommandInput, options?: __HttpHandlerOptions): Promise<ListDatasetsCommandOutput>;
     listDatasets(args: ListDatasetsCommandInput, cb: (err: any, data?: ListDatasetsCommandOutput) => void): void;
     listDatasets(args: ListDatasetsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListDatasetsCommandOutput) => void): void;
+    /**
+     * <p>Returns a list of Explainability resources created using the <a>CreateExplainability</a> operation. This operation returns a summary for
+     *             each Explainability. You can filter the list using an array of <a>Filter</a>
+     *             objects.</p>
+     *         <p>To retrieve the complete set of properties for a particular Explainability resource,
+     *             use the ARN with the <a>DescribeExplainability</a> operation.</p>
+     */
+    listExplainabilities(args: ListExplainabilitiesCommandInput, options?: __HttpHandlerOptions): Promise<ListExplainabilitiesCommandOutput>;
+    listExplainabilities(args: ListExplainabilitiesCommandInput, cb: (err: any, data?: ListExplainabilitiesCommandOutput) => void): void;
+    listExplainabilities(args: ListExplainabilitiesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListExplainabilitiesCommandOutput) => void): void;
+    /**
+     * <p>Returns a list of Explainability exports created using the <a>CreateExplainabilityExport</a> operation. This operation returns a summary
+     *             for each Explainability export. You can filter the list using an array of <a>Filter</a> objects.</p>
+     *         <p>To retrieve the complete set of properties for a particular Explainability export, use
+     *             the ARN with the <a>DescribeExplainability</a> operation.</p>
+     */
+    listExplainabilityExports(args: ListExplainabilityExportsCommandInput, options?: __HttpHandlerOptions): Promise<ListExplainabilityExportsCommandOutput>;
+    listExplainabilityExports(args: ListExplainabilityExportsCommandInput, cb: (err: any, data?: ListExplainabilityExportsCommandOutput) => void): void;
+    listExplainabilityExports(args: ListExplainabilityExportsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListExplainabilityExportsCommandOutput) => void): void;
     /**
      * <p>Returns a list of forecast export jobs created using the <a>CreateForecastExportJob</a> operation. For each forecast export job, this operation
      *       returns a summary of its properties, including its Amazon Resource Name (ARN). To retrieve the

package/dist-types/ForecastClient.d.ts

@@ -6,9 +6,12 @@ import { UserAgentInputConfig, UserAgentResolvedConfig } from "@aws-sdk/middlewa
 import { HttpHandler as __HttpHandler } from "@aws-sdk/protocol-http";
 import { Client as __Client, SmithyConfiguration as __SmithyConfiguration, SmithyResolvedConfiguration as __SmithyResolvedConfiguration } from "@aws-sdk/smithy-client";
 import { Credentials as __Credentials, Decoder as __Decoder, Encoder as __Encoder, HashConstructor as __HashConstructor, HttpHandlerOptions as __HttpHandlerOptions, Logger as __Logger, Provider as __Provider, Provider, RegionInfoProvider, StreamCollector as __StreamCollector, UrlParser as __UrlParser, UserAgent as __UserAgent } from "@aws-sdk/types";
+import { CreateAutoPredictorCommandInput, CreateAutoPredictorCommandOutput } from "./commands/CreateAutoPredictorCommand";
 import { CreateDatasetCommandInput, CreateDatasetCommandOutput } from "./commands/CreateDatasetCommand";
 import { CreateDatasetGroupCommandInput, CreateDatasetGroupCommandOutput } from "./commands/CreateDatasetGroupCommand";
 import { CreateDatasetImportJobCommandInput, CreateDatasetImportJobCommandOutput } from "./commands/CreateDatasetImportJobCommand";
+import { CreateExplainabilityCommandInput, CreateExplainabilityCommandOutput } from "./commands/CreateExplainabilityCommand";
+import { CreateExplainabilityExportCommandInput, CreateExplainabilityExportCommandOutput } from "./commands/CreateExplainabilityExportCommand";
 import { CreateForecastCommandInput, CreateForecastCommandOutput } from "./commands/CreateForecastCommand";
 import { CreateForecastExportJobCommandInput, CreateForecastExportJobCommandOutput } from "./commands/CreateForecastExportJobCommand";
 import { CreatePredictorBacktestExportJobCommandInput, CreatePredictorBacktestExportJobCommandOutput } from "./commands/CreatePredictorBacktestExportJobCommand";
@@ -16,14 +19,19 @@ import { CreatePredictorCommandInput, CreatePredictorCommandOutput } from "./com
 import { DeleteDatasetCommandInput, DeleteDatasetCommandOutput } from "./commands/DeleteDatasetCommand";
 import { DeleteDatasetGroupCommandInput, DeleteDatasetGroupCommandOutput } from "./commands/DeleteDatasetGroupCommand";
 import { DeleteDatasetImportJobCommandInput, DeleteDatasetImportJobCommandOutput } from "./commands/DeleteDatasetImportJobCommand";
+import { DeleteExplainabilityCommandInput, DeleteExplainabilityCommandOutput } from "./commands/DeleteExplainabilityCommand";
+import { DeleteExplainabilityExportCommandInput, DeleteExplainabilityExportCommandOutput } from "./commands/DeleteExplainabilityExportCommand";
 import { DeleteForecastCommandInput, DeleteForecastCommandOutput } from "./commands/DeleteForecastCommand";
 import { DeleteForecastExportJobCommandInput, DeleteForecastExportJobCommandOutput } from "./commands/DeleteForecastExportJobCommand";
 import { DeletePredictorBacktestExportJobCommandInput, DeletePredictorBacktestExportJobCommandOutput } from "./commands/DeletePredictorBacktestExportJobCommand";
 import { DeletePredictorCommandInput, DeletePredictorCommandOutput } from "./commands/DeletePredictorCommand";
 import { DeleteResourceTreeCommandInput, DeleteResourceTreeCommandOutput } from "./commands/DeleteResourceTreeCommand";
+import { DescribeAutoPredictorCommandInput, DescribeAutoPredictorCommandOutput } from "./commands/DescribeAutoPredictorCommand";
 import { DescribeDatasetCommandInput, DescribeDatasetCommandOutput } from "./commands/DescribeDatasetCommand";
 import { DescribeDatasetGroupCommandInput, DescribeDatasetGroupCommandOutput } from "./commands/DescribeDatasetGroupCommand";
 import { DescribeDatasetImportJobCommandInput, DescribeDatasetImportJobCommandOutput } from "./commands/DescribeDatasetImportJobCommand";
+import { DescribeExplainabilityCommandInput, DescribeExplainabilityCommandOutput } from "./commands/DescribeExplainabilityCommand";
+import { DescribeExplainabilityExportCommandInput, DescribeExplainabilityExportCommandOutput } from "./commands/DescribeExplainabilityExportCommand";
 import { DescribeForecastCommandInput, DescribeForecastCommandOutput } from "./commands/DescribeForecastCommand";
 import { DescribeForecastExportJobCommandInput, DescribeForecastExportJobCommandOutput } from "./commands/DescribeForecastExportJobCommand";
 import { DescribePredictorBacktestExportJobCommandInput, DescribePredictorBacktestExportJobCommandOutput } from "./commands/DescribePredictorBacktestExportJobCommand";
@@ -32,6 +40,8 @@ import { GetAccuracyMetricsCommandInput, GetAccuracyMetricsCommandOutput } from
 import { ListDatasetGroupsCommandInput, ListDatasetGroupsCommandOutput } from "./commands/ListDatasetGroupsCommand";
 import { ListDatasetImportJobsCommandInput, ListDatasetImportJobsCommandOutput } from "./commands/ListDatasetImportJobsCommand";
 import { ListDatasetsCommandInput, ListDatasetsCommandOutput } from "./commands/ListDatasetsCommand";
+import { ListExplainabilitiesCommandInput, ListExplainabilitiesCommandOutput } from "./commands/ListExplainabilitiesCommand";
+import { ListExplainabilityExportsCommandInput, ListExplainabilityExportsCommandOutput } from "./commands/ListExplainabilityExportsCommand";
 import { ListForecastExportJobsCommandInput, ListForecastExportJobsCommandOutput } from "./commands/ListForecastExportJobsCommand";
 import { ListForecastsCommandInput, ListForecastsCommandOutput } from "./commands/ListForecastsCommand";
 import { ListPredictorBacktestExportJobsCommandInput, ListPredictorBacktestExportJobsCommandOutput } from "./commands/ListPredictorBacktestExportJobsCommand";
@@ -41,8 +51,8 @@ import { StopResourceCommandInput, StopResourceCommandOutput } from "./commands/
 import { TagResourceCommandInput, TagResourceCommandOutput } from "./commands/TagResourceCommand";
 import { UntagResourceCommandInput, UntagResourceCommandOutput } from "./commands/UntagResourceCommand";
 import { UpdateDatasetGroupCommandInput, UpdateDatasetGroupCommandOutput } from "./commands/UpdateDatasetGroupCommand";
-export declare type ServiceInputTypes = CreateDatasetCommandInput | CreateDatasetGroupCommandInput | CreateDatasetImportJobCommandInput | CreateForecastCommandInput | CreateForecastExportJobCommandInput | CreatePredictorBacktestExportJobCommandInput | CreatePredictorCommandInput | DeleteDatasetCommandInput | DeleteDatasetGroupCommandInput | DeleteDatasetImportJobCommandInput | DeleteForecastCommandInput | DeleteForecastExportJobCommandInput | DeletePredictorBacktestExportJobCommandInput | DeletePredictorCommandInput | DeleteResourceTreeCommandInput | DescribeDatasetCommandInput | DescribeDatasetGroupCommandInput | DescribeDatasetImportJobCommandInput | DescribeForecastCommandInput | DescribeForecastExportJobCommandInput | DescribePredictorBacktestExportJobCommandInput | DescribePredictorCommandInput | GetAccuracyMetricsCommandInput | ListDatasetGroupsCommandInput | ListDatasetImportJobsCommandInput | ListDatasetsCommandInput | ListForecastExportJobsCommandInput | ListForecastsCommandInput | ListPredictorBacktestExportJobsCommandInput | ListPredictorsCommandInput | ListTagsForResourceCommandInput | StopResourceCommandInput | TagResourceCommandInput | UntagResourceCommandInput | UpdateDatasetGroupCommandInput;
-export declare type ServiceOutputTypes = CreateDatasetCommandOutput | CreateDatasetGroupCommandOutput | CreateDatasetImportJobCommandOutput | CreateForecastCommandOutput | CreateForecastExportJobCommandOutput | CreatePredictorBacktestExportJobCommandOutput | CreatePredictorCommandOutput | DeleteDatasetCommandOutput | DeleteDatasetGroupCommandOutput | DeleteDatasetImportJobCommandOutput | DeleteForecastCommandOutput | DeleteForecastExportJobCommandOutput | DeletePredictorBacktestExportJobCommandOutput | DeletePredictorCommandOutput | DeleteResourceTreeCommandOutput | DescribeDatasetCommandOutput | DescribeDatasetGroupCommandOutput | DescribeDatasetImportJobCommandOutput | DescribeForecastCommandOutput | DescribeForecastExportJobCommandOutput | DescribePredictorBacktestExportJobCommandOutput | DescribePredictorCommandOutput | GetAccuracyMetricsCommandOutput | ListDatasetGroupsCommandOutput | ListDatasetImportJobsCommandOutput | ListDatasetsCommandOutput | ListForecastExportJobsCommandOutput | ListForecastsCommandOutput | ListPredictorBacktestExportJobsCommandOutput | ListPredictorsCommandOutput | ListTagsForResourceCommandOutput | StopResourceCommandOutput | TagResourceCommandOutput | UntagResourceCommandOutput | UpdateDatasetGroupCommandOutput;
+export declare type ServiceInputTypes = CreateAutoPredictorCommandInput | CreateDatasetCommandInput | CreateDatasetGroupCommandInput | CreateDatasetImportJobCommandInput | CreateExplainabilityCommandInput | CreateExplainabilityExportCommandInput | CreateForecastCommandInput | CreateForecastExportJobCommandInput | CreatePredictorBacktestExportJobCommandInput | CreatePredictorCommandInput | DeleteDatasetCommandInput | DeleteDatasetGroupCommandInput | DeleteDatasetImportJobCommandInput | DeleteExplainabilityCommandInput | DeleteExplainabilityExportCommandInput | DeleteForecastCommandInput | DeleteForecastExportJobCommandInput | DeletePredictorBacktestExportJobCommandInput | DeletePredictorCommandInput | DeleteResourceTreeCommandInput | DescribeAutoPredictorCommandInput | DescribeDatasetCommandInput | DescribeDatasetGroupCommandInput | DescribeDatasetImportJobCommandInput | DescribeExplainabilityCommandInput | DescribeExplainabilityExportCommandInput | DescribeForecastCommandInput | DescribeForecastExportJobCommandInput | DescribePredictorBacktestExportJobCommandInput | DescribePredictorCommandInput | GetAccuracyMetricsCommandInput | ListDatasetGroupsCommandInput | ListDatasetImportJobsCommandInput | ListDatasetsCommandInput | ListExplainabilitiesCommandInput | ListExplainabilityExportsCommandInput | ListForecastExportJobsCommandInput | ListForecastsCommandInput | ListPredictorBacktestExportJobsCommandInput | ListPredictorsCommandInput | ListTagsForResourceCommandInput | StopResourceCommandInput | TagResourceCommandInput | UntagResourceCommandInput | UpdateDatasetGroupCommandInput;
+export declare type ServiceOutputTypes = CreateAutoPredictorCommandOutput | CreateDatasetCommandOutput | CreateDatasetGroupCommandOutput | CreateDatasetImportJobCommandOutput | CreateExplainabilityCommandOutput | CreateExplainabilityExportCommandOutput | CreateForecastCommandOutput | CreateForecastExportJobCommandOutput | CreatePredictorBacktestExportJobCommandOutput | CreatePredictorCommandOutput | DeleteDatasetCommandOutput | DeleteDatasetGroupCommandOutput | DeleteDatasetImportJobCommandOutput | DeleteExplainabilityCommandOutput | DeleteExplainabilityExportCommandOutput | DeleteForecastCommandOutput | DeleteForecastExportJobCommandOutput | DeletePredictorBacktestExportJobCommandOutput | DeletePredictorCommandOutput | DeleteResourceTreeCommandOutput | DescribeAutoPredictorCommandOutput | DescribeDatasetCommandOutput | DescribeDatasetGroupCommandOutput | DescribeDatasetImportJobCommandOutput | DescribeExplainabilityCommandOutput | DescribeExplainabilityExportCommandOutput | DescribeForecastCommandOutput | DescribeForecastExportJobCommandOutput | DescribePredictorBacktestExportJobCommandOutput | DescribePredictorCommandOutput | GetAccuracyMetricsCommandOutput | ListDatasetGroupsCommandOutput | ListDatasetImportJobsCommandOutput | ListDatasetsCommandOutput | ListExplainabilitiesCommandOutput | ListExplainabilityExportsCommandOutput | ListForecastExportJobsCommandOutput | ListForecastsCommandOutput | ListPredictorBacktestExportJobsCommandOutput | ListPredictorsCommandOutput | ListTagsForResourceCommandOutput | StopResourceCommandOutput | TagResourceCommandOutput | UntagResourceCommandOutput | UpdateDatasetGroupCommandOutput;
 export interface ClientDefaults extends Partial<__SmithyResolvedConfiguration<__HttpHandlerOptions>> {
     /**
      * The HTTP handler to use. Fetch in browser and Https in Nodejs.

package/dist-types/commands/CreateAutoPredictorCommand.d.ts

@@ -0,0 +1,83 @@
+import { Command as $Command } from "@aws-sdk/smithy-client";
+import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer, MiddlewareStack } from "@aws-sdk/types";
+import { ForecastClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ForecastClient";
+import { CreateAutoPredictorRequest, CreateAutoPredictorResponse } from "../models/models_0";
+export interface CreateAutoPredictorCommandInput extends CreateAutoPredictorRequest {
+}
+export interface CreateAutoPredictorCommandOutput extends CreateAutoPredictorResponse, __MetadataBearer {
+}
+/**
+ * <p>Creates an Amazon Forecast predictor.</p>
+ *         <p>Amazon Forecast creates predictors with AutoPredictor, which involves applying the
+ *             optimal combination of algorithms to each time series in your datasets. You can use
+ *             CreateAutoPredictor to create new predictors or upgrade/retrain existing
+ *             predictors.</p>
+ *         <p>
+ *             <b>Creating new predictors</b>
+ *          </p>
+ *         <p>The following parameters are required when creating a new predictor:</p>
+ *         <ul>
+ *             <li>
+ *                 <p>
+ *                   <code>PredictorName</code> - A unique name for the predictor.</p>
+ *             </li>
+ *             <li>
+ *                 <p>
+ *                   <code>DatasetGroupArn</code> - The ARN of the dataset group used to train the
+ *                     predictor.</p>
+ *             </li>
+ *             <li>
+ *                 <p>
+ *                   <code>ForecastFrequency</code> - The granularity of your forecasts (hourly,
+ *                     daily, weekly, etc).</p>
+ *             </li>
+ *             <li>
+ *                 <p>
+ *                   <code>ForecastHorizon</code> - The number of time steps being
+ *                     forecasted.</p>
+ *             </li>
+ *          </ul>
+ *         <p>When creating a new predictor, do not specify a value for
+ *                 <code>ReferencePredictorArn</code>.</p>
+ *         <p>
+ *             <b>Upgrading and retraining predictors</b>
+ *          </p>
+ *         <p>The following parameters are required when retraining or upgrading a predictor:</p>
+ *         <ul>
+ *             <li>
+ *                 <p>
+ *                   <code>PredictorName</code> - A unique name for the predictor.</p>
+ *             </li>
+ *             <li>
+ *                 <p>
+ *                   <code>ReferencePredictorArn</code> - The ARN of the predictor to retrain or
+ *                     upgrade.</p>
+ *             </li>
+ *          </ul>
+ *         <p>When upgrading or retraining a predictor, only specify values for the
+ *                 <code>ReferencePredictorArn</code> and <code>PredictorName</code>. </p>
+ * @example
+ * Use a bare-bones client and the command you need to make an API call.
+ * ```javascript
+ * import { ForecastClient, CreateAutoPredictorCommand } from "@aws-sdk/client-forecast"; // ES Modules import
+ * // const { ForecastClient, CreateAutoPredictorCommand } = require("@aws-sdk/client-forecast"); // CommonJS import
+ * const client = new ForecastClient(config);
+ * const command = new CreateAutoPredictorCommand(input);
+ * const response = await client.send(command);
+ * ```
+ *
+ * @see {@link CreateAutoPredictorCommandInput} for command's `input` shape.
+ * @see {@link CreateAutoPredictorCommandOutput} for command's `response` shape.
+ * @see {@link ForecastClientResolvedConfig | config} for ForecastClient's `config` shape.
+ *
+ */
+export declare class CreateAutoPredictorCommand extends $Command<CreateAutoPredictorCommandInput, CreateAutoPredictorCommandOutput, ForecastClientResolvedConfig> {
+    readonly input: CreateAutoPredictorCommandInput;
+    constructor(input: CreateAutoPredictorCommandInput);
+    /**
+     * @internal
+     */
+    resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: ForecastClientResolvedConfig, options?: __HttpHandlerOptions): Handler<CreateAutoPredictorCommandInput, CreateAutoPredictorCommandOutput>;
+    private serialize;
+    private deserialize;
+}