aws-sdk-forecastservice 1.31.0 → 1.34.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/CHANGELOG.md +15 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-forecastservice/client.rb +525 -56
- data/lib/aws-sdk-forecastservice/client_api.rb +228 -0
- data/lib/aws-sdk-forecastservice/types.rb +808 -30
- data/lib/aws-sdk-forecastservice.rb +1 -1
- metadata +4 -4
@@ -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,9 @@ module Aws::ForecastService
|
|
421
464
|
# value: "TagValue", # required
|
422
465
|
# },
|
423
466
|
# ],
|
467
|
+
# monitor_config: {
|
468
|
+
# monitor_name: "Name", # required
|
469
|
+
# },
|
424
470
|
# }
|
425
471
|
#
|
426
472
|
# @!attribute [rw] predictor_name
|
@@ -430,6 +476,17 @@ module Aws::ForecastService
|
|
430
476
|
# @!attribute [rw] forecast_horizon
|
431
477
|
# The number of time-steps that the model predicts. The forecast
|
432
478
|
# horizon is also called the prediction length.
|
479
|
+
#
|
480
|
+
# The maximum forecast horizon is the lesser of 500 time-steps or 1/4
|
481
|
+
# of the TARGET\_TIME\_SERIES dataset length. If you are retraining an
|
482
|
+
# existing AutoPredictor, then the maximum forecast horizon is the
|
483
|
+
# lesser of 500 time-steps or 1/3 of the TARGET\_TIME\_SERIES dataset
|
484
|
+
# length.
|
485
|
+
#
|
486
|
+
# If you are upgrading to an AutoPredictor or retraining an existing
|
487
|
+
# AutoPredictor, you cannot update the forecast horizon parameter. You
|
488
|
+
# can meet this requirement by providing longer time-series in the
|
489
|
+
# dataset.
|
433
490
|
# @return [Integer]
|
434
491
|
#
|
435
492
|
# @!attribute [rw] forecast_types
|
@@ -524,6 +581,19 @@ module Aws::ForecastService
|
|
524
581
|
# prefix.
|
525
582
|
# @return [Array<Types::Tag>]
|
526
583
|
#
|
584
|
+
# @!attribute [rw] monitor_config
|
585
|
+
# The configuration details for predictor monitoring. Provide a name
|
586
|
+
# for the monitor resource to enable predictor monitoring.
|
587
|
+
#
|
588
|
+
# Predictor monitoring allows you to see how your predictor's
|
589
|
+
# performance changes over time. For more information, see [Predictor
|
590
|
+
# Monitoring][1].
|
591
|
+
#
|
592
|
+
#
|
593
|
+
#
|
594
|
+
# [1]: https://docs.aws.amazon.com/forecast/latest/dg/predictor-monitoring.html
|
595
|
+
# @return [Types::MonitorConfig]
|
596
|
+
#
|
527
597
|
# @see http://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/CreateAutoPredictorRequest AWS API Documentation
|
528
598
|
#
|
529
599
|
class CreateAutoPredictorRequest < Struct.new(
|
@@ -537,7 +607,8 @@ module Aws::ForecastService
|
|
537
607
|
:reference_predictor_arn,
|
538
608
|
:optimization_metric,
|
539
609
|
:explain_predictor,
|
540
|
-
:tags
|
610
|
+
:tags,
|
611
|
+
:monitor_config)
|
541
612
|
SENSITIVE = []
|
542
613
|
include Aws::Structure
|
543
614
|
end
|
@@ -576,14 +647,19 @@ module Aws::ForecastService
|
|
576
647
|
# @!attribute [rw] domain
|
577
648
|
# The domain associated with the dataset group. When you add a dataset
|
578
649
|
# to a dataset group, this value and the value specified for the
|
579
|
-
# `Domain` parameter of the CreateDataset operation must match.
|
650
|
+
# `Domain` parameter of the [CreateDataset][1] operation must match.
|
580
651
|
#
|
581
652
|
# The `Domain` and `DatasetType` that you choose determine the fields
|
582
653
|
# that must be present in training data that you import to a dataset.
|
583
654
|
# For example, if you choose the `RETAIL` domain and
|
584
655
|
# `TARGET_TIME_SERIES` as the `DatasetType`, Amazon Forecast requires
|
585
656
|
# that `item_id`, `timestamp`, and `demand` fields are present in your
|
586
|
-
# data. For more information, see
|
657
|
+
# data. For more information, see [Dataset groups][2].
|
658
|
+
#
|
659
|
+
#
|
660
|
+
#
|
661
|
+
# [1]: https://docs.aws.amazon.com/forecast/latest/dg/API_CreateDataset.html
|
662
|
+
# [2]: https://docs.aws.amazon.com/forecast/latest/dg/howitworks-datasets-groups.html
|
587
663
|
# @return [String]
|
588
664
|
#
|
589
665
|
# @!attribute [rw] dataset_arns
|
@@ -694,7 +770,11 @@ module Aws::ForecastService
|
|
694
770
|
# Management Service (KMS) key and the IAM role must allow Amazon
|
695
771
|
# Forecast permission to access the key. The KMS key and IAM role must
|
696
772
|
# match those specified in the `EncryptionConfig` parameter of the
|
697
|
-
# CreateDataset operation.
|
773
|
+
# [CreateDataset][1] operation.
|
774
|
+
#
|
775
|
+
#
|
776
|
+
#
|
777
|
+
# [1]: https://docs.aws.amazon.com/forecast/latest/dg/API_CreateDataset.html
|
698
778
|
# @return [Types::DataSource]
|
699
779
|
#
|
700
780
|
# @!attribute [rw] timestamp_format
|
@@ -841,14 +921,19 @@ module Aws::ForecastService
|
|
841
921
|
# @!attribute [rw] domain
|
842
922
|
# The domain associated with the dataset. When you add a dataset to a
|
843
923
|
# dataset group, this value and the value specified for the `Domain`
|
844
|
-
# parameter of the CreateDatasetGroup operation must match.
|
924
|
+
# parameter of the [CreateDatasetGroup][1] operation must match.
|
845
925
|
#
|
846
926
|
# The `Domain` and `DatasetType` that you choose determine the fields
|
847
927
|
# that must be present in the training data that you import to the
|
848
928
|
# dataset. For example, if you choose the `RETAIL` domain and
|
849
929
|
# `TARGET_TIME_SERIES` as the `DatasetType`, Amazon Forecast requires
|
850
930
|
# `item_id`, `timestamp`, and `demand` fields to be present in your
|
851
|
-
# data. For more information, see
|
931
|
+
# data. For more information, see [Importing datasets][2].
|
932
|
+
#
|
933
|
+
#
|
934
|
+
#
|
935
|
+
# [1]: https://docs.aws.amazon.com/forecast/latest/dg/API_CreateDatasetGroup.html
|
936
|
+
# [2]: https://docs.aws.amazon.com/forecast/latest/dg/howitworks-datasets-groups.html
|
852
937
|
# @return [String]
|
853
938
|
#
|
854
939
|
# @!attribute [rw] dataset_type
|
@@ -870,7 +955,12 @@ module Aws::ForecastService
|
|
870
955
|
# must match the fields in your data. The dataset `Domain` and
|
871
956
|
# `DatasetType` that you choose determine the minimum required fields
|
872
957
|
# in your training data. For information about the required fields for
|
873
|
-
# a specific dataset domain and type, see
|
958
|
+
# a specific dataset domain and type, see [Dataset Domains and Dataset
|
959
|
+
# Types][1].
|
960
|
+
#
|
961
|
+
#
|
962
|
+
#
|
963
|
+
# [1]: https://docs.aws.amazon.com/forecast/latest/dg/howitworks-domains-ds-types.html
|
874
964
|
# @return [Types::Schema]
|
875
965
|
#
|
876
966
|
# @!attribute [rw] encryption_config
|
@@ -1088,7 +1178,7 @@ module Aws::ForecastService
|
|
1088
1178
|
# @return [Types::Schema]
|
1089
1179
|
#
|
1090
1180
|
# @!attribute [rw] enable_visualization
|
1091
|
-
# Create an
|
1181
|
+
# Create an Explainability visualization that is viewable within the
|
1092
1182
|
# AWS console.
|
1093
1183
|
# @return [Boolean]
|
1094
1184
|
#
|
@@ -1293,7 +1383,11 @@ module Aws::ForecastService
|
|
1293
1383
|
# values include `0.01 to 0.99` (increments of .01 only) and `mean`.
|
1294
1384
|
# The mean forecast is different from the median (0.50) when the
|
1295
1385
|
# distribution is not symmetric (for example, Beta and Negative
|
1296
|
-
# Binomial).
|
1386
|
+
# Binomial).
|
1387
|
+
#
|
1388
|
+
# The default quantiles are the quantiles you specified during
|
1389
|
+
# predictor creation. If you didn't specify quantiles, the default
|
1390
|
+
# values are `["0.1", "0.5", "0.9"]`.
|
1297
1391
|
# @return [Array<String>]
|
1298
1392
|
#
|
1299
1393
|
# @!attribute [rw] tags
|
@@ -1352,6 +1446,58 @@ module Aws::ForecastService
|
|
1352
1446
|
include Aws::Structure
|
1353
1447
|
end
|
1354
1448
|
|
1449
|
+
# @note When making an API call, you may pass CreateMonitorRequest
|
1450
|
+
# data as a hash:
|
1451
|
+
#
|
1452
|
+
# {
|
1453
|
+
# monitor_name: "Name", # required
|
1454
|
+
# resource_arn: "Arn", # required
|
1455
|
+
# tags: [
|
1456
|
+
# {
|
1457
|
+
# key: "TagKey", # required
|
1458
|
+
# value: "TagValue", # required
|
1459
|
+
# },
|
1460
|
+
# ],
|
1461
|
+
# }
|
1462
|
+
#
|
1463
|
+
# @!attribute [rw] monitor_name
|
1464
|
+
# The name of the monitor resource.
|
1465
|
+
# @return [String]
|
1466
|
+
#
|
1467
|
+
# @!attribute [rw] resource_arn
|
1468
|
+
# The Amazon Resource Name (ARN) of the predictor to monitor.
|
1469
|
+
# @return [String]
|
1470
|
+
#
|
1471
|
+
# @!attribute [rw] tags
|
1472
|
+
# A list of [tags][1] to apply to the monitor resource.
|
1473
|
+
#
|
1474
|
+
#
|
1475
|
+
#
|
1476
|
+
# [1]: https://docs.aws.amazon.com/forecast/latest/dg/tagging-forecast-resources.html
|
1477
|
+
# @return [Array<Types::Tag>]
|
1478
|
+
#
|
1479
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/CreateMonitorRequest AWS API Documentation
|
1480
|
+
#
|
1481
|
+
class CreateMonitorRequest < Struct.new(
|
1482
|
+
:monitor_name,
|
1483
|
+
:resource_arn,
|
1484
|
+
:tags)
|
1485
|
+
SENSITIVE = []
|
1486
|
+
include Aws::Structure
|
1487
|
+
end
|
1488
|
+
|
1489
|
+
# @!attribute [rw] monitor_arn
|
1490
|
+
# The Amazon Resource Name (ARN) of the monitor resource.
|
1491
|
+
# @return [String]
|
1492
|
+
#
|
1493
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/CreateMonitorResponse AWS API Documentation
|
1494
|
+
#
|
1495
|
+
class CreateMonitorResponse < Struct.new(
|
1496
|
+
:monitor_arn)
|
1497
|
+
SENSITIVE = []
|
1498
|
+
include Aws::Structure
|
1499
|
+
end
|
1500
|
+
|
1355
1501
|
# @note When making an API call, you may pass CreatePredictorBacktestExportJobRequest
|
1356
1502
|
# data as a hash:
|
1357
1503
|
#
|
@@ -1839,9 +1985,14 @@ module Aws::ForecastService
|
|
1839
1985
|
end
|
1840
1986
|
|
1841
1987
|
# Provides a summary of the dataset group properties used in the
|
1842
|
-
# ListDatasetGroups operation. To get the complete set of
|
1843
|
-
# call the DescribeDatasetGroup operation, and provide
|
1844
|
-
# `DatasetGroupArn`.
|
1988
|
+
# [ListDatasetGroups][1] operation. To get the complete set of
|
1989
|
+
# properties, call the [DescribeDatasetGroup][2] operation, and provide
|
1990
|
+
# the `DatasetGroupArn`.
|
1991
|
+
#
|
1992
|
+
#
|
1993
|
+
#
|
1994
|
+
# [1]: https://docs.aws.amazon.com/forecast/latest/dg/API_ListDatasetGroups.html
|
1995
|
+
# [2]: https://docs.aws.amazon.com/forecast/latest/dg/API_DescribeDatasetGroup.html
|
1845
1996
|
#
|
1846
1997
|
# @!attribute [rw] dataset_group_arn
|
1847
1998
|
# The Amazon Resource Name (ARN) of the dataset group.
|
@@ -1857,9 +2008,13 @@ module Aws::ForecastService
|
|
1857
2008
|
#
|
1858
2009
|
# @!attribute [rw] last_modification_time
|
1859
2010
|
# When the dataset group was created or last updated from a call to
|
1860
|
-
# the UpdateDatasetGroup operation. While the dataset group is
|
1861
|
-
# updated, `LastModificationTime` is the current time of the
|
2011
|
+
# the [UpdateDatasetGroup][1] operation. While the dataset group is
|
2012
|
+
# being updated, `LastModificationTime` is the current time of the
|
1862
2013
|
# `ListDatasetGroups` call.
|
2014
|
+
#
|
2015
|
+
#
|
2016
|
+
#
|
2017
|
+
# [1]: https://docs.aws.amazon.com/forecast/latest/dg/API_UpdateDatasetGroup.html
|
1863
2018
|
# @return [Time]
|
1864
2019
|
#
|
1865
2020
|
# @see http://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/DatasetGroupSummary AWS API Documentation
|
@@ -1874,9 +2029,14 @@ module Aws::ForecastService
|
|
1874
2029
|
end
|
1875
2030
|
|
1876
2031
|
# 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
|
1879
|
-
# the `DatasetImportJobArn`.
|
2032
|
+
# [ListDatasetImportJobs][1] operation. To get the complete set of
|
2033
|
+
# properties, call the [DescribeDatasetImportJob][2] operation, and
|
2034
|
+
# provide the `DatasetImportJobArn`.
|
2035
|
+
#
|
2036
|
+
#
|
2037
|
+
#
|
2038
|
+
# [1]: https://docs.aws.amazon.com/forecast/latest/dg/API_ListDatasetImportJobs.html
|
2039
|
+
# [2]: https://docs.aws.amazon.com/forecast/latest/dg/API_DescribeDatasetImportJob.html
|
1880
2040
|
#
|
1881
2041
|
# @!attribute [rw] dataset_import_job_arn
|
1882
2042
|
# The Amazon Resource Name (ARN) of the dataset import job.
|
@@ -1945,9 +2105,14 @@ module Aws::ForecastService
|
|
1945
2105
|
include Aws::Structure
|
1946
2106
|
end
|
1947
2107
|
|
1948
|
-
# Provides a summary of the dataset properties used in the
|
1949
|
-
# operation. To get the complete set of properties,
|
1950
|
-
# DescribeDataset operation, and provide the `DatasetArn`.
|
2108
|
+
# Provides a summary of the dataset properties used in the
|
2109
|
+
# [ListDatasets][1] operation. To get the complete set of properties,
|
2110
|
+
# call the [DescribeDataset][2] operation, and provide the `DatasetArn`.
|
2111
|
+
#
|
2112
|
+
#
|
2113
|
+
#
|
2114
|
+
# [1]: https://docs.aws.amazon.com/forecast/latest/dg/API_ListDatasets.html
|
2115
|
+
# [2]: https://docs.aws.amazon.com/forecast/latest/dg/API_DescribeDataset.html
|
1951
2116
|
#
|
1952
2117
|
# @!attribute [rw] dataset_arn
|
1953
2118
|
# The Amazon Resource Name (ARN) of the dataset.
|
@@ -1973,8 +2138,12 @@ module Aws::ForecastService
|
|
1973
2138
|
# When you create a dataset, `LastModificationTime` is the same as
|
1974
2139
|
# `CreationTime`. While data is being imported to the dataset,
|
1975
2140
|
# `LastModificationTime` is the current time of the `ListDatasets`
|
1976
|
-
# call. After a CreateDatasetImportJob operation has finished,
|
2141
|
+
# call. After a [CreateDatasetImportJob][1] operation has finished,
|
1977
2142
|
# `LastModificationTime` is when the import job completed or failed.
|
2143
|
+
#
|
2144
|
+
#
|
2145
|
+
#
|
2146
|
+
# [1]: https://docs.aws.amazon.com/forecast/latest/dg/API_CreateDatasetImportJob.html
|
1978
2147
|
# @return [Time]
|
1979
2148
|
#
|
1980
2149
|
# @see http://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/DatasetSummary AWS API Documentation
|
@@ -2125,6 +2294,25 @@ module Aws::ForecastService
|
|
2125
2294
|
include Aws::Structure
|
2126
2295
|
end
|
2127
2296
|
|
2297
|
+
# @note When making an API call, you may pass DeleteMonitorRequest
|
2298
|
+
# data as a hash:
|
2299
|
+
#
|
2300
|
+
# {
|
2301
|
+
# monitor_arn: "Arn", # required
|
2302
|
+
# }
|
2303
|
+
#
|
2304
|
+
# @!attribute [rw] monitor_arn
|
2305
|
+
# The Amazon Resource Name (ARN) of the monitor resource to delete.
|
2306
|
+
# @return [String]
|
2307
|
+
#
|
2308
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/DeleteMonitorRequest AWS API Documentation
|
2309
|
+
#
|
2310
|
+
class DeleteMonitorRequest < Struct.new(
|
2311
|
+
:monitor_arn)
|
2312
|
+
SENSITIVE = []
|
2313
|
+
include Aws::Structure
|
2314
|
+
end
|
2315
|
+
|
2128
2316
|
# @note When making an API call, you may pass DeletePredictorBacktestExportJobRequest
|
2129
2317
|
# data as a hash:
|
2130
2318
|
#
|
@@ -2306,6 +2494,11 @@ module Aws::ForecastService
|
|
2306
2494
|
# Provides the status and ARN of the Predictor Explainability.
|
2307
2495
|
# @return [Types::ExplainabilityInfo]
|
2308
2496
|
#
|
2497
|
+
# @!attribute [rw] monitor_info
|
2498
|
+
# A object with the Amazon Resource Name (ARN) and status of the
|
2499
|
+
# monitor resource.
|
2500
|
+
# @return [Types::MonitorInfo]
|
2501
|
+
#
|
2309
2502
|
# @see http://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/DescribeAutoPredictorResponse AWS API Documentation
|
2310
2503
|
#
|
2311
2504
|
class DescribeAutoPredictorResponse < Struct.new(
|
@@ -2325,7 +2518,8 @@ module Aws::ForecastService
|
|
2325
2518
|
:creation_time,
|
2326
2519
|
:last_modification_time,
|
2327
2520
|
:optimization_metric,
|
2328
|
-
:explainability_info
|
2521
|
+
:explainability_info,
|
2522
|
+
:monitor_info)
|
2329
2523
|
SENSITIVE = []
|
2330
2524
|
include Aws::Structure
|
2331
2525
|
end
|
@@ -2377,13 +2571,17 @@ module Aws::ForecastService
|
|
2377
2571
|
#
|
2378
2572
|
# * `UPDATE_PENDING`, `UPDATE_IN_PROGRESS`, `UPDATE_FAILED`
|
2379
2573
|
#
|
2380
|
-
# The `UPDATE` states apply when you call the UpdateDatasetGroup
|
2574
|
+
# The `UPDATE` states apply when you call the [UpdateDatasetGroup][1]
|
2381
2575
|
# operation.
|
2382
2576
|
#
|
2383
2577
|
# <note markdown="1"> The `Status` of the dataset group must be `ACTIVE` before you can
|
2384
2578
|
# use the dataset group to create a predictor.
|
2385
2579
|
#
|
2386
2580
|
# </note>
|
2581
|
+
#
|
2582
|
+
#
|
2583
|
+
#
|
2584
|
+
# [1]: https://docs.aws.amazon.com/forecast/latest/dg/API_UpdateDatasetGroup.html
|
2387
2585
|
# @return [String]
|
2388
2586
|
#
|
2389
2587
|
# @!attribute [rw] creation_time
|
@@ -2392,9 +2590,13 @@ module Aws::ForecastService
|
|
2392
2590
|
#
|
2393
2591
|
# @!attribute [rw] last_modification_time
|
2394
2592
|
# When the dataset group was created or last updated from a call to
|
2395
|
-
# the UpdateDatasetGroup operation. While the dataset group is
|
2396
|
-
# updated, `LastModificationTime` is the current time of the
|
2593
|
+
# the [UpdateDatasetGroup][1] operation. While the dataset group is
|
2594
|
+
# being updated, `LastModificationTime` is the current time of the
|
2397
2595
|
# `DescribeDatasetGroup` call.
|
2596
|
+
#
|
2597
|
+
#
|
2598
|
+
#
|
2599
|
+
# [1]: https://docs.aws.amazon.com/forecast/latest/dg/API_UpdateDatasetGroup.html
|
2398
2600
|
# @return [Time]
|
2399
2601
|
#
|
2400
2602
|
# @see http://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/DescribeDatasetGroupResponse AWS API Documentation
|
@@ -2620,7 +2822,7 @@ module Aws::ForecastService
|
|
2620
2822
|
# * `UPDATE_PENDING`, `UPDATE_IN_PROGRESS`, `UPDATE_FAILED`
|
2621
2823
|
#
|
2622
2824
|
# The `UPDATE` states apply while data is imported to the dataset from
|
2623
|
-
# a call to the CreateDatasetImportJob operation and reflect the
|
2825
|
+
# a call to the [CreateDatasetImportJob][1] operation and reflect the
|
2624
2826
|
# status of the dataset import job. For example, when the import job
|
2625
2827
|
# status is `CREATE_IN_PROGRESS`, the status of the dataset is
|
2626
2828
|
# `UPDATE_IN_PROGRESS`.
|
@@ -2629,6 +2831,10 @@ module Aws::ForecastService
|
|
2629
2831
|
# training data.
|
2630
2832
|
#
|
2631
2833
|
# </note>
|
2834
|
+
#
|
2835
|
+
#
|
2836
|
+
#
|
2837
|
+
# [1]: https://docs.aws.amazon.com/forecast/latest/dg/API_CreateDatasetImportJob.html
|
2632
2838
|
# @return [String]
|
2633
2839
|
#
|
2634
2840
|
# @!attribute [rw] creation_time
|
@@ -2639,8 +2845,12 @@ module Aws::ForecastService
|
|
2639
2845
|
# When you create a dataset, `LastModificationTime` is the same as
|
2640
2846
|
# `CreationTime`. While data is being imported to the dataset,
|
2641
2847
|
# `LastModificationTime` is the current time of the `DescribeDataset`
|
2642
|
-
# call. After a CreateDatasetImportJob operation has finished,
|
2848
|
+
# call. After a [CreateDatasetImportJob][1] operation has finished,
|
2643
2849
|
# `LastModificationTime` is when the import job completed or failed.
|
2850
|
+
#
|
2851
|
+
#
|
2852
|
+
#
|
2853
|
+
# [1]: https://docs.aws.amazon.com/forecast/latest/dg/API_CreateDatasetImportJob.html
|
2644
2854
|
# @return [Time]
|
2645
2855
|
#
|
2646
2856
|
# @see http://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/DescribeDatasetResponse AWS API Documentation
|
@@ -3064,6 +3274,90 @@ module Aws::ForecastService
|
|
3064
3274
|
include Aws::Structure
|
3065
3275
|
end
|
3066
3276
|
|
3277
|
+
# @note When making an API call, you may pass DescribeMonitorRequest
|
3278
|
+
# data as a hash:
|
3279
|
+
#
|
3280
|
+
# {
|
3281
|
+
# monitor_arn: "Arn", # required
|
3282
|
+
# }
|
3283
|
+
#
|
3284
|
+
# @!attribute [rw] monitor_arn
|
3285
|
+
# The Amazon Resource Name (ARN) of the monitor resource to describe.
|
3286
|
+
# @return [String]
|
3287
|
+
#
|
3288
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/DescribeMonitorRequest AWS API Documentation
|
3289
|
+
#
|
3290
|
+
class DescribeMonitorRequest < Struct.new(
|
3291
|
+
:monitor_arn)
|
3292
|
+
SENSITIVE = []
|
3293
|
+
include Aws::Structure
|
3294
|
+
end
|
3295
|
+
|
3296
|
+
# @!attribute [rw] monitor_name
|
3297
|
+
# The name of the monitor.
|
3298
|
+
# @return [String]
|
3299
|
+
#
|
3300
|
+
# @!attribute [rw] monitor_arn
|
3301
|
+
# The Amazon Resource Name (ARN) of the monitor resource described.
|
3302
|
+
# @return [String]
|
3303
|
+
#
|
3304
|
+
# @!attribute [rw] resource_arn
|
3305
|
+
# The Amazon Resource Name (ARN) of the auto predictor being
|
3306
|
+
# monitored.
|
3307
|
+
# @return [String]
|
3308
|
+
#
|
3309
|
+
# @!attribute [rw] status
|
3310
|
+
# The status of the monitor resource.
|
3311
|
+
# @return [String]
|
3312
|
+
#
|
3313
|
+
# @!attribute [rw] last_evaluation_time
|
3314
|
+
# The timestamp of the latest evaluation completed by the monitor.
|
3315
|
+
# @return [Time]
|
3316
|
+
#
|
3317
|
+
# @!attribute [rw] last_evaluation_state
|
3318
|
+
# The state of the monitor's latest evaluation.
|
3319
|
+
# @return [String]
|
3320
|
+
#
|
3321
|
+
# @!attribute [rw] baseline
|
3322
|
+
# Metrics you can use as a baseline for comparison purposes. Use these
|
3323
|
+
# values you interpret monitoring results for an auto predictor.
|
3324
|
+
# @return [Types::Baseline]
|
3325
|
+
#
|
3326
|
+
# @!attribute [rw] message
|
3327
|
+
# An error message, if any, for the monitor.
|
3328
|
+
# @return [String]
|
3329
|
+
#
|
3330
|
+
# @!attribute [rw] creation_time
|
3331
|
+
# The timestamp for when the monitor resource was created.
|
3332
|
+
# @return [Time]
|
3333
|
+
#
|
3334
|
+
# @!attribute [rw] last_modification_time
|
3335
|
+
# The timestamp of the latest modification to the monitor.
|
3336
|
+
# @return [Time]
|
3337
|
+
#
|
3338
|
+
# @!attribute [rw] estimated_evaluation_time_remaining_in_minutes
|
3339
|
+
# The estimated number of minutes remaining before the monitor
|
3340
|
+
# resource finishes its current evaluation.
|
3341
|
+
# @return [Integer]
|
3342
|
+
#
|
3343
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/DescribeMonitorResponse AWS API Documentation
|
3344
|
+
#
|
3345
|
+
class DescribeMonitorResponse < Struct.new(
|
3346
|
+
:monitor_name,
|
3347
|
+
:monitor_arn,
|
3348
|
+
:resource_arn,
|
3349
|
+
:status,
|
3350
|
+
:last_evaluation_time,
|
3351
|
+
:last_evaluation_state,
|
3352
|
+
:baseline,
|
3353
|
+
:message,
|
3354
|
+
:creation_time,
|
3355
|
+
:last_modification_time,
|
3356
|
+
:estimated_evaluation_time_remaining_in_minutes)
|
3357
|
+
SENSITIVE = []
|
3358
|
+
include Aws::Structure
|
3359
|
+
end
|
3360
|
+
|
3067
3361
|
# @note When making an API call, you may pass DescribePredictorBacktestExportJobRequest
|
3068
3362
|
# data as a hash:
|
3069
3363
|
#
|
@@ -4858,6 +5152,178 @@ module Aws::ForecastService
|
|
4858
5152
|
include Aws::Structure
|
4859
5153
|
end
|
4860
5154
|
|
5155
|
+
# @note When making an API call, you may pass ListMonitorEvaluationsRequest
|
5156
|
+
# data as a hash:
|
5157
|
+
#
|
5158
|
+
# {
|
5159
|
+
# next_token: "NextToken",
|
5160
|
+
# max_results: 1,
|
5161
|
+
# monitor_arn: "Arn", # required
|
5162
|
+
# filters: [
|
5163
|
+
# {
|
5164
|
+
# key: "String", # required
|
5165
|
+
# value: "Arn", # required
|
5166
|
+
# condition: "IS", # required, accepts IS, IS_NOT
|
5167
|
+
# },
|
5168
|
+
# ],
|
5169
|
+
# }
|
5170
|
+
#
|
5171
|
+
# @!attribute [rw] next_token
|
5172
|
+
# If the result of the previous request was truncated, the response
|
5173
|
+
# includes a `NextToken`. To retrieve the next set of results, use the
|
5174
|
+
# token in the next request. Tokens expire after 24 hours.
|
5175
|
+
# @return [String]
|
5176
|
+
#
|
5177
|
+
# @!attribute [rw] max_results
|
5178
|
+
# The maximum number of monitoring results to return.
|
5179
|
+
# @return [Integer]
|
5180
|
+
#
|
5181
|
+
# @!attribute [rw] monitor_arn
|
5182
|
+
# The Amazon Resource Name (ARN) of the monitor resource to get
|
5183
|
+
# results from.
|
5184
|
+
# @return [String]
|
5185
|
+
#
|
5186
|
+
# @!attribute [rw] filters
|
5187
|
+
# An array of filters. For each filter, provide a condition and a
|
5188
|
+
# match statement. The condition is either `IS` or `IS_NOT`, which
|
5189
|
+
# specifies whether to include or exclude the resources that match the
|
5190
|
+
# statement from the list. The match statement consists of a key and a
|
5191
|
+
# value.
|
5192
|
+
#
|
5193
|
+
# **Filter properties**
|
5194
|
+
#
|
5195
|
+
# * `Condition` - The condition to apply. Valid values are `IS` and
|
5196
|
+
# `IS_NOT`.
|
5197
|
+
#
|
5198
|
+
# * `Key` - The name of the parameter to filter on. The only valid
|
5199
|
+
# value is `EvaluationState`.
|
5200
|
+
#
|
5201
|
+
# * `Value` - The value to match. Valid values are only `SUCCESS` or
|
5202
|
+
# `FAILURE`.
|
5203
|
+
#
|
5204
|
+
# For example, to list only successful monitor evaluations, you would
|
5205
|
+
# specify:
|
5206
|
+
#
|
5207
|
+
# `"Filters": [ \{ "Condition": "IS", "Key": "EvaluationState",
|
5208
|
+
# "Value": "SUCCESS" \} ]`
|
5209
|
+
# @return [Array<Types::Filter>]
|
5210
|
+
#
|
5211
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/ListMonitorEvaluationsRequest AWS API Documentation
|
5212
|
+
#
|
5213
|
+
class ListMonitorEvaluationsRequest < Struct.new(
|
5214
|
+
:next_token,
|
5215
|
+
:max_results,
|
5216
|
+
:monitor_arn,
|
5217
|
+
:filters)
|
5218
|
+
SENSITIVE = []
|
5219
|
+
include Aws::Structure
|
5220
|
+
end
|
5221
|
+
|
5222
|
+
# @!attribute [rw] next_token
|
5223
|
+
# If the response is truncated, Amazon Forecast returns this token. To
|
5224
|
+
# retrieve the next set of results, use the token in the next request.
|
5225
|
+
# Tokens expire after 24 hours.
|
5226
|
+
# @return [String]
|
5227
|
+
#
|
5228
|
+
# @!attribute [rw] predictor_monitor_evaluations
|
5229
|
+
# The monitoring results and predictor events collected by the monitor
|
5230
|
+
# resource during different windows of time.
|
5231
|
+
#
|
5232
|
+
# For information about monitoring see [Viewing Monitoring
|
5233
|
+
# Results][1]. For more information about retrieving monitoring
|
5234
|
+
# results see [Viewing Monitoring Results][1].
|
5235
|
+
#
|
5236
|
+
#
|
5237
|
+
#
|
5238
|
+
# [1]: https://docs.aws.amazon.com/forecast/latest/dg/predictor-monitoring-results.html
|
5239
|
+
# @return [Array<Types::PredictorMonitorEvaluation>]
|
5240
|
+
#
|
5241
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/ListMonitorEvaluationsResponse AWS API Documentation
|
5242
|
+
#
|
5243
|
+
class ListMonitorEvaluationsResponse < Struct.new(
|
5244
|
+
:next_token,
|
5245
|
+
:predictor_monitor_evaluations)
|
5246
|
+
SENSITIVE = []
|
5247
|
+
include Aws::Structure
|
5248
|
+
end
|
5249
|
+
|
5250
|
+
# @note When making an API call, you may pass ListMonitorsRequest
|
5251
|
+
# data as a hash:
|
5252
|
+
#
|
5253
|
+
# {
|
5254
|
+
# next_token: "NextToken",
|
5255
|
+
# max_results: 1,
|
5256
|
+
# filters: [
|
5257
|
+
# {
|
5258
|
+
# key: "String", # required
|
5259
|
+
# value: "Arn", # required
|
5260
|
+
# condition: "IS", # required, accepts IS, IS_NOT
|
5261
|
+
# },
|
5262
|
+
# ],
|
5263
|
+
# }
|
5264
|
+
#
|
5265
|
+
# @!attribute [rw] next_token
|
5266
|
+
# If the result of the previous request was truncated, the response
|
5267
|
+
# includes a `NextToken`. To retrieve the next set of results, use the
|
5268
|
+
# token in the next request. Tokens expire after 24 hours.
|
5269
|
+
# @return [String]
|
5270
|
+
#
|
5271
|
+
# @!attribute [rw] max_results
|
5272
|
+
# The maximum number of monitors to include in the response.
|
5273
|
+
# @return [Integer]
|
5274
|
+
#
|
5275
|
+
# @!attribute [rw] filters
|
5276
|
+
# An array of filters. For each filter, provide a condition and a
|
5277
|
+
# match statement. The condition is either `IS` or `IS_NOT`, which
|
5278
|
+
# specifies whether to include or exclude the resources that match the
|
5279
|
+
# statement from the list. The match statement consists of a key and a
|
5280
|
+
# value.
|
5281
|
+
#
|
5282
|
+
# **Filter properties**
|
5283
|
+
#
|
5284
|
+
# * `Condition` - The condition to apply. Valid values are `IS` and
|
5285
|
+
# `IS_NOT`.
|
5286
|
+
#
|
5287
|
+
# * `Key` - The name of the parameter to filter on. The only valid
|
5288
|
+
# value is `Status`.
|
5289
|
+
#
|
5290
|
+
# * `Value` - The value to match.
|
5291
|
+
#
|
5292
|
+
# For example, to list all monitors who's status is ACTIVE, you would
|
5293
|
+
# specify:
|
5294
|
+
#
|
5295
|
+
# `"Filters": [ \{ "Condition": "IS", "Key": "Status", "Value":
|
5296
|
+
# "ACTIVE" \} ]`
|
5297
|
+
# @return [Array<Types::Filter>]
|
5298
|
+
#
|
5299
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/ListMonitorsRequest AWS API Documentation
|
5300
|
+
#
|
5301
|
+
class ListMonitorsRequest < Struct.new(
|
5302
|
+
:next_token,
|
5303
|
+
:max_results,
|
5304
|
+
:filters)
|
5305
|
+
SENSITIVE = []
|
5306
|
+
include Aws::Structure
|
5307
|
+
end
|
5308
|
+
|
5309
|
+
# @!attribute [rw] monitors
|
5310
|
+
# An array of objects that summarize each monitor's properties.
|
5311
|
+
# @return [Array<Types::MonitorSummary>]
|
5312
|
+
#
|
5313
|
+
# @!attribute [rw] next_token
|
5314
|
+
# If the response is truncated, Amazon Forecast returns this token. To
|
5315
|
+
# retrieve the next set of results, use the token in the next request.
|
5316
|
+
# @return [String]
|
5317
|
+
#
|
5318
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/ListMonitorsResponse AWS API Documentation
|
5319
|
+
#
|
5320
|
+
class ListMonitorsResponse < Struct.new(
|
5321
|
+
:monitors,
|
5322
|
+
:next_token)
|
5323
|
+
SENSITIVE = []
|
5324
|
+
include Aws::Structure
|
5325
|
+
end
|
5326
|
+
|
4861
5327
|
# @note When making an API call, you may pass ListPredictorBacktestExportJobsRequest
|
4862
5328
|
# data as a hash:
|
4863
5329
|
#
|
@@ -5042,6 +5508,35 @@ module Aws::ForecastService
|
|
5042
5508
|
include Aws::Structure
|
5043
5509
|
end
|
5044
5510
|
|
5511
|
+
# An individual metric Forecast calculated when monitoring predictor
|
5512
|
+
# usage. You can compare the value for this metric to the metric's
|
5513
|
+
# value in the Baseline to see how your predictor's performance is
|
5514
|
+
# changing.
|
5515
|
+
#
|
5516
|
+
# For more information about metrics generated by Forecast see
|
5517
|
+
# [Evaluating Predictor Accuracy][1]
|
5518
|
+
#
|
5519
|
+
#
|
5520
|
+
#
|
5521
|
+
# [1]: https://docs.aws.amazon.com/forecast/latest/dg/metrics.html
|
5522
|
+
#
|
5523
|
+
# @!attribute [rw] metric_name
|
5524
|
+
# The name of the metric.
|
5525
|
+
# @return [String]
|
5526
|
+
#
|
5527
|
+
# @!attribute [rw] metric_value
|
5528
|
+
# The value for the metric.
|
5529
|
+
# @return [Float]
|
5530
|
+
#
|
5531
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/MetricResult AWS API Documentation
|
5532
|
+
#
|
5533
|
+
class MetricResult < Struct.new(
|
5534
|
+
:metric_name,
|
5535
|
+
:metric_value)
|
5536
|
+
SENSITIVE = []
|
5537
|
+
include Aws::Structure
|
5538
|
+
end
|
5539
|
+
|
5045
5540
|
# Provides metrics that are used to evaluate the performance of a
|
5046
5541
|
# predictor. This object is part of the WindowSummary object.
|
5047
5542
|
#
|
@@ -5077,6 +5572,144 @@ module Aws::ForecastService
|
|
5077
5572
|
include Aws::Structure
|
5078
5573
|
end
|
5079
5574
|
|
5575
|
+
# The configuration details for the predictor monitor.
|
5576
|
+
#
|
5577
|
+
# @note When making an API call, you may pass MonitorConfig
|
5578
|
+
# data as a hash:
|
5579
|
+
#
|
5580
|
+
# {
|
5581
|
+
# monitor_name: "Name", # required
|
5582
|
+
# }
|
5583
|
+
#
|
5584
|
+
# @!attribute [rw] monitor_name
|
5585
|
+
# The name of the monitor resource.
|
5586
|
+
# @return [String]
|
5587
|
+
#
|
5588
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/MonitorConfig AWS API Documentation
|
5589
|
+
#
|
5590
|
+
class MonitorConfig < Struct.new(
|
5591
|
+
:monitor_name)
|
5592
|
+
SENSITIVE = []
|
5593
|
+
include Aws::Structure
|
5594
|
+
end
|
5595
|
+
|
5596
|
+
# The source of the data the monitor used during the evaluation.
|
5597
|
+
#
|
5598
|
+
# @!attribute [rw] dataset_import_job_arn
|
5599
|
+
# The Amazon Resource Name (ARN) of the dataset import job used to
|
5600
|
+
# import the data that initiated the monitor evaluation.
|
5601
|
+
# @return [String]
|
5602
|
+
#
|
5603
|
+
# @!attribute [rw] forecast_arn
|
5604
|
+
# The Amazon Resource Name (ARN) of the forecast the monitor used
|
5605
|
+
# during the evaluation.
|
5606
|
+
# @return [String]
|
5607
|
+
#
|
5608
|
+
# @!attribute [rw] predictor_arn
|
5609
|
+
# The Amazon Resource Name (ARN) of the predictor resource you are
|
5610
|
+
# monitoring.
|
5611
|
+
# @return [String]
|
5612
|
+
#
|
5613
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/MonitorDataSource AWS API Documentation
|
5614
|
+
#
|
5615
|
+
class MonitorDataSource < Struct.new(
|
5616
|
+
:dataset_import_job_arn,
|
5617
|
+
:forecast_arn,
|
5618
|
+
:predictor_arn)
|
5619
|
+
SENSITIVE = []
|
5620
|
+
include Aws::Structure
|
5621
|
+
end
|
5622
|
+
|
5623
|
+
# Provides information about the monitor resource.
|
5624
|
+
#
|
5625
|
+
# @!attribute [rw] monitor_arn
|
5626
|
+
# The Amazon Resource Name (ARN) of the monitor resource.
|
5627
|
+
# @return [String]
|
5628
|
+
#
|
5629
|
+
# @!attribute [rw] status
|
5630
|
+
# The status of the monitor. States include:
|
5631
|
+
#
|
5632
|
+
# * `ACTIVE`
|
5633
|
+
#
|
5634
|
+
# * `ACTIVE_STOPPING`, `ACTIVE_STOPPED`
|
5635
|
+
#
|
5636
|
+
# * `UPDATE_IN_PROGRESS`
|
5637
|
+
#
|
5638
|
+
# * `CREATE_PENDING`, `CREATE_IN_PROGRESS`, `CREATE_FAILED`
|
5639
|
+
#
|
5640
|
+
# * `DELETE_PENDING`, `DELETE_IN_PROGRESS`, `DELETE_FAILED`
|
5641
|
+
# @return [String]
|
5642
|
+
#
|
5643
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/MonitorInfo AWS API Documentation
|
5644
|
+
#
|
5645
|
+
class MonitorInfo < Struct.new(
|
5646
|
+
:monitor_arn,
|
5647
|
+
:status)
|
5648
|
+
SENSITIVE = []
|
5649
|
+
include Aws::Structure
|
5650
|
+
end
|
5651
|
+
|
5652
|
+
# Provides a summary of the monitor properties used in the ListMonitors
|
5653
|
+
# operation. To get a complete set of properties, call the
|
5654
|
+
# DescribeMonitor operation, and provide the listed `MonitorArn`.
|
5655
|
+
#
|
5656
|
+
# @!attribute [rw] monitor_arn
|
5657
|
+
# The Amazon Resource Name (ARN) of the monitor resource.
|
5658
|
+
# @return [String]
|
5659
|
+
#
|
5660
|
+
# @!attribute [rw] monitor_name
|
5661
|
+
# The name of the monitor resource.
|
5662
|
+
# @return [String]
|
5663
|
+
#
|
5664
|
+
# @!attribute [rw] resource_arn
|
5665
|
+
# The Amazon Resource Name (ARN) of the predictor being monitored.
|
5666
|
+
# @return [String]
|
5667
|
+
#
|
5668
|
+
# @!attribute [rw] status
|
5669
|
+
# The status of the monitor. States include:
|
5670
|
+
#
|
5671
|
+
# * `ACTIVE`
|
5672
|
+
#
|
5673
|
+
# * `ACTIVE_STOPPING`, `ACTIVE_STOPPED`
|
5674
|
+
#
|
5675
|
+
# * `UPDATE_IN_PROGRESS`
|
5676
|
+
#
|
5677
|
+
# * `CREATE_PENDING`, `CREATE_IN_PROGRESS`, `CREATE_FAILED`
|
5678
|
+
#
|
5679
|
+
# * `DELETE_PENDING`, `DELETE_IN_PROGRESS`, `DELETE_FAILED`
|
5680
|
+
# @return [String]
|
5681
|
+
#
|
5682
|
+
# @!attribute [rw] creation_time
|
5683
|
+
# When the monitor resource was created.
|
5684
|
+
# @return [Time]
|
5685
|
+
#
|
5686
|
+
# @!attribute [rw] last_modification_time
|
5687
|
+
# The last time the monitor resource was modified. The timestamp
|
5688
|
+
# depends on the status of the job:
|
5689
|
+
#
|
5690
|
+
# * `CREATE_PENDING` - The `CreationTime`.
|
5691
|
+
#
|
5692
|
+
# * `CREATE_IN_PROGRESS` - The current timestamp.
|
5693
|
+
#
|
5694
|
+
# * `STOPPED` - When the resource stopped.
|
5695
|
+
#
|
5696
|
+
# * `ACTIVE` or `CREATE_FAILED` - When the monitor creation finished
|
5697
|
+
# or failed.
|
5698
|
+
# @return [Time]
|
5699
|
+
#
|
5700
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/MonitorSummary AWS API Documentation
|
5701
|
+
#
|
5702
|
+
class MonitorSummary < Struct.new(
|
5703
|
+
:monitor_arn,
|
5704
|
+
:monitor_name,
|
5705
|
+
:resource_arn,
|
5706
|
+
:status,
|
5707
|
+
:creation_time,
|
5708
|
+
:last_modification_time)
|
5709
|
+
SENSITIVE = []
|
5710
|
+
include Aws::Structure
|
5711
|
+
end
|
5712
|
+
|
5080
5713
|
# Specifies the categorical, continuous, and integer hyperparameters,
|
5081
5714
|
# and their ranges of tunable values. The range of tunable values
|
5082
5715
|
# determines which values that a hyperparameter tuning job can choose
|
@@ -5204,6 +5837,49 @@ module Aws::ForecastService
|
|
5204
5837
|
include Aws::Structure
|
5205
5838
|
end
|
5206
5839
|
|
5840
|
+
# Metrics you can use as a baseline for comparison purposes. Use these
|
5841
|
+
# metrics when you interpret monitoring results for an auto predictor.
|
5842
|
+
#
|
5843
|
+
# @!attribute [rw] baseline_metrics
|
5844
|
+
# The initial [accuracy metrics][1] for the predictor. Use these
|
5845
|
+
# metrics as a baseline for comparison purposes as you use your
|
5846
|
+
# predictor and the metrics change.
|
5847
|
+
#
|
5848
|
+
#
|
5849
|
+
#
|
5850
|
+
# [1]: https://docs.aws.amazon.com/forecast/latest/dg/metrics.html
|
5851
|
+
# @return [Array<Types::BaselineMetric>]
|
5852
|
+
#
|
5853
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/PredictorBaseline AWS API Documentation
|
5854
|
+
#
|
5855
|
+
class PredictorBaseline < Struct.new(
|
5856
|
+
:baseline_metrics)
|
5857
|
+
SENSITIVE = []
|
5858
|
+
include Aws::Structure
|
5859
|
+
end
|
5860
|
+
|
5861
|
+
# Provides details about a predictor event, such as a retraining.
|
5862
|
+
#
|
5863
|
+
# @!attribute [rw] detail
|
5864
|
+
# The type of event. For example, `Retrain`. A retraining event
|
5865
|
+
# denotes the timepoint when a predictor was retrained. Any monitor
|
5866
|
+
# results from before the `Datetime` are from the previous predictor.
|
5867
|
+
# Any new metrics are for the newly retrained predictor.
|
5868
|
+
# @return [String]
|
5869
|
+
#
|
5870
|
+
# @!attribute [rw] datetime
|
5871
|
+
# The timestamp for when the event occurred.
|
5872
|
+
# @return [Time]
|
5873
|
+
#
|
5874
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/PredictorEvent AWS API Documentation
|
5875
|
+
#
|
5876
|
+
class PredictorEvent < Struct.new(
|
5877
|
+
:detail,
|
5878
|
+
:datetime)
|
5879
|
+
SENSITIVE = []
|
5880
|
+
include Aws::Structure
|
5881
|
+
end
|
5882
|
+
|
5207
5883
|
# The algorithm used to perform a backtest and the status of those
|
5208
5884
|
# tests.
|
5209
5885
|
#
|
@@ -5246,6 +5922,77 @@ module Aws::ForecastService
|
|
5246
5922
|
include Aws::Structure
|
5247
5923
|
end
|
5248
5924
|
|
5925
|
+
# Describes the results of a monitor evaluation.
|
5926
|
+
#
|
5927
|
+
# @!attribute [rw] resource_arn
|
5928
|
+
# @return [String]
|
5929
|
+
#
|
5930
|
+
# @!attribute [rw] monitor_arn
|
5931
|
+
# @return [String]
|
5932
|
+
#
|
5933
|
+
# @!attribute [rw] evaluation_time
|
5934
|
+
# The timestamp that indicates when the monitor evaluation was
|
5935
|
+
# started.
|
5936
|
+
# @return [Time]
|
5937
|
+
#
|
5938
|
+
# @!attribute [rw] evaluation_state
|
5939
|
+
# The status of the monitor evaluation. The state can be `SUCCESS` or
|
5940
|
+
# `FAILURE`.
|
5941
|
+
# @return [String]
|
5942
|
+
#
|
5943
|
+
# @!attribute [rw] window_start_datetime
|
5944
|
+
# The timestamp that indicates the start of the window that is used
|
5945
|
+
# for monitor evaluation.
|
5946
|
+
# @return [Time]
|
5947
|
+
#
|
5948
|
+
# @!attribute [rw] window_end_datetime
|
5949
|
+
# The timestamp that indicates the end of the window that is used for
|
5950
|
+
# monitor evaluation.
|
5951
|
+
# @return [Time]
|
5952
|
+
#
|
5953
|
+
# @!attribute [rw] predictor_event
|
5954
|
+
# Provides details about a predictor event, such as a retraining.
|
5955
|
+
# @return [Types::PredictorEvent]
|
5956
|
+
#
|
5957
|
+
# @!attribute [rw] monitor_data_source
|
5958
|
+
# The source of the data the monitor resource used during the
|
5959
|
+
# evaluation.
|
5960
|
+
# @return [Types::MonitorDataSource]
|
5961
|
+
#
|
5962
|
+
# @!attribute [rw] metric_results
|
5963
|
+
# A list of metrics Forecast calculated when monitoring a predictor.
|
5964
|
+
# You can compare the value for each metric in the list to the
|
5965
|
+
# metric's value in the Baseline to see how your predictor's
|
5966
|
+
# performance is changing.
|
5967
|
+
# @return [Array<Types::MetricResult>]
|
5968
|
+
#
|
5969
|
+
# @!attribute [rw] num_items_evaluated
|
5970
|
+
# The number of items considered during the evaluation.
|
5971
|
+
# @return [Integer]
|
5972
|
+
#
|
5973
|
+
# @!attribute [rw] message
|
5974
|
+
# Information about any errors that may have occurred during the
|
5975
|
+
# monitor evaluation.
|
5976
|
+
# @return [String]
|
5977
|
+
#
|
5978
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/PredictorMonitorEvaluation AWS API Documentation
|
5979
|
+
#
|
5980
|
+
class PredictorMonitorEvaluation < Struct.new(
|
5981
|
+
:resource_arn,
|
5982
|
+
:monitor_arn,
|
5983
|
+
:evaluation_time,
|
5984
|
+
:evaluation_state,
|
5985
|
+
:window_start_datetime,
|
5986
|
+
:window_end_datetime,
|
5987
|
+
:predictor_event,
|
5988
|
+
:monitor_data_source,
|
5989
|
+
:metric_results,
|
5990
|
+
:num_items_evaluated,
|
5991
|
+
:message)
|
5992
|
+
SENSITIVE = []
|
5993
|
+
include Aws::Structure
|
5994
|
+
end
|
5995
|
+
|
5249
5996
|
# Provides a summary of the predictor properties that are used in the
|
5250
5997
|
# ListPredictors operation. To get the complete set of properties, call
|
5251
5998
|
# the DescribePredictor operation, and provide the listed
|
@@ -5390,6 +6137,25 @@ module Aws::ForecastService
|
|
5390
6137
|
include Aws::Structure
|
5391
6138
|
end
|
5392
6139
|
|
6140
|
+
# @note When making an API call, you may pass ResumeResourceRequest
|
6141
|
+
# data as a hash:
|
6142
|
+
#
|
6143
|
+
# {
|
6144
|
+
# resource_arn: "Arn", # required
|
6145
|
+
# }
|
6146
|
+
#
|
6147
|
+
# @!attribute [rw] resource_arn
|
6148
|
+
# The Amazon Resource Name (ARN) of the monitor resource to resume.
|
6149
|
+
# @return [String]
|
6150
|
+
#
|
6151
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/ResumeResourceRequest AWS API Documentation
|
6152
|
+
#
|
6153
|
+
class ResumeResourceRequest < Struct.new(
|
6154
|
+
:resource_arn)
|
6155
|
+
SENSITIVE = []
|
6156
|
+
include Aws::Structure
|
6157
|
+
end
|
6158
|
+
|
5393
6159
|
# The path to the file(s) in an Amazon Simple Storage Service (Amazon
|
5394
6160
|
# S3) bucket, and an AWS Identity and Access Management (IAM) role that
|
5395
6161
|
# Amazon Forecast can assume to access the file(s). Optionally, includes
|
@@ -5465,8 +6231,12 @@ module Aws::ForecastService
|
|
5465
6231
|
end
|
5466
6232
|
|
5467
6233
|
# An attribute of a schema, which defines a dataset field. A schema
|
5468
|
-
# attribute is required for every field in a dataset. The Schema
|
5469
|
-
# contains an array of `SchemaAttribute` objects.
|
6234
|
+
# attribute is required for every field in a dataset. The [Schema][1]
|
6235
|
+
# object contains an array of `SchemaAttribute` objects.
|
6236
|
+
#
|
6237
|
+
#
|
6238
|
+
#
|
6239
|
+
# [1]: https://docs.aws.amazon.com/forecast/latest/dg/API_Schema.html
|
5470
6240
|
#
|
5471
6241
|
# @note When making an API call, you may pass SchemaAttribute
|
5472
6242
|
# data as a hash:
|
@@ -5482,6 +6252,10 @@ module Aws::ForecastService
|
|
5482
6252
|
#
|
5483
6253
|
# @!attribute [rw] attribute_type
|
5484
6254
|
# The data type of the field.
|
6255
|
+
#
|
6256
|
+
# For a related time series dataset, other than date, item\_id, and
|
6257
|
+
# forecast dimensions attributes, all attributes should be of
|
6258
|
+
# numerical type (integer/float).
|
5485
6259
|
# @return [String]
|
5486
6260
|
#
|
5487
6261
|
# @see http://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/SchemaAttribute AWS API Documentation
|
@@ -5494,7 +6268,11 @@ module Aws::ForecastService
|
|
5494
6268
|
end
|
5495
6269
|
|
5496
6270
|
# Provides statistics for each data field imported into to an Amazon
|
5497
|
-
# Forecast dataset with the CreateDatasetImportJob operation.
|
6271
|
+
# Forecast dataset with the [CreateDatasetImportJob][1] operation.
|
6272
|
+
#
|
6273
|
+
#
|
6274
|
+
#
|
6275
|
+
# [1]: https://docs.aws.amazon.com/forecast/latest/dg/API_CreateDatasetImportJob.html
|
5498
6276
|
#
|
5499
6277
|
# @!attribute [rw] count
|
5500
6278
|
# The number of values in the field. If the response value is -1,
|