aws-sdk-forecastservice 1.11.0 → 1.16.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 70b267366d492acd5e216dd6845914afbe9a22d5715c170112b9cfe2acabf577
4
- data.tar.gz: 8ef8bec9a516306642555b10bb837453870a243698041a59d3ec971464f5db02
3
+ metadata.gz: 3837442c9af2a5a98a59e49a12a86dbe1b4e3d5666f5d282354520f2eb8cb792
4
+ data.tar.gz: 806d88f643d636b08e01c5f17637a619a9b83654337fbb249e401d2371788ba7
5
5
  SHA512:
6
- metadata.gz: 40ce700ff5c1e8f81b92cc2b9bad79fdd26a2a0bcdd9de2a1a4f035db7fa310704d45c0e8604d20257944e740fc11403b32acc6f0e9798f5c727644795688601
7
- data.tar.gz: 7e33d26ca12568a648ae2207f9e1b525f471a11cf1c00faa589b1005da22cd9932ba302472d4023ed4cf19eda8ab5a737c6574aa55221e6118e6ea2702c9b050
6
+ metadata.gz: 2ad14e8d73344cf2bcc58d9b3f2d662f681e1fa3ec039016af1b58a8be75c82a888ffc1c667ac59804fb5a96ca6078cab3aed0e3376fed160449d3c4c0139e01
7
+ data.tar.gz: c5694ee5ac1c2bf4de1420685f26c555e5d82d7980fdf8ca840ae977bc547f2abf8fd16d9c92ad78d3ae01312fff4441b2c1cb28f9590af99d9315bc0086bb3d
@@ -48,6 +48,6 @@ require_relative 'aws-sdk-forecastservice/customizations'
48
48
  # @!group service
49
49
  module Aws::ForecastService
50
50
 
51
- GEM_VERSION = '1.11.0'
51
+ GEM_VERSION = '1.16.0'
52
52
 
53
53
  end
@@ -459,7 +459,7 @@ module Aws::ForecastService
459
459
  # attributes: [
460
460
  # {
461
461
  # attribute_name: "Name",
462
- # attribute_type: "string", # accepts string, integer, float, timestamp
462
+ # attribute_type: "string", # accepts string, integer, float, timestamp, geolocation
463
463
  # },
464
464
  # ],
465
465
  # },
@@ -499,9 +499,9 @@ module Aws::ForecastService
499
499
  # To get a list of all your datasets groups, use the ListDatasetGroups
500
500
  # operation.
501
501
  #
502
- # <note markdown="1"> The `Status` of a dataset group must be `ACTIVE` before you can create
503
- # use the dataset group to create a predictor. To get the status, use
504
- # the DescribeDatasetGroup operation.
502
+ # <note markdown="1"> The `Status` of a dataset group must be `ACTIVE` before you can use
503
+ # the dataset group to create a predictor. To get the status, use the
504
+ # DescribeDatasetGroup operation.
505
505
  #
506
506
  # </note>
507
507
  #
@@ -652,6 +652,34 @@ module Aws::ForecastService
652
652
  # If the format isn't specified, Amazon Forecast expects the format to
653
653
  # be "yyyy-MM-dd HH:mm:ss".
654
654
  #
655
+ # @option params [String] :time_zone
656
+ # A single time zone for every item in your dataset. This option is
657
+ # ideal for datasets with all timestamps within a single time zone, or
658
+ # if all timestamps are normalized to a single time zone.
659
+ #
660
+ # Refer to the [Joda-Time API][1] for a complete list of valid time zone
661
+ # names.
662
+ #
663
+ #
664
+ #
665
+ # [1]: http://joda-time.sourceforge.net/timezones.html
666
+ #
667
+ # @option params [Boolean] :use_geolocation_for_time_zone
668
+ # Automatically derive time zone information from the geolocation
669
+ # attribute. This option is ideal for datasets that contain timestamps
670
+ # in multiple time zones and those timestamps are expressed in local
671
+ # time.
672
+ #
673
+ # @option params [String] :geolocation_format
674
+ # The format of the geolocation attribute. The geolocation attribute can
675
+ # be formatted in one of two ways:
676
+ #
677
+ # * `LAT_LONG` - the latitude and longitude in decimal format (Example:
678
+ # 47.61\_-122.33).
679
+ #
680
+ # * `CC_POSTALCODE` (US Only) - the country code (US), followed by the
681
+ # 5-digit ZIP code (Example: US\_98121).
682
+ #
655
683
  # @option params [Array<Types::Tag>] :tags
656
684
  # The optional metadata that you apply to the dataset import job to help
657
685
  # you categorize and organize them. Each tag consists of a key and an
@@ -701,6 +729,9 @@ module Aws::ForecastService
701
729
  # },
702
730
  # },
703
731
  # timestamp_format: "TimestampFormat",
732
+ # time_zone: "TimeZone",
733
+ # use_geolocation_for_time_zone: false,
734
+ # geolocation_format: "GeolocationFormat",
704
735
  # tags: [
705
736
  # {
706
737
  # key: "TagKey", # required
@@ -940,24 +971,20 @@ module Aws::ForecastService
940
971
 
941
972
  # Creates an Amazon Forecast predictor.
942
973
  #
943
- # In the request, you provide a dataset group and either specify an
944
- # algorithm or let Amazon Forecast choose the algorithm for you using
974
+ # In the request, provide a dataset group and either specify an
975
+ # algorithm or let Amazon Forecast choose an algorithm for you using
945
976
  # AutoML. If you specify an algorithm, you also can override
946
977
  # algorithm-specific hyperparameters.
947
978
  #
948
- # Amazon Forecast uses the chosen algorithm to train a model using the
949
- # latest version of the datasets in the specified dataset group. The
950
- # result is called a predictor. You then generate a forecast using the
951
- # CreateForecast operation.
979
+ # Amazon Forecast uses the algorithm to train a predictor using the
980
+ # latest version of the datasets in the specified dataset group. You can
981
+ # then generate a forecast using the CreateForecast operation.
952
982
  #
953
- # After training a model, the `CreatePredictor` operation also evaluates
954
- # it. To see the evaluation metrics, use the GetAccuracyMetrics
955
- # operation. Always review the evaluation metrics before deciding to use
956
- # the predictor to generate a forecast.
983
+ # To see the evaluation metrics, use the GetAccuracyMetrics operation.
957
984
  #
958
- # Optionally, you can specify a featurization configuration to fill and
959
- # aggregate the data fields in the `TARGET_TIME_SERIES` dataset to
960
- # improve model training. For more information, see FeaturizationConfig.
985
+ # You can specify a featurization configuration to fill and aggregate
986
+ # the data fields in the `TARGET_TIME_SERIES` dataset to improve model
987
+ # training. For more information, see FeaturizationConfig.
961
988
  #
962
989
  # For RELATED\_TIME\_SERIES datasets, `CreatePredictor` verifies that
963
990
  # the `DataFrequency` specified when the dataset was created matches the
@@ -965,12 +992,17 @@ module Aws::ForecastService
965
992
  # restriction. Amazon Forecast also verifies the delimiter and timestamp
966
993
  # format. For more information, see howitworks-datasets-groups.
967
994
  #
995
+ # By default, predictors are trained and evaluated at the 0.1 (P10), 0.5
996
+ # (P50), and 0.9 (P90) quantiles. You can choose custom forecast types
997
+ # to train and evaluate your predictor by setting the `ForecastTypes`.
998
+ #
968
999
  # **AutoML**
969
1000
  #
970
1001
  # If you want Amazon Forecast to evaluate each algorithm and choose the
971
1002
  # one that minimizes the `objective function`, set `PerformAutoML` to
972
1003
  # `true`. The `objective function` is defined as the mean of the
973
- # weighted p10, p50, and p90 quantile losses. For more information, see
1004
+ # weighted losses over the forecast types. By default, these are the
1005
+ # p10, p50, and p90 quantile losses. For more information, see
974
1006
  # EvaluationResult.
975
1007
  #
976
1008
  # When AutoML is enabled, the following properties are disallowed:
@@ -1003,9 +1035,9 @@ module Aws::ForecastService
1003
1035
  #
1004
1036
  # * `arn:aws:forecast:::algorithm/ARIMA`
1005
1037
  #
1006
- # * `arn:aws:forecast:::algorithm/Deep_AR_Plus`
1038
+ # * `arn:aws:forecast:::algorithm/CNN-QR`
1007
1039
  #
1008
- # Supports hyperparameter optimization (HPO)
1040
+ # * `arn:aws:forecast:::algorithm/Deep_AR_Plus`
1009
1041
  #
1010
1042
  # * `arn:aws:forecast:::algorithm/ETS`
1011
1043
  #
@@ -1025,6 +1057,14 @@ module Aws::ForecastService
1025
1057
  # The maximum forecast horizon is the lesser of 500 time-steps or 1/3 of
1026
1058
  # the TARGET\_TIME\_SERIES dataset length.
1027
1059
  #
1060
+ # @option params [Array<String>] :forecast_types
1061
+ # Specifies the forecast types used to train a predictor. You can
1062
+ # specify up to five forecast types. Forecast types can be quantiles
1063
+ # from 0.01 to 0.99, by increments of 0.01 or higher. You can also
1064
+ # specify the mean forecast with `mean`.
1065
+ #
1066
+ # The default value is `["0.10", "0.50", "0.9"]`.
1067
+ #
1028
1068
  # @option params [Boolean] :perform_auto_ml
1029
1069
  # Whether to perform AutoML. When Amazon Forecast performs AutoML, it
1030
1070
  # evaluates the algorithms it provides and chooses the best algorithm
@@ -1052,11 +1092,11 @@ module Aws::ForecastService
1052
1092
  # hyperparameter. In this case, you are required to specify an algorithm
1053
1093
  # and `PerformAutoML` must be false.
1054
1094
  #
1055
- # The following algorithm supports HPO:
1095
+ # The following algorithms support HPO:
1056
1096
  #
1057
1097
  # * DeepAR+
1058
1098
  #
1059
- # ^
1099
+ # * CNN-QR
1060
1100
  #
1061
1101
  # @option params [Hash<String,String>] :training_parameters
1062
1102
  # The hyperparameters to override for model training. The
@@ -1134,6 +1174,7 @@ module Aws::ForecastService
1134
1174
  # predictor_name: "Name", # required
1135
1175
  # algorithm_arn: "Arn",
1136
1176
  # forecast_horizon: 1, # required
1177
+ # forecast_types: ["ForecastType"],
1137
1178
  # perform_auto_ml: false,
1138
1179
  # perform_hpo: false,
1139
1180
  # training_parameters: {
@@ -1220,6 +1261,105 @@ module Aws::ForecastService
1220
1261
  req.send_request(options)
1221
1262
  end
1222
1263
 
1264
+ # Exports backtest forecasts and accuracy metrics generated by the
1265
+ # CreatePredictor operation. Two folders containing CSV files are
1266
+ # exported to your specified S3 bucket.
1267
+ #
1268
+ # The export file names will match the following conventions:
1269
+ #
1270
+ # `<ExportJobName>_<ExportTimestamp>_<PartNumber>.csv`
1271
+ #
1272
+ # The &lt;ExportTimestamp&gt; component is in Java SimpleDate format
1273
+ # (yyyy-MM-ddTHH-mm-ssZ).
1274
+ #
1275
+ # You must specify a DataDestination object that includes an Amazon S3
1276
+ # bucket and an AWS Identity and Access Management (IAM) role that
1277
+ # Amazon Forecast can assume to access the Amazon S3 bucket. For more
1278
+ # information, see aws-forecast-iam-roles.
1279
+ #
1280
+ # <note markdown="1"> The `Status` of the export job must be `ACTIVE` before you can access
1281
+ # the export in your Amazon S3 bucket. To get the status, use the
1282
+ # DescribePredictorBacktestExportJob operation.
1283
+ #
1284
+ # </note>
1285
+ #
1286
+ # @option params [required, String] :predictor_backtest_export_job_name
1287
+ # The name for the backtest export job.
1288
+ #
1289
+ # @option params [required, String] :predictor_arn
1290
+ # The Amazon Resource Name (ARN) of the predictor that you want to
1291
+ # export.
1292
+ #
1293
+ # @option params [required, Types::DataDestination] :destination
1294
+ # The destination for an export job. Provide an S3 path, an AWS Identity
1295
+ # and Access Management (IAM) role that allows Amazon Forecast to access
1296
+ # the location, and an AWS Key Management Service (KMS) key (optional).
1297
+ #
1298
+ # @option params [Array<Types::Tag>] :tags
1299
+ # Optional metadata to help you categorize and organize your backtests.
1300
+ # Each tag consists of a key and an optional value, both of which you
1301
+ # define. Tag keys and values are case sensitive.
1302
+ #
1303
+ # The following restrictions apply to tags:
1304
+ #
1305
+ # * For each resource, each tag key must be unique and each tag key must
1306
+ # have one value.
1307
+ #
1308
+ # * Maximum number of tags per resource: 50.
1309
+ #
1310
+ # * Maximum key length: 128 Unicode characters in UTF-8.
1311
+ #
1312
+ # * Maximum value length: 256 Unicode characters in UTF-8.
1313
+ #
1314
+ # * Accepted characters: all letters and numbers, spaces representable
1315
+ # in UTF-8, and + - = . \_ : / @. If your tagging schema is used
1316
+ # across other services and resources, the character restrictions of
1317
+ # those services also apply.
1318
+ #
1319
+ # * Key prefixes cannot include any upper or lowercase combination of
1320
+ # `aws:` or `AWS:`. Values can have this prefix. If a tag value has
1321
+ # `aws` as its prefix but the key does not, Forecast considers it to
1322
+ # be a user tag and will count against the limit of 50 tags. Tags with
1323
+ # only the key prefix of `aws` do not count against your tags per
1324
+ # resource limit. You cannot edit or delete tag keys with this prefix.
1325
+ #
1326
+ # @return [Types::CreatePredictorBacktestExportJobResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1327
+ #
1328
+ # * {Types::CreatePredictorBacktestExportJobResponse#predictor_backtest_export_job_arn #predictor_backtest_export_job_arn} => String
1329
+ #
1330
+ # @example Request syntax with placeholder values
1331
+ #
1332
+ # resp = client.create_predictor_backtest_export_job({
1333
+ # predictor_backtest_export_job_name: "Name", # required
1334
+ # predictor_arn: "Arn", # required
1335
+ # destination: { # required
1336
+ # s3_config: { # required
1337
+ # path: "S3Path", # required
1338
+ # role_arn: "Arn", # required
1339
+ # kms_key_arn: "KMSKeyArn",
1340
+ # },
1341
+ # },
1342
+ # tags: [
1343
+ # {
1344
+ # key: "TagKey", # required
1345
+ # value: "TagValue", # required
1346
+ # },
1347
+ # ],
1348
+ # })
1349
+ #
1350
+ # @example Response structure
1351
+ #
1352
+ # resp.predictor_backtest_export_job_arn #=> String
1353
+ #
1354
+ # @see http://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/CreatePredictorBacktestExportJob AWS API Documentation
1355
+ #
1356
+ # @overload create_predictor_backtest_export_job(params = {})
1357
+ # @param [Hash] params ({})
1358
+ def create_predictor_backtest_export_job(params = {}, options = {})
1359
+ req = build_request(:create_predictor_backtest_export_job, params)
1360
+ req.send_request(options)
1361
+ end
1362
+
1223
1363
  # Deletes an Amazon Forecast dataset that was created using the
1224
1364
  # CreateDataset operation. You can only delete datasets that have a
1225
1365
  # status of `ACTIVE` or `CREATE_FAILED`. To get the status use the
@@ -1382,6 +1522,29 @@ module Aws::ForecastService
1382
1522
  req.send_request(options)
1383
1523
  end
1384
1524
 
1525
+ # Deletes a predictor backtest export job.
1526
+ #
1527
+ # @option params [required, String] :predictor_backtest_export_job_arn
1528
+ # The Amazon Resource Name (ARN) of the predictor backtest export job to
1529
+ # delete.
1530
+ #
1531
+ # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
1532
+ #
1533
+ # @example Request syntax with placeholder values
1534
+ #
1535
+ # resp = client.delete_predictor_backtest_export_job({
1536
+ # predictor_backtest_export_job_arn: "Arn", # required
1537
+ # })
1538
+ #
1539
+ # @see http://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/DeletePredictorBacktestExportJob AWS API Documentation
1540
+ #
1541
+ # @overload delete_predictor_backtest_export_job(params = {})
1542
+ # @param [Hash] params ({})
1543
+ def delete_predictor_backtest_export_job(params = {}, options = {})
1544
+ req = build_request(:delete_predictor_backtest_export_job, params)
1545
+ req.send_request(options)
1546
+ end
1547
+
1385
1548
  # Describes an Amazon Forecast dataset created using the CreateDataset
1386
1549
  # operation.
1387
1550
  #
@@ -1425,7 +1588,7 @@ module Aws::ForecastService
1425
1588
  # resp.data_frequency #=> String
1426
1589
  # resp.schema.attributes #=> Array
1427
1590
  # resp.schema.attributes[0].attribute_name #=> String
1428
- # resp.schema.attributes[0].attribute_type #=> String, one of "string", "integer", "float", "timestamp"
1591
+ # resp.schema.attributes[0].attribute_type #=> String, one of "string", "integer", "float", "timestamp", "geolocation"
1429
1592
  # resp.encryption_config.role_arn #=> String
1430
1593
  # resp.encryption_config.kms_key_arn #=> String
1431
1594
  # resp.status #=> String
@@ -1523,6 +1686,9 @@ module Aws::ForecastService
1523
1686
  # * {Types::DescribeDatasetImportJobResponse#dataset_import_job_arn #dataset_import_job_arn} => String
1524
1687
  # * {Types::DescribeDatasetImportJobResponse#dataset_arn #dataset_arn} => String
1525
1688
  # * {Types::DescribeDatasetImportJobResponse#timestamp_format #timestamp_format} => String
1689
+ # * {Types::DescribeDatasetImportJobResponse#time_zone #time_zone} => String
1690
+ # * {Types::DescribeDatasetImportJobResponse#use_geolocation_for_time_zone #use_geolocation_for_time_zone} => Boolean
1691
+ # * {Types::DescribeDatasetImportJobResponse#geolocation_format #geolocation_format} => String
1526
1692
  # * {Types::DescribeDatasetImportJobResponse#data_source #data_source} => Types::DataSource
1527
1693
  # * {Types::DescribeDatasetImportJobResponse#field_statistics #field_statistics} => Hash&lt;String,Types::Statistics&gt;
1528
1694
  # * {Types::DescribeDatasetImportJobResponse#data_size #data_size} => Float
@@ -1543,6 +1709,9 @@ module Aws::ForecastService
1543
1709
  # resp.dataset_import_job_arn #=> String
1544
1710
  # resp.dataset_arn #=> String
1545
1711
  # resp.timestamp_format #=> String
1712
+ # resp.time_zone #=> String
1713
+ # resp.use_geolocation_for_time_zone #=> Boolean
1714
+ # resp.geolocation_format #=> String
1546
1715
  # resp.data_source.s3_config.path #=> String
1547
1716
  # resp.data_source.s3_config.role_arn #=> String
1548
1717
  # resp.data_source.s3_config.kms_key_arn #=> String
@@ -1716,6 +1885,7 @@ module Aws::ForecastService
1716
1885
  # * {Types::DescribePredictorResponse#predictor_name #predictor_name} => String
1717
1886
  # * {Types::DescribePredictorResponse#algorithm_arn #algorithm_arn} => String
1718
1887
  # * {Types::DescribePredictorResponse#forecast_horizon #forecast_horizon} => Integer
1888
+ # * {Types::DescribePredictorResponse#forecast_types #forecast_types} => Array&lt;String&gt;
1719
1889
  # * {Types::DescribePredictorResponse#perform_auto_ml #perform_auto_ml} => Boolean
1720
1890
  # * {Types::DescribePredictorResponse#perform_hpo #perform_hpo} => Boolean
1721
1891
  # * {Types::DescribePredictorResponse#training_parameters #training_parameters} => Hash&lt;String,String&gt;
@@ -1744,6 +1914,8 @@ module Aws::ForecastService
1744
1914
  # resp.predictor_name #=> String
1745
1915
  # resp.algorithm_arn #=> String
1746
1916
  # resp.forecast_horizon #=> Integer
1917
+ # resp.forecast_types #=> Array
1918
+ # resp.forecast_types[0] #=> String
1747
1919
  # resp.perform_auto_ml #=> Boolean
1748
1920
  # resp.perform_hpo #=> Boolean
1749
1921
  # resp.training_parameters #=> Hash
@@ -1804,10 +1976,67 @@ module Aws::ForecastService
1804
1976
  req.send_request(options)
1805
1977
  end
1806
1978
 
1979
+ # Describes a predictor backtest export job created using the
1980
+ # CreatePredictorBacktestExportJob operation.
1981
+ #
1982
+ # In addition to listing the properties provided by the user in the
1983
+ # `CreatePredictorBacktestExportJob` request, this operation lists the
1984
+ # following properties:
1985
+ #
1986
+ # * `CreationTime`
1987
+ #
1988
+ # * `LastModificationTime`
1989
+ #
1990
+ # * `Status`
1991
+ #
1992
+ # * `Message` (if an error occurred)
1993
+ #
1994
+ # @option params [required, String] :predictor_backtest_export_job_arn
1995
+ # The Amazon Resource Name (ARN) of the predictor backtest export job.
1996
+ #
1997
+ # @return [Types::DescribePredictorBacktestExportJobResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1998
+ #
1999
+ # * {Types::DescribePredictorBacktestExportJobResponse#predictor_backtest_export_job_arn #predictor_backtest_export_job_arn} => String
2000
+ # * {Types::DescribePredictorBacktestExportJobResponse#predictor_backtest_export_job_name #predictor_backtest_export_job_name} => String
2001
+ # * {Types::DescribePredictorBacktestExportJobResponse#predictor_arn #predictor_arn} => String
2002
+ # * {Types::DescribePredictorBacktestExportJobResponse#destination #destination} => Types::DataDestination
2003
+ # * {Types::DescribePredictorBacktestExportJobResponse#message #message} => String
2004
+ # * {Types::DescribePredictorBacktestExportJobResponse#status #status} => String
2005
+ # * {Types::DescribePredictorBacktestExportJobResponse#creation_time #creation_time} => Time
2006
+ # * {Types::DescribePredictorBacktestExportJobResponse#last_modification_time #last_modification_time} => Time
2007
+ #
2008
+ # @example Request syntax with placeholder values
2009
+ #
2010
+ # resp = client.describe_predictor_backtest_export_job({
2011
+ # predictor_backtest_export_job_arn: "Arn", # required
2012
+ # })
2013
+ #
2014
+ # @example Response structure
2015
+ #
2016
+ # resp.predictor_backtest_export_job_arn #=> String
2017
+ # resp.predictor_backtest_export_job_name #=> String
2018
+ # resp.predictor_arn #=> String
2019
+ # resp.destination.s3_config.path #=> String
2020
+ # resp.destination.s3_config.role_arn #=> String
2021
+ # resp.destination.s3_config.kms_key_arn #=> String
2022
+ # resp.message #=> String
2023
+ # resp.status #=> String
2024
+ # resp.creation_time #=> Time
2025
+ # resp.last_modification_time #=> Time
2026
+ #
2027
+ # @see http://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/DescribePredictorBacktestExportJob AWS API Documentation
2028
+ #
2029
+ # @overload describe_predictor_backtest_export_job(params = {})
2030
+ # @param [Hash] params ({})
2031
+ def describe_predictor_backtest_export_job(params = {}, options = {})
2032
+ req = build_request(:describe_predictor_backtest_export_job, params)
2033
+ req.send_request(options)
2034
+ end
2035
+
1807
2036
  # Provides metrics on the accuracy of the models that were trained by
1808
2037
  # the CreatePredictor operation. Use metrics to see how well the model
1809
2038
  # performed and to decide whether to use the predictor to generate a
1810
- # forecast. For more information, see metrics.
2039
+ # forecast. For more information, see [Predictor Metrics][1].
1811
2040
  #
1812
2041
  # This operation generates metrics for each backtest window that was
1813
2042
  # evaluated. The number of backtest windows (`NumberOfBacktestWindows`)
@@ -1828,6 +2057,10 @@ module Aws::ForecastService
1828
2057
  #
1829
2058
  # </note>
1830
2059
  #
2060
+ #
2061
+ #
2062
+ # [1]: https://docs.aws.amazon.com/forecast/latest/dg/metrics.html
2063
+ #
1831
2064
  # @option params [required, String] :predictor_arn
1832
2065
  # The Amazon Resource Name (ARN) of the predictor to get metrics for.
1833
2066
  #
@@ -1854,6 +2087,10 @@ module Aws::ForecastService
1854
2087
  # resp.predictor_evaluation_results[0].test_windows[0].metrics.weighted_quantile_losses #=> Array
1855
2088
  # resp.predictor_evaluation_results[0].test_windows[0].metrics.weighted_quantile_losses[0].quantile #=> Float
1856
2089
  # resp.predictor_evaluation_results[0].test_windows[0].metrics.weighted_quantile_losses[0].loss_value #=> Float
2090
+ # resp.predictor_evaluation_results[0].test_windows[0].metrics.error_metrics #=> Array
2091
+ # resp.predictor_evaluation_results[0].test_windows[0].metrics.error_metrics[0].forecast_type #=> String
2092
+ # resp.predictor_evaluation_results[0].test_windows[0].metrics.error_metrics[0].wape #=> Float
2093
+ # resp.predictor_evaluation_results[0].test_windows[0].metrics.error_metrics[0].rmse #=> Float
1857
2094
  #
1858
2095
  # @see http://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/GetAccuracyMetrics AWS API Documentation
1859
2096
  #
@@ -2206,6 +2443,86 @@ module Aws::ForecastService
2206
2443
  req.send_request(options)
2207
2444
  end
2208
2445
 
2446
+ # Returns a list of predictor backtest export jobs created using the
2447
+ # CreatePredictorBacktestExportJob operation. This operation returns a
2448
+ # summary for each backtest export job. You can filter the list using an
2449
+ # array of Filter objects.
2450
+ #
2451
+ # To retrieve the complete set of properties for a particular backtest
2452
+ # export job, use the ARN with the DescribePredictorBacktestExportJob
2453
+ # operation.
2454
+ #
2455
+ # @option params [String] :next_token
2456
+ # If the result of the previous request was truncated, the response
2457
+ # includes a NextToken. To retrieve the next set of results, use the
2458
+ # token in the next request. Tokens expire after 24 hours.
2459
+ #
2460
+ # @option params [Integer] :max_results
2461
+ # The number of items to return in the response.
2462
+ #
2463
+ # @option params [Array<Types::Filter>] :filters
2464
+ # An array of filters. For each filter, provide a condition and a match
2465
+ # statement. The condition is either `IS` or `IS_NOT`, which specifies
2466
+ # whether to include or exclude the predictor backtest export jobs that
2467
+ # match the statement from the list. The match statement consists of a
2468
+ # key and a value.
2469
+ #
2470
+ # **Filter properties**
2471
+ #
2472
+ # * `Condition` - The condition to apply. Valid values are `IS` and
2473
+ # `IS_NOT`. To include the predictor backtest export jobs that match
2474
+ # the statement, specify `IS`. To exclude matching predictor backtest
2475
+ # export jobs, specify `IS_NOT`.
2476
+ #
2477
+ # * `Key` - The name of the parameter to filter on. Valid values are
2478
+ # `PredictorArn` and `Status`.
2479
+ #
2480
+ # * `Value` - The value to match.
2481
+ #
2482
+ # @return [Types::ListPredictorBacktestExportJobsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
2483
+ #
2484
+ # * {Types::ListPredictorBacktestExportJobsResponse#predictor_backtest_export_jobs #predictor_backtest_export_jobs} => Array&lt;Types::PredictorBacktestExportJobSummary&gt;
2485
+ # * {Types::ListPredictorBacktestExportJobsResponse#next_token #next_token} => String
2486
+ #
2487
+ # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
2488
+ #
2489
+ # @example Request syntax with placeholder values
2490
+ #
2491
+ # resp = client.list_predictor_backtest_export_jobs({
2492
+ # next_token: "NextToken",
2493
+ # max_results: 1,
2494
+ # filters: [
2495
+ # {
2496
+ # key: "String", # required
2497
+ # value: "Arn", # required
2498
+ # condition: "IS", # required, accepts IS, IS_NOT
2499
+ # },
2500
+ # ],
2501
+ # })
2502
+ #
2503
+ # @example Response structure
2504
+ #
2505
+ # resp.predictor_backtest_export_jobs #=> Array
2506
+ # resp.predictor_backtest_export_jobs[0].predictor_backtest_export_job_arn #=> String
2507
+ # resp.predictor_backtest_export_jobs[0].predictor_backtest_export_job_name #=> String
2508
+ # resp.predictor_backtest_export_jobs[0].destination.s3_config.path #=> String
2509
+ # resp.predictor_backtest_export_jobs[0].destination.s3_config.role_arn #=> String
2510
+ # resp.predictor_backtest_export_jobs[0].destination.s3_config.kms_key_arn #=> String
2511
+ # resp.predictor_backtest_export_jobs[0].status #=> String
2512
+ # resp.predictor_backtest_export_jobs[0].message #=> String
2513
+ # resp.predictor_backtest_export_jobs[0].creation_time #=> Time
2514
+ # resp.predictor_backtest_export_jobs[0].last_modification_time #=> Time
2515
+ # resp.next_token #=> String
2516
+ #
2517
+ # @see http://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/ListPredictorBacktestExportJobs AWS API Documentation
2518
+ #
2519
+ # @overload list_predictor_backtest_export_jobs(params = {})
2520
+ # @param [Hash] params ({})
2521
+ def list_predictor_backtest_export_jobs(params = {}, options = {})
2522
+ req = build_request(:list_predictor_backtest_export_jobs, params)
2523
+ req.send_request(options)
2524
+ end
2525
+
2209
2526
  # Returns a list of predictors created using the CreatePredictor
2210
2527
  # operation. For each predictor, this operation returns a summary of its
2211
2528
  # properties, including its Amazon Resource Name (ARN). You can retrieve
@@ -2320,6 +2637,48 @@ module Aws::ForecastService
2320
2637
  req.send_request(options)
2321
2638
  end
2322
2639
 
2640
+ # Stops a resource.
2641
+ #
2642
+ # The resource undergoes the following states: `CREATE_STOPPING` and
2643
+ # `CREATE_STOPPED`. You cannot resume a resource once it has been
2644
+ # stopped.
2645
+ #
2646
+ # This operation can be applied to the following resources (and their
2647
+ # corresponding child resources):
2648
+ #
2649
+ # * Dataset Import Job
2650
+ #
2651
+ # * Predictor Job
2652
+ #
2653
+ # * Forecast Job
2654
+ #
2655
+ # * Forecast Export Job
2656
+ #
2657
+ # * Predictor Backtest Export Job
2658
+ #
2659
+ # @option params [required, String] :resource_arn
2660
+ # The Amazon Resource Name (ARN) that identifies the resource to stop.
2661
+ # The supported ARNs are `DatasetImportJobArn`, `PredictorArn`,
2662
+ # `PredictorBacktestExportJobArn`, `ForecastArn`, and
2663
+ # `ForecastExportJobArn`.
2664
+ #
2665
+ # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
2666
+ #
2667
+ # @example Request syntax with placeholder values
2668
+ #
2669
+ # resp = client.stop_resource({
2670
+ # resource_arn: "Arn", # required
2671
+ # })
2672
+ #
2673
+ # @see http://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/StopResource AWS API Documentation
2674
+ #
2675
+ # @overload stop_resource(params = {})
2676
+ # @param [Hash] params ({})
2677
+ def stop_resource(params = {}, options = {})
2678
+ req = build_request(:stop_resource, params)
2679
+ req.send_request(options)
2680
+ end
2681
+
2323
2682
  # Associates the specified tags to a resource with the specified
2324
2683
  # `resourceArn`. If existing tags on a resource are not specified in the
2325
2684
  # request parameters, they are not changed. When a resource is deleted,
@@ -2459,7 +2818,7 @@ module Aws::ForecastService
2459
2818
  params: params,
2460
2819
  config: config)
2461
2820
  context[:gem_name] = 'aws-sdk-forecastservice'
2462
- context[:gem_version] = '1.11.0'
2821
+ context[:gem_version] = '1.16.0'
2463
2822
  Seahorse::Client::Request.new(handlers, context)
2464
2823
  end
2465
2824