aws-sdk-forecastservice 1.39.0 → 1.41.0

Sign up to get free protection for your applications and to get access to all the features.
@@ -266,25 +266,25 @@ module Aws::ForecastService
266
266
  # the "filling" featurization method for a **Target Time Series**
267
267
  # dataset. Default values are bolded.
268
268
  #
269
- # * `aggregation`\: **sum**, `avg`, `first`, `min`, `max`
269
+ # * `aggregation`: **sum**, `avg`, `first`, `min`, `max`
270
270
  #
271
- # * `frontfill`\: **none**
271
+ # * `frontfill`: **none**
272
272
  #
273
- # * `middlefill`\: **zero**, `nan` (not a number), `value`, `median`,
273
+ # * `middlefill`: **zero**, `nan` (not a number), `value`, `median`,
274
274
  # `mean`, `min`, `max`
275
275
  #
276
- # * `backfill`\: **zero**, `nan`, `value`, `median`, `mean`, `min`,
276
+ # * `backfill`: **zero**, `nan`, `value`, `median`, `mean`, `min`,
277
277
  # `max`
278
278
  #
279
279
  # The following list shows the parameters and their valid values for a
280
280
  # **Related Time Series** featurization method (there are no
281
281
  # defaults):
282
282
  #
283
- # * `middlefill`\: `zero`, `value`, `median`, `mean`, `min`, `max`
283
+ # * `middlefill`: `zero`, `value`, `median`, `mean`, `min`, `max`
284
284
  #
285
- # * `backfill`\: `zero`, `value`, `median`, `mean`, `min`, `max`
285
+ # * `backfill`: `zero`, `value`, `median`, `mean`, `min`, `max`
286
286
  #
287
- # * `futurefill`\: `zero`, `value`, `median`, `mean`, `min`, `max`
287
+ # * `futurefill`: `zero`, `value`, `median`, `mean`, `min`, `max`
288
288
  #
289
289
  # To set a filling method to a specific value, set the fill parameter
290
290
  # to `value` and define the value in a corresponding `_value`
@@ -466,10 +466,28 @@ module Aws::ForecastService
466
466
  # @!attribute [rw] forecast_frequency
467
467
  # The frequency of predictions in a forecast.
468
468
  #
469
- # Valid intervals are Y (Year), M (Month), W (Week), D (Day), H
470
- # (Hour), 30min (30 minutes), 15min (15 minutes), 10min (10 minutes),
471
- # 5min (5 minutes), and 1min (1 minute). For example, "Y" indicates
472
- # every year and "5min" indicates every five minutes.
469
+ # Valid intervals are an integer followed by Y (Year), M (Month), W
470
+ # (Week), D (Day), H (Hour), and min (Minute). For example, "1D"
471
+ # indicates every day and "15min" indicates every 15 minutes. You
472
+ # cannot specify a value that would overlap with the next larger
473
+ # frequency. That means, for example, you cannot specify a frequency
474
+ # of 60 minutes, because that is equivalent to 1 hour. The valid
475
+ # values for each frequency are the following:
476
+ #
477
+ # * Minute - 1-59
478
+ #
479
+ # * Hour - 1-23
480
+ #
481
+ # * Day - 1-6
482
+ #
483
+ # * Week - 1-4
484
+ #
485
+ # * Month - 1-11
486
+ #
487
+ # * Year - 1
488
+ #
489
+ # Thus, if you want every other week forecasts, specify "2W". Or, if
490
+ # you want quarterly forecasts, you specify "3M".
473
491
  #
474
492
  # The frequency must be greater than or equal to the
475
493
  # TARGET\_TIME\_SERIES dataset frequency.
@@ -484,10 +502,10 @@ module Aws::ForecastService
484
502
  # @return [Types::DataConfig]
485
503
  #
486
504
  # @!attribute [rw] encryption_config
487
- # An AWS Key Management Service (KMS) key and an AWS Identity and
488
- # Access Management (IAM) role that Amazon Forecast can assume to
489
- # access the key. You can specify this optional object in the
490
- # CreateDataset and CreatePredictor requests.
505
+ # An Key Management Service (KMS) key and an Identity and Access
506
+ # Management (IAM) role that Amazon Forecast can assume to access the
507
+ # key. You can specify this optional object in the CreateDataset and
508
+ # CreatePredictor requests.
491
509
  # @return [Types::EncryptionConfig]
492
510
  #
493
511
  # @!attribute [rw] reference_predictor_arn
@@ -649,12 +667,13 @@ module Aws::ForecastService
649
667
  # * Tag keys and values are case sensitive.
650
668
  #
651
669
  # * Do not use `aws:`, `AWS:`, or any upper or lowercase combination
652
- # of such as a prefix for keys as it is reserved for AWS use. You
653
- # cannot edit or delete tag keys with this prefix. Values can have
654
- # this prefix. If a tag value has `aws` as its prefix but the key
655
- # does not, then Forecast considers it to be a user tag and will
656
- # count against the limit of 50 tags. Tags with only the key prefix
657
- # of `aws` do not count against your tags per resource limit.
670
+ # of such as a prefix for keys as it is reserved for Amazon Web
671
+ # Services use. You cannot edit or delete tag keys with this prefix.
672
+ # Values can have this prefix. If a tag value has `aws` as its
673
+ # prefix but the key does not, then Forecast considers it to be a
674
+ # user tag and will count against the limit of 50 tags. Tags with
675
+ # only the key prefix of `aws` do not count against your tags per
676
+ # resource limit.
658
677
  # @return [Array<Types::Tag>]
659
678
  #
660
679
  # @see http://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/CreateDatasetGroupRequest AWS API Documentation
@@ -693,15 +712,15 @@ module Aws::ForecastService
693
712
  # @return [String]
694
713
  #
695
714
  # @!attribute [rw] data_source
696
- # The location of the training data to import and an AWS Identity and
715
+ # The location of the training data to import and an Identity and
697
716
  # Access Management (IAM) role that Amazon Forecast can assume to
698
717
  # access the data. The training data must be stored in an Amazon S3
699
718
  # bucket.
700
719
  #
701
- # If encryption is used, `DataSource` must include an AWS Key
702
- # Management Service (KMS) key and the IAM role must allow Amazon
703
- # Forecast permission to access the key. The KMS key and IAM role must
704
- # match those specified in the `EncryptionConfig` parameter of the
720
+ # If encryption is used, `DataSource` must include an Key Management
721
+ # Service (KMS) key and the IAM role must allow Amazon Forecast
722
+ # permission to access the key. The KMS key and IAM role must match
723
+ # those specified in the `EncryptionConfig` parameter of the
705
724
  # [CreateDataset][1] operation.
706
725
  #
707
726
  #
@@ -783,12 +802,13 @@ module Aws::ForecastService
783
802
  # * Tag keys and values are case sensitive.
784
803
  #
785
804
  # * Do not use `aws:`, `AWS:`, or any upper or lowercase combination
786
- # of such as a prefix for keys as it is reserved for AWS use. You
787
- # cannot edit or delete tag keys with this prefix. Values can have
788
- # this prefix. If a tag value has `aws` as its prefix but the key
789
- # does not, then Forecast considers it to be a user tag and will
790
- # count against the limit of 50 tags. Tags with only the key prefix
791
- # of `aws` do not count against your tags per resource limit.
805
+ # of such as a prefix for keys as it is reserved for Amazon Web
806
+ # Services use. You cannot edit or delete tag keys with this prefix.
807
+ # Values can have this prefix. If a tag value has `aws` as its
808
+ # prefix but the key does not, then Forecast considers it to be a
809
+ # user tag and will count against the limit of 50 tags. Tags with
810
+ # only the key prefix of `aws` do not count against your tags per
811
+ # resource limit.
792
812
  # @return [Array<Types::Tag>]
793
813
  #
794
814
  # @!attribute [rw] format
@@ -796,6 +816,13 @@ module Aws::ForecastService
796
816
  # is CSV.
797
817
  # @return [String]
798
818
  #
819
+ # @!attribute [rw] import_mode
820
+ # Specifies whether the dataset import job is a `FULL` or
821
+ # `INCREMENTAL` import. A `FULL` dataset import replaces all of the
822
+ # existing data with the newly imported data. An `INCREMENTAL` import
823
+ # appends the imported data to the existing data.
824
+ # @return [String]
825
+ #
799
826
  # @see http://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/CreateDatasetImportJobRequest AWS API Documentation
800
827
  #
801
828
  class CreateDatasetImportJobRequest < Struct.new(
@@ -807,7 +834,8 @@ module Aws::ForecastService
807
834
  :use_geolocation_for_time_zone,
808
835
  :geolocation_format,
809
836
  :tags,
810
- :format)
837
+ :format,
838
+ :import_mode)
811
839
  SENSITIVE = []
812
840
  include Aws::Structure
813
841
  end
@@ -854,10 +882,28 @@ module Aws::ForecastService
854
882
  # The frequency of data collection. This parameter is required for
855
883
  # RELATED\_TIME\_SERIES datasets.
856
884
  #
857
- # Valid intervals are Y (Year), M (Month), W (Week), D (Day), H
858
- # (Hour), 30min (30 minutes), 15min (15 minutes), 10min (10 minutes),
859
- # 5min (5 minutes), and 1min (1 minute). For example, "D" indicates
860
- # every day and "15min" indicates every 15 minutes.
885
+ # Valid intervals are an integer followed by Y (Year), M (Month), W
886
+ # (Week), D (Day), H (Hour), and min (Minute). For example, "1D"
887
+ # indicates every day and "15min" indicates every 15 minutes. You
888
+ # cannot specify a value that would overlap with the next larger
889
+ # frequency. That means, for example, you cannot specify a frequency
890
+ # of 60 minutes, because that is equivalent to 1 hour. The valid
891
+ # values for each frequency are the following:
892
+ #
893
+ # * Minute - 1-59
894
+ #
895
+ # * Hour - 1-23
896
+ #
897
+ # * Day - 1-6
898
+ #
899
+ # * Week - 1-4
900
+ #
901
+ # * Month - 1-11
902
+ #
903
+ # * Year - 1
904
+ #
905
+ # Thus, if you want every other week forecasts, specify "2W". Or, if
906
+ # you want quarterly forecasts, you specify "3M".
861
907
  # @return [String]
862
908
  #
863
909
  # @!attribute [rw] schema
@@ -874,9 +920,9 @@ module Aws::ForecastService
874
920
  # @return [Types::Schema]
875
921
  #
876
922
  # @!attribute [rw] encryption_config
877
- # An AWS Key Management Service (KMS) key and the AWS Identity and
878
- # Access Management (IAM) role that Amazon Forecast can assume to
879
- # access the key.
923
+ # An Key Management Service (KMS) key and the Identity and Access
924
+ # Management (IAM) role that Amazon Forecast can assume to access the
925
+ # key.
880
926
  # @return [Types::EncryptionConfig]
881
927
  #
882
928
  # @!attribute [rw] tags
@@ -904,12 +950,13 @@ module Aws::ForecastService
904
950
  # * Tag keys and values are case sensitive.
905
951
  #
906
952
  # * Do not use `aws:`, `AWS:`, or any upper or lowercase combination
907
- # of such as a prefix for keys as it is reserved for AWS use. You
908
- # cannot edit or delete tag keys with this prefix. Values can have
909
- # this prefix. If a tag value has `aws` as its prefix but the key
910
- # does not, then Forecast considers it to be a user tag and will
911
- # count against the limit of 50 tags. Tags with only the key prefix
912
- # of `aws` do not count against your tags per resource limit.
953
+ # of such as a prefix for keys as it is reserved for Amazon Web
954
+ # Services use. You cannot edit or delete tag keys with this prefix.
955
+ # Values can have this prefix. If a tag value has `aws` as its
956
+ # prefix but the key does not, then Forecast considers it to be a
957
+ # user tag and will count against the limit of 50 tags. Tags with
958
+ # only the key prefix of `aws` do not count against your tags per
959
+ # resource limit.
913
960
  # @return [Array<Types::Tag>]
914
961
  #
915
962
  # @see http://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/CreateDatasetRequest AWS API Documentation
@@ -947,10 +994,10 @@ module Aws::ForecastService
947
994
  # @return [String]
948
995
  #
949
996
  # @!attribute [rw] destination
950
- # The destination for an export job. Provide an S3 path, an AWS
951
- # Identity and Access Management (IAM) role that allows Amazon
952
- # Forecast to access the location, and an AWS Key Management Service
953
- # (KMS) key (optional).
997
+ # The destination for an export job. Provide an S3 path, an Identity
998
+ # and Access Management (IAM) role that allows Amazon Forecast to
999
+ # access the location, and an Key Management Service (KMS) key
1000
+ # (optional).
954
1001
  # @return [Types::DataDestination]
955
1002
  #
956
1003
  # @!attribute [rw] tags
@@ -1026,9 +1073,9 @@ module Aws::ForecastService
1026
1073
  # @return [Types::ExplainabilityConfig]
1027
1074
  #
1028
1075
  # @!attribute [rw] data_source
1029
- # The source of your data, an AWS Identity and Access Management (IAM)
1076
+ # The source of your data, an Identity and Access Management (IAM)
1030
1077
  # role that allows Amazon Forecast to access the data and, optionally,
1031
- # an AWS Key Management Service (KMS) key.
1078
+ # an Key Management Service (KMS) key.
1032
1079
  # @return [Types::DataSource]
1033
1080
  #
1034
1081
  # @!attribute [rw] schema
@@ -1037,7 +1084,7 @@ module Aws::ForecastService
1037
1084
  #
1038
1085
  # @!attribute [rw] enable_visualization
1039
1086
  # Create an Explainability visualization that is viewable within the
1040
- # AWS console.
1087
+ # Amazon Web Services console.
1041
1088
  # @return [Boolean]
1042
1089
  #
1043
1090
  # @!attribute [rw] start_date_time
@@ -1124,14 +1171,14 @@ module Aws::ForecastService
1124
1171
  # @return [String]
1125
1172
  #
1126
1173
  # @!attribute [rw] destination
1127
- # The location where you want to save the forecast and an AWS Identity
1128
- # and Access Management (IAM) role that Amazon Forecast can assume to
1174
+ # The location where you want to save the forecast and an Identity and
1175
+ # Access Management (IAM) role that Amazon Forecast can assume to
1129
1176
  # access the location. The forecast must be exported to an Amazon S3
1130
1177
  # bucket.
1131
1178
  #
1132
- # If encryption is used, `Destination` must include an AWS Key
1133
- # Management Service (KMS) key. The IAM role must allow Amazon
1134
- # Forecast permission to access the key.
1179
+ # If encryption is used, `Destination` must include an Key Management
1180
+ # Service (KMS) key. The IAM role must allow Amazon Forecast
1181
+ # permission to access the key.
1135
1182
  # @return [Types::DataDestination]
1136
1183
  #
1137
1184
  # @!attribute [rw] tags
@@ -1159,12 +1206,13 @@ module Aws::ForecastService
1159
1206
  # * Tag keys and values are case sensitive.
1160
1207
  #
1161
1208
  # * Do not use `aws:`, `AWS:`, or any upper or lowercase combination
1162
- # of such as a prefix for keys as it is reserved for AWS use. You
1163
- # cannot edit or delete tag keys with this prefix. Values can have
1164
- # this prefix. If a tag value has `aws` as its prefix but the key
1165
- # does not, then Forecast considers it to be a user tag and will
1166
- # count against the limit of 50 tags. Tags with only the key prefix
1167
- # of `aws` do not count against your tags per resource limit.
1209
+ # of such as a prefix for keys as it is reserved for Amazon Web
1210
+ # Services use. You cannot edit or delete tag keys with this prefix.
1211
+ # Values can have this prefix. If a tag value has `aws` as its
1212
+ # prefix but the key does not, then Forecast considers it to be a
1213
+ # user tag and will count against the limit of 50 tags. Tags with
1214
+ # only the key prefix of `aws` do not count against your tags per
1215
+ # resource limit.
1168
1216
  # @return [Array<Types::Tag>]
1169
1217
  #
1170
1218
  # @!attribute [rw] format
@@ -1243,12 +1291,13 @@ module Aws::ForecastService
1243
1291
  # * Tag keys and values are case sensitive.
1244
1292
  #
1245
1293
  # * Do not use `aws:`, `AWS:`, or any upper or lowercase combination
1246
- # of such as a prefix for keys as it is reserved for AWS use. You
1247
- # cannot edit or delete tag keys with this prefix. Values can have
1248
- # this prefix. If a tag value has `aws` as its prefix but the key
1249
- # does not, then Forecast considers it to be a user tag and will
1250
- # count against the limit of 50 tags. Tags with only the key prefix
1251
- # of `aws` do not count against your tags per resource limit.
1294
+ # of such as a prefix for keys as it is reserved for Amazon Web
1295
+ # Services use. You cannot edit or delete tag keys with this prefix.
1296
+ # Values can have this prefix. If a tag value has `aws` as its
1297
+ # prefix but the key does not, then Forecast considers it to be a
1298
+ # user tag and will count against the limit of 50 tags. Tags with
1299
+ # only the key prefix of `aws` do not count against your tags per
1300
+ # resource limit.
1252
1301
  # @return [Array<Types::Tag>]
1253
1302
  #
1254
1303
  # @!attribute [rw] time_series_selector
@@ -1336,10 +1385,10 @@ module Aws::ForecastService
1336
1385
  # @return [String]
1337
1386
  #
1338
1387
  # @!attribute [rw] destination
1339
- # The destination for an export job. Provide an S3 path, an AWS
1340
- # Identity and Access Management (IAM) role that allows Amazon
1341
- # Forecast to access the location, and an AWS Key Management Service
1342
- # (KMS) key (optional).
1388
+ # The destination for an export job. Provide an S3 path, an Identity
1389
+ # and Access Management (IAM) role that allows Amazon Forecast to
1390
+ # access the location, and an Key Management Service (KMS) key
1391
+ # (optional).
1343
1392
  # @return [Types::DataDestination]
1344
1393
  #
1345
1394
  # @!attribute [rw] tags
@@ -1463,8 +1512,8 @@ module Aws::ForecastService
1463
1512
  #
1464
1513
  # @!attribute [rw] auto_ml_override_strategy
1465
1514
  # <note markdown="1"> The `LatencyOptimized` AutoML override strategy is only available in
1466
- # private beta. Contact AWS Support or your account manager to learn
1467
- # more about access privileges.
1515
+ # private beta. Contact Amazon Web Services Support or your account
1516
+ # manager to learn more about access privileges.
1468
1517
  #
1469
1518
  # </note>
1470
1519
  #
@@ -1533,9 +1582,9 @@ module Aws::ForecastService
1533
1582
  # @return [Types::FeaturizationConfig]
1534
1583
  #
1535
1584
  # @!attribute [rw] encryption_config
1536
- # An AWS Key Management Service (KMS) key and the AWS Identity and
1537
- # Access Management (IAM) role that Amazon Forecast can assume to
1538
- # access the key.
1585
+ # An Key Management Service (KMS) key and the Identity and Access
1586
+ # Management (IAM) role that Amazon Forecast can assume to access the
1587
+ # key.
1539
1588
  # @return [Types::EncryptionConfig]
1540
1589
  #
1541
1590
  # @!attribute [rw] tags
@@ -1563,12 +1612,13 @@ module Aws::ForecastService
1563
1612
  # * Tag keys and values are case sensitive.
1564
1613
  #
1565
1614
  # * Do not use `aws:`, `AWS:`, or any upper or lowercase combination
1566
- # of such as a prefix for keys as it is reserved for AWS use. You
1567
- # cannot edit or delete tag keys with this prefix. Values can have
1568
- # this prefix. If a tag value has `aws` as its prefix but the key
1569
- # does not, then Forecast considers it to be a user tag and will
1570
- # count against the limit of 50 tags. Tags with only the key prefix
1571
- # of `aws` do not count against your tags per resource limit.
1615
+ # of such as a prefix for keys as it is reserved for Amazon Web
1616
+ # Services use. You cannot edit or delete tag keys with this prefix.
1617
+ # Values can have this prefix. If a tag value has `aws` as its
1618
+ # prefix but the key does not, then Forecast considers it to be a
1619
+ # user tag and will count against the limit of 50 tags. Tags with
1620
+ # only the key prefix of `aws` do not count against your tags per
1621
+ # resource limit.
1572
1622
  # @return [Array<Types::Tag>]
1573
1623
  #
1574
1624
  # @!attribute [rw] optimization_metric
@@ -1671,14 +1721,14 @@ module Aws::ForecastService
1671
1721
  # @return [Array<String>]
1672
1722
  #
1673
1723
  # @!attribute [rw] destination
1674
- # The location where you want to save the forecast and an AWS Identity
1675
- # and Access Management (IAM) role that Amazon Forecast can assume to
1724
+ # The location where you want to save the forecast and an Identity and
1725
+ # Access Management (IAM) role that Amazon Forecast can assume to
1676
1726
  # access the location. The forecast must be exported to an Amazon S3
1677
1727
  # bucket.
1678
1728
  #
1679
- # If encryption is used, `Destination` must include an AWS Key
1680
- # Management Service (KMS) key. The IAM role must allow Amazon
1681
- # Forecast permission to access the key.
1729
+ # If encryption is used, `Destination` must include an Key Management
1730
+ # Service (KMS) key. The IAM role must allow Amazon Forecast
1731
+ # permission to access the key.
1682
1732
  # @return [Types::DataDestination]
1683
1733
  #
1684
1734
  # @!attribute [rw] tags
@@ -1739,9 +1789,10 @@ module Aws::ForecastService
1739
1789
  # time series does not need to contain all rows that are in the
1740
1790
  # baseline related time series. Include only the rows
1741
1791
  # (measure-dimension combinations) that you want to include in the
1742
- # what-if forecast. This dataset is merged with the original time
1743
- # series to create a transformed dataset that is used for the what-if
1744
- # analysis.
1792
+ # what-if forecast.
1793
+ #
1794
+ # This dataset is merged with the original time series to create a
1795
+ # transformed dataset that is used for the what-if analysis.
1745
1796
  #
1746
1797
  # This dataset should contain the items to modify (such as item\_id or
1747
1798
  # workforce\_type), any relevant dimensions, the timestamp column, and
@@ -1810,9 +1861,9 @@ module Aws::ForecastService
1810
1861
  include Aws::Structure
1811
1862
  end
1812
1863
 
1813
- # The destination for an export job. Provide an S3 path, an AWS Identity
1814
- # and Access Management (IAM) role that allows Amazon Forecast to access
1815
- # the location, and an AWS Key Management Service (KMS) key (optional).
1864
+ # The destination for an export job. Provide an S3 path, an Identity and
1865
+ # Access Management (IAM) role that allows Amazon Forecast to access the
1866
+ # location, and an Key Management Service (KMS) key (optional).
1816
1867
  #
1817
1868
  # @!attribute [rw] s3_config
1818
1869
  # The path to an Amazon Simple Storage Service (Amazon S3) bucket
@@ -1827,9 +1878,9 @@ module Aws::ForecastService
1827
1878
  include Aws::Structure
1828
1879
  end
1829
1880
 
1830
- # The source of your data, an AWS Identity and Access Management (IAM)
1831
- # role that allows Amazon Forecast to access the data and, optionally,
1832
- # an AWS Key Management Service (KMS) key.
1881
+ # The source of your data, an Identity and Access Management (IAM) role
1882
+ # that allows Amazon Forecast to access the data and, optionally, an Key
1883
+ # Management Service (KMS) key.
1833
1884
  #
1834
1885
  # @!attribute [rw] s3_config
1835
1886
  # The path to the data stored in an Amazon Simple Storage Service
@@ -1907,12 +1958,12 @@ module Aws::ForecastService
1907
1958
  # @return [String]
1908
1959
  #
1909
1960
  # @!attribute [rw] data_source
1910
- # The location of the training data to import and an AWS Identity and
1961
+ # The location of the training data to import and an Identity and
1911
1962
  # Access Management (IAM) role that Amazon Forecast can assume to
1912
1963
  # access the data. The training data must be stored in an Amazon S3
1913
1964
  # bucket.
1914
1965
  #
1915
- # If encryption is used, `DataSource` includes an AWS Key Management
1966
+ # If encryption is used, `DataSource` includes an Key Management
1916
1967
  # Service (KMS) key.
1917
1968
  # @return [Types::DataSource]
1918
1969
  #
@@ -1951,6 +2002,10 @@ module Aws::ForecastService
1951
2002
  # * `ACTIVE` or `CREATE_FAILED` - When the job finished or failed.
1952
2003
  # @return [Time]
1953
2004
  #
2005
+ # @!attribute [rw] import_mode
2006
+ # The import mode of the dataset import job, FULL or INCREMENTAL.
2007
+ # @return [String]
2008
+ #
1954
2009
  # @see http://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/DatasetImportJobSummary AWS API Documentation
1955
2010
  #
1956
2011
  class DatasetImportJobSummary < Struct.new(
@@ -1960,7 +2015,8 @@ module Aws::ForecastService
1960
2015
  :status,
1961
2016
  :message,
1962
2017
  :creation_time,
1963
- :last_modification_time)
2018
+ :last_modification_time,
2019
+ :import_mode)
1964
2020
  SENSITIVE = []
1965
2021
  include Aws::Structure
1966
2022
  end
@@ -2249,10 +2305,10 @@ module Aws::ForecastService
2249
2305
  # @return [Types::DataConfig]
2250
2306
  #
2251
2307
  # @!attribute [rw] encryption_config
2252
- # An AWS Key Management Service (KMS) key and an AWS Identity and
2253
- # Access Management (IAM) role that Amazon Forecast can assume to
2254
- # access the key. You can specify this optional object in the
2255
- # CreateDataset and CreatePredictor requests.
2308
+ # An Key Management Service (KMS) key and an Identity and Access
2309
+ # Management (IAM) role that Amazon Forecast can assume to access the
2310
+ # key. You can specify this optional object in the CreateDataset and
2311
+ # CreatePredictor requests.
2256
2312
  # @return [Types::EncryptionConfig]
2257
2313
  #
2258
2314
  # @!attribute [rw] reference_predictor_summary
@@ -2481,11 +2537,11 @@ module Aws::ForecastService
2481
2537
  # @return [String]
2482
2538
  #
2483
2539
  # @!attribute [rw] data_source
2484
- # The location of the training data to import and an AWS Identity and
2540
+ # The location of the training data to import and an Identity and
2485
2541
  # Access Management (IAM) role that Amazon Forecast can assume to
2486
2542
  # access the data.
2487
2543
  #
2488
- # If encryption is used, `DataSource` includes an AWS Key Management
2544
+ # If encryption is used, `DataSource` includes an Key Management
2489
2545
  # Service (KMS) key.
2490
2546
  # @return [Types::DataSource]
2491
2547
  #
@@ -2542,6 +2598,10 @@ module Aws::ForecastService
2542
2598
  # The format of the imported data, CSV or PARQUET.
2543
2599
  # @return [String]
2544
2600
  #
2601
+ # @!attribute [rw] import_mode
2602
+ # The import mode of the dataset import job, FULL or INCREMENTAL.
2603
+ # @return [String]
2604
+ #
2545
2605
  # @see http://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/DescribeDatasetImportJobResponse AWS API Documentation
2546
2606
  #
2547
2607
  class DescribeDatasetImportJobResponse < Struct.new(
@@ -2560,7 +2620,8 @@ module Aws::ForecastService
2560
2620
  :message,
2561
2621
  :creation_time,
2562
2622
  :last_modification_time,
2563
- :format)
2623
+ :format,
2624
+ :import_mode)
2564
2625
  SENSITIVE = []
2565
2626
  include Aws::Structure
2566
2627
  end
@@ -2609,9 +2670,9 @@ module Aws::ForecastService
2609
2670
  # @return [Types::Schema]
2610
2671
  #
2611
2672
  # @!attribute [rw] encryption_config
2612
- # The AWS Key Management Service (KMS) key and the AWS Identity and
2613
- # Access Management (IAM) role that Amazon Forecast can assume to
2614
- # access the key.
2673
+ # The Key Management Service (KMS) key and the Identity and Access
2674
+ # Management (IAM) role that Amazon Forecast can assume to access the
2675
+ # key.
2615
2676
  # @return [Types::EncryptionConfig]
2616
2677
  #
2617
2678
  # @!attribute [rw] status
@@ -2699,10 +2760,10 @@ module Aws::ForecastService
2699
2760
  # @return [String]
2700
2761
  #
2701
2762
  # @!attribute [rw] destination
2702
- # The destination for an export job. Provide an S3 path, an AWS
2703
- # Identity and Access Management (IAM) role that allows Amazon
2704
- # Forecast to access the location, and an AWS Key Management Service
2705
- # (KMS) key (optional).
2763
+ # The destination for an export job. Provide an S3 path, an Identity
2764
+ # and Access Management (IAM) role that allows Amazon Forecast to
2765
+ # access the location, and an Key Management Service (KMS) key
2766
+ # (optional).
2706
2767
  # @return [Types::DataDestination]
2707
2768
  #
2708
2769
  # @!attribute [rw] message
@@ -2796,9 +2857,9 @@ module Aws::ForecastService
2796
2857
  # @return [Boolean]
2797
2858
  #
2798
2859
  # @!attribute [rw] data_source
2799
- # The source of your data, an AWS Identity and Access Management (IAM)
2860
+ # The source of your data, an Identity and Access Management (IAM)
2800
2861
  # role that allows Amazon Forecast to access the data and, optionally,
2801
- # an AWS Key Management Service (KMS) key.
2862
+ # an Key Management Service (KMS) key.
2802
2863
  # @return [Types::DataSource]
2803
2864
  #
2804
2865
  # @!attribute [rw] schema
@@ -3167,10 +3228,10 @@ module Aws::ForecastService
3167
3228
  # @return [String]
3168
3229
  #
3169
3230
  # @!attribute [rw] destination
3170
- # The destination for an export job. Provide an S3 path, an AWS
3171
- # Identity and Access Management (IAM) role that allows Amazon
3172
- # Forecast to access the location, and an AWS Key Management Service
3173
- # (KMS) key (optional).
3231
+ # The destination for an export job. Provide an S3 path, an Identity
3232
+ # and Access Management (IAM) role that allows Amazon Forecast to
3233
+ # access the location, and an Key Management Service (KMS) key
3234
+ # (optional).
3174
3235
  # @return [Types::DataDestination]
3175
3236
  #
3176
3237
  # @!attribute [rw] message
@@ -3275,8 +3336,8 @@ module Aws::ForecastService
3275
3336
  #
3276
3337
  # @!attribute [rw] auto_ml_override_strategy
3277
3338
  # <note markdown="1"> The `LatencyOptimized` AutoML override strategy is only available in
3278
- # private beta. Contact AWS Support or your account manager to learn
3279
- # more about access privileges.
3339
+ # private beta. Contact Amazon Web Services Support or your account
3340
+ # manager to learn more about access privileges.
3280
3341
  #
3281
3342
  # </note>
3282
3343
  #
@@ -3321,9 +3382,9 @@ module Aws::ForecastService
3321
3382
  # @return [Types::FeaturizationConfig]
3322
3383
  #
3323
3384
  # @!attribute [rw] encryption_config
3324
- # An AWS Key Management Service (KMS) key and the AWS Identity and
3325
- # Access Management (IAM) role that Amazon Forecast can assume to
3326
- # access the key.
3385
+ # An Key Management Service (KMS) key and the Identity and Access
3386
+ # Management (IAM) role that Amazon Forecast can assume to access the
3387
+ # key.
3327
3388
  # @return [Types::EncryptionConfig]
3328
3389
  #
3329
3390
  # @!attribute [rw] predictor_execution_details
@@ -3547,10 +3608,10 @@ module Aws::ForecastService
3547
3608
  # @return [Array<String>]
3548
3609
  #
3549
3610
  # @!attribute [rw] destination
3550
- # The destination for an export job. Provide an S3 path, an AWS
3551
- # Identity and Access Management (IAM) role that allows Amazon
3552
- # Forecast to access the location, and an AWS Key Management Service
3553
- # (KMS) key (optional).
3611
+ # The destination for an export job. Provide an S3 path, an Identity
3612
+ # and Access Management (IAM) role that allows Amazon Forecast to
3613
+ # access the location, and an Key Management Service (KMS) key
3614
+ # (optional).
3554
3615
  # @return [Types::DataDestination]
3555
3616
  #
3556
3617
  # @!attribute [rw] message
@@ -3702,7 +3763,7 @@ module Aws::ForecastService
3702
3763
  #
3703
3764
  # @!attribute [rw] forecast_types
3704
3765
  # The quantiles at which probabilistic forecasts are generated. You
3705
- # can specify up to 5 quantiles per what-if forecast in the
3766
+ # can specify up to five quantiles per what-if forecast in the
3706
3767
  # CreateWhatIfForecast operation. If you didn't specify quantiles,
3707
3768
  # the default values are `["0.1", "0.5", "0.9"]`.
3708
3769
  # @return [Array<String>]
@@ -3725,18 +3786,18 @@ module Aws::ForecastService
3725
3786
  include Aws::Structure
3726
3787
  end
3727
3788
 
3728
- # An AWS Key Management Service (KMS) key and an AWS Identity and Access
3789
+ # An Key Management Service (KMS) key and an Identity and Access
3729
3790
  # Management (IAM) role that Amazon Forecast can assume to access the
3730
3791
  # key. You can specify this optional object in the CreateDataset and
3731
3792
  # CreatePredictor requests.
3732
3793
  #
3733
3794
  # @!attribute [rw] role_arn
3734
3795
  # The ARN of the IAM role that Amazon Forecast can assume to access
3735
- # the AWS KMS key.
3796
+ # the KMS key.
3736
3797
  #
3737
- # Passing a role across AWS accounts is not allowed. If you pass a
3738
- # role that isn't in your account, you get an `InvalidInputException`
3739
- # error.
3798
+ # Passing a role across Amazon Web Services accounts is not allowed.
3799
+ # If you pass a role that isn't in your account, you get an
3800
+ # `InvalidInputException` error.
3740
3801
  # @return [String]
3741
3802
  #
3742
3803
  # @!attribute [rw] kms_key_arn
@@ -3894,10 +3955,10 @@ module Aws::ForecastService
3894
3955
  # @return [String]
3895
3956
  #
3896
3957
  # @!attribute [rw] destination
3897
- # The destination for an export job. Provide an S3 path, an AWS
3898
- # Identity and Access Management (IAM) role that allows Amazon
3899
- # Forecast to access the location, and an AWS Key Management Service
3900
- # (KMS) key (optional).
3958
+ # The destination for an export job. Provide an S3 path, an Identity
3959
+ # and Access Management (IAM) role that allows Amazon Forecast to
3960
+ # access the location, and an Key Management Service (KMS) key
3961
+ # (optional).
3901
3962
  # @return [Types::DataDestination]
3902
3963
  #
3903
3964
  # @!attribute [rw] status
@@ -4123,16 +4184,34 @@ module Aws::ForecastService
4123
4184
  # @!attribute [rw] forecast_frequency
4124
4185
  # The frequency of predictions in a forecast.
4125
4186
  #
4126
- # Valid intervals are Y (Year), M (Month), W (Week), D (Day), H
4127
- # (Hour), 30min (30 minutes), 15min (15 minutes), 10min (10 minutes),
4128
- # 5min (5 minutes), and 1min (1 minute). For example, "Y" indicates
4129
- # every year and "5min" indicates every five minutes.
4187
+ # Valid intervals are an integer followed by Y (Year), M (Month), W
4188
+ # (Week), D (Day), H (Hour), and min (Minute). For example, "1D"
4189
+ # indicates every day and "15min" indicates every 15 minutes. You
4190
+ # cannot specify a value that would overlap with the next larger
4191
+ # frequency. That means, for example, you cannot specify a frequency
4192
+ # of 60 minutes, because that is equivalent to 1 hour. The valid
4193
+ # values for each frequency are the following:
4194
+ #
4195
+ # * Minute - 1-59
4196
+ #
4197
+ # * Hour - 1-23
4198
+ #
4199
+ # * Day - 1-6
4200
+ #
4201
+ # * Week - 1-4
4202
+ #
4203
+ # * Month - 1-11
4204
+ #
4205
+ # * Year - 1
4206
+ #
4207
+ # Thus, if you want every other week forecasts, specify "2W". Or, if
4208
+ # you want quarterly forecasts, you specify "3M".
4130
4209
  #
4131
4210
  # The frequency must be greater than or equal to the
4132
4211
  # TARGET\_TIME\_SERIES dataset frequency.
4133
4212
  #
4134
4213
  # When a RELATED\_TIME\_SERIES dataset is provided, the frequency must
4135
- # be equal to the RELATED\_TIME\_SERIES dataset frequency.
4214
+ # be equal to the TARGET\_TIME\_SERIES dataset frequency.
4136
4215
  # @return [String]
4137
4216
  #
4138
4217
  # @!attribute [rw] forecast_dimensions
@@ -4196,25 +4275,25 @@ module Aws::ForecastService
4196
4275
  # the "filling" featurization method for a **Target Time Series**
4197
4276
  # dataset. Bold signifies the default value.
4198
4277
  #
4199
- # * `aggregation`\: **sum**, `avg`, `first`, `min`, `max`
4278
+ # * `aggregation`: **sum**, `avg`, `first`, `min`, `max`
4200
4279
  #
4201
- # * `frontfill`\: **none**
4280
+ # * `frontfill`: **none**
4202
4281
  #
4203
- # * `middlefill`\: **zero**, `nan` (not a number), `value`, `median`,
4282
+ # * `middlefill`: **zero**, `nan` (not a number), `value`, `median`,
4204
4283
  # `mean`, `min`, `max`
4205
4284
  #
4206
- # * `backfill`\: **zero**, `nan`, `value`, `median`, `mean`, `min`,
4285
+ # * `backfill`: **zero**, `nan`, `value`, `median`, `mean`, `min`,
4207
4286
  # `max`
4208
4287
  #
4209
4288
  # The following list shows the parameters and their valid values for a
4210
4289
  # **Related Time Series** featurization method (there are no
4211
4290
  # defaults):
4212
4291
  #
4213
- # * `middlefill`\: `zero`, `value`, `median`, `mean`, `min`, `max`
4292
+ # * `middlefill`: `zero`, `value`, `median`, `mean`, `min`, `max`
4214
4293
  #
4215
- # * `backfill`\: `zero`, `value`, `median`, `mean`, `min`, `max`
4294
+ # * `backfill`: `zero`, `value`, `median`, `mean`, `min`, `max`
4216
4295
  #
4217
- # * `futurefill`\: `zero`, `value`, `median`, `mean`, `min`, `max`
4296
+ # * `futurefill`: `zero`, `value`, `median`, `mean`, `min`, `max`
4218
4297
  #
4219
4298
  # To set a filling method to a specific value, set the fill parameter
4220
4299
  # to `value` and define the value in a corresponding `_value`
@@ -4437,8 +4516,8 @@ module Aws::ForecastService
4437
4516
  #
4438
4517
  # @!attribute [rw] auto_ml_override_strategy
4439
4518
  # <note markdown="1"> The `LatencyOptimized` AutoML override strategy is only available in
4440
- # private beta. Contact AWS Support or your account manager to learn
4441
- # more about access privileges.
4519
+ # private beta. Contact Amazon Web Services Support or your account
4520
+ # manager to learn more about access privileges.
4442
4521
  #
4443
4522
  # </note>
4444
4523
  #
@@ -5729,10 +5808,10 @@ module Aws::ForecastService
5729
5808
  # @return [String]
5730
5809
  #
5731
5810
  # @!attribute [rw] destination
5732
- # The destination for an export job. Provide an S3 path, an AWS
5733
- # Identity and Access Management (IAM) role that allows Amazon
5734
- # Forecast to access the location, and an AWS Key Management Service
5735
- # (KMS) key (optional).
5811
+ # The destination for an export job. Provide an S3 path, an Identity
5812
+ # and Access Management (IAM) role that allows Amazon Forecast to
5813
+ # access the location, and an Key Management Service (KMS) key
5814
+ # (optional).
5736
5815
  # @return [Types::DataDestination]
5737
5816
  #
5738
5817
  # @!attribute [rw] status
@@ -6100,9 +6179,9 @@ module Aws::ForecastService
6100
6179
  end
6101
6180
 
6102
6181
  # The path to the file(s) in an Amazon Simple Storage Service (Amazon
6103
- # S3) bucket, and an AWS Identity and Access Management (IAM) role that
6182
+ # S3) bucket, and an Identity and Access Management (IAM) role that
6104
6183
  # Amazon Forecast can assume to access the file(s). Optionally, includes
6105
- # an AWS Key Management Service (KMS) key. This object is part of the
6184
+ # an Key Management Service (KMS) key. This object is part of the
6106
6185
  # DataSource object that is submitted in the CreateDatasetImportJob
6107
6186
  # request, and part of the DataDestination object.
6108
6187
  #
@@ -6112,19 +6191,19 @@ module Aws::ForecastService
6112
6191
  # @return [String]
6113
6192
  #
6114
6193
  # @!attribute [rw] role_arn
6115
- # The ARN of the AWS Identity and Access Management (IAM) role that
6116
- # Amazon Forecast can assume to access the Amazon S3 bucket or files.
6117
- # If you provide a value for the `KMSKeyArn` key, the role must allow
6118
- # access to the key.
6194
+ # The ARN of the Identity and Access Management (IAM) role that Amazon
6195
+ # Forecast can assume to access the Amazon S3 bucket or files. If you
6196
+ # provide a value for the `KMSKeyArn` key, the role must allow access
6197
+ # to the key.
6119
6198
  #
6120
- # Passing a role across AWS accounts is not allowed. If you pass a
6121
- # role that isn't in your account, you get an `InvalidInputException`
6122
- # error.
6199
+ # Passing a role across Amazon Web Services accounts is not allowed.
6200
+ # If you pass a role that isn't in your account, you get an
6201
+ # `InvalidInputException` error.
6123
6202
  # @return [String]
6124
6203
  #
6125
6204
  # @!attribute [rw] kms_key_arn
6126
- # The Amazon Resource Name (ARN) of an AWS Key Management Service
6127
- # (KMS) key.
6205
+ # The Amazon Resource Name (ARN) of an Key Management Service (KMS)
6206
+ # key.
6128
6207
  # @return [String]
6129
6208
  #
6130
6209
  # @see http://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/S3Config AWS API Documentation
@@ -6492,12 +6571,12 @@ module Aws::ForecastService
6492
6571
  # * Tag keys and values are case sensitive.
6493
6572
  #
6494
6573
  # * Do not use `aws:`, `AWS:`, or any upper or lowercase combination of
6495
- # such as a prefix for keys as it is reserved for AWS use. You cannot
6496
- # edit or delete tag keys with this prefix. Values can have this
6497
- # prefix. If a tag value has `aws` as its prefix but the key does not,
6498
- # then Forecast considers it to be a user tag and will count against
6499
- # the limit of 50 tags. Tags with only the key prefix of `aws` do not
6500
- # count against your tags per resource limit.
6574
+ # such as a prefix for keys as it is reserved for Amazon Web Services
6575
+ # use. You cannot edit or delete tag keys with this prefix. Values can
6576
+ # have this prefix. If a tag value has `aws` as its prefix but the key
6577
+ # does not, then Forecast considers it to be a user tag and will count
6578
+ # against the limit of 50 tags. Tags with only the key prefix of `aws`
6579
+ # do not count against your tags per resource limit.
6501
6580
  #
6502
6581
  # @!attribute [rw] key
6503
6582
  # One part of a key-value pair that makes up a tag. A `key` is a
@@ -6548,12 +6627,13 @@ module Aws::ForecastService
6548
6627
  # * Tag keys and values are case sensitive.
6549
6628
  #
6550
6629
  # * Do not use `aws:`, `AWS:`, or any upper or lowercase combination
6551
- # of such as a prefix for keys as it is reserved for AWS use. You
6552
- # cannot edit or delete tag keys with this prefix. Values can have
6553
- # this prefix. If a tag value has `aws` as its prefix but the key
6554
- # does not, then Forecast considers it to be a user tag and will
6555
- # count against the limit of 50 tags. Tags with only the key prefix
6556
- # of `aws` do not count against your tags per resource limit.
6630
+ # of such as a prefix for keys as it is reserved for Amazon Web
6631
+ # Services use. You cannot edit or delete tag keys with this prefix.
6632
+ # Values can have this prefix. If a tag value has `aws` as its
6633
+ # prefix but the key does not, then Forecast considers it to be a
6634
+ # user tag and will count against the limit of 50 tags. Tags with
6635
+ # only the key prefix of `aws` do not count against your tags per
6636
+ # resource limit.
6557
6637
  # @return [Array<Types::Tag>]
6558
6638
  #
6559
6639
  # @see http://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/TagResourceRequest AWS API Documentation
@@ -6685,9 +6765,9 @@ module Aws::ForecastService
6685
6765
  # you want to create forecasts.
6686
6766
  #
6687
6767
  # @!attribute [rw] data_source
6688
- # The source of your data, an AWS Identity and Access Management (IAM)
6768
+ # The source of your data, an Identity and Access Management (IAM)
6689
6769
  # role that allows Amazon Forecast to access the data and, optionally,
6690
- # an AWS Key Management Service (KMS) key.
6770
+ # an Key Management Service (KMS) key.
6691
6771
  # @return [Types::DataSource]
6692
6772
  #
6693
6773
  # @!attribute [rw] schema
@@ -6718,10 +6798,10 @@ module Aws::ForecastService
6718
6798
  #
6719
6799
  # @!attribute [rw] s3_config
6720
6800
  # The path to the file(s) in an Amazon Simple Storage Service (Amazon
6721
- # S3) bucket, and an AWS Identity and Access Management (IAM) role
6722
- # that Amazon Forecast can assume to access the file(s). Optionally,
6723
- # includes an AWS Key Management Service (KMS) key. This object is
6724
- # part of the DataSource object that is submitted in the
6801
+ # S3) bucket, and an Identity and Access Management (IAM) role that
6802
+ # Amazon Forecast can assume to access the file(s). Optionally,
6803
+ # includes an Key Management Service (KMS) key. This object is part of
6804
+ # the DataSource object that is submitted in the
6725
6805
  # CreateDatasetImportJob request, and part of the DataDestination
6726
6806
  # object.
6727
6807
  # @return [Types::S3Config]