@aws-sdk/client-forecast 3.99.0 → 3.105.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +33 -0
- package/dist-cjs/ForecastClient.js +2 -0
- package/dist-cjs/models/models_0.js +47 -4
- package/dist-cjs/protocols/Aws_json1_1.js +73 -0
- package/dist-es/ForecastClient.js +2 -0
- package/dist-es/models/models_0.js +37 -0
- package/dist-es/protocols/Aws_json1_1.js +68 -12
- package/dist-types/Forecast.d.ts +7 -8
- package/dist-types/commands/CreateDatasetImportJobCommand.d.ts +2 -6
- package/dist-types/commands/CreateForecastCommand.d.ts +2 -0
- package/dist-types/commands/CreatePredictorBacktestExportJobCommand.d.ts +1 -1
- package/dist-types/commands/ListMonitorEvaluationsCommand.d.ts +2 -1
- package/dist-types/models/models_0.d.ts +199 -20
- package/dist-types/ts3.4/models/models_0.d.ts +92 -18
- package/package.json +4 -3
|
@@ -14,18 +14,14 @@ export interface CreateDatasetImportJobCommandOutput extends CreateDatasetImport
|
|
|
14
14
|
* AWS Identity and Access Management (IAM) role that Amazon Forecast can assume to access the data, as Amazon Forecast makes a copy
|
|
15
15
|
* 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
|
|
16
16
|
* permissions</a>.</p>
|
|
17
|
-
* <p>The training data must be in CSV format. The delimiter must be a comma (,).</p>
|
|
18
|
-
* <p>You can specify the path to a specific
|
|
17
|
+
* <p>The training data must be in CSV or Parquet format. The delimiter must be a comma (,).</p>
|
|
18
|
+
* <p>You can specify the path to a specific file, the S3 bucket, or to a folder in the S3
|
|
19
19
|
* bucket. For the latter two cases, Amazon Forecast imports all files up to the limit of 10,000
|
|
20
20
|
* files.</p>
|
|
21
|
-
*
|
|
22
|
-
*
|
|
23
21
|
* <p>Because dataset imports are not aggregated, your most recent dataset import is the one
|
|
24
22
|
* that is used when training a predictor or generating a forecast. Make sure that your most
|
|
25
23
|
* recent dataset import contains all of the data you want to model off of, and not just the new
|
|
26
24
|
* data collected since the previous import.</p>
|
|
27
|
-
*
|
|
28
|
-
*
|
|
29
25
|
* <p>To get a list of all your dataset import jobs, filtered by specified criteria, use the
|
|
30
26
|
* <a href="https://docs.aws.amazon.com/forecast/latest/dg/API_ListDatasetImportJobs.html">ListDatasetImportJobs</a> operation.</p>
|
|
31
27
|
* @example
|
|
@@ -26,6 +26,8 @@ export interface CreateForecastCommandOutput extends CreateForecastResponse, __M
|
|
|
26
26
|
* or export the forecast. Use the <a>DescribeForecast</a> operation to get the
|
|
27
27
|
* status.</p>
|
|
28
28
|
* </note>
|
|
29
|
+
* <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.
|
|
30
|
+
* 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>
|
|
29
31
|
* @example
|
|
30
32
|
* Use a bare-bones client and the command you need to make an API call.
|
|
31
33
|
* ```javascript
|
|
@@ -8,7 +8,7 @@ export interface CreatePredictorBacktestExportJobCommandOutput extends CreatePre
|
|
|
8
8
|
}
|
|
9
9
|
/**
|
|
10
10
|
* <p>Exports backtest forecasts and accuracy metrics generated by the <a>CreateAutoPredictor</a> or <a>CreatePredictor</a> operations. Two
|
|
11
|
-
* folders containing CSV files are exported to your specified S3 bucket.</p>
|
|
11
|
+
* folders containing CSV or Parquet files are exported to your specified S3 bucket.</p>
|
|
12
12
|
* <p> The export file names will match the following conventions:</p>
|
|
13
13
|
* <p>
|
|
14
14
|
* <code><ExportJobName>_<ExportTimestamp>_<PartNumber>.csv</code>
|
|
@@ -9,7 +9,8 @@ export interface ListMonitorEvaluationsCommandOutput extends ListMonitorEvaluati
|
|
|
9
9
|
/**
|
|
10
10
|
* <p>Returns a list of the monitoring evaluation results and predictor events collected by
|
|
11
11
|
* the monitor resource during different windows of time.</p>
|
|
12
|
-
* <p>For information about monitoring see <a
|
|
12
|
+
* <p>For information about monitoring see <a>predictor-monitoring</a>. For
|
|
13
|
+
* more information about retrieving monitoring results see <a href="https://docs.aws.amazon.com/forecast/latest/dg/predictor-monitoring-results.html">Viewing Monitoring Results</a>.</p>
|
|
13
14
|
* @example
|
|
14
15
|
* Use a bare-bones client and the command you need to make an API call.
|
|
15
16
|
* ```javascript
|
|
@@ -241,9 +241,7 @@ export interface AdditionalDataset {
|
|
|
241
241
|
* </li>
|
|
242
242
|
* </ul>
|
|
243
243
|
*/
|
|
244
|
-
Configuration?:
|
|
245
|
-
[key: string]: string[];
|
|
246
|
-
};
|
|
244
|
+
Configuration?: Record<string, string[]>;
|
|
247
245
|
}
|
|
248
246
|
export declare namespace AdditionalDataset {
|
|
249
247
|
/**
|
|
@@ -341,9 +339,7 @@ export interface AttributeConfig {
|
|
|
341
339
|
* parameter. For example, to set backfilling to a value of 2, include the following:
|
|
342
340
|
* <code>"backfill": "value"</code> and <code>"backfill_value":"2"</code>. </p>
|
|
343
341
|
*/
|
|
344
|
-
Transformations:
|
|
345
|
-
[key: string]: string;
|
|
346
|
-
} | undefined;
|
|
342
|
+
Transformations: Record<string, string> | undefined;
|
|
347
343
|
}
|
|
348
344
|
export declare namespace AttributeConfig {
|
|
349
345
|
/**
|
|
@@ -474,6 +470,65 @@ export declare namespace Tag {
|
|
|
474
470
|
*/
|
|
475
471
|
const filterSensitiveLog: (obj: Tag) => any;
|
|
476
472
|
}
|
|
473
|
+
export declare enum DayOfWeek {
|
|
474
|
+
FRIDAY = "FRIDAY",
|
|
475
|
+
MONDAY = "MONDAY",
|
|
476
|
+
SATURDAY = "SATURDAY",
|
|
477
|
+
SUNDAY = "SUNDAY",
|
|
478
|
+
THURSDAY = "THURSDAY",
|
|
479
|
+
TUESDAY = "TUESDAY",
|
|
480
|
+
WEDNESDAY = "WEDNESDAY"
|
|
481
|
+
}
|
|
482
|
+
export declare enum Month {
|
|
483
|
+
APRIL = "APRIL",
|
|
484
|
+
AUGUST = "AUGUST",
|
|
485
|
+
DECEMBER = "DECEMBER",
|
|
486
|
+
FEBRUARY = "FEBRUARY",
|
|
487
|
+
JANUARY = "JANUARY",
|
|
488
|
+
JULY = "JULY",
|
|
489
|
+
JUNE = "JUNE",
|
|
490
|
+
MARCH = "MARCH",
|
|
491
|
+
MAY = "MAY",
|
|
492
|
+
NOVEMBER = "NOVEMBER",
|
|
493
|
+
OCTOBER = "OCTOBER",
|
|
494
|
+
SEPTEMBER = "SEPTEMBER"
|
|
495
|
+
}
|
|
496
|
+
/**
|
|
497
|
+
* <p>The time boundary Forecast uses to align and aggregate your data to match your forecast frequency. Provide the unit of time and the time boundary as a key value pair. If you
|
|
498
|
+
* don't provide a time boundary, Forecast uses a set of <a href="https://docs.aws.amazon.com/forecast/latest/dg/data-aggregation.html#default-time-boundaries">Default Time Boundaries</a>.
|
|
499
|
+
* </p>
|
|
500
|
+
*
|
|
501
|
+
* <p>For more information about aggregation,
|
|
502
|
+
* see <a href="https://docs.aws.amazon.com/forecast/latest/dg/data-aggregation.html">Data Aggregation for Different Forecast Frequencies</a>.
|
|
503
|
+
* For more information setting a custom time boundary,
|
|
504
|
+
* see <a href="https://docs.aws.amazon.com/forecast/latest/dg/data-aggregation.html#specifying-time-boundary">Specifying a Time Boundary</a>.
|
|
505
|
+
*
|
|
506
|
+
* </p>
|
|
507
|
+
*/
|
|
508
|
+
export interface TimeAlignmentBoundary {
|
|
509
|
+
/**
|
|
510
|
+
* <p>The month to use for time alignment during aggregation. The month must be in uppercase.</p>
|
|
511
|
+
*/
|
|
512
|
+
Month?: Month | string;
|
|
513
|
+
/**
|
|
514
|
+
* <p>The day of the month to use for time alignment during aggregation.</p>
|
|
515
|
+
*/
|
|
516
|
+
DayOfMonth?: number;
|
|
517
|
+
/**
|
|
518
|
+
* <p>The day of week to use for time alignment during aggregation. The day must be in uppercase.</p>
|
|
519
|
+
*/
|
|
520
|
+
DayOfWeek?: DayOfWeek | string;
|
|
521
|
+
/**
|
|
522
|
+
* <p>The hour of day to use for time alignment during aggregation.</p>
|
|
523
|
+
*/
|
|
524
|
+
Hour?: number;
|
|
525
|
+
}
|
|
526
|
+
export declare namespace TimeAlignmentBoundary {
|
|
527
|
+
/**
|
|
528
|
+
* @internal
|
|
529
|
+
*/
|
|
530
|
+
const filterSensitiveLog: (obj: TimeAlignmentBoundary) => any;
|
|
531
|
+
}
|
|
477
532
|
export interface CreateAutoPredictorRequest {
|
|
478
533
|
/**
|
|
479
534
|
* <p>A unique name for the predictor</p>
|
|
@@ -584,6 +639,13 @@ export interface CreateAutoPredictorRequest {
|
|
|
584
639
|
* For more information, see <a href="https://docs.aws.amazon.com/forecast/latest/dg/predictor-monitoring.html">Predictor Monitoring</a>.</p>
|
|
585
640
|
*/
|
|
586
641
|
MonitorConfig?: MonitorConfig;
|
|
642
|
+
/**
|
|
643
|
+
* <p>The time boundary Forecast uses to align and aggregate any data that doesn't align with your forecast frequency. Provide the unit of time and the time boundary as a key value pair.
|
|
644
|
+
* For more information on specifying a time boundary, see <a href="https://docs.aws.amazon.com/forecast/latest/dg/data-aggregation.html#specifying-time-boundary">Specifying a Time Boundary</a>.
|
|
645
|
+
* If you
|
|
646
|
+
* don't provide a time boundary, Forecast uses a set of <a href="https://docs.aws.amazon.com/forecast/latest/dg/data-aggregation.html#default-time-boundaries">Default Time Boundaries</a>.</p>
|
|
647
|
+
*/
|
|
648
|
+
TimeAlignmentBoundary?: TimeAlignmentBoundary;
|
|
587
649
|
}
|
|
588
650
|
export declare namespace CreateAutoPredictorRequest {
|
|
589
651
|
/**
|
|
@@ -1055,6 +1117,10 @@ export interface CreateDatasetImportJobRequest {
|
|
|
1055
1117
|
* </ul>
|
|
1056
1118
|
*/
|
|
1057
1119
|
Tags?: Tag[];
|
|
1120
|
+
/**
|
|
1121
|
+
* <p>The format of the imported data, CSV or PARQUET. The default value is CSV.</p>
|
|
1122
|
+
*/
|
|
1123
|
+
Format?: string;
|
|
1058
1124
|
}
|
|
1059
1125
|
export declare namespace CreateDatasetImportJobRequest {
|
|
1060
1126
|
/**
|
|
@@ -1098,7 +1164,7 @@ export interface ExplainabilityConfig {
|
|
|
1098
1164
|
* <p>To create an Explainability for all time series in your datasets, use
|
|
1099
1165
|
* <code>ALL</code>. To create an Explainability for specific time series in your datasets,
|
|
1100
1166
|
* use <code>SPECIFIC</code>.</p>
|
|
1101
|
-
* <p>Specify time series by uploading a CSV file to an Amazon S3 bucket and set the location
|
|
1167
|
+
* <p>Specify time series by uploading a CSV or Parquet file to an Amazon S3 bucket and set the location
|
|
1102
1168
|
* within the <a>DataDestination</a> data type.</p>
|
|
1103
1169
|
*/
|
|
1104
1170
|
TimeSeriesGranularity: TimeSeriesGranularity | string | undefined;
|
|
@@ -1279,6 +1345,10 @@ export interface CreateExplainabilityExportRequest {
|
|
|
1279
1345
|
* </ul>
|
|
1280
1346
|
*/
|
|
1281
1347
|
Tags?: Tag[];
|
|
1348
|
+
/**
|
|
1349
|
+
* <p>The format of the exported data, CSV or PARQUET.</p>
|
|
1350
|
+
*/
|
|
1351
|
+
Format?: string;
|
|
1282
1352
|
}
|
|
1283
1353
|
export declare namespace CreateExplainabilityExportRequest {
|
|
1284
1354
|
/**
|
|
@@ -1298,6 +1368,63 @@ export declare namespace CreateExplainabilityExportResponse {
|
|
|
1298
1368
|
*/
|
|
1299
1369
|
const filterSensitiveLog: (obj: CreateExplainabilityExportResponse) => any;
|
|
1300
1370
|
}
|
|
1371
|
+
/**
|
|
1372
|
+
* <p>Details about the import file that contains the time series for which you want to create forecasts.</p>
|
|
1373
|
+
*/
|
|
1374
|
+
export interface TimeSeriesIdentifiers {
|
|
1375
|
+
/**
|
|
1376
|
+
* <p>The source of your data, an AWS Identity and Access Management (IAM) role that allows Amazon Forecast to
|
|
1377
|
+
* access the data and, optionally, an AWS Key Management Service (KMS) key.</p>
|
|
1378
|
+
*/
|
|
1379
|
+
DataSource?: DataSource;
|
|
1380
|
+
/**
|
|
1381
|
+
* <p>Defines the fields of a dataset.</p>
|
|
1382
|
+
*/
|
|
1383
|
+
Schema?: Schema;
|
|
1384
|
+
/**
|
|
1385
|
+
* <p>The format of the data, either CSV or PARQUET.</p>
|
|
1386
|
+
*/
|
|
1387
|
+
Format?: string;
|
|
1388
|
+
}
|
|
1389
|
+
export declare namespace TimeSeriesIdentifiers {
|
|
1390
|
+
/**
|
|
1391
|
+
* @internal
|
|
1392
|
+
*/
|
|
1393
|
+
const filterSensitiveLog: (obj: TimeSeriesIdentifiers) => any;
|
|
1394
|
+
}
|
|
1395
|
+
/**
|
|
1396
|
+
* <p>Defines the set of time series that are used to create the forecasts in a <code>TimeSeriesIdentifiers</code> object.</p>
|
|
1397
|
+
* <p>The <code>TimeSeriesIdentifiers</code> object needs the following information:</p>
|
|
1398
|
+
* <ul>
|
|
1399
|
+
* <li>
|
|
1400
|
+
* <p>
|
|
1401
|
+
* <code>DataSource</code>
|
|
1402
|
+
* </p>
|
|
1403
|
+
* </li>
|
|
1404
|
+
* <li>
|
|
1405
|
+
* <p>
|
|
1406
|
+
* <code>Format</code>
|
|
1407
|
+
* </p>
|
|
1408
|
+
* </li>
|
|
1409
|
+
* <li>
|
|
1410
|
+
* <p>
|
|
1411
|
+
* <code>Schema</code>
|
|
1412
|
+
* </p>
|
|
1413
|
+
* </li>
|
|
1414
|
+
* </ul>
|
|
1415
|
+
*/
|
|
1416
|
+
export interface TimeSeriesSelector {
|
|
1417
|
+
/**
|
|
1418
|
+
* <p>Details about the import file that contains the time series for which you want to create forecasts.</p>
|
|
1419
|
+
*/
|
|
1420
|
+
TimeSeriesIdentifiers?: TimeSeriesIdentifiers;
|
|
1421
|
+
}
|
|
1422
|
+
export declare namespace TimeSeriesSelector {
|
|
1423
|
+
/**
|
|
1424
|
+
* @internal
|
|
1425
|
+
*/
|
|
1426
|
+
const filterSensitiveLog: (obj: TimeSeriesSelector) => any;
|
|
1427
|
+
}
|
|
1301
1428
|
export interface CreateForecastRequest {
|
|
1302
1429
|
/**
|
|
1303
1430
|
* <p>A name for the forecast.</p>
|
|
@@ -1357,6 +1484,28 @@ export interface CreateForecastRequest {
|
|
|
1357
1484
|
* </ul>
|
|
1358
1485
|
*/
|
|
1359
1486
|
Tags?: Tag[];
|
|
1487
|
+
/**
|
|
1488
|
+
* <p>Defines the set of time series that are used to create the forecasts in a <code>TimeSeriesIdentifiers</code> object.</p>
|
|
1489
|
+
* <p>The <code>TimeSeriesIdentifiers</code> object needs the following information:</p>
|
|
1490
|
+
* <ul>
|
|
1491
|
+
* <li>
|
|
1492
|
+
* <p>
|
|
1493
|
+
* <code>DataSource</code>
|
|
1494
|
+
* </p>
|
|
1495
|
+
* </li>
|
|
1496
|
+
* <li>
|
|
1497
|
+
* <p>
|
|
1498
|
+
* <code>Format</code>
|
|
1499
|
+
* </p>
|
|
1500
|
+
* </li>
|
|
1501
|
+
* <li>
|
|
1502
|
+
* <p>
|
|
1503
|
+
* <code>Schema</code>
|
|
1504
|
+
* </p>
|
|
1505
|
+
* </li>
|
|
1506
|
+
* </ul>
|
|
1507
|
+
*/
|
|
1508
|
+
TimeSeriesSelector?: TimeSeriesSelector;
|
|
1360
1509
|
}
|
|
1361
1510
|
export declare namespace CreateForecastRequest {
|
|
1362
1511
|
/**
|
|
@@ -1432,6 +1581,10 @@ export interface CreateForecastExportJobRequest {
|
|
|
1432
1581
|
* </ul>
|
|
1433
1582
|
*/
|
|
1434
1583
|
Tags?: Tag[];
|
|
1584
|
+
/**
|
|
1585
|
+
* <p>The format of the exported data, CSV or PARQUET. The default value is CSV.</p>
|
|
1586
|
+
*/
|
|
1587
|
+
Format?: string;
|
|
1435
1588
|
}
|
|
1436
1589
|
export declare namespace CreateForecastExportJobRequest {
|
|
1437
1590
|
/**
|
|
@@ -1604,9 +1757,7 @@ export interface FeaturizationMethod {
|
|
|
1604
1757
|
* backfilling to a value of 2, include the following: <code>"backfill": "value"</code> and
|
|
1605
1758
|
* <code>"backfill_value":"2"</code>. </p>
|
|
1606
1759
|
*/
|
|
1607
|
-
FeaturizationMethodParameters?:
|
|
1608
|
-
[key: string]: string;
|
|
1609
|
-
};
|
|
1760
|
+
FeaturizationMethodParameters?: Record<string, string>;
|
|
1610
1761
|
}
|
|
1611
1762
|
export declare namespace FeaturizationMethod {
|
|
1612
1763
|
/**
|
|
@@ -2293,9 +2444,7 @@ export interface CreatePredictorRequest {
|
|
|
2293
2444
|
* override are listed in the individual algorithms. For the list of supported algorithms, see
|
|
2294
2445
|
* <a>aws-forecast-choosing-recipes</a>.</p>
|
|
2295
2446
|
*/
|
|
2296
|
-
TrainingParameters?:
|
|
2297
|
-
[key: string]: string;
|
|
2298
|
-
};
|
|
2447
|
+
TrainingParameters?: Record<string, string>;
|
|
2299
2448
|
/**
|
|
2300
2449
|
* <p>Used to override the default evaluation parameters of the specified algorithm. Amazon Forecast
|
|
2301
2450
|
* evaluates a predictor by splitting a dataset into training data and testing data. The
|
|
@@ -2433,6 +2582,10 @@ export interface CreatePredictorBacktestExportJobRequest {
|
|
|
2433
2582
|
* </ul>
|
|
2434
2583
|
*/
|
|
2435
2584
|
Tags?: Tag[];
|
|
2585
|
+
/**
|
|
2586
|
+
* <p>The format of the exported data, CSV or PARQUET. The default value is CSV.</p>
|
|
2587
|
+
*/
|
|
2588
|
+
Format?: string;
|
|
2436
2589
|
}
|
|
2437
2590
|
export declare namespace CreatePredictorBacktestExportJobRequest {
|
|
2438
2591
|
/**
|
|
@@ -2843,6 +2996,10 @@ export interface DescribeAutoPredictorResponse {
|
|
|
2843
2996
|
* <p>A object with the Amazon Resource Name (ARN) and status of the monitor resource.</p>
|
|
2844
2997
|
*/
|
|
2845
2998
|
MonitorInfo?: MonitorInfo;
|
|
2999
|
+
/**
|
|
3000
|
+
* <p>The time boundary Forecast uses when aggregating data.</p>
|
|
3001
|
+
*/
|
|
3002
|
+
TimeAlignmentBoundary?: TimeAlignmentBoundary;
|
|
2846
3003
|
}
|
|
2847
3004
|
export declare namespace DescribeAutoPredictorResponse {
|
|
2848
3005
|
/**
|
|
@@ -3173,9 +3330,7 @@ export interface DescribeDatasetImportJobResponse {
|
|
|
3173
3330
|
/**
|
|
3174
3331
|
* <p>Statistical information about each field in the input data.</p>
|
|
3175
3332
|
*/
|
|
3176
|
-
FieldStatistics?:
|
|
3177
|
-
[key: string]: Statistics;
|
|
3178
|
-
};
|
|
3333
|
+
FieldStatistics?: Record<string, Statistics>;
|
|
3179
3334
|
/**
|
|
3180
3335
|
* <p>The size of the dataset in gigabytes (GB) after the import job has finished.</p>
|
|
3181
3336
|
*/
|
|
@@ -3244,6 +3399,10 @@ export interface DescribeDatasetImportJobResponse {
|
|
|
3244
3399
|
* </ul>
|
|
3245
3400
|
*/
|
|
3246
3401
|
LastModificationTime?: Date;
|
|
3402
|
+
/**
|
|
3403
|
+
* <p>The format of the imported data, CSV or PARQUET.</p>
|
|
3404
|
+
*/
|
|
3405
|
+
Format?: string;
|
|
3247
3406
|
}
|
|
3248
3407
|
export declare namespace DescribeDatasetImportJobResponse {
|
|
3249
3408
|
/**
|
|
@@ -3403,7 +3562,7 @@ export interface DescribeExplainabilityExportResponse {
|
|
|
3403
3562
|
*/
|
|
3404
3563
|
ExplainabilityExportName?: string;
|
|
3405
3564
|
/**
|
|
3406
|
-
* <p>The Amazon Resource Name (ARN) of the Explainability.</p>
|
|
3565
|
+
* <p>The Amazon Resource Name (ARN) of the Explainability export.</p>
|
|
3407
3566
|
*/
|
|
3408
3567
|
ExplainabilityArn?: string;
|
|
3409
3568
|
/**
|
|
@@ -3475,6 +3634,10 @@ export interface DescribeExplainabilityExportResponse {
|
|
|
3475
3634
|
* </ul>
|
|
3476
3635
|
*/
|
|
3477
3636
|
LastModificationTime?: Date;
|
|
3637
|
+
/**
|
|
3638
|
+
* <p>The format of the exported data, CSV or PARQUET.</p>
|
|
3639
|
+
*/
|
|
3640
|
+
Format?: string;
|
|
3478
3641
|
}
|
|
3479
3642
|
export declare namespace DescribeExplainabilityExportResponse {
|
|
3480
3643
|
/**
|
|
@@ -3586,6 +3749,10 @@ export interface DescribeForecastResponse {
|
|
|
3586
3749
|
* </ul>
|
|
3587
3750
|
*/
|
|
3588
3751
|
LastModificationTime?: Date;
|
|
3752
|
+
/**
|
|
3753
|
+
* <p>The time series to include in the forecast.</p>
|
|
3754
|
+
*/
|
|
3755
|
+
TimeSeriesSelector?: TimeSeriesSelector;
|
|
3589
3756
|
}
|
|
3590
3757
|
export declare namespace DescribeForecastResponse {
|
|
3591
3758
|
/**
|
|
@@ -3689,6 +3856,10 @@ export interface DescribeForecastExportJobResponse {
|
|
|
3689
3856
|
* </ul>
|
|
3690
3857
|
*/
|
|
3691
3858
|
LastModificationTime?: Date;
|
|
3859
|
+
/**
|
|
3860
|
+
* <p>The format of the exported data, CSV or PARQUET.</p>
|
|
3861
|
+
*/
|
|
3862
|
+
Format?: string;
|
|
3692
3863
|
}
|
|
3693
3864
|
export declare namespace DescribeForecastExportJobResponse {
|
|
3694
3865
|
/**
|
|
@@ -3960,9 +4131,7 @@ export interface DescribePredictorResponse {
|
|
|
3960
4131
|
* AutoML or choosing HPO with CNN-QR or DeepAR+, the optimized values for the chosen
|
|
3961
4132
|
* hyperparameters are returned. For more information, see <a>aws-forecast-choosing-recipes</a>.</p>
|
|
3962
4133
|
*/
|
|
3963
|
-
TrainingParameters?:
|
|
3964
|
-
[key: string]: string;
|
|
3965
|
-
};
|
|
4134
|
+
TrainingParameters?: Record<string, string>;
|
|
3966
4135
|
/**
|
|
3967
4136
|
* <p>Used to override the default evaluation parameters of the specified algorithm. Amazon Forecast
|
|
3968
4137
|
* evaluates a predictor by splitting a dataset into training data and testing data. The
|
|
@@ -4177,6 +4346,10 @@ export interface DescribePredictorBacktestExportJobResponse {
|
|
|
4177
4346
|
* </ul>
|
|
4178
4347
|
*/
|
|
4179
4348
|
LastModificationTime?: Date;
|
|
4349
|
+
/**
|
|
4350
|
+
* <p>The format of the exported data, CSV or PARQUET.</p>
|
|
4351
|
+
*/
|
|
4352
|
+
Format?: string;
|
|
4180
4353
|
}
|
|
4181
4354
|
export declare namespace DescribePredictorBacktestExportJobResponse {
|
|
4182
4355
|
/**
|
|
@@ -5486,7 +5659,13 @@ export declare namespace PredictorEvent {
|
|
|
5486
5659
|
* <p>Describes the results of a monitor evaluation.</p>
|
|
5487
5660
|
*/
|
|
5488
5661
|
export interface PredictorMonitorEvaluation {
|
|
5662
|
+
/**
|
|
5663
|
+
* <p>The Amazon Resource Name (ARN) of the resource to monitor.</p>
|
|
5664
|
+
*/
|
|
5489
5665
|
ResourceArn?: string;
|
|
5666
|
+
/**
|
|
5667
|
+
* <p>The Amazon Resource Name (ARN) of the monitor resource.</p>
|
|
5668
|
+
*/
|
|
5490
5669
|
MonitorArn?: string;
|
|
5491
5670
|
/**
|
|
5492
5671
|
* <p>The timestamp that indicates when the monitor evaluation was started. </p>
|
|
@@ -5,9 +5,7 @@ export interface AdditionalDataset {
|
|
|
5
5
|
|
|
6
6
|
Name: string | undefined;
|
|
7
7
|
|
|
8
|
-
Configuration?:
|
|
9
|
-
[key: string]: string[];
|
|
10
|
-
};
|
|
8
|
+
Configuration?: Record<string, string[]>;
|
|
11
9
|
}
|
|
12
10
|
export declare namespace AdditionalDataset {
|
|
13
11
|
|
|
@@ -18,9 +16,7 @@ export interface AttributeConfig {
|
|
|
18
16
|
|
|
19
17
|
AttributeName: string | undefined;
|
|
20
18
|
|
|
21
|
-
Transformations:
|
|
22
|
-
[key: string]: string;
|
|
23
|
-
} | undefined;
|
|
19
|
+
Transformations: Record<string, string> | undefined;
|
|
24
20
|
}
|
|
25
21
|
export declare namespace AttributeConfig {
|
|
26
22
|
|
|
@@ -77,6 +73,44 @@ export declare namespace Tag {
|
|
|
77
73
|
|
|
78
74
|
const filterSensitiveLog: (obj: Tag) => any;
|
|
79
75
|
}
|
|
76
|
+
export declare enum DayOfWeek {
|
|
77
|
+
FRIDAY = "FRIDAY",
|
|
78
|
+
MONDAY = "MONDAY",
|
|
79
|
+
SATURDAY = "SATURDAY",
|
|
80
|
+
SUNDAY = "SUNDAY",
|
|
81
|
+
THURSDAY = "THURSDAY",
|
|
82
|
+
TUESDAY = "TUESDAY",
|
|
83
|
+
WEDNESDAY = "WEDNESDAY"
|
|
84
|
+
}
|
|
85
|
+
export declare enum Month {
|
|
86
|
+
APRIL = "APRIL",
|
|
87
|
+
AUGUST = "AUGUST",
|
|
88
|
+
DECEMBER = "DECEMBER",
|
|
89
|
+
FEBRUARY = "FEBRUARY",
|
|
90
|
+
JANUARY = "JANUARY",
|
|
91
|
+
JULY = "JULY",
|
|
92
|
+
JUNE = "JUNE",
|
|
93
|
+
MARCH = "MARCH",
|
|
94
|
+
MAY = "MAY",
|
|
95
|
+
NOVEMBER = "NOVEMBER",
|
|
96
|
+
OCTOBER = "OCTOBER",
|
|
97
|
+
SEPTEMBER = "SEPTEMBER"
|
|
98
|
+
}
|
|
99
|
+
|
|
100
|
+
export interface TimeAlignmentBoundary {
|
|
101
|
+
|
|
102
|
+
Month?: Month | string;
|
|
103
|
+
|
|
104
|
+
DayOfMonth?: number;
|
|
105
|
+
|
|
106
|
+
DayOfWeek?: DayOfWeek | string;
|
|
107
|
+
|
|
108
|
+
Hour?: number;
|
|
109
|
+
}
|
|
110
|
+
export declare namespace TimeAlignmentBoundary {
|
|
111
|
+
|
|
112
|
+
const filterSensitiveLog: (obj: TimeAlignmentBoundary) => any;
|
|
113
|
+
}
|
|
80
114
|
export interface CreateAutoPredictorRequest {
|
|
81
115
|
|
|
82
116
|
PredictorName: string | undefined;
|
|
@@ -102,6 +136,8 @@ export interface CreateAutoPredictorRequest {
|
|
|
102
136
|
Tags?: Tag[];
|
|
103
137
|
|
|
104
138
|
MonitorConfig?: MonitorConfig;
|
|
139
|
+
|
|
140
|
+
TimeAlignmentBoundary?: TimeAlignmentBoundary;
|
|
105
141
|
}
|
|
106
142
|
export declare namespace CreateAutoPredictorRequest {
|
|
107
143
|
|
|
@@ -285,6 +321,8 @@ export interface CreateDatasetImportJobRequest {
|
|
|
285
321
|
GeolocationFormat?: string;
|
|
286
322
|
|
|
287
323
|
Tags?: Tag[];
|
|
324
|
+
|
|
325
|
+
Format?: string;
|
|
288
326
|
}
|
|
289
327
|
export declare namespace CreateDatasetImportJobRequest {
|
|
290
328
|
|
|
@@ -367,6 +405,8 @@ export interface CreateExplainabilityExportRequest {
|
|
|
367
405
|
Destination: DataDestination | undefined;
|
|
368
406
|
|
|
369
407
|
Tags?: Tag[];
|
|
408
|
+
|
|
409
|
+
Format?: string;
|
|
370
410
|
}
|
|
371
411
|
export declare namespace CreateExplainabilityExportRequest {
|
|
372
412
|
|
|
@@ -380,6 +420,28 @@ export declare namespace CreateExplainabilityExportResponse {
|
|
|
380
420
|
|
|
381
421
|
const filterSensitiveLog: (obj: CreateExplainabilityExportResponse) => any;
|
|
382
422
|
}
|
|
423
|
+
|
|
424
|
+
export interface TimeSeriesIdentifiers {
|
|
425
|
+
|
|
426
|
+
DataSource?: DataSource;
|
|
427
|
+
|
|
428
|
+
Schema?: Schema;
|
|
429
|
+
|
|
430
|
+
Format?: string;
|
|
431
|
+
}
|
|
432
|
+
export declare namespace TimeSeriesIdentifiers {
|
|
433
|
+
|
|
434
|
+
const filterSensitiveLog: (obj: TimeSeriesIdentifiers) => any;
|
|
435
|
+
}
|
|
436
|
+
|
|
437
|
+
export interface TimeSeriesSelector {
|
|
438
|
+
|
|
439
|
+
TimeSeriesIdentifiers?: TimeSeriesIdentifiers;
|
|
440
|
+
}
|
|
441
|
+
export declare namespace TimeSeriesSelector {
|
|
442
|
+
|
|
443
|
+
const filterSensitiveLog: (obj: TimeSeriesSelector) => any;
|
|
444
|
+
}
|
|
383
445
|
export interface CreateForecastRequest {
|
|
384
446
|
|
|
385
447
|
ForecastName: string | undefined;
|
|
@@ -389,6 +451,8 @@ export interface CreateForecastRequest {
|
|
|
389
451
|
ForecastTypes?: string[];
|
|
390
452
|
|
|
391
453
|
Tags?: Tag[];
|
|
454
|
+
|
|
455
|
+
TimeSeriesSelector?: TimeSeriesSelector;
|
|
392
456
|
}
|
|
393
457
|
export declare namespace CreateForecastRequest {
|
|
394
458
|
|
|
@@ -411,6 +475,8 @@ export interface CreateForecastExportJobRequest {
|
|
|
411
475
|
Destination: DataDestination | undefined;
|
|
412
476
|
|
|
413
477
|
Tags?: Tag[];
|
|
478
|
+
|
|
479
|
+
Format?: string;
|
|
414
480
|
}
|
|
415
481
|
export declare namespace CreateForecastExportJobRequest {
|
|
416
482
|
|
|
@@ -467,9 +533,7 @@ export interface FeaturizationMethod {
|
|
|
467
533
|
|
|
468
534
|
FeaturizationMethodName: FeaturizationMethodName | string | undefined;
|
|
469
535
|
|
|
470
|
-
FeaturizationMethodParameters?:
|
|
471
|
-
[key: string]: string;
|
|
472
|
-
};
|
|
536
|
+
FeaturizationMethodParameters?: Record<string, string>;
|
|
473
537
|
}
|
|
474
538
|
export declare namespace FeaturizationMethod {
|
|
475
539
|
|
|
@@ -606,9 +670,7 @@ export interface CreatePredictorRequest {
|
|
|
606
670
|
|
|
607
671
|
PerformHPO?: boolean;
|
|
608
672
|
|
|
609
|
-
TrainingParameters?:
|
|
610
|
-
[key: string]: string;
|
|
611
|
-
};
|
|
673
|
+
TrainingParameters?: Record<string, string>;
|
|
612
674
|
|
|
613
675
|
EvaluationParameters?: EvaluationParameters;
|
|
614
676
|
|
|
@@ -645,6 +707,8 @@ export interface CreatePredictorBacktestExportJobRequest {
|
|
|
645
707
|
Destination: DataDestination | undefined;
|
|
646
708
|
|
|
647
709
|
Tags?: Tag[];
|
|
710
|
+
|
|
711
|
+
Format?: string;
|
|
648
712
|
}
|
|
649
713
|
export declare namespace CreatePredictorBacktestExportJobRequest {
|
|
650
714
|
|
|
@@ -828,6 +892,8 @@ export interface DescribeAutoPredictorResponse {
|
|
|
828
892
|
ExplainabilityInfo?: ExplainabilityInfo;
|
|
829
893
|
|
|
830
894
|
MonitorInfo?: MonitorInfo;
|
|
895
|
+
|
|
896
|
+
TimeAlignmentBoundary?: TimeAlignmentBoundary;
|
|
831
897
|
}
|
|
832
898
|
export declare namespace DescribeAutoPredictorResponse {
|
|
833
899
|
|
|
@@ -954,9 +1020,7 @@ export interface DescribeDatasetImportJobResponse {
|
|
|
954
1020
|
|
|
955
1021
|
EstimatedTimeRemainingInMinutes?: number;
|
|
956
1022
|
|
|
957
|
-
FieldStatistics?:
|
|
958
|
-
[key: string]: Statistics;
|
|
959
|
-
};
|
|
1023
|
+
FieldStatistics?: Record<string, Statistics>;
|
|
960
1024
|
|
|
961
1025
|
DataSize?: number;
|
|
962
1026
|
|
|
@@ -967,6 +1031,8 @@ export interface DescribeDatasetImportJobResponse {
|
|
|
967
1031
|
CreationTime?: Date;
|
|
968
1032
|
|
|
969
1033
|
LastModificationTime?: Date;
|
|
1034
|
+
|
|
1035
|
+
Format?: string;
|
|
970
1036
|
}
|
|
971
1037
|
export declare namespace DescribeDatasetImportJobResponse {
|
|
972
1038
|
|
|
@@ -1039,6 +1105,8 @@ export interface DescribeExplainabilityExportResponse {
|
|
|
1039
1105
|
CreationTime?: Date;
|
|
1040
1106
|
|
|
1041
1107
|
LastModificationTime?: Date;
|
|
1108
|
+
|
|
1109
|
+
Format?: string;
|
|
1042
1110
|
}
|
|
1043
1111
|
export declare namespace DescribeExplainabilityExportResponse {
|
|
1044
1112
|
|
|
@@ -1073,6 +1141,8 @@ export interface DescribeForecastResponse {
|
|
|
1073
1141
|
CreationTime?: Date;
|
|
1074
1142
|
|
|
1075
1143
|
LastModificationTime?: Date;
|
|
1144
|
+
|
|
1145
|
+
TimeSeriesSelector?: TimeSeriesSelector;
|
|
1076
1146
|
}
|
|
1077
1147
|
export declare namespace DescribeForecastResponse {
|
|
1078
1148
|
|
|
@@ -1103,6 +1173,8 @@ export interface DescribeForecastExportJobResponse {
|
|
|
1103
1173
|
CreationTime?: Date;
|
|
1104
1174
|
|
|
1105
1175
|
LastModificationTime?: Date;
|
|
1176
|
+
|
|
1177
|
+
Format?: string;
|
|
1106
1178
|
}
|
|
1107
1179
|
export declare namespace DescribeForecastExportJobResponse {
|
|
1108
1180
|
|
|
@@ -1236,9 +1308,7 @@ export interface DescribePredictorResponse {
|
|
|
1236
1308
|
|
|
1237
1309
|
PerformHPO?: boolean;
|
|
1238
1310
|
|
|
1239
|
-
TrainingParameters?:
|
|
1240
|
-
[key: string]: string;
|
|
1241
|
-
};
|
|
1311
|
+
TrainingParameters?: Record<string, string>;
|
|
1242
1312
|
|
|
1243
1313
|
EvaluationParameters?: EvaluationParameters;
|
|
1244
1314
|
|
|
@@ -1297,6 +1367,8 @@ export interface DescribePredictorBacktestExportJobResponse {
|
|
|
1297
1367
|
CreationTime?: Date;
|
|
1298
1368
|
|
|
1299
1369
|
LastModificationTime?: Date;
|
|
1370
|
+
|
|
1371
|
+
Format?: string;
|
|
1300
1372
|
}
|
|
1301
1373
|
export declare namespace DescribePredictorBacktestExportJobResponse {
|
|
1302
1374
|
|
|
@@ -1770,7 +1842,9 @@ export declare namespace PredictorEvent {
|
|
|
1770
1842
|
}
|
|
1771
1843
|
|
|
1772
1844
|
export interface PredictorMonitorEvaluation {
|
|
1845
|
+
|
|
1773
1846
|
ResourceArn?: string;
|
|
1847
|
+
|
|
1774
1848
|
MonitorArn?: string;
|
|
1775
1849
|
|
|
1776
1850
|
EvaluationTime?: Date;
|