@aws-sdk/client-forecast 3.43.0 → 3.47.1
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 +47 -0
- package/dist-cjs/endpoints.js +1 -12
- package/dist-cjs/models/models_0.js +3 -39
- package/dist-cjs/protocols/Aws_json1_1.js +3 -0
- package/dist-cjs/runtimeConfig.browser.js +7 -2
- package/dist-cjs/runtimeConfig.js +9 -3
- package/dist-es/endpoints.js +1 -12
- package/dist-es/models/models_0.js +0 -24
- package/dist-es/protocols/Aws_json1_1.js +3 -0
- package/dist-es/runtimeConfig.browser.js +12 -3
- package/dist-es/runtimeConfig.js +13 -6
- package/dist-types/Forecast.d.ts +34 -27
- package/dist-types/ForecastClient.d.ts +5 -1
- 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 -176
- package/dist-types/runtimeConfig.browser.d.ts +3 -2
- package/dist-types/runtimeConfig.d.ts +4 -3
- package/dist-types/runtimeConfig.native.d.ts +1 -0
- package/dist-types/ts3.4/ForecastClient.d.ts +3 -1
- package/dist-types/ts3.4/models/models_0.d.ts +8 -24
- package/dist-types/ts3.4/runtimeConfig.browser.d.ts +3 -2
- package/dist-types/ts3.4/runtimeConfig.d.ts +4 -3
- package/dist-types/ts3.4/runtimeConfig.native.d.ts +1 -0
- package/package.json +39 -46
|
@@ -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
|
|
@@ -564,12 +579,6 @@ export interface InvalidInputException extends __SmithyException, $MetadataBeare
|
|
|
564
579
|
$fault: "client";
|
|
565
580
|
Message?: string;
|
|
566
581
|
}
|
|
567
|
-
export declare namespace InvalidInputException {
|
|
568
|
-
/**
|
|
569
|
-
* @internal
|
|
570
|
-
*/
|
|
571
|
-
const filterSensitiveLog: (obj: InvalidInputException) => any;
|
|
572
|
-
}
|
|
573
582
|
/**
|
|
574
583
|
* <p>The limit on the number of resources per account has been exceeded.</p>
|
|
575
584
|
*/
|
|
@@ -578,12 +587,6 @@ export interface LimitExceededException extends __SmithyException, $MetadataBear
|
|
|
578
587
|
$fault: "client";
|
|
579
588
|
Message?: string;
|
|
580
589
|
}
|
|
581
|
-
export declare namespace LimitExceededException {
|
|
582
|
-
/**
|
|
583
|
-
* @internal
|
|
584
|
-
*/
|
|
585
|
-
const filterSensitiveLog: (obj: LimitExceededException) => any;
|
|
586
|
-
}
|
|
587
590
|
/**
|
|
588
591
|
* <p>There is already a resource with this name. Try again with a different name.</p>
|
|
589
592
|
*/
|
|
@@ -592,12 +595,6 @@ export interface ResourceAlreadyExistsException extends __SmithyException, $Meta
|
|
|
592
595
|
$fault: "client";
|
|
593
596
|
Message?: string;
|
|
594
597
|
}
|
|
595
|
-
export declare namespace ResourceAlreadyExistsException {
|
|
596
|
-
/**
|
|
597
|
-
* @internal
|
|
598
|
-
*/
|
|
599
|
-
const filterSensitiveLog: (obj: ResourceAlreadyExistsException) => any;
|
|
600
|
-
}
|
|
601
598
|
/**
|
|
602
599
|
* <p>The specified resource is in use.</p>
|
|
603
600
|
*/
|
|
@@ -606,12 +603,6 @@ export interface ResourceInUseException extends __SmithyException, $MetadataBear
|
|
|
606
603
|
$fault: "client";
|
|
607
604
|
Message?: string;
|
|
608
605
|
}
|
|
609
|
-
export declare namespace ResourceInUseException {
|
|
610
|
-
/**
|
|
611
|
-
* @internal
|
|
612
|
-
*/
|
|
613
|
-
const filterSensitiveLog: (obj: ResourceInUseException) => any;
|
|
614
|
-
}
|
|
615
606
|
/**
|
|
616
607
|
* <p>We can't find a resource with that Amazon Resource Name (ARN). Check the ARN and try
|
|
617
608
|
* again.</p>
|
|
@@ -621,12 +612,6 @@ export interface ResourceNotFoundException extends __SmithyException, $MetadataB
|
|
|
621
612
|
$fault: "client";
|
|
622
613
|
Message?: string;
|
|
623
614
|
}
|
|
624
|
-
export declare namespace ResourceNotFoundException {
|
|
625
|
-
/**
|
|
626
|
-
* @internal
|
|
627
|
-
*/
|
|
628
|
-
const filterSensitiveLog: (obj: ResourceNotFoundException) => any;
|
|
629
|
-
}
|
|
630
615
|
export declare enum DatasetType {
|
|
631
616
|
ITEM_METADATA = "ITEM_METADATA",
|
|
632
617
|
RELATED_TIME_SERIES = "RELATED_TIME_SERIES",
|
|
@@ -670,7 +655,7 @@ export declare namespace SchemaAttribute {
|
|
|
670
655
|
const filterSensitiveLog: (obj: SchemaAttribute) => any;
|
|
671
656
|
}
|
|
672
657
|
/**
|
|
673
|
-
* <p>Defines the fields of a dataset
|
|
658
|
+
* <p>Defines the fields of a dataset.</p>
|
|
674
659
|
*/
|
|
675
660
|
export interface Schema {
|
|
676
661
|
/**
|
|
@@ -724,14 +709,16 @@ export interface CreateDatasetRequest {
|
|
|
724
709
|
*/
|
|
725
710
|
EncryptionConfig?: EncryptionConfig;
|
|
726
711
|
/**
|
|
727
|
-
* <p>The optional metadata that you apply to the dataset to help you categorize and organize
|
|
712
|
+
* <p>The optional metadata that you apply to the dataset to help you categorize and organize
|
|
713
|
+
* them. Each tag consists of a key and an optional value, both of which you define.</p>
|
|
728
714
|
* <p>The following basic restrictions apply to tags:</p>
|
|
729
715
|
* <ul>
|
|
730
716
|
* <li>
|
|
731
717
|
* <p>Maximum number of tags per resource - 50.</p>
|
|
732
718
|
* </li>
|
|
733
719
|
* <li>
|
|
734
|
-
* <p>For each resource, each tag key must be unique, and each tag key can have only one
|
|
720
|
+
* <p>For each resource, each tag key must be unique, and each tag key can have only one
|
|
721
|
+
* value.</p>
|
|
735
722
|
* </li>
|
|
736
723
|
* <li>
|
|
737
724
|
* <p>Maximum key length - 128 Unicode characters in UTF-8.</p>
|
|
@@ -740,13 +727,21 @@ export interface CreateDatasetRequest {
|
|
|
740
727
|
* <p>Maximum value length - 256 Unicode characters in UTF-8.</p>
|
|
741
728
|
* </li>
|
|
742
729
|
* <li>
|
|
743
|
-
* <p>If your tagging schema is used across multiple services and resources, remember that
|
|
730
|
+
* <p>If your tagging schema is used across multiple services and resources, remember that
|
|
731
|
+
* other services may have restrictions on allowed characters. Generally allowed characters
|
|
732
|
+
* are: letters, numbers, and spaces representable in UTF-8, and the following characters: +
|
|
733
|
+
* - = . _ : / @.</p>
|
|
744
734
|
* </li>
|
|
745
735
|
* <li>
|
|
746
736
|
* <p>Tag keys and values are case sensitive.</p>
|
|
747
737
|
* </li>
|
|
748
738
|
* <li>
|
|
749
|
-
* <p>Do not use <code>aws:</code>, <code>AWS:</code>, or any upper or lowercase combination
|
|
739
|
+
* <p>Do not use <code>aws:</code>, <code>AWS:</code>, or any upper or lowercase combination
|
|
740
|
+
* of such as a prefix for keys as it is reserved for AWS use. You cannot edit or delete tag
|
|
741
|
+
* keys with this prefix. Values can have this prefix. If a tag value has <code>aws</code> as
|
|
742
|
+
* its prefix but the key does not, then Forecast considers it to be a user tag and will
|
|
743
|
+
* count against the limit of 50 tags. Tags with only the key prefix of <code>aws</code> do
|
|
744
|
+
* not count against your tags per resource limit.</p>
|
|
750
745
|
* </li>
|
|
751
746
|
* </ul>
|
|
752
747
|
*/
|
|
@@ -792,14 +787,17 @@ export interface CreateDatasetGroupRequest {
|
|
|
792
787
|
*/
|
|
793
788
|
DatasetArns?: string[];
|
|
794
789
|
/**
|
|
795
|
-
* <p>The optional metadata that you apply to the dataset group to help you categorize and
|
|
790
|
+
* <p>The optional metadata that you apply to the dataset group to help you categorize and
|
|
791
|
+
* organize them. Each tag consists of a key and an optional value, both of which you
|
|
792
|
+
* define.</p>
|
|
796
793
|
* <p>The following basic restrictions apply to tags:</p>
|
|
797
794
|
* <ul>
|
|
798
795
|
* <li>
|
|
799
796
|
* <p>Maximum number of tags per resource - 50.</p>
|
|
800
797
|
* </li>
|
|
801
798
|
* <li>
|
|
802
|
-
* <p>For each resource, each tag key must be unique, and each tag key can have only one
|
|
799
|
+
* <p>For each resource, each tag key must be unique, and each tag key can have only one
|
|
800
|
+
* value.</p>
|
|
803
801
|
* </li>
|
|
804
802
|
* <li>
|
|
805
803
|
* <p>Maximum key length - 128 Unicode characters in UTF-8.</p>
|
|
@@ -808,13 +806,21 @@ export interface CreateDatasetGroupRequest {
|
|
|
808
806
|
* <p>Maximum value length - 256 Unicode characters in UTF-8.</p>
|
|
809
807
|
* </li>
|
|
810
808
|
* <li>
|
|
811
|
-
* <p>If your tagging schema is used across multiple services and resources, remember that
|
|
809
|
+
* <p>If your tagging schema is used across multiple services and resources, remember that
|
|
810
|
+
* other services may have restrictions on allowed characters. Generally allowed characters
|
|
811
|
+
* are: letters, numbers, and spaces representable in UTF-8, and the following characters: +
|
|
812
|
+
* - = . _ : / @.</p>
|
|
812
813
|
* </li>
|
|
813
814
|
* <li>
|
|
814
815
|
* <p>Tag keys and values are case sensitive.</p>
|
|
815
816
|
* </li>
|
|
816
817
|
* <li>
|
|
817
|
-
* <p>Do not use <code>aws:</code>, <code>AWS:</code>, or any upper or lowercase combination
|
|
818
|
+
* <p>Do not use <code>aws:</code>, <code>AWS:</code>, or any upper or lowercase combination
|
|
819
|
+
* of such as a prefix for keys as it is reserved for AWS use. You cannot edit or delete tag
|
|
820
|
+
* keys with this prefix. Values can have this prefix. If a tag value has <code>aws</code> as
|
|
821
|
+
* its prefix but the key does not, then Forecast considers it to be a user tag and will
|
|
822
|
+
* count against the limit of 50 tags. Tags with only the key prefix of <code>aws</code> do
|
|
823
|
+
* not count against your tags per resource limit.</p>
|
|
818
824
|
* </li>
|
|
819
825
|
* </ul>
|
|
820
826
|
*/
|
|
@@ -868,13 +874,12 @@ export declare namespace S3Config {
|
|
|
868
874
|
const filterSensitiveLog: (obj: S3Config) => any;
|
|
869
875
|
}
|
|
870
876
|
/**
|
|
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>
|
|
877
|
+
* <p>The source of your data, an AWS Identity and Access Management (IAM) role that allows Amazon Forecast to
|
|
878
|
+
* access the data and, optionally, an AWS Key Management Service (KMS) key.</p>
|
|
874
879
|
*/
|
|
875
880
|
export interface DataSource {
|
|
876
881
|
/**
|
|
877
|
-
* <p>The path to the
|
|
882
|
+
* <p>The path to the data stored in an Amazon Simple Storage Service (Amazon S3) bucket along with the
|
|
878
883
|
* credentials to access the data.</p>
|
|
879
884
|
*/
|
|
880
885
|
S3Config: S3Config | undefined;
|
|
@@ -954,14 +959,17 @@ export interface CreateDatasetImportJobRequest {
|
|
|
954
959
|
*/
|
|
955
960
|
GeolocationFormat?: string;
|
|
956
961
|
/**
|
|
957
|
-
* <p>The optional metadata that you apply to the dataset import job to help you categorize and
|
|
962
|
+
* <p>The optional metadata that you apply to the dataset import job to help you categorize and
|
|
963
|
+
* organize them. Each tag consists of a key and an optional value, both of which you
|
|
964
|
+
* define.</p>
|
|
958
965
|
* <p>The following basic restrictions apply to tags:</p>
|
|
959
966
|
* <ul>
|
|
960
967
|
* <li>
|
|
961
968
|
* <p>Maximum number of tags per resource - 50.</p>
|
|
962
969
|
* </li>
|
|
963
970
|
* <li>
|
|
964
|
-
* <p>For each resource, each tag key must be unique, and each tag key can have only one
|
|
971
|
+
* <p>For each resource, each tag key must be unique, and each tag key can have only one
|
|
972
|
+
* value.</p>
|
|
965
973
|
* </li>
|
|
966
974
|
* <li>
|
|
967
975
|
* <p>Maximum key length - 128 Unicode characters in UTF-8.</p>
|
|
@@ -970,13 +978,21 @@ export interface CreateDatasetImportJobRequest {
|
|
|
970
978
|
* <p>Maximum value length - 256 Unicode characters in UTF-8.</p>
|
|
971
979
|
* </li>
|
|
972
980
|
* <li>
|
|
973
|
-
* <p>If your tagging schema is used across multiple services and resources, remember that
|
|
981
|
+
* <p>If your tagging schema is used across multiple services and resources, remember that
|
|
982
|
+
* other services may have restrictions on allowed characters. Generally allowed characters
|
|
983
|
+
* are: letters, numbers, and spaces representable in UTF-8, and the following characters: +
|
|
984
|
+
* - = . _ : / @.</p>
|
|
974
985
|
* </li>
|
|
975
986
|
* <li>
|
|
976
987
|
* <p>Tag keys and values are case sensitive.</p>
|
|
977
988
|
* </li>
|
|
978
989
|
* <li>
|
|
979
|
-
* <p>Do not use <code>aws:</code>, <code>AWS:</code>, or any upper or lowercase combination
|
|
990
|
+
* <p>Do not use <code>aws:</code>, <code>AWS:</code>, or any upper or lowercase combination
|
|
991
|
+
* of such as a prefix for keys as it is reserved for AWS use. You cannot edit or delete tag
|
|
992
|
+
* keys with this prefix. Values can have this prefix. If a tag value has <code>aws</code> as
|
|
993
|
+
* its prefix but the key does not, then Forecast considers it to be a user tag and will
|
|
994
|
+
* count against the limit of 50 tags. Tags with only the key prefix of <code>aws</code> do
|
|
995
|
+
* not count against your tags per resource limit.</p>
|
|
980
996
|
* </li>
|
|
981
997
|
* </ul>
|
|
982
998
|
*/
|
|
@@ -1058,13 +1074,12 @@ export interface CreateExplainabilityRequest {
|
|
|
1058
1074
|
*/
|
|
1059
1075
|
ExplainabilityConfig: ExplainabilityConfig | undefined;
|
|
1060
1076
|
/**
|
|
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>
|
|
1077
|
+
* <p>The source of your data, an AWS Identity and Access Management (IAM) role that allows Amazon Forecast to
|
|
1078
|
+
* access the data and, optionally, an AWS Key Management Service (KMS) key.</p>
|
|
1064
1079
|
*/
|
|
1065
1080
|
DataSource?: DataSource;
|
|
1066
1081
|
/**
|
|
1067
|
-
* <p>Defines the fields of a dataset
|
|
1082
|
+
* <p>Defines the fields of a dataset.</p>
|
|
1068
1083
|
*/
|
|
1069
1084
|
Schema?: Schema;
|
|
1070
1085
|
/**
|
|
@@ -1074,11 +1089,13 @@ export interface CreateExplainabilityRequest {
|
|
|
1074
1089
|
/**
|
|
1075
1090
|
* <p>If <code>TimePointGranularity</code> is set to <code>SPECIFIC</code>, define the first
|
|
1076
1091
|
* point for the Explainability.</p>
|
|
1092
|
+
* <p>Use the following timestamp format: yyyy-MM-ddTHH:mm:ss (example: 2015-01-01T20:00:00)</p>
|
|
1077
1093
|
*/
|
|
1078
1094
|
StartDateTime?: string;
|
|
1079
1095
|
/**
|
|
1080
1096
|
* <p>If <code>TimePointGranularity</code> is set to <code>SPECIFIC</code>, define the last
|
|
1081
1097
|
* time point for the Explainability.</p>
|
|
1098
|
+
* <p>Use the following timestamp format: yyyy-MM-ddTHH:mm:ss (example: 2015-01-01T20:00:00)</p>
|
|
1082
1099
|
*/
|
|
1083
1100
|
EndDateTime?: string;
|
|
1084
1101
|
/**
|
|
@@ -1238,14 +1255,16 @@ export interface CreateForecastRequest {
|
|
|
1238
1255
|
*/
|
|
1239
1256
|
ForecastTypes?: string[];
|
|
1240
1257
|
/**
|
|
1241
|
-
* <p>The optional metadata that you apply to the forecast to help you categorize and organize
|
|
1258
|
+
* <p>The optional metadata that you apply to the forecast to help you categorize and organize
|
|
1259
|
+
* them. Each tag consists of a key and an optional value, both of which you define.</p>
|
|
1242
1260
|
* <p>The following basic restrictions apply to tags:</p>
|
|
1243
1261
|
* <ul>
|
|
1244
1262
|
* <li>
|
|
1245
1263
|
* <p>Maximum number of tags per resource - 50.</p>
|
|
1246
1264
|
* </li>
|
|
1247
1265
|
* <li>
|
|
1248
|
-
* <p>For each resource, each tag key must be unique, and each tag key can have only one
|
|
1266
|
+
* <p>For each resource, each tag key must be unique, and each tag key can have only one
|
|
1267
|
+
* value.</p>
|
|
1249
1268
|
* </li>
|
|
1250
1269
|
* <li>
|
|
1251
1270
|
* <p>Maximum key length - 128 Unicode characters in UTF-8.</p>
|
|
@@ -1254,13 +1273,21 @@ export interface CreateForecastRequest {
|
|
|
1254
1273
|
* <p>Maximum value length - 256 Unicode characters in UTF-8.</p>
|
|
1255
1274
|
* </li>
|
|
1256
1275
|
* <li>
|
|
1257
|
-
* <p>If your tagging schema is used across multiple services and resources, remember that
|
|
1276
|
+
* <p>If your tagging schema is used across multiple services and resources, remember that
|
|
1277
|
+
* other services may have restrictions on allowed characters. Generally allowed characters
|
|
1278
|
+
* are: letters, numbers, and spaces representable in UTF-8, and the following characters: +
|
|
1279
|
+
* - = . _ : / @.</p>
|
|
1258
1280
|
* </li>
|
|
1259
1281
|
* <li>
|
|
1260
1282
|
* <p>Tag keys and values are case sensitive.</p>
|
|
1261
1283
|
* </li>
|
|
1262
1284
|
* <li>
|
|
1263
|
-
* <p>Do not use <code>aws:</code>, <code>AWS:</code>, or any upper or lowercase combination
|
|
1285
|
+
* <p>Do not use <code>aws:</code>, <code>AWS:</code>, or any upper or lowercase combination
|
|
1286
|
+
* of such as a prefix for keys as it is reserved for AWS use. You cannot edit or delete tag
|
|
1287
|
+
* keys with this prefix. Values can have this prefix. If a tag value has <code>aws</code> as
|
|
1288
|
+
* its prefix but the key does not, then Forecast considers it to be a user tag and will
|
|
1289
|
+
* count against the limit of 50 tags. Tags with only the key prefix of <code>aws</code> do
|
|
1290
|
+
* not count against your tags per resource limit.</p>
|
|
1264
1291
|
* </li>
|
|
1265
1292
|
* </ul>
|
|
1266
1293
|
*/
|
|
@@ -1302,14 +1329,17 @@ export interface CreateForecastExportJobRequest {
|
|
|
1302
1329
|
*/
|
|
1303
1330
|
Destination: DataDestination | undefined;
|
|
1304
1331
|
/**
|
|
1305
|
-
* <p>The optional metadata that you apply to the forecast export job to help you categorize and
|
|
1332
|
+
* <p>The optional metadata that you apply to the forecast export job to help you categorize and
|
|
1333
|
+
* organize them. Each tag consists of a key and an optional value, both of which you
|
|
1334
|
+
* define.</p>
|
|
1306
1335
|
* <p>The following basic restrictions apply to tags:</p>
|
|
1307
1336
|
* <ul>
|
|
1308
1337
|
* <li>
|
|
1309
1338
|
* <p>Maximum number of tags per resource - 50.</p>
|
|
1310
1339
|
* </li>
|
|
1311
1340
|
* <li>
|
|
1312
|
-
* <p>For each resource, each tag key must be unique, and each tag key can have only one
|
|
1341
|
+
* <p>For each resource, each tag key must be unique, and each tag key can have only one
|
|
1342
|
+
* value.</p>
|
|
1313
1343
|
* </li>
|
|
1314
1344
|
* <li>
|
|
1315
1345
|
* <p>Maximum key length - 128 Unicode characters in UTF-8.</p>
|
|
@@ -1318,13 +1348,21 @@ export interface CreateForecastExportJobRequest {
|
|
|
1318
1348
|
* <p>Maximum value length - 256 Unicode characters in UTF-8.</p>
|
|
1319
1349
|
* </li>
|
|
1320
1350
|
* <li>
|
|
1321
|
-
* <p>If your tagging schema is used across multiple services and resources, remember that
|
|
1351
|
+
* <p>If your tagging schema is used across multiple services and resources, remember that
|
|
1352
|
+
* other services may have restrictions on allowed characters. Generally allowed characters
|
|
1353
|
+
* are: letters, numbers, and spaces representable in UTF-8, and the following characters: +
|
|
1354
|
+
* - = . _ : / @.</p>
|
|
1322
1355
|
* </li>
|
|
1323
1356
|
* <li>
|
|
1324
1357
|
* <p>Tag keys and values are case sensitive.</p>
|
|
1325
1358
|
* </li>
|
|
1326
1359
|
* <li>
|
|
1327
|
-
* <p>Do not use <code>aws:</code>, <code>AWS:</code>, or any upper or lowercase combination
|
|
1360
|
+
* <p>Do not use <code>aws:</code>, <code>AWS:</code>, or any upper or lowercase combination
|
|
1361
|
+
* of such as a prefix for keys as it is reserved for AWS use. You cannot edit or delete tag
|
|
1362
|
+
* keys with this prefix. Values can have this prefix. If a tag value has <code>aws</code> as
|
|
1363
|
+
* its prefix but the key does not, then Forecast considers it to be a user tag and will
|
|
1364
|
+
* count against the limit of 50 tags. Tags with only the key prefix of <code>aws</code> do
|
|
1365
|
+
* not count against your tags per resource limit.</p>
|
|
1328
1366
|
* </li>
|
|
1329
1367
|
* </ul>
|
|
1330
1368
|
*/
|
|
@@ -1385,10 +1423,10 @@ export declare enum FeaturizationMethodName {
|
|
|
1385
1423
|
filling = "filling"
|
|
1386
1424
|
}
|
|
1387
1425
|
/**
|
|
1388
|
-
* <p>Provides information about the method that featurizes (transforms) a dataset field.
|
|
1389
|
-
*
|
|
1390
|
-
*
|
|
1391
|
-
*
|
|
1426
|
+
* <p>Provides information about the method that featurizes (transforms) a dataset field. The
|
|
1427
|
+
* method is part of the <code>FeaturizationPipeline</code> of the <a>Featurization</a> object. </p>
|
|
1428
|
+
* <p>The following is an example of how you specify a <code>FeaturizationMethod</code>
|
|
1429
|
+
* object.</p>
|
|
1392
1430
|
* <p>
|
|
1393
1431
|
* <code>{</code>
|
|
1394
1432
|
* </p>
|
|
@@ -1396,7 +1434,8 @@ export declare enum FeaturizationMethodName {
|
|
|
1396
1434
|
* <code>"FeaturizationMethodName": "filling",</code>
|
|
1397
1435
|
* </p>
|
|
1398
1436
|
* <p>
|
|
1399
|
-
* <code>"FeaturizationMethodParameters": {"aggregation": "sum", "middlefill": "zero",
|
|
1437
|
+
* <code>"FeaturizationMethodParameters": {"aggregation": "sum", "middlefill": "zero",
|
|
1438
|
+
* "backfill": "zero"}</code>
|
|
1400
1439
|
* </p>
|
|
1401
1440
|
* <p>
|
|
1402
1441
|
* <code>}</code>
|
|
@@ -1408,14 +1447,17 @@ export interface FeaturizationMethod {
|
|
|
1408
1447
|
*/
|
|
1409
1448
|
FeaturizationMethodName: FeaturizationMethodName | string | undefined;
|
|
1410
1449
|
/**
|
|
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
|
-
*
|
|
1450
|
+
* <p>The method parameters (key-value pairs), which are a map of override parameters. Specify
|
|
1451
|
+
* these parameters to override the default values. Related Time Series attributes do not accept
|
|
1452
|
+
* aggregation parameters.</p>
|
|
1453
|
+
* <p>The following list shows the parameters and their valid values for the "filling"
|
|
1454
|
+
* featurization method for a <b>Target Time Series</b> dataset. Bold
|
|
1455
|
+
* signifies the default value.</p>
|
|
1415
1456
|
* <ul>
|
|
1416
1457
|
* <li>
|
|
1417
1458
|
* <p>
|
|
1418
|
-
* <code>aggregation</code>: <b>sum</b>, <code>avg</code>,
|
|
1459
|
+
* <code>aggregation</code>: <b>sum</b>, <code>avg</code>,
|
|
1460
|
+
* <code>first</code>, <code>min</code>, <code>max</code>
|
|
1419
1461
|
* </p>
|
|
1420
1462
|
* </li>
|
|
1421
1463
|
* <li>
|
|
@@ -1425,12 +1467,16 @@ export interface FeaturizationMethod {
|
|
|
1425
1467
|
* </li>
|
|
1426
1468
|
* <li>
|
|
1427
1469
|
* <p>
|
|
1428
|
-
* <code>middlefill</code>: <b>zero</b>, <code>nan</code> (not
|
|
1470
|
+
* <code>middlefill</code>: <b>zero</b>, <code>nan</code> (not
|
|
1471
|
+
* a number), <code>value</code>, <code>median</code>, <code>mean</code>, <code>min</code>,
|
|
1472
|
+
* <code>max</code>
|
|
1429
1473
|
* </p>
|
|
1430
1474
|
* </li>
|
|
1431
1475
|
* <li>
|
|
1432
1476
|
* <p>
|
|
1433
|
-
* <code>backfill</code>: <b>zero</b>, <code>nan</code>,
|
|
1477
|
+
* <code>backfill</code>: <b>zero</b>, <code>nan</code>,
|
|
1478
|
+
* <code>value</code>, <code>median</code>, <code>mean</code>, <code>min</code>,
|
|
1479
|
+
* <code>max</code>
|
|
1434
1480
|
* </p>
|
|
1435
1481
|
* </li>
|
|
1436
1482
|
* </ul>
|
|
@@ -1439,17 +1485,20 @@ export interface FeaturizationMethod {
|
|
|
1439
1485
|
* <ul>
|
|
1440
1486
|
* <li>
|
|
1441
1487
|
* <p>
|
|
1442
|
-
* <code>middlefill</code>: <code>zero</code>, <code>value</code>, <code>median</code>,
|
|
1488
|
+
* <code>middlefill</code>: <code>zero</code>, <code>value</code>, <code>median</code>,
|
|
1489
|
+
* <code>mean</code>, <code>min</code>, <code>max</code>
|
|
1443
1490
|
* </p>
|
|
1444
1491
|
* </li>
|
|
1445
1492
|
* <li>
|
|
1446
1493
|
* <p>
|
|
1447
|
-
* <code>backfill</code>: <code>zero</code>, <code>value</code>, <code>median</code>,
|
|
1494
|
+
* <code>backfill</code>: <code>zero</code>, <code>value</code>, <code>median</code>,
|
|
1495
|
+
* <code>mean</code>, <code>min</code>, <code>max</code>
|
|
1448
1496
|
* </p>
|
|
1449
1497
|
* </li>
|
|
1450
1498
|
* <li>
|
|
1451
1499
|
* <p>
|
|
1452
|
-
* <code>futurefill</code>: <code>zero</code>, <code>value</code>, <code>median</code>,
|
|
1500
|
+
* <code>futurefill</code>: <code>zero</code>, <code>value</code>, <code>median</code>,
|
|
1501
|
+
* <code>mean</code>, <code>min</code>, <code>max</code>
|
|
1453
1502
|
* </p>
|
|
1454
1503
|
* </li>
|
|
1455
1504
|
* </ul>
|
|
@@ -1469,8 +1518,12 @@ export declare namespace FeaturizationMethod {
|
|
|
1469
1518
|
const filterSensitiveLog: (obj: FeaturizationMethod) => any;
|
|
1470
1519
|
}
|
|
1471
1520
|
/**
|
|
1472
|
-
* <
|
|
1473
|
-
*
|
|
1521
|
+
* <note>
|
|
1522
|
+
* <p>This object belongs to the <a>CreatePredictor</a> operation. If you created
|
|
1523
|
+
* your predictor with <a>CreateAutoPredictor</a>, see <a>AttributeConfig</a>.</p>
|
|
1524
|
+
* </note>
|
|
1525
|
+
* <p>Provides featurization (transformation) information for a dataset field. This object is
|
|
1526
|
+
* part of the <a>FeaturizationConfig</a> object.</p>
|
|
1474
1527
|
* <p>For example:</p>
|
|
1475
1528
|
* <p>
|
|
1476
1529
|
* <code>{</code>
|
|
@@ -1486,7 +1539,8 @@ export declare namespace FeaturizationMethod {
|
|
|
1486
1539
|
* <code>"FeaturizationMethodName": "filling",</code>
|
|
1487
1540
|
* </p>
|
|
1488
1541
|
* <p>
|
|
1489
|
-
* <code>"FeaturizationMethodParameters": {"aggregation": "avg", "backfill":
|
|
1542
|
+
* <code>"FeaturizationMethodParameters": {"aggregation": "avg", "backfill":
|
|
1543
|
+
* "nan"}</code>
|
|
1490
1544
|
* </p>
|
|
1491
1545
|
* <p>
|
|
1492
1546
|
* <code>} ]</code>
|
|
@@ -1497,11 +1551,11 @@ export declare namespace FeaturizationMethod {
|
|
|
1497
1551
|
*/
|
|
1498
1552
|
export interface Featurization {
|
|
1499
1553
|
/**
|
|
1500
|
-
* <p>The name of the schema attribute that specifies the data field to be featurized. Amazon
|
|
1501
|
-
*
|
|
1502
|
-
*
|
|
1503
|
-
* <code>
|
|
1504
|
-
*
|
|
1554
|
+
* <p>The name of the schema attribute that specifies the data field to be featurized. Amazon
|
|
1555
|
+
* Forecast supports the target field of the <code>TARGET_TIME_SERIES</code> and the
|
|
1556
|
+
* <code>RELATED_TIME_SERIES</code> datasets. For example, for the <code>RETAIL</code> domain,
|
|
1557
|
+
* the target is <code>demand</code>, and for the <code>CUSTOM</code> domain, the target is
|
|
1558
|
+
* <code>target_value</code>. For more information, see <a>howitworks-missing-values</a>.</p>
|
|
1505
1559
|
*/
|
|
1506
1560
|
AttributeName: string | undefined;
|
|
1507
1561
|
/**
|
|
@@ -1517,25 +1571,29 @@ export declare namespace Featurization {
|
|
|
1517
1571
|
const filterSensitiveLog: (obj: Featurization) => any;
|
|
1518
1572
|
}
|
|
1519
1573
|
/**
|
|
1520
|
-
* <
|
|
1521
|
-
*
|
|
1522
|
-
*
|
|
1523
|
-
*
|
|
1524
|
-
* <p>
|
|
1525
|
-
*
|
|
1526
|
-
*
|
|
1527
|
-
*
|
|
1528
|
-
*
|
|
1529
|
-
*
|
|
1530
|
-
*
|
|
1531
|
-
* featurization
|
|
1574
|
+
* <note>
|
|
1575
|
+
* <p>This object belongs to the <a>CreatePredictor</a> operation. If you created
|
|
1576
|
+
* your predictor with <a>CreateAutoPredictor</a>, see <a>AttributeConfig</a>.</p>
|
|
1577
|
+
* </note>
|
|
1578
|
+
* <p>In a <a>CreatePredictor</a> operation, the specified algorithm trains a model
|
|
1579
|
+
* using the specified dataset group. You can optionally tell the operation to modify data fields
|
|
1580
|
+
* prior to training a model. These modifications are referred to as
|
|
1581
|
+
* <i>featurization</i>.</p>
|
|
1582
|
+
* <p>You define featurization using the <code>FeaturizationConfig</code> object. You specify an
|
|
1583
|
+
* array of transformations, one for each field that you want to featurize. You then include the
|
|
1584
|
+
* <code>FeaturizationConfig</code> object in your <code>CreatePredictor</code> request.
|
|
1585
|
+
* Amazon Forecast applies the featurization to the <code>TARGET_TIME_SERIES</code> and
|
|
1586
|
+
* <code>RELATED_TIME_SERIES</code> datasets before model training.</p>
|
|
1587
|
+
* <p>You can create multiple featurization configurations. For example, you might call the
|
|
1588
|
+
* <code>CreatePredictor</code> operation twice by specifying different featurization
|
|
1589
|
+
* configurations.</p>
|
|
1532
1590
|
*/
|
|
1533
1591
|
export interface FeaturizationConfig {
|
|
1534
1592
|
/**
|
|
1535
1593
|
* <p>The frequency of predictions in a forecast.</p>
|
|
1536
1594
|
* <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
|
-
*
|
|
1595
|
+
* 15min (15 minutes), 10min (10 minutes), 5min (5 minutes), and 1min (1 minute). For example,
|
|
1596
|
+
* "Y" indicates every year and "5min" indicates every five minutes.</p>
|
|
1539
1597
|
* <p>The frequency must be greater than or equal to the TARGET_TIME_SERIES dataset
|
|
1540
1598
|
* frequency.</p>
|
|
1541
1599
|
* <p>When a RELATED_TIME_SERIES dataset is provided, the frequency must be equal to the
|
|
@@ -1543,14 +1601,16 @@ export interface FeaturizationConfig {
|
|
|
1543
1601
|
*/
|
|
1544
1602
|
ForecastFrequency: string | undefined;
|
|
1545
1603
|
/**
|
|
1546
|
-
* <p>An array of dimension (field) names that specify how to group the generated
|
|
1547
|
-
*
|
|
1548
|
-
*
|
|
1549
|
-
*
|
|
1604
|
+
* <p>An array of dimension (field) names that specify how to group the generated
|
|
1605
|
+
* forecast.</p>
|
|
1606
|
+
* <p>For example, suppose that you are generating a forecast for item sales across all of your
|
|
1607
|
+
* stores, and your dataset contains a <code>store_id</code> field. If you want the sales
|
|
1608
|
+
* forecast for each item by store, you would specify <code>store_id</code> as the
|
|
1609
|
+
* dimension.</p>
|
|
1550
1610
|
* <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
|
-
*
|
|
1611
|
+
* need to be specified in the <code>CreatePredictor</code> request. All forecast dimensions
|
|
1612
|
+
* specified in the <code>RELATED_TIME_SERIES</code> dataset must be specified in the
|
|
1613
|
+
* <code>CreatePredictor</code> request.</p>
|
|
1554
1614
|
*/
|
|
1555
1615
|
ForecastDimensions?: string[];
|
|
1556
1616
|
/**
|
|
@@ -1751,7 +1811,11 @@ export declare namespace HyperParameterTuningJobConfig {
|
|
|
1751
1811
|
const filterSensitiveLog: (obj: HyperParameterTuningJobConfig) => any;
|
|
1752
1812
|
}
|
|
1753
1813
|
/**
|
|
1754
|
-
* <
|
|
1814
|
+
* <note>
|
|
1815
|
+
* <p>This object belongs to the <a>CreatePredictor</a> operation. If you created
|
|
1816
|
+
* your predictor with <a>CreateAutoPredictor</a>, see <a>AdditionalDataset</a>.</p>
|
|
1817
|
+
* </note>
|
|
1818
|
+
* <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
1819
|
* featurizations.</p>
|
|
1756
1820
|
* <p>
|
|
1757
1821
|
* <b>Weather Index</b>
|
|
@@ -1996,7 +2060,11 @@ export declare namespace SupplementaryFeature {
|
|
|
1996
2060
|
const filterSensitiveLog: (obj: SupplementaryFeature) => any;
|
|
1997
2061
|
}
|
|
1998
2062
|
/**
|
|
1999
|
-
* <
|
|
2063
|
+
* <note>
|
|
2064
|
+
* <p>This object belongs to the <a>CreatePredictor</a> operation. If you created
|
|
2065
|
+
* your predictor with <a>CreateAutoPredictor</a>, see <a>DataConfig</a>.</p>
|
|
2066
|
+
* </note>
|
|
2067
|
+
* <p>The data used to train a predictor. The data includes a dataset group and any
|
|
2000
2068
|
* supplementary features. You specify this object in the <a>CreatePredictor</a>
|
|
2001
2069
|
* request.</p>
|
|
2002
2070
|
*/
|
|
@@ -2159,14 +2227,16 @@ export interface CreatePredictorRequest {
|
|
|
2159
2227
|
*/
|
|
2160
2228
|
EncryptionConfig?: EncryptionConfig;
|
|
2161
2229
|
/**
|
|
2162
|
-
* <p>The optional metadata that you apply to the predictor to help you categorize and organize
|
|
2230
|
+
* <p>The optional metadata that you apply to the predictor to help you categorize and organize
|
|
2231
|
+
* them. Each tag consists of a key and an optional value, both of which you define.</p>
|
|
2163
2232
|
* <p>The following basic restrictions apply to tags:</p>
|
|
2164
2233
|
* <ul>
|
|
2165
2234
|
* <li>
|
|
2166
2235
|
* <p>Maximum number of tags per resource - 50.</p>
|
|
2167
2236
|
* </li>
|
|
2168
2237
|
* <li>
|
|
2169
|
-
* <p>For each resource, each tag key must be unique, and each tag key can have only one
|
|
2238
|
+
* <p>For each resource, each tag key must be unique, and each tag key can have only one
|
|
2239
|
+
* value.</p>
|
|
2170
2240
|
* </li>
|
|
2171
2241
|
* <li>
|
|
2172
2242
|
* <p>Maximum key length - 128 Unicode characters in UTF-8.</p>
|
|
@@ -2175,13 +2245,21 @@ export interface CreatePredictorRequest {
|
|
|
2175
2245
|
* <p>Maximum value length - 256 Unicode characters in UTF-8.</p>
|
|
2176
2246
|
* </li>
|
|
2177
2247
|
* <li>
|
|
2178
|
-
* <p>If your tagging schema is used across multiple services and resources, remember that
|
|
2248
|
+
* <p>If your tagging schema is used across multiple services and resources, remember that
|
|
2249
|
+
* other services may have restrictions on allowed characters. Generally allowed characters
|
|
2250
|
+
* are: letters, numbers, and spaces representable in UTF-8, and the following characters: +
|
|
2251
|
+
* - = . _ : / @.</p>
|
|
2179
2252
|
* </li>
|
|
2180
2253
|
* <li>
|
|
2181
2254
|
* <p>Tag keys and values are case sensitive.</p>
|
|
2182
2255
|
* </li>
|
|
2183
2256
|
* <li>
|
|
2184
|
-
* <p>Do not use <code>aws:</code>, <code>AWS:</code>, or any upper or lowercase combination
|
|
2257
|
+
* <p>Do not use <code>aws:</code>, <code>AWS:</code>, or any upper or lowercase combination
|
|
2258
|
+
* of such as a prefix for keys as it is reserved for AWS use. You cannot edit or delete tag
|
|
2259
|
+
* keys with this prefix. Values can have this prefix. If a tag value has <code>aws</code> as
|
|
2260
|
+
* its prefix but the key does not, then Forecast considers it to be a user tag and will
|
|
2261
|
+
* count against the limit of 50 tags. Tags with only the key prefix of <code>aws</code> do
|
|
2262
|
+
* not count against your tags per resource limit.</p>
|
|
2185
2263
|
* </li>
|
|
2186
2264
|
* </ul>
|
|
2187
2265
|
*/
|
|
@@ -2224,9 +2302,9 @@ export interface CreatePredictorBacktestExportJobRequest {
|
|
|
2224
2302
|
*/
|
|
2225
2303
|
Destination: DataDestination | undefined;
|
|
2226
2304
|
/**
|
|
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>
|
|
2305
|
+
* <p>Optional metadata to help you categorize and organize your backtests. Each tag
|
|
2306
|
+
* consists of a key and an optional value, both of which you define. Tag keys and values
|
|
2307
|
+
* are case sensitive.</p>
|
|
2230
2308
|
* <p>The following restrictions apply to tags:</p>
|
|
2231
2309
|
* <ul>
|
|
2232
2310
|
* <li>
|
|
@@ -2243,17 +2321,17 @@ export interface CreatePredictorBacktestExportJobRequest {
|
|
|
2243
2321
|
* <p>Maximum value length: 256 Unicode characters in UTF-8.</p>
|
|
2244
2322
|
* </li>
|
|
2245
2323
|
* <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>
|
|
2324
|
+
* <p>Accepted characters: all letters and numbers, spaces representable in UTF-8,
|
|
2325
|
+
* and + - = . _ : / @. If your tagging schema is used across other services and
|
|
2326
|
+
* resources, the character restrictions of those services also apply. </p>
|
|
2249
2327
|
* </li>
|
|
2250
2328
|
* <li>
|
|
2251
2329
|
* <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>
|
|
2330
|
+
* <code>aws:</code> or <code>AWS:</code>. Values can have this prefix. If a
|
|
2331
|
+
* tag value has <code>aws</code> as its prefix but the key does not, Forecast
|
|
2332
|
+
* considers it to be a user tag and will count against the limit of 50 tags. Tags
|
|
2333
|
+
* with only the key prefix of <code>aws</code> do not count against your tags per
|
|
2334
|
+
* resource limit. You cannot edit or delete tag keys with this prefix.</p>
|
|
2257
2335
|
* </li>
|
|
2258
2336
|
* </ul>
|
|
2259
2337
|
*/
|
|
@@ -2411,8 +2489,41 @@ export declare namespace DescribeAutoPredictorRequest {
|
|
|
2411
2489
|
*/
|
|
2412
2490
|
const filterSensitiveLog: (obj: DescribeAutoPredictorRequest) => any;
|
|
2413
2491
|
}
|
|
2492
|
+
/**
|
|
2493
|
+
* <p>Provides information about the Explainability resource.</p>
|
|
2494
|
+
*/
|
|
2414
2495
|
export interface ExplainabilityInfo {
|
|
2496
|
+
/**
|
|
2497
|
+
* <p>The Amazon Resource Name (ARN) of the Explainability.</p>
|
|
2498
|
+
*/
|
|
2415
2499
|
ExplainabilityArn?: string;
|
|
2500
|
+
/**
|
|
2501
|
+
* <p>The status of the Explainability. States include: </p>
|
|
2502
|
+
* <ul>
|
|
2503
|
+
* <li>
|
|
2504
|
+
* <p>
|
|
2505
|
+
* <code>ACTIVE</code>
|
|
2506
|
+
* </p>
|
|
2507
|
+
* </li>
|
|
2508
|
+
* <li>
|
|
2509
|
+
* <p>
|
|
2510
|
+
* <code>CREATE_PENDING</code>, <code>CREATE_IN_PROGRESS</code>,
|
|
2511
|
+
* <code>CREATE_FAILED</code>
|
|
2512
|
+
* </p>
|
|
2513
|
+
* </li>
|
|
2514
|
+
* <li>
|
|
2515
|
+
* <p>
|
|
2516
|
+
* <code>CREATE_STOPPING</code>, <code>CREATE_STOPPED</code>
|
|
2517
|
+
* </p>
|
|
2518
|
+
* </li>
|
|
2519
|
+
* <li>
|
|
2520
|
+
* <p>
|
|
2521
|
+
* <code>DELETE_PENDING</code>, <code>DELETE_IN_PROGRESS</code>,
|
|
2522
|
+
* <code>DELETE_FAILED</code>
|
|
2523
|
+
* </p>
|
|
2524
|
+
* </li>
|
|
2525
|
+
* </ul>
|
|
2526
|
+
*/
|
|
2416
2527
|
Status?: string;
|
|
2417
2528
|
}
|
|
2418
2529
|
export declare namespace ExplainabilityInfo {
|
|
@@ -2471,6 +2582,10 @@ export interface DescribeAutoPredictorResponse {
|
|
|
2471
2582
|
* For example, "Y" indicates every year and "5min" indicates every five minutes.</p>
|
|
2472
2583
|
*/
|
|
2473
2584
|
ForecastFrequency?: string;
|
|
2585
|
+
/**
|
|
2586
|
+
* <p>An array of dimension (field) names that specify the attributes used to group your time series.</p>
|
|
2587
|
+
*/
|
|
2588
|
+
ForecastDimensions?: string[];
|
|
2474
2589
|
/**
|
|
2475
2590
|
* <p>An array of the ARNs of the dataset import jobs used to import training data for the
|
|
2476
2591
|
* predictor.</p>
|
|
@@ -2564,6 +2679,9 @@ export interface DescribeAutoPredictorResponse {
|
|
|
2564
2679
|
* <p>The accuracy metric used to optimize the predictor.</p>
|
|
2565
2680
|
*/
|
|
2566
2681
|
OptimizationMetric?: OptimizationMetric | string;
|
|
2682
|
+
/**
|
|
2683
|
+
* <p>Provides the status and ARN of the Predictor Explainability.</p>
|
|
2684
|
+
*/
|
|
2567
2685
|
ExplainabilityInfo?: ExplainabilityInfo;
|
|
2568
2686
|
}
|
|
2569
2687
|
export declare namespace DescribeAutoPredictorResponse {
|
|
@@ -3007,13 +3125,12 @@ export interface DescribeExplainabilityResponse {
|
|
|
3007
3125
|
*/
|
|
3008
3126
|
EnableVisualization?: boolean;
|
|
3009
3127
|
/**
|
|
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>
|
|
3128
|
+
* <p>The source of your data, an AWS Identity and Access Management (IAM) role that allows Amazon Forecast to
|
|
3129
|
+
* access the data and, optionally, an AWS Key Management Service (KMS) key.</p>
|
|
3013
3130
|
*/
|
|
3014
3131
|
DataSource?: DataSource;
|
|
3015
3132
|
/**
|
|
3016
|
-
* <p>Defines the fields of a dataset
|
|
3133
|
+
* <p>Defines the fields of a dataset.</p>
|
|
3017
3134
|
*/
|
|
3018
3135
|
Schema?: Schema;
|
|
3019
3136
|
/**
|
|
@@ -3734,7 +3851,7 @@ export interface DescribePredictorBacktestExportJobResponse {
|
|
|
3734
3851
|
* <li>
|
|
3735
3852
|
* <p>
|
|
3736
3853
|
* <code>CREATE_PENDING</code>, <code>CREATE_IN_PROGRESS</code>,
|
|
3737
|
-
*
|
|
3854
|
+
* <code>CREATE_FAILED</code>
|
|
3738
3855
|
* </p>
|
|
3739
3856
|
* </li>
|
|
3740
3857
|
* <li>
|
|
@@ -3745,7 +3862,7 @@ export interface DescribePredictorBacktestExportJobResponse {
|
|
|
3745
3862
|
* <li>
|
|
3746
3863
|
* <p>
|
|
3747
3864
|
* <code>DELETE_PENDING</code>, <code>DELETE_IN_PROGRESS</code>,
|
|
3748
|
-
*
|
|
3865
|
+
* <code>DELETE_FAILED</code>
|
|
3749
3866
|
* </p>
|
|
3750
3867
|
* </li>
|
|
3751
3868
|
* </ul>
|
|
@@ -3756,7 +3873,8 @@ export interface DescribePredictorBacktestExportJobResponse {
|
|
|
3756
3873
|
*/
|
|
3757
3874
|
CreationTime?: Date;
|
|
3758
3875
|
/**
|
|
3759
|
-
* <p>The last time the resource was modified. The timestamp depends on the status of the
|
|
3876
|
+
* <p>The last time the resource was modified. The timestamp depends on the status of the
|
|
3877
|
+
* job:</p>
|
|
3760
3878
|
* <ul>
|
|
3761
3879
|
* <li>
|
|
3762
3880
|
* <p>
|
|
@@ -3996,12 +4114,6 @@ export interface InvalidNextTokenException extends __SmithyException, $MetadataB
|
|
|
3996
4114
|
$fault: "client";
|
|
3997
4115
|
Message?: string;
|
|
3998
4116
|
}
|
|
3999
|
-
export declare namespace InvalidNextTokenException {
|
|
4000
|
-
/**
|
|
4001
|
-
* @internal
|
|
4002
|
-
*/
|
|
4003
|
-
const filterSensitiveLog: (obj: InvalidNextTokenException) => any;
|
|
4004
|
-
}
|
|
4005
4117
|
export interface ListDatasetGroupsRequest {
|
|
4006
4118
|
/**
|
|
4007
4119
|
* <p>If the result of the previous request was truncated, the response includes a
|
|
@@ -4363,7 +4475,7 @@ export interface ListExplainabilitiesRequest {
|
|
|
4363
4475
|
* <li>
|
|
4364
4476
|
* <p>
|
|
4365
4477
|
* <code>Key</code> - The name of the parameter to filter on. Valid values are
|
|
4366
|
-
* <code>
|
|
4478
|
+
* <code>ResourceArn</code> and <code>Status</code>.</p>
|
|
4367
4479
|
* </li>
|
|
4368
4480
|
* <li>
|
|
4369
4481
|
* <p>
|
|
@@ -4521,7 +4633,7 @@ export interface ListExplainabilityExportsRequest {
|
|
|
4521
4633
|
* <li>
|
|
4522
4634
|
* <p>
|
|
4523
4635
|
* <code>Key</code> - The name of the parameter to filter on. Valid values are
|
|
4524
|
-
* <code>
|
|
4636
|
+
* <code>ResourceArn</code> and <code>Status</code>.</p>
|
|
4525
4637
|
* </li>
|
|
4526
4638
|
* <li>
|
|
4527
4639
|
* <p>
|
|
@@ -4875,6 +4987,9 @@ export interface ForecastSummary {
|
|
|
4875
4987
|
* <p>The ARN of the predictor used to generate the forecast.</p>
|
|
4876
4988
|
*/
|
|
4877
4989
|
PredictorArn?: string;
|
|
4990
|
+
/**
|
|
4991
|
+
* <p>Whether the Forecast was created from an AutoPredictor.</p>
|
|
4992
|
+
*/
|
|
4878
4993
|
CreatedUsingAutoPredictor?: boolean;
|
|
4879
4994
|
/**
|
|
4880
4995
|
* <p>The Amazon Resource Name (ARN) of the dataset group that provided the data used to train
|
|
@@ -4974,9 +5089,9 @@ export declare namespace ListForecastsResponse {
|
|
|
4974
5089
|
}
|
|
4975
5090
|
export interface ListPredictorBacktestExportJobsRequest {
|
|
4976
5091
|
/**
|
|
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>
|
|
5092
|
+
* <p>If the result of the previous request was truncated, the response includes a
|
|
5093
|
+
* NextToken. To retrieve the next set of results, use the token in the next request.
|
|
5094
|
+
* Tokens expire after 24 hours.</p>
|
|
4980
5095
|
*/
|
|
4981
5096
|
NextToken?: string;
|
|
4982
5097
|
/**
|
|
@@ -4985,29 +5100,29 @@ export interface ListPredictorBacktestExportJobsRequest {
|
|
|
4985
5100
|
MaxResults?: number;
|
|
4986
5101
|
/**
|
|
4987
5102
|
* <p>An array of filters. For each filter, provide a condition and a match statement. The
|
|
4988
|
-
*
|
|
4989
|
-
*
|
|
4990
|
-
*
|
|
4991
|
-
*
|
|
4992
|
-
*
|
|
4993
|
-
*
|
|
4994
|
-
*
|
|
5103
|
+
* condition is either <code>IS</code> or <code>IS_NOT</code>, which specifies whether to
|
|
5104
|
+
* include or exclude the predictor backtest export jobs that match the statement from the
|
|
5105
|
+
* list. The match statement consists of a key and a value.</p>
|
|
5106
|
+
* <p>
|
|
5107
|
+
* <b>Filter properties</b>
|
|
5108
|
+
* </p>
|
|
5109
|
+
* <ul>
|
|
4995
5110
|
* <li>
|
|
4996
|
-
*
|
|
5111
|
+
* <p>
|
|
4997
5112
|
* <code>Condition</code> - The condition to apply. Valid values are
|
|
4998
5113
|
* <code>IS</code> and <code>IS_NOT</code>. To include the predictor backtest
|
|
4999
|
-
*
|
|
5000
|
-
*
|
|
5001
|
-
*
|
|
5114
|
+
* export jobs that match the statement, specify <code>IS</code>. To exclude
|
|
5115
|
+
* matching predictor backtest export jobs, specify <code>IS_NOT</code>.</p>
|
|
5116
|
+
* </li>
|
|
5002
5117
|
* <li>
|
|
5003
|
-
*
|
|
5118
|
+
* <p>
|
|
5004
5119
|
* <code>Key</code> - The name of the parameter to filter on. Valid values are
|
|
5005
5120
|
* <code>PredictorArn</code> and <code>Status</code>.</p>
|
|
5006
|
-
*
|
|
5121
|
+
* </li>
|
|
5007
5122
|
* <li>
|
|
5008
|
-
*
|
|
5123
|
+
* <p>
|
|
5009
5124
|
* <code>Value</code> - The value to match.</p>
|
|
5010
|
-
*
|
|
5125
|
+
* </li>
|
|
5011
5126
|
* </ul>
|
|
5012
5127
|
*/
|
|
5013
5128
|
Filters?: Filter[];
|
|
@@ -5019,9 +5134,9 @@ export declare namespace ListPredictorBacktestExportJobsRequest {
|
|
|
5019
5134
|
const filterSensitiveLog: (obj: ListPredictorBacktestExportJobsRequest) => any;
|
|
5020
5135
|
}
|
|
5021
5136
|
/**
|
|
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>
|
|
5137
|
+
* <p>Provides a summary of the predictor backtest export job properties used in the <a>ListPredictorBacktestExportJobs</a> operation. To get a complete set of
|
|
5138
|
+
* properties, call the <a>DescribePredictorBacktestExportJob</a> operation, and
|
|
5139
|
+
* provide the listed <code>PredictorBacktestExportJobArn</code>.</p>
|
|
5025
5140
|
*/
|
|
5026
5141
|
export interface PredictorBacktestExportJobSummary {
|
|
5027
5142
|
/**
|
|
@@ -5048,7 +5163,7 @@ export interface PredictorBacktestExportJobSummary {
|
|
|
5048
5163
|
* <li>
|
|
5049
5164
|
* <p>
|
|
5050
5165
|
* <code>CREATE_PENDING</code>, <code>CREATE_IN_PROGRESS</code>,
|
|
5051
|
-
*
|
|
5166
|
+
* <code>CREATE_FAILED</code>
|
|
5052
5167
|
* </p>
|
|
5053
5168
|
* </li>
|
|
5054
5169
|
* <li>
|
|
@@ -5059,7 +5174,7 @@ export interface PredictorBacktestExportJobSummary {
|
|
|
5059
5174
|
* <li>
|
|
5060
5175
|
* <p>
|
|
5061
5176
|
* <code>DELETE_PENDING</code>, <code>DELETE_IN_PROGRESS</code>,
|
|
5062
|
-
*
|
|
5177
|
+
* <code>DELETE_FAILED</code>
|
|
5063
5178
|
* </p>
|
|
5064
5179
|
* </li>
|
|
5065
5180
|
* </ul>
|
|
@@ -5074,7 +5189,8 @@ export interface PredictorBacktestExportJobSummary {
|
|
|
5074
5189
|
*/
|
|
5075
5190
|
CreationTime?: Date;
|
|
5076
5191
|
/**
|
|
5077
|
-
* <p>The last time the resource was modified. The timestamp depends on the status of the
|
|
5192
|
+
* <p>The last time the resource was modified. The timestamp depends on the status of the
|
|
5193
|
+
* job:</p>
|
|
5078
5194
|
* <ul>
|
|
5079
5195
|
* <li>
|
|
5080
5196
|
* <p>
|
|
@@ -5114,8 +5230,8 @@ export interface ListPredictorBacktestExportJobsResponse {
|
|
|
5114
5230
|
*/
|
|
5115
5231
|
PredictorBacktestExportJobs?: PredictorBacktestExportJobSummary[];
|
|
5116
5232
|
/**
|
|
5117
|
-
* <p>Returns this token if the response is truncated. To retrieve the next
|
|
5118
|
-
*
|
|
5233
|
+
* <p>Returns this token if the response is truncated. To retrieve the next set of results,
|
|
5234
|
+
* use the token in the next request.</p>
|
|
5119
5235
|
*/
|
|
5120
5236
|
NextToken?: string;
|
|
5121
5237
|
}
|
|
@@ -5296,7 +5412,8 @@ export declare namespace ListPredictorsResponse {
|
|
|
5296
5412
|
}
|
|
5297
5413
|
export interface ListTagsForResourceRequest {
|
|
5298
5414
|
/**
|
|
5299
|
-
* <p>The Amazon Resource Name (ARN) that identifies the resource for which to list the tags.
|
|
5415
|
+
* <p>The Amazon Resource Name (ARN) that identifies the resource for which to list the tags.
|
|
5416
|
+
* </p>
|
|
5300
5417
|
*/
|
|
5301
5418
|
ResourceArn: string | undefined;
|
|
5302
5419
|
}
|
|
@@ -5322,8 +5439,9 @@ export interface StopResourceRequest {
|
|
|
5322
5439
|
/**
|
|
5323
5440
|
* <p>The Amazon Resource Name (ARN) that identifies the resource to stop. The supported ARNs
|
|
5324
5441
|
* are <code>DatasetImportJobArn</code>, <code>PredictorArn</code>,
|
|
5325
|
-
* <code>PredictorBacktestExportJobArn</code>, <code>ForecastArn</code>,
|
|
5326
|
-
* <code>ForecastExportJobArn</code
|
|
5442
|
+
* <code>PredictorBacktestExportJobArn</code>, <code>ForecastArn</code>,
|
|
5443
|
+
* <code>ForecastExportJobArn</code>, <code>ExplainabilityArn</code>, and
|
|
5444
|
+
* <code>ExplainabilityExportArn</code>. </p>
|
|
5327
5445
|
*/
|
|
5328
5446
|
ResourceArn: string | undefined;
|
|
5329
5447
|
}
|
|
@@ -5335,7 +5453,8 @@ export declare namespace StopResourceRequest {
|
|
|
5335
5453
|
}
|
|
5336
5454
|
export interface TagResourceRequest {
|
|
5337
5455
|
/**
|
|
5338
|
-
* <p>The Amazon Resource Name (ARN) that identifies the resource for which to list the tags.
|
|
5456
|
+
* <p>The Amazon Resource Name (ARN) that identifies the resource for which to list the tags.
|
|
5457
|
+
* </p>
|
|
5339
5458
|
*/
|
|
5340
5459
|
ResourceArn: string | undefined;
|
|
5341
5460
|
/**
|
|
@@ -5346,7 +5465,8 @@ export interface TagResourceRequest {
|
|
|
5346
5465
|
* <p>Maximum number of tags per resource - 50.</p>
|
|
5347
5466
|
* </li>
|
|
5348
5467
|
* <li>
|
|
5349
|
-
* <p>For each resource, each tag key must be unique, and each tag key can have only one
|
|
5468
|
+
* <p>For each resource, each tag key must be unique, and each tag key can have only one
|
|
5469
|
+
* value.</p>
|
|
5350
5470
|
* </li>
|
|
5351
5471
|
* <li>
|
|
5352
5472
|
* <p>Maximum key length - 128 Unicode characters in UTF-8.</p>
|
|
@@ -5355,13 +5475,21 @@ export interface TagResourceRequest {
|
|
|
5355
5475
|
* <p>Maximum value length - 256 Unicode characters in UTF-8.</p>
|
|
5356
5476
|
* </li>
|
|
5357
5477
|
* <li>
|
|
5358
|
-
* <p>If your tagging schema is used across multiple services and resources, remember that
|
|
5478
|
+
* <p>If your tagging schema is used across multiple services and resources, remember that
|
|
5479
|
+
* other services may have restrictions on allowed characters. Generally allowed characters
|
|
5480
|
+
* are: letters, numbers, and spaces representable in UTF-8, and the following characters: +
|
|
5481
|
+
* - = . _ : / @.</p>
|
|
5359
5482
|
* </li>
|
|
5360
5483
|
* <li>
|
|
5361
5484
|
* <p>Tag keys and values are case sensitive.</p>
|
|
5362
5485
|
* </li>
|
|
5363
5486
|
* <li>
|
|
5364
|
-
* <p>Do not use <code>aws:</code>, <code>AWS:</code>, or any upper or lowercase combination
|
|
5487
|
+
* <p>Do not use <code>aws:</code>, <code>AWS:</code>, or any upper or lowercase combination
|
|
5488
|
+
* of such as a prefix for keys as it is reserved for AWS use. You cannot edit or delete tag
|
|
5489
|
+
* keys with this prefix. Values can have this prefix. If a tag value has <code>aws</code> as
|
|
5490
|
+
* its prefix but the key does not, then Forecast considers it to be a user tag and will
|
|
5491
|
+
* count against the limit of 50 tags. Tags with only the key prefix of <code>aws</code> do
|
|
5492
|
+
* not count against your tags per resource limit.</p>
|
|
5365
5493
|
* </li>
|
|
5366
5494
|
* </ul>
|
|
5367
5495
|
*/
|
|
@@ -5383,7 +5511,8 @@ export declare namespace TagResourceResponse {
|
|
|
5383
5511
|
}
|
|
5384
5512
|
export interface UntagResourceRequest {
|
|
5385
5513
|
/**
|
|
5386
|
-
* <p>The Amazon Resource Name (ARN) that identifies the resource for which to list the tags.
|
|
5514
|
+
* <p>The Amazon Resource Name (ARN) that identifies the resource for which to list the tags.
|
|
5515
|
+
* </p>
|
|
5387
5516
|
*/
|
|
5388
5517
|
ResourceArn: string | undefined;
|
|
5389
5518
|
/**
|