aws-sdk-forecastservice 1.32.0 → 1.35.0

Sign up to get free protection for your applications and to get access to all the features.
@@ -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
@@ -694,7 +791,11 @@ module Aws::ForecastService
694
791
  # Management Service (KMS) key and the IAM role must allow Amazon
695
792
  # Forecast permission to access the key. The KMS key and IAM role must
696
793
  # match those specified in the `EncryptionConfig` parameter of the
697
- # CreateDataset operation.
794
+ # [CreateDataset][1] operation.
795
+ #
796
+ #
797
+ #
798
+ # [1]: https://docs.aws.amazon.com/forecast/latest/dg/API_CreateDataset.html
698
799
  # @return [Types::DataSource]
699
800
  #
700
801
  # @!attribute [rw] timestamp_format
@@ -841,14 +942,19 @@ module Aws::ForecastService
841
942
  # @!attribute [rw] domain
842
943
  # The domain associated with the dataset. When you add a dataset to a
843
944
  # dataset group, this value and the value specified for the `Domain`
844
- # parameter of the CreateDatasetGroup operation must match.
945
+ # parameter of the [CreateDatasetGroup][1] operation must match.
845
946
  #
846
947
  # The `Domain` and `DatasetType` that you choose determine the fields
847
948
  # that must be present in the training data that you import to the
848
949
  # dataset. For example, if you choose the `RETAIL` domain and
849
950
  # `TARGET_TIME_SERIES` as the `DatasetType`, Amazon Forecast requires
850
951
  # `item_id`, `timestamp`, and `demand` fields to be present in your
851
- # data. For more information, see howitworks-datasets-groups.
952
+ # data. For more information, see [Importing datasets][2].
953
+ #
954
+ #
955
+ #
956
+ # [1]: https://docs.aws.amazon.com/forecast/latest/dg/API_CreateDatasetGroup.html
957
+ # [2]: https://docs.aws.amazon.com/forecast/latest/dg/howitworks-datasets-groups.html
852
958
  # @return [String]
853
959
  #
854
960
  # @!attribute [rw] dataset_type
@@ -870,7 +976,12 @@ module Aws::ForecastService
870
976
  # must match the fields in your data. The dataset `Domain` and
871
977
  # `DatasetType` that you choose determine the minimum required fields
872
978
  # in your training data. For information about the required fields for
873
- # a specific dataset domain and type, see howitworks-domains-ds-types.
979
+ # a specific dataset domain and type, see [Dataset Domains and Dataset
980
+ # Types][1].
981
+ #
982
+ #
983
+ #
984
+ # [1]: https://docs.aws.amazon.com/forecast/latest/dg/howitworks-domains-ds-types.html
874
985
  # @return [Types::Schema]
875
986
  #
876
987
  # @!attribute [rw] encryption_config
@@ -1088,7 +1199,7 @@ module Aws::ForecastService
1088
1199
  # @return [Types::Schema]
1089
1200
  #
1090
1201
  # @!attribute [rw] enable_visualization
1091
- # Create an Expainability visualization that is viewable within the
1202
+ # Create an Explainability visualization that is viewable within the
1092
1203
  # AWS console.
1093
1204
  # @return [Boolean]
1094
1205
  #
@@ -1293,7 +1404,11 @@ module Aws::ForecastService
1293
1404
  # values include `0.01 to 0.99` (increments of .01 only) and `mean`.
1294
1405
  # The mean forecast is different from the median (0.50) when the
1295
1406
  # distribution is not symmetric (for example, Beta and Negative
1296
- # Binomial). The default value is `["0.1", "0.5", "0.9"]`.
1407
+ # Binomial).
1408
+ #
1409
+ # The default quantiles are the quantiles you specified during
1410
+ # predictor creation. If you didn't specify quantiles, the default
1411
+ # values are `["0.1", "0.5", "0.9"]`.
1297
1412
  # @return [Array<String>]
1298
1413
  #
1299
1414
  # @!attribute [rw] tags
@@ -1352,6 +1467,58 @@ module Aws::ForecastService
1352
1467
  include Aws::Structure
1353
1468
  end
1354
1469
 
1470
+ # @note When making an API call, you may pass CreateMonitorRequest
1471
+ # data as a hash:
1472
+ #
1473
+ # {
1474
+ # monitor_name: "Name", # required
1475
+ # resource_arn: "Arn", # required
1476
+ # tags: [
1477
+ # {
1478
+ # key: "TagKey", # required
1479
+ # value: "TagValue", # required
1480
+ # },
1481
+ # ],
1482
+ # }
1483
+ #
1484
+ # @!attribute [rw] monitor_name
1485
+ # The name of the monitor resource.
1486
+ # @return [String]
1487
+ #
1488
+ # @!attribute [rw] resource_arn
1489
+ # The Amazon Resource Name (ARN) of the predictor to monitor.
1490
+ # @return [String]
1491
+ #
1492
+ # @!attribute [rw] tags
1493
+ # A list of [tags][1] to apply to the monitor resource.
1494
+ #
1495
+ #
1496
+ #
1497
+ # [1]: https://docs.aws.amazon.com/forecast/latest/dg/tagging-forecast-resources.html
1498
+ # @return [Array<Types::Tag>]
1499
+ #
1500
+ # @see http://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/CreateMonitorRequest AWS API Documentation
1501
+ #
1502
+ class CreateMonitorRequest < Struct.new(
1503
+ :monitor_name,
1504
+ :resource_arn,
1505
+ :tags)
1506
+ SENSITIVE = []
1507
+ include Aws::Structure
1508
+ end
1509
+
1510
+ # @!attribute [rw] monitor_arn
1511
+ # The Amazon Resource Name (ARN) of the monitor resource.
1512
+ # @return [String]
1513
+ #
1514
+ # @see http://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/CreateMonitorResponse AWS API Documentation
1515
+ #
1516
+ class CreateMonitorResponse < Struct.new(
1517
+ :monitor_arn)
1518
+ SENSITIVE = []
1519
+ include Aws::Structure
1520
+ end
1521
+
1355
1522
  # @note When making an API call, you may pass CreatePredictorBacktestExportJobRequest
1356
1523
  # data as a hash:
1357
1524
  #
@@ -1839,9 +2006,14 @@ module Aws::ForecastService
1839
2006
  end
1840
2007
 
1841
2008
  # 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`.
2009
+ # [ListDatasetGroups][1] operation. To get the complete set of
2010
+ # properties, call the [DescribeDatasetGroup][2] operation, and provide
2011
+ # the `DatasetGroupArn`.
2012
+ #
2013
+ #
2014
+ #
2015
+ # [1]: https://docs.aws.amazon.com/forecast/latest/dg/API_ListDatasetGroups.html
2016
+ # [2]: https://docs.aws.amazon.com/forecast/latest/dg/API_DescribeDatasetGroup.html
1845
2017
  #
1846
2018
  # @!attribute [rw] dataset_group_arn
1847
2019
  # The Amazon Resource Name (ARN) of the dataset group.
@@ -1857,9 +2029,13 @@ module Aws::ForecastService
1857
2029
  #
1858
2030
  # @!attribute [rw] last_modification_time
1859
2031
  # 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
2032
+ # the [UpdateDatasetGroup][1] operation. While the dataset group is
2033
+ # being updated, `LastModificationTime` is the current time of the
1862
2034
  # `ListDatasetGroups` call.
2035
+ #
2036
+ #
2037
+ #
2038
+ # [1]: https://docs.aws.amazon.com/forecast/latest/dg/API_UpdateDatasetGroup.html
1863
2039
  # @return [Time]
1864
2040
  #
1865
2041
  # @see http://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/DatasetGroupSummary AWS API Documentation
@@ -1874,9 +2050,14 @@ module Aws::ForecastService
1874
2050
  end
1875
2051
 
1876
2052
  # 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`.
2053
+ # [ListDatasetImportJobs][1] operation. To get the complete set of
2054
+ # properties, call the [DescribeDatasetImportJob][2] operation, and
2055
+ # provide the `DatasetImportJobArn`.
2056
+ #
2057
+ #
2058
+ #
2059
+ # [1]: https://docs.aws.amazon.com/forecast/latest/dg/API_ListDatasetImportJobs.html
2060
+ # [2]: https://docs.aws.amazon.com/forecast/latest/dg/API_DescribeDatasetImportJob.html
1880
2061
  #
1881
2062
  # @!attribute [rw] dataset_import_job_arn
1882
2063
  # The Amazon Resource Name (ARN) of the dataset import job.
@@ -1945,9 +2126,14 @@ module Aws::ForecastService
1945
2126
  include Aws::Structure
1946
2127
  end
1947
2128
 
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`.
2129
+ # Provides a summary of the dataset properties used in the
2130
+ # [ListDatasets][1] operation. To get the complete set of properties,
2131
+ # call the [DescribeDataset][2] operation, and provide the `DatasetArn`.
2132
+ #
2133
+ #
2134
+ #
2135
+ # [1]: https://docs.aws.amazon.com/forecast/latest/dg/API_ListDatasets.html
2136
+ # [2]: https://docs.aws.amazon.com/forecast/latest/dg/API_DescribeDataset.html
1951
2137
  #
1952
2138
  # @!attribute [rw] dataset_arn
1953
2139
  # The Amazon Resource Name (ARN) of the dataset.
@@ -1973,8 +2159,12 @@ module Aws::ForecastService
1973
2159
  # When you create a dataset, `LastModificationTime` is the same as
1974
2160
  # `CreationTime`. While data is being imported to the dataset,
1975
2161
  # `LastModificationTime` is the current time of the `ListDatasets`
1976
- # call. After a CreateDatasetImportJob operation has finished,
2162
+ # call. After a [CreateDatasetImportJob][1] operation has finished,
1977
2163
  # `LastModificationTime` is when the import job completed or failed.
2164
+ #
2165
+ #
2166
+ #
2167
+ # [1]: https://docs.aws.amazon.com/forecast/latest/dg/API_CreateDatasetImportJob.html
1978
2168
  # @return [Time]
1979
2169
  #
1980
2170
  # @see http://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/DatasetSummary AWS API Documentation
@@ -2125,6 +2315,25 @@ module Aws::ForecastService
2125
2315
  include Aws::Structure
2126
2316
  end
2127
2317
 
2318
+ # @note When making an API call, you may pass DeleteMonitorRequest
2319
+ # data as a hash:
2320
+ #
2321
+ # {
2322
+ # monitor_arn: "Arn", # required
2323
+ # }
2324
+ #
2325
+ # @!attribute [rw] monitor_arn
2326
+ # The Amazon Resource Name (ARN) of the monitor resource to delete.
2327
+ # @return [String]
2328
+ #
2329
+ # @see http://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/DeleteMonitorRequest AWS API Documentation
2330
+ #
2331
+ class DeleteMonitorRequest < Struct.new(
2332
+ :monitor_arn)
2333
+ SENSITIVE = []
2334
+ include Aws::Structure
2335
+ end
2336
+
2128
2337
  # @note When making an API call, you may pass DeletePredictorBacktestExportJobRequest
2129
2338
  # data as a hash:
2130
2339
  #
@@ -2306,6 +2515,15 @@ module Aws::ForecastService
2306
2515
  # Provides the status and ARN of the Predictor Explainability.
2307
2516
  # @return [Types::ExplainabilityInfo]
2308
2517
  #
2518
+ # @!attribute [rw] monitor_info
2519
+ # A object with the Amazon Resource Name (ARN) and status of the
2520
+ # monitor resource.
2521
+ # @return [Types::MonitorInfo]
2522
+ #
2523
+ # @!attribute [rw] time_alignment_boundary
2524
+ # The time boundary Forecast uses when aggregating data.
2525
+ # @return [Types::TimeAlignmentBoundary]
2526
+ #
2309
2527
  # @see http://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/DescribeAutoPredictorResponse AWS API Documentation
2310
2528
  #
2311
2529
  class DescribeAutoPredictorResponse < Struct.new(
@@ -2325,7 +2543,9 @@ module Aws::ForecastService
2325
2543
  :creation_time,
2326
2544
  :last_modification_time,
2327
2545
  :optimization_metric,
2328
- :explainability_info)
2546
+ :explainability_info,
2547
+ :monitor_info,
2548
+ :time_alignment_boundary)
2329
2549
  SENSITIVE = []
2330
2550
  include Aws::Structure
2331
2551
  end
@@ -2377,13 +2597,17 @@ module Aws::ForecastService
2377
2597
  #
2378
2598
  # * `UPDATE_PENDING`, `UPDATE_IN_PROGRESS`, `UPDATE_FAILED`
2379
2599
  #
2380
- # The `UPDATE` states apply when you call the UpdateDatasetGroup
2600
+ # The `UPDATE` states apply when you call the [UpdateDatasetGroup][1]
2381
2601
  # operation.
2382
2602
  #
2383
2603
  # <note markdown="1"> The `Status` of the dataset group must be `ACTIVE` before you can
2384
2604
  # use the dataset group to create a predictor.
2385
2605
  #
2386
2606
  # </note>
2607
+ #
2608
+ #
2609
+ #
2610
+ # [1]: https://docs.aws.amazon.com/forecast/latest/dg/API_UpdateDatasetGroup.html
2387
2611
  # @return [String]
2388
2612
  #
2389
2613
  # @!attribute [rw] creation_time
@@ -2392,9 +2616,13 @@ module Aws::ForecastService
2392
2616
  #
2393
2617
  # @!attribute [rw] last_modification_time
2394
2618
  # 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
2619
+ # the [UpdateDatasetGroup][1] operation. While the dataset group is
2620
+ # being updated, `LastModificationTime` is the current time of the
2397
2621
  # `DescribeDatasetGroup` call.
2622
+ #
2623
+ #
2624
+ #
2625
+ # [1]: https://docs.aws.amazon.com/forecast/latest/dg/API_UpdateDatasetGroup.html
2398
2626
  # @return [Time]
2399
2627
  #
2400
2628
  # @see http://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/DescribeDatasetGroupResponse AWS API Documentation
@@ -2620,7 +2848,7 @@ module Aws::ForecastService
2620
2848
  # * `UPDATE_PENDING`, `UPDATE_IN_PROGRESS`, `UPDATE_FAILED`
2621
2849
  #
2622
2850
  # The `UPDATE` states apply while data is imported to the dataset from
2623
- # a call to the CreateDatasetImportJob operation and reflect the
2851
+ # a call to the [CreateDatasetImportJob][1] operation and reflect the
2624
2852
  # status of the dataset import job. For example, when the import job
2625
2853
  # status is `CREATE_IN_PROGRESS`, the status of the dataset is
2626
2854
  # `UPDATE_IN_PROGRESS`.
@@ -2629,6 +2857,10 @@ module Aws::ForecastService
2629
2857
  # training data.
2630
2858
  #
2631
2859
  # </note>
2860
+ #
2861
+ #
2862
+ #
2863
+ # [1]: https://docs.aws.amazon.com/forecast/latest/dg/API_CreateDatasetImportJob.html
2632
2864
  # @return [String]
2633
2865
  #
2634
2866
  # @!attribute [rw] creation_time
@@ -2639,8 +2871,12 @@ module Aws::ForecastService
2639
2871
  # When you create a dataset, `LastModificationTime` is the same as
2640
2872
  # `CreationTime`. While data is being imported to the dataset,
2641
2873
  # `LastModificationTime` is the current time of the `DescribeDataset`
2642
- # call. After a CreateDatasetImportJob operation has finished,
2874
+ # call. After a [CreateDatasetImportJob][1] operation has finished,
2643
2875
  # `LastModificationTime` is when the import job completed or failed.
2876
+ #
2877
+ #
2878
+ #
2879
+ # [1]: https://docs.aws.amazon.com/forecast/latest/dg/API_CreateDatasetImportJob.html
2644
2880
  # @return [Time]
2645
2881
  #
2646
2882
  # @see http://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/DescribeDatasetResponse AWS API Documentation
@@ -3064,6 +3300,90 @@ module Aws::ForecastService
3064
3300
  include Aws::Structure
3065
3301
  end
3066
3302
 
3303
+ # @note When making an API call, you may pass DescribeMonitorRequest
3304
+ # data as a hash:
3305
+ #
3306
+ # {
3307
+ # monitor_arn: "Arn", # required
3308
+ # }
3309
+ #
3310
+ # @!attribute [rw] monitor_arn
3311
+ # The Amazon Resource Name (ARN) of the monitor resource to describe.
3312
+ # @return [String]
3313
+ #
3314
+ # @see http://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/DescribeMonitorRequest AWS API Documentation
3315
+ #
3316
+ class DescribeMonitorRequest < Struct.new(
3317
+ :monitor_arn)
3318
+ SENSITIVE = []
3319
+ include Aws::Structure
3320
+ end
3321
+
3322
+ # @!attribute [rw] monitor_name
3323
+ # The name of the monitor.
3324
+ # @return [String]
3325
+ #
3326
+ # @!attribute [rw] monitor_arn
3327
+ # The Amazon Resource Name (ARN) of the monitor resource described.
3328
+ # @return [String]
3329
+ #
3330
+ # @!attribute [rw] resource_arn
3331
+ # The Amazon Resource Name (ARN) of the auto predictor being
3332
+ # monitored.
3333
+ # @return [String]
3334
+ #
3335
+ # @!attribute [rw] status
3336
+ # The status of the monitor resource.
3337
+ # @return [String]
3338
+ #
3339
+ # @!attribute [rw] last_evaluation_time
3340
+ # The timestamp of the latest evaluation completed by the monitor.
3341
+ # @return [Time]
3342
+ #
3343
+ # @!attribute [rw] last_evaluation_state
3344
+ # The state of the monitor's latest evaluation.
3345
+ # @return [String]
3346
+ #
3347
+ # @!attribute [rw] baseline
3348
+ # Metrics you can use as a baseline for comparison purposes. Use these
3349
+ # values you interpret monitoring results for an auto predictor.
3350
+ # @return [Types::Baseline]
3351
+ #
3352
+ # @!attribute [rw] message
3353
+ # An error message, if any, for the monitor.
3354
+ # @return [String]
3355
+ #
3356
+ # @!attribute [rw] creation_time
3357
+ # The timestamp for when the monitor resource was created.
3358
+ # @return [Time]
3359
+ #
3360
+ # @!attribute [rw] last_modification_time
3361
+ # The timestamp of the latest modification to the monitor.
3362
+ # @return [Time]
3363
+ #
3364
+ # @!attribute [rw] estimated_evaluation_time_remaining_in_minutes
3365
+ # The estimated number of minutes remaining before the monitor
3366
+ # resource finishes its current evaluation.
3367
+ # @return [Integer]
3368
+ #
3369
+ # @see http://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/DescribeMonitorResponse AWS API Documentation
3370
+ #
3371
+ class DescribeMonitorResponse < Struct.new(
3372
+ :monitor_name,
3373
+ :monitor_arn,
3374
+ :resource_arn,
3375
+ :status,
3376
+ :last_evaluation_time,
3377
+ :last_evaluation_state,
3378
+ :baseline,
3379
+ :message,
3380
+ :creation_time,
3381
+ :last_modification_time,
3382
+ :estimated_evaluation_time_remaining_in_minutes)
3383
+ SENSITIVE = []
3384
+ include Aws::Structure
3385
+ end
3386
+
3067
3387
  # @note When making an API call, you may pass DescribePredictorBacktestExportJobRequest
3068
3388
  # data as a hash:
3069
3389
  #
@@ -4858,6 +5178,178 @@ module Aws::ForecastService
4858
5178
  include Aws::Structure
4859
5179
  end
4860
5180
 
5181
+ # @note When making an API call, you may pass ListMonitorEvaluationsRequest
5182
+ # data as a hash:
5183
+ #
5184
+ # {
5185
+ # next_token: "NextToken",
5186
+ # max_results: 1,
5187
+ # monitor_arn: "Arn", # required
5188
+ # filters: [
5189
+ # {
5190
+ # key: "String", # required
5191
+ # value: "Arn", # required
5192
+ # condition: "IS", # required, accepts IS, IS_NOT
5193
+ # },
5194
+ # ],
5195
+ # }
5196
+ #
5197
+ # @!attribute [rw] next_token
5198
+ # If the result of the previous request was truncated, the response
5199
+ # includes a `NextToken`. To retrieve the next set of results, use the
5200
+ # token in the next request. Tokens expire after 24 hours.
5201
+ # @return [String]
5202
+ #
5203
+ # @!attribute [rw] max_results
5204
+ # The maximum number of monitoring results to return.
5205
+ # @return [Integer]
5206
+ #
5207
+ # @!attribute [rw] monitor_arn
5208
+ # The Amazon Resource Name (ARN) of the monitor resource to get
5209
+ # results from.
5210
+ # @return [String]
5211
+ #
5212
+ # @!attribute [rw] filters
5213
+ # An array of filters. For each filter, provide a condition and a
5214
+ # match statement. The condition is either `IS` or `IS_NOT`, which
5215
+ # specifies whether to include or exclude the resources that match the
5216
+ # statement from the list. The match statement consists of a key and a
5217
+ # value.
5218
+ #
5219
+ # **Filter properties**
5220
+ #
5221
+ # * `Condition` - The condition to apply. Valid values are `IS` and
5222
+ # `IS_NOT`.
5223
+ #
5224
+ # * `Key` - The name of the parameter to filter on. The only valid
5225
+ # value is `EvaluationState`.
5226
+ #
5227
+ # * `Value` - The value to match. Valid values are only `SUCCESS` or
5228
+ # `FAILURE`.
5229
+ #
5230
+ # For example, to list only successful monitor evaluations, you would
5231
+ # specify:
5232
+ #
5233
+ # `"Filters": [ \{ "Condition": "IS", "Key": "EvaluationState",
5234
+ # "Value": "SUCCESS" \} ]`
5235
+ # @return [Array<Types::Filter>]
5236
+ #
5237
+ # @see http://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/ListMonitorEvaluationsRequest AWS API Documentation
5238
+ #
5239
+ class ListMonitorEvaluationsRequest < Struct.new(
5240
+ :next_token,
5241
+ :max_results,
5242
+ :monitor_arn,
5243
+ :filters)
5244
+ SENSITIVE = []
5245
+ include Aws::Structure
5246
+ end
5247
+
5248
+ # @!attribute [rw] next_token
5249
+ # If the response is truncated, Amazon Forecast returns this token. To
5250
+ # retrieve the next set of results, use the token in the next request.
5251
+ # Tokens expire after 24 hours.
5252
+ # @return [String]
5253
+ #
5254
+ # @!attribute [rw] predictor_monitor_evaluations
5255
+ # The monitoring results and predictor events collected by the monitor
5256
+ # resource during different windows of time.
5257
+ #
5258
+ # For information about monitoring see [Viewing Monitoring
5259
+ # Results][1]. For more information about retrieving monitoring
5260
+ # results see [Viewing Monitoring Results][1].
5261
+ #
5262
+ #
5263
+ #
5264
+ # [1]: https://docs.aws.amazon.com/forecast/latest/dg/predictor-monitoring-results.html
5265
+ # @return [Array<Types::PredictorMonitorEvaluation>]
5266
+ #
5267
+ # @see http://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/ListMonitorEvaluationsResponse AWS API Documentation
5268
+ #
5269
+ class ListMonitorEvaluationsResponse < Struct.new(
5270
+ :next_token,
5271
+ :predictor_monitor_evaluations)
5272
+ SENSITIVE = []
5273
+ include Aws::Structure
5274
+ end
5275
+
5276
+ # @note When making an API call, you may pass ListMonitorsRequest
5277
+ # data as a hash:
5278
+ #
5279
+ # {
5280
+ # next_token: "NextToken",
5281
+ # max_results: 1,
5282
+ # filters: [
5283
+ # {
5284
+ # key: "String", # required
5285
+ # value: "Arn", # required
5286
+ # condition: "IS", # required, accepts IS, IS_NOT
5287
+ # },
5288
+ # ],
5289
+ # }
5290
+ #
5291
+ # @!attribute [rw] next_token
5292
+ # If the result of the previous request was truncated, the response
5293
+ # includes a `NextToken`. To retrieve the next set of results, use the
5294
+ # token in the next request. Tokens expire after 24 hours.
5295
+ # @return [String]
5296
+ #
5297
+ # @!attribute [rw] max_results
5298
+ # The maximum number of monitors to include in the response.
5299
+ # @return [Integer]
5300
+ #
5301
+ # @!attribute [rw] filters
5302
+ # An array of filters. For each filter, provide a condition and a
5303
+ # match statement. The condition is either `IS` or `IS_NOT`, which
5304
+ # specifies whether to include or exclude the resources that match the
5305
+ # statement from the list. The match statement consists of a key and a
5306
+ # value.
5307
+ #
5308
+ # **Filter properties**
5309
+ #
5310
+ # * `Condition` - The condition to apply. Valid values are `IS` and
5311
+ # `IS_NOT`.
5312
+ #
5313
+ # * `Key` - The name of the parameter to filter on. The only valid
5314
+ # value is `Status`.
5315
+ #
5316
+ # * `Value` - The value to match.
5317
+ #
5318
+ # For example, to list all monitors who's status is ACTIVE, you would
5319
+ # specify:
5320
+ #
5321
+ # `"Filters": [ \{ "Condition": "IS", "Key": "Status", "Value":
5322
+ # "ACTIVE" \} ]`
5323
+ # @return [Array<Types::Filter>]
5324
+ #
5325
+ # @see http://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/ListMonitorsRequest AWS API Documentation
5326
+ #
5327
+ class ListMonitorsRequest < Struct.new(
5328
+ :next_token,
5329
+ :max_results,
5330
+ :filters)
5331
+ SENSITIVE = []
5332
+ include Aws::Structure
5333
+ end
5334
+
5335
+ # @!attribute [rw] monitors
5336
+ # An array of objects that summarize each monitor's properties.
5337
+ # @return [Array<Types::MonitorSummary>]
5338
+ #
5339
+ # @!attribute [rw] next_token
5340
+ # If the response is truncated, Amazon Forecast returns this token. To
5341
+ # retrieve the next set of results, use the token in the next request.
5342
+ # @return [String]
5343
+ #
5344
+ # @see http://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/ListMonitorsResponse AWS API Documentation
5345
+ #
5346
+ class ListMonitorsResponse < Struct.new(
5347
+ :monitors,
5348
+ :next_token)
5349
+ SENSITIVE = []
5350
+ include Aws::Structure
5351
+ end
5352
+
4861
5353
  # @note When making an API call, you may pass ListPredictorBacktestExportJobsRequest
4862
5354
  # data as a hash:
4863
5355
  #
@@ -5042,6 +5534,35 @@ module Aws::ForecastService
5042
5534
  include Aws::Structure
5043
5535
  end
5044
5536
 
5537
+ # An individual metric Forecast calculated when monitoring predictor
5538
+ # usage. You can compare the value for this metric to the metric's
5539
+ # value in the Baseline to see how your predictor's performance is
5540
+ # changing.
5541
+ #
5542
+ # For more information about metrics generated by Forecast see
5543
+ # [Evaluating Predictor Accuracy][1]
5544
+ #
5545
+ #
5546
+ #
5547
+ # [1]: https://docs.aws.amazon.com/forecast/latest/dg/metrics.html
5548
+ #
5549
+ # @!attribute [rw] metric_name
5550
+ # The name of the metric.
5551
+ # @return [String]
5552
+ #
5553
+ # @!attribute [rw] metric_value
5554
+ # The value for the metric.
5555
+ # @return [Float]
5556
+ #
5557
+ # @see http://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/MetricResult AWS API Documentation
5558
+ #
5559
+ class MetricResult < Struct.new(
5560
+ :metric_name,
5561
+ :metric_value)
5562
+ SENSITIVE = []
5563
+ include Aws::Structure
5564
+ end
5565
+
5045
5566
  # Provides metrics that are used to evaluate the performance of a
5046
5567
  # predictor. This object is part of the WindowSummary object.
5047
5568
  #
@@ -5077,6 +5598,144 @@ module Aws::ForecastService
5077
5598
  include Aws::Structure
5078
5599
  end
5079
5600
 
5601
+ # The configuration details for the predictor monitor.
5602
+ #
5603
+ # @note When making an API call, you may pass MonitorConfig
5604
+ # data as a hash:
5605
+ #
5606
+ # {
5607
+ # monitor_name: "Name", # required
5608
+ # }
5609
+ #
5610
+ # @!attribute [rw] monitor_name
5611
+ # The name of the monitor resource.
5612
+ # @return [String]
5613
+ #
5614
+ # @see http://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/MonitorConfig AWS API Documentation
5615
+ #
5616
+ class MonitorConfig < Struct.new(
5617
+ :monitor_name)
5618
+ SENSITIVE = []
5619
+ include Aws::Structure
5620
+ end
5621
+
5622
+ # The source of the data the monitor used during the evaluation.
5623
+ #
5624
+ # @!attribute [rw] dataset_import_job_arn
5625
+ # The Amazon Resource Name (ARN) of the dataset import job used to
5626
+ # import the data that initiated the monitor evaluation.
5627
+ # @return [String]
5628
+ #
5629
+ # @!attribute [rw] forecast_arn
5630
+ # The Amazon Resource Name (ARN) of the forecast the monitor used
5631
+ # during the evaluation.
5632
+ # @return [String]
5633
+ #
5634
+ # @!attribute [rw] predictor_arn
5635
+ # The Amazon Resource Name (ARN) of the predictor resource you are
5636
+ # monitoring.
5637
+ # @return [String]
5638
+ #
5639
+ # @see http://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/MonitorDataSource AWS API Documentation
5640
+ #
5641
+ class MonitorDataSource < Struct.new(
5642
+ :dataset_import_job_arn,
5643
+ :forecast_arn,
5644
+ :predictor_arn)
5645
+ SENSITIVE = []
5646
+ include Aws::Structure
5647
+ end
5648
+
5649
+ # Provides information about the monitor resource.
5650
+ #
5651
+ # @!attribute [rw] monitor_arn
5652
+ # The Amazon Resource Name (ARN) of the monitor resource.
5653
+ # @return [String]
5654
+ #
5655
+ # @!attribute [rw] status
5656
+ # The status of the monitor. States include:
5657
+ #
5658
+ # * `ACTIVE`
5659
+ #
5660
+ # * `ACTIVE_STOPPING`, `ACTIVE_STOPPED`
5661
+ #
5662
+ # * `UPDATE_IN_PROGRESS`
5663
+ #
5664
+ # * `CREATE_PENDING`, `CREATE_IN_PROGRESS`, `CREATE_FAILED`
5665
+ #
5666
+ # * `DELETE_PENDING`, `DELETE_IN_PROGRESS`, `DELETE_FAILED`
5667
+ # @return [String]
5668
+ #
5669
+ # @see http://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/MonitorInfo AWS API Documentation
5670
+ #
5671
+ class MonitorInfo < Struct.new(
5672
+ :monitor_arn,
5673
+ :status)
5674
+ SENSITIVE = []
5675
+ include Aws::Structure
5676
+ end
5677
+
5678
+ # Provides a summary of the monitor properties used in the ListMonitors
5679
+ # operation. To get a complete set of properties, call the
5680
+ # DescribeMonitor operation, and provide the listed `MonitorArn`.
5681
+ #
5682
+ # @!attribute [rw] monitor_arn
5683
+ # The Amazon Resource Name (ARN) of the monitor resource.
5684
+ # @return [String]
5685
+ #
5686
+ # @!attribute [rw] monitor_name
5687
+ # The name of the monitor resource.
5688
+ # @return [String]
5689
+ #
5690
+ # @!attribute [rw] resource_arn
5691
+ # The Amazon Resource Name (ARN) of the predictor being monitored.
5692
+ # @return [String]
5693
+ #
5694
+ # @!attribute [rw] status
5695
+ # The status of the monitor. States include:
5696
+ #
5697
+ # * `ACTIVE`
5698
+ #
5699
+ # * `ACTIVE_STOPPING`, `ACTIVE_STOPPED`
5700
+ #
5701
+ # * `UPDATE_IN_PROGRESS`
5702
+ #
5703
+ # * `CREATE_PENDING`, `CREATE_IN_PROGRESS`, `CREATE_FAILED`
5704
+ #
5705
+ # * `DELETE_PENDING`, `DELETE_IN_PROGRESS`, `DELETE_FAILED`
5706
+ # @return [String]
5707
+ #
5708
+ # @!attribute [rw] creation_time
5709
+ # When the monitor resource was created.
5710
+ # @return [Time]
5711
+ #
5712
+ # @!attribute [rw] last_modification_time
5713
+ # The last time the monitor resource was modified. The timestamp
5714
+ # depends on the status of the job:
5715
+ #
5716
+ # * `CREATE_PENDING` - The `CreationTime`.
5717
+ #
5718
+ # * `CREATE_IN_PROGRESS` - The current timestamp.
5719
+ #
5720
+ # * `STOPPED` - When the resource stopped.
5721
+ #
5722
+ # * `ACTIVE` or `CREATE_FAILED` - When the monitor creation finished
5723
+ # or failed.
5724
+ # @return [Time]
5725
+ #
5726
+ # @see http://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/MonitorSummary AWS API Documentation
5727
+ #
5728
+ class MonitorSummary < Struct.new(
5729
+ :monitor_arn,
5730
+ :monitor_name,
5731
+ :resource_arn,
5732
+ :status,
5733
+ :creation_time,
5734
+ :last_modification_time)
5735
+ SENSITIVE = []
5736
+ include Aws::Structure
5737
+ end
5738
+
5080
5739
  # Specifies the categorical, continuous, and integer hyperparameters,
5081
5740
  # and their ranges of tunable values. The range of tunable values
5082
5741
  # determines which values that a hyperparameter tuning job can choose
@@ -5204,6 +5863,49 @@ module Aws::ForecastService
5204
5863
  include Aws::Structure
5205
5864
  end
5206
5865
 
5866
+ # Metrics you can use as a baseline for comparison purposes. Use these
5867
+ # metrics when you interpret monitoring results for an auto predictor.
5868
+ #
5869
+ # @!attribute [rw] baseline_metrics
5870
+ # The initial [accuracy metrics][1] for the predictor. Use these
5871
+ # metrics as a baseline for comparison purposes as you use your
5872
+ # predictor and the metrics change.
5873
+ #
5874
+ #
5875
+ #
5876
+ # [1]: https://docs.aws.amazon.com/forecast/latest/dg/metrics.html
5877
+ # @return [Array<Types::BaselineMetric>]
5878
+ #
5879
+ # @see http://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/PredictorBaseline AWS API Documentation
5880
+ #
5881
+ class PredictorBaseline < Struct.new(
5882
+ :baseline_metrics)
5883
+ SENSITIVE = []
5884
+ include Aws::Structure
5885
+ end
5886
+
5887
+ # Provides details about a predictor event, such as a retraining.
5888
+ #
5889
+ # @!attribute [rw] detail
5890
+ # The type of event. For example, `Retrain`. A retraining event
5891
+ # denotes the timepoint when a predictor was retrained. Any monitor
5892
+ # results from before the `Datetime` are from the previous predictor.
5893
+ # Any new metrics are for the newly retrained predictor.
5894
+ # @return [String]
5895
+ #
5896
+ # @!attribute [rw] datetime
5897
+ # The timestamp for when the event occurred.
5898
+ # @return [Time]
5899
+ #
5900
+ # @see http://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/PredictorEvent AWS API Documentation
5901
+ #
5902
+ class PredictorEvent < Struct.new(
5903
+ :detail,
5904
+ :datetime)
5905
+ SENSITIVE = []
5906
+ include Aws::Structure
5907
+ end
5908
+
5207
5909
  # The algorithm used to perform a backtest and the status of those
5208
5910
  # tests.
5209
5911
  #
@@ -5246,6 +5948,79 @@ module Aws::ForecastService
5246
5948
  include Aws::Structure
5247
5949
  end
5248
5950
 
5951
+ # Describes the results of a monitor evaluation.
5952
+ #
5953
+ # @!attribute [rw] resource_arn
5954
+ # The Amazon Resource Name (ARN) of the resource to monitor.
5955
+ # @return [String]
5956
+ #
5957
+ # @!attribute [rw] monitor_arn
5958
+ # The Amazon Resource Name (ARN) of the monitor resource.
5959
+ # @return [String]
5960
+ #
5961
+ # @!attribute [rw] evaluation_time
5962
+ # The timestamp that indicates when the monitor evaluation was
5963
+ # started.
5964
+ # @return [Time]
5965
+ #
5966
+ # @!attribute [rw] evaluation_state
5967
+ # The status of the monitor evaluation. The state can be `SUCCESS` or
5968
+ # `FAILURE`.
5969
+ # @return [String]
5970
+ #
5971
+ # @!attribute [rw] window_start_datetime
5972
+ # The timestamp that indicates the start of the window that is used
5973
+ # for monitor evaluation.
5974
+ # @return [Time]
5975
+ #
5976
+ # @!attribute [rw] window_end_datetime
5977
+ # The timestamp that indicates the end of the window that is used for
5978
+ # monitor evaluation.
5979
+ # @return [Time]
5980
+ #
5981
+ # @!attribute [rw] predictor_event
5982
+ # Provides details about a predictor event, such as a retraining.
5983
+ # @return [Types::PredictorEvent]
5984
+ #
5985
+ # @!attribute [rw] monitor_data_source
5986
+ # The source of the data the monitor resource used during the
5987
+ # evaluation.
5988
+ # @return [Types::MonitorDataSource]
5989
+ #
5990
+ # @!attribute [rw] metric_results
5991
+ # A list of metrics Forecast calculated when monitoring a predictor.
5992
+ # You can compare the value for each metric in the list to the
5993
+ # metric's value in the Baseline to see how your predictor's
5994
+ # performance is changing.
5995
+ # @return [Array<Types::MetricResult>]
5996
+ #
5997
+ # @!attribute [rw] num_items_evaluated
5998
+ # The number of items considered during the evaluation.
5999
+ # @return [Integer]
6000
+ #
6001
+ # @!attribute [rw] message
6002
+ # Information about any errors that may have occurred during the
6003
+ # monitor evaluation.
6004
+ # @return [String]
6005
+ #
6006
+ # @see http://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/PredictorMonitorEvaluation AWS API Documentation
6007
+ #
6008
+ class PredictorMonitorEvaluation < Struct.new(
6009
+ :resource_arn,
6010
+ :monitor_arn,
6011
+ :evaluation_time,
6012
+ :evaluation_state,
6013
+ :window_start_datetime,
6014
+ :window_end_datetime,
6015
+ :predictor_event,
6016
+ :monitor_data_source,
6017
+ :metric_results,
6018
+ :num_items_evaluated,
6019
+ :message)
6020
+ SENSITIVE = []
6021
+ include Aws::Structure
6022
+ end
6023
+
5249
6024
  # Provides a summary of the predictor properties that are used in the
5250
6025
  # ListPredictors operation. To get the complete set of properties, call
5251
6026
  # the DescribePredictor operation, and provide the listed
@@ -5390,6 +6165,25 @@ module Aws::ForecastService
5390
6165
  include Aws::Structure
5391
6166
  end
5392
6167
 
6168
+ # @note When making an API call, you may pass ResumeResourceRequest
6169
+ # data as a hash:
6170
+ #
6171
+ # {
6172
+ # resource_arn: "Arn", # required
6173
+ # }
6174
+ #
6175
+ # @!attribute [rw] resource_arn
6176
+ # The Amazon Resource Name (ARN) of the monitor resource to resume.
6177
+ # @return [String]
6178
+ #
6179
+ # @see http://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/ResumeResourceRequest AWS API Documentation
6180
+ #
6181
+ class ResumeResourceRequest < Struct.new(
6182
+ :resource_arn)
6183
+ SENSITIVE = []
6184
+ include Aws::Structure
6185
+ end
6186
+
5393
6187
  # The path to the file(s) in an Amazon Simple Storage Service (Amazon
5394
6188
  # S3) bucket, and an AWS Identity and Access Management (IAM) role that
5395
6189
  # Amazon Forecast can assume to access the file(s). Optionally, includes
@@ -5465,8 +6259,12 @@ module Aws::ForecastService
5465
6259
  end
5466
6260
 
5467
6261
  # 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.
6262
+ # attribute is required for every field in a dataset. The [Schema][1]
6263
+ # object contains an array of `SchemaAttribute` objects.
6264
+ #
6265
+ #
6266
+ #
6267
+ # [1]: https://docs.aws.amazon.com/forecast/latest/dg/API_Schema.html
5470
6268
  #
5471
6269
  # @note When making an API call, you may pass SchemaAttribute
5472
6270
  # data as a hash:
@@ -5482,6 +6280,10 @@ module Aws::ForecastService
5482
6280
  #
5483
6281
  # @!attribute [rw] attribute_type
5484
6282
  # The data type of the field.
6283
+ #
6284
+ # For a related time series dataset, other than date, item\_id, and
6285
+ # forecast dimensions attributes, all attributes should be of
6286
+ # numerical type (integer/float).
5485
6287
  # @return [String]
5486
6288
  #
5487
6289
  # @see http://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/SchemaAttribute AWS API Documentation
@@ -5494,7 +6296,11 @@ module Aws::ForecastService
5494
6296
  end
5495
6297
 
5496
6298
  # Provides statistics for each data field imported into to an Amazon
5497
- # Forecast dataset with the CreateDatasetImportJob operation.
6299
+ # Forecast dataset with the [CreateDatasetImportJob][1] operation.
6300
+ #
6301
+ #
6302
+ #
6303
+ # [1]: https://docs.aws.amazon.com/forecast/latest/dg/API_CreateDatasetImportJob.html
5498
6304
  #
5499
6305
  # @!attribute [rw] count
5500
6306
  # The number of values in the field. If the response value is -1,
@@ -5949,6 +6755,60 @@ module Aws::ForecastService
5949
6755
  include Aws::Structure
5950
6756
  end
5951
6757
 
6758
+ # The time boundary Forecast uses to align and aggregate your data to
6759
+ # match your forecast frequency. Provide the unit of time and the time
6760
+ # boundary as a key value pair. If you don't provide a time boundary,
6761
+ # Forecast uses a set of [Default Time Boundaries][1].
6762
+ #
6763
+ # For more information about aggregation, see [Data Aggregation for
6764
+ # Different Forecast Frequencies][2]. For more information setting a
6765
+ # custom time boundary, see [Specifying a Time Boundary][3].
6766
+ #
6767
+ #
6768
+ #
6769
+ # [1]: https://docs.aws.amazon.com/forecast/latest/dg/data-aggregation.html#default-time-boundaries
6770
+ # [2]: https://docs.aws.amazon.com/forecast/latest/dg/data-aggregation.html
6771
+ # [3]: https://docs.aws.amazon.com/forecast/latest/dg/data-aggregation.html#specifying-time-boundary
6772
+ #
6773
+ # @note When making an API call, you may pass TimeAlignmentBoundary
6774
+ # data as a hash:
6775
+ #
6776
+ # {
6777
+ # month: "JANUARY", # accepts JANUARY, FEBRUARY, MARCH, APRIL, MAY, JUNE, JULY, AUGUST, SEPTEMBER, OCTOBER, NOVEMBER, DECEMBER
6778
+ # day_of_month: 1,
6779
+ # day_of_week: "MONDAY", # accepts MONDAY, TUESDAY, WEDNESDAY, THURSDAY, FRIDAY, SATURDAY, SUNDAY
6780
+ # hour: 1,
6781
+ # }
6782
+ #
6783
+ # @!attribute [rw] month
6784
+ # The month to use for time alignment during aggregation. The month
6785
+ # must be in uppercase.
6786
+ # @return [String]
6787
+ #
6788
+ # @!attribute [rw] day_of_month
6789
+ # The day of the month to use for time alignment during aggregation.
6790
+ # @return [Integer]
6791
+ #
6792
+ # @!attribute [rw] day_of_week
6793
+ # The day of week to use for time alignment during aggregation. The
6794
+ # day must be in uppercase.
6795
+ # @return [String]
6796
+ #
6797
+ # @!attribute [rw] hour
6798
+ # The hour of day to use for time alignment during aggregation.
6799
+ # @return [Integer]
6800
+ #
6801
+ # @see http://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/TimeAlignmentBoundary AWS API Documentation
6802
+ #
6803
+ class TimeAlignmentBoundary < Struct.new(
6804
+ :month,
6805
+ :day_of_month,
6806
+ :day_of_week,
6807
+ :hour)
6808
+ SENSITIVE = []
6809
+ include Aws::Structure
6810
+ end
6811
+
5952
6812
  # @note When making an API call, you may pass UntagResourceRequest
5953
6813
  # data as a hash:
5954
6814
  #