aws-sdk-forecastservice 1.33.0 → 1.34.0

Sign up to get free protection for your applications and to get access to all the features.
@@ -380,7 +380,8 @@ module Aws::ForecastService
380
380
  # * `ForecastFrequency` - The granularity of your forecasts (hourly,
381
381
  # daily, weekly, etc).
382
382
  #
383
- # * `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.
384
385
  #
385
386
  # When creating a new predictor, do not specify a value for
386
387
  # `ReferencePredictorArn`.
@@ -405,6 +406,17 @@ module Aws::ForecastService
405
406
  # The number of time-steps that the model predicts. The forecast horizon
406
407
  # is also called the prediction length.
407
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
+ #
408
420
  # @option params [Array<String>] :forecast_types
409
421
  # The forecast types used to train a predictor. You can specify up to
410
422
  # five forecast types. Forecast types can be quantiles from 0.01 to
@@ -487,6 +499,18 @@ module Aws::ForecastService
487
499
  # only the key prefix of `aws` do not count against your tags per
488
500
  # resource limit. You cannot edit or delete tag keys with this prefix.
489
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
+ #
490
514
  # @return [Types::CreateAutoPredictorResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
491
515
  #
492
516
  # * {Types::CreateAutoPredictorResponse#predictor_arn #predictor_arn} => String
@@ -531,6 +555,9 @@ module Aws::ForecastService
531
555
  # value: "TagValue", # required
532
556
  # },
533
557
  # ],
558
+ # monitor_config: {
559
+ # monitor_name: "Name", # required
560
+ # },
534
561
  # })
535
562
  #
536
563
  # @example Response structure
@@ -565,22 +592,26 @@ module Aws::ForecastService
565
592
  #
566
593
  # After creating a dataset, you import your training data into it and
567
594
  # add the dataset to a dataset group. You use the dataset group to
568
- # create a predictor. For more information, see
569
- # howitworks-datasets-groups.
595
+ # create a predictor. For more information, see [Importing datasets][1].
570
596
  #
571
- # To get a list of all your datasets, use the ListDatasets operation.
597
+ # To get a list of all your datasets, use the [ListDatasets][2]
598
+ # operation.
572
599
  #
573
600
  # For example Forecast datasets, see the [Amazon Forecast Sample GitHub
574
- # repository][1].
601
+ # repository][3].
575
602
  #
576
603
  # <note markdown="1"> The `Status` of a dataset must be `ACTIVE` before you can import
577
- # training data. Use the DescribeDataset operation to get the status.
604
+ # training data. Use the [DescribeDataset][4] operation to get the
605
+ # status.
578
606
  #
579
607
  # </note>
580
608
  #
581
609
  #
582
610
  #
583
- # [1]: https://github.com/aws-samples/amazon-forecast-samples
611
+ # [1]: https://docs.aws.amazon.com/forecast/latest/dg/howitworks-datasets-groups.html
612
+ # [2]: https://docs.aws.amazon.com/forecast/latest/dg/API_ListDatasets.html
613
+ # [3]: https://github.com/aws-samples/amazon-forecast-samples
614
+ # [4]: https://docs.aws.amazon.com/forecast/latest/dg/API_DescribeDataset.html
584
615
  #
585
616
  # @option params [required, String] :dataset_name
586
617
  # A name for the dataset.
@@ -588,14 +619,19 @@ module Aws::ForecastService
588
619
  # @option params [required, String] :domain
589
620
  # The domain associated with the dataset. When you add a dataset to a
590
621
  # dataset group, this value and the value specified for the `Domain`
591
- # parameter of the CreateDatasetGroup operation must match.
622
+ # parameter of the [CreateDatasetGroup][1] operation must match.
592
623
  #
593
624
  # The `Domain` and `DatasetType` that you choose determine the fields
594
625
  # that must be present in the training data that you import to the
595
626
  # dataset. For example, if you choose the `RETAIL` domain and
596
627
  # `TARGET_TIME_SERIES` as the `DatasetType`, Amazon Forecast requires
597
628
  # `item_id`, `timestamp`, and `demand` fields to be present in your
598
- # data. For more information, see howitworks-datasets-groups.
629
+ # data. For more information, see [Importing datasets][2].
630
+ #
631
+ #
632
+ #
633
+ # [1]: https://docs.aws.amazon.com/forecast/latest/dg/API_CreateDatasetGroup.html
634
+ # [2]: https://docs.aws.amazon.com/forecast/latest/dg/howitworks-datasets-groups.html
599
635
  #
600
636
  # @option params [required, String] :dataset_type
601
637
  # The dataset type. Valid values depend on the chosen `Domain`.
@@ -614,7 +650,11 @@ module Aws::ForecastService
614
650
  # match the fields in your data. The dataset `Domain` and `DatasetType`
615
651
  # that you choose determine the minimum required fields in your training
616
652
  # data. For information about the required fields for a specific dataset
617
- # domain and type, see howitworks-domains-ds-types.
653
+ # domain and type, see [Dataset Domains and Dataset Types][1].
654
+ #
655
+ #
656
+ #
657
+ # [1]: https://docs.aws.amazon.com/forecast/latest/dg/howitworks-domains-ds-types.html
618
658
  #
619
659
  # @option params [Types::EncryptionConfig] :encryption_config
620
660
  # An AWS Key Management Service (KMS) key and the AWS Identity and
@@ -699,35 +739,47 @@ module Aws::ForecastService
699
739
 
700
740
  # Creates a dataset group, which holds a collection of related datasets.
701
741
  # You can add datasets to the dataset group when you create the dataset
702
- # group, or later by using the UpdateDatasetGroup operation.
742
+ # group, or later by using the [UpdateDatasetGroup][1] operation.
703
743
  #
704
744
  # After creating a dataset group and adding datasets, you use the
705
745
  # dataset group when you create a predictor. For more information, see
706
- # howitworks-datasets-groups.
746
+ # [Dataset groups][2].
707
747
  #
708
- # To get a list of all your datasets groups, use the ListDatasetGroups
709
- # operation.
748
+ # To get a list of all your datasets groups, use the
749
+ # [ListDatasetGroups][3] operation.
710
750
  #
711
751
  # <note markdown="1"> The `Status` of a dataset group must be `ACTIVE` before you can use
712
752
  # the dataset group to create a predictor. To get the status, use the
713
- # DescribeDatasetGroup operation.
753
+ # [DescribeDatasetGroup][4] operation.
714
754
  #
715
755
  # </note>
716
756
  #
757
+ #
758
+ #
759
+ # [1]: https://docs.aws.amazon.com/forecast/latest/dg/API_UpdateDatasetGroup.html
760
+ # [2]: https://docs.aws.amazon.com/forecast/latest/dg/howitworks-datasets-groups.html
761
+ # [3]: https://docs.aws.amazon.com/forecast/latest/dg/API_ListDatasetGroups.html
762
+ # [4]: https://docs.aws.amazon.com/forecast/latest/dg/API_DescribeDatasetGroup.html
763
+ #
717
764
  # @option params [required, String] :dataset_group_name
718
765
  # A name for the dataset group.
719
766
  #
720
767
  # @option params [required, String] :domain
721
768
  # The domain associated with the dataset group. When you add a dataset
722
769
  # to a dataset group, this value and the value specified for the
723
- # `Domain` parameter of the CreateDataset operation must match.
770
+ # `Domain` parameter of the [CreateDataset][1] operation must match.
724
771
  #
725
772
  # The `Domain` and `DatasetType` that you choose determine the fields
726
773
  # that must be present in training data that you import to a dataset.
727
774
  # For example, if you choose the `RETAIL` domain and
728
775
  # `TARGET_TIME_SERIES` as the `DatasetType`, Amazon Forecast requires
729
776
  # that `item_id`, `timestamp`, and `demand` fields are present in your
730
- # data. For more information, see howitworks-datasets-groups.
777
+ # data. For more information, see [Dataset groups][2].
778
+ #
779
+ #
780
+ #
781
+ # [1]: https://docs.aws.amazon.com/forecast/latest/dg/API_CreateDataset.html
782
+ # [2]: https://docs.aws.amazon.com/forecast/latest/dg/howitworks-datasets-groups.html
731
783
  #
732
784
  # @option params [Array<String>] :dataset_arns
733
785
  # An array of Amazon Resource Names (ARNs) of the datasets that you want
@@ -801,11 +853,11 @@ module Aws::ForecastService
801
853
  # (Amazon S3) bucket and the Amazon Resource Name (ARN) of the dataset
802
854
  # that you want to import the data to.
803
855
  #
804
- # You must specify a DataSource object that includes an AWS Identity and
805
- # Access Management (IAM) role that Amazon Forecast can assume to access
806
- # the data, as Amazon Forecast makes a copy of your data and processes
807
- # it in an internal AWS system. For more information, see
808
- # aws-forecast-iam-roles.
856
+ # You must specify a [DataSource][1] object that includes an AWS
857
+ # Identity and Access Management (IAM) role that Amazon Forecast can
858
+ # assume to access the data, as Amazon Forecast makes a copy of your
859
+ # data and processes it in an internal AWS system. For more information,
860
+ # see [Set up permissions][2].
809
861
  #
810
862
  # The training data must be in CSV format. The delimiter must be a comma
811
863
  # (,).
@@ -821,7 +873,13 @@ module Aws::ForecastService
821
873
  # collected since the previous import.
822
874
  #
823
875
  # To get a list of all your dataset import jobs, filtered by specified
824
- # criteria, use the ListDatasetImportJobs operation.
876
+ # criteria, use the [ListDatasetImportJobs][3] operation.
877
+ #
878
+ #
879
+ #
880
+ # [1]: https://docs.aws.amazon.com/forecast/latest/dg/API_DataSource.html
881
+ # [2]: https://docs.aws.amazon.com/forecast/latest/dg/aws-forecast-iam-roles.html
882
+ # [3]: https://docs.aws.amazon.com/forecast/latest/dg/API_ListDatasetImportJobs.html
825
883
  #
826
884
  # @option params [required, String] :dataset_import_job_name
827
885
  # The name for the dataset import job. We recommend including the
@@ -842,7 +900,11 @@ module Aws::ForecastService
842
900
  # Service (KMS) key and the IAM role must allow Amazon Forecast
843
901
  # permission to access the key. The KMS key and IAM role must match
844
902
  # those specified in the `EncryptionConfig` parameter of the
845
- # CreateDataset operation.
903
+ # [CreateDataset][1] operation.
904
+ #
905
+ #
906
+ #
907
+ # [1]: https://docs.aws.amazon.com/forecast/latest/dg/API_CreateDataset.html
846
908
  #
847
909
  # @option params [String] :timestamp_format
848
910
  # The format of timestamps in the dataset. The format that you specify
@@ -1065,7 +1127,7 @@ module Aws::ForecastService
1065
1127
  # Defines the fields of a dataset.
1066
1128
  #
1067
1129
  # @option params [Boolean] :enable_visualization
1068
- # Create an Expainability visualization that is viewable within the AWS
1130
+ # Create an Explainability visualization that is viewable within the AWS
1069
1131
  # console.
1070
1132
  #
1071
1133
  # @option params [String] :start_date_time
@@ -1293,7 +1355,11 @@ module Aws::ForecastService
1293
1355
  # values include `0.01 to 0.99` (increments of .01 only) and `mean`. The
1294
1356
  # mean forecast is different from the median (0.50) when the
1295
1357
  # distribution is not symmetric (for example, Beta and Negative
1296
- # Binomial). The default value is `["0.1", "0.5", "0.9"]`.
1358
+ # Binomial).
1359
+ #
1360
+ # The default quantiles are the quantiles you specified during predictor
1361
+ # creation. If you didn't specify quantiles, the default values are
1362
+ # `["0.1", "0.5", "0.9"]`.
1297
1363
  #
1298
1364
  # @option params [Array<Types::Tag>] :tags
1299
1365
  # The optional metadata that you apply to the forecast to help you
@@ -1469,6 +1535,58 @@ module Aws::ForecastService
1469
1535
  req.send_request(options)
1470
1536
  end
1471
1537
 
1538
+ # Creates a predictor monitor resource for an existing auto predictor.
1539
+ # Predictor monitoring allows you to see how your predictor's
1540
+ # performance changes over time. For more information, see [Predictor
1541
+ # Monitoring][1].
1542
+ #
1543
+ #
1544
+ #
1545
+ # [1]: https://docs.aws.amazon.com/forecast/latest/dg/predictor-monitoring.html
1546
+ #
1547
+ # @option params [required, String] :monitor_name
1548
+ # The name of the monitor resource.
1549
+ #
1550
+ # @option params [required, String] :resource_arn
1551
+ # The Amazon Resource Name (ARN) of the predictor to monitor.
1552
+ #
1553
+ # @option params [Array<Types::Tag>] :tags
1554
+ # A list of [tags][1] to apply to the monitor resource.
1555
+ #
1556
+ #
1557
+ #
1558
+ # [1]: https://docs.aws.amazon.com/forecast/latest/dg/tagging-forecast-resources.html
1559
+ #
1560
+ # @return [Types::CreateMonitorResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1561
+ #
1562
+ # * {Types::CreateMonitorResponse#monitor_arn #monitor_arn} => String
1563
+ #
1564
+ # @example Request syntax with placeholder values
1565
+ #
1566
+ # resp = client.create_monitor({
1567
+ # monitor_name: "Name", # required
1568
+ # resource_arn: "Arn", # required
1569
+ # tags: [
1570
+ # {
1571
+ # key: "TagKey", # required
1572
+ # value: "TagValue", # required
1573
+ # },
1574
+ # ],
1575
+ # })
1576
+ #
1577
+ # @example Response structure
1578
+ #
1579
+ # resp.monitor_arn #=> String
1580
+ #
1581
+ # @see http://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/CreateMonitor AWS API Documentation
1582
+ #
1583
+ # @overload create_monitor(params = {})
1584
+ # @param [Hash] params ({})
1585
+ def create_monitor(params = {}, options = {})
1586
+ req = build_request(:create_monitor, params)
1587
+ req.send_request(options)
1588
+ end
1589
+
1472
1590
  # <note markdown="1"> This operation creates a legacy predictor that does not include all
1473
1591
  # the predictor functionalities provided by Amazon Forecast. To create a
1474
1592
  # predictor that is compatible with all aspects of Forecast, use
@@ -1886,16 +2004,23 @@ module Aws::ForecastService
1886
2004
  end
1887
2005
 
1888
2006
  # Deletes an Amazon Forecast dataset that was created using the
1889
- # CreateDataset operation. You can only delete datasets that have a
2007
+ # [CreateDataset][1] operation. You can only delete datasets that have a
1890
2008
  # status of `ACTIVE` or `CREATE_FAILED`. To get the status use the
1891
- # DescribeDataset operation.
2009
+ # [DescribeDataset][2] operation.
1892
2010
  #
1893
2011
  # <note markdown="1"> Forecast does not automatically update any dataset groups that contain
1894
2012
  # the deleted dataset. In order to update the dataset group, use the
1895
- # operation, omitting the deleted dataset's ARN.
2013
+ # [UpdateDatasetGroup][3] operation, omitting the deleted dataset's
2014
+ # ARN.
1896
2015
  #
1897
2016
  # </note>
1898
2017
  #
2018
+ #
2019
+ #
2020
+ # [1]: https://docs.aws.amazon.com/forecast/latest/dg/API_CreateDataset.html
2021
+ # [2]: https://docs.aws.amazon.com/forecast/latest/dg/API_DescribeDataset.html
2022
+ # [3]: https://docs.aws.amazon.com/forecast/latest/dg/API_UpdateDatasetGroup.html
2023
+ #
1899
2024
  # @option params [required, String] :dataset_arn
1900
2025
  # The Amazon Resource Name (ARN) of the dataset to delete.
1901
2026
  #
@@ -1916,14 +2041,19 @@ module Aws::ForecastService
1916
2041
  req.send_request(options)
1917
2042
  end
1918
2043
 
1919
- # Deletes a dataset group created using the CreateDatasetGroup
2044
+ # Deletes a dataset group created using the [CreateDatasetGroup][1]
1920
2045
  # operation. You can only delete dataset groups that have a status of
1921
2046
  # `ACTIVE`, `CREATE_FAILED`, or `UPDATE_FAILED`. To get the status, use
1922
- # the DescribeDatasetGroup operation.
2047
+ # the [DescribeDatasetGroup][2] operation.
1923
2048
  #
1924
2049
  # This operation deletes only the dataset group, not the datasets in the
1925
2050
  # group.
1926
2051
  #
2052
+ #
2053
+ #
2054
+ # [1]: https://docs.aws.amazon.com/forecast/latest/dg/API_CreateDatasetGroup.html
2055
+ # [2]: https://docs.aws.amazon.com/forecast/latest/dg/API_DescribeDatasetGroup.html
2056
+ #
1927
2057
  # @option params [required, String] :dataset_group_arn
1928
2058
  # The Amazon Resource Name (ARN) of the dataset group to delete.
1929
2059
  #
@@ -1944,10 +2074,15 @@ module Aws::ForecastService
1944
2074
  req.send_request(options)
1945
2075
  end
1946
2076
 
1947
- # Deletes a dataset import job created using the CreateDatasetImportJob
1948
- # operation. You can delete only dataset import jobs that have a status
1949
- # of `ACTIVE` or `CREATE_FAILED`. To get the status, use the
1950
- # DescribeDatasetImportJob operation.
2077
+ # Deletes a dataset import job created using the
2078
+ # [CreateDatasetImportJob][1] operation. You can delete only dataset
2079
+ # import jobs that have a status of `ACTIVE` or `CREATE_FAILED`. To get
2080
+ # the status, use the [DescribeDatasetImportJob][2] operation.
2081
+ #
2082
+ #
2083
+ #
2084
+ # [1]: https://docs.aws.amazon.com/forecast/latest/dg/API_CreateDatasetImportJob.html
2085
+ # [2]: https://docs.aws.amazon.com/forecast/latest/dg/API_DescribeDatasetImportJob.html
1951
2086
  #
1952
2087
  # @option params [required, String] :dataset_import_job_arn
1953
2088
  # The Amazon Resource Name (ARN) of the dataset import job to delete.
@@ -2071,6 +2206,30 @@ module Aws::ForecastService
2071
2206
  req.send_request(options)
2072
2207
  end
2073
2208
 
2209
+ # Deletes a monitor resource. You can only delete a monitor resource
2210
+ # with a status of `ACTIVE`, `ACTIVE_STOPPED`, `CREATE_FAILED`, or
2211
+ # `CREATE_STOPPED`.
2212
+ #
2213
+ # @option params [required, String] :monitor_arn
2214
+ # The Amazon Resource Name (ARN) of the monitor resource to delete.
2215
+ #
2216
+ # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
2217
+ #
2218
+ # @example Request syntax with placeholder values
2219
+ #
2220
+ # resp = client.delete_monitor({
2221
+ # monitor_arn: "Arn", # required
2222
+ # })
2223
+ #
2224
+ # @see http://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/DeleteMonitor AWS API Documentation
2225
+ #
2226
+ # @overload delete_monitor(params = {})
2227
+ # @param [Hash] params ({})
2228
+ def delete_monitor(params = {}, options = {})
2229
+ req = build_request(:delete_monitor, params)
2230
+ req.send_request(options)
2231
+ end
2232
+
2074
2233
  # Deletes a predictor created using the DescribePredictor or
2075
2234
  # CreatePredictor operations. You can delete only predictor that have a
2076
2235
  # status of `ACTIVE` or `CREATE_FAILED`. To get the status, use the
@@ -2190,6 +2349,7 @@ module Aws::ForecastService
2190
2349
  # * {Types::DescribeAutoPredictorResponse#last_modification_time #last_modification_time} => Time
2191
2350
  # * {Types::DescribeAutoPredictorResponse#optimization_metric #optimization_metric} => String
2192
2351
  # * {Types::DescribeAutoPredictorResponse#explainability_info #explainability_info} => Types::ExplainabilityInfo
2352
+ # * {Types::DescribeAutoPredictorResponse#monitor_info #monitor_info} => Types::MonitorInfo
2193
2353
  #
2194
2354
  # @example Request syntax with placeholder values
2195
2355
  #
@@ -2231,6 +2391,8 @@ module Aws::ForecastService
2231
2391
  # resp.optimization_metric #=> String, one of "WAPE", "RMSE", "AverageWeightedQuantileLoss", "MASE", "MAPE"
2232
2392
  # resp.explainability_info.explainability_arn #=> String
2233
2393
  # resp.explainability_info.status #=> String
2394
+ # resp.monitor_info.monitor_arn #=> String
2395
+ # resp.monitor_info.status #=> String
2234
2396
  #
2235
2397
  # @see http://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/DescribeAutoPredictor AWS API Documentation
2236
2398
  #
@@ -2241,8 +2403,8 @@ module Aws::ForecastService
2241
2403
  req.send_request(options)
2242
2404
  end
2243
2405
 
2244
- # Describes an Amazon Forecast dataset created using the CreateDataset
2245
- # operation.
2406
+ # Describes an Amazon Forecast dataset created using the
2407
+ # [CreateDataset][1] operation.
2246
2408
  #
2247
2409
  # In addition to listing the parameters specified in the `CreateDataset`
2248
2410
  # request, this operation includes the following dataset properties:
@@ -2253,6 +2415,10 @@ module Aws::ForecastService
2253
2415
  #
2254
2416
  # * `Status`
2255
2417
  #
2418
+ #
2419
+ #
2420
+ # [1]: https://docs.aws.amazon.com/forecast/latest/dg/API_CreateDataset.html
2421
+ #
2256
2422
  # @option params [required, String] :dataset_arn
2257
2423
  # The Amazon Resource Name (ARN) of the dataset.
2258
2424
  #
@@ -2300,7 +2466,7 @@ module Aws::ForecastService
2300
2466
  req.send_request(options)
2301
2467
  end
2302
2468
 
2303
- # Describes a dataset group created using the CreateDatasetGroup
2469
+ # Describes a dataset group created using the [CreateDatasetGroup][1]
2304
2470
  # operation.
2305
2471
  #
2306
2472
  # In addition to listing the parameters provided in the
@@ -2315,6 +2481,10 @@ module Aws::ForecastService
2315
2481
  #
2316
2482
  # * `Status`
2317
2483
  #
2484
+ #
2485
+ #
2486
+ # [1]: https://docs.aws.amazon.com/forecast/latest/dg/API_CreateDatasetGroup.html
2487
+ #
2318
2488
  # @option params [required, String] :dataset_group_arn
2319
2489
  # The Amazon Resource Name (ARN) of the dataset group.
2320
2490
  #
@@ -2355,7 +2525,7 @@ module Aws::ForecastService
2355
2525
  end
2356
2526
 
2357
2527
  # Describes a dataset import job created using the
2358
- # CreateDatasetImportJob operation.
2528
+ # [CreateDatasetImportJob][1] operation.
2359
2529
  #
2360
2530
  # In addition to listing the parameters provided in the
2361
2531
  # `CreateDatasetImportJob` request, this operation includes the
@@ -2373,6 +2543,10 @@ module Aws::ForecastService
2373
2543
  #
2374
2544
  # * `Message` - If an error occurred, information about the error.
2375
2545
  #
2546
+ #
2547
+ #
2548
+ # [1]: https://docs.aws.amazon.com/forecast/latest/dg/API_CreateDatasetImportJob.html
2549
+ #
2376
2550
  # @option params [required, String] :dataset_import_job_arn
2377
2551
  # The Amazon Resource Name (ARN) of the dataset import job.
2378
2552
  #
@@ -2664,6 +2838,72 @@ module Aws::ForecastService
2664
2838
  req.send_request(options)
2665
2839
  end
2666
2840
 
2841
+ # Describes a monitor resource. In addition to listing the properties
2842
+ # provided in the CreateMonitor request, this operation lists the
2843
+ # following properties:
2844
+ #
2845
+ # * `Baseline`
2846
+ #
2847
+ # * `CreationTime`
2848
+ #
2849
+ # * `LastEvaluationTime`
2850
+ #
2851
+ # * `LastEvaluationState`
2852
+ #
2853
+ # * `LastModificationTime`
2854
+ #
2855
+ # * `Message`
2856
+ #
2857
+ # * `Status`
2858
+ #
2859
+ # @option params [required, String] :monitor_arn
2860
+ # The Amazon Resource Name (ARN) of the monitor resource to describe.
2861
+ #
2862
+ # @return [Types::DescribeMonitorResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
2863
+ #
2864
+ # * {Types::DescribeMonitorResponse#monitor_name #monitor_name} => String
2865
+ # * {Types::DescribeMonitorResponse#monitor_arn #monitor_arn} => String
2866
+ # * {Types::DescribeMonitorResponse#resource_arn #resource_arn} => String
2867
+ # * {Types::DescribeMonitorResponse#status #status} => String
2868
+ # * {Types::DescribeMonitorResponse#last_evaluation_time #last_evaluation_time} => Time
2869
+ # * {Types::DescribeMonitorResponse#last_evaluation_state #last_evaluation_state} => String
2870
+ # * {Types::DescribeMonitorResponse#baseline #baseline} => Types::Baseline
2871
+ # * {Types::DescribeMonitorResponse#message #message} => String
2872
+ # * {Types::DescribeMonitorResponse#creation_time #creation_time} => Time
2873
+ # * {Types::DescribeMonitorResponse#last_modification_time #last_modification_time} => Time
2874
+ # * {Types::DescribeMonitorResponse#estimated_evaluation_time_remaining_in_minutes #estimated_evaluation_time_remaining_in_minutes} => Integer
2875
+ #
2876
+ # @example Request syntax with placeholder values
2877
+ #
2878
+ # resp = client.describe_monitor({
2879
+ # monitor_arn: "Arn", # required
2880
+ # })
2881
+ #
2882
+ # @example Response structure
2883
+ #
2884
+ # resp.monitor_name #=> String
2885
+ # resp.monitor_arn #=> String
2886
+ # resp.resource_arn #=> String
2887
+ # resp.status #=> String
2888
+ # resp.last_evaluation_time #=> Time
2889
+ # resp.last_evaluation_state #=> String
2890
+ # resp.baseline.predictor_baseline.baseline_metrics #=> Array
2891
+ # resp.baseline.predictor_baseline.baseline_metrics[0].name #=> String
2892
+ # resp.baseline.predictor_baseline.baseline_metrics[0].value #=> Float
2893
+ # resp.message #=> String
2894
+ # resp.creation_time #=> Time
2895
+ # resp.last_modification_time #=> Time
2896
+ # resp.estimated_evaluation_time_remaining_in_minutes #=> Integer
2897
+ #
2898
+ # @see http://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/DescribeMonitor AWS API Documentation
2899
+ #
2900
+ # @overload describe_monitor(params = {})
2901
+ # @param [Hash] params ({})
2902
+ def describe_monitor(params = {}, options = {})
2903
+ req = build_request(:describe_monitor, params)
2904
+ req.send_request(options)
2905
+ end
2906
+
2667
2907
  # <note markdown="1"> This operation is only valid for legacy predictors created with
2668
2908
  # CreatePredictor. If you are not using a legacy predictor, use
2669
2909
  # DescribeAutoPredictor.
@@ -2933,11 +3173,17 @@ module Aws::ForecastService
2933
3173
  req.send_request(options)
2934
3174
  end
2935
3175
 
2936
- # Returns a list of dataset groups created using the CreateDatasetGroup
2937
- # operation. For each dataset group, this operation returns a summary of
2938
- # its properties, including its Amazon Resource Name (ARN). You can
2939
- # retrieve the complete set of properties by using the dataset group ARN
2940
- # with the DescribeDatasetGroup operation.
3176
+ # Returns a list of dataset groups created using the
3177
+ # [CreateDatasetGroup][1] operation. For each dataset group, this
3178
+ # operation returns a summary of its properties, including its Amazon
3179
+ # Resource Name (ARN). You can retrieve the complete set of properties
3180
+ # by using the dataset group ARN with the [DescribeDatasetGroup][2]
3181
+ # operation.
3182
+ #
3183
+ #
3184
+ #
3185
+ # [1]: https://docs.aws.amazon.com/forecast/latest/dg/API_CreateDatasetGroup.html
3186
+ # [2]: https://docs.aws.amazon.com/forecast/latest/dg/API_DescribeDatasetGroup.html
2941
3187
  #
2942
3188
  # @option params [String] :next_token
2943
3189
  # If the result of the previous request was truncated, the response
@@ -2980,11 +3226,17 @@ module Aws::ForecastService
2980
3226
  end
2981
3227
 
2982
3228
  # Returns a list of dataset import jobs created using the
2983
- # CreateDatasetImportJob operation. For each import job, this operation
2984
- # returns a summary of its properties, including its Amazon Resource
2985
- # Name (ARN). You can retrieve the complete set of properties by using
2986
- # the ARN with the DescribeDatasetImportJob operation. You can filter
2987
- # the list by providing an array of Filter objects.
3229
+ # [CreateDatasetImportJob][1] operation. For each import job, this
3230
+ # operation returns a summary of its properties, including its Amazon
3231
+ # Resource Name (ARN). You can retrieve the complete set of properties
3232
+ # by using the ARN with the [DescribeDatasetImportJob][2] operation. You
3233
+ # can filter the list by providing an array of [Filter][3] objects.
3234
+ #
3235
+ #
3236
+ #
3237
+ # [1]: https://docs.aws.amazon.com/forecast/latest/dg/API_CreateDatasetImportJob.html
3238
+ # [2]: https://docs.aws.amazon.com/forecast/latest/dg/API_DescribeDatasetImportJob.html
3239
+ # [3]: https://docs.aws.amazon.com/forecast/latest/dg/API_Filter.html
2988
3240
  #
2989
3241
  # @option params [String] :next_token
2990
3242
  # If the result of the previous request was truncated, the response
@@ -3062,10 +3314,16 @@ module Aws::ForecastService
3062
3314
  req.send_request(options)
3063
3315
  end
3064
3316
 
3065
- # Returns a list of datasets created using the CreateDataset operation.
3066
- # For each dataset, a summary of its properties, including its Amazon
3067
- # Resource Name (ARN), is returned. To retrieve the complete set of
3068
- # properties, use the ARN with the DescribeDataset operation.
3317
+ # Returns a list of datasets created using the [CreateDataset][1]
3318
+ # operation. For each dataset, a summary of its properties, including
3319
+ # its Amazon Resource Name (ARN), is returned. To retrieve the complete
3320
+ # set of properties, use the ARN with the [DescribeDataset][2]
3321
+ # operation.
3322
+ #
3323
+ #
3324
+ #
3325
+ # [1]: https://docs.aws.amazon.com/forecast/latest/dg/API_CreateDataset.html
3326
+ # [2]: https://docs.aws.amazon.com/forecast/latest/dg/API_DescribeDataset.html
3069
3327
  #
3070
3328
  # @option params [String] :next_token
3071
3329
  # If the result of the previous request was truncated, the response
@@ -3147,6 +3405,8 @@ module Aws::ForecastService
3147
3405
  # * {Types::ListExplainabilitiesResponse#explainabilities #explainabilities} => Array&lt;Types::ExplainabilitySummary&gt;
3148
3406
  # * {Types::ListExplainabilitiesResponse#next_token #next_token} => String
3149
3407
  #
3408
+ # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
3409
+ #
3150
3410
  # @example Request syntax with placeholder values
3151
3411
  #
3152
3412
  # resp = client.list_explainabilities({
@@ -3222,6 +3482,8 @@ module Aws::ForecastService
3222
3482
  # * {Types::ListExplainabilityExportsResponse#explainability_exports #explainability_exports} => Array&lt;Types::ExplainabilityExportSummary&gt;
3223
3483
  # * {Types::ListExplainabilityExportsResponse#next_token #next_token} => String
3224
3484
  #
3485
+ # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
3486
+ #
3225
3487
  # @example Request syntax with placeholder values
3226
3488
  #
3227
3489
  # resp = client.list_explainability_exports({
@@ -3426,6 +3688,183 @@ module Aws::ForecastService
3426
3688
  req.send_request(options)
3427
3689
  end
3428
3690
 
3691
+ # Returns a list of the monitoring evaluation results and predictor
3692
+ # events collected by the monitor resource during different windows of
3693
+ # time.
3694
+ #
3695
+ # For information about monitoring see [Viewing Monitoring Results][1].
3696
+ # For more information about retrieving monitoring results see [Viewing
3697
+ # Monitoring Results][1].
3698
+ #
3699
+ #
3700
+ #
3701
+ # [1]: https://docs.aws.amazon.com/forecast/latest/dg/predictor-monitoring-results.html
3702
+ #
3703
+ # @option params [String] :next_token
3704
+ # If the result of the previous request was truncated, the response
3705
+ # includes a `NextToken`. To retrieve the next set of results, use the
3706
+ # token in the next request. Tokens expire after 24 hours.
3707
+ #
3708
+ # @option params [Integer] :max_results
3709
+ # The maximum number of monitoring results to return.
3710
+ #
3711
+ # @option params [required, String] :monitor_arn
3712
+ # The Amazon Resource Name (ARN) of the monitor resource to get results
3713
+ # from.
3714
+ #
3715
+ # @option params [Array<Types::Filter>] :filters
3716
+ # An array of filters. For each filter, provide a condition and a match
3717
+ # statement. The condition is either `IS` or `IS_NOT`, which specifies
3718
+ # whether to include or exclude the resources that match the statement
3719
+ # from the list. The match statement consists of a key and a value.
3720
+ #
3721
+ # **Filter properties**
3722
+ #
3723
+ # * `Condition` - The condition to apply. Valid values are `IS` and
3724
+ # `IS_NOT`.
3725
+ #
3726
+ # * `Key` - The name of the parameter to filter on. The only valid value
3727
+ # is `EvaluationState`.
3728
+ #
3729
+ # * `Value` - The value to match. Valid values are only `SUCCESS` or
3730
+ # `FAILURE`.
3731
+ #
3732
+ # For example, to list only successful monitor evaluations, you would
3733
+ # specify:
3734
+ #
3735
+ # `"Filters": [ \{ "Condition": "IS", "Key": "EvaluationState", "Value":
3736
+ # "SUCCESS" \} ]`
3737
+ #
3738
+ # @return [Types::ListMonitorEvaluationsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
3739
+ #
3740
+ # * {Types::ListMonitorEvaluationsResponse#next_token #next_token} => String
3741
+ # * {Types::ListMonitorEvaluationsResponse#predictor_monitor_evaluations #predictor_monitor_evaluations} => Array&lt;Types::PredictorMonitorEvaluation&gt;
3742
+ #
3743
+ # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
3744
+ #
3745
+ # @example Request syntax with placeholder values
3746
+ #
3747
+ # resp = client.list_monitor_evaluations({
3748
+ # next_token: "NextToken",
3749
+ # max_results: 1,
3750
+ # monitor_arn: "Arn", # required
3751
+ # filters: [
3752
+ # {
3753
+ # key: "String", # required
3754
+ # value: "Arn", # required
3755
+ # condition: "IS", # required, accepts IS, IS_NOT
3756
+ # },
3757
+ # ],
3758
+ # })
3759
+ #
3760
+ # @example Response structure
3761
+ #
3762
+ # resp.next_token #=> String
3763
+ # resp.predictor_monitor_evaluations #=> Array
3764
+ # resp.predictor_monitor_evaluations[0].resource_arn #=> String
3765
+ # resp.predictor_monitor_evaluations[0].monitor_arn #=> String
3766
+ # resp.predictor_monitor_evaluations[0].evaluation_time #=> Time
3767
+ # resp.predictor_monitor_evaluations[0].evaluation_state #=> String
3768
+ # resp.predictor_monitor_evaluations[0].window_start_datetime #=> Time
3769
+ # resp.predictor_monitor_evaluations[0].window_end_datetime #=> Time
3770
+ # resp.predictor_monitor_evaluations[0].predictor_event.detail #=> String
3771
+ # resp.predictor_monitor_evaluations[0].predictor_event.datetime #=> Time
3772
+ # resp.predictor_monitor_evaluations[0].monitor_data_source.dataset_import_job_arn #=> String
3773
+ # resp.predictor_monitor_evaluations[0].monitor_data_source.forecast_arn #=> String
3774
+ # resp.predictor_monitor_evaluations[0].monitor_data_source.predictor_arn #=> String
3775
+ # resp.predictor_monitor_evaluations[0].metric_results #=> Array
3776
+ # resp.predictor_monitor_evaluations[0].metric_results[0].metric_name #=> String
3777
+ # resp.predictor_monitor_evaluations[0].metric_results[0].metric_value #=> Float
3778
+ # resp.predictor_monitor_evaluations[0].num_items_evaluated #=> Integer
3779
+ # resp.predictor_monitor_evaluations[0].message #=> String
3780
+ #
3781
+ # @see http://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/ListMonitorEvaluations AWS API Documentation
3782
+ #
3783
+ # @overload list_monitor_evaluations(params = {})
3784
+ # @param [Hash] params ({})
3785
+ def list_monitor_evaluations(params = {}, options = {})
3786
+ req = build_request(:list_monitor_evaluations, params)
3787
+ req.send_request(options)
3788
+ end
3789
+
3790
+ # Returns a list of monitors created with the CreateMonitor operation
3791
+ # and CreateAutoPredictor operation. For each monitor resource, this
3792
+ # operation returns of a summary of its properties, including its Amazon
3793
+ # Resource Name (ARN). You can retrieve a complete set of properties of
3794
+ # a monitor resource by specify the monitor's ARN in the
3795
+ # DescribeMonitor operation.
3796
+ #
3797
+ # @option params [String] :next_token
3798
+ # If the result of the previous request was truncated, the response
3799
+ # includes a `NextToken`. To retrieve the next set of results, use the
3800
+ # token in the next request. Tokens expire after 24 hours.
3801
+ #
3802
+ # @option params [Integer] :max_results
3803
+ # The maximum number of monitors to include in the response.
3804
+ #
3805
+ # @option params [Array<Types::Filter>] :filters
3806
+ # An array of filters. For each filter, provide a condition and a match
3807
+ # statement. The condition is either `IS` or `IS_NOT`, which specifies
3808
+ # whether to include or exclude the resources that match the statement
3809
+ # from the list. The match statement consists of a key and a value.
3810
+ #
3811
+ # **Filter properties**
3812
+ #
3813
+ # * `Condition` - The condition to apply. Valid values are `IS` and
3814
+ # `IS_NOT`.
3815
+ #
3816
+ # * `Key` - The name of the parameter to filter on. The only valid value
3817
+ # is `Status`.
3818
+ #
3819
+ # * `Value` - The value to match.
3820
+ #
3821
+ # For example, to list all monitors who's status is ACTIVE, you would
3822
+ # specify:
3823
+ #
3824
+ # `"Filters": [ \{ "Condition": "IS", "Key": "Status", "Value": "ACTIVE"
3825
+ # \} ]`
3826
+ #
3827
+ # @return [Types::ListMonitorsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
3828
+ #
3829
+ # * {Types::ListMonitorsResponse#monitors #monitors} => Array&lt;Types::MonitorSummary&gt;
3830
+ # * {Types::ListMonitorsResponse#next_token #next_token} => String
3831
+ #
3832
+ # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
3833
+ #
3834
+ # @example Request syntax with placeholder values
3835
+ #
3836
+ # resp = client.list_monitors({
3837
+ # next_token: "NextToken",
3838
+ # max_results: 1,
3839
+ # filters: [
3840
+ # {
3841
+ # key: "String", # required
3842
+ # value: "Arn", # required
3843
+ # condition: "IS", # required, accepts IS, IS_NOT
3844
+ # },
3845
+ # ],
3846
+ # })
3847
+ #
3848
+ # @example Response structure
3849
+ #
3850
+ # resp.monitors #=> Array
3851
+ # resp.monitors[0].monitor_arn #=> String
3852
+ # resp.monitors[0].monitor_name #=> String
3853
+ # resp.monitors[0].resource_arn #=> String
3854
+ # resp.monitors[0].status #=> String
3855
+ # resp.monitors[0].creation_time #=> Time
3856
+ # resp.monitors[0].last_modification_time #=> Time
3857
+ # resp.next_token #=> String
3858
+ #
3859
+ # @see http://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/ListMonitors AWS API Documentation
3860
+ #
3861
+ # @overload list_monitors(params = {})
3862
+ # @param [Hash] params ({})
3863
+ def list_monitors(params = {}, options = {})
3864
+ req = build_request(:list_monitors, params)
3865
+ req.send_request(options)
3866
+ end
3867
+
3429
3868
  # Returns a list of predictor backtest export jobs created using the
3430
3869
  # CreatePredictorBacktestExportJob operation. This operation returns a
3431
3870
  # summary for each backtest export job. You can filter the list using an
@@ -3622,6 +4061,28 @@ module Aws::ForecastService
3622
4061
  req.send_request(options)
3623
4062
  end
3624
4063
 
4064
+ # Resumes a stopped monitor resource.
4065
+ #
4066
+ # @option params [required, String] :resource_arn
4067
+ # The Amazon Resource Name (ARN) of the monitor resource to resume.
4068
+ #
4069
+ # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
4070
+ #
4071
+ # @example Request syntax with placeholder values
4072
+ #
4073
+ # resp = client.resume_resource({
4074
+ # resource_arn: "Arn", # required
4075
+ # })
4076
+ #
4077
+ # @see http://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/ResumeResource AWS API Documentation
4078
+ #
4079
+ # @overload resume_resource(params = {})
4080
+ # @param [Hash] params ({})
4081
+ def resume_resource(params = {}, options = {})
4082
+ req = build_request(:resume_resource, params)
4083
+ req.send_request(options)
4084
+ end
4085
+
3625
4086
  # Stops a resource.
3626
4087
  #
3627
4088
  # The resource undergoes the following states: `CREATE_STOPPING` and
@@ -3761,11 +4222,15 @@ module Aws::ForecastService
3761
4222
  # Replaces the datasets in a dataset group with the specified datasets.
3762
4223
  #
3763
4224
  # <note markdown="1"> The `Status` of the dataset group must be `ACTIVE` before you can use
3764
- # the dataset group to create a predictor. Use the DescribeDatasetGroup
3765
- # operation to get the status.
4225
+ # the dataset group to create a predictor. Use the
4226
+ # [DescribeDatasetGroup][1] operation to get the status.
3766
4227
  #
3767
4228
  # </note>
3768
4229
  #
4230
+ #
4231
+ #
4232
+ # [1]: https://docs.aws.amazon.com/forecast/latest/dg/API_DescribeDatasetGroup.html
4233
+ #
3769
4234
  # @option params [required, String] :dataset_group_arn
3770
4235
  # The ARN of the dataset group.
3771
4236
  #
@@ -3804,7 +4269,7 @@ module Aws::ForecastService
3804
4269
  params: params,
3805
4270
  config: config)
3806
4271
  context[:gem_name] = 'aws-sdk-forecastservice'
3807
- context[:gem_version] = '1.33.0'
4272
+ context[:gem_version] = '1.34.0'
3808
4273
  Seahorse::Client::Request.new(handlers, context)
3809
4274
  end
3810
4275