aws-sdk-forecastservice 1.28.0 → 1.32.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 +20 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-forecastservice/client.rb +57 -39
- data/lib/aws-sdk-forecastservice/client_api.rb +1 -0
- data/lib/aws-sdk-forecastservice/types.rb +70 -35
- 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: 7e245b4c1d6539d5a964dc49bf9b24b14ade9dc5265421f65b9c246f655b64ed
|
4
|
+
data.tar.gz: 9d94f6185b48c5aa5d7a973a8ba4f1ca3682304bfef3dc4ff43d06d00f3cb7d2
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 1abb5313f9bc5923bd53a15fb052a4093e55ec577399b405d1a71177c6de76caebbb2fc47f7efcfa02ce9bc34edf31b0b1647c16af24253522761bd21d8f1290
|
7
|
+
data.tar.gz: 55c27977f637e3368413e421c395d81da2510984b425bae6b25e534ff75c9a50dbd03f352dc5ae6e9951dcf54298b7bb47f3a2380d3ad6cfa22797ae1fcce2a9
|
data/CHANGELOG.md
CHANGED
@@ -1,6 +1,26 @@
|
|
1
1
|
Unreleased Changes
|
2
2
|
------------------
|
3
3
|
|
4
|
+
1.32.0 (2022-02-03)
|
5
|
+
------------------
|
6
|
+
|
7
|
+
* Feature - Code Generated Changes, see `./build_tools` or `aws-sdk-core`'s CHANGELOG.md for details.
|
8
|
+
|
9
|
+
1.31.0 (2021-12-21)
|
10
|
+
------------------
|
11
|
+
|
12
|
+
* Feature - Code Generated Changes, see `./build_tools` or `aws-sdk-core`'s CHANGELOG.md for details.
|
13
|
+
|
14
|
+
1.30.0 (2021-12-20)
|
15
|
+
------------------
|
16
|
+
|
17
|
+
* Feature - Adds ForecastDimensions field to the DescribeAutoPredictorResponse
|
18
|
+
|
19
|
+
1.29.0 (2021-11-30)
|
20
|
+
------------------
|
21
|
+
|
22
|
+
* Feature - Code Generated Changes, see `./build_tools` or `aws-sdk-core`'s CHANGELOG.md for details.
|
23
|
+
|
4
24
|
1.28.0 (2021-11-18)
|
5
25
|
------------------
|
6
26
|
|
data/VERSION
CHANGED
@@ -1 +1 @@
|
|
1
|
-
1.
|
1
|
+
1.32.0
|
@@ -27,6 +27,8 @@ require 'aws-sdk-core/plugins/client_metrics_plugin.rb'
|
|
27
27
|
require 'aws-sdk-core/plugins/client_metrics_send_plugin.rb'
|
28
28
|
require 'aws-sdk-core/plugins/transfer_encoding.rb'
|
29
29
|
require 'aws-sdk-core/plugins/http_checksum.rb'
|
30
|
+
require 'aws-sdk-core/plugins/defaults_mode.rb'
|
31
|
+
require 'aws-sdk-core/plugins/recursion_detection.rb'
|
30
32
|
require 'aws-sdk-core/plugins/signature_v4.rb'
|
31
33
|
require 'aws-sdk-core/plugins/protocols/json_rpc.rb'
|
32
34
|
|
@@ -73,6 +75,8 @@ module Aws::ForecastService
|
|
73
75
|
add_plugin(Aws::Plugins::ClientMetricsSendPlugin)
|
74
76
|
add_plugin(Aws::Plugins::TransferEncoding)
|
75
77
|
add_plugin(Aws::Plugins::HttpChecksum)
|
78
|
+
add_plugin(Aws::Plugins::DefaultsMode)
|
79
|
+
add_plugin(Aws::Plugins::RecursionDetection)
|
76
80
|
add_plugin(Aws::Plugins::SignatureV4)
|
77
81
|
add_plugin(Aws::Plugins::Protocols::JsonRpc)
|
78
82
|
|
@@ -119,7 +123,9 @@ module Aws::ForecastService
|
|
119
123
|
# * EC2/ECS IMDS instance profile - When used by default, the timeouts
|
120
124
|
# are very aggressive. Construct and pass an instance of
|
121
125
|
# `Aws::InstanceProfileCredentails` or `Aws::ECSCredentials` to
|
122
|
-
# enable retries and extended timeouts.
|
126
|
+
# enable retries and extended timeouts. Instance profile credential
|
127
|
+
# fetching can be disabled by setting ENV['AWS_EC2_METADATA_DISABLED']
|
128
|
+
# to true.
|
123
129
|
#
|
124
130
|
# @option options [required, String] :region
|
125
131
|
# The AWS region to connect to. The configured `:region` is
|
@@ -173,6 +179,10 @@ module Aws::ForecastService
|
|
173
179
|
# Used only in `standard` and adaptive retry modes. Specifies whether to apply
|
174
180
|
# a clock skew correction and retry requests with skewed client clocks.
|
175
181
|
#
|
182
|
+
# @option options [String] :defaults_mode ("legacy")
|
183
|
+
# See {Aws::DefaultsModeConfiguration} for a list of the
|
184
|
+
# accepted modes and the configuration defaults that are included.
|
185
|
+
#
|
176
186
|
# @option options [Boolean] :disable_host_prefix_injection (false)
|
177
187
|
# Set to true to disable SDK automatically adding host prefix
|
178
188
|
# to default service endpoint when available.
|
@@ -305,7 +315,7 @@ module Aws::ForecastService
|
|
305
315
|
# seconds to wait when opening a HTTP session before raising a
|
306
316
|
# `Timeout::Error`.
|
307
317
|
#
|
308
|
-
# @option options [
|
318
|
+
# @option options [Float] :http_read_timeout (60) The default
|
309
319
|
# number of seconds to wait for response data. This value can
|
310
320
|
# safely be set per-request on the session.
|
311
321
|
#
|
@@ -321,6 +331,9 @@ module Aws::ForecastService
|
|
321
331
|
# disables this behaviour. This value can safely be set per
|
322
332
|
# request on the session.
|
323
333
|
#
|
334
|
+
# @option options [Float] :ssl_timeout (nil) Sets the SSL timeout
|
335
|
+
# in seconds.
|
336
|
+
#
|
324
337
|
# @option options [Boolean] :http_wire_trace (false) When `true`,
|
325
338
|
# HTTP debug output will be sent to the `:logger`.
|
326
339
|
#
|
@@ -442,6 +455,7 @@ module Aws::ForecastService
|
|
442
455
|
# The accuracy metric used to optimize the predictor.
|
443
456
|
#
|
444
457
|
# @option params [Boolean] :explain_predictor
|
458
|
+
# Create an Explainability resource for the predictor.
|
445
459
|
#
|
446
460
|
# @option params [Array<Types::Tag>] :tags
|
447
461
|
# Optional metadata to help you categorize and organize your predictors.
|
@@ -999,7 +1013,7 @@ module Aws::ForecastService
|
|
999
1013
|
#
|
1000
1014
|
# **CreateExplainability with a Forecast ARN**
|
1001
1015
|
#
|
1002
|
-
# <note markdown="1"> You can specify a maximum of 50 time series and
|
1016
|
+
# <note markdown="1"> You can specify a maximum of 50 time series and 500 time points.
|
1003
1017
|
#
|
1004
1018
|
# </note>
|
1005
1019
|
#
|
@@ -1041,14 +1055,12 @@ module Aws::ForecastService
|
|
1041
1055
|
# and time points for the Explainability.
|
1042
1056
|
#
|
1043
1057
|
# @option params [Types::DataSource] :data_source
|
1044
|
-
# The source of your
|
1045
|
-
#
|
1046
|
-
#
|
1047
|
-
# is submitted in the CreateDatasetImportJob request.
|
1058
|
+
# The source of your data, an AWS Identity and Access Management (IAM)
|
1059
|
+
# role that allows Amazon Forecast to access the data and, optionally,
|
1060
|
+
# an AWS Key Management Service (KMS) key.
|
1048
1061
|
#
|
1049
1062
|
# @option params [Types::Schema] :schema
|
1050
|
-
# Defines the fields of a dataset.
|
1051
|
-
# CreateDataset request.
|
1063
|
+
# Defines the fields of a dataset.
|
1052
1064
|
#
|
1053
1065
|
# @option params [Boolean] :enable_visualization
|
1054
1066
|
# Create an Expainability visualization that is viewable within the AWS
|
@@ -1058,10 +1070,16 @@ module Aws::ForecastService
|
|
1058
1070
|
# If `TimePointGranularity` is set to `SPECIFIC`, define the first point
|
1059
1071
|
# for the Explainability.
|
1060
1072
|
#
|
1073
|
+
# Use the following timestamp format: yyyy-MM-ddTHH:mm:ss (example:
|
1074
|
+
# 2015-01-01T20:00:00)
|
1075
|
+
#
|
1061
1076
|
# @option params [String] :end_date_time
|
1062
1077
|
# If `TimePointGranularity` is set to `SPECIFIC`, define the last time
|
1063
1078
|
# point for the Explainability.
|
1064
1079
|
#
|
1080
|
+
# Use the following timestamp format: yyyy-MM-ddTHH:mm:ss (example:
|
1081
|
+
# 2015-01-01T20:00:00)
|
1082
|
+
#
|
1065
1083
|
# @option params [Array<Types::Tag>] :tags
|
1066
1084
|
# Optional metadata to help you categorize and organize your resources.
|
1067
1085
|
# Each tag consists of a key and an optional value, both of which you
|
@@ -1767,8 +1785,8 @@ module Aws::ForecastService
|
|
1767
1785
|
end
|
1768
1786
|
|
1769
1787
|
# Exports backtest forecasts and accuracy metrics generated by the
|
1770
|
-
# CreatePredictor
|
1771
|
-
# exported to your specified S3 bucket.
|
1788
|
+
# CreateAutoPredictor or CreatePredictor operations. Two folders
|
1789
|
+
# containing CSV files are exported to your specified S3 bucket.
|
1772
1790
|
#
|
1773
1791
|
# The export file names will match the following conventions:
|
1774
1792
|
#
|
@@ -1976,7 +1994,7 @@ module Aws::ForecastService
|
|
1976
1994
|
req.send_request(options)
|
1977
1995
|
end
|
1978
1996
|
|
1979
|
-
# Deletes an Explainability export
|
1997
|
+
# Deletes an Explainability export.
|
1980
1998
|
#
|
1981
1999
|
# @option params [required, String] :explainability_export_arn
|
1982
2000
|
# The Amazon Resource Name (ARN) of the Explainability export to delete.
|
@@ -2051,10 +2069,10 @@ module Aws::ForecastService
|
|
2051
2069
|
req.send_request(options)
|
2052
2070
|
end
|
2053
2071
|
|
2054
|
-
# Deletes a predictor created using the
|
2055
|
-
# can delete only predictor that have a
|
2056
|
-
# `CREATE_FAILED`. To get the status, use the
|
2057
|
-
# operation.
|
2072
|
+
# Deletes a predictor created using the DescribePredictor or
|
2073
|
+
# CreatePredictor operations. You can delete only predictor that have a
|
2074
|
+
# status of `ACTIVE` or `CREATE_FAILED`. To get the status, use the
|
2075
|
+
# DescribePredictor operation.
|
2058
2076
|
#
|
2059
2077
|
# @option params [required, String] :predictor_arn
|
2060
2078
|
# The Amazon Resource Name (ARN) of the predictor to delete.
|
@@ -2158,6 +2176,7 @@ module Aws::ForecastService
|
|
2158
2176
|
# * {Types::DescribeAutoPredictorResponse#forecast_horizon #forecast_horizon} => Integer
|
2159
2177
|
# * {Types::DescribeAutoPredictorResponse#forecast_types #forecast_types} => Array<String>
|
2160
2178
|
# * {Types::DescribeAutoPredictorResponse#forecast_frequency #forecast_frequency} => String
|
2179
|
+
# * {Types::DescribeAutoPredictorResponse#forecast_dimensions #forecast_dimensions} => Array<String>
|
2161
2180
|
# * {Types::DescribeAutoPredictorResponse#dataset_import_job_arns #dataset_import_job_arns} => Array<String>
|
2162
2181
|
# * {Types::DescribeAutoPredictorResponse#data_config #data_config} => Types::DataConfig
|
2163
2182
|
# * {Types::DescribeAutoPredictorResponse#encryption_config #encryption_config} => Types::EncryptionConfig
|
@@ -2184,6 +2203,8 @@ module Aws::ForecastService
|
|
2184
2203
|
# resp.forecast_types #=> Array
|
2185
2204
|
# resp.forecast_types[0] #=> String
|
2186
2205
|
# resp.forecast_frequency #=> String
|
2206
|
+
# resp.forecast_dimensions #=> Array
|
2207
|
+
# resp.forecast_dimensions[0] #=> String
|
2187
2208
|
# resp.dataset_import_job_arns #=> Array
|
2188
2209
|
# resp.dataset_import_job_arns[0] #=> String
|
2189
2210
|
# resp.data_config.dataset_group_arn #=> String
|
@@ -2645,9 +2666,6 @@ module Aws::ForecastService
|
|
2645
2666
|
# CreatePredictor. If you are not using a legacy predictor, use
|
2646
2667
|
# DescribeAutoPredictor.
|
2647
2668
|
#
|
2648
|
-
# To upgrade a legacy predictor to AutoPredictor, see Upgrading to
|
2649
|
-
# AutoPredictor.
|
2650
|
-
#
|
2651
2669
|
# </note>
|
2652
2670
|
#
|
2653
2671
|
# Describes a predictor created using the CreatePredictor operation.
|
@@ -3118,7 +3136,7 @@ module Aws::ForecastService
|
|
3118
3136
|
# `IS_NOT`.
|
3119
3137
|
#
|
3120
3138
|
# * `Key` - The name of the parameter to filter on. Valid values are
|
3121
|
-
# `
|
3139
|
+
# `ResourceArn` and `Status`.
|
3122
3140
|
#
|
3123
3141
|
# * `Value` - The value to match.
|
3124
3142
|
#
|
@@ -3193,7 +3211,7 @@ module Aws::ForecastService
|
|
3193
3211
|
# `IS_NOT`.
|
3194
3212
|
#
|
3195
3213
|
# * `Key` - The name of the parameter to filter on. Valid values are
|
3196
|
-
# `
|
3214
|
+
# `ResourceArn` and `Status`.
|
3197
3215
|
#
|
3198
3216
|
# * `Value` - The value to match.
|
3199
3217
|
#
|
@@ -3486,12 +3504,13 @@ module Aws::ForecastService
|
|
3486
3504
|
req.send_request(options)
|
3487
3505
|
end
|
3488
3506
|
|
3489
|
-
# Returns a list of predictors created using the
|
3490
|
-
#
|
3491
|
-
# properties, including its Amazon Resource Name (ARN).
|
3492
|
-
#
|
3493
|
-
#
|
3494
|
-
#
|
3507
|
+
# Returns a list of predictors created using the CreateAutoPredictor or
|
3508
|
+
# CreatePredictor operations. For each predictor, this operation returns
|
3509
|
+
# a summary of its properties, including its Amazon Resource Name (ARN).
|
3510
|
+
#
|
3511
|
+
# You can retrieve the complete set of properties by using the ARN with
|
3512
|
+
# the DescribeAutoPredictor and DescribePredictor operations. You can
|
3513
|
+
# filter the list using an array of Filter objects.
|
3495
3514
|
#
|
3496
3515
|
# @option params [String] :next_token
|
3497
3516
|
# If the result of the previous request was truncated, the response
|
@@ -3574,9 +3593,7 @@ module Aws::ForecastService
|
|
3574
3593
|
#
|
3575
3594
|
# @option params [required, String] :resource_arn
|
3576
3595
|
# The Amazon Resource Name (ARN) that identifies the resource for which
|
3577
|
-
# to list the tags.
|
3578
|
-
# dataset groups, datasets, dataset import jobs, predictors, forecasts,
|
3579
|
-
# and forecast export jobs.
|
3596
|
+
# to list the tags.
|
3580
3597
|
#
|
3581
3598
|
# @return [Types::ListTagsForResourceResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
3582
3599
|
#
|
@@ -3622,11 +3639,16 @@ module Aws::ForecastService
|
|
3622
3639
|
#
|
3623
3640
|
# * Predictor Backtest Export Job
|
3624
3641
|
#
|
3642
|
+
# * Explainability Job
|
3643
|
+
#
|
3644
|
+
# * Explainability Export Job
|
3645
|
+
#
|
3625
3646
|
# @option params [required, String] :resource_arn
|
3626
3647
|
# The Amazon Resource Name (ARN) that identifies the resource to stop.
|
3627
3648
|
# The supported ARNs are `DatasetImportJobArn`, `PredictorArn`,
|
3628
|
-
# `PredictorBacktestExportJobArn`, `ForecastArn`,
|
3629
|
-
# `ForecastExportJobArn
|
3649
|
+
# `PredictorBacktestExportJobArn`, `ForecastArn`,
|
3650
|
+
# `ForecastExportJobArn`, `ExplainabilityArn`, and
|
3651
|
+
# `ExplainabilityExportArn`.
|
3630
3652
|
#
|
3631
3653
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
3632
3654
|
#
|
@@ -3652,9 +3674,7 @@ module Aws::ForecastService
|
|
3652
3674
|
#
|
3653
3675
|
# @option params [required, String] :resource_arn
|
3654
3676
|
# The Amazon Resource Name (ARN) that identifies the resource for which
|
3655
|
-
# to list the tags.
|
3656
|
-
# dataset groups, datasets, dataset import jobs, predictors, forecasts,
|
3657
|
-
# and forecast export jobs.
|
3677
|
+
# to list the tags.
|
3658
3678
|
#
|
3659
3679
|
# @option params [required, Array<Types::Tag>] :tags
|
3660
3680
|
# The tags to add to the resource. A tag is an array of key-value pairs.
|
@@ -3713,9 +3733,7 @@ module Aws::ForecastService
|
|
3713
3733
|
#
|
3714
3734
|
# @option params [required, String] :resource_arn
|
3715
3735
|
# The Amazon Resource Name (ARN) that identifies the resource for which
|
3716
|
-
# to list the tags.
|
3717
|
-
# dataset groups, datasets, dataset import jobs, predictors, forecasts,
|
3718
|
-
# and forecast exports.
|
3736
|
+
# to list the tags.
|
3719
3737
|
#
|
3720
3738
|
# @option params [required, Array<String>] :tag_keys
|
3721
3739
|
# The keys of the tags to be removed.
|
@@ -3784,7 +3802,7 @@ module Aws::ForecastService
|
|
3784
3802
|
params: params,
|
3785
3803
|
config: config)
|
3786
3804
|
context[:gem_name] = 'aws-sdk-forecastservice'
|
3787
|
-
context[:gem_version] = '1.
|
3805
|
+
context[:gem_version] = '1.32.0'
|
3788
3806
|
Seahorse::Client::Request.new(handlers, context)
|
3789
3807
|
end
|
3790
3808
|
|
@@ -446,6 +446,7 @@ module Aws::ForecastService
|
|
446
446
|
DescribeAutoPredictorResponse.add_member(:forecast_horizon, Shapes::ShapeRef.new(shape: Integer, location_name: "ForecastHorizon"))
|
447
447
|
DescribeAutoPredictorResponse.add_member(:forecast_types, Shapes::ShapeRef.new(shape: ForecastTypes, location_name: "ForecastTypes"))
|
448
448
|
DescribeAutoPredictorResponse.add_member(:forecast_frequency, Shapes::ShapeRef.new(shape: Frequency, location_name: "ForecastFrequency"))
|
449
|
+
DescribeAutoPredictorResponse.add_member(:forecast_dimensions, Shapes::ShapeRef.new(shape: ForecastDimensions, location_name: "ForecastDimensions"))
|
449
450
|
DescribeAutoPredictorResponse.add_member(:dataset_import_job_arns, Shapes::ShapeRef.new(shape: ArnList, location_name: "DatasetImportJobArns"))
|
450
451
|
DescribeAutoPredictorResponse.add_member(:data_config, Shapes::ShapeRef.new(shape: DataConfig, location_name: "DataConfig"))
|
451
452
|
DescribeAutoPredictorResponse.add_member(:encryption_config, Shapes::ShapeRef.new(shape: EncryptionConfig, location_name: "EncryptionConfig"))
|
@@ -59,7 +59,7 @@ module Aws::ForecastService
|
|
59
59
|
#
|
60
60
|
# **Holidays**
|
61
61
|
#
|
62
|
-
# To enable Holidays,
|
62
|
+
# To enable Holidays, set `CountryCode` to one of the following
|
63
63
|
# two-letter country codes:
|
64
64
|
#
|
65
65
|
# * "AL" - ALBANIA
|
@@ -491,6 +491,7 @@ module Aws::ForecastService
|
|
491
491
|
# @return [String]
|
492
492
|
#
|
493
493
|
# @!attribute [rw] explain_predictor
|
494
|
+
# Create an Explainability resource for the predictor.
|
494
495
|
# @return [Boolean]
|
495
496
|
#
|
496
497
|
# @!attribute [rw] tags
|
@@ -1077,15 +1078,13 @@ module Aws::ForecastService
|
|
1077
1078
|
# @return [Types::ExplainabilityConfig]
|
1078
1079
|
#
|
1079
1080
|
# @!attribute [rw] data_source
|
1080
|
-
# The source of your
|
1081
|
-
#
|
1082
|
-
#
|
1083
|
-
# object is submitted in the CreateDatasetImportJob request.
|
1081
|
+
# The source of your data, an AWS Identity and Access Management (IAM)
|
1082
|
+
# role that allows Amazon Forecast to access the data and, optionally,
|
1083
|
+
# an AWS Key Management Service (KMS) key.
|
1084
1084
|
# @return [Types::DataSource]
|
1085
1085
|
#
|
1086
1086
|
# @!attribute [rw] schema
|
1087
|
-
# Defines the fields of a dataset.
|
1088
|
-
# CreateDataset request.
|
1087
|
+
# Defines the fields of a dataset.
|
1089
1088
|
# @return [Types::Schema]
|
1090
1089
|
#
|
1091
1090
|
# @!attribute [rw] enable_visualization
|
@@ -1096,11 +1095,17 @@ module Aws::ForecastService
|
|
1096
1095
|
# @!attribute [rw] start_date_time
|
1097
1096
|
# If `TimePointGranularity` is set to `SPECIFIC`, define the first
|
1098
1097
|
# point for the Explainability.
|
1098
|
+
#
|
1099
|
+
# Use the following timestamp format: yyyy-MM-ddTHH:mm:ss (example:
|
1100
|
+
# 2015-01-01T20:00:00)
|
1099
1101
|
# @return [String]
|
1100
1102
|
#
|
1101
1103
|
# @!attribute [rw] end_date_time
|
1102
1104
|
# If `TimePointGranularity` is set to `SPECIFIC`, define the last time
|
1103
1105
|
# point for the Explainability.
|
1106
|
+
#
|
1107
|
+
# Use the following timestamp format: yyyy-MM-ddTHH:mm:ss (example:
|
1108
|
+
# 2015-01-01T20:00:00)
|
1104
1109
|
# @return [String]
|
1105
1110
|
#
|
1106
1111
|
# @!attribute [rw] tags
|
@@ -1805,10 +1810,9 @@ module Aws::ForecastService
|
|
1805
1810
|
include Aws::Structure
|
1806
1811
|
end
|
1807
1812
|
|
1808
|
-
# The source of your
|
1809
|
-
#
|
1810
|
-
#
|
1811
|
-
# is submitted in the CreateDatasetImportJob request.
|
1813
|
+
# The source of your data, an AWS Identity and Access Management (IAM)
|
1814
|
+
# role that allows Amazon Forecast to access the data and, optionally,
|
1815
|
+
# an AWS Key Management Service (KMS) key.
|
1812
1816
|
#
|
1813
1817
|
# @note When making an API call, you may pass DataSource
|
1814
1818
|
# data as a hash:
|
@@ -1822,9 +1826,8 @@ module Aws::ForecastService
|
|
1822
1826
|
# }
|
1823
1827
|
#
|
1824
1828
|
# @!attribute [rw] s3_config
|
1825
|
-
# The path to the
|
1826
|
-
#
|
1827
|
-
# data.
|
1829
|
+
# The path to the data stored in an Amazon Simple Storage Service
|
1830
|
+
# (Amazon S3) bucket along with the credentials to access the data.
|
1828
1831
|
# @return [Types::S3Config]
|
1829
1832
|
#
|
1830
1833
|
# @see http://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/DataSource AWS API Documentation
|
@@ -2227,6 +2230,11 @@ module Aws::ForecastService
|
|
2227
2230
|
# every year and "5min" indicates every five minutes.
|
2228
2231
|
# @return [String]
|
2229
2232
|
#
|
2233
|
+
# @!attribute [rw] forecast_dimensions
|
2234
|
+
# An array of dimension (field) names that specify the attributes used
|
2235
|
+
# to group your time series.
|
2236
|
+
# @return [Array<String>]
|
2237
|
+
#
|
2230
2238
|
# @!attribute [rw] dataset_import_job_arns
|
2231
2239
|
# An array of the ARNs of the dataset import jobs used to import
|
2232
2240
|
# training data for the predictor.
|
@@ -2295,6 +2303,7 @@ module Aws::ForecastService
|
|
2295
2303
|
# @return [String]
|
2296
2304
|
#
|
2297
2305
|
# @!attribute [rw] explainability_info
|
2306
|
+
# Provides the status and ARN of the Predictor Explainability.
|
2298
2307
|
# @return [Types::ExplainabilityInfo]
|
2299
2308
|
#
|
2300
2309
|
# @see http://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/DescribeAutoPredictorResponse AWS API Documentation
|
@@ -2305,6 +2314,7 @@ module Aws::ForecastService
|
|
2305
2314
|
:forecast_horizon,
|
2306
2315
|
:forecast_types,
|
2307
2316
|
:forecast_frequency,
|
2317
|
+
:forecast_dimensions,
|
2308
2318
|
:dataset_import_job_arns,
|
2309
2319
|
:data_config,
|
2310
2320
|
:encryption_config,
|
@@ -2781,15 +2791,13 @@ module Aws::ForecastService
|
|
2781
2791
|
# @return [Boolean]
|
2782
2792
|
#
|
2783
2793
|
# @!attribute [rw] data_source
|
2784
|
-
# The source of your
|
2785
|
-
#
|
2786
|
-
#
|
2787
|
-
# object is submitted in the CreateDatasetImportJob request.
|
2794
|
+
# The source of your data, an AWS Identity and Access Management (IAM)
|
2795
|
+
# role that allows Amazon Forecast to access the data and, optionally,
|
2796
|
+
# an AWS Key Management Service (KMS) key.
|
2788
2797
|
# @return [Types::DataSource]
|
2789
2798
|
#
|
2790
2799
|
# @!attribute [rw] schema
|
2791
|
-
# Defines the fields of a dataset.
|
2792
|
-
# CreateDataset request.
|
2800
|
+
# Defines the fields of a dataset.
|
2793
2801
|
# @return [Types::Schema]
|
2794
2802
|
#
|
2795
2803
|
# @!attribute [rw] start_date_time
|
@@ -3593,10 +3601,22 @@ module Aws::ForecastService
|
|
3593
3601
|
include Aws::Structure
|
3594
3602
|
end
|
3595
3603
|
|
3604
|
+
# Provides information about the Explainability resource.
|
3605
|
+
#
|
3596
3606
|
# @!attribute [rw] explainability_arn
|
3607
|
+
# The Amazon Resource Name (ARN) of the Explainability.
|
3597
3608
|
# @return [String]
|
3598
3609
|
#
|
3599
3610
|
# @!attribute [rw] status
|
3611
|
+
# The status of the Explainability. States include:
|
3612
|
+
#
|
3613
|
+
# * `ACTIVE`
|
3614
|
+
#
|
3615
|
+
# * `CREATE_PENDING`, `CREATE_IN_PROGRESS`, `CREATE_FAILED`
|
3616
|
+
#
|
3617
|
+
# * `CREATE_STOPPING`, `CREATE_STOPPED`
|
3618
|
+
#
|
3619
|
+
# * `DELETE_PENDING`, `DELETE_IN_PROGRESS`, `DELETE_FAILED`
|
3600
3620
|
# @return [String]
|
3601
3621
|
#
|
3602
3622
|
# @see http://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/ExplainabilityInfo AWS API Documentation
|
@@ -3682,6 +3702,11 @@ module Aws::ForecastService
|
|
3682
3702
|
include Aws::Structure
|
3683
3703
|
end
|
3684
3704
|
|
3705
|
+
# <note markdown="1"> This object belongs to the CreatePredictor operation. If you created
|
3706
|
+
# your predictor with CreateAutoPredictor, see AttributeConfig.
|
3707
|
+
#
|
3708
|
+
# </note>
|
3709
|
+
#
|
3685
3710
|
# Provides featurization (transformation) information for a dataset
|
3686
3711
|
# field. This object is part of the FeaturizationConfig object.
|
3687
3712
|
#
|
@@ -3740,6 +3765,11 @@ module Aws::ForecastService
|
|
3740
3765
|
include Aws::Structure
|
3741
3766
|
end
|
3742
3767
|
|
3768
|
+
# <note markdown="1"> This object belongs to the CreatePredictor operation. If you created
|
3769
|
+
# your predictor with CreateAutoPredictor, see AttributeConfig.
|
3770
|
+
#
|
3771
|
+
# </note>
|
3772
|
+
#
|
3743
3773
|
# In a CreatePredictor operation, the specified algorithm trains a model
|
3744
3774
|
# using the specified dataset group. You can optionally tell the
|
3745
3775
|
# operation to modify data fields prior to training a model. These
|
@@ -4027,6 +4057,7 @@ module Aws::ForecastService
|
|
4027
4057
|
# @return [String]
|
4028
4058
|
#
|
4029
4059
|
# @!attribute [rw] created_using_auto_predictor
|
4060
|
+
# Whether the Forecast was created from an AutoPredictor.
|
4030
4061
|
# @return [Boolean]
|
4031
4062
|
#
|
4032
4063
|
# @!attribute [rw] dataset_group_arn
|
@@ -4203,6 +4234,11 @@ module Aws::ForecastService
|
|
4203
4234
|
include Aws::Structure
|
4204
4235
|
end
|
4205
4236
|
|
4237
|
+
# <note markdown="1"> This object belongs to the CreatePredictor operation. If you created
|
4238
|
+
# your predictor with CreateAutoPredictor, see DataConfig.
|
4239
|
+
#
|
4240
|
+
# </note>
|
4241
|
+
#
|
4206
4242
|
# The data used to train a predictor. The data includes a dataset group
|
4207
4243
|
# and any supplementary features. You specify this object in the
|
4208
4244
|
# CreatePredictor request.
|
@@ -4558,7 +4594,7 @@ module Aws::ForecastService
|
|
4558
4594
|
# `IS_NOT`.
|
4559
4595
|
#
|
4560
4596
|
# * `Key` - The name of the parameter to filter on. Valid values are
|
4561
|
-
# `
|
4597
|
+
# `ResourceArn` and `Status`.
|
4562
4598
|
#
|
4563
4599
|
# * `Value` - The value to match.
|
4564
4600
|
# @return [Array<Types::Filter>]
|
@@ -4630,7 +4666,7 @@ module Aws::ForecastService
|
|
4630
4666
|
# `IS_NOT`.
|
4631
4667
|
#
|
4632
4668
|
# * `Key` - The name of the parameter to filter on. Valid values are
|
4633
|
-
# `
|
4669
|
+
# `ResourceArn` and `Status`.
|
4634
4670
|
#
|
4635
4671
|
# * `Value` - The value to match.
|
4636
4672
|
# @return [Array<Types::Filter>]
|
@@ -4983,9 +5019,7 @@ module Aws::ForecastService
|
|
4983
5019
|
#
|
4984
5020
|
# @!attribute [rw] resource_arn
|
4985
5021
|
# The Amazon Resource Name (ARN) that identifies the resource for
|
4986
|
-
# which to list the tags.
|
4987
|
-
# Forecast dataset groups, datasets, dataset import jobs, predictors,
|
4988
|
-
# forecasts, and forecast export jobs.
|
5022
|
+
# which to list the tags.
|
4989
5023
|
# @return [String]
|
4990
5024
|
#
|
4991
5025
|
# @see http://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/ListTagsForResourceRequest AWS API Documentation
|
@@ -5403,8 +5437,7 @@ module Aws::ForecastService
|
|
5403
5437
|
include Aws::Structure
|
5404
5438
|
end
|
5405
5439
|
|
5406
|
-
# Defines the fields of a dataset.
|
5407
|
-
# CreateDataset request.
|
5440
|
+
# Defines the fields of a dataset.
|
5408
5441
|
#
|
5409
5442
|
# @note When making an API call, you may pass Schema
|
5410
5443
|
# data as a hash:
|
@@ -5550,8 +5583,9 @@ module Aws::ForecastService
|
|
5550
5583
|
# @!attribute [rw] resource_arn
|
5551
5584
|
# The Amazon Resource Name (ARN) that identifies the resource to stop.
|
5552
5585
|
# The supported ARNs are `DatasetImportJobArn`, `PredictorArn`,
|
5553
|
-
# `PredictorBacktestExportJobArn`, `ForecastArn`,
|
5554
|
-
# `ForecastExportJobArn
|
5586
|
+
# `PredictorBacktestExportJobArn`, `ForecastArn`,
|
5587
|
+
# `ForecastExportJobArn`, `ExplainabilityArn`, and
|
5588
|
+
# `ExplainabilityExportArn`.
|
5555
5589
|
# @return [String]
|
5556
5590
|
#
|
5557
5591
|
# @see http://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/StopResourceRequest AWS API Documentation
|
@@ -5562,6 +5596,11 @@ module Aws::ForecastService
|
|
5562
5596
|
include Aws::Structure
|
5563
5597
|
end
|
5564
5598
|
|
5599
|
+
# <note markdown="1"> This object belongs to the CreatePredictor operation. If you created
|
5600
|
+
# your predictor with CreateAutoPredictor, see AdditionalDataset.
|
5601
|
+
#
|
5602
|
+
# </note>
|
5603
|
+
#
|
5565
5604
|
# Describes a supplementary feature of a dataset group. This object is
|
5566
5605
|
# part of the InputDataConfig object. Forecast supports the Weather
|
5567
5606
|
# Index and Holidays built-in featurizations.
|
@@ -5826,9 +5865,7 @@ module Aws::ForecastService
|
|
5826
5865
|
#
|
5827
5866
|
# @!attribute [rw] resource_arn
|
5828
5867
|
# The Amazon Resource Name (ARN) that identifies the resource for
|
5829
|
-
# which to list the tags.
|
5830
|
-
# Forecast dataset groups, datasets, dataset import jobs, predictors,
|
5831
|
-
# forecasts, and forecast export jobs.
|
5868
|
+
# which to list the tags.
|
5832
5869
|
# @return [String]
|
5833
5870
|
#
|
5834
5871
|
# @!attribute [rw] tags
|
@@ -5922,9 +5959,7 @@ module Aws::ForecastService
|
|
5922
5959
|
#
|
5923
5960
|
# @!attribute [rw] resource_arn
|
5924
5961
|
# The Amazon Resource Name (ARN) that identifies the resource for
|
5925
|
-
# which to list the tags.
|
5926
|
-
# Forecast dataset groups, datasets, dataset import jobs, predictors,
|
5927
|
-
# forecasts, and forecast exports.
|
5962
|
+
# which to list the tags.
|
5928
5963
|
# @return [String]
|
5929
5964
|
#
|
5930
5965
|
# @!attribute [rw] tag_keys
|
metadata
CHANGED
@@ -1,14 +1,14 @@
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
2
2
|
name: aws-sdk-forecastservice
|
3
3
|
version: !ruby/object:Gem::Version
|
4
|
-
version: 1.
|
4
|
+
version: 1.32.0
|
5
5
|
platform: ruby
|
6
6
|
authors:
|
7
7
|
- Amazon Web Services
|
8
8
|
autorequire:
|
9
9
|
bindir: bin
|
10
10
|
cert_chain: []
|
11
|
-
date:
|
11
|
+
date: 2022-02-03 00:00:00.000000000 Z
|
12
12
|
dependencies:
|
13
13
|
- !ruby/object:Gem::Dependency
|
14
14
|
name: aws-sdk-core
|
@@ -19,7 +19,7 @@ dependencies:
|
|
19
19
|
version: '3'
|
20
20
|
- - ">="
|
21
21
|
- !ruby/object:Gem::Version
|
22
|
-
version: 3.
|
22
|
+
version: 3.126.0
|
23
23
|
type: :runtime
|
24
24
|
prerelease: false
|
25
25
|
version_requirements: !ruby/object:Gem::Requirement
|
@@ -29,7 +29,7 @@ dependencies:
|
|
29
29
|
version: '3'
|
30
30
|
- - ">="
|
31
31
|
- !ruby/object:Gem::Version
|
32
|
-
version: 3.
|
32
|
+
version: 3.126.0
|
33
33
|
- !ruby/object:Gem::Dependency
|
34
34
|
name: aws-sigv4
|
35
35
|
requirement: !ruby/object:Gem::Requirement
|