aws-sdk-forecastservice 1.26.0 → 1.30.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, set `CountryCode` to 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,237 @@ 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
+ # Create an Explainability resource for the predictor.
495
+ # @return [Boolean]
79
496
  #
80
- # Logarithmic
497
+ # @!attribute [rw] tags
498
+ # Optional metadata to help you categorize and organize your
499
+ # predictors. Each tag consists of a key and an optional value, both
500
+ # of which you define. Tag keys and values are case sensitive.
81
501
  #
82
- # : Hyperparameter tuning searches the values in the hyperparameter
83
- # range by using a logarithmic scale.
502
+ # The following restrictions apply to tags:
84
503
  #
85
- # Logarithmic scaling works only for ranges that have values greater
86
- # than 0.
504
+ # * For each resource, each tag key must be unique and each tag key
505
+ # must have one value.
87
506
  #
88
- # ReverseLogarithmic
507
+ # * Maximum number of tags per resource: 50.
89
508
  #
90
- # : hyperparameter tuning searches the values in the hyperparameter
91
- # range by using a reverse logarithmic scale.
509
+ # * Maximum key length: 128 Unicode characters in UTF-8.
92
510
  #
93
- # Reverse logarithmic scaling works only for ranges that are
94
- # entirely within the range 0 &lt;= x &lt; 1.0.
511
+ # * Maximum value length: 256 Unicode characters in UTF-8.
95
512
  #
96
- # For information about choosing a hyperparameter scale, see
97
- # [Hyperparameter Scaling][1]. One of the following values:
513
+ # * Accepted characters: all letters and numbers, spaces representable
514
+ # in UTF-8, and + - = . \_ : / @. If your tagging schema is used
515
+ # across other services and resources, the character restrictions of
516
+ # those services also apply.
98
517
  #
518
+ # * Key prefixes cannot include any upper or lowercase combination of
519
+ # `aws:` or `AWS:`. Values can have this prefix. If a tag value has
520
+ # `aws` as its prefix but the key does not, Forecast considers it to
521
+ # be a user tag and will count against the limit of 50 tags. Tags
522
+ # with only the key prefix of `aws` do not count against your tags
523
+ # per resource limit. You cannot edit or delete tag keys with this
524
+ # prefix.
525
+ # @return [Array<Types::Tag>]
99
526
  #
527
+ # @see http://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/CreateAutoPredictorRequest AWS API Documentation
100
528
  #
101
- # [1]: http://docs.aws.amazon.com/sagemaker/latest/dg/automatic-model-tuning-define-ranges.html#scaling-type
529
+ class CreateAutoPredictorRequest < Struct.new(
530
+ :predictor_name,
531
+ :forecast_horizon,
532
+ :forecast_types,
533
+ :forecast_dimensions,
534
+ :forecast_frequency,
535
+ :data_config,
536
+ :encryption_config,
537
+ :reference_predictor_arn,
538
+ :optimization_metric,
539
+ :explain_predictor,
540
+ :tags)
541
+ SENSITIVE = []
542
+ include Aws::Structure
543
+ end
544
+
545
+ # @!attribute [rw] predictor_arn
546
+ # The Amazon Resource Name (ARN) of the predictor.
102
547
  # @return [String]
103
548
  #
104
- # @see http://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/ContinuousParameterRange AWS API Documentation
549
+ # @see http://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/CreateAutoPredictorResponse AWS API Documentation
105
550
  #
106
- class ContinuousParameterRange < Struct.new(
107
- :name,
108
- :max_value,
109
- :min_value,
110
- :scaling_type)
551
+ class CreateAutoPredictorResponse < Struct.new(
552
+ :predictor_arn)
111
553
  SENSITIVE = []
112
554
  include Aws::Structure
113
555
  end
@@ -424,74 +866,302 @@ module Aws::ForecastService
424
866
  # @return [String]
425
867
  #
426
868
  # @!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.
869
+ # The schema for the dataset. The schema attributes and their order
870
+ # must match the fields in your data. The dataset `Domain` and
871
+ # `DatasetType` that you choose determine the minimum required fields
872
+ # in your training data. For information about the required fields for
873
+ # a specific dataset domain and type, see howitworks-domains-ds-types.
874
+ # @return [Types::Schema]
875
+ #
876
+ # @!attribute [rw] encryption_config
877
+ # An AWS Key Management Service (KMS) key and the AWS Identity and
878
+ # Access Management (IAM) role that Amazon Forecast can assume to
879
+ # access the key.
880
+ # @return [Types::EncryptionConfig]
881
+ #
882
+ # @!attribute [rw] tags
883
+ # The optional metadata that you apply to the dataset to help you
884
+ # categorize and organize them. Each tag consists of a key and an
885
+ # optional value, both of which you define.
886
+ #
887
+ # The following basic restrictions apply to tags:
888
+ #
889
+ # * Maximum number of tags per resource - 50.
890
+ #
891
+ # * For each resource, each tag key must be unique, and each tag key
892
+ # can have only one value.
893
+ #
894
+ # * Maximum key length - 128 Unicode characters in UTF-8.
895
+ #
896
+ # * Maximum value length - 256 Unicode characters in UTF-8.
897
+ #
898
+ # * If your tagging schema is used across multiple services and
899
+ # resources, remember that other services may have restrictions on
900
+ # allowed characters. Generally allowed characters are: letters,
901
+ # numbers, and spaces representable in UTF-8, and the following
902
+ # characters: + - = . \_ : / @.
903
+ #
904
+ # * Tag keys and values are case sensitive.
905
+ #
906
+ # * Do not use `aws:`, `AWS:`, or any upper or lowercase combination
907
+ # of such as a prefix for keys as it is reserved for AWS use. You
908
+ # cannot edit or delete tag keys with this prefix. Values can have
909
+ # this prefix. If a tag value has `aws` as its prefix but the key
910
+ # does not, then Forecast considers it to be a user tag and will
911
+ # count against the limit of 50 tags. Tags with only the key prefix
912
+ # of `aws` do not count against your tags per resource limit.
913
+ # @return [Array<Types::Tag>]
914
+ #
915
+ # @see http://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/CreateDatasetRequest AWS API Documentation
916
+ #
917
+ class CreateDatasetRequest < Struct.new(
918
+ :dataset_name,
919
+ :domain,
920
+ :dataset_type,
921
+ :data_frequency,
922
+ :schema,
923
+ :encryption_config,
924
+ :tags)
925
+ SENSITIVE = []
926
+ include Aws::Structure
927
+ end
928
+
929
+ # @!attribute [rw] dataset_arn
930
+ # The Amazon Resource Name (ARN) of the dataset.
931
+ # @return [String]
932
+ #
933
+ # @see http://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/CreateDatasetResponse AWS API Documentation
934
+ #
935
+ class CreateDatasetResponse < Struct.new(
936
+ :dataset_arn)
937
+ SENSITIVE = []
938
+ include Aws::Structure
939
+ end
940
+
941
+ # @note When making an API call, you may pass CreateExplainabilityExportRequest
942
+ # data as a hash:
943
+ #
944
+ # {
945
+ # explainability_export_name: "Name", # required
946
+ # explainability_arn: "Arn", # required
947
+ # destination: { # required
948
+ # s3_config: { # required
949
+ # path: "S3Path", # required
950
+ # role_arn: "Arn", # required
951
+ # kms_key_arn: "KMSKeyArn",
952
+ # },
953
+ # },
954
+ # tags: [
955
+ # {
956
+ # key: "TagKey", # required
957
+ # value: "TagValue", # required
958
+ # },
959
+ # ],
960
+ # }
961
+ #
962
+ # @!attribute [rw] explainability_export_name
963
+ # A unique name for the Explainability export.
964
+ # @return [String]
965
+ #
966
+ # @!attribute [rw] explainability_arn
967
+ # The Amazon Resource Name (ARN) of the Explainability to export.
968
+ # @return [String]
969
+ #
970
+ # @!attribute [rw] destination
971
+ # The destination for an export job. Provide an S3 path, an AWS
972
+ # Identity and Access Management (IAM) role that allows Amazon
973
+ # Forecast to access the location, and an AWS Key Management Service
974
+ # (KMS) key (optional).
975
+ # @return [Types::DataDestination]
976
+ #
977
+ # @!attribute [rw] tags
978
+ # Optional metadata to help you categorize and organize your
979
+ # resources. Each tag consists of a key and an optional value, both of
980
+ # which you define. Tag keys and values are case sensitive.
981
+ #
982
+ # The following restrictions apply to tags:
983
+ #
984
+ # * For each resource, each tag key must be unique and each tag key
985
+ # must have one value.
986
+ #
987
+ # * Maximum number of tags per resource: 50.
988
+ #
989
+ # * Maximum key length: 128 Unicode characters in UTF-8.
990
+ #
991
+ # * Maximum value length: 256 Unicode characters in UTF-8.
992
+ #
993
+ # * Accepted characters: all letters and numbers, spaces representable
994
+ # in UTF-8, and + - = . \_ : / @. If your tagging schema is used
995
+ # across other services and resources, the character restrictions of
996
+ # those services also apply.
997
+ #
998
+ # * Key prefixes cannot include any upper or lowercase combination of
999
+ # `aws:` or `AWS:`. Values can have this prefix. If a tag value has
1000
+ # `aws` as its prefix but the key does not, Forecast considers it to
1001
+ # be a user tag and will count against the limit of 50 tags. Tags
1002
+ # with only the key prefix of `aws` do not count against your tags
1003
+ # per resource limit. You cannot edit or delete tag keys with this
1004
+ # prefix.
1005
+ # @return [Array<Types::Tag>]
1006
+ #
1007
+ # @see http://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/CreateExplainabilityExportRequest AWS API Documentation
1008
+ #
1009
+ class CreateExplainabilityExportRequest < Struct.new(
1010
+ :explainability_export_name,
1011
+ :explainability_arn,
1012
+ :destination,
1013
+ :tags)
1014
+ SENSITIVE = []
1015
+ include Aws::Structure
1016
+ end
1017
+
1018
+ # @!attribute [rw] explainability_export_arn
1019
+ # The Amazon Resource Name (ARN) of the export.
1020
+ # @return [String]
1021
+ #
1022
+ # @see http://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/CreateExplainabilityExportResponse AWS API Documentation
1023
+ #
1024
+ class CreateExplainabilityExportResponse < Struct.new(
1025
+ :explainability_export_arn)
1026
+ SENSITIVE = []
1027
+ include Aws::Structure
1028
+ end
1029
+
1030
+ # @note When making an API call, you may pass CreateExplainabilityRequest
1031
+ # data as a hash:
1032
+ #
1033
+ # {
1034
+ # explainability_name: "Name", # required
1035
+ # resource_arn: "Arn", # required
1036
+ # explainability_config: { # required
1037
+ # time_series_granularity: "ALL", # required, accepts ALL, SPECIFIC
1038
+ # time_point_granularity: "ALL", # required, accepts ALL, SPECIFIC
1039
+ # },
1040
+ # data_source: {
1041
+ # s3_config: { # required
1042
+ # path: "S3Path", # required
1043
+ # role_arn: "Arn", # required
1044
+ # kms_key_arn: "KMSKeyArn",
1045
+ # },
1046
+ # },
1047
+ # schema: {
1048
+ # attributes: [
1049
+ # {
1050
+ # attribute_name: "Name",
1051
+ # attribute_type: "string", # accepts string, integer, float, timestamp, geolocation
1052
+ # },
1053
+ # ],
1054
+ # },
1055
+ # enable_visualization: false,
1056
+ # start_date_time: "LocalDateTime",
1057
+ # end_date_time: "LocalDateTime",
1058
+ # tags: [
1059
+ # {
1060
+ # key: "TagKey", # required
1061
+ # value: "TagValue", # required
1062
+ # },
1063
+ # ],
1064
+ # }
1065
+ #
1066
+ # @!attribute [rw] explainability_name
1067
+ # A unique name for the Explainability.
1068
+ # @return [String]
1069
+ #
1070
+ # @!attribute [rw] resource_arn
1071
+ # The Amazon Resource Name (ARN) of the Predictor or Forecast used to
1072
+ # create the Explainability.
1073
+ # @return [String]
1074
+ #
1075
+ # @!attribute [rw] explainability_config
1076
+ # The configuration settings that define the granularity of time
1077
+ # series and time points for the Explainability.
1078
+ # @return [Types::ExplainabilityConfig]
1079
+ #
1080
+ # @!attribute [rw] data_source
1081
+ # The source of your data, an AWS Identity and Access Management (IAM)
1082
+ # role that allows Amazon Forecast to access the data and, optionally,
1083
+ # an AWS Key Management Service (KMS) key.
1084
+ # @return [Types::DataSource]
1085
+ #
1086
+ # @!attribute [rw] schema
1087
+ # Defines the fields of a dataset.
432
1088
  # @return [Types::Schema]
433
1089
  #
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]
1090
+ # @!attribute [rw] enable_visualization
1091
+ # Create an Expainability visualization that is viewable within the
1092
+ # AWS console.
1093
+ # @return [Boolean]
439
1094
  #
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.
1095
+ # @!attribute [rw] start_date_time
1096
+ # If `TimePointGranularity` is set to `SPECIFIC`, define the first
1097
+ # point for the Explainability.
444
1098
  #
445
- # The following basic restrictions apply to tags:
1099
+ # Use the following timestamp format: yyyy-MM-ddTHH:mm:ss (example:
1100
+ # 2015-01-01T20:00:00)
1101
+ # @return [String]
446
1102
  #
447
- # * Maximum number of tags per resource - 50.
1103
+ # @!attribute [rw] end_date_time
1104
+ # If `TimePointGranularity` is set to `SPECIFIC`, define the last time
1105
+ # point for the Explainability.
448
1106
  #
449
- # * For each resource, each tag key must be unique, and each tag key
450
- # can have only one value.
1107
+ # Use the following timestamp format: yyyy-MM-ddTHH:mm:ss (example:
1108
+ # 2015-01-01T20:00:00)
1109
+ # @return [String]
451
1110
  #
452
- # * Maximum key length - 128 Unicode characters in UTF-8.
1111
+ # @!attribute [rw] tags
1112
+ # Optional metadata to help you categorize and organize your
1113
+ # resources. Each tag consists of a key and an optional value, both of
1114
+ # which you define. Tag keys and values are case sensitive.
453
1115
  #
454
- # * Maximum value length - 256 Unicode characters in UTF-8.
1116
+ # The following restrictions apply to tags:
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
+ # * For each resource, each tag key must be unique and each tag key
1119
+ # must have one value.
461
1120
  #
462
- # * Tag keys and values are case sensitive.
1121
+ # * Maximum number of tags per resource: 50.
463
1122
  #
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.
1123
+ # * Maximum key length: 128 Unicode characters in UTF-8.
1124
+ #
1125
+ # * Maximum value length: 256 Unicode characters in UTF-8.
1126
+ #
1127
+ # * Accepted characters: all letters and numbers, spaces representable
1128
+ # in UTF-8, and + - = . \_ : / @. If your tagging schema is used
1129
+ # across other services and resources, the character restrictions of
1130
+ # those services also apply.
1131
+ #
1132
+ # * Key prefixes cannot include any upper or lowercase combination of
1133
+ # `aws:` or `AWS:`. Values can have this prefix. If a tag value has
1134
+ # `aws` as its prefix but the key does not, Forecast considers it to
1135
+ # be a user tag and will count against the limit of 50 tags. Tags
1136
+ # with only the key prefix of `aws` do not count against your tags
1137
+ # per resource limit. You cannot edit or delete tag keys with this
1138
+ # prefix.
471
1139
  # @return [Array<Types::Tag>]
472
1140
  #
473
- # @see http://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/CreateDatasetRequest AWS API Documentation
1141
+ # @see http://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/CreateExplainabilityRequest AWS API Documentation
474
1142
  #
475
- class CreateDatasetRequest < Struct.new(
476
- :dataset_name,
477
- :domain,
478
- :dataset_type,
479
- :data_frequency,
1143
+ class CreateExplainabilityRequest < Struct.new(
1144
+ :explainability_name,
1145
+ :resource_arn,
1146
+ :explainability_config,
1147
+ :data_source,
480
1148
  :schema,
481
- :encryption_config,
1149
+ :enable_visualization,
1150
+ :start_date_time,
1151
+ :end_date_time,
482
1152
  :tags)
483
1153
  SENSITIVE = []
484
1154
  include Aws::Structure
485
1155
  end
486
1156
 
487
- # @!attribute [rw] dataset_arn
488
- # The Amazon Resource Name (ARN) of the dataset.
1157
+ # @!attribute [rw] explainability_arn
1158
+ # The Amazon Resource Name (ARN) of the Explainability.
489
1159
  # @return [String]
490
1160
  #
491
- # @see http://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/CreateDatasetResponse AWS API Documentation
1161
+ # @see http://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/CreateExplainabilityResponse AWS API Documentation
492
1162
  #
493
- class CreateDatasetResponse < Struct.new(
494
- :dataset_arn)
1163
+ class CreateExplainabilityResponse < Struct.new(
1164
+ :explainability_arn)
495
1165
  SENSITIVE = []
496
1166
  include Aws::Structure
497
1167
  end
@@ -782,7 +1452,7 @@ module Aws::ForecastService
782
1452
  # forecast_horizon: 1, # required
783
1453
  # forecast_types: ["ForecastType"],
784
1454
  # perform_auto_ml: false,
785
- # auto_ml_override_strategy: "LatencyOptimized", # accepts LatencyOptimized
1455
+ # auto_ml_override_strategy: "LatencyOptimized", # accepts LatencyOptimized, AccuracyOptimized
786
1456
  # perform_hpo: false,
787
1457
  # training_parameters: {
788
1458
  # "ParameterKey" => "ParameterValue",
@@ -1063,6 +1733,55 @@ module Aws::ForecastService
1063
1733
  include Aws::Structure
1064
1734
  end
1065
1735
 
1736
+ # The data configuration for your dataset group and any additional
1737
+ # datasets.
1738
+ #
1739
+ # @note When making an API call, you may pass DataConfig
1740
+ # data as a hash:
1741
+ #
1742
+ # {
1743
+ # dataset_group_arn: "Arn", # required
1744
+ # attribute_configs: [
1745
+ # {
1746
+ # attribute_name: "Name", # required
1747
+ # transformations: { # required
1748
+ # "Name" => "Value",
1749
+ # },
1750
+ # },
1751
+ # ],
1752
+ # additional_datasets: [
1753
+ # {
1754
+ # name: "Name", # required
1755
+ # configuration: {
1756
+ # "Name" => ["Value"],
1757
+ # },
1758
+ # },
1759
+ # ],
1760
+ # }
1761
+ #
1762
+ # @!attribute [rw] dataset_group_arn
1763
+ # The ARN of the dataset group used to train the predictor.
1764
+ # @return [String]
1765
+ #
1766
+ # @!attribute [rw] attribute_configs
1767
+ # Aggregation and filling options for attributes in your dataset
1768
+ # group.
1769
+ # @return [Array<Types::AttributeConfig>]
1770
+ #
1771
+ # @!attribute [rw] additional_datasets
1772
+ # Additional built-in datasets like Holidays and the Weather Index.
1773
+ # @return [Array<Types::AdditionalDataset>]
1774
+ #
1775
+ # @see http://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/DataConfig AWS API Documentation
1776
+ #
1777
+ class DataConfig < Struct.new(
1778
+ :dataset_group_arn,
1779
+ :attribute_configs,
1780
+ :additional_datasets)
1781
+ SENSITIVE = []
1782
+ include Aws::Structure
1783
+ end
1784
+
1066
1785
  # The destination for an export job. Provide an S3 path, an AWS Identity
1067
1786
  # and Access Management (IAM) role that allows Amazon Forecast to access
1068
1787
  # the location, and an AWS Key Management Service (KMS) key (optional).
@@ -1091,10 +1810,9 @@ module Aws::ForecastService
1091
1810
  include Aws::Structure
1092
1811
  end
1093
1812
 
1094
- # The source of your training data, an AWS Identity and Access
1095
- # Management (IAM) role that allows Amazon Forecast to access the data
1096
- # and, optionally, an AWS Key Management Service (KMS) key. This object
1097
- # is submitted in the CreateDatasetImportJob request.
1813
+ # The source of your data, an AWS Identity and Access Management (IAM)
1814
+ # role that allows Amazon Forecast to access the data and, optionally,
1815
+ # an AWS Key Management Service (KMS) key.
1098
1816
  #
1099
1817
  # @note When making an API call, you may pass DataSource
1100
1818
  # data as a hash:
@@ -1108,9 +1826,8 @@ module Aws::ForecastService
1108
1826
  # }
1109
1827
  #
1110
1828
  # @!attribute [rw] s3_config
1111
- # The path to the training data stored in an Amazon Simple Storage
1112
- # Service (Amazon S3) bucket along with the credentials to access the
1113
- # data.
1829
+ # The path to the data stored in an Amazon Simple Storage Service
1830
+ # (Amazon S3) bucket along with the credentials to access the data.
1114
1831
  # @return [Types::S3Config]
1115
1832
  #
1116
1833
  # @see http://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/DataSource AWS API Documentation
@@ -1330,6 +2047,46 @@ module Aws::ForecastService
1330
2047
  include Aws::Structure
1331
2048
  end
1332
2049
 
2050
+ # @note When making an API call, you may pass DeleteExplainabilityExportRequest
2051
+ # data as a hash:
2052
+ #
2053
+ # {
2054
+ # explainability_export_arn: "Arn", # required
2055
+ # }
2056
+ #
2057
+ # @!attribute [rw] explainability_export_arn
2058
+ # The Amazon Resource Name (ARN) of the Explainability export to
2059
+ # delete.
2060
+ # @return [String]
2061
+ #
2062
+ # @see http://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/DeleteExplainabilityExportRequest AWS API Documentation
2063
+ #
2064
+ class DeleteExplainabilityExportRequest < Struct.new(
2065
+ :explainability_export_arn)
2066
+ SENSITIVE = []
2067
+ include Aws::Structure
2068
+ end
2069
+
2070
+ # @note When making an API call, you may pass DeleteExplainabilityRequest
2071
+ # data as a hash:
2072
+ #
2073
+ # {
2074
+ # explainability_arn: "Arn", # required
2075
+ # }
2076
+ #
2077
+ # @!attribute [rw] explainability_arn
2078
+ # The Amazon Resource Name (ARN) of the Explainability resource to
2079
+ # delete.
2080
+ # @return [String]
2081
+ #
2082
+ # @see http://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/DeleteExplainabilityRequest AWS API Documentation
2083
+ #
2084
+ class DeleteExplainabilityRequest < Struct.new(
2085
+ :explainability_arn)
2086
+ SENSITIVE = []
2087
+ include Aws::Structure
2088
+ end
2089
+
1333
2090
  # @note When making an API call, you may pass DeleteForecastExportJobRequest
1334
2091
  # data as a hash:
1335
2092
  #
@@ -1352,77 +2109,223 @@ module Aws::ForecastService
1352
2109
  # @note When making an API call, you may pass DeleteForecastRequest
1353
2110
  # data as a hash:
1354
2111
  #
1355
- # {
1356
- # forecast_arn: "Arn", # required
1357
- # }
2112
+ # {
2113
+ # forecast_arn: "Arn", # required
2114
+ # }
2115
+ #
2116
+ # @!attribute [rw] forecast_arn
2117
+ # The Amazon Resource Name (ARN) of the forecast to delete.
2118
+ # @return [String]
2119
+ #
2120
+ # @see http://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/DeleteForecastRequest AWS API Documentation
2121
+ #
2122
+ class DeleteForecastRequest < Struct.new(
2123
+ :forecast_arn)
2124
+ SENSITIVE = []
2125
+ include Aws::Structure
2126
+ end
2127
+
2128
+ # @note When making an API call, you may pass DeletePredictorBacktestExportJobRequest
2129
+ # data as a hash:
2130
+ #
2131
+ # {
2132
+ # predictor_backtest_export_job_arn: "Arn", # required
2133
+ # }
2134
+ #
2135
+ # @!attribute [rw] predictor_backtest_export_job_arn
2136
+ # The Amazon Resource Name (ARN) of the predictor backtest export job
2137
+ # to delete.
2138
+ # @return [String]
2139
+ #
2140
+ # @see http://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/DeletePredictorBacktestExportJobRequest AWS API Documentation
2141
+ #
2142
+ class DeletePredictorBacktestExportJobRequest < Struct.new(
2143
+ :predictor_backtest_export_job_arn)
2144
+ SENSITIVE = []
2145
+ include Aws::Structure
2146
+ end
2147
+
2148
+ # @note When making an API call, you may pass DeletePredictorRequest
2149
+ # data as a hash:
2150
+ #
2151
+ # {
2152
+ # predictor_arn: "Arn", # required
2153
+ # }
2154
+ #
2155
+ # @!attribute [rw] predictor_arn
2156
+ # The Amazon Resource Name (ARN) of the predictor to delete.
2157
+ # @return [String]
2158
+ #
2159
+ # @see http://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/DeletePredictorRequest AWS API Documentation
2160
+ #
2161
+ class DeletePredictorRequest < Struct.new(
2162
+ :predictor_arn)
2163
+ SENSITIVE = []
2164
+ include Aws::Structure
2165
+ end
2166
+
2167
+ # @note When making an API call, you may pass DeleteResourceTreeRequest
2168
+ # data as a hash:
2169
+ #
2170
+ # {
2171
+ # resource_arn: "Arn", # required
2172
+ # }
2173
+ #
2174
+ # @!attribute [rw] resource_arn
2175
+ # The Amazon Resource Name (ARN) of the parent resource to delete. All
2176
+ # child resources of the parent resource will also be deleted.
2177
+ # @return [String]
2178
+ #
2179
+ # @see http://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/DeleteResourceTreeRequest AWS API Documentation
2180
+ #
2181
+ class DeleteResourceTreeRequest < Struct.new(
2182
+ :resource_arn)
2183
+ SENSITIVE = []
2184
+ include Aws::Structure
2185
+ end
2186
+
2187
+ # @note When making an API call, you may pass DescribeAutoPredictorRequest
2188
+ # data as a hash:
2189
+ #
2190
+ # {
2191
+ # predictor_arn: "Arn", # required
2192
+ # }
2193
+ #
2194
+ # @!attribute [rw] predictor_arn
2195
+ # The Amazon Resource Name (ARN) of the predictor.
2196
+ # @return [String]
2197
+ #
2198
+ # @see http://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/DescribeAutoPredictorRequest AWS API Documentation
2199
+ #
2200
+ class DescribeAutoPredictorRequest < Struct.new(
2201
+ :predictor_arn)
2202
+ SENSITIVE = []
2203
+ include Aws::Structure
2204
+ end
2205
+
2206
+ # @!attribute [rw] predictor_arn
2207
+ # The Amazon Resource Name (ARN) of the predictor
2208
+ # @return [String]
2209
+ #
2210
+ # @!attribute [rw] predictor_name
2211
+ # The name of the predictor.
2212
+ # @return [String]
2213
+ #
2214
+ # @!attribute [rw] forecast_horizon
2215
+ # The number of time-steps that the model predicts. The forecast
2216
+ # horizon is also called the prediction length.
2217
+ # @return [Integer]
2218
+ #
2219
+ # @!attribute [rw] forecast_types
2220
+ # The forecast types used during predictor training. Default value is
2221
+ # \["0.1","0.5","0.9"\].
2222
+ # @return [Array<String>]
2223
+ #
2224
+ # @!attribute [rw] forecast_frequency
2225
+ # The frequency of predictions in a forecast.
2226
+ #
2227
+ # Valid intervals are Y (Year), M (Month), W (Week), D (Day), H
2228
+ # (Hour), 30min (30 minutes), 15min (15 minutes), 10min (10 minutes),
2229
+ # 5min (5 minutes), and 1min (1 minute). For example, "Y" indicates
2230
+ # every year and "5min" indicates every five minutes.
2231
+ # @return [String]
2232
+ #
2233
+ # @!attribute [rw] forecast_dimensions
2234
+ # An array of dimension (field) names that specify the attributes used
2235
+ # to group your time series.
2236
+ # @return [Array<String>]
2237
+ #
2238
+ # @!attribute [rw] dataset_import_job_arns
2239
+ # An array of the ARNs of the dataset import jobs used to import
2240
+ # training data for the predictor.
2241
+ # @return [Array<String>]
2242
+ #
2243
+ # @!attribute [rw] data_config
2244
+ # The data configuration for your dataset group and any additional
2245
+ # datasets.
2246
+ # @return [Types::DataConfig]
2247
+ #
2248
+ # @!attribute [rw] encryption_config
2249
+ # An AWS Key Management Service (KMS) key and an AWS Identity and
2250
+ # Access Management (IAM) role that Amazon Forecast can assume to
2251
+ # access the key. You can specify this optional object in the
2252
+ # CreateDataset and CreatePredictor requests.
2253
+ # @return [Types::EncryptionConfig]
2254
+ #
2255
+ # @!attribute [rw] reference_predictor_summary
2256
+ # The ARN and state of the reference predictor. This parameter is only
2257
+ # valid for retrained or upgraded predictors.
2258
+ # @return [Types::ReferencePredictorSummary]
1358
2259
  #
1359
- # @!attribute [rw] forecast_arn
1360
- # The Amazon Resource Name (ARN) of the forecast to delete.
1361
- # @return [String]
2260
+ # @!attribute [rw] estimated_time_remaining_in_minutes
2261
+ # The estimated time remaining in minutes for the predictor training
2262
+ # job to complete.
2263
+ # @return [Integer]
1362
2264
  #
1363
- # @see http://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/DeleteForecastRequest AWS API Documentation
2265
+ # @!attribute [rw] status
2266
+ # The status of the predictor. States include:
1364
2267
  #
1365
- class DeleteForecastRequest < Struct.new(
1366
- :forecast_arn)
1367
- SENSITIVE = []
1368
- include Aws::Structure
1369
- end
1370
-
1371
- # @note When making an API call, you may pass DeletePredictorBacktestExportJobRequest
1372
- # data as a hash:
2268
+ # * `ACTIVE`
1373
2269
  #
1374
- # {
1375
- # predictor_backtest_export_job_arn: "Arn", # required
1376
- # }
2270
+ # * `CREATE_PENDING`, `CREATE_IN_PROGRESS`, `CREATE_FAILED`
1377
2271
  #
1378
- # @!attribute [rw] predictor_backtest_export_job_arn
1379
- # The Amazon Resource Name (ARN) of the predictor backtest export job
1380
- # to delete.
2272
+ # * `CREATE_STOPPING`, `CREATE_STOPPED`
2273
+ #
2274
+ # * `DELETE_PENDING`, `DELETE_IN_PROGRESS`, `DELETE_FAILED`
1381
2275
  # @return [String]
1382
2276
  #
1383
- # @see http://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/DeletePredictorBacktestExportJobRequest AWS API Documentation
2277
+ # @!attribute [rw] message
2278
+ # In the event of an error, a message detailing the cause of the
2279
+ # error.
2280
+ # @return [String]
1384
2281
  #
1385
- class DeletePredictorBacktestExportJobRequest < Struct.new(
1386
- :predictor_backtest_export_job_arn)
1387
- SENSITIVE = []
1388
- include Aws::Structure
1389
- end
1390
-
1391
- # @note When making an API call, you may pass DeletePredictorRequest
1392
- # data as a hash:
2282
+ # @!attribute [rw] creation_time
2283
+ # The timestamp of the CreateAutoPredictor request.
2284
+ # @return [Time]
1393
2285
  #
1394
- # {
1395
- # predictor_arn: "Arn", # required
1396
- # }
2286
+ # @!attribute [rw] last_modification_time
2287
+ # The last time the resource was modified. The timestamp depends on
2288
+ # the status of the job:
1397
2289
  #
1398
- # @!attribute [rw] predictor_arn
1399
- # The Amazon Resource Name (ARN) of the predictor to delete.
1400
- # @return [String]
2290
+ # * `CREATE_PENDING` - The `CreationTime`.
1401
2291
  #
1402
- # @see http://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/DeletePredictorRequest AWS API Documentation
2292
+ # * `CREATE_IN_PROGRESS` - The current timestamp.
1403
2293
  #
1404
- class DeletePredictorRequest < Struct.new(
1405
- :predictor_arn)
1406
- SENSITIVE = []
1407
- include Aws::Structure
1408
- end
1409
-
1410
- # @note When making an API call, you may pass DeleteResourceTreeRequest
1411
- # data as a hash:
2294
+ # * `CREATE_STOPPING` - The current timestamp.
1412
2295
  #
1413
- # {
1414
- # resource_arn: "Arn", # required
1415
- # }
2296
+ # * `CREATE_STOPPED` - When the job stopped.
1416
2297
  #
1417
- # @!attribute [rw] resource_arn
1418
- # The Amazon Resource Name (ARN) of the parent resource to delete. All
1419
- # child resources of the parent resource will also be deleted.
2298
+ # * `ACTIVE` or `CREATE_FAILED` - When the job finished or failed.
2299
+ # @return [Time]
2300
+ #
2301
+ # @!attribute [rw] optimization_metric
2302
+ # The accuracy metric used to optimize the predictor.
1420
2303
  # @return [String]
1421
2304
  #
1422
- # @see http://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/DeleteResourceTreeRequest AWS API Documentation
2305
+ # @!attribute [rw] explainability_info
2306
+ # Provides the status and ARN of the Predictor Explainability.
2307
+ # @return [Types::ExplainabilityInfo]
1423
2308
  #
1424
- class DeleteResourceTreeRequest < Struct.new(
1425
- :resource_arn)
2309
+ # @see http://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/DescribeAutoPredictorResponse AWS API Documentation
2310
+ #
2311
+ class DescribeAutoPredictorResponse < Struct.new(
2312
+ :predictor_arn,
2313
+ :predictor_name,
2314
+ :forecast_horizon,
2315
+ :forecast_types,
2316
+ :forecast_frequency,
2317
+ :forecast_dimensions,
2318
+ :dataset_import_job_arns,
2319
+ :data_config,
2320
+ :encryption_config,
2321
+ :reference_predictor_summary,
2322
+ :estimated_time_remaining_in_minutes,
2323
+ :status,
2324
+ :message,
2325
+ :creation_time,
2326
+ :last_modification_time,
2327
+ :optimization_metric,
2328
+ :explainability_info)
1426
2329
  SENSITIVE = []
1427
2330
  include Aws::Structure
1428
2331
  end
@@ -1680,76 +2583,287 @@ module Aws::ForecastService
1680
2583
  # The domain associated with the dataset.
1681
2584
  # @return [String]
1682
2585
  #
1683
- # @!attribute [rw] dataset_type
1684
- # The dataset type.
2586
+ # @!attribute [rw] dataset_type
2587
+ # The dataset type.
2588
+ # @return [String]
2589
+ #
2590
+ # @!attribute [rw] data_frequency
2591
+ # The frequency of data collection.
2592
+ #
2593
+ # Valid intervals are Y (Year), M (Month), W (Week), D (Day), H
2594
+ # (Hour), 30min (30 minutes), 15min (15 minutes), 10min (10 minutes),
2595
+ # 5min (5 minutes), and 1min (1 minute). For example, "M" indicates
2596
+ # every month and "30min" indicates every 30 minutes.
2597
+ # @return [String]
2598
+ #
2599
+ # @!attribute [rw] schema
2600
+ # An array of `SchemaAttribute` objects that specify the dataset
2601
+ # fields. Each `SchemaAttribute` specifies the name and data type of a
2602
+ # field.
2603
+ # @return [Types::Schema]
2604
+ #
2605
+ # @!attribute [rw] encryption_config
2606
+ # The AWS Key Management Service (KMS) key and the AWS Identity and
2607
+ # Access Management (IAM) role that Amazon Forecast can assume to
2608
+ # access the key.
2609
+ # @return [Types::EncryptionConfig]
2610
+ #
2611
+ # @!attribute [rw] status
2612
+ # The status of the dataset. States include:
2613
+ #
2614
+ # * `ACTIVE`
2615
+ #
2616
+ # * `CREATE_PENDING`, `CREATE_IN_PROGRESS`, `CREATE_FAILED`
2617
+ #
2618
+ # * `DELETE_PENDING`, `DELETE_IN_PROGRESS`, `DELETE_FAILED`
2619
+ #
2620
+ # * `UPDATE_PENDING`, `UPDATE_IN_PROGRESS`, `UPDATE_FAILED`
2621
+ #
2622
+ # The `UPDATE` states apply while data is imported to the dataset from
2623
+ # a call to the CreateDatasetImportJob operation and reflect the
2624
+ # status of the dataset import job. For example, when the import job
2625
+ # status is `CREATE_IN_PROGRESS`, the status of the dataset is
2626
+ # `UPDATE_IN_PROGRESS`.
2627
+ #
2628
+ # <note markdown="1"> The `Status` of the dataset must be `ACTIVE` before you can import
2629
+ # training data.
2630
+ #
2631
+ # </note>
2632
+ # @return [String]
2633
+ #
2634
+ # @!attribute [rw] creation_time
2635
+ # When the dataset was created.
2636
+ # @return [Time]
2637
+ #
2638
+ # @!attribute [rw] last_modification_time
2639
+ # When you create a dataset, `LastModificationTime` is the same as
2640
+ # `CreationTime`. While data is being imported to the dataset,
2641
+ # `LastModificationTime` is the current time of the `DescribeDataset`
2642
+ # call. After a CreateDatasetImportJob operation has finished,
2643
+ # `LastModificationTime` is when the import job completed or failed.
2644
+ # @return [Time]
2645
+ #
2646
+ # @see http://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/DescribeDatasetResponse AWS API Documentation
2647
+ #
2648
+ class DescribeDatasetResponse < Struct.new(
2649
+ :dataset_arn,
2650
+ :dataset_name,
2651
+ :domain,
2652
+ :dataset_type,
2653
+ :data_frequency,
2654
+ :schema,
2655
+ :encryption_config,
2656
+ :status,
2657
+ :creation_time,
2658
+ :last_modification_time)
2659
+ SENSITIVE = []
2660
+ include Aws::Structure
2661
+ end
2662
+
2663
+ # @note When making an API call, you may pass DescribeExplainabilityExportRequest
2664
+ # data as a hash:
2665
+ #
2666
+ # {
2667
+ # explainability_export_arn: "Arn", # required
2668
+ # }
2669
+ #
2670
+ # @!attribute [rw] explainability_export_arn
2671
+ # The Amazon Resource Name (ARN) of the Explainability export.
2672
+ # @return [String]
2673
+ #
2674
+ # @see http://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/DescribeExplainabilityExportRequest AWS API Documentation
2675
+ #
2676
+ class DescribeExplainabilityExportRequest < Struct.new(
2677
+ :explainability_export_arn)
2678
+ SENSITIVE = []
2679
+ include Aws::Structure
2680
+ end
2681
+
2682
+ # @!attribute [rw] explainability_export_arn
2683
+ # The Amazon Resource Name (ARN) of the Explainability export.
2684
+ # @return [String]
2685
+ #
2686
+ # @!attribute [rw] explainability_export_name
2687
+ # The name of the Explainability export.
2688
+ # @return [String]
2689
+ #
2690
+ # @!attribute [rw] explainability_arn
2691
+ # The Amazon Resource Name (ARN) of the Explainability.
2692
+ # @return [String]
2693
+ #
2694
+ # @!attribute [rw] destination
2695
+ # The destination for an export job. Provide an S3 path, an AWS
2696
+ # Identity and Access Management (IAM) role that allows Amazon
2697
+ # Forecast to access the location, and an AWS Key Management Service
2698
+ # (KMS) key (optional).
2699
+ # @return [Types::DataDestination]
2700
+ #
2701
+ # @!attribute [rw] message
2702
+ # Information about any errors that occurred during the export.
2703
+ # @return [String]
2704
+ #
2705
+ # @!attribute [rw] status
2706
+ # The status of the Explainability export. States include:
2707
+ #
2708
+ # * `ACTIVE`
2709
+ #
2710
+ # * `CREATE_PENDING`, `CREATE_IN_PROGRESS`, `CREATE_FAILED`
2711
+ #
2712
+ # * `CREATE_STOPPING`, `CREATE_STOPPED`
2713
+ #
2714
+ # * `DELETE_PENDING`, `DELETE_IN_PROGRESS`, `DELETE_FAILED`
2715
+ # @return [String]
2716
+ #
2717
+ # @!attribute [rw] creation_time
2718
+ # When the Explainability export was created.
2719
+ # @return [Time]
2720
+ #
2721
+ # @!attribute [rw] last_modification_time
2722
+ # The last time the resource was modified. The timestamp depends on
2723
+ # the status of the job:
2724
+ #
2725
+ # * `CREATE_PENDING` - The `CreationTime`.
2726
+ #
2727
+ # * `CREATE_IN_PROGRESS` - The current timestamp.
2728
+ #
2729
+ # * `CREATE_STOPPING` - The current timestamp.
2730
+ #
2731
+ # * `CREATE_STOPPED` - When the job stopped.
2732
+ #
2733
+ # * `ACTIVE` or `CREATE_FAILED` - When the job finished or failed.
2734
+ # @return [Time]
2735
+ #
2736
+ # @see http://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/DescribeExplainabilityExportResponse AWS API Documentation
2737
+ #
2738
+ class DescribeExplainabilityExportResponse < Struct.new(
2739
+ :explainability_export_arn,
2740
+ :explainability_export_name,
2741
+ :explainability_arn,
2742
+ :destination,
2743
+ :message,
2744
+ :status,
2745
+ :creation_time,
2746
+ :last_modification_time)
2747
+ SENSITIVE = []
2748
+ include Aws::Structure
2749
+ end
2750
+
2751
+ # @note When making an API call, you may pass DescribeExplainabilityRequest
2752
+ # data as a hash:
2753
+ #
2754
+ # {
2755
+ # explainability_arn: "Arn", # required
2756
+ # }
2757
+ #
2758
+ # @!attribute [rw] explainability_arn
2759
+ # The Amazon Resource Name (ARN) of the Explaianability to describe.
2760
+ # @return [String]
2761
+ #
2762
+ # @see http://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/DescribeExplainabilityRequest AWS API Documentation
2763
+ #
2764
+ class DescribeExplainabilityRequest < Struct.new(
2765
+ :explainability_arn)
2766
+ SENSITIVE = []
2767
+ include Aws::Structure
2768
+ end
2769
+
2770
+ # @!attribute [rw] explainability_arn
2771
+ # The Amazon Resource Name (ARN) of the Explainability.
2772
+ # @return [String]
2773
+ #
2774
+ # @!attribute [rw] explainability_name
2775
+ # The name of the Explainability.
2776
+ # @return [String]
2777
+ #
2778
+ # @!attribute [rw] resource_arn
2779
+ # The Amazon Resource Name (ARN) of the Predictor or Forecast used to
2780
+ # create the Explainability resource.
1685
2781
  # @return [String]
1686
2782
  #
1687
- # @!attribute [rw] data_frequency
1688
- # The frequency of data collection.
2783
+ # @!attribute [rw] explainability_config
2784
+ # The configuration settings that define the granularity of time
2785
+ # series and time points for the Explainability.
2786
+ # @return [Types::ExplainabilityConfig]
1689
2787
  #
1690
- # Valid intervals are Y (Year), M (Month), W (Week), D (Day), H
1691
- # (Hour), 30min (30 minutes), 15min (15 minutes), 10min (10 minutes),
1692
- # 5min (5 minutes), and 1min (1 minute). For example, "M" indicates
1693
- # every month and "30min" indicates every 30 minutes.
1694
- # @return [String]
2788
+ # @!attribute [rw] enable_visualization
2789
+ # Whether the visualization was enabled for the Explainability
2790
+ # resource.
2791
+ # @return [Boolean]
2792
+ #
2793
+ # @!attribute [rw] data_source
2794
+ # The source of your data, an AWS Identity and Access Management (IAM)
2795
+ # role that allows Amazon Forecast to access the data and, optionally,
2796
+ # an AWS Key Management Service (KMS) key.
2797
+ # @return [Types::DataSource]
1695
2798
  #
1696
2799
  # @!attribute [rw] schema
1697
- # An array of `SchemaAttribute` objects that specify the dataset
1698
- # fields. Each `SchemaAttribute` specifies the name and data type of a
1699
- # field.
2800
+ # Defines the fields of a dataset.
1700
2801
  # @return [Types::Schema]
1701
2802
  #
1702
- # @!attribute [rw] encryption_config
1703
- # The AWS Key Management Service (KMS) key and the AWS Identity and
1704
- # Access Management (IAM) role that Amazon Forecast can assume to
1705
- # access the key.
1706
- # @return [Types::EncryptionConfig]
2803
+ # @!attribute [rw] start_date_time
2804
+ # If `TimePointGranularity` is set to `SPECIFIC`, the first time point
2805
+ # in the Explainability.
2806
+ # @return [String]
1707
2807
  #
1708
- # @!attribute [rw] status
1709
- # The status of the dataset. States include:
2808
+ # @!attribute [rw] end_date_time
2809
+ # If `TimePointGranularity` is set to `SPECIFIC`, the last time point
2810
+ # in the Explainability.
2811
+ # @return [String]
1710
2812
  #
1711
- # * `ACTIVE`
2813
+ # @!attribute [rw] estimated_time_remaining_in_minutes
2814
+ # The estimated time remaining in minutes for the CreateExplainability
2815
+ # job to complete.
2816
+ # @return [Integer]
1712
2817
  #
1713
- # * `CREATE_PENDING`, `CREATE_IN_PROGRESS`, `CREATE_FAILED`
2818
+ # @!attribute [rw] message
2819
+ # If an error occurred, a message about the error.
2820
+ # @return [String]
1714
2821
  #
1715
- # * `DELETE_PENDING`, `DELETE_IN_PROGRESS`, `DELETE_FAILED`
2822
+ # @!attribute [rw] status
2823
+ # The status of the Explainability resource. States include:
1716
2824
  #
1717
- # * `UPDATE_PENDING`, `UPDATE_IN_PROGRESS`, `UPDATE_FAILED`
2825
+ # * `ACTIVE`
1718
2826
  #
1719
- # The `UPDATE` states apply while data is imported to the dataset from
1720
- # a call to the CreateDatasetImportJob operation and reflect the
1721
- # status of the dataset import job. For example, when the import job
1722
- # status is `CREATE_IN_PROGRESS`, the status of the dataset is
1723
- # `UPDATE_IN_PROGRESS`.
2827
+ # * `CREATE_PENDING`, `CREATE_IN_PROGRESS`, `CREATE_FAILED`
1724
2828
  #
1725
- # <note markdown="1"> The `Status` of the dataset must be `ACTIVE` before you can import
1726
- # training data.
2829
+ # * `CREATE_STOPPING`, `CREATE_STOPPED`
1727
2830
  #
1728
- # </note>
2831
+ # * `DELETE_PENDING`, `DELETE_IN_PROGRESS`, `DELETE_FAILED`
1729
2832
  # @return [String]
1730
2833
  #
1731
2834
  # @!attribute [rw] creation_time
1732
- # When the dataset was created.
2835
+ # When the Explainability resource was created.
1733
2836
  # @return [Time]
1734
2837
  #
1735
2838
  # @!attribute [rw] last_modification_time
1736
- # When you create a dataset, `LastModificationTime` is the same as
1737
- # `CreationTime`. While data is being imported to the dataset,
1738
- # `LastModificationTime` is the current time of the `DescribeDataset`
1739
- # call. After a CreateDatasetImportJob operation has finished,
1740
- # `LastModificationTime` is when the import job completed or failed.
2839
+ # The last time the resource was modified. The timestamp depends on
2840
+ # the status of the job:
2841
+ #
2842
+ # * `CREATE_PENDING` - The `CreationTime`.
2843
+ #
2844
+ # * `CREATE_IN_PROGRESS` - The current timestamp.
2845
+ #
2846
+ # * `CREATE_STOPPING` - The current timestamp.
2847
+ #
2848
+ # * `CREATE_STOPPED` - When the job stopped.
2849
+ #
2850
+ # * `ACTIVE` or `CREATE_FAILED` - When the job finished or failed.
1741
2851
  # @return [Time]
1742
2852
  #
1743
- # @see http://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/DescribeDatasetResponse AWS API Documentation
2853
+ # @see http://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/DescribeExplainabilityResponse AWS API Documentation
1744
2854
  #
1745
- class DescribeDatasetResponse < Struct.new(
1746
- :dataset_arn,
1747
- :dataset_name,
1748
- :domain,
1749
- :dataset_type,
1750
- :data_frequency,
2855
+ class DescribeExplainabilityResponse < Struct.new(
2856
+ :explainability_arn,
2857
+ :explainability_name,
2858
+ :resource_arn,
2859
+ :explainability_config,
2860
+ :enable_visualization,
2861
+ :data_source,
1751
2862
  :schema,
1752
- :encryption_config,
2863
+ :start_date_time,
2864
+ :end_date_time,
2865
+ :estimated_time_remaining_in_minutes,
2866
+ :message,
1753
2867
  :status,
1754
2868
  :creation_time,
1755
2869
  :last_modification_time)
@@ -2072,6 +3186,10 @@ module Aws::ForecastService
2072
3186
  # training.
2073
3187
  # @return [String]
2074
3188
  #
3189
+ # @!attribute [rw] auto_ml_algorithm_arns
3190
+ # When `PerformAutoML` is specified, the ARN of the chosen algorithm.
3191
+ # @return [Array<String>]
3192
+ #
2075
3193
  # @!attribute [rw] forecast_horizon
2076
3194
  # The number of time-steps of the forecast. The forecast horizon is
2077
3195
  # also called the prediction length.
@@ -2150,15 +3268,15 @@ module Aws::ForecastService
2150
3268
  # job to complete.
2151
3269
  # @return [Integer]
2152
3270
  #
3271
+ # @!attribute [rw] is_auto_predictor
3272
+ # Whether the predictor was created with CreateAutoPredictor.
3273
+ # @return [Boolean]
3274
+ #
2153
3275
  # @!attribute [rw] dataset_import_job_arns
2154
3276
  # An array of the ARNs of the dataset import jobs used to import
2155
3277
  # training data for the predictor.
2156
3278
  # @return [Array<String>]
2157
3279
  #
2158
- # @!attribute [rw] auto_ml_algorithm_arns
2159
- # When `PerformAutoML` is specified, the ARN of the chosen algorithm.
2160
- # @return [Array<String>]
2161
- #
2162
3280
  # @!attribute [rw] status
2163
3281
  # The status of the predictor. States include:
2164
3282
  #
@@ -2209,6 +3327,7 @@ module Aws::ForecastService
2209
3327
  :predictor_arn,
2210
3328
  :predictor_name,
2211
3329
  :algorithm_arn,
3330
+ :auto_ml_algorithm_arns,
2212
3331
  :forecast_horizon,
2213
3332
  :forecast_types,
2214
3333
  :perform_auto_ml,
@@ -2222,8 +3341,8 @@ module Aws::ForecastService
2222
3341
  :encryption_config,
2223
3342
  :predictor_execution_details,
2224
3343
  :estimated_time_remaining_in_minutes,
3344
+ :is_auto_predictor,
2225
3345
  :dataset_import_job_arns,
2226
- :auto_ml_algorithm_arns,
2227
3346
  :status,
2228
3347
  :message,
2229
3348
  :creation_time,
@@ -2268,103 +3387,326 @@ module Aws::ForecastService
2268
3387
  include Aws::Structure
2269
3388
  end
2270
3389
 
2271
- # Provides detailed error metrics to evaluate the performance of a
2272
- # predictor. This object is part of the Metrics object.
3390
+ # Provides detailed error metrics to evaluate the performance of a
3391
+ # predictor. This object is part of the Metrics object.
3392
+ #
3393
+ # @!attribute [rw] forecast_type
3394
+ # The Forecast type used to compute WAPE, MAPE, MASE, and RMSE.
3395
+ # @return [String]
3396
+ #
3397
+ # @!attribute [rw] wape
3398
+ # The weighted absolute percentage error (WAPE).
3399
+ # @return [Float]
3400
+ #
3401
+ # @!attribute [rw] rmse
3402
+ # The root-mean-square error (RMSE).
3403
+ # @return [Float]
3404
+ #
3405
+ # @!attribute [rw] mase
3406
+ # The Mean Absolute Scaled Error (MASE)
3407
+ # @return [Float]
3408
+ #
3409
+ # @!attribute [rw] mape
3410
+ # The Mean Absolute Percentage Error (MAPE)
3411
+ # @return [Float]
3412
+ #
3413
+ # @see http://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/ErrorMetric AWS API Documentation
3414
+ #
3415
+ class ErrorMetric < Struct.new(
3416
+ :forecast_type,
3417
+ :wape,
3418
+ :rmse,
3419
+ :mase,
3420
+ :mape)
3421
+ SENSITIVE = []
3422
+ include Aws::Structure
3423
+ end
3424
+
3425
+ # Parameters that define how to split a dataset into training data and
3426
+ # testing data, and the number of iterations to perform. These
3427
+ # parameters are specified in the predefined algorithms but you can
3428
+ # override them in the CreatePredictor request.
3429
+ #
3430
+ # @note When making an API call, you may pass EvaluationParameters
3431
+ # data as a hash:
3432
+ #
3433
+ # {
3434
+ # number_of_backtest_windows: 1,
3435
+ # back_test_window_offset: 1,
3436
+ # }
3437
+ #
3438
+ # @!attribute [rw] number_of_backtest_windows
3439
+ # The number of times to split the input data. The default is 1. Valid
3440
+ # values are 1 through 5.
3441
+ # @return [Integer]
3442
+ #
3443
+ # @!attribute [rw] back_test_window_offset
3444
+ # The point from the end of the dataset where you want to split the
3445
+ # data for model training and testing (evaluation). Specify the value
3446
+ # as the number of data points. The default is the value of the
3447
+ # forecast horizon. `BackTestWindowOffset` can be used to mimic a past
3448
+ # virtual forecast start date. This value must be greater than or
3449
+ # equal to the forecast horizon and less than half of the
3450
+ # TARGET\_TIME\_SERIES dataset length.
3451
+ #
3452
+ # `ForecastHorizon` &lt;= `BackTestWindowOffset` &lt; 1/2 *
3453
+ # TARGET\_TIME\_SERIES dataset length
3454
+ # @return [Integer]
3455
+ #
3456
+ # @see http://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/EvaluationParameters AWS API Documentation
3457
+ #
3458
+ class EvaluationParameters < Struct.new(
3459
+ :number_of_backtest_windows,
3460
+ :back_test_window_offset)
3461
+ SENSITIVE = []
3462
+ include Aws::Structure
3463
+ end
3464
+
3465
+ # The results of evaluating an algorithm. Returned as part of the
3466
+ # GetAccuracyMetrics response.
3467
+ #
3468
+ # @!attribute [rw] algorithm_arn
3469
+ # The Amazon Resource Name (ARN) of the algorithm that was evaluated.
3470
+ # @return [String]
3471
+ #
3472
+ # @!attribute [rw] test_windows
3473
+ # The array of test windows used for evaluating the algorithm. The
3474
+ # `NumberOfBacktestWindows` from the EvaluationParameters object
3475
+ # determines the number of windows in the array.
3476
+ # @return [Array<Types::WindowSummary>]
3477
+ #
3478
+ # @see http://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/EvaluationResult AWS API Documentation
3479
+ #
3480
+ class EvaluationResult < Struct.new(
3481
+ :algorithm_arn,
3482
+ :test_windows)
3483
+ SENSITIVE = []
3484
+ include Aws::Structure
3485
+ end
3486
+
3487
+ # The ExplainabilityConfig data type defines the number of time series
3488
+ # and time points included in CreateExplainability.
3489
+ #
3490
+ # If you provide a predictor ARN for `ResourceArn`, you must set both
3491
+ # `TimePointGranularity` and `TimeSeriesGranularity` to “ALL”. When
3492
+ # creating Predictor Explainability, Amazon Forecast considers all time
3493
+ # series and time points.
3494
+ #
3495
+ # If you provide a forecast ARN for `ResourceArn`, you can set
3496
+ # `TimePointGranularity` and `TimeSeriesGranularity` to either “ALL” or
3497
+ # “Specific”.
3498
+ #
3499
+ # @note When making an API call, you may pass ExplainabilityConfig
3500
+ # data as a hash:
3501
+ #
3502
+ # {
3503
+ # time_series_granularity: "ALL", # required, accepts ALL, SPECIFIC
3504
+ # time_point_granularity: "ALL", # required, accepts ALL, SPECIFIC
3505
+ # }
3506
+ #
3507
+ # @!attribute [rw] time_series_granularity
3508
+ # To create an Explainability for all time series in your datasets,
3509
+ # use `ALL`. To create an Explainability for specific time series in
3510
+ # your datasets, use `SPECIFIC`.
3511
+ #
3512
+ # Specify time series by uploading a CSV file to an Amazon S3 bucket
3513
+ # and set the location within the DataDestination data type.
3514
+ # @return [String]
3515
+ #
3516
+ # @!attribute [rw] time_point_granularity
3517
+ # To create an Explainability for all time points in your forecast
3518
+ # horizon, use `ALL`. To create an Explainability for specific time
3519
+ # points in your forecast horizon, use `SPECIFIC`.
3520
+ #
3521
+ # Specify time points with the `StartDateTime` and `EndDateTime`
3522
+ # parameters within the CreateExplainability operation.
3523
+ # @return [String]
3524
+ #
3525
+ # @see http://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/ExplainabilityConfig AWS API Documentation
3526
+ #
3527
+ class ExplainabilityConfig < Struct.new(
3528
+ :time_series_granularity,
3529
+ :time_point_granularity)
3530
+ SENSITIVE = []
3531
+ include Aws::Structure
3532
+ end
3533
+
3534
+ # Provides a summary of the Explainability export properties used in the
3535
+ # ListExplainabilityExports operation. To get a complete set of
3536
+ # properties, call the DescribeExplainabilityExport operation, and
3537
+ # provide the `ExplainabilityExportArn`.
3538
+ #
3539
+ # @!attribute [rw] explainability_export_arn
3540
+ # The Amazon Resource Name (ARN) of the Explainability export.
3541
+ # @return [String]
3542
+ #
3543
+ # @!attribute [rw] explainability_export_name
3544
+ # The name of the Explainability export
3545
+ # @return [String]
3546
+ #
3547
+ # @!attribute [rw] destination
3548
+ # The destination for an export job. Provide an S3 path, an AWS
3549
+ # Identity and Access Management (IAM) role that allows Amazon
3550
+ # Forecast to access the location, and an AWS Key Management Service
3551
+ # (KMS) key (optional).
3552
+ # @return [Types::DataDestination]
3553
+ #
3554
+ # @!attribute [rw] status
3555
+ # The status of the Explainability export. States include:
3556
+ #
3557
+ # * `ACTIVE`
3558
+ #
3559
+ # * `CREATE_PENDING`, `CREATE_IN_PROGRESS`, `CREATE_FAILED`
3560
+ #
3561
+ # * `CREATE_STOPPING`, `CREATE_STOPPED`
3562
+ #
3563
+ # * `DELETE_PENDING`, `DELETE_IN_PROGRESS`, `DELETE_FAILED`
3564
+ # @return [String]
3565
+ #
3566
+ # @!attribute [rw] message
3567
+ # Information about any errors that may have occurred during the
3568
+ # Explainability export.
3569
+ # @return [String]
3570
+ #
3571
+ # @!attribute [rw] creation_time
3572
+ # When the Explainability was created.
3573
+ # @return [Time]
3574
+ #
3575
+ # @!attribute [rw] last_modification_time
3576
+ # The last time the resource was modified. The timestamp depends on
3577
+ # the status of the job:
3578
+ #
3579
+ # * `CREATE_PENDING` - The `CreationTime`.
3580
+ #
3581
+ # * `CREATE_IN_PROGRESS` - The current timestamp.
3582
+ #
3583
+ # * `CREATE_STOPPING` - The current timestamp.
3584
+ #
3585
+ # * `CREATE_STOPPED` - When the job stopped.
3586
+ #
3587
+ # * `ACTIVE` or `CREATE_FAILED` - When the job finished or failed.
3588
+ # @return [Time]
3589
+ #
3590
+ # @see http://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/ExplainabilityExportSummary AWS API Documentation
3591
+ #
3592
+ class ExplainabilityExportSummary < Struct.new(
3593
+ :explainability_export_arn,
3594
+ :explainability_export_name,
3595
+ :destination,
3596
+ :status,
3597
+ :message,
3598
+ :creation_time,
3599
+ :last_modification_time)
3600
+ SENSITIVE = []
3601
+ include Aws::Structure
3602
+ end
3603
+
3604
+ # Provides information about the Explainability resource.
2273
3605
  #
2274
- # @!attribute [rw] forecast_type
2275
- # The Forecast type used to compute WAPE, MAPE, MASE, and RMSE.
3606
+ # @!attribute [rw] explainability_arn
3607
+ # The Amazon Resource Name (ARN) of the Explainability.
2276
3608
  # @return [String]
2277
3609
  #
2278
- # @!attribute [rw] wape
2279
- # The weighted absolute percentage error (WAPE).
2280
- # @return [Float]
3610
+ # @!attribute [rw] status
3611
+ # The status of the Explainability. States include:
2281
3612
  #
2282
- # @!attribute [rw] rmse
2283
- # The root-mean-square error (RMSE).
2284
- # @return [Float]
3613
+ # * `ACTIVE`
2285
3614
  #
2286
- # @!attribute [rw] mase
2287
- # The Mean Absolute Scaled Error (MASE)
2288
- # @return [Float]
3615
+ # * `CREATE_PENDING`, `CREATE_IN_PROGRESS`, `CREATE_FAILED`
2289
3616
  #
2290
- # @!attribute [rw] mape
2291
- # The Mean Absolute Percentage Error (MAPE)
2292
- # @return [Float]
3617
+ # * `CREATE_STOPPING`, `CREATE_STOPPED`
2293
3618
  #
2294
- # @see http://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/ErrorMetric AWS API Documentation
3619
+ # * `DELETE_PENDING`, `DELETE_IN_PROGRESS`, `DELETE_FAILED`
3620
+ # @return [String]
2295
3621
  #
2296
- class ErrorMetric < Struct.new(
2297
- :forecast_type,
2298
- :wape,
2299
- :rmse,
2300
- :mase,
2301
- :mape)
3622
+ # @see http://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/ExplainabilityInfo AWS API Documentation
3623
+ #
3624
+ class ExplainabilityInfo < Struct.new(
3625
+ :explainability_arn,
3626
+ :status)
2302
3627
  SENSITIVE = []
2303
3628
  include Aws::Structure
2304
3629
  end
2305
3630
 
2306
- # Parameters that define how to split a dataset into training data and
2307
- # testing data, and the number of iterations to perform. These
2308
- # parameters are specified in the predefined algorithms but you can
2309
- # override them in the CreatePredictor request.
3631
+ # Provides a summary of the Explainability properties used in the
3632
+ # ListExplainabilities operation. To get a complete set of properties,
3633
+ # call the DescribeExplainability operation, and provide the listed
3634
+ # `ExplainabilityArn`.
2310
3635
  #
2311
- # @note When making an API call, you may pass EvaluationParameters
2312
- # data as a hash:
3636
+ # @!attribute [rw] explainability_arn
3637
+ # The Amazon Resource Name (ARN) of the Explainability.
3638
+ # @return [String]
2313
3639
  #
2314
- # {
2315
- # number_of_backtest_windows: 1,
2316
- # back_test_window_offset: 1,
2317
- # }
3640
+ # @!attribute [rw] explainability_name
3641
+ # The name of the Explainability.
3642
+ # @return [String]
2318
3643
  #
2319
- # @!attribute [rw] number_of_backtest_windows
2320
- # The number of times to split the input data. The default is 1. Valid
2321
- # values are 1 through 5.
2322
- # @return [Integer]
3644
+ # @!attribute [rw] resource_arn
3645
+ # The Amazon Resource Name (ARN) of the Predictor or Forecast used to
3646
+ # create the Explainability.
3647
+ # @return [String]
2323
3648
  #
2324
- # @!attribute [rw] back_test_window_offset
2325
- # The point from the end of the dataset where you want to split the
2326
- # data for model training and testing (evaluation). Specify the value
2327
- # as the number of data points. The default is the value of the
2328
- # forecast horizon. `BackTestWindowOffset` can be used to mimic a past
2329
- # virtual forecast start date. This value must be greater than or
2330
- # equal to the forecast horizon and less than half of the
2331
- # TARGET\_TIME\_SERIES dataset length.
3649
+ # @!attribute [rw] explainability_config
3650
+ # The configuration settings that define the granularity of time
3651
+ # series and time points for the Explainability.
3652
+ # @return [Types::ExplainabilityConfig]
2332
3653
  #
2333
- # `ForecastHorizon` &lt;= `BackTestWindowOffset` &lt; 1/2 *
2334
- # TARGET\_TIME\_SERIES dataset length
2335
- # @return [Integer]
3654
+ # @!attribute [rw] status
3655
+ # The status of the Explainability. States include:
2336
3656
  #
2337
- # @see http://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/EvaluationParameters AWS API Documentation
3657
+ # * `ACTIVE`
2338
3658
  #
2339
- class EvaluationParameters < Struct.new(
2340
- :number_of_backtest_windows,
2341
- :back_test_window_offset)
2342
- SENSITIVE = []
2343
- include Aws::Structure
2344
- end
2345
-
2346
- # The results of evaluating an algorithm. Returned as part of the
2347
- # GetAccuracyMetrics response.
3659
+ # * `CREATE_PENDING`, `CREATE_IN_PROGRESS`, `CREATE_FAILED`
2348
3660
  #
2349
- # @!attribute [rw] algorithm_arn
2350
- # The Amazon Resource Name (ARN) of the algorithm that was evaluated.
3661
+ # * `CREATE_STOPPING`, `CREATE_STOPPED`
3662
+ #
3663
+ # * `DELETE_PENDING`, `DELETE_IN_PROGRESS`, `DELETE_FAILED`
2351
3664
  # @return [String]
2352
3665
  #
2353
- # @!attribute [rw] test_windows
2354
- # The array of test windows used for evaluating the algorithm. The
2355
- # `NumberOfBacktestWindows` from the EvaluationParameters object
2356
- # determines the number of windows in the array.
2357
- # @return [Array<Types::WindowSummary>]
3666
+ # @!attribute [rw] message
3667
+ # Information about any errors that may have occurred during the
3668
+ # Explainability creation process.
3669
+ # @return [String]
2358
3670
  #
2359
- # @see http://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/EvaluationResult AWS API Documentation
3671
+ # @!attribute [rw] creation_time
3672
+ # When the Explainability was created.
3673
+ # @return [Time]
2360
3674
  #
2361
- class EvaluationResult < Struct.new(
2362
- :algorithm_arn,
2363
- :test_windows)
3675
+ # @!attribute [rw] last_modification_time
3676
+ # The last time the resource was modified. The timestamp depends on
3677
+ # the status of the job:
3678
+ #
3679
+ # * `CREATE_PENDING` - The `CreationTime`.
3680
+ #
3681
+ # * `CREATE_IN_PROGRESS` - The current timestamp.
3682
+ #
3683
+ # * `CREATE_STOPPING` - The current timestamp.
3684
+ #
3685
+ # * `CREATE_STOPPED` - When the job stopped.
3686
+ #
3687
+ # * `ACTIVE` or `CREATE_FAILED` - When the job finished or failed.
3688
+ # @return [Time]
3689
+ #
3690
+ # @see http://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/ExplainabilitySummary AWS API Documentation
3691
+ #
3692
+ class ExplainabilitySummary < Struct.new(
3693
+ :explainability_arn,
3694
+ :explainability_name,
3695
+ :resource_arn,
3696
+ :explainability_config,
3697
+ :status,
3698
+ :message,
3699
+ :creation_time,
3700
+ :last_modification_time)
2364
3701
  SENSITIVE = []
2365
3702
  include Aws::Structure
2366
3703
  end
2367
3704
 
3705
+ # <note markdown="1"> This object belongs to the CreatePredictor operation. If you created
3706
+ # your predictor with CreateAutoPredictor, see AttributeConfig.
3707
+ #
3708
+ # </note>
3709
+ #
2368
3710
  # Provides featurization (transformation) information for a dataset
2369
3711
  # field. This object is part of the FeaturizationConfig object.
2370
3712
  #
@@ -2423,6 +3765,11 @@ module Aws::ForecastService
2423
3765
  include Aws::Structure
2424
3766
  end
2425
3767
 
3768
+ # <note markdown="1"> This object belongs to the CreatePredictor operation. If you created
3769
+ # your predictor with CreateAutoPredictor, see AttributeConfig.
3770
+ #
3771
+ # </note>
3772
+ #
2426
3773
  # In a CreatePredictor operation, the specified algorithm trains a model
2427
3774
  # using the specified dataset group. You can optionally tell the
2428
3775
  # operation to modify data fields prior to training a model. These
@@ -2709,6 +4056,10 @@ module Aws::ForecastService
2709
4056
  # The ARN of the predictor used to generate the forecast.
2710
4057
  # @return [String]
2711
4058
  #
4059
+ # @!attribute [rw] created_using_auto_predictor
4060
+ # Whether the Forecast was created from an AutoPredictor.
4061
+ # @return [Boolean]
4062
+ #
2712
4063
  # @!attribute [rw] dataset_group_arn
2713
4064
  # The Amazon Resource Name (ARN) of the dataset group that provided
2714
4065
  # the data used to train the predictor.
@@ -2760,6 +4111,7 @@ module Aws::ForecastService
2760
4111
  :forecast_arn,
2761
4112
  :forecast_name,
2762
4113
  :predictor_arn,
4114
+ :created_using_auto_predictor,
2763
4115
  :dataset_group_arn,
2764
4116
  :status,
2765
4117
  :message,
@@ -2792,6 +4144,10 @@ module Aws::ForecastService
2792
4144
  # An array of results from evaluating the predictor.
2793
4145
  # @return [Array<Types::EvaluationResult>]
2794
4146
  #
4147
+ # @!attribute [rw] is_auto_predictor
4148
+ # Whether the predictor was created with CreateAutoPredictor.
4149
+ # @return [Boolean]
4150
+ #
2795
4151
  # @!attribute [rw] auto_ml_override_strategy
2796
4152
  # <note markdown="1"> The `LatencyOptimized` AutoML override strategy is only available in
2797
4153
  # private beta. Contact AWS Support or your account manager to learn
@@ -2814,6 +4170,7 @@ module Aws::ForecastService
2814
4170
  #
2815
4171
  class GetAccuracyMetricsResponse < Struct.new(
2816
4172
  :predictor_evaluation_results,
4173
+ :is_auto_predictor,
2817
4174
  :auto_ml_override_strategy,
2818
4175
  :optimization_metric)
2819
4176
  SENSITIVE = []
@@ -2877,6 +4234,11 @@ module Aws::ForecastService
2877
4234
  include Aws::Structure
2878
4235
  end
2879
4236
 
4237
+ # <note markdown="1"> This object belongs to the CreatePredictor operation. If you created
4238
+ # your predictor with CreateAutoPredictor, see DataConfig.
4239
+ #
4240
+ # </note>
4241
+ #
2880
4242
  # The data used to train a predictor. The data includes a dataset group
2881
4243
  # and any supplementary features. You specify this object in the
2882
4244
  # CreatePredictor request.
@@ -3194,6 +4556,150 @@ module Aws::ForecastService
3194
4556
  include Aws::Structure
3195
4557
  end
3196
4558
 
4559
+ # @note When making an API call, you may pass ListExplainabilitiesRequest
4560
+ # data as a hash:
4561
+ #
4562
+ # {
4563
+ # next_token: "NextToken",
4564
+ # max_results: 1,
4565
+ # filters: [
4566
+ # {
4567
+ # key: "String", # required
4568
+ # value: "Arn", # required
4569
+ # condition: "IS", # required, accepts IS, IS_NOT
4570
+ # },
4571
+ # ],
4572
+ # }
4573
+ #
4574
+ # @!attribute [rw] next_token
4575
+ # If the result of the previous request was truncated, the response
4576
+ # includes a NextToken. To retrieve the next set of results, use the
4577
+ # token in the next request. Tokens expire after 24 hours.
4578
+ # @return [String]
4579
+ #
4580
+ # @!attribute [rw] max_results
4581
+ # The number of items returned in the response.
4582
+ # @return [Integer]
4583
+ #
4584
+ # @!attribute [rw] filters
4585
+ # An array of filters. For each filter, provide a condition and a
4586
+ # match statement. The condition is either `IS` or `IS_NOT`, which
4587
+ # specifies whether to include or exclude the resources that match the
4588
+ # statement from the list. The match statement consists of a key and a
4589
+ # value.
4590
+ #
4591
+ # **Filter properties**
4592
+ #
4593
+ # * `Condition` - The condition to apply. Valid values are `IS` and
4594
+ # `IS_NOT`.
4595
+ #
4596
+ # * `Key` - The name of the parameter to filter on. Valid values are
4597
+ # `ResourceArn` and `Status`.
4598
+ #
4599
+ # * `Value` - The value to match.
4600
+ # @return [Array<Types::Filter>]
4601
+ #
4602
+ # @see http://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/ListExplainabilitiesRequest AWS API Documentation
4603
+ #
4604
+ class ListExplainabilitiesRequest < Struct.new(
4605
+ :next_token,
4606
+ :max_results,
4607
+ :filters)
4608
+ SENSITIVE = []
4609
+ include Aws::Structure
4610
+ end
4611
+
4612
+ # @!attribute [rw] explainabilities
4613
+ # An array of objects that summarize the properties of each
4614
+ # Explainability resource.
4615
+ # @return [Array<Types::ExplainabilitySummary>]
4616
+ #
4617
+ # @!attribute [rw] next_token
4618
+ # Returns this token if the response is truncated. To retrieve the
4619
+ # next set of results, use the token in the next request.
4620
+ # @return [String]
4621
+ #
4622
+ # @see http://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/ListExplainabilitiesResponse AWS API Documentation
4623
+ #
4624
+ class ListExplainabilitiesResponse < Struct.new(
4625
+ :explainabilities,
4626
+ :next_token)
4627
+ SENSITIVE = []
4628
+ include Aws::Structure
4629
+ end
4630
+
4631
+ # @note When making an API call, you may pass ListExplainabilityExportsRequest
4632
+ # data as a hash:
4633
+ #
4634
+ # {
4635
+ # next_token: "NextToken",
4636
+ # max_results: 1,
4637
+ # filters: [
4638
+ # {
4639
+ # key: "String", # required
4640
+ # value: "Arn", # required
4641
+ # condition: "IS", # required, accepts IS, IS_NOT
4642
+ # },
4643
+ # ],
4644
+ # }
4645
+ #
4646
+ # @!attribute [rw] next_token
4647
+ # If the result of the previous request was truncated, the response
4648
+ # includes a NextToken. To retrieve the next set of results, use the
4649
+ # token in the next request. Tokens expire after 24 hours.
4650
+ # @return [String]
4651
+ #
4652
+ # @!attribute [rw] max_results
4653
+ # The number of items to return in the response.
4654
+ # @return [Integer]
4655
+ #
4656
+ # @!attribute [rw] filters
4657
+ # An array of filters. For each filter, provide a condition and a
4658
+ # match statement. The condition is either `IS` or `IS_NOT`, which
4659
+ # specifies whether to include or exclude resources that match the
4660
+ # statement from the list. The match statement consists of a key and a
4661
+ # value.
4662
+ #
4663
+ # **Filter properties**
4664
+ #
4665
+ # * `Condition` - The condition to apply. Valid values are `IS` and
4666
+ # `IS_NOT`.
4667
+ #
4668
+ # * `Key` - The name of the parameter to filter on. Valid values are
4669
+ # `ResourceArn` and `Status`.
4670
+ #
4671
+ # * `Value` - The value to match.
4672
+ # @return [Array<Types::Filter>]
4673
+ #
4674
+ # @see http://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/ListExplainabilityExportsRequest AWS API Documentation
4675
+ #
4676
+ class ListExplainabilityExportsRequest < Struct.new(
4677
+ :next_token,
4678
+ :max_results,
4679
+ :filters)
4680
+ SENSITIVE = []
4681
+ include Aws::Structure
4682
+ end
4683
+
4684
+ # @!attribute [rw] explainability_exports
4685
+ # An array of objects that summarize the properties of each
4686
+ # Explainability export.
4687
+ # @return [Array<Types::ExplainabilityExportSummary>]
4688
+ #
4689
+ # @!attribute [rw] next_token
4690
+ # Returns this token if the response is truncated. To retrieve the
4691
+ # next set of results, use the token in the next request.
4692
+ # @return [String]
4693
+ #
4694
+ # @see http://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/ListExplainabilityExportsResponse AWS API Documentation
4695
+ #
4696
+ class ListExplainabilityExportsResponse < Struct.new(
4697
+ :explainability_exports,
4698
+ :next_token)
4699
+ SENSITIVE = []
4700
+ include Aws::Structure
4701
+ end
4702
+
3197
4703
  # @note When making an API call, you may pass ListForecastExportJobsRequest
3198
4704
  # data as a hash:
3199
4705
  #
@@ -3513,9 +5019,7 @@ module Aws::ForecastService
3513
5019
  #
3514
5020
  # @!attribute [rw] resource_arn
3515
5021
  # The Amazon Resource Name (ARN) that identifies the resource for
3516
- # which to list the tags. Currently, the supported resources are
3517
- # Forecast dataset groups, datasets, dataset import jobs, predictors,
3518
- # forecasts, and forecast export jobs.
5022
+ # which to list the tags.
3519
5023
  # @return [String]
3520
5024
  #
3521
5025
  # @see http://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/ListTagsForResourceRequest AWS API Documentation
@@ -3760,6 +5264,15 @@ module Aws::ForecastService
3760
5264
  # the data used to train the predictor.
3761
5265
  # @return [String]
3762
5266
  #
5267
+ # @!attribute [rw] is_auto_predictor
5268
+ # Whether AutoPredictor was used to create the predictor.
5269
+ # @return [Boolean]
5270
+ #
5271
+ # @!attribute [rw] reference_predictor_summary
5272
+ # A summary of the reference predictor used if the predictor was
5273
+ # retrained or upgraded.
5274
+ # @return [Types::ReferencePredictorSummary]
5275
+ #
3763
5276
  # @!attribute [rw] status
3764
5277
  # The status of the predictor. States include:
3765
5278
  #
@@ -3806,6 +5319,8 @@ module Aws::ForecastService
3806
5319
  :predictor_arn,
3807
5320
  :predictor_name,
3808
5321
  :dataset_group_arn,
5322
+ :is_auto_predictor,
5323
+ :reference_predictor_summary,
3809
5324
  :status,
3810
5325
  :message,
3811
5326
  :creation_time,
@@ -3814,6 +5329,26 @@ module Aws::ForecastService
3814
5329
  include Aws::Structure
3815
5330
  end
3816
5331
 
5332
+ # Provides a summary of the reference predictor used when retraining or
5333
+ # upgrading a predictor.
5334
+ #
5335
+ # @!attribute [rw] arn
5336
+ # The ARN of the reference predictor.
5337
+ # @return [String]
5338
+ #
5339
+ # @!attribute [rw] state
5340
+ # Whether the reference predictor is `Active` or `Deleted`.
5341
+ # @return [String]
5342
+ #
5343
+ # @see http://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/ReferencePredictorSummary AWS API Documentation
5344
+ #
5345
+ class ReferencePredictorSummary < Struct.new(
5346
+ :arn,
5347
+ :state)
5348
+ SENSITIVE = []
5349
+ include Aws::Structure
5350
+ end
5351
+
3817
5352
  # There is already a resource with this name. Try again with a different
3818
5353
  # name.
3819
5354
  #
@@ -3902,8 +5437,7 @@ module Aws::ForecastService
3902
5437
  include Aws::Structure
3903
5438
  end
3904
5439
 
3905
- # Defines the fields of a dataset. You specify this object in the
3906
- # CreateDataset request.
5440
+ # Defines the fields of a dataset.
3907
5441
  #
3908
5442
  # @note When making an API call, you may pass Schema
3909
5443
  # data as a hash:
@@ -4049,8 +5583,9 @@ module Aws::ForecastService
4049
5583
  # @!attribute [rw] resource_arn
4050
5584
  # The Amazon Resource Name (ARN) that identifies the resource to stop.
4051
5585
  # The supported ARNs are `DatasetImportJobArn`, `PredictorArn`,
4052
- # `PredictorBacktestExportJobArn`, `ForecastArn`, and
4053
- # `ForecastExportJobArn`.
5586
+ # `PredictorBacktestExportJobArn`, `ForecastArn`,
5587
+ # `ForecastExportJobArn`, `ExplainabilityArn`, and
5588
+ # `ExplainabilityExportArn`.
4054
5589
  # @return [String]
4055
5590
  #
4056
5591
  # @see http://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/StopResourceRequest AWS API Documentation
@@ -4061,6 +5596,11 @@ module Aws::ForecastService
4061
5596
  include Aws::Structure
4062
5597
  end
4063
5598
 
5599
+ # <note markdown="1"> This object belongs to the CreatePredictor operation. If you created
5600
+ # your predictor with CreateAutoPredictor, see AdditionalDataset.
5601
+ #
5602
+ # </note>
5603
+ #
4064
5604
  # Describes a supplementary feature of a dataset group. This object is
4065
5605
  # part of the InputDataConfig object. Forecast supports the Weather
4066
5606
  # Index and Holidays built-in featurizations.
@@ -4325,9 +5865,7 @@ module Aws::ForecastService
4325
5865
  #
4326
5866
  # @!attribute [rw] resource_arn
4327
5867
  # The Amazon Resource Name (ARN) that identifies the resource for
4328
- # which to list the tags. Currently, the supported resources are
4329
- # Forecast dataset groups, datasets, dataset import jobs, predictors,
4330
- # forecasts, and forecast export jobs.
5868
+ # which to list the tags.
4331
5869
  # @return [String]
4332
5870
  #
4333
5871
  # @!attribute [rw] tags
@@ -4421,9 +5959,7 @@ module Aws::ForecastService
4421
5959
  #
4422
5960
  # @!attribute [rw] resource_arn
4423
5961
  # The Amazon Resource Name (ARN) that identifies the resource for
4424
- # which to list the tags. Currently, the supported resources are
4425
- # Forecast dataset groups, datasets, dataset import jobs, predictors,
4426
- # forecasts, and forecast exports.
5962
+ # which to list the tags.
4427
5963
  # @return [String]
4428
5964
  #
4429
5965
  # @!attribute [rw] tag_keys