feat(client-forecast): Added Format field to Import and Export APIs in Amazon Forecast. Added TimeSeriesSelector to Create Forecast API.

Author: awstools

clients/client-forecast/src/Forecast.ts

@@ -462,18 +462,14 @@ export class Forecast extends ForecastClient {
    *       AWS Identity and Access Management (IAM) role that Amazon Forecast can assume to access the data, as Amazon Forecast makes a copy
    *       of your data and processes it in an internal AWS system. For more information, see <a href="https://docs.aws.amazon.com/forecast/latest/dg/aws-forecast-iam-roles.html">Set up
    *         permissions</a>.</p>
-   *          <p>The training data must be in CSV format. The delimiter must be a comma (,).</p>
-   *          <p>You can specify the path to a specific CSV file, the S3 bucket, or to a folder in the S3
+   *          <p>The training data must be in CSV or Parquet format. The delimiter must be a comma (,).</p>
+   *          <p>You can specify the path to a specific file, the S3 bucket, or to a folder in the S3
    *       bucket. For the latter two cases, Amazon Forecast imports all files up to the limit of 10,000
    *       files.</p>
-   *
-   *
    *          <p>Because dataset imports are not aggregated, your most recent dataset import is the one
    *       that is used when training a predictor or generating a forecast. Make sure that your most
    *       recent dataset import contains all of the data you want to model off of, and not just the new
    *       data collected since the previous import.</p>
-   *
-   *
    *          <p>To get a list of all your dataset import jobs, filtered by specified criteria, use the
    *         <a href="https://docs.aws.amazon.com/forecast/latest/dg/API_ListDatasetImportJobs.html">ListDatasetImportJobs</a> operation.</p>
    */
@@ -716,6 +712,8 @@ export class Forecast extends ForecastClient {
    *         or export the forecast. Use the <a>DescribeForecast</a> operation to get the
    *         status.</p>
    *          </note>
+   *          <p>By default, a forecast includes predictions for every item (<code>item_id</code>) in the dataset group that was used to train the predictor.
+   *       However, you can use the <code>TimeSeriesSelector</code> object to generate a forecast on a subset of time series. Forecast creation is skipped for any time series that you specify that are not in the input dataset. The forecast export file will not contain these time series or their forecasted values.</p>
    */
   public createForecast(
     args: CreateForecastCommandInput,
@@ -921,7 +919,7 @@ export class Forecast extends ForecastClient {
 
   /**
    * <p>Exports backtest forecasts and accuracy metrics generated by the <a>CreateAutoPredictor</a> or <a>CreatePredictor</a> operations. Two
-   *             folders containing CSV files are exported to your specified S3 bucket.</p>
+   *             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>
    *             <code><ExportJobName>_<ExportTimestamp>_<PartNumber>.csv</code>

clients/client-forecast/src/commands/CreateDatasetImportJobCommand.ts

@@ -30,18 +30,14 @@ export interface CreateDatasetImportJobCommandOutput extends CreateDatasetImport
  *       AWS Identity and Access Management (IAM) role that Amazon Forecast can assume to access the data, as Amazon Forecast makes a copy
  *       of your data and processes it in an internal AWS system. For more information, see <a href="https://docs.aws.amazon.com/forecast/latest/dg/aws-forecast-iam-roles.html">Set up
  *         permissions</a>.</p>
- *          <p>The training data must be in CSV format. The delimiter must be a comma (,).</p>
- *          <p>You can specify the path to a specific CSV file, the S3 bucket, or to a folder in the S3
+ *          <p>The training data must be in CSV or Parquet format. The delimiter must be a comma (,).</p>
+ *          <p>You can specify the path to a specific file, the S3 bucket, or to a folder in the S3
  *       bucket. For the latter two cases, Amazon Forecast imports all files up to the limit of 10,000
  *       files.</p>
- *
- *
  *          <p>Because dataset imports are not aggregated, your most recent dataset import is the one
  *       that is used when training a predictor or generating a forecast. Make sure that your most
  *       recent dataset import contains all of the data you want to model off of, and not just the new
  *       data collected since the previous import.</p>
- *
- *
  *          <p>To get a list of all your dataset import jobs, filtered by specified criteria, use the
  *         <a href="https://docs.aws.amazon.com/forecast/latest/dg/API_ListDatasetImportJobs.html">ListDatasetImportJobs</a> operation.</p>
  * @example

clients/client-forecast/src/commands/CreateForecastCommand.ts

@@ -42,6 +42,8 @@ export interface CreateForecastCommandOutput extends CreateForecastResponse, __M
  *         or export the forecast. Use the <a>DescribeForecast</a> operation to get the
  *         status.</p>
  *          </note>
+ *          <p>By default, a forecast includes predictions for every item (<code>item_id</code>) in the dataset group that was used to train the predictor.
+ *       However, you can use the <code>TimeSeriesSelector</code> object to generate a forecast on a subset of time series. Forecast creation is skipped for any time series that you specify that are not in the input dataset. The forecast export file will not contain these time series or their forecasted values.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript

clients/client-forecast/src/commands/CreatePredictorBacktestExportJobCommand.ts

@@ -26,7 +26,7 @@ export interface CreatePredictorBacktestExportJobCommandOutput
 
 /**
  * <p>Exports backtest forecasts and accuracy metrics generated by the <a>CreateAutoPredictor</a> or <a>CreatePredictor</a> operations. Two
- *             folders containing CSV files are exported to your specified S3 bucket.</p>
+ *             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>
  *             <code><ExportJobName>_<ExportTimestamp>_<PartNumber>.csv</code>

clients/client-forecast/src/models/models_0.ts

@@ -1284,6 +1284,11 @@ export interface CreateDatasetImportJobRequest {
    *          </ul>
    */
   Tags?: Tag[];
+
+  /**
+   * <p>The format of the imported data, CSV or PARQUET. The default value is CSV.</p>
+   */
+  Format?: string;
 }
 
 export namespace CreateDatasetImportJobRequest {
@@ -1338,7 +1343,7 @@ export interface ExplainabilityConfig {
    * <p>To create an Explainability for all time series in your datasets, use
    *             <code>ALL</code>. To create an Explainability for specific time series in your datasets,
    *             use <code>SPECIFIC</code>.</p>
-   *         <p>Specify time series by uploading a CSV file to an Amazon S3 bucket and set the location
+   *         <p>Specify time series by uploading a CSV or Parquet file to an Amazon S3 bucket and set the location
    *             within the <a>DataDestination</a> data type.</p>
    */
   TimeSeriesGranularity: TimeSeriesGranularity | string | undefined;
@@ -1548,6 +1553,11 @@ export interface CreateExplainabilityExportRequest {
    *          </ul>
    */
   Tags?: Tag[];
+
+  /**
+   * <p>The format of the exported data, CSV or PARQUET.</p>
+   */
+  Format?: string;
 }
 
 export namespace CreateExplainabilityExportRequest {
@@ -1576,6 +1586,73 @@ export namespace CreateExplainabilityExportResponse {
   });
 }
 
+/**
+ * <p>Details about the import file that contains the time series for which you want to create forecasts.</p>
+ */
+export interface TimeSeriesIdentifiers {
+  /**
+   * <p>The source of your data, an AWS Identity and Access Management (IAM) role that allows Amazon Forecast to
+   *       access the data and, optionally, an AWS Key Management Service (KMS) key.</p>
+   */
+  DataSource?: DataSource;
+
+  /**
+   * <p>Defines the fields of a dataset.</p>
+   */
+  Schema?: Schema;
+
+  /**
+   * <p>The format of the data, either CSV or PARQUET.</p>
+   */
+  Format?: string;
+}
+
+export namespace TimeSeriesIdentifiers {
+  /**
+   * @internal
+   */
+  export const filterSensitiveLog = (obj: TimeSeriesIdentifiers): any => ({
+    ...obj,
+  });
+}
+
+/**
+ * <p>Defines the set of time series that are used to create the forecasts in a <code>TimeSeriesIdentifiers</code> object.</p>
+ *          <p>The <code>TimeSeriesIdentifiers</code> object needs the following information:</p>
+ *          <ul>
+ *             <li>
+ *                <p>
+ *                   <code>DataSource</code>
+ *                </p>
+ *             </li>
+ *             <li>
+ *                <p>
+ *                   <code>Format</code>
+ *                </p>
+ *             </li>
+ *             <li>
+ *                <p>
+ *                   <code>Schema</code>
+ *                </p>
+ *             </li>
+ *          </ul>
+ */
+export interface TimeSeriesSelector {
+  /**
+   * <p>Details about the import file that contains the time series for which you want to create forecasts.</p>
+   */
+  TimeSeriesIdentifiers?: TimeSeriesIdentifiers;
+}
+
+export namespace TimeSeriesSelector {
+  /**
+   * @internal
+   */
+  export const filterSensitiveLog = (obj: TimeSeriesSelector): any => ({
+    ...obj,
+  });
+}
+
 export interface CreateForecastRequest {
   /**
    * <p>A name for the forecast.</p>
@@ -1638,6 +1715,29 @@ export interface CreateForecastRequest {
    *          </ul>
    */
   Tags?: Tag[];
+
+  /**
+   * <p>Defines the set of time series that are used to create the forecasts in a <code>TimeSeriesIdentifiers</code> object.</p>
+   *          <p>The <code>TimeSeriesIdentifiers</code> object needs the following information:</p>
+   *          <ul>
+   *             <li>
+   *                <p>
+   *                   <code>DataSource</code>
+   *                </p>
+   *             </li>
+   *             <li>
+   *                <p>
+   *                   <code>Format</code>
+   *                </p>
+   *             </li>
+   *             <li>
+   *                <p>
+   *                   <code>Schema</code>
+   *                </p>
+   *             </li>
+   *          </ul>
+   */
+  TimeSeriesSelector?: TimeSeriesSelector;
 }
 
 export namespace CreateForecastRequest {
@@ -1725,6 +1825,11 @@ export interface CreateForecastExportJobRequest {
    *          </ul>
    */
   Tags?: Tag[];
+
+  /**
+   * <p>The format of the exported data, CSV or PARQUET. The default value is CSV.</p>
+   */
+  Format?: string;
 }
 
 export namespace CreateForecastExportJobRequest {
@@ -2831,6 +2936,11 @@ export interface CreatePredictorBacktestExportJobRequest {
    *          </ul>
    */
   Tags?: Tag[];
+
+  /**
+   * <p>The format of the exported data, CSV or PARQUET. The default value is CSV.</p>
+   */
+  Format?: string;
 }
 
 export namespace CreatePredictorBacktestExportJobRequest {
@@ -3803,6 +3913,11 @@ export interface DescribeDatasetImportJobResponse {
    *          </ul>
    */
   LastModificationTime?: Date;
+
+  /**
+   * <p>The format of the imported data, CSV or PARQUET.</p>
+   */
+  Format?: string;
 }
 
 export namespace DescribeDatasetImportJobResponse {
@@ -3993,7 +4108,7 @@ export interface DescribeExplainabilityExportResponse {
   ExplainabilityExportName?: string;
 
   /**
-   * <p>The Amazon Resource Name (ARN) of the Explainability.</p>
+   * <p>The Amazon Resource Name (ARN) of the Explainability export.</p>
    */
   ExplainabilityArn?: string;
 
@@ -4070,6 +4185,11 @@ export interface DescribeExplainabilityExportResponse {
    *          </ul>
    */
   LastModificationTime?: Date;
+
+  /**
+   * <p>The format of the exported data, CSV or PARQUET.</p>
+   */
+  Format?: string;
 }
 
 export namespace DescribeExplainabilityExportResponse {
@@ -4198,6 +4318,11 @@ export interface DescribeForecastResponse {
    *          </ul>
    */
   LastModificationTime?: Date;
+
+  /**
+   * <p>The time series to include in the forecast.</p>
+   */
+  TimeSeriesSelector?: TimeSeriesSelector;
 }
 
 export namespace DescribeForecastResponse {
@@ -4316,6 +4441,11 @@ export interface DescribeForecastExportJobResponse {
    *          </ul>
    */
   LastModificationTime?: Date;
+
+  /**
+   * <p>The format of the exported data, CSV or PARQUET.</p>
+   */
+  Format?: string;
 }
 
 export namespace DescribeForecastExportJobResponse {
@@ -4895,6 +5025,11 @@ export interface DescribePredictorBacktestExportJobResponse {
    *          </ul>
    */
   LastModificationTime?: Date;
+
+  /**
+   * <p>The format of the exported data, CSV or PARQUET.</p>
+   */
+  Format?: string;
 }
 
 export namespace DescribePredictorBacktestExportJobResponse {