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.
- checksums.yaml +4 -4
- data/CHANGELOG.md +10 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-forecastservice/client.rb +167 -116
- data/lib/aws-sdk-forecastservice/client_api.rb +4 -0
- data/lib/aws-sdk-forecastservice/endpoint_parameters.rb +3 -0
- data/lib/aws-sdk-forecastservice/endpoint_provider.rb +1 -1
- data/lib/aws-sdk-forecastservice/types.rb +268 -188
- data/lib/aws-sdk-forecastservice.rb +1 -1
- metadata +4 -4
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 44e51fbc796d5f80a757eacee5f026a30106e1066b9182fef4fd3b3e404ced17
|
4
|
+
data.tar.gz: a6b4a8de6f455d9362c6d9fd79c5a8ecb2a94eaf736706a825001c3baab3aad6
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: e90e2685bc2bf702e9a6395bf908024d85a29c38031f968616aad10d8a660a56bc3cdd69bf00647524b97594c3ecbae8a5b39fade9b3a162ea8fa9c57ee8f166
|
7
|
+
data.tar.gz: aba4759f14ddeac0061475bb9cf4cdb76b5ae6894cdbaaa9d43104bd92e2018163fe5e02289785118d73a5616bb246d4473b1641e3a733ac3cbccf07fe740041
|
data/CHANGELOG.md
CHANGED
@@ -1,6 +1,16 @@
|
|
1
1
|
Unreleased Changes
|
2
2
|
------------------
|
3
3
|
|
4
|
+
1.41.0 (2023-05-31)
|
5
|
+
------------------
|
6
|
+
|
7
|
+
* Feature - Code Generated Changes, see `./build_tools` or `aws-sdk-core`'s CHANGELOG.md for details.
|
8
|
+
|
9
|
+
1.40.0 (2023-02-01)
|
10
|
+
------------------
|
11
|
+
|
12
|
+
* Feature - This release will enable customer select INCREMENTAL as ImportModel in Forecast's CreateDatasetImportJob API. Verified latest SDK containing required attribute, following https://w.amazon.com/bin/view/AWS-Seer/Launch/Trebuchet/
|
13
|
+
|
4
14
|
1.39.0 (2023-01-18)
|
5
15
|
------------------
|
6
16
|
|
data/VERSION
CHANGED
@@ -1 +1 @@
|
|
1
|
-
1.
|
1
|
+
1.41.0
|
@@ -275,6 +275,11 @@ module Aws::ForecastService
|
|
275
275
|
# in the future.
|
276
276
|
#
|
277
277
|
#
|
278
|
+
# @option options [String] :sdk_ua_app_id
|
279
|
+
# A unique and opaque application ID that is appended to the
|
280
|
+
# User-Agent header as app/<sdk_ua_app_id>. It should have a
|
281
|
+
# maximum length of 50.
|
282
|
+
#
|
278
283
|
# @option options [String] :secret_access_key
|
279
284
|
#
|
280
285
|
# @option options [String] :session_token
|
@@ -452,10 +457,28 @@ module Aws::ForecastService
|
|
452
457
|
# @option params [String] :forecast_frequency
|
453
458
|
# The frequency of predictions in a forecast.
|
454
459
|
#
|
455
|
-
# Valid intervals are Y (Year), M (Month), W
|
456
|
-
#
|
457
|
-
#
|
458
|
-
#
|
460
|
+
# Valid intervals are an integer followed by Y (Year), M (Month), W
|
461
|
+
# (Week), D (Day), H (Hour), and min (Minute). For example, "1D"
|
462
|
+
# indicates every day and "15min" indicates every 15 minutes. You
|
463
|
+
# cannot specify a value that would overlap with the next larger
|
464
|
+
# frequency. That means, for example, you cannot specify a frequency of
|
465
|
+
# 60 minutes, because that is equivalent to 1 hour. The valid values for
|
466
|
+
# each frequency are the following:
|
467
|
+
#
|
468
|
+
# * Minute - 1-59
|
469
|
+
#
|
470
|
+
# * Hour - 1-23
|
471
|
+
#
|
472
|
+
# * Day - 1-6
|
473
|
+
#
|
474
|
+
# * Week - 1-4
|
475
|
+
#
|
476
|
+
# * Month - 1-11
|
477
|
+
#
|
478
|
+
# * Year - 1
|
479
|
+
#
|
480
|
+
# Thus, if you want every other week forecasts, specify "2W". Or, if
|
481
|
+
# you want quarterly forecasts, you specify "3M".
|
459
482
|
#
|
460
483
|
# The frequency must be greater than or equal to the
|
461
484
|
# TARGET\_TIME\_SERIES dataset frequency.
|
@@ -468,7 +491,7 @@ module Aws::ForecastService
|
|
468
491
|
# datasets.
|
469
492
|
#
|
470
493
|
# @option params [Types::EncryptionConfig] :encryption_config
|
471
|
-
# An
|
494
|
+
# An Key Management Service (KMS) key and an Identity and Access
|
472
495
|
# Management (IAM) role that Amazon Forecast can assume to access the
|
473
496
|
# key. You can specify this optional object in the CreateDataset and
|
474
497
|
# CreatePredictor requests.
|
@@ -676,10 +699,28 @@ module Aws::ForecastService
|
|
676
699
|
# The frequency of data collection. This parameter is required for
|
677
700
|
# RELATED\_TIME\_SERIES datasets.
|
678
701
|
#
|
679
|
-
# Valid intervals are Y (Year), M (Month), W
|
680
|
-
#
|
681
|
-
#
|
682
|
-
#
|
702
|
+
# Valid intervals are an integer followed by Y (Year), M (Month), W
|
703
|
+
# (Week), D (Day), H (Hour), and min (Minute). For example, "1D"
|
704
|
+
# indicates every day and "15min" indicates every 15 minutes. You
|
705
|
+
# cannot specify a value that would overlap with the next larger
|
706
|
+
# frequency. That means, for example, you cannot specify a frequency of
|
707
|
+
# 60 minutes, because that is equivalent to 1 hour. The valid values for
|
708
|
+
# each frequency are the following:
|
709
|
+
#
|
710
|
+
# * Minute - 1-59
|
711
|
+
#
|
712
|
+
# * Hour - 1-23
|
713
|
+
#
|
714
|
+
# * Day - 1-6
|
715
|
+
#
|
716
|
+
# * Week - 1-4
|
717
|
+
#
|
718
|
+
# * Month - 1-11
|
719
|
+
#
|
720
|
+
# * Year - 1
|
721
|
+
#
|
722
|
+
# Thus, if you want every other week forecasts, specify "2W". Or, if
|
723
|
+
# you want quarterly forecasts, you specify "3M".
|
683
724
|
#
|
684
725
|
# @option params [required, Types::Schema] :schema
|
685
726
|
# The schema for the dataset. The schema attributes and their order must
|
@@ -693,9 +734,9 @@ module Aws::ForecastService
|
|
693
734
|
# [1]: https://docs.aws.amazon.com/forecast/latest/dg/howitworks-domains-ds-types.html
|
694
735
|
#
|
695
736
|
# @option params [Types::EncryptionConfig] :encryption_config
|
696
|
-
# An
|
697
|
-
#
|
698
|
-
#
|
737
|
+
# An Key Management Service (KMS) key and the Identity and Access
|
738
|
+
# Management (IAM) role that Amazon Forecast can assume to access the
|
739
|
+
# key.
|
699
740
|
#
|
700
741
|
# @option params [Array<Types::Tag>] :tags
|
701
742
|
# The optional metadata that you apply to the dataset to help you
|
@@ -722,12 +763,12 @@ module Aws::ForecastService
|
|
722
763
|
# * Tag keys and values are case sensitive.
|
723
764
|
#
|
724
765
|
# * Do not use `aws:`, `AWS:`, or any upper or lowercase combination of
|
725
|
-
# such as a prefix for keys as it is reserved for
|
726
|
-
# edit or delete tag keys with this prefix. Values can
|
727
|
-
# prefix. If a tag value has `aws` as its prefix but the key
|
728
|
-
# then Forecast considers it to be a user tag and will count
|
729
|
-
# the limit of 50 tags. Tags with only the key prefix of `aws`
|
730
|
-
# count against your tags per resource limit.
|
766
|
+
# such as a prefix for keys as it is reserved for Amazon Web Services
|
767
|
+
# use. You cannot edit or delete tag keys with this prefix. Values can
|
768
|
+
# have this prefix. If a tag value has `aws` as its prefix but the key
|
769
|
+
# does not, then Forecast considers it to be a user tag and will count
|
770
|
+
# against the limit of 50 tags. Tags with only the key prefix of `aws`
|
771
|
+
# do not count against your tags per resource limit.
|
731
772
|
#
|
732
773
|
# @return [Types::CreateDatasetResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
733
774
|
#
|
@@ -846,12 +887,12 @@ module Aws::ForecastService
|
|
846
887
|
# * Tag keys and values are case sensitive.
|
847
888
|
#
|
848
889
|
# * Do not use `aws:`, `AWS:`, or any upper or lowercase combination of
|
849
|
-
# such as a prefix for keys as it is reserved for
|
850
|
-
# edit or delete tag keys with this prefix. Values can
|
851
|
-
# prefix. If a tag value has `aws` as its prefix but the key
|
852
|
-
# then Forecast considers it to be a user tag and will count
|
853
|
-
# the limit of 50 tags. Tags with only the key prefix of `aws`
|
854
|
-
# count against your tags per resource limit.
|
890
|
+
# such as a prefix for keys as it is reserved for Amazon Web Services
|
891
|
+
# use. You cannot edit or delete tag keys with this prefix. Values can
|
892
|
+
# have this prefix. If a tag value has `aws` as its prefix but the key
|
893
|
+
# does not, then Forecast considers it to be a user tag and will count
|
894
|
+
# against the limit of 50 tags. Tags with only the key prefix of `aws`
|
895
|
+
# do not count against your tags per resource limit.
|
855
896
|
#
|
856
897
|
# @return [Types::CreateDatasetGroupResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
857
898
|
#
|
@@ -889,11 +930,11 @@ module Aws::ForecastService
|
|
889
930
|
# (Amazon S3) bucket and the Amazon Resource Name (ARN) of the dataset
|
890
931
|
# that you want to import the data to.
|
891
932
|
#
|
892
|
-
# You must specify a [DataSource][1] object that includes an
|
893
|
-
#
|
894
|
-
#
|
895
|
-
#
|
896
|
-
# see [Set up permissions][2].
|
933
|
+
# You must specify a [DataSource][1] object that includes an Identity
|
934
|
+
# and Access Management (IAM) role that Amazon Forecast can assume to
|
935
|
+
# access the data, as Amazon Forecast makes a copy of your data and
|
936
|
+
# processes it in an internal Amazon Web Services system. For more
|
937
|
+
# information, see [Set up permissions][2].
|
897
938
|
#
|
898
939
|
# The training data must be in CSV or Parquet format. The delimiter must
|
899
940
|
# be a comma (,).
|
@@ -928,11 +969,11 @@ module Aws::ForecastService
|
|
928
969
|
# want to import data to.
|
929
970
|
#
|
930
971
|
# @option params [required, Types::DataSource] :data_source
|
931
|
-
# The location of the training data to import and an
|
932
|
-
#
|
933
|
-
#
|
972
|
+
# The location of the training data to import and an Identity and Access
|
973
|
+
# Management (IAM) role that Amazon Forecast can assume to access the
|
974
|
+
# data. The training data must be stored in an Amazon S3 bucket.
|
934
975
|
#
|
935
|
-
# If encryption is used, `DataSource` must include an
|
976
|
+
# If encryption is used, `DataSource` must include an Key Management
|
936
977
|
# Service (KMS) key and the IAM role must allow Amazon Forecast
|
937
978
|
# permission to access the key. The KMS key and IAM role must match
|
938
979
|
# those specified in the `EncryptionConfig` parameter of the
|
@@ -1012,17 +1053,23 @@ module Aws::ForecastService
|
|
1012
1053
|
# * Tag keys and values are case sensitive.
|
1013
1054
|
#
|
1014
1055
|
# * Do not use `aws:`, `AWS:`, or any upper or lowercase combination of
|
1015
|
-
# such as a prefix for keys as it is reserved for
|
1016
|
-
# edit or delete tag keys with this prefix. Values can
|
1017
|
-
# prefix. If a tag value has `aws` as its prefix but the key
|
1018
|
-
# then Forecast considers it to be a user tag and will count
|
1019
|
-
# the limit of 50 tags. Tags with only the key prefix of `aws`
|
1020
|
-
# count against your tags per resource limit.
|
1056
|
+
# such as a prefix for keys as it is reserved for Amazon Web Services
|
1057
|
+
# use. You cannot edit or delete tag keys with this prefix. Values can
|
1058
|
+
# have this prefix. If a tag value has `aws` as its prefix but the key
|
1059
|
+
# does not, then Forecast considers it to be a user tag and will count
|
1060
|
+
# against the limit of 50 tags. Tags with only the key prefix of `aws`
|
1061
|
+
# do not count against your tags per resource limit.
|
1021
1062
|
#
|
1022
1063
|
# @option params [String] :format
|
1023
1064
|
# The format of the imported data, CSV or PARQUET. The default value is
|
1024
1065
|
# CSV.
|
1025
1066
|
#
|
1067
|
+
# @option params [String] :import_mode
|
1068
|
+
# Specifies whether the dataset import job is a `FULL` or `INCREMENTAL`
|
1069
|
+
# import. A `FULL` dataset import replaces all of the existing data with
|
1070
|
+
# the newly imported data. An `INCREMENTAL` import appends the imported
|
1071
|
+
# data to the existing data.
|
1072
|
+
#
|
1026
1073
|
# @return [Types::CreateDatasetImportJobResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1027
1074
|
#
|
1028
1075
|
# * {Types::CreateDatasetImportJobResponse#dataset_import_job_arn #dataset_import_job_arn} => String
|
@@ -1050,6 +1097,7 @@ module Aws::ForecastService
|
|
1050
1097
|
# },
|
1051
1098
|
# ],
|
1052
1099
|
# format: "Format",
|
1100
|
+
# import_mode: "FULL", # accepts FULL, INCREMENTAL
|
1053
1101
|
# })
|
1054
1102
|
#
|
1055
1103
|
# @example Response structure
|
@@ -1160,16 +1208,16 @@ module Aws::ForecastService
|
|
1160
1208
|
# and time points for the Explainability.
|
1161
1209
|
#
|
1162
1210
|
# @option params [Types::DataSource] :data_source
|
1163
|
-
# The source of your data, an
|
1164
|
-
#
|
1165
|
-
#
|
1211
|
+
# The source of your data, an Identity and Access Management (IAM) role
|
1212
|
+
# that allows Amazon Forecast to access the data and, optionally, an Key
|
1213
|
+
# Management Service (KMS) key.
|
1166
1214
|
#
|
1167
1215
|
# @option params [Types::Schema] :schema
|
1168
1216
|
# Defines the fields of a dataset.
|
1169
1217
|
#
|
1170
1218
|
# @option params [Boolean] :enable_visualization
|
1171
|
-
# Create an Explainability visualization that is viewable within the
|
1172
|
-
# console.
|
1219
|
+
# Create an Explainability visualization that is viewable within the
|
1220
|
+
# Amazon Web Services console.
|
1173
1221
|
#
|
1174
1222
|
# @option params [String] :start_date_time
|
1175
1223
|
# If `TimePointGranularity` is set to `SPECIFIC`, define the first point
|
@@ -1270,8 +1318,8 @@ module Aws::ForecastService
|
|
1270
1318
|
# Service (Amazon S3) bucket.
|
1271
1319
|
#
|
1272
1320
|
# You must specify a DataDestination object that includes an Amazon S3
|
1273
|
-
# bucket and an
|
1274
|
-
#
|
1321
|
+
# bucket and an Identity and Access Management (IAM) role that Amazon
|
1322
|
+
# Forecast can assume to access the Amazon S3 bucket. For more
|
1275
1323
|
# information, see aws-forecast-iam-roles.
|
1276
1324
|
#
|
1277
1325
|
# <note markdown="1"> The `Status` of the export job must be `ACTIVE` before you can access
|
@@ -1287,9 +1335,9 @@ module Aws::ForecastService
|
|
1287
1335
|
# The Amazon Resource Name (ARN) of the Explainability to export.
|
1288
1336
|
#
|
1289
1337
|
# @option params [required, Types::DataDestination] :destination
|
1290
|
-
# The destination for an export job. Provide an S3 path, an
|
1291
|
-
#
|
1292
|
-
#
|
1338
|
+
# The destination for an export job. Provide an S3 path, an Identity and
|
1339
|
+
# Access Management (IAM) role that allows Amazon Forecast to access the
|
1340
|
+
# location, and an Key Management Service (KMS) key (optional).
|
1293
1341
|
#
|
1294
1342
|
# @option params [Array<Types::Tag>] :tags
|
1295
1343
|
# Optional metadata to help you categorize and organize your resources.
|
@@ -1439,12 +1487,12 @@ module Aws::ForecastService
|
|
1439
1487
|
# * Tag keys and values are case sensitive.
|
1440
1488
|
#
|
1441
1489
|
# * Do not use `aws:`, `AWS:`, or any upper or lowercase combination of
|
1442
|
-
# such as a prefix for keys as it is reserved for
|
1443
|
-
# edit or delete tag keys with this prefix. Values can
|
1444
|
-
# prefix. If a tag value has `aws` as its prefix but the key
|
1445
|
-
# then Forecast considers it to be a user tag and will count
|
1446
|
-
# the limit of 50 tags. Tags with only the key prefix of `aws`
|
1447
|
-
# count against your tags per resource limit.
|
1490
|
+
# such as a prefix for keys as it is reserved for Amazon Web Services
|
1491
|
+
# use. You cannot edit or delete tag keys with this prefix. Values can
|
1492
|
+
# have this prefix. If a tag value has `aws` as its prefix but the key
|
1493
|
+
# does not, then Forecast considers it to be a user tag and will count
|
1494
|
+
# against the limit of 50 tags. Tags with only the key prefix of `aws`
|
1495
|
+
# do not count against your tags per resource limit.
|
1448
1496
|
#
|
1449
1497
|
# @option params [Types::TimeSeriesSelector] :time_series_selector
|
1450
1498
|
# Defines the set of time series that are used to create the forecasts
|
@@ -1518,9 +1566,9 @@ module Aws::ForecastService
|
|
1518
1566
|
# where the <ExportTimestamp> component is in Java
|
1519
1567
|
# SimpleDateFormat (yyyy-MM-ddTHH-mm-ssZ).
|
1520
1568
|
#
|
1521
|
-
# You must specify a DataDestination object that includes an
|
1522
|
-
#
|
1523
|
-
#
|
1569
|
+
# You must specify a DataDestination object that includes an Identity
|
1570
|
+
# and Access Management (IAM) role that Amazon Forecast can assume to
|
1571
|
+
# access the Amazon S3 bucket. For more information, see
|
1524
1572
|
# aws-forecast-iam-roles.
|
1525
1573
|
#
|
1526
1574
|
# For more information, see howitworks-forecast.
|
@@ -1542,14 +1590,13 @@ module Aws::ForecastService
|
|
1542
1590
|
# export.
|
1543
1591
|
#
|
1544
1592
|
# @option params [required, Types::DataDestination] :destination
|
1545
|
-
# The location where you want to save the forecast and an
|
1546
|
-
#
|
1547
|
-
#
|
1548
|
-
# bucket.
|
1593
|
+
# The location where you want to save the forecast and an Identity and
|
1594
|
+
# Access Management (IAM) role that Amazon Forecast can assume to access
|
1595
|
+
# the location. The forecast must be exported to an Amazon S3 bucket.
|
1549
1596
|
#
|
1550
|
-
# If encryption is used, `Destination` must include an
|
1551
|
-
#
|
1552
|
-
#
|
1597
|
+
# If encryption is used, `Destination` must include an Key Management
|
1598
|
+
# Service (KMS) key. The IAM role must allow Amazon Forecast permission
|
1599
|
+
# to access the key.
|
1553
1600
|
#
|
1554
1601
|
# @option params [Array<Types::Tag>] :tags
|
1555
1602
|
# The optional metadata that you apply to the forecast export job to
|
@@ -1576,12 +1623,12 @@ module Aws::ForecastService
|
|
1576
1623
|
# * Tag keys and values are case sensitive.
|
1577
1624
|
#
|
1578
1625
|
# * Do not use `aws:`, `AWS:`, or any upper or lowercase combination of
|
1579
|
-
# such as a prefix for keys as it is reserved for
|
1580
|
-
# edit or delete tag keys with this prefix. Values can
|
1581
|
-
# prefix. If a tag value has `aws` as its prefix but the key
|
1582
|
-
# then Forecast considers it to be a user tag and will count
|
1583
|
-
# the limit of 50 tags. Tags with only the key prefix of `aws`
|
1584
|
-
# count against your tags per resource limit.
|
1626
|
+
# such as a prefix for keys as it is reserved for Amazon Web Services
|
1627
|
+
# use. You cannot edit or delete tag keys with this prefix. Values can
|
1628
|
+
# have this prefix. If a tag value has `aws` as its prefix but the key
|
1629
|
+
# does not, then Forecast considers it to be a user tag and will count
|
1630
|
+
# against the limit of 50 tags. Tags with only the key prefix of `aws`
|
1631
|
+
# do not count against your tags per resource limit.
|
1585
1632
|
#
|
1586
1633
|
# @option params [String] :format
|
1587
1634
|
# The format of the exported data, CSV or PARQUET. The default value is
|
@@ -1794,8 +1841,8 @@ module Aws::ForecastService
|
|
1794
1841
|
#
|
1795
1842
|
# @option params [String] :auto_ml_override_strategy
|
1796
1843
|
# <note markdown="1"> The `LatencyOptimized` AutoML override strategy is only available in
|
1797
|
-
# private beta. Contact
|
1798
|
-
# more about access privileges.
|
1844
|
+
# private beta. Contact Amazon Web Services Support or your account
|
1845
|
+
# manager to learn more about access privileges.
|
1799
1846
|
#
|
1800
1847
|
# </note>
|
1801
1848
|
#
|
@@ -1856,9 +1903,9 @@ module Aws::ForecastService
|
|
1856
1903
|
# The featurization configuration.
|
1857
1904
|
#
|
1858
1905
|
# @option params [Types::EncryptionConfig] :encryption_config
|
1859
|
-
# An
|
1860
|
-
#
|
1861
|
-
#
|
1906
|
+
# An Key Management Service (KMS) key and the Identity and Access
|
1907
|
+
# Management (IAM) role that Amazon Forecast can assume to access the
|
1908
|
+
# key.
|
1862
1909
|
#
|
1863
1910
|
# @option params [Array<Types::Tag>] :tags
|
1864
1911
|
# The optional metadata that you apply to the predictor to help you
|
@@ -1885,12 +1932,12 @@ module Aws::ForecastService
|
|
1885
1932
|
# * Tag keys and values are case sensitive.
|
1886
1933
|
#
|
1887
1934
|
# * Do not use `aws:`, `AWS:`, or any upper or lowercase combination of
|
1888
|
-
# such as a prefix for keys as it is reserved for
|
1889
|
-
# edit or delete tag keys with this prefix. Values can
|
1890
|
-
# prefix. If a tag value has `aws` as its prefix but the key
|
1891
|
-
# then Forecast considers it to be a user tag and will count
|
1892
|
-
# the limit of 50 tags. Tags with only the key prefix of `aws`
|
1893
|
-
# count against your tags per resource limit.
|
1935
|
+
# such as a prefix for keys as it is reserved for Amazon Web Services
|
1936
|
+
# use. You cannot edit or delete tag keys with this prefix. Values can
|
1937
|
+
# have this prefix. If a tag value has `aws` as its prefix but the key
|
1938
|
+
# does not, then Forecast considers it to be a user tag and will count
|
1939
|
+
# against the limit of 50 tags. Tags with only the key prefix of `aws`
|
1940
|
+
# do not count against your tags per resource limit.
|
1894
1941
|
#
|
1895
1942
|
# @option params [String] :optimization_metric
|
1896
1943
|
# The accuracy metric used to optimize the predictor.
|
@@ -2007,8 +2054,8 @@ module Aws::ForecastService
|
|
2007
2054
|
# (yyyy-MM-ddTHH-mm-ssZ).
|
2008
2055
|
#
|
2009
2056
|
# You must specify a DataDestination object that includes an Amazon S3
|
2010
|
-
# bucket and an
|
2011
|
-
#
|
2057
|
+
# bucket and an Identity and Access Management (IAM) role that Amazon
|
2058
|
+
# Forecast can assume to access the Amazon S3 bucket. For more
|
2012
2059
|
# information, see aws-forecast-iam-roles.
|
2013
2060
|
#
|
2014
2061
|
# <note markdown="1"> The `Status` of the export job must be `ACTIVE` before you can access
|
@@ -2025,9 +2072,9 @@ module Aws::ForecastService
|
|
2025
2072
|
# export.
|
2026
2073
|
#
|
2027
2074
|
# @option params [required, Types::DataDestination] :destination
|
2028
|
-
# The destination for an export job. Provide an S3 path, an
|
2029
|
-
#
|
2030
|
-
#
|
2075
|
+
# The destination for an export job. Provide an S3 path, an Identity and
|
2076
|
+
# Access Management (IAM) role that allows Amazon Forecast to access the
|
2077
|
+
# location, and an Key Management Service (KMS) key (optional).
|
2031
2078
|
#
|
2032
2079
|
# @option params [Array<Types::Tag>] :tags
|
2033
2080
|
# Optional metadata to help you categorize and organize your backtests.
|
@@ -2109,12 +2156,13 @@ module Aws::ForecastService
|
|
2109
2156
|
# For example, imagine you are a clothing retailer who is considering an
|
2110
2157
|
# end of season sale to clear space for new styles. After creating a
|
2111
2158
|
# baseline forecast, you can use a what-if analysis to investigate how
|
2112
|
-
# different sales tactics might affect your goals.
|
2113
|
-
#
|
2114
|
-
#
|
2115
|
-
#
|
2116
|
-
#
|
2117
|
-
#
|
2159
|
+
# different sales tactics might affect your goals.
|
2160
|
+
#
|
2161
|
+
# You could create a scenario where everything is given a 25% markdown,
|
2162
|
+
# and another where everything is given a fixed dollar markdown. You
|
2163
|
+
# could create a scenario where the sale lasts for one week and another
|
2164
|
+
# where the sale lasts for one month. With a what-if analysis, you can
|
2165
|
+
# compare many different scenarios against each other.
|
2118
2166
|
#
|
2119
2167
|
# Note that a what-if analysis is meant to display what the forecasting
|
2120
2168
|
# model has learned and how it will behave in the scenarios that you are
|
@@ -2225,8 +2273,9 @@ module Aws::ForecastService
|
|
2225
2273
|
# want to change in the related time series dataset. A replacement time
|
2226
2274
|
# series does not need to contain all rows that are in the baseline
|
2227
2275
|
# related time series. Include only the rows (measure-dimension
|
2228
|
-
# combinations) that you want to include in the what-if forecast.
|
2229
|
-
#
|
2276
|
+
# combinations) that you want to include in the what-if forecast.
|
2277
|
+
#
|
2278
|
+
# This dataset is merged with the original time series to create a
|
2230
2279
|
# transformed dataset that is used for the what-if analysis.
|
2231
2280
|
#
|
2232
2281
|
# This dataset should contain the items to modify (such as item\_id or
|
@@ -2316,9 +2365,9 @@ module Aws::ForecastService
|
|
2316
2365
|
# The <ExportTimestamp> component is in Java SimpleDateFormat
|
2317
2366
|
# (yyyy-MM-ddTHH-mm-ssZ).
|
2318
2367
|
#
|
2319
|
-
# You must specify a DataDestination object that includes an
|
2320
|
-
#
|
2321
|
-
#
|
2368
|
+
# You must specify a DataDestination object that includes an Identity
|
2369
|
+
# and Access Management (IAM) role that Amazon Forecast can assume to
|
2370
|
+
# access the Amazon S3 bucket. For more information, see
|
2322
2371
|
# aws-forecast-iam-roles.
|
2323
2372
|
#
|
2324
2373
|
# For more information, see howitworks-forecast.
|
@@ -2339,14 +2388,13 @@ module Aws::ForecastService
|
|
2339
2388
|
# The list of what-if forecast Amazon Resource Names (ARNs) to export.
|
2340
2389
|
#
|
2341
2390
|
# @option params [required, Types::DataDestination] :destination
|
2342
|
-
# The location where you want to save the forecast and an
|
2343
|
-
#
|
2344
|
-
#
|
2345
|
-
# bucket.
|
2391
|
+
# The location where you want to save the forecast and an Identity and
|
2392
|
+
# Access Management (IAM) role that Amazon Forecast can assume to access
|
2393
|
+
# the location. The forecast must be exported to an Amazon S3 bucket.
|
2346
2394
|
#
|
2347
|
-
# If encryption is used, `Destination` must include an
|
2348
|
-
#
|
2349
|
-
#
|
2395
|
+
# If encryption is used, `Destination` must include an Key Management
|
2396
|
+
# Service (KMS) key. The IAM role must allow Amazon Forecast permission
|
2397
|
+
# to access the key.
|
2350
2398
|
#
|
2351
2399
|
# @option params [Array<Types::Tag>] :tags
|
2352
2400
|
# A list of [tags][1] to apply to the what if forecast.
|
@@ -2682,15 +2730,15 @@ module Aws::ForecastService
|
|
2682
2730
|
# Amazon Forecast resources possess the following parent-child resource
|
2683
2731
|
# hierarchies:
|
2684
2732
|
#
|
2685
|
-
# * **Dataset
|
2733
|
+
# * **Dataset**: dataset import jobs
|
2686
2734
|
#
|
2687
|
-
# * **Dataset Group
|
2735
|
+
# * **Dataset Group**: predictors, predictor backtest export jobs,
|
2688
2736
|
# forecasts, forecast export jobs
|
2689
2737
|
#
|
2690
|
-
# * **Predictor
|
2738
|
+
# * **Predictor**: predictor backtest export jobs, forecasts, forecast
|
2691
2739
|
# export jobs
|
2692
2740
|
#
|
2693
|
-
# * **Forecast
|
2741
|
+
# * **Forecast**: forecast export jobs
|
2694
2742
|
#
|
2695
2743
|
# <note markdown="1"> `DeleteResourceTree` will only delete Amazon Forecast resources, and
|
2696
2744
|
# will not delete datasets or exported files stored in Amazon S3.
|
@@ -3051,6 +3099,7 @@ module Aws::ForecastService
|
|
3051
3099
|
# * {Types::DescribeDatasetImportJobResponse#creation_time #creation_time} => Time
|
3052
3100
|
# * {Types::DescribeDatasetImportJobResponse#last_modification_time #last_modification_time} => Time
|
3053
3101
|
# * {Types::DescribeDatasetImportJobResponse#format #format} => String
|
3102
|
+
# * {Types::DescribeDatasetImportJobResponse#import_mode #import_mode} => String
|
3054
3103
|
#
|
3055
3104
|
# @example Request syntax with placeholder values
|
3056
3105
|
#
|
@@ -3090,6 +3139,7 @@ module Aws::ForecastService
|
|
3090
3139
|
# resp.creation_time #=> Time
|
3091
3140
|
# resp.last_modification_time #=> Time
|
3092
3141
|
# resp.format #=> String
|
3142
|
+
# resp.import_mode #=> String, one of "FULL", "INCREMENTAL"
|
3093
3143
|
#
|
3094
3144
|
# @see http://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/DescribeDatasetImportJob AWS API Documentation
|
3095
3145
|
#
|
@@ -4006,6 +4056,7 @@ module Aws::ForecastService
|
|
4006
4056
|
# resp.dataset_import_jobs[0].message #=> String
|
4007
4057
|
# resp.dataset_import_jobs[0].creation_time #=> Time
|
4008
4058
|
# resp.dataset_import_jobs[0].last_modification_time #=> Time
|
4059
|
+
# resp.dataset_import_jobs[0].import_mode #=> String, one of "FULL", "INCREMENTAL"
|
4009
4060
|
# resp.next_token #=> String
|
4010
4061
|
#
|
4011
4062
|
# @see http://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/ListDatasetImportJobs AWS API Documentation
|
@@ -5121,12 +5172,12 @@ module Aws::ForecastService
|
|
5121
5172
|
# * Tag keys and values are case sensitive.
|
5122
5173
|
#
|
5123
5174
|
# * Do not use `aws:`, `AWS:`, or any upper or lowercase combination of
|
5124
|
-
# such as a prefix for keys as it is reserved for
|
5125
|
-
# edit or delete tag keys with this prefix. Values can
|
5126
|
-
# prefix. If a tag value has `aws` as its prefix but the key
|
5127
|
-
# then Forecast considers it to be a user tag and will count
|
5128
|
-
# the limit of 50 tags. Tags with only the key prefix of `aws`
|
5129
|
-
# count against your tags per resource limit.
|
5175
|
+
# such as a prefix for keys as it is reserved for Amazon Web Services
|
5176
|
+
# use. You cannot edit or delete tag keys with this prefix. Values can
|
5177
|
+
# have this prefix. If a tag value has `aws` as its prefix but the key
|
5178
|
+
# does not, then Forecast considers it to be a user tag and will count
|
5179
|
+
# against the limit of 50 tags. Tags with only the key prefix of `aws`
|
5180
|
+
# do not count against your tags per resource limit.
|
5130
5181
|
#
|
5131
5182
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
5132
5183
|
#
|
@@ -5228,7 +5279,7 @@ module Aws::ForecastService
|
|
5228
5279
|
params: params,
|
5229
5280
|
config: config)
|
5230
5281
|
context[:gem_name] = 'aws-sdk-forecastservice'
|
5231
|
-
context[:gem_version] = '1.
|
5282
|
+
context[:gem_version] = '1.41.0'
|
5232
5283
|
Seahorse::Client::Request.new(handlers, context)
|
5233
5284
|
end
|
5234
5285
|
|
@@ -157,6 +157,7 @@ module Aws::ForecastService
|
|
157
157
|
GetAccuracyMetricsResponse = Shapes::StructureShape.new(name: 'GetAccuracyMetricsResponse')
|
158
158
|
Hour = Shapes::IntegerShape.new(name: 'Hour')
|
159
159
|
HyperParameterTuningJobConfig = Shapes::StructureShape.new(name: 'HyperParameterTuningJobConfig')
|
160
|
+
ImportMode = Shapes::StringShape.new(name: 'ImportMode')
|
160
161
|
InputDataConfig = Shapes::StructureShape.new(name: 'InputDataConfig')
|
161
162
|
Integer = Shapes::IntegerShape.new(name: 'Integer')
|
162
163
|
IntegerParameterRange = Shapes::StructureShape.new(name: 'IntegerParameterRange')
|
@@ -372,6 +373,7 @@ module Aws::ForecastService
|
|
372
373
|
CreateDatasetImportJobRequest.add_member(:geolocation_format, Shapes::ShapeRef.new(shape: GeolocationFormat, location_name: "GeolocationFormat"))
|
373
374
|
CreateDatasetImportJobRequest.add_member(:tags, Shapes::ShapeRef.new(shape: Tags, location_name: "Tags"))
|
374
375
|
CreateDatasetImportJobRequest.add_member(:format, Shapes::ShapeRef.new(shape: Format, location_name: "Format"))
|
376
|
+
CreateDatasetImportJobRequest.add_member(:import_mode, Shapes::ShapeRef.new(shape: ImportMode, location_name: "ImportMode"))
|
375
377
|
CreateDatasetImportJobRequest.struct_class = Types::CreateDatasetImportJobRequest
|
376
378
|
|
377
379
|
CreateDatasetImportJobResponse.add_member(:dataset_import_job_arn, Shapes::ShapeRef.new(shape: Arn, location_name: "DatasetImportJobArn"))
|
@@ -526,6 +528,7 @@ module Aws::ForecastService
|
|
526
528
|
DatasetImportJobSummary.add_member(:message, Shapes::ShapeRef.new(shape: ErrorMessage, location_name: "Message"))
|
527
529
|
DatasetImportJobSummary.add_member(:creation_time, Shapes::ShapeRef.new(shape: Timestamp, location_name: "CreationTime"))
|
528
530
|
DatasetImportJobSummary.add_member(:last_modification_time, Shapes::ShapeRef.new(shape: Timestamp, location_name: "LastModificationTime"))
|
531
|
+
DatasetImportJobSummary.add_member(:import_mode, Shapes::ShapeRef.new(shape: ImportMode, location_name: "ImportMode"))
|
529
532
|
DatasetImportJobSummary.struct_class = Types::DatasetImportJobSummary
|
530
533
|
|
531
534
|
DatasetImportJobs.member = Shapes::ShapeRef.new(shape: DatasetImportJobSummary)
|
@@ -637,6 +640,7 @@ module Aws::ForecastService
|
|
637
640
|
DescribeDatasetImportJobResponse.add_member(:creation_time, Shapes::ShapeRef.new(shape: Timestamp, location_name: "CreationTime"))
|
638
641
|
DescribeDatasetImportJobResponse.add_member(:last_modification_time, Shapes::ShapeRef.new(shape: Timestamp, location_name: "LastModificationTime"))
|
639
642
|
DescribeDatasetImportJobResponse.add_member(:format, Shapes::ShapeRef.new(shape: Format, location_name: "Format"))
|
643
|
+
DescribeDatasetImportJobResponse.add_member(:import_mode, Shapes::ShapeRef.new(shape: ImportMode, location_name: "ImportMode"))
|
640
644
|
DescribeDatasetImportJobResponse.struct_class = Types::DescribeDatasetImportJobResponse
|
641
645
|
|
642
646
|
DescribeDatasetRequest.add_member(:dataset_arn, Shapes::ShapeRef.new(shape: Arn, required: true, location_name: "DatasetArn"))
|
@@ -50,6 +50,9 @@ module Aws::ForecastService
|
|
50
50
|
|
51
51
|
def initialize(options = {})
|
52
52
|
self[:region] = options[:region]
|
53
|
+
if self[:region].nil?
|
54
|
+
raise ArgumentError, "Missing required EndpointParameter: :region"
|
55
|
+
end
|
53
56
|
self[:use_dual_stack] = options[:use_dual_stack]
|
54
57
|
self[:use_dual_stack] = false if self[:use_dual_stack].nil?
|
55
58
|
if self[:use_dual_stack].nil?
|
@@ -15,7 +15,7 @@ module Aws::ForecastService
|
|
15
15
|
use_fips = parameters.use_fips
|
16
16
|
endpoint = parameters.endpoint
|
17
17
|
if (partition_result = Aws::Endpoints::Matchers.aws_partition(region))
|
18
|
-
if Aws::Endpoints::Matchers.set?(endpoint)
|
18
|
+
if Aws::Endpoints::Matchers.set?(endpoint)
|
19
19
|
if Aws::Endpoints::Matchers.boolean_equals?(use_fips, true)
|
20
20
|
raise ArgumentError, "Invalid Configuration: FIPS and custom endpoint are not supported"
|
21
21
|
end
|