aws-sdk-forecastservice 1.34.0 → 1.37.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,56 @@
10
10
  module Aws::ForecastService
11
11
  module Types
12
12
 
13
+ # Defines the modifications that you are making to an attribute for a
14
+ # what-if forecast. For example, you can use this operation to create a
15
+ # what-if forecast that investigates a 10% off sale on all shoes. To do
16
+ # this, you specify `"AttributeName": "shoes"`, `"Operation":
17
+ # "MULTIPLY"`, and `"Value": "0.90"`. Pair this operation with the
18
+ # TimeSeriesCondition operation within the
19
+ # CreateWhatIfForecastRequest$TimeSeriesTransformations operation to
20
+ # define a subset of attribute items that are modified.
21
+ #
22
+ # @note When making an API call, you may pass Action
23
+ # data as a hash:
24
+ #
25
+ # {
26
+ # attribute_name: "Name", # required
27
+ # operation: "ADD", # required, accepts ADD, SUBTRACT, MULTIPLY, DIVIDE
28
+ # value: 1.0, # required
29
+ # }
30
+ #
31
+ # @!attribute [rw] attribute_name
32
+ # The related time series that you are modifying. This value is case
33
+ # insensitive.
34
+ # @return [String]
35
+ #
36
+ # @!attribute [rw] operation
37
+ # The operation that is applied to the provided attribute. Operations
38
+ # include:
39
+ #
40
+ # * `ADD` - adds `Value` to all rows of `AttributeName`.
41
+ #
42
+ # * `SUBTRACT` - subtracts `Value` from all rows of `AttributeName`.
43
+ #
44
+ # * `MULTIPLY` - multiplies all rows of `AttributeName` by `Value`.
45
+ #
46
+ # * `DIVIDE` - divides all rows of `AttributeName` by `Value`.
47
+ # @return [String]
48
+ #
49
+ # @!attribute [rw] value
50
+ # The value that is applied for the chosen `Operation`.
51
+ # @return [Float]
52
+ #
53
+ # @see http://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/Action AWS API Documentation
54
+ #
55
+ class Action < Struct.new(
56
+ :attribute_name,
57
+ :operation,
58
+ :value)
59
+ SENSITIVE = []
60
+ include Aws::Structure
61
+ end
62
+
13
63
  # Describes an additional dataset. This object is part of the DataConfig
14
64
  # object. Forecast supports the Weather Index and Holidays additional
15
65
  # datasets.
@@ -467,6 +517,12 @@ module Aws::ForecastService
467
517
  # monitor_config: {
468
518
  # monitor_name: "Name", # required
469
519
  # },
520
+ # time_alignment_boundary: {
521
+ # month: "JANUARY", # accepts JANUARY, FEBRUARY, MARCH, APRIL, MAY, JUNE, JULY, AUGUST, SEPTEMBER, OCTOBER, NOVEMBER, DECEMBER
522
+ # day_of_month: 1,
523
+ # day_of_week: "MONDAY", # accepts MONDAY, TUESDAY, WEDNESDAY, THURSDAY, FRIDAY, SATURDAY, SUNDAY
524
+ # hour: 1,
525
+ # },
470
526
  # }
471
527
  #
472
528
  # @!attribute [rw] predictor_name
@@ -594,6 +650,20 @@ module Aws::ForecastService
594
650
  # [1]: https://docs.aws.amazon.com/forecast/latest/dg/predictor-monitoring.html
595
651
  # @return [Types::MonitorConfig]
596
652
  #
653
+ # @!attribute [rw] time_alignment_boundary
654
+ # The time boundary Forecast uses to align and aggregate any data that
655
+ # doesn't align with your forecast frequency. Provide the unit of
656
+ # time and the time boundary as a key value pair. For more information
657
+ # on specifying a time boundary, see [Specifying a Time Boundary][1].
658
+ # If you don't provide a time boundary, Forecast uses a set of
659
+ # [Default Time Boundaries][2].
660
+ #
661
+ #
662
+ #
663
+ # [1]: https://docs.aws.amazon.com/forecast/latest/dg/data-aggregation.html#specifying-time-boundary
664
+ # [2]: https://docs.aws.amazon.com/forecast/latest/dg/data-aggregation.html#default-time-boundaries
665
+ # @return [Types::TimeAlignmentBoundary]
666
+ #
597
667
  # @see http://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/CreateAutoPredictorRequest AWS API Documentation
598
668
  #
599
669
  class CreateAutoPredictorRequest < Struct.new(
@@ -608,7 +678,8 @@ module Aws::ForecastService
608
678
  :optimization_metric,
609
679
  :explain_predictor,
610
680
  :tags,
611
- :monitor_config)
681
+ :monitor_config,
682
+ :time_alignment_boundary)
612
683
  SENSITIVE = []
613
684
  include Aws::Structure
614
685
  end
@@ -746,6 +817,7 @@ module Aws::ForecastService
746
817
  # value: "TagValue", # required
747
818
  # },
748
819
  # ],
820
+ # format: "Format",
749
821
  # }
750
822
  #
751
823
  # @!attribute [rw] dataset_import_job_name
@@ -859,6 +931,11 @@ module Aws::ForecastService
859
931
  # of `aws` do not count against your tags per resource limit.
860
932
  # @return [Array<Types::Tag>]
861
933
  #
934
+ # @!attribute [rw] format
935
+ # The format of the imported data, CSV or PARQUET. The default value
936
+ # is CSV.
937
+ # @return [String]
938
+ #
862
939
  # @see http://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/CreateDatasetImportJobRequest AWS API Documentation
863
940
  #
864
941
  class CreateDatasetImportJobRequest < Struct.new(
@@ -869,7 +946,8 @@ module Aws::ForecastService
869
946
  :time_zone,
870
947
  :use_geolocation_for_time_zone,
871
948
  :geolocation_format,
872
- :tags)
949
+ :tags,
950
+ :format)
873
951
  SENSITIVE = []
874
952
  include Aws::Structure
875
953
  end
@@ -1047,6 +1125,7 @@ module Aws::ForecastService
1047
1125
  # value: "TagValue", # required
1048
1126
  # },
1049
1127
  # ],
1128
+ # format: "Format",
1050
1129
  # }
1051
1130
  #
1052
1131
  # @!attribute [rw] explainability_export_name
@@ -1094,13 +1173,18 @@ module Aws::ForecastService
1094
1173
  # prefix.
1095
1174
  # @return [Array<Types::Tag>]
1096
1175
  #
1176
+ # @!attribute [rw] format
1177
+ # The format of the exported data, CSV or PARQUET.
1178
+ # @return [String]
1179
+ #
1097
1180
  # @see http://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/CreateExplainabilityExportRequest AWS API Documentation
1098
1181
  #
1099
1182
  class CreateExplainabilityExportRequest < Struct.new(
1100
1183
  :explainability_export_name,
1101
1184
  :explainability_arn,
1102
1185
  :destination,
1103
- :tags)
1186
+ :tags,
1187
+ :format)
1104
1188
  SENSITIVE = []
1105
1189
  include Aws::Structure
1106
1190
  end
@@ -1275,6 +1359,7 @@ module Aws::ForecastService
1275
1359
  # value: "TagValue", # required
1276
1360
  # },
1277
1361
  # ],
1362
+ # format: "Format",
1278
1363
  # }
1279
1364
  #
1280
1365
  # @!attribute [rw] forecast_export_job_name
@@ -1330,13 +1415,19 @@ module Aws::ForecastService
1330
1415
  # of `aws` do not count against your tags per resource limit.
1331
1416
  # @return [Array<Types::Tag>]
1332
1417
  #
1418
+ # @!attribute [rw] format
1419
+ # The format of the exported data, CSV or PARQUET. The default value
1420
+ # is CSV.
1421
+ # @return [String]
1422
+ #
1333
1423
  # @see http://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/CreateForecastExportJobRequest AWS API Documentation
1334
1424
  #
1335
1425
  class CreateForecastExportJobRequest < Struct.new(
1336
1426
  :forecast_export_job_name,
1337
1427
  :forecast_arn,
1338
1428
  :destination,
1339
- :tags)
1429
+ :tags,
1430
+ :format)
1340
1431
  SENSITIVE = []
1341
1432
  include Aws::Structure
1342
1433
  end
@@ -1366,6 +1457,26 @@ module Aws::ForecastService
1366
1457
  # value: "TagValue", # required
1367
1458
  # },
1368
1459
  # ],
1460
+ # time_series_selector: {
1461
+ # time_series_identifiers: {
1462
+ # data_source: {
1463
+ # s3_config: { # required
1464
+ # path: "S3Path", # required
1465
+ # role_arn: "Arn", # required
1466
+ # kms_key_arn: "KMSKeyArn",
1467
+ # },
1468
+ # },
1469
+ # schema: {
1470
+ # attributes: [
1471
+ # {
1472
+ # attribute_name: "Name",
1473
+ # attribute_type: "string", # accepts string, integer, float, timestamp, geolocation
1474
+ # },
1475
+ # ],
1476
+ # },
1477
+ # format: "Format",
1478
+ # },
1479
+ # },
1369
1480
  # }
1370
1481
  #
1371
1482
  # @!attribute [rw] forecast_name
@@ -1423,13 +1534,27 @@ module Aws::ForecastService
1423
1534
  # of `aws` do not count against your tags per resource limit.
1424
1535
  # @return [Array<Types::Tag>]
1425
1536
  #
1537
+ # @!attribute [rw] time_series_selector
1538
+ # Defines the set of time series that are used to create the forecasts
1539
+ # in a `TimeSeriesIdentifiers` object.
1540
+ #
1541
+ # The `TimeSeriesIdentifiers` object needs the following information:
1542
+ #
1543
+ # * `DataSource`
1544
+ #
1545
+ # * `Format`
1546
+ #
1547
+ # * `Schema`
1548
+ # @return [Types::TimeSeriesSelector]
1549
+ #
1426
1550
  # @see http://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/CreateForecastRequest AWS API Documentation
1427
1551
  #
1428
1552
  class CreateForecastRequest < Struct.new(
1429
1553
  :forecast_name,
1430
1554
  :predictor_arn,
1431
1555
  :forecast_types,
1432
- :tags)
1556
+ :tags,
1557
+ :time_series_selector)
1433
1558
  SENSITIVE = []
1434
1559
  include Aws::Structure
1435
1560
  end
@@ -1517,6 +1642,7 @@ module Aws::ForecastService
1517
1642
  # value: "TagValue", # required
1518
1643
  # },
1519
1644
  # ],
1645
+ # format: "Format",
1520
1646
  # }
1521
1647
  #
1522
1648
  # @!attribute [rw] predictor_backtest_export_job_name
@@ -1565,13 +1691,19 @@ module Aws::ForecastService
1565
1691
  # prefix.
1566
1692
  # @return [Array<Types::Tag>]
1567
1693
  #
1694
+ # @!attribute [rw] format
1695
+ # The format of the exported data, CSV or PARQUET. The default value
1696
+ # is CSV.
1697
+ # @return [String]
1698
+ #
1568
1699
  # @see http://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/CreatePredictorBacktestExportJobRequest AWS API Documentation
1569
1700
  #
1570
1701
  class CreatePredictorBacktestExportJobRequest < Struct.new(
1571
1702
  :predictor_backtest_export_job_name,
1572
1703
  :predictor_arn,
1573
1704
  :destination,
1574
- :tags)
1705
+ :tags,
1706
+ :format)
1575
1707
  SENSITIVE = []
1576
1708
  include Aws::Structure
1577
1709
  end
@@ -1879,6 +2011,284 @@ module Aws::ForecastService
1879
2011
  include Aws::Structure
1880
2012
  end
1881
2013
 
2014
+ # @note When making an API call, you may pass CreateWhatIfAnalysisRequest
2015
+ # data as a hash:
2016
+ #
2017
+ # {
2018
+ # what_if_analysis_name: "Name", # required
2019
+ # forecast_arn: "Arn", # required
2020
+ # time_series_selector: {
2021
+ # time_series_identifiers: {
2022
+ # data_source: {
2023
+ # s3_config: { # required
2024
+ # path: "S3Path", # required
2025
+ # role_arn: "Arn", # required
2026
+ # kms_key_arn: "KMSKeyArn",
2027
+ # },
2028
+ # },
2029
+ # schema: {
2030
+ # attributes: [
2031
+ # {
2032
+ # attribute_name: "Name",
2033
+ # attribute_type: "string", # accepts string, integer, float, timestamp, geolocation
2034
+ # },
2035
+ # ],
2036
+ # },
2037
+ # format: "Format",
2038
+ # },
2039
+ # },
2040
+ # tags: [
2041
+ # {
2042
+ # key: "TagKey", # required
2043
+ # value: "TagValue", # required
2044
+ # },
2045
+ # ],
2046
+ # }
2047
+ #
2048
+ # @!attribute [rw] what_if_analysis_name
2049
+ # The name of the what-if analysis. Each name must be unique.
2050
+ # @return [String]
2051
+ #
2052
+ # @!attribute [rw] forecast_arn
2053
+ # The Amazon Resource Name (ARN) of the baseline forecast.
2054
+ # @return [String]
2055
+ #
2056
+ # @!attribute [rw] time_series_selector
2057
+ # Defines the set of time series that are used in the what-if analysis
2058
+ # with a `TimeSeriesIdentifiers` object. What-if analyses are
2059
+ # performed only for the time series in this object.
2060
+ #
2061
+ # The `TimeSeriesIdentifiers` object needs the following information:
2062
+ #
2063
+ # * `DataSource`
2064
+ #
2065
+ # * `Format`
2066
+ #
2067
+ # * `Schema`
2068
+ # @return [Types::TimeSeriesSelector]
2069
+ #
2070
+ # @!attribute [rw] tags
2071
+ # A list of [tags][1] to apply to the what if forecast.
2072
+ #
2073
+ #
2074
+ #
2075
+ # [1]: https://docs.aws.amazon.com/forecast/latest/dg/tagging-forecast-resources.html
2076
+ # @return [Array<Types::Tag>]
2077
+ #
2078
+ # @see http://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/CreateWhatIfAnalysisRequest AWS API Documentation
2079
+ #
2080
+ class CreateWhatIfAnalysisRequest < Struct.new(
2081
+ :what_if_analysis_name,
2082
+ :forecast_arn,
2083
+ :time_series_selector,
2084
+ :tags)
2085
+ SENSITIVE = []
2086
+ include Aws::Structure
2087
+ end
2088
+
2089
+ # @!attribute [rw] what_if_analysis_arn
2090
+ # The Amazon Resource Name (ARN) of the what-if analysis.
2091
+ # @return [String]
2092
+ #
2093
+ # @see http://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/CreateWhatIfAnalysisResponse AWS API Documentation
2094
+ #
2095
+ class CreateWhatIfAnalysisResponse < Struct.new(
2096
+ :what_if_analysis_arn)
2097
+ SENSITIVE = []
2098
+ include Aws::Structure
2099
+ end
2100
+
2101
+ # @note When making an API call, you may pass CreateWhatIfForecastExportRequest
2102
+ # data as a hash:
2103
+ #
2104
+ # {
2105
+ # what_if_forecast_export_name: "Name", # required
2106
+ # what_if_forecast_arns: ["LongArn"], # required
2107
+ # destination: { # required
2108
+ # s3_config: { # required
2109
+ # path: "S3Path", # required
2110
+ # role_arn: "Arn", # required
2111
+ # kms_key_arn: "KMSKeyArn",
2112
+ # },
2113
+ # },
2114
+ # tags: [
2115
+ # {
2116
+ # key: "TagKey", # required
2117
+ # value: "TagValue", # required
2118
+ # },
2119
+ # ],
2120
+ # format: "Format",
2121
+ # }
2122
+ #
2123
+ # @!attribute [rw] what_if_forecast_export_name
2124
+ # The name of the what-if forecast to export.
2125
+ # @return [String]
2126
+ #
2127
+ # @!attribute [rw] what_if_forecast_arns
2128
+ # The list of what-if forecast Amazon Resource Names (ARNs) to export.
2129
+ # @return [Array<String>]
2130
+ #
2131
+ # @!attribute [rw] destination
2132
+ # The location where you want to save the forecast and an AWS Identity
2133
+ # and Access Management (IAM) role that Amazon Forecast can assume to
2134
+ # access the location. The forecast must be exported to an Amazon S3
2135
+ # bucket.
2136
+ #
2137
+ # If encryption is used, `Destination` must include an AWS Key
2138
+ # Management Service (KMS) key. The IAM role must allow Amazon
2139
+ # Forecast permission to access the key.
2140
+ # @return [Types::DataDestination]
2141
+ #
2142
+ # @!attribute [rw] tags
2143
+ # A list of [tags][1] to apply to the what if forecast.
2144
+ #
2145
+ #
2146
+ #
2147
+ # [1]: https://docs.aws.amazon.com/forecast/latest/dg/tagging-forecast-resources.html
2148
+ # @return [Array<Types::Tag>]
2149
+ #
2150
+ # @!attribute [rw] format
2151
+ # The format of the exported data, CSV or PARQUET.
2152
+ # @return [String]
2153
+ #
2154
+ # @see http://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/CreateWhatIfForecastExportRequest AWS API Documentation
2155
+ #
2156
+ class CreateWhatIfForecastExportRequest < Struct.new(
2157
+ :what_if_forecast_export_name,
2158
+ :what_if_forecast_arns,
2159
+ :destination,
2160
+ :tags,
2161
+ :format)
2162
+ SENSITIVE = []
2163
+ include Aws::Structure
2164
+ end
2165
+
2166
+ # @!attribute [rw] what_if_forecast_export_arn
2167
+ # The Amazon Resource Name (ARN) of the what-if forecast.
2168
+ # @return [String]
2169
+ #
2170
+ # @see http://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/CreateWhatIfForecastExportResponse AWS API Documentation
2171
+ #
2172
+ class CreateWhatIfForecastExportResponse < Struct.new(
2173
+ :what_if_forecast_export_arn)
2174
+ SENSITIVE = []
2175
+ include Aws::Structure
2176
+ end
2177
+
2178
+ # @note When making an API call, you may pass CreateWhatIfForecastRequest
2179
+ # data as a hash:
2180
+ #
2181
+ # {
2182
+ # what_if_forecast_name: "Name", # required
2183
+ # what_if_analysis_arn: "Arn", # required
2184
+ # time_series_transformations: [
2185
+ # {
2186
+ # action: {
2187
+ # attribute_name: "Name", # required
2188
+ # operation: "ADD", # required, accepts ADD, SUBTRACT, MULTIPLY, DIVIDE
2189
+ # value: 1.0, # required
2190
+ # },
2191
+ # time_series_conditions: [
2192
+ # {
2193
+ # attribute_name: "Name", # required
2194
+ # attribute_value: "AttributeValue", # required
2195
+ # condition: "EQUALS", # required, accepts EQUALS, NOT_EQUALS, LESS_THAN, GREATER_THAN
2196
+ # },
2197
+ # ],
2198
+ # },
2199
+ # ],
2200
+ # time_series_replacements_data_source: {
2201
+ # s3_config: { # required
2202
+ # path: "S3Path", # required
2203
+ # role_arn: "Arn", # required
2204
+ # kms_key_arn: "KMSKeyArn",
2205
+ # },
2206
+ # schema: { # required
2207
+ # attributes: [
2208
+ # {
2209
+ # attribute_name: "Name",
2210
+ # attribute_type: "string", # accepts string, integer, float, timestamp, geolocation
2211
+ # },
2212
+ # ],
2213
+ # },
2214
+ # format: "Format",
2215
+ # timestamp_format: "TimestampFormat",
2216
+ # },
2217
+ # tags: [
2218
+ # {
2219
+ # key: "TagKey", # required
2220
+ # value: "TagValue", # required
2221
+ # },
2222
+ # ],
2223
+ # }
2224
+ #
2225
+ # @!attribute [rw] what_if_forecast_name
2226
+ # The name of the what-if forecast. Names must be unique within each
2227
+ # what-if analysis.
2228
+ # @return [String]
2229
+ #
2230
+ # @!attribute [rw] what_if_analysis_arn
2231
+ # The Amazon Resource Name (ARN) of the what-if analysis.
2232
+ # @return [String]
2233
+ #
2234
+ # @!attribute [rw] time_series_transformations
2235
+ # The transformations that are applied to the baseline time series.
2236
+ # Each transformation contains an action and a set of conditions. An
2237
+ # action is applied only when all conditions are met. If no conditions
2238
+ # are provided, the action is applied to all items.
2239
+ # @return [Array<Types::TimeSeriesTransformation>]
2240
+ #
2241
+ # @!attribute [rw] time_series_replacements_data_source
2242
+ # The replacement time series dataset, which contains the rows that
2243
+ # you want to change in the related time series dataset. A replacement
2244
+ # time series does not need to contain all rows that are in the
2245
+ # baseline related time series. Include only the rows
2246
+ # (measure-dimension combinations) that you want to include in the
2247
+ # what-if forecast. This dataset is merged with the original time
2248
+ # series to create a transformed dataset that is used for the what-if
2249
+ # analysis.
2250
+ #
2251
+ # This dataset should contain the items to modify (such as item\_id or
2252
+ # workforce\_type), any relevant dimensions, the timestamp column, and
2253
+ # at least one of the related time series columns. This file should
2254
+ # not contain duplicate timestamps for the same time series.
2255
+ #
2256
+ # Timestamps and item\_ids not included in this dataset are not
2257
+ # included in the what-if analysis.
2258
+ # @return [Types::TimeSeriesReplacementsDataSource]
2259
+ #
2260
+ # @!attribute [rw] tags
2261
+ # A list of [tags][1] to apply to the what if forecast.
2262
+ #
2263
+ #
2264
+ #
2265
+ # [1]: https://docs.aws.amazon.com/forecast/latest/dg/tagging-forecast-resources.html
2266
+ # @return [Array<Types::Tag>]
2267
+ #
2268
+ # @see http://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/CreateWhatIfForecastRequest AWS API Documentation
2269
+ #
2270
+ class CreateWhatIfForecastRequest < Struct.new(
2271
+ :what_if_forecast_name,
2272
+ :what_if_analysis_arn,
2273
+ :time_series_transformations,
2274
+ :time_series_replacements_data_source,
2275
+ :tags)
2276
+ SENSITIVE = []
2277
+ include Aws::Structure
2278
+ end
2279
+
2280
+ # @!attribute [rw] what_if_forecast_arn
2281
+ # The Amazon Resource Name (ARN) of the what-if forecast.
2282
+ # @return [String]
2283
+ #
2284
+ # @see http://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/CreateWhatIfForecastResponse AWS API Documentation
2285
+ #
2286
+ class CreateWhatIfForecastResponse < Struct.new(
2287
+ :what_if_forecast_arn)
2288
+ SENSITIVE = []
2289
+ include Aws::Structure
2290
+ end
2291
+
1882
2292
  # The data configuration for your dataset group and any additional
1883
2293
  # datasets.
1884
2294
  #
@@ -2372,44 +2782,104 @@ module Aws::ForecastService
2372
2782
  include Aws::Structure
2373
2783
  end
2374
2784
 
2375
- # @note When making an API call, you may pass DescribeAutoPredictorRequest
2785
+ # @note When making an API call, you may pass DeleteWhatIfAnalysisRequest
2376
2786
  # data as a hash:
2377
2787
  #
2378
2788
  # {
2379
- # predictor_arn: "Arn", # required
2789
+ # what_if_analysis_arn: "Arn", # required
2380
2790
  # }
2381
2791
  #
2382
- # @!attribute [rw] predictor_arn
2383
- # The Amazon Resource Name (ARN) of the predictor.
2792
+ # @!attribute [rw] what_if_analysis_arn
2793
+ # The Amazon Resource Name (ARN) of the what-if analysis that you want
2794
+ # to delete.
2384
2795
  # @return [String]
2385
2796
  #
2386
- # @see http://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/DescribeAutoPredictorRequest AWS API Documentation
2797
+ # @see http://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/DeleteWhatIfAnalysisRequest AWS API Documentation
2387
2798
  #
2388
- class DescribeAutoPredictorRequest < Struct.new(
2389
- :predictor_arn)
2799
+ class DeleteWhatIfAnalysisRequest < Struct.new(
2800
+ :what_if_analysis_arn)
2390
2801
  SENSITIVE = []
2391
2802
  include Aws::Structure
2392
2803
  end
2393
2804
 
2394
- # @!attribute [rw] predictor_arn
2395
- # The Amazon Resource Name (ARN) of the predictor
2396
- # @return [String]
2805
+ # @note When making an API call, you may pass DeleteWhatIfForecastExportRequest
2806
+ # data as a hash:
2397
2807
  #
2398
- # @!attribute [rw] predictor_name
2399
- # The name of the predictor.
2808
+ # {
2809
+ # what_if_forecast_export_arn: "LongArn", # required
2810
+ # }
2811
+ #
2812
+ # @!attribute [rw] what_if_forecast_export_arn
2813
+ # The Amazon Resource Name (ARN) of the what-if forecast export that
2814
+ # you want to delete.
2400
2815
  # @return [String]
2401
2816
  #
2402
- # @!attribute [rw] forecast_horizon
2403
- # The number of time-steps that the model predicts. The forecast
2404
- # horizon is also called the prediction length.
2405
- # @return [Integer]
2817
+ # @see http://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/DeleteWhatIfForecastExportRequest AWS API Documentation
2406
2818
  #
2407
- # @!attribute [rw] forecast_types
2408
- # The forecast types used during predictor training. Default value is
2409
- # \["0.1","0.5","0.9"\].
2410
- # @return [Array<String>]
2819
+ class DeleteWhatIfForecastExportRequest < Struct.new(
2820
+ :what_if_forecast_export_arn)
2821
+ SENSITIVE = []
2822
+ include Aws::Structure
2823
+ end
2824
+
2825
+ # @note When making an API call, you may pass DeleteWhatIfForecastRequest
2826
+ # data as a hash:
2411
2827
  #
2412
- # @!attribute [rw] forecast_frequency
2828
+ # {
2829
+ # what_if_forecast_arn: "LongArn", # required
2830
+ # }
2831
+ #
2832
+ # @!attribute [rw] what_if_forecast_arn
2833
+ # The Amazon Resource Name (ARN) of the what-if forecast that you want
2834
+ # to delete.
2835
+ # @return [String]
2836
+ #
2837
+ # @see http://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/DeleteWhatIfForecastRequest AWS API Documentation
2838
+ #
2839
+ class DeleteWhatIfForecastRequest < Struct.new(
2840
+ :what_if_forecast_arn)
2841
+ SENSITIVE = []
2842
+ include Aws::Structure
2843
+ end
2844
+
2845
+ # @note When making an API call, you may pass DescribeAutoPredictorRequest
2846
+ # data as a hash:
2847
+ #
2848
+ # {
2849
+ # predictor_arn: "Arn", # required
2850
+ # }
2851
+ #
2852
+ # @!attribute [rw] predictor_arn
2853
+ # The Amazon Resource Name (ARN) of the predictor.
2854
+ # @return [String]
2855
+ #
2856
+ # @see http://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/DescribeAutoPredictorRequest AWS API Documentation
2857
+ #
2858
+ class DescribeAutoPredictorRequest < Struct.new(
2859
+ :predictor_arn)
2860
+ SENSITIVE = []
2861
+ include Aws::Structure
2862
+ end
2863
+
2864
+ # @!attribute [rw] predictor_arn
2865
+ # The Amazon Resource Name (ARN) of the predictor
2866
+ # @return [String]
2867
+ #
2868
+ # @!attribute [rw] predictor_name
2869
+ # The name of the predictor.
2870
+ # @return [String]
2871
+ #
2872
+ # @!attribute [rw] forecast_horizon
2873
+ # The number of time-steps that the model predicts. The forecast
2874
+ # horizon is also called the prediction length.
2875
+ # @return [Integer]
2876
+ #
2877
+ # @!attribute [rw] forecast_types
2878
+ # The forecast types used during predictor training. Default value is
2879
+ # \["0.1","0.5","0.9"\].
2880
+ # @return [Array<String>]
2881
+ #
2882
+ # @!attribute [rw] forecast_frequency
2413
2883
  # The frequency of predictions in a forecast.
2414
2884
  #
2415
2885
  # Valid intervals are Y (Year), M (Month), W (Week), D (Day), H
@@ -2499,6 +2969,10 @@ module Aws::ForecastService
2499
2969
  # monitor resource.
2500
2970
  # @return [Types::MonitorInfo]
2501
2971
  #
2972
+ # @!attribute [rw] time_alignment_boundary
2973
+ # The time boundary Forecast uses when aggregating data.
2974
+ # @return [Types::TimeAlignmentBoundary]
2975
+ #
2502
2976
  # @see http://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/DescribeAutoPredictorResponse AWS API Documentation
2503
2977
  #
2504
2978
  class DescribeAutoPredictorResponse < Struct.new(
@@ -2519,7 +2993,8 @@ module Aws::ForecastService
2519
2993
  :last_modification_time,
2520
2994
  :optimization_metric,
2521
2995
  :explainability_info,
2522
- :monitor_info)
2996
+ :monitor_info,
2997
+ :time_alignment_boundary)
2523
2998
  SENSITIVE = []
2524
2999
  include Aws::Structure
2525
3000
  end
@@ -2732,6 +3207,10 @@ module Aws::ForecastService
2732
3207
  # * `ACTIVE` or `CREATE_FAILED` - When the job finished or failed.
2733
3208
  # @return [Time]
2734
3209
  #
3210
+ # @!attribute [rw] format
3211
+ # The format of the imported data, CSV or PARQUET.
3212
+ # @return [String]
3213
+ #
2735
3214
  # @see http://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/DescribeDatasetImportJobResponse AWS API Documentation
2736
3215
  #
2737
3216
  class DescribeDatasetImportJobResponse < Struct.new(
@@ -2749,7 +3228,8 @@ module Aws::ForecastService
2749
3228
  :status,
2750
3229
  :message,
2751
3230
  :creation_time,
2752
- :last_modification_time)
3231
+ :last_modification_time,
3232
+ :format)
2753
3233
  SENSITIVE = []
2754
3234
  include Aws::Structure
2755
3235
  end
@@ -2898,7 +3378,7 @@ module Aws::ForecastService
2898
3378
  # @return [String]
2899
3379
  #
2900
3380
  # @!attribute [rw] explainability_arn
2901
- # The Amazon Resource Name (ARN) of the Explainability.
3381
+ # The Amazon Resource Name (ARN) of the Explainability export.
2902
3382
  # @return [String]
2903
3383
  #
2904
3384
  # @!attribute [rw] destination
@@ -2943,6 +3423,10 @@ module Aws::ForecastService
2943
3423
  # * `ACTIVE` or `CREATE_FAILED` - When the job finished or failed.
2944
3424
  # @return [Time]
2945
3425
  #
3426
+ # @!attribute [rw] format
3427
+ # The format of the exported data, CSV or PARQUET.
3428
+ # @return [String]
3429
+ #
2946
3430
  # @see http://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/DescribeExplainabilityExportResponse AWS API Documentation
2947
3431
  #
2948
3432
  class DescribeExplainabilityExportResponse < Struct.new(
@@ -2953,7 +3437,8 @@ module Aws::ForecastService
2953
3437
  :message,
2954
3438
  :status,
2955
3439
  :creation_time,
2956
- :last_modification_time)
3440
+ :last_modification_time,
3441
+ :format)
2957
3442
  SENSITIVE = []
2958
3443
  include Aws::Structure
2959
3444
  end
@@ -3157,6 +3642,10 @@ module Aws::ForecastService
3157
3642
  # * `ACTIVE` or `CREATE_FAILED` - When the job finished or failed.
3158
3643
  # @return [Time]
3159
3644
  #
3645
+ # @!attribute [rw] format
3646
+ # The format of the exported data, CSV or PARQUET.
3647
+ # @return [String]
3648
+ #
3160
3649
  # @see http://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/DescribeForecastExportJobResponse AWS API Documentation
3161
3650
  #
3162
3651
  class DescribeForecastExportJobResponse < Struct.new(
@@ -3167,7 +3656,8 @@ module Aws::ForecastService
3167
3656
  :message,
3168
3657
  :status,
3169
3658
  :creation_time,
3170
- :last_modification_time)
3659
+ :last_modification_time,
3660
+ :format)
3171
3661
  SENSITIVE = []
3172
3662
  include Aws::Structure
3173
3663
  end
@@ -3257,6 +3747,10 @@ module Aws::ForecastService
3257
3747
  # * `ACTIVE` or `CREATE_FAILED` - When the job finished or failed.
3258
3748
  # @return [Time]
3259
3749
  #
3750
+ # @!attribute [rw] time_series_selector
3751
+ # The time series to include in the forecast.
3752
+ # @return [Types::TimeSeriesSelector]
3753
+ #
3260
3754
  # @see http://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/DescribeForecastResponse AWS API Documentation
3261
3755
  #
3262
3756
  class DescribeForecastResponse < Struct.new(
@@ -3269,7 +3763,8 @@ module Aws::ForecastService
3269
3763
  :status,
3270
3764
  :message,
3271
3765
  :creation_time,
3272
- :last_modification_time)
3766
+ :last_modification_time,
3767
+ :time_series_selector)
3273
3768
  SENSITIVE = []
3274
3769
  include Aws::Structure
3275
3770
  end
@@ -3432,6 +3927,10 @@ module Aws::ForecastService
3432
3927
  # * `ACTIVE` or `CREATE_FAILED` - When the job finished or failed.
3433
3928
  # @return [Time]
3434
3929
  #
3930
+ # @!attribute [rw] format
3931
+ # The format of the exported data, CSV or PARQUET.
3932
+ # @return [String]
3933
+ #
3435
3934
  # @see http://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/DescribePredictorBacktestExportJobResponse AWS API Documentation
3436
3935
  #
3437
3936
  class DescribePredictorBacktestExportJobResponse < Struct.new(
@@ -3442,7 +3941,8 @@ module Aws::ForecastService
3442
3941
  :message,
3443
3942
  :status,
3444
3943
  :creation_time,
3445
- :last_modification_time)
3944
+ :last_modification_time,
3945
+ :format)
3446
3946
  SENSITIVE = []
3447
3947
  include Aws::Structure
3448
3948
  end
@@ -3646,198 +4146,145 @@ module Aws::ForecastService
3646
4146
  include Aws::Structure
3647
4147
  end
3648
4148
 
3649
- # An AWS Key Management Service (KMS) key and an AWS Identity and Access
3650
- # Management (IAM) role that Amazon Forecast can assume to access the
3651
- # key. You can specify this optional object in the CreateDataset and
3652
- # CreatePredictor requests.
3653
- #
3654
- # @note When making an API call, you may pass EncryptionConfig
4149
+ # @note When making an API call, you may pass DescribeWhatIfAnalysisRequest
3655
4150
  # data as a hash:
3656
4151
  #
3657
4152
  # {
3658
- # role_arn: "Arn", # required
3659
- # kms_key_arn: "KMSKeyArn", # required
4153
+ # what_if_analysis_arn: "Arn", # required
3660
4154
  # }
3661
4155
  #
3662
- # @!attribute [rw] role_arn
3663
- # The ARN of the IAM role that Amazon Forecast can assume to access
3664
- # the AWS KMS key.
3665
- #
3666
- # Passing a role across AWS accounts is not allowed. If you pass a
3667
- # role that isn't in your account, you get an `InvalidInputException`
3668
- # error.
3669
- # @return [String]
3670
- #
3671
- # @!attribute [rw] kms_key_arn
3672
- # The Amazon Resource Name (ARN) of the KMS key.
4156
+ # @!attribute [rw] what_if_analysis_arn
4157
+ # The Amazon Resource Name (ARN) of the what-if analysis that you are
4158
+ # interested in.
3673
4159
  # @return [String]
3674
4160
  #
3675
- # @see http://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/EncryptionConfig AWS API Documentation
4161
+ # @see http://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/DescribeWhatIfAnalysisRequest AWS API Documentation
3676
4162
  #
3677
- class EncryptionConfig < Struct.new(
3678
- :role_arn,
3679
- :kms_key_arn)
4163
+ class DescribeWhatIfAnalysisRequest < Struct.new(
4164
+ :what_if_analysis_arn)
3680
4165
  SENSITIVE = []
3681
4166
  include Aws::Structure
3682
4167
  end
3683
4168
 
3684
- # Provides detailed error metrics to evaluate the performance of a
3685
- # predictor. This object is part of the Metrics object.
4169
+ # @!attribute [rw] what_if_analysis_name
4170
+ # The name of the what-if analysis.
4171
+ # @return [String]
3686
4172
  #
3687
- # @!attribute [rw] forecast_type
3688
- # The Forecast type used to compute WAPE, MAPE, MASE, and RMSE.
4173
+ # @!attribute [rw] what_if_analysis_arn
4174
+ # The Amazon Resource Name (ARN) of the what-if analysis.
3689
4175
  # @return [String]
3690
4176
  #
3691
- # @!attribute [rw] wape
3692
- # The weighted absolute percentage error (WAPE).
3693
- # @return [Float]
4177
+ # @!attribute [rw] forecast_arn
4178
+ # The Amazon Resource Name (ARN) of the what-if forecast.
4179
+ # @return [String]
3694
4180
  #
3695
- # @!attribute [rw] rmse
3696
- # The root-mean-square error (RMSE).
3697
- # @return [Float]
4181
+ # @!attribute [rw] estimated_time_remaining_in_minutes
4182
+ # The approximate time remaining to complete the what-if analysis, in
4183
+ # minutes.
4184
+ # @return [Integer]
3698
4185
  #
3699
- # @!attribute [rw] mase
3700
- # The Mean Absolute Scaled Error (MASE)
3701
- # @return [Float]
4186
+ # @!attribute [rw] status
4187
+ # The status of the what-if analysis. States include:
3702
4188
  #
3703
- # @!attribute [rw] mape
3704
- # The Mean Absolute Percentage Error (MAPE)
3705
- # @return [Float]
4189
+ # * `ACTIVE`
3706
4190
  #
3707
- # @see http://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/ErrorMetric AWS API Documentation
4191
+ # * `CREATE_PENDING`, `CREATE_IN_PROGRESS`, `CREATE_FAILED`
3708
4192
  #
3709
- class ErrorMetric < Struct.new(
3710
- :forecast_type,
3711
- :wape,
3712
- :rmse,
3713
- :mase,
3714
- :mape)
3715
- SENSITIVE = []
3716
- include Aws::Structure
3717
- end
3718
-
3719
- # Parameters that define how to split a dataset into training data and
3720
- # testing data, and the number of iterations to perform. These
3721
- # parameters are specified in the predefined algorithms but you can
3722
- # override them in the CreatePredictor request.
4193
+ # * `CREATE_STOPPING`, `CREATE_STOPPED`
3723
4194
  #
3724
- # @note When making an API call, you may pass EvaluationParameters
3725
- # data as a hash:
4195
+ # * `DELETE_PENDING`, `DELETE_IN_PROGRESS`, `DELETE_FAILED`
3726
4196
  #
3727
- # {
3728
- # number_of_backtest_windows: 1,
3729
- # back_test_window_offset: 1,
3730
- # }
4197
+ # <note markdown="1"> The `Status` of the what-if analysis must be `ACTIVE` before you can
4198
+ # access the analysis.
3731
4199
  #
3732
- # @!attribute [rw] number_of_backtest_windows
3733
- # The number of times to split the input data. The default is 1. Valid
3734
- # values are 1 through 5.
3735
- # @return [Integer]
4200
+ # </note>
4201
+ # @return [String]
3736
4202
  #
3737
- # @!attribute [rw] back_test_window_offset
3738
- # The point from the end of the dataset where you want to split the
3739
- # data for model training and testing (evaluation). Specify the value
3740
- # as the number of data points. The default is the value of the
3741
- # forecast horizon. `BackTestWindowOffset` can be used to mimic a past
3742
- # virtual forecast start date. This value must be greater than or
3743
- # equal to the forecast horizon and less than half of the
3744
- # TARGET\_TIME\_SERIES dataset length.
4203
+ # @!attribute [rw] message
4204
+ # If an error occurred, an informational message about the error.
4205
+ # @return [String]
3745
4206
  #
3746
- # `ForecastHorizon` &lt;= `BackTestWindowOffset` &lt; 1/2 *
3747
- # TARGET\_TIME\_SERIES dataset length
3748
- # @return [Integer]
4207
+ # @!attribute [rw] creation_time
4208
+ # When the what-if analysis was created.
4209
+ # @return [Time]
3749
4210
  #
3750
- # @see http://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/EvaluationParameters AWS API Documentation
4211
+ # @!attribute [rw] last_modification_time
4212
+ # The last time the resource was modified. The timestamp depends on
4213
+ # the status of the job:
3751
4214
  #
3752
- class EvaluationParameters < Struct.new(
3753
- :number_of_backtest_windows,
3754
- :back_test_window_offset)
3755
- SENSITIVE = []
3756
- include Aws::Structure
3757
- end
3758
-
3759
- # The results of evaluating an algorithm. Returned as part of the
3760
- # GetAccuracyMetrics response.
4215
+ # * `CREATE_PENDING` - The `CreationTime`.
3761
4216
  #
3762
- # @!attribute [rw] algorithm_arn
3763
- # The Amazon Resource Name (ARN) of the algorithm that was evaluated.
3764
- # @return [String]
4217
+ # * `CREATE_IN_PROGRESS` - The current timestamp.
3765
4218
  #
3766
- # @!attribute [rw] test_windows
3767
- # The array of test windows used for evaluating the algorithm. The
3768
- # `NumberOfBacktestWindows` from the EvaluationParameters object
3769
- # determines the number of windows in the array.
3770
- # @return [Array<Types::WindowSummary>]
4219
+ # * `CREATE_STOPPING` - The current timestamp.
3771
4220
  #
3772
- # @see http://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/EvaluationResult AWS API Documentation
4221
+ # * `CREATE_STOPPED` - When the job stopped.
3773
4222
  #
3774
- class EvaluationResult < Struct.new(
3775
- :algorithm_arn,
3776
- :test_windows)
4223
+ # * `ACTIVE` or `CREATE_FAILED` - When the job finished or failed.
4224
+ # @return [Time]
4225
+ #
4226
+ # @!attribute [rw] time_series_selector
4227
+ # Defines the set of time series that are used to create the forecasts
4228
+ # in a `TimeSeriesIdentifiers` object.
4229
+ #
4230
+ # The `TimeSeriesIdentifiers` object needs the following information:
4231
+ #
4232
+ # * `DataSource`
4233
+ #
4234
+ # * `Format`
4235
+ #
4236
+ # * `Schema`
4237
+ # @return [Types::TimeSeriesSelector]
4238
+ #
4239
+ # @see http://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/DescribeWhatIfAnalysisResponse AWS API Documentation
4240
+ #
4241
+ class DescribeWhatIfAnalysisResponse < Struct.new(
4242
+ :what_if_analysis_name,
4243
+ :what_if_analysis_arn,
4244
+ :forecast_arn,
4245
+ :estimated_time_remaining_in_minutes,
4246
+ :status,
4247
+ :message,
4248
+ :creation_time,
4249
+ :last_modification_time,
4250
+ :time_series_selector)
3777
4251
  SENSITIVE = []
3778
4252
  include Aws::Structure
3779
4253
  end
3780
4254
 
3781
- # The ExplainabilityConfig data type defines the number of time series
3782
- # and time points included in CreateExplainability.
3783
- #
3784
- # If you provide a predictor ARN for `ResourceArn`, you must set both
3785
- # `TimePointGranularity` and `TimeSeriesGranularity` to “ALL”. When
3786
- # creating Predictor Explainability, Amazon Forecast considers all time
3787
- # series and time points.
3788
- #
3789
- # If you provide a forecast ARN for `ResourceArn`, you can set
3790
- # `TimePointGranularity` and `TimeSeriesGranularity` to either “ALL” or
3791
- # “Specific”.
3792
- #
3793
- # @note When making an API call, you may pass ExplainabilityConfig
4255
+ # @note When making an API call, you may pass DescribeWhatIfForecastExportRequest
3794
4256
  # data as a hash:
3795
4257
  #
3796
4258
  # {
3797
- # time_series_granularity: "ALL", # required, accepts ALL, SPECIFIC
3798
- # time_point_granularity: "ALL", # required, accepts ALL, SPECIFIC
4259
+ # what_if_forecast_export_arn: "LongArn", # required
3799
4260
  # }
3800
4261
  #
3801
- # @!attribute [rw] time_series_granularity
3802
- # To create an Explainability for all time series in your datasets,
3803
- # use `ALL`. To create an Explainability for specific time series in
3804
- # your datasets, use `SPECIFIC`.
3805
- #
3806
- # Specify time series by uploading a CSV file to an Amazon S3 bucket
3807
- # and set the location within the DataDestination data type.
3808
- # @return [String]
3809
- #
3810
- # @!attribute [rw] time_point_granularity
3811
- # To create an Explainability for all time points in your forecast
3812
- # horizon, use `ALL`. To create an Explainability for specific time
3813
- # points in your forecast horizon, use `SPECIFIC`.
3814
- #
3815
- # Specify time points with the `StartDateTime` and `EndDateTime`
3816
- # parameters within the CreateExplainability operation.
4262
+ # @!attribute [rw] what_if_forecast_export_arn
4263
+ # The Amazon Resource Name (ARN) of the what-if forecast export that
4264
+ # you are interested in.
3817
4265
  # @return [String]
3818
4266
  #
3819
- # @see http://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/ExplainabilityConfig AWS API Documentation
4267
+ # @see http://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/DescribeWhatIfForecastExportRequest AWS API Documentation
3820
4268
  #
3821
- class ExplainabilityConfig < Struct.new(
3822
- :time_series_granularity,
3823
- :time_point_granularity)
4269
+ class DescribeWhatIfForecastExportRequest < Struct.new(
4270
+ :what_if_forecast_export_arn)
3824
4271
  SENSITIVE = []
3825
4272
  include Aws::Structure
3826
4273
  end
3827
4274
 
3828
- # Provides a summary of the Explainability export properties used in the
3829
- # ListExplainabilityExports operation. To get a complete set of
3830
- # properties, call the DescribeExplainabilityExport operation, and
3831
- # provide the `ExplainabilityExportArn`.
3832
- #
3833
- # @!attribute [rw] explainability_export_arn
3834
- # The Amazon Resource Name (ARN) of the Explainability export.
4275
+ # @!attribute [rw] what_if_forecast_export_arn
4276
+ # The Amazon Resource Name (ARN) of the what-if forecast export.
3835
4277
  # @return [String]
3836
4278
  #
3837
- # @!attribute [rw] explainability_export_name
3838
- # The name of the Explainability export
4279
+ # @!attribute [rw] what_if_forecast_export_name
4280
+ # The name of the what-if forecast export.
3839
4281
  # @return [String]
3840
4282
  #
4283
+ # @!attribute [rw] what_if_forecast_arns
4284
+ # An array of Amazon Resource Names (ARNs) that represent all of the
4285
+ # what-if forecasts exported in this resource.
4286
+ # @return [Array<String>]
4287
+ #
3841
4288
  # @!attribute [rw] destination
3842
4289
  # The destination for an export job. Provide an S3 path, an AWS
3843
4290
  # Identity and Access Management (IAM) role that allows Amazon
@@ -3845,8 +4292,12 @@ module Aws::ForecastService
3845
4292
  # (KMS) key (optional).
3846
4293
  # @return [Types::DataDestination]
3847
4294
  #
4295
+ # @!attribute [rw] message
4296
+ # If an error occurred, an informational message about the error.
4297
+ # @return [String]
4298
+ #
3848
4299
  # @!attribute [rw] status
3849
- # The status of the Explainability export. States include:
4300
+ # The status of the what-if forecast. States include:
3850
4301
  #
3851
4302
  # * `ACTIVE`
3852
4303
  #
@@ -3855,17 +4306,22 @@ module Aws::ForecastService
3855
4306
  # * `CREATE_STOPPING`, `CREATE_STOPPED`
3856
4307
  #
3857
4308
  # * `DELETE_PENDING`, `DELETE_IN_PROGRESS`, `DELETE_FAILED`
3858
- # @return [String]
3859
4309
  #
3860
- # @!attribute [rw] message
3861
- # Information about any errors that may have occurred during the
3862
- # Explainability export.
4310
+ # <note markdown="1"> The `Status` of the what-if forecast export must be `ACTIVE` before
4311
+ # you can access the forecast export.
4312
+ #
4313
+ # </note>
3863
4314
  # @return [String]
3864
4315
  #
3865
4316
  # @!attribute [rw] creation_time
3866
- # When the Explainability was created.
4317
+ # When the what-if forecast export was created.
3867
4318
  # @return [Time]
3868
4319
  #
4320
+ # @!attribute [rw] estimated_time_remaining_in_minutes
4321
+ # The approximate time remaining to complete the what-if forecast
4322
+ # export, in minutes.
4323
+ # @return [Integer]
4324
+ #
3869
4325
  # @!attribute [rw] last_modification_time
3870
4326
  # The last time the resource was modified. The timestamp depends on
3871
4327
  # the status of the job:
@@ -3881,72 +4337,67 @@ module Aws::ForecastService
3881
4337
  # * `ACTIVE` or `CREATE_FAILED` - When the job finished or failed.
3882
4338
  # @return [Time]
3883
4339
  #
3884
- # @see http://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/ExplainabilityExportSummary AWS API Documentation
4340
+ # @!attribute [rw] format
4341
+ # The format of the exported data, CSV or PARQUET.
4342
+ # @return [String]
3885
4343
  #
3886
- class ExplainabilityExportSummary < Struct.new(
3887
- :explainability_export_arn,
3888
- :explainability_export_name,
4344
+ # @see http://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/DescribeWhatIfForecastExportResponse AWS API Documentation
4345
+ #
4346
+ class DescribeWhatIfForecastExportResponse < Struct.new(
4347
+ :what_if_forecast_export_arn,
4348
+ :what_if_forecast_export_name,
4349
+ :what_if_forecast_arns,
3889
4350
  :destination,
3890
- :status,
3891
4351
  :message,
4352
+ :status,
3892
4353
  :creation_time,
3893
- :last_modification_time)
4354
+ :estimated_time_remaining_in_minutes,
4355
+ :last_modification_time,
4356
+ :format)
3894
4357
  SENSITIVE = []
3895
4358
  include Aws::Structure
3896
4359
  end
3897
4360
 
3898
- # Provides information about the Explainability resource.
3899
- #
3900
- # @!attribute [rw] explainability_arn
3901
- # The Amazon Resource Name (ARN) of the Explainability.
3902
- # @return [String]
3903
- #
3904
- # @!attribute [rw] status
3905
- # The status of the Explainability. States include:
3906
- #
3907
- # * `ACTIVE`
3908
- #
3909
- # * `CREATE_PENDING`, `CREATE_IN_PROGRESS`, `CREATE_FAILED`
4361
+ # @note When making an API call, you may pass DescribeWhatIfForecastRequest
4362
+ # data as a hash:
3910
4363
  #
3911
- # * `CREATE_STOPPING`, `CREATE_STOPPED`
4364
+ # {
4365
+ # what_if_forecast_arn: "LongArn", # required
4366
+ # }
3912
4367
  #
3913
- # * `DELETE_PENDING`, `DELETE_IN_PROGRESS`, `DELETE_FAILED`
4368
+ # @!attribute [rw] what_if_forecast_arn
4369
+ # The Amazon Resource Name (ARN) of the what-if forecast that you are
4370
+ # interested in.
3914
4371
  # @return [String]
3915
4372
  #
3916
- # @see http://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/ExplainabilityInfo AWS API Documentation
4373
+ # @see http://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/DescribeWhatIfForecastRequest AWS API Documentation
3917
4374
  #
3918
- class ExplainabilityInfo < Struct.new(
3919
- :explainability_arn,
3920
- :status)
4375
+ class DescribeWhatIfForecastRequest < Struct.new(
4376
+ :what_if_forecast_arn)
3921
4377
  SENSITIVE = []
3922
4378
  include Aws::Structure
3923
4379
  end
3924
4380
 
3925
- # Provides a summary of the Explainability properties used in the
3926
- # ListExplainabilities operation. To get a complete set of properties,
3927
- # call the DescribeExplainability operation, and provide the listed
3928
- # `ExplainabilityArn`.
3929
- #
3930
- # @!attribute [rw] explainability_arn
3931
- # The Amazon Resource Name (ARN) of the Explainability.
4381
+ # @!attribute [rw] what_if_forecast_name
4382
+ # The name of the what-if forecast.
3932
4383
  # @return [String]
3933
4384
  #
3934
- # @!attribute [rw] explainability_name
3935
- # The name of the Explainability.
4385
+ # @!attribute [rw] what_if_forecast_arn
4386
+ # The Amazon Resource Name (ARN) of the what-if forecast.
3936
4387
  # @return [String]
3937
4388
  #
3938
- # @!attribute [rw] resource_arn
3939
- # The Amazon Resource Name (ARN) of the Predictor or Forecast used to
3940
- # create the Explainability.
4389
+ # @!attribute [rw] what_if_analysis_arn
4390
+ # The Amazon Resource Name (ARN) of the what-if analysis that contains
4391
+ # this forecast.
3941
4392
  # @return [String]
3942
4393
  #
3943
- # @!attribute [rw] explainability_config
3944
- # The configuration settings that define the granularity of time
3945
- # series and time points for the Explainability.
3946
- # @return [Types::ExplainabilityConfig]
4394
+ # @!attribute [rw] estimated_time_remaining_in_minutes
4395
+ # The approximate time remaining to complete the what-if forecast, in
4396
+ # minutes.
4397
+ # @return [Integer]
3947
4398
  #
3948
4399
  # @!attribute [rw] status
3949
- # The status of the Explainability. States include:
4400
+ # The status of the what-if forecast. States include:
3950
4401
  #
3951
4402
  # * `ACTIVE`
3952
4403
  #
@@ -3955,15 +4406,19 @@ module Aws::ForecastService
3955
4406
  # * `CREATE_STOPPING`, `CREATE_STOPPED`
3956
4407
  #
3957
4408
  # * `DELETE_PENDING`, `DELETE_IN_PROGRESS`, `DELETE_FAILED`
4409
+ #
4410
+ # <note markdown="1"> The `Status` of the what-if forecast must be `ACTIVE` before you can
4411
+ # access the forecast.
4412
+ #
4413
+ # </note>
3958
4414
  # @return [String]
3959
4415
  #
3960
4416
  # @!attribute [rw] message
3961
- # Information about any errors that may have occurred during the
3962
- # Explainability creation process.
4417
+ # If an error occurred, an informational message about the error.
3963
4418
  # @return [String]
3964
4419
  #
3965
4420
  # @!attribute [rw] creation_time
3966
- # When the Explainability was created.
4421
+ # When the what-if forecast was created.
3967
4422
  # @return [Time]
3968
4423
  #
3969
4424
  # @!attribute [rw] last_modification_time
@@ -3981,106 +4436,476 @@ module Aws::ForecastService
3981
4436
  # * `ACTIVE` or `CREATE_FAILED` - When the job finished or failed.
3982
4437
  # @return [Time]
3983
4438
  #
3984
- # @see http://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/ExplainabilitySummary AWS API Documentation
4439
+ # @!attribute [rw] time_series_transformations
4440
+ # An array of `Action` and `TimeSeriesConditions` elements that
4441
+ # describe what transformations were applied to which time series.
4442
+ # @return [Array<Types::TimeSeriesTransformation>]
3985
4443
  #
3986
- class ExplainabilitySummary < Struct.new(
3987
- :explainability_arn,
3988
- :explainability_name,
3989
- :resource_arn,
3990
- :explainability_config,
4444
+ # @!attribute [rw] time_series_replacements_data_source
4445
+ # An array of `S3Config`, `Schema`, and `Format` elements that
4446
+ # describe the replacement time series.
4447
+ # @return [Types::TimeSeriesReplacementsDataSource]
4448
+ #
4449
+ # @!attribute [rw] forecast_types
4450
+ # The quantiles at which probabilistic forecasts are generated. You
4451
+ # can specify up to 5 quantiles per what-if forecast in the
4452
+ # CreateWhatIfForecast operation. If you didn't specify quantiles,
4453
+ # the default values are `["0.1", "0.5", "0.9"]`.
4454
+ # @return [Array<String>]
4455
+ #
4456
+ # @see http://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/DescribeWhatIfForecastResponse AWS API Documentation
4457
+ #
4458
+ class DescribeWhatIfForecastResponse < Struct.new(
4459
+ :what_if_forecast_name,
4460
+ :what_if_forecast_arn,
4461
+ :what_if_analysis_arn,
4462
+ :estimated_time_remaining_in_minutes,
3991
4463
  :status,
3992
4464
  :message,
3993
4465
  :creation_time,
3994
- :last_modification_time)
4466
+ :last_modification_time,
4467
+ :time_series_transformations,
4468
+ :time_series_replacements_data_source,
4469
+ :forecast_types)
3995
4470
  SENSITIVE = []
3996
4471
  include Aws::Structure
3997
4472
  end
3998
4473
 
3999
- # <note markdown="1"> This object belongs to the CreatePredictor operation. If you created
4000
- # your predictor with CreateAutoPredictor, see AttributeConfig.
4474
+ # An AWS Key Management Service (KMS) key and an AWS Identity and Access
4475
+ # Management (IAM) role that Amazon Forecast can assume to access the
4476
+ # key. You can specify this optional object in the CreateDataset and
4477
+ # CreatePredictor requests.
4001
4478
  #
4002
- # </note>
4479
+ # @note When making an API call, you may pass EncryptionConfig
4480
+ # data as a hash:
4003
4481
  #
4004
- # Provides featurization (transformation) information for a dataset
4005
- # field. This object is part of the FeaturizationConfig object.
4482
+ # {
4483
+ # role_arn: "Arn", # required
4484
+ # kms_key_arn: "KMSKeyArn", # required
4485
+ # }
4006
4486
  #
4007
- # For example:
4487
+ # @!attribute [rw] role_arn
4488
+ # The ARN of the IAM role that Amazon Forecast can assume to access
4489
+ # the AWS KMS key.
4008
4490
  #
4009
- # `\{`
4491
+ # Passing a role across AWS accounts is not allowed. If you pass a
4492
+ # role that isn't in your account, you get an `InvalidInputException`
4493
+ # error.
4494
+ # @return [String]
4010
4495
  #
4011
- # `"AttributeName": "demand",`
4496
+ # @!attribute [rw] kms_key_arn
4497
+ # The Amazon Resource Name (ARN) of the KMS key.
4498
+ # @return [String]
4012
4499
  #
4013
- # `FeaturizationPipeline [ \{`
4500
+ # @see http://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/EncryptionConfig AWS API Documentation
4014
4501
  #
4015
- # `"FeaturizationMethodName": "filling",`
4502
+ class EncryptionConfig < Struct.new(
4503
+ :role_arn,
4504
+ :kms_key_arn)
4505
+ SENSITIVE = []
4506
+ include Aws::Structure
4507
+ end
4508
+
4509
+ # Provides detailed error metrics to evaluate the performance of a
4510
+ # predictor. This object is part of the Metrics object.
4016
4511
  #
4017
- # `"FeaturizationMethodParameters": \{"aggregation": "avg", "backfill":
4018
- # "nan"\}`
4512
+ # @!attribute [rw] forecast_type
4513
+ # The Forecast type used to compute WAPE, MAPE, MASE, and RMSE.
4514
+ # @return [String]
4019
4515
  #
4020
- # `\} ]`
4516
+ # @!attribute [rw] wape
4517
+ # The weighted absolute percentage error (WAPE).
4518
+ # @return [Float]
4021
4519
  #
4022
- # `\}`
4520
+ # @!attribute [rw] rmse
4521
+ # The root-mean-square error (RMSE).
4522
+ # @return [Float]
4023
4523
  #
4024
- # @note When making an API call, you may pass Featurization
4524
+ # @!attribute [rw] mase
4525
+ # The Mean Absolute Scaled Error (MASE)
4526
+ # @return [Float]
4527
+ #
4528
+ # @!attribute [rw] mape
4529
+ # The Mean Absolute Percentage Error (MAPE)
4530
+ # @return [Float]
4531
+ #
4532
+ # @see http://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/ErrorMetric AWS API Documentation
4533
+ #
4534
+ class ErrorMetric < Struct.new(
4535
+ :forecast_type,
4536
+ :wape,
4537
+ :rmse,
4538
+ :mase,
4539
+ :mape)
4540
+ SENSITIVE = []
4541
+ include Aws::Structure
4542
+ end
4543
+
4544
+ # Parameters that define how to split a dataset into training data and
4545
+ # testing data, and the number of iterations to perform. These
4546
+ # parameters are specified in the predefined algorithms but you can
4547
+ # override them in the CreatePredictor request.
4548
+ #
4549
+ # @note When making an API call, you may pass EvaluationParameters
4025
4550
  # data as a hash:
4026
4551
  #
4027
4552
  # {
4028
- # attribute_name: "Name", # required
4029
- # featurization_pipeline: [
4030
- # {
4031
- # featurization_method_name: "filling", # required, accepts filling
4032
- # featurization_method_parameters: {
4033
- # "ParameterKey" => "ParameterValue",
4034
- # },
4035
- # },
4036
- # ],
4553
+ # number_of_backtest_windows: 1,
4554
+ # back_test_window_offset: 1,
4037
4555
  # }
4038
4556
  #
4039
- # @!attribute [rw] attribute_name
4040
- # The name of the schema attribute that specifies the data field to be
4041
- # featurized. Amazon Forecast supports the target field of the
4042
- # `TARGET_TIME_SERIES` and the `RELATED_TIME_SERIES` datasets. For
4043
- # example, for the `RETAIL` domain, the target is `demand`, and for
4044
- # the `CUSTOM` domain, the target is `target_value`. For more
4045
- # information, see howitworks-missing-values.
4046
- # @return [String]
4557
+ # @!attribute [rw] number_of_backtest_windows
4558
+ # The number of times to split the input data. The default is 1. Valid
4559
+ # values are 1 through 5.
4560
+ # @return [Integer]
4047
4561
  #
4048
- # @!attribute [rw] featurization_pipeline
4049
- # An array of one `FeaturizationMethod` object that specifies the
4050
- # feature transformation method.
4051
- # @return [Array<Types::FeaturizationMethod>]
4562
+ # @!attribute [rw] back_test_window_offset
4563
+ # The point from the end of the dataset where you want to split the
4564
+ # data for model training and testing (evaluation). Specify the value
4565
+ # as the number of data points. The default is the value of the
4566
+ # forecast horizon. `BackTestWindowOffset` can be used to mimic a past
4567
+ # virtual forecast start date. This value must be greater than or
4568
+ # equal to the forecast horizon and less than half of the
4569
+ # TARGET\_TIME\_SERIES dataset length.
4052
4570
  #
4053
- # @see http://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/Featurization AWS API Documentation
4571
+ # `ForecastHorizon` &lt;= `BackTestWindowOffset` &lt; 1/2 *
4572
+ # TARGET\_TIME\_SERIES dataset length
4573
+ # @return [Integer]
4054
4574
  #
4055
- class Featurization < Struct.new(
4056
- :attribute_name,
4057
- :featurization_pipeline)
4575
+ # @see http://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/EvaluationParameters AWS API Documentation
4576
+ #
4577
+ class EvaluationParameters < Struct.new(
4578
+ :number_of_backtest_windows,
4579
+ :back_test_window_offset)
4058
4580
  SENSITIVE = []
4059
4581
  include Aws::Structure
4060
4582
  end
4061
4583
 
4062
- # <note markdown="1"> This object belongs to the CreatePredictor operation. If you created
4063
- # your predictor with CreateAutoPredictor, see AttributeConfig.
4584
+ # The results of evaluating an algorithm. Returned as part of the
4585
+ # GetAccuracyMetrics response.
4064
4586
  #
4065
- # </note>
4587
+ # @!attribute [rw] algorithm_arn
4588
+ # The Amazon Resource Name (ARN) of the algorithm that was evaluated.
4589
+ # @return [String]
4066
4590
  #
4067
- # In a CreatePredictor operation, the specified algorithm trains a model
4068
- # using the specified dataset group. You can optionally tell the
4069
- # operation to modify data fields prior to training a model. These
4070
- # modifications are referred to as *featurization*.
4591
+ # @!attribute [rw] test_windows
4592
+ # The array of test windows used for evaluating the algorithm. The
4593
+ # `NumberOfBacktestWindows` from the EvaluationParameters object
4594
+ # determines the number of windows in the array.
4595
+ # @return [Array<Types::WindowSummary>]
4071
4596
  #
4072
- # You define featurization using the `FeaturizationConfig` object. You
4073
- # specify an array of transformations, one for each field that you want
4074
- # to featurize. You then include the `FeaturizationConfig` object in
4075
- # your `CreatePredictor` request. Amazon Forecast applies the
4076
- # featurization to the `TARGET_TIME_SERIES` and `RELATED_TIME_SERIES`
4077
- # datasets before model training.
4597
+ # @see http://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/EvaluationResult AWS API Documentation
4078
4598
  #
4079
- # You can create multiple featurization configurations. For example, you
4080
- # might call the `CreatePredictor` operation twice by specifying
4081
- # different featurization configurations.
4599
+ class EvaluationResult < Struct.new(
4600
+ :algorithm_arn,
4601
+ :test_windows)
4602
+ SENSITIVE = []
4603
+ include Aws::Structure
4604
+ end
4605
+
4606
+ # The ExplainabilityConfig data type defines the number of time series
4607
+ # and time points included in CreateExplainability.
4082
4608
  #
4083
- # @note When making an API call, you may pass FeaturizationConfig
4609
+ # If you provide a predictor ARN for `ResourceArn`, you must set both
4610
+ # `TimePointGranularity` and `TimeSeriesGranularity` to “ALL”. When
4611
+ # creating Predictor Explainability, Amazon Forecast considers all time
4612
+ # series and time points.
4613
+ #
4614
+ # If you provide a forecast ARN for `ResourceArn`, you can set
4615
+ # `TimePointGranularity` and `TimeSeriesGranularity` to either “ALL” or
4616
+ # “Specific”.
4617
+ #
4618
+ # @note When making an API call, you may pass ExplainabilityConfig
4619
+ # data as a hash:
4620
+ #
4621
+ # {
4622
+ # time_series_granularity: "ALL", # required, accepts ALL, SPECIFIC
4623
+ # time_point_granularity: "ALL", # required, accepts ALL, SPECIFIC
4624
+ # }
4625
+ #
4626
+ # @!attribute [rw] time_series_granularity
4627
+ # To create an Explainability for all time series in your datasets,
4628
+ # use `ALL`. To create an Explainability for specific time series in
4629
+ # your datasets, use `SPECIFIC`.
4630
+ #
4631
+ # Specify time series by uploading a CSV or Parquet file to an Amazon
4632
+ # S3 bucket and set the location within the DataDestination data type.
4633
+ # @return [String]
4634
+ #
4635
+ # @!attribute [rw] time_point_granularity
4636
+ # To create an Explainability for all time points in your forecast
4637
+ # horizon, use `ALL`. To create an Explainability for specific time
4638
+ # points in your forecast horizon, use `SPECIFIC`.
4639
+ #
4640
+ # Specify time points with the `StartDateTime` and `EndDateTime`
4641
+ # parameters within the CreateExplainability operation.
4642
+ # @return [String]
4643
+ #
4644
+ # @see http://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/ExplainabilityConfig AWS API Documentation
4645
+ #
4646
+ class ExplainabilityConfig < Struct.new(
4647
+ :time_series_granularity,
4648
+ :time_point_granularity)
4649
+ SENSITIVE = []
4650
+ include Aws::Structure
4651
+ end
4652
+
4653
+ # Provides a summary of the Explainability export properties used in the
4654
+ # ListExplainabilityExports operation. To get a complete set of
4655
+ # properties, call the DescribeExplainabilityExport operation, and
4656
+ # provide the `ExplainabilityExportArn`.
4657
+ #
4658
+ # @!attribute [rw] explainability_export_arn
4659
+ # The Amazon Resource Name (ARN) of the Explainability export.
4660
+ # @return [String]
4661
+ #
4662
+ # @!attribute [rw] explainability_export_name
4663
+ # The name of the Explainability export
4664
+ # @return [String]
4665
+ #
4666
+ # @!attribute [rw] destination
4667
+ # The destination for an export job. Provide an S3 path, an AWS
4668
+ # Identity and Access Management (IAM) role that allows Amazon
4669
+ # Forecast to access the location, and an AWS Key Management Service
4670
+ # (KMS) key (optional).
4671
+ # @return [Types::DataDestination]
4672
+ #
4673
+ # @!attribute [rw] status
4674
+ # The status of the Explainability export. States include:
4675
+ #
4676
+ # * `ACTIVE`
4677
+ #
4678
+ # * `CREATE_PENDING`, `CREATE_IN_PROGRESS`, `CREATE_FAILED`
4679
+ #
4680
+ # * `CREATE_STOPPING`, `CREATE_STOPPED`
4681
+ #
4682
+ # * `DELETE_PENDING`, `DELETE_IN_PROGRESS`, `DELETE_FAILED`
4683
+ # @return [String]
4684
+ #
4685
+ # @!attribute [rw] message
4686
+ # Information about any errors that may have occurred during the
4687
+ # Explainability export.
4688
+ # @return [String]
4689
+ #
4690
+ # @!attribute [rw] creation_time
4691
+ # When the Explainability was created.
4692
+ # @return [Time]
4693
+ #
4694
+ # @!attribute [rw] last_modification_time
4695
+ # The last time the resource was modified. The timestamp depends on
4696
+ # the status of the job:
4697
+ #
4698
+ # * `CREATE_PENDING` - The `CreationTime`.
4699
+ #
4700
+ # * `CREATE_IN_PROGRESS` - The current timestamp.
4701
+ #
4702
+ # * `CREATE_STOPPING` - The current timestamp.
4703
+ #
4704
+ # * `CREATE_STOPPED` - When the job stopped.
4705
+ #
4706
+ # * `ACTIVE` or `CREATE_FAILED` - When the job finished or failed.
4707
+ # @return [Time]
4708
+ #
4709
+ # @see http://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/ExplainabilityExportSummary AWS API Documentation
4710
+ #
4711
+ class ExplainabilityExportSummary < Struct.new(
4712
+ :explainability_export_arn,
4713
+ :explainability_export_name,
4714
+ :destination,
4715
+ :status,
4716
+ :message,
4717
+ :creation_time,
4718
+ :last_modification_time)
4719
+ SENSITIVE = []
4720
+ include Aws::Structure
4721
+ end
4722
+
4723
+ # Provides information about the Explainability resource.
4724
+ #
4725
+ # @!attribute [rw] explainability_arn
4726
+ # The Amazon Resource Name (ARN) of the Explainability.
4727
+ # @return [String]
4728
+ #
4729
+ # @!attribute [rw] status
4730
+ # The status of the Explainability. States include:
4731
+ #
4732
+ # * `ACTIVE`
4733
+ #
4734
+ # * `CREATE_PENDING`, `CREATE_IN_PROGRESS`, `CREATE_FAILED`
4735
+ #
4736
+ # * `CREATE_STOPPING`, `CREATE_STOPPED`
4737
+ #
4738
+ # * `DELETE_PENDING`, `DELETE_IN_PROGRESS`, `DELETE_FAILED`
4739
+ # @return [String]
4740
+ #
4741
+ # @see http://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/ExplainabilityInfo AWS API Documentation
4742
+ #
4743
+ class ExplainabilityInfo < Struct.new(
4744
+ :explainability_arn,
4745
+ :status)
4746
+ SENSITIVE = []
4747
+ include Aws::Structure
4748
+ end
4749
+
4750
+ # Provides a summary of the Explainability properties used in the
4751
+ # ListExplainabilities operation. To get a complete set of properties,
4752
+ # call the DescribeExplainability operation, and provide the listed
4753
+ # `ExplainabilityArn`.
4754
+ #
4755
+ # @!attribute [rw] explainability_arn
4756
+ # The Amazon Resource Name (ARN) of the Explainability.
4757
+ # @return [String]
4758
+ #
4759
+ # @!attribute [rw] explainability_name
4760
+ # The name of the Explainability.
4761
+ # @return [String]
4762
+ #
4763
+ # @!attribute [rw] resource_arn
4764
+ # The Amazon Resource Name (ARN) of the Predictor or Forecast used to
4765
+ # create the Explainability.
4766
+ # @return [String]
4767
+ #
4768
+ # @!attribute [rw] explainability_config
4769
+ # The configuration settings that define the granularity of time
4770
+ # series and time points for the Explainability.
4771
+ # @return [Types::ExplainabilityConfig]
4772
+ #
4773
+ # @!attribute [rw] status
4774
+ # The status of the Explainability. States include:
4775
+ #
4776
+ # * `ACTIVE`
4777
+ #
4778
+ # * `CREATE_PENDING`, `CREATE_IN_PROGRESS`, `CREATE_FAILED`
4779
+ #
4780
+ # * `CREATE_STOPPING`, `CREATE_STOPPED`
4781
+ #
4782
+ # * `DELETE_PENDING`, `DELETE_IN_PROGRESS`, `DELETE_FAILED`
4783
+ # @return [String]
4784
+ #
4785
+ # @!attribute [rw] message
4786
+ # Information about any errors that may have occurred during the
4787
+ # Explainability creation process.
4788
+ # @return [String]
4789
+ #
4790
+ # @!attribute [rw] creation_time
4791
+ # When the Explainability was created.
4792
+ # @return [Time]
4793
+ #
4794
+ # @!attribute [rw] last_modification_time
4795
+ # The last time the resource was modified. The timestamp depends on
4796
+ # the status of the job:
4797
+ #
4798
+ # * `CREATE_PENDING` - The `CreationTime`.
4799
+ #
4800
+ # * `CREATE_IN_PROGRESS` - The current timestamp.
4801
+ #
4802
+ # * `CREATE_STOPPING` - The current timestamp.
4803
+ #
4804
+ # * `CREATE_STOPPED` - When the job stopped.
4805
+ #
4806
+ # * `ACTIVE` or `CREATE_FAILED` - When the job finished or failed.
4807
+ # @return [Time]
4808
+ #
4809
+ # @see http://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/ExplainabilitySummary AWS API Documentation
4810
+ #
4811
+ class ExplainabilitySummary < Struct.new(
4812
+ :explainability_arn,
4813
+ :explainability_name,
4814
+ :resource_arn,
4815
+ :explainability_config,
4816
+ :status,
4817
+ :message,
4818
+ :creation_time,
4819
+ :last_modification_time)
4820
+ SENSITIVE = []
4821
+ include Aws::Structure
4822
+ end
4823
+
4824
+ # <note markdown="1"> This object belongs to the CreatePredictor operation. If you created
4825
+ # your predictor with CreateAutoPredictor, see AttributeConfig.
4826
+ #
4827
+ # </note>
4828
+ #
4829
+ # Provides featurization (transformation) information for a dataset
4830
+ # field. This object is part of the FeaturizationConfig object.
4831
+ #
4832
+ # For example:
4833
+ #
4834
+ # `\{`
4835
+ #
4836
+ # `"AttributeName": "demand",`
4837
+ #
4838
+ # `FeaturizationPipeline [ \{`
4839
+ #
4840
+ # `"FeaturizationMethodName": "filling",`
4841
+ #
4842
+ # `"FeaturizationMethodParameters": \{"aggregation": "avg", "backfill":
4843
+ # "nan"\}`
4844
+ #
4845
+ # `\} ]`
4846
+ #
4847
+ # `\}`
4848
+ #
4849
+ # @note When making an API call, you may pass Featurization
4850
+ # data as a hash:
4851
+ #
4852
+ # {
4853
+ # attribute_name: "Name", # required
4854
+ # featurization_pipeline: [
4855
+ # {
4856
+ # featurization_method_name: "filling", # required, accepts filling
4857
+ # featurization_method_parameters: {
4858
+ # "ParameterKey" => "ParameterValue",
4859
+ # },
4860
+ # },
4861
+ # ],
4862
+ # }
4863
+ #
4864
+ # @!attribute [rw] attribute_name
4865
+ # The name of the schema attribute that specifies the data field to be
4866
+ # featurized. Amazon Forecast supports the target field of the
4867
+ # `TARGET_TIME_SERIES` and the `RELATED_TIME_SERIES` datasets. For
4868
+ # example, for the `RETAIL` domain, the target is `demand`, and for
4869
+ # the `CUSTOM` domain, the target is `target_value`. For more
4870
+ # information, see howitworks-missing-values.
4871
+ # @return [String]
4872
+ #
4873
+ # @!attribute [rw] featurization_pipeline
4874
+ # An array of one `FeaturizationMethod` object that specifies the
4875
+ # feature transformation method.
4876
+ # @return [Array<Types::FeaturizationMethod>]
4877
+ #
4878
+ # @see http://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/Featurization AWS API Documentation
4879
+ #
4880
+ class Featurization < Struct.new(
4881
+ :attribute_name,
4882
+ :featurization_pipeline)
4883
+ SENSITIVE = []
4884
+ include Aws::Structure
4885
+ end
4886
+
4887
+ # <note markdown="1"> This object belongs to the CreatePredictor operation. If you created
4888
+ # your predictor with CreateAutoPredictor, see AttributeConfig.
4889
+ #
4890
+ # </note>
4891
+ #
4892
+ # In a CreatePredictor operation, the specified algorithm trains a model
4893
+ # using the specified dataset group. You can optionally tell the
4894
+ # operation to modify data fields prior to training a model. These
4895
+ # modifications are referred to as *featurization*.
4896
+ #
4897
+ # You define featurization using the `FeaturizationConfig` object. You
4898
+ # specify an array of transformations, one for each field that you want
4899
+ # to featurize. You then include the `FeaturizationConfig` object in
4900
+ # your `CreatePredictor` request. Amazon Forecast applies the
4901
+ # featurization to the `TARGET_TIME_SERIES` and `RELATED_TIME_SERIES`
4902
+ # datasets before model training.
4903
+ #
4904
+ # You can create multiple featurization configurations. For example, you
4905
+ # might call the `CreatePredictor` operation twice by specifying
4906
+ # different featurization configurations.
4907
+ #
4908
+ # @note When making an API call, you may pass FeaturizationConfig
4084
4909
  # data as a hash:
4085
4910
  #
4086
4911
  # {
@@ -5398,7 +6223,281 @@ module Aws::ForecastService
5398
6223
  include Aws::Structure
5399
6224
  end
5400
6225
 
5401
- # @note When making an API call, you may pass ListPredictorsRequest
6226
+ # @note When making an API call, you may pass ListPredictorsRequest
6227
+ # data as a hash:
6228
+ #
6229
+ # {
6230
+ # next_token: "NextToken",
6231
+ # max_results: 1,
6232
+ # filters: [
6233
+ # {
6234
+ # key: "String", # required
6235
+ # value: "Arn", # required
6236
+ # condition: "IS", # required, accepts IS, IS_NOT
6237
+ # },
6238
+ # ],
6239
+ # }
6240
+ #
6241
+ # @!attribute [rw] next_token
6242
+ # If the result of the previous request was truncated, the response
6243
+ # includes a `NextToken`. To retrieve the next set of results, use the
6244
+ # token in the next request. Tokens expire after 24 hours.
6245
+ # @return [String]
6246
+ #
6247
+ # @!attribute [rw] max_results
6248
+ # The number of items to return in the response.
6249
+ # @return [Integer]
6250
+ #
6251
+ # @!attribute [rw] filters
6252
+ # An array of filters. For each filter, you provide a condition and a
6253
+ # match statement. The condition is either `IS` or `IS_NOT`, which
6254
+ # specifies whether to include or exclude the predictors that match
6255
+ # the statement from the list, respectively. The match statement
6256
+ # consists of a key and a value.
6257
+ #
6258
+ # **Filter properties**
6259
+ #
6260
+ # * `Condition` - The condition to apply. Valid values are `IS` and
6261
+ # `IS_NOT`. To include the predictors that match the statement,
6262
+ # specify `IS`. To exclude matching predictors, specify `IS_NOT`.
6263
+ #
6264
+ # * `Key` - The name of the parameter to filter on. Valid values are
6265
+ # `DatasetGroupArn` and `Status`.
6266
+ #
6267
+ # * `Value` - The value to match.
6268
+ #
6269
+ # For example, to list all predictors whose status is ACTIVE, you
6270
+ # would specify:
6271
+ #
6272
+ # `"Filters": [ \{ "Condition": "IS", "Key": "Status", "Value":
6273
+ # "ACTIVE" \} ]`
6274
+ # @return [Array<Types::Filter>]
6275
+ #
6276
+ # @see http://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/ListPredictorsRequest AWS API Documentation
6277
+ #
6278
+ class ListPredictorsRequest < Struct.new(
6279
+ :next_token,
6280
+ :max_results,
6281
+ :filters)
6282
+ SENSITIVE = []
6283
+ include Aws::Structure
6284
+ end
6285
+
6286
+ # @!attribute [rw] predictors
6287
+ # An array of objects that summarize each predictor's properties.
6288
+ # @return [Array<Types::PredictorSummary>]
6289
+ #
6290
+ # @!attribute [rw] next_token
6291
+ # If the response is truncated, Amazon Forecast returns this token. To
6292
+ # retrieve the next set of results, use the token in the next request.
6293
+ # @return [String]
6294
+ #
6295
+ # @see http://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/ListPredictorsResponse AWS API Documentation
6296
+ #
6297
+ class ListPredictorsResponse < Struct.new(
6298
+ :predictors,
6299
+ :next_token)
6300
+ SENSITIVE = []
6301
+ include Aws::Structure
6302
+ end
6303
+
6304
+ # @note When making an API call, you may pass ListTagsForResourceRequest
6305
+ # data as a hash:
6306
+ #
6307
+ # {
6308
+ # resource_arn: "Arn", # required
6309
+ # }
6310
+ #
6311
+ # @!attribute [rw] resource_arn
6312
+ # The Amazon Resource Name (ARN) that identifies the resource for
6313
+ # which to list the tags.
6314
+ # @return [String]
6315
+ #
6316
+ # @see http://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/ListTagsForResourceRequest AWS API Documentation
6317
+ #
6318
+ class ListTagsForResourceRequest < Struct.new(
6319
+ :resource_arn)
6320
+ SENSITIVE = []
6321
+ include Aws::Structure
6322
+ end
6323
+
6324
+ # @!attribute [rw] tags
6325
+ # The tags for the resource.
6326
+ # @return [Array<Types::Tag>]
6327
+ #
6328
+ # @see http://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/ListTagsForResourceResponse AWS API Documentation
6329
+ #
6330
+ class ListTagsForResourceResponse < Struct.new(
6331
+ :tags)
6332
+ SENSITIVE = []
6333
+ include Aws::Structure
6334
+ end
6335
+
6336
+ # @note When making an API call, you may pass ListWhatIfAnalysesRequest
6337
+ # data as a hash:
6338
+ #
6339
+ # {
6340
+ # next_token: "NextToken",
6341
+ # max_results: 1,
6342
+ # filters: [
6343
+ # {
6344
+ # key: "String", # required
6345
+ # value: "Arn", # required
6346
+ # condition: "IS", # required, accepts IS, IS_NOT
6347
+ # },
6348
+ # ],
6349
+ # }
6350
+ #
6351
+ # @!attribute [rw] next_token
6352
+ # If the result of the previous request was truncated, the response
6353
+ # includes a `NextToken`. To retrieve the next set of results, use the
6354
+ # token in the next request. Tokens expire after 24 hours.
6355
+ # @return [String]
6356
+ #
6357
+ # @!attribute [rw] max_results
6358
+ # The number of items to return in the response.
6359
+ # @return [Integer]
6360
+ #
6361
+ # @!attribute [rw] filters
6362
+ # An array of filters. For each filter, you provide a condition and a
6363
+ # match statement. The condition is either `IS` or `IS_NOT`, which
6364
+ # specifies whether to include or exclude the what-if analysis jobs
6365
+ # that match the statement from the list, respectively. The match
6366
+ # statement consists of a key and a value.
6367
+ #
6368
+ # **Filter properties**
6369
+ #
6370
+ # * `Condition` - The condition to apply. Valid values are `IS` and
6371
+ # `IS_NOT`. To include the what-if analysis jobs that match the
6372
+ # statement, specify `IS`. To exclude matching what-if analysis
6373
+ # jobs, specify `IS_NOT`.
6374
+ #
6375
+ # * `Key` - The name of the parameter to filter on. Valid values are
6376
+ # `WhatIfAnalysisArn` and `Status`.
6377
+ #
6378
+ # * `Value` - The value to match.
6379
+ #
6380
+ # For example, to list all jobs that export a forecast named
6381
+ # *electricityWhatIf*, specify the following filter:
6382
+ #
6383
+ # `"Filters": [ \{ "Condition": "IS", "Key": "WhatIfAnalysisArn",
6384
+ # "Value":
6385
+ # "arn:aws:forecast:us-west-2:<acct-id>:forecast/electricityWhatIf" \}
6386
+ # ]`
6387
+ # @return [Array<Types::Filter>]
6388
+ #
6389
+ # @see http://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/ListWhatIfAnalysesRequest AWS API Documentation
6390
+ #
6391
+ class ListWhatIfAnalysesRequest < Struct.new(
6392
+ :next_token,
6393
+ :max_results,
6394
+ :filters)
6395
+ SENSITIVE = []
6396
+ include Aws::Structure
6397
+ end
6398
+
6399
+ # @!attribute [rw] what_if_analyses
6400
+ # An array of `WhatIfAnalysisSummary` objects that describe the
6401
+ # matched analyses.
6402
+ # @return [Array<Types::WhatIfAnalysisSummary>]
6403
+ #
6404
+ # @!attribute [rw] next_token
6405
+ # If the response is truncated, Forecast returns this token. To
6406
+ # retrieve the next set of results, use the token in the next request.
6407
+ # @return [String]
6408
+ #
6409
+ # @see http://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/ListWhatIfAnalysesResponse AWS API Documentation
6410
+ #
6411
+ class ListWhatIfAnalysesResponse < Struct.new(
6412
+ :what_if_analyses,
6413
+ :next_token)
6414
+ SENSITIVE = []
6415
+ include Aws::Structure
6416
+ end
6417
+
6418
+ # @note When making an API call, you may pass ListWhatIfForecastExportsRequest
6419
+ # data as a hash:
6420
+ #
6421
+ # {
6422
+ # next_token: "NextToken",
6423
+ # max_results: 1,
6424
+ # filters: [
6425
+ # {
6426
+ # key: "String", # required
6427
+ # value: "Arn", # required
6428
+ # condition: "IS", # required, accepts IS, IS_NOT
6429
+ # },
6430
+ # ],
6431
+ # }
6432
+ #
6433
+ # @!attribute [rw] next_token
6434
+ # If the result of the previous request was truncated, the response
6435
+ # includes a `NextToken`. To retrieve the next set of results, use the
6436
+ # token in the next
 request. Tokens expire after 24 hours.
6437
+ # @return [String]
6438
+ #
6439
+ # @!attribute [rw] max_results
6440
+ # The number of items to return in the response.
6441
+ # @return [Integer]
6442
+ #
6443
+ # @!attribute [rw] filters
6444
+ # An array of filters. For each filter, you provide a condition and a
6445
+ # match statement. The condition is either `IS` or `IS_NOT`, which
6446
+ # specifies whether to include or exclude the what-if forecast export
6447
+ # jobs that match the statement from the list, respectively. The match
6448
+ # statement consists of a key and a value.
6449
+ #
6450
+ # **Filter properties**
6451
+ #
6452
+ # * `Condition` - The condition to apply. Valid values are `IS` and
6453
+ # `IS_NOT`. To include the forecast export jobs that match the
6454
+ # statement, specify `IS`. To exclude matching forecast export jobs,
6455
+ # specify `IS_NOT`.
6456
+ #
6457
+ # * `Key` - The name of the parameter to filter on. Valid values are
6458
+ # `WhatIfForecastExportArn` and `Status`.
6459
+ #
6460
+ # * `Value` - The value to match.
6461
+ #
6462
+ # For example, to list all jobs that export a forecast named
6463
+ # *electricityWIFExport*, specify the following filter:
6464
+ #
6465
+ # `"Filters": [ \{ "Condition": "IS", "Key":
6466
+ # "WhatIfForecastExportArn", "Value":
6467
+ # "arn:aws:forecast:us-west-2:<acct-id>:forecast/electricityWIFExport"
6468
+ # \} ]`
6469
+ # @return [Array<Types::Filter>]
6470
+ #
6471
+ # @see http://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/ListWhatIfForecastExportsRequest AWS API Documentation
6472
+ #
6473
+ class ListWhatIfForecastExportsRequest < Struct.new(
6474
+ :next_token,
6475
+ :max_results,
6476
+ :filters)
6477
+ SENSITIVE = []
6478
+ include Aws::Structure
6479
+ end
6480
+
6481
+ # @!attribute [rw] what_if_forecast_exports
6482
+ # An array of `WhatIfForecastExports` objects that describe the
6483
+ # matched forecast exports.
6484
+ # @return [Array<Types::WhatIfForecastExportSummary>]
6485
+ #
6486
+ # @!attribute [rw] next_token
6487
+ # If the response is truncated, Forecast returns this token. To
6488
+ # retrieve the next set of results, use the token in the next request.
6489
+ # @return [String]
6490
+ #
6491
+ # @see http://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/ListWhatIfForecastExportsResponse AWS API Documentation
6492
+ #
6493
+ class ListWhatIfForecastExportsResponse < Struct.new(
6494
+ :what_if_forecast_exports,
6495
+ :next_token)
6496
+ SENSITIVE = []
6497
+ include Aws::Structure
6498
+ end
6499
+
6500
+ # @note When making an API call, you may pass ListWhatIfForecastsRequest
5402
6501
  # data as a hash:
5403
6502
  #
5404
6503
  # {
@@ -5416,7 +6515,7 @@ module Aws::ForecastService
5416
6515
  # @!attribute [rw] next_token
5417
6516
  # If the result of the previous request was truncated, the response
5418
6517
  # includes a `NextToken`. To retrieve the next set of results, use the
5419
- # token in the next request. Tokens expire after 24 hours.
6518
+ # token in the nextrequest. Tokens expire after 24 hours.
5420
6519
  # @return [String]
5421
6520
  #
5422
6521
  # @!attribute [rw] max_results
@@ -5426,31 +6525,34 @@ module Aws::ForecastService
5426
6525
  # @!attribute [rw] filters
5427
6526
  # An array of filters. For each filter, you provide a condition and a
5428
6527
  # match statement. The condition is either `IS` or `IS_NOT`, which
5429
- # specifies whether to include or exclude the predictors that match
5430
- # the statement from the list, respectively. The match statement
5431
- # consists of a key and a value.
6528
+ # specifies whether to include or exclude the what-if forecast export
6529
+ # jobs that match the statement from the list, respectively. The match
6530
+ # statement consists of a key and a value.
5432
6531
  #
5433
6532
  # **Filter properties**
5434
6533
  #
5435
6534
  # * `Condition` - The condition to apply. Valid values are `IS` and
5436
- # `IS_NOT`. To include the predictors that match the statement,
5437
- # specify `IS`. To exclude matching predictors, specify `IS_NOT`.
6535
+ # `IS_NOT`. To include the forecast export jobs that match the
6536
+ # statement, specify `IS`. To exclude matching forecast export jobs,
6537
+ # specify `IS_NOT`.
5438
6538
  #
5439
6539
  # * `Key` - The name of the parameter to filter on. Valid values are
5440
- # `DatasetGroupArn` and `Status`.
6540
+ # `WhatIfForecastArn` and `Status`.
5441
6541
  #
5442
6542
  # * `Value` - The value to match.
5443
6543
  #
5444
- # For example, to list all predictors whose status is ACTIVE, you
5445
- # would specify:
6544
+ # For example, to list all jobs that export a forecast named
6545
+ # *electricityWhatIfForecast*, specify the following filter:
5446
6546
  #
5447
- # `"Filters": [ \{ "Condition": "IS", "Key": "Status", "Value":
5448
- # "ACTIVE" \} ]`
6547
+ # `"Filters": [ \{ "Condition": "IS", "Key": "WhatIfForecastArn",
6548
+ # "Value":
6549
+ # "arn:aws:forecast:us-west-2:<acct-id>:forecast/electricityWhatIfForecast"
6550
+ # \} ]`
5449
6551
  # @return [Array<Types::Filter>]
5450
6552
  #
5451
- # @see http://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/ListPredictorsRequest AWS API Documentation
6553
+ # @see http://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/ListWhatIfForecastsRequest AWS API Documentation
5452
6554
  #
5453
- class ListPredictorsRequest < Struct.new(
6555
+ class ListWhatIfForecastsRequest < Struct.new(
5454
6556
  :next_token,
5455
6557
  :max_results,
5456
6558
  :filters)
@@ -5458,56 +6560,26 @@ module Aws::ForecastService
5458
6560
  include Aws::Structure
5459
6561
  end
5460
6562
 
5461
- # @!attribute [rw] predictors
5462
- # An array of objects that summarize each predictor's properties.
5463
- # @return [Array<Types::PredictorSummary>]
6563
+ # @!attribute [rw] what_if_forecasts
6564
+ # An array of `WhatIfForecasts` objects that describe the matched
6565
+ # forecasts.
6566
+ # @return [Array<Types::WhatIfForecastSummary>]
5464
6567
  #
5465
6568
  # @!attribute [rw] next_token
5466
- # If the response is truncated, Amazon Forecast returns this token. To
5467
- # retrieve the next set of results, use the token in the next request.
6569
+ # If the result of the previous request was truncated, the response
6570
+ # includes a `NextToken`. To retrieve the next set of results, use the
6571
+ # token in the next
 request. Tokens expire after 24 hours.
5468
6572
  # @return [String]
5469
6573
  #
5470
- # @see http://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/ListPredictorsResponse AWS API Documentation
6574
+ # @see http://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/ListWhatIfForecastsResponse AWS API Documentation
5471
6575
  #
5472
- class ListPredictorsResponse < Struct.new(
5473
- :predictors,
6576
+ class ListWhatIfForecastsResponse < Struct.new(
6577
+ :what_if_forecasts,
5474
6578
  :next_token)
5475
6579
  SENSITIVE = []
5476
6580
  include Aws::Structure
5477
6581
  end
5478
6582
 
5479
- # @note When making an API call, you may pass ListTagsForResourceRequest
5480
- # data as a hash:
5481
- #
5482
- # {
5483
- # resource_arn: "Arn", # required
5484
- # }
5485
- #
5486
- # @!attribute [rw] resource_arn
5487
- # The Amazon Resource Name (ARN) that identifies the resource for
5488
- # which to list the tags.
5489
- # @return [String]
5490
- #
5491
- # @see http://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/ListTagsForResourceRequest AWS API Documentation
5492
- #
5493
- class ListTagsForResourceRequest < Struct.new(
5494
- :resource_arn)
5495
- SENSITIVE = []
5496
- include Aws::Structure
5497
- end
5498
-
5499
- # @!attribute [rw] tags
5500
- # The tags for the resource.
5501
- # @return [Array<Types::Tag>]
5502
- #
5503
- # @see http://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/ListTagsForResourceResponse AWS API Documentation
5504
- #
5505
- class ListTagsForResourceResponse < Struct.new(
5506
- :tags)
5507
- SENSITIVE = []
5508
- include Aws::Structure
5509
- end
5510
-
5511
6583
  # An individual metric Forecast calculated when monitoring predictor
5512
6584
  # usage. You can compare the value for this metric to the metric's
5513
6585
  # value in the Baseline to see how your predictor's performance is
@@ -5925,9 +6997,11 @@ module Aws::ForecastService
5925
6997
  # Describes the results of a monitor evaluation.
5926
6998
  #
5927
6999
  # @!attribute [rw] resource_arn
7000
+ # The Amazon Resource Name (ARN) of the resource to monitor.
5928
7001
  # @return [String]
5929
7002
  #
5930
7003
  # @!attribute [rw] monitor_arn
7004
+ # The Amazon Resource Name (ARN) of the monitor resource.
5931
7005
  # @return [String]
5932
7006
  #
5933
7007
  # @!attribute [rw] evaluation_time
@@ -6641,88 +7715,388 @@ module Aws::ForecastService
6641
7715
  # ],
6642
7716
  # }
6643
7717
  #
6644
- # @!attribute [rw] resource_arn
6645
- # The Amazon Resource Name (ARN) that identifies the resource for
6646
- # which to list the tags.
7718
+ # @!attribute [rw] resource_arn
7719
+ # The Amazon Resource Name (ARN) that identifies the resource for
7720
+ # which to list the tags.
7721
+ # @return [String]
7722
+ #
7723
+ # @!attribute [rw] tags
7724
+ # The tags to add to the resource. A tag is an array of key-value
7725
+ # pairs.
7726
+ #
7727
+ # The following basic restrictions apply to tags:
7728
+ #
7729
+ # * Maximum number of tags per resource - 50.
7730
+ #
7731
+ # * For each resource, each tag key must be unique, and each tag key
7732
+ # can have only one value.
7733
+ #
7734
+ # * Maximum key length - 128 Unicode characters in UTF-8.
7735
+ #
7736
+ # * Maximum value length - 256 Unicode characters in UTF-8.
7737
+ #
7738
+ # * If your tagging schema is used across multiple services and
7739
+ # resources, remember that other services may have restrictions on
7740
+ # allowed characters. Generally allowed characters are: letters,
7741
+ # numbers, and spaces representable in UTF-8, and the following
7742
+ # characters: + - = . \_ : / @.
7743
+ #
7744
+ # * Tag keys and values are case sensitive.
7745
+ #
7746
+ # * Do not use `aws:`, `AWS:`, or any upper or lowercase combination
7747
+ # of such as a prefix for keys as it is reserved for AWS use. You
7748
+ # cannot edit or delete tag keys with this prefix. Values can have
7749
+ # this prefix. If a tag value has `aws` as its prefix but the key
7750
+ # does not, then Forecast considers it to be a user tag and will
7751
+ # count against the limit of 50 tags. Tags with only the key prefix
7752
+ # of `aws` do not count against your tags per resource limit.
7753
+ # @return [Array<Types::Tag>]
7754
+ #
7755
+ # @see http://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/TagResourceRequest AWS API Documentation
7756
+ #
7757
+ class TagResourceRequest < Struct.new(
7758
+ :resource_arn,
7759
+ :tags)
7760
+ SENSITIVE = []
7761
+ include Aws::Structure
7762
+ end
7763
+
7764
+ # @see http://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/TagResourceResponse AWS API Documentation
7765
+ #
7766
+ class TagResourceResponse < Aws::EmptyStructure; end
7767
+
7768
+ # The status, start time, and end time of a backtest, as well as a
7769
+ # failure reason if applicable.
7770
+ #
7771
+ # @!attribute [rw] test_window_start
7772
+ # The time at which the test began.
7773
+ # @return [Time]
7774
+ #
7775
+ # @!attribute [rw] test_window_end
7776
+ # The time at which the test ended.
7777
+ # @return [Time]
7778
+ #
7779
+ # @!attribute [rw] status
7780
+ # The status of the test. Possible status values are:
7781
+ #
7782
+ # * `ACTIVE`
7783
+ #
7784
+ # * `CREATE_IN_PROGRESS`
7785
+ #
7786
+ # * `CREATE_FAILED`
7787
+ # @return [String]
7788
+ #
7789
+ # @!attribute [rw] message
7790
+ # If the test failed, the reason why it failed.
7791
+ # @return [String]
7792
+ #
7793
+ # @see http://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/TestWindowSummary AWS API Documentation
7794
+ #
7795
+ class TestWindowSummary < Struct.new(
7796
+ :test_window_start,
7797
+ :test_window_end,
7798
+ :status,
7799
+ :message)
7800
+ SENSITIVE = []
7801
+ include Aws::Structure
7802
+ end
7803
+
7804
+ # The time boundary Forecast uses to align and aggregate your data to
7805
+ # match your forecast frequency. Provide the unit of time and the time
7806
+ # boundary as a key value pair. If you don't provide a time boundary,
7807
+ # Forecast uses a set of [Default Time Boundaries][1].
7808
+ #
7809
+ # For more information about aggregation, see [Data Aggregation for
7810
+ # Different Forecast Frequencies][2]. For more information setting a
7811
+ # custom time boundary, see [Specifying a Time Boundary][3].
7812
+ #
7813
+ #
7814
+ #
7815
+ # [1]: https://docs.aws.amazon.com/forecast/latest/dg/data-aggregation.html#default-time-boundaries
7816
+ # [2]: https://docs.aws.amazon.com/forecast/latest/dg/data-aggregation.html
7817
+ # [3]: https://docs.aws.amazon.com/forecast/latest/dg/data-aggregation.html#specifying-time-boundary
7818
+ #
7819
+ # @note When making an API call, you may pass TimeAlignmentBoundary
7820
+ # data as a hash:
7821
+ #
7822
+ # {
7823
+ # month: "JANUARY", # accepts JANUARY, FEBRUARY, MARCH, APRIL, MAY, JUNE, JULY, AUGUST, SEPTEMBER, OCTOBER, NOVEMBER, DECEMBER
7824
+ # day_of_month: 1,
7825
+ # day_of_week: "MONDAY", # accepts MONDAY, TUESDAY, WEDNESDAY, THURSDAY, FRIDAY, SATURDAY, SUNDAY
7826
+ # hour: 1,
7827
+ # }
7828
+ #
7829
+ # @!attribute [rw] month
7830
+ # The month to use for time alignment during aggregation. The month
7831
+ # must be in uppercase.
7832
+ # @return [String]
7833
+ #
7834
+ # @!attribute [rw] day_of_month
7835
+ # The day of the month to use for time alignment during aggregation.
7836
+ # @return [Integer]
7837
+ #
7838
+ # @!attribute [rw] day_of_week
7839
+ # The day of week to use for time alignment during aggregation. The
7840
+ # day must be in uppercase.
7841
+ # @return [String]
7842
+ #
7843
+ # @!attribute [rw] hour
7844
+ # The hour of day to use for time alignment during aggregation.
7845
+ # @return [Integer]
7846
+ #
7847
+ # @see http://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/TimeAlignmentBoundary AWS API Documentation
7848
+ #
7849
+ class TimeAlignmentBoundary < Struct.new(
7850
+ :month,
7851
+ :day_of_month,
7852
+ :day_of_week,
7853
+ :hour)
7854
+ SENSITIVE = []
7855
+ include Aws::Structure
7856
+ end
7857
+
7858
+ # Creates a subset of items within an attribute that are modified. For
7859
+ # example, you can use this operation to create a subset of items that
7860
+ # cost $5 or less. To do this, you specify `"AttributeName": "price"`,
7861
+ # `"AttributeValue": "5"`, and `"Condition": "LESS_THAN"`. Pair this
7862
+ # operation with the Action operation within the
7863
+ # CreateWhatIfForecastRequest$TimeSeriesTransformations operation to
7864
+ # define how the attribute is modified.
7865
+ #
7866
+ # @note When making an API call, you may pass TimeSeriesCondition
7867
+ # data as a hash:
7868
+ #
7869
+ # {
7870
+ # attribute_name: "Name", # required
7871
+ # attribute_value: "AttributeValue", # required
7872
+ # condition: "EQUALS", # required, accepts EQUALS, NOT_EQUALS, LESS_THAN, GREATER_THAN
7873
+ # }
7874
+ #
7875
+ # @!attribute [rw] attribute_name
7876
+ # The item\_id, dimension name, IM name, or timestamp that you are
7877
+ # modifying.
7878
+ # @return [String]
7879
+ #
7880
+ # @!attribute [rw] attribute_value
7881
+ # The value that is applied for the chosen `Condition`.
7882
+ # @return [String]
7883
+ #
7884
+ # @!attribute [rw] condition
7885
+ # The condition to apply. Valid values are `EQUALS`, `NOT_EQUALS`,
7886
+ # `LESS_THAN` and `GREATER_THAN`.
7887
+ # @return [String]
7888
+ #
7889
+ # @see http://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/TimeSeriesCondition AWS API Documentation
7890
+ #
7891
+ class TimeSeriesCondition < Struct.new(
7892
+ :attribute_name,
7893
+ :attribute_value,
7894
+ :condition)
7895
+ SENSITIVE = []
7896
+ include Aws::Structure
7897
+ end
7898
+
7899
+ # Details about the import file that contains the time series for which
7900
+ # you want to create forecasts.
7901
+ #
7902
+ # @note When making an API call, you may pass TimeSeriesIdentifiers
7903
+ # data as a hash:
7904
+ #
7905
+ # {
7906
+ # data_source: {
7907
+ # s3_config: { # required
7908
+ # path: "S3Path", # required
7909
+ # role_arn: "Arn", # required
7910
+ # kms_key_arn: "KMSKeyArn",
7911
+ # },
7912
+ # },
7913
+ # schema: {
7914
+ # attributes: [
7915
+ # {
7916
+ # attribute_name: "Name",
7917
+ # attribute_type: "string", # accepts string, integer, float, timestamp, geolocation
7918
+ # },
7919
+ # ],
7920
+ # },
7921
+ # format: "Format",
7922
+ # }
7923
+ #
7924
+ # @!attribute [rw] data_source
7925
+ # The source of your data, an AWS Identity and Access Management (IAM)
7926
+ # role that allows Amazon Forecast to access the data and, optionally,
7927
+ # an AWS Key Management Service (KMS) key.
7928
+ # @return [Types::DataSource]
7929
+ #
7930
+ # @!attribute [rw] schema
7931
+ # Defines the fields of a dataset.
7932
+ # @return [Types::Schema]
7933
+ #
7934
+ # @!attribute [rw] format
7935
+ # The format of the data, either CSV or PARQUET.
7936
+ # @return [String]
7937
+ #
7938
+ # @see http://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/TimeSeriesIdentifiers AWS API Documentation
7939
+ #
7940
+ class TimeSeriesIdentifiers < Struct.new(
7941
+ :data_source,
7942
+ :schema,
7943
+ :format)
7944
+ SENSITIVE = []
7945
+ include Aws::Structure
7946
+ end
7947
+
7948
+ # A replacement dataset is a modified version of the baseline related
7949
+ # time series that contains only the values that you want to include in
7950
+ # a what-if forecast. The replacement dataset must contain the forecast
7951
+ # dimensions and item identifiers in the baseline related time series as
7952
+ # well as at least 1 changed time series. This dataset is merged with
7953
+ # the baseline related time series to create a transformed dataset that
7954
+ # is used for the what-if forecast.
7955
+ #
7956
+ # @note When making an API call, you may pass TimeSeriesReplacementsDataSource
7957
+ # data as a hash:
7958
+ #
7959
+ # {
7960
+ # s3_config: { # required
7961
+ # path: "S3Path", # required
7962
+ # role_arn: "Arn", # required
7963
+ # kms_key_arn: "KMSKeyArn",
7964
+ # },
7965
+ # schema: { # required
7966
+ # attributes: [
7967
+ # {
7968
+ # attribute_name: "Name",
7969
+ # attribute_type: "string", # accepts string, integer, float, timestamp, geolocation
7970
+ # },
7971
+ # ],
7972
+ # },
7973
+ # format: "Format",
7974
+ # timestamp_format: "TimestampFormat",
7975
+ # }
7976
+ #
7977
+ # @!attribute [rw] s3_config
7978
+ # The path to the file(s) in an Amazon Simple Storage Service (Amazon
7979
+ # S3) bucket, and an AWS Identity and Access Management (IAM) role
7980
+ # that Amazon Forecast can assume to access the file(s). Optionally,
7981
+ # includes an AWS Key Management Service (KMS) key. This object is
7982
+ # part of the DataSource object that is submitted in the
7983
+ # CreateDatasetImportJob request, and part of the DataDestination
7984
+ # object.
7985
+ # @return [Types::S3Config]
7986
+ #
7987
+ # @!attribute [rw] schema
7988
+ # Defines the fields of a dataset.
7989
+ # @return [Types::Schema]
7990
+ #
7991
+ # @!attribute [rw] format
7992
+ # The format of the replacement data, CSV or PARQUET.
6647
7993
  # @return [String]
6648
7994
  #
6649
- # @!attribute [rw] tags
6650
- # The tags to add to the resource. A tag is an array of key-value
6651
- # pairs.
7995
+ # @!attribute [rw] timestamp_format
7996
+ # The timestamp format of the replacement data.
7997
+ # @return [String]
6652
7998
  #
6653
- # The following basic restrictions apply to tags:
7999
+ # @see http://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/TimeSeriesReplacementsDataSource AWS API Documentation
6654
8000
  #
6655
- # * Maximum number of tags per resource - 50.
8001
+ class TimeSeriesReplacementsDataSource < Struct.new(
8002
+ :s3_config,
8003
+ :schema,
8004
+ :format,
8005
+ :timestamp_format)
8006
+ SENSITIVE = []
8007
+ include Aws::Structure
8008
+ end
8009
+
8010
+ # Defines the set of time series that are used to create the forecasts
8011
+ # in a `TimeSeriesIdentifiers` object.
6656
8012
  #
6657
- # * For each resource, each tag key must be unique, and each tag key
6658
- # can have only one value.
8013
+ # The `TimeSeriesIdentifiers` object needs the following information:
6659
8014
  #
6660
- # * Maximum key length - 128 Unicode characters in UTF-8.
8015
+ # * `DataSource`
6661
8016
  #
6662
- # * Maximum value length - 256 Unicode characters in UTF-8.
8017
+ # * `Format`
6663
8018
  #
6664
- # * If your tagging schema is used across multiple services and
6665
- # resources, remember that other services may have restrictions on
6666
- # allowed characters. Generally allowed characters are: letters,
6667
- # numbers, and spaces representable in UTF-8, and the following
6668
- # characters: + - = . \_ : / @.
8019
+ # * `Schema`
6669
8020
  #
6670
- # * Tag keys and values are case sensitive.
8021
+ # @note When making an API call, you may pass TimeSeriesSelector
8022
+ # data as a hash:
6671
8023
  #
6672
- # * Do not use `aws:`, `AWS:`, or any upper or lowercase combination
6673
- # of such as a prefix for keys as it is reserved for AWS use. You
6674
- # cannot edit or delete tag keys with this prefix. Values can have
6675
- # this prefix. If a tag value has `aws` as its prefix but the key
6676
- # does not, then Forecast considers it to be a user tag and will
6677
- # count against the limit of 50 tags. Tags with only the key prefix
6678
- # of `aws` do not count against your tags per resource limit.
6679
- # @return [Array<Types::Tag>]
8024
+ # {
8025
+ # time_series_identifiers: {
8026
+ # data_source: {
8027
+ # s3_config: { # required
8028
+ # path: "S3Path", # required
8029
+ # role_arn: "Arn", # required
8030
+ # kms_key_arn: "KMSKeyArn",
8031
+ # },
8032
+ # },
8033
+ # schema: {
8034
+ # attributes: [
8035
+ # {
8036
+ # attribute_name: "Name",
8037
+ # attribute_type: "string", # accepts string, integer, float, timestamp, geolocation
8038
+ # },
8039
+ # ],
8040
+ # },
8041
+ # format: "Format",
8042
+ # },
8043
+ # }
6680
8044
  #
6681
- # @see http://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/TagResourceRequest AWS API Documentation
8045
+ # @!attribute [rw] time_series_identifiers
8046
+ # Details about the import file that contains the time series for
8047
+ # which you want to create forecasts.
8048
+ # @return [Types::TimeSeriesIdentifiers]
6682
8049
  #
6683
- class TagResourceRequest < Struct.new(
6684
- :resource_arn,
6685
- :tags)
8050
+ # @see http://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/TimeSeriesSelector AWS API Documentation
8051
+ #
8052
+ class TimeSeriesSelector < Struct.new(
8053
+ :time_series_identifiers)
6686
8054
  SENSITIVE = []
6687
8055
  include Aws::Structure
6688
8056
  end
6689
8057
 
6690
- # @see http://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/TagResourceResponse AWS API Documentation
6691
- #
6692
- class TagResourceResponse < Aws::EmptyStructure; end
6693
-
6694
- # The status, start time, and end time of a backtest, as well as a
6695
- # failure reason if applicable.
6696
- #
6697
- # @!attribute [rw] test_window_start
6698
- # The time at which the test began.
6699
- # @return [Time]
8058
+ # A transformation function is a pair of operations that select and
8059
+ # modify the rows in a related time series. You select the rows that you
8060
+ # want with a condition operation and you modify the rows with a
8061
+ # transformation operation. All conditions are joined with an AND
8062
+ # operation, meaning that all conditions must be true for the
8063
+ # transformation to be applied. Transformations are applied in the order
8064
+ # that they are listed.
6700
8065
  #
6701
- # @!attribute [rw] test_window_end
6702
- # The time at which the test ended.
6703
- # @return [Time]
6704
- #
6705
- # @!attribute [rw] status
6706
- # The status of the test. Possible status values are:
6707
- #
6708
- # * `ACTIVE`
8066
+ # @note When making an API call, you may pass TimeSeriesTransformation
8067
+ # data as a hash:
6709
8068
  #
6710
- # * `CREATE_IN_PROGRESS`
8069
+ # {
8070
+ # action: {
8071
+ # attribute_name: "Name", # required
8072
+ # operation: "ADD", # required, accepts ADD, SUBTRACT, MULTIPLY, DIVIDE
8073
+ # value: 1.0, # required
8074
+ # },
8075
+ # time_series_conditions: [
8076
+ # {
8077
+ # attribute_name: "Name", # required
8078
+ # attribute_value: "AttributeValue", # required
8079
+ # condition: "EQUALS", # required, accepts EQUALS, NOT_EQUALS, LESS_THAN, GREATER_THAN
8080
+ # },
8081
+ # ],
8082
+ # }
6711
8083
  #
6712
- # * `CREATE_FAILED`
6713
- # @return [String]
8084
+ # @!attribute [rw] action
8085
+ # An array of actions that define a time series and how it is
8086
+ # transformed. These transformations create a new time series that is
8087
+ # used for the what-if analysis.
8088
+ # @return [Types::Action]
6714
8089
  #
6715
- # @!attribute [rw] message
6716
- # If the test failed, the reason why it failed.
6717
- # @return [String]
8090
+ # @!attribute [rw] time_series_conditions
8091
+ # An array of conditions that define which members of the related time
8092
+ # series are transformed.
8093
+ # @return [Array<Types::TimeSeriesCondition>]
6718
8094
  #
6719
- # @see http://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/TestWindowSummary AWS API Documentation
8095
+ # @see http://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/TimeSeriesTransformation AWS API Documentation
6720
8096
  #
6721
- class TestWindowSummary < Struct.new(
6722
- :test_window_start,
6723
- :test_window_end,
6724
- :status,
6725
- :message)
8097
+ class TimeSeriesTransformation < Struct.new(
8098
+ :action,
8099
+ :time_series_conditions)
6726
8100
  SENSITIVE = []
6727
8101
  include Aws::Structure
6728
8102
  end
@@ -6812,6 +8186,228 @@ module Aws::ForecastService
6812
8186
  include Aws::Structure
6813
8187
  end
6814
8188
 
8189
+ # Provides a summary of the what-if analysis properties used in the
8190
+ # ListWhatIfAnalyses operation. To get the complete set of properties,
8191
+ # call the DescribeWhatIfAnalysis operation, and provide the
8192
+ # `WhatIfAnalysisArn` that is listed in the summary.
8193
+ #
8194
+ # @!attribute [rw] what_if_analysis_arn
8195
+ # The Amazon Resource Name (ARN) of the what-if analysis.
8196
+ # @return [String]
8197
+ #
8198
+ # @!attribute [rw] what_if_analysis_name
8199
+ # The name of the what-if analysis.
8200
+ # @return [String]
8201
+ #
8202
+ # @!attribute [rw] forecast_arn
8203
+ # The Amazon Resource Name (ARN) of the baseline forecast that is
8204
+ # being used in this what-if analysis.
8205
+ # @return [String]
8206
+ #
8207
+ # @!attribute [rw] status
8208
+ # The status of the what-if analysis. States include:
8209
+ #
8210
+ # * `ACTIVE`
8211
+ #
8212
+ # * `CREATE_PENDING`, `CREATE_IN_PROGRESS`, `CREATE_FAILED`
8213
+ #
8214
+ # * `CREATE_STOPPING`, `CREATE_STOPPED`
8215
+ #
8216
+ # * `DELETE_PENDING`, `DELETE_IN_PROGRESS`, `DELETE_FAILED`
8217
+ #
8218
+ # <note markdown="1"> The `Status` of the what-if analysis must be `ACTIVE` before you can
8219
+ # access the analysis.
8220
+ #
8221
+ # </note>
8222
+ # @return [String]
8223
+ #
8224
+ # @!attribute [rw] message
8225
+ # If an error occurred, an informational message about the error.
8226
+ # @return [String]
8227
+ #
8228
+ # @!attribute [rw] creation_time
8229
+ # When the what-if analysis was created.
8230
+ # @return [Time]
8231
+ #
8232
+ # @!attribute [rw] last_modification_time
8233
+ # The last time the resource was modified. The timestamp depends on
8234
+ # the status of the job:
8235
+ #
8236
+ # * `CREATE_PENDING` - The `CreationTime`.
8237
+ #
8238
+ # * `CREATE_IN_PROGRESS` - The current timestamp.
8239
+ #
8240
+ # * `CREATE_STOPPING` - The current timestamp.
8241
+ #
8242
+ # * `CREATE_STOPPED` - When the job stopped.
8243
+ #
8244
+ # * `ACTIVE` or `CREATE_FAILED` - When the job finished or failed.
8245
+ # @return [Time]
8246
+ #
8247
+ # @see http://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/WhatIfAnalysisSummary AWS API Documentation
8248
+ #
8249
+ class WhatIfAnalysisSummary < Struct.new(
8250
+ :what_if_analysis_arn,
8251
+ :what_if_analysis_name,
8252
+ :forecast_arn,
8253
+ :status,
8254
+ :message,
8255
+ :creation_time,
8256
+ :last_modification_time)
8257
+ SENSITIVE = []
8258
+ include Aws::Structure
8259
+ end
8260
+
8261
+ # Provides a summary of the what-if forecast export properties used in
8262
+ # the ListWhatIfForecastExports operation. To get the complete set of
8263
+ # properties, call the DescribeWhatIfForecastExport operation, and
8264
+ # provide the `WhatIfForecastExportArn` that is listed in the summary.
8265
+ #
8266
+ # @!attribute [rw] what_if_forecast_export_arn
8267
+ # The Amazon Resource Name (ARN) of the what-if forecast export.
8268
+ # @return [String]
8269
+ #
8270
+ # @!attribute [rw] what_if_forecast_arns
8271
+ # An array of Amazon Resource Names (ARNs) that define the what-if
8272
+ # forecasts included in the export.
8273
+ # @return [Array<String>]
8274
+ #
8275
+ # @!attribute [rw] what_if_forecast_export_name
8276
+ # The what-if forecast export name.
8277
+ # @return [String]
8278
+ #
8279
+ # @!attribute [rw] destination
8280
+ # The path to the Amazon Simple Storage Service (Amazon S3) bucket
8281
+ # where the forecast is exported.
8282
+ # @return [Types::DataDestination]
8283
+ #
8284
+ # @!attribute [rw] status
8285
+ # The status of the what-if forecast export. States include:
8286
+ #
8287
+ # * `ACTIVE`
8288
+ #
8289
+ # * `CREATE_PENDING`, `CREATE_IN_PROGRESS`, `CREATE_FAILED`
8290
+ #
8291
+ # * `CREATE_STOPPING`, `CREATE_STOPPED`
8292
+ #
8293
+ # * `DELETE_PENDING`, `DELETE_IN_PROGRESS`, `DELETE_FAILED`
8294
+ #
8295
+ # <note markdown="1"> The `Status` of the what-if analysis must be `ACTIVE` before you can
8296
+ # access the analysis.
8297
+ #
8298
+ # </note>
8299
+ # @return [String]
8300
+ #
8301
+ # @!attribute [rw] message
8302
+ # If an error occurred, an informational message about the error.
8303
+ # @return [String]
8304
+ #
8305
+ # @!attribute [rw] creation_time
8306
+ # When the what-if forecast export was created.
8307
+ # @return [Time]
8308
+ #
8309
+ # @!attribute [rw] last_modification_time
8310
+ # The last time the resource was modified. The timestamp depends on
8311
+ # the status of the job:
8312
+ #
8313
+ # * `CREATE_PENDING` - The `CreationTime`.
8314
+ #
8315
+ # * `CREATE_IN_PROGRESS` - The current timestamp.
8316
+ #
8317
+ # * `CREATE_STOPPING` - The current timestamp.
8318
+ #
8319
+ # * `CREATE_STOPPED` - When the job stopped.
8320
+ #
8321
+ # * `ACTIVE` or `CREATE_FAILED` - When the job finished or failed.
8322
+ # @return [Time]
8323
+ #
8324
+ # @see http://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/WhatIfForecastExportSummary AWS API Documentation
8325
+ #
8326
+ class WhatIfForecastExportSummary < Struct.new(
8327
+ :what_if_forecast_export_arn,
8328
+ :what_if_forecast_arns,
8329
+ :what_if_forecast_export_name,
8330
+ :destination,
8331
+ :status,
8332
+ :message,
8333
+ :creation_time,
8334
+ :last_modification_time)
8335
+ SENSITIVE = []
8336
+ include Aws::Structure
8337
+ end
8338
+
8339
+ # Provides a summary of the what-if forecast properties used in the
8340
+ # ListWhatIfForecasts operation. To get the complete set of properties,
8341
+ # call the DescribeWhatIfForecast operation, and provide the
8342
+ # `WhatIfForecastArn` that is listed in the summary.
8343
+ #
8344
+ # @!attribute [rw] what_if_forecast_arn
8345
+ # The Amazon Resource Name (ARN) of the what-if forecast.
8346
+ # @return [String]
8347
+ #
8348
+ # @!attribute [rw] what_if_forecast_name
8349
+ # The name of the what-if forecast.
8350
+ # @return [String]
8351
+ #
8352
+ # @!attribute [rw] what_if_analysis_arn
8353
+ # The Amazon Resource Name (ARN) of the what-if analysis that contains
8354
+ # this what-if forecast.
8355
+ # @return [String]
8356
+ #
8357
+ # @!attribute [rw] status
8358
+ # The status of the what-if forecast. States include:
8359
+ #
8360
+ # * `ACTIVE`
8361
+ #
8362
+ # * `CREATE_PENDING`, `CREATE_IN_PROGRESS`, `CREATE_FAILED`
8363
+ #
8364
+ # * `CREATE_STOPPING`, `CREATE_STOPPED`
8365
+ #
8366
+ # * `DELETE_PENDING`, `DELETE_IN_PROGRESS`, `DELETE_FAILED`
8367
+ #
8368
+ # <note markdown="1"> The `Status` of the what-if analysis must be `ACTIVE` before you can
8369
+ # access the analysis.
8370
+ #
8371
+ # </note>
8372
+ # @return [String]
8373
+ #
8374
+ # @!attribute [rw] message
8375
+ # If an error occurred, an informational message about the error.
8376
+ # @return [String]
8377
+ #
8378
+ # @!attribute [rw] creation_time
8379
+ # When the what-if forecast was created.
8380
+ # @return [Time]
8381
+ #
8382
+ # @!attribute [rw] last_modification_time
8383
+ # The last time the resource was modified. The timestamp depends on
8384
+ # the status of the job:
8385
+ #
8386
+ # * `CREATE_PENDING` - The `CreationTime`.
8387
+ #
8388
+ # * `CREATE_IN_PROGRESS` - The current timestamp.
8389
+ #
8390
+ # * `CREATE_STOPPING` - The current timestamp.
8391
+ #
8392
+ # * `CREATE_STOPPED` - When the job stopped.
8393
+ #
8394
+ # * `ACTIVE` or `CREATE_FAILED` - When the job finished or failed.
8395
+ # @return [Time]
8396
+ #
8397
+ # @see http://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/WhatIfForecastSummary AWS API Documentation
8398
+ #
8399
+ class WhatIfForecastSummary < Struct.new(
8400
+ :what_if_forecast_arn,
8401
+ :what_if_forecast_name,
8402
+ :what_if_analysis_arn,
8403
+ :status,
8404
+ :message,
8405
+ :creation_time,
8406
+ :last_modification_time)
8407
+ SENSITIVE = []
8408
+ include Aws::Structure
8409
+ end
8410
+
6815
8411
  # The metrics for a time range within the evaluation portion of a
6816
8412
  # dataset. This object is part of the EvaluationResult object.
6817
8413
  #