aws-sdk-forecastservice 1.24.0 → 1.28.0

Sign up to get free protection for your applications and to get access to all the features.
@@ -10,6 +10,274 @@
10
10
  module Aws::ForecastService
11
11
  module Types
12
12
 
13
+ # Describes an additional dataset. This object is part of the DataConfig
14
+ # object. Forecast supports the Weather Index and Holidays additional
15
+ # datasets.
16
+ #
17
+ # **Weather Index**
18
+ #
19
+ # The Amazon Forecast Weather Index is a built-in dataset that
20
+ # incorporates historical and projected weather information into your
21
+ # model. The Weather Index supplements your datasets with over two years
22
+ # of historical weather data and up to 14 days of projected weather
23
+ # data. For more information, see [Amazon Forecast Weather Index][1].
24
+ #
25
+ # **Holidays**
26
+ #
27
+ # Holidays is a built-in dataset that incorporates national holiday
28
+ # information into your model. It provides native support for the
29
+ # holiday calendars of 66 countries. To view the holiday calendars,
30
+ # refer to the [Jollyday][2] library. For more information, see
31
+ # [Holidays Featurization][3].
32
+ #
33
+ #
34
+ #
35
+ # [1]: https://docs.aws.amazon.com/forecast/latest/dg/weather.html
36
+ # [2]: http://jollyday.sourceforge.net/data.html
37
+ # [3]: https://docs.aws.amazon.com/forecast/latest/dg/holidays.html
38
+ #
39
+ # @note When making an API call, you may pass AdditionalDataset
40
+ # data as a hash:
41
+ #
42
+ # {
43
+ # name: "Name", # required
44
+ # configuration: {
45
+ # "Name" => ["Value"],
46
+ # },
47
+ # }
48
+ #
49
+ # @!attribute [rw] name
50
+ # The name of the additional dataset. Valid names: `"holiday"` and
51
+ # `"weather"`.
52
+ # @return [String]
53
+ #
54
+ # @!attribute [rw] configuration
55
+ # **Weather Index**
56
+ #
57
+ # To enable the Weather Index, do not specify a value for
58
+ # `Configuration`.
59
+ #
60
+ # **Holidays**
61
+ #
62
+ # To enable Holidays, specify a country with one of the following
63
+ # two-letter country codes:
64
+ #
65
+ # * "AL" - ALBANIA
66
+ #
67
+ # * "AR" - ARGENTINA
68
+ #
69
+ # * "AT" - AUSTRIA
70
+ #
71
+ # * "AU" - AUSTRALIA
72
+ #
73
+ # * "BA" - BOSNIA HERZEGOVINA
74
+ #
75
+ # * "BE" - BELGIUM
76
+ #
77
+ # * "BG" - BULGARIA
78
+ #
79
+ # * "BO" - BOLIVIA
80
+ #
81
+ # * "BR" - BRAZIL
82
+ #
83
+ # * "BY" - BELARUS
84
+ #
85
+ # * "CA" - CANADA
86
+ #
87
+ # * "CL" - CHILE
88
+ #
89
+ # * "CO" - COLOMBIA
90
+ #
91
+ # * "CR" - COSTA RICA
92
+ #
93
+ # * "HR" - CROATIA
94
+ #
95
+ # * "CZ" - CZECH REPUBLIC
96
+ #
97
+ # * "DK" - DENMARK
98
+ #
99
+ # * "EC" - ECUADOR
100
+ #
101
+ # * "EE" - ESTONIA
102
+ #
103
+ # * "ET" - ETHIOPIA
104
+ #
105
+ # * "FI" - FINLAND
106
+ #
107
+ # * "FR" - FRANCE
108
+ #
109
+ # * "DE" - GERMANY
110
+ #
111
+ # * "GR" - GREECE
112
+ #
113
+ # * "HU" - HUNGARY
114
+ #
115
+ # * "IS" - ICELAND
116
+ #
117
+ # * "IN" - INDIA
118
+ #
119
+ # * "IE" - IRELAND
120
+ #
121
+ # * "IT" - ITALY
122
+ #
123
+ # * "JP" - JAPAN
124
+ #
125
+ # * "KZ" - KAZAKHSTAN
126
+ #
127
+ # * "KR" - KOREA
128
+ #
129
+ # * "LV" - LATVIA
130
+ #
131
+ # * "LI" - LIECHTENSTEIN
132
+ #
133
+ # * "LT" - LITHUANIA
134
+ #
135
+ # * "LU" - LUXEMBOURG
136
+ #
137
+ # * "MK" - MACEDONIA
138
+ #
139
+ # * "MT" - MALTA
140
+ #
141
+ # * "MX" - MEXICO
142
+ #
143
+ # * "MD" - MOLDOVA
144
+ #
145
+ # * "ME" - MONTENEGRO
146
+ #
147
+ # * "NL" - NETHERLANDS
148
+ #
149
+ # * "NZ" - NEW ZEALAND
150
+ #
151
+ # * "NI" - NICARAGUA
152
+ #
153
+ # * "NG" - NIGERIA
154
+ #
155
+ # * "NO" - NORWAY
156
+ #
157
+ # * "PA" - PANAMA
158
+ #
159
+ # * "PY" - PARAGUAY
160
+ #
161
+ # * "PE" - PERU
162
+ #
163
+ # * "PL" - POLAND
164
+ #
165
+ # * "PT" - PORTUGAL
166
+ #
167
+ # * "RO" - ROMANIA
168
+ #
169
+ # * "RU" - RUSSIA
170
+ #
171
+ # * "RS" - SERBIA
172
+ #
173
+ # * "SK" - SLOVAKIA
174
+ #
175
+ # * "SI" - SLOVENIA
176
+ #
177
+ # * "ZA" - SOUTH AFRICA
178
+ #
179
+ # * "ES" - SPAIN
180
+ #
181
+ # * "SE" - SWEDEN
182
+ #
183
+ # * "CH" - SWITZERLAND
184
+ #
185
+ # * "UA" - UKRAINE
186
+ #
187
+ # * "AE" - UNITED ARAB EMIRATES
188
+ #
189
+ # * "US" - UNITED STATES
190
+ #
191
+ # * "UK" - UNITED KINGDOM
192
+ #
193
+ # * "UY" - URUGUAY
194
+ #
195
+ # * "VE" - VENEZUELA
196
+ # @return [Hash<String,Array<String>>]
197
+ #
198
+ # @see http://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/AdditionalDataset AWS API Documentation
199
+ #
200
+ class AdditionalDataset < Struct.new(
201
+ :name,
202
+ :configuration)
203
+ SENSITIVE = []
204
+ include Aws::Structure
205
+ end
206
+
207
+ # Provides information about the method used to transform attributes.
208
+ #
209
+ # The following is an example using the RETAIL domain:
210
+ #
211
+ # `\{`
212
+ #
213
+ # `"AttributeName": "demand",`
214
+ #
215
+ # `"Transformations": \{"aggregation": "sum", "middlefill": "zero",
216
+ # "backfill": "zero"\}`
217
+ #
218
+ # `\}`
219
+ #
220
+ # @note When making an API call, you may pass AttributeConfig
221
+ # data as a hash:
222
+ #
223
+ # {
224
+ # attribute_name: "Name", # required
225
+ # transformations: { # required
226
+ # "Name" => "Value",
227
+ # },
228
+ # }
229
+ #
230
+ # @!attribute [rw] attribute_name
231
+ # The name of the attribute as specified in the schema. Amazon
232
+ # Forecast supports the target field of the target time series and the
233
+ # related time series datasets. For example, for the RETAIL domain,
234
+ # the target is `demand`.
235
+ # @return [String]
236
+ #
237
+ # @!attribute [rw] transformations
238
+ # The method parameters (key-value pairs), which are a map of override
239
+ # parameters. Specify these parameters to override the default values.
240
+ # Related Time Series attributes do not accept aggregation parameters.
241
+ #
242
+ # The following list shows the parameters and their valid values for
243
+ # the "filling" featurization method for a **Target Time Series**
244
+ # dataset. Default values are bolded.
245
+ #
246
+ # * `aggregation`\: **sum**, `avg`, `first`, `min`, `max`
247
+ #
248
+ # * `frontfill`\: **none**
249
+ #
250
+ # * `middlefill`\: **zero**, `nan` (not a number), `value`, `median`,
251
+ # `mean`, `min`, `max`
252
+ #
253
+ # * `backfill`\: **zero**, `nan`, `value`, `median`, `mean`, `min`,
254
+ # `max`
255
+ #
256
+ # The following list shows the parameters and their valid values for a
257
+ # **Related Time Series** featurization method (there are no
258
+ # defaults):
259
+ #
260
+ # * `middlefill`\: `zero`, `value`, `median`, `mean`, `min`, `max`
261
+ #
262
+ # * `backfill`\: `zero`, `value`, `median`, `mean`, `min`, `max`
263
+ #
264
+ # * `futurefill`\: `zero`, `value`, `median`, `mean`, `min`, `max`
265
+ #
266
+ # To set a filling method to a specific value, set the fill parameter
267
+ # to `value` and define the value in a corresponding `_value`
268
+ # parameter. For example, to set backfilling to a value of 2, include
269
+ # the following: `"backfill": "value"` and `"backfill_value":"2"`.
270
+ # @return [Hash<String,String>]
271
+ #
272
+ # @see http://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/AttributeConfig AWS API Documentation
273
+ #
274
+ class AttributeConfig < Struct.new(
275
+ :attribute_name,
276
+ :transformations)
277
+ SENSITIVE = []
278
+ include Aws::Structure
279
+ end
280
+
13
281
  # Specifies a categorical hyperparameter and it's range of tunable
14
282
  # values. This object is part of the ParameterRanges object.
15
283
  #
@@ -51,63 +319,236 @@ module Aws::ForecastService
51
319
  # scaling_type: "Auto", # accepts Auto, Linear, Logarithmic, ReverseLogarithmic
52
320
  # }
53
321
  #
54
- # @!attribute [rw] name
55
- # The name of the hyperparameter to tune.
322
+ # @!attribute [rw] name
323
+ # The name of the hyperparameter to tune.
324
+ # @return [String]
325
+ #
326
+ # @!attribute [rw] max_value
327
+ # The maximum tunable value of the hyperparameter.
328
+ # @return [Float]
329
+ #
330
+ # @!attribute [rw] min_value
331
+ # The minimum tunable value of the hyperparameter.
332
+ # @return [Float]
333
+ #
334
+ # @!attribute [rw] scaling_type
335
+ # The scale that hyperparameter tuning uses to search the
336
+ # hyperparameter range. Valid values:
337
+ #
338
+ # Auto
339
+ #
340
+ # : Amazon Forecast hyperparameter tuning chooses the best scale for
341
+ # the hyperparameter.
342
+ #
343
+ # Linear
344
+ #
345
+ # : Hyperparameter tuning searches the values in the hyperparameter
346
+ # range by using a linear scale.
347
+ #
348
+ # Logarithmic
349
+ #
350
+ # : Hyperparameter tuning searches the values in the hyperparameter
351
+ # range by using a logarithmic scale.
352
+ #
353
+ # Logarithmic scaling works only for ranges that have values greater
354
+ # than 0.
355
+ #
356
+ # ReverseLogarithmic
357
+ #
358
+ # : hyperparameter tuning searches the values in the hyperparameter
359
+ # range by using a reverse logarithmic scale.
360
+ #
361
+ # Reverse logarithmic scaling works only for ranges that are
362
+ # entirely within the range 0 &lt;= x &lt; 1.0.
363
+ #
364
+ # For information about choosing a hyperparameter scale, see
365
+ # [Hyperparameter Scaling][1]. One of the following values:
366
+ #
367
+ #
368
+ #
369
+ # [1]: http://docs.aws.amazon.com/sagemaker/latest/dg/automatic-model-tuning-define-ranges.html#scaling-type
370
+ # @return [String]
371
+ #
372
+ # @see http://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/ContinuousParameterRange AWS API Documentation
373
+ #
374
+ class ContinuousParameterRange < Struct.new(
375
+ :name,
376
+ :max_value,
377
+ :min_value,
378
+ :scaling_type)
379
+ SENSITIVE = []
380
+ include Aws::Structure
381
+ end
382
+
383
+ # @note When making an API call, you may pass CreateAutoPredictorRequest
384
+ # data as a hash:
385
+ #
386
+ # {
387
+ # predictor_name: "Name", # required
388
+ # forecast_horizon: 1,
389
+ # forecast_types: ["ForecastType"],
390
+ # forecast_dimensions: ["Name"],
391
+ # forecast_frequency: "Frequency",
392
+ # data_config: {
393
+ # dataset_group_arn: "Arn", # required
394
+ # attribute_configs: [
395
+ # {
396
+ # attribute_name: "Name", # required
397
+ # transformations: { # required
398
+ # "Name" => "Value",
399
+ # },
400
+ # },
401
+ # ],
402
+ # additional_datasets: [
403
+ # {
404
+ # name: "Name", # required
405
+ # configuration: {
406
+ # "Name" => ["Value"],
407
+ # },
408
+ # },
409
+ # ],
410
+ # },
411
+ # encryption_config: {
412
+ # role_arn: "Arn", # required
413
+ # kms_key_arn: "KMSKeyArn", # required
414
+ # },
415
+ # reference_predictor_arn: "Arn",
416
+ # optimization_metric: "WAPE", # accepts WAPE, RMSE, AverageWeightedQuantileLoss, MASE, MAPE
417
+ # explain_predictor: false,
418
+ # tags: [
419
+ # {
420
+ # key: "TagKey", # required
421
+ # value: "TagValue", # required
422
+ # },
423
+ # ],
424
+ # }
425
+ #
426
+ # @!attribute [rw] predictor_name
427
+ # A unique name for the predictor
428
+ # @return [String]
429
+ #
430
+ # @!attribute [rw] forecast_horizon
431
+ # The number of time-steps that the model predicts. The forecast
432
+ # horizon is also called the prediction length.
433
+ # @return [Integer]
434
+ #
435
+ # @!attribute [rw] forecast_types
436
+ # The forecast types used to train a predictor. You can specify up to
437
+ # five forecast types. Forecast types can be quantiles from 0.01 to
438
+ # 0.99, by increments of 0.01 or higher. You can also specify the mean
439
+ # forecast with `mean`.
440
+ # @return [Array<String>]
441
+ #
442
+ # @!attribute [rw] forecast_dimensions
443
+ # An array of dimension (field) names that specify how to group the
444
+ # generated forecast.
445
+ #
446
+ # For example, if you are generating forecasts for item sales across
447
+ # all your stores, and your dataset contains a `store_id` field, you
448
+ # would specify `store_id` as a dimension to group sales forecasts for
449
+ # each store.
450
+ # @return [Array<String>]
451
+ #
452
+ # @!attribute [rw] forecast_frequency
453
+ # The frequency of predictions in a forecast.
454
+ #
455
+ # Valid intervals are Y (Year), M (Month), W (Week), D (Day), H
456
+ # (Hour), 30min (30 minutes), 15min (15 minutes), 10min (10 minutes),
457
+ # 5min (5 minutes), and 1min (1 minute). For example, "Y" indicates
458
+ # every year and "5min" indicates every five minutes.
459
+ #
460
+ # The frequency must be greater than or equal to the
461
+ # TARGET\_TIME\_SERIES dataset frequency.
462
+ #
463
+ # When a RELATED\_TIME\_SERIES dataset is provided, the frequency must
464
+ # be equal to the RELATED\_TIME\_SERIES dataset frequency.
56
465
  # @return [String]
57
466
  #
58
- # @!attribute [rw] max_value
59
- # The maximum tunable value of the hyperparameter.
60
- # @return [Float]
61
- #
62
- # @!attribute [rw] min_value
63
- # The minimum tunable value of the hyperparameter.
64
- # @return [Float]
467
+ # @!attribute [rw] data_config
468
+ # The data configuration for your dataset group and any additional
469
+ # datasets.
470
+ # @return [Types::DataConfig]
65
471
  #
66
- # @!attribute [rw] scaling_type
67
- # The scale that hyperparameter tuning uses to search the
68
- # hyperparameter range. Valid values:
472
+ # @!attribute [rw] encryption_config
473
+ # An AWS Key Management Service (KMS) key and an AWS Identity and
474
+ # Access Management (IAM) role that Amazon Forecast can assume to
475
+ # access the key. You can specify this optional object in the
476
+ # CreateDataset and CreatePredictor requests.
477
+ # @return [Types::EncryptionConfig]
69
478
  #
70
- # Auto
479
+ # @!attribute [rw] reference_predictor_arn
480
+ # The ARN of the predictor to retrain or upgrade. This parameter is
481
+ # only used when retraining or upgrading a predictor. When creating a
482
+ # new predictor, do not specify a value for this parameter.
71
483
  #
72
- # : Amazon Forecast hyperparameter tuning chooses the best scale for
73
- # the hyperparameter.
484
+ # When upgrading or retraining a predictor, only specify values for
485
+ # the `ReferencePredictorArn` and `PredictorName`. The value for
486
+ # `PredictorName` must be a unique predictor name.
487
+ # @return [String]
74
488
  #
75
- # Linear
489
+ # @!attribute [rw] optimization_metric
490
+ # The accuracy metric used to optimize the predictor.
491
+ # @return [String]
76
492
  #
77
- # : Hyperparameter tuning searches the values in the hyperparameter
78
- # range by using a linear scale.
493
+ # @!attribute [rw] explain_predictor
494
+ # @return [Boolean]
79
495
  #
80
- # Logarithmic
496
+ # @!attribute [rw] tags
497
+ # Optional metadata to help you categorize and organize your
498
+ # predictors. Each tag consists of a key and an optional value, both
499
+ # of which you define. Tag keys and values are case sensitive.
81
500
  #
82
- # : Hyperparameter tuning searches the values in the hyperparameter
83
- # range by using a logarithmic scale.
501
+ # The following restrictions apply to tags:
84
502
  #
85
- # Logarithmic scaling works only for ranges that have values greater
86
- # than 0.
503
+ # * For each resource, each tag key must be unique and each tag key
504
+ # must have one value.
87
505
  #
88
- # ReverseLogarithmic
506
+ # * Maximum number of tags per resource: 50.
89
507
  #
90
- # : hyperparameter tuning searches the values in the hyperparameter
91
- # range by using a reverse logarithmic scale.
508
+ # * Maximum key length: 128 Unicode characters in UTF-8.
92
509
  #
93
- # Reverse logarithmic scaling works only for ranges that are
94
- # entirely within the range 0 &lt;= x &lt; 1.0.
510
+ # * Maximum value length: 256 Unicode characters in UTF-8.
95
511
  #
96
- # For information about choosing a hyperparameter scale, see
97
- # [Hyperparameter Scaling][1]. One of the following values:
512
+ # * Accepted characters: all letters and numbers, spaces representable
513
+ # in UTF-8, and + - = . \_ : / @. If your tagging schema is used
514
+ # across other services and resources, the character restrictions of
515
+ # those services also apply.
98
516
  #
517
+ # * Key prefixes cannot include any upper or lowercase combination of
518
+ # `aws:` or `AWS:`. Values can have this prefix. If a tag value has
519
+ # `aws` as its prefix but the key does not, Forecast considers it to
520
+ # be a user tag and will count against the limit of 50 tags. Tags
521
+ # with only the key prefix of `aws` do not count against your tags
522
+ # per resource limit. You cannot edit or delete tag keys with this
523
+ # prefix.
524
+ # @return [Array<Types::Tag>]
99
525
  #
526
+ # @see http://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/CreateAutoPredictorRequest AWS API Documentation
100
527
  #
101
- # [1]: http://docs.aws.amazon.com/sagemaker/latest/dg/automatic-model-tuning-define-ranges.html#scaling-type
528
+ class CreateAutoPredictorRequest < Struct.new(
529
+ :predictor_name,
530
+ :forecast_horizon,
531
+ :forecast_types,
532
+ :forecast_dimensions,
533
+ :forecast_frequency,
534
+ :data_config,
535
+ :encryption_config,
536
+ :reference_predictor_arn,
537
+ :optimization_metric,
538
+ :explain_predictor,
539
+ :tags)
540
+ SENSITIVE = []
541
+ include Aws::Structure
542
+ end
543
+
544
+ # @!attribute [rw] predictor_arn
545
+ # The Amazon Resource Name (ARN) of the predictor.
102
546
  # @return [String]
103
547
  #
104
- # @see http://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/ContinuousParameterRange AWS API Documentation
548
+ # @see http://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/CreateAutoPredictorResponse AWS API Documentation
105
549
  #
106
- class ContinuousParameterRange < Struct.new(
107
- :name,
108
- :max_value,
109
- :min_value,
110
- :scaling_type)
550
+ class CreateAutoPredictorResponse < Struct.new(
551
+ :predictor_arn)
111
552
  SENSITIVE = []
112
553
  include Aws::Structure
113
554
  end
@@ -424,74 +865,298 @@ module Aws::ForecastService
424
865
  # @return [String]
425
866
  #
426
867
  # @!attribute [rw] schema
427
- # The schema for the dataset. The schema attributes and their order
428
- # must match the fields in your data. The dataset `Domain` and
429
- # `DatasetType` that you choose determine the minimum required fields
430
- # in your training data. For information about the required fields for
431
- # a specific dataset domain and type, see howitworks-domains-ds-types.
868
+ # The schema for the dataset. The schema attributes and their order
869
+ # must match the fields in your data. The dataset `Domain` and
870
+ # `DatasetType` that you choose determine the minimum required fields
871
+ # in your training data. For information about the required fields for
872
+ # a specific dataset domain and type, see howitworks-domains-ds-types.
873
+ # @return [Types::Schema]
874
+ #
875
+ # @!attribute [rw] encryption_config
876
+ # An AWS Key Management Service (KMS) key and the AWS Identity and
877
+ # Access Management (IAM) role that Amazon Forecast can assume to
878
+ # access the key.
879
+ # @return [Types::EncryptionConfig]
880
+ #
881
+ # @!attribute [rw] tags
882
+ # The optional metadata that you apply to the dataset to help you
883
+ # categorize and organize them. Each tag consists of a key and an
884
+ # optional value, both of which you define.
885
+ #
886
+ # The following basic restrictions apply to tags:
887
+ #
888
+ # * Maximum number of tags per resource - 50.
889
+ #
890
+ # * For each resource, each tag key must be unique, and each tag key
891
+ # can have only one value.
892
+ #
893
+ # * Maximum key length - 128 Unicode characters in UTF-8.
894
+ #
895
+ # * Maximum value length - 256 Unicode characters in UTF-8.
896
+ #
897
+ # * If your tagging schema is used across multiple services and
898
+ # resources, remember that other services may have restrictions on
899
+ # allowed characters. Generally allowed characters are: letters,
900
+ # numbers, and spaces representable in UTF-8, and the following
901
+ # characters: + - = . \_ : / @.
902
+ #
903
+ # * Tag keys and values are case sensitive.
904
+ #
905
+ # * Do not use `aws:`, `AWS:`, or any upper or lowercase combination
906
+ # of such as a prefix for keys as it is reserved for AWS use. You
907
+ # cannot edit or delete tag keys with this prefix. Values can have
908
+ # this prefix. If a tag value has `aws` as its prefix but the key
909
+ # does not, then Forecast considers it to be a user tag and will
910
+ # count against the limit of 50 tags. Tags with only the key prefix
911
+ # of `aws` do not count against your tags per resource limit.
912
+ # @return [Array<Types::Tag>]
913
+ #
914
+ # @see http://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/CreateDatasetRequest AWS API Documentation
915
+ #
916
+ class CreateDatasetRequest < Struct.new(
917
+ :dataset_name,
918
+ :domain,
919
+ :dataset_type,
920
+ :data_frequency,
921
+ :schema,
922
+ :encryption_config,
923
+ :tags)
924
+ SENSITIVE = []
925
+ include Aws::Structure
926
+ end
927
+
928
+ # @!attribute [rw] dataset_arn
929
+ # The Amazon Resource Name (ARN) of the dataset.
930
+ # @return [String]
931
+ #
932
+ # @see http://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/CreateDatasetResponse AWS API Documentation
933
+ #
934
+ class CreateDatasetResponse < Struct.new(
935
+ :dataset_arn)
936
+ SENSITIVE = []
937
+ include Aws::Structure
938
+ end
939
+
940
+ # @note When making an API call, you may pass CreateExplainabilityExportRequest
941
+ # data as a hash:
942
+ #
943
+ # {
944
+ # explainability_export_name: "Name", # required
945
+ # explainability_arn: "Arn", # required
946
+ # destination: { # required
947
+ # s3_config: { # required
948
+ # path: "S3Path", # required
949
+ # role_arn: "Arn", # required
950
+ # kms_key_arn: "KMSKeyArn",
951
+ # },
952
+ # },
953
+ # tags: [
954
+ # {
955
+ # key: "TagKey", # required
956
+ # value: "TagValue", # required
957
+ # },
958
+ # ],
959
+ # }
960
+ #
961
+ # @!attribute [rw] explainability_export_name
962
+ # A unique name for the Explainability export.
963
+ # @return [String]
964
+ #
965
+ # @!attribute [rw] explainability_arn
966
+ # The Amazon Resource Name (ARN) of the Explainability to export.
967
+ # @return [String]
968
+ #
969
+ # @!attribute [rw] destination
970
+ # The destination for an export job. Provide an S3 path, an AWS
971
+ # Identity and Access Management (IAM) role that allows Amazon
972
+ # Forecast to access the location, and an AWS Key Management Service
973
+ # (KMS) key (optional).
974
+ # @return [Types::DataDestination]
975
+ #
976
+ # @!attribute [rw] tags
977
+ # Optional metadata to help you categorize and organize your
978
+ # resources. Each tag consists of a key and an optional value, both of
979
+ # which you define. Tag keys and values are case sensitive.
980
+ #
981
+ # The following restrictions apply to tags:
982
+ #
983
+ # * For each resource, each tag key must be unique and each tag key
984
+ # must have one value.
985
+ #
986
+ # * Maximum number of tags per resource: 50.
987
+ #
988
+ # * Maximum key length: 128 Unicode characters in UTF-8.
989
+ #
990
+ # * Maximum value length: 256 Unicode characters in UTF-8.
991
+ #
992
+ # * Accepted characters: all letters and numbers, spaces representable
993
+ # in UTF-8, and + - = . \_ : / @. If your tagging schema is used
994
+ # across other services and resources, the character restrictions of
995
+ # those services also apply.
996
+ #
997
+ # * Key prefixes cannot include any upper or lowercase combination of
998
+ # `aws:` or `AWS:`. Values can have this prefix. If a tag value has
999
+ # `aws` as its prefix but the key does not, Forecast considers it to
1000
+ # be a user tag and will count against the limit of 50 tags. Tags
1001
+ # with only the key prefix of `aws` do not count against your tags
1002
+ # per resource limit. You cannot edit or delete tag keys with this
1003
+ # prefix.
1004
+ # @return [Array<Types::Tag>]
1005
+ #
1006
+ # @see http://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/CreateExplainabilityExportRequest AWS API Documentation
1007
+ #
1008
+ class CreateExplainabilityExportRequest < Struct.new(
1009
+ :explainability_export_name,
1010
+ :explainability_arn,
1011
+ :destination,
1012
+ :tags)
1013
+ SENSITIVE = []
1014
+ include Aws::Structure
1015
+ end
1016
+
1017
+ # @!attribute [rw] explainability_export_arn
1018
+ # The Amazon Resource Name (ARN) of the export.
1019
+ # @return [String]
1020
+ #
1021
+ # @see http://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/CreateExplainabilityExportResponse AWS API Documentation
1022
+ #
1023
+ class CreateExplainabilityExportResponse < Struct.new(
1024
+ :explainability_export_arn)
1025
+ SENSITIVE = []
1026
+ include Aws::Structure
1027
+ end
1028
+
1029
+ # @note When making an API call, you may pass CreateExplainabilityRequest
1030
+ # data as a hash:
1031
+ #
1032
+ # {
1033
+ # explainability_name: "Name", # required
1034
+ # resource_arn: "Arn", # required
1035
+ # explainability_config: { # required
1036
+ # time_series_granularity: "ALL", # required, accepts ALL, SPECIFIC
1037
+ # time_point_granularity: "ALL", # required, accepts ALL, SPECIFIC
1038
+ # },
1039
+ # data_source: {
1040
+ # s3_config: { # required
1041
+ # path: "S3Path", # required
1042
+ # role_arn: "Arn", # required
1043
+ # kms_key_arn: "KMSKeyArn",
1044
+ # },
1045
+ # },
1046
+ # schema: {
1047
+ # attributes: [
1048
+ # {
1049
+ # attribute_name: "Name",
1050
+ # attribute_type: "string", # accepts string, integer, float, timestamp, geolocation
1051
+ # },
1052
+ # ],
1053
+ # },
1054
+ # enable_visualization: false,
1055
+ # start_date_time: "LocalDateTime",
1056
+ # end_date_time: "LocalDateTime",
1057
+ # tags: [
1058
+ # {
1059
+ # key: "TagKey", # required
1060
+ # value: "TagValue", # required
1061
+ # },
1062
+ # ],
1063
+ # }
1064
+ #
1065
+ # @!attribute [rw] explainability_name
1066
+ # A unique name for the Explainability.
1067
+ # @return [String]
1068
+ #
1069
+ # @!attribute [rw] resource_arn
1070
+ # The Amazon Resource Name (ARN) of the Predictor or Forecast used to
1071
+ # create the Explainability.
1072
+ # @return [String]
1073
+ #
1074
+ # @!attribute [rw] explainability_config
1075
+ # The configuration settings that define the granularity of time
1076
+ # series and time points for the Explainability.
1077
+ # @return [Types::ExplainabilityConfig]
1078
+ #
1079
+ # @!attribute [rw] data_source
1080
+ # The source of your training data, an AWS Identity and Access
1081
+ # Management (IAM) role that allows Amazon Forecast to access the data
1082
+ # and, optionally, an AWS Key Management Service (KMS) key. This
1083
+ # object is submitted in the CreateDatasetImportJob request.
1084
+ # @return [Types::DataSource]
1085
+ #
1086
+ # @!attribute [rw] schema
1087
+ # Defines the fields of a dataset. You specify this object in the
1088
+ # CreateDataset request.
432
1089
  # @return [Types::Schema]
433
1090
  #
434
- # @!attribute [rw] encryption_config
435
- # An AWS Key Management Service (KMS) key and the AWS Identity and
436
- # Access Management (IAM) role that Amazon Forecast can assume to
437
- # access the key.
438
- # @return [Types::EncryptionConfig]
1091
+ # @!attribute [rw] enable_visualization
1092
+ # Create an Expainability visualization that is viewable within the
1093
+ # AWS console.
1094
+ # @return [Boolean]
439
1095
  #
440
- # @!attribute [rw] tags
441
- # The optional metadata that you apply to the dataset to help you
442
- # categorize and organize them. Each tag consists of a key and an
443
- # optional value, both of which you define.
1096
+ # @!attribute [rw] start_date_time
1097
+ # If `TimePointGranularity` is set to `SPECIFIC`, define the first
1098
+ # point for the Explainability.
1099
+ # @return [String]
444
1100
  #
445
- # The following basic restrictions apply to tags:
1101
+ # @!attribute [rw] end_date_time
1102
+ # If `TimePointGranularity` is set to `SPECIFIC`, define the last time
1103
+ # point for the Explainability.
1104
+ # @return [String]
446
1105
  #
447
- # * Maximum number of tags per resource - 50.
1106
+ # @!attribute [rw] tags
1107
+ # Optional metadata to help you categorize and organize your
1108
+ # resources. Each tag consists of a key and an optional value, both of
1109
+ # which you define. Tag keys and values are case sensitive.
448
1110
  #
449
- # * For each resource, each tag key must be unique, and each tag key
450
- # can have only one value.
1111
+ # The following restrictions apply to tags:
451
1112
  #
452
- # * Maximum key length - 128 Unicode characters in UTF-8.
1113
+ # * For each resource, each tag key must be unique and each tag key
1114
+ # must have one value.
453
1115
  #
454
- # * Maximum value length - 256 Unicode characters in UTF-8.
1116
+ # * Maximum number of tags per resource: 50.
455
1117
  #
456
- # * If your tagging schema is used across multiple services and
457
- # resources, remember that other services may have restrictions on
458
- # allowed characters. Generally allowed characters are: letters,
459
- # numbers, and spaces representable in UTF-8, and the following
460
- # characters: + - = . \_ : / @.
1118
+ # * Maximum key length: 128 Unicode characters in UTF-8.
461
1119
  #
462
- # * Tag keys and values are case sensitive.
1120
+ # * Maximum value length: 256 Unicode characters in UTF-8.
463
1121
  #
464
- # * Do not use `aws:`, `AWS:`, or any upper or lowercase combination
465
- # of such as a prefix for keys as it is reserved for AWS use. You
466
- # cannot edit or delete tag keys with this prefix. Values can have
467
- # this prefix. If a tag value has `aws` as its prefix but the key
468
- # does not, then Forecast considers it to be a user tag and will
469
- # count against the limit of 50 tags. Tags with only the key prefix
470
- # of `aws` do not count against your tags per resource limit.
1122
+ # * Accepted characters: all letters and numbers, spaces representable
1123
+ # in UTF-8, and + - = . \_ : / @. If your tagging schema is used
1124
+ # across other services and resources, the character restrictions of
1125
+ # those services also apply.
1126
+ #
1127
+ # * Key prefixes cannot include any upper or lowercase combination of
1128
+ # `aws:` or `AWS:`. Values can have this prefix. If a tag value has
1129
+ # `aws` as its prefix but the key does not, Forecast considers it to
1130
+ # be a user tag and will count against the limit of 50 tags. Tags
1131
+ # with only the key prefix of `aws` do not count against your tags
1132
+ # per resource limit. You cannot edit or delete tag keys with this
1133
+ # prefix.
471
1134
  # @return [Array<Types::Tag>]
472
1135
  #
473
- # @see http://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/CreateDatasetRequest AWS API Documentation
1136
+ # @see http://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/CreateExplainabilityRequest AWS API Documentation
474
1137
  #
475
- class CreateDatasetRequest < Struct.new(
476
- :dataset_name,
477
- :domain,
478
- :dataset_type,
479
- :data_frequency,
1138
+ class CreateExplainabilityRequest < Struct.new(
1139
+ :explainability_name,
1140
+ :resource_arn,
1141
+ :explainability_config,
1142
+ :data_source,
480
1143
  :schema,
481
- :encryption_config,
1144
+ :enable_visualization,
1145
+ :start_date_time,
1146
+ :end_date_time,
482
1147
  :tags)
483
1148
  SENSITIVE = []
484
1149
  include Aws::Structure
485
1150
  end
486
1151
 
487
- # @!attribute [rw] dataset_arn
488
- # The Amazon Resource Name (ARN) of the dataset.
1152
+ # @!attribute [rw] explainability_arn
1153
+ # The Amazon Resource Name (ARN) of the Explainability.
489
1154
  # @return [String]
490
1155
  #
491
- # @see http://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/CreateDatasetResponse AWS API Documentation
1156
+ # @see http://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/CreateExplainabilityResponse AWS API Documentation
492
1157
  #
493
- class CreateDatasetResponse < Struct.new(
494
- :dataset_arn)
1158
+ class CreateExplainabilityResponse < Struct.new(
1159
+ :explainability_arn)
495
1160
  SENSITIVE = []
496
1161
  include Aws::Structure
497
1162
  end
@@ -782,7 +1447,7 @@ module Aws::ForecastService
782
1447
  # forecast_horizon: 1, # required
783
1448
  # forecast_types: ["ForecastType"],
784
1449
  # perform_auto_ml: false,
785
- # auto_ml_override_strategy: "LatencyOptimized", # accepts LatencyOptimized
1450
+ # auto_ml_override_strategy: "LatencyOptimized", # accepts LatencyOptimized, AccuracyOptimized
786
1451
  # perform_hpo: false,
787
1452
  # training_parameters: {
788
1453
  # "ParameterKey" => "ParameterValue",
@@ -853,6 +1518,7 @@ module Aws::ForecastService
853
1518
  # value: "TagValue", # required
854
1519
  # },
855
1520
  # ],
1521
+ # optimization_metric: "WAPE", # accepts WAPE, RMSE, AverageWeightedQuantileLoss, MASE, MAPE
856
1522
  # }
857
1523
  #
858
1524
  # @!attribute [rw] predictor_name
@@ -915,6 +1581,12 @@ module Aws::ForecastService
915
1581
  # @return [Boolean]
916
1582
  #
917
1583
  # @!attribute [rw] auto_ml_override_strategy
1584
+ # <note markdown="1"> The `LatencyOptimized` AutoML override strategy is only available in
1585
+ # private beta. Contact AWS Support or your account manager to learn
1586
+ # more about access privileges.
1587
+ #
1588
+ # </note>
1589
+ #
918
1590
  # Used to overide the default AutoML strategy, which is to optimize
919
1591
  # predictor accuracy. To apply an AutoML strategy that minimizes
920
1592
  # training time, use `LatencyOptimized`.
@@ -1018,6 +1690,10 @@ module Aws::ForecastService
1018
1690
  # of `aws` do not count against your tags per resource limit.
1019
1691
  # @return [Array<Types::Tag>]
1020
1692
  #
1693
+ # @!attribute [rw] optimization_metric
1694
+ # The accuracy metric used to optimize the predictor.
1695
+ # @return [String]
1696
+ #
1021
1697
  # @see http://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/CreatePredictorRequest AWS API Documentation
1022
1698
  #
1023
1699
  class CreatePredictorRequest < Struct.new(
@@ -1034,7 +1710,8 @@ module Aws::ForecastService
1034
1710
  :input_data_config,
1035
1711
  :featurization_config,
1036
1712
  :encryption_config,
1037
- :tags)
1713
+ :tags,
1714
+ :optimization_metric)
1038
1715
  SENSITIVE = []
1039
1716
  include Aws::Structure
1040
1717
  end
@@ -1051,6 +1728,55 @@ module Aws::ForecastService
1051
1728
  include Aws::Structure
1052
1729
  end
1053
1730
 
1731
+ # The data configuration for your dataset group and any additional
1732
+ # datasets.
1733
+ #
1734
+ # @note When making an API call, you may pass DataConfig
1735
+ # data as a hash:
1736
+ #
1737
+ # {
1738
+ # dataset_group_arn: "Arn", # required
1739
+ # attribute_configs: [
1740
+ # {
1741
+ # attribute_name: "Name", # required
1742
+ # transformations: { # required
1743
+ # "Name" => "Value",
1744
+ # },
1745
+ # },
1746
+ # ],
1747
+ # additional_datasets: [
1748
+ # {
1749
+ # name: "Name", # required
1750
+ # configuration: {
1751
+ # "Name" => ["Value"],
1752
+ # },
1753
+ # },
1754
+ # ],
1755
+ # }
1756
+ #
1757
+ # @!attribute [rw] dataset_group_arn
1758
+ # The ARN of the dataset group used to train the predictor.
1759
+ # @return [String]
1760
+ #
1761
+ # @!attribute [rw] attribute_configs
1762
+ # Aggregation and filling options for attributes in your dataset
1763
+ # group.
1764
+ # @return [Array<Types::AttributeConfig>]
1765
+ #
1766
+ # @!attribute [rw] additional_datasets
1767
+ # Additional built-in datasets like Holidays and the Weather Index.
1768
+ # @return [Array<Types::AdditionalDataset>]
1769
+ #
1770
+ # @see http://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/DataConfig AWS API Documentation
1771
+ #
1772
+ class DataConfig < Struct.new(
1773
+ :dataset_group_arn,
1774
+ :attribute_configs,
1775
+ :additional_datasets)
1776
+ SENSITIVE = []
1777
+ include Aws::Structure
1778
+ end
1779
+
1054
1780
  # The destination for an export job. Provide an S3 path, an AWS Identity
1055
1781
  # and Access Management (IAM) role that allows Amazon Forecast to access
1056
1782
  # the location, and an AWS Key Management Service (KMS) key (optional).
@@ -1318,6 +2044,46 @@ module Aws::ForecastService
1318
2044
  include Aws::Structure
1319
2045
  end
1320
2046
 
2047
+ # @note When making an API call, you may pass DeleteExplainabilityExportRequest
2048
+ # data as a hash:
2049
+ #
2050
+ # {
2051
+ # explainability_export_arn: "Arn", # required
2052
+ # }
2053
+ #
2054
+ # @!attribute [rw] explainability_export_arn
2055
+ # The Amazon Resource Name (ARN) of the Explainability export to
2056
+ # delete.
2057
+ # @return [String]
2058
+ #
2059
+ # @see http://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/DeleteExplainabilityExportRequest AWS API Documentation
2060
+ #
2061
+ class DeleteExplainabilityExportRequest < Struct.new(
2062
+ :explainability_export_arn)
2063
+ SENSITIVE = []
2064
+ include Aws::Structure
2065
+ end
2066
+
2067
+ # @note When making an API call, you may pass DeleteExplainabilityRequest
2068
+ # data as a hash:
2069
+ #
2070
+ # {
2071
+ # explainability_arn: "Arn", # required
2072
+ # }
2073
+ #
2074
+ # @!attribute [rw] explainability_arn
2075
+ # The Amazon Resource Name (ARN) of the Explainability resource to
2076
+ # delete.
2077
+ # @return [String]
2078
+ #
2079
+ # @see http://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/DeleteExplainabilityRequest AWS API Documentation
2080
+ #
2081
+ class DeleteExplainabilityRequest < Struct.new(
2082
+ :explainability_arn)
2083
+ SENSITIVE = []
2084
+ include Aws::Structure
2085
+ end
2086
+
1321
2087
  # @note When making an API call, you may pass DeleteForecastExportJobRequest
1322
2088
  # data as a hash:
1323
2089
  #
@@ -1340,77 +2106,216 @@ module Aws::ForecastService
1340
2106
  # @note When making an API call, you may pass DeleteForecastRequest
1341
2107
  # data as a hash:
1342
2108
  #
1343
- # {
1344
- # forecast_arn: "Arn", # required
1345
- # }
2109
+ # {
2110
+ # forecast_arn: "Arn", # required
2111
+ # }
2112
+ #
2113
+ # @!attribute [rw] forecast_arn
2114
+ # The Amazon Resource Name (ARN) of the forecast to delete.
2115
+ # @return [String]
2116
+ #
2117
+ # @see http://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/DeleteForecastRequest AWS API Documentation
2118
+ #
2119
+ class DeleteForecastRequest < Struct.new(
2120
+ :forecast_arn)
2121
+ SENSITIVE = []
2122
+ include Aws::Structure
2123
+ end
2124
+
2125
+ # @note When making an API call, you may pass DeletePredictorBacktestExportJobRequest
2126
+ # data as a hash:
2127
+ #
2128
+ # {
2129
+ # predictor_backtest_export_job_arn: "Arn", # required
2130
+ # }
2131
+ #
2132
+ # @!attribute [rw] predictor_backtest_export_job_arn
2133
+ # The Amazon Resource Name (ARN) of the predictor backtest export job
2134
+ # to delete.
2135
+ # @return [String]
2136
+ #
2137
+ # @see http://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/DeletePredictorBacktestExportJobRequest AWS API Documentation
2138
+ #
2139
+ class DeletePredictorBacktestExportJobRequest < Struct.new(
2140
+ :predictor_backtest_export_job_arn)
2141
+ SENSITIVE = []
2142
+ include Aws::Structure
2143
+ end
2144
+
2145
+ # @note When making an API call, you may pass DeletePredictorRequest
2146
+ # data as a hash:
2147
+ #
2148
+ # {
2149
+ # predictor_arn: "Arn", # required
2150
+ # }
2151
+ #
2152
+ # @!attribute [rw] predictor_arn
2153
+ # The Amazon Resource Name (ARN) of the predictor to delete.
2154
+ # @return [String]
2155
+ #
2156
+ # @see http://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/DeletePredictorRequest AWS API Documentation
2157
+ #
2158
+ class DeletePredictorRequest < Struct.new(
2159
+ :predictor_arn)
2160
+ SENSITIVE = []
2161
+ include Aws::Structure
2162
+ end
2163
+
2164
+ # @note When making an API call, you may pass DeleteResourceTreeRequest
2165
+ # data as a hash:
2166
+ #
2167
+ # {
2168
+ # resource_arn: "Arn", # required
2169
+ # }
2170
+ #
2171
+ # @!attribute [rw] resource_arn
2172
+ # The Amazon Resource Name (ARN) of the parent resource to delete. All
2173
+ # child resources of the parent resource will also be deleted.
2174
+ # @return [String]
2175
+ #
2176
+ # @see http://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/DeleteResourceTreeRequest AWS API Documentation
2177
+ #
2178
+ class DeleteResourceTreeRequest < Struct.new(
2179
+ :resource_arn)
2180
+ SENSITIVE = []
2181
+ include Aws::Structure
2182
+ end
2183
+
2184
+ # @note When making an API call, you may pass DescribeAutoPredictorRequest
2185
+ # data as a hash:
2186
+ #
2187
+ # {
2188
+ # predictor_arn: "Arn", # required
2189
+ # }
2190
+ #
2191
+ # @!attribute [rw] predictor_arn
2192
+ # The Amazon Resource Name (ARN) of the predictor.
2193
+ # @return [String]
2194
+ #
2195
+ # @see http://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/DescribeAutoPredictorRequest AWS API Documentation
2196
+ #
2197
+ class DescribeAutoPredictorRequest < Struct.new(
2198
+ :predictor_arn)
2199
+ SENSITIVE = []
2200
+ include Aws::Structure
2201
+ end
2202
+
2203
+ # @!attribute [rw] predictor_arn
2204
+ # The Amazon Resource Name (ARN) of the predictor
2205
+ # @return [String]
2206
+ #
2207
+ # @!attribute [rw] predictor_name
2208
+ # The name of the predictor.
2209
+ # @return [String]
2210
+ #
2211
+ # @!attribute [rw] forecast_horizon
2212
+ # The number of time-steps that the model predicts. The forecast
2213
+ # horizon is also called the prediction length.
2214
+ # @return [Integer]
2215
+ #
2216
+ # @!attribute [rw] forecast_types
2217
+ # The forecast types used during predictor training. Default value is
2218
+ # \["0.1","0.5","0.9"\].
2219
+ # @return [Array<String>]
2220
+ #
2221
+ # @!attribute [rw] forecast_frequency
2222
+ # The frequency of predictions in a forecast.
2223
+ #
2224
+ # Valid intervals are Y (Year), M (Month), W (Week), D (Day), H
2225
+ # (Hour), 30min (30 minutes), 15min (15 minutes), 10min (10 minutes),
2226
+ # 5min (5 minutes), and 1min (1 minute). For example, "Y" indicates
2227
+ # every year and "5min" indicates every five minutes.
2228
+ # @return [String]
2229
+ #
2230
+ # @!attribute [rw] dataset_import_job_arns
2231
+ # An array of the ARNs of the dataset import jobs used to import
2232
+ # training data for the predictor.
2233
+ # @return [Array<String>]
2234
+ #
2235
+ # @!attribute [rw] data_config
2236
+ # The data configuration for your dataset group and any additional
2237
+ # datasets.
2238
+ # @return [Types::DataConfig]
2239
+ #
2240
+ # @!attribute [rw] encryption_config
2241
+ # An AWS Key Management Service (KMS) key and an AWS Identity and
2242
+ # Access Management (IAM) role that Amazon Forecast can assume to
2243
+ # access the key. You can specify this optional object in the
2244
+ # CreateDataset and CreatePredictor requests.
2245
+ # @return [Types::EncryptionConfig]
2246
+ #
2247
+ # @!attribute [rw] reference_predictor_summary
2248
+ # The ARN and state of the reference predictor. This parameter is only
2249
+ # valid for retrained or upgraded predictors.
2250
+ # @return [Types::ReferencePredictorSummary]
1346
2251
  #
1347
- # @!attribute [rw] forecast_arn
1348
- # The Amazon Resource Name (ARN) of the forecast to delete.
1349
- # @return [String]
2252
+ # @!attribute [rw] estimated_time_remaining_in_minutes
2253
+ # The estimated time remaining in minutes for the predictor training
2254
+ # job to complete.
2255
+ # @return [Integer]
1350
2256
  #
1351
- # @see http://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/DeleteForecastRequest AWS API Documentation
2257
+ # @!attribute [rw] status
2258
+ # The status of the predictor. States include:
1352
2259
  #
1353
- class DeleteForecastRequest < Struct.new(
1354
- :forecast_arn)
1355
- SENSITIVE = []
1356
- include Aws::Structure
1357
- end
1358
-
1359
- # @note When making an API call, you may pass DeletePredictorBacktestExportJobRequest
1360
- # data as a hash:
2260
+ # * `ACTIVE`
1361
2261
  #
1362
- # {
1363
- # predictor_backtest_export_job_arn: "Arn", # required
1364
- # }
2262
+ # * `CREATE_PENDING`, `CREATE_IN_PROGRESS`, `CREATE_FAILED`
1365
2263
  #
1366
- # @!attribute [rw] predictor_backtest_export_job_arn
1367
- # The Amazon Resource Name (ARN) of the predictor backtest export job
1368
- # to delete.
2264
+ # * `CREATE_STOPPING`, `CREATE_STOPPED`
2265
+ #
2266
+ # * `DELETE_PENDING`, `DELETE_IN_PROGRESS`, `DELETE_FAILED`
1369
2267
  # @return [String]
1370
2268
  #
1371
- # @see http://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/DeletePredictorBacktestExportJobRequest AWS API Documentation
2269
+ # @!attribute [rw] message
2270
+ # In the event of an error, a message detailing the cause of the
2271
+ # error.
2272
+ # @return [String]
1372
2273
  #
1373
- class DeletePredictorBacktestExportJobRequest < Struct.new(
1374
- :predictor_backtest_export_job_arn)
1375
- SENSITIVE = []
1376
- include Aws::Structure
1377
- end
1378
-
1379
- # @note When making an API call, you may pass DeletePredictorRequest
1380
- # data as a hash:
2274
+ # @!attribute [rw] creation_time
2275
+ # The timestamp of the CreateAutoPredictor request.
2276
+ # @return [Time]
1381
2277
  #
1382
- # {
1383
- # predictor_arn: "Arn", # required
1384
- # }
2278
+ # @!attribute [rw] last_modification_time
2279
+ # The last time the resource was modified. The timestamp depends on
2280
+ # the status of the job:
1385
2281
  #
1386
- # @!attribute [rw] predictor_arn
1387
- # The Amazon Resource Name (ARN) of the predictor to delete.
1388
- # @return [String]
2282
+ # * `CREATE_PENDING` - The `CreationTime`.
1389
2283
  #
1390
- # @see http://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/DeletePredictorRequest AWS API Documentation
2284
+ # * `CREATE_IN_PROGRESS` - The current timestamp.
1391
2285
  #
1392
- class DeletePredictorRequest < Struct.new(
1393
- :predictor_arn)
1394
- SENSITIVE = []
1395
- include Aws::Structure
1396
- end
1397
-
1398
- # @note When making an API call, you may pass DeleteResourceTreeRequest
1399
- # data as a hash:
2286
+ # * `CREATE_STOPPING` - The current timestamp.
1400
2287
  #
1401
- # {
1402
- # resource_arn: "Arn", # required
1403
- # }
2288
+ # * `CREATE_STOPPED` - When the job stopped.
1404
2289
  #
1405
- # @!attribute [rw] resource_arn
1406
- # The Amazon Resource Name (ARN) of the parent resource to delete. All
1407
- # child resources of the parent resource will also be deleted.
2290
+ # * `ACTIVE` or `CREATE_FAILED` - When the job finished or failed.
2291
+ # @return [Time]
2292
+ #
2293
+ # @!attribute [rw] optimization_metric
2294
+ # The accuracy metric used to optimize the predictor.
1408
2295
  # @return [String]
1409
2296
  #
1410
- # @see http://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/DeleteResourceTreeRequest AWS API Documentation
2297
+ # @!attribute [rw] explainability_info
2298
+ # @return [Types::ExplainabilityInfo]
1411
2299
  #
1412
- class DeleteResourceTreeRequest < Struct.new(
1413
- :resource_arn)
2300
+ # @see http://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/DescribeAutoPredictorResponse AWS API Documentation
2301
+ #
2302
+ class DescribeAutoPredictorResponse < Struct.new(
2303
+ :predictor_arn,
2304
+ :predictor_name,
2305
+ :forecast_horizon,
2306
+ :forecast_types,
2307
+ :forecast_frequency,
2308
+ :dataset_import_job_arns,
2309
+ :data_config,
2310
+ :encryption_config,
2311
+ :reference_predictor_summary,
2312
+ :estimated_time_remaining_in_minutes,
2313
+ :status,
2314
+ :message,
2315
+ :creation_time,
2316
+ :last_modification_time,
2317
+ :optimization_metric,
2318
+ :explainability_info)
1414
2319
  SENSITIVE = []
1415
2320
  include Aws::Structure
1416
2321
  end
@@ -1668,76 +2573,289 @@ module Aws::ForecastService
1668
2573
  # The domain associated with the dataset.
1669
2574
  # @return [String]
1670
2575
  #
1671
- # @!attribute [rw] dataset_type
1672
- # The dataset type.
1673
- # @return [String]
2576
+ # @!attribute [rw] dataset_type
2577
+ # The dataset type.
2578
+ # @return [String]
2579
+ #
2580
+ # @!attribute [rw] data_frequency
2581
+ # The frequency of data collection.
2582
+ #
2583
+ # Valid intervals are Y (Year), M (Month), W (Week), D (Day), H
2584
+ # (Hour), 30min (30 minutes), 15min (15 minutes), 10min (10 minutes),
2585
+ # 5min (5 minutes), and 1min (1 minute). For example, "M" indicates
2586
+ # every month and "30min" indicates every 30 minutes.
2587
+ # @return [String]
2588
+ #
2589
+ # @!attribute [rw] schema
2590
+ # An array of `SchemaAttribute` objects that specify the dataset
2591
+ # fields. Each `SchemaAttribute` specifies the name and data type of a
2592
+ # field.
2593
+ # @return [Types::Schema]
2594
+ #
2595
+ # @!attribute [rw] encryption_config
2596
+ # The AWS Key Management Service (KMS) key and the AWS Identity and
2597
+ # Access Management (IAM) role that Amazon Forecast can assume to
2598
+ # access the key.
2599
+ # @return [Types::EncryptionConfig]
2600
+ #
2601
+ # @!attribute [rw] status
2602
+ # The status of the dataset. States include:
2603
+ #
2604
+ # * `ACTIVE`
2605
+ #
2606
+ # * `CREATE_PENDING`, `CREATE_IN_PROGRESS`, `CREATE_FAILED`
2607
+ #
2608
+ # * `DELETE_PENDING`, `DELETE_IN_PROGRESS`, `DELETE_FAILED`
2609
+ #
2610
+ # * `UPDATE_PENDING`, `UPDATE_IN_PROGRESS`, `UPDATE_FAILED`
2611
+ #
2612
+ # The `UPDATE` states apply while data is imported to the dataset from
2613
+ # a call to the CreateDatasetImportJob operation and reflect the
2614
+ # status of the dataset import job. For example, when the import job
2615
+ # status is `CREATE_IN_PROGRESS`, the status of the dataset is
2616
+ # `UPDATE_IN_PROGRESS`.
2617
+ #
2618
+ # <note markdown="1"> The `Status` of the dataset must be `ACTIVE` before you can import
2619
+ # training data.
2620
+ #
2621
+ # </note>
2622
+ # @return [String]
2623
+ #
2624
+ # @!attribute [rw] creation_time
2625
+ # When the dataset was created.
2626
+ # @return [Time]
2627
+ #
2628
+ # @!attribute [rw] last_modification_time
2629
+ # When you create a dataset, `LastModificationTime` is the same as
2630
+ # `CreationTime`. While data is being imported to the dataset,
2631
+ # `LastModificationTime` is the current time of the `DescribeDataset`
2632
+ # call. After a CreateDatasetImportJob operation has finished,
2633
+ # `LastModificationTime` is when the import job completed or failed.
2634
+ # @return [Time]
2635
+ #
2636
+ # @see http://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/DescribeDatasetResponse AWS API Documentation
2637
+ #
2638
+ class DescribeDatasetResponse < Struct.new(
2639
+ :dataset_arn,
2640
+ :dataset_name,
2641
+ :domain,
2642
+ :dataset_type,
2643
+ :data_frequency,
2644
+ :schema,
2645
+ :encryption_config,
2646
+ :status,
2647
+ :creation_time,
2648
+ :last_modification_time)
2649
+ SENSITIVE = []
2650
+ include Aws::Structure
2651
+ end
2652
+
2653
+ # @note When making an API call, you may pass DescribeExplainabilityExportRequest
2654
+ # data as a hash:
2655
+ #
2656
+ # {
2657
+ # explainability_export_arn: "Arn", # required
2658
+ # }
2659
+ #
2660
+ # @!attribute [rw] explainability_export_arn
2661
+ # The Amazon Resource Name (ARN) of the Explainability export.
2662
+ # @return [String]
2663
+ #
2664
+ # @see http://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/DescribeExplainabilityExportRequest AWS API Documentation
2665
+ #
2666
+ class DescribeExplainabilityExportRequest < Struct.new(
2667
+ :explainability_export_arn)
2668
+ SENSITIVE = []
2669
+ include Aws::Structure
2670
+ end
2671
+
2672
+ # @!attribute [rw] explainability_export_arn
2673
+ # The Amazon Resource Name (ARN) of the Explainability export.
2674
+ # @return [String]
2675
+ #
2676
+ # @!attribute [rw] explainability_export_name
2677
+ # The name of the Explainability export.
2678
+ # @return [String]
2679
+ #
2680
+ # @!attribute [rw] explainability_arn
2681
+ # The Amazon Resource Name (ARN) of the Explainability.
2682
+ # @return [String]
2683
+ #
2684
+ # @!attribute [rw] destination
2685
+ # The destination for an export job. Provide an S3 path, an AWS
2686
+ # Identity and Access Management (IAM) role that allows Amazon
2687
+ # Forecast to access the location, and an AWS Key Management Service
2688
+ # (KMS) key (optional).
2689
+ # @return [Types::DataDestination]
2690
+ #
2691
+ # @!attribute [rw] message
2692
+ # Information about any errors that occurred during the export.
2693
+ # @return [String]
2694
+ #
2695
+ # @!attribute [rw] status
2696
+ # The status of the Explainability export. States include:
2697
+ #
2698
+ # * `ACTIVE`
2699
+ #
2700
+ # * `CREATE_PENDING`, `CREATE_IN_PROGRESS`, `CREATE_FAILED`
2701
+ #
2702
+ # * `CREATE_STOPPING`, `CREATE_STOPPED`
2703
+ #
2704
+ # * `DELETE_PENDING`, `DELETE_IN_PROGRESS`, `DELETE_FAILED`
2705
+ # @return [String]
2706
+ #
2707
+ # @!attribute [rw] creation_time
2708
+ # When the Explainability export was created.
2709
+ # @return [Time]
2710
+ #
2711
+ # @!attribute [rw] last_modification_time
2712
+ # The last time the resource was modified. The timestamp depends on
2713
+ # the status of the job:
2714
+ #
2715
+ # * `CREATE_PENDING` - The `CreationTime`.
2716
+ #
2717
+ # * `CREATE_IN_PROGRESS` - The current timestamp.
2718
+ #
2719
+ # * `CREATE_STOPPING` - The current timestamp.
2720
+ #
2721
+ # * `CREATE_STOPPED` - When the job stopped.
2722
+ #
2723
+ # * `ACTIVE` or `CREATE_FAILED` - When the job finished or failed.
2724
+ # @return [Time]
2725
+ #
2726
+ # @see http://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/DescribeExplainabilityExportResponse AWS API Documentation
2727
+ #
2728
+ class DescribeExplainabilityExportResponse < Struct.new(
2729
+ :explainability_export_arn,
2730
+ :explainability_export_name,
2731
+ :explainability_arn,
2732
+ :destination,
2733
+ :message,
2734
+ :status,
2735
+ :creation_time,
2736
+ :last_modification_time)
2737
+ SENSITIVE = []
2738
+ include Aws::Structure
2739
+ end
2740
+
2741
+ # @note When making an API call, you may pass DescribeExplainabilityRequest
2742
+ # data as a hash:
2743
+ #
2744
+ # {
2745
+ # explainability_arn: "Arn", # required
2746
+ # }
2747
+ #
2748
+ # @!attribute [rw] explainability_arn
2749
+ # The Amazon Resource Name (ARN) of the Explaianability to describe.
2750
+ # @return [String]
2751
+ #
2752
+ # @see http://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/DescribeExplainabilityRequest AWS API Documentation
2753
+ #
2754
+ class DescribeExplainabilityRequest < Struct.new(
2755
+ :explainability_arn)
2756
+ SENSITIVE = []
2757
+ include Aws::Structure
2758
+ end
2759
+
2760
+ # @!attribute [rw] explainability_arn
2761
+ # The Amazon Resource Name (ARN) of the Explainability.
2762
+ # @return [String]
2763
+ #
2764
+ # @!attribute [rw] explainability_name
2765
+ # The name of the Explainability.
2766
+ # @return [String]
2767
+ #
2768
+ # @!attribute [rw] resource_arn
2769
+ # The Amazon Resource Name (ARN) of the Predictor or Forecast used to
2770
+ # create the Explainability resource.
2771
+ # @return [String]
2772
+ #
2773
+ # @!attribute [rw] explainability_config
2774
+ # The configuration settings that define the granularity of time
2775
+ # series and time points for the Explainability.
2776
+ # @return [Types::ExplainabilityConfig]
1674
2777
  #
1675
- # @!attribute [rw] data_frequency
1676
- # The frequency of data collection.
2778
+ # @!attribute [rw] enable_visualization
2779
+ # Whether the visualization was enabled for the Explainability
2780
+ # resource.
2781
+ # @return [Boolean]
1677
2782
  #
1678
- # Valid intervals are Y (Year), M (Month), W (Week), D (Day), H
1679
- # (Hour), 30min (30 minutes), 15min (15 minutes), 10min (10 minutes),
1680
- # 5min (5 minutes), and 1min (1 minute). For example, "M" indicates
1681
- # every month and "30min" indicates every 30 minutes.
1682
- # @return [String]
2783
+ # @!attribute [rw] data_source
2784
+ # The source of your training data, an AWS Identity and Access
2785
+ # Management (IAM) role that allows Amazon Forecast to access the data
2786
+ # and, optionally, an AWS Key Management Service (KMS) key. This
2787
+ # object is submitted in the CreateDatasetImportJob request.
2788
+ # @return [Types::DataSource]
1683
2789
  #
1684
2790
  # @!attribute [rw] schema
1685
- # An array of `SchemaAttribute` objects that specify the dataset
1686
- # fields. Each `SchemaAttribute` specifies the name and data type of a
1687
- # field.
2791
+ # Defines the fields of a dataset. You specify this object in the
2792
+ # CreateDataset request.
1688
2793
  # @return [Types::Schema]
1689
2794
  #
1690
- # @!attribute [rw] encryption_config
1691
- # The AWS Key Management Service (KMS) key and the AWS Identity and
1692
- # Access Management (IAM) role that Amazon Forecast can assume to
1693
- # access the key.
1694
- # @return [Types::EncryptionConfig]
2795
+ # @!attribute [rw] start_date_time
2796
+ # If `TimePointGranularity` is set to `SPECIFIC`, the first time point
2797
+ # in the Explainability.
2798
+ # @return [String]
1695
2799
  #
1696
- # @!attribute [rw] status
1697
- # The status of the dataset. States include:
2800
+ # @!attribute [rw] end_date_time
2801
+ # If `TimePointGranularity` is set to `SPECIFIC`, the last time point
2802
+ # in the Explainability.
2803
+ # @return [String]
1698
2804
  #
1699
- # * `ACTIVE`
2805
+ # @!attribute [rw] estimated_time_remaining_in_minutes
2806
+ # The estimated time remaining in minutes for the CreateExplainability
2807
+ # job to complete.
2808
+ # @return [Integer]
1700
2809
  #
1701
- # * `CREATE_PENDING`, `CREATE_IN_PROGRESS`, `CREATE_FAILED`
2810
+ # @!attribute [rw] message
2811
+ # If an error occurred, a message about the error.
2812
+ # @return [String]
1702
2813
  #
1703
- # * `DELETE_PENDING`, `DELETE_IN_PROGRESS`, `DELETE_FAILED`
2814
+ # @!attribute [rw] status
2815
+ # The status of the Explainability resource. States include:
1704
2816
  #
1705
- # * `UPDATE_PENDING`, `UPDATE_IN_PROGRESS`, `UPDATE_FAILED`
2817
+ # * `ACTIVE`
1706
2818
  #
1707
- # The `UPDATE` states apply while data is imported to the dataset from
1708
- # a call to the CreateDatasetImportJob operation and reflect the
1709
- # status of the dataset import job. For example, when the import job
1710
- # status is `CREATE_IN_PROGRESS`, the status of the dataset is
1711
- # `UPDATE_IN_PROGRESS`.
2819
+ # * `CREATE_PENDING`, `CREATE_IN_PROGRESS`, `CREATE_FAILED`
1712
2820
  #
1713
- # <note markdown="1"> The `Status` of the dataset must be `ACTIVE` before you can import
1714
- # training data.
2821
+ # * `CREATE_STOPPING`, `CREATE_STOPPED`
1715
2822
  #
1716
- # </note>
2823
+ # * `DELETE_PENDING`, `DELETE_IN_PROGRESS`, `DELETE_FAILED`
1717
2824
  # @return [String]
1718
2825
  #
1719
2826
  # @!attribute [rw] creation_time
1720
- # When the dataset was created.
2827
+ # When the Explainability resource was created.
1721
2828
  # @return [Time]
1722
2829
  #
1723
2830
  # @!attribute [rw] last_modification_time
1724
- # When you create a dataset, `LastModificationTime` is the same as
1725
- # `CreationTime`. While data is being imported to the dataset,
1726
- # `LastModificationTime` is the current time of the `DescribeDataset`
1727
- # call. After a CreateDatasetImportJob operation has finished,
1728
- # `LastModificationTime` is when the import job completed or failed.
2831
+ # The last time the resource was modified. The timestamp depends on
2832
+ # the status of the job:
2833
+ #
2834
+ # * `CREATE_PENDING` - The `CreationTime`.
2835
+ #
2836
+ # * `CREATE_IN_PROGRESS` - The current timestamp.
2837
+ #
2838
+ # * `CREATE_STOPPING` - The current timestamp.
2839
+ #
2840
+ # * `CREATE_STOPPED` - When the job stopped.
2841
+ #
2842
+ # * `ACTIVE` or `CREATE_FAILED` - When the job finished or failed.
1729
2843
  # @return [Time]
1730
2844
  #
1731
- # @see http://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/DescribeDatasetResponse AWS API Documentation
2845
+ # @see http://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/DescribeExplainabilityResponse AWS API Documentation
1732
2846
  #
1733
- class DescribeDatasetResponse < Struct.new(
1734
- :dataset_arn,
1735
- :dataset_name,
1736
- :domain,
1737
- :dataset_type,
1738
- :data_frequency,
2847
+ class DescribeExplainabilityResponse < Struct.new(
2848
+ :explainability_arn,
2849
+ :explainability_name,
2850
+ :resource_arn,
2851
+ :explainability_config,
2852
+ :enable_visualization,
2853
+ :data_source,
1739
2854
  :schema,
1740
- :encryption_config,
2855
+ :start_date_time,
2856
+ :end_date_time,
2857
+ :estimated_time_remaining_in_minutes,
2858
+ :message,
1741
2859
  :status,
1742
2860
  :creation_time,
1743
2861
  :last_modification_time)
@@ -2060,6 +3178,10 @@ module Aws::ForecastService
2060
3178
  # training.
2061
3179
  # @return [String]
2062
3180
  #
3181
+ # @!attribute [rw] auto_ml_algorithm_arns
3182
+ # When `PerformAutoML` is specified, the ARN of the chosen algorithm.
3183
+ # @return [Array<String>]
3184
+ #
2063
3185
  # @!attribute [rw] forecast_horizon
2064
3186
  # The number of time-steps of the forecast. The forecast horizon is
2065
3187
  # also called the prediction length.
@@ -2075,6 +3197,12 @@ module Aws::ForecastService
2075
3197
  # @return [Boolean]
2076
3198
  #
2077
3199
  # @!attribute [rw] auto_ml_override_strategy
3200
+ # <note markdown="1"> The `LatencyOptimized` AutoML override strategy is only available in
3201
+ # private beta. Contact AWS Support or your account manager to learn
3202
+ # more about access privileges.
3203
+ #
3204
+ # </note>
3205
+ #
2078
3206
  # The AutoML strategy used to train the predictor. Unless
2079
3207
  # `LatencyOptimized` is specified, the AutoML strategy optimizes
2080
3208
  # predictor accuracy.
@@ -2132,15 +3260,15 @@ module Aws::ForecastService
2132
3260
  # job to complete.
2133
3261
  # @return [Integer]
2134
3262
  #
3263
+ # @!attribute [rw] is_auto_predictor
3264
+ # Whether the predictor was created with CreateAutoPredictor.
3265
+ # @return [Boolean]
3266
+ #
2135
3267
  # @!attribute [rw] dataset_import_job_arns
2136
3268
  # An array of the ARNs of the dataset import jobs used to import
2137
3269
  # training data for the predictor.
2138
3270
  # @return [Array<String>]
2139
3271
  #
2140
- # @!attribute [rw] auto_ml_algorithm_arns
2141
- # When `PerformAutoML` is specified, the ARN of the chosen algorithm.
2142
- # @return [Array<String>]
2143
- #
2144
3272
  # @!attribute [rw] status
2145
3273
  # The status of the predictor. States include:
2146
3274
  #
@@ -2181,12 +3309,17 @@ module Aws::ForecastService
2181
3309
  # * `ACTIVE` or `CREATE_FAILED` - When the job finished or failed.
2182
3310
  # @return [Time]
2183
3311
  #
3312
+ # @!attribute [rw] optimization_metric
3313
+ # The accuracy metric used to optimize the predictor.
3314
+ # @return [String]
3315
+ #
2184
3316
  # @see http://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/DescribePredictorResponse AWS API Documentation
2185
3317
  #
2186
3318
  class DescribePredictorResponse < Struct.new(
2187
3319
  :predictor_arn,
2188
3320
  :predictor_name,
2189
3321
  :algorithm_arn,
3322
+ :auto_ml_algorithm_arns,
2190
3323
  :forecast_horizon,
2191
3324
  :forecast_types,
2192
3325
  :perform_auto_ml,
@@ -2200,12 +3333,13 @@ module Aws::ForecastService
2200
3333
  :encryption_config,
2201
3334
  :predictor_execution_details,
2202
3335
  :estimated_time_remaining_in_minutes,
3336
+ :is_auto_predictor,
2203
3337
  :dataset_import_job_arns,
2204
- :auto_ml_algorithm_arns,
2205
3338
  :status,
2206
3339
  :message,
2207
3340
  :creation_time,
2208
- :last_modification_time)
3341
+ :last_modification_time,
3342
+ :optimization_metric)
2209
3343
  SENSITIVE = []
2210
3344
  include Aws::Structure
2211
3345
  end
@@ -2232,102 +3366,318 @@ module Aws::ForecastService
2232
3366
  # error.
2233
3367
  # @return [String]
2234
3368
  #
2235
- # @!attribute [rw] kms_key_arn
2236
- # The Amazon Resource Name (ARN) of the KMS key.
2237
- # @return [String]
3369
+ # @!attribute [rw] kms_key_arn
3370
+ # The Amazon Resource Name (ARN) of the KMS key.
3371
+ # @return [String]
3372
+ #
3373
+ # @see http://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/EncryptionConfig AWS API Documentation
3374
+ #
3375
+ class EncryptionConfig < Struct.new(
3376
+ :role_arn,
3377
+ :kms_key_arn)
3378
+ SENSITIVE = []
3379
+ include Aws::Structure
3380
+ end
3381
+
3382
+ # Provides detailed error metrics to evaluate the performance of a
3383
+ # predictor. This object is part of the Metrics object.
3384
+ #
3385
+ # @!attribute [rw] forecast_type
3386
+ # The Forecast type used to compute WAPE, MAPE, MASE, and RMSE.
3387
+ # @return [String]
3388
+ #
3389
+ # @!attribute [rw] wape
3390
+ # The weighted absolute percentage error (WAPE).
3391
+ # @return [Float]
3392
+ #
3393
+ # @!attribute [rw] rmse
3394
+ # The root-mean-square error (RMSE).
3395
+ # @return [Float]
3396
+ #
3397
+ # @!attribute [rw] mase
3398
+ # The Mean Absolute Scaled Error (MASE)
3399
+ # @return [Float]
3400
+ #
3401
+ # @!attribute [rw] mape
3402
+ # The Mean Absolute Percentage Error (MAPE)
3403
+ # @return [Float]
3404
+ #
3405
+ # @see http://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/ErrorMetric AWS API Documentation
3406
+ #
3407
+ class ErrorMetric < Struct.new(
3408
+ :forecast_type,
3409
+ :wape,
3410
+ :rmse,
3411
+ :mase,
3412
+ :mape)
3413
+ SENSITIVE = []
3414
+ include Aws::Structure
3415
+ end
3416
+
3417
+ # Parameters that define how to split a dataset into training data and
3418
+ # testing data, and the number of iterations to perform. These
3419
+ # parameters are specified in the predefined algorithms but you can
3420
+ # override them in the CreatePredictor request.
3421
+ #
3422
+ # @note When making an API call, you may pass EvaluationParameters
3423
+ # data as a hash:
3424
+ #
3425
+ # {
3426
+ # number_of_backtest_windows: 1,
3427
+ # back_test_window_offset: 1,
3428
+ # }
3429
+ #
3430
+ # @!attribute [rw] number_of_backtest_windows
3431
+ # The number of times to split the input data. The default is 1. Valid
3432
+ # values are 1 through 5.
3433
+ # @return [Integer]
3434
+ #
3435
+ # @!attribute [rw] back_test_window_offset
3436
+ # The point from the end of the dataset where you want to split the
3437
+ # data for model training and testing (evaluation). Specify the value
3438
+ # as the number of data points. The default is the value of the
3439
+ # forecast horizon. `BackTestWindowOffset` can be used to mimic a past
3440
+ # virtual forecast start date. This value must be greater than or
3441
+ # equal to the forecast horizon and less than half of the
3442
+ # TARGET\_TIME\_SERIES dataset length.
3443
+ #
3444
+ # `ForecastHorizon` &lt;= `BackTestWindowOffset` &lt; 1/2 *
3445
+ # TARGET\_TIME\_SERIES dataset length
3446
+ # @return [Integer]
3447
+ #
3448
+ # @see http://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/EvaluationParameters AWS API Documentation
3449
+ #
3450
+ class EvaluationParameters < Struct.new(
3451
+ :number_of_backtest_windows,
3452
+ :back_test_window_offset)
3453
+ SENSITIVE = []
3454
+ include Aws::Structure
3455
+ end
3456
+
3457
+ # The results of evaluating an algorithm. Returned as part of the
3458
+ # GetAccuracyMetrics response.
3459
+ #
3460
+ # @!attribute [rw] algorithm_arn
3461
+ # The Amazon Resource Name (ARN) of the algorithm that was evaluated.
3462
+ # @return [String]
3463
+ #
3464
+ # @!attribute [rw] test_windows
3465
+ # The array of test windows used for evaluating the algorithm. The
3466
+ # `NumberOfBacktestWindows` from the EvaluationParameters object
3467
+ # determines the number of windows in the array.
3468
+ # @return [Array<Types::WindowSummary>]
3469
+ #
3470
+ # @see http://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/EvaluationResult AWS API Documentation
3471
+ #
3472
+ class EvaluationResult < Struct.new(
3473
+ :algorithm_arn,
3474
+ :test_windows)
3475
+ SENSITIVE = []
3476
+ include Aws::Structure
3477
+ end
3478
+
3479
+ # The ExplainabilityConfig data type defines the number of time series
3480
+ # and time points included in CreateExplainability.
3481
+ #
3482
+ # If you provide a predictor ARN for `ResourceArn`, you must set both
3483
+ # `TimePointGranularity` and `TimeSeriesGranularity` to “ALL”. When
3484
+ # creating Predictor Explainability, Amazon Forecast considers all time
3485
+ # series and time points.
3486
+ #
3487
+ # If you provide a forecast ARN for `ResourceArn`, you can set
3488
+ # `TimePointGranularity` and `TimeSeriesGranularity` to either “ALL” or
3489
+ # “Specific”.
3490
+ #
3491
+ # @note When making an API call, you may pass ExplainabilityConfig
3492
+ # data as a hash:
3493
+ #
3494
+ # {
3495
+ # time_series_granularity: "ALL", # required, accepts ALL, SPECIFIC
3496
+ # time_point_granularity: "ALL", # required, accepts ALL, SPECIFIC
3497
+ # }
3498
+ #
3499
+ # @!attribute [rw] time_series_granularity
3500
+ # To create an Explainability for all time series in your datasets,
3501
+ # use `ALL`. To create an Explainability for specific time series in
3502
+ # your datasets, use `SPECIFIC`.
3503
+ #
3504
+ # Specify time series by uploading a CSV file to an Amazon S3 bucket
3505
+ # and set the location within the DataDestination data type.
3506
+ # @return [String]
3507
+ #
3508
+ # @!attribute [rw] time_point_granularity
3509
+ # To create an Explainability for all time points in your forecast
3510
+ # horizon, use `ALL`. To create an Explainability for specific time
3511
+ # points in your forecast horizon, use `SPECIFIC`.
3512
+ #
3513
+ # Specify time points with the `StartDateTime` and `EndDateTime`
3514
+ # parameters within the CreateExplainability operation.
3515
+ # @return [String]
3516
+ #
3517
+ # @see http://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/ExplainabilityConfig AWS API Documentation
3518
+ #
3519
+ class ExplainabilityConfig < Struct.new(
3520
+ :time_series_granularity,
3521
+ :time_point_granularity)
3522
+ SENSITIVE = []
3523
+ include Aws::Structure
3524
+ end
3525
+
3526
+ # Provides a summary of the Explainability export properties used in the
3527
+ # ListExplainabilityExports operation. To get a complete set of
3528
+ # properties, call the DescribeExplainabilityExport operation, and
3529
+ # provide the `ExplainabilityExportArn`.
3530
+ #
3531
+ # @!attribute [rw] explainability_export_arn
3532
+ # The Amazon Resource Name (ARN) of the Explainability export.
3533
+ # @return [String]
3534
+ #
3535
+ # @!attribute [rw] explainability_export_name
3536
+ # The name of the Explainability export
3537
+ # @return [String]
3538
+ #
3539
+ # @!attribute [rw] destination
3540
+ # The destination for an export job. Provide an S3 path, an AWS
3541
+ # Identity and Access Management (IAM) role that allows Amazon
3542
+ # Forecast to access the location, and an AWS Key Management Service
3543
+ # (KMS) key (optional).
3544
+ # @return [Types::DataDestination]
3545
+ #
3546
+ # @!attribute [rw] status
3547
+ # The status of the Explainability export. States include:
3548
+ #
3549
+ # * `ACTIVE`
3550
+ #
3551
+ # * `CREATE_PENDING`, `CREATE_IN_PROGRESS`, `CREATE_FAILED`
3552
+ #
3553
+ # * `CREATE_STOPPING`, `CREATE_STOPPED`
3554
+ #
3555
+ # * `DELETE_PENDING`, `DELETE_IN_PROGRESS`, `DELETE_FAILED`
3556
+ # @return [String]
3557
+ #
3558
+ # @!attribute [rw] message
3559
+ # Information about any errors that may have occurred during the
3560
+ # Explainability export.
3561
+ # @return [String]
3562
+ #
3563
+ # @!attribute [rw] creation_time
3564
+ # When the Explainability was created.
3565
+ # @return [Time]
3566
+ #
3567
+ # @!attribute [rw] last_modification_time
3568
+ # The last time the resource was modified. The timestamp depends on
3569
+ # the status of the job:
3570
+ #
3571
+ # * `CREATE_PENDING` - The `CreationTime`.
3572
+ #
3573
+ # * `CREATE_IN_PROGRESS` - The current timestamp.
3574
+ #
3575
+ # * `CREATE_STOPPING` - The current timestamp.
3576
+ #
3577
+ # * `CREATE_STOPPED` - When the job stopped.
2238
3578
  #
2239
- # @see http://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/EncryptionConfig AWS API Documentation
3579
+ # * `ACTIVE` or `CREATE_FAILED` - When the job finished or failed.
3580
+ # @return [Time]
2240
3581
  #
2241
- class EncryptionConfig < Struct.new(
2242
- :role_arn,
2243
- :kms_key_arn)
3582
+ # @see http://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/ExplainabilityExportSummary AWS API Documentation
3583
+ #
3584
+ class ExplainabilityExportSummary < Struct.new(
3585
+ :explainability_export_arn,
3586
+ :explainability_export_name,
3587
+ :destination,
3588
+ :status,
3589
+ :message,
3590
+ :creation_time,
3591
+ :last_modification_time)
2244
3592
  SENSITIVE = []
2245
3593
  include Aws::Structure
2246
3594
  end
2247
3595
 
2248
- # Provides detailed error metrics to evaluate the performance of a
2249
- # predictor. This object is part of the Metrics object.
2250
- #
2251
- # @!attribute [rw] forecast_type
2252
- # The Forecast type used to compute WAPE and RMSE.
3596
+ # @!attribute [rw] explainability_arn
2253
3597
  # @return [String]
2254
3598
  #
2255
- # @!attribute [rw] wape
2256
- # The weighted absolute percentage error (WAPE).
2257
- # @return [Float]
2258
- #
2259
- # @!attribute [rw] rmse
2260
- # The root-mean-square error (RMSE).
2261
- # @return [Float]
3599
+ # @!attribute [rw] status
3600
+ # @return [String]
2262
3601
  #
2263
- # @see http://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/ErrorMetric AWS API Documentation
3602
+ # @see http://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/ExplainabilityInfo AWS API Documentation
2264
3603
  #
2265
- class ErrorMetric < Struct.new(
2266
- :forecast_type,
2267
- :wape,
2268
- :rmse)
3604
+ class ExplainabilityInfo < Struct.new(
3605
+ :explainability_arn,
3606
+ :status)
2269
3607
  SENSITIVE = []
2270
3608
  include Aws::Structure
2271
3609
  end
2272
3610
 
2273
- # Parameters that define how to split a dataset into training data and
2274
- # testing data, and the number of iterations to perform. These
2275
- # parameters are specified in the predefined algorithms but you can
2276
- # override them in the CreatePredictor request.
3611
+ # Provides a summary of the Explainability properties used in the
3612
+ # ListExplainabilities operation. To get a complete set of properties,
3613
+ # call the DescribeExplainability operation, and provide the listed
3614
+ # `ExplainabilityArn`.
2277
3615
  #
2278
- # @note When making an API call, you may pass EvaluationParameters
2279
- # data as a hash:
3616
+ # @!attribute [rw] explainability_arn
3617
+ # The Amazon Resource Name (ARN) of the Explainability.
3618
+ # @return [String]
2280
3619
  #
2281
- # {
2282
- # number_of_backtest_windows: 1,
2283
- # back_test_window_offset: 1,
2284
- # }
3620
+ # @!attribute [rw] explainability_name
3621
+ # The name of the Explainability.
3622
+ # @return [String]
2285
3623
  #
2286
- # @!attribute [rw] number_of_backtest_windows
2287
- # The number of times to split the input data. The default is 1. Valid
2288
- # values are 1 through 5.
2289
- # @return [Integer]
3624
+ # @!attribute [rw] resource_arn
3625
+ # The Amazon Resource Name (ARN) of the Predictor or Forecast used to
3626
+ # create the Explainability.
3627
+ # @return [String]
2290
3628
  #
2291
- # @!attribute [rw] back_test_window_offset
2292
- # The point from the end of the dataset where you want to split the
2293
- # data for model training and testing (evaluation). Specify the value
2294
- # as the number of data points. The default is the value of the
2295
- # forecast horizon. `BackTestWindowOffset` can be used to mimic a past
2296
- # virtual forecast start date. This value must be greater than or
2297
- # equal to the forecast horizon and less than half of the
2298
- # TARGET\_TIME\_SERIES dataset length.
3629
+ # @!attribute [rw] explainability_config
3630
+ # The configuration settings that define the granularity of time
3631
+ # series and time points for the Explainability.
3632
+ # @return [Types::ExplainabilityConfig]
2299
3633
  #
2300
- # `ForecastHorizon` &lt;= `BackTestWindowOffset` &lt; 1/2 *
2301
- # TARGET\_TIME\_SERIES dataset length
2302
- # @return [Integer]
3634
+ # @!attribute [rw] status
3635
+ # The status of the Explainability. States include:
2303
3636
  #
2304
- # @see http://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/EvaluationParameters AWS API Documentation
3637
+ # * `ACTIVE`
2305
3638
  #
2306
- class EvaluationParameters < Struct.new(
2307
- :number_of_backtest_windows,
2308
- :back_test_window_offset)
2309
- SENSITIVE = []
2310
- include Aws::Structure
2311
- end
2312
-
2313
- # The results of evaluating an algorithm. Returned as part of the
2314
- # GetAccuracyMetrics response.
3639
+ # * `CREATE_PENDING`, `CREATE_IN_PROGRESS`, `CREATE_FAILED`
2315
3640
  #
2316
- # @!attribute [rw] algorithm_arn
2317
- # The Amazon Resource Name (ARN) of the algorithm that was evaluated.
3641
+ # * `CREATE_STOPPING`, `CREATE_STOPPED`
3642
+ #
3643
+ # * `DELETE_PENDING`, `DELETE_IN_PROGRESS`, `DELETE_FAILED`
2318
3644
  # @return [String]
2319
3645
  #
2320
- # @!attribute [rw] test_windows
2321
- # The array of test windows used for evaluating the algorithm. The
2322
- # `NumberOfBacktestWindows` from the EvaluationParameters object
2323
- # determines the number of windows in the array.
2324
- # @return [Array<Types::WindowSummary>]
3646
+ # @!attribute [rw] message
3647
+ # Information about any errors that may have occurred during the
3648
+ # Explainability creation process.
3649
+ # @return [String]
2325
3650
  #
2326
- # @see http://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/EvaluationResult AWS API Documentation
3651
+ # @!attribute [rw] creation_time
3652
+ # When the Explainability was created.
3653
+ # @return [Time]
2327
3654
  #
2328
- class EvaluationResult < Struct.new(
2329
- :algorithm_arn,
2330
- :test_windows)
3655
+ # @!attribute [rw] last_modification_time
3656
+ # The last time the resource was modified. The timestamp depends on
3657
+ # the status of the job:
3658
+ #
3659
+ # * `CREATE_PENDING` - The `CreationTime`.
3660
+ #
3661
+ # * `CREATE_IN_PROGRESS` - The current timestamp.
3662
+ #
3663
+ # * `CREATE_STOPPING` - The current timestamp.
3664
+ #
3665
+ # * `CREATE_STOPPED` - When the job stopped.
3666
+ #
3667
+ # * `ACTIVE` or `CREATE_FAILED` - When the job finished or failed.
3668
+ # @return [Time]
3669
+ #
3670
+ # @see http://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/ExplainabilitySummary AWS API Documentation
3671
+ #
3672
+ class ExplainabilitySummary < Struct.new(
3673
+ :explainability_arn,
3674
+ :explainability_name,
3675
+ :resource_arn,
3676
+ :explainability_config,
3677
+ :status,
3678
+ :message,
3679
+ :creation_time,
3680
+ :last_modification_time)
2331
3681
  SENSITIVE = []
2332
3682
  include Aws::Structure
2333
3683
  end
@@ -2676,6 +4026,9 @@ module Aws::ForecastService
2676
4026
  # The ARN of the predictor used to generate the forecast.
2677
4027
  # @return [String]
2678
4028
  #
4029
+ # @!attribute [rw] created_using_auto_predictor
4030
+ # @return [Boolean]
4031
+ #
2679
4032
  # @!attribute [rw] dataset_group_arn
2680
4033
  # The Amazon Resource Name (ARN) of the dataset group that provided
2681
4034
  # the data used to train the predictor.
@@ -2727,6 +4080,7 @@ module Aws::ForecastService
2727
4080
  :forecast_arn,
2728
4081
  :forecast_name,
2729
4082
  :predictor_arn,
4083
+ :created_using_auto_predictor,
2730
4084
  :dataset_group_arn,
2731
4085
  :status,
2732
4086
  :message,
@@ -2759,7 +4113,17 @@ module Aws::ForecastService
2759
4113
  # An array of results from evaluating the predictor.
2760
4114
  # @return [Array<Types::EvaluationResult>]
2761
4115
  #
4116
+ # @!attribute [rw] is_auto_predictor
4117
+ # Whether the predictor was created with CreateAutoPredictor.
4118
+ # @return [Boolean]
4119
+ #
2762
4120
  # @!attribute [rw] auto_ml_override_strategy
4121
+ # <note markdown="1"> The `LatencyOptimized` AutoML override strategy is only available in
4122
+ # private beta. Contact AWS Support or your account manager to learn
4123
+ # more about access privileges.
4124
+ #
4125
+ # </note>
4126
+ #
2763
4127
  # The AutoML strategy used to train the predictor. Unless
2764
4128
  # `LatencyOptimized` is specified, the AutoML strategy optimizes
2765
4129
  # predictor accuracy.
@@ -2767,11 +4131,17 @@ module Aws::ForecastService
2767
4131
  # This parameter is only valid for predictors trained using AutoML.
2768
4132
  # @return [String]
2769
4133
  #
4134
+ # @!attribute [rw] optimization_metric
4135
+ # The accuracy metric used to optimize the predictor.
4136
+ # @return [String]
4137
+ #
2770
4138
  # @see http://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/GetAccuracyMetricsResponse AWS API Documentation
2771
4139
  #
2772
4140
  class GetAccuracyMetricsResponse < Struct.new(
2773
4141
  :predictor_evaluation_results,
2774
- :auto_ml_override_strategy)
4142
+ :is_auto_predictor,
4143
+ :auto_ml_override_strategy,
4144
+ :optimization_metric)
2775
4145
  SENSITIVE = []
2776
4146
  include Aws::Structure
2777
4147
  end
@@ -3150,6 +4520,150 @@ module Aws::ForecastService
3150
4520
  include Aws::Structure
3151
4521
  end
3152
4522
 
4523
+ # @note When making an API call, you may pass ListExplainabilitiesRequest
4524
+ # data as a hash:
4525
+ #
4526
+ # {
4527
+ # next_token: "NextToken",
4528
+ # max_results: 1,
4529
+ # filters: [
4530
+ # {
4531
+ # key: "String", # required
4532
+ # value: "Arn", # required
4533
+ # condition: "IS", # required, accepts IS, IS_NOT
4534
+ # },
4535
+ # ],
4536
+ # }
4537
+ #
4538
+ # @!attribute [rw] next_token
4539
+ # If the result of the previous request was truncated, the response
4540
+ # includes a NextToken. To retrieve the next set of results, use the
4541
+ # token in the next request. Tokens expire after 24 hours.
4542
+ # @return [String]
4543
+ #
4544
+ # @!attribute [rw] max_results
4545
+ # The number of items returned in the response.
4546
+ # @return [Integer]
4547
+ #
4548
+ # @!attribute [rw] filters
4549
+ # An array of filters. For each filter, provide a condition and a
4550
+ # match statement. The condition is either `IS` or `IS_NOT`, which
4551
+ # specifies whether to include or exclude the resources that match the
4552
+ # statement from the list. The match statement consists of a key and a
4553
+ # value.
4554
+ #
4555
+ # **Filter properties**
4556
+ #
4557
+ # * `Condition` - The condition to apply. Valid values are `IS` and
4558
+ # `IS_NOT`.
4559
+ #
4560
+ # * `Key` - The name of the parameter to filter on. Valid values are
4561
+ # `PredictorArn` and `Status`.
4562
+ #
4563
+ # * `Value` - The value to match.
4564
+ # @return [Array<Types::Filter>]
4565
+ #
4566
+ # @see http://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/ListExplainabilitiesRequest AWS API Documentation
4567
+ #
4568
+ class ListExplainabilitiesRequest < Struct.new(
4569
+ :next_token,
4570
+ :max_results,
4571
+ :filters)
4572
+ SENSITIVE = []
4573
+ include Aws::Structure
4574
+ end
4575
+
4576
+ # @!attribute [rw] explainabilities
4577
+ # An array of objects that summarize the properties of each
4578
+ # Explainability resource.
4579
+ # @return [Array<Types::ExplainabilitySummary>]
4580
+ #
4581
+ # @!attribute [rw] next_token
4582
+ # Returns this token if the response is truncated. To retrieve the
4583
+ # next set of results, use the token in the next request.
4584
+ # @return [String]
4585
+ #
4586
+ # @see http://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/ListExplainabilitiesResponse AWS API Documentation
4587
+ #
4588
+ class ListExplainabilitiesResponse < Struct.new(
4589
+ :explainabilities,
4590
+ :next_token)
4591
+ SENSITIVE = []
4592
+ include Aws::Structure
4593
+ end
4594
+
4595
+ # @note When making an API call, you may pass ListExplainabilityExportsRequest
4596
+ # data as a hash:
4597
+ #
4598
+ # {
4599
+ # next_token: "NextToken",
4600
+ # max_results: 1,
4601
+ # filters: [
4602
+ # {
4603
+ # key: "String", # required
4604
+ # value: "Arn", # required
4605
+ # condition: "IS", # required, accepts IS, IS_NOT
4606
+ # },
4607
+ # ],
4608
+ # }
4609
+ #
4610
+ # @!attribute [rw] next_token
4611
+ # If the result of the previous request was truncated, the response
4612
+ # includes a NextToken. To retrieve the next set of results, use the
4613
+ # token in the next request. Tokens expire after 24 hours.
4614
+ # @return [String]
4615
+ #
4616
+ # @!attribute [rw] max_results
4617
+ # The number of items to return in the response.
4618
+ # @return [Integer]
4619
+ #
4620
+ # @!attribute [rw] filters
4621
+ # An array of filters. For each filter, provide a condition and a
4622
+ # match statement. The condition is either `IS` or `IS_NOT`, which
4623
+ # specifies whether to include or exclude resources that match the
4624
+ # statement from the list. The match statement consists of a key and a
4625
+ # value.
4626
+ #
4627
+ # **Filter properties**
4628
+ #
4629
+ # * `Condition` - The condition to apply. Valid values are `IS` and
4630
+ # `IS_NOT`.
4631
+ #
4632
+ # * `Key` - The name of the parameter to filter on. Valid values are
4633
+ # `PredictorArn` and `Status`.
4634
+ #
4635
+ # * `Value` - The value to match.
4636
+ # @return [Array<Types::Filter>]
4637
+ #
4638
+ # @see http://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/ListExplainabilityExportsRequest AWS API Documentation
4639
+ #
4640
+ class ListExplainabilityExportsRequest < Struct.new(
4641
+ :next_token,
4642
+ :max_results,
4643
+ :filters)
4644
+ SENSITIVE = []
4645
+ include Aws::Structure
4646
+ end
4647
+
4648
+ # @!attribute [rw] explainability_exports
4649
+ # An array of objects that summarize the properties of each
4650
+ # Explainability export.
4651
+ # @return [Array<Types::ExplainabilityExportSummary>]
4652
+ #
4653
+ # @!attribute [rw] next_token
4654
+ # Returns this token if the response is truncated. To retrieve the
4655
+ # next set of results, use the token in the next request.
4656
+ # @return [String]
4657
+ #
4658
+ # @see http://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/ListExplainabilityExportsResponse AWS API Documentation
4659
+ #
4660
+ class ListExplainabilityExportsResponse < Struct.new(
4661
+ :explainability_exports,
4662
+ :next_token)
4663
+ SENSITIVE = []
4664
+ include Aws::Structure
4665
+ end
4666
+
3153
4667
  # @note When making an API call, you may pass ListForecastExportJobsRequest
3154
4668
  # data as a hash:
3155
4669
  #
@@ -3508,16 +5022,23 @@ module Aws::ForecastService
3508
5022
  # @return [Array<Types::WeightedQuantileLoss>]
3509
5023
  #
3510
5024
  # @!attribute [rw] error_metrics
3511
- # Provides detailed error metrics on forecast type, root-mean
3512
- # square-error (RMSE), and weighted average percentage error (WAPE).
5025
+ # Provides detailed error metrics for each forecast type. Metrics
5026
+ # include root-mean square-error (RMSE), mean absolute percentage
5027
+ # error (MAPE), mean absolute scaled error (MASE), and weighted
5028
+ # average percentage error (WAPE).
3513
5029
  # @return [Array<Types::ErrorMetric>]
3514
5030
  #
5031
+ # @!attribute [rw] average_weighted_quantile_loss
5032
+ # The average value of all weighted quantile losses.
5033
+ # @return [Float]
5034
+ #
3515
5035
  # @see http://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/Metrics AWS API Documentation
3516
5036
  #
3517
5037
  class Metrics < Struct.new(
3518
5038
  :rmse,
3519
5039
  :weighted_quantile_losses,
3520
- :error_metrics)
5040
+ :error_metrics,
5041
+ :average_weighted_quantile_loss)
3521
5042
  SENSITIVE = []
3522
5043
  include Aws::Structure
3523
5044
  end
@@ -3709,6 +5230,15 @@ module Aws::ForecastService
3709
5230
  # the data used to train the predictor.
3710
5231
  # @return [String]
3711
5232
  #
5233
+ # @!attribute [rw] is_auto_predictor
5234
+ # Whether AutoPredictor was used to create the predictor.
5235
+ # @return [Boolean]
5236
+ #
5237
+ # @!attribute [rw] reference_predictor_summary
5238
+ # A summary of the reference predictor used if the predictor was
5239
+ # retrained or upgraded.
5240
+ # @return [Types::ReferencePredictorSummary]
5241
+ #
3712
5242
  # @!attribute [rw] status
3713
5243
  # The status of the predictor. States include:
3714
5244
  #
@@ -3755,6 +5285,8 @@ module Aws::ForecastService
3755
5285
  :predictor_arn,
3756
5286
  :predictor_name,
3757
5287
  :dataset_group_arn,
5288
+ :is_auto_predictor,
5289
+ :reference_predictor_summary,
3758
5290
  :status,
3759
5291
  :message,
3760
5292
  :creation_time,
@@ -3763,6 +5295,26 @@ module Aws::ForecastService
3763
5295
  include Aws::Structure
3764
5296
  end
3765
5297
 
5298
+ # Provides a summary of the reference predictor used when retraining or
5299
+ # upgrading a predictor.
5300
+ #
5301
+ # @!attribute [rw] arn
5302
+ # The ARN of the reference predictor.
5303
+ # @return [String]
5304
+ #
5305
+ # @!attribute [rw] state
5306
+ # Whether the reference predictor is `Active` or `Deleted`.
5307
+ # @return [String]
5308
+ #
5309
+ # @see http://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/ReferencePredictorSummary AWS API Documentation
5310
+ #
5311
+ class ReferencePredictorSummary < Struct.new(
5312
+ :arn,
5313
+ :state)
5314
+ SENSITIVE = []
5315
+ include Aws::Structure
5316
+ end
5317
+
3766
5318
  # There is already a resource with this name. Try again with a different
3767
5319
  # name.
3768
5320
  #