aws-sdk-forecastservice 1.0.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 +7 -0
- data/lib/aws-sdk-forecastservice.rb +47 -0
- data/lib/aws-sdk-forecastservice/client.rb +1953 -0
- data/lib/aws-sdk-forecastservice/client_api.rb +940 -0
- data/lib/aws-sdk-forecastservice/customizations.rb +0 -0
- data/lib/aws-sdk-forecastservice/errors.rb +110 -0
- data/lib/aws-sdk-forecastservice/resource.rb +23 -0
- data/lib/aws-sdk-forecastservice/types.rb +3005 -0
- metadata +88 -0
File without changes
|
@@ -0,0 +1,110 @@
|
|
1
|
+
# WARNING ABOUT GENERATED CODE
|
2
|
+
#
|
3
|
+
# This file is generated. See the contributing guide for more information:
|
4
|
+
# https://github.com/aws/aws-sdk-ruby/blob/master/CONTRIBUTING.md
|
5
|
+
#
|
6
|
+
# WARNING ABOUT GENERATED CODE
|
7
|
+
|
8
|
+
module Aws::ForecastService
|
9
|
+
module Errors
|
10
|
+
|
11
|
+
extend Aws::Errors::DynamicErrors
|
12
|
+
|
13
|
+
class InvalidInputException < ServiceError
|
14
|
+
|
15
|
+
# @param [Seahorse::Client::RequestContext] context
|
16
|
+
# @param [String] message
|
17
|
+
# @param [Aws::ForecastService::Types::InvalidInputException] data
|
18
|
+
def initialize(context, message, data = Aws::EmptyStructure.new)
|
19
|
+
super(context, message, data)
|
20
|
+
end
|
21
|
+
|
22
|
+
# @return [String]
|
23
|
+
def message
|
24
|
+
@message || @data[:message]
|
25
|
+
end
|
26
|
+
|
27
|
+
end
|
28
|
+
|
29
|
+
class InvalidNextTokenException < ServiceError
|
30
|
+
|
31
|
+
# @param [Seahorse::Client::RequestContext] context
|
32
|
+
# @param [String] message
|
33
|
+
# @param [Aws::ForecastService::Types::InvalidNextTokenException] data
|
34
|
+
def initialize(context, message, data = Aws::EmptyStructure.new)
|
35
|
+
super(context, message, data)
|
36
|
+
end
|
37
|
+
|
38
|
+
# @return [String]
|
39
|
+
def message
|
40
|
+
@message || @data[:message]
|
41
|
+
end
|
42
|
+
|
43
|
+
end
|
44
|
+
|
45
|
+
class LimitExceededException < ServiceError
|
46
|
+
|
47
|
+
# @param [Seahorse::Client::RequestContext] context
|
48
|
+
# @param [String] message
|
49
|
+
# @param [Aws::ForecastService::Types::LimitExceededException] data
|
50
|
+
def initialize(context, message, data = Aws::EmptyStructure.new)
|
51
|
+
super(context, message, data)
|
52
|
+
end
|
53
|
+
|
54
|
+
# @return [String]
|
55
|
+
def message
|
56
|
+
@message || @data[:message]
|
57
|
+
end
|
58
|
+
|
59
|
+
end
|
60
|
+
|
61
|
+
class ResourceAlreadyExistsException < ServiceError
|
62
|
+
|
63
|
+
# @param [Seahorse::Client::RequestContext] context
|
64
|
+
# @param [String] message
|
65
|
+
# @param [Aws::ForecastService::Types::ResourceAlreadyExistsException] data
|
66
|
+
def initialize(context, message, data = Aws::EmptyStructure.new)
|
67
|
+
super(context, message, data)
|
68
|
+
end
|
69
|
+
|
70
|
+
# @return [String]
|
71
|
+
def message
|
72
|
+
@message || @data[:message]
|
73
|
+
end
|
74
|
+
|
75
|
+
end
|
76
|
+
|
77
|
+
class ResourceInUseException < ServiceError
|
78
|
+
|
79
|
+
# @param [Seahorse::Client::RequestContext] context
|
80
|
+
# @param [String] message
|
81
|
+
# @param [Aws::ForecastService::Types::ResourceInUseException] data
|
82
|
+
def initialize(context, message, data = Aws::EmptyStructure.new)
|
83
|
+
super(context, message, data)
|
84
|
+
end
|
85
|
+
|
86
|
+
# @return [String]
|
87
|
+
def message
|
88
|
+
@message || @data[:message]
|
89
|
+
end
|
90
|
+
|
91
|
+
end
|
92
|
+
|
93
|
+
class ResourceNotFoundException < ServiceError
|
94
|
+
|
95
|
+
# @param [Seahorse::Client::RequestContext] context
|
96
|
+
# @param [String] message
|
97
|
+
# @param [Aws::ForecastService::Types::ResourceNotFoundException] data
|
98
|
+
def initialize(context, message, data = Aws::EmptyStructure.new)
|
99
|
+
super(context, message, data)
|
100
|
+
end
|
101
|
+
|
102
|
+
# @return [String]
|
103
|
+
def message
|
104
|
+
@message || @data[:message]
|
105
|
+
end
|
106
|
+
|
107
|
+
end
|
108
|
+
|
109
|
+
end
|
110
|
+
end
|
@@ -0,0 +1,23 @@
|
|
1
|
+
# WARNING ABOUT GENERATED CODE
|
2
|
+
#
|
3
|
+
# This file is generated. See the contributing guide for more information:
|
4
|
+
# https://github.com/aws/aws-sdk-ruby/blob/master/CONTRIBUTING.md
|
5
|
+
#
|
6
|
+
# WARNING ABOUT GENERATED CODE
|
7
|
+
|
8
|
+
module Aws::ForecastService
|
9
|
+
class Resource
|
10
|
+
|
11
|
+
# @param options ({})
|
12
|
+
# @option options [Client] :client
|
13
|
+
def initialize(options = {})
|
14
|
+
@client = options[:client] || Client.new(options)
|
15
|
+
end
|
16
|
+
|
17
|
+
# @return [Client]
|
18
|
+
def client
|
19
|
+
@client
|
20
|
+
end
|
21
|
+
|
22
|
+
end
|
23
|
+
end
|
@@ -0,0 +1,3005 @@
|
|
1
|
+
# WARNING ABOUT GENERATED CODE
|
2
|
+
#
|
3
|
+
# This file is generated. See the contributing guide for more information:
|
4
|
+
# https://github.com/aws/aws-sdk-ruby/blob/master/CONTRIBUTING.md
|
5
|
+
#
|
6
|
+
# WARNING ABOUT GENERATED CODE
|
7
|
+
|
8
|
+
module Aws::ForecastService
|
9
|
+
module Types
|
10
|
+
|
11
|
+
# Specifies a categorical hyperparameter and it's range of tunable
|
12
|
+
# values. This object is part of the ParameterRanges object.
|
13
|
+
#
|
14
|
+
# @note When making an API call, you may pass CategoricalParameterRange
|
15
|
+
# data as a hash:
|
16
|
+
#
|
17
|
+
# {
|
18
|
+
# name: "Name", # required
|
19
|
+
# values: ["Value"], # required
|
20
|
+
# }
|
21
|
+
#
|
22
|
+
# @!attribute [rw] name
|
23
|
+
# The name of the categorical hyperparameter to tune.
|
24
|
+
# @return [String]
|
25
|
+
#
|
26
|
+
# @!attribute [rw] values
|
27
|
+
# A list of the tunable categories for the hyperparameter.
|
28
|
+
# @return [Array<String>]
|
29
|
+
#
|
30
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/CategoricalParameterRange AWS API Documentation
|
31
|
+
#
|
32
|
+
class CategoricalParameterRange < Struct.new(
|
33
|
+
:name,
|
34
|
+
:values)
|
35
|
+
include Aws::Structure
|
36
|
+
end
|
37
|
+
|
38
|
+
# Specifies a continuous hyperparameter and it's range of tunable
|
39
|
+
# values. This object is part of the ParameterRanges object.
|
40
|
+
#
|
41
|
+
# @note When making an API call, you may pass ContinuousParameterRange
|
42
|
+
# data as a hash:
|
43
|
+
#
|
44
|
+
# {
|
45
|
+
# name: "Name", # required
|
46
|
+
# max_value: 1.0, # required
|
47
|
+
# min_value: 1.0, # required
|
48
|
+
# scaling_type: "Auto", # accepts Auto, Linear, Logarithmic, ReverseLogarithmic
|
49
|
+
# }
|
50
|
+
#
|
51
|
+
# @!attribute [rw] name
|
52
|
+
# The name of the hyperparameter to tune.
|
53
|
+
# @return [String]
|
54
|
+
#
|
55
|
+
# @!attribute [rw] max_value
|
56
|
+
# The maximum tunable value of the hyperparameter.
|
57
|
+
# @return [Float]
|
58
|
+
#
|
59
|
+
# @!attribute [rw] min_value
|
60
|
+
# The minimum tunable value of the hyperparameter.
|
61
|
+
# @return [Float]
|
62
|
+
#
|
63
|
+
# @!attribute [rw] scaling_type
|
64
|
+
# The scale that hyperparameter tuning uses to search the
|
65
|
+
# hyperparameter range. For information about choosing a
|
66
|
+
# hyperparameter scale, see [Hyperparameter Scaling][1]. One of the
|
67
|
+
# following values:
|
68
|
+
#
|
69
|
+
# Auto
|
70
|
+
#
|
71
|
+
# : Amazon Forecast hyperparameter tuning chooses the best scale for
|
72
|
+
# the hyperparameter.
|
73
|
+
#
|
74
|
+
# Linear
|
75
|
+
#
|
76
|
+
# : Hyperparameter tuning searches the values in the hyperparameter
|
77
|
+
# range by using a linear scale.
|
78
|
+
#
|
79
|
+
# Logarithmic
|
80
|
+
#
|
81
|
+
# : Hyperparameter tuning searches the values in the hyperparameter
|
82
|
+
# range by using a logarithmic scale.
|
83
|
+
#
|
84
|
+
# Logarithmic scaling works only for ranges that have only values
|
85
|
+
# greater than 0.
|
86
|
+
#
|
87
|
+
# ReverseLogarithmic
|
88
|
+
#
|
89
|
+
# : Hyperparemeter tuning searches the values in the hyperparameter
|
90
|
+
# range by using a reverse logarithmic scale.
|
91
|
+
#
|
92
|
+
# Reverse logarithmic scaling works only for ranges that are
|
93
|
+
# entirely within the range 0 <= x < 1.0.
|
94
|
+
#
|
95
|
+
#
|
96
|
+
#
|
97
|
+
# [1]: http://docs.aws.amazon.com/sagemaker/latest/dg/automatic-model-tuning-define-ranges.html#scaling-type
|
98
|
+
# @return [String]
|
99
|
+
#
|
100
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/ContinuousParameterRange AWS API Documentation
|
101
|
+
#
|
102
|
+
class ContinuousParameterRange < Struct.new(
|
103
|
+
:name,
|
104
|
+
:max_value,
|
105
|
+
:min_value,
|
106
|
+
:scaling_type)
|
107
|
+
include Aws::Structure
|
108
|
+
end
|
109
|
+
|
110
|
+
# @note When making an API call, you may pass CreateDatasetGroupRequest
|
111
|
+
# data as a hash:
|
112
|
+
#
|
113
|
+
# {
|
114
|
+
# dataset_group_name: "Name", # required
|
115
|
+
# domain: "RETAIL", # required, accepts RETAIL, CUSTOM, INVENTORY_PLANNING, EC2_CAPACITY, WORK_FORCE, WEB_TRAFFIC, METRICS
|
116
|
+
# dataset_arns: ["Arn"],
|
117
|
+
# }
|
118
|
+
#
|
119
|
+
# @!attribute [rw] dataset_group_name
|
120
|
+
# A name for the dataset group.
|
121
|
+
# @return [String]
|
122
|
+
#
|
123
|
+
# @!attribute [rw] domain
|
124
|
+
# The domain associated with the dataset group. The `Domain` and
|
125
|
+
# `DatasetType` that you choose determine the fields that must be
|
126
|
+
# present in the training data that you import to the dataset. For
|
127
|
+
# example, if you choose the `RETAIL` domain and `TARGET_TIME_SERIES`
|
128
|
+
# as the `DatasetType`, Amazon Forecast requires `item_id`,
|
129
|
+
# `timestamp`, and `demand` fields to be present in your data. For
|
130
|
+
# more information, see howitworks-datasets-groups.
|
131
|
+
# @return [String]
|
132
|
+
#
|
133
|
+
# @!attribute [rw] dataset_arns
|
134
|
+
# An array of Amazon Resource Names (ARNs) of the datasets that you
|
135
|
+
# want to include in the dataset group.
|
136
|
+
# @return [Array<String>]
|
137
|
+
#
|
138
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/CreateDatasetGroupRequest AWS API Documentation
|
139
|
+
#
|
140
|
+
class CreateDatasetGroupRequest < Struct.new(
|
141
|
+
:dataset_group_name,
|
142
|
+
:domain,
|
143
|
+
:dataset_arns)
|
144
|
+
include Aws::Structure
|
145
|
+
end
|
146
|
+
|
147
|
+
# @!attribute [rw] dataset_group_arn
|
148
|
+
# The Amazon Resource Name (ARN) of the dataset group.
|
149
|
+
# @return [String]
|
150
|
+
#
|
151
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/CreateDatasetGroupResponse AWS API Documentation
|
152
|
+
#
|
153
|
+
class CreateDatasetGroupResponse < Struct.new(
|
154
|
+
:dataset_group_arn)
|
155
|
+
include Aws::Structure
|
156
|
+
end
|
157
|
+
|
158
|
+
# @note When making an API call, you may pass CreateDatasetImportJobRequest
|
159
|
+
# data as a hash:
|
160
|
+
#
|
161
|
+
# {
|
162
|
+
# dataset_import_job_name: "Name", # required
|
163
|
+
# dataset_arn: "Arn", # required
|
164
|
+
# data_source: { # required
|
165
|
+
# s3_config: { # required
|
166
|
+
# path: "S3Path", # required
|
167
|
+
# role_arn: "Arn", # required
|
168
|
+
# kms_key_arn: "KMSKeyArn",
|
169
|
+
# },
|
170
|
+
# },
|
171
|
+
# timestamp_format: "TimestampFormat",
|
172
|
+
# }
|
173
|
+
#
|
174
|
+
# @!attribute [rw] dataset_import_job_name
|
175
|
+
# The name for the dataset import job. It is recommended to include
|
176
|
+
# the current timestamp in the name to guard against getting a
|
177
|
+
# `ResourceAlreadyExistsException` exception, for example,
|
178
|
+
# `20190721DatasetImport`.
|
179
|
+
# @return [String]
|
180
|
+
#
|
181
|
+
# @!attribute [rw] dataset_arn
|
182
|
+
# The Amazon Resource Name (ARN) of the Amazon Forecast dataset that
|
183
|
+
# you want to import data to.
|
184
|
+
# @return [String]
|
185
|
+
#
|
186
|
+
# @!attribute [rw] data_source
|
187
|
+
# The location of the training data to import and an AWS Identity and
|
188
|
+
# Access Management (IAM) role that Amazon Forecast can assume to
|
189
|
+
# access the data.
|
190
|
+
# @return [Types::DataSource]
|
191
|
+
#
|
192
|
+
# @!attribute [rw] timestamp_format
|
193
|
+
# The format of timestamps in the dataset. Two formats are supported,
|
194
|
+
# dependent on the `DataFrequency` specified when the dataset was
|
195
|
+
# created.
|
196
|
+
#
|
197
|
+
# * "yyyy-MM-dd"
|
198
|
+
#
|
199
|
+
# For data frequencies: Y, M, W, and D
|
200
|
+
#
|
201
|
+
# * "yyyy-MM-dd HH:mm:ss"
|
202
|
+
#
|
203
|
+
# For data frequencies: H, 30min, 15min, and 1min; and optionally,
|
204
|
+
# for: Y, M, W, and D
|
205
|
+
# @return [String]
|
206
|
+
#
|
207
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/CreateDatasetImportJobRequest AWS API Documentation
|
208
|
+
#
|
209
|
+
class CreateDatasetImportJobRequest < Struct.new(
|
210
|
+
:dataset_import_job_name,
|
211
|
+
:dataset_arn,
|
212
|
+
:data_source,
|
213
|
+
:timestamp_format)
|
214
|
+
include Aws::Structure
|
215
|
+
end
|
216
|
+
|
217
|
+
# @!attribute [rw] dataset_import_job_arn
|
218
|
+
# The Amazon Resource Name (ARN) of the dataset import job.
|
219
|
+
# @return [String]
|
220
|
+
#
|
221
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/CreateDatasetImportJobResponse AWS API Documentation
|
222
|
+
#
|
223
|
+
class CreateDatasetImportJobResponse < Struct.new(
|
224
|
+
:dataset_import_job_arn)
|
225
|
+
include Aws::Structure
|
226
|
+
end
|
227
|
+
|
228
|
+
# @note When making an API call, you may pass CreateDatasetRequest
|
229
|
+
# data as a hash:
|
230
|
+
#
|
231
|
+
# {
|
232
|
+
# dataset_name: "Name", # required
|
233
|
+
# domain: "RETAIL", # required, accepts RETAIL, CUSTOM, INVENTORY_PLANNING, EC2_CAPACITY, WORK_FORCE, WEB_TRAFFIC, METRICS
|
234
|
+
# dataset_type: "TARGET_TIME_SERIES", # required, accepts TARGET_TIME_SERIES, RELATED_TIME_SERIES, ITEM_METADATA
|
235
|
+
# data_frequency: "Frequency",
|
236
|
+
# schema: { # required
|
237
|
+
# attributes: [
|
238
|
+
# {
|
239
|
+
# attribute_name: "Name",
|
240
|
+
# attribute_type: "string", # accepts string, integer, float, timestamp
|
241
|
+
# },
|
242
|
+
# ],
|
243
|
+
# },
|
244
|
+
# encryption_config: {
|
245
|
+
# role_arn: "Arn", # required
|
246
|
+
# kms_key_arn: "KMSKeyArn", # required
|
247
|
+
# },
|
248
|
+
# }
|
249
|
+
#
|
250
|
+
# @!attribute [rw] dataset_name
|
251
|
+
# A name for the dataset.
|
252
|
+
# @return [String]
|
253
|
+
#
|
254
|
+
# @!attribute [rw] domain
|
255
|
+
# The domain associated with the dataset. The `Domain` and
|
256
|
+
# `DatasetType` that you choose determine the fields that must be
|
257
|
+
# present in the training data that you import to the dataset. For
|
258
|
+
# example, if you choose the `RETAIL` domain and `TARGET_TIME_SERIES`
|
259
|
+
# as the `DatasetType`, Amazon Forecast requires `item_id`,
|
260
|
+
# `timestamp`, and `demand` fields to be present in your data. For
|
261
|
+
# more information, see howitworks-datasets-groups.
|
262
|
+
# @return [String]
|
263
|
+
#
|
264
|
+
# @!attribute [rw] dataset_type
|
265
|
+
# The dataset type. Valid values depend on the chosen `Domain`.
|
266
|
+
# @return [String]
|
267
|
+
#
|
268
|
+
# @!attribute [rw] data_frequency
|
269
|
+
# The frequency of data collection.
|
270
|
+
#
|
271
|
+
# Valid intervals are Y (Year), M (Month), W (Week), D (Day), H
|
272
|
+
# (Hour), 30min (30 minutes), 15min (15 minutes), 10min (10 minutes),
|
273
|
+
# 5min (5 minutes), and 1min (1 minute). For example, "D" indicates
|
274
|
+
# every day and "15min" indicates every 15 minutes.
|
275
|
+
# @return [String]
|
276
|
+
#
|
277
|
+
# @!attribute [rw] schema
|
278
|
+
# The schema for the dataset. The schema attributes and their order
|
279
|
+
# must match the fields in your data. The dataset `Domain` and
|
280
|
+
# `DatasetType` that you choose determine the minimum required fields
|
281
|
+
# in your training data. For information about the required fields for
|
282
|
+
# a specific dataset domain and type, see howitworks-domains-ds-types.
|
283
|
+
# @return [Types::Schema]
|
284
|
+
#
|
285
|
+
# @!attribute [rw] encryption_config
|
286
|
+
# An AWS Key Management Service (KMS) key and the AWS Identity and
|
287
|
+
# Access Management (IAM) role that Amazon Forecast can assume to
|
288
|
+
# access the key.
|
289
|
+
# @return [Types::EncryptionConfig]
|
290
|
+
#
|
291
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/CreateDatasetRequest AWS API Documentation
|
292
|
+
#
|
293
|
+
class CreateDatasetRequest < Struct.new(
|
294
|
+
:dataset_name,
|
295
|
+
:domain,
|
296
|
+
:dataset_type,
|
297
|
+
:data_frequency,
|
298
|
+
:schema,
|
299
|
+
:encryption_config)
|
300
|
+
include Aws::Structure
|
301
|
+
end
|
302
|
+
|
303
|
+
# @!attribute [rw] dataset_arn
|
304
|
+
# The Amazon Resource Name (ARN) of the dataset.
|
305
|
+
# @return [String]
|
306
|
+
#
|
307
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/CreateDatasetResponse AWS API Documentation
|
308
|
+
#
|
309
|
+
class CreateDatasetResponse < Struct.new(
|
310
|
+
:dataset_arn)
|
311
|
+
include Aws::Structure
|
312
|
+
end
|
313
|
+
|
314
|
+
# @note When making an API call, you may pass CreateForecastExportJobRequest
|
315
|
+
# data as a hash:
|
316
|
+
#
|
317
|
+
# {
|
318
|
+
# forecast_export_job_name: "Name", # required
|
319
|
+
# forecast_arn: "Arn", # required
|
320
|
+
# destination: { # required
|
321
|
+
# s3_config: { # required
|
322
|
+
# path: "S3Path", # required
|
323
|
+
# role_arn: "Arn", # required
|
324
|
+
# kms_key_arn: "KMSKeyArn",
|
325
|
+
# },
|
326
|
+
# },
|
327
|
+
# }
|
328
|
+
#
|
329
|
+
# @!attribute [rw] forecast_export_job_name
|
330
|
+
# The name for the forecast export job.
|
331
|
+
# @return [String]
|
332
|
+
#
|
333
|
+
# @!attribute [rw] forecast_arn
|
334
|
+
# The Amazon Resource Name (ARN) of the forecast that you want to
|
335
|
+
# export.
|
336
|
+
# @return [String]
|
337
|
+
#
|
338
|
+
# @!attribute [rw] destination
|
339
|
+
# The path to the Amazon S3 bucket where you want to save the forecast
|
340
|
+
# and an AWS Identity and Access Management (IAM) role that Amazon
|
341
|
+
# Forecast can assume to access the bucket.
|
342
|
+
# @return [Types::DataDestination]
|
343
|
+
#
|
344
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/CreateForecastExportJobRequest AWS API Documentation
|
345
|
+
#
|
346
|
+
class CreateForecastExportJobRequest < Struct.new(
|
347
|
+
:forecast_export_job_name,
|
348
|
+
:forecast_arn,
|
349
|
+
:destination)
|
350
|
+
include Aws::Structure
|
351
|
+
end
|
352
|
+
|
353
|
+
# @!attribute [rw] forecast_export_job_arn
|
354
|
+
# The Amazon Resource Name (ARN) of the export job.
|
355
|
+
# @return [String]
|
356
|
+
#
|
357
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/CreateForecastExportJobResponse AWS API Documentation
|
358
|
+
#
|
359
|
+
class CreateForecastExportJobResponse < Struct.new(
|
360
|
+
:forecast_export_job_arn)
|
361
|
+
include Aws::Structure
|
362
|
+
end
|
363
|
+
|
364
|
+
# @note When making an API call, you may pass CreateForecastRequest
|
365
|
+
# data as a hash:
|
366
|
+
#
|
367
|
+
# {
|
368
|
+
# forecast_name: "Name", # required
|
369
|
+
# predictor_arn: "Arn", # required
|
370
|
+
# }
|
371
|
+
#
|
372
|
+
# @!attribute [rw] forecast_name
|
373
|
+
# The name for the forecast.
|
374
|
+
# @return [String]
|
375
|
+
#
|
376
|
+
# @!attribute [rw] predictor_arn
|
377
|
+
# The Amazon Resource Name (ARN) of the predictor to use to generate
|
378
|
+
# the forecast.
|
379
|
+
# @return [String]
|
380
|
+
#
|
381
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/CreateForecastRequest AWS API Documentation
|
382
|
+
#
|
383
|
+
class CreateForecastRequest < Struct.new(
|
384
|
+
:forecast_name,
|
385
|
+
:predictor_arn)
|
386
|
+
include Aws::Structure
|
387
|
+
end
|
388
|
+
|
389
|
+
# @!attribute [rw] forecast_arn
|
390
|
+
# The Amazon Resource Name (ARN) of the forecast.
|
391
|
+
# @return [String]
|
392
|
+
#
|
393
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/CreateForecastResponse AWS API Documentation
|
394
|
+
#
|
395
|
+
class CreateForecastResponse < Struct.new(
|
396
|
+
:forecast_arn)
|
397
|
+
include Aws::Structure
|
398
|
+
end
|
399
|
+
|
400
|
+
# @note When making an API call, you may pass CreatePredictorRequest
|
401
|
+
# data as a hash:
|
402
|
+
#
|
403
|
+
# {
|
404
|
+
# predictor_name: "Name", # required
|
405
|
+
# algorithm_arn: "Arn",
|
406
|
+
# forecast_horizon: 1, # required
|
407
|
+
# perform_auto_ml: false,
|
408
|
+
# perform_hpo: false,
|
409
|
+
# training_parameters: {
|
410
|
+
# "ParameterKey" => "ParameterValue",
|
411
|
+
# },
|
412
|
+
# evaluation_parameters: {
|
413
|
+
# number_of_backtest_windows: 1,
|
414
|
+
# back_test_window_offset: 1,
|
415
|
+
# },
|
416
|
+
# hpo_config: {
|
417
|
+
# parameter_ranges: {
|
418
|
+
# categorical_parameter_ranges: [
|
419
|
+
# {
|
420
|
+
# name: "Name", # required
|
421
|
+
# values: ["Value"], # required
|
422
|
+
# },
|
423
|
+
# ],
|
424
|
+
# continuous_parameter_ranges: [
|
425
|
+
# {
|
426
|
+
# name: "Name", # required
|
427
|
+
# max_value: 1.0, # required
|
428
|
+
# min_value: 1.0, # required
|
429
|
+
# scaling_type: "Auto", # accepts Auto, Linear, Logarithmic, ReverseLogarithmic
|
430
|
+
# },
|
431
|
+
# ],
|
432
|
+
# integer_parameter_ranges: [
|
433
|
+
# {
|
434
|
+
# name: "Name", # required
|
435
|
+
# max_value: 1, # required
|
436
|
+
# min_value: 1, # required
|
437
|
+
# scaling_type: "Auto", # accepts Auto, Linear, Logarithmic, ReverseLogarithmic
|
438
|
+
# },
|
439
|
+
# ],
|
440
|
+
# },
|
441
|
+
# },
|
442
|
+
# input_data_config: { # required
|
443
|
+
# dataset_group_arn: "Arn", # required
|
444
|
+
# supplementary_features: [
|
445
|
+
# {
|
446
|
+
# name: "Name", # required
|
447
|
+
# value: "Value", # required
|
448
|
+
# },
|
449
|
+
# ],
|
450
|
+
# },
|
451
|
+
# featurization_config: { # required
|
452
|
+
# forecast_frequency: "Frequency", # required
|
453
|
+
# forecast_dimensions: ["Name"],
|
454
|
+
# featurizations: [
|
455
|
+
# {
|
456
|
+
# attribute_name: "Name", # required
|
457
|
+
# featurization_pipeline: [
|
458
|
+
# {
|
459
|
+
# featurization_method_name: "filling", # required, accepts filling
|
460
|
+
# featurization_method_parameters: {
|
461
|
+
# "ParameterKey" => "ParameterValue",
|
462
|
+
# },
|
463
|
+
# },
|
464
|
+
# ],
|
465
|
+
# },
|
466
|
+
# ],
|
467
|
+
# },
|
468
|
+
# encryption_config: {
|
469
|
+
# role_arn: "Arn", # required
|
470
|
+
# kms_key_arn: "KMSKeyArn", # required
|
471
|
+
# },
|
472
|
+
# }
|
473
|
+
#
|
474
|
+
# @!attribute [rw] predictor_name
|
475
|
+
# A name for the predictor.
|
476
|
+
# @return [String]
|
477
|
+
#
|
478
|
+
# @!attribute [rw] algorithm_arn
|
479
|
+
# The Amazon Resource Name (ARN) of the algorithm to use for model
|
480
|
+
# training. Required if `PerformAutoML` is not set to `true`.
|
481
|
+
#
|
482
|
+
# **Supported algorithms**
|
483
|
+
#
|
484
|
+
# * `arn:aws:forecast:::algorithm/ARIMA`
|
485
|
+
#
|
486
|
+
# * `arn:aws:forecast:::algorithm/Deep_AR_Plus`
|
487
|
+
#
|
488
|
+
# `- supports hyperparameter optimization (HPO)`
|
489
|
+
#
|
490
|
+
# * `arn:aws:forecast:::algorithm/ETS`
|
491
|
+
#
|
492
|
+
# * `arn:aws:forecast:::algorithm/NPTS`
|
493
|
+
#
|
494
|
+
# * `arn:aws:forecast:::algorithm/Prophet`
|
495
|
+
# @return [String]
|
496
|
+
#
|
497
|
+
# @!attribute [rw] forecast_horizon
|
498
|
+
# Specifies the number of time-steps that the model is trained to
|
499
|
+
# predict. The forecast horizon is also called the prediction length.
|
500
|
+
#
|
501
|
+
# For example, if you configure a dataset for daily data collection
|
502
|
+
# (using the `DataFrequency` parameter of the CreateDataset operation)
|
503
|
+
# and set the forecast horizon to 10, the model returns predictions
|
504
|
+
# for 10 days.
|
505
|
+
# @return [Integer]
|
506
|
+
#
|
507
|
+
# @!attribute [rw] perform_auto_ml
|
508
|
+
# Whether to perform AutoML. The default value is `false`. In this
|
509
|
+
# case, you are required to specify an algorithm.
|
510
|
+
#
|
511
|
+
# If you want Amazon Forecast to evaluate the algorithms it provides
|
512
|
+
# and choose the best algorithm and configuration for your training
|
513
|
+
# dataset, set `PerformAutoML` to `true`. This is a good option if you
|
514
|
+
# aren't sure which algorithm is suitable for your application.
|
515
|
+
# @return [Boolean]
|
516
|
+
#
|
517
|
+
# @!attribute [rw] perform_hpo
|
518
|
+
# Whether to perform hyperparameter optimization (HPO). HPO finds
|
519
|
+
# optimal hyperparameter values for your training data. The process of
|
520
|
+
# performing HPO is known as a hyperparameter tuning job.
|
521
|
+
#
|
522
|
+
# The default value is `false`. In this case, Amazon Forecast uses
|
523
|
+
# default hyperparameter values from the chosen algorithm.
|
524
|
+
#
|
525
|
+
# To override the default values, set `PerformHPO` to `true` and
|
526
|
+
# supply the HyperParameterTuningJobConfig object. The tuning job
|
527
|
+
# specifies an objective metric, the hyperparameters to optimize, and
|
528
|
+
# the valid range for each hyperparameter.
|
529
|
+
#
|
530
|
+
# The following algorithms support HPO:
|
531
|
+
#
|
532
|
+
# * DeepAR+
|
533
|
+
#
|
534
|
+
# ^
|
535
|
+
# @return [Boolean]
|
536
|
+
#
|
537
|
+
# @!attribute [rw] training_parameters
|
538
|
+
# The training parameters to override for model training. The
|
539
|
+
# parameters that you can override are listed in the individual
|
540
|
+
# algorithms in aws-forecast-choosing-recipes.
|
541
|
+
# @return [Hash<String,String>]
|
542
|
+
#
|
543
|
+
# @!attribute [rw] evaluation_parameters
|
544
|
+
# Used to override the default evaluation parameters of the specified
|
545
|
+
# algorithm. Amazon Forecast evaluates a predictor by splitting a
|
546
|
+
# dataset into training data and testing data. The evaluation
|
547
|
+
# parameters define how to perform the split and the number of
|
548
|
+
# iterations.
|
549
|
+
# @return [Types::EvaluationParameters]
|
550
|
+
#
|
551
|
+
# @!attribute [rw] hpo_config
|
552
|
+
# Provides hyperparameter override values for the algorithm. If you
|
553
|
+
# don't provide this parameter, Amazon Forecast uses default values.
|
554
|
+
# The individual algorithms specify which hyperparameters support
|
555
|
+
# hyperparameter optimization (HPO). For more information, see
|
556
|
+
# aws-forecast-choosing-recipes.
|
557
|
+
# @return [Types::HyperParameterTuningJobConfig]
|
558
|
+
#
|
559
|
+
# @!attribute [rw] input_data_config
|
560
|
+
# Describes the dataset group that contains the data to use to train
|
561
|
+
# the predictor.
|
562
|
+
# @return [Types::InputDataConfig]
|
563
|
+
#
|
564
|
+
# @!attribute [rw] featurization_config
|
565
|
+
# The featurization configuration.
|
566
|
+
# @return [Types::FeaturizationConfig]
|
567
|
+
#
|
568
|
+
# @!attribute [rw] encryption_config
|
569
|
+
# An AWS Key Management Service (KMS) key and the AWS Identity and
|
570
|
+
# Access Management (IAM) role that Amazon Forecast can assume to
|
571
|
+
# access the key.
|
572
|
+
# @return [Types::EncryptionConfig]
|
573
|
+
#
|
574
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/CreatePredictorRequest AWS API Documentation
|
575
|
+
#
|
576
|
+
class CreatePredictorRequest < Struct.new(
|
577
|
+
:predictor_name,
|
578
|
+
:algorithm_arn,
|
579
|
+
:forecast_horizon,
|
580
|
+
:perform_auto_ml,
|
581
|
+
:perform_hpo,
|
582
|
+
:training_parameters,
|
583
|
+
:evaluation_parameters,
|
584
|
+
:hpo_config,
|
585
|
+
:input_data_config,
|
586
|
+
:featurization_config,
|
587
|
+
:encryption_config)
|
588
|
+
include Aws::Structure
|
589
|
+
end
|
590
|
+
|
591
|
+
# @!attribute [rw] predictor_arn
|
592
|
+
# The Amazon Resource Name (ARN) of the predictor.
|
593
|
+
# @return [String]
|
594
|
+
#
|
595
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/CreatePredictorResponse AWS API Documentation
|
596
|
+
#
|
597
|
+
class CreatePredictorResponse < Struct.new(
|
598
|
+
:predictor_arn)
|
599
|
+
include Aws::Structure
|
600
|
+
end
|
601
|
+
|
602
|
+
# The destination of an exported forecast and credentials to access the
|
603
|
+
# location. This object is submitted in the CreateForecastExportJob
|
604
|
+
# request.
|
605
|
+
#
|
606
|
+
# @note When making an API call, you may pass DataDestination
|
607
|
+
# data as a hash:
|
608
|
+
#
|
609
|
+
# {
|
610
|
+
# s3_config: { # required
|
611
|
+
# path: "S3Path", # required
|
612
|
+
# role_arn: "Arn", # required
|
613
|
+
# kms_key_arn: "KMSKeyArn",
|
614
|
+
# },
|
615
|
+
# }
|
616
|
+
#
|
617
|
+
# @!attribute [rw] s3_config
|
618
|
+
# The path to an Amazon Simple Storage Service (Amazon S3) bucket
|
619
|
+
# along with the credentials to access the bucket.
|
620
|
+
# @return [Types::S3Config]
|
621
|
+
#
|
622
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/DataDestination AWS API Documentation
|
623
|
+
#
|
624
|
+
class DataDestination < Struct.new(
|
625
|
+
:s3_config)
|
626
|
+
include Aws::Structure
|
627
|
+
end
|
628
|
+
|
629
|
+
# The source of your training data and credentials to access the data.
|
630
|
+
# This object is submitted in the CreateDatasetImportJob request.
|
631
|
+
#
|
632
|
+
# @note When making an API call, you may pass DataSource
|
633
|
+
# data as a hash:
|
634
|
+
#
|
635
|
+
# {
|
636
|
+
# s3_config: { # required
|
637
|
+
# path: "S3Path", # required
|
638
|
+
# role_arn: "Arn", # required
|
639
|
+
# kms_key_arn: "KMSKeyArn",
|
640
|
+
# },
|
641
|
+
# }
|
642
|
+
#
|
643
|
+
# @!attribute [rw] s3_config
|
644
|
+
# The path to the training data stored in an Amazon Simple Storage
|
645
|
+
# Service (Amazon S3) bucket along with the credentials to access the
|
646
|
+
# data.
|
647
|
+
# @return [Types::S3Config]
|
648
|
+
#
|
649
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/DataSource AWS API Documentation
|
650
|
+
#
|
651
|
+
class DataSource < Struct.new(
|
652
|
+
:s3_config)
|
653
|
+
include Aws::Structure
|
654
|
+
end
|
655
|
+
|
656
|
+
# Provides a summary of the dataset group properties used in the
|
657
|
+
# ListDatasetGroups operation. To get the complete set of properties,
|
658
|
+
# call the DescribeDatasetGroup operation, and provide the listed
|
659
|
+
# `DatasetGroupArn`.
|
660
|
+
#
|
661
|
+
# @!attribute [rw] dataset_group_arn
|
662
|
+
# The Amazon Resource Name (ARN) of the dataset group.
|
663
|
+
# @return [String]
|
664
|
+
#
|
665
|
+
# @!attribute [rw] dataset_group_name
|
666
|
+
# The name of the dataset group.
|
667
|
+
# @return [String]
|
668
|
+
#
|
669
|
+
# @!attribute [rw] creation_time
|
670
|
+
# When the datase group was created.
|
671
|
+
# @return [Time]
|
672
|
+
#
|
673
|
+
# @!attribute [rw] last_modification_time
|
674
|
+
# When the dataset group was created or last updated from a call to
|
675
|
+
# the UpdateDatasetGroup operation. While the dataset group is being
|
676
|
+
# updated, `LastModificationTime` is the current query time.
|
677
|
+
# @return [Time]
|
678
|
+
#
|
679
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/DatasetGroupSummary AWS API Documentation
|
680
|
+
#
|
681
|
+
class DatasetGroupSummary < Struct.new(
|
682
|
+
:dataset_group_arn,
|
683
|
+
:dataset_group_name,
|
684
|
+
:creation_time,
|
685
|
+
:last_modification_time)
|
686
|
+
include Aws::Structure
|
687
|
+
end
|
688
|
+
|
689
|
+
# Provides a summary of the dataset import job properties used in the
|
690
|
+
# ListDatasetImportJobs operation. To get the complete set of
|
691
|
+
# properties, call the DescribeDatasetImportJob operation, and provide
|
692
|
+
# the listed `DatasetImportJobArn`.
|
693
|
+
#
|
694
|
+
# @!attribute [rw] dataset_import_job_arn
|
695
|
+
# The Amazon Resource Name (ARN) of the dataset import job.
|
696
|
+
# @return [String]
|
697
|
+
#
|
698
|
+
# @!attribute [rw] dataset_import_job_name
|
699
|
+
# The name of the dataset import job.
|
700
|
+
# @return [String]
|
701
|
+
#
|
702
|
+
# @!attribute [rw] data_source
|
703
|
+
# The location of the Amazon S3 bucket that contains the training
|
704
|
+
# data.
|
705
|
+
# @return [Types::DataSource]
|
706
|
+
#
|
707
|
+
# @!attribute [rw] status
|
708
|
+
# The status of the dataset import job. The status is reflected in the
|
709
|
+
# status of the dataset. For example, when the import job status is
|
710
|
+
# `CREATE_IN_PROGRESS`, the status of the dataset is
|
711
|
+
# `UPDATE_IN_PROGRESS`. States include:
|
712
|
+
#
|
713
|
+
# * `ACTIVE`
|
714
|
+
#
|
715
|
+
# * `CREATE_PENDING`, `CREATE_IN_PROGRESS`, `CREATE_FAILED`
|
716
|
+
#
|
717
|
+
# * `DELETE_PENDING`, `DELETE_IN_PROGRESS`, `DELETE_FAILED`
|
718
|
+
# @return [String]
|
719
|
+
#
|
720
|
+
# @!attribute [rw] message
|
721
|
+
# If an error occurred, an informational message about the error.
|
722
|
+
# @return [String]
|
723
|
+
#
|
724
|
+
# @!attribute [rw] creation_time
|
725
|
+
# When the dataset import job was created.
|
726
|
+
# @return [Time]
|
727
|
+
#
|
728
|
+
# @!attribute [rw] last_modification_time
|
729
|
+
# Dependent on the status as follows:
|
730
|
+
#
|
731
|
+
# * `CREATE_PENDING` - same as `CreationTime`
|
732
|
+
#
|
733
|
+
# * `CREATE_IN_PROGRESS` - the current timestamp
|
734
|
+
#
|
735
|
+
# * `ACTIVE` or `CREATE_FAILED` - when the job finished or failed
|
736
|
+
# @return [Time]
|
737
|
+
#
|
738
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/DatasetImportJobSummary AWS API Documentation
|
739
|
+
#
|
740
|
+
class DatasetImportJobSummary < Struct.new(
|
741
|
+
:dataset_import_job_arn,
|
742
|
+
:dataset_import_job_name,
|
743
|
+
:data_source,
|
744
|
+
:status,
|
745
|
+
:message,
|
746
|
+
:creation_time,
|
747
|
+
:last_modification_time)
|
748
|
+
include Aws::Structure
|
749
|
+
end
|
750
|
+
|
751
|
+
# Provides a summary of the dataset properties used in the ListDatasets
|
752
|
+
# operation. To get the complete set of properties, call the
|
753
|
+
# DescribeDataset operation, and provide the listed `DatasetArn`.
|
754
|
+
#
|
755
|
+
# @!attribute [rw] dataset_arn
|
756
|
+
# The Amazon Resource Name (ARN) of the dataset.
|
757
|
+
# @return [String]
|
758
|
+
#
|
759
|
+
# @!attribute [rw] dataset_name
|
760
|
+
# The name of the dataset.
|
761
|
+
# @return [String]
|
762
|
+
#
|
763
|
+
# @!attribute [rw] dataset_type
|
764
|
+
# The dataset type.
|
765
|
+
# @return [String]
|
766
|
+
#
|
767
|
+
# @!attribute [rw] domain
|
768
|
+
# The domain associated with the dataset.
|
769
|
+
# @return [String]
|
770
|
+
#
|
771
|
+
# @!attribute [rw] creation_time
|
772
|
+
# When the dataset was created.
|
773
|
+
# @return [Time]
|
774
|
+
#
|
775
|
+
# @!attribute [rw] last_modification_time
|
776
|
+
# When the dataset is created, `LastModificationTime` is the same as
|
777
|
+
# `CreationTime`. After a CreateDatasetImportJob operation is called,
|
778
|
+
# `LastModificationTime` is when the import job finished or failed.
|
779
|
+
# While data is being imported to the dataset, `LastModificationTime`
|
780
|
+
# is the current query time.
|
781
|
+
# @return [Time]
|
782
|
+
#
|
783
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/DatasetSummary AWS API Documentation
|
784
|
+
#
|
785
|
+
class DatasetSummary < Struct.new(
|
786
|
+
:dataset_arn,
|
787
|
+
:dataset_name,
|
788
|
+
:dataset_type,
|
789
|
+
:domain,
|
790
|
+
:creation_time,
|
791
|
+
:last_modification_time)
|
792
|
+
include Aws::Structure
|
793
|
+
end
|
794
|
+
|
795
|
+
# @note When making an API call, you may pass DeleteDatasetGroupRequest
|
796
|
+
# data as a hash:
|
797
|
+
#
|
798
|
+
# {
|
799
|
+
# dataset_group_arn: "Arn", # required
|
800
|
+
# }
|
801
|
+
#
|
802
|
+
# @!attribute [rw] dataset_group_arn
|
803
|
+
# The Amazon Resource Name (ARN) of the dataset group to delete.
|
804
|
+
# @return [String]
|
805
|
+
#
|
806
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/DeleteDatasetGroupRequest AWS API Documentation
|
807
|
+
#
|
808
|
+
class DeleteDatasetGroupRequest < Struct.new(
|
809
|
+
:dataset_group_arn)
|
810
|
+
include Aws::Structure
|
811
|
+
end
|
812
|
+
|
813
|
+
# @note When making an API call, you may pass DeleteDatasetImportJobRequest
|
814
|
+
# data as a hash:
|
815
|
+
#
|
816
|
+
# {
|
817
|
+
# dataset_import_job_arn: "Arn", # required
|
818
|
+
# }
|
819
|
+
#
|
820
|
+
# @!attribute [rw] dataset_import_job_arn
|
821
|
+
# The Amazon Resource Name (ARN) of the dataset import job to delete.
|
822
|
+
# @return [String]
|
823
|
+
#
|
824
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/DeleteDatasetImportJobRequest AWS API Documentation
|
825
|
+
#
|
826
|
+
class DeleteDatasetImportJobRequest < Struct.new(
|
827
|
+
:dataset_import_job_arn)
|
828
|
+
include Aws::Structure
|
829
|
+
end
|
830
|
+
|
831
|
+
# @note When making an API call, you may pass DeleteDatasetRequest
|
832
|
+
# data as a hash:
|
833
|
+
#
|
834
|
+
# {
|
835
|
+
# dataset_arn: "Arn", # required
|
836
|
+
# }
|
837
|
+
#
|
838
|
+
# @!attribute [rw] dataset_arn
|
839
|
+
# The Amazon Resource Name (ARN) of the dataset to delete.
|
840
|
+
# @return [String]
|
841
|
+
#
|
842
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/DeleteDatasetRequest AWS API Documentation
|
843
|
+
#
|
844
|
+
class DeleteDatasetRequest < Struct.new(
|
845
|
+
:dataset_arn)
|
846
|
+
include Aws::Structure
|
847
|
+
end
|
848
|
+
|
849
|
+
# @note When making an API call, you may pass DeleteForecastExportJobRequest
|
850
|
+
# data as a hash:
|
851
|
+
#
|
852
|
+
# {
|
853
|
+
# forecast_export_job_arn: "Arn", # required
|
854
|
+
# }
|
855
|
+
#
|
856
|
+
# @!attribute [rw] forecast_export_job_arn
|
857
|
+
# The Amazon Resource Name (ARN) of the forecast export job to delete.
|
858
|
+
# @return [String]
|
859
|
+
#
|
860
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/DeleteForecastExportJobRequest AWS API Documentation
|
861
|
+
#
|
862
|
+
class DeleteForecastExportJobRequest < Struct.new(
|
863
|
+
:forecast_export_job_arn)
|
864
|
+
include Aws::Structure
|
865
|
+
end
|
866
|
+
|
867
|
+
# @note When making an API call, you may pass DeleteForecastRequest
|
868
|
+
# data as a hash:
|
869
|
+
#
|
870
|
+
# {
|
871
|
+
# forecast_arn: "Arn", # required
|
872
|
+
# }
|
873
|
+
#
|
874
|
+
# @!attribute [rw] forecast_arn
|
875
|
+
# The Amazon Resource Name (ARN) of the forecast to delete.
|
876
|
+
# @return [String]
|
877
|
+
#
|
878
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/DeleteForecastRequest AWS API Documentation
|
879
|
+
#
|
880
|
+
class DeleteForecastRequest < Struct.new(
|
881
|
+
:forecast_arn)
|
882
|
+
include Aws::Structure
|
883
|
+
end
|
884
|
+
|
885
|
+
# @note When making an API call, you may pass DeletePredictorRequest
|
886
|
+
# data as a hash:
|
887
|
+
#
|
888
|
+
# {
|
889
|
+
# predictor_arn: "Arn", # required
|
890
|
+
# }
|
891
|
+
#
|
892
|
+
# @!attribute [rw] predictor_arn
|
893
|
+
# The Amazon Resource Name (ARN) of the predictor to delete.
|
894
|
+
# @return [String]
|
895
|
+
#
|
896
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/DeletePredictorRequest AWS API Documentation
|
897
|
+
#
|
898
|
+
class DeletePredictorRequest < Struct.new(
|
899
|
+
:predictor_arn)
|
900
|
+
include Aws::Structure
|
901
|
+
end
|
902
|
+
|
903
|
+
# @note When making an API call, you may pass DescribeDatasetGroupRequest
|
904
|
+
# data as a hash:
|
905
|
+
#
|
906
|
+
# {
|
907
|
+
# dataset_group_arn: "Arn", # required
|
908
|
+
# }
|
909
|
+
#
|
910
|
+
# @!attribute [rw] dataset_group_arn
|
911
|
+
# The Amazon Resource Name (ARN) of the dataset group.
|
912
|
+
# @return [String]
|
913
|
+
#
|
914
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/DescribeDatasetGroupRequest AWS API Documentation
|
915
|
+
#
|
916
|
+
class DescribeDatasetGroupRequest < Struct.new(
|
917
|
+
:dataset_group_arn)
|
918
|
+
include Aws::Structure
|
919
|
+
end
|
920
|
+
|
921
|
+
# @!attribute [rw] dataset_group_name
|
922
|
+
# The name of the dataset group.
|
923
|
+
# @return [String]
|
924
|
+
#
|
925
|
+
# @!attribute [rw] dataset_group_arn
|
926
|
+
# The ARN of the dataset group.
|
927
|
+
# @return [String]
|
928
|
+
#
|
929
|
+
# @!attribute [rw] dataset_arns
|
930
|
+
# An array of Amazon Resource Names (ARNs) of the datasets contained
|
931
|
+
# in the dataset group.
|
932
|
+
# @return [Array<String>]
|
933
|
+
#
|
934
|
+
# @!attribute [rw] domain
|
935
|
+
# The domain associated with the dataset group. The `Domain` and
|
936
|
+
# `DatasetType` that you choose determine the fields that must be
|
937
|
+
# present in the training data that you import to the dataset. For
|
938
|
+
# example, if you choose the `RETAIL` domain and `TARGET_TIME_SERIES`
|
939
|
+
# as the `DatasetType`, Amazon Forecast requires `item_id`,
|
940
|
+
# `timestamp`, and `demand` fields to be present in your data. For
|
941
|
+
# more information, see howitworks-datasets-groups.
|
942
|
+
# @return [String]
|
943
|
+
#
|
944
|
+
# @!attribute [rw] status
|
945
|
+
# The status of the dataset group. States include:
|
946
|
+
#
|
947
|
+
# * `ACTIVE`
|
948
|
+
#
|
949
|
+
# * `CREATE_PENDING`, `CREATE_IN_PROGRESS`, `CREATE_FAILED`
|
950
|
+
#
|
951
|
+
# * `DELETE_PENDING`, `DELETE_IN_PROGRESS`, `DELETE_FAILED`
|
952
|
+
#
|
953
|
+
# * `UPDATE_PENDING`, `UPDATE_IN_PROGRESS`, `UPDATE_FAILED`
|
954
|
+
#
|
955
|
+
# The `UPDATE` states apply when the UpdateDatasetGroup operation is
|
956
|
+
# called.
|
957
|
+
#
|
958
|
+
# <note markdown="1"> The `Status` of the dataset group must be `ACTIVE` before creating a
|
959
|
+
# predictor using the dataset group.
|
960
|
+
#
|
961
|
+
# </note>
|
962
|
+
# @return [String]
|
963
|
+
#
|
964
|
+
# @!attribute [rw] creation_time
|
965
|
+
# When the dataset group was created.
|
966
|
+
# @return [Time]
|
967
|
+
#
|
968
|
+
# @!attribute [rw] last_modification_time
|
969
|
+
# When the dataset group was created or last updated from a call to
|
970
|
+
# the UpdateDatasetGroup operation. While the dataset group is being
|
971
|
+
# updated, `LastModificationTime` is the current query time.
|
972
|
+
# @return [Time]
|
973
|
+
#
|
974
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/DescribeDatasetGroupResponse AWS API Documentation
|
975
|
+
#
|
976
|
+
class DescribeDatasetGroupResponse < Struct.new(
|
977
|
+
:dataset_group_name,
|
978
|
+
:dataset_group_arn,
|
979
|
+
:dataset_arns,
|
980
|
+
:domain,
|
981
|
+
:status,
|
982
|
+
:creation_time,
|
983
|
+
:last_modification_time)
|
984
|
+
include Aws::Structure
|
985
|
+
end
|
986
|
+
|
987
|
+
# @note When making an API call, you may pass DescribeDatasetImportJobRequest
|
988
|
+
# data as a hash:
|
989
|
+
#
|
990
|
+
# {
|
991
|
+
# dataset_import_job_arn: "Arn", # required
|
992
|
+
# }
|
993
|
+
#
|
994
|
+
# @!attribute [rw] dataset_import_job_arn
|
995
|
+
# The Amazon Resource Name (ARN) of the dataset import job.
|
996
|
+
# @return [String]
|
997
|
+
#
|
998
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/DescribeDatasetImportJobRequest AWS API Documentation
|
999
|
+
#
|
1000
|
+
class DescribeDatasetImportJobRequest < Struct.new(
|
1001
|
+
:dataset_import_job_arn)
|
1002
|
+
include Aws::Structure
|
1003
|
+
end
|
1004
|
+
|
1005
|
+
# @!attribute [rw] dataset_import_job_name
|
1006
|
+
# The name of the dataset import job.
|
1007
|
+
# @return [String]
|
1008
|
+
#
|
1009
|
+
# @!attribute [rw] dataset_import_job_arn
|
1010
|
+
# The ARN of the dataset import job.
|
1011
|
+
# @return [String]
|
1012
|
+
#
|
1013
|
+
# @!attribute [rw] dataset_arn
|
1014
|
+
# The Amazon Resource Name (ARN) of the dataset that the training data
|
1015
|
+
# was imported to.
|
1016
|
+
# @return [String]
|
1017
|
+
#
|
1018
|
+
# @!attribute [rw] timestamp_format
|
1019
|
+
# The format of timestamps in the dataset. Two formats are supported
|
1020
|
+
# dependent on the `DataFrequency` specified when the dataset was
|
1021
|
+
# created.
|
1022
|
+
#
|
1023
|
+
# * "yyyy-MM-dd"
|
1024
|
+
#
|
1025
|
+
# For data frequencies: Y, M, W, and D
|
1026
|
+
#
|
1027
|
+
# * "yyyy-MM-dd HH:mm:ss"
|
1028
|
+
#
|
1029
|
+
# For data frequencies: H, 30min, 15min, and 1min; and optionally,
|
1030
|
+
# for: Y, M, W, and D
|
1031
|
+
# @return [String]
|
1032
|
+
#
|
1033
|
+
# @!attribute [rw] data_source
|
1034
|
+
# The location of the training data to import. The training data must
|
1035
|
+
# be stored in an Amazon S3 bucket.
|
1036
|
+
# @return [Types::DataSource]
|
1037
|
+
#
|
1038
|
+
# @!attribute [rw] field_statistics
|
1039
|
+
# Statistical information about each field in the input data.
|
1040
|
+
# @return [Hash<String,Types::Statistics>]
|
1041
|
+
#
|
1042
|
+
# @!attribute [rw] data_size
|
1043
|
+
# The size of the dataset in gigabytes (GB) after completion of the
|
1044
|
+
# import job.
|
1045
|
+
# @return [Float]
|
1046
|
+
#
|
1047
|
+
# @!attribute [rw] status
|
1048
|
+
# The status of the dataset import job. The status is reflected in the
|
1049
|
+
# status of the dataset. For example, when the import job status is
|
1050
|
+
# `CREATE_IN_PROGRESS`, the status of the dataset is
|
1051
|
+
# `UPDATE_IN_PROGRESS`. States include:
|
1052
|
+
#
|
1053
|
+
# * `ACTIVE`
|
1054
|
+
#
|
1055
|
+
# * `CREATE_PENDING`, `CREATE_IN_PROGRESS`, `CREATE_FAILED`
|
1056
|
+
#
|
1057
|
+
# * `DELETE_PENDING`, `DELETE_IN_PROGRESS`, `DELETE_FAILED`
|
1058
|
+
# @return [String]
|
1059
|
+
#
|
1060
|
+
# @!attribute [rw] message
|
1061
|
+
# If an error occurred, an informational message about the error.
|
1062
|
+
# @return [String]
|
1063
|
+
#
|
1064
|
+
# @!attribute [rw] creation_time
|
1065
|
+
# When the dataset import job was created.
|
1066
|
+
# @return [Time]
|
1067
|
+
#
|
1068
|
+
# @!attribute [rw] last_modification_time
|
1069
|
+
# Dependent on the status as follows:
|
1070
|
+
#
|
1071
|
+
# * `CREATE_PENDING` - same as `CreationTime`
|
1072
|
+
#
|
1073
|
+
# * `CREATE_IN_PROGRESS` - the current timestamp
|
1074
|
+
#
|
1075
|
+
# * `ACTIVE` or `CREATE_FAILED` - when the job finished or failed
|
1076
|
+
# @return [Time]
|
1077
|
+
#
|
1078
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/DescribeDatasetImportJobResponse AWS API Documentation
|
1079
|
+
#
|
1080
|
+
class DescribeDatasetImportJobResponse < Struct.new(
|
1081
|
+
:dataset_import_job_name,
|
1082
|
+
:dataset_import_job_arn,
|
1083
|
+
:dataset_arn,
|
1084
|
+
:timestamp_format,
|
1085
|
+
:data_source,
|
1086
|
+
:field_statistics,
|
1087
|
+
:data_size,
|
1088
|
+
:status,
|
1089
|
+
:message,
|
1090
|
+
:creation_time,
|
1091
|
+
:last_modification_time)
|
1092
|
+
include Aws::Structure
|
1093
|
+
end
|
1094
|
+
|
1095
|
+
# @note When making an API call, you may pass DescribeDatasetRequest
|
1096
|
+
# data as a hash:
|
1097
|
+
#
|
1098
|
+
# {
|
1099
|
+
# dataset_arn: "Arn", # required
|
1100
|
+
# }
|
1101
|
+
#
|
1102
|
+
# @!attribute [rw] dataset_arn
|
1103
|
+
# The Amazon Resource Name (ARN) of the dataset.
|
1104
|
+
# @return [String]
|
1105
|
+
#
|
1106
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/DescribeDatasetRequest AWS API Documentation
|
1107
|
+
#
|
1108
|
+
class DescribeDatasetRequest < Struct.new(
|
1109
|
+
:dataset_arn)
|
1110
|
+
include Aws::Structure
|
1111
|
+
end
|
1112
|
+
|
1113
|
+
# @!attribute [rw] dataset_arn
|
1114
|
+
# The Amazon Resource Name (ARN) of the dataset.
|
1115
|
+
# @return [String]
|
1116
|
+
#
|
1117
|
+
# @!attribute [rw] dataset_name
|
1118
|
+
# The name of the dataset.
|
1119
|
+
# @return [String]
|
1120
|
+
#
|
1121
|
+
# @!attribute [rw] domain
|
1122
|
+
# The dataset domain.
|
1123
|
+
# @return [String]
|
1124
|
+
#
|
1125
|
+
# @!attribute [rw] dataset_type
|
1126
|
+
# The dataset type.
|
1127
|
+
# @return [String]
|
1128
|
+
#
|
1129
|
+
# @!attribute [rw] data_frequency
|
1130
|
+
# The frequency of data collection.
|
1131
|
+
#
|
1132
|
+
# Valid intervals are Y (Year), M (Month), W (Week), D (Day), H
|
1133
|
+
# (Hour), 30min (30 minutes), 15min (15 minutes), 10min (10 minutes),
|
1134
|
+
# 5min (5 minutes), and 1min (1 minute). For example, "M" indicates
|
1135
|
+
# every month and "30min" indicates every 30 minutes.
|
1136
|
+
# @return [String]
|
1137
|
+
#
|
1138
|
+
# @!attribute [rw] schema
|
1139
|
+
# An array of `SchemaAttribute` objects that specify the dataset
|
1140
|
+
# fields. Each `SchemaAttribute` specifies the name and data type of a
|
1141
|
+
# field.
|
1142
|
+
# @return [Types::Schema]
|
1143
|
+
#
|
1144
|
+
# @!attribute [rw] encryption_config
|
1145
|
+
# An AWS Key Management Service (KMS) key and the AWS Identity and
|
1146
|
+
# Access Management (IAM) role that Amazon Forecast can assume to
|
1147
|
+
# access the key.
|
1148
|
+
# @return [Types::EncryptionConfig]
|
1149
|
+
#
|
1150
|
+
# @!attribute [rw] status
|
1151
|
+
# The status of the dataset. States include:
|
1152
|
+
#
|
1153
|
+
# * `ACTIVE`
|
1154
|
+
#
|
1155
|
+
# * `CREATE_PENDING`, `CREATE_IN_PROGRESS`, `CREATE_FAILED`
|
1156
|
+
#
|
1157
|
+
# * `DELETE_PENDING`, `DELETE_IN_PROGRESS`, `DELETE_FAILED`
|
1158
|
+
#
|
1159
|
+
# * `UPDATE_PENDING`, `UPDATE_IN_PROGRESS`, `UPDATE_FAILED`
|
1160
|
+
#
|
1161
|
+
# The `UPDATE` states apply while data is imported to the dataset from
|
1162
|
+
# a call to the CreateDatasetImportJob operation. During this time,
|
1163
|
+
# the status reflects the status of the dataset import job. For
|
1164
|
+
# example, when the import job status is `CREATE_IN_PROGRESS`, the
|
1165
|
+
# status of the dataset is `UPDATE_IN_PROGRESS`.
|
1166
|
+
#
|
1167
|
+
# <note markdown="1"> The `Status` of the dataset must be `ACTIVE` before you can import
|
1168
|
+
# training data.
|
1169
|
+
#
|
1170
|
+
# </note>
|
1171
|
+
# @return [String]
|
1172
|
+
#
|
1173
|
+
# @!attribute [rw] creation_time
|
1174
|
+
# When the dataset was created.
|
1175
|
+
# @return [Time]
|
1176
|
+
#
|
1177
|
+
# @!attribute [rw] last_modification_time
|
1178
|
+
# When the dataset is created, `LastModificationTime` is the same as
|
1179
|
+
# `CreationTime`. After a CreateDatasetImportJob operation is called,
|
1180
|
+
# `LastModificationTime` is when the import job finished or failed.
|
1181
|
+
# While data is being imported to the dataset, `LastModificationTime`
|
1182
|
+
# is the current query time.
|
1183
|
+
# @return [Time]
|
1184
|
+
#
|
1185
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/DescribeDatasetResponse AWS API Documentation
|
1186
|
+
#
|
1187
|
+
class DescribeDatasetResponse < Struct.new(
|
1188
|
+
:dataset_arn,
|
1189
|
+
:dataset_name,
|
1190
|
+
:domain,
|
1191
|
+
:dataset_type,
|
1192
|
+
:data_frequency,
|
1193
|
+
:schema,
|
1194
|
+
:encryption_config,
|
1195
|
+
:status,
|
1196
|
+
:creation_time,
|
1197
|
+
:last_modification_time)
|
1198
|
+
include Aws::Structure
|
1199
|
+
end
|
1200
|
+
|
1201
|
+
# @note When making an API call, you may pass DescribeForecastExportJobRequest
|
1202
|
+
# data as a hash:
|
1203
|
+
#
|
1204
|
+
# {
|
1205
|
+
# forecast_export_job_arn: "Arn", # required
|
1206
|
+
# }
|
1207
|
+
#
|
1208
|
+
# @!attribute [rw] forecast_export_job_arn
|
1209
|
+
# The Amazon Resource Name (ARN) of the forecast export job.
|
1210
|
+
# @return [String]
|
1211
|
+
#
|
1212
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/DescribeForecastExportJobRequest AWS API Documentation
|
1213
|
+
#
|
1214
|
+
class DescribeForecastExportJobRequest < Struct.new(
|
1215
|
+
:forecast_export_job_arn)
|
1216
|
+
include Aws::Structure
|
1217
|
+
end
|
1218
|
+
|
1219
|
+
# @!attribute [rw] forecast_export_job_arn
|
1220
|
+
# The ARN of the forecast export job.
|
1221
|
+
# @return [String]
|
1222
|
+
#
|
1223
|
+
# @!attribute [rw] forecast_export_job_name
|
1224
|
+
# The name of the forecast export job.
|
1225
|
+
# @return [String]
|
1226
|
+
#
|
1227
|
+
# @!attribute [rw] forecast_arn
|
1228
|
+
# The Amazon Resource Name (ARN) of the exported forecast.
|
1229
|
+
# @return [String]
|
1230
|
+
#
|
1231
|
+
# @!attribute [rw] destination
|
1232
|
+
# The path to the AWS S3 bucket where the forecast is exported.
|
1233
|
+
# @return [Types::DataDestination]
|
1234
|
+
#
|
1235
|
+
# @!attribute [rw] message
|
1236
|
+
# If an error occurred, an informational message about the error.
|
1237
|
+
# @return [String]
|
1238
|
+
#
|
1239
|
+
# @!attribute [rw] status
|
1240
|
+
# The status of the forecast export job. One of the following states:
|
1241
|
+
#
|
1242
|
+
# * `ACTIVE`
|
1243
|
+
#
|
1244
|
+
# * `CREATE_PENDING`, `CREATE_IN_PROGRESS`, `CREATE_FAILED`
|
1245
|
+
#
|
1246
|
+
# * `DELETE_PENDING`, `DELETE_IN_PROGRESS`, `DELETE_FAILED`
|
1247
|
+
#
|
1248
|
+
# <note markdown="1"> The `Status` of the forecast export job must be `ACTIVE` before you
|
1249
|
+
# can access the forecast in your Amazon S3 bucket.
|
1250
|
+
#
|
1251
|
+
# </note>
|
1252
|
+
# @return [String]
|
1253
|
+
#
|
1254
|
+
# @!attribute [rw] creation_time
|
1255
|
+
# When the forecast export job was created.
|
1256
|
+
# @return [Time]
|
1257
|
+
#
|
1258
|
+
# @!attribute [rw] last_modification_time
|
1259
|
+
# When the last successful export job finished.
|
1260
|
+
# @return [Time]
|
1261
|
+
#
|
1262
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/DescribeForecastExportJobResponse AWS API Documentation
|
1263
|
+
#
|
1264
|
+
class DescribeForecastExportJobResponse < Struct.new(
|
1265
|
+
:forecast_export_job_arn,
|
1266
|
+
:forecast_export_job_name,
|
1267
|
+
:forecast_arn,
|
1268
|
+
:destination,
|
1269
|
+
:message,
|
1270
|
+
:status,
|
1271
|
+
:creation_time,
|
1272
|
+
:last_modification_time)
|
1273
|
+
include Aws::Structure
|
1274
|
+
end
|
1275
|
+
|
1276
|
+
# @note When making an API call, you may pass DescribeForecastRequest
|
1277
|
+
# data as a hash:
|
1278
|
+
#
|
1279
|
+
# {
|
1280
|
+
# forecast_arn: "Arn", # required
|
1281
|
+
# }
|
1282
|
+
#
|
1283
|
+
# @!attribute [rw] forecast_arn
|
1284
|
+
# The Amazon Resource Name (ARN) of the forecast.
|
1285
|
+
# @return [String]
|
1286
|
+
#
|
1287
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/DescribeForecastRequest AWS API Documentation
|
1288
|
+
#
|
1289
|
+
class DescribeForecastRequest < Struct.new(
|
1290
|
+
:forecast_arn)
|
1291
|
+
include Aws::Structure
|
1292
|
+
end
|
1293
|
+
|
1294
|
+
# @!attribute [rw] forecast_arn
|
1295
|
+
# The same forecast ARN as given in the request.
|
1296
|
+
# @return [String]
|
1297
|
+
#
|
1298
|
+
# @!attribute [rw] forecast_name
|
1299
|
+
# The name of the forecast.
|
1300
|
+
# @return [String]
|
1301
|
+
#
|
1302
|
+
# @!attribute [rw] predictor_arn
|
1303
|
+
# The ARN of the predictor used to generate the forecast.
|
1304
|
+
# @return [String]
|
1305
|
+
#
|
1306
|
+
# @!attribute [rw] dataset_group_arn
|
1307
|
+
# The ARN of the dataset group that provided the data used to train
|
1308
|
+
# the predictor.
|
1309
|
+
# @return [String]
|
1310
|
+
#
|
1311
|
+
# @!attribute [rw] status
|
1312
|
+
# The status of the forecast. States include:
|
1313
|
+
#
|
1314
|
+
# * `ACTIVE`
|
1315
|
+
#
|
1316
|
+
# * `CREATE_PENDING`, `CREATE_IN_PROGRESS`, `CREATE_FAILED`
|
1317
|
+
#
|
1318
|
+
# * `DELETE_PENDING`, `DELETE_IN_PROGRESS`, `DELETE_FAILED`
|
1319
|
+
#
|
1320
|
+
# <note markdown="1"> The `Status` of the forecast must be `ACTIVE` before you can query
|
1321
|
+
# or export the forecast.
|
1322
|
+
#
|
1323
|
+
# </note>
|
1324
|
+
# @return [String]
|
1325
|
+
#
|
1326
|
+
# @!attribute [rw] message
|
1327
|
+
# If an error occurred, an informational message about the error.
|
1328
|
+
# @return [String]
|
1329
|
+
#
|
1330
|
+
# @!attribute [rw] creation_time
|
1331
|
+
# When the forecast creation task was created.
|
1332
|
+
# @return [Time]
|
1333
|
+
#
|
1334
|
+
# @!attribute [rw] last_modification_time
|
1335
|
+
# Initially, the same as `CreationTime` (status is `CREATE_PENDING`).
|
1336
|
+
# Updated when inference (creating the forecast) starts (status
|
1337
|
+
# changed to `CREATE_IN_PROGRESS`), and when inference is complete
|
1338
|
+
# (status changed to `ACTIVE`) or fails (status changed to
|
1339
|
+
# `CREATE_FAILED`).
|
1340
|
+
# @return [Time]
|
1341
|
+
#
|
1342
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/DescribeForecastResponse AWS API Documentation
|
1343
|
+
#
|
1344
|
+
class DescribeForecastResponse < Struct.new(
|
1345
|
+
:forecast_arn,
|
1346
|
+
:forecast_name,
|
1347
|
+
:predictor_arn,
|
1348
|
+
:dataset_group_arn,
|
1349
|
+
:status,
|
1350
|
+
:message,
|
1351
|
+
:creation_time,
|
1352
|
+
:last_modification_time)
|
1353
|
+
include Aws::Structure
|
1354
|
+
end
|
1355
|
+
|
1356
|
+
# @note When making an API call, you may pass DescribePredictorRequest
|
1357
|
+
# data as a hash:
|
1358
|
+
#
|
1359
|
+
# {
|
1360
|
+
# predictor_arn: "Arn", # required
|
1361
|
+
# }
|
1362
|
+
#
|
1363
|
+
# @!attribute [rw] predictor_arn
|
1364
|
+
# The Amazon Resource Name (ARN) of the predictor that you want
|
1365
|
+
# information about.
|
1366
|
+
# @return [String]
|
1367
|
+
#
|
1368
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/DescribePredictorRequest AWS API Documentation
|
1369
|
+
#
|
1370
|
+
class DescribePredictorRequest < Struct.new(
|
1371
|
+
:predictor_arn)
|
1372
|
+
include Aws::Structure
|
1373
|
+
end
|
1374
|
+
|
1375
|
+
# @!attribute [rw] predictor_arn
|
1376
|
+
# The ARN of the predictor.
|
1377
|
+
# @return [String]
|
1378
|
+
#
|
1379
|
+
# @!attribute [rw] predictor_name
|
1380
|
+
# The name of the predictor.
|
1381
|
+
# @return [String]
|
1382
|
+
#
|
1383
|
+
# @!attribute [rw] algorithm_arn
|
1384
|
+
# The Amazon Resource Name (ARN) of the algorithm used for model
|
1385
|
+
# training.
|
1386
|
+
# @return [String]
|
1387
|
+
#
|
1388
|
+
# @!attribute [rw] forecast_horizon
|
1389
|
+
# The number of time-steps of the forecast. The forecast horizon is
|
1390
|
+
# also called the prediction length.
|
1391
|
+
# @return [Integer]
|
1392
|
+
#
|
1393
|
+
# @!attribute [rw] perform_auto_ml
|
1394
|
+
# Whether the predictor is set to perform AutoML.
|
1395
|
+
# @return [Boolean]
|
1396
|
+
#
|
1397
|
+
# @!attribute [rw] perform_hpo
|
1398
|
+
# Whether the predictor is set to perform HPO.
|
1399
|
+
# @return [Boolean]
|
1400
|
+
#
|
1401
|
+
# @!attribute [rw] training_parameters
|
1402
|
+
# The training parameters to override for model training. The
|
1403
|
+
# parameters that you can override are listed in the individual
|
1404
|
+
# algorithms in aws-forecast-choosing-recipes.
|
1405
|
+
# @return [Hash<String,String>]
|
1406
|
+
#
|
1407
|
+
# @!attribute [rw] evaluation_parameters
|
1408
|
+
# Used to override the default evaluation parameters of the specified
|
1409
|
+
# algorithm. Amazon Forecast evaluates a predictor by splitting a
|
1410
|
+
# dataset into training data and testing data. The evaluation
|
1411
|
+
# parameters define how to perform the split and the number of
|
1412
|
+
# iterations.
|
1413
|
+
# @return [Types::EvaluationParameters]
|
1414
|
+
#
|
1415
|
+
# @!attribute [rw] hpo_config
|
1416
|
+
# The hyperparameter override values for the algorithm.
|
1417
|
+
# @return [Types::HyperParameterTuningJobConfig]
|
1418
|
+
#
|
1419
|
+
# @!attribute [rw] input_data_config
|
1420
|
+
# Describes the dataset group that contains the data to use to train
|
1421
|
+
# the predictor.
|
1422
|
+
# @return [Types::InputDataConfig]
|
1423
|
+
#
|
1424
|
+
# @!attribute [rw] featurization_config
|
1425
|
+
# The featurization configuration.
|
1426
|
+
# @return [Types::FeaturizationConfig]
|
1427
|
+
#
|
1428
|
+
# @!attribute [rw] encryption_config
|
1429
|
+
# An AWS Key Management Service (KMS) key and the AWS Identity and
|
1430
|
+
# Access Management (IAM) role that Amazon Forecast can assume to
|
1431
|
+
# access the key.
|
1432
|
+
# @return [Types::EncryptionConfig]
|
1433
|
+
#
|
1434
|
+
# @!attribute [rw] dataset_import_job_arns
|
1435
|
+
# An array of ARNs of the dataset import jobs used to import training
|
1436
|
+
# data for the predictor.
|
1437
|
+
# @return [Array<String>]
|
1438
|
+
#
|
1439
|
+
# @!attribute [rw] auto_ml_algorithm_arns
|
1440
|
+
# When `PerformAutoML` is specified, the ARN of the chosen algorithm.
|
1441
|
+
# @return [Array<String>]
|
1442
|
+
#
|
1443
|
+
# @!attribute [rw] status
|
1444
|
+
# The status of the predictor. States include:
|
1445
|
+
#
|
1446
|
+
# * `ACTIVE`
|
1447
|
+
#
|
1448
|
+
# * `CREATE_PENDING`, `CREATE_IN_PROGRESS`, `CREATE_FAILED`
|
1449
|
+
#
|
1450
|
+
# * `DELETE_PENDING`, `DELETE_IN_PROGRESS`, `DELETE_FAILED`
|
1451
|
+
#
|
1452
|
+
# * `UPDATE_PENDING`, `UPDATE_IN_PROGRESS`, `UPDATE_FAILED`
|
1453
|
+
#
|
1454
|
+
# <note markdown="1"> The `Status` of the predictor must be `ACTIVE` before using the
|
1455
|
+
# predictor to create a forecast.
|
1456
|
+
#
|
1457
|
+
# </note>
|
1458
|
+
# @return [String]
|
1459
|
+
#
|
1460
|
+
# @!attribute [rw] message
|
1461
|
+
# If an error occurred, an informational message about the error.
|
1462
|
+
# @return [String]
|
1463
|
+
#
|
1464
|
+
# @!attribute [rw] creation_time
|
1465
|
+
# When the model training task was created.
|
1466
|
+
# @return [Time]
|
1467
|
+
#
|
1468
|
+
# @!attribute [rw] last_modification_time
|
1469
|
+
# Initially, the same as `CreationTime` (status is `CREATE_PENDING`).
|
1470
|
+
# Updated when training starts (status changed to
|
1471
|
+
# `CREATE_IN_PROGRESS`), and when training is complete (status changed
|
1472
|
+
# to `ACTIVE`) or fails (status changed to `CREATE_FAILED`).
|
1473
|
+
# @return [Time]
|
1474
|
+
#
|
1475
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/DescribePredictorResponse AWS API Documentation
|
1476
|
+
#
|
1477
|
+
class DescribePredictorResponse < Struct.new(
|
1478
|
+
:predictor_arn,
|
1479
|
+
:predictor_name,
|
1480
|
+
:algorithm_arn,
|
1481
|
+
:forecast_horizon,
|
1482
|
+
:perform_auto_ml,
|
1483
|
+
:perform_hpo,
|
1484
|
+
:training_parameters,
|
1485
|
+
:evaluation_parameters,
|
1486
|
+
:hpo_config,
|
1487
|
+
:input_data_config,
|
1488
|
+
:featurization_config,
|
1489
|
+
:encryption_config,
|
1490
|
+
:dataset_import_job_arns,
|
1491
|
+
:auto_ml_algorithm_arns,
|
1492
|
+
:status,
|
1493
|
+
:message,
|
1494
|
+
:creation_time,
|
1495
|
+
:last_modification_time)
|
1496
|
+
include Aws::Structure
|
1497
|
+
end
|
1498
|
+
|
1499
|
+
# An AWS Key Management Service (KMS) key and an AWS Identity and Access
|
1500
|
+
# Management (IAM) role that Amazon Forecast can assume to access the
|
1501
|
+
# key. This object is optionally submitted in the CreateDataset and
|
1502
|
+
# CreatePredictor requests.
|
1503
|
+
#
|
1504
|
+
# @note When making an API call, you may pass EncryptionConfig
|
1505
|
+
# data as a hash:
|
1506
|
+
#
|
1507
|
+
# {
|
1508
|
+
# role_arn: "Arn", # required
|
1509
|
+
# kms_key_arn: "KMSKeyArn", # required
|
1510
|
+
# }
|
1511
|
+
#
|
1512
|
+
# @!attribute [rw] role_arn
|
1513
|
+
# The ARN of the AWS Identity and Access Management (IAM) role that
|
1514
|
+
# Amazon Forecast can assume to access the AWS KMS key.
|
1515
|
+
#
|
1516
|
+
# Cross-account pass role is not allowed. If you pass a role that
|
1517
|
+
# doesn't belong to your account, an `InvalidInputException` is
|
1518
|
+
# thrown.
|
1519
|
+
# @return [String]
|
1520
|
+
#
|
1521
|
+
# @!attribute [rw] kms_key_arn
|
1522
|
+
# The Amazon Resource Name (ARN) of an AWS Key Management Service
|
1523
|
+
# (KMS) key.
|
1524
|
+
# @return [String]
|
1525
|
+
#
|
1526
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/EncryptionConfig AWS API Documentation
|
1527
|
+
#
|
1528
|
+
class EncryptionConfig < Struct.new(
|
1529
|
+
:role_arn,
|
1530
|
+
:kms_key_arn)
|
1531
|
+
include Aws::Structure
|
1532
|
+
end
|
1533
|
+
|
1534
|
+
# Parameters that define how to split a dataset into training data and
|
1535
|
+
# testing data, and the number of iterations to perform. These
|
1536
|
+
# parameters are specified in the predefined algorithms and can be
|
1537
|
+
# overridden in the CreatePredictor request.
|
1538
|
+
#
|
1539
|
+
# For example, suppose that you have a dataset with data collection
|
1540
|
+
# frequency set to every day and you have 200 days worth of data (that
|
1541
|
+
# is, 200 data points). Now suppose that you set the
|
1542
|
+
# `NumberOfBacktestWindows` to 2 and the `BackTestWindowOffset`
|
1543
|
+
# parameter to 20. The algorithm splits the data twice. The first time,
|
1544
|
+
# the algorithm trains the model using the first 180 data points and
|
1545
|
+
# uses the last 20 data points for evaluation. The second time, the
|
1546
|
+
# algorithm trains the model using the first 160 data points and uses
|
1547
|
+
# the last 40 data points for evaluation.
|
1548
|
+
#
|
1549
|
+
# @note When making an API call, you may pass EvaluationParameters
|
1550
|
+
# data as a hash:
|
1551
|
+
#
|
1552
|
+
# {
|
1553
|
+
# number_of_backtest_windows: 1,
|
1554
|
+
# back_test_window_offset: 1,
|
1555
|
+
# }
|
1556
|
+
#
|
1557
|
+
# @!attribute [rw] number_of_backtest_windows
|
1558
|
+
# The number of times to split the input data. The default is 1. The
|
1559
|
+
# range is 1 through 5.
|
1560
|
+
# @return [Integer]
|
1561
|
+
#
|
1562
|
+
# @!attribute [rw] back_test_window_offset
|
1563
|
+
# The point from the end of the dataset where you want to split the
|
1564
|
+
# data for model training and evaluation. The value is specified as
|
1565
|
+
# the number of data points.
|
1566
|
+
# @return [Integer]
|
1567
|
+
#
|
1568
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/EvaluationParameters AWS API Documentation
|
1569
|
+
#
|
1570
|
+
class EvaluationParameters < Struct.new(
|
1571
|
+
:number_of_backtest_windows,
|
1572
|
+
:back_test_window_offset)
|
1573
|
+
include Aws::Structure
|
1574
|
+
end
|
1575
|
+
|
1576
|
+
# The results of evaluating an algorithm. Returned as part of the
|
1577
|
+
# GetAccuracyMetrics response.
|
1578
|
+
#
|
1579
|
+
# @!attribute [rw] algorithm_arn
|
1580
|
+
# The Amazon Resource Name (ARN) of the algorithm that was evaluated.
|
1581
|
+
# @return [String]
|
1582
|
+
#
|
1583
|
+
# @!attribute [rw] test_windows
|
1584
|
+
# The array of test windows used for evaluating the algorithm. The
|
1585
|
+
# `NumberOfBacktestWindows` from the EvaluationParameters object
|
1586
|
+
# determines the number of windows in the array.
|
1587
|
+
# @return [Array<Types::WindowSummary>]
|
1588
|
+
#
|
1589
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/EvaluationResult AWS API Documentation
|
1590
|
+
#
|
1591
|
+
class EvaluationResult < Struct.new(
|
1592
|
+
:algorithm_arn,
|
1593
|
+
:test_windows)
|
1594
|
+
include Aws::Structure
|
1595
|
+
end
|
1596
|
+
|
1597
|
+
# Provides featurization (transformation) information for a dataset
|
1598
|
+
# field. This object is part of the FeaturizationConfig object.
|
1599
|
+
#
|
1600
|
+
# For example:
|
1601
|
+
#
|
1602
|
+
# `\{`
|
1603
|
+
#
|
1604
|
+
# `"AttributeName": "demand",`
|
1605
|
+
#
|
1606
|
+
# `FeaturizationPipeline [ \{`
|
1607
|
+
#
|
1608
|
+
# `"FeaturizationMethodName": "filling",`
|
1609
|
+
#
|
1610
|
+
# `"FeaturizationMethodParameters": \{"aggregation": "avg", "backfill":
|
1611
|
+
# "nan"\}`
|
1612
|
+
#
|
1613
|
+
# `\} ]`
|
1614
|
+
#
|
1615
|
+
# `\}`
|
1616
|
+
#
|
1617
|
+
# @note When making an API call, you may pass Featurization
|
1618
|
+
# data as a hash:
|
1619
|
+
#
|
1620
|
+
# {
|
1621
|
+
# attribute_name: "Name", # required
|
1622
|
+
# featurization_pipeline: [
|
1623
|
+
# {
|
1624
|
+
# featurization_method_name: "filling", # required, accepts filling
|
1625
|
+
# featurization_method_parameters: {
|
1626
|
+
# "ParameterKey" => "ParameterValue",
|
1627
|
+
# },
|
1628
|
+
# },
|
1629
|
+
# ],
|
1630
|
+
# }
|
1631
|
+
#
|
1632
|
+
# @!attribute [rw] attribute_name
|
1633
|
+
# The name of the schema attribute specifying the data field to be
|
1634
|
+
# featurized. In this release, only the `target` field of the
|
1635
|
+
# `TARGET_TIME_SERIES` dataset type is supported. For example, for the
|
1636
|
+
# `RETAIL` domain, the target is `demand`, and for the `CUSTOM`
|
1637
|
+
# domain, the target is `target_value`.
|
1638
|
+
# @return [String]
|
1639
|
+
#
|
1640
|
+
# @!attribute [rw] featurization_pipeline
|
1641
|
+
# An array `FeaturizationMethod` objects that specifies the feature
|
1642
|
+
# transformation methods. For this release, the number of methods is
|
1643
|
+
# limited to one.
|
1644
|
+
# @return [Array<Types::FeaturizationMethod>]
|
1645
|
+
#
|
1646
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/Featurization AWS API Documentation
|
1647
|
+
#
|
1648
|
+
class Featurization < Struct.new(
|
1649
|
+
:attribute_name,
|
1650
|
+
:featurization_pipeline)
|
1651
|
+
include Aws::Structure
|
1652
|
+
end
|
1653
|
+
|
1654
|
+
# In a CreatePredictor operation, the specified algorithm trains a model
|
1655
|
+
# using the specified dataset group. You can optionally tell the
|
1656
|
+
# operation to modify data fields prior to training a model. These
|
1657
|
+
# modifications are referred to as *featurization*.
|
1658
|
+
#
|
1659
|
+
# You define featurization using the `FeaturizationConfig` object. You
|
1660
|
+
# specify an array of transformations, one for each field that you want
|
1661
|
+
# to featurize. You then include the `FeaturizationConfig` in your
|
1662
|
+
# `CreatePredictor` request. Amazon Forecast applies the featurization
|
1663
|
+
# to the `TARGET_TIME_SERIES` dataset before model training.
|
1664
|
+
#
|
1665
|
+
# You can create multiple featurization configurations. For example, you
|
1666
|
+
# might call the `CreatePredictor` operation twice by specifying
|
1667
|
+
# different featurization configurations.
|
1668
|
+
#
|
1669
|
+
# @note When making an API call, you may pass FeaturizationConfig
|
1670
|
+
# data as a hash:
|
1671
|
+
#
|
1672
|
+
# {
|
1673
|
+
# forecast_frequency: "Frequency", # required
|
1674
|
+
# forecast_dimensions: ["Name"],
|
1675
|
+
# featurizations: [
|
1676
|
+
# {
|
1677
|
+
# attribute_name: "Name", # required
|
1678
|
+
# featurization_pipeline: [
|
1679
|
+
# {
|
1680
|
+
# featurization_method_name: "filling", # required, accepts filling
|
1681
|
+
# featurization_method_parameters: {
|
1682
|
+
# "ParameterKey" => "ParameterValue",
|
1683
|
+
# },
|
1684
|
+
# },
|
1685
|
+
# ],
|
1686
|
+
# },
|
1687
|
+
# ],
|
1688
|
+
# }
|
1689
|
+
#
|
1690
|
+
# @!attribute [rw] forecast_frequency
|
1691
|
+
# The frequency of predictions in a forecast.
|
1692
|
+
#
|
1693
|
+
# Valid intervals are Y (Year), M (Month), W (Week), D (Day), H
|
1694
|
+
# (Hour), 30min (30 minutes), 15min (15 minutes), 10min (10 minutes),
|
1695
|
+
# 5min (5 minutes), and 1min (1 minute). For example, "Y" indicates
|
1696
|
+
# every year and "5min" indicates every five minutes.
|
1697
|
+
# @return [String]
|
1698
|
+
#
|
1699
|
+
# @!attribute [rw] forecast_dimensions
|
1700
|
+
# An array of dimension (field) names that specify how to group the
|
1701
|
+
# generated forecast.
|
1702
|
+
#
|
1703
|
+
# For example, suppose that you are generating a forecast for item
|
1704
|
+
# sales across all of your stores, and your dataset contains a
|
1705
|
+
# `store_id` field. If you want the sales forecast for each item by
|
1706
|
+
# store, you would specify `store_id` as the dimension.
|
1707
|
+
# @return [Array<String>]
|
1708
|
+
#
|
1709
|
+
# @!attribute [rw] featurizations
|
1710
|
+
# An array of featurization (transformation) information for the
|
1711
|
+
# fields of a dataset. In this release, only a single featurization is
|
1712
|
+
# supported.
|
1713
|
+
# @return [Array<Types::Featurization>]
|
1714
|
+
#
|
1715
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/FeaturizationConfig AWS API Documentation
|
1716
|
+
#
|
1717
|
+
class FeaturizationConfig < Struct.new(
|
1718
|
+
:forecast_frequency,
|
1719
|
+
:forecast_dimensions,
|
1720
|
+
:featurizations)
|
1721
|
+
include Aws::Structure
|
1722
|
+
end
|
1723
|
+
|
1724
|
+
# Provides information about a method that featurizes (transforms) a
|
1725
|
+
# dataset field. The method is part of the `FeaturizationPipeline` of
|
1726
|
+
# the Featurization object. If `FeaturizationMethodParameters` isn't
|
1727
|
+
# specified, Amazon Forecast uses default parameters.
|
1728
|
+
#
|
1729
|
+
# For example:
|
1730
|
+
#
|
1731
|
+
# `\{`
|
1732
|
+
#
|
1733
|
+
# `"FeaturizationMethodName": "filling",`
|
1734
|
+
#
|
1735
|
+
# `"FeaturizationMethodParameters": \{"aggregation": "avg", "backfill":
|
1736
|
+
# "nan"\}`
|
1737
|
+
#
|
1738
|
+
# `\}`
|
1739
|
+
#
|
1740
|
+
# @note When making an API call, you may pass FeaturizationMethod
|
1741
|
+
# data as a hash:
|
1742
|
+
#
|
1743
|
+
# {
|
1744
|
+
# featurization_method_name: "filling", # required, accepts filling
|
1745
|
+
# featurization_method_parameters: {
|
1746
|
+
# "ParameterKey" => "ParameterValue",
|
1747
|
+
# },
|
1748
|
+
# }
|
1749
|
+
#
|
1750
|
+
# @!attribute [rw] featurization_method_name
|
1751
|
+
# The name of the method. In this release, "filling" is the only
|
1752
|
+
# supported method.
|
1753
|
+
# @return [String]
|
1754
|
+
#
|
1755
|
+
# @!attribute [rw] featurization_method_parameters
|
1756
|
+
# The method parameters (key-value pairs). Specify these to override
|
1757
|
+
# the default values. The following list shows the parameters and
|
1758
|
+
# their valid values. Bold signifies the default value.
|
1759
|
+
#
|
1760
|
+
# * `aggregation`\: **sum**, `avg`, `first`, `min`, `max`
|
1761
|
+
#
|
1762
|
+
# * `frontfill`\: **none**
|
1763
|
+
#
|
1764
|
+
# * `middlefill`\: **zero**, `nan` (not a number)
|
1765
|
+
#
|
1766
|
+
# * `backfill`\: **zero**, `nan`
|
1767
|
+
# @return [Hash<String,String>]
|
1768
|
+
#
|
1769
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/FeaturizationMethod AWS API Documentation
|
1770
|
+
#
|
1771
|
+
class FeaturizationMethod < Struct.new(
|
1772
|
+
:featurization_method_name,
|
1773
|
+
:featurization_method_parameters)
|
1774
|
+
include Aws::Structure
|
1775
|
+
end
|
1776
|
+
|
1777
|
+
# Describes a filter for choosing a subset of objects. Each filter
|
1778
|
+
# consists of a condition and a match statement. The condition is either
|
1779
|
+
# `IS` or `IS_NOT`, which specifies whether to include or exclude,
|
1780
|
+
# respectively, the objects that match the statement. The match
|
1781
|
+
# statement consists of a key and a value.
|
1782
|
+
#
|
1783
|
+
# @note When making an API call, you may pass Filter
|
1784
|
+
# data as a hash:
|
1785
|
+
#
|
1786
|
+
# {
|
1787
|
+
# key: "String", # required
|
1788
|
+
# value: "Arn", # required
|
1789
|
+
# condition: "IS", # required, accepts IS, IS_NOT
|
1790
|
+
# }
|
1791
|
+
#
|
1792
|
+
# @!attribute [rw] key
|
1793
|
+
# The name of the parameter to filter on.
|
1794
|
+
# @return [String]
|
1795
|
+
#
|
1796
|
+
# @!attribute [rw] value
|
1797
|
+
# A valid value for `Key`.
|
1798
|
+
# @return [String]
|
1799
|
+
#
|
1800
|
+
# @!attribute [rw] condition
|
1801
|
+
# The condition to apply.
|
1802
|
+
# @return [String]
|
1803
|
+
#
|
1804
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/Filter AWS API Documentation
|
1805
|
+
#
|
1806
|
+
class Filter < Struct.new(
|
1807
|
+
:key,
|
1808
|
+
:value,
|
1809
|
+
:condition)
|
1810
|
+
include Aws::Structure
|
1811
|
+
end
|
1812
|
+
|
1813
|
+
# Provides a summary of the forecast export job properties used in the
|
1814
|
+
# ListForecastExportJobs operation. To get the complete set of
|
1815
|
+
# properties, call the DescribeForecastExportJob operation, and provide
|
1816
|
+
# the listed `ForecastExportJobArn`.
|
1817
|
+
#
|
1818
|
+
# @!attribute [rw] forecast_export_job_arn
|
1819
|
+
# The Amazon Resource Name (ARN) of the forecast export job.
|
1820
|
+
# @return [String]
|
1821
|
+
#
|
1822
|
+
# @!attribute [rw] forecast_export_job_name
|
1823
|
+
# The name of the forecast export job.
|
1824
|
+
# @return [String]
|
1825
|
+
#
|
1826
|
+
# @!attribute [rw] destination
|
1827
|
+
# The path to the S3 bucket where the forecast is stored.
|
1828
|
+
# @return [Types::DataDestination]
|
1829
|
+
#
|
1830
|
+
# @!attribute [rw] status
|
1831
|
+
# The status of the forecast export job. One of the following states:
|
1832
|
+
#
|
1833
|
+
# * `ACTIVE`
|
1834
|
+
#
|
1835
|
+
# * `CREATE_PENDING`, `CREATE_IN_PROGRESS`, `CREATE_FAILED`
|
1836
|
+
#
|
1837
|
+
# * `DELETE_PENDING`, `DELETE_IN_PROGRESS`, `DELETE_FAILED`
|
1838
|
+
#
|
1839
|
+
# <note markdown="1"> The `Status` of the forecast export job must be `ACTIVE` before you
|
1840
|
+
# can access the forecast in your Amazon S3 bucket.
|
1841
|
+
#
|
1842
|
+
# </note>
|
1843
|
+
# @return [String]
|
1844
|
+
#
|
1845
|
+
# @!attribute [rw] message
|
1846
|
+
# If an error occurred, an informational message about the error.
|
1847
|
+
# @return [String]
|
1848
|
+
#
|
1849
|
+
# @!attribute [rw] creation_time
|
1850
|
+
# When the forecast export job was created.
|
1851
|
+
# @return [Time]
|
1852
|
+
#
|
1853
|
+
# @!attribute [rw] last_modification_time
|
1854
|
+
# When the last successful export job finished.
|
1855
|
+
# @return [Time]
|
1856
|
+
#
|
1857
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/ForecastExportJobSummary AWS API Documentation
|
1858
|
+
#
|
1859
|
+
class ForecastExportJobSummary < Struct.new(
|
1860
|
+
:forecast_export_job_arn,
|
1861
|
+
:forecast_export_job_name,
|
1862
|
+
:destination,
|
1863
|
+
:status,
|
1864
|
+
:message,
|
1865
|
+
:creation_time,
|
1866
|
+
:last_modification_time)
|
1867
|
+
include Aws::Structure
|
1868
|
+
end
|
1869
|
+
|
1870
|
+
# Provides a summary of the forecast properties used in the
|
1871
|
+
# ListForecasts operation. To get the complete set of properties, call
|
1872
|
+
# the DescribeForecast operation, and provide the listed `ForecastArn`.
|
1873
|
+
#
|
1874
|
+
# @!attribute [rw] forecast_arn
|
1875
|
+
# The ARN of the forecast.
|
1876
|
+
# @return [String]
|
1877
|
+
#
|
1878
|
+
# @!attribute [rw] forecast_name
|
1879
|
+
# The name of the forecast.
|
1880
|
+
# @return [String]
|
1881
|
+
#
|
1882
|
+
# @!attribute [rw] predictor_arn
|
1883
|
+
# The ARN of the predictor used to generate the forecast.
|
1884
|
+
# @return [String]
|
1885
|
+
#
|
1886
|
+
# @!attribute [rw] dataset_group_arn
|
1887
|
+
# The Amazon Resource Name (ARN) of the dataset group that provided
|
1888
|
+
# the data used to train the predictor.
|
1889
|
+
# @return [String]
|
1890
|
+
#
|
1891
|
+
# @!attribute [rw] status
|
1892
|
+
# The status of the forecast. States include:
|
1893
|
+
#
|
1894
|
+
# * `ACTIVE`
|
1895
|
+
#
|
1896
|
+
# * `CREATE_PENDING`, `CREATE_IN_PROGRESS`, `CREATE_FAILED`
|
1897
|
+
#
|
1898
|
+
# * `DELETE_PENDING`, `DELETE_IN_PROGRESS`, `DELETE_FAILED`
|
1899
|
+
#
|
1900
|
+
# <note markdown="1"> The `Status` of the forecast must be `ACTIVE` before you can query
|
1901
|
+
# or export the forecast.
|
1902
|
+
#
|
1903
|
+
# </note>
|
1904
|
+
# @return [String]
|
1905
|
+
#
|
1906
|
+
# @!attribute [rw] message
|
1907
|
+
# If an error occurred, an informational message about the error.
|
1908
|
+
# @return [String]
|
1909
|
+
#
|
1910
|
+
# @!attribute [rw] creation_time
|
1911
|
+
# When the forecast creation task was created.
|
1912
|
+
# @return [Time]
|
1913
|
+
#
|
1914
|
+
# @!attribute [rw] last_modification_time
|
1915
|
+
# Initially, the same as `CreationTime` (status is `CREATE_PENDING`).
|
1916
|
+
# Updated when inference (creating the forecast) starts (status
|
1917
|
+
# changed to `CREATE_IN_PROGRESS`), and when inference is complete
|
1918
|
+
# (status changed to `ACTIVE`) or fails (status changed to
|
1919
|
+
# `CREATE_FAILED`).
|
1920
|
+
# @return [Time]
|
1921
|
+
#
|
1922
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/ForecastSummary AWS API Documentation
|
1923
|
+
#
|
1924
|
+
class ForecastSummary < Struct.new(
|
1925
|
+
:forecast_arn,
|
1926
|
+
:forecast_name,
|
1927
|
+
:predictor_arn,
|
1928
|
+
:dataset_group_arn,
|
1929
|
+
:status,
|
1930
|
+
:message,
|
1931
|
+
:creation_time,
|
1932
|
+
:last_modification_time)
|
1933
|
+
include Aws::Structure
|
1934
|
+
end
|
1935
|
+
|
1936
|
+
# @note When making an API call, you may pass GetAccuracyMetricsRequest
|
1937
|
+
# data as a hash:
|
1938
|
+
#
|
1939
|
+
# {
|
1940
|
+
# predictor_arn: "Arn", # required
|
1941
|
+
# }
|
1942
|
+
#
|
1943
|
+
# @!attribute [rw] predictor_arn
|
1944
|
+
# The Amazon Resource Name (ARN) of the predictor to get metrics for.
|
1945
|
+
# @return [String]
|
1946
|
+
#
|
1947
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/GetAccuracyMetricsRequest AWS API Documentation
|
1948
|
+
#
|
1949
|
+
class GetAccuracyMetricsRequest < Struct.new(
|
1950
|
+
:predictor_arn)
|
1951
|
+
include Aws::Structure
|
1952
|
+
end
|
1953
|
+
|
1954
|
+
# @!attribute [rw] predictor_evaluation_results
|
1955
|
+
# An array of results from evaluating the predictor.
|
1956
|
+
# @return [Array<Types::EvaluationResult>]
|
1957
|
+
#
|
1958
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/GetAccuracyMetricsResponse AWS API Documentation
|
1959
|
+
#
|
1960
|
+
class GetAccuracyMetricsResponse < Struct.new(
|
1961
|
+
:predictor_evaluation_results)
|
1962
|
+
include Aws::Structure
|
1963
|
+
end
|
1964
|
+
|
1965
|
+
# Configuration information for a hyperparameter tuning job. This object
|
1966
|
+
# is specified in the CreatePredictor request.
|
1967
|
+
#
|
1968
|
+
# A hyperparameter is a parameter that governs the model training
|
1969
|
+
# process and is set before training starts. This is as opposed to a
|
1970
|
+
# model parameter that is determined during training. The values of the
|
1971
|
+
# hyperparameters have an effect on the chosen model parameters.
|
1972
|
+
#
|
1973
|
+
# A hyperparameter tuning job is the process of choosing the optimum set
|
1974
|
+
# of hyperparameter values that optimize a specified metric. This is
|
1975
|
+
# accomplished by running many training jobs over a range of
|
1976
|
+
# hyperparameter values. The optimum set of values is dependent on the
|
1977
|
+
# algorithm, the training data, and the given metric objective.
|
1978
|
+
#
|
1979
|
+
# @note When making an API call, you may pass HyperParameterTuningJobConfig
|
1980
|
+
# data as a hash:
|
1981
|
+
#
|
1982
|
+
# {
|
1983
|
+
# parameter_ranges: {
|
1984
|
+
# categorical_parameter_ranges: [
|
1985
|
+
# {
|
1986
|
+
# name: "Name", # required
|
1987
|
+
# values: ["Value"], # required
|
1988
|
+
# },
|
1989
|
+
# ],
|
1990
|
+
# continuous_parameter_ranges: [
|
1991
|
+
# {
|
1992
|
+
# name: "Name", # required
|
1993
|
+
# max_value: 1.0, # required
|
1994
|
+
# min_value: 1.0, # required
|
1995
|
+
# scaling_type: "Auto", # accepts Auto, Linear, Logarithmic, ReverseLogarithmic
|
1996
|
+
# },
|
1997
|
+
# ],
|
1998
|
+
# integer_parameter_ranges: [
|
1999
|
+
# {
|
2000
|
+
# name: "Name", # required
|
2001
|
+
# max_value: 1, # required
|
2002
|
+
# min_value: 1, # required
|
2003
|
+
# scaling_type: "Auto", # accepts Auto, Linear, Logarithmic, ReverseLogarithmic
|
2004
|
+
# },
|
2005
|
+
# ],
|
2006
|
+
# },
|
2007
|
+
# }
|
2008
|
+
#
|
2009
|
+
# @!attribute [rw] parameter_ranges
|
2010
|
+
# Specifies the ranges of valid values for the hyperparameters.
|
2011
|
+
# @return [Types::ParameterRanges]
|
2012
|
+
#
|
2013
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/HyperParameterTuningJobConfig AWS API Documentation
|
2014
|
+
#
|
2015
|
+
class HyperParameterTuningJobConfig < Struct.new(
|
2016
|
+
:parameter_ranges)
|
2017
|
+
include Aws::Structure
|
2018
|
+
end
|
2019
|
+
|
2020
|
+
# The data used to train a predictor. The data includes a dataset group
|
2021
|
+
# and any supplementary features. This object is specified in the
|
2022
|
+
# CreatePredictor request.
|
2023
|
+
#
|
2024
|
+
# @note When making an API call, you may pass InputDataConfig
|
2025
|
+
# data as a hash:
|
2026
|
+
#
|
2027
|
+
# {
|
2028
|
+
# dataset_group_arn: "Arn", # required
|
2029
|
+
# supplementary_features: [
|
2030
|
+
# {
|
2031
|
+
# name: "Name", # required
|
2032
|
+
# value: "Value", # required
|
2033
|
+
# },
|
2034
|
+
# ],
|
2035
|
+
# }
|
2036
|
+
#
|
2037
|
+
# @!attribute [rw] dataset_group_arn
|
2038
|
+
# The Amazon Resource Name (ARN) of the dataset group.
|
2039
|
+
# @return [String]
|
2040
|
+
#
|
2041
|
+
# @!attribute [rw] supplementary_features
|
2042
|
+
# An array of supplementary features. For this release, the only
|
2043
|
+
# supported feature is a holiday calendar.
|
2044
|
+
# @return [Array<Types::SupplementaryFeature>]
|
2045
|
+
#
|
2046
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/InputDataConfig AWS API Documentation
|
2047
|
+
#
|
2048
|
+
class InputDataConfig < Struct.new(
|
2049
|
+
:dataset_group_arn,
|
2050
|
+
:supplementary_features)
|
2051
|
+
include Aws::Structure
|
2052
|
+
end
|
2053
|
+
|
2054
|
+
# Specifies an integer hyperparameter and it's range of tunable values.
|
2055
|
+
# This object is part of the ParameterRanges object.
|
2056
|
+
#
|
2057
|
+
# @note When making an API call, you may pass IntegerParameterRange
|
2058
|
+
# data as a hash:
|
2059
|
+
#
|
2060
|
+
# {
|
2061
|
+
# name: "Name", # required
|
2062
|
+
# max_value: 1, # required
|
2063
|
+
# min_value: 1, # required
|
2064
|
+
# scaling_type: "Auto", # accepts Auto, Linear, Logarithmic, ReverseLogarithmic
|
2065
|
+
# }
|
2066
|
+
#
|
2067
|
+
# @!attribute [rw] name
|
2068
|
+
# The name of the hyperparameter to tune.
|
2069
|
+
# @return [String]
|
2070
|
+
#
|
2071
|
+
# @!attribute [rw] max_value
|
2072
|
+
# The maximum tunable value of the hyperparameter.
|
2073
|
+
# @return [Integer]
|
2074
|
+
#
|
2075
|
+
# @!attribute [rw] min_value
|
2076
|
+
# The minimum tunable value of the hyperparameter.
|
2077
|
+
# @return [Integer]
|
2078
|
+
#
|
2079
|
+
# @!attribute [rw] scaling_type
|
2080
|
+
# The scale that hyperparameter tuning uses to search the
|
2081
|
+
# hyperparameter range. For information about choosing a
|
2082
|
+
# hyperparameter scale, see [Hyperparameter Scaling][1]. One of the
|
2083
|
+
# following values:
|
2084
|
+
#
|
2085
|
+
# Auto
|
2086
|
+
#
|
2087
|
+
# : Amazon Forecast hyperparameter tuning chooses the best scale for
|
2088
|
+
# the hyperparameter.
|
2089
|
+
#
|
2090
|
+
# Linear
|
2091
|
+
#
|
2092
|
+
# : Hyperparameter tuning searches the values in the hyperparameter
|
2093
|
+
# range by using a linear scale.
|
2094
|
+
#
|
2095
|
+
# Logarithmic
|
2096
|
+
#
|
2097
|
+
# : Hyperparameter tuning searches the values in the hyperparameter
|
2098
|
+
# range by using a logarithmic scale.
|
2099
|
+
#
|
2100
|
+
# Logarithmic scaling works only for ranges that have only values
|
2101
|
+
# greater than 0.
|
2102
|
+
#
|
2103
|
+
# ReverseLogarithmic
|
2104
|
+
#
|
2105
|
+
# : Not supported for `IntegerParameterRange`.
|
2106
|
+
#
|
2107
|
+
# Reverse logarithmic scaling works only for ranges that are
|
2108
|
+
# entirely within the range 0 <= x < 1.0.
|
2109
|
+
#
|
2110
|
+
#
|
2111
|
+
#
|
2112
|
+
# [1]: http://docs.aws.amazon.com/sagemaker/latest/dg/automatic-model-tuning-define-ranges.html#scaling-type
|
2113
|
+
# @return [String]
|
2114
|
+
#
|
2115
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/IntegerParameterRange AWS API Documentation
|
2116
|
+
#
|
2117
|
+
class IntegerParameterRange < Struct.new(
|
2118
|
+
:name,
|
2119
|
+
:max_value,
|
2120
|
+
:min_value,
|
2121
|
+
:scaling_type)
|
2122
|
+
include Aws::Structure
|
2123
|
+
end
|
2124
|
+
|
2125
|
+
# We can't process the request because it includes an invalid value or
|
2126
|
+
# a value that exceeds the valid range.
|
2127
|
+
#
|
2128
|
+
# @!attribute [rw] message
|
2129
|
+
# @return [String]
|
2130
|
+
#
|
2131
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/InvalidInputException AWS API Documentation
|
2132
|
+
#
|
2133
|
+
class InvalidInputException < Struct.new(
|
2134
|
+
:message)
|
2135
|
+
include Aws::Structure
|
2136
|
+
end
|
2137
|
+
|
2138
|
+
# The token is not valid. Tokens expire after 24 hours.
|
2139
|
+
#
|
2140
|
+
# @!attribute [rw] message
|
2141
|
+
# @return [String]
|
2142
|
+
#
|
2143
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/InvalidNextTokenException AWS API Documentation
|
2144
|
+
#
|
2145
|
+
class InvalidNextTokenException < Struct.new(
|
2146
|
+
:message)
|
2147
|
+
include Aws::Structure
|
2148
|
+
end
|
2149
|
+
|
2150
|
+
# The limit on the number of requests per second has been exceeded.
|
2151
|
+
#
|
2152
|
+
# @!attribute [rw] message
|
2153
|
+
# @return [String]
|
2154
|
+
#
|
2155
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/LimitExceededException AWS API Documentation
|
2156
|
+
#
|
2157
|
+
class LimitExceededException < Struct.new(
|
2158
|
+
:message)
|
2159
|
+
include Aws::Structure
|
2160
|
+
end
|
2161
|
+
|
2162
|
+
# @note When making an API call, you may pass ListDatasetGroupsRequest
|
2163
|
+
# data as a hash:
|
2164
|
+
#
|
2165
|
+
# {
|
2166
|
+
# next_token: "NextToken",
|
2167
|
+
# max_results: 1,
|
2168
|
+
# }
|
2169
|
+
#
|
2170
|
+
# @!attribute [rw] next_token
|
2171
|
+
# If the result of the previous request was truncated, the response
|
2172
|
+
# includes a `NextToken`. To retrieve the next set of results, use the
|
2173
|
+
# token in the next request. Tokens expire after 24 hours.
|
2174
|
+
# @return [String]
|
2175
|
+
#
|
2176
|
+
# @!attribute [rw] max_results
|
2177
|
+
# The number of items to return in the response.
|
2178
|
+
# @return [Integer]
|
2179
|
+
#
|
2180
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/ListDatasetGroupsRequest AWS API Documentation
|
2181
|
+
#
|
2182
|
+
class ListDatasetGroupsRequest < Struct.new(
|
2183
|
+
:next_token,
|
2184
|
+
:max_results)
|
2185
|
+
include Aws::Structure
|
2186
|
+
end
|
2187
|
+
|
2188
|
+
# @!attribute [rw] dataset_groups
|
2189
|
+
# An array of objects that summarize each dataset group's properties.
|
2190
|
+
# @return [Array<Types::DatasetGroupSummary>]
|
2191
|
+
#
|
2192
|
+
# @!attribute [rw] next_token
|
2193
|
+
# If the response is truncated, Amazon Forecast returns this token. To
|
2194
|
+
# retrieve the next set of results, use the token in the next request.
|
2195
|
+
# @return [String]
|
2196
|
+
#
|
2197
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/ListDatasetGroupsResponse AWS API Documentation
|
2198
|
+
#
|
2199
|
+
class ListDatasetGroupsResponse < Struct.new(
|
2200
|
+
:dataset_groups,
|
2201
|
+
:next_token)
|
2202
|
+
include Aws::Structure
|
2203
|
+
end
|
2204
|
+
|
2205
|
+
# @note When making an API call, you may pass ListDatasetImportJobsRequest
|
2206
|
+
# data as a hash:
|
2207
|
+
#
|
2208
|
+
# {
|
2209
|
+
# next_token: "NextToken",
|
2210
|
+
# max_results: 1,
|
2211
|
+
# filters: [
|
2212
|
+
# {
|
2213
|
+
# key: "String", # required
|
2214
|
+
# value: "Arn", # required
|
2215
|
+
# condition: "IS", # required, accepts IS, IS_NOT
|
2216
|
+
# },
|
2217
|
+
# ],
|
2218
|
+
# }
|
2219
|
+
#
|
2220
|
+
# @!attribute [rw] next_token
|
2221
|
+
# If the result of the previous request was truncated, the response
|
2222
|
+
# includes a `NextToken`. To retrieve the next set of results, use the
|
2223
|
+
# token in the next request. Tokens expire after 24 hours.
|
2224
|
+
# @return [String]
|
2225
|
+
#
|
2226
|
+
# @!attribute [rw] max_results
|
2227
|
+
# The number of items to return in the response.
|
2228
|
+
# @return [Integer]
|
2229
|
+
#
|
2230
|
+
# @!attribute [rw] filters
|
2231
|
+
# An array of filters. For each filter, you provide a condition and a
|
2232
|
+
# match statement. The condition is either `IS` or `IS_NOT`, which
|
2233
|
+
# specifies whether to include or exclude, respectively, from the
|
2234
|
+
# list, the predictors that match the statement. The match statement
|
2235
|
+
# consists of a key and a value. In this release, `Name` is the only
|
2236
|
+
# valid key, which filters on the `DatasetImportJobName` property.
|
2237
|
+
#
|
2238
|
+
# * `Condition` - `IS` or `IS_NOT`
|
2239
|
+
#
|
2240
|
+
# * `Key` - `Name`
|
2241
|
+
#
|
2242
|
+
# * `Value` - the value to match
|
2243
|
+
#
|
2244
|
+
# For example, to list all dataset import jobs named
|
2245
|
+
# *my\_dataset\_import\_job*, you would specify:
|
2246
|
+
#
|
2247
|
+
# `"Filters": [ \{ "Condition": "IS", "Key": "Name", "Value":
|
2248
|
+
# "my_dataset_import_job" \} ]`
|
2249
|
+
# @return [Array<Types::Filter>]
|
2250
|
+
#
|
2251
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/ListDatasetImportJobsRequest AWS API Documentation
|
2252
|
+
#
|
2253
|
+
class ListDatasetImportJobsRequest < Struct.new(
|
2254
|
+
:next_token,
|
2255
|
+
:max_results,
|
2256
|
+
:filters)
|
2257
|
+
include Aws::Structure
|
2258
|
+
end
|
2259
|
+
|
2260
|
+
# @!attribute [rw] dataset_import_jobs
|
2261
|
+
# An array of objects that summarize each dataset import job's
|
2262
|
+
# properties.
|
2263
|
+
# @return [Array<Types::DatasetImportJobSummary>]
|
2264
|
+
#
|
2265
|
+
# @!attribute [rw] next_token
|
2266
|
+
# If the response is truncated, Amazon Forecast returns this token. To
|
2267
|
+
# retrieve the next set of results, use the token in the next request.
|
2268
|
+
# @return [String]
|
2269
|
+
#
|
2270
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/ListDatasetImportJobsResponse AWS API Documentation
|
2271
|
+
#
|
2272
|
+
class ListDatasetImportJobsResponse < Struct.new(
|
2273
|
+
:dataset_import_jobs,
|
2274
|
+
:next_token)
|
2275
|
+
include Aws::Structure
|
2276
|
+
end
|
2277
|
+
|
2278
|
+
# @note When making an API call, you may pass ListDatasetsRequest
|
2279
|
+
# data as a hash:
|
2280
|
+
#
|
2281
|
+
# {
|
2282
|
+
# next_token: "NextToken",
|
2283
|
+
# max_results: 1,
|
2284
|
+
# }
|
2285
|
+
#
|
2286
|
+
# @!attribute [rw] next_token
|
2287
|
+
# If the result of the previous request was truncated, the response
|
2288
|
+
# includes a `NextToken`. To retrieve the next set of results, use the
|
2289
|
+
# token in the next request. Tokens expire after 24 hours.
|
2290
|
+
# @return [String]
|
2291
|
+
#
|
2292
|
+
# @!attribute [rw] max_results
|
2293
|
+
# The number of items to return in the response.
|
2294
|
+
# @return [Integer]
|
2295
|
+
#
|
2296
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/ListDatasetsRequest AWS API Documentation
|
2297
|
+
#
|
2298
|
+
class ListDatasetsRequest < Struct.new(
|
2299
|
+
:next_token,
|
2300
|
+
:max_results)
|
2301
|
+
include Aws::Structure
|
2302
|
+
end
|
2303
|
+
|
2304
|
+
# @!attribute [rw] datasets
|
2305
|
+
# An array of objects that summarize each dataset's properties.
|
2306
|
+
# @return [Array<Types::DatasetSummary>]
|
2307
|
+
#
|
2308
|
+
# @!attribute [rw] next_token
|
2309
|
+
# If the response is truncated, Amazon Forecast returns this token. To
|
2310
|
+
# retrieve the next set of results, use the token in the next request.
|
2311
|
+
# @return [String]
|
2312
|
+
#
|
2313
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/ListDatasetsResponse AWS API Documentation
|
2314
|
+
#
|
2315
|
+
class ListDatasetsResponse < Struct.new(
|
2316
|
+
:datasets,
|
2317
|
+
:next_token)
|
2318
|
+
include Aws::Structure
|
2319
|
+
end
|
2320
|
+
|
2321
|
+
# @note When making an API call, you may pass ListForecastExportJobsRequest
|
2322
|
+
# data as a hash:
|
2323
|
+
#
|
2324
|
+
# {
|
2325
|
+
# next_token: "NextToken",
|
2326
|
+
# max_results: 1,
|
2327
|
+
# filters: [
|
2328
|
+
# {
|
2329
|
+
# key: "String", # required
|
2330
|
+
# value: "Arn", # required
|
2331
|
+
# condition: "IS", # required, accepts IS, IS_NOT
|
2332
|
+
# },
|
2333
|
+
# ],
|
2334
|
+
# }
|
2335
|
+
#
|
2336
|
+
# @!attribute [rw] next_token
|
2337
|
+
# If the result of the previous request was truncated, the response
|
2338
|
+
# includes a `NextToken`. To retrieve the next set of results, use the
|
2339
|
+
# token in the next request. Tokens expire after 24 hours.
|
2340
|
+
# @return [String]
|
2341
|
+
#
|
2342
|
+
# @!attribute [rw] max_results
|
2343
|
+
# The number of items to return in the response.
|
2344
|
+
# @return [Integer]
|
2345
|
+
#
|
2346
|
+
# @!attribute [rw] filters
|
2347
|
+
# An array of filters. For each filter, you provide a condition and a
|
2348
|
+
# match statement. The condition is either `IS` or `IS_NOT`, which
|
2349
|
+
# specifies whether to include or exclude, respectively, from the
|
2350
|
+
# list, the predictors that match the statement. The match statement
|
2351
|
+
# consists of a key and a value. In this release, `Name` is the only
|
2352
|
+
# valid key, which filters on the `ForecastExportJobName` property.
|
2353
|
+
#
|
2354
|
+
# * `Condition` - `IS` or `IS_NOT`
|
2355
|
+
#
|
2356
|
+
# * `Key` - `Name`
|
2357
|
+
#
|
2358
|
+
# * `Value` - the value to match
|
2359
|
+
#
|
2360
|
+
# For example, to list all forecast export jobs named
|
2361
|
+
# *my\_forecast\_export\_job*, you would specify:
|
2362
|
+
#
|
2363
|
+
# `"Filters": [ \{ "Condition": "IS", "Key": "Name", "Value":
|
2364
|
+
# "my_forecast_export_job" \} ]`
|
2365
|
+
# @return [Array<Types::Filter>]
|
2366
|
+
#
|
2367
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/ListForecastExportJobsRequest AWS API Documentation
|
2368
|
+
#
|
2369
|
+
class ListForecastExportJobsRequest < Struct.new(
|
2370
|
+
:next_token,
|
2371
|
+
:max_results,
|
2372
|
+
:filters)
|
2373
|
+
include Aws::Structure
|
2374
|
+
end
|
2375
|
+
|
2376
|
+
# @!attribute [rw] forecast_export_jobs
|
2377
|
+
# An array of objects that summarize each export job's properties.
|
2378
|
+
# @return [Array<Types::ForecastExportJobSummary>]
|
2379
|
+
#
|
2380
|
+
# @!attribute [rw] next_token
|
2381
|
+
# If the response is truncated, Amazon Forecast returns this token. To
|
2382
|
+
# retrieve the next set of results, use the token in the next request.
|
2383
|
+
# @return [String]
|
2384
|
+
#
|
2385
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/ListForecastExportJobsResponse AWS API Documentation
|
2386
|
+
#
|
2387
|
+
class ListForecastExportJobsResponse < Struct.new(
|
2388
|
+
:forecast_export_jobs,
|
2389
|
+
:next_token)
|
2390
|
+
include Aws::Structure
|
2391
|
+
end
|
2392
|
+
|
2393
|
+
# @note When making an API call, you may pass ListForecastsRequest
|
2394
|
+
# data as a hash:
|
2395
|
+
#
|
2396
|
+
# {
|
2397
|
+
# next_token: "NextToken",
|
2398
|
+
# max_results: 1,
|
2399
|
+
# filters: [
|
2400
|
+
# {
|
2401
|
+
# key: "String", # required
|
2402
|
+
# value: "Arn", # required
|
2403
|
+
# condition: "IS", # required, accepts IS, IS_NOT
|
2404
|
+
# },
|
2405
|
+
# ],
|
2406
|
+
# }
|
2407
|
+
#
|
2408
|
+
# @!attribute [rw] next_token
|
2409
|
+
# If the result of the previous request was truncated, the response
|
2410
|
+
# includes a `NextToken`. To retrieve the next set of results, use the
|
2411
|
+
# token in the next request. Tokens expire after 24 hours.
|
2412
|
+
# @return [String]
|
2413
|
+
#
|
2414
|
+
# @!attribute [rw] max_results
|
2415
|
+
# The number of items to return in the response.
|
2416
|
+
# @return [Integer]
|
2417
|
+
#
|
2418
|
+
# @!attribute [rw] filters
|
2419
|
+
# An array of filters. For each filter, you provide a condition and a
|
2420
|
+
# match statement. The condition is either `IS` or `IS_NOT`, which
|
2421
|
+
# specifies whether to include or exclude, respectively, from the
|
2422
|
+
# list, the predictors that match the statement. The match statement
|
2423
|
+
# consists of a key and a value. In this release, `Name` is the only
|
2424
|
+
# valid key, which filters on the `ForecastName` property.
|
2425
|
+
#
|
2426
|
+
# * `Condition` - `IS` or `IS_NOT`
|
2427
|
+
#
|
2428
|
+
# * `Key` - `Name`
|
2429
|
+
#
|
2430
|
+
# * `Value` - the value to match
|
2431
|
+
#
|
2432
|
+
# For example, to list all forecasts named *my\_forecast*, you would
|
2433
|
+
# specify:
|
2434
|
+
#
|
2435
|
+
# `"Filters": [ \{ "Condition": "IS", "Key": "Name", "Value":
|
2436
|
+
# "my_forecast" \} ]`
|
2437
|
+
# @return [Array<Types::Filter>]
|
2438
|
+
#
|
2439
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/ListForecastsRequest AWS API Documentation
|
2440
|
+
#
|
2441
|
+
class ListForecastsRequest < Struct.new(
|
2442
|
+
:next_token,
|
2443
|
+
:max_results,
|
2444
|
+
:filters)
|
2445
|
+
include Aws::Structure
|
2446
|
+
end
|
2447
|
+
|
2448
|
+
# @!attribute [rw] forecasts
|
2449
|
+
# An array of objects that summarize each forecast's properties.
|
2450
|
+
# @return [Array<Types::ForecastSummary>]
|
2451
|
+
#
|
2452
|
+
# @!attribute [rw] next_token
|
2453
|
+
# If the response is truncated, Amazon Forecast returns this token. To
|
2454
|
+
# retrieve the next set of results, use the token in the next request.
|
2455
|
+
# @return [String]
|
2456
|
+
#
|
2457
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/ListForecastsResponse AWS API Documentation
|
2458
|
+
#
|
2459
|
+
class ListForecastsResponse < Struct.new(
|
2460
|
+
:forecasts,
|
2461
|
+
:next_token)
|
2462
|
+
include Aws::Structure
|
2463
|
+
end
|
2464
|
+
|
2465
|
+
# @note When making an API call, you may pass ListPredictorsRequest
|
2466
|
+
# data as a hash:
|
2467
|
+
#
|
2468
|
+
# {
|
2469
|
+
# next_token: "NextToken",
|
2470
|
+
# max_results: 1,
|
2471
|
+
# filters: [
|
2472
|
+
# {
|
2473
|
+
# key: "String", # required
|
2474
|
+
# value: "Arn", # required
|
2475
|
+
# condition: "IS", # required, accepts IS, IS_NOT
|
2476
|
+
# },
|
2477
|
+
# ],
|
2478
|
+
# }
|
2479
|
+
#
|
2480
|
+
# @!attribute [rw] next_token
|
2481
|
+
# If the result of the previous request was truncated, the response
|
2482
|
+
# includes a `NextToken`. To retrieve the next set of results, use the
|
2483
|
+
# token in the next request. Tokens expire after 24 hours.
|
2484
|
+
# @return [String]
|
2485
|
+
#
|
2486
|
+
# @!attribute [rw] max_results
|
2487
|
+
# The number of items to return in the response.
|
2488
|
+
# @return [Integer]
|
2489
|
+
#
|
2490
|
+
# @!attribute [rw] filters
|
2491
|
+
# An array of filters. For each filter, you provide a condition and a
|
2492
|
+
# match statement. The condition is either `IS` or `IS_NOT`, which
|
2493
|
+
# specifies whether to include or exclude, respectively, from the
|
2494
|
+
# list, the predictors that match the statement. The match statement
|
2495
|
+
# consists of a key and a value. In this release, `Name` is the only
|
2496
|
+
# valid key, which filters on the `PredictorName` property.
|
2497
|
+
#
|
2498
|
+
# * `Condition` - `IS` or `IS_NOT`
|
2499
|
+
#
|
2500
|
+
# * `Key` - `Name`
|
2501
|
+
#
|
2502
|
+
# * `Value` - the value to match
|
2503
|
+
#
|
2504
|
+
# For example, to list all predictors named *my\_predictor*, you would
|
2505
|
+
# specify:
|
2506
|
+
#
|
2507
|
+
# `"Filters": [ \{ "Condition": "IS", "Key": "Name", "Value":
|
2508
|
+
# "my_predictor" \} ]`
|
2509
|
+
# @return [Array<Types::Filter>]
|
2510
|
+
#
|
2511
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/ListPredictorsRequest AWS API Documentation
|
2512
|
+
#
|
2513
|
+
class ListPredictorsRequest < Struct.new(
|
2514
|
+
:next_token,
|
2515
|
+
:max_results,
|
2516
|
+
:filters)
|
2517
|
+
include Aws::Structure
|
2518
|
+
end
|
2519
|
+
|
2520
|
+
# @!attribute [rw] predictors
|
2521
|
+
# An array of objects that summarize each predictor's properties.
|
2522
|
+
# @return [Array<Types::PredictorSummary>]
|
2523
|
+
#
|
2524
|
+
# @!attribute [rw] next_token
|
2525
|
+
# If the response is truncated, Amazon Forecast returns this token. To
|
2526
|
+
# retrieve the next set of results, use the token in the next request.
|
2527
|
+
# @return [String]
|
2528
|
+
#
|
2529
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/ListPredictorsResponse AWS API Documentation
|
2530
|
+
#
|
2531
|
+
class ListPredictorsResponse < Struct.new(
|
2532
|
+
:predictors,
|
2533
|
+
:next_token)
|
2534
|
+
include Aws::Structure
|
2535
|
+
end
|
2536
|
+
|
2537
|
+
# Provides metrics used to evaluate the performance of a predictor. This
|
2538
|
+
# object is part of the WindowSummary object.
|
2539
|
+
#
|
2540
|
+
# @!attribute [rw] rmse
|
2541
|
+
# The root mean square error (RMSE).
|
2542
|
+
# @return [Float]
|
2543
|
+
#
|
2544
|
+
# @!attribute [rw] weighted_quantile_losses
|
2545
|
+
# An array of weighted quantile losses. Quantiles divide a probability
|
2546
|
+
# distribution into regions of equal probability. The distribution in
|
2547
|
+
# this case is the loss function.
|
2548
|
+
# @return [Array<Types::WeightedQuantileLoss>]
|
2549
|
+
#
|
2550
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/Metrics AWS API Documentation
|
2551
|
+
#
|
2552
|
+
class Metrics < Struct.new(
|
2553
|
+
:rmse,
|
2554
|
+
:weighted_quantile_losses)
|
2555
|
+
include Aws::Structure
|
2556
|
+
end
|
2557
|
+
|
2558
|
+
# Specifies the categorical, continuous, and integer hyperparameters,
|
2559
|
+
# and their ranges of tunable values. The range of tunable values
|
2560
|
+
# determines which values that a hyperparameter tuning job can choose
|
2561
|
+
# for the specified hyperparameter. This object is part of the
|
2562
|
+
# HyperParameterTuningJobConfig object.
|
2563
|
+
#
|
2564
|
+
# @note When making an API call, you may pass ParameterRanges
|
2565
|
+
# data as a hash:
|
2566
|
+
#
|
2567
|
+
# {
|
2568
|
+
# categorical_parameter_ranges: [
|
2569
|
+
# {
|
2570
|
+
# name: "Name", # required
|
2571
|
+
# values: ["Value"], # required
|
2572
|
+
# },
|
2573
|
+
# ],
|
2574
|
+
# continuous_parameter_ranges: [
|
2575
|
+
# {
|
2576
|
+
# name: "Name", # required
|
2577
|
+
# max_value: 1.0, # required
|
2578
|
+
# min_value: 1.0, # required
|
2579
|
+
# scaling_type: "Auto", # accepts Auto, Linear, Logarithmic, ReverseLogarithmic
|
2580
|
+
# },
|
2581
|
+
# ],
|
2582
|
+
# integer_parameter_ranges: [
|
2583
|
+
# {
|
2584
|
+
# name: "Name", # required
|
2585
|
+
# max_value: 1, # required
|
2586
|
+
# min_value: 1, # required
|
2587
|
+
# scaling_type: "Auto", # accepts Auto, Linear, Logarithmic, ReverseLogarithmic
|
2588
|
+
# },
|
2589
|
+
# ],
|
2590
|
+
# }
|
2591
|
+
#
|
2592
|
+
# @!attribute [rw] categorical_parameter_ranges
|
2593
|
+
# Specifies the tunable range for each categorical hyperparameter.
|
2594
|
+
# @return [Array<Types::CategoricalParameterRange>]
|
2595
|
+
#
|
2596
|
+
# @!attribute [rw] continuous_parameter_ranges
|
2597
|
+
# Specifies the tunable range for each continuous hyperparameter.
|
2598
|
+
# @return [Array<Types::ContinuousParameterRange>]
|
2599
|
+
#
|
2600
|
+
# @!attribute [rw] integer_parameter_ranges
|
2601
|
+
# Specifies the tunable range for each integer hyperparameter.
|
2602
|
+
# @return [Array<Types::IntegerParameterRange>]
|
2603
|
+
#
|
2604
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/ParameterRanges AWS API Documentation
|
2605
|
+
#
|
2606
|
+
class ParameterRanges < Struct.new(
|
2607
|
+
:categorical_parameter_ranges,
|
2608
|
+
:continuous_parameter_ranges,
|
2609
|
+
:integer_parameter_ranges)
|
2610
|
+
include Aws::Structure
|
2611
|
+
end
|
2612
|
+
|
2613
|
+
# Provides a summary of the predictor properties used in the
|
2614
|
+
# ListPredictors operation. To get the complete set of properties, call
|
2615
|
+
# the DescribePredictor operation, and provide the listed
|
2616
|
+
# `PredictorArn`.
|
2617
|
+
#
|
2618
|
+
# @!attribute [rw] predictor_arn
|
2619
|
+
# The ARN of the predictor.
|
2620
|
+
# @return [String]
|
2621
|
+
#
|
2622
|
+
# @!attribute [rw] predictor_name
|
2623
|
+
# The name of the predictor.
|
2624
|
+
# @return [String]
|
2625
|
+
#
|
2626
|
+
# @!attribute [rw] dataset_group_arn
|
2627
|
+
# The Amazon Resource Name (ARN) of the dataset group that contains
|
2628
|
+
# the data used to train the predictor.
|
2629
|
+
# @return [String]
|
2630
|
+
#
|
2631
|
+
# @!attribute [rw] status
|
2632
|
+
# The status of the predictor. States include:
|
2633
|
+
#
|
2634
|
+
# * `ACTIVE`
|
2635
|
+
#
|
2636
|
+
# * `CREATE_PENDING`, `CREATE_IN_PROGRESS`, `CREATE_FAILED`
|
2637
|
+
#
|
2638
|
+
# * `DELETE_PENDING`, `DELETE_IN_PROGRESS`, `DELETE_FAILED`
|
2639
|
+
#
|
2640
|
+
# * `UPDATE_PENDING`, `UPDATE_IN_PROGRESS`, `UPDATE_FAILED`
|
2641
|
+
#
|
2642
|
+
# <note markdown="1"> The `Status` of the predictor must be `ACTIVE` before using the
|
2643
|
+
# predictor to create a forecast.
|
2644
|
+
#
|
2645
|
+
# </note>
|
2646
|
+
# @return [String]
|
2647
|
+
#
|
2648
|
+
# @!attribute [rw] message
|
2649
|
+
# If an error occurred, an informational message about the error.
|
2650
|
+
# @return [String]
|
2651
|
+
#
|
2652
|
+
# @!attribute [rw] creation_time
|
2653
|
+
# When the model training task was created.
|
2654
|
+
# @return [Time]
|
2655
|
+
#
|
2656
|
+
# @!attribute [rw] last_modification_time
|
2657
|
+
# Initially, the same as `CreationTime` (status is `CREATE_PENDING`).
|
2658
|
+
# Updated when training starts (status changed to
|
2659
|
+
# `CREATE_IN_PROGRESS`), and when training is complete (status changed
|
2660
|
+
# to `ACTIVE`) or fails (status changed to `CREATE_FAILED`).
|
2661
|
+
# @return [Time]
|
2662
|
+
#
|
2663
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/PredictorSummary AWS API Documentation
|
2664
|
+
#
|
2665
|
+
class PredictorSummary < Struct.new(
|
2666
|
+
:predictor_arn,
|
2667
|
+
:predictor_name,
|
2668
|
+
:dataset_group_arn,
|
2669
|
+
:status,
|
2670
|
+
:message,
|
2671
|
+
:creation_time,
|
2672
|
+
:last_modification_time)
|
2673
|
+
include Aws::Structure
|
2674
|
+
end
|
2675
|
+
|
2676
|
+
# There is already a resource with that Amazon Resource Name (ARN). Try
|
2677
|
+
# again with a different ARN.
|
2678
|
+
#
|
2679
|
+
# @!attribute [rw] message
|
2680
|
+
# @return [String]
|
2681
|
+
#
|
2682
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/ResourceAlreadyExistsException AWS API Documentation
|
2683
|
+
#
|
2684
|
+
class ResourceAlreadyExistsException < Struct.new(
|
2685
|
+
:message)
|
2686
|
+
include Aws::Structure
|
2687
|
+
end
|
2688
|
+
|
2689
|
+
# The specified resource is in use.
|
2690
|
+
#
|
2691
|
+
# @!attribute [rw] message
|
2692
|
+
# @return [String]
|
2693
|
+
#
|
2694
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/ResourceInUseException AWS API Documentation
|
2695
|
+
#
|
2696
|
+
class ResourceInUseException < Struct.new(
|
2697
|
+
:message)
|
2698
|
+
include Aws::Structure
|
2699
|
+
end
|
2700
|
+
|
2701
|
+
# We can't find a resource with that Amazon Resource Name (ARN). Check
|
2702
|
+
# the ARN and try again.
|
2703
|
+
#
|
2704
|
+
# @!attribute [rw] message
|
2705
|
+
# @return [String]
|
2706
|
+
#
|
2707
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/ResourceNotFoundException AWS API Documentation
|
2708
|
+
#
|
2709
|
+
class ResourceNotFoundException < Struct.new(
|
2710
|
+
:message)
|
2711
|
+
include Aws::Structure
|
2712
|
+
end
|
2713
|
+
|
2714
|
+
# The path to the file(s) in an Amazon Simple Storage Service (Amazon
|
2715
|
+
# S3) bucket, and an AWS Identity and Access Management (IAM) role that
|
2716
|
+
# Amazon Forecast can assume to access the file(s). Optionally, includes
|
2717
|
+
# an AWS Key Management Service (KMS) key. This object is submitted in
|
2718
|
+
# the CreateDatasetImportJob and CreateForecastExportJob requests.
|
2719
|
+
#
|
2720
|
+
# @note When making an API call, you may pass S3Config
|
2721
|
+
# data as a hash:
|
2722
|
+
#
|
2723
|
+
# {
|
2724
|
+
# path: "S3Path", # required
|
2725
|
+
# role_arn: "Arn", # required
|
2726
|
+
# kms_key_arn: "KMSKeyArn",
|
2727
|
+
# }
|
2728
|
+
#
|
2729
|
+
# @!attribute [rw] path
|
2730
|
+
# The path to an Amazon Simple Storage Service (Amazon S3) bucket or
|
2731
|
+
# file(s) in an Amazon S3 bucket.
|
2732
|
+
# @return [String]
|
2733
|
+
#
|
2734
|
+
# @!attribute [rw] role_arn
|
2735
|
+
# The ARN of the AWS Identity and Access Management (IAM) role that
|
2736
|
+
# Amazon Forecast can assume to access the Amazon S3 bucket or
|
2737
|
+
# file(s).
|
2738
|
+
#
|
2739
|
+
# Cross-account pass role is not allowed. If you pass a role that
|
2740
|
+
# doesn't belong to your account, an `InvalidInputException` is
|
2741
|
+
# thrown.
|
2742
|
+
# @return [String]
|
2743
|
+
#
|
2744
|
+
# @!attribute [rw] kms_key_arn
|
2745
|
+
# The Amazon Resource Name (ARN) of an AWS Key Management Service
|
2746
|
+
# (KMS) key.
|
2747
|
+
# @return [String]
|
2748
|
+
#
|
2749
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/S3Config AWS API Documentation
|
2750
|
+
#
|
2751
|
+
class S3Config < Struct.new(
|
2752
|
+
:path,
|
2753
|
+
:role_arn,
|
2754
|
+
:kms_key_arn)
|
2755
|
+
include Aws::Structure
|
2756
|
+
end
|
2757
|
+
|
2758
|
+
# Defines the fields of a dataset. This object is specified in the
|
2759
|
+
# CreateDataset request.
|
2760
|
+
#
|
2761
|
+
# @note When making an API call, you may pass Schema
|
2762
|
+
# data as a hash:
|
2763
|
+
#
|
2764
|
+
# {
|
2765
|
+
# attributes: [
|
2766
|
+
# {
|
2767
|
+
# attribute_name: "Name",
|
2768
|
+
# attribute_type: "string", # accepts string, integer, float, timestamp
|
2769
|
+
# },
|
2770
|
+
# ],
|
2771
|
+
# }
|
2772
|
+
#
|
2773
|
+
# @!attribute [rw] attributes
|
2774
|
+
# An array of attributes specifying the name and type of each field in
|
2775
|
+
# a dataset.
|
2776
|
+
# @return [Array<Types::SchemaAttribute>]
|
2777
|
+
#
|
2778
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/Schema AWS API Documentation
|
2779
|
+
#
|
2780
|
+
class Schema < Struct.new(
|
2781
|
+
:attributes)
|
2782
|
+
include Aws::Structure
|
2783
|
+
end
|
2784
|
+
|
2785
|
+
# An attribute of a schema, which defines a field of a dataset. A schema
|
2786
|
+
# attribute is required for every field in a dataset. The Schema object
|
2787
|
+
# contains an array of `SchemaAttribute` objects.
|
2788
|
+
#
|
2789
|
+
# @note When making an API call, you may pass SchemaAttribute
|
2790
|
+
# data as a hash:
|
2791
|
+
#
|
2792
|
+
# {
|
2793
|
+
# attribute_name: "Name",
|
2794
|
+
# attribute_type: "string", # accepts string, integer, float, timestamp
|
2795
|
+
# }
|
2796
|
+
#
|
2797
|
+
# @!attribute [rw] attribute_name
|
2798
|
+
# The name of the dataset field.
|
2799
|
+
# @return [String]
|
2800
|
+
#
|
2801
|
+
# @!attribute [rw] attribute_type
|
2802
|
+
# The data type of the field.
|
2803
|
+
# @return [String]
|
2804
|
+
#
|
2805
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/SchemaAttribute AWS API Documentation
|
2806
|
+
#
|
2807
|
+
class SchemaAttribute < Struct.new(
|
2808
|
+
:attribute_name,
|
2809
|
+
:attribute_type)
|
2810
|
+
include Aws::Structure
|
2811
|
+
end
|
2812
|
+
|
2813
|
+
# Provides statistics for each data field imported to an Amazon Forecast
|
2814
|
+
# dataset with the CreateDatasetImportJob operation.
|
2815
|
+
#
|
2816
|
+
# @!attribute [rw] count
|
2817
|
+
# The number of values in the field.
|
2818
|
+
# @return [Integer]
|
2819
|
+
#
|
2820
|
+
# @!attribute [rw] count_distinct
|
2821
|
+
# The number of distinct values in the field.
|
2822
|
+
# @return [Integer]
|
2823
|
+
#
|
2824
|
+
# @!attribute [rw] count_null
|
2825
|
+
# The number of null values in the field.
|
2826
|
+
# @return [Integer]
|
2827
|
+
#
|
2828
|
+
# @!attribute [rw] count_nan
|
2829
|
+
# The number of NAN (not a number) values in the field.
|
2830
|
+
# @return [Integer]
|
2831
|
+
#
|
2832
|
+
# @!attribute [rw] min
|
2833
|
+
# For a numeric field, the minimum value in the field.
|
2834
|
+
# @return [String]
|
2835
|
+
#
|
2836
|
+
# @!attribute [rw] max
|
2837
|
+
# For a numeric field, the maximum value in the field.
|
2838
|
+
# @return [String]
|
2839
|
+
#
|
2840
|
+
# @!attribute [rw] avg
|
2841
|
+
# For a numeric field, the average value in the field.
|
2842
|
+
# @return [Float]
|
2843
|
+
#
|
2844
|
+
# @!attribute [rw] stddev
|
2845
|
+
# For a numeric field, the standard deviation.
|
2846
|
+
# @return [Float]
|
2847
|
+
#
|
2848
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/Statistics AWS API Documentation
|
2849
|
+
#
|
2850
|
+
class Statistics < Struct.new(
|
2851
|
+
:count,
|
2852
|
+
:count_distinct,
|
2853
|
+
:count_null,
|
2854
|
+
:count_nan,
|
2855
|
+
:min,
|
2856
|
+
:max,
|
2857
|
+
:avg,
|
2858
|
+
:stddev)
|
2859
|
+
include Aws::Structure
|
2860
|
+
end
|
2861
|
+
|
2862
|
+
# Describes a supplementary feature of a dataset group. This object is
|
2863
|
+
# part of the InputDataConfig object.
|
2864
|
+
#
|
2865
|
+
# For this release, the only supported feature is a holiday calendar. If
|
2866
|
+
# the calendar is used, all data should belong to the same country as
|
2867
|
+
# the calendar. For the calendar data, see
|
2868
|
+
# [http://jollyday.sourceforge.net/data.html][1].
|
2869
|
+
#
|
2870
|
+
#
|
2871
|
+
#
|
2872
|
+
# [1]: http://jollyday.sourceforge.net/data.html
|
2873
|
+
#
|
2874
|
+
# @note When making an API call, you may pass SupplementaryFeature
|
2875
|
+
# data as a hash:
|
2876
|
+
#
|
2877
|
+
# {
|
2878
|
+
# name: "Name", # required
|
2879
|
+
# value: "Value", # required
|
2880
|
+
# }
|
2881
|
+
#
|
2882
|
+
# @!attribute [rw] name
|
2883
|
+
# The name of the feature. This must be "holiday".
|
2884
|
+
# @return [String]
|
2885
|
+
#
|
2886
|
+
# @!attribute [rw] value
|
2887
|
+
# One of the following 2 letter country codes:
|
2888
|
+
#
|
2889
|
+
# * "AU" - AUSTRALIA
|
2890
|
+
#
|
2891
|
+
# * "DE" - GERMANY
|
2892
|
+
#
|
2893
|
+
# * "JP" - JAPAN
|
2894
|
+
#
|
2895
|
+
# * "US" - UNITED\_STATES
|
2896
|
+
#
|
2897
|
+
# * "UK" - UNITED\_KINGDOM
|
2898
|
+
# @return [String]
|
2899
|
+
#
|
2900
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/SupplementaryFeature AWS API Documentation
|
2901
|
+
#
|
2902
|
+
class SupplementaryFeature < Struct.new(
|
2903
|
+
:name,
|
2904
|
+
:value)
|
2905
|
+
include Aws::Structure
|
2906
|
+
end
|
2907
|
+
|
2908
|
+
# @note When making an API call, you may pass UpdateDatasetGroupRequest
|
2909
|
+
# data as a hash:
|
2910
|
+
#
|
2911
|
+
# {
|
2912
|
+
# dataset_group_arn: "Arn", # required
|
2913
|
+
# dataset_arns: ["Arn"], # required
|
2914
|
+
# }
|
2915
|
+
#
|
2916
|
+
# @!attribute [rw] dataset_group_arn
|
2917
|
+
# The ARN of the dataset group.
|
2918
|
+
# @return [String]
|
2919
|
+
#
|
2920
|
+
# @!attribute [rw] dataset_arns
|
2921
|
+
# An array of Amazon Resource Names (ARNs) of the datasets to add to
|
2922
|
+
# the dataset group.
|
2923
|
+
# @return [Array<String>]
|
2924
|
+
#
|
2925
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/UpdateDatasetGroupRequest AWS API Documentation
|
2926
|
+
#
|
2927
|
+
class UpdateDatasetGroupRequest < Struct.new(
|
2928
|
+
:dataset_group_arn,
|
2929
|
+
:dataset_arns)
|
2930
|
+
include Aws::Structure
|
2931
|
+
end
|
2932
|
+
|
2933
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/UpdateDatasetGroupResponse AWS API Documentation
|
2934
|
+
#
|
2935
|
+
class UpdateDatasetGroupResponse < Aws::EmptyStructure; end
|
2936
|
+
|
2937
|
+
# The weighted loss value for a quantile. This object is part of the
|
2938
|
+
# Metrics object.
|
2939
|
+
#
|
2940
|
+
# @!attribute [rw] quantile
|
2941
|
+
# The quantile. Quantiles divide a probability distribution into
|
2942
|
+
# regions of equal probability. For example, if the distribution was
|
2943
|
+
# divided into 5 regions of equal probability, the quantiles would be
|
2944
|
+
# 0.2, 0.4, 0.6, and 0.8.
|
2945
|
+
# @return [Float]
|
2946
|
+
#
|
2947
|
+
# @!attribute [rw] loss_value
|
2948
|
+
# The difference between the predicted value and actual value over the
|
2949
|
+
# quantile, weighted (normalized) by dividing by the sum over all
|
2950
|
+
# quantiles.
|
2951
|
+
# @return [Float]
|
2952
|
+
#
|
2953
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/WeightedQuantileLoss AWS API Documentation
|
2954
|
+
#
|
2955
|
+
class WeightedQuantileLoss < Struct.new(
|
2956
|
+
:quantile,
|
2957
|
+
:loss_value)
|
2958
|
+
include Aws::Structure
|
2959
|
+
end
|
2960
|
+
|
2961
|
+
# The metrics for a time range within the evaluation portion of a
|
2962
|
+
# dataset. This object is part of the EvaluationResult object.
|
2963
|
+
#
|
2964
|
+
# The `TestWindowStart` and `TestWindowEnd` parameters are determined by
|
2965
|
+
# the `BackTestWindowOffset` parameter of the EvaluationParameters
|
2966
|
+
# object.
|
2967
|
+
#
|
2968
|
+
# @!attribute [rw] test_window_start
|
2969
|
+
# The timestamp that defines the start of the window.
|
2970
|
+
# @return [Time]
|
2971
|
+
#
|
2972
|
+
# @!attribute [rw] test_window_end
|
2973
|
+
# The timestamp that defines the end of the window.
|
2974
|
+
# @return [Time]
|
2975
|
+
#
|
2976
|
+
# @!attribute [rw] item_count
|
2977
|
+
# The number of data points within the window.
|
2978
|
+
# @return [Integer]
|
2979
|
+
#
|
2980
|
+
# @!attribute [rw] evaluation_type
|
2981
|
+
# The type of evaluation.
|
2982
|
+
#
|
2983
|
+
# * `SUMMARY` - The average metrics across all windows.
|
2984
|
+
#
|
2985
|
+
# * `COMPUTED` - The metrics for the specified window.
|
2986
|
+
# @return [String]
|
2987
|
+
#
|
2988
|
+
# @!attribute [rw] metrics
|
2989
|
+
# Provides metrics used to evaluate the performance of a predictor.
|
2990
|
+
# This object is part of the WindowSummary object.
|
2991
|
+
# @return [Types::Metrics]
|
2992
|
+
#
|
2993
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/WindowSummary AWS API Documentation
|
2994
|
+
#
|
2995
|
+
class WindowSummary < Struct.new(
|
2996
|
+
:test_window_start,
|
2997
|
+
:test_window_end,
|
2998
|
+
:item_count,
|
2999
|
+
:evaluation_type,
|
3000
|
+
:metrics)
|
3001
|
+
include Aws::Structure
|
3002
|
+
end
|
3003
|
+
|
3004
|
+
end
|
3005
|
+
end
|