aws-sdk-forecastservice 1.8.0 → 1.13.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 +4 -4
- data/lib/aws-sdk-forecastservice.rb +3 -2
- data/lib/aws-sdk-forecastservice/client.rb +312 -30
- data/lib/aws-sdk-forecastservice/client_api.rb +117 -1
- data/lib/aws-sdk-forecastservice/types.rb +470 -49
- 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: 47c5be302516af22f5ed8d15fd0693158f3c643b466e061f167ead0fdb197dec
|
4
|
+
data.tar.gz: 57753a38f00308802d7378215da48681977bead8c61099a84e7dbecbd469671a
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 985391b7401ffa81e6a2c916c814b734f9aeb4e9d4fa519c7b7dc9edb11cf55104280b8858937b5ad7b1b60c4e3a42c2f2ec22d8c7d36762913d422d45d34cf8
|
7
|
+
data.tar.gz: 5b5f48e7719e315a3799be2e28150ca8f7254b0b8b2d66d9c9c0bab7930b52b9f601a0e5ac9dea7dd56c271449e8396a9ce75d7bc80375fd86d341cb0789d286
|
@@ -7,6 +7,7 @@
|
|
7
7
|
#
|
8
8
|
# WARNING ABOUT GENERATED CODE
|
9
9
|
|
10
|
+
|
10
11
|
require 'aws-sdk-core'
|
11
12
|
require 'aws-sigv4'
|
12
13
|
|
@@ -44,9 +45,9 @@ require_relative 'aws-sdk-forecastservice/customizations'
|
|
44
45
|
#
|
45
46
|
# See {Errors} for more information.
|
46
47
|
#
|
47
|
-
#
|
48
|
+
# @!group service
|
48
49
|
module Aws::ForecastService
|
49
50
|
|
50
|
-
GEM_VERSION = '1.
|
51
|
+
GEM_VERSION = '1.13.0'
|
51
52
|
|
52
53
|
end
|
@@ -85,13 +85,28 @@ module Aws::ForecastService
|
|
85
85
|
# * `Aws::Credentials` - Used for configuring static, non-refreshing
|
86
86
|
# credentials.
|
87
87
|
#
|
88
|
+
# * `Aws::SharedCredentials` - Used for loading static credentials from a
|
89
|
+
# shared file, such as `~/.aws/config`.
|
90
|
+
#
|
91
|
+
# * `Aws::AssumeRoleCredentials` - Used when you need to assume a role.
|
92
|
+
#
|
93
|
+
# * `Aws::AssumeRoleWebIdentityCredentials` - Used when you need to
|
94
|
+
# assume a role after providing credentials via the web.
|
95
|
+
#
|
96
|
+
# * `Aws::SSOCredentials` - Used for loading credentials from AWS SSO using an
|
97
|
+
# access token generated from `aws login`.
|
98
|
+
#
|
99
|
+
# * `Aws::ProcessCredentials` - Used for loading credentials from a
|
100
|
+
# process that outputs to stdout.
|
101
|
+
#
|
88
102
|
# * `Aws::InstanceProfileCredentials` - Used for loading credentials
|
89
103
|
# from an EC2 IMDS on an EC2 instance.
|
90
104
|
#
|
91
|
-
# * `Aws::
|
92
|
-
#
|
105
|
+
# * `Aws::ECSCredentials` - Used for loading credentials from
|
106
|
+
# instances running in ECS.
|
93
107
|
#
|
94
|
-
# * `Aws::
|
108
|
+
# * `Aws::CognitoIdentityCredentials` - Used for loading credentials
|
109
|
+
# from the Cognito Identity service.
|
95
110
|
#
|
96
111
|
# When `:credentials` are not configured directly, the following
|
97
112
|
# locations will be searched for credentials:
|
@@ -101,10 +116,10 @@ module Aws::ForecastService
|
|
101
116
|
# * ENV['AWS_ACCESS_KEY_ID'], ENV['AWS_SECRET_ACCESS_KEY']
|
102
117
|
# * `~/.aws/credentials`
|
103
118
|
# * `~/.aws/config`
|
104
|
-
# * EC2 IMDS instance profile - When used by default, the timeouts
|
105
|
-
# very aggressive. Construct and pass an instance of
|
106
|
-
# `Aws::InstanceProfileCredentails`
|
107
|
-
# timeouts.
|
119
|
+
# * EC2/ECS IMDS instance profile - When used by default, the timeouts
|
120
|
+
# are very aggressive. Construct and pass an instance of
|
121
|
+
# `Aws::InstanceProfileCredentails` or `Aws::ECSCredentials` to
|
122
|
+
# enable retries and extended timeouts.
|
108
123
|
#
|
109
124
|
# @option options [required, String] :region
|
110
125
|
# The AWS region to connect to. The configured `:region` is
|
@@ -484,9 +499,9 @@ module Aws::ForecastService
|
|
484
499
|
# To get a list of all your datasets groups, use the ListDatasetGroups
|
485
500
|
# operation.
|
486
501
|
#
|
487
|
-
# <note markdown="1"> The `Status` of a dataset group must be `ACTIVE` before you can
|
488
|
-
#
|
489
|
-
#
|
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.
|
490
505
|
#
|
491
506
|
# </note>
|
492
507
|
#
|
@@ -925,24 +940,20 @@ module Aws::ForecastService
|
|
925
940
|
|
926
941
|
# Creates an Amazon Forecast predictor.
|
927
942
|
#
|
928
|
-
# In the request,
|
929
|
-
# algorithm or let Amazon Forecast choose
|
943
|
+
# In the request, provide a dataset group and either specify an
|
944
|
+
# algorithm or let Amazon Forecast choose an algorithm for you using
|
930
945
|
# AutoML. If you specify an algorithm, you also can override
|
931
946
|
# algorithm-specific hyperparameters.
|
932
947
|
#
|
933
|
-
# Amazon Forecast uses the
|
934
|
-
# latest version of the datasets in the specified dataset group.
|
935
|
-
#
|
936
|
-
# CreateForecast operation.
|
948
|
+
# Amazon Forecast uses the algorithm to train a predictor using the
|
949
|
+
# latest version of the datasets in the specified dataset group. You can
|
950
|
+
# then generate a forecast using the CreateForecast operation.
|
937
951
|
#
|
938
|
-
#
|
939
|
-
# it. To see the evaluation metrics, use the GetAccuracyMetrics
|
940
|
-
# operation. Always review the evaluation metrics before deciding to use
|
941
|
-
# the predictor to generate a forecast.
|
952
|
+
# To see the evaluation metrics, use the GetAccuracyMetrics operation.
|
942
953
|
#
|
943
|
-
#
|
944
|
-
#
|
945
|
-
#
|
954
|
+
# You can specify a featurization configuration to fill and aggregate
|
955
|
+
# the data fields in the `TARGET_TIME_SERIES` dataset to improve model
|
956
|
+
# training. For more information, see FeaturizationConfig.
|
946
957
|
#
|
947
958
|
# For RELATED\_TIME\_SERIES datasets, `CreatePredictor` verifies that
|
948
959
|
# the `DataFrequency` specified when the dataset was created matches the
|
@@ -950,12 +961,17 @@ module Aws::ForecastService
|
|
950
961
|
# restriction. Amazon Forecast also verifies the delimiter and timestamp
|
951
962
|
# format. For more information, see howitworks-datasets-groups.
|
952
963
|
#
|
964
|
+
# By default, predictors are trained and evaluated at the 0.1 (P10), 0.5
|
965
|
+
# (P50), and 0.9 (P90) quantiles. You can choose custom forecast types
|
966
|
+
# to train and evaluate your predictor by setting the `ForecastTypes`.
|
967
|
+
#
|
953
968
|
# **AutoML**
|
954
969
|
#
|
955
970
|
# If you want Amazon Forecast to evaluate each algorithm and choose the
|
956
971
|
# one that minimizes the `objective function`, set `PerformAutoML` to
|
957
972
|
# `true`. The `objective function` is defined as the mean of the
|
958
|
-
# weighted
|
973
|
+
# weighted losses over the forecast types. By default, these are the
|
974
|
+
# p10, p50, and p90 quantile losses. For more information, see
|
959
975
|
# EvaluationResult.
|
960
976
|
#
|
961
977
|
# When AutoML is enabled, the following properties are disallowed:
|
@@ -988,9 +1004,9 @@ module Aws::ForecastService
|
|
988
1004
|
#
|
989
1005
|
# * `arn:aws:forecast:::algorithm/ARIMA`
|
990
1006
|
#
|
991
|
-
# * `arn:aws:forecast:::algorithm/
|
1007
|
+
# * `arn:aws:forecast:::algorithm/CNN-QR`
|
992
1008
|
#
|
993
|
-
#
|
1009
|
+
# * `arn:aws:forecast:::algorithm/Deep_AR_Plus`
|
994
1010
|
#
|
995
1011
|
# * `arn:aws:forecast:::algorithm/ETS`
|
996
1012
|
#
|
@@ -1010,6 +1026,14 @@ module Aws::ForecastService
|
|
1010
1026
|
# The maximum forecast horizon is the lesser of 500 time-steps or 1/3 of
|
1011
1027
|
# the TARGET\_TIME\_SERIES dataset length.
|
1012
1028
|
#
|
1029
|
+
# @option params [Array<String>] :forecast_types
|
1030
|
+
# Specifies the forecast types used to train a predictor. You can
|
1031
|
+
# specify up to five forecast types. Forecast types can be quantiles
|
1032
|
+
# from 0.01 to 0.99, by increments of 0.01 or higher. You can also
|
1033
|
+
# specify the mean forecast with `mean`.
|
1034
|
+
#
|
1035
|
+
# The default value is `["0.10", "0.50", "0.9"]`.
|
1036
|
+
#
|
1013
1037
|
# @option params [Boolean] :perform_auto_ml
|
1014
1038
|
# Whether to perform AutoML. When Amazon Forecast performs AutoML, it
|
1015
1039
|
# evaluates the algorithms it provides and chooses the best algorithm
|
@@ -1037,11 +1061,11 @@ module Aws::ForecastService
|
|
1037
1061
|
# hyperparameter. In this case, you are required to specify an algorithm
|
1038
1062
|
# and `PerformAutoML` must be false.
|
1039
1063
|
#
|
1040
|
-
# The following
|
1064
|
+
# The following algorithms support HPO:
|
1041
1065
|
#
|
1042
1066
|
# * DeepAR+
|
1043
1067
|
#
|
1044
|
-
#
|
1068
|
+
# * CNN-QR
|
1045
1069
|
#
|
1046
1070
|
# @option params [Hash<String,String>] :training_parameters
|
1047
1071
|
# The hyperparameters to override for model training. The
|
@@ -1119,6 +1143,7 @@ module Aws::ForecastService
|
|
1119
1143
|
# predictor_name: "Name", # required
|
1120
1144
|
# algorithm_arn: "Arn",
|
1121
1145
|
# forecast_horizon: 1, # required
|
1146
|
+
# forecast_types: ["ForecastType"],
|
1122
1147
|
# perform_auto_ml: false,
|
1123
1148
|
# perform_hpo: false,
|
1124
1149
|
# training_parameters: {
|
@@ -1205,6 +1230,92 @@ module Aws::ForecastService
|
|
1205
1230
|
req.send_request(options)
|
1206
1231
|
end
|
1207
1232
|
|
1233
|
+
# Exports backtest forecasts and accuracy metrics generated by the
|
1234
|
+
# CreatePredictor operation. Two CSV files are exported to a specified
|
1235
|
+
# S3 bucket.
|
1236
|
+
#
|
1237
|
+
# You must specify a DataDestination object that includes an AWS
|
1238
|
+
# Identity and Access Management (IAM) role that Amazon Forecast can
|
1239
|
+
# assume to access the Amazon S3 bucket. For more information, see
|
1240
|
+
# aws-forecast-iam-roles.
|
1241
|
+
#
|
1242
|
+
# @option params [required, String] :predictor_backtest_export_job_name
|
1243
|
+
# The name for the backtest export job.
|
1244
|
+
#
|
1245
|
+
# @option params [required, String] :predictor_arn
|
1246
|
+
# The Amazon Resource Name (ARN) of the predictor that you want to
|
1247
|
+
# export.
|
1248
|
+
#
|
1249
|
+
# @option params [required, Types::DataDestination] :destination
|
1250
|
+
# The destination for an export job, an AWS Identity and Access
|
1251
|
+
# Management (IAM) role that allows Amazon Forecast to access the
|
1252
|
+
# location and, optionally, an AWS Key Management Service (KMS) key.
|
1253
|
+
#
|
1254
|
+
# @option params [Array<Types::Tag>] :tags
|
1255
|
+
# Optional metadata to help you categorize and organize your backtests.
|
1256
|
+
# Each tag consists of a key and an optional value, both of which you
|
1257
|
+
# define. Tag keys and values are case sensitive.
|
1258
|
+
#
|
1259
|
+
# The following restrictions apply to tags:
|
1260
|
+
#
|
1261
|
+
# * For each resource, each tag key must be unique and each tag key must
|
1262
|
+
# have one value.
|
1263
|
+
#
|
1264
|
+
# * Maximum number of tags per resource: 50.
|
1265
|
+
#
|
1266
|
+
# * Maximum key length: 128 Unicode characters in UTF-8.
|
1267
|
+
#
|
1268
|
+
# * Maximum value length: 256 Unicode characters in UTF-8.
|
1269
|
+
#
|
1270
|
+
# * Accepted characters: all letters and numbers, spaces representable
|
1271
|
+
# in UTF-8, and + - = . \_ : / @. If your tagging schema is used
|
1272
|
+
# across other services and resources, the character restrictions of
|
1273
|
+
# those services also apply.
|
1274
|
+
#
|
1275
|
+
# * Key prefixes cannot include any upper or lowercase combination of
|
1276
|
+
# `aws:` or `AWS:`. Values can have this prefix. If a tag value has
|
1277
|
+
# `aws` as its prefix but the key does not, Forecast considers it to
|
1278
|
+
# be a user tag and will count against the limit of 50 tags. Tags with
|
1279
|
+
# only the key prefix of `aws` do not count against your tags per
|
1280
|
+
# resource limit. You cannot edit or delete tag keys with this prefix.
|
1281
|
+
#
|
1282
|
+
# @return [Types::CreatePredictorBacktestExportJobResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1283
|
+
#
|
1284
|
+
# * {Types::CreatePredictorBacktestExportJobResponse#predictor_backtest_export_job_arn #predictor_backtest_export_job_arn} => String
|
1285
|
+
#
|
1286
|
+
# @example Request syntax with placeholder values
|
1287
|
+
#
|
1288
|
+
# resp = client.create_predictor_backtest_export_job({
|
1289
|
+
# predictor_backtest_export_job_name: "Name", # required
|
1290
|
+
# predictor_arn: "Arn", # required
|
1291
|
+
# destination: { # required
|
1292
|
+
# s3_config: { # required
|
1293
|
+
# path: "S3Path", # required
|
1294
|
+
# role_arn: "Arn", # required
|
1295
|
+
# kms_key_arn: "KMSKeyArn",
|
1296
|
+
# },
|
1297
|
+
# },
|
1298
|
+
# tags: [
|
1299
|
+
# {
|
1300
|
+
# key: "TagKey", # required
|
1301
|
+
# value: "TagValue", # required
|
1302
|
+
# },
|
1303
|
+
# ],
|
1304
|
+
# })
|
1305
|
+
#
|
1306
|
+
# @example Response structure
|
1307
|
+
#
|
1308
|
+
# resp.predictor_backtest_export_job_arn #=> String
|
1309
|
+
#
|
1310
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/CreatePredictorBacktestExportJob AWS API Documentation
|
1311
|
+
#
|
1312
|
+
# @overload create_predictor_backtest_export_job(params = {})
|
1313
|
+
# @param [Hash] params ({})
|
1314
|
+
def create_predictor_backtest_export_job(params = {}, options = {})
|
1315
|
+
req = build_request(:create_predictor_backtest_export_job, params)
|
1316
|
+
req.send_request(options)
|
1317
|
+
end
|
1318
|
+
|
1208
1319
|
# Deletes an Amazon Forecast dataset that was created using the
|
1209
1320
|
# CreateDataset operation. You can only delete datasets that have a
|
1210
1321
|
# status of `ACTIVE` or `CREATE_FAILED`. To get the status use the
|
@@ -1367,6 +1478,29 @@ module Aws::ForecastService
|
|
1367
1478
|
req.send_request(options)
|
1368
1479
|
end
|
1369
1480
|
|
1481
|
+
# Deletes a predictor backtest export job.
|
1482
|
+
#
|
1483
|
+
# @option params [required, String] :predictor_backtest_export_job_arn
|
1484
|
+
# The Amazon Resource Name (ARN) of the predictor backtest export job to
|
1485
|
+
# delete.
|
1486
|
+
#
|
1487
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
1488
|
+
#
|
1489
|
+
# @example Request syntax with placeholder values
|
1490
|
+
#
|
1491
|
+
# resp = client.delete_predictor_backtest_export_job({
|
1492
|
+
# predictor_backtest_export_job_arn: "Arn", # required
|
1493
|
+
# })
|
1494
|
+
#
|
1495
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/DeletePredictorBacktestExportJob AWS API Documentation
|
1496
|
+
#
|
1497
|
+
# @overload delete_predictor_backtest_export_job(params = {})
|
1498
|
+
# @param [Hash] params ({})
|
1499
|
+
def delete_predictor_backtest_export_job(params = {}, options = {})
|
1500
|
+
req = build_request(:delete_predictor_backtest_export_job, params)
|
1501
|
+
req.send_request(options)
|
1502
|
+
end
|
1503
|
+
|
1370
1504
|
# Describes an Amazon Forecast dataset created using the CreateDataset
|
1371
1505
|
# operation.
|
1372
1506
|
#
|
@@ -1701,6 +1835,7 @@ module Aws::ForecastService
|
|
1701
1835
|
# * {Types::DescribePredictorResponse#predictor_name #predictor_name} => String
|
1702
1836
|
# * {Types::DescribePredictorResponse#algorithm_arn #algorithm_arn} => String
|
1703
1837
|
# * {Types::DescribePredictorResponse#forecast_horizon #forecast_horizon} => Integer
|
1838
|
+
# * {Types::DescribePredictorResponse#forecast_types #forecast_types} => Array<String>
|
1704
1839
|
# * {Types::DescribePredictorResponse#perform_auto_ml #perform_auto_ml} => Boolean
|
1705
1840
|
# * {Types::DescribePredictorResponse#perform_hpo #perform_hpo} => Boolean
|
1706
1841
|
# * {Types::DescribePredictorResponse#training_parameters #training_parameters} => Hash<String,String>
|
@@ -1729,6 +1864,8 @@ module Aws::ForecastService
|
|
1729
1864
|
# resp.predictor_name #=> String
|
1730
1865
|
# resp.algorithm_arn #=> String
|
1731
1866
|
# resp.forecast_horizon #=> Integer
|
1867
|
+
# resp.forecast_types #=> Array
|
1868
|
+
# resp.forecast_types[0] #=> String
|
1732
1869
|
# resp.perform_auto_ml #=> Boolean
|
1733
1870
|
# resp.perform_hpo #=> Boolean
|
1734
1871
|
# resp.training_parameters #=> Hash
|
@@ -1789,10 +1926,67 @@ module Aws::ForecastService
|
|
1789
1926
|
req.send_request(options)
|
1790
1927
|
end
|
1791
1928
|
|
1929
|
+
# Describes a predictor backtest export job created using the
|
1930
|
+
# CreatePredictorBacktestExportJob operation.
|
1931
|
+
#
|
1932
|
+
# In addition to listing the properties provided by the user in the
|
1933
|
+
# `CreatePredictorBacktestExportJob` request, this operation lists the
|
1934
|
+
# following properties:
|
1935
|
+
#
|
1936
|
+
# * `CreationTime`
|
1937
|
+
#
|
1938
|
+
# * `LastModificationTime`
|
1939
|
+
#
|
1940
|
+
# * `Status`
|
1941
|
+
#
|
1942
|
+
# * `Message` (if an error occurred)
|
1943
|
+
#
|
1944
|
+
# @option params [required, String] :predictor_backtest_export_job_arn
|
1945
|
+
# The Amazon Resource Name (ARN) of the predictor backtest export job.
|
1946
|
+
#
|
1947
|
+
# @return [Types::DescribePredictorBacktestExportJobResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1948
|
+
#
|
1949
|
+
# * {Types::DescribePredictorBacktestExportJobResponse#predictor_backtest_export_job_arn #predictor_backtest_export_job_arn} => String
|
1950
|
+
# * {Types::DescribePredictorBacktestExportJobResponse#predictor_backtest_export_job_name #predictor_backtest_export_job_name} => String
|
1951
|
+
# * {Types::DescribePredictorBacktestExportJobResponse#predictor_arn #predictor_arn} => String
|
1952
|
+
# * {Types::DescribePredictorBacktestExportJobResponse#destination #destination} => Types::DataDestination
|
1953
|
+
# * {Types::DescribePredictorBacktestExportJobResponse#message #message} => String
|
1954
|
+
# * {Types::DescribePredictorBacktestExportJobResponse#status #status} => String
|
1955
|
+
# * {Types::DescribePredictorBacktestExportJobResponse#creation_time #creation_time} => Time
|
1956
|
+
# * {Types::DescribePredictorBacktestExportJobResponse#last_modification_time #last_modification_time} => Time
|
1957
|
+
#
|
1958
|
+
# @example Request syntax with placeholder values
|
1959
|
+
#
|
1960
|
+
# resp = client.describe_predictor_backtest_export_job({
|
1961
|
+
# predictor_backtest_export_job_arn: "Arn", # required
|
1962
|
+
# })
|
1963
|
+
#
|
1964
|
+
# @example Response structure
|
1965
|
+
#
|
1966
|
+
# resp.predictor_backtest_export_job_arn #=> String
|
1967
|
+
# resp.predictor_backtest_export_job_name #=> String
|
1968
|
+
# resp.predictor_arn #=> String
|
1969
|
+
# resp.destination.s3_config.path #=> String
|
1970
|
+
# resp.destination.s3_config.role_arn #=> String
|
1971
|
+
# resp.destination.s3_config.kms_key_arn #=> String
|
1972
|
+
# resp.message #=> String
|
1973
|
+
# resp.status #=> String
|
1974
|
+
# resp.creation_time #=> Time
|
1975
|
+
# resp.last_modification_time #=> Time
|
1976
|
+
#
|
1977
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/DescribePredictorBacktestExportJob AWS API Documentation
|
1978
|
+
#
|
1979
|
+
# @overload describe_predictor_backtest_export_job(params = {})
|
1980
|
+
# @param [Hash] params ({})
|
1981
|
+
def describe_predictor_backtest_export_job(params = {}, options = {})
|
1982
|
+
req = build_request(:describe_predictor_backtest_export_job, params)
|
1983
|
+
req.send_request(options)
|
1984
|
+
end
|
1985
|
+
|
1792
1986
|
# Provides metrics on the accuracy of the models that were trained by
|
1793
1987
|
# the CreatePredictor operation. Use metrics to see how well the model
|
1794
1988
|
# performed and to decide whether to use the predictor to generate a
|
1795
|
-
# forecast. For more information, see
|
1989
|
+
# forecast. For more information, see [Predictor Metrics][1].
|
1796
1990
|
#
|
1797
1991
|
# This operation generates metrics for each backtest window that was
|
1798
1992
|
# evaluated. The number of backtest windows (`NumberOfBacktestWindows`)
|
@@ -1813,6 +2007,10 @@ module Aws::ForecastService
|
|
1813
2007
|
#
|
1814
2008
|
# </note>
|
1815
2009
|
#
|
2010
|
+
#
|
2011
|
+
#
|
2012
|
+
# [1]: https://docs.aws.amazon.com/forecast/latest/dg/metrics.html
|
2013
|
+
#
|
1816
2014
|
# @option params [required, String] :predictor_arn
|
1817
2015
|
# The Amazon Resource Name (ARN) of the predictor to get metrics for.
|
1818
2016
|
#
|
@@ -1839,6 +2037,10 @@ module Aws::ForecastService
|
|
1839
2037
|
# resp.predictor_evaluation_results[0].test_windows[0].metrics.weighted_quantile_losses #=> Array
|
1840
2038
|
# resp.predictor_evaluation_results[0].test_windows[0].metrics.weighted_quantile_losses[0].quantile #=> Float
|
1841
2039
|
# resp.predictor_evaluation_results[0].test_windows[0].metrics.weighted_quantile_losses[0].loss_value #=> Float
|
2040
|
+
# resp.predictor_evaluation_results[0].test_windows[0].metrics.error_metrics #=> Array
|
2041
|
+
# resp.predictor_evaluation_results[0].test_windows[0].metrics.error_metrics[0].forecast_type #=> String
|
2042
|
+
# resp.predictor_evaluation_results[0].test_windows[0].metrics.error_metrics[0].wape #=> Float
|
2043
|
+
# resp.predictor_evaluation_results[0].test_windows[0].metrics.error_metrics[0].rmse #=> Float
|
1842
2044
|
#
|
1843
2045
|
# @see http://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/GetAccuracyMetrics AWS API Documentation
|
1844
2046
|
#
|
@@ -2191,6 +2393,86 @@ module Aws::ForecastService
|
|
2191
2393
|
req.send_request(options)
|
2192
2394
|
end
|
2193
2395
|
|
2396
|
+
# Returns a list of predictor backtest export jobs created using the
|
2397
|
+
# CreatePredictorBacktestExportJob operation. This operation returns a
|
2398
|
+
# summary for each backtest export job. You can filter the list using an
|
2399
|
+
# array of Filter objects.
|
2400
|
+
#
|
2401
|
+
# To retrieve the complete set of properties for a particular backtest
|
2402
|
+
# export job, use the ARN with the DescribePredictorBacktestExportJob
|
2403
|
+
# operation.
|
2404
|
+
#
|
2405
|
+
# @option params [String] :next_token
|
2406
|
+
# If the result of the previous request was truncated, the response
|
2407
|
+
# includes a NextToken. To retrieve the next set of results, use the
|
2408
|
+
# token in the next request. Tokens expire after 24 hours.
|
2409
|
+
#
|
2410
|
+
# @option params [Integer] :max_results
|
2411
|
+
# The number of items to return in the response.
|
2412
|
+
#
|
2413
|
+
# @option params [Array<Types::Filter>] :filters
|
2414
|
+
# An array of filters. For each filter, provide a condition and a match
|
2415
|
+
# statement. The condition is either `IS` or `IS_NOT`, which specifies
|
2416
|
+
# whether to include or exclude the predictor backtest export jobs that
|
2417
|
+
# match the statement from the list. The match statement consists of a
|
2418
|
+
# key and a value.
|
2419
|
+
#
|
2420
|
+
# **Filter properties**
|
2421
|
+
#
|
2422
|
+
# * `Condition` - The condition to apply. Valid values are `IS` and
|
2423
|
+
# `IS_NOT`. To include the predictor backtest export jobs that match
|
2424
|
+
# the statement, specify `IS`. To exclude matching predictor backtest
|
2425
|
+
# export jobs, specify `IS_NOT`.
|
2426
|
+
#
|
2427
|
+
# * `Key` - The name of the parameter to filter on. Valid values are
|
2428
|
+
# `PredictorBacktestExportJobArn` and `Status`.
|
2429
|
+
#
|
2430
|
+
# * `Value` - The value to match.
|
2431
|
+
#
|
2432
|
+
# @return [Types::ListPredictorBacktestExportJobsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2433
|
+
#
|
2434
|
+
# * {Types::ListPredictorBacktestExportJobsResponse#predictor_backtest_export_jobs #predictor_backtest_export_jobs} => Array<Types::PredictorBacktestExportJobSummary>
|
2435
|
+
# * {Types::ListPredictorBacktestExportJobsResponse#next_token #next_token} => String
|
2436
|
+
#
|
2437
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
2438
|
+
#
|
2439
|
+
# @example Request syntax with placeholder values
|
2440
|
+
#
|
2441
|
+
# resp = client.list_predictor_backtest_export_jobs({
|
2442
|
+
# next_token: "NextToken",
|
2443
|
+
# max_results: 1,
|
2444
|
+
# filters: [
|
2445
|
+
# {
|
2446
|
+
# key: "String", # required
|
2447
|
+
# value: "Arn", # required
|
2448
|
+
# condition: "IS", # required, accepts IS, IS_NOT
|
2449
|
+
# },
|
2450
|
+
# ],
|
2451
|
+
# })
|
2452
|
+
#
|
2453
|
+
# @example Response structure
|
2454
|
+
#
|
2455
|
+
# resp.predictor_backtest_export_jobs #=> Array
|
2456
|
+
# resp.predictor_backtest_export_jobs[0].predictor_backtest_export_job_arn #=> String
|
2457
|
+
# resp.predictor_backtest_export_jobs[0].predictor_backtest_export_job_name #=> String
|
2458
|
+
# resp.predictor_backtest_export_jobs[0].destination.s3_config.path #=> String
|
2459
|
+
# resp.predictor_backtest_export_jobs[0].destination.s3_config.role_arn #=> String
|
2460
|
+
# resp.predictor_backtest_export_jobs[0].destination.s3_config.kms_key_arn #=> String
|
2461
|
+
# resp.predictor_backtest_export_jobs[0].status #=> String
|
2462
|
+
# resp.predictor_backtest_export_jobs[0].message #=> String
|
2463
|
+
# resp.predictor_backtest_export_jobs[0].creation_time #=> Time
|
2464
|
+
# resp.predictor_backtest_export_jobs[0].last_modification_time #=> Time
|
2465
|
+
# resp.next_token #=> String
|
2466
|
+
#
|
2467
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/ListPredictorBacktestExportJobs AWS API Documentation
|
2468
|
+
#
|
2469
|
+
# @overload list_predictor_backtest_export_jobs(params = {})
|
2470
|
+
# @param [Hash] params ({})
|
2471
|
+
def list_predictor_backtest_export_jobs(params = {}, options = {})
|
2472
|
+
req = build_request(:list_predictor_backtest_export_jobs, params)
|
2473
|
+
req.send_request(options)
|
2474
|
+
end
|
2475
|
+
|
2194
2476
|
# Returns a list of predictors created using the CreatePredictor
|
2195
2477
|
# operation. For each predictor, this operation returns a summary of its
|
2196
2478
|
# properties, including its Amazon Resource Name (ARN). You can retrieve
|
@@ -2444,7 +2726,7 @@ module Aws::ForecastService
|
|
2444
2726
|
params: params,
|
2445
2727
|
config: config)
|
2446
2728
|
context[:gem_name] = 'aws-sdk-forecastservice'
|
2447
|
-
context[:gem_version] = '1.
|
2729
|
+
context[:gem_version] = '1.13.0'
|
2448
2730
|
Seahorse::Client::Request.new(handlers, context)
|
2449
2731
|
end
|
2450
2732
|
|