@aws-sdk/client-forecast 3.92.0 → 3.97.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 +27 -0
- package/dist-cjs/Forecast.js +90 -0
- package/dist-cjs/commands/CreateMonitorCommand.js +36 -0
- package/dist-cjs/commands/DeleteMonitorCommand.js +36 -0
- package/dist-cjs/commands/DescribeMonitorCommand.js +36 -0
- package/dist-cjs/commands/ListMonitorEvaluationsCommand.js +36 -0
- package/dist-cjs/commands/ListMonitorsCommand.js +36 -0
- package/dist-cjs/commands/ResumeResourceCommand.js +36 -0
- package/dist-cjs/commands/index.js +6 -0
- package/dist-cjs/models/models_0.js +125 -3
- package/dist-cjs/pagination/ListExplainabilitiesPaginator.js +36 -0
- package/dist-cjs/pagination/ListExplainabilityExportsPaginator.js +36 -0
- package/dist-cjs/pagination/ListMonitorEvaluationsPaginator.js +36 -0
- package/dist-cjs/pagination/ListMonitorsPaginator.js +36 -0
- package/dist-cjs/pagination/index.js +4 -0
- package/dist-cjs/protocols/Aws_json1_1.js +539 -2
- package/dist-es/Forecast.js +90 -0
- package/dist-es/commands/CreateMonitorCommand.js +39 -0
- package/dist-es/commands/DeleteMonitorCommand.js +39 -0
- package/dist-es/commands/DescribeMonitorCommand.js +39 -0
- package/dist-es/commands/ListMonitorEvaluationsCommand.js +39 -0
- package/dist-es/commands/ListMonitorsCommand.js +39 -0
- package/dist-es/commands/ResumeResourceCommand.js +39 -0
- package/dist-es/commands/index.js +6 -0
- package/dist-es/models/models_0.js +80 -0
- package/dist-es/pagination/ListExplainabilitiesPaginator.js +75 -0
- package/dist-es/pagination/ListExplainabilityExportsPaginator.js +75 -0
- package/dist-es/pagination/ListMonitorEvaluationsPaginator.js +75 -0
- package/dist-es/pagination/ListMonitorsPaginator.js +75 -0
- package/dist-es/pagination/index.js +4 -0
- package/dist-es/protocols/Aws_json1_1.js +624 -1
- package/dist-types/Forecast.d.ts +133 -45
- package/dist-types/ForecastClient.d.ts +8 -2
- package/dist-types/commands/CreateAutoPredictorCommand.d.ts +7 -5
- package/dist-types/commands/CreateDatasetCommand.d.ts +4 -4
- package/dist-types/commands/CreateDatasetGroupCommand.d.ts +4 -4
- package/dist-types/commands/CreateDatasetImportJobCommand.d.ts +5 -4
- package/dist-types/commands/CreateExplainabilityCommand.d.ts +2 -2
- package/dist-types/commands/CreateMonitorCommand.d.ts +37 -0
- package/dist-types/commands/DeleteDatasetCommand.d.ts +5 -6
- package/dist-types/commands/DeleteDatasetGroupCommand.d.ts +2 -2
- package/dist-types/commands/DeleteDatasetImportJobCommand.d.ts +3 -2
- package/dist-types/commands/DeleteMonitorCommand.d.ts +35 -0
- package/dist-types/commands/DescribeDatasetCommand.d.ts +1 -2
- package/dist-types/commands/DescribeDatasetGroupCommand.d.ts +1 -1
- package/dist-types/commands/DescribeDatasetImportJobCommand.d.ts +1 -1
- package/dist-types/commands/DescribeMonitorCommand.d.ts +72 -0
- package/dist-types/commands/ListDatasetGroupsCommand.d.ts +5 -4
- package/dist-types/commands/ListDatasetImportJobsCommand.d.ts +5 -4
- package/dist-types/commands/ListDatasetsCommand.d.ts +3 -3
- package/dist-types/commands/ListMonitorEvaluationsCommand.d.ts +37 -0
- package/dist-types/commands/ListMonitorsCommand.d.ts +36 -0
- package/dist-types/commands/ResumeResourceCommand.d.ts +35 -0
- package/dist-types/commands/UpdateDatasetGroupCommand.d.ts +1 -1
- package/dist-types/commands/index.d.ts +6 -0
- package/dist-types/models/models_0.d.ts +660 -62
- package/dist-types/pagination/ListExplainabilitiesPaginator.d.ts +4 -0
- package/dist-types/pagination/ListExplainabilityExportsPaginator.d.ts +4 -0
- package/dist-types/pagination/ListMonitorEvaluationsPaginator.d.ts +4 -0
- package/dist-types/pagination/ListMonitorsPaginator.d.ts +4 -0
- package/dist-types/pagination/index.d.ts +4 -0
- package/dist-types/protocols/Aws_json1_1.d.ts +18 -0
- package/dist-types/ts3.4/Forecast.d.ts +30 -0
- package/dist-types/ts3.4/ForecastClient.d.ts +8 -2
- package/dist-types/ts3.4/commands/CreateMonitorCommand.d.ts +17 -0
- package/dist-types/ts3.4/commands/DeleteMonitorCommand.d.ts +17 -0
- package/dist-types/ts3.4/commands/DescribeMonitorCommand.d.ts +17 -0
- package/dist-types/ts3.4/commands/ListMonitorEvaluationsCommand.d.ts +17 -0
- package/dist-types/ts3.4/commands/ListMonitorsCommand.d.ts +17 -0
- package/dist-types/ts3.4/commands/ResumeResourceCommand.d.ts +17 -0
- package/dist-types/ts3.4/commands/index.d.ts +6 -0
- package/dist-types/ts3.4/models/models_0.d.ts +252 -0
- package/dist-types/ts3.4/pagination/ListExplainabilitiesPaginator.d.ts +4 -0
- package/dist-types/ts3.4/pagination/ListExplainabilityExportsPaginator.d.ts +4 -0
- package/dist-types/ts3.4/pagination/ListMonitorEvaluationsPaginator.d.ts +4 -0
- package/dist-types/ts3.4/pagination/ListMonitorsPaginator.d.ts +4 -0
- package/dist-types/ts3.4/pagination/index.d.ts +4 -0
- package/dist-types/ts3.4/protocols/Aws_json1_1.d.ts +18 -0
- package/package.json +4 -4
|
@@ -4,7 +4,7 @@ import { ForecastServiceException as __BaseException } from "./ForecastServiceEx
|
|
|
4
4
|
* <p>Describes an additional dataset. This object is part of the <a>DataConfig</a> object. Forecast supports the Weather Index and Holidays additional datasets.</p>
|
|
5
5
|
* <p>
|
|
6
6
|
* <b>Weather Index</b>
|
|
7
|
-
*
|
|
7
|
+
* </p>
|
|
8
8
|
* <p>The Amazon Forecast Weather Index is a built-in dataset that incorporates historical and
|
|
9
9
|
* projected weather information into your model. The Weather Index supplements your
|
|
10
10
|
* datasets with over two years of historical weather data and up to 14 days of projected
|
|
@@ -12,7 +12,7 @@ import { ForecastServiceException as __BaseException } from "./ForecastServiceEx
|
|
|
12
12
|
* Weather Index</a>.</p>
|
|
13
13
|
* <p>
|
|
14
14
|
* <b>Holidays</b>
|
|
15
|
-
*
|
|
15
|
+
* </p>
|
|
16
16
|
* <p>Holidays is a built-in dataset that incorporates national holiday information into
|
|
17
17
|
* your model. It provides native support for the holiday calendars of 66 countries. To
|
|
18
18
|
* view the holiday calendars, refer to the <a href="http://jollyday.sourceforge.net/data.html">Jollyday</a> library. For more
|
|
@@ -28,14 +28,18 @@ export interface AdditionalDataset {
|
|
|
28
28
|
/**
|
|
29
29
|
* <p>
|
|
30
30
|
* <b>Weather Index</b>
|
|
31
|
-
*
|
|
31
|
+
* </p>
|
|
32
32
|
* <p>To enable the Weather Index, do not specify a value for
|
|
33
33
|
* <code>Configuration</code>.</p>
|
|
34
34
|
* <p>
|
|
35
35
|
* <b>Holidays</b>
|
|
36
36
|
* </p>
|
|
37
|
-
*
|
|
38
|
-
*
|
|
37
|
+
*
|
|
38
|
+
* <p>
|
|
39
|
+
* <b>Holidays</b>
|
|
40
|
+
* </p>
|
|
41
|
+
* <p>To enable Holidays, set <code>CountryCode</code> to one of the following two-letter
|
|
42
|
+
* country codes:</p>
|
|
39
43
|
* <ul>
|
|
40
44
|
* <li>
|
|
41
45
|
* <p>"AL" - ALBANIA</p>
|
|
@@ -252,17 +256,17 @@ export declare namespace AdditionalDataset {
|
|
|
252
256
|
* <p>The following is an example using the RETAIL domain:</p>
|
|
253
257
|
* <p>
|
|
254
258
|
* <code>{</code>
|
|
255
|
-
*
|
|
259
|
+
* </p>
|
|
256
260
|
* <p>
|
|
257
261
|
* <code>"AttributeName": "demand",</code>
|
|
258
|
-
*
|
|
262
|
+
* </p>
|
|
259
263
|
* <p>
|
|
260
264
|
* <code>"Transformations": {"aggregation": "sum", "middlefill": "zero", "backfill":
|
|
261
265
|
* "zero"}</code>
|
|
262
|
-
*
|
|
266
|
+
* </p>
|
|
263
267
|
* <p>
|
|
264
268
|
* <code>}</code>
|
|
265
|
-
*
|
|
269
|
+
* </p>
|
|
266
270
|
*/
|
|
267
271
|
export interface AttributeConfig {
|
|
268
272
|
/**
|
|
@@ -393,6 +397,21 @@ export declare namespace EncryptionConfig {
|
|
|
393
397
|
*/
|
|
394
398
|
const filterSensitiveLog: (obj: EncryptionConfig) => any;
|
|
395
399
|
}
|
|
400
|
+
/**
|
|
401
|
+
* <p>The configuration details for the predictor monitor.</p>
|
|
402
|
+
*/
|
|
403
|
+
export interface MonitorConfig {
|
|
404
|
+
/**
|
|
405
|
+
* <p>The name of the monitor resource.</p>
|
|
406
|
+
*/
|
|
407
|
+
MonitorName: string | undefined;
|
|
408
|
+
}
|
|
409
|
+
export declare namespace MonitorConfig {
|
|
410
|
+
/**
|
|
411
|
+
* @internal
|
|
412
|
+
*/
|
|
413
|
+
const filterSensitiveLog: (obj: MonitorConfig) => any;
|
|
414
|
+
}
|
|
396
415
|
export declare enum OptimizationMetric {
|
|
397
416
|
AverageWeightedQuantileLoss = "AverageWeightedQuantileLoss",
|
|
398
417
|
MAPE = "MAPE",
|
|
@@ -463,6 +482,13 @@ export interface CreateAutoPredictorRequest {
|
|
|
463
482
|
/**
|
|
464
483
|
* <p>The number of time-steps that the model predicts. The forecast horizon is also called
|
|
465
484
|
* the prediction length.</p>
|
|
485
|
+
* <p>The maximum forecast horizon is the lesser of 500 time-steps or 1/4 of the
|
|
486
|
+
* TARGET_TIME_SERIES dataset length. If you are retraining an existing AutoPredictor, then
|
|
487
|
+
* the maximum forecast horizon is the lesser of 500 time-steps or 1/3 of the
|
|
488
|
+
* TARGET_TIME_SERIES dataset length.</p>
|
|
489
|
+
* <p>If you are upgrading to an AutoPredictor or retraining an existing AutoPredictor, you
|
|
490
|
+
* cannot update the forecast horizon parameter. You can meet this requirement by providing
|
|
491
|
+
* longer time-series in the dataset.</p>
|
|
466
492
|
*/
|
|
467
493
|
ForecastHorizon?: number;
|
|
468
494
|
/**
|
|
@@ -552,6 +578,12 @@ export interface CreateAutoPredictorRequest {
|
|
|
552
578
|
* </ul>
|
|
553
579
|
*/
|
|
554
580
|
Tags?: Tag[];
|
|
581
|
+
/**
|
|
582
|
+
* <p>The configuration details for predictor monitoring. Provide a name for the monitor resource to enable predictor monitoring.</p>
|
|
583
|
+
* <p>Predictor monitoring allows you to see how your predictor's performance changes over time.
|
|
584
|
+
* For more information, see <a href="https://docs.aws.amazon.com/forecast/latest/dg/predictor-monitoring.html">Predictor Monitoring</a>.</p>
|
|
585
|
+
*/
|
|
586
|
+
MonitorConfig?: MonitorConfig;
|
|
555
587
|
}
|
|
556
588
|
export declare namespace CreateAutoPredictorRequest {
|
|
557
589
|
/**
|
|
@@ -656,7 +688,7 @@ export declare enum AttributeType {
|
|
|
656
688
|
}
|
|
657
689
|
/**
|
|
658
690
|
* <p>An attribute of a schema, which defines a dataset field. A schema attribute is required
|
|
659
|
-
* for every field in a dataset. The <a>Schema</a> object contains an array of
|
|
691
|
+
* for every field in a dataset. The <a href="https://docs.aws.amazon.com/forecast/latest/dg/API_Schema.html">Schema</a> object contains an array of
|
|
660
692
|
* <code>SchemaAttribute</code> objects.</p>
|
|
661
693
|
*/
|
|
662
694
|
export interface SchemaAttribute {
|
|
@@ -666,6 +698,7 @@ export interface SchemaAttribute {
|
|
|
666
698
|
AttributeName?: string;
|
|
667
699
|
/**
|
|
668
700
|
* <p>The data type of the field.</p>
|
|
701
|
+
* <p>For a related time series dataset, other than date, item_id, and forecast dimensions attributes, all attributes should be of numerical type (integer/float).</p>
|
|
669
702
|
*/
|
|
670
703
|
AttributeType?: AttributeType | string;
|
|
671
704
|
}
|
|
@@ -697,12 +730,13 @@ export interface CreateDatasetRequest {
|
|
|
697
730
|
DatasetName: string | undefined;
|
|
698
731
|
/**
|
|
699
732
|
* <p>The domain associated with the dataset. When you add a dataset to a dataset group, this
|
|
700
|
-
* value and the value specified for the <code>Domain</code> parameter of the <a>CreateDatasetGroup</a> operation must match.</p>
|
|
733
|
+
* value and the value specified for the <code>Domain</code> parameter of the <a href="https://docs.aws.amazon.com/forecast/latest/dg/API_CreateDatasetGroup.html">CreateDatasetGroup</a> operation must match.</p>
|
|
701
734
|
* <p>The <code>Domain</code> and <code>DatasetType</code> that you choose determine the fields
|
|
702
735
|
* that must be present in the training data that you import to the dataset. For example, if you
|
|
703
736
|
* choose the <code>RETAIL</code> domain and <code>TARGET_TIME_SERIES</code> as the
|
|
704
737
|
* <code>DatasetType</code>, Amazon Forecast requires <code>item_id</code>, <code>timestamp</code>,
|
|
705
|
-
* and <code>demand</code> fields to be present in your data. For more information, see <a
|
|
738
|
+
* and <code>demand</code> fields to be present in your data. For more information, see <a href="https://docs.aws.amazon.com/forecast/latest/dg/howitworks-datasets-groups.html">Importing
|
|
739
|
+
* datasets</a>.</p>
|
|
706
740
|
*/
|
|
707
741
|
Domain: Domain | string | undefined;
|
|
708
742
|
/**
|
|
@@ -721,7 +755,8 @@ export interface CreateDatasetRequest {
|
|
|
721
755
|
* <p>The schema for the dataset. The schema attributes and their order must match the fields in
|
|
722
756
|
* your data. The dataset <code>Domain</code> and <code>DatasetType</code> that you choose
|
|
723
757
|
* determine the minimum required fields in your training data. For information about the
|
|
724
|
-
* required fields for a specific dataset domain and type, see <a
|
|
758
|
+
* required fields for a specific dataset domain and type, see <a href="https://docs.aws.amazon.com/forecast/latest/dg/howitworks-domains-ds-types.html">Dataset Domains and Dataset
|
|
759
|
+
* Types</a>.</p>
|
|
725
760
|
*/
|
|
726
761
|
Schema: Schema | undefined;
|
|
727
762
|
/**
|
|
@@ -793,13 +828,14 @@ export interface CreateDatasetGroupRequest {
|
|
|
793
828
|
DatasetGroupName: string | undefined;
|
|
794
829
|
/**
|
|
795
830
|
* <p>The domain associated with the dataset group. When you add a dataset to a dataset group,
|
|
796
|
-
* this value and the value specified for the <code>Domain</code> parameter of the <a>CreateDataset</a>
|
|
831
|
+
* this value and the value specified for the <code>Domain</code> parameter of the <a href="https://docs.aws.amazon.com/forecast/latest/dg/API_CreateDataset.html">CreateDataset</a>
|
|
832
|
+
* operation must match.</p>
|
|
797
833
|
* <p>The <code>Domain</code> and <code>DatasetType</code> that you choose determine the fields
|
|
798
834
|
* that must be present in training data that you import to a dataset. For example, if you choose
|
|
799
835
|
* the <code>RETAIL</code> domain and <code>TARGET_TIME_SERIES</code> as the
|
|
800
836
|
* <code>DatasetType</code>, Amazon Forecast requires that <code>item_id</code>,
|
|
801
837
|
* <code>timestamp</code>, and <code>demand</code> fields are present in your data. For more
|
|
802
|
-
* information, see <a
|
|
838
|
+
* information, see <a href="https://docs.aws.amazon.com/forecast/latest/dg/howitworks-datasets-groups.html">Dataset groups</a>.</p>
|
|
803
839
|
*/
|
|
804
840
|
Domain: Domain | string | undefined;
|
|
805
841
|
/**
|
|
@@ -928,7 +964,8 @@ export interface CreateDatasetImportJobRequest {
|
|
|
928
964
|
* can assume to access the data. The training data must be stored in an Amazon S3 bucket.</p>
|
|
929
965
|
* <p>If encryption is used, <code>DataSource</code> must include an AWS Key Management Service (KMS) key and the
|
|
930
966
|
* IAM role must allow Amazon Forecast permission to access the key. The KMS key and IAM role must
|
|
931
|
-
* match those specified in the <code>EncryptionConfig</code> parameter of the <a>CreateDataset</a>
|
|
967
|
+
* match those specified in the <code>EncryptionConfig</code> parameter of the <a href="https://docs.aws.amazon.com/forecast/latest/dg/API_CreateDataset.html">CreateDataset</a>
|
|
968
|
+
* operation.</p>
|
|
932
969
|
*/
|
|
933
970
|
DataSource: DataSource | undefined;
|
|
934
971
|
/**
|
|
@@ -1052,8 +1089,9 @@ export declare enum TimeSeriesGranularity {
|
|
|
1052
1089
|
* <code>TimePointGranularity</code> and <code>TimeSeriesGranularity</code> to “ALL”.
|
|
1053
1090
|
* When creating Predictor Explainability, Amazon Forecast considers all time series and
|
|
1054
1091
|
* time points.</p>
|
|
1055
|
-
* <p>If you provide a forecast ARN for <code>ResourceArn</code>, you can set
|
|
1056
|
-
*
|
|
1092
|
+
* <p>If you provide a forecast ARN for <code>ResourceArn</code>, you can set
|
|
1093
|
+
* <code>TimePointGranularity</code> and <code>TimeSeriesGranularity</code> to either
|
|
1094
|
+
* “ALL” or “Specific”.</p>
|
|
1057
1095
|
*/
|
|
1058
1096
|
export interface ExplainabilityConfig {
|
|
1059
1097
|
/**
|
|
@@ -1104,19 +1142,21 @@ export interface CreateExplainabilityRequest {
|
|
|
1104
1142
|
*/
|
|
1105
1143
|
Schema?: Schema;
|
|
1106
1144
|
/**
|
|
1107
|
-
* <p>Create an
|
|
1145
|
+
* <p>Create an Explainability visualization that is viewable within the AWS console.</p>
|
|
1108
1146
|
*/
|
|
1109
1147
|
EnableVisualization?: boolean;
|
|
1110
1148
|
/**
|
|
1111
1149
|
* <p>If <code>TimePointGranularity</code> is set to <code>SPECIFIC</code>, define the first
|
|
1112
1150
|
* point for the Explainability.</p>
|
|
1113
|
-
* <p>Use the following timestamp format: yyyy-MM-ddTHH:mm:ss (example:
|
|
1151
|
+
* <p>Use the following timestamp format: yyyy-MM-ddTHH:mm:ss (example:
|
|
1152
|
+
* 2015-01-01T20:00:00)</p>
|
|
1114
1153
|
*/
|
|
1115
1154
|
StartDateTime?: string;
|
|
1116
1155
|
/**
|
|
1117
1156
|
* <p>If <code>TimePointGranularity</code> is set to <code>SPECIFIC</code>, define the last
|
|
1118
1157
|
* time point for the Explainability.</p>
|
|
1119
|
-
* <p>Use the following timestamp format: yyyy-MM-ddTHH:mm:ss (example:
|
|
1158
|
+
* <p>Use the following timestamp format: yyyy-MM-ddTHH:mm:ss (example:
|
|
1159
|
+
* 2015-01-01T20:00:00)</p>
|
|
1120
1160
|
*/
|
|
1121
1161
|
EndDateTime?: string;
|
|
1122
1162
|
/**
|
|
@@ -1272,7 +1312,11 @@ export interface CreateForecastRequest {
|
|
|
1272
1312
|
* can currently specify up to 5 quantiles per forecast</b>. Accepted values include
|
|
1273
1313
|
* <code>0.01 to 0.99</code> (increments of .01 only) and <code>mean</code>. The mean forecast
|
|
1274
1314
|
* is different from the median (0.50) when the distribution is not symmetric (for example, Beta
|
|
1275
|
-
* and Negative Binomial).
|
|
1315
|
+
* and Negative Binomial).
|
|
1316
|
+
* </p>
|
|
1317
|
+
* <p>The default quantiles are the quantiles you specified during predictor creation.
|
|
1318
|
+
* If you didn't specify quantiles, the default values are <code>["0.1", "0.5", "0.9"]</code>.
|
|
1319
|
+
* </p>
|
|
1276
1320
|
*/
|
|
1277
1321
|
ForecastTypes?: string[];
|
|
1278
1322
|
/**
|
|
@@ -1407,6 +1451,38 @@ export declare namespace CreateForecastExportJobResponse {
|
|
|
1407
1451
|
*/
|
|
1408
1452
|
const filterSensitiveLog: (obj: CreateForecastExportJobResponse) => any;
|
|
1409
1453
|
}
|
|
1454
|
+
export interface CreateMonitorRequest {
|
|
1455
|
+
/**
|
|
1456
|
+
* <p>The name of the monitor resource.</p>
|
|
1457
|
+
*/
|
|
1458
|
+
MonitorName: string | undefined;
|
|
1459
|
+
/**
|
|
1460
|
+
* <p>The Amazon Resource Name (ARN) of the predictor to monitor.</p>
|
|
1461
|
+
*/
|
|
1462
|
+
ResourceArn: string | undefined;
|
|
1463
|
+
/**
|
|
1464
|
+
* <p>A list of <a href="https://docs.aws.amazon.com/forecast/latest/dg/tagging-forecast-resources.html">tags</a> to apply to the monitor resource.</p>
|
|
1465
|
+
*/
|
|
1466
|
+
Tags?: Tag[];
|
|
1467
|
+
}
|
|
1468
|
+
export declare namespace CreateMonitorRequest {
|
|
1469
|
+
/**
|
|
1470
|
+
* @internal
|
|
1471
|
+
*/
|
|
1472
|
+
const filterSensitiveLog: (obj: CreateMonitorRequest) => any;
|
|
1473
|
+
}
|
|
1474
|
+
export interface CreateMonitorResponse {
|
|
1475
|
+
/**
|
|
1476
|
+
* <p>The Amazon Resource Name (ARN) of the monitor resource.</p>
|
|
1477
|
+
*/
|
|
1478
|
+
MonitorArn?: string;
|
|
1479
|
+
}
|
|
1480
|
+
export declare namespace CreateMonitorResponse {
|
|
1481
|
+
/**
|
|
1482
|
+
* @internal
|
|
1483
|
+
*/
|
|
1484
|
+
const filterSensitiveLog: (obj: CreateMonitorResponse) => any;
|
|
1485
|
+
}
|
|
1410
1486
|
export declare enum AutoMLOverrideStrategy {
|
|
1411
1487
|
AccuracyOptimized = "AccuracyOptimized",
|
|
1412
1488
|
LatencyOptimized = "LatencyOptimized"
|
|
@@ -2461,6 +2537,18 @@ export declare namespace DeleteForecastExportJobRequest {
|
|
|
2461
2537
|
*/
|
|
2462
2538
|
const filterSensitiveLog: (obj: DeleteForecastExportJobRequest) => any;
|
|
2463
2539
|
}
|
|
2540
|
+
export interface DeleteMonitorRequest {
|
|
2541
|
+
/**
|
|
2542
|
+
* <p>The Amazon Resource Name (ARN) of the monitor resource to delete.</p>
|
|
2543
|
+
*/
|
|
2544
|
+
MonitorArn: string | undefined;
|
|
2545
|
+
}
|
|
2546
|
+
export declare namespace DeleteMonitorRequest {
|
|
2547
|
+
/**
|
|
2548
|
+
* @internal
|
|
2549
|
+
*/
|
|
2550
|
+
const filterSensitiveLog: (obj: DeleteMonitorRequest) => any;
|
|
2551
|
+
}
|
|
2464
2552
|
export interface DeletePredictorRequest {
|
|
2465
2553
|
/**
|
|
2466
2554
|
* <p>The Amazon Resource Name (ARN) of the predictor to delete.</p>
|
|
@@ -2523,13 +2611,13 @@ export interface ExplainabilityInfo {
|
|
|
2523
2611
|
* <ul>
|
|
2524
2612
|
* <li>
|
|
2525
2613
|
* <p>
|
|
2526
|
-
*
|
|
2527
|
-
*
|
|
2614
|
+
* <code>ACTIVE</code>
|
|
2615
|
+
* </p>
|
|
2528
2616
|
* </li>
|
|
2529
2617
|
* <li>
|
|
2530
2618
|
* <p>
|
|
2531
2619
|
* <code>CREATE_PENDING</code>, <code>CREATE_IN_PROGRESS</code>,
|
|
2532
|
-
*
|
|
2620
|
+
* <code>CREATE_FAILED</code>
|
|
2533
2621
|
* </p>
|
|
2534
2622
|
* </li>
|
|
2535
2623
|
* <li>
|
|
@@ -2540,7 +2628,7 @@ export interface ExplainabilityInfo {
|
|
|
2540
2628
|
* <li>
|
|
2541
2629
|
* <p>
|
|
2542
2630
|
* <code>DELETE_PENDING</code>, <code>DELETE_IN_PROGRESS</code>,
|
|
2543
|
-
*
|
|
2631
|
+
* <code>DELETE_FAILED</code>
|
|
2544
2632
|
* </p>
|
|
2545
2633
|
* </li>
|
|
2546
2634
|
* </ul>
|
|
@@ -2553,6 +2641,52 @@ export declare namespace ExplainabilityInfo {
|
|
|
2553
2641
|
*/
|
|
2554
2642
|
const filterSensitiveLog: (obj: ExplainabilityInfo) => any;
|
|
2555
2643
|
}
|
|
2644
|
+
/**
|
|
2645
|
+
* <p>Provides information about the monitor resource.</p>
|
|
2646
|
+
*/
|
|
2647
|
+
export interface MonitorInfo {
|
|
2648
|
+
/**
|
|
2649
|
+
* <p>The Amazon Resource Name (ARN) of the monitor resource.</p>
|
|
2650
|
+
*/
|
|
2651
|
+
MonitorArn?: string;
|
|
2652
|
+
/**
|
|
2653
|
+
* <p>The status of the monitor. States include:</p>
|
|
2654
|
+
* <ul>
|
|
2655
|
+
* <li>
|
|
2656
|
+
* <p>
|
|
2657
|
+
* <code>ACTIVE</code>
|
|
2658
|
+
* </p>
|
|
2659
|
+
* </li>
|
|
2660
|
+
* <li>
|
|
2661
|
+
* <p>
|
|
2662
|
+
* <code>ACTIVE_STOPPING</code>, <code>ACTIVE_STOPPED</code>
|
|
2663
|
+
* </p>
|
|
2664
|
+
* </li>
|
|
2665
|
+
* <li>
|
|
2666
|
+
* <p>
|
|
2667
|
+
* <code>UPDATE_IN_PROGRESS</code>
|
|
2668
|
+
* </p>
|
|
2669
|
+
* </li>
|
|
2670
|
+
* <li>
|
|
2671
|
+
* <p>
|
|
2672
|
+
* <code>CREATE_PENDING</code>, <code>CREATE_IN_PROGRESS</code>, <code>CREATE_FAILED</code>
|
|
2673
|
+
* </p>
|
|
2674
|
+
* </li>
|
|
2675
|
+
* <li>
|
|
2676
|
+
* <p>
|
|
2677
|
+
* <code>DELETE_PENDING</code>, <code>DELETE_IN_PROGRESS</code>, <code>DELETE_FAILED</code>
|
|
2678
|
+
* </p>
|
|
2679
|
+
* </li>
|
|
2680
|
+
* </ul>
|
|
2681
|
+
*/
|
|
2682
|
+
Status?: string;
|
|
2683
|
+
}
|
|
2684
|
+
export declare namespace MonitorInfo {
|
|
2685
|
+
/**
|
|
2686
|
+
* @internal
|
|
2687
|
+
*/
|
|
2688
|
+
const filterSensitiveLog: (obj: MonitorInfo) => any;
|
|
2689
|
+
}
|
|
2556
2690
|
export declare enum State {
|
|
2557
2691
|
Active = "Active",
|
|
2558
2692
|
Deleted = "Deleted"
|
|
@@ -2604,7 +2738,8 @@ export interface DescribeAutoPredictorResponse {
|
|
|
2604
2738
|
*/
|
|
2605
2739
|
ForecastFrequency?: string;
|
|
2606
2740
|
/**
|
|
2607
|
-
* <p>An array of dimension (field) names that specify the attributes used to group your
|
|
2741
|
+
* <p>An array of dimension (field) names that specify the attributes used to group your
|
|
2742
|
+
* time series.</p>
|
|
2608
2743
|
*/
|
|
2609
2744
|
ForecastDimensions?: string[];
|
|
2610
2745
|
/**
|
|
@@ -2637,8 +2772,8 @@ export interface DescribeAutoPredictorResponse {
|
|
|
2637
2772
|
* <ul>
|
|
2638
2773
|
* <li>
|
|
2639
2774
|
* <p>
|
|
2640
|
-
*
|
|
2641
|
-
*
|
|
2775
|
+
* <code>ACTIVE</code>
|
|
2776
|
+
* </p>
|
|
2642
2777
|
* </li>
|
|
2643
2778
|
* <li>
|
|
2644
2779
|
* <p>
|
|
@@ -2704,6 +2839,10 @@ export interface DescribeAutoPredictorResponse {
|
|
|
2704
2839
|
* <p>Provides the status and ARN of the Predictor Explainability.</p>
|
|
2705
2840
|
*/
|
|
2706
2841
|
ExplainabilityInfo?: ExplainabilityInfo;
|
|
2842
|
+
/**
|
|
2843
|
+
* <p>A object with the Amazon Resource Name (ARN) and status of the monitor resource.</p>
|
|
2844
|
+
*/
|
|
2845
|
+
MonitorInfo?: MonitorInfo;
|
|
2707
2846
|
}
|
|
2708
2847
|
export declare namespace DescribeAutoPredictorResponse {
|
|
2709
2848
|
/**
|
|
@@ -2785,9 +2924,9 @@ export interface DescribeDatasetResponse {
|
|
|
2785
2924
|
* </li>
|
|
2786
2925
|
* </ul>
|
|
2787
2926
|
* <p>The <code>UPDATE</code> states apply while data is imported to the dataset from a call to
|
|
2788
|
-
* the <a>CreateDatasetImportJob</a> operation and reflect the status of the dataset
|
|
2789
|
-
*
|
|
2790
|
-
*
|
|
2927
|
+
* the <a href="https://docs.aws.amazon.com/forecast/latest/dg/API_CreateDatasetImportJob.html">CreateDatasetImportJob</a> operation and reflect the status of the dataset import job.
|
|
2928
|
+
* For example, when the import job status is <code>CREATE_IN_PROGRESS</code>, the status of the
|
|
2929
|
+
* dataset is <code>UPDATE_IN_PROGRESS</code>.</p>
|
|
2791
2930
|
* <note>
|
|
2792
2931
|
* <p>The <code>Status</code> of the dataset must be <code>ACTIVE</code> before you can import
|
|
2793
2932
|
* training data.</p>
|
|
@@ -2802,8 +2941,9 @@ export interface DescribeDatasetResponse {
|
|
|
2802
2941
|
* <p>When you create a dataset, <code>LastModificationTime</code> is the same as
|
|
2803
2942
|
* <code>CreationTime</code>. While data is being imported to the dataset,
|
|
2804
2943
|
* <code>LastModificationTime</code> is the current time of the <code>DescribeDataset</code>
|
|
2805
|
-
* call. After a <a>CreateDatasetImportJob</a>
|
|
2806
|
-
*
|
|
2944
|
+
* call. After a <a href="https://docs.aws.amazon.com/forecast/latest/dg/API_CreateDatasetImportJob.html">CreateDatasetImportJob</a>
|
|
2945
|
+
* operation has finished, <code>LastModificationTime</code> is when the import job completed or
|
|
2946
|
+
* failed.</p>
|
|
2807
2947
|
*/
|
|
2808
2948
|
LastModificationTime?: Date;
|
|
2809
2949
|
}
|
|
@@ -2870,7 +3010,8 @@ export interface DescribeDatasetGroupResponse {
|
|
|
2870
3010
|
* </p>
|
|
2871
3011
|
* </li>
|
|
2872
3012
|
* </ul>
|
|
2873
|
-
* <p>The <code>UPDATE</code> states apply when you call the <a>UpdateDatasetGroup</a>
|
|
3013
|
+
* <p>The <code>UPDATE</code> states apply when you call the <a href="https://docs.aws.amazon.com/forecast/latest/dg/API_UpdateDatasetGroup.html">UpdateDatasetGroup</a>
|
|
3014
|
+
* operation.</p>
|
|
2874
3015
|
* <note>
|
|
2875
3016
|
* <p>The <code>Status</code> of the dataset group must be <code>ACTIVE</code> before you can
|
|
2876
3017
|
* use the dataset group to create a predictor.</p>
|
|
@@ -2882,7 +3023,7 @@ export interface DescribeDatasetGroupResponse {
|
|
|
2882
3023
|
*/
|
|
2883
3024
|
CreationTime?: Date;
|
|
2884
3025
|
/**
|
|
2885
|
-
* <p>When the dataset group was created or last updated from a call to the <a>UpdateDatasetGroup</a> operation. While the dataset group is being updated,
|
|
3026
|
+
* <p>When the dataset group was created or last updated from a call to the <a href="https://docs.aws.amazon.com/forecast/latest/dg/API_UpdateDatasetGroup.html">UpdateDatasetGroup</a> operation. While the dataset group is being updated,
|
|
2886
3027
|
* <code>LastModificationTime</code> is the current time of the
|
|
2887
3028
|
* <code>DescribeDatasetGroup</code> call.</p>
|
|
2888
3029
|
*/
|
|
@@ -2908,7 +3049,7 @@ export declare namespace DescribeDatasetImportJobRequest {
|
|
|
2908
3049
|
}
|
|
2909
3050
|
/**
|
|
2910
3051
|
* <p>Provides statistics for each data field imported into to an Amazon Forecast dataset with
|
|
2911
|
-
* the <a>CreateDatasetImportJob</a> operation.</p>
|
|
3052
|
+
* the <a href="https://docs.aws.amazon.com/forecast/latest/dg/API_CreateDatasetImportJob.html">CreateDatasetImportJob</a> operation.</p>
|
|
2912
3053
|
*/
|
|
2913
3054
|
export interface Statistics {
|
|
2914
3055
|
/**
|
|
@@ -2918,17 +3059,17 @@ export interface Statistics {
|
|
|
2918
3059
|
Count?: number;
|
|
2919
3060
|
/**
|
|
2920
3061
|
* <p>The number of distinct values in the field. If the response value is -1, refer to
|
|
2921
|
-
*
|
|
3062
|
+
* <code>CountDistinctLong</code>.</p>
|
|
2922
3063
|
*/
|
|
2923
3064
|
CountDistinct?: number;
|
|
2924
3065
|
/**
|
|
2925
3066
|
* <p>The number of null values in the field. If the response value is -1, refer to
|
|
2926
|
-
*
|
|
3067
|
+
* <code>CountNullLong</code>.</p>
|
|
2927
3068
|
*/
|
|
2928
3069
|
CountNull?: number;
|
|
2929
3070
|
/**
|
|
2930
|
-
* <p>The number of NAN (not a number) values in the field. If the response value is -1, refer
|
|
2931
|
-
* <code>CountNanLong</code>.</p>
|
|
3071
|
+
* <p>The number of NAN (not a number) values in the field. If the response value is -1, refer
|
|
3072
|
+
* to <code>CountNanLong</code>.</p>
|
|
2932
3073
|
*/
|
|
2933
3074
|
CountNan?: number;
|
|
2934
3075
|
/**
|
|
@@ -3178,8 +3319,8 @@ export interface DescribeExplainabilityResponse {
|
|
|
3178
3319
|
* <ul>
|
|
3179
3320
|
* <li>
|
|
3180
3321
|
* <p>
|
|
3181
|
-
*
|
|
3182
|
-
*
|
|
3322
|
+
* <code>ACTIVE</code>
|
|
3323
|
+
* </p>
|
|
3183
3324
|
* </li>
|
|
3184
3325
|
* <li>
|
|
3185
3326
|
* <p>
|
|
@@ -3279,8 +3420,8 @@ export interface DescribeExplainabilityExportResponse {
|
|
|
3279
3420
|
* <ul>
|
|
3280
3421
|
* <li>
|
|
3281
3422
|
* <p>
|
|
3282
|
-
*
|
|
3283
|
-
*
|
|
3423
|
+
* <code>ACTIVE</code>
|
|
3424
|
+
* </p>
|
|
3284
3425
|
* </li>
|
|
3285
3426
|
* <li>
|
|
3286
3427
|
* <p>
|
|
@@ -3555,6 +3696,121 @@ export declare namespace DescribeForecastExportJobResponse {
|
|
|
3555
3696
|
*/
|
|
3556
3697
|
const filterSensitiveLog: (obj: DescribeForecastExportJobResponse) => any;
|
|
3557
3698
|
}
|
|
3699
|
+
export interface DescribeMonitorRequest {
|
|
3700
|
+
/**
|
|
3701
|
+
* <p>The Amazon Resource Name (ARN) of the monitor resource to describe.</p>
|
|
3702
|
+
*/
|
|
3703
|
+
MonitorArn: string | undefined;
|
|
3704
|
+
}
|
|
3705
|
+
export declare namespace DescribeMonitorRequest {
|
|
3706
|
+
/**
|
|
3707
|
+
* @internal
|
|
3708
|
+
*/
|
|
3709
|
+
const filterSensitiveLog: (obj: DescribeMonitorRequest) => any;
|
|
3710
|
+
}
|
|
3711
|
+
/**
|
|
3712
|
+
* <p>An individual metric that you can use for comparison as you evaluate your monitoring results.</p>
|
|
3713
|
+
*/
|
|
3714
|
+
export interface BaselineMetric {
|
|
3715
|
+
/**
|
|
3716
|
+
* <p>The name of the metric.</p>
|
|
3717
|
+
*/
|
|
3718
|
+
Name?: string;
|
|
3719
|
+
/**
|
|
3720
|
+
* <p>The value for the metric.</p>
|
|
3721
|
+
*/
|
|
3722
|
+
Value?: number;
|
|
3723
|
+
}
|
|
3724
|
+
export declare namespace BaselineMetric {
|
|
3725
|
+
/**
|
|
3726
|
+
* @internal
|
|
3727
|
+
*/
|
|
3728
|
+
const filterSensitiveLog: (obj: BaselineMetric) => any;
|
|
3729
|
+
}
|
|
3730
|
+
/**
|
|
3731
|
+
* <p>Metrics you can use as a baseline for comparison purposes. Use these metrics when you interpret monitoring results for an auto predictor.</p>
|
|
3732
|
+
*/
|
|
3733
|
+
export interface PredictorBaseline {
|
|
3734
|
+
/**
|
|
3735
|
+
* <p>The initial <a href="https://docs.aws.amazon.com/forecast/latest/dg/metrics.html">accuracy metrics</a> for the predictor. Use these metrics as a baseline for comparison purposes as you
|
|
3736
|
+
* use your predictor and the metrics change.</p>
|
|
3737
|
+
*/
|
|
3738
|
+
BaselineMetrics?: BaselineMetric[];
|
|
3739
|
+
}
|
|
3740
|
+
export declare namespace PredictorBaseline {
|
|
3741
|
+
/**
|
|
3742
|
+
* @internal
|
|
3743
|
+
*/
|
|
3744
|
+
const filterSensitiveLog: (obj: PredictorBaseline) => any;
|
|
3745
|
+
}
|
|
3746
|
+
/**
|
|
3747
|
+
* <p>Metrics you can use as a baseline for comparison purposes. Use these metrics when you interpret monitoring results for an auto predictor.</p>
|
|
3748
|
+
*/
|
|
3749
|
+
export interface Baseline {
|
|
3750
|
+
/**
|
|
3751
|
+
* <p>The initial <a href="https://docs.aws.amazon.com/forecast/latest/dg/metrics.html">accuracy metrics</a> for the predictor you are monitoring. Use these metrics as a baseline for comparison purposes as you
|
|
3752
|
+
* use your predictor and the metrics change.</p>
|
|
3753
|
+
*/
|
|
3754
|
+
PredictorBaseline?: PredictorBaseline;
|
|
3755
|
+
}
|
|
3756
|
+
export declare namespace Baseline {
|
|
3757
|
+
/**
|
|
3758
|
+
* @internal
|
|
3759
|
+
*/
|
|
3760
|
+
const filterSensitiveLog: (obj: Baseline) => any;
|
|
3761
|
+
}
|
|
3762
|
+
export interface DescribeMonitorResponse {
|
|
3763
|
+
/**
|
|
3764
|
+
* <p>The name of the monitor.</p>
|
|
3765
|
+
*/
|
|
3766
|
+
MonitorName?: string;
|
|
3767
|
+
/**
|
|
3768
|
+
* <p>The Amazon Resource Name (ARN) of the monitor resource described.</p>
|
|
3769
|
+
*/
|
|
3770
|
+
MonitorArn?: string;
|
|
3771
|
+
/**
|
|
3772
|
+
* <p>The Amazon Resource Name (ARN) of the auto predictor being monitored.</p>
|
|
3773
|
+
*/
|
|
3774
|
+
ResourceArn?: string;
|
|
3775
|
+
/**
|
|
3776
|
+
* <p>The status of the monitor resource.</p>
|
|
3777
|
+
*/
|
|
3778
|
+
Status?: string;
|
|
3779
|
+
/**
|
|
3780
|
+
* <p>The timestamp of the latest evaluation completed by the monitor.</p>
|
|
3781
|
+
*/
|
|
3782
|
+
LastEvaluationTime?: Date;
|
|
3783
|
+
/**
|
|
3784
|
+
* <p>The state of the monitor's latest evaluation.</p>
|
|
3785
|
+
*/
|
|
3786
|
+
LastEvaluationState?: string;
|
|
3787
|
+
/**
|
|
3788
|
+
* <p>Metrics you can use as a baseline for comparison purposes. Use these values you interpret monitoring results for an auto predictor.</p>
|
|
3789
|
+
*/
|
|
3790
|
+
Baseline?: Baseline;
|
|
3791
|
+
/**
|
|
3792
|
+
* <p>An error message, if any, for the monitor.</p>
|
|
3793
|
+
*/
|
|
3794
|
+
Message?: string;
|
|
3795
|
+
/**
|
|
3796
|
+
* <p>The timestamp for when the monitor resource was created.</p>
|
|
3797
|
+
*/
|
|
3798
|
+
CreationTime?: Date;
|
|
3799
|
+
/**
|
|
3800
|
+
* <p>The timestamp of the latest modification to the monitor.</p>
|
|
3801
|
+
*/
|
|
3802
|
+
LastModificationTime?: Date;
|
|
3803
|
+
/**
|
|
3804
|
+
* <p>The estimated number of minutes remaining before the monitor resource finishes its current evaluation.</p>
|
|
3805
|
+
*/
|
|
3806
|
+
EstimatedEvaluationTimeRemainingInMinutes?: number;
|
|
3807
|
+
}
|
|
3808
|
+
export declare namespace DescribeMonitorResponse {
|
|
3809
|
+
/**
|
|
3810
|
+
* @internal
|
|
3811
|
+
*/
|
|
3812
|
+
const filterSensitiveLog: (obj: DescribeMonitorResponse) => any;
|
|
3813
|
+
}
|
|
3558
3814
|
export interface DescribePredictorRequest {
|
|
3559
3815
|
/**
|
|
3560
3816
|
* <p>The Amazon Resource Name (ARN) of the predictor that you want information about.</p>
|
|
@@ -4158,9 +4414,9 @@ export declare namespace ListDatasetGroupsRequest {
|
|
|
4158
4414
|
const filterSensitiveLog: (obj: ListDatasetGroupsRequest) => any;
|
|
4159
4415
|
}
|
|
4160
4416
|
/**
|
|
4161
|
-
* <p>Provides a summary of the dataset group properties used in the <a>ListDatasetGroups</a> operation. To
|
|
4162
|
-
*
|
|
4163
|
-
*
|
|
4417
|
+
* <p>Provides a summary of the dataset group properties used in the <a href="https://docs.aws.amazon.com/forecast/latest/dg/API_ListDatasetGroups.html">ListDatasetGroups</a> operation. To
|
|
4418
|
+
* get the complete set of properties, call the <a href="https://docs.aws.amazon.com/forecast/latest/dg/API_DescribeDatasetGroup.html">DescribeDatasetGroup</a>
|
|
4419
|
+
* operation, and provide the <code>DatasetGroupArn</code>.</p>
|
|
4164
4420
|
*/
|
|
4165
4421
|
export interface DatasetGroupSummary {
|
|
4166
4422
|
/**
|
|
@@ -4176,7 +4432,7 @@ export interface DatasetGroupSummary {
|
|
|
4176
4432
|
*/
|
|
4177
4433
|
CreationTime?: Date;
|
|
4178
4434
|
/**
|
|
4179
|
-
* <p>When the dataset group was created or last updated from a call to the <a>UpdateDatasetGroup</a> operation. While the dataset group is being updated,
|
|
4435
|
+
* <p>When the dataset group was created or last updated from a call to the <a href="https://docs.aws.amazon.com/forecast/latest/dg/API_UpdateDatasetGroup.html">UpdateDatasetGroup</a> operation. While the dataset group is being updated,
|
|
4180
4436
|
* <code>LastModificationTime</code> is the current time of the <code>ListDatasetGroups</code>
|
|
4181
4437
|
* call.</p>
|
|
4182
4438
|
*/
|
|
@@ -4276,8 +4532,7 @@ export interface ListDatasetImportJobsRequest {
|
|
|
4276
4532
|
* <p>For example, to list all dataset import jobs whose status is ACTIVE, you specify the
|
|
4277
4533
|
* following filter:</p>
|
|
4278
4534
|
* <p>
|
|
4279
|
-
* <code>"Filters": [ { "Condition": "IS", "Key": "Status", "Value": "ACTIVE" }
|
|
4280
|
-
* ]</code>
|
|
4535
|
+
* <code>"Filters": [ { "Condition": "IS", "Key": "Status", "Value": "ACTIVE" } ]</code>
|
|
4281
4536
|
* </p>
|
|
4282
4537
|
*/
|
|
4283
4538
|
Filters?: Filter[];
|
|
@@ -4289,8 +4544,8 @@ export declare namespace ListDatasetImportJobsRequest {
|
|
|
4289
4544
|
const filterSensitiveLog: (obj: ListDatasetImportJobsRequest) => any;
|
|
4290
4545
|
}
|
|
4291
4546
|
/**
|
|
4292
|
-
* <p>Provides a summary of the dataset import job properties used in the <a>ListDatasetImportJobs</a> operation. To get the complete set of properties, call the
|
|
4293
|
-
* <a>DescribeDatasetImportJob</a> operation, and provide the
|
|
4547
|
+
* <p>Provides a summary of the dataset import job properties used in the <a href="https://docs.aws.amazon.com/forecast/latest/dg/API_ListDatasetImportJobs.html">ListDatasetImportJobs</a> operation. To get the complete set of properties, call the
|
|
4548
|
+
* <a href="https://docs.aws.amazon.com/forecast/latest/dg/API_DescribeDatasetImportJob.html">DescribeDatasetImportJob</a> operation, and provide the
|
|
4294
4549
|
* <code>DatasetImportJobArn</code>.</p>
|
|
4295
4550
|
*/
|
|
4296
4551
|
export interface DatasetImportJobSummary {
|
|
@@ -4415,9 +4670,9 @@ export declare namespace ListDatasetsRequest {
|
|
|
4415
4670
|
const filterSensitiveLog: (obj: ListDatasetsRequest) => any;
|
|
4416
4671
|
}
|
|
4417
4672
|
/**
|
|
4418
|
-
* <p>Provides a summary of the dataset properties used in the <a>ListDatasets</a>
|
|
4419
|
-
*
|
|
4420
|
-
*
|
|
4673
|
+
* <p>Provides a summary of the dataset properties used in the <a href="https://docs.aws.amazon.com/forecast/latest/dg/API_ListDatasets.html">ListDatasets</a> operation. To get the
|
|
4674
|
+
* complete set of properties, call the <a href="https://docs.aws.amazon.com/forecast/latest/dg/API_DescribeDataset.html">DescribeDataset</a> operation, and
|
|
4675
|
+
* provide the <code>DatasetArn</code>.</p>
|
|
4421
4676
|
*/
|
|
4422
4677
|
export interface DatasetSummary {
|
|
4423
4678
|
/**
|
|
@@ -4444,8 +4699,8 @@ export interface DatasetSummary {
|
|
|
4444
4699
|
* <p>When you create a dataset, <code>LastModificationTime</code> is the same as
|
|
4445
4700
|
* <code>CreationTime</code>. While data is being imported to the dataset,
|
|
4446
4701
|
* <code>LastModificationTime</code> is the current time of the <code>ListDatasets</code> call.
|
|
4447
|
-
* After a <a>CreateDatasetImportJob</a> operation has finished,
|
|
4448
|
-
*
|
|
4702
|
+
* After a <a href="https://docs.aws.amazon.com/forecast/latest/dg/API_CreateDatasetImportJob.html">CreateDatasetImportJob</a> operation has finished, <code>LastModificationTime</code> is
|
|
4703
|
+
* when the import job completed or failed.</p>
|
|
4449
4704
|
*/
|
|
4450
4705
|
LastModificationTime?: Date;
|
|
4451
4706
|
}
|
|
@@ -4545,8 +4800,8 @@ export interface ExplainabilitySummary {
|
|
|
4545
4800
|
* <ul>
|
|
4546
4801
|
* <li>
|
|
4547
4802
|
* <p>
|
|
4548
|
-
*
|
|
4549
|
-
*
|
|
4803
|
+
* <code>ACTIVE</code>
|
|
4804
|
+
* </p>
|
|
4550
4805
|
* </li>
|
|
4551
4806
|
* <li>
|
|
4552
4807
|
* <p>
|
|
@@ -4698,8 +4953,8 @@ export interface ExplainabilityExportSummary {
|
|
|
4698
4953
|
* <ul>
|
|
4699
4954
|
* <li>
|
|
4700
4955
|
* <p>
|
|
4701
|
-
*
|
|
4702
|
-
*
|
|
4956
|
+
* <code>ACTIVE</code>
|
|
4957
|
+
* </p>
|
|
4703
4958
|
* </li>
|
|
4704
4959
|
* <li>
|
|
4705
4960
|
* <p>
|
|
@@ -5112,6 +5367,337 @@ export declare namespace ListForecastsResponse {
|
|
|
5112
5367
|
*/
|
|
5113
5368
|
const filterSensitiveLog: (obj: ListForecastsResponse) => any;
|
|
5114
5369
|
}
|
|
5370
|
+
export interface ListMonitorEvaluationsRequest {
|
|
5371
|
+
/**
|
|
5372
|
+
* <p>If the result of the previous request was truncated, the response includes a
|
|
5373
|
+
* <code>NextToken</code>. To retrieve the next set of results, use the token in the next
|
|
5374
|
+
* request. Tokens expire after 24 hours.</p>
|
|
5375
|
+
*/
|
|
5376
|
+
NextToken?: string;
|
|
5377
|
+
/**
|
|
5378
|
+
* <p>The maximum number of monitoring results to return.</p>
|
|
5379
|
+
*/
|
|
5380
|
+
MaxResults?: number;
|
|
5381
|
+
/**
|
|
5382
|
+
* <p>The Amazon Resource Name (ARN) of the monitor resource to get results from.</p>
|
|
5383
|
+
*/
|
|
5384
|
+
MonitorArn: string | undefined;
|
|
5385
|
+
/**
|
|
5386
|
+
* <p>An array of filters. For each filter, provide a condition and a match statement. The
|
|
5387
|
+
* condition is either <code>IS</code> or <code>IS_NOT</code>, which specifies whether to
|
|
5388
|
+
* include or exclude the resources that match the statement from the list. The match
|
|
5389
|
+
* statement consists of a key and a value.</p>
|
|
5390
|
+
* <p>
|
|
5391
|
+
* <b>Filter properties</b>
|
|
5392
|
+
* </p>
|
|
5393
|
+
* <ul>
|
|
5394
|
+
* <li>
|
|
5395
|
+
* <p>
|
|
5396
|
+
* <code>Condition</code> - The condition to apply. Valid values are
|
|
5397
|
+
* <code>IS</code> and <code>IS_NOT</code>.</p>
|
|
5398
|
+
* </li>
|
|
5399
|
+
* <li>
|
|
5400
|
+
* <p>
|
|
5401
|
+
* <code>Key</code> - The name of the parameter to filter on. The only valid value is
|
|
5402
|
+
* <code>EvaluationState</code>.</p>
|
|
5403
|
+
* </li>
|
|
5404
|
+
* <li>
|
|
5405
|
+
* <p>
|
|
5406
|
+
* <code>Value</code> - The value to match. Valid values are only <code>SUCCESS</code> or <code>FAILURE</code>.</p>
|
|
5407
|
+
* </li>
|
|
5408
|
+
* </ul>
|
|
5409
|
+
* <p>For example, to list only successful monitor evaluations, you would specify:</p>
|
|
5410
|
+
* <p>
|
|
5411
|
+
* <code>"Filters": [ { "Condition": "IS", "Key": "EvaluationState", "Value": "SUCCESS" } ]</code>
|
|
5412
|
+
* </p>
|
|
5413
|
+
*/
|
|
5414
|
+
Filters?: Filter[];
|
|
5415
|
+
}
|
|
5416
|
+
export declare namespace ListMonitorEvaluationsRequest {
|
|
5417
|
+
/**
|
|
5418
|
+
* @internal
|
|
5419
|
+
*/
|
|
5420
|
+
const filterSensitiveLog: (obj: ListMonitorEvaluationsRequest) => any;
|
|
5421
|
+
}
|
|
5422
|
+
/**
|
|
5423
|
+
* <p>An individual metric Forecast calculated when monitoring predictor usage. You can compare the value for this metric to the metric's value in the <a>Baseline</a> to see how your predictor's performance is changing.</p>
|
|
5424
|
+
* <p>For more information about metrics generated by Forecast see <a href="https://docs.aws.amazon.com/forecast/latest/dg/metrics.html">Evaluating Predictor Accuracy</a>
|
|
5425
|
+
* </p>
|
|
5426
|
+
*/
|
|
5427
|
+
export interface MetricResult {
|
|
5428
|
+
/**
|
|
5429
|
+
* <p>The name of the metric.</p>
|
|
5430
|
+
*/
|
|
5431
|
+
MetricName?: string;
|
|
5432
|
+
/**
|
|
5433
|
+
* <p>The value for the metric.</p>
|
|
5434
|
+
*/
|
|
5435
|
+
MetricValue?: number;
|
|
5436
|
+
}
|
|
5437
|
+
export declare namespace MetricResult {
|
|
5438
|
+
/**
|
|
5439
|
+
* @internal
|
|
5440
|
+
*/
|
|
5441
|
+
const filterSensitiveLog: (obj: MetricResult) => any;
|
|
5442
|
+
}
|
|
5443
|
+
/**
|
|
5444
|
+
* <p>The source of the data the monitor used during the evaluation.</p>
|
|
5445
|
+
*/
|
|
5446
|
+
export interface MonitorDataSource {
|
|
5447
|
+
/**
|
|
5448
|
+
* <p>The Amazon Resource Name (ARN) of the dataset import job used to import the data that initiated the monitor evaluation.</p>
|
|
5449
|
+
*/
|
|
5450
|
+
DatasetImportJobArn?: string;
|
|
5451
|
+
/**
|
|
5452
|
+
* <p>The Amazon Resource Name (ARN) of the forecast the monitor used during the evaluation.</p>
|
|
5453
|
+
*/
|
|
5454
|
+
ForecastArn?: string;
|
|
5455
|
+
/**
|
|
5456
|
+
* <p>The Amazon Resource Name (ARN) of the predictor resource you are monitoring.</p>
|
|
5457
|
+
*/
|
|
5458
|
+
PredictorArn?: string;
|
|
5459
|
+
}
|
|
5460
|
+
export declare namespace MonitorDataSource {
|
|
5461
|
+
/**
|
|
5462
|
+
* @internal
|
|
5463
|
+
*/
|
|
5464
|
+
const filterSensitiveLog: (obj: MonitorDataSource) => any;
|
|
5465
|
+
}
|
|
5466
|
+
/**
|
|
5467
|
+
* <p>Provides details about a predictor event, such as a retraining.</p>
|
|
5468
|
+
*/
|
|
5469
|
+
export interface PredictorEvent {
|
|
5470
|
+
/**
|
|
5471
|
+
* <p>The type of event. For example, <code>Retrain</code>. A retraining event denotes the timepoint when a predictor was retrained. Any monitor results from before the <code>Datetime</code> are from the previous predictor. Any new metrics are for the newly retrained predictor.</p>
|
|
5472
|
+
*/
|
|
5473
|
+
Detail?: string;
|
|
5474
|
+
/**
|
|
5475
|
+
* <p>The timestamp for when the event occurred.</p>
|
|
5476
|
+
*/
|
|
5477
|
+
Datetime?: Date;
|
|
5478
|
+
}
|
|
5479
|
+
export declare namespace PredictorEvent {
|
|
5480
|
+
/**
|
|
5481
|
+
* @internal
|
|
5482
|
+
*/
|
|
5483
|
+
const filterSensitiveLog: (obj: PredictorEvent) => any;
|
|
5484
|
+
}
|
|
5485
|
+
/**
|
|
5486
|
+
* <p>Describes the results of a monitor evaluation.</p>
|
|
5487
|
+
*/
|
|
5488
|
+
export interface PredictorMonitorEvaluation {
|
|
5489
|
+
ResourceArn?: string;
|
|
5490
|
+
MonitorArn?: string;
|
|
5491
|
+
/**
|
|
5492
|
+
* <p>The timestamp that indicates when the monitor evaluation was started. </p>
|
|
5493
|
+
*/
|
|
5494
|
+
EvaluationTime?: Date;
|
|
5495
|
+
/**
|
|
5496
|
+
* <p>The status of the monitor evaluation. The state can be <code>SUCCESS</code> or <code>FAILURE</code>.</p>
|
|
5497
|
+
*/
|
|
5498
|
+
EvaluationState?: string;
|
|
5499
|
+
/**
|
|
5500
|
+
* <p>The timestamp that indicates the start of the window that is used for monitor evaluation.</p>
|
|
5501
|
+
*/
|
|
5502
|
+
WindowStartDatetime?: Date;
|
|
5503
|
+
/**
|
|
5504
|
+
* <p>The timestamp that indicates the end of the window that is used for monitor evaluation.</p>
|
|
5505
|
+
*/
|
|
5506
|
+
WindowEndDatetime?: Date;
|
|
5507
|
+
/**
|
|
5508
|
+
* <p>Provides details about a predictor event, such as a retraining.</p>
|
|
5509
|
+
*/
|
|
5510
|
+
PredictorEvent?: PredictorEvent;
|
|
5511
|
+
/**
|
|
5512
|
+
* <p>The source of the data the monitor resource used during the evaluation.</p>
|
|
5513
|
+
*/
|
|
5514
|
+
MonitorDataSource?: MonitorDataSource;
|
|
5515
|
+
/**
|
|
5516
|
+
* <p>A list of metrics Forecast calculated when monitoring a predictor. You can compare the value for each metric in the list to the metric's value in the <a>Baseline</a> to see how your predictor's performance is changing.</p>
|
|
5517
|
+
*/
|
|
5518
|
+
MetricResults?: MetricResult[];
|
|
5519
|
+
/**
|
|
5520
|
+
* <p>The number of items considered during the evaluation.</p>
|
|
5521
|
+
*/
|
|
5522
|
+
NumItemsEvaluated?: number;
|
|
5523
|
+
/**
|
|
5524
|
+
* <p>Information about any errors that may have occurred during the monitor evaluation.</p>
|
|
5525
|
+
*/
|
|
5526
|
+
Message?: string;
|
|
5527
|
+
}
|
|
5528
|
+
export declare namespace PredictorMonitorEvaluation {
|
|
5529
|
+
/**
|
|
5530
|
+
* @internal
|
|
5531
|
+
*/
|
|
5532
|
+
const filterSensitiveLog: (obj: PredictorMonitorEvaluation) => any;
|
|
5533
|
+
}
|
|
5534
|
+
export interface ListMonitorEvaluationsResponse {
|
|
5535
|
+
/**
|
|
5536
|
+
* <p>If the response is truncated, Amazon Forecast returns this token. To retrieve the next set of
|
|
5537
|
+
* results, use the token in the next request. Tokens expire after 24 hours.</p>
|
|
5538
|
+
*/
|
|
5539
|
+
NextToken?: string;
|
|
5540
|
+
/**
|
|
5541
|
+
* <p>The monitoring results and predictor events collected by the monitor resource during different windows of time.</p>
|
|
5542
|
+
* <p>For information about monitoring see <a href="https://docs.aws.amazon.com/forecast/latest/dg/predictor-monitoring-results.html">Viewing Monitoring Results</a>. For 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>
|
|
5543
|
+
*/
|
|
5544
|
+
PredictorMonitorEvaluations?: PredictorMonitorEvaluation[];
|
|
5545
|
+
}
|
|
5546
|
+
export declare namespace ListMonitorEvaluationsResponse {
|
|
5547
|
+
/**
|
|
5548
|
+
* @internal
|
|
5549
|
+
*/
|
|
5550
|
+
const filterSensitiveLog: (obj: ListMonitorEvaluationsResponse) => any;
|
|
5551
|
+
}
|
|
5552
|
+
export interface ListMonitorsRequest {
|
|
5553
|
+
/**
|
|
5554
|
+
* <p>If the result of the previous request was truncated, the response includes a
|
|
5555
|
+
* <code>NextToken</code>. To retrieve the next set of results, use the token in the next
|
|
5556
|
+
* request. Tokens expire after 24 hours.</p>
|
|
5557
|
+
*/
|
|
5558
|
+
NextToken?: string;
|
|
5559
|
+
/**
|
|
5560
|
+
* <p>The maximum number of monitors to include in the response.</p>
|
|
5561
|
+
*/
|
|
5562
|
+
MaxResults?: number;
|
|
5563
|
+
/**
|
|
5564
|
+
* <p>An array of filters. For each filter, provide a condition and a match statement. The
|
|
5565
|
+
* condition is either <code>IS</code> or <code>IS_NOT</code>, which specifies whether to
|
|
5566
|
+
* include or exclude the resources that match the statement from the list. The match
|
|
5567
|
+
* statement consists of a key and a value.</p>
|
|
5568
|
+
* <p>
|
|
5569
|
+
* <b>Filter properties</b>
|
|
5570
|
+
* </p>
|
|
5571
|
+
* <ul>
|
|
5572
|
+
* <li>
|
|
5573
|
+
* <p>
|
|
5574
|
+
* <code>Condition</code> - The condition to apply. Valid values are
|
|
5575
|
+
* <code>IS</code> and <code>IS_NOT</code>.</p>
|
|
5576
|
+
* </li>
|
|
5577
|
+
* <li>
|
|
5578
|
+
* <p>
|
|
5579
|
+
* <code>Key</code> - The name of the parameter to filter on. The only valid value is
|
|
5580
|
+
* <code>Status</code>.</p>
|
|
5581
|
+
* </li>
|
|
5582
|
+
* <li>
|
|
5583
|
+
* <p>
|
|
5584
|
+
* <code>Value</code> - The value to match.</p>
|
|
5585
|
+
* </li>
|
|
5586
|
+
* </ul>
|
|
5587
|
+
* <p>For example, to list all monitors who's status is ACTIVE, you would specify:</p>
|
|
5588
|
+
* <p>
|
|
5589
|
+
* <code>"Filters": [ { "Condition": "IS", "Key": "Status", "Value": "ACTIVE" } ]</code>
|
|
5590
|
+
* </p>
|
|
5591
|
+
*/
|
|
5592
|
+
Filters?: Filter[];
|
|
5593
|
+
}
|
|
5594
|
+
export declare namespace ListMonitorsRequest {
|
|
5595
|
+
/**
|
|
5596
|
+
* @internal
|
|
5597
|
+
*/
|
|
5598
|
+
const filterSensitiveLog: (obj: ListMonitorsRequest) => any;
|
|
5599
|
+
}
|
|
5600
|
+
/**
|
|
5601
|
+
* <p>Provides a summary of the monitor properties used in the <a>ListMonitors</a> operation. To get a complete set of properties,
|
|
5602
|
+
* call the <a>DescribeMonitor</a> operation, and provide the listed
|
|
5603
|
+
* <code>MonitorArn</code>.</p>
|
|
5604
|
+
*/
|
|
5605
|
+
export interface MonitorSummary {
|
|
5606
|
+
/**
|
|
5607
|
+
* <p>The Amazon Resource Name (ARN) of the monitor resource.</p>
|
|
5608
|
+
*/
|
|
5609
|
+
MonitorArn?: string;
|
|
5610
|
+
/**
|
|
5611
|
+
* <p>The name of the monitor resource.</p>
|
|
5612
|
+
*/
|
|
5613
|
+
MonitorName?: string;
|
|
5614
|
+
/**
|
|
5615
|
+
* <p>The Amazon Resource Name (ARN) of the predictor being monitored.</p>
|
|
5616
|
+
*/
|
|
5617
|
+
ResourceArn?: string;
|
|
5618
|
+
/**
|
|
5619
|
+
* <p>The status of the monitor. States include:</p>
|
|
5620
|
+
* <ul>
|
|
5621
|
+
* <li>
|
|
5622
|
+
* <p>
|
|
5623
|
+
* <code>ACTIVE</code>
|
|
5624
|
+
* </p>
|
|
5625
|
+
* </li>
|
|
5626
|
+
* <li>
|
|
5627
|
+
* <p>
|
|
5628
|
+
* <code>ACTIVE_STOPPING</code>, <code>ACTIVE_STOPPED</code>
|
|
5629
|
+
* </p>
|
|
5630
|
+
* </li>
|
|
5631
|
+
* <li>
|
|
5632
|
+
* <p>
|
|
5633
|
+
* <code>UPDATE_IN_PROGRESS</code>
|
|
5634
|
+
* </p>
|
|
5635
|
+
* </li>
|
|
5636
|
+
* <li>
|
|
5637
|
+
* <p>
|
|
5638
|
+
* <code>CREATE_PENDING</code>, <code>CREATE_IN_PROGRESS</code>, <code>CREATE_FAILED</code>
|
|
5639
|
+
* </p>
|
|
5640
|
+
* </li>
|
|
5641
|
+
* <li>
|
|
5642
|
+
* <p>
|
|
5643
|
+
* <code>DELETE_PENDING</code>, <code>DELETE_IN_PROGRESS</code>, <code>DELETE_FAILED</code>
|
|
5644
|
+
* </p>
|
|
5645
|
+
* </li>
|
|
5646
|
+
* </ul>
|
|
5647
|
+
*/
|
|
5648
|
+
Status?: string;
|
|
5649
|
+
/**
|
|
5650
|
+
* <p>When the monitor resource was created.</p>
|
|
5651
|
+
*/
|
|
5652
|
+
CreationTime?: Date;
|
|
5653
|
+
/**
|
|
5654
|
+
* <p>The last time the monitor resource was modified. The timestamp depends on the status of the
|
|
5655
|
+
* job:</p>
|
|
5656
|
+
* <ul>
|
|
5657
|
+
* <li>
|
|
5658
|
+
* <p>
|
|
5659
|
+
* <code>CREATE_PENDING</code> - The <code>CreationTime</code>.</p>
|
|
5660
|
+
* </li>
|
|
5661
|
+
* <li>
|
|
5662
|
+
* <p>
|
|
5663
|
+
* <code>CREATE_IN_PROGRESS</code> - The current timestamp.</p>
|
|
5664
|
+
* </li>
|
|
5665
|
+
* <li>
|
|
5666
|
+
* <p>
|
|
5667
|
+
* <code>STOPPED</code> - When the resource stopped.</p>
|
|
5668
|
+
* </li>
|
|
5669
|
+
* <li>
|
|
5670
|
+
* <p>
|
|
5671
|
+
* <code>ACTIVE</code> or <code>CREATE_FAILED</code> - When the monitor creation finished or
|
|
5672
|
+
* failed.</p>
|
|
5673
|
+
* </li>
|
|
5674
|
+
* </ul>
|
|
5675
|
+
*/
|
|
5676
|
+
LastModificationTime?: Date;
|
|
5677
|
+
}
|
|
5678
|
+
export declare namespace MonitorSummary {
|
|
5679
|
+
/**
|
|
5680
|
+
* @internal
|
|
5681
|
+
*/
|
|
5682
|
+
const filterSensitiveLog: (obj: MonitorSummary) => any;
|
|
5683
|
+
}
|
|
5684
|
+
export interface ListMonitorsResponse {
|
|
5685
|
+
/**
|
|
5686
|
+
* <p>An array of objects that summarize each monitor's properties.</p>
|
|
5687
|
+
*/
|
|
5688
|
+
Monitors?: MonitorSummary[];
|
|
5689
|
+
/**
|
|
5690
|
+
* <p>If the response is truncated, Amazon Forecast returns this token. To retrieve the next set of
|
|
5691
|
+
* results, use the token in the next request.</p>
|
|
5692
|
+
*/
|
|
5693
|
+
NextToken?: string;
|
|
5694
|
+
}
|
|
5695
|
+
export declare namespace ListMonitorsResponse {
|
|
5696
|
+
/**
|
|
5697
|
+
* @internal
|
|
5698
|
+
*/
|
|
5699
|
+
const filterSensitiveLog: (obj: ListMonitorsResponse) => any;
|
|
5700
|
+
}
|
|
5115
5701
|
export interface ListPredictorBacktestExportJobsRequest {
|
|
5116
5702
|
/**
|
|
5117
5703
|
* <p>If the result of the previous request was truncated, the response includes a
|
|
@@ -5460,6 +6046,18 @@ export declare namespace ListTagsForResourceResponse {
|
|
|
5460
6046
|
*/
|
|
5461
6047
|
const filterSensitiveLog: (obj: ListTagsForResourceResponse) => any;
|
|
5462
6048
|
}
|
|
6049
|
+
export interface ResumeResourceRequest {
|
|
6050
|
+
/**
|
|
6051
|
+
* <p>The Amazon Resource Name (ARN) of the monitor resource to resume.</p>
|
|
6052
|
+
*/
|
|
6053
|
+
ResourceArn: string | undefined;
|
|
6054
|
+
}
|
|
6055
|
+
export declare namespace ResumeResourceRequest {
|
|
6056
|
+
/**
|
|
6057
|
+
* @internal
|
|
6058
|
+
*/
|
|
6059
|
+
const filterSensitiveLog: (obj: ResumeResourceRequest) => any;
|
|
6060
|
+
}
|
|
5463
6061
|
export interface StopResourceRequest {
|
|
5464
6062
|
/**
|
|
5465
6063
|
* <p>The Amazon Resource Name (ARN) that identifies the resource to stop. The supported ARNs
|