@aws-sdk/client-forecast 3.43.0 → 3.45.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 +11 -0
- package/dist-cjs/endpoints.js +1 -0
- package/dist-cjs/protocols/Aws_json1_1.js +3 -0
- package/dist-es/endpoints.js +1 -0
- package/dist-es/protocols/Aws_json1_1.js +3 -0
- package/dist-types/Forecast.d.ts +34 -27
- package/dist-types/commands/CreateAutoPredictorCommand.d.ts +1 -1
- package/dist-types/commands/CreateExplainabilityCommand.d.ts +1 -1
- package/dist-types/commands/CreatePredictorBacktestExportJobCommand.d.ts +4 -4
- package/dist-types/commands/CreatePredictorCommand.d.ts +1 -1
- package/dist-types/commands/DeleteExplainabilityExportCommand.d.ts +1 -1
- package/dist-types/commands/DeletePredictorCommand.d.ts +2 -3
- package/dist-types/commands/DescribePredictorBacktestExportJobCommand.d.ts +1 -1
- package/dist-types/commands/DescribePredictorCommand.d.ts +1 -2
- package/dist-types/commands/ListPredictorBacktestExportJobsCommand.d.ts +4 -4
- package/dist-types/commands/ListPredictorsCommand.d.ts +5 -5
- package/dist-types/commands/StopResourceCommand.d.ts +9 -3
- package/dist-types/commands/TagResourceCommand.d.ts +4 -1
- package/dist-types/models/models_0.d.ts +305 -140
- package/dist-types/ts3.4/models/models_0.d.ts +8 -0
- package/package.json +5 -5
|
@@ -33,7 +33,7 @@ export interface AdditionalDataset {
|
|
|
33
33
|
* <p>
|
|
34
34
|
* <b>Holidays</b>
|
|
35
35
|
* </p>
|
|
36
|
-
* <p>To enable Holidays,
|
|
36
|
+
* <p>To enable Holidays, set <code>CountryCode</code> to one of the following two-letter country
|
|
37
37
|
* codes:</p>
|
|
38
38
|
* <ul>
|
|
39
39
|
* <li>
|
|
@@ -400,14 +400,16 @@ export declare enum OptimizationMetric {
|
|
|
400
400
|
WAPE = "WAPE"
|
|
401
401
|
}
|
|
402
402
|
/**
|
|
403
|
-
* <p>The optional metadata that you apply to a resource to help you categorize and organize
|
|
403
|
+
* <p>The optional metadata that you apply to a resource to help you categorize and organize
|
|
404
|
+
* them. Each tag consists of a key and an optional value, both of which you define.</p>
|
|
404
405
|
* <p>The following basic restrictions apply to tags:</p>
|
|
405
406
|
* <ul>
|
|
406
407
|
* <li>
|
|
407
408
|
* <p>Maximum number of tags per resource - 50.</p>
|
|
408
409
|
* </li>
|
|
409
410
|
* <li>
|
|
410
|
-
* <p>For each resource, each tag key must be unique, and each tag key can have only one
|
|
411
|
+
* <p>For each resource, each tag key must be unique, and each tag key can have only one
|
|
412
|
+
* value.</p>
|
|
411
413
|
* </li>
|
|
412
414
|
* <li>
|
|
413
415
|
* <p>Maximum key length - 128 Unicode characters in UTF-8.</p>
|
|
@@ -416,23 +418,33 @@ export declare enum OptimizationMetric {
|
|
|
416
418
|
* <p>Maximum value length - 256 Unicode characters in UTF-8.</p>
|
|
417
419
|
* </li>
|
|
418
420
|
* <li>
|
|
419
|
-
* <p>If your tagging schema is used across multiple services and resources, remember that
|
|
421
|
+
* <p>If your tagging schema is used across multiple services and resources, remember that
|
|
422
|
+
* other services may have restrictions on allowed characters. Generally allowed characters
|
|
423
|
+
* are: letters, numbers, and spaces representable in UTF-8, and the following characters: +
|
|
424
|
+
* - = . _ : / @.</p>
|
|
420
425
|
* </li>
|
|
421
426
|
* <li>
|
|
422
427
|
* <p>Tag keys and values are case sensitive.</p>
|
|
423
428
|
* </li>
|
|
424
429
|
* <li>
|
|
425
|
-
* <p>Do not use <code>aws:</code>, <code>AWS:</code>, or any upper or lowercase combination
|
|
430
|
+
* <p>Do not use <code>aws:</code>, <code>AWS:</code>, or any upper or lowercase combination
|
|
431
|
+
* of such as a prefix for keys as it is reserved for AWS use. You cannot edit or delete tag
|
|
432
|
+
* keys with this prefix. Values can have this prefix. If a tag value has <code>aws</code> as
|
|
433
|
+
* its prefix but the key does not, then Forecast considers it to be a user tag and will
|
|
434
|
+
* count against the limit of 50 tags. Tags with only the key prefix of <code>aws</code> do
|
|
435
|
+
* not count against your tags per resource limit.</p>
|
|
426
436
|
* </li>
|
|
427
437
|
* </ul>
|
|
428
438
|
*/
|
|
429
439
|
export interface Tag {
|
|
430
440
|
/**
|
|
431
|
-
* <p>One part of a key-value pair that makes up a tag. A <code>key</code> is a general label
|
|
441
|
+
* <p>One part of a key-value pair that makes up a tag. A <code>key</code> is a general label
|
|
442
|
+
* that acts like a category for more specific tag values.</p>
|
|
432
443
|
*/
|
|
433
444
|
Key: string | undefined;
|
|
434
445
|
/**
|
|
435
|
-
* <p>The optional part of a key-value pair that makes up a tag. A <code>value</code> acts as a
|
|
446
|
+
* <p>The optional part of a key-value pair that makes up a tag. A <code>value</code> acts as a
|
|
447
|
+
* descriptor within a tag category (key).</p>
|
|
436
448
|
*/
|
|
437
449
|
Value: string | undefined;
|
|
438
450
|
}
|
|
@@ -500,6 +512,9 @@ export interface CreateAutoPredictorRequest {
|
|
|
500
512
|
* <p>The accuracy metric used to optimize the predictor.</p>
|
|
501
513
|
*/
|
|
502
514
|
OptimizationMetric?: OptimizationMetric | string;
|
|
515
|
+
/**
|
|
516
|
+
* <p>Create an Explainability resource for the predictor.</p>
|
|
517
|
+
*/
|
|
503
518
|
ExplainPredictor?: boolean;
|
|
504
519
|
/**
|
|
505
520
|
* <p>Optional metadata to help you categorize and organize your predictors. Each tag
|
|
@@ -670,7 +685,7 @@ export declare namespace SchemaAttribute {
|
|
|
670
685
|
const filterSensitiveLog: (obj: SchemaAttribute) => any;
|
|
671
686
|
}
|
|
672
687
|
/**
|
|
673
|
-
* <p>Defines the fields of a dataset
|
|
688
|
+
* <p>Defines the fields of a dataset.</p>
|
|
674
689
|
*/
|
|
675
690
|
export interface Schema {
|
|
676
691
|
/**
|
|
@@ -724,14 +739,16 @@ export interface CreateDatasetRequest {
|
|
|
724
739
|
*/
|
|
725
740
|
EncryptionConfig?: EncryptionConfig;
|
|
726
741
|
/**
|
|
727
|
-
* <p>The optional metadata that you apply to the dataset to help you categorize and organize
|
|
742
|
+
* <p>The optional metadata that you apply to the dataset to help you categorize and organize
|
|
743
|
+
* them. Each tag consists of a key and an optional value, both of which you define.</p>
|
|
728
744
|
* <p>The following basic restrictions apply to tags:</p>
|
|
729
745
|
* <ul>
|
|
730
746
|
* <li>
|
|
731
747
|
* <p>Maximum number of tags per resource - 50.</p>
|
|
732
748
|
* </li>
|
|
733
749
|
* <li>
|
|
734
|
-
* <p>For each resource, each tag key must be unique, and each tag key can have only one
|
|
750
|
+
* <p>For each resource, each tag key must be unique, and each tag key can have only one
|
|
751
|
+
* value.</p>
|
|
735
752
|
* </li>
|
|
736
753
|
* <li>
|
|
737
754
|
* <p>Maximum key length - 128 Unicode characters in UTF-8.</p>
|
|
@@ -740,13 +757,21 @@ export interface CreateDatasetRequest {
|
|
|
740
757
|
* <p>Maximum value length - 256 Unicode characters in UTF-8.</p>
|
|
741
758
|
* </li>
|
|
742
759
|
* <li>
|
|
743
|
-
* <p>If your tagging schema is used across multiple services and resources, remember that
|
|
760
|
+
* <p>If your tagging schema is used across multiple services and resources, remember that
|
|
761
|
+
* other services may have restrictions on allowed characters. Generally allowed characters
|
|
762
|
+
* are: letters, numbers, and spaces representable in UTF-8, and the following characters: +
|
|
763
|
+
* - = . _ : / @.</p>
|
|
744
764
|
* </li>
|
|
745
765
|
* <li>
|
|
746
766
|
* <p>Tag keys and values are case sensitive.</p>
|
|
747
767
|
* </li>
|
|
748
768
|
* <li>
|
|
749
|
-
* <p>Do not use <code>aws:</code>, <code>AWS:</code>, or any upper or lowercase combination
|
|
769
|
+
* <p>Do not use <code>aws:</code>, <code>AWS:</code>, or any upper or lowercase combination
|
|
770
|
+
* of such as a prefix for keys as it is reserved for AWS use. You cannot edit or delete tag
|
|
771
|
+
* keys with this prefix. Values can have this prefix. If a tag value has <code>aws</code> as
|
|
772
|
+
* its prefix but the key does not, then Forecast considers it to be a user tag and will
|
|
773
|
+
* count against the limit of 50 tags. Tags with only the key prefix of <code>aws</code> do
|
|
774
|
+
* not count against your tags per resource limit.</p>
|
|
750
775
|
* </li>
|
|
751
776
|
* </ul>
|
|
752
777
|
*/
|
|
@@ -792,14 +817,17 @@ export interface CreateDatasetGroupRequest {
|
|
|
792
817
|
*/
|
|
793
818
|
DatasetArns?: string[];
|
|
794
819
|
/**
|
|
795
|
-
* <p>The optional metadata that you apply to the dataset group to help you categorize and
|
|
820
|
+
* <p>The optional metadata that you apply to the dataset group to help you categorize and
|
|
821
|
+
* organize them. Each tag consists of a key and an optional value, both of which you
|
|
822
|
+
* define.</p>
|
|
796
823
|
* <p>The following basic restrictions apply to tags:</p>
|
|
797
824
|
* <ul>
|
|
798
825
|
* <li>
|
|
799
826
|
* <p>Maximum number of tags per resource - 50.</p>
|
|
800
827
|
* </li>
|
|
801
828
|
* <li>
|
|
802
|
-
* <p>For each resource, each tag key must be unique, and each tag key can have only one
|
|
829
|
+
* <p>For each resource, each tag key must be unique, and each tag key can have only one
|
|
830
|
+
* value.</p>
|
|
803
831
|
* </li>
|
|
804
832
|
* <li>
|
|
805
833
|
* <p>Maximum key length - 128 Unicode characters in UTF-8.</p>
|
|
@@ -808,13 +836,21 @@ export interface CreateDatasetGroupRequest {
|
|
|
808
836
|
* <p>Maximum value length - 256 Unicode characters in UTF-8.</p>
|
|
809
837
|
* </li>
|
|
810
838
|
* <li>
|
|
811
|
-
* <p>If your tagging schema is used across multiple services and resources, remember that
|
|
839
|
+
* <p>If your tagging schema is used across multiple services and resources, remember that
|
|
840
|
+
* other services may have restrictions on allowed characters. Generally allowed characters
|
|
841
|
+
* are: letters, numbers, and spaces representable in UTF-8, and the following characters: +
|
|
842
|
+
* - = . _ : / @.</p>
|
|
812
843
|
* </li>
|
|
813
844
|
* <li>
|
|
814
845
|
* <p>Tag keys and values are case sensitive.</p>
|
|
815
846
|
* </li>
|
|
816
847
|
* <li>
|
|
817
|
-
* <p>Do not use <code>aws:</code>, <code>AWS:</code>, or any upper or lowercase combination
|
|
848
|
+
* <p>Do not use <code>aws:</code>, <code>AWS:</code>, or any upper or lowercase combination
|
|
849
|
+
* of such as a prefix for keys as it is reserved for AWS use. You cannot edit or delete tag
|
|
850
|
+
* keys with this prefix. Values can have this prefix. If a tag value has <code>aws</code> as
|
|
851
|
+
* its prefix but the key does not, then Forecast considers it to be a user tag and will
|
|
852
|
+
* count against the limit of 50 tags. Tags with only the key prefix of <code>aws</code> do
|
|
853
|
+
* not count against your tags per resource limit.</p>
|
|
818
854
|
* </li>
|
|
819
855
|
* </ul>
|
|
820
856
|
*/
|
|
@@ -868,13 +904,12 @@ export declare namespace S3Config {
|
|
|
868
904
|
const filterSensitiveLog: (obj: S3Config) => any;
|
|
869
905
|
}
|
|
870
906
|
/**
|
|
871
|
-
* <p>The source of your
|
|
872
|
-
* access the data and, optionally, an AWS Key Management Service (KMS) key
|
|
873
|
-
* <a>CreateDatasetImportJob</a> request.</p>
|
|
907
|
+
* <p>The source of your data, an AWS Identity and Access Management (IAM) role that allows Amazon Forecast to
|
|
908
|
+
* access the data and, optionally, an AWS Key Management Service (KMS) key.</p>
|
|
874
909
|
*/
|
|
875
910
|
export interface DataSource {
|
|
876
911
|
/**
|
|
877
|
-
* <p>The path to the
|
|
912
|
+
* <p>The path to the data stored in an Amazon Simple Storage Service (Amazon S3) bucket along with the
|
|
878
913
|
* credentials to access the data.</p>
|
|
879
914
|
*/
|
|
880
915
|
S3Config: S3Config | undefined;
|
|
@@ -954,14 +989,17 @@ export interface CreateDatasetImportJobRequest {
|
|
|
954
989
|
*/
|
|
955
990
|
GeolocationFormat?: string;
|
|
956
991
|
/**
|
|
957
|
-
* <p>The optional metadata that you apply to the dataset import job to help you categorize and
|
|
992
|
+
* <p>The optional metadata that you apply to the dataset import job to help you categorize and
|
|
993
|
+
* organize them. Each tag consists of a key and an optional value, both of which you
|
|
994
|
+
* define.</p>
|
|
958
995
|
* <p>The following basic restrictions apply to tags:</p>
|
|
959
996
|
* <ul>
|
|
960
997
|
* <li>
|
|
961
998
|
* <p>Maximum number of tags per resource - 50.</p>
|
|
962
999
|
* </li>
|
|
963
1000
|
* <li>
|
|
964
|
-
* <p>For each resource, each tag key must be unique, and each tag key can have only one
|
|
1001
|
+
* <p>For each resource, each tag key must be unique, and each tag key can have only one
|
|
1002
|
+
* value.</p>
|
|
965
1003
|
* </li>
|
|
966
1004
|
* <li>
|
|
967
1005
|
* <p>Maximum key length - 128 Unicode characters in UTF-8.</p>
|
|
@@ -970,13 +1008,21 @@ export interface CreateDatasetImportJobRequest {
|
|
|
970
1008
|
* <p>Maximum value length - 256 Unicode characters in UTF-8.</p>
|
|
971
1009
|
* </li>
|
|
972
1010
|
* <li>
|
|
973
|
-
* <p>If your tagging schema is used across multiple services and resources, remember that
|
|
1011
|
+
* <p>If your tagging schema is used across multiple services and resources, remember that
|
|
1012
|
+
* other services may have restrictions on allowed characters. Generally allowed characters
|
|
1013
|
+
* are: letters, numbers, and spaces representable in UTF-8, and the following characters: +
|
|
1014
|
+
* - = . _ : / @.</p>
|
|
974
1015
|
* </li>
|
|
975
1016
|
* <li>
|
|
976
1017
|
* <p>Tag keys and values are case sensitive.</p>
|
|
977
1018
|
* </li>
|
|
978
1019
|
* <li>
|
|
979
|
-
* <p>Do not use <code>aws:</code>, <code>AWS:</code>, or any upper or lowercase combination
|
|
1020
|
+
* <p>Do not use <code>aws:</code>, <code>AWS:</code>, or any upper or lowercase combination
|
|
1021
|
+
* of such as a prefix for keys as it is reserved for AWS use. You cannot edit or delete tag
|
|
1022
|
+
* keys with this prefix. Values can have this prefix. If a tag value has <code>aws</code> as
|
|
1023
|
+
* its prefix but the key does not, then Forecast considers it to be a user tag and will
|
|
1024
|
+
* count against the limit of 50 tags. Tags with only the key prefix of <code>aws</code> do
|
|
1025
|
+
* not count against your tags per resource limit.</p>
|
|
980
1026
|
* </li>
|
|
981
1027
|
* </ul>
|
|
982
1028
|
*/
|
|
@@ -1058,13 +1104,12 @@ export interface CreateExplainabilityRequest {
|
|
|
1058
1104
|
*/
|
|
1059
1105
|
ExplainabilityConfig: ExplainabilityConfig | undefined;
|
|
1060
1106
|
/**
|
|
1061
|
-
* <p>The source of your
|
|
1062
|
-
* access the data and, optionally, an AWS Key Management Service (KMS) key
|
|
1063
|
-
* <a>CreateDatasetImportJob</a> request.</p>
|
|
1107
|
+
* <p>The source of your data, an AWS Identity and Access Management (IAM) role that allows Amazon Forecast to
|
|
1108
|
+
* access the data and, optionally, an AWS Key Management Service (KMS) key.</p>
|
|
1064
1109
|
*/
|
|
1065
1110
|
DataSource?: DataSource;
|
|
1066
1111
|
/**
|
|
1067
|
-
* <p>Defines the fields of a dataset
|
|
1112
|
+
* <p>Defines the fields of a dataset.</p>
|
|
1068
1113
|
*/
|
|
1069
1114
|
Schema?: Schema;
|
|
1070
1115
|
/**
|
|
@@ -1074,11 +1119,13 @@ export interface CreateExplainabilityRequest {
|
|
|
1074
1119
|
/**
|
|
1075
1120
|
* <p>If <code>TimePointGranularity</code> is set to <code>SPECIFIC</code>, define the first
|
|
1076
1121
|
* point for the Explainability.</p>
|
|
1122
|
+
* <p>Use the following timestamp format: yyyy-MM-ddTHH:mm:ss (example: 2015-01-01T20:00:00)</p>
|
|
1077
1123
|
*/
|
|
1078
1124
|
StartDateTime?: string;
|
|
1079
1125
|
/**
|
|
1080
1126
|
* <p>If <code>TimePointGranularity</code> is set to <code>SPECIFIC</code>, define the last
|
|
1081
1127
|
* time point for the Explainability.</p>
|
|
1128
|
+
* <p>Use the following timestamp format: yyyy-MM-ddTHH:mm:ss (example: 2015-01-01T20:00:00)</p>
|
|
1082
1129
|
*/
|
|
1083
1130
|
EndDateTime?: string;
|
|
1084
1131
|
/**
|
|
@@ -1238,14 +1285,16 @@ export interface CreateForecastRequest {
|
|
|
1238
1285
|
*/
|
|
1239
1286
|
ForecastTypes?: string[];
|
|
1240
1287
|
/**
|
|
1241
|
-
* <p>The optional metadata that you apply to the forecast to help you categorize and organize
|
|
1288
|
+
* <p>The optional metadata that you apply to the forecast to help you categorize and organize
|
|
1289
|
+
* them. Each tag consists of a key and an optional value, both of which you define.</p>
|
|
1242
1290
|
* <p>The following basic restrictions apply to tags:</p>
|
|
1243
1291
|
* <ul>
|
|
1244
1292
|
* <li>
|
|
1245
1293
|
* <p>Maximum number of tags per resource - 50.</p>
|
|
1246
1294
|
* </li>
|
|
1247
1295
|
* <li>
|
|
1248
|
-
* <p>For each resource, each tag key must be unique, and each tag key can have only one
|
|
1296
|
+
* <p>For each resource, each tag key must be unique, and each tag key can have only one
|
|
1297
|
+
* value.</p>
|
|
1249
1298
|
* </li>
|
|
1250
1299
|
* <li>
|
|
1251
1300
|
* <p>Maximum key length - 128 Unicode characters in UTF-8.</p>
|
|
@@ -1254,13 +1303,21 @@ export interface CreateForecastRequest {
|
|
|
1254
1303
|
* <p>Maximum value length - 256 Unicode characters in UTF-8.</p>
|
|
1255
1304
|
* </li>
|
|
1256
1305
|
* <li>
|
|
1257
|
-
* <p>If your tagging schema is used across multiple services and resources, remember that
|
|
1306
|
+
* <p>If your tagging schema is used across multiple services and resources, remember that
|
|
1307
|
+
* other services may have restrictions on allowed characters. Generally allowed characters
|
|
1308
|
+
* are: letters, numbers, and spaces representable in UTF-8, and the following characters: +
|
|
1309
|
+
* - = . _ : / @.</p>
|
|
1258
1310
|
* </li>
|
|
1259
1311
|
* <li>
|
|
1260
1312
|
* <p>Tag keys and values are case sensitive.</p>
|
|
1261
1313
|
* </li>
|
|
1262
1314
|
* <li>
|
|
1263
|
-
* <p>Do not use <code>aws:</code>, <code>AWS:</code>, or any upper or lowercase combination
|
|
1315
|
+
* <p>Do not use <code>aws:</code>, <code>AWS:</code>, or any upper or lowercase combination
|
|
1316
|
+
* of such as a prefix for keys as it is reserved for AWS use. You cannot edit or delete tag
|
|
1317
|
+
* keys with this prefix. Values can have this prefix. If a tag value has <code>aws</code> as
|
|
1318
|
+
* its prefix but the key does not, then Forecast considers it to be a user tag and will
|
|
1319
|
+
* count against the limit of 50 tags. Tags with only the key prefix of <code>aws</code> do
|
|
1320
|
+
* not count against your tags per resource limit.</p>
|
|
1264
1321
|
* </li>
|
|
1265
1322
|
* </ul>
|
|
1266
1323
|
*/
|
|
@@ -1302,14 +1359,17 @@ export interface CreateForecastExportJobRequest {
|
|
|
1302
1359
|
*/
|
|
1303
1360
|
Destination: DataDestination | undefined;
|
|
1304
1361
|
/**
|
|
1305
|
-
* <p>The optional metadata that you apply to the forecast export job to help you categorize and
|
|
1362
|
+
* <p>The optional metadata that you apply to the forecast export job to help you categorize and
|
|
1363
|
+
* organize them. Each tag consists of a key and an optional value, both of which you
|
|
1364
|
+
* define.</p>
|
|
1306
1365
|
* <p>The following basic restrictions apply to tags:</p>
|
|
1307
1366
|
* <ul>
|
|
1308
1367
|
* <li>
|
|
1309
1368
|
* <p>Maximum number of tags per resource - 50.</p>
|
|
1310
1369
|
* </li>
|
|
1311
1370
|
* <li>
|
|
1312
|
-
* <p>For each resource, each tag key must be unique, and each tag key can have only one
|
|
1371
|
+
* <p>For each resource, each tag key must be unique, and each tag key can have only one
|
|
1372
|
+
* value.</p>
|
|
1313
1373
|
* </li>
|
|
1314
1374
|
* <li>
|
|
1315
1375
|
* <p>Maximum key length - 128 Unicode characters in UTF-8.</p>
|
|
@@ -1318,13 +1378,21 @@ export interface CreateForecastExportJobRequest {
|
|
|
1318
1378
|
* <p>Maximum value length - 256 Unicode characters in UTF-8.</p>
|
|
1319
1379
|
* </li>
|
|
1320
1380
|
* <li>
|
|
1321
|
-
* <p>If your tagging schema is used across multiple services and resources, remember that
|
|
1381
|
+
* <p>If your tagging schema is used across multiple services and resources, remember that
|
|
1382
|
+
* other services may have restrictions on allowed characters. Generally allowed characters
|
|
1383
|
+
* are: letters, numbers, and spaces representable in UTF-8, and the following characters: +
|
|
1384
|
+
* - = . _ : / @.</p>
|
|
1322
1385
|
* </li>
|
|
1323
1386
|
* <li>
|
|
1324
1387
|
* <p>Tag keys and values are case sensitive.</p>
|
|
1325
1388
|
* </li>
|
|
1326
1389
|
* <li>
|
|
1327
|
-
* <p>Do not use <code>aws:</code>, <code>AWS:</code>, or any upper or lowercase combination
|
|
1390
|
+
* <p>Do not use <code>aws:</code>, <code>AWS:</code>, or any upper or lowercase combination
|
|
1391
|
+
* of such as a prefix for keys as it is reserved for AWS use. You cannot edit or delete tag
|
|
1392
|
+
* keys with this prefix. Values can have this prefix. If a tag value has <code>aws</code> as
|
|
1393
|
+
* its prefix but the key does not, then Forecast considers it to be a user tag and will
|
|
1394
|
+
* count against the limit of 50 tags. Tags with only the key prefix of <code>aws</code> do
|
|
1395
|
+
* not count against your tags per resource limit.</p>
|
|
1328
1396
|
* </li>
|
|
1329
1397
|
* </ul>
|
|
1330
1398
|
*/
|
|
@@ -1385,10 +1453,10 @@ export declare enum FeaturizationMethodName {
|
|
|
1385
1453
|
filling = "filling"
|
|
1386
1454
|
}
|
|
1387
1455
|
/**
|
|
1388
|
-
* <p>Provides information about the method that featurizes (transforms) a dataset field.
|
|
1389
|
-
*
|
|
1390
|
-
*
|
|
1391
|
-
*
|
|
1456
|
+
* <p>Provides information about the method that featurizes (transforms) a dataset field. The
|
|
1457
|
+
* method is part of the <code>FeaturizationPipeline</code> of the <a>Featurization</a> object. </p>
|
|
1458
|
+
* <p>The following is an example of how you specify a <code>FeaturizationMethod</code>
|
|
1459
|
+
* object.</p>
|
|
1392
1460
|
* <p>
|
|
1393
1461
|
* <code>{</code>
|
|
1394
1462
|
* </p>
|
|
@@ -1396,7 +1464,8 @@ export declare enum FeaturizationMethodName {
|
|
|
1396
1464
|
* <code>"FeaturizationMethodName": "filling",</code>
|
|
1397
1465
|
* </p>
|
|
1398
1466
|
* <p>
|
|
1399
|
-
* <code>"FeaturizationMethodParameters": {"aggregation": "sum", "middlefill": "zero",
|
|
1467
|
+
* <code>"FeaturizationMethodParameters": {"aggregation": "sum", "middlefill": "zero",
|
|
1468
|
+
* "backfill": "zero"}</code>
|
|
1400
1469
|
* </p>
|
|
1401
1470
|
* <p>
|
|
1402
1471
|
* <code>}</code>
|
|
@@ -1408,14 +1477,17 @@ export interface FeaturizationMethod {
|
|
|
1408
1477
|
*/
|
|
1409
1478
|
FeaturizationMethodName: FeaturizationMethodName | string | undefined;
|
|
1410
1479
|
/**
|
|
1411
|
-
* <p>The method parameters (key-value pairs), which are a map of override parameters. Specify
|
|
1412
|
-
* Related Time Series attributes do not accept
|
|
1413
|
-
*
|
|
1414
|
-
*
|
|
1480
|
+
* <p>The method parameters (key-value pairs), which are a map of override parameters. Specify
|
|
1481
|
+
* these parameters to override the default values. Related Time Series attributes do not accept
|
|
1482
|
+
* aggregation parameters.</p>
|
|
1483
|
+
* <p>The following list shows the parameters and their valid values for the "filling"
|
|
1484
|
+
* featurization method for a <b>Target Time Series</b> dataset. Bold
|
|
1485
|
+
* signifies the default value.</p>
|
|
1415
1486
|
* <ul>
|
|
1416
1487
|
* <li>
|
|
1417
1488
|
* <p>
|
|
1418
|
-
* <code>aggregation</code>: <b>sum</b>, <code>avg</code>,
|
|
1489
|
+
* <code>aggregation</code>: <b>sum</b>, <code>avg</code>,
|
|
1490
|
+
* <code>first</code>, <code>min</code>, <code>max</code>
|
|
1419
1491
|
* </p>
|
|
1420
1492
|
* </li>
|
|
1421
1493
|
* <li>
|
|
@@ -1425,12 +1497,16 @@ export interface FeaturizationMethod {
|
|
|
1425
1497
|
* </li>
|
|
1426
1498
|
* <li>
|
|
1427
1499
|
* <p>
|
|
1428
|
-
* <code>middlefill</code>: <b>zero</b>, <code>nan</code> (not
|
|
1500
|
+
* <code>middlefill</code>: <b>zero</b>, <code>nan</code> (not
|
|
1501
|
+
* a number), <code>value</code>, <code>median</code>, <code>mean</code>, <code>min</code>,
|
|
1502
|
+
* <code>max</code>
|
|
1429
1503
|
* </p>
|
|
1430
1504
|
* </li>
|
|
1431
1505
|
* <li>
|
|
1432
1506
|
* <p>
|
|
1433
|
-
* <code>backfill</code>: <b>zero</b>, <code>nan</code>,
|
|
1507
|
+
* <code>backfill</code>: <b>zero</b>, <code>nan</code>,
|
|
1508
|
+
* <code>value</code>, <code>median</code>, <code>mean</code>, <code>min</code>,
|
|
1509
|
+
* <code>max</code>
|
|
1434
1510
|
* </p>
|
|
1435
1511
|
* </li>
|
|
1436
1512
|
* </ul>
|
|
@@ -1439,17 +1515,20 @@ export interface FeaturizationMethod {
|
|
|
1439
1515
|
* <ul>
|
|
1440
1516
|
* <li>
|
|
1441
1517
|
* <p>
|
|
1442
|
-
* <code>middlefill</code>: <code>zero</code>, <code>value</code>, <code>median</code>,
|
|
1518
|
+
* <code>middlefill</code>: <code>zero</code>, <code>value</code>, <code>median</code>,
|
|
1519
|
+
* <code>mean</code>, <code>min</code>, <code>max</code>
|
|
1443
1520
|
* </p>
|
|
1444
1521
|
* </li>
|
|
1445
1522
|
* <li>
|
|
1446
1523
|
* <p>
|
|
1447
|
-
* <code>backfill</code>: <code>zero</code>, <code>value</code>, <code>median</code>,
|
|
1524
|
+
* <code>backfill</code>: <code>zero</code>, <code>value</code>, <code>median</code>,
|
|
1525
|
+
* <code>mean</code>, <code>min</code>, <code>max</code>
|
|
1448
1526
|
* </p>
|
|
1449
1527
|
* </li>
|
|
1450
1528
|
* <li>
|
|
1451
1529
|
* <p>
|
|
1452
|
-
* <code>futurefill</code>: <code>zero</code>, <code>value</code>, <code>median</code>,
|
|
1530
|
+
* <code>futurefill</code>: <code>zero</code>, <code>value</code>, <code>median</code>,
|
|
1531
|
+
* <code>mean</code>, <code>min</code>, <code>max</code>
|
|
1453
1532
|
* </p>
|
|
1454
1533
|
* </li>
|
|
1455
1534
|
* </ul>
|
|
@@ -1469,8 +1548,12 @@ export declare namespace FeaturizationMethod {
|
|
|
1469
1548
|
const filterSensitiveLog: (obj: FeaturizationMethod) => any;
|
|
1470
1549
|
}
|
|
1471
1550
|
/**
|
|
1472
|
-
* <
|
|
1473
|
-
*
|
|
1551
|
+
* <note>
|
|
1552
|
+
* <p>This object belongs to the <a>CreatePredictor</a> operation. If you created
|
|
1553
|
+
* your predictor with <a>CreateAutoPredictor</a>, see <a>AttributeConfig</a>.</p>
|
|
1554
|
+
* </note>
|
|
1555
|
+
* <p>Provides featurization (transformation) information for a dataset field. This object is
|
|
1556
|
+
* part of the <a>FeaturizationConfig</a> object.</p>
|
|
1474
1557
|
* <p>For example:</p>
|
|
1475
1558
|
* <p>
|
|
1476
1559
|
* <code>{</code>
|
|
@@ -1486,7 +1569,8 @@ export declare namespace FeaturizationMethod {
|
|
|
1486
1569
|
* <code>"FeaturizationMethodName": "filling",</code>
|
|
1487
1570
|
* </p>
|
|
1488
1571
|
* <p>
|
|
1489
|
-
* <code>"FeaturizationMethodParameters": {"aggregation": "avg", "backfill":
|
|
1572
|
+
* <code>"FeaturizationMethodParameters": {"aggregation": "avg", "backfill":
|
|
1573
|
+
* "nan"}</code>
|
|
1490
1574
|
* </p>
|
|
1491
1575
|
* <p>
|
|
1492
1576
|
* <code>} ]</code>
|
|
@@ -1497,11 +1581,11 @@ export declare namespace FeaturizationMethod {
|
|
|
1497
1581
|
*/
|
|
1498
1582
|
export interface Featurization {
|
|
1499
1583
|
/**
|
|
1500
|
-
* <p>The name of the schema attribute that specifies the data field to be featurized. Amazon
|
|
1501
|
-
*
|
|
1502
|
-
*
|
|
1503
|
-
* <code>
|
|
1504
|
-
*
|
|
1584
|
+
* <p>The name of the schema attribute that specifies the data field to be featurized. Amazon
|
|
1585
|
+
* Forecast supports the target field of the <code>TARGET_TIME_SERIES</code> and the
|
|
1586
|
+
* <code>RELATED_TIME_SERIES</code> datasets. For example, for the <code>RETAIL</code> domain,
|
|
1587
|
+
* the target is <code>demand</code>, and for the <code>CUSTOM</code> domain, the target is
|
|
1588
|
+
* <code>target_value</code>. For more information, see <a>howitworks-missing-values</a>.</p>
|
|
1505
1589
|
*/
|
|
1506
1590
|
AttributeName: string | undefined;
|
|
1507
1591
|
/**
|
|
@@ -1517,25 +1601,29 @@ export declare namespace Featurization {
|
|
|
1517
1601
|
const filterSensitiveLog: (obj: Featurization) => any;
|
|
1518
1602
|
}
|
|
1519
1603
|
/**
|
|
1520
|
-
* <
|
|
1521
|
-
*
|
|
1522
|
-
*
|
|
1523
|
-
*
|
|
1524
|
-
* <p>
|
|
1525
|
-
*
|
|
1526
|
-
*
|
|
1527
|
-
*
|
|
1528
|
-
*
|
|
1529
|
-
*
|
|
1530
|
-
*
|
|
1531
|
-
* featurization
|
|
1604
|
+
* <note>
|
|
1605
|
+
* <p>This object belongs to the <a>CreatePredictor</a> operation. If you created
|
|
1606
|
+
* your predictor with <a>CreateAutoPredictor</a>, see <a>AttributeConfig</a>.</p>
|
|
1607
|
+
* </note>
|
|
1608
|
+
* <p>In a <a>CreatePredictor</a> operation, the specified algorithm trains a model
|
|
1609
|
+
* using the specified dataset group. You can optionally tell the operation to modify data fields
|
|
1610
|
+
* prior to training a model. These modifications are referred to as
|
|
1611
|
+
* <i>featurization</i>.</p>
|
|
1612
|
+
* <p>You define featurization using the <code>FeaturizationConfig</code> object. You specify an
|
|
1613
|
+
* array of transformations, one for each field that you want to featurize. You then include the
|
|
1614
|
+
* <code>FeaturizationConfig</code> object in your <code>CreatePredictor</code> request.
|
|
1615
|
+
* Amazon Forecast applies the featurization to the <code>TARGET_TIME_SERIES</code> and
|
|
1616
|
+
* <code>RELATED_TIME_SERIES</code> datasets before model training.</p>
|
|
1617
|
+
* <p>You can create multiple featurization configurations. For example, you might call the
|
|
1618
|
+
* <code>CreatePredictor</code> operation twice by specifying different featurization
|
|
1619
|
+
* configurations.</p>
|
|
1532
1620
|
*/
|
|
1533
1621
|
export interface FeaturizationConfig {
|
|
1534
1622
|
/**
|
|
1535
1623
|
* <p>The frequency of predictions in a forecast.</p>
|
|
1536
1624
|
* <p>Valid intervals are Y (Year), M (Month), W (Week), D (Day), H (Hour), 30min (30 minutes),
|
|
1537
|
-
* 15min (15 minutes), 10min (10 minutes), 5min (5 minutes), and 1min (1 minute).
|
|
1538
|
-
*
|
|
1625
|
+
* 15min (15 minutes), 10min (10 minutes), 5min (5 minutes), and 1min (1 minute). For example,
|
|
1626
|
+
* "Y" indicates every year and "5min" indicates every five minutes.</p>
|
|
1539
1627
|
* <p>The frequency must be greater than or equal to the TARGET_TIME_SERIES dataset
|
|
1540
1628
|
* frequency.</p>
|
|
1541
1629
|
* <p>When a RELATED_TIME_SERIES dataset is provided, the frequency must be equal to the
|
|
@@ -1543,14 +1631,16 @@ export interface FeaturizationConfig {
|
|
|
1543
1631
|
*/
|
|
1544
1632
|
ForecastFrequency: string | undefined;
|
|
1545
1633
|
/**
|
|
1546
|
-
* <p>An array of dimension (field) names that specify how to group the generated
|
|
1547
|
-
*
|
|
1548
|
-
*
|
|
1549
|
-
*
|
|
1634
|
+
* <p>An array of dimension (field) names that specify how to group the generated
|
|
1635
|
+
* forecast.</p>
|
|
1636
|
+
* <p>For example, suppose that you are generating a forecast for item sales across all of your
|
|
1637
|
+
* stores, and your dataset contains a <code>store_id</code> field. If you want the sales
|
|
1638
|
+
* forecast for each item by store, you would specify <code>store_id</code> as the
|
|
1639
|
+
* dimension.</p>
|
|
1550
1640
|
* <p>All forecast dimensions specified in the <code>TARGET_TIME_SERIES</code> dataset don't
|
|
1551
|
-
* need to be specified in the <code>CreatePredictor</code> request.
|
|
1552
|
-
*
|
|
1553
|
-
*
|
|
1641
|
+
* need to be specified in the <code>CreatePredictor</code> request. All forecast dimensions
|
|
1642
|
+
* specified in the <code>RELATED_TIME_SERIES</code> dataset must be specified in the
|
|
1643
|
+
* <code>CreatePredictor</code> request.</p>
|
|
1554
1644
|
*/
|
|
1555
1645
|
ForecastDimensions?: string[];
|
|
1556
1646
|
/**
|
|
@@ -1751,7 +1841,11 @@ export declare namespace HyperParameterTuningJobConfig {
|
|
|
1751
1841
|
const filterSensitiveLog: (obj: HyperParameterTuningJobConfig) => any;
|
|
1752
1842
|
}
|
|
1753
1843
|
/**
|
|
1754
|
-
* <
|
|
1844
|
+
* <note>
|
|
1845
|
+
* <p>This object belongs to the <a>CreatePredictor</a> operation. If you created
|
|
1846
|
+
* your predictor with <a>CreateAutoPredictor</a>, see <a>AdditionalDataset</a>.</p>
|
|
1847
|
+
* </note>
|
|
1848
|
+
* <p>Describes a supplementary feature of a dataset group. This object is part of the <a>InputDataConfig</a> object. Forecast supports the Weather Index and Holidays built-in
|
|
1755
1849
|
* featurizations.</p>
|
|
1756
1850
|
* <p>
|
|
1757
1851
|
* <b>Weather Index</b>
|
|
@@ -1996,7 +2090,11 @@ export declare namespace SupplementaryFeature {
|
|
|
1996
2090
|
const filterSensitiveLog: (obj: SupplementaryFeature) => any;
|
|
1997
2091
|
}
|
|
1998
2092
|
/**
|
|
1999
|
-
* <
|
|
2093
|
+
* <note>
|
|
2094
|
+
* <p>This object belongs to the <a>CreatePredictor</a> operation. If you created
|
|
2095
|
+
* your predictor with <a>CreateAutoPredictor</a>, see <a>DataConfig</a>.</p>
|
|
2096
|
+
* </note>
|
|
2097
|
+
* <p>The data used to train a predictor. The data includes a dataset group and any
|
|
2000
2098
|
* supplementary features. You specify this object in the <a>CreatePredictor</a>
|
|
2001
2099
|
* request.</p>
|
|
2002
2100
|
*/
|
|
@@ -2159,14 +2257,16 @@ export interface CreatePredictorRequest {
|
|
|
2159
2257
|
*/
|
|
2160
2258
|
EncryptionConfig?: EncryptionConfig;
|
|
2161
2259
|
/**
|
|
2162
|
-
* <p>The optional metadata that you apply to the predictor to help you categorize and organize
|
|
2260
|
+
* <p>The optional metadata that you apply to the predictor to help you categorize and organize
|
|
2261
|
+
* them. Each tag consists of a key and an optional value, both of which you define.</p>
|
|
2163
2262
|
* <p>The following basic restrictions apply to tags:</p>
|
|
2164
2263
|
* <ul>
|
|
2165
2264
|
* <li>
|
|
2166
2265
|
* <p>Maximum number of tags per resource - 50.</p>
|
|
2167
2266
|
* </li>
|
|
2168
2267
|
* <li>
|
|
2169
|
-
* <p>For each resource, each tag key must be unique, and each tag key can have only one
|
|
2268
|
+
* <p>For each resource, each tag key must be unique, and each tag key can have only one
|
|
2269
|
+
* value.</p>
|
|
2170
2270
|
* </li>
|
|
2171
2271
|
* <li>
|
|
2172
2272
|
* <p>Maximum key length - 128 Unicode characters in UTF-8.</p>
|
|
@@ -2175,13 +2275,21 @@ export interface CreatePredictorRequest {
|
|
|
2175
2275
|
* <p>Maximum value length - 256 Unicode characters in UTF-8.</p>
|
|
2176
2276
|
* </li>
|
|
2177
2277
|
* <li>
|
|
2178
|
-
* <p>If your tagging schema is used across multiple services and resources, remember that
|
|
2278
|
+
* <p>If your tagging schema is used across multiple services and resources, remember that
|
|
2279
|
+
* other services may have restrictions on allowed characters. Generally allowed characters
|
|
2280
|
+
* are: letters, numbers, and spaces representable in UTF-8, and the following characters: +
|
|
2281
|
+
* - = . _ : / @.</p>
|
|
2179
2282
|
* </li>
|
|
2180
2283
|
* <li>
|
|
2181
2284
|
* <p>Tag keys and values are case sensitive.</p>
|
|
2182
2285
|
* </li>
|
|
2183
2286
|
* <li>
|
|
2184
|
-
* <p>Do not use <code>aws:</code>, <code>AWS:</code>, or any upper or lowercase combination
|
|
2287
|
+
* <p>Do not use <code>aws:</code>, <code>AWS:</code>, or any upper or lowercase combination
|
|
2288
|
+
* of such as a prefix for keys as it is reserved for AWS use. You cannot edit or delete tag
|
|
2289
|
+
* keys with this prefix. Values can have this prefix. If a tag value has <code>aws</code> as
|
|
2290
|
+
* its prefix but the key does not, then Forecast considers it to be a user tag and will
|
|
2291
|
+
* count against the limit of 50 tags. Tags with only the key prefix of <code>aws</code> do
|
|
2292
|
+
* not count against your tags per resource limit.</p>
|
|
2185
2293
|
* </li>
|
|
2186
2294
|
* </ul>
|
|
2187
2295
|
*/
|
|
@@ -2224,9 +2332,9 @@ export interface CreatePredictorBacktestExportJobRequest {
|
|
|
2224
2332
|
*/
|
|
2225
2333
|
Destination: DataDestination | undefined;
|
|
2226
2334
|
/**
|
|
2227
|
-
* <p>Optional metadata to help you categorize and organize your backtests. Each tag
|
|
2228
|
-
* of a key and an optional value, both of which you define. Tag keys and values
|
|
2229
|
-
* sensitive.</p>
|
|
2335
|
+
* <p>Optional metadata to help you categorize and organize your backtests. Each tag
|
|
2336
|
+
* consists of a key and an optional value, both of which you define. Tag keys and values
|
|
2337
|
+
* are case sensitive.</p>
|
|
2230
2338
|
* <p>The following restrictions apply to tags:</p>
|
|
2231
2339
|
* <ul>
|
|
2232
2340
|
* <li>
|
|
@@ -2243,17 +2351,17 @@ export interface CreatePredictorBacktestExportJobRequest {
|
|
|
2243
2351
|
* <p>Maximum value length: 256 Unicode characters in UTF-8.</p>
|
|
2244
2352
|
* </li>
|
|
2245
2353
|
* <li>
|
|
2246
|
-
* <p>Accepted characters: all letters and numbers, spaces representable in UTF-8,
|
|
2247
|
-
* - = . _ : / @. If your tagging schema is used across other services and
|
|
2248
|
-
* the character restrictions of those services also apply. </p>
|
|
2354
|
+
* <p>Accepted characters: all letters and numbers, spaces representable in UTF-8,
|
|
2355
|
+
* and + - = . _ : / @. If your tagging schema is used across other services and
|
|
2356
|
+
* resources, the character restrictions of those services also apply. </p>
|
|
2249
2357
|
* </li>
|
|
2250
2358
|
* <li>
|
|
2251
2359
|
* <p>Key prefixes cannot include any upper or lowercase combination of
|
|
2252
|
-
*
|
|
2253
|
-
* value has <code>aws</code> as its prefix but the key does not, Forecast
|
|
2254
|
-
* to be a user tag and will count against the limit of 50 tags. Tags
|
|
2255
|
-
* prefix of <code>aws</code> do not count against your tags per
|
|
2256
|
-
* cannot edit or delete tag keys with this prefix.</p>
|
|
2360
|
+
* <code>aws:</code> or <code>AWS:</code>. Values can have this prefix. If a
|
|
2361
|
+
* tag value has <code>aws</code> as its prefix but the key does not, Forecast
|
|
2362
|
+
* considers it to be a user tag and will count against the limit of 50 tags. Tags
|
|
2363
|
+
* with only the key prefix of <code>aws</code> do not count against your tags per
|
|
2364
|
+
* resource limit. You cannot edit or delete tag keys with this prefix.</p>
|
|
2257
2365
|
* </li>
|
|
2258
2366
|
* </ul>
|
|
2259
2367
|
*/
|
|
@@ -2411,8 +2519,41 @@ export declare namespace DescribeAutoPredictorRequest {
|
|
|
2411
2519
|
*/
|
|
2412
2520
|
const filterSensitiveLog: (obj: DescribeAutoPredictorRequest) => any;
|
|
2413
2521
|
}
|
|
2522
|
+
/**
|
|
2523
|
+
* <p>Provides information about the Explainability resource.</p>
|
|
2524
|
+
*/
|
|
2414
2525
|
export interface ExplainabilityInfo {
|
|
2526
|
+
/**
|
|
2527
|
+
* <p>The Amazon Resource Name (ARN) of the Explainability.</p>
|
|
2528
|
+
*/
|
|
2415
2529
|
ExplainabilityArn?: string;
|
|
2530
|
+
/**
|
|
2531
|
+
* <p>The status of the Explainability. States include: </p>
|
|
2532
|
+
* <ul>
|
|
2533
|
+
* <li>
|
|
2534
|
+
* <p>
|
|
2535
|
+
* <code>ACTIVE</code>
|
|
2536
|
+
* </p>
|
|
2537
|
+
* </li>
|
|
2538
|
+
* <li>
|
|
2539
|
+
* <p>
|
|
2540
|
+
* <code>CREATE_PENDING</code>, <code>CREATE_IN_PROGRESS</code>,
|
|
2541
|
+
* <code>CREATE_FAILED</code>
|
|
2542
|
+
* </p>
|
|
2543
|
+
* </li>
|
|
2544
|
+
* <li>
|
|
2545
|
+
* <p>
|
|
2546
|
+
* <code>CREATE_STOPPING</code>, <code>CREATE_STOPPED</code>
|
|
2547
|
+
* </p>
|
|
2548
|
+
* </li>
|
|
2549
|
+
* <li>
|
|
2550
|
+
* <p>
|
|
2551
|
+
* <code>DELETE_PENDING</code>, <code>DELETE_IN_PROGRESS</code>,
|
|
2552
|
+
* <code>DELETE_FAILED</code>
|
|
2553
|
+
* </p>
|
|
2554
|
+
* </li>
|
|
2555
|
+
* </ul>
|
|
2556
|
+
*/
|
|
2416
2557
|
Status?: string;
|
|
2417
2558
|
}
|
|
2418
2559
|
export declare namespace ExplainabilityInfo {
|
|
@@ -2471,6 +2612,10 @@ export interface DescribeAutoPredictorResponse {
|
|
|
2471
2612
|
* For example, "Y" indicates every year and "5min" indicates every five minutes.</p>
|
|
2472
2613
|
*/
|
|
2473
2614
|
ForecastFrequency?: string;
|
|
2615
|
+
/**
|
|
2616
|
+
* <p>An array of dimension (field) names that specify the attributes used to group your time series.</p>
|
|
2617
|
+
*/
|
|
2618
|
+
ForecastDimensions?: string[];
|
|
2474
2619
|
/**
|
|
2475
2620
|
* <p>An array of the ARNs of the dataset import jobs used to import training data for the
|
|
2476
2621
|
* predictor.</p>
|
|
@@ -2564,6 +2709,9 @@ export interface DescribeAutoPredictorResponse {
|
|
|
2564
2709
|
* <p>The accuracy metric used to optimize the predictor.</p>
|
|
2565
2710
|
*/
|
|
2566
2711
|
OptimizationMetric?: OptimizationMetric | string;
|
|
2712
|
+
/**
|
|
2713
|
+
* <p>Provides the status and ARN of the Predictor Explainability.</p>
|
|
2714
|
+
*/
|
|
2567
2715
|
ExplainabilityInfo?: ExplainabilityInfo;
|
|
2568
2716
|
}
|
|
2569
2717
|
export declare namespace DescribeAutoPredictorResponse {
|
|
@@ -3007,13 +3155,12 @@ export interface DescribeExplainabilityResponse {
|
|
|
3007
3155
|
*/
|
|
3008
3156
|
EnableVisualization?: boolean;
|
|
3009
3157
|
/**
|
|
3010
|
-
* <p>The source of your
|
|
3011
|
-
* access the data and, optionally, an AWS Key Management Service (KMS) key
|
|
3012
|
-
* <a>CreateDatasetImportJob</a> request.</p>
|
|
3158
|
+
* <p>The source of your data, an AWS Identity and Access Management (IAM) role that allows Amazon Forecast to
|
|
3159
|
+
* access the data and, optionally, an AWS Key Management Service (KMS) key.</p>
|
|
3013
3160
|
*/
|
|
3014
3161
|
DataSource?: DataSource;
|
|
3015
3162
|
/**
|
|
3016
|
-
* <p>Defines the fields of a dataset
|
|
3163
|
+
* <p>Defines the fields of a dataset.</p>
|
|
3017
3164
|
*/
|
|
3018
3165
|
Schema?: Schema;
|
|
3019
3166
|
/**
|
|
@@ -3734,7 +3881,7 @@ export interface DescribePredictorBacktestExportJobResponse {
|
|
|
3734
3881
|
* <li>
|
|
3735
3882
|
* <p>
|
|
3736
3883
|
* <code>CREATE_PENDING</code>, <code>CREATE_IN_PROGRESS</code>,
|
|
3737
|
-
*
|
|
3884
|
+
* <code>CREATE_FAILED</code>
|
|
3738
3885
|
* </p>
|
|
3739
3886
|
* </li>
|
|
3740
3887
|
* <li>
|
|
@@ -3745,7 +3892,7 @@ export interface DescribePredictorBacktestExportJobResponse {
|
|
|
3745
3892
|
* <li>
|
|
3746
3893
|
* <p>
|
|
3747
3894
|
* <code>DELETE_PENDING</code>, <code>DELETE_IN_PROGRESS</code>,
|
|
3748
|
-
*
|
|
3895
|
+
* <code>DELETE_FAILED</code>
|
|
3749
3896
|
* </p>
|
|
3750
3897
|
* </li>
|
|
3751
3898
|
* </ul>
|
|
@@ -3756,7 +3903,8 @@ export interface DescribePredictorBacktestExportJobResponse {
|
|
|
3756
3903
|
*/
|
|
3757
3904
|
CreationTime?: Date;
|
|
3758
3905
|
/**
|
|
3759
|
-
* <p>The last time the resource was modified. The timestamp depends on the status of the
|
|
3906
|
+
* <p>The last time the resource was modified. The timestamp depends on the status of the
|
|
3907
|
+
* job:</p>
|
|
3760
3908
|
* <ul>
|
|
3761
3909
|
* <li>
|
|
3762
3910
|
* <p>
|
|
@@ -4363,7 +4511,7 @@ export interface ListExplainabilitiesRequest {
|
|
|
4363
4511
|
* <li>
|
|
4364
4512
|
* <p>
|
|
4365
4513
|
* <code>Key</code> - The name of the parameter to filter on. Valid values are
|
|
4366
|
-
* <code>
|
|
4514
|
+
* <code>ResourceArn</code> and <code>Status</code>.</p>
|
|
4367
4515
|
* </li>
|
|
4368
4516
|
* <li>
|
|
4369
4517
|
* <p>
|
|
@@ -4521,7 +4669,7 @@ export interface ListExplainabilityExportsRequest {
|
|
|
4521
4669
|
* <li>
|
|
4522
4670
|
* <p>
|
|
4523
4671
|
* <code>Key</code> - The name of the parameter to filter on. Valid values are
|
|
4524
|
-
* <code>
|
|
4672
|
+
* <code>ResourceArn</code> and <code>Status</code>.</p>
|
|
4525
4673
|
* </li>
|
|
4526
4674
|
* <li>
|
|
4527
4675
|
* <p>
|
|
@@ -4875,6 +5023,9 @@ export interface ForecastSummary {
|
|
|
4875
5023
|
* <p>The ARN of the predictor used to generate the forecast.</p>
|
|
4876
5024
|
*/
|
|
4877
5025
|
PredictorArn?: string;
|
|
5026
|
+
/**
|
|
5027
|
+
* <p>Whether the Forecast was created from an AutoPredictor.</p>
|
|
5028
|
+
*/
|
|
4878
5029
|
CreatedUsingAutoPredictor?: boolean;
|
|
4879
5030
|
/**
|
|
4880
5031
|
* <p>The Amazon Resource Name (ARN) of the dataset group that provided the data used to train
|
|
@@ -4974,9 +5125,9 @@ export declare namespace ListForecastsResponse {
|
|
|
4974
5125
|
}
|
|
4975
5126
|
export interface ListPredictorBacktestExportJobsRequest {
|
|
4976
5127
|
/**
|
|
4977
|
-
* <p>If the result of the previous request was truncated, the response includes a
|
|
4978
|
-
* To retrieve the next set of results, use the token in the next request.
|
|
4979
|
-
* 24 hours.</p>
|
|
5128
|
+
* <p>If the result of the previous request was truncated, the response includes a
|
|
5129
|
+
* NextToken. To retrieve the next set of results, use the token in the next request.
|
|
5130
|
+
* Tokens expire after 24 hours.</p>
|
|
4980
5131
|
*/
|
|
4981
5132
|
NextToken?: string;
|
|
4982
5133
|
/**
|
|
@@ -4985,29 +5136,29 @@ export interface ListPredictorBacktestExportJobsRequest {
|
|
|
4985
5136
|
MaxResults?: number;
|
|
4986
5137
|
/**
|
|
4987
5138
|
* <p>An array of filters. For each filter, provide a condition and a match statement. The
|
|
4988
|
-
*
|
|
4989
|
-
*
|
|
4990
|
-
*
|
|
4991
|
-
*
|
|
4992
|
-
*
|
|
4993
|
-
*
|
|
4994
|
-
*
|
|
5139
|
+
* condition is either <code>IS</code> or <code>IS_NOT</code>, which specifies whether to
|
|
5140
|
+
* include or exclude the predictor backtest export jobs that match the statement from the
|
|
5141
|
+
* list. The match statement consists of a key and a value.</p>
|
|
5142
|
+
* <p>
|
|
5143
|
+
* <b>Filter properties</b>
|
|
5144
|
+
* </p>
|
|
5145
|
+
* <ul>
|
|
4995
5146
|
* <li>
|
|
4996
|
-
*
|
|
5147
|
+
* <p>
|
|
4997
5148
|
* <code>Condition</code> - The condition to apply. Valid values are
|
|
4998
5149
|
* <code>IS</code> and <code>IS_NOT</code>. To include the predictor backtest
|
|
4999
|
-
*
|
|
5000
|
-
*
|
|
5001
|
-
*
|
|
5150
|
+
* export jobs that match the statement, specify <code>IS</code>. To exclude
|
|
5151
|
+
* matching predictor backtest export jobs, specify <code>IS_NOT</code>.</p>
|
|
5152
|
+
* </li>
|
|
5002
5153
|
* <li>
|
|
5003
|
-
*
|
|
5154
|
+
* <p>
|
|
5004
5155
|
* <code>Key</code> - The name of the parameter to filter on. Valid values are
|
|
5005
5156
|
* <code>PredictorArn</code> and <code>Status</code>.</p>
|
|
5006
|
-
*
|
|
5157
|
+
* </li>
|
|
5007
5158
|
* <li>
|
|
5008
|
-
*
|
|
5159
|
+
* <p>
|
|
5009
5160
|
* <code>Value</code> - The value to match.</p>
|
|
5010
|
-
*
|
|
5161
|
+
* </li>
|
|
5011
5162
|
* </ul>
|
|
5012
5163
|
*/
|
|
5013
5164
|
Filters?: Filter[];
|
|
@@ -5019,9 +5170,9 @@ export declare namespace ListPredictorBacktestExportJobsRequest {
|
|
|
5019
5170
|
const filterSensitiveLog: (obj: ListPredictorBacktestExportJobsRequest) => any;
|
|
5020
5171
|
}
|
|
5021
5172
|
/**
|
|
5022
|
-
* <p>Provides a summary of the predictor backtest export job properties used in the <a>ListPredictorBacktestExportJobs</a> operation. To get a complete set of
|
|
5023
|
-
* the <a>DescribePredictorBacktestExportJob</a> operation, and
|
|
5024
|
-
* <code>PredictorBacktestExportJobArn</code>.</p>
|
|
5173
|
+
* <p>Provides a summary of the predictor backtest export job properties used in the <a>ListPredictorBacktestExportJobs</a> operation. To get a complete set of
|
|
5174
|
+
* properties, call the <a>DescribePredictorBacktestExportJob</a> operation, and
|
|
5175
|
+
* provide the listed <code>PredictorBacktestExportJobArn</code>.</p>
|
|
5025
5176
|
*/
|
|
5026
5177
|
export interface PredictorBacktestExportJobSummary {
|
|
5027
5178
|
/**
|
|
@@ -5048,7 +5199,7 @@ export interface PredictorBacktestExportJobSummary {
|
|
|
5048
5199
|
* <li>
|
|
5049
5200
|
* <p>
|
|
5050
5201
|
* <code>CREATE_PENDING</code>, <code>CREATE_IN_PROGRESS</code>,
|
|
5051
|
-
*
|
|
5202
|
+
* <code>CREATE_FAILED</code>
|
|
5052
5203
|
* </p>
|
|
5053
5204
|
* </li>
|
|
5054
5205
|
* <li>
|
|
@@ -5059,7 +5210,7 @@ export interface PredictorBacktestExportJobSummary {
|
|
|
5059
5210
|
* <li>
|
|
5060
5211
|
* <p>
|
|
5061
5212
|
* <code>DELETE_PENDING</code>, <code>DELETE_IN_PROGRESS</code>,
|
|
5062
|
-
*
|
|
5213
|
+
* <code>DELETE_FAILED</code>
|
|
5063
5214
|
* </p>
|
|
5064
5215
|
* </li>
|
|
5065
5216
|
* </ul>
|
|
@@ -5074,7 +5225,8 @@ export interface PredictorBacktestExportJobSummary {
|
|
|
5074
5225
|
*/
|
|
5075
5226
|
CreationTime?: Date;
|
|
5076
5227
|
/**
|
|
5077
|
-
* <p>The last time the resource was modified. The timestamp depends on the status of the
|
|
5228
|
+
* <p>The last time the resource was modified. The timestamp depends on the status of the
|
|
5229
|
+
* job:</p>
|
|
5078
5230
|
* <ul>
|
|
5079
5231
|
* <li>
|
|
5080
5232
|
* <p>
|
|
@@ -5114,8 +5266,8 @@ export interface ListPredictorBacktestExportJobsResponse {
|
|
|
5114
5266
|
*/
|
|
5115
5267
|
PredictorBacktestExportJobs?: PredictorBacktestExportJobSummary[];
|
|
5116
5268
|
/**
|
|
5117
|
-
* <p>Returns this token if the response is truncated. To retrieve the next
|
|
5118
|
-
*
|
|
5269
|
+
* <p>Returns this token if the response is truncated. To retrieve the next set of results,
|
|
5270
|
+
* use the token in the next request.</p>
|
|
5119
5271
|
*/
|
|
5120
5272
|
NextToken?: string;
|
|
5121
5273
|
}
|
|
@@ -5296,7 +5448,8 @@ export declare namespace ListPredictorsResponse {
|
|
|
5296
5448
|
}
|
|
5297
5449
|
export interface ListTagsForResourceRequest {
|
|
5298
5450
|
/**
|
|
5299
|
-
* <p>The Amazon Resource Name (ARN) that identifies the resource for which to list the tags.
|
|
5451
|
+
* <p>The Amazon Resource Name (ARN) that identifies the resource for which to list the tags.
|
|
5452
|
+
* </p>
|
|
5300
5453
|
*/
|
|
5301
5454
|
ResourceArn: string | undefined;
|
|
5302
5455
|
}
|
|
@@ -5322,8 +5475,9 @@ export interface StopResourceRequest {
|
|
|
5322
5475
|
/**
|
|
5323
5476
|
* <p>The Amazon Resource Name (ARN) that identifies the resource to stop. The supported ARNs
|
|
5324
5477
|
* are <code>DatasetImportJobArn</code>, <code>PredictorArn</code>,
|
|
5325
|
-
* <code>PredictorBacktestExportJobArn</code>, <code>ForecastArn</code>,
|
|
5326
|
-
* <code>ForecastExportJobArn</code
|
|
5478
|
+
* <code>PredictorBacktestExportJobArn</code>, <code>ForecastArn</code>,
|
|
5479
|
+
* <code>ForecastExportJobArn</code>, <code>ExplainabilityArn</code>, and
|
|
5480
|
+
* <code>ExplainabilityExportArn</code>. </p>
|
|
5327
5481
|
*/
|
|
5328
5482
|
ResourceArn: string | undefined;
|
|
5329
5483
|
}
|
|
@@ -5335,7 +5489,8 @@ export declare namespace StopResourceRequest {
|
|
|
5335
5489
|
}
|
|
5336
5490
|
export interface TagResourceRequest {
|
|
5337
5491
|
/**
|
|
5338
|
-
* <p>The Amazon Resource Name (ARN) that identifies the resource for which to list the tags.
|
|
5492
|
+
* <p>The Amazon Resource Name (ARN) that identifies the resource for which to list the tags.
|
|
5493
|
+
* </p>
|
|
5339
5494
|
*/
|
|
5340
5495
|
ResourceArn: string | undefined;
|
|
5341
5496
|
/**
|
|
@@ -5346,7 +5501,8 @@ export interface TagResourceRequest {
|
|
|
5346
5501
|
* <p>Maximum number of tags per resource - 50.</p>
|
|
5347
5502
|
* </li>
|
|
5348
5503
|
* <li>
|
|
5349
|
-
* <p>For each resource, each tag key must be unique, and each tag key can have only one
|
|
5504
|
+
* <p>For each resource, each tag key must be unique, and each tag key can have only one
|
|
5505
|
+
* value.</p>
|
|
5350
5506
|
* </li>
|
|
5351
5507
|
* <li>
|
|
5352
5508
|
* <p>Maximum key length - 128 Unicode characters in UTF-8.</p>
|
|
@@ -5355,13 +5511,21 @@ export interface TagResourceRequest {
|
|
|
5355
5511
|
* <p>Maximum value length - 256 Unicode characters in UTF-8.</p>
|
|
5356
5512
|
* </li>
|
|
5357
5513
|
* <li>
|
|
5358
|
-
* <p>If your tagging schema is used across multiple services and resources, remember that
|
|
5514
|
+
* <p>If your tagging schema is used across multiple services and resources, remember that
|
|
5515
|
+
* other services may have restrictions on allowed characters. Generally allowed characters
|
|
5516
|
+
* are: letters, numbers, and spaces representable in UTF-8, and the following characters: +
|
|
5517
|
+
* - = . _ : / @.</p>
|
|
5359
5518
|
* </li>
|
|
5360
5519
|
* <li>
|
|
5361
5520
|
* <p>Tag keys and values are case sensitive.</p>
|
|
5362
5521
|
* </li>
|
|
5363
5522
|
* <li>
|
|
5364
|
-
* <p>Do not use <code>aws:</code>, <code>AWS:</code>, or any upper or lowercase combination
|
|
5523
|
+
* <p>Do not use <code>aws:</code>, <code>AWS:</code>, or any upper or lowercase combination
|
|
5524
|
+
* of such as a prefix for keys as it is reserved for AWS use. You cannot edit or delete tag
|
|
5525
|
+
* keys with this prefix. Values can have this prefix. If a tag value has <code>aws</code> as
|
|
5526
|
+
* its prefix but the key does not, then Forecast considers it to be a user tag and will
|
|
5527
|
+
* count against the limit of 50 tags. Tags with only the key prefix of <code>aws</code> do
|
|
5528
|
+
* not count against your tags per resource limit.</p>
|
|
5365
5529
|
* </li>
|
|
5366
5530
|
* </ul>
|
|
5367
5531
|
*/
|
|
@@ -5383,7 +5547,8 @@ export declare namespace TagResourceResponse {
|
|
|
5383
5547
|
}
|
|
5384
5548
|
export interface UntagResourceRequest {
|
|
5385
5549
|
/**
|
|
5386
|
-
* <p>The Amazon Resource Name (ARN) that identifies the resource for which to list the tags.
|
|
5550
|
+
* <p>The Amazon Resource Name (ARN) that identifies the resource for which to list the tags.
|
|
5551
|
+
* </p>
|
|
5387
5552
|
*/
|
|
5388
5553
|
ResourceArn: string | undefined;
|
|
5389
5554
|
/**
|