aws-sdk-forecastservice 1.33.0 → 1.36.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.
@@ -59,6 +59,8 @@ module Aws::ForecastService
59
59
  #
60
60
  # **Holidays**
61
61
  #
62
+ # **Holidays**
63
+ #
62
64
  # To enable Holidays, set `CountryCode` to one of the following
63
65
  # two-letter country codes:
64
66
  #
@@ -278,6 +280,47 @@ module Aws::ForecastService
278
280
  include Aws::Structure
279
281
  end
280
282
 
283
+ # Metrics you can use as a baseline for comparison purposes. Use these
284
+ # metrics when you interpret monitoring results for an auto predictor.
285
+ #
286
+ # @!attribute [rw] predictor_baseline
287
+ # The initial [accuracy metrics][1] for the predictor you are
288
+ # monitoring. Use these metrics as a baseline for comparison purposes
289
+ # as you use your predictor and the metrics change.
290
+ #
291
+ #
292
+ #
293
+ # [1]: https://docs.aws.amazon.com/forecast/latest/dg/metrics.html
294
+ # @return [Types::PredictorBaseline]
295
+ #
296
+ # @see http://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/Baseline AWS API Documentation
297
+ #
298
+ class Baseline < Struct.new(
299
+ :predictor_baseline)
300
+ SENSITIVE = []
301
+ include Aws::Structure
302
+ end
303
+
304
+ # An individual metric that you can use for comparison as you evaluate
305
+ # your monitoring results.
306
+ #
307
+ # @!attribute [rw] name
308
+ # The name of the metric.
309
+ # @return [String]
310
+ #
311
+ # @!attribute [rw] value
312
+ # The value for the metric.
313
+ # @return [Float]
314
+ #
315
+ # @see http://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/BaselineMetric AWS API Documentation
316
+ #
317
+ class BaselineMetric < Struct.new(
318
+ :name,
319
+ :value)
320
+ SENSITIVE = []
321
+ include Aws::Structure
322
+ end
323
+
281
324
  # Specifies a categorical hyperparameter and it's range of tunable
282
325
  # values. This object is part of the ParameterRanges object.
283
326
  #
@@ -421,6 +464,15 @@ module Aws::ForecastService
421
464
  # value: "TagValue", # required
422
465
  # },
423
466
  # ],
467
+ # monitor_config: {
468
+ # monitor_name: "Name", # required
469
+ # },
470
+ # time_alignment_boundary: {
471
+ # month: "JANUARY", # accepts JANUARY, FEBRUARY, MARCH, APRIL, MAY, JUNE, JULY, AUGUST, SEPTEMBER, OCTOBER, NOVEMBER, DECEMBER
472
+ # day_of_month: 1,
473
+ # day_of_week: "MONDAY", # accepts MONDAY, TUESDAY, WEDNESDAY, THURSDAY, FRIDAY, SATURDAY, SUNDAY
474
+ # hour: 1,
475
+ # },
424
476
  # }
425
477
  #
426
478
  # @!attribute [rw] predictor_name
@@ -430,6 +482,17 @@ module Aws::ForecastService
430
482
  # @!attribute [rw] forecast_horizon
431
483
  # The number of time-steps that the model predicts. The forecast
432
484
  # horizon is also called the prediction length.
485
+ #
486
+ # The maximum forecast horizon is the lesser of 500 time-steps or 1/4
487
+ # of the TARGET\_TIME\_SERIES dataset length. If you are retraining an
488
+ # existing AutoPredictor, then the maximum forecast horizon is the
489
+ # lesser of 500 time-steps or 1/3 of the TARGET\_TIME\_SERIES dataset
490
+ # length.
491
+ #
492
+ # If you are upgrading to an AutoPredictor or retraining an existing
493
+ # AutoPredictor, you cannot update the forecast horizon parameter. You
494
+ # can meet this requirement by providing longer time-series in the
495
+ # dataset.
433
496
  # @return [Integer]
434
497
  #
435
498
  # @!attribute [rw] forecast_types
@@ -524,6 +587,33 @@ module Aws::ForecastService
524
587
  # prefix.
525
588
  # @return [Array<Types::Tag>]
526
589
  #
590
+ # @!attribute [rw] monitor_config
591
+ # The configuration details for predictor monitoring. Provide a name
592
+ # for the monitor resource to enable predictor monitoring.
593
+ #
594
+ # Predictor monitoring allows you to see how your predictor's
595
+ # performance changes over time. For more information, see [Predictor
596
+ # Monitoring][1].
597
+ #
598
+ #
599
+ #
600
+ # [1]: https://docs.aws.amazon.com/forecast/latest/dg/predictor-monitoring.html
601
+ # @return [Types::MonitorConfig]
602
+ #
603
+ # @!attribute [rw] time_alignment_boundary
604
+ # The time boundary Forecast uses to align and aggregate any data that
605
+ # doesn't align with your forecast frequency. Provide the unit of
606
+ # time and the time boundary as a key value pair. For more information
607
+ # on specifying a time boundary, see [Specifying a Time Boundary][1].
608
+ # If you don't provide a time boundary, Forecast uses a set of
609
+ # [Default Time Boundaries][2].
610
+ #
611
+ #
612
+ #
613
+ # [1]: https://docs.aws.amazon.com/forecast/latest/dg/data-aggregation.html#specifying-time-boundary
614
+ # [2]: https://docs.aws.amazon.com/forecast/latest/dg/data-aggregation.html#default-time-boundaries
615
+ # @return [Types::TimeAlignmentBoundary]
616
+ #
527
617
  # @see http://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/CreateAutoPredictorRequest AWS API Documentation
528
618
  #
529
619
  class CreateAutoPredictorRequest < Struct.new(
@@ -537,7 +627,9 @@ module Aws::ForecastService
537
627
  :reference_predictor_arn,
538
628
  :optimization_metric,
539
629
  :explain_predictor,
540
- :tags)
630
+ :tags,
631
+ :monitor_config,
632
+ :time_alignment_boundary)
541
633
  SENSITIVE = []
542
634
  include Aws::Structure
543
635
  end
@@ -576,14 +668,19 @@ module Aws::ForecastService
576
668
  # @!attribute [rw] domain
577
669
  # The domain associated with the dataset group. When you add a dataset
578
670
  # to a dataset group, this value and the value specified for the
579
- # `Domain` parameter of the CreateDataset operation must match.
671
+ # `Domain` parameter of the [CreateDataset][1] operation must match.
580
672
  #
581
673
  # The `Domain` and `DatasetType` that you choose determine the fields
582
674
  # that must be present in training data that you import to a dataset.
583
675
  # For example, if you choose the `RETAIL` domain and
584
676
  # `TARGET_TIME_SERIES` as the `DatasetType`, Amazon Forecast requires
585
677
  # that `item_id`, `timestamp`, and `demand` fields are present in your
586
- # data. For more information, see howitworks-datasets-groups.
678
+ # data. For more information, see [Dataset groups][2].
679
+ #
680
+ #
681
+ #
682
+ # [1]: https://docs.aws.amazon.com/forecast/latest/dg/API_CreateDataset.html
683
+ # [2]: https://docs.aws.amazon.com/forecast/latest/dg/howitworks-datasets-groups.html
587
684
  # @return [String]
588
685
  #
589
686
  # @!attribute [rw] dataset_arns
@@ -670,6 +767,7 @@ module Aws::ForecastService
670
767
  # value: "TagValue", # required
671
768
  # },
672
769
  # ],
770
+ # format: "Format",
673
771
  # }
674
772
  #
675
773
  # @!attribute [rw] dataset_import_job_name
@@ -694,7 +792,11 @@ module Aws::ForecastService
694
792
  # Management Service (KMS) key and the IAM role must allow Amazon
695
793
  # Forecast permission to access the key. The KMS key and IAM role must
696
794
  # match those specified in the `EncryptionConfig` parameter of the
697
- # CreateDataset operation.
795
+ # [CreateDataset][1] operation.
796
+ #
797
+ #
798
+ #
799
+ # [1]: https://docs.aws.amazon.com/forecast/latest/dg/API_CreateDataset.html
698
800
  # @return [Types::DataSource]
699
801
  #
700
802
  # @!attribute [rw] timestamp_format
@@ -779,6 +881,11 @@ module Aws::ForecastService
779
881
  # of `aws` do not count against your tags per resource limit.
780
882
  # @return [Array<Types::Tag>]
781
883
  #
884
+ # @!attribute [rw] format
885
+ # The format of the imported data, CSV or PARQUET. The default value
886
+ # is CSV.
887
+ # @return [String]
888
+ #
782
889
  # @see http://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/CreateDatasetImportJobRequest AWS API Documentation
783
890
  #
784
891
  class CreateDatasetImportJobRequest < Struct.new(
@@ -789,7 +896,8 @@ module Aws::ForecastService
789
896
  :time_zone,
790
897
  :use_geolocation_for_time_zone,
791
898
  :geolocation_format,
792
- :tags)
899
+ :tags,
900
+ :format)
793
901
  SENSITIVE = []
794
902
  include Aws::Structure
795
903
  end
@@ -841,14 +949,19 @@ module Aws::ForecastService
841
949
  # @!attribute [rw] domain
842
950
  # The domain associated with the dataset. When you add a dataset to a
843
951
  # dataset group, this value and the value specified for the `Domain`
844
- # parameter of the CreateDatasetGroup operation must match.
952
+ # parameter of the [CreateDatasetGroup][1] operation must match.
845
953
  #
846
954
  # The `Domain` and `DatasetType` that you choose determine the fields
847
955
  # that must be present in the training data that you import to the
848
956
  # dataset. For example, if you choose the `RETAIL` domain and
849
957
  # `TARGET_TIME_SERIES` as the `DatasetType`, Amazon Forecast requires
850
958
  # `item_id`, `timestamp`, and `demand` fields to be present in your
851
- # data. For more information, see howitworks-datasets-groups.
959
+ # data. For more information, see [Importing datasets][2].
960
+ #
961
+ #
962
+ #
963
+ # [1]: https://docs.aws.amazon.com/forecast/latest/dg/API_CreateDatasetGroup.html
964
+ # [2]: https://docs.aws.amazon.com/forecast/latest/dg/howitworks-datasets-groups.html
852
965
  # @return [String]
853
966
  #
854
967
  # @!attribute [rw] dataset_type
@@ -870,7 +983,12 @@ module Aws::ForecastService
870
983
  # must match the fields in your data. The dataset `Domain` and
871
984
  # `DatasetType` that you choose determine the minimum required fields
872
985
  # in your training data. For information about the required fields for
873
- # a specific dataset domain and type, see howitworks-domains-ds-types.
986
+ # a specific dataset domain and type, see [Dataset Domains and Dataset
987
+ # Types][1].
988
+ #
989
+ #
990
+ #
991
+ # [1]: https://docs.aws.amazon.com/forecast/latest/dg/howitworks-domains-ds-types.html
874
992
  # @return [Types::Schema]
875
993
  #
876
994
  # @!attribute [rw] encryption_config
@@ -957,6 +1075,7 @@ module Aws::ForecastService
957
1075
  # value: "TagValue", # required
958
1076
  # },
959
1077
  # ],
1078
+ # format: "Format",
960
1079
  # }
961
1080
  #
962
1081
  # @!attribute [rw] explainability_export_name
@@ -1004,13 +1123,18 @@ module Aws::ForecastService
1004
1123
  # prefix.
1005
1124
  # @return [Array<Types::Tag>]
1006
1125
  #
1126
+ # @!attribute [rw] format
1127
+ # The format of the exported data, CSV or PARQUET.
1128
+ # @return [String]
1129
+ #
1007
1130
  # @see http://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/CreateExplainabilityExportRequest AWS API Documentation
1008
1131
  #
1009
1132
  class CreateExplainabilityExportRequest < Struct.new(
1010
1133
  :explainability_export_name,
1011
1134
  :explainability_arn,
1012
1135
  :destination,
1013
- :tags)
1136
+ :tags,
1137
+ :format)
1014
1138
  SENSITIVE = []
1015
1139
  include Aws::Structure
1016
1140
  end
@@ -1088,7 +1212,7 @@ module Aws::ForecastService
1088
1212
  # @return [Types::Schema]
1089
1213
  #
1090
1214
  # @!attribute [rw] enable_visualization
1091
- # Create an Expainability visualization that is viewable within the
1215
+ # Create an Explainability visualization that is viewable within the
1092
1216
  # AWS console.
1093
1217
  # @return [Boolean]
1094
1218
  #
@@ -1185,6 +1309,7 @@ module Aws::ForecastService
1185
1309
  # value: "TagValue", # required
1186
1310
  # },
1187
1311
  # ],
1312
+ # format: "Format",
1188
1313
  # }
1189
1314
  #
1190
1315
  # @!attribute [rw] forecast_export_job_name
@@ -1240,13 +1365,19 @@ module Aws::ForecastService
1240
1365
  # of `aws` do not count against your tags per resource limit.
1241
1366
  # @return [Array<Types::Tag>]
1242
1367
  #
1368
+ # @!attribute [rw] format
1369
+ # The format of the exported data, CSV or PARQUET. The default value
1370
+ # is CSV.
1371
+ # @return [String]
1372
+ #
1243
1373
  # @see http://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/CreateForecastExportJobRequest AWS API Documentation
1244
1374
  #
1245
1375
  class CreateForecastExportJobRequest < Struct.new(
1246
1376
  :forecast_export_job_name,
1247
1377
  :forecast_arn,
1248
1378
  :destination,
1249
- :tags)
1379
+ :tags,
1380
+ :format)
1250
1381
  SENSITIVE = []
1251
1382
  include Aws::Structure
1252
1383
  end
@@ -1276,6 +1407,26 @@ module Aws::ForecastService
1276
1407
  # value: "TagValue", # required
1277
1408
  # },
1278
1409
  # ],
1410
+ # time_series_selector: {
1411
+ # time_series_identifiers: {
1412
+ # data_source: {
1413
+ # s3_config: { # required
1414
+ # path: "S3Path", # required
1415
+ # role_arn: "Arn", # required
1416
+ # kms_key_arn: "KMSKeyArn",
1417
+ # },
1418
+ # },
1419
+ # schema: {
1420
+ # attributes: [
1421
+ # {
1422
+ # attribute_name: "Name",
1423
+ # attribute_type: "string", # accepts string, integer, float, timestamp, geolocation
1424
+ # },
1425
+ # ],
1426
+ # },
1427
+ # format: "Format",
1428
+ # },
1429
+ # },
1279
1430
  # }
1280
1431
  #
1281
1432
  # @!attribute [rw] forecast_name
@@ -1293,7 +1444,11 @@ module Aws::ForecastService
1293
1444
  # values include `0.01 to 0.99` (increments of .01 only) and `mean`.
1294
1445
  # The mean forecast is different from the median (0.50) when the
1295
1446
  # distribution is not symmetric (for example, Beta and Negative
1296
- # Binomial). The default value is `["0.1", "0.5", "0.9"]`.
1447
+ # Binomial).
1448
+ #
1449
+ # The default quantiles are the quantiles you specified during
1450
+ # predictor creation. If you didn't specify quantiles, the default
1451
+ # values are `["0.1", "0.5", "0.9"]`.
1297
1452
  # @return [Array<String>]
1298
1453
  #
1299
1454
  # @!attribute [rw] tags
@@ -1329,13 +1484,27 @@ module Aws::ForecastService
1329
1484
  # of `aws` do not count against your tags per resource limit.
1330
1485
  # @return [Array<Types::Tag>]
1331
1486
  #
1487
+ # @!attribute [rw] time_series_selector
1488
+ # Defines the set of time series that are used to create the forecasts
1489
+ # in a `TimeSeriesIdentifiers` object.
1490
+ #
1491
+ # The `TimeSeriesIdentifiers` object needs the following information:
1492
+ #
1493
+ # * `DataSource`
1494
+ #
1495
+ # * `Format`
1496
+ #
1497
+ # * `Schema`
1498
+ # @return [Types::TimeSeriesSelector]
1499
+ #
1332
1500
  # @see http://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/CreateForecastRequest AWS API Documentation
1333
1501
  #
1334
1502
  class CreateForecastRequest < Struct.new(
1335
1503
  :forecast_name,
1336
1504
  :predictor_arn,
1337
1505
  :forecast_types,
1338
- :tags)
1506
+ :tags,
1507
+ :time_series_selector)
1339
1508
  SENSITIVE = []
1340
1509
  include Aws::Structure
1341
1510
  end
@@ -1352,6 +1521,58 @@ module Aws::ForecastService
1352
1521
  include Aws::Structure
1353
1522
  end
1354
1523
 
1524
+ # @note When making an API call, you may pass CreateMonitorRequest
1525
+ # data as a hash:
1526
+ #
1527
+ # {
1528
+ # monitor_name: "Name", # required
1529
+ # resource_arn: "Arn", # required
1530
+ # tags: [
1531
+ # {
1532
+ # key: "TagKey", # required
1533
+ # value: "TagValue", # required
1534
+ # },
1535
+ # ],
1536
+ # }
1537
+ #
1538
+ # @!attribute [rw] monitor_name
1539
+ # The name of the monitor resource.
1540
+ # @return [String]
1541
+ #
1542
+ # @!attribute [rw] resource_arn
1543
+ # The Amazon Resource Name (ARN) of the predictor to monitor.
1544
+ # @return [String]
1545
+ #
1546
+ # @!attribute [rw] tags
1547
+ # A list of [tags][1] to apply to the monitor resource.
1548
+ #
1549
+ #
1550
+ #
1551
+ # [1]: https://docs.aws.amazon.com/forecast/latest/dg/tagging-forecast-resources.html
1552
+ # @return [Array<Types::Tag>]
1553
+ #
1554
+ # @see http://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/CreateMonitorRequest AWS API Documentation
1555
+ #
1556
+ class CreateMonitorRequest < Struct.new(
1557
+ :monitor_name,
1558
+ :resource_arn,
1559
+ :tags)
1560
+ SENSITIVE = []
1561
+ include Aws::Structure
1562
+ end
1563
+
1564
+ # @!attribute [rw] monitor_arn
1565
+ # The Amazon Resource Name (ARN) of the monitor resource.
1566
+ # @return [String]
1567
+ #
1568
+ # @see http://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/CreateMonitorResponse AWS API Documentation
1569
+ #
1570
+ class CreateMonitorResponse < Struct.new(
1571
+ :monitor_arn)
1572
+ SENSITIVE = []
1573
+ include Aws::Structure
1574
+ end
1575
+
1355
1576
  # @note When making an API call, you may pass CreatePredictorBacktestExportJobRequest
1356
1577
  # data as a hash:
1357
1578
  #
@@ -1371,6 +1592,7 @@ module Aws::ForecastService
1371
1592
  # value: "TagValue", # required
1372
1593
  # },
1373
1594
  # ],
1595
+ # format: "Format",
1374
1596
  # }
1375
1597
  #
1376
1598
  # @!attribute [rw] predictor_backtest_export_job_name
@@ -1419,13 +1641,19 @@ module Aws::ForecastService
1419
1641
  # prefix.
1420
1642
  # @return [Array<Types::Tag>]
1421
1643
  #
1644
+ # @!attribute [rw] format
1645
+ # The format of the exported data, CSV or PARQUET. The default value
1646
+ # is CSV.
1647
+ # @return [String]
1648
+ #
1422
1649
  # @see http://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/CreatePredictorBacktestExportJobRequest AWS API Documentation
1423
1650
  #
1424
1651
  class CreatePredictorBacktestExportJobRequest < Struct.new(
1425
1652
  :predictor_backtest_export_job_name,
1426
1653
  :predictor_arn,
1427
1654
  :destination,
1428
- :tags)
1655
+ :tags,
1656
+ :format)
1429
1657
  SENSITIVE = []
1430
1658
  include Aws::Structure
1431
1659
  end
@@ -1839,9 +2067,14 @@ module Aws::ForecastService
1839
2067
  end
1840
2068
 
1841
2069
  # Provides a summary of the dataset group properties used in the
1842
- # ListDatasetGroups operation. To get the complete set of properties,
1843
- # call the DescribeDatasetGroup operation, and provide the
1844
- # `DatasetGroupArn`.
2070
+ # [ListDatasetGroups][1] operation. To get the complete set of
2071
+ # properties, call the [DescribeDatasetGroup][2] operation, and provide
2072
+ # the `DatasetGroupArn`.
2073
+ #
2074
+ #
2075
+ #
2076
+ # [1]: https://docs.aws.amazon.com/forecast/latest/dg/API_ListDatasetGroups.html
2077
+ # [2]: https://docs.aws.amazon.com/forecast/latest/dg/API_DescribeDatasetGroup.html
1845
2078
  #
1846
2079
  # @!attribute [rw] dataset_group_arn
1847
2080
  # The Amazon Resource Name (ARN) of the dataset group.
@@ -1857,9 +2090,13 @@ module Aws::ForecastService
1857
2090
  #
1858
2091
  # @!attribute [rw] last_modification_time
1859
2092
  # When the dataset group was created or last updated from a call to
1860
- # the UpdateDatasetGroup operation. While the dataset group is being
1861
- # updated, `LastModificationTime` is the current time of the
2093
+ # the [UpdateDatasetGroup][1] operation. While the dataset group is
2094
+ # being updated, `LastModificationTime` is the current time of the
1862
2095
  # `ListDatasetGroups` call.
2096
+ #
2097
+ #
2098
+ #
2099
+ # [1]: https://docs.aws.amazon.com/forecast/latest/dg/API_UpdateDatasetGroup.html
1863
2100
  # @return [Time]
1864
2101
  #
1865
2102
  # @see http://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/DatasetGroupSummary AWS API Documentation
@@ -1874,9 +2111,14 @@ module Aws::ForecastService
1874
2111
  end
1875
2112
 
1876
2113
  # Provides a summary of the dataset import job properties used in the
1877
- # ListDatasetImportJobs operation. To get the complete set of
1878
- # properties, call the DescribeDatasetImportJob operation, and provide
1879
- # the `DatasetImportJobArn`.
2114
+ # [ListDatasetImportJobs][1] operation. To get the complete set of
2115
+ # properties, call the [DescribeDatasetImportJob][2] operation, and
2116
+ # provide the `DatasetImportJobArn`.
2117
+ #
2118
+ #
2119
+ #
2120
+ # [1]: https://docs.aws.amazon.com/forecast/latest/dg/API_ListDatasetImportJobs.html
2121
+ # [2]: https://docs.aws.amazon.com/forecast/latest/dg/API_DescribeDatasetImportJob.html
1880
2122
  #
1881
2123
  # @!attribute [rw] dataset_import_job_arn
1882
2124
  # The Amazon Resource Name (ARN) of the dataset import job.
@@ -1945,9 +2187,14 @@ module Aws::ForecastService
1945
2187
  include Aws::Structure
1946
2188
  end
1947
2189
 
1948
- # Provides a summary of the dataset properties used in the ListDatasets
1949
- # operation. To get the complete set of properties, call the
1950
- # DescribeDataset operation, and provide the `DatasetArn`.
2190
+ # Provides a summary of the dataset properties used in the
2191
+ # [ListDatasets][1] operation. To get the complete set of properties,
2192
+ # call the [DescribeDataset][2] operation, and provide the `DatasetArn`.
2193
+ #
2194
+ #
2195
+ #
2196
+ # [1]: https://docs.aws.amazon.com/forecast/latest/dg/API_ListDatasets.html
2197
+ # [2]: https://docs.aws.amazon.com/forecast/latest/dg/API_DescribeDataset.html
1951
2198
  #
1952
2199
  # @!attribute [rw] dataset_arn
1953
2200
  # The Amazon Resource Name (ARN) of the dataset.
@@ -1973,8 +2220,12 @@ module Aws::ForecastService
1973
2220
  # When you create a dataset, `LastModificationTime` is the same as
1974
2221
  # `CreationTime`. While data is being imported to the dataset,
1975
2222
  # `LastModificationTime` is the current time of the `ListDatasets`
1976
- # call. After a CreateDatasetImportJob operation has finished,
2223
+ # call. After a [CreateDatasetImportJob][1] operation has finished,
1977
2224
  # `LastModificationTime` is when the import job completed or failed.
2225
+ #
2226
+ #
2227
+ #
2228
+ # [1]: https://docs.aws.amazon.com/forecast/latest/dg/API_CreateDatasetImportJob.html
1978
2229
  # @return [Time]
1979
2230
  #
1980
2231
  # @see http://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/DatasetSummary AWS API Documentation
@@ -2125,6 +2376,25 @@ module Aws::ForecastService
2125
2376
  include Aws::Structure
2126
2377
  end
2127
2378
 
2379
+ # @note When making an API call, you may pass DeleteMonitorRequest
2380
+ # data as a hash:
2381
+ #
2382
+ # {
2383
+ # monitor_arn: "Arn", # required
2384
+ # }
2385
+ #
2386
+ # @!attribute [rw] monitor_arn
2387
+ # The Amazon Resource Name (ARN) of the monitor resource to delete.
2388
+ # @return [String]
2389
+ #
2390
+ # @see http://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/DeleteMonitorRequest AWS API Documentation
2391
+ #
2392
+ class DeleteMonitorRequest < Struct.new(
2393
+ :monitor_arn)
2394
+ SENSITIVE = []
2395
+ include Aws::Structure
2396
+ end
2397
+
2128
2398
  # @note When making an API call, you may pass DeletePredictorBacktestExportJobRequest
2129
2399
  # data as a hash:
2130
2400
  #
@@ -2306,6 +2576,15 @@ module Aws::ForecastService
2306
2576
  # Provides the status and ARN of the Predictor Explainability.
2307
2577
  # @return [Types::ExplainabilityInfo]
2308
2578
  #
2579
+ # @!attribute [rw] monitor_info
2580
+ # A object with the Amazon Resource Name (ARN) and status of the
2581
+ # monitor resource.
2582
+ # @return [Types::MonitorInfo]
2583
+ #
2584
+ # @!attribute [rw] time_alignment_boundary
2585
+ # The time boundary Forecast uses when aggregating data.
2586
+ # @return [Types::TimeAlignmentBoundary]
2587
+ #
2309
2588
  # @see http://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/DescribeAutoPredictorResponse AWS API Documentation
2310
2589
  #
2311
2590
  class DescribeAutoPredictorResponse < Struct.new(
@@ -2325,7 +2604,9 @@ module Aws::ForecastService
2325
2604
  :creation_time,
2326
2605
  :last_modification_time,
2327
2606
  :optimization_metric,
2328
- :explainability_info)
2607
+ :explainability_info,
2608
+ :monitor_info,
2609
+ :time_alignment_boundary)
2329
2610
  SENSITIVE = []
2330
2611
  include Aws::Structure
2331
2612
  end
@@ -2377,13 +2658,17 @@ module Aws::ForecastService
2377
2658
  #
2378
2659
  # * `UPDATE_PENDING`, `UPDATE_IN_PROGRESS`, `UPDATE_FAILED`
2379
2660
  #
2380
- # The `UPDATE` states apply when you call the UpdateDatasetGroup
2661
+ # The `UPDATE` states apply when you call the [UpdateDatasetGroup][1]
2381
2662
  # operation.
2382
2663
  #
2383
2664
  # <note markdown="1"> The `Status` of the dataset group must be `ACTIVE` before you can
2384
2665
  # use the dataset group to create a predictor.
2385
2666
  #
2386
2667
  # </note>
2668
+ #
2669
+ #
2670
+ #
2671
+ # [1]: https://docs.aws.amazon.com/forecast/latest/dg/API_UpdateDatasetGroup.html
2387
2672
  # @return [String]
2388
2673
  #
2389
2674
  # @!attribute [rw] creation_time
@@ -2392,9 +2677,13 @@ module Aws::ForecastService
2392
2677
  #
2393
2678
  # @!attribute [rw] last_modification_time
2394
2679
  # When the dataset group was created or last updated from a call to
2395
- # the UpdateDatasetGroup operation. While the dataset group is being
2396
- # updated, `LastModificationTime` is the current time of the
2680
+ # the [UpdateDatasetGroup][1] operation. While the dataset group is
2681
+ # being updated, `LastModificationTime` is the current time of the
2397
2682
  # `DescribeDatasetGroup` call.
2683
+ #
2684
+ #
2685
+ #
2686
+ # [1]: https://docs.aws.amazon.com/forecast/latest/dg/API_UpdateDatasetGroup.html
2398
2687
  # @return [Time]
2399
2688
  #
2400
2689
  # @see http://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/DescribeDatasetGroupResponse AWS API Documentation
@@ -2530,6 +2819,10 @@ module Aws::ForecastService
2530
2819
  # * `ACTIVE` or `CREATE_FAILED` - When the job finished or failed.
2531
2820
  # @return [Time]
2532
2821
  #
2822
+ # @!attribute [rw] format
2823
+ # The format of the imported data, CSV or PARQUET.
2824
+ # @return [String]
2825
+ #
2533
2826
  # @see http://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/DescribeDatasetImportJobResponse AWS API Documentation
2534
2827
  #
2535
2828
  class DescribeDatasetImportJobResponse < Struct.new(
@@ -2547,7 +2840,8 @@ module Aws::ForecastService
2547
2840
  :status,
2548
2841
  :message,
2549
2842
  :creation_time,
2550
- :last_modification_time)
2843
+ :last_modification_time,
2844
+ :format)
2551
2845
  SENSITIVE = []
2552
2846
  include Aws::Structure
2553
2847
  end
@@ -2620,7 +2914,7 @@ module Aws::ForecastService
2620
2914
  # * `UPDATE_PENDING`, `UPDATE_IN_PROGRESS`, `UPDATE_FAILED`
2621
2915
  #
2622
2916
  # The `UPDATE` states apply while data is imported to the dataset from
2623
- # a call to the CreateDatasetImportJob operation and reflect the
2917
+ # a call to the [CreateDatasetImportJob][1] operation and reflect the
2624
2918
  # status of the dataset import job. For example, when the import job
2625
2919
  # status is `CREATE_IN_PROGRESS`, the status of the dataset is
2626
2920
  # `UPDATE_IN_PROGRESS`.
@@ -2629,6 +2923,10 @@ module Aws::ForecastService
2629
2923
  # training data.
2630
2924
  #
2631
2925
  # </note>
2926
+ #
2927
+ #
2928
+ #
2929
+ # [1]: https://docs.aws.amazon.com/forecast/latest/dg/API_CreateDatasetImportJob.html
2632
2930
  # @return [String]
2633
2931
  #
2634
2932
  # @!attribute [rw] creation_time
@@ -2639,8 +2937,12 @@ module Aws::ForecastService
2639
2937
  # When you create a dataset, `LastModificationTime` is the same as
2640
2938
  # `CreationTime`. While data is being imported to the dataset,
2641
2939
  # `LastModificationTime` is the current time of the `DescribeDataset`
2642
- # call. After a CreateDatasetImportJob operation has finished,
2940
+ # call. After a [CreateDatasetImportJob][1] operation has finished,
2643
2941
  # `LastModificationTime` is when the import job completed or failed.
2942
+ #
2943
+ #
2944
+ #
2945
+ # [1]: https://docs.aws.amazon.com/forecast/latest/dg/API_CreateDatasetImportJob.html
2644
2946
  # @return [Time]
2645
2947
  #
2646
2948
  # @see http://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/DescribeDatasetResponse AWS API Documentation
@@ -2688,7 +2990,7 @@ module Aws::ForecastService
2688
2990
  # @return [String]
2689
2991
  #
2690
2992
  # @!attribute [rw] explainability_arn
2691
- # The Amazon Resource Name (ARN) of the Explainability.
2993
+ # The Amazon Resource Name (ARN) of the Explainability export.
2692
2994
  # @return [String]
2693
2995
  #
2694
2996
  # @!attribute [rw] destination
@@ -2733,6 +3035,10 @@ module Aws::ForecastService
2733
3035
  # * `ACTIVE` or `CREATE_FAILED` - When the job finished or failed.
2734
3036
  # @return [Time]
2735
3037
  #
3038
+ # @!attribute [rw] format
3039
+ # The format of the exported data, CSV or PARQUET.
3040
+ # @return [String]
3041
+ #
2736
3042
  # @see http://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/DescribeExplainabilityExportResponse AWS API Documentation
2737
3043
  #
2738
3044
  class DescribeExplainabilityExportResponse < Struct.new(
@@ -2743,7 +3049,8 @@ module Aws::ForecastService
2743
3049
  :message,
2744
3050
  :status,
2745
3051
  :creation_time,
2746
- :last_modification_time)
3052
+ :last_modification_time,
3053
+ :format)
2747
3054
  SENSITIVE = []
2748
3055
  include Aws::Structure
2749
3056
  end
@@ -2947,6 +3254,10 @@ module Aws::ForecastService
2947
3254
  # * `ACTIVE` or `CREATE_FAILED` - When the job finished or failed.
2948
3255
  # @return [Time]
2949
3256
  #
3257
+ # @!attribute [rw] format
3258
+ # The format of the exported data, CSV or PARQUET.
3259
+ # @return [String]
3260
+ #
2950
3261
  # @see http://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/DescribeForecastExportJobResponse AWS API Documentation
2951
3262
  #
2952
3263
  class DescribeForecastExportJobResponse < Struct.new(
@@ -2957,7 +3268,8 @@ module Aws::ForecastService
2957
3268
  :message,
2958
3269
  :status,
2959
3270
  :creation_time,
2960
- :last_modification_time)
3271
+ :last_modification_time,
3272
+ :format)
2961
3273
  SENSITIVE = []
2962
3274
  include Aws::Structure
2963
3275
  end
@@ -3047,6 +3359,10 @@ module Aws::ForecastService
3047
3359
  # * `ACTIVE` or `CREATE_FAILED` - When the job finished or failed.
3048
3360
  # @return [Time]
3049
3361
  #
3362
+ # @!attribute [rw] time_series_selector
3363
+ # The time series to include in the forecast.
3364
+ # @return [Types::TimeSeriesSelector]
3365
+ #
3050
3366
  # @see http://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/DescribeForecastResponse AWS API Documentation
3051
3367
  #
3052
3368
  class DescribeForecastResponse < Struct.new(
@@ -3059,7 +3375,92 @@ module Aws::ForecastService
3059
3375
  :status,
3060
3376
  :message,
3061
3377
  :creation_time,
3062
- :last_modification_time)
3378
+ :last_modification_time,
3379
+ :time_series_selector)
3380
+ SENSITIVE = []
3381
+ include Aws::Structure
3382
+ end
3383
+
3384
+ # @note When making an API call, you may pass DescribeMonitorRequest
3385
+ # data as a hash:
3386
+ #
3387
+ # {
3388
+ # monitor_arn: "Arn", # required
3389
+ # }
3390
+ #
3391
+ # @!attribute [rw] monitor_arn
3392
+ # The Amazon Resource Name (ARN) of the monitor resource to describe.
3393
+ # @return [String]
3394
+ #
3395
+ # @see http://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/DescribeMonitorRequest AWS API Documentation
3396
+ #
3397
+ class DescribeMonitorRequest < Struct.new(
3398
+ :monitor_arn)
3399
+ SENSITIVE = []
3400
+ include Aws::Structure
3401
+ end
3402
+
3403
+ # @!attribute [rw] monitor_name
3404
+ # The name of the monitor.
3405
+ # @return [String]
3406
+ #
3407
+ # @!attribute [rw] monitor_arn
3408
+ # The Amazon Resource Name (ARN) of the monitor resource described.
3409
+ # @return [String]
3410
+ #
3411
+ # @!attribute [rw] resource_arn
3412
+ # The Amazon Resource Name (ARN) of the auto predictor being
3413
+ # monitored.
3414
+ # @return [String]
3415
+ #
3416
+ # @!attribute [rw] status
3417
+ # The status of the monitor resource.
3418
+ # @return [String]
3419
+ #
3420
+ # @!attribute [rw] last_evaluation_time
3421
+ # The timestamp of the latest evaluation completed by the monitor.
3422
+ # @return [Time]
3423
+ #
3424
+ # @!attribute [rw] last_evaluation_state
3425
+ # The state of the monitor's latest evaluation.
3426
+ # @return [String]
3427
+ #
3428
+ # @!attribute [rw] baseline
3429
+ # Metrics you can use as a baseline for comparison purposes. Use these
3430
+ # values you interpret monitoring results for an auto predictor.
3431
+ # @return [Types::Baseline]
3432
+ #
3433
+ # @!attribute [rw] message
3434
+ # An error message, if any, for the monitor.
3435
+ # @return [String]
3436
+ #
3437
+ # @!attribute [rw] creation_time
3438
+ # The timestamp for when the monitor resource was created.
3439
+ # @return [Time]
3440
+ #
3441
+ # @!attribute [rw] last_modification_time
3442
+ # The timestamp of the latest modification to the monitor.
3443
+ # @return [Time]
3444
+ #
3445
+ # @!attribute [rw] estimated_evaluation_time_remaining_in_minutes
3446
+ # The estimated number of minutes remaining before the monitor
3447
+ # resource finishes its current evaluation.
3448
+ # @return [Integer]
3449
+ #
3450
+ # @see http://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/DescribeMonitorResponse AWS API Documentation
3451
+ #
3452
+ class DescribeMonitorResponse < Struct.new(
3453
+ :monitor_name,
3454
+ :monitor_arn,
3455
+ :resource_arn,
3456
+ :status,
3457
+ :last_evaluation_time,
3458
+ :last_evaluation_state,
3459
+ :baseline,
3460
+ :message,
3461
+ :creation_time,
3462
+ :last_modification_time,
3463
+ :estimated_evaluation_time_remaining_in_minutes)
3063
3464
  SENSITIVE = []
3064
3465
  include Aws::Structure
3065
3466
  end
@@ -3138,6 +3539,10 @@ module Aws::ForecastService
3138
3539
  # * `ACTIVE` or `CREATE_FAILED` - When the job finished or failed.
3139
3540
  # @return [Time]
3140
3541
  #
3542
+ # @!attribute [rw] format
3543
+ # The format of the exported data, CSV or PARQUET.
3544
+ # @return [String]
3545
+ #
3141
3546
  # @see http://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/DescribePredictorBacktestExportJobResponse AWS API Documentation
3142
3547
  #
3143
3548
  class DescribePredictorBacktestExportJobResponse < Struct.new(
@@ -3148,7 +3553,8 @@ module Aws::ForecastService
3148
3553
  :message,
3149
3554
  :status,
3150
3555
  :creation_time,
3151
- :last_modification_time)
3556
+ :last_modification_time,
3557
+ :format)
3152
3558
  SENSITIVE = []
3153
3559
  include Aws::Structure
3154
3560
  end
@@ -3509,8 +3915,8 @@ module Aws::ForecastService
3509
3915
  # use `ALL`. To create an Explainability for specific time series in
3510
3916
  # your datasets, use `SPECIFIC`.
3511
3917
  #
3512
- # Specify time series by uploading a CSV file to an Amazon S3 bucket
3513
- # and set the location within the DataDestination data type.
3918
+ # Specify time series by uploading a CSV or Parquet file to an Amazon
3919
+ # S3 bucket and set the location within the DataDestination data type.
3514
3920
  # @return [String]
3515
3921
  #
3516
3922
  # @!attribute [rw] time_point_granularity
@@ -4858,12 +5264,13 @@ module Aws::ForecastService
4858
5264
  include Aws::Structure
4859
5265
  end
4860
5266
 
4861
- # @note When making an API call, you may pass ListPredictorBacktestExportJobsRequest
5267
+ # @note When making an API call, you may pass ListMonitorEvaluationsRequest
4862
5268
  # data as a hash:
4863
5269
  #
4864
5270
  # {
4865
5271
  # next_token: "NextToken",
4866
5272
  # max_results: 1,
5273
+ # monitor_arn: "Arn", # required
4867
5274
  # filters: [
4868
5275
  # {
4869
5276
  # key: "String", # required
@@ -4875,45 +5282,216 @@ module Aws::ForecastService
4875
5282
  #
4876
5283
  # @!attribute [rw] next_token
4877
5284
  # If the result of the previous request was truncated, the response
4878
- # includes a NextToken. To retrieve the next set of results, use the
5285
+ # includes a `NextToken`. To retrieve the next set of results, use the
4879
5286
  # token in the next request. Tokens expire after 24 hours.
4880
5287
  # @return [String]
4881
5288
  #
4882
5289
  # @!attribute [rw] max_results
4883
- # The number of items to return in the response.
5290
+ # The maximum number of monitoring results to return.
4884
5291
  # @return [Integer]
4885
5292
  #
5293
+ # @!attribute [rw] monitor_arn
5294
+ # The Amazon Resource Name (ARN) of the monitor resource to get
5295
+ # results from.
5296
+ # @return [String]
5297
+ #
4886
5298
  # @!attribute [rw] filters
4887
5299
  # An array of filters. For each filter, provide a condition and a
4888
5300
  # match statement. The condition is either `IS` or `IS_NOT`, which
4889
- # specifies whether to include or exclude the predictor backtest
4890
- # export jobs that match the statement from the list. The match
4891
- # statement consists of a key and a value.
5301
+ # specifies whether to include or exclude the resources that match the
5302
+ # statement from the list. The match statement consists of a key and a
5303
+ # value.
4892
5304
  #
4893
5305
  # **Filter properties**
4894
5306
  #
4895
5307
  # * `Condition` - The condition to apply. Valid values are `IS` and
4896
- # `IS_NOT`. To include the predictor backtest export jobs that match
4897
- # the statement, specify `IS`. To exclude matching predictor
4898
- # backtest export jobs, specify `IS_NOT`.
5308
+ # `IS_NOT`.
4899
5309
  #
4900
- # * `Key` - The name of the parameter to filter on. Valid values are
4901
- # `PredictorArn` and `Status`.
5310
+ # * `Key` - The name of the parameter to filter on. The only valid
5311
+ # value is `EvaluationState`.
4902
5312
  #
4903
- # * `Value` - The value to match.
5313
+ # * `Value` - The value to match. Valid values are only `SUCCESS` or
5314
+ # `FAILURE`.
5315
+ #
5316
+ # For example, to list only successful monitor evaluations, you would
5317
+ # specify:
5318
+ #
5319
+ # `"Filters": [ \{ "Condition": "IS", "Key": "EvaluationState",
5320
+ # "Value": "SUCCESS" \} ]`
4904
5321
  # @return [Array<Types::Filter>]
4905
5322
  #
4906
- # @see http://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/ListPredictorBacktestExportJobsRequest AWS API Documentation
5323
+ # @see http://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/ListMonitorEvaluationsRequest AWS API Documentation
4907
5324
  #
4908
- class ListPredictorBacktestExportJobsRequest < Struct.new(
5325
+ class ListMonitorEvaluationsRequest < Struct.new(
4909
5326
  :next_token,
4910
5327
  :max_results,
5328
+ :monitor_arn,
4911
5329
  :filters)
4912
5330
  SENSITIVE = []
4913
5331
  include Aws::Structure
4914
5332
  end
4915
5333
 
4916
- # @!attribute [rw] predictor_backtest_export_jobs
5334
+ # @!attribute [rw] next_token
5335
+ # If the response is truncated, Amazon Forecast returns this token. To
5336
+ # retrieve the next set of results, use the token in the next request.
5337
+ # Tokens expire after 24 hours.
5338
+ # @return [String]
5339
+ #
5340
+ # @!attribute [rw] predictor_monitor_evaluations
5341
+ # The monitoring results and predictor events collected by the monitor
5342
+ # resource during different windows of time.
5343
+ #
5344
+ # For information about monitoring see [Viewing Monitoring
5345
+ # Results][1]. For more information about retrieving monitoring
5346
+ # results see [Viewing Monitoring Results][1].
5347
+ #
5348
+ #
5349
+ #
5350
+ # [1]: https://docs.aws.amazon.com/forecast/latest/dg/predictor-monitoring-results.html
5351
+ # @return [Array<Types::PredictorMonitorEvaluation>]
5352
+ #
5353
+ # @see http://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/ListMonitorEvaluationsResponse AWS API Documentation
5354
+ #
5355
+ class ListMonitorEvaluationsResponse < Struct.new(
5356
+ :next_token,
5357
+ :predictor_monitor_evaluations)
5358
+ SENSITIVE = []
5359
+ include Aws::Structure
5360
+ end
5361
+
5362
+ # @note When making an API call, you may pass ListMonitorsRequest
5363
+ # data as a hash:
5364
+ #
5365
+ # {
5366
+ # next_token: "NextToken",
5367
+ # max_results: 1,
5368
+ # filters: [
5369
+ # {
5370
+ # key: "String", # required
5371
+ # value: "Arn", # required
5372
+ # condition: "IS", # required, accepts IS, IS_NOT
5373
+ # },
5374
+ # ],
5375
+ # }
5376
+ #
5377
+ # @!attribute [rw] next_token
5378
+ # If the result of the previous request was truncated, the response
5379
+ # includes a `NextToken`. To retrieve the next set of results, use the
5380
+ # token in the next request. Tokens expire after 24 hours.
5381
+ # @return [String]
5382
+ #
5383
+ # @!attribute [rw] max_results
5384
+ # The maximum number of monitors to include in the response.
5385
+ # @return [Integer]
5386
+ #
5387
+ # @!attribute [rw] filters
5388
+ # An array of filters. For each filter, provide a condition and a
5389
+ # match statement. The condition is either `IS` or `IS_NOT`, which
5390
+ # specifies whether to include or exclude the resources that match the
5391
+ # statement from the list. The match statement consists of a key and a
5392
+ # value.
5393
+ #
5394
+ # **Filter properties**
5395
+ #
5396
+ # * `Condition` - The condition to apply. Valid values are `IS` and
5397
+ # `IS_NOT`.
5398
+ #
5399
+ # * `Key` - The name of the parameter to filter on. The only valid
5400
+ # value is `Status`.
5401
+ #
5402
+ # * `Value` - The value to match.
5403
+ #
5404
+ # For example, to list all monitors who's status is ACTIVE, you would
5405
+ # specify:
5406
+ #
5407
+ # `"Filters": [ \{ "Condition": "IS", "Key": "Status", "Value":
5408
+ # "ACTIVE" \} ]`
5409
+ # @return [Array<Types::Filter>]
5410
+ #
5411
+ # @see http://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/ListMonitorsRequest AWS API Documentation
5412
+ #
5413
+ class ListMonitorsRequest < Struct.new(
5414
+ :next_token,
5415
+ :max_results,
5416
+ :filters)
5417
+ SENSITIVE = []
5418
+ include Aws::Structure
5419
+ end
5420
+
5421
+ # @!attribute [rw] monitors
5422
+ # An array of objects that summarize each monitor's properties.
5423
+ # @return [Array<Types::MonitorSummary>]
5424
+ #
5425
+ # @!attribute [rw] next_token
5426
+ # If the response is truncated, Amazon Forecast returns this token. To
5427
+ # retrieve the next set of results, use the token in the next request.
5428
+ # @return [String]
5429
+ #
5430
+ # @see http://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/ListMonitorsResponse AWS API Documentation
5431
+ #
5432
+ class ListMonitorsResponse < Struct.new(
5433
+ :monitors,
5434
+ :next_token)
5435
+ SENSITIVE = []
5436
+ include Aws::Structure
5437
+ end
5438
+
5439
+ # @note When making an API call, you may pass ListPredictorBacktestExportJobsRequest
5440
+ # data as a hash:
5441
+ #
5442
+ # {
5443
+ # next_token: "NextToken",
5444
+ # max_results: 1,
5445
+ # filters: [
5446
+ # {
5447
+ # key: "String", # required
5448
+ # value: "Arn", # required
5449
+ # condition: "IS", # required, accepts IS, IS_NOT
5450
+ # },
5451
+ # ],
5452
+ # }
5453
+ #
5454
+ # @!attribute [rw] next_token
5455
+ # If the result of the previous request was truncated, the response
5456
+ # includes a NextToken. To retrieve the next set of results, use the
5457
+ # token in the next request. Tokens expire after 24 hours.
5458
+ # @return [String]
5459
+ #
5460
+ # @!attribute [rw] max_results
5461
+ # The number of items to return in the response.
5462
+ # @return [Integer]
5463
+ #
5464
+ # @!attribute [rw] filters
5465
+ # An array of filters. For each filter, provide a condition and a
5466
+ # match statement. The condition is either `IS` or `IS_NOT`, which
5467
+ # specifies whether to include or exclude the predictor backtest
5468
+ # export jobs that match the statement from the list. The match
5469
+ # statement consists of a key and a value.
5470
+ #
5471
+ # **Filter properties**
5472
+ #
5473
+ # * `Condition` - The condition to apply. Valid values are `IS` and
5474
+ # `IS_NOT`. To include the predictor backtest export jobs that match
5475
+ # the statement, specify `IS`. To exclude matching predictor
5476
+ # backtest export jobs, specify `IS_NOT`.
5477
+ #
5478
+ # * `Key` - The name of the parameter to filter on. Valid values are
5479
+ # `PredictorArn` and `Status`.
5480
+ #
5481
+ # * `Value` - The value to match.
5482
+ # @return [Array<Types::Filter>]
5483
+ #
5484
+ # @see http://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/ListPredictorBacktestExportJobsRequest AWS API Documentation
5485
+ #
5486
+ class ListPredictorBacktestExportJobsRequest < Struct.new(
5487
+ :next_token,
5488
+ :max_results,
5489
+ :filters)
5490
+ SENSITIVE = []
5491
+ include Aws::Structure
5492
+ end
5493
+
5494
+ # @!attribute [rw] predictor_backtest_export_jobs
4917
5495
  # An array of objects that summarize the properties of each predictor
4918
5496
  # backtest export job.
4919
5497
  # @return [Array<Types::PredictorBacktestExportJobSummary>]
@@ -5042,6 +5620,35 @@ module Aws::ForecastService
5042
5620
  include Aws::Structure
5043
5621
  end
5044
5622
 
5623
+ # An individual metric Forecast calculated when monitoring predictor
5624
+ # usage. You can compare the value for this metric to the metric's
5625
+ # value in the Baseline to see how your predictor's performance is
5626
+ # changing.
5627
+ #
5628
+ # For more information about metrics generated by Forecast see
5629
+ # [Evaluating Predictor Accuracy][1]
5630
+ #
5631
+ #
5632
+ #
5633
+ # [1]: https://docs.aws.amazon.com/forecast/latest/dg/metrics.html
5634
+ #
5635
+ # @!attribute [rw] metric_name
5636
+ # The name of the metric.
5637
+ # @return [String]
5638
+ #
5639
+ # @!attribute [rw] metric_value
5640
+ # The value for the metric.
5641
+ # @return [Float]
5642
+ #
5643
+ # @see http://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/MetricResult AWS API Documentation
5644
+ #
5645
+ class MetricResult < Struct.new(
5646
+ :metric_name,
5647
+ :metric_value)
5648
+ SENSITIVE = []
5649
+ include Aws::Structure
5650
+ end
5651
+
5045
5652
  # Provides metrics that are used to evaluate the performance of a
5046
5653
  # predictor. This object is part of the WindowSummary object.
5047
5654
  #
@@ -5077,6 +5684,144 @@ module Aws::ForecastService
5077
5684
  include Aws::Structure
5078
5685
  end
5079
5686
 
5687
+ # The configuration details for the predictor monitor.
5688
+ #
5689
+ # @note When making an API call, you may pass MonitorConfig
5690
+ # data as a hash:
5691
+ #
5692
+ # {
5693
+ # monitor_name: "Name", # required
5694
+ # }
5695
+ #
5696
+ # @!attribute [rw] monitor_name
5697
+ # The name of the monitor resource.
5698
+ # @return [String]
5699
+ #
5700
+ # @see http://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/MonitorConfig AWS API Documentation
5701
+ #
5702
+ class MonitorConfig < Struct.new(
5703
+ :monitor_name)
5704
+ SENSITIVE = []
5705
+ include Aws::Structure
5706
+ end
5707
+
5708
+ # The source of the data the monitor used during the evaluation.
5709
+ #
5710
+ # @!attribute [rw] dataset_import_job_arn
5711
+ # The Amazon Resource Name (ARN) of the dataset import job used to
5712
+ # import the data that initiated the monitor evaluation.
5713
+ # @return [String]
5714
+ #
5715
+ # @!attribute [rw] forecast_arn
5716
+ # The Amazon Resource Name (ARN) of the forecast the monitor used
5717
+ # during the evaluation.
5718
+ # @return [String]
5719
+ #
5720
+ # @!attribute [rw] predictor_arn
5721
+ # The Amazon Resource Name (ARN) of the predictor resource you are
5722
+ # monitoring.
5723
+ # @return [String]
5724
+ #
5725
+ # @see http://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/MonitorDataSource AWS API Documentation
5726
+ #
5727
+ class MonitorDataSource < Struct.new(
5728
+ :dataset_import_job_arn,
5729
+ :forecast_arn,
5730
+ :predictor_arn)
5731
+ SENSITIVE = []
5732
+ include Aws::Structure
5733
+ end
5734
+
5735
+ # Provides information about the monitor resource.
5736
+ #
5737
+ # @!attribute [rw] monitor_arn
5738
+ # The Amazon Resource Name (ARN) of the monitor resource.
5739
+ # @return [String]
5740
+ #
5741
+ # @!attribute [rw] status
5742
+ # The status of the monitor. States include:
5743
+ #
5744
+ # * `ACTIVE`
5745
+ #
5746
+ # * `ACTIVE_STOPPING`, `ACTIVE_STOPPED`
5747
+ #
5748
+ # * `UPDATE_IN_PROGRESS`
5749
+ #
5750
+ # * `CREATE_PENDING`, `CREATE_IN_PROGRESS`, `CREATE_FAILED`
5751
+ #
5752
+ # * `DELETE_PENDING`, `DELETE_IN_PROGRESS`, `DELETE_FAILED`
5753
+ # @return [String]
5754
+ #
5755
+ # @see http://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/MonitorInfo AWS API Documentation
5756
+ #
5757
+ class MonitorInfo < Struct.new(
5758
+ :monitor_arn,
5759
+ :status)
5760
+ SENSITIVE = []
5761
+ include Aws::Structure
5762
+ end
5763
+
5764
+ # Provides a summary of the monitor properties used in the ListMonitors
5765
+ # operation. To get a complete set of properties, call the
5766
+ # DescribeMonitor operation, and provide the listed `MonitorArn`.
5767
+ #
5768
+ # @!attribute [rw] monitor_arn
5769
+ # The Amazon Resource Name (ARN) of the monitor resource.
5770
+ # @return [String]
5771
+ #
5772
+ # @!attribute [rw] monitor_name
5773
+ # The name of the monitor resource.
5774
+ # @return [String]
5775
+ #
5776
+ # @!attribute [rw] resource_arn
5777
+ # The Amazon Resource Name (ARN) of the predictor being monitored.
5778
+ # @return [String]
5779
+ #
5780
+ # @!attribute [rw] status
5781
+ # The status of the monitor. States include:
5782
+ #
5783
+ # * `ACTIVE`
5784
+ #
5785
+ # * `ACTIVE_STOPPING`, `ACTIVE_STOPPED`
5786
+ #
5787
+ # * `UPDATE_IN_PROGRESS`
5788
+ #
5789
+ # * `CREATE_PENDING`, `CREATE_IN_PROGRESS`, `CREATE_FAILED`
5790
+ #
5791
+ # * `DELETE_PENDING`, `DELETE_IN_PROGRESS`, `DELETE_FAILED`
5792
+ # @return [String]
5793
+ #
5794
+ # @!attribute [rw] creation_time
5795
+ # When the monitor resource was created.
5796
+ # @return [Time]
5797
+ #
5798
+ # @!attribute [rw] last_modification_time
5799
+ # The last time the monitor resource was modified. The timestamp
5800
+ # depends on the status of the job:
5801
+ #
5802
+ # * `CREATE_PENDING` - The `CreationTime`.
5803
+ #
5804
+ # * `CREATE_IN_PROGRESS` - The current timestamp.
5805
+ #
5806
+ # * `STOPPED` - When the resource stopped.
5807
+ #
5808
+ # * `ACTIVE` or `CREATE_FAILED` - When the monitor creation finished
5809
+ # or failed.
5810
+ # @return [Time]
5811
+ #
5812
+ # @see http://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/MonitorSummary AWS API Documentation
5813
+ #
5814
+ class MonitorSummary < Struct.new(
5815
+ :monitor_arn,
5816
+ :monitor_name,
5817
+ :resource_arn,
5818
+ :status,
5819
+ :creation_time,
5820
+ :last_modification_time)
5821
+ SENSITIVE = []
5822
+ include Aws::Structure
5823
+ end
5824
+
5080
5825
  # Specifies the categorical, continuous, and integer hyperparameters,
5081
5826
  # and their ranges of tunable values. The range of tunable values
5082
5827
  # determines which values that a hyperparameter tuning job can choose
@@ -5204,6 +5949,49 @@ module Aws::ForecastService
5204
5949
  include Aws::Structure
5205
5950
  end
5206
5951
 
5952
+ # Metrics you can use as a baseline for comparison purposes. Use these
5953
+ # metrics when you interpret monitoring results for an auto predictor.
5954
+ #
5955
+ # @!attribute [rw] baseline_metrics
5956
+ # The initial [accuracy metrics][1] for the predictor. Use these
5957
+ # metrics as a baseline for comparison purposes as you use your
5958
+ # predictor and the metrics change.
5959
+ #
5960
+ #
5961
+ #
5962
+ # [1]: https://docs.aws.amazon.com/forecast/latest/dg/metrics.html
5963
+ # @return [Array<Types::BaselineMetric>]
5964
+ #
5965
+ # @see http://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/PredictorBaseline AWS API Documentation
5966
+ #
5967
+ class PredictorBaseline < Struct.new(
5968
+ :baseline_metrics)
5969
+ SENSITIVE = []
5970
+ include Aws::Structure
5971
+ end
5972
+
5973
+ # Provides details about a predictor event, such as a retraining.
5974
+ #
5975
+ # @!attribute [rw] detail
5976
+ # The type of event. For example, `Retrain`. A retraining event
5977
+ # denotes the timepoint when a predictor was retrained. Any monitor
5978
+ # results from before the `Datetime` are from the previous predictor.
5979
+ # Any new metrics are for the newly retrained predictor.
5980
+ # @return [String]
5981
+ #
5982
+ # @!attribute [rw] datetime
5983
+ # The timestamp for when the event occurred.
5984
+ # @return [Time]
5985
+ #
5986
+ # @see http://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/PredictorEvent AWS API Documentation
5987
+ #
5988
+ class PredictorEvent < Struct.new(
5989
+ :detail,
5990
+ :datetime)
5991
+ SENSITIVE = []
5992
+ include Aws::Structure
5993
+ end
5994
+
5207
5995
  # The algorithm used to perform a backtest and the status of those
5208
5996
  # tests.
5209
5997
  #
@@ -5246,6 +6034,79 @@ module Aws::ForecastService
5246
6034
  include Aws::Structure
5247
6035
  end
5248
6036
 
6037
+ # Describes the results of a monitor evaluation.
6038
+ #
6039
+ # @!attribute [rw] resource_arn
6040
+ # The Amazon Resource Name (ARN) of the resource to monitor.
6041
+ # @return [String]
6042
+ #
6043
+ # @!attribute [rw] monitor_arn
6044
+ # The Amazon Resource Name (ARN) of the monitor resource.
6045
+ # @return [String]
6046
+ #
6047
+ # @!attribute [rw] evaluation_time
6048
+ # The timestamp that indicates when the monitor evaluation was
6049
+ # started.
6050
+ # @return [Time]
6051
+ #
6052
+ # @!attribute [rw] evaluation_state
6053
+ # The status of the monitor evaluation. The state can be `SUCCESS` or
6054
+ # `FAILURE`.
6055
+ # @return [String]
6056
+ #
6057
+ # @!attribute [rw] window_start_datetime
6058
+ # The timestamp that indicates the start of the window that is used
6059
+ # for monitor evaluation.
6060
+ # @return [Time]
6061
+ #
6062
+ # @!attribute [rw] window_end_datetime
6063
+ # The timestamp that indicates the end of the window that is used for
6064
+ # monitor evaluation.
6065
+ # @return [Time]
6066
+ #
6067
+ # @!attribute [rw] predictor_event
6068
+ # Provides details about a predictor event, such as a retraining.
6069
+ # @return [Types::PredictorEvent]
6070
+ #
6071
+ # @!attribute [rw] monitor_data_source
6072
+ # The source of the data the monitor resource used during the
6073
+ # evaluation.
6074
+ # @return [Types::MonitorDataSource]
6075
+ #
6076
+ # @!attribute [rw] metric_results
6077
+ # A list of metrics Forecast calculated when monitoring a predictor.
6078
+ # You can compare the value for each metric in the list to the
6079
+ # metric's value in the Baseline to see how your predictor's
6080
+ # performance is changing.
6081
+ # @return [Array<Types::MetricResult>]
6082
+ #
6083
+ # @!attribute [rw] num_items_evaluated
6084
+ # The number of items considered during the evaluation.
6085
+ # @return [Integer]
6086
+ #
6087
+ # @!attribute [rw] message
6088
+ # Information about any errors that may have occurred during the
6089
+ # monitor evaluation.
6090
+ # @return [String]
6091
+ #
6092
+ # @see http://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/PredictorMonitorEvaluation AWS API Documentation
6093
+ #
6094
+ class PredictorMonitorEvaluation < Struct.new(
6095
+ :resource_arn,
6096
+ :monitor_arn,
6097
+ :evaluation_time,
6098
+ :evaluation_state,
6099
+ :window_start_datetime,
6100
+ :window_end_datetime,
6101
+ :predictor_event,
6102
+ :monitor_data_source,
6103
+ :metric_results,
6104
+ :num_items_evaluated,
6105
+ :message)
6106
+ SENSITIVE = []
6107
+ include Aws::Structure
6108
+ end
6109
+
5249
6110
  # Provides a summary of the predictor properties that are used in the
5250
6111
  # ListPredictors operation. To get the complete set of properties, call
5251
6112
  # the DescribePredictor operation, and provide the listed
@@ -5390,6 +6251,25 @@ module Aws::ForecastService
5390
6251
  include Aws::Structure
5391
6252
  end
5392
6253
 
6254
+ # @note When making an API call, you may pass ResumeResourceRequest
6255
+ # data as a hash:
6256
+ #
6257
+ # {
6258
+ # resource_arn: "Arn", # required
6259
+ # }
6260
+ #
6261
+ # @!attribute [rw] resource_arn
6262
+ # The Amazon Resource Name (ARN) of the monitor resource to resume.
6263
+ # @return [String]
6264
+ #
6265
+ # @see http://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/ResumeResourceRequest AWS API Documentation
6266
+ #
6267
+ class ResumeResourceRequest < Struct.new(
6268
+ :resource_arn)
6269
+ SENSITIVE = []
6270
+ include Aws::Structure
6271
+ end
6272
+
5393
6273
  # The path to the file(s) in an Amazon Simple Storage Service (Amazon
5394
6274
  # S3) bucket, and an AWS Identity and Access Management (IAM) role that
5395
6275
  # Amazon Forecast can assume to access the file(s). Optionally, includes
@@ -5465,8 +6345,12 @@ module Aws::ForecastService
5465
6345
  end
5466
6346
 
5467
6347
  # An attribute of a schema, which defines a dataset field. A schema
5468
- # attribute is required for every field in a dataset. The Schema object
5469
- # contains an array of `SchemaAttribute` objects.
6348
+ # attribute is required for every field in a dataset. The [Schema][1]
6349
+ # object contains an array of `SchemaAttribute` objects.
6350
+ #
6351
+ #
6352
+ #
6353
+ # [1]: https://docs.aws.amazon.com/forecast/latest/dg/API_Schema.html
5470
6354
  #
5471
6355
  # @note When making an API call, you may pass SchemaAttribute
5472
6356
  # data as a hash:
@@ -5482,6 +6366,10 @@ module Aws::ForecastService
5482
6366
  #
5483
6367
  # @!attribute [rw] attribute_type
5484
6368
  # The data type of the field.
6369
+ #
6370
+ # For a related time series dataset, other than date, item\_id, and
6371
+ # forecast dimensions attributes, all attributes should be of
6372
+ # numerical type (integer/float).
5485
6373
  # @return [String]
5486
6374
  #
5487
6375
  # @see http://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/SchemaAttribute AWS API Documentation
@@ -5494,7 +6382,11 @@ module Aws::ForecastService
5494
6382
  end
5495
6383
 
5496
6384
  # Provides statistics for each data field imported into to an Amazon
5497
- # Forecast dataset with the CreateDatasetImportJob operation.
6385
+ # Forecast dataset with the [CreateDatasetImportJob][1] operation.
6386
+ #
6387
+ #
6388
+ #
6389
+ # [1]: https://docs.aws.amazon.com/forecast/latest/dg/API_CreateDatasetImportJob.html
5498
6390
  #
5499
6391
  # @!attribute [rw] count
5500
6392
  # The number of values in the field. If the response value is -1,
@@ -5949,6 +6841,157 @@ module Aws::ForecastService
5949
6841
  include Aws::Structure
5950
6842
  end
5951
6843
 
6844
+ # The time boundary Forecast uses to align and aggregate your data to
6845
+ # match your forecast frequency. Provide the unit of time and the time
6846
+ # boundary as a key value pair. If you don't provide a time boundary,
6847
+ # Forecast uses a set of [Default Time Boundaries][1].
6848
+ #
6849
+ # For more information about aggregation, see [Data Aggregation for
6850
+ # Different Forecast Frequencies][2]. For more information setting a
6851
+ # custom time boundary, see [Specifying a Time Boundary][3].
6852
+ #
6853
+ #
6854
+ #
6855
+ # [1]: https://docs.aws.amazon.com/forecast/latest/dg/data-aggregation.html#default-time-boundaries
6856
+ # [2]: https://docs.aws.amazon.com/forecast/latest/dg/data-aggregation.html
6857
+ # [3]: https://docs.aws.amazon.com/forecast/latest/dg/data-aggregation.html#specifying-time-boundary
6858
+ #
6859
+ # @note When making an API call, you may pass TimeAlignmentBoundary
6860
+ # data as a hash:
6861
+ #
6862
+ # {
6863
+ # month: "JANUARY", # accepts JANUARY, FEBRUARY, MARCH, APRIL, MAY, JUNE, JULY, AUGUST, SEPTEMBER, OCTOBER, NOVEMBER, DECEMBER
6864
+ # day_of_month: 1,
6865
+ # day_of_week: "MONDAY", # accepts MONDAY, TUESDAY, WEDNESDAY, THURSDAY, FRIDAY, SATURDAY, SUNDAY
6866
+ # hour: 1,
6867
+ # }
6868
+ #
6869
+ # @!attribute [rw] month
6870
+ # The month to use for time alignment during aggregation. The month
6871
+ # must be in uppercase.
6872
+ # @return [String]
6873
+ #
6874
+ # @!attribute [rw] day_of_month
6875
+ # The day of the month to use for time alignment during aggregation.
6876
+ # @return [Integer]
6877
+ #
6878
+ # @!attribute [rw] day_of_week
6879
+ # The day of week to use for time alignment during aggregation. The
6880
+ # day must be in uppercase.
6881
+ # @return [String]
6882
+ #
6883
+ # @!attribute [rw] hour
6884
+ # The hour of day to use for time alignment during aggregation.
6885
+ # @return [Integer]
6886
+ #
6887
+ # @see http://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/TimeAlignmentBoundary AWS API Documentation
6888
+ #
6889
+ class TimeAlignmentBoundary < Struct.new(
6890
+ :month,
6891
+ :day_of_month,
6892
+ :day_of_week,
6893
+ :hour)
6894
+ SENSITIVE = []
6895
+ include Aws::Structure
6896
+ end
6897
+
6898
+ # Details about the import file that contains the time series for which
6899
+ # you want to create forecasts.
6900
+ #
6901
+ # @note When making an API call, you may pass TimeSeriesIdentifiers
6902
+ # data as a hash:
6903
+ #
6904
+ # {
6905
+ # data_source: {
6906
+ # s3_config: { # required
6907
+ # path: "S3Path", # required
6908
+ # role_arn: "Arn", # required
6909
+ # kms_key_arn: "KMSKeyArn",
6910
+ # },
6911
+ # },
6912
+ # schema: {
6913
+ # attributes: [
6914
+ # {
6915
+ # attribute_name: "Name",
6916
+ # attribute_type: "string", # accepts string, integer, float, timestamp, geolocation
6917
+ # },
6918
+ # ],
6919
+ # },
6920
+ # format: "Format",
6921
+ # }
6922
+ #
6923
+ # @!attribute [rw] data_source
6924
+ # The source of your data, an AWS Identity and Access Management (IAM)
6925
+ # role that allows Amazon Forecast to access the data and, optionally,
6926
+ # an AWS Key Management Service (KMS) key.
6927
+ # @return [Types::DataSource]
6928
+ #
6929
+ # @!attribute [rw] schema
6930
+ # Defines the fields of a dataset.
6931
+ # @return [Types::Schema]
6932
+ #
6933
+ # @!attribute [rw] format
6934
+ # The format of the data, either CSV or PARQUET.
6935
+ # @return [String]
6936
+ #
6937
+ # @see http://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/TimeSeriesIdentifiers AWS API Documentation
6938
+ #
6939
+ class TimeSeriesIdentifiers < Struct.new(
6940
+ :data_source,
6941
+ :schema,
6942
+ :format)
6943
+ SENSITIVE = []
6944
+ include Aws::Structure
6945
+ end
6946
+
6947
+ # Defines the set of time series that are used to create the forecasts
6948
+ # in a `TimeSeriesIdentifiers` object.
6949
+ #
6950
+ # The `TimeSeriesIdentifiers` object needs the following information:
6951
+ #
6952
+ # * `DataSource`
6953
+ #
6954
+ # * `Format`
6955
+ #
6956
+ # * `Schema`
6957
+ #
6958
+ # @note When making an API call, you may pass TimeSeriesSelector
6959
+ # data as a hash:
6960
+ #
6961
+ # {
6962
+ # time_series_identifiers: {
6963
+ # data_source: {
6964
+ # s3_config: { # required
6965
+ # path: "S3Path", # required
6966
+ # role_arn: "Arn", # required
6967
+ # kms_key_arn: "KMSKeyArn",
6968
+ # },
6969
+ # },
6970
+ # schema: {
6971
+ # attributes: [
6972
+ # {
6973
+ # attribute_name: "Name",
6974
+ # attribute_type: "string", # accepts string, integer, float, timestamp, geolocation
6975
+ # },
6976
+ # ],
6977
+ # },
6978
+ # format: "Format",
6979
+ # },
6980
+ # }
6981
+ #
6982
+ # @!attribute [rw] time_series_identifiers
6983
+ # Details about the import file that contains the time series for
6984
+ # which you want to create forecasts.
6985
+ # @return [Types::TimeSeriesIdentifiers]
6986
+ #
6987
+ # @see http://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/TimeSeriesSelector AWS API Documentation
6988
+ #
6989
+ class TimeSeriesSelector < Struct.new(
6990
+ :time_series_identifiers)
6991
+ SENSITIVE = []
6992
+ include Aws::Structure
6993
+ end
6994
+
5952
6995
  # @note When making an API call, you may pass UntagResourceRequest
5953
6996
  # data as a hash:
5954
6997
  #