@aws-sdk/client-forecast 3.262.0 → 3.263.0

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

@@ -11,118 +11,118 @@ export interface CreateExplainabilityCommandOutput extends CreateExplainabilityR
  * <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
+ *          </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
+ *          <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
+ *          <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>
+ *          <p>
  *             <b>CreateExplainability with a Predictor ARN</b>
- *         </p>
- *         <note>
+ *          </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>
+ *          </note>
+ *          <p>The following parameters are required when providing a Predictor ARN:</p>
+ *          <ul>
  *             <li>
- *                 <p>
+ *                <p>
  *                   <code>ExplainabilityName</code> - A unique name for the Explainability.</p>
  *             </li>
  *             <li>
- *                 <p>
+ *                <p>
  *                   <code>ResourceArn</code> - The Arn of the predictor.</p>
  *             </li>
  *             <li>
- *                 <p>
+ *                <p>
  *                   <code>TimePointGranularity</code> - Must be set to “ALL”.</p>
  *             </li>
  *             <li>
- *                 <p>
+ *                <p>
  *                   <code>TimeSeriesGranularity</code> - Must be set to “ALL”.</p>
  *             </li>
  *          </ul>
- *         <p>Do not specify a value for the following parameters:</p>
- *         <ul>
+ *          <p>Do not specify a value for the following parameters:</p>
+ *          <ul>
  *             <li>
- *                 <p>
+ *                <p>
  *                   <code>DataSource</code> - Only valid when TimeSeriesGranularity is
  *                     “SPECIFIC”.</p>
  *             </li>
  *             <li>
- *                 <p>
+ *                <p>
  *                   <code>Schema</code> - Only valid when TimeSeriesGranularity is
  *                     “SPECIFIC”.</p>
  *             </li>
  *             <li>
- *                 <p>
+ *                <p>
  *                   <code>StartDateTime</code> - Only valid when TimePointGranularity is
  *                     “SPECIFIC”.</p>
  *             </li>
  *             <li>
- *                 <p>
+ *                <p>
  *                   <code>EndDateTime</code> - Only valid when TimePointGranularity is
  *                     “SPECIFIC”.</p>
  *             </li>
  *          </ul>
- *         <p>
+ *          <p>
  *             <b>CreateExplainability with a Forecast ARN</b>
- *         </p>
- *         <note>
+ *          </p>
+ *          <note>
  *             <p>You can specify a maximum of 50 time series and 500 time points.</p>
- *         </note>
- *         <p>The following parameters are required when providing a Predictor ARN:</p>
- *         <ul>
+ *          </note>
+ *          <p>The following parameters are required when providing a Predictor ARN:</p>
+ *          <ul>
  *             <li>
- *                 <p>
+ *                <p>
  *                   <code>ExplainabilityName</code> - A unique name for the Explainability.</p>
  *             </li>
  *             <li>
- *                 <p>
+ *                <p>
  *                   <code>ResourceArn</code> - The Arn of the forecast.</p>
  *             </li>
  *             <li>
- *                 <p>
+ *                <p>
  *                   <code>TimePointGranularity</code> - Either “ALL” or “SPECIFIC”.</p>
  *             </li>
  *             <li>
- *                 <p>
+ *                <p>
  *                   <code>TimeSeriesGranularity</code> - Either “ALL” or “SPECIFIC”.</p>
  *             </li>
  *          </ul>
- *         <p>If you set TimeSeriesGranularity to “SPECIFIC”, you must also provide the
+ *          <p>If you set TimeSeriesGranularity to “SPECIFIC”, you must also provide the
  *             following:</p>
- *         <ul>
+ *          <ul>
  *             <li>
- *                 <p>
+ *                <p>
  *                   <code>DataSource</code> - The S3 location of the CSV file specifying your time
  *                     series.</p>
  *             </li>
  *             <li>
- *                 <p>
+ *                <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
+ *          <p>If you set TimePointGranularity to “SPECIFIC”, you must also provide the
  *             following:</p>
- *         <ul>
+ *          <ul>
  *             <li>
- *                 <p>
+ *                <p>
  *                   <code>StartDateTime</code> - The first timestamp in the range of time
  *                     points.</p>
  *             </li>
  *             <li>
- *                 <p>
+ *                <p>
  *                   <code>EndDateTime</code> - The last timestamp in the range of time
  *                     points.</p>
  *             </li>

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

@@ -10,13 +10,13 @@ export interface CreateExplainabilityExportCommandOutput extends CreateExplainab
 /**
  * <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
+ *          <p>You must specify a <a>DataDestination</a> object that includes an Amazon S3
+ *             bucket and an 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>
+ *          <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>
+ *          </note>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript

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

@@ -13,7 +13,7 @@ export interface CreateForecastExportJobCommandOutput extends CreateForecastExpo
  *          <p><ForecastExportJobName>_<ExportTimestamp>_<PartNumber></p>
  *          <p>where the <ExportTimestamp> component is in Java SimpleDateFormat
  *       (yyyy-MM-ddTHH-mm-ssZ).</p>
- *          <p>You must specify a <a>DataDestination</a> object that includes an AWS Identity and Access Management
+ *          <p>You must specify a <a>DataDestination</a> object that includes an 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>
  *          <p>For more information, see <a>howitworks-forecast</a>.</p>

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

@@ -10,19 +10,19 @@ export interface CreatePredictorBacktestExportJobCommandOutput extends CreatePre
 /**
  * <p>Exports backtest forecasts and accuracy metrics generated by the <a>CreateAutoPredictor</a> or <a>CreatePredictor</a> operations. Two
  *             folders containing CSV or Parquet files are exported to your specified S3 bucket.</p>
- *         <p> The export file names will match the following conventions:</p>
- *         <p>
+ *          <p> The export file names will match the following conventions:</p>
+ *          <p>
  *             <code><ExportJobName>_<ExportTimestamp>_<PartNumber>.csv</code>
  *          </p>
- *         <p>The <ExportTimestamp> component is in Java SimpleDate format
+ *          <p>The <ExportTimestamp> component is in Java SimpleDate format
  *             (yyyy-MM-ddTHH-mm-ssZ).</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
+ *          <p>You must specify a <a>DataDestination</a> object that includes an Amazon S3
+ *             bucket and an 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>
+ *          <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>DescribePredictorBacktestExportJob</a> operation.</p>
- *         </note>
+ *          </note>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript

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

@@ -61,9 +61,6 @@ export interface CreatePredictorCommandOutput extends CreatePredictorResponse, _
  *                </p>
  *             </li>
  *          </ul>
- *
- *
- *
  *          <p>To get a list of all of your predictors, use the <a>ListPredictors</a>
  *       operation.</p>
  *          <note>

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

@@ -12,12 +12,13 @@ export interface CreateWhatIfAnalysisCommandOutput extends CreateWhatIfAnalysisR
  *       compare the forecasts generated by these changes against the baseline, unchanged time series. It is important to
  *       remember that the purpose of a what-if analysis is to understand how a forecast can change given different
  *       modifications to the baseline time series.</p>
- *          <p>For example, imagine you are a clothing retailer who is considering an end of season sale to clear space for
- *       new styles. After creating a baseline forecast, you can use a what-if analysis to investigate how different sales
- *       tactics might affect your goals. You could create a scenario where everything is given a 25% markdown and another
- *       where everything is given a fixed dollar markdown. You can create a scenario where the sale lasts for 1 week and
- *       another where the sale lasts for 1 month. Your what-if analysis enables you to compare many different scenarios
- *       against each other.</p>
+ *          <p>For example, imagine you are a clothing retailer who is considering an end of season sale
+ *       to clear space for new styles. After creating a baseline forecast, you can use a what-if
+ *       analysis to investigate how different sales tactics might affect your goals.</p>
+ *          <p>You could create a scenario where everything is given a 25% markdown, and another where
+ *       everything is given a fixed dollar markdown. You could create a scenario where the sale lasts for one week and
+ *       another where the sale lasts for one month.
+ *       With a what-if analysis, you can compare many different scenarios against each other.</p>
  *          <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>
  *          <p>The <a>TimeSeriesSelector</a> object defines the items that you want in the what-if analysis.</p>
  * @example

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

@@ -15,7 +15,7 @@ export interface CreateWhatIfForecastExportCommandOutput extends CreateWhatIfFor
  *          </p>
  *          <p>The <ExportTimestamp> component is in Java SimpleDateFormat
  *       (yyyy-MM-ddTHH-mm-ssZ).</p>
- *          <p>You must specify a <a>DataDestination</a> object that includes an AWS Identity and Access Management
+ *          <p>You must specify a <a>DataDestination</a> object that includes an 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>
  *          <p>For more information, see <a>howitworks-forecast</a>.</p>

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

@@ -9,7 +9,7 @@ export interface DeleteExplainabilityCommandOutput extends __MetadataBearer {
 }
 /**
  * <p>Deletes an Explainability resource.</p>
- *         <p>You can delete only predictor that have a status of <code>ACTIVE</code> or
+ *          <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>
  * @example
  * Use a bare-bones client and the command you need to make an API call.

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

@@ -10,36 +10,35 @@ export interface DeleteResourceTreeCommandOutput extends __MetadataBearer {
 /**
  * <p>Deletes an entire resource tree. This operation will delete the parent resource and
  *             its child resources.</p>
- *         <p>Child resources are resources that were created from another resource. For example,
+ *          <p>Child resources are resources that were created from another resource. For example,
  *             when a forecast is generated from a predictor, the forecast is the child resource and
  *             the predictor is the parent resource.</p>
- *         <p>Amazon Forecast resources possess the following parent-child resource hierarchies:</p>
- *
- *         <ul>
+ *          <p>Amazon Forecast resources possess the following parent-child resource hierarchies:</p>
+ *          <ul>
  *             <li>
- *                 <p>
+ *                <p>
  *                   <b>Dataset</b>: dataset import jobs</p>
  *             </li>
  *             <li>
- *                 <p>
+ *                <p>
  *                   <b>Dataset Group</b>: predictors, predictor backtest
  *                     export jobs, forecasts, forecast export jobs</p>
  *             </li>
  *             <li>
- *                 <p>
+ *                <p>
  *                   <b>Predictor</b>: predictor backtest export jobs,
  *                     forecasts, forecast export jobs</p>
  *             </li>
  *             <li>
- *                 <p>
+ *                <p>
  *                   <b>Forecast</b>: forecast export jobs</p>
  *             </li>
  *          </ul>
- *         <note>
+ *          <note>
  *             <p>
  *                <code>DeleteResourceTree</code> will only delete Amazon Forecast resources, and will not
  *                 delete datasets or exported files stored in Amazon S3. </p>
- *         </note>
+ *          </note>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript

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

@@ -9,27 +9,27 @@ export interface DescribePredictorBacktestExportJobCommandOutput extends Describ
 }
 /**
  * <p>Describes a predictor backtest export job created using the <a>CreatePredictorBacktestExportJob</a> operation.</p>
- *         <p>In addition to listing the properties provided by the user in the
+ *          <p>In addition to listing the properties provided by the user in the
  *                 <code>CreatePredictorBacktestExportJob</code> request, this operation lists the
  *             following properties:</p>
- *         <ul>
+ *          <ul>
  *             <li>
- *                 <p>
- *                     <code>CreationTime</code>
- *                 </p>
+ *                <p>
+ *                   <code>CreationTime</code>
+ *                </p>
  *             </li>
  *             <li>
- *                 <p>
- *                     <code>LastModificationTime</code>
- *                 </p>
+ *                <p>
+ *                   <code>LastModificationTime</code>
+ *                </p>
  *             </li>
  *             <li>
- *                 <p>
- *                     <code>Status</code>
- *                 </p>
+ *                <p>
+ *                   <code>Status</code>
+ *                </p>
  *             </li>
  *             <li>
- *                 <p>
+ *                <p>
  *                   <code>Message</code> (if an error occurred)</p>
  *             </li>
  *          </ul>

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

@@ -20,7 +20,6 @@ export interface GetAccuracyMetricsCommandOutput extends GetAccuracyMetricsRespo
  *       metrics. If you want all items to contribute, specify <code>zero</code>. If you want only
  *       those items that have complete data in the range being evaluated to contribute, specify
  *         <code>nan</code>. For more information, see <a>FeaturizationMethod</a>.</p>
- *
  *          <note>
  *             <p>Before you can get accuracy metrics, the <code>Status</code> of the predictor must be
  *           <code>ACTIVE</code>, signifying that training has completed. To get the status, use the

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

@@ -11,7 +11,7 @@ export interface ListExplainabilitiesCommandOutput extends ListExplainabilitiesR
  * <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,
+ *          <p>To retrieve the complete set of properties for a particular Explainability resource,
  *             use the ARN with the <a>DescribeExplainability</a> operation.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.

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

@@ -10,7 +10,7 @@ export interface ListExplainabilityExportsCommandOutput extends ListExplainabili
 /**
  * <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
+ *          <p>To retrieve the complete set of properties for a particular Explainability export, use
  *             the ARN with the <a>DescribeExplainability</a> operation.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.

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

@@ -10,7 +10,7 @@ export interface ListPredictorBacktestExportJobsCommandOutput extends ListPredic
 /**
  * <p>Returns a list of predictor backtest export jobs created using the <a>CreatePredictorBacktestExportJob</a> operation. This operation returns a
  *             summary for each backtest export job. 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 backtest export job, use
+ *          <p>To retrieve the complete set of properties for a particular backtest export job, use
  *             the ARN with the <a>DescribePredictorBacktestExportJob</a> operation.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.

package/dist-types/endpoint/EndpointParameters.d.ts

@@ -12,7 +12,7 @@ export declare const resolveClientEndpointParameters: <T>(options: T & ClientInp
     defaultSigningName: string;
 };
 export interface EndpointParameters extends __EndpointParameters {
-    Region?: string;
+    Region: string;
     UseDualStack?: boolean;
     UseFIPS?: boolean;
     Endpoint?: string;