aws-sdk-forecastservice 1.27.0 → 1.28.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -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
  #
@@ -112,6 +380,179 @@ module Aws::ForecastService
112
380
  include Aws::Structure
113
381
  end
114
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.
465
+ # @return [String]
466
+ #
467
+ # @!attribute [rw] data_config
468
+ # The data configuration for your dataset group and any additional
469
+ # datasets.
470
+ # @return [Types::DataConfig]
471
+ #
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]
478
+ #
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.
483
+ #
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]
488
+ #
489
+ # @!attribute [rw] optimization_metric
490
+ # The accuracy metric used to optimize the predictor.
491
+ # @return [String]
492
+ #
493
+ # @!attribute [rw] explain_predictor
494
+ # @return [Boolean]
495
+ #
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.
500
+ #
501
+ # The following restrictions apply to tags:
502
+ #
503
+ # * For each resource, each tag key must be unique and each tag key
504
+ # must have one value.
505
+ #
506
+ # * Maximum number of tags per resource: 50.
507
+ #
508
+ # * Maximum key length: 128 Unicode characters in UTF-8.
509
+ #
510
+ # * Maximum value length: 256 Unicode characters in UTF-8.
511
+ #
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.
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>]
525
+ #
526
+ # @see http://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/CreateAutoPredictorRequest AWS API Documentation
527
+ #
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.
546
+ # @return [String]
547
+ #
548
+ # @see http://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/CreateAutoPredictorResponse AWS API Documentation
549
+ #
550
+ class CreateAutoPredictorResponse < Struct.new(
551
+ :predictor_arn)
552
+ SENSITIVE = []
553
+ include Aws::Structure
554
+ end
555
+
115
556
  # @note When making an API call, you may pass CreateDatasetGroupRequest
116
557
  # data as a hash:
117
558
  #
@@ -496,6 +937,230 @@ module Aws::ForecastService
496
937
  include Aws::Structure
497
938
  end
498
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.
1089
+ # @return [Types::Schema]
1090
+ #
1091
+ # @!attribute [rw] enable_visualization
1092
+ # Create an Expainability visualization that is viewable within the
1093
+ # AWS console.
1094
+ # @return [Boolean]
1095
+ #
1096
+ # @!attribute [rw] start_date_time
1097
+ # If `TimePointGranularity` is set to `SPECIFIC`, define the first
1098
+ # point for the Explainability.
1099
+ # @return [String]
1100
+ #
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]
1105
+ #
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.
1110
+ #
1111
+ # The following restrictions apply to tags:
1112
+ #
1113
+ # * For each resource, each tag key must be unique and each tag key
1114
+ # must have one value.
1115
+ #
1116
+ # * Maximum number of tags per resource: 50.
1117
+ #
1118
+ # * Maximum key length: 128 Unicode characters in UTF-8.
1119
+ #
1120
+ # * Maximum value length: 256 Unicode characters in UTF-8.
1121
+ #
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.
1134
+ # @return [Array<Types::Tag>]
1135
+ #
1136
+ # @see http://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/CreateExplainabilityRequest AWS API Documentation
1137
+ #
1138
+ class CreateExplainabilityRequest < Struct.new(
1139
+ :explainability_name,
1140
+ :resource_arn,
1141
+ :explainability_config,
1142
+ :data_source,
1143
+ :schema,
1144
+ :enable_visualization,
1145
+ :start_date_time,
1146
+ :end_date_time,
1147
+ :tags)
1148
+ SENSITIVE = []
1149
+ include Aws::Structure
1150
+ end
1151
+
1152
+ # @!attribute [rw] explainability_arn
1153
+ # The Amazon Resource Name (ARN) of the Explainability.
1154
+ # @return [String]
1155
+ #
1156
+ # @see http://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/CreateExplainabilityResponse AWS API Documentation
1157
+ #
1158
+ class CreateExplainabilityResponse < Struct.new(
1159
+ :explainability_arn)
1160
+ SENSITIVE = []
1161
+ include Aws::Structure
1162
+ end
1163
+
499
1164
  # @note When making an API call, you may pass CreateForecastExportJobRequest
500
1165
  # data as a hash:
501
1166
  #
@@ -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",
@@ -1063,6 +1728,55 @@ module Aws::ForecastService
1063
1728
  include Aws::Structure
1064
1729
  end
1065
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
+
1066
1780
  # The destination for an export job. Provide an S3 path, an AWS Identity
1067
1781
  # and Access Management (IAM) role that allows Amazon Forecast to access
1068
1782
  # the location, and an AWS Key Management Service (KMS) key (optional).
@@ -1330,6 +2044,46 @@ module Aws::ForecastService
1330
2044
  include Aws::Structure
1331
2045
  end
1332
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
+
1333
2087
  # @note When making an API call, you may pass DeleteForecastExportJobRequest
1334
2088
  # data as a hash:
1335
2089
  #
@@ -1388,7 +2142,46 @@ module Aws::ForecastService
1388
2142
  include Aws::Structure
1389
2143
  end
1390
2144
 
1391
- # @note When making an API call, you may pass DeletePredictorRequest
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
1392
2185
  # data as a hash:
1393
2186
  #
1394
2187
  # {
@@ -1396,33 +2189,133 @@ module Aws::ForecastService
1396
2189
  # }
1397
2190
  #
1398
2191
  # @!attribute [rw] predictor_arn
1399
- # The Amazon Resource Name (ARN) of the predictor to delete.
2192
+ # The Amazon Resource Name (ARN) of the predictor.
1400
2193
  # @return [String]
1401
2194
  #
1402
- # @see http://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/DeletePredictorRequest AWS API Documentation
2195
+ # @see http://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/DescribeAutoPredictorRequest AWS API Documentation
1403
2196
  #
1404
- class DeletePredictorRequest < Struct.new(
2197
+ class DescribeAutoPredictorRequest < Struct.new(
1405
2198
  :predictor_arn)
1406
2199
  SENSITIVE = []
1407
2200
  include Aws::Structure
1408
2201
  end
1409
2202
 
1410
- # @note When making an API call, you may pass DeleteResourceTreeRequest
1411
- # data as a hash:
2203
+ # @!attribute [rw] predictor_arn
2204
+ # The Amazon Resource Name (ARN) of the predictor
2205
+ # @return [String]
1412
2206
  #
1413
- # {
1414
- # resource_arn: "Arn", # required
1415
- # }
2207
+ # @!attribute [rw] predictor_name
2208
+ # The name of the predictor.
2209
+ # @return [String]
1416
2210
  #
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.
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.
1420
2228
  # @return [String]
1421
2229
  #
1422
- # @see http://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/DeleteResourceTreeRequest AWS API Documentation
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>]
1423
2234
  #
1424
- class DeleteResourceTreeRequest < Struct.new(
1425
- :resource_arn)
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]
2251
+ #
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]
2256
+ #
2257
+ # @!attribute [rw] status
2258
+ # The status of the predictor. States include:
2259
+ #
2260
+ # * `ACTIVE`
2261
+ #
2262
+ # * `CREATE_PENDING`, `CREATE_IN_PROGRESS`, `CREATE_FAILED`
2263
+ #
2264
+ # * `CREATE_STOPPING`, `CREATE_STOPPED`
2265
+ #
2266
+ # * `DELETE_PENDING`, `DELETE_IN_PROGRESS`, `DELETE_FAILED`
2267
+ # @return [String]
2268
+ #
2269
+ # @!attribute [rw] message
2270
+ # In the event of an error, a message detailing the cause of the
2271
+ # error.
2272
+ # @return [String]
2273
+ #
2274
+ # @!attribute [rw] creation_time
2275
+ # The timestamp of the CreateAutoPredictor request.
2276
+ # @return [Time]
2277
+ #
2278
+ # @!attribute [rw] last_modification_time
2279
+ # The last time the resource was modified. The timestamp depends on
2280
+ # the status of the job:
2281
+ #
2282
+ # * `CREATE_PENDING` - The `CreationTime`.
2283
+ #
2284
+ # * `CREATE_IN_PROGRESS` - The current timestamp.
2285
+ #
2286
+ # * `CREATE_STOPPING` - The current timestamp.
2287
+ #
2288
+ # * `CREATE_STOPPED` - When the job stopped.
2289
+ #
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.
2295
+ # @return [String]
2296
+ #
2297
+ # @!attribute [rw] explainability_info
2298
+ # @return [Types::ExplainabilityInfo]
2299
+ #
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)
1426
2319
  SENSITIVE = []
1427
2320
  include Aws::Structure
1428
2321
  end
@@ -1694,62 +2587,275 @@ module Aws::ForecastService
1694
2587
  # @return [String]
1695
2588
  #
1696
2589
  # @!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.
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]
2777
+ #
2778
+ # @!attribute [rw] enable_visualization
2779
+ # Whether the visualization was enabled for the Explainability
2780
+ # resource.
2781
+ # @return [Boolean]
2782
+ #
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]
2789
+ #
2790
+ # @!attribute [rw] schema
2791
+ # Defines the fields of a dataset. You specify this object in the
2792
+ # CreateDataset request.
1700
2793
  # @return [Types::Schema]
1701
2794
  #
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]
2795
+ # @!attribute [rw] start_date_time
2796
+ # If `TimePointGranularity` is set to `SPECIFIC`, the first time point
2797
+ # in the Explainability.
2798
+ # @return [String]
1707
2799
  #
1708
- # @!attribute [rw] status
1709
- # 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]
1710
2804
  #
1711
- # * `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]
1712
2809
  #
1713
- # * `CREATE_PENDING`, `CREATE_IN_PROGRESS`, `CREATE_FAILED`
2810
+ # @!attribute [rw] message
2811
+ # If an error occurred, a message about the error.
2812
+ # @return [String]
1714
2813
  #
1715
- # * `DELETE_PENDING`, `DELETE_IN_PROGRESS`, `DELETE_FAILED`
2814
+ # @!attribute [rw] status
2815
+ # The status of the Explainability resource. States include:
1716
2816
  #
1717
- # * `UPDATE_PENDING`, `UPDATE_IN_PROGRESS`, `UPDATE_FAILED`
2817
+ # * `ACTIVE`
1718
2818
  #
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`.
2819
+ # * `CREATE_PENDING`, `CREATE_IN_PROGRESS`, `CREATE_FAILED`
1724
2820
  #
1725
- # <note markdown="1"> The `Status` of the dataset must be `ACTIVE` before you can import
1726
- # training data.
2821
+ # * `CREATE_STOPPING`, `CREATE_STOPPED`
1727
2822
  #
1728
- # </note>
2823
+ # * `DELETE_PENDING`, `DELETE_IN_PROGRESS`, `DELETE_FAILED`
1729
2824
  # @return [String]
1730
2825
  #
1731
2826
  # @!attribute [rw] creation_time
1732
- # When the dataset was created.
2827
+ # When the Explainability resource was created.
1733
2828
  # @return [Time]
1734
2829
  #
1735
2830
  # @!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.
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.
1741
2843
  # @return [Time]
1742
2844
  #
1743
- # @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
1744
2846
  #
1745
- class DescribeDatasetResponse < Struct.new(
1746
- :dataset_arn,
1747
- :dataset_name,
1748
- :domain,
1749
- :dataset_type,
1750
- :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,
1751
2854
  :schema,
1752
- :encryption_config,
2855
+ :start_date_time,
2856
+ :end_date_time,
2857
+ :estimated_time_remaining_in_minutes,
2858
+ :message,
1753
2859
  :status,
1754
2860
  :creation_time,
1755
2861
  :last_modification_time)
@@ -2072,6 +3178,10 @@ module Aws::ForecastService
2072
3178
  # training.
2073
3179
  # @return [String]
2074
3180
  #
3181
+ # @!attribute [rw] auto_ml_algorithm_arns
3182
+ # When `PerformAutoML` is specified, the ARN of the chosen algorithm.
3183
+ # @return [Array<String>]
3184
+ #
2075
3185
  # @!attribute [rw] forecast_horizon
2076
3186
  # The number of time-steps of the forecast. The forecast horizon is
2077
3187
  # also called the prediction length.
@@ -2150,15 +3260,15 @@ module Aws::ForecastService
2150
3260
  # job to complete.
2151
3261
  # @return [Integer]
2152
3262
  #
3263
+ # @!attribute [rw] is_auto_predictor
3264
+ # Whether the predictor was created with CreateAutoPredictor.
3265
+ # @return [Boolean]
3266
+ #
2153
3267
  # @!attribute [rw] dataset_import_job_arns
2154
3268
  # An array of the ARNs of the dataset import jobs used to import
2155
3269
  # training data for the predictor.
2156
3270
  # @return [Array<String>]
2157
3271
  #
2158
- # @!attribute [rw] auto_ml_algorithm_arns
2159
- # When `PerformAutoML` is specified, the ARN of the chosen algorithm.
2160
- # @return [Array<String>]
2161
- #
2162
3272
  # @!attribute [rw] status
2163
3273
  # The status of the predictor. States include:
2164
3274
  #
@@ -2209,6 +3319,7 @@ module Aws::ForecastService
2209
3319
  :predictor_arn,
2210
3320
  :predictor_name,
2211
3321
  :algorithm_arn,
3322
+ :auto_ml_algorithm_arns,
2212
3323
  :forecast_horizon,
2213
3324
  :forecast_types,
2214
3325
  :perform_auto_ml,
@@ -2222,8 +3333,8 @@ module Aws::ForecastService
2222
3333
  :encryption_config,
2223
3334
  :predictor_execution_details,
2224
3335
  :estimated_time_remaining_in_minutes,
3336
+ :is_auto_predictor,
2225
3337
  :dataset_import_job_arns,
2226
- :auto_ml_algorithm_arns,
2227
3338
  :status,
2228
3339
  :message,
2229
3340
  :creation_time,
@@ -2250,117 +3361,323 @@ module Aws::ForecastService
2250
3361
  # The ARN of the IAM role that Amazon Forecast can assume to access
2251
3362
  # the AWS KMS key.
2252
3363
  #
2253
- # Passing a role across AWS accounts is not allowed. If you pass a
2254
- # role that isn't in your account, you get an `InvalidInputException`
2255
- # error.
3364
+ # Passing a role across AWS accounts is not allowed. If you pass a
3365
+ # role that isn't in your account, you get an `InvalidInputException`
3366
+ # error.
3367
+ # @return [String]
3368
+ #
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.
3578
+ #
3579
+ # * `ACTIVE` or `CREATE_FAILED` - When the job finished or failed.
3580
+ # @return [Time]
3581
+ #
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)
3592
+ SENSITIVE = []
3593
+ include Aws::Structure
3594
+ end
3595
+
3596
+ # @!attribute [rw] explainability_arn
2256
3597
  # @return [String]
2257
3598
  #
2258
- # @!attribute [rw] kms_key_arn
2259
- # The Amazon Resource Name (ARN) of the KMS key.
3599
+ # @!attribute [rw] status
2260
3600
  # @return [String]
2261
3601
  #
2262
- # @see http://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/EncryptionConfig AWS API Documentation
3602
+ # @see http://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/ExplainabilityInfo AWS API Documentation
2263
3603
  #
2264
- class EncryptionConfig < Struct.new(
2265
- :role_arn,
2266
- :kms_key_arn)
3604
+ class ExplainabilityInfo < Struct.new(
3605
+ :explainability_arn,
3606
+ :status)
2267
3607
  SENSITIVE = []
2268
3608
  include Aws::Structure
2269
3609
  end
2270
3610
 
2271
- # Provides detailed error metrics to evaluate the performance of a
2272
- # predictor. This object is part of the Metrics object.
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`.
2273
3615
  #
2274
- # @!attribute [rw] forecast_type
2275
- # The Forecast type used to compute WAPE, MAPE, MASE, and RMSE.
3616
+ # @!attribute [rw] explainability_arn
3617
+ # The Amazon Resource Name (ARN) of the Explainability.
2276
3618
  # @return [String]
2277
3619
  #
2278
- # @!attribute [rw] wape
2279
- # The weighted absolute percentage error (WAPE).
2280
- # @return [Float]
3620
+ # @!attribute [rw] explainability_name
3621
+ # The name of the Explainability.
3622
+ # @return [String]
2281
3623
  #
2282
- # @!attribute [rw] rmse
2283
- # The root-mean-square error (RMSE).
2284
- # @return [Float]
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]
2285
3628
  #
2286
- # @!attribute [rw] mase
2287
- # The Mean Absolute Scaled Error (MASE)
2288
- # @return [Float]
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]
2289
3633
  #
2290
- # @!attribute [rw] mape
2291
- # The Mean Absolute Percentage Error (MAPE)
2292
- # @return [Float]
3634
+ # @!attribute [rw] status
3635
+ # The status of the Explainability. States include:
2293
3636
  #
2294
- # @see http://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/ErrorMetric AWS API Documentation
3637
+ # * `ACTIVE`
2295
3638
  #
2296
- class ErrorMetric < Struct.new(
2297
- :forecast_type,
2298
- :wape,
2299
- :rmse,
2300
- :mase,
2301
- :mape)
2302
- SENSITIVE = []
2303
- include Aws::Structure
2304
- end
2305
-
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.
3639
+ # * `CREATE_PENDING`, `CREATE_IN_PROGRESS`, `CREATE_FAILED`
2310
3640
  #
2311
- # @note When making an API call, you may pass EvaluationParameters
2312
- # data as a hash:
3641
+ # * `CREATE_STOPPING`, `CREATE_STOPPED`
2313
3642
  #
2314
- # {
2315
- # number_of_backtest_windows: 1,
2316
- # back_test_window_offset: 1,
2317
- # }
3643
+ # * `DELETE_PENDING`, `DELETE_IN_PROGRESS`, `DELETE_FAILED`
3644
+ # @return [String]
2318
3645
  #
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]
3646
+ # @!attribute [rw] message
3647
+ # Information about any errors that may have occurred during the
3648
+ # Explainability creation process.
3649
+ # @return [String]
2323
3650
  #
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.
3651
+ # @!attribute [rw] creation_time
3652
+ # When the Explainability was created.
3653
+ # @return [Time]
2332
3654
  #
2333
- # `ForecastHorizon` &lt;= `BackTestWindowOffset` &lt; 1/2 *
2334
- # TARGET\_TIME\_SERIES dataset length
2335
- # @return [Integer]
3655
+ # @!attribute [rw] last_modification_time
3656
+ # The last time the resource was modified. The timestamp depends on
3657
+ # the status of the job:
2336
3658
  #
2337
- # @see http://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/EvaluationParameters AWS API Documentation
3659
+ # * `CREATE_PENDING` - The `CreationTime`.
2338
3660
  #
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.
3661
+ # * `CREATE_IN_PROGRESS` - The current timestamp.
2348
3662
  #
2349
- # @!attribute [rw] algorithm_arn
2350
- # The Amazon Resource Name (ARN) of the algorithm that was evaluated.
2351
- # @return [String]
3663
+ # * `CREATE_STOPPING` - The current timestamp.
2352
3664
  #
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>]
3665
+ # * `CREATE_STOPPED` - When the job stopped.
2358
3666
  #
2359
- # @see http://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/EvaluationResult AWS API Documentation
3667
+ # * `ACTIVE` or `CREATE_FAILED` - When the job finished or failed.
3668
+ # @return [Time]
2360
3669
  #
2361
- class EvaluationResult < Struct.new(
2362
- :algorithm_arn,
2363
- :test_windows)
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)
2364
3681
  SENSITIVE = []
2365
3682
  include Aws::Structure
2366
3683
  end
@@ -2709,6 +4026,9 @@ module Aws::ForecastService
2709
4026
  # The ARN of the predictor used to generate the forecast.
2710
4027
  # @return [String]
2711
4028
  #
4029
+ # @!attribute [rw] created_using_auto_predictor
4030
+ # @return [Boolean]
4031
+ #
2712
4032
  # @!attribute [rw] dataset_group_arn
2713
4033
  # The Amazon Resource Name (ARN) of the dataset group that provided
2714
4034
  # the data used to train the predictor.
@@ -2760,6 +4080,7 @@ module Aws::ForecastService
2760
4080
  :forecast_arn,
2761
4081
  :forecast_name,
2762
4082
  :predictor_arn,
4083
+ :created_using_auto_predictor,
2763
4084
  :dataset_group_arn,
2764
4085
  :status,
2765
4086
  :message,
@@ -2792,6 +4113,10 @@ module Aws::ForecastService
2792
4113
  # An array of results from evaluating the predictor.
2793
4114
  # @return [Array<Types::EvaluationResult>]
2794
4115
  #
4116
+ # @!attribute [rw] is_auto_predictor
4117
+ # Whether the predictor was created with CreateAutoPredictor.
4118
+ # @return [Boolean]
4119
+ #
2795
4120
  # @!attribute [rw] auto_ml_override_strategy
2796
4121
  # <note markdown="1"> The `LatencyOptimized` AutoML override strategy is only available in
2797
4122
  # private beta. Contact AWS Support or your account manager to learn
@@ -2814,6 +4139,7 @@ module Aws::ForecastService
2814
4139
  #
2815
4140
  class GetAccuracyMetricsResponse < Struct.new(
2816
4141
  :predictor_evaluation_results,
4142
+ :is_auto_predictor,
2817
4143
  :auto_ml_override_strategy,
2818
4144
  :optimization_metric)
2819
4145
  SENSITIVE = []
@@ -3194,6 +4520,150 @@ module Aws::ForecastService
3194
4520
  include Aws::Structure
3195
4521
  end
3196
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
+
3197
4667
  # @note When making an API call, you may pass ListForecastExportJobsRequest
3198
4668
  # data as a hash:
3199
4669
  #
@@ -3760,6 +5230,15 @@ module Aws::ForecastService
3760
5230
  # the data used to train the predictor.
3761
5231
  # @return [String]
3762
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
+ #
3763
5242
  # @!attribute [rw] status
3764
5243
  # The status of the predictor. States include:
3765
5244
  #
@@ -3806,6 +5285,8 @@ module Aws::ForecastService
3806
5285
  :predictor_arn,
3807
5286
  :predictor_name,
3808
5287
  :dataset_group_arn,
5288
+ :is_auto_predictor,
5289
+ :reference_predictor_summary,
3809
5290
  :status,
3810
5291
  :message,
3811
5292
  :creation_time,
@@ -3814,6 +5295,26 @@ module Aws::ForecastService
3814
5295
  include Aws::Structure
3815
5296
  end
3816
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
+
3817
5318
  # There is already a resource with this name. Try again with a different
3818
5319
  # name.
3819
5320
  #