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.
@@ -27,6 +27,7 @@ require 'aws-sdk-core/plugins/client_metrics_plugin.rb'
27
27
  require 'aws-sdk-core/plugins/client_metrics_send_plugin.rb'
28
28
  require 'aws-sdk-core/plugins/transfer_encoding.rb'
29
29
  require 'aws-sdk-core/plugins/http_checksum.rb'
30
+ require 'aws-sdk-core/plugins/checksum_algorithm.rb'
30
31
  require 'aws-sdk-core/plugins/defaults_mode.rb'
31
32
  require 'aws-sdk-core/plugins/recursion_detection.rb'
32
33
  require 'aws-sdk-core/plugins/signature_v4.rb'
@@ -75,6 +76,7 @@ module Aws::ForecastService
75
76
  add_plugin(Aws::Plugins::ClientMetricsSendPlugin)
76
77
  add_plugin(Aws::Plugins::TransferEncoding)
77
78
  add_plugin(Aws::Plugins::HttpChecksum)
79
+ add_plugin(Aws::Plugins::ChecksumAlgorithm)
78
80
  add_plugin(Aws::Plugins::DefaultsMode)
79
81
  add_plugin(Aws::Plugins::RecursionDetection)
80
82
  add_plugin(Aws::Plugins::SignatureV4)
@@ -378,7 +380,8 @@ module Aws::ForecastService
378
380
  # * `ForecastFrequency` - The granularity of your forecasts (hourly,
379
381
  # daily, weekly, etc).
380
382
  #
381
- # * `ForecastHorizon` - The number of time steps being forecasted.
383
+ # * `ForecastHorizon` - The number of time-steps that the model
384
+ # predicts. The forecast horizon is also called the prediction length.
382
385
  #
383
386
  # When creating a new predictor, do not specify a value for
384
387
  # `ReferencePredictorArn`.
@@ -403,6 +406,17 @@ module Aws::ForecastService
403
406
  # The number of time-steps that the model predicts. The forecast horizon
404
407
  # is also called the prediction length.
405
408
  #
409
+ # The maximum forecast horizon is the lesser of 500 time-steps or 1/4 of
410
+ # the TARGET\_TIME\_SERIES dataset length. If you are retraining an
411
+ # existing AutoPredictor, then the maximum forecast horizon is the
412
+ # lesser of 500 time-steps or 1/3 of the TARGET\_TIME\_SERIES dataset
413
+ # length.
414
+ #
415
+ # If you are upgrading to an AutoPredictor or retraining an existing
416
+ # AutoPredictor, you cannot update the forecast horizon parameter. You
417
+ # can meet this requirement by providing longer time-series in the
418
+ # dataset.
419
+ #
406
420
  # @option params [Array<String>] :forecast_types
407
421
  # The forecast types used to train a predictor. You can specify up to
408
422
  # five forecast types. Forecast types can be quantiles from 0.01 to
@@ -485,6 +499,31 @@ module Aws::ForecastService
485
499
  # only the key prefix of `aws` do not count against your tags per
486
500
  # resource limit. You cannot edit or delete tag keys with this prefix.
487
501
  #
502
+ # @option params [Types::MonitorConfig] :monitor_config
503
+ # The configuration details for predictor monitoring. Provide a name for
504
+ # the monitor resource to enable predictor monitoring.
505
+ #
506
+ # Predictor monitoring allows you to see how your predictor's
507
+ # performance changes over time. For more information, see [Predictor
508
+ # Monitoring][1].
509
+ #
510
+ #
511
+ #
512
+ # [1]: https://docs.aws.amazon.com/forecast/latest/dg/predictor-monitoring.html
513
+ #
514
+ # @option params [Types::TimeAlignmentBoundary] :time_alignment_boundary
515
+ # The time boundary Forecast uses to align and aggregate any data that
516
+ # doesn't align with your forecast frequency. Provide the unit of time
517
+ # and the time boundary as a key value pair. For more information on
518
+ # specifying a time boundary, see [Specifying a Time Boundary][1]. If
519
+ # you don't provide a time boundary, Forecast uses a set of [Default
520
+ # Time Boundaries][2].
521
+ #
522
+ #
523
+ #
524
+ # [1]: https://docs.aws.amazon.com/forecast/latest/dg/data-aggregation.html#specifying-time-boundary
525
+ # [2]: https://docs.aws.amazon.com/forecast/latest/dg/data-aggregation.html#default-time-boundaries
526
+ #
488
527
  # @return [Types::CreateAutoPredictorResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
489
528
  #
490
529
  # * {Types::CreateAutoPredictorResponse#predictor_arn #predictor_arn} => String
@@ -529,6 +568,15 @@ module Aws::ForecastService
529
568
  # value: "TagValue", # required
530
569
  # },
531
570
  # ],
571
+ # monitor_config: {
572
+ # monitor_name: "Name", # required
573
+ # },
574
+ # time_alignment_boundary: {
575
+ # month: "JANUARY", # accepts JANUARY, FEBRUARY, MARCH, APRIL, MAY, JUNE, JULY, AUGUST, SEPTEMBER, OCTOBER, NOVEMBER, DECEMBER
576
+ # day_of_month: 1,
577
+ # day_of_week: "MONDAY", # accepts MONDAY, TUESDAY, WEDNESDAY, THURSDAY, FRIDAY, SATURDAY, SUNDAY
578
+ # hour: 1,
579
+ # },
532
580
  # })
533
581
  #
534
582
  # @example Response structure
@@ -563,22 +611,26 @@ module Aws::ForecastService
563
611
  #
564
612
  # After creating a dataset, you import your training data into it and
565
613
  # add the dataset to a dataset group. You use the dataset group to
566
- # create a predictor. For more information, see
567
- # howitworks-datasets-groups.
614
+ # create a predictor. For more information, see [Importing datasets][1].
568
615
  #
569
- # To get a list of all your datasets, use the ListDatasets operation.
616
+ # To get a list of all your datasets, use the [ListDatasets][2]
617
+ # operation.
570
618
  #
571
619
  # For example Forecast datasets, see the [Amazon Forecast Sample GitHub
572
- # repository][1].
620
+ # repository][3].
573
621
  #
574
622
  # <note markdown="1"> The `Status` of a dataset must be `ACTIVE` before you can import
575
- # training data. Use the DescribeDataset operation to get the status.
623
+ # training data. Use the [DescribeDataset][4] operation to get the
624
+ # status.
576
625
  #
577
626
  # </note>
578
627
  #
579
628
  #
580
629
  #
581
- # [1]: https://github.com/aws-samples/amazon-forecast-samples
630
+ # [1]: https://docs.aws.amazon.com/forecast/latest/dg/howitworks-datasets-groups.html
631
+ # [2]: https://docs.aws.amazon.com/forecast/latest/dg/API_ListDatasets.html
632
+ # [3]: https://github.com/aws-samples/amazon-forecast-samples
633
+ # [4]: https://docs.aws.amazon.com/forecast/latest/dg/API_DescribeDataset.html
582
634
  #
583
635
  # @option params [required, String] :dataset_name
584
636
  # A name for the dataset.
@@ -586,14 +638,19 @@ module Aws::ForecastService
586
638
  # @option params [required, String] :domain
587
639
  # The domain associated with the dataset. When you add a dataset to a
588
640
  # dataset group, this value and the value specified for the `Domain`
589
- # parameter of the CreateDatasetGroup operation must match.
641
+ # parameter of the [CreateDatasetGroup][1] operation must match.
590
642
  #
591
643
  # The `Domain` and `DatasetType` that you choose determine the fields
592
644
  # that must be present in the training data that you import to the
593
645
  # dataset. For example, if you choose the `RETAIL` domain and
594
646
  # `TARGET_TIME_SERIES` as the `DatasetType`, Amazon Forecast requires
595
647
  # `item_id`, `timestamp`, and `demand` fields to be present in your
596
- # data. For more information, see howitworks-datasets-groups.
648
+ # data. For more information, see [Importing datasets][2].
649
+ #
650
+ #
651
+ #
652
+ # [1]: https://docs.aws.amazon.com/forecast/latest/dg/API_CreateDatasetGroup.html
653
+ # [2]: https://docs.aws.amazon.com/forecast/latest/dg/howitworks-datasets-groups.html
597
654
  #
598
655
  # @option params [required, String] :dataset_type
599
656
  # The dataset type. Valid values depend on the chosen `Domain`.
@@ -612,7 +669,11 @@ module Aws::ForecastService
612
669
  # match the fields in your data. The dataset `Domain` and `DatasetType`
613
670
  # that you choose determine the minimum required fields in your training
614
671
  # data. For information about the required fields for a specific dataset
615
- # domain and type, see howitworks-domains-ds-types.
672
+ # domain and type, see [Dataset Domains and Dataset Types][1].
673
+ #
674
+ #
675
+ #
676
+ # [1]: https://docs.aws.amazon.com/forecast/latest/dg/howitworks-domains-ds-types.html
616
677
  #
617
678
  # @option params [Types::EncryptionConfig] :encryption_config
618
679
  # An AWS Key Management Service (KMS) key and the AWS Identity and
@@ -697,35 +758,47 @@ module Aws::ForecastService
697
758
 
698
759
  # Creates a dataset group, which holds a collection of related datasets.
699
760
  # You can add datasets to the dataset group when you create the dataset
700
- # group, or later by using the UpdateDatasetGroup operation.
761
+ # group, or later by using the [UpdateDatasetGroup][1] operation.
701
762
  #
702
763
  # After creating a dataset group and adding datasets, you use the
703
764
  # dataset group when you create a predictor. For more information, see
704
- # howitworks-datasets-groups.
765
+ # [Dataset groups][2].
705
766
  #
706
- # To get a list of all your datasets groups, use the ListDatasetGroups
707
- # operation.
767
+ # To get a list of all your datasets groups, use the
768
+ # [ListDatasetGroups][3] operation.
708
769
  #
709
770
  # <note markdown="1"> The `Status` of a dataset group must be `ACTIVE` before you can use
710
771
  # the dataset group to create a predictor. To get the status, use the
711
- # DescribeDatasetGroup operation.
772
+ # [DescribeDatasetGroup][4] operation.
712
773
  #
713
774
  # </note>
714
775
  #
776
+ #
777
+ #
778
+ # [1]: https://docs.aws.amazon.com/forecast/latest/dg/API_UpdateDatasetGroup.html
779
+ # [2]: https://docs.aws.amazon.com/forecast/latest/dg/howitworks-datasets-groups.html
780
+ # [3]: https://docs.aws.amazon.com/forecast/latest/dg/API_ListDatasetGroups.html
781
+ # [4]: https://docs.aws.amazon.com/forecast/latest/dg/API_DescribeDatasetGroup.html
782
+ #
715
783
  # @option params [required, String] :dataset_group_name
716
784
  # A name for the dataset group.
717
785
  #
718
786
  # @option params [required, String] :domain
719
787
  # The domain associated with the dataset group. When you add a dataset
720
788
  # to a dataset group, this value and the value specified for the
721
- # `Domain` parameter of the CreateDataset operation must match.
789
+ # `Domain` parameter of the [CreateDataset][1] operation must match.
722
790
  #
723
791
  # The `Domain` and `DatasetType` that you choose determine the fields
724
792
  # that must be present in training data that you import to a dataset.
725
793
  # For example, if you choose the `RETAIL` domain and
726
794
  # `TARGET_TIME_SERIES` as the `DatasetType`, Amazon Forecast requires
727
795
  # that `item_id`, `timestamp`, and `demand` fields are present in your
728
- # data. For more information, see howitworks-datasets-groups.
796
+ # data. For more information, see [Dataset groups][2].
797
+ #
798
+ #
799
+ #
800
+ # [1]: https://docs.aws.amazon.com/forecast/latest/dg/API_CreateDataset.html
801
+ # [2]: https://docs.aws.amazon.com/forecast/latest/dg/howitworks-datasets-groups.html
729
802
  #
730
803
  # @option params [Array<String>] :dataset_arns
731
804
  # An array of Amazon Resource Names (ARNs) of the datasets that you want
@@ -799,11 +872,11 @@ module Aws::ForecastService
799
872
  # (Amazon S3) bucket and the Amazon Resource Name (ARN) of the dataset
800
873
  # that you want to import the data to.
801
874
  #
802
- # You must specify a DataSource object that includes an AWS Identity and
803
- # Access Management (IAM) role that Amazon Forecast can assume to access
804
- # the data, as Amazon Forecast makes a copy of your data and processes
805
- # it in an internal AWS system. For more information, see
806
- # aws-forecast-iam-roles.
875
+ # You must specify a [DataSource][1] object that includes an AWS
876
+ # Identity and Access Management (IAM) role that Amazon Forecast can
877
+ # assume to access the data, as Amazon Forecast makes a copy of your
878
+ # data and processes it in an internal AWS system. For more information,
879
+ # see [Set up permissions][2].
807
880
  #
808
881
  # The training data must be in CSV format. The delimiter must be a comma
809
882
  # (,).
@@ -819,7 +892,13 @@ module Aws::ForecastService
819
892
  # collected since the previous import.
820
893
  #
821
894
  # To get a list of all your dataset import jobs, filtered by specified
822
- # criteria, use the ListDatasetImportJobs operation.
895
+ # criteria, use the [ListDatasetImportJobs][3] operation.
896
+ #
897
+ #
898
+ #
899
+ # [1]: https://docs.aws.amazon.com/forecast/latest/dg/API_DataSource.html
900
+ # [2]: https://docs.aws.amazon.com/forecast/latest/dg/aws-forecast-iam-roles.html
901
+ # [3]: https://docs.aws.amazon.com/forecast/latest/dg/API_ListDatasetImportJobs.html
823
902
  #
824
903
  # @option params [required, String] :dataset_import_job_name
825
904
  # The name for the dataset import job. We recommend including the
@@ -840,7 +919,11 @@ module Aws::ForecastService
840
919
  # Service (KMS) key and the IAM role must allow Amazon Forecast
841
920
  # permission to access the key. The KMS key and IAM role must match
842
921
  # those specified in the `EncryptionConfig` parameter of the
843
- # CreateDataset operation.
922
+ # [CreateDataset][1] operation.
923
+ #
924
+ #
925
+ #
926
+ # [1]: https://docs.aws.amazon.com/forecast/latest/dg/API_CreateDataset.html
844
927
  #
845
928
  # @option params [String] :timestamp_format
846
929
  # The format of timestamps in the dataset. The format that you specify
@@ -1063,7 +1146,7 @@ module Aws::ForecastService
1063
1146
  # Defines the fields of a dataset.
1064
1147
  #
1065
1148
  # @option params [Boolean] :enable_visualization
1066
- # Create an Expainability visualization that is viewable within the AWS
1149
+ # Create an Explainability visualization that is viewable within the AWS
1067
1150
  # console.
1068
1151
  #
1069
1152
  # @option params [String] :start_date_time
@@ -1291,7 +1374,11 @@ module Aws::ForecastService
1291
1374
  # values include `0.01 to 0.99` (increments of .01 only) and `mean`. The
1292
1375
  # mean forecast is different from the median (0.50) when the
1293
1376
  # distribution is not symmetric (for example, Beta and Negative
1294
- # Binomial). The default value is `["0.1", "0.5", "0.9"]`.
1377
+ # Binomial).
1378
+ #
1379
+ # The default quantiles are the quantiles you specified during predictor
1380
+ # creation. If you didn't specify quantiles, the default values are
1381
+ # `["0.1", "0.5", "0.9"]`.
1295
1382
  #
1296
1383
  # @option params [Array<Types::Tag>] :tags
1297
1384
  # The optional metadata that you apply to the forecast to help you
@@ -1467,6 +1554,58 @@ module Aws::ForecastService
1467
1554
  req.send_request(options)
1468
1555
  end
1469
1556
 
1557
+ # Creates a predictor monitor resource for an existing auto predictor.
1558
+ # Predictor monitoring allows you to see how your predictor's
1559
+ # performance changes over time. For more information, see [Predictor
1560
+ # Monitoring][1].
1561
+ #
1562
+ #
1563
+ #
1564
+ # [1]: https://docs.aws.amazon.com/forecast/latest/dg/predictor-monitoring.html
1565
+ #
1566
+ # @option params [required, String] :monitor_name
1567
+ # The name of the monitor resource.
1568
+ #
1569
+ # @option params [required, String] :resource_arn
1570
+ # The Amazon Resource Name (ARN) of the predictor to monitor.
1571
+ #
1572
+ # @option params [Array<Types::Tag>] :tags
1573
+ # A list of [tags][1] to apply to the monitor resource.
1574
+ #
1575
+ #
1576
+ #
1577
+ # [1]: https://docs.aws.amazon.com/forecast/latest/dg/tagging-forecast-resources.html
1578
+ #
1579
+ # @return [Types::CreateMonitorResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1580
+ #
1581
+ # * {Types::CreateMonitorResponse#monitor_arn #monitor_arn} => String
1582
+ #
1583
+ # @example Request syntax with placeholder values
1584
+ #
1585
+ # resp = client.create_monitor({
1586
+ # monitor_name: "Name", # required
1587
+ # resource_arn: "Arn", # required
1588
+ # tags: [
1589
+ # {
1590
+ # key: "TagKey", # required
1591
+ # value: "TagValue", # required
1592
+ # },
1593
+ # ],
1594
+ # })
1595
+ #
1596
+ # @example Response structure
1597
+ #
1598
+ # resp.monitor_arn #=> String
1599
+ #
1600
+ # @see http://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/CreateMonitor AWS API Documentation
1601
+ #
1602
+ # @overload create_monitor(params = {})
1603
+ # @param [Hash] params ({})
1604
+ def create_monitor(params = {}, options = {})
1605
+ req = build_request(:create_monitor, params)
1606
+ req.send_request(options)
1607
+ end
1608
+
1470
1609
  # <note markdown="1"> This operation creates a legacy predictor that does not include all
1471
1610
  # the predictor functionalities provided by Amazon Forecast. To create a
1472
1611
  # predictor that is compatible with all aspects of Forecast, use
@@ -1884,16 +2023,23 @@ module Aws::ForecastService
1884
2023
  end
1885
2024
 
1886
2025
  # Deletes an Amazon Forecast dataset that was created using the
1887
- # CreateDataset operation. You can only delete datasets that have a
2026
+ # [CreateDataset][1] operation. You can only delete datasets that have a
1888
2027
  # status of `ACTIVE` or `CREATE_FAILED`. To get the status use the
1889
- # DescribeDataset operation.
2028
+ # [DescribeDataset][2] operation.
1890
2029
  #
1891
2030
  # <note markdown="1"> Forecast does not automatically update any dataset groups that contain
1892
2031
  # the deleted dataset. In order to update the dataset group, use the
1893
- # operation, omitting the deleted dataset's ARN.
2032
+ # [UpdateDatasetGroup][3] operation, omitting the deleted dataset's
2033
+ # ARN.
1894
2034
  #
1895
2035
  # </note>
1896
2036
  #
2037
+ #
2038
+ #
2039
+ # [1]: https://docs.aws.amazon.com/forecast/latest/dg/API_CreateDataset.html
2040
+ # [2]: https://docs.aws.amazon.com/forecast/latest/dg/API_DescribeDataset.html
2041
+ # [3]: https://docs.aws.amazon.com/forecast/latest/dg/API_UpdateDatasetGroup.html
2042
+ #
1897
2043
  # @option params [required, String] :dataset_arn
1898
2044
  # The Amazon Resource Name (ARN) of the dataset to delete.
1899
2045
  #
@@ -1914,14 +2060,19 @@ module Aws::ForecastService
1914
2060
  req.send_request(options)
1915
2061
  end
1916
2062
 
1917
- # Deletes a dataset group created using the CreateDatasetGroup
2063
+ # Deletes a dataset group created using the [CreateDatasetGroup][1]
1918
2064
  # operation. You can only delete dataset groups that have a status of
1919
2065
  # `ACTIVE`, `CREATE_FAILED`, or `UPDATE_FAILED`. To get the status, use
1920
- # the DescribeDatasetGroup operation.
2066
+ # the [DescribeDatasetGroup][2] operation.
1921
2067
  #
1922
2068
  # This operation deletes only the dataset group, not the datasets in the
1923
2069
  # group.
1924
2070
  #
2071
+ #
2072
+ #
2073
+ # [1]: https://docs.aws.amazon.com/forecast/latest/dg/API_CreateDatasetGroup.html
2074
+ # [2]: https://docs.aws.amazon.com/forecast/latest/dg/API_DescribeDatasetGroup.html
2075
+ #
1925
2076
  # @option params [required, String] :dataset_group_arn
1926
2077
  # The Amazon Resource Name (ARN) of the dataset group to delete.
1927
2078
  #
@@ -1942,10 +2093,15 @@ module Aws::ForecastService
1942
2093
  req.send_request(options)
1943
2094
  end
1944
2095
 
1945
- # Deletes a dataset import job created using the CreateDatasetImportJob
1946
- # operation. You can delete only dataset import jobs that have a status
1947
- # of `ACTIVE` or `CREATE_FAILED`. To get the status, use the
1948
- # DescribeDatasetImportJob operation.
2096
+ # Deletes a dataset import job created using the
2097
+ # [CreateDatasetImportJob][1] operation. You can delete only dataset
2098
+ # import jobs that have a status of `ACTIVE` or `CREATE_FAILED`. To get
2099
+ # the status, use the [DescribeDatasetImportJob][2] operation.
2100
+ #
2101
+ #
2102
+ #
2103
+ # [1]: https://docs.aws.amazon.com/forecast/latest/dg/API_CreateDatasetImportJob.html
2104
+ # [2]: https://docs.aws.amazon.com/forecast/latest/dg/API_DescribeDatasetImportJob.html
1949
2105
  #
1950
2106
  # @option params [required, String] :dataset_import_job_arn
1951
2107
  # The Amazon Resource Name (ARN) of the dataset import job to delete.
@@ -2069,6 +2225,30 @@ module Aws::ForecastService
2069
2225
  req.send_request(options)
2070
2226
  end
2071
2227
 
2228
+ # Deletes a monitor resource. You can only delete a monitor resource
2229
+ # with a status of `ACTIVE`, `ACTIVE_STOPPED`, `CREATE_FAILED`, or
2230
+ # `CREATE_STOPPED`.
2231
+ #
2232
+ # @option params [required, String] :monitor_arn
2233
+ # The Amazon Resource Name (ARN) of the monitor resource to delete.
2234
+ #
2235
+ # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
2236
+ #
2237
+ # @example Request syntax with placeholder values
2238
+ #
2239
+ # resp = client.delete_monitor({
2240
+ # monitor_arn: "Arn", # required
2241
+ # })
2242
+ #
2243
+ # @see http://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/DeleteMonitor AWS API Documentation
2244
+ #
2245
+ # @overload delete_monitor(params = {})
2246
+ # @param [Hash] params ({})
2247
+ def delete_monitor(params = {}, options = {})
2248
+ req = build_request(:delete_monitor, params)
2249
+ req.send_request(options)
2250
+ end
2251
+
2072
2252
  # Deletes a predictor created using the DescribePredictor or
2073
2253
  # CreatePredictor operations. You can delete only predictor that have a
2074
2254
  # status of `ACTIVE` or `CREATE_FAILED`. To get the status, use the
@@ -2188,6 +2368,8 @@ module Aws::ForecastService
2188
2368
  # * {Types::DescribeAutoPredictorResponse#last_modification_time #last_modification_time} => Time
2189
2369
  # * {Types::DescribeAutoPredictorResponse#optimization_metric #optimization_metric} => String
2190
2370
  # * {Types::DescribeAutoPredictorResponse#explainability_info #explainability_info} => Types::ExplainabilityInfo
2371
+ # * {Types::DescribeAutoPredictorResponse#monitor_info #monitor_info} => Types::MonitorInfo
2372
+ # * {Types::DescribeAutoPredictorResponse#time_alignment_boundary #time_alignment_boundary} => Types::TimeAlignmentBoundary
2191
2373
  #
2192
2374
  # @example Request syntax with placeholder values
2193
2375
  #
@@ -2229,6 +2411,12 @@ module Aws::ForecastService
2229
2411
  # resp.optimization_metric #=> String, one of "WAPE", "RMSE", "AverageWeightedQuantileLoss", "MASE", "MAPE"
2230
2412
  # resp.explainability_info.explainability_arn #=> String
2231
2413
  # resp.explainability_info.status #=> String
2414
+ # resp.monitor_info.monitor_arn #=> String
2415
+ # resp.monitor_info.status #=> String
2416
+ # resp.time_alignment_boundary.month #=> String, one of "JANUARY", "FEBRUARY", "MARCH", "APRIL", "MAY", "JUNE", "JULY", "AUGUST", "SEPTEMBER", "OCTOBER", "NOVEMBER", "DECEMBER"
2417
+ # resp.time_alignment_boundary.day_of_month #=> Integer
2418
+ # resp.time_alignment_boundary.day_of_week #=> String, one of "MONDAY", "TUESDAY", "WEDNESDAY", "THURSDAY", "FRIDAY", "SATURDAY", "SUNDAY"
2419
+ # resp.time_alignment_boundary.hour #=> Integer
2232
2420
  #
2233
2421
  # @see http://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/DescribeAutoPredictor AWS API Documentation
2234
2422
  #
@@ -2239,8 +2427,8 @@ module Aws::ForecastService
2239
2427
  req.send_request(options)
2240
2428
  end
2241
2429
 
2242
- # Describes an Amazon Forecast dataset created using the CreateDataset
2243
- # operation.
2430
+ # Describes an Amazon Forecast dataset created using the
2431
+ # [CreateDataset][1] operation.
2244
2432
  #
2245
2433
  # In addition to listing the parameters specified in the `CreateDataset`
2246
2434
  # request, this operation includes the following dataset properties:
@@ -2251,6 +2439,10 @@ module Aws::ForecastService
2251
2439
  #
2252
2440
  # * `Status`
2253
2441
  #
2442
+ #
2443
+ #
2444
+ # [1]: https://docs.aws.amazon.com/forecast/latest/dg/API_CreateDataset.html
2445
+ #
2254
2446
  # @option params [required, String] :dataset_arn
2255
2447
  # The Amazon Resource Name (ARN) of the dataset.
2256
2448
  #
@@ -2298,7 +2490,7 @@ module Aws::ForecastService
2298
2490
  req.send_request(options)
2299
2491
  end
2300
2492
 
2301
- # Describes a dataset group created using the CreateDatasetGroup
2493
+ # Describes a dataset group created using the [CreateDatasetGroup][1]
2302
2494
  # operation.
2303
2495
  #
2304
2496
  # In addition to listing the parameters provided in the
@@ -2313,6 +2505,10 @@ module Aws::ForecastService
2313
2505
  #
2314
2506
  # * `Status`
2315
2507
  #
2508
+ #
2509
+ #
2510
+ # [1]: https://docs.aws.amazon.com/forecast/latest/dg/API_CreateDatasetGroup.html
2511
+ #
2316
2512
  # @option params [required, String] :dataset_group_arn
2317
2513
  # The Amazon Resource Name (ARN) of the dataset group.
2318
2514
  #
@@ -2353,7 +2549,7 @@ module Aws::ForecastService
2353
2549
  end
2354
2550
 
2355
2551
  # Describes a dataset import job created using the
2356
- # CreateDatasetImportJob operation.
2552
+ # [CreateDatasetImportJob][1] operation.
2357
2553
  #
2358
2554
  # In addition to listing the parameters provided in the
2359
2555
  # `CreateDatasetImportJob` request, this operation includes the
@@ -2371,6 +2567,10 @@ module Aws::ForecastService
2371
2567
  #
2372
2568
  # * `Message` - If an error occurred, information about the error.
2373
2569
  #
2570
+ #
2571
+ #
2572
+ # [1]: https://docs.aws.amazon.com/forecast/latest/dg/API_CreateDatasetImportJob.html
2573
+ #
2374
2574
  # @option params [required, String] :dataset_import_job_arn
2375
2575
  # The Amazon Resource Name (ARN) of the dataset import job.
2376
2576
  #
@@ -2662,6 +2862,72 @@ module Aws::ForecastService
2662
2862
  req.send_request(options)
2663
2863
  end
2664
2864
 
2865
+ # Describes a monitor resource. In addition to listing the properties
2866
+ # provided in the CreateMonitor request, this operation lists the
2867
+ # following properties:
2868
+ #
2869
+ # * `Baseline`
2870
+ #
2871
+ # * `CreationTime`
2872
+ #
2873
+ # * `LastEvaluationTime`
2874
+ #
2875
+ # * `LastEvaluationState`
2876
+ #
2877
+ # * `LastModificationTime`
2878
+ #
2879
+ # * `Message`
2880
+ #
2881
+ # * `Status`
2882
+ #
2883
+ # @option params [required, String] :monitor_arn
2884
+ # The Amazon Resource Name (ARN) of the monitor resource to describe.
2885
+ #
2886
+ # @return [Types::DescribeMonitorResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
2887
+ #
2888
+ # * {Types::DescribeMonitorResponse#monitor_name #monitor_name} => String
2889
+ # * {Types::DescribeMonitorResponse#monitor_arn #monitor_arn} => String
2890
+ # * {Types::DescribeMonitorResponse#resource_arn #resource_arn} => String
2891
+ # * {Types::DescribeMonitorResponse#status #status} => String
2892
+ # * {Types::DescribeMonitorResponse#last_evaluation_time #last_evaluation_time} => Time
2893
+ # * {Types::DescribeMonitorResponse#last_evaluation_state #last_evaluation_state} => String
2894
+ # * {Types::DescribeMonitorResponse#baseline #baseline} => Types::Baseline
2895
+ # * {Types::DescribeMonitorResponse#message #message} => String
2896
+ # * {Types::DescribeMonitorResponse#creation_time #creation_time} => Time
2897
+ # * {Types::DescribeMonitorResponse#last_modification_time #last_modification_time} => Time
2898
+ # * {Types::DescribeMonitorResponse#estimated_evaluation_time_remaining_in_minutes #estimated_evaluation_time_remaining_in_minutes} => Integer
2899
+ #
2900
+ # @example Request syntax with placeholder values
2901
+ #
2902
+ # resp = client.describe_monitor({
2903
+ # monitor_arn: "Arn", # required
2904
+ # })
2905
+ #
2906
+ # @example Response structure
2907
+ #
2908
+ # resp.monitor_name #=> String
2909
+ # resp.monitor_arn #=> String
2910
+ # resp.resource_arn #=> String
2911
+ # resp.status #=> String
2912
+ # resp.last_evaluation_time #=> Time
2913
+ # resp.last_evaluation_state #=> String
2914
+ # resp.baseline.predictor_baseline.baseline_metrics #=> Array
2915
+ # resp.baseline.predictor_baseline.baseline_metrics[0].name #=> String
2916
+ # resp.baseline.predictor_baseline.baseline_metrics[0].value #=> Float
2917
+ # resp.message #=> String
2918
+ # resp.creation_time #=> Time
2919
+ # resp.last_modification_time #=> Time
2920
+ # resp.estimated_evaluation_time_remaining_in_minutes #=> Integer
2921
+ #
2922
+ # @see http://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/DescribeMonitor AWS API Documentation
2923
+ #
2924
+ # @overload describe_monitor(params = {})
2925
+ # @param [Hash] params ({})
2926
+ def describe_monitor(params = {}, options = {})
2927
+ req = build_request(:describe_monitor, params)
2928
+ req.send_request(options)
2929
+ end
2930
+
2665
2931
  # <note markdown="1"> This operation is only valid for legacy predictors created with
2666
2932
  # CreatePredictor. If you are not using a legacy predictor, use
2667
2933
  # DescribeAutoPredictor.
@@ -2931,11 +3197,17 @@ module Aws::ForecastService
2931
3197
  req.send_request(options)
2932
3198
  end
2933
3199
 
2934
- # Returns a list of dataset groups created using the CreateDatasetGroup
2935
- # operation. For each dataset group, this operation returns a summary of
2936
- # its properties, including its Amazon Resource Name (ARN). You can
2937
- # retrieve the complete set of properties by using the dataset group ARN
2938
- # with the DescribeDatasetGroup operation.
3200
+ # Returns a list of dataset groups created using the
3201
+ # [CreateDatasetGroup][1] operation. For each dataset group, this
3202
+ # operation returns a summary of its properties, including its Amazon
3203
+ # Resource Name (ARN). You can retrieve the complete set of properties
3204
+ # by using the dataset group ARN with the [DescribeDatasetGroup][2]
3205
+ # operation.
3206
+ #
3207
+ #
3208
+ #
3209
+ # [1]: https://docs.aws.amazon.com/forecast/latest/dg/API_CreateDatasetGroup.html
3210
+ # [2]: https://docs.aws.amazon.com/forecast/latest/dg/API_DescribeDatasetGroup.html
2939
3211
  #
2940
3212
  # @option params [String] :next_token
2941
3213
  # If the result of the previous request was truncated, the response
@@ -2978,11 +3250,17 @@ module Aws::ForecastService
2978
3250
  end
2979
3251
 
2980
3252
  # Returns a list of dataset import jobs created using the
2981
- # CreateDatasetImportJob operation. For each import job, this operation
2982
- # returns a summary of its properties, including its Amazon Resource
2983
- # Name (ARN). You can retrieve the complete set of properties by using
2984
- # the ARN with the DescribeDatasetImportJob operation. You can filter
2985
- # the list by providing an array of Filter objects.
3253
+ # [CreateDatasetImportJob][1] operation. For each import job, this
3254
+ # operation returns a summary of its properties, including its Amazon
3255
+ # Resource Name (ARN). You can retrieve the complete set of properties
3256
+ # by using the ARN with the [DescribeDatasetImportJob][2] operation. You
3257
+ # can filter the list by providing an array of [Filter][3] objects.
3258
+ #
3259
+ #
3260
+ #
3261
+ # [1]: https://docs.aws.amazon.com/forecast/latest/dg/API_CreateDatasetImportJob.html
3262
+ # [2]: https://docs.aws.amazon.com/forecast/latest/dg/API_DescribeDatasetImportJob.html
3263
+ # [3]: https://docs.aws.amazon.com/forecast/latest/dg/API_Filter.html
2986
3264
  #
2987
3265
  # @option params [String] :next_token
2988
3266
  # If the result of the previous request was truncated, the response
@@ -3060,10 +3338,16 @@ module Aws::ForecastService
3060
3338
  req.send_request(options)
3061
3339
  end
3062
3340
 
3063
- # Returns a list of datasets created using the CreateDataset operation.
3064
- # For each dataset, a summary of its properties, including its Amazon
3065
- # Resource Name (ARN), is returned. To retrieve the complete set of
3066
- # properties, use the ARN with the DescribeDataset operation.
3341
+ # Returns a list of datasets created using the [CreateDataset][1]
3342
+ # operation. For each dataset, a summary of its properties, including
3343
+ # its Amazon Resource Name (ARN), is returned. To retrieve the complete
3344
+ # set of properties, use the ARN with the [DescribeDataset][2]
3345
+ # operation.
3346
+ #
3347
+ #
3348
+ #
3349
+ # [1]: https://docs.aws.amazon.com/forecast/latest/dg/API_CreateDataset.html
3350
+ # [2]: https://docs.aws.amazon.com/forecast/latest/dg/API_DescribeDataset.html
3067
3351
  #
3068
3352
  # @option params [String] :next_token
3069
3353
  # If the result of the previous request was truncated, the response
@@ -3145,6 +3429,8 @@ module Aws::ForecastService
3145
3429
  # * {Types::ListExplainabilitiesResponse#explainabilities #explainabilities} => Array&lt;Types::ExplainabilitySummary&gt;
3146
3430
  # * {Types::ListExplainabilitiesResponse#next_token #next_token} => String
3147
3431
  #
3432
+ # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
3433
+ #
3148
3434
  # @example Request syntax with placeholder values
3149
3435
  #
3150
3436
  # resp = client.list_explainabilities({
@@ -3220,6 +3506,8 @@ module Aws::ForecastService
3220
3506
  # * {Types::ListExplainabilityExportsResponse#explainability_exports #explainability_exports} => Array&lt;Types::ExplainabilityExportSummary&gt;
3221
3507
  # * {Types::ListExplainabilityExportsResponse#next_token #next_token} => String
3222
3508
  #
3509
+ # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
3510
+ #
3223
3511
  # @example Request syntax with placeholder values
3224
3512
  #
3225
3513
  # resp = client.list_explainability_exports({
@@ -3424,6 +3712,183 @@ module Aws::ForecastService
3424
3712
  req.send_request(options)
3425
3713
  end
3426
3714
 
3715
+ # Returns a list of the monitoring evaluation results and predictor
3716
+ # events collected by the monitor resource during different windows of
3717
+ # time.
3718
+ #
3719
+ # For information about monitoring see predictor-monitoring. For more
3720
+ # information about retrieving monitoring results see [Viewing
3721
+ # Monitoring Results][1].
3722
+ #
3723
+ #
3724
+ #
3725
+ # [1]: https://docs.aws.amazon.com/forecast/latest/dg/predictor-monitoring-results.html
3726
+ #
3727
+ # @option params [String] :next_token
3728
+ # If the result of the previous request was truncated, the response
3729
+ # includes a `NextToken`. To retrieve the next set of results, use the
3730
+ # token in the next request. Tokens expire after 24 hours.
3731
+ #
3732
+ # @option params [Integer] :max_results
3733
+ # The maximum number of monitoring results to return.
3734
+ #
3735
+ # @option params [required, String] :monitor_arn
3736
+ # The Amazon Resource Name (ARN) of the monitor resource to get results
3737
+ # from.
3738
+ #
3739
+ # @option params [Array<Types::Filter>] :filters
3740
+ # An array of filters. For each filter, provide a condition and a match
3741
+ # statement. The condition is either `IS` or `IS_NOT`, which specifies
3742
+ # whether to include or exclude the resources that match the statement
3743
+ # from the list. The match statement consists of a key and a value.
3744
+ #
3745
+ # **Filter properties**
3746
+ #
3747
+ # * `Condition` - The condition to apply. Valid values are `IS` and
3748
+ # `IS_NOT`.
3749
+ #
3750
+ # * `Key` - The name of the parameter to filter on. The only valid value
3751
+ # is `EvaluationState`.
3752
+ #
3753
+ # * `Value` - The value to match. Valid values are only `SUCCESS` or
3754
+ # `FAILURE`.
3755
+ #
3756
+ # For example, to list only successful monitor evaluations, you would
3757
+ # specify:
3758
+ #
3759
+ # `"Filters": [ \{ "Condition": "IS", "Key": "EvaluationState", "Value":
3760
+ # "SUCCESS" \} ]`
3761
+ #
3762
+ # @return [Types::ListMonitorEvaluationsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
3763
+ #
3764
+ # * {Types::ListMonitorEvaluationsResponse#next_token #next_token} => String
3765
+ # * {Types::ListMonitorEvaluationsResponse#predictor_monitor_evaluations #predictor_monitor_evaluations} => Array&lt;Types::PredictorMonitorEvaluation&gt;
3766
+ #
3767
+ # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
3768
+ #
3769
+ # @example Request syntax with placeholder values
3770
+ #
3771
+ # resp = client.list_monitor_evaluations({
3772
+ # next_token: "NextToken",
3773
+ # max_results: 1,
3774
+ # monitor_arn: "Arn", # required
3775
+ # filters: [
3776
+ # {
3777
+ # key: "String", # required
3778
+ # value: "Arn", # required
3779
+ # condition: "IS", # required, accepts IS, IS_NOT
3780
+ # },
3781
+ # ],
3782
+ # })
3783
+ #
3784
+ # @example Response structure
3785
+ #
3786
+ # resp.next_token #=> String
3787
+ # resp.predictor_monitor_evaluations #=> Array
3788
+ # resp.predictor_monitor_evaluations[0].resource_arn #=> String
3789
+ # resp.predictor_monitor_evaluations[0].monitor_arn #=> String
3790
+ # resp.predictor_monitor_evaluations[0].evaluation_time #=> Time
3791
+ # resp.predictor_monitor_evaluations[0].evaluation_state #=> String
3792
+ # resp.predictor_monitor_evaluations[0].window_start_datetime #=> Time
3793
+ # resp.predictor_monitor_evaluations[0].window_end_datetime #=> Time
3794
+ # resp.predictor_monitor_evaluations[0].predictor_event.detail #=> String
3795
+ # resp.predictor_monitor_evaluations[0].predictor_event.datetime #=> Time
3796
+ # resp.predictor_monitor_evaluations[0].monitor_data_source.dataset_import_job_arn #=> String
3797
+ # resp.predictor_monitor_evaluations[0].monitor_data_source.forecast_arn #=> String
3798
+ # resp.predictor_monitor_evaluations[0].monitor_data_source.predictor_arn #=> String
3799
+ # resp.predictor_monitor_evaluations[0].metric_results #=> Array
3800
+ # resp.predictor_monitor_evaluations[0].metric_results[0].metric_name #=> String
3801
+ # resp.predictor_monitor_evaluations[0].metric_results[0].metric_value #=> Float
3802
+ # resp.predictor_monitor_evaluations[0].num_items_evaluated #=> Integer
3803
+ # resp.predictor_monitor_evaluations[0].message #=> String
3804
+ #
3805
+ # @see http://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/ListMonitorEvaluations AWS API Documentation
3806
+ #
3807
+ # @overload list_monitor_evaluations(params = {})
3808
+ # @param [Hash] params ({})
3809
+ def list_monitor_evaluations(params = {}, options = {})
3810
+ req = build_request(:list_monitor_evaluations, params)
3811
+ req.send_request(options)
3812
+ end
3813
+
3814
+ # Returns a list of monitors created with the CreateMonitor operation
3815
+ # and CreateAutoPredictor operation. For each monitor resource, this
3816
+ # operation returns of a summary of its properties, including its Amazon
3817
+ # Resource Name (ARN). You can retrieve a complete set of properties of
3818
+ # a monitor resource by specify the monitor's ARN in the
3819
+ # DescribeMonitor operation.
3820
+ #
3821
+ # @option params [String] :next_token
3822
+ # If the result of the previous request was truncated, the response
3823
+ # includes a `NextToken`. To retrieve the next set of results, use the
3824
+ # token in the next request. Tokens expire after 24 hours.
3825
+ #
3826
+ # @option params [Integer] :max_results
3827
+ # The maximum number of monitors to include in the response.
3828
+ #
3829
+ # @option params [Array<Types::Filter>] :filters
3830
+ # An array of filters. For each filter, provide a condition and a match
3831
+ # statement. The condition is either `IS` or `IS_NOT`, which specifies
3832
+ # whether to include or exclude the resources that match the statement
3833
+ # from the list. The match statement consists of a key and a value.
3834
+ #
3835
+ # **Filter properties**
3836
+ #
3837
+ # * `Condition` - The condition to apply. Valid values are `IS` and
3838
+ # `IS_NOT`.
3839
+ #
3840
+ # * `Key` - The name of the parameter to filter on. The only valid value
3841
+ # is `Status`.
3842
+ #
3843
+ # * `Value` - The value to match.
3844
+ #
3845
+ # For example, to list all monitors who's status is ACTIVE, you would
3846
+ # specify:
3847
+ #
3848
+ # `"Filters": [ \{ "Condition": "IS", "Key": "Status", "Value": "ACTIVE"
3849
+ # \} ]`
3850
+ #
3851
+ # @return [Types::ListMonitorsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
3852
+ #
3853
+ # * {Types::ListMonitorsResponse#monitors #monitors} => Array&lt;Types::MonitorSummary&gt;
3854
+ # * {Types::ListMonitorsResponse#next_token #next_token} => String
3855
+ #
3856
+ # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
3857
+ #
3858
+ # @example Request syntax with placeholder values
3859
+ #
3860
+ # resp = client.list_monitors({
3861
+ # next_token: "NextToken",
3862
+ # max_results: 1,
3863
+ # filters: [
3864
+ # {
3865
+ # key: "String", # required
3866
+ # value: "Arn", # required
3867
+ # condition: "IS", # required, accepts IS, IS_NOT
3868
+ # },
3869
+ # ],
3870
+ # })
3871
+ #
3872
+ # @example Response structure
3873
+ #
3874
+ # resp.monitors #=> Array
3875
+ # resp.monitors[0].monitor_arn #=> String
3876
+ # resp.monitors[0].monitor_name #=> String
3877
+ # resp.monitors[0].resource_arn #=> String
3878
+ # resp.monitors[0].status #=> String
3879
+ # resp.monitors[0].creation_time #=> Time
3880
+ # resp.monitors[0].last_modification_time #=> Time
3881
+ # resp.next_token #=> String
3882
+ #
3883
+ # @see http://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/ListMonitors AWS API Documentation
3884
+ #
3885
+ # @overload list_monitors(params = {})
3886
+ # @param [Hash] params ({})
3887
+ def list_monitors(params = {}, options = {})
3888
+ req = build_request(:list_monitors, params)
3889
+ req.send_request(options)
3890
+ end
3891
+
3427
3892
  # Returns a list of predictor backtest export jobs created using the
3428
3893
  # CreatePredictorBacktestExportJob operation. This operation returns a
3429
3894
  # summary for each backtest export job. You can filter the list using an
@@ -3620,6 +4085,28 @@ module Aws::ForecastService
3620
4085
  req.send_request(options)
3621
4086
  end
3622
4087
 
4088
+ # Resumes a stopped monitor resource.
4089
+ #
4090
+ # @option params [required, String] :resource_arn
4091
+ # The Amazon Resource Name (ARN) of the monitor resource to resume.
4092
+ #
4093
+ # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
4094
+ #
4095
+ # @example Request syntax with placeholder values
4096
+ #
4097
+ # resp = client.resume_resource({
4098
+ # resource_arn: "Arn", # required
4099
+ # })
4100
+ #
4101
+ # @see http://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/ResumeResource AWS API Documentation
4102
+ #
4103
+ # @overload resume_resource(params = {})
4104
+ # @param [Hash] params ({})
4105
+ def resume_resource(params = {}, options = {})
4106
+ req = build_request(:resume_resource, params)
4107
+ req.send_request(options)
4108
+ end
4109
+
3623
4110
  # Stops a resource.
3624
4111
  #
3625
4112
  # The resource undergoes the following states: `CREATE_STOPPING` and
@@ -3759,11 +4246,15 @@ module Aws::ForecastService
3759
4246
  # Replaces the datasets in a dataset group with the specified datasets.
3760
4247
  #
3761
4248
  # <note markdown="1"> The `Status` of the dataset group must be `ACTIVE` before you can use
3762
- # the dataset group to create a predictor. Use the DescribeDatasetGroup
3763
- # operation to get the status.
4249
+ # the dataset group to create a predictor. Use the
4250
+ # [DescribeDatasetGroup][1] operation to get the status.
3764
4251
  #
3765
4252
  # </note>
3766
4253
  #
4254
+ #
4255
+ #
4256
+ # [1]: https://docs.aws.amazon.com/forecast/latest/dg/API_DescribeDatasetGroup.html
4257
+ #
3767
4258
  # @option params [required, String] :dataset_group_arn
3768
4259
  # The ARN of the dataset group.
3769
4260
  #
@@ -3802,7 +4293,7 @@ module Aws::ForecastService
3802
4293
  params: params,
3803
4294
  config: config)
3804
4295
  context[:gem_name] = 'aws-sdk-forecastservice'
3805
- context[:gem_version] = '1.32.0'
4296
+ context[:gem_version] = '1.35.0'
3806
4297
  Seahorse::Client::Request.new(handlers, context)
3807
4298
  end
3808
4299