aws-sdk-forecastservice 1.33.0 → 1.36.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 +626 -61
- data/lib/aws-sdk-forecastservice/client_api.rb +262 -0
- data/lib/aws-sdk-forecastservice/types.rb +1101 -58
- data/lib/aws-sdk-forecastservice.rb +1 -1
- metadata +2 -2
@@ -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
|
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,31 @@ 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
|
+
#
|
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
|
+
#
|
490
527
|
# @return [Types::CreateAutoPredictorResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
491
528
|
#
|
492
529
|
# * {Types::CreateAutoPredictorResponse#predictor_arn #predictor_arn} => String
|
@@ -531,6 +568,15 @@ module Aws::ForecastService
|
|
531
568
|
# value: "TagValue", # required
|
532
569
|
# },
|
533
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
|
+
# },
|
534
580
|
# })
|
535
581
|
#
|
536
582
|
# @example Response structure
|
@@ -565,22 +611,26 @@ module Aws::ForecastService
|
|
565
611
|
#
|
566
612
|
# After creating a dataset, you import your training data into it and
|
567
613
|
# 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.
|
614
|
+
# create a predictor. For more information, see [Importing datasets][1].
|
570
615
|
#
|
571
|
-
# To get a list of all your datasets, use the ListDatasets
|
616
|
+
# To get a list of all your datasets, use the [ListDatasets][2]
|
617
|
+
# operation.
|
572
618
|
#
|
573
619
|
# For example Forecast datasets, see the [Amazon Forecast Sample GitHub
|
574
|
-
# repository][
|
620
|
+
# repository][3].
|
575
621
|
#
|
576
622
|
# <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
|
623
|
+
# training data. Use the [DescribeDataset][4] operation to get the
|
624
|
+
# status.
|
578
625
|
#
|
579
626
|
# </note>
|
580
627
|
#
|
581
628
|
#
|
582
629
|
#
|
583
|
-
# [1]: https://
|
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
|
584
634
|
#
|
585
635
|
# @option params [required, String] :dataset_name
|
586
636
|
# A name for the dataset.
|
@@ -588,14 +638,19 @@ module Aws::ForecastService
|
|
588
638
|
# @option params [required, String] :domain
|
589
639
|
# The domain associated with the dataset. When you add a dataset to a
|
590
640
|
# dataset group, this value and the value specified for the `Domain`
|
591
|
-
# parameter of the CreateDatasetGroup operation must match.
|
641
|
+
# parameter of the [CreateDatasetGroup][1] operation must match.
|
592
642
|
#
|
593
643
|
# The `Domain` and `DatasetType` that you choose determine the fields
|
594
644
|
# that must be present in the training data that you import to the
|
595
645
|
# dataset. For example, if you choose the `RETAIL` domain and
|
596
646
|
# `TARGET_TIME_SERIES` as the `DatasetType`, Amazon Forecast requires
|
597
647
|
# `item_id`, `timestamp`, and `demand` fields to be present in your
|
598
|
-
# data. For more information, see
|
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
|
599
654
|
#
|
600
655
|
# @option params [required, String] :dataset_type
|
601
656
|
# The dataset type. Valid values depend on the chosen `Domain`.
|
@@ -614,7 +669,11 @@ module Aws::ForecastService
|
|
614
669
|
# match the fields in your data. The dataset `Domain` and `DatasetType`
|
615
670
|
# that you choose determine the minimum required fields in your training
|
616
671
|
# data. For information about the required fields for a specific dataset
|
617
|
-
# domain and type, see
|
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
|
618
677
|
#
|
619
678
|
# @option params [Types::EncryptionConfig] :encryption_config
|
620
679
|
# An AWS Key Management Service (KMS) key and the AWS Identity and
|
@@ -699,35 +758,47 @@ module Aws::ForecastService
|
|
699
758
|
|
700
759
|
# Creates a dataset group, which holds a collection of related datasets.
|
701
760
|
# You can add datasets to the dataset group when you create the dataset
|
702
|
-
# group, or later by using the UpdateDatasetGroup operation.
|
761
|
+
# group, or later by using the [UpdateDatasetGroup][1] operation.
|
703
762
|
#
|
704
763
|
# After creating a dataset group and adding datasets, you use the
|
705
764
|
# dataset group when you create a predictor. For more information, see
|
706
|
-
#
|
765
|
+
# [Dataset groups][2].
|
707
766
|
#
|
708
|
-
# To get a list of all your datasets groups, use the
|
709
|
-
# operation.
|
767
|
+
# To get a list of all your datasets groups, use the
|
768
|
+
# [ListDatasetGroups][3] operation.
|
710
769
|
#
|
711
770
|
# <note markdown="1"> The `Status` of a dataset group must be `ACTIVE` before you can use
|
712
771
|
# the dataset group to create a predictor. To get the status, use the
|
713
|
-
# DescribeDatasetGroup operation.
|
772
|
+
# [DescribeDatasetGroup][4] operation.
|
714
773
|
#
|
715
774
|
# </note>
|
716
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
|
+
#
|
717
783
|
# @option params [required, String] :dataset_group_name
|
718
784
|
# A name for the dataset group.
|
719
785
|
#
|
720
786
|
# @option params [required, String] :domain
|
721
787
|
# The domain associated with the dataset group. When you add a dataset
|
722
788
|
# to a dataset group, this value and the value specified for the
|
723
|
-
# `Domain` parameter of the CreateDataset operation must match.
|
789
|
+
# `Domain` parameter of the [CreateDataset][1] operation must match.
|
724
790
|
#
|
725
791
|
# The `Domain` and `DatasetType` that you choose determine the fields
|
726
792
|
# that must be present in training data that you import to a dataset.
|
727
793
|
# For example, if you choose the `RETAIL` domain and
|
728
794
|
# `TARGET_TIME_SERIES` as the `DatasetType`, Amazon Forecast requires
|
729
795
|
# that `item_id`, `timestamp`, and `demand` fields are present in your
|
730
|
-
# data. For more information, see
|
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
|
731
802
|
#
|
732
803
|
# @option params [Array<String>] :dataset_arns
|
733
804
|
# An array of Amazon Resource Names (ARNs) of the datasets that you want
|
@@ -801,17 +872,17 @@ module Aws::ForecastService
|
|
801
872
|
# (Amazon S3) bucket and the Amazon Resource Name (ARN) of the dataset
|
802
873
|
# that you want to import the data to.
|
803
874
|
#
|
804
|
-
# You must specify a DataSource object that includes an AWS
|
805
|
-
# Access Management (IAM) role that Amazon Forecast can
|
806
|
-
# the data, as Amazon Forecast makes a copy of your
|
807
|
-
# it in an internal AWS system. For more information,
|
808
|
-
#
|
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].
|
809
880
|
#
|
810
|
-
# The training data must be in CSV format. The delimiter must
|
811
|
-
# (,).
|
881
|
+
# The training data must be in CSV or Parquet format. The delimiter must
|
882
|
+
# be a comma (,).
|
812
883
|
#
|
813
|
-
# You can specify the path to a specific
|
814
|
-
#
|
884
|
+
# You can specify the path to a specific file, the S3 bucket, or to a
|
885
|
+
# folder in the S3 bucket. For the latter two cases, Amazon Forecast
|
815
886
|
# imports all files up to the limit of 10,000 files.
|
816
887
|
#
|
817
888
|
# Because dataset imports are not aggregated, your most recent dataset
|
@@ -821,7 +892,13 @@ module Aws::ForecastService
|
|
821
892
|
# collected since the previous import.
|
822
893
|
#
|
823
894
|
# To get a list of all your dataset import jobs, filtered by specified
|
824
|
-
# 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
|
825
902
|
#
|
826
903
|
# @option params [required, String] :dataset_import_job_name
|
827
904
|
# The name for the dataset import job. We recommend including the
|
@@ -842,7 +919,11 @@ module Aws::ForecastService
|
|
842
919
|
# Service (KMS) key and the IAM role must allow Amazon Forecast
|
843
920
|
# permission to access the key. The KMS key and IAM role must match
|
844
921
|
# those specified in the `EncryptionConfig` parameter of the
|
845
|
-
# CreateDataset operation.
|
922
|
+
# [CreateDataset][1] operation.
|
923
|
+
#
|
924
|
+
#
|
925
|
+
#
|
926
|
+
# [1]: https://docs.aws.amazon.com/forecast/latest/dg/API_CreateDataset.html
|
846
927
|
#
|
847
928
|
# @option params [String] :timestamp_format
|
848
929
|
# The format of timestamps in the dataset. The format that you specify
|
@@ -921,6 +1002,10 @@ module Aws::ForecastService
|
|
921
1002
|
# the limit of 50 tags. Tags with only the key prefix of `aws` do not
|
922
1003
|
# count against your tags per resource limit.
|
923
1004
|
#
|
1005
|
+
# @option params [String] :format
|
1006
|
+
# The format of the imported data, CSV or PARQUET. The default value is
|
1007
|
+
# CSV.
|
1008
|
+
#
|
924
1009
|
# @return [Types::CreateDatasetImportJobResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
925
1010
|
#
|
926
1011
|
# * {Types::CreateDatasetImportJobResponse#dataset_import_job_arn #dataset_import_job_arn} => String
|
@@ -947,6 +1032,7 @@ module Aws::ForecastService
|
|
947
1032
|
# value: "TagValue", # required
|
948
1033
|
# },
|
949
1034
|
# ],
|
1035
|
+
# format: "Format",
|
950
1036
|
# })
|
951
1037
|
#
|
952
1038
|
# @example Response structure
|
@@ -1065,7 +1151,7 @@ module Aws::ForecastService
|
|
1065
1151
|
# Defines the fields of a dataset.
|
1066
1152
|
#
|
1067
1153
|
# @option params [Boolean] :enable_visualization
|
1068
|
-
# Create an
|
1154
|
+
# Create an Explainability visualization that is viewable within the AWS
|
1069
1155
|
# console.
|
1070
1156
|
#
|
1071
1157
|
# @option params [String] :start_date_time
|
@@ -1216,6 +1302,9 @@ module Aws::ForecastService
|
|
1216
1302
|
# only the key prefix of `aws` do not count against your tags per
|
1217
1303
|
# resource limit. You cannot edit or delete tag keys with this prefix.
|
1218
1304
|
#
|
1305
|
+
# @option params [String] :format
|
1306
|
+
# The format of the exported data, CSV or PARQUET.
|
1307
|
+
#
|
1219
1308
|
# @return [Types::CreateExplainabilityExportResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1220
1309
|
#
|
1221
1310
|
# * {Types::CreateExplainabilityExportResponse#explainability_export_arn #explainability_export_arn} => String
|
@@ -1238,6 +1327,7 @@ module Aws::ForecastService
|
|
1238
1327
|
# value: "TagValue", # required
|
1239
1328
|
# },
|
1240
1329
|
# ],
|
1330
|
+
# format: "Format",
|
1241
1331
|
# })
|
1242
1332
|
#
|
1243
1333
|
# @example Response structure
|
@@ -1280,6 +1370,14 @@ module Aws::ForecastService
|
|
1280
1370
|
#
|
1281
1371
|
# </note>
|
1282
1372
|
#
|
1373
|
+
# By default, a forecast includes predictions for every item (`item_id`)
|
1374
|
+
# in the dataset group that was used to train the predictor. However,
|
1375
|
+
# you can use the `TimeSeriesSelector` object to generate a forecast on
|
1376
|
+
# a subset of time series. Forecast creation is skipped for any time
|
1377
|
+
# series that you specify that are not in the input dataset. The
|
1378
|
+
# forecast export file will not contain these time series or their
|
1379
|
+
# forecasted values.
|
1380
|
+
#
|
1283
1381
|
# @option params [required, String] :forecast_name
|
1284
1382
|
# A name for the forecast.
|
1285
1383
|
#
|
@@ -1293,7 +1391,11 @@ module Aws::ForecastService
|
|
1293
1391
|
# values include `0.01 to 0.99` (increments of .01 only) and `mean`. The
|
1294
1392
|
# mean forecast is different from the median (0.50) when the
|
1295
1393
|
# distribution is not symmetric (for example, Beta and Negative
|
1296
|
-
# Binomial).
|
1394
|
+
# Binomial).
|
1395
|
+
#
|
1396
|
+
# The default quantiles are the quantiles you specified during predictor
|
1397
|
+
# creation. If you didn't specify quantiles, the default values are
|
1398
|
+
# `["0.1", "0.5", "0.9"]`.
|
1297
1399
|
#
|
1298
1400
|
# @option params [Array<Types::Tag>] :tags
|
1299
1401
|
# The optional metadata that you apply to the forecast to help you
|
@@ -1327,6 +1429,18 @@ module Aws::ForecastService
|
|
1327
1429
|
# the limit of 50 tags. Tags with only the key prefix of `aws` do not
|
1328
1430
|
# count against your tags per resource limit.
|
1329
1431
|
#
|
1432
|
+
# @option params [Types::TimeSeriesSelector] :time_series_selector
|
1433
|
+
# Defines the set of time series that are used to create the forecasts
|
1434
|
+
# in a `TimeSeriesIdentifiers` object.
|
1435
|
+
#
|
1436
|
+
# The `TimeSeriesIdentifiers` object needs the following information:
|
1437
|
+
#
|
1438
|
+
# * `DataSource`
|
1439
|
+
#
|
1440
|
+
# * `Format`
|
1441
|
+
#
|
1442
|
+
# * `Schema`
|
1443
|
+
#
|
1330
1444
|
# @return [Types::CreateForecastResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1331
1445
|
#
|
1332
1446
|
# * {Types::CreateForecastResponse#forecast_arn #forecast_arn} => String
|
@@ -1343,6 +1457,26 @@ module Aws::ForecastService
|
|
1343
1457
|
# value: "TagValue", # required
|
1344
1458
|
# },
|
1345
1459
|
# ],
|
1460
|
+
# time_series_selector: {
|
1461
|
+
# time_series_identifiers: {
|
1462
|
+
# data_source: {
|
1463
|
+
# s3_config: { # required
|
1464
|
+
# path: "S3Path", # required
|
1465
|
+
# role_arn: "Arn", # required
|
1466
|
+
# kms_key_arn: "KMSKeyArn",
|
1467
|
+
# },
|
1468
|
+
# },
|
1469
|
+
# schema: {
|
1470
|
+
# attributes: [
|
1471
|
+
# {
|
1472
|
+
# attribute_name: "Name",
|
1473
|
+
# attribute_type: "string", # accepts string, integer, float, timestamp, geolocation
|
1474
|
+
# },
|
1475
|
+
# ],
|
1476
|
+
# },
|
1477
|
+
# format: "Format",
|
1478
|
+
# },
|
1479
|
+
# },
|
1346
1480
|
# })
|
1347
1481
|
#
|
1348
1482
|
# @example Response structure
|
@@ -1432,6 +1566,10 @@ module Aws::ForecastService
|
|
1432
1566
|
# the limit of 50 tags. Tags with only the key prefix of `aws` do not
|
1433
1567
|
# count against your tags per resource limit.
|
1434
1568
|
#
|
1569
|
+
# @option params [String] :format
|
1570
|
+
# The format of the exported data, CSV or PARQUET. The default value is
|
1571
|
+
# CSV.
|
1572
|
+
#
|
1435
1573
|
# @return [Types::CreateForecastExportJobResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1436
1574
|
#
|
1437
1575
|
# * {Types::CreateForecastExportJobResponse#forecast_export_job_arn #forecast_export_job_arn} => String
|
@@ -1454,6 +1592,7 @@ module Aws::ForecastService
|
|
1454
1592
|
# value: "TagValue", # required
|
1455
1593
|
# },
|
1456
1594
|
# ],
|
1595
|
+
# format: "Format",
|
1457
1596
|
# })
|
1458
1597
|
#
|
1459
1598
|
# @example Response structure
|
@@ -1469,6 +1608,58 @@ module Aws::ForecastService
|
|
1469
1608
|
req.send_request(options)
|
1470
1609
|
end
|
1471
1610
|
|
1611
|
+
# Creates a predictor monitor resource for an existing auto predictor.
|
1612
|
+
# Predictor monitoring allows you to see how your predictor's
|
1613
|
+
# performance changes over time. For more information, see [Predictor
|
1614
|
+
# Monitoring][1].
|
1615
|
+
#
|
1616
|
+
#
|
1617
|
+
#
|
1618
|
+
# [1]: https://docs.aws.amazon.com/forecast/latest/dg/predictor-monitoring.html
|
1619
|
+
#
|
1620
|
+
# @option params [required, String] :monitor_name
|
1621
|
+
# The name of the monitor resource.
|
1622
|
+
#
|
1623
|
+
# @option params [required, String] :resource_arn
|
1624
|
+
# The Amazon Resource Name (ARN) of the predictor to monitor.
|
1625
|
+
#
|
1626
|
+
# @option params [Array<Types::Tag>] :tags
|
1627
|
+
# A list of [tags][1] to apply to the monitor resource.
|
1628
|
+
#
|
1629
|
+
#
|
1630
|
+
#
|
1631
|
+
# [1]: https://docs.aws.amazon.com/forecast/latest/dg/tagging-forecast-resources.html
|
1632
|
+
#
|
1633
|
+
# @return [Types::CreateMonitorResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1634
|
+
#
|
1635
|
+
# * {Types::CreateMonitorResponse#monitor_arn #monitor_arn} => String
|
1636
|
+
#
|
1637
|
+
# @example Request syntax with placeholder values
|
1638
|
+
#
|
1639
|
+
# resp = client.create_monitor({
|
1640
|
+
# monitor_name: "Name", # required
|
1641
|
+
# resource_arn: "Arn", # required
|
1642
|
+
# tags: [
|
1643
|
+
# {
|
1644
|
+
# key: "TagKey", # required
|
1645
|
+
# value: "TagValue", # required
|
1646
|
+
# },
|
1647
|
+
# ],
|
1648
|
+
# })
|
1649
|
+
#
|
1650
|
+
# @example Response structure
|
1651
|
+
#
|
1652
|
+
# resp.monitor_arn #=> String
|
1653
|
+
#
|
1654
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/CreateMonitor AWS API Documentation
|
1655
|
+
#
|
1656
|
+
# @overload create_monitor(params = {})
|
1657
|
+
# @param [Hash] params ({})
|
1658
|
+
def create_monitor(params = {}, options = {})
|
1659
|
+
req = build_request(:create_monitor, params)
|
1660
|
+
req.send_request(options)
|
1661
|
+
end
|
1662
|
+
|
1472
1663
|
# <note markdown="1"> This operation creates a legacy predictor that does not include all
|
1473
1664
|
# the predictor functionalities provided by Amazon Forecast. To create a
|
1474
1665
|
# predictor that is compatible with all aspects of Forecast, use
|
@@ -1788,7 +1979,8 @@ module Aws::ForecastService
|
|
1788
1979
|
|
1789
1980
|
# Exports backtest forecasts and accuracy metrics generated by the
|
1790
1981
|
# CreateAutoPredictor or CreatePredictor operations. Two folders
|
1791
|
-
# containing CSV files are exported to your specified S3
|
1982
|
+
# containing CSV or Parquet files are exported to your specified S3
|
1983
|
+
# bucket.
|
1792
1984
|
#
|
1793
1985
|
# The export file names will match the following conventions:
|
1794
1986
|
#
|
@@ -1848,6 +2040,10 @@ module Aws::ForecastService
|
|
1848
2040
|
# only the key prefix of `aws` do not count against your tags per
|
1849
2041
|
# resource limit. You cannot edit or delete tag keys with this prefix.
|
1850
2042
|
#
|
2043
|
+
# @option params [String] :format
|
2044
|
+
# The format of the exported data, CSV or PARQUET. The default value is
|
2045
|
+
# CSV.
|
2046
|
+
#
|
1851
2047
|
# @return [Types::CreatePredictorBacktestExportJobResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1852
2048
|
#
|
1853
2049
|
# * {Types::CreatePredictorBacktestExportJobResponse#predictor_backtest_export_job_arn #predictor_backtest_export_job_arn} => String
|
@@ -1870,6 +2066,7 @@ module Aws::ForecastService
|
|
1870
2066
|
# value: "TagValue", # required
|
1871
2067
|
# },
|
1872
2068
|
# ],
|
2069
|
+
# format: "Format",
|
1873
2070
|
# })
|
1874
2071
|
#
|
1875
2072
|
# @example Response structure
|
@@ -1886,16 +2083,23 @@ module Aws::ForecastService
|
|
1886
2083
|
end
|
1887
2084
|
|
1888
2085
|
# Deletes an Amazon Forecast dataset that was created using the
|
1889
|
-
# CreateDataset operation. You can only delete datasets that have a
|
2086
|
+
# [CreateDataset][1] operation. You can only delete datasets that have a
|
1890
2087
|
# status of `ACTIVE` or `CREATE_FAILED`. To get the status use the
|
1891
|
-
# DescribeDataset operation.
|
2088
|
+
# [DescribeDataset][2] operation.
|
1892
2089
|
#
|
1893
2090
|
# <note markdown="1"> Forecast does not automatically update any dataset groups that contain
|
1894
2091
|
# the deleted dataset. In order to update the dataset group, use the
|
1895
|
-
# operation, omitting the deleted dataset's
|
2092
|
+
# [UpdateDatasetGroup][3] operation, omitting the deleted dataset's
|
2093
|
+
# ARN.
|
1896
2094
|
#
|
1897
2095
|
# </note>
|
1898
2096
|
#
|
2097
|
+
#
|
2098
|
+
#
|
2099
|
+
# [1]: https://docs.aws.amazon.com/forecast/latest/dg/API_CreateDataset.html
|
2100
|
+
# [2]: https://docs.aws.amazon.com/forecast/latest/dg/API_DescribeDataset.html
|
2101
|
+
# [3]: https://docs.aws.amazon.com/forecast/latest/dg/API_UpdateDatasetGroup.html
|
2102
|
+
#
|
1899
2103
|
# @option params [required, String] :dataset_arn
|
1900
2104
|
# The Amazon Resource Name (ARN) of the dataset to delete.
|
1901
2105
|
#
|
@@ -1916,14 +2120,19 @@ module Aws::ForecastService
|
|
1916
2120
|
req.send_request(options)
|
1917
2121
|
end
|
1918
2122
|
|
1919
|
-
# Deletes a dataset group created using the CreateDatasetGroup
|
2123
|
+
# Deletes a dataset group created using the [CreateDatasetGroup][1]
|
1920
2124
|
# operation. You can only delete dataset groups that have a status of
|
1921
2125
|
# `ACTIVE`, `CREATE_FAILED`, or `UPDATE_FAILED`. To get the status, use
|
1922
|
-
# the DescribeDatasetGroup operation.
|
2126
|
+
# the [DescribeDatasetGroup][2] operation.
|
1923
2127
|
#
|
1924
2128
|
# This operation deletes only the dataset group, not the datasets in the
|
1925
2129
|
# group.
|
1926
2130
|
#
|
2131
|
+
#
|
2132
|
+
#
|
2133
|
+
# [1]: https://docs.aws.amazon.com/forecast/latest/dg/API_CreateDatasetGroup.html
|
2134
|
+
# [2]: https://docs.aws.amazon.com/forecast/latest/dg/API_DescribeDatasetGroup.html
|
2135
|
+
#
|
1927
2136
|
# @option params [required, String] :dataset_group_arn
|
1928
2137
|
# The Amazon Resource Name (ARN) of the dataset group to delete.
|
1929
2138
|
#
|
@@ -1944,10 +2153,15 @@ module Aws::ForecastService
|
|
1944
2153
|
req.send_request(options)
|
1945
2154
|
end
|
1946
2155
|
|
1947
|
-
# Deletes a dataset import job created using the
|
1948
|
-
# operation. You can delete only dataset
|
1949
|
-
# of `ACTIVE` or `CREATE_FAILED`. To get
|
1950
|
-
# DescribeDatasetImportJob operation.
|
2156
|
+
# Deletes a dataset import job created using the
|
2157
|
+
# [CreateDatasetImportJob][1] operation. You can delete only dataset
|
2158
|
+
# import jobs that have a status of `ACTIVE` or `CREATE_FAILED`. To get
|
2159
|
+
# the status, use the [DescribeDatasetImportJob][2] operation.
|
2160
|
+
#
|
2161
|
+
#
|
2162
|
+
#
|
2163
|
+
# [1]: https://docs.aws.amazon.com/forecast/latest/dg/API_CreateDatasetImportJob.html
|
2164
|
+
# [2]: https://docs.aws.amazon.com/forecast/latest/dg/API_DescribeDatasetImportJob.html
|
1951
2165
|
#
|
1952
2166
|
# @option params [required, String] :dataset_import_job_arn
|
1953
2167
|
# The Amazon Resource Name (ARN) of the dataset import job to delete.
|
@@ -2071,6 +2285,30 @@ module Aws::ForecastService
|
|
2071
2285
|
req.send_request(options)
|
2072
2286
|
end
|
2073
2287
|
|
2288
|
+
# Deletes a monitor resource. You can only delete a monitor resource
|
2289
|
+
# with a status of `ACTIVE`, `ACTIVE_STOPPED`, `CREATE_FAILED`, or
|
2290
|
+
# `CREATE_STOPPED`.
|
2291
|
+
#
|
2292
|
+
# @option params [required, String] :monitor_arn
|
2293
|
+
# The Amazon Resource Name (ARN) of the monitor resource to delete.
|
2294
|
+
#
|
2295
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
2296
|
+
#
|
2297
|
+
# @example Request syntax with placeholder values
|
2298
|
+
#
|
2299
|
+
# resp = client.delete_monitor({
|
2300
|
+
# monitor_arn: "Arn", # required
|
2301
|
+
# })
|
2302
|
+
#
|
2303
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/DeleteMonitor AWS API Documentation
|
2304
|
+
#
|
2305
|
+
# @overload delete_monitor(params = {})
|
2306
|
+
# @param [Hash] params ({})
|
2307
|
+
def delete_monitor(params = {}, options = {})
|
2308
|
+
req = build_request(:delete_monitor, params)
|
2309
|
+
req.send_request(options)
|
2310
|
+
end
|
2311
|
+
|
2074
2312
|
# Deletes a predictor created using the DescribePredictor or
|
2075
2313
|
# CreatePredictor operations. You can delete only predictor that have a
|
2076
2314
|
# status of `ACTIVE` or `CREATE_FAILED`. To get the status, use the
|
@@ -2190,6 +2428,8 @@ module Aws::ForecastService
|
|
2190
2428
|
# * {Types::DescribeAutoPredictorResponse#last_modification_time #last_modification_time} => Time
|
2191
2429
|
# * {Types::DescribeAutoPredictorResponse#optimization_metric #optimization_metric} => String
|
2192
2430
|
# * {Types::DescribeAutoPredictorResponse#explainability_info #explainability_info} => Types::ExplainabilityInfo
|
2431
|
+
# * {Types::DescribeAutoPredictorResponse#monitor_info #monitor_info} => Types::MonitorInfo
|
2432
|
+
# * {Types::DescribeAutoPredictorResponse#time_alignment_boundary #time_alignment_boundary} => Types::TimeAlignmentBoundary
|
2193
2433
|
#
|
2194
2434
|
# @example Request syntax with placeholder values
|
2195
2435
|
#
|
@@ -2231,6 +2471,12 @@ module Aws::ForecastService
|
|
2231
2471
|
# resp.optimization_metric #=> String, one of "WAPE", "RMSE", "AverageWeightedQuantileLoss", "MASE", "MAPE"
|
2232
2472
|
# resp.explainability_info.explainability_arn #=> String
|
2233
2473
|
# resp.explainability_info.status #=> String
|
2474
|
+
# resp.monitor_info.monitor_arn #=> String
|
2475
|
+
# resp.monitor_info.status #=> String
|
2476
|
+
# resp.time_alignment_boundary.month #=> String, one of "JANUARY", "FEBRUARY", "MARCH", "APRIL", "MAY", "JUNE", "JULY", "AUGUST", "SEPTEMBER", "OCTOBER", "NOVEMBER", "DECEMBER"
|
2477
|
+
# resp.time_alignment_boundary.day_of_month #=> Integer
|
2478
|
+
# resp.time_alignment_boundary.day_of_week #=> String, one of "MONDAY", "TUESDAY", "WEDNESDAY", "THURSDAY", "FRIDAY", "SATURDAY", "SUNDAY"
|
2479
|
+
# resp.time_alignment_boundary.hour #=> Integer
|
2234
2480
|
#
|
2235
2481
|
# @see http://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/DescribeAutoPredictor AWS API Documentation
|
2236
2482
|
#
|
@@ -2241,8 +2487,8 @@ module Aws::ForecastService
|
|
2241
2487
|
req.send_request(options)
|
2242
2488
|
end
|
2243
2489
|
|
2244
|
-
# Describes an Amazon Forecast dataset created using the
|
2245
|
-
# operation.
|
2490
|
+
# Describes an Amazon Forecast dataset created using the
|
2491
|
+
# [CreateDataset][1] operation.
|
2246
2492
|
#
|
2247
2493
|
# In addition to listing the parameters specified in the `CreateDataset`
|
2248
2494
|
# request, this operation includes the following dataset properties:
|
@@ -2253,6 +2499,10 @@ module Aws::ForecastService
|
|
2253
2499
|
#
|
2254
2500
|
# * `Status`
|
2255
2501
|
#
|
2502
|
+
#
|
2503
|
+
#
|
2504
|
+
# [1]: https://docs.aws.amazon.com/forecast/latest/dg/API_CreateDataset.html
|
2505
|
+
#
|
2256
2506
|
# @option params [required, String] :dataset_arn
|
2257
2507
|
# The Amazon Resource Name (ARN) of the dataset.
|
2258
2508
|
#
|
@@ -2300,7 +2550,7 @@ module Aws::ForecastService
|
|
2300
2550
|
req.send_request(options)
|
2301
2551
|
end
|
2302
2552
|
|
2303
|
-
# Describes a dataset group created using the CreateDatasetGroup
|
2553
|
+
# Describes a dataset group created using the [CreateDatasetGroup][1]
|
2304
2554
|
# operation.
|
2305
2555
|
#
|
2306
2556
|
# In addition to listing the parameters provided in the
|
@@ -2315,6 +2565,10 @@ module Aws::ForecastService
|
|
2315
2565
|
#
|
2316
2566
|
# * `Status`
|
2317
2567
|
#
|
2568
|
+
#
|
2569
|
+
#
|
2570
|
+
# [1]: https://docs.aws.amazon.com/forecast/latest/dg/API_CreateDatasetGroup.html
|
2571
|
+
#
|
2318
2572
|
# @option params [required, String] :dataset_group_arn
|
2319
2573
|
# The Amazon Resource Name (ARN) of the dataset group.
|
2320
2574
|
#
|
@@ -2355,7 +2609,7 @@ module Aws::ForecastService
|
|
2355
2609
|
end
|
2356
2610
|
|
2357
2611
|
# Describes a dataset import job created using the
|
2358
|
-
# CreateDatasetImportJob operation.
|
2612
|
+
# [CreateDatasetImportJob][1] operation.
|
2359
2613
|
#
|
2360
2614
|
# In addition to listing the parameters provided in the
|
2361
2615
|
# `CreateDatasetImportJob` request, this operation includes the
|
@@ -2373,6 +2627,10 @@ module Aws::ForecastService
|
|
2373
2627
|
#
|
2374
2628
|
# * `Message` - If an error occurred, information about the error.
|
2375
2629
|
#
|
2630
|
+
#
|
2631
|
+
#
|
2632
|
+
# [1]: https://docs.aws.amazon.com/forecast/latest/dg/API_CreateDatasetImportJob.html
|
2633
|
+
#
|
2376
2634
|
# @option params [required, String] :dataset_import_job_arn
|
2377
2635
|
# The Amazon Resource Name (ARN) of the dataset import job.
|
2378
2636
|
#
|
@@ -2393,6 +2651,7 @@ module Aws::ForecastService
|
|
2393
2651
|
# * {Types::DescribeDatasetImportJobResponse#message #message} => String
|
2394
2652
|
# * {Types::DescribeDatasetImportJobResponse#creation_time #creation_time} => Time
|
2395
2653
|
# * {Types::DescribeDatasetImportJobResponse#last_modification_time #last_modification_time} => Time
|
2654
|
+
# * {Types::DescribeDatasetImportJobResponse#format #format} => String
|
2396
2655
|
#
|
2397
2656
|
# @example Request syntax with placeholder values
|
2398
2657
|
#
|
@@ -2431,6 +2690,7 @@ module Aws::ForecastService
|
|
2431
2690
|
# resp.message #=> String
|
2432
2691
|
# resp.creation_time #=> Time
|
2433
2692
|
# resp.last_modification_time #=> Time
|
2693
|
+
# resp.format #=> String
|
2434
2694
|
#
|
2435
2695
|
# @see http://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/DescribeDatasetImportJob AWS API Documentation
|
2436
2696
|
#
|
@@ -2517,6 +2777,7 @@ module Aws::ForecastService
|
|
2517
2777
|
# * {Types::DescribeExplainabilityExportResponse#status #status} => String
|
2518
2778
|
# * {Types::DescribeExplainabilityExportResponse#creation_time #creation_time} => Time
|
2519
2779
|
# * {Types::DescribeExplainabilityExportResponse#last_modification_time #last_modification_time} => Time
|
2780
|
+
# * {Types::DescribeExplainabilityExportResponse#format #format} => String
|
2520
2781
|
#
|
2521
2782
|
# @example Request syntax with placeholder values
|
2522
2783
|
#
|
@@ -2536,6 +2797,7 @@ module Aws::ForecastService
|
|
2536
2797
|
# resp.status #=> String
|
2537
2798
|
# resp.creation_time #=> Time
|
2538
2799
|
# resp.last_modification_time #=> Time
|
2800
|
+
# resp.format #=> String
|
2539
2801
|
#
|
2540
2802
|
# @see http://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/DescribeExplainabilityExport AWS API Documentation
|
2541
2803
|
#
|
@@ -2577,6 +2839,7 @@ module Aws::ForecastService
|
|
2577
2839
|
# * {Types::DescribeForecastResponse#message #message} => String
|
2578
2840
|
# * {Types::DescribeForecastResponse#creation_time #creation_time} => Time
|
2579
2841
|
# * {Types::DescribeForecastResponse#last_modification_time #last_modification_time} => Time
|
2842
|
+
# * {Types::DescribeForecastResponse#time_series_selector #time_series_selector} => Types::TimeSeriesSelector
|
2580
2843
|
#
|
2581
2844
|
# @example Request syntax with placeholder values
|
2582
2845
|
#
|
@@ -2597,6 +2860,13 @@ module Aws::ForecastService
|
|
2597
2860
|
# resp.message #=> String
|
2598
2861
|
# resp.creation_time #=> Time
|
2599
2862
|
# resp.last_modification_time #=> Time
|
2863
|
+
# resp.time_series_selector.time_series_identifiers.data_source.s3_config.path #=> String
|
2864
|
+
# resp.time_series_selector.time_series_identifiers.data_source.s3_config.role_arn #=> String
|
2865
|
+
# resp.time_series_selector.time_series_identifiers.data_source.s3_config.kms_key_arn #=> String
|
2866
|
+
# resp.time_series_selector.time_series_identifiers.schema.attributes #=> Array
|
2867
|
+
# resp.time_series_selector.time_series_identifiers.schema.attributes[0].attribute_name #=> String
|
2868
|
+
# resp.time_series_selector.time_series_identifiers.schema.attributes[0].attribute_type #=> String, one of "string", "integer", "float", "timestamp", "geolocation"
|
2869
|
+
# resp.time_series_selector.time_series_identifiers.format #=> String
|
2600
2870
|
#
|
2601
2871
|
# @see http://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/DescribeForecast AWS API Documentation
|
2602
2872
|
#
|
@@ -2635,6 +2905,7 @@ module Aws::ForecastService
|
|
2635
2905
|
# * {Types::DescribeForecastExportJobResponse#status #status} => String
|
2636
2906
|
# * {Types::DescribeForecastExportJobResponse#creation_time #creation_time} => Time
|
2637
2907
|
# * {Types::DescribeForecastExportJobResponse#last_modification_time #last_modification_time} => Time
|
2908
|
+
# * {Types::DescribeForecastExportJobResponse#format #format} => String
|
2638
2909
|
#
|
2639
2910
|
# @example Request syntax with placeholder values
|
2640
2911
|
#
|
@@ -2654,6 +2925,7 @@ module Aws::ForecastService
|
|
2654
2925
|
# resp.status #=> String
|
2655
2926
|
# resp.creation_time #=> Time
|
2656
2927
|
# resp.last_modification_time #=> Time
|
2928
|
+
# resp.format #=> String
|
2657
2929
|
#
|
2658
2930
|
# @see http://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/DescribeForecastExportJob AWS API Documentation
|
2659
2931
|
#
|
@@ -2664,6 +2936,72 @@ module Aws::ForecastService
|
|
2664
2936
|
req.send_request(options)
|
2665
2937
|
end
|
2666
2938
|
|
2939
|
+
# Describes a monitor resource. In addition to listing the properties
|
2940
|
+
# provided in the CreateMonitor request, this operation lists the
|
2941
|
+
# following properties:
|
2942
|
+
#
|
2943
|
+
# * `Baseline`
|
2944
|
+
#
|
2945
|
+
# * `CreationTime`
|
2946
|
+
#
|
2947
|
+
# * `LastEvaluationTime`
|
2948
|
+
#
|
2949
|
+
# * `LastEvaluationState`
|
2950
|
+
#
|
2951
|
+
# * `LastModificationTime`
|
2952
|
+
#
|
2953
|
+
# * `Message`
|
2954
|
+
#
|
2955
|
+
# * `Status`
|
2956
|
+
#
|
2957
|
+
# @option params [required, String] :monitor_arn
|
2958
|
+
# The Amazon Resource Name (ARN) of the monitor resource to describe.
|
2959
|
+
#
|
2960
|
+
# @return [Types::DescribeMonitorResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2961
|
+
#
|
2962
|
+
# * {Types::DescribeMonitorResponse#monitor_name #monitor_name} => String
|
2963
|
+
# * {Types::DescribeMonitorResponse#monitor_arn #monitor_arn} => String
|
2964
|
+
# * {Types::DescribeMonitorResponse#resource_arn #resource_arn} => String
|
2965
|
+
# * {Types::DescribeMonitorResponse#status #status} => String
|
2966
|
+
# * {Types::DescribeMonitorResponse#last_evaluation_time #last_evaluation_time} => Time
|
2967
|
+
# * {Types::DescribeMonitorResponse#last_evaluation_state #last_evaluation_state} => String
|
2968
|
+
# * {Types::DescribeMonitorResponse#baseline #baseline} => Types::Baseline
|
2969
|
+
# * {Types::DescribeMonitorResponse#message #message} => String
|
2970
|
+
# * {Types::DescribeMonitorResponse#creation_time #creation_time} => Time
|
2971
|
+
# * {Types::DescribeMonitorResponse#last_modification_time #last_modification_time} => Time
|
2972
|
+
# * {Types::DescribeMonitorResponse#estimated_evaluation_time_remaining_in_minutes #estimated_evaluation_time_remaining_in_minutes} => Integer
|
2973
|
+
#
|
2974
|
+
# @example Request syntax with placeholder values
|
2975
|
+
#
|
2976
|
+
# resp = client.describe_monitor({
|
2977
|
+
# monitor_arn: "Arn", # required
|
2978
|
+
# })
|
2979
|
+
#
|
2980
|
+
# @example Response structure
|
2981
|
+
#
|
2982
|
+
# resp.monitor_name #=> String
|
2983
|
+
# resp.monitor_arn #=> String
|
2984
|
+
# resp.resource_arn #=> String
|
2985
|
+
# resp.status #=> String
|
2986
|
+
# resp.last_evaluation_time #=> Time
|
2987
|
+
# resp.last_evaluation_state #=> String
|
2988
|
+
# resp.baseline.predictor_baseline.baseline_metrics #=> Array
|
2989
|
+
# resp.baseline.predictor_baseline.baseline_metrics[0].name #=> String
|
2990
|
+
# resp.baseline.predictor_baseline.baseline_metrics[0].value #=> Float
|
2991
|
+
# resp.message #=> String
|
2992
|
+
# resp.creation_time #=> Time
|
2993
|
+
# resp.last_modification_time #=> Time
|
2994
|
+
# resp.estimated_evaluation_time_remaining_in_minutes #=> Integer
|
2995
|
+
#
|
2996
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/DescribeMonitor AWS API Documentation
|
2997
|
+
#
|
2998
|
+
# @overload describe_monitor(params = {})
|
2999
|
+
# @param [Hash] params ({})
|
3000
|
+
def describe_monitor(params = {}, options = {})
|
3001
|
+
req = build_request(:describe_monitor, params)
|
3002
|
+
req.send_request(options)
|
3003
|
+
end
|
3004
|
+
|
2667
3005
|
# <note markdown="1"> This operation is only valid for legacy predictors created with
|
2668
3006
|
# CreatePredictor. If you are not using a legacy predictor, use
|
2669
3007
|
# DescribeAutoPredictor.
|
@@ -2827,6 +3165,7 @@ module Aws::ForecastService
|
|
2827
3165
|
# * {Types::DescribePredictorBacktestExportJobResponse#status #status} => String
|
2828
3166
|
# * {Types::DescribePredictorBacktestExportJobResponse#creation_time #creation_time} => Time
|
2829
3167
|
# * {Types::DescribePredictorBacktestExportJobResponse#last_modification_time #last_modification_time} => Time
|
3168
|
+
# * {Types::DescribePredictorBacktestExportJobResponse#format #format} => String
|
2830
3169
|
#
|
2831
3170
|
# @example Request syntax with placeholder values
|
2832
3171
|
#
|
@@ -2846,6 +3185,7 @@ module Aws::ForecastService
|
|
2846
3185
|
# resp.status #=> String
|
2847
3186
|
# resp.creation_time #=> Time
|
2848
3187
|
# resp.last_modification_time #=> Time
|
3188
|
+
# resp.format #=> String
|
2849
3189
|
#
|
2850
3190
|
# @see http://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/DescribePredictorBacktestExportJob AWS API Documentation
|
2851
3191
|
#
|
@@ -2933,11 +3273,17 @@ module Aws::ForecastService
|
|
2933
3273
|
req.send_request(options)
|
2934
3274
|
end
|
2935
3275
|
|
2936
|
-
# Returns a list of dataset groups created using the
|
2937
|
-
# operation. For each dataset group, this
|
2938
|
-
# its properties, including its Amazon
|
2939
|
-
# retrieve the complete set of properties
|
2940
|
-
# with the DescribeDatasetGroup
|
3276
|
+
# Returns a list of dataset groups created using the
|
3277
|
+
# [CreateDatasetGroup][1] operation. For each dataset group, this
|
3278
|
+
# operation returns a summary of its properties, including its Amazon
|
3279
|
+
# Resource Name (ARN). You can retrieve the complete set of properties
|
3280
|
+
# by using the dataset group ARN with the [DescribeDatasetGroup][2]
|
3281
|
+
# operation.
|
3282
|
+
#
|
3283
|
+
#
|
3284
|
+
#
|
3285
|
+
# [1]: https://docs.aws.amazon.com/forecast/latest/dg/API_CreateDatasetGroup.html
|
3286
|
+
# [2]: https://docs.aws.amazon.com/forecast/latest/dg/API_DescribeDatasetGroup.html
|
2941
3287
|
#
|
2942
3288
|
# @option params [String] :next_token
|
2943
3289
|
# If the result of the previous request was truncated, the response
|
@@ -2980,11 +3326,17 @@ module Aws::ForecastService
|
|
2980
3326
|
end
|
2981
3327
|
|
2982
3328
|
# Returns a list of dataset import jobs created using the
|
2983
|
-
# CreateDatasetImportJob operation. For each import job, this
|
2984
|
-
# returns a summary of its properties, including its Amazon
|
2985
|
-
# Name (ARN). You can retrieve the complete set of properties
|
2986
|
-
# the ARN with the DescribeDatasetImportJob operation. You
|
2987
|
-
# the list by providing an array of Filter objects.
|
3329
|
+
# [CreateDatasetImportJob][1] operation. For each import job, this
|
3330
|
+
# operation returns a summary of its properties, including its Amazon
|
3331
|
+
# Resource Name (ARN). You can retrieve the complete set of properties
|
3332
|
+
# by using the ARN with the [DescribeDatasetImportJob][2] operation. You
|
3333
|
+
# can filter the list by providing an array of [Filter][3] objects.
|
3334
|
+
#
|
3335
|
+
#
|
3336
|
+
#
|
3337
|
+
# [1]: https://docs.aws.amazon.com/forecast/latest/dg/API_CreateDatasetImportJob.html
|
3338
|
+
# [2]: https://docs.aws.amazon.com/forecast/latest/dg/API_DescribeDatasetImportJob.html
|
3339
|
+
# [3]: https://docs.aws.amazon.com/forecast/latest/dg/API_Filter.html
|
2988
3340
|
#
|
2989
3341
|
# @option params [String] :next_token
|
2990
3342
|
# If the result of the previous request was truncated, the response
|
@@ -3062,10 +3414,16 @@ module Aws::ForecastService
|
|
3062
3414
|
req.send_request(options)
|
3063
3415
|
end
|
3064
3416
|
|
3065
|
-
# Returns a list of datasets created using the CreateDataset
|
3066
|
-
# For each dataset, a summary of its properties, including
|
3067
|
-
# Resource Name (ARN), is returned. To retrieve the complete
|
3068
|
-
# properties, use the ARN with the DescribeDataset
|
3417
|
+
# Returns a list of datasets created using the [CreateDataset][1]
|
3418
|
+
# operation. For each dataset, a summary of its properties, including
|
3419
|
+
# its Amazon Resource Name (ARN), is returned. To retrieve the complete
|
3420
|
+
# set of properties, use the ARN with the [DescribeDataset][2]
|
3421
|
+
# operation.
|
3422
|
+
#
|
3423
|
+
#
|
3424
|
+
#
|
3425
|
+
# [1]: https://docs.aws.amazon.com/forecast/latest/dg/API_CreateDataset.html
|
3426
|
+
# [2]: https://docs.aws.amazon.com/forecast/latest/dg/API_DescribeDataset.html
|
3069
3427
|
#
|
3070
3428
|
# @option params [String] :next_token
|
3071
3429
|
# If the result of the previous request was truncated, the response
|
@@ -3147,6 +3505,8 @@ module Aws::ForecastService
|
|
3147
3505
|
# * {Types::ListExplainabilitiesResponse#explainabilities #explainabilities} => Array<Types::ExplainabilitySummary>
|
3148
3506
|
# * {Types::ListExplainabilitiesResponse#next_token #next_token} => String
|
3149
3507
|
#
|
3508
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
3509
|
+
#
|
3150
3510
|
# @example Request syntax with placeholder values
|
3151
3511
|
#
|
3152
3512
|
# resp = client.list_explainabilities({
|
@@ -3222,6 +3582,8 @@ module Aws::ForecastService
|
|
3222
3582
|
# * {Types::ListExplainabilityExportsResponse#explainability_exports #explainability_exports} => Array<Types::ExplainabilityExportSummary>
|
3223
3583
|
# * {Types::ListExplainabilityExportsResponse#next_token #next_token} => String
|
3224
3584
|
#
|
3585
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
3586
|
+
#
|
3225
3587
|
# @example Request syntax with placeholder values
|
3226
3588
|
#
|
3227
3589
|
# resp = client.list_explainability_exports({
|
@@ -3426,6 +3788,183 @@ module Aws::ForecastService
|
|
3426
3788
|
req.send_request(options)
|
3427
3789
|
end
|
3428
3790
|
|
3791
|
+
# Returns a list of the monitoring evaluation results and predictor
|
3792
|
+
# events collected by the monitor resource during different windows of
|
3793
|
+
# time.
|
3794
|
+
#
|
3795
|
+
# For information about monitoring see predictor-monitoring. For more
|
3796
|
+
# information about retrieving monitoring results see [Viewing
|
3797
|
+
# Monitoring Results][1].
|
3798
|
+
#
|
3799
|
+
#
|
3800
|
+
#
|
3801
|
+
# [1]: https://docs.aws.amazon.com/forecast/latest/dg/predictor-monitoring-results.html
|
3802
|
+
#
|
3803
|
+
# @option params [String] :next_token
|
3804
|
+
# If the result of the previous request was truncated, the response
|
3805
|
+
# includes a `NextToken`. To retrieve the next set of results, use the
|
3806
|
+
# token in the next request. Tokens expire after 24 hours.
|
3807
|
+
#
|
3808
|
+
# @option params [Integer] :max_results
|
3809
|
+
# The maximum number of monitoring results to return.
|
3810
|
+
#
|
3811
|
+
# @option params [required, String] :monitor_arn
|
3812
|
+
# The Amazon Resource Name (ARN) of the monitor resource to get results
|
3813
|
+
# from.
|
3814
|
+
#
|
3815
|
+
# @option params [Array<Types::Filter>] :filters
|
3816
|
+
# An array of filters. For each filter, provide a condition and a match
|
3817
|
+
# statement. The condition is either `IS` or `IS_NOT`, which specifies
|
3818
|
+
# whether to include or exclude the resources that match the statement
|
3819
|
+
# from the list. The match statement consists of a key and a value.
|
3820
|
+
#
|
3821
|
+
# **Filter properties**
|
3822
|
+
#
|
3823
|
+
# * `Condition` - The condition to apply. Valid values are `IS` and
|
3824
|
+
# `IS_NOT`.
|
3825
|
+
#
|
3826
|
+
# * `Key` - The name of the parameter to filter on. The only valid value
|
3827
|
+
# is `EvaluationState`.
|
3828
|
+
#
|
3829
|
+
# * `Value` - The value to match. Valid values are only `SUCCESS` or
|
3830
|
+
# `FAILURE`.
|
3831
|
+
#
|
3832
|
+
# For example, to list only successful monitor evaluations, you would
|
3833
|
+
# specify:
|
3834
|
+
#
|
3835
|
+
# `"Filters": [ \{ "Condition": "IS", "Key": "EvaluationState", "Value":
|
3836
|
+
# "SUCCESS" \} ]`
|
3837
|
+
#
|
3838
|
+
# @return [Types::ListMonitorEvaluationsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
3839
|
+
#
|
3840
|
+
# * {Types::ListMonitorEvaluationsResponse#next_token #next_token} => String
|
3841
|
+
# * {Types::ListMonitorEvaluationsResponse#predictor_monitor_evaluations #predictor_monitor_evaluations} => Array<Types::PredictorMonitorEvaluation>
|
3842
|
+
#
|
3843
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
3844
|
+
#
|
3845
|
+
# @example Request syntax with placeholder values
|
3846
|
+
#
|
3847
|
+
# resp = client.list_monitor_evaluations({
|
3848
|
+
# next_token: "NextToken",
|
3849
|
+
# max_results: 1,
|
3850
|
+
# monitor_arn: "Arn", # required
|
3851
|
+
# filters: [
|
3852
|
+
# {
|
3853
|
+
# key: "String", # required
|
3854
|
+
# value: "Arn", # required
|
3855
|
+
# condition: "IS", # required, accepts IS, IS_NOT
|
3856
|
+
# },
|
3857
|
+
# ],
|
3858
|
+
# })
|
3859
|
+
#
|
3860
|
+
# @example Response structure
|
3861
|
+
#
|
3862
|
+
# resp.next_token #=> String
|
3863
|
+
# resp.predictor_monitor_evaluations #=> Array
|
3864
|
+
# resp.predictor_monitor_evaluations[0].resource_arn #=> String
|
3865
|
+
# resp.predictor_monitor_evaluations[0].monitor_arn #=> String
|
3866
|
+
# resp.predictor_monitor_evaluations[0].evaluation_time #=> Time
|
3867
|
+
# resp.predictor_monitor_evaluations[0].evaluation_state #=> String
|
3868
|
+
# resp.predictor_monitor_evaluations[0].window_start_datetime #=> Time
|
3869
|
+
# resp.predictor_monitor_evaluations[0].window_end_datetime #=> Time
|
3870
|
+
# resp.predictor_monitor_evaluations[0].predictor_event.detail #=> String
|
3871
|
+
# resp.predictor_monitor_evaluations[0].predictor_event.datetime #=> Time
|
3872
|
+
# resp.predictor_monitor_evaluations[0].monitor_data_source.dataset_import_job_arn #=> String
|
3873
|
+
# resp.predictor_monitor_evaluations[0].monitor_data_source.forecast_arn #=> String
|
3874
|
+
# resp.predictor_monitor_evaluations[0].monitor_data_source.predictor_arn #=> String
|
3875
|
+
# resp.predictor_monitor_evaluations[0].metric_results #=> Array
|
3876
|
+
# resp.predictor_monitor_evaluations[0].metric_results[0].metric_name #=> String
|
3877
|
+
# resp.predictor_monitor_evaluations[0].metric_results[0].metric_value #=> Float
|
3878
|
+
# resp.predictor_monitor_evaluations[0].num_items_evaluated #=> Integer
|
3879
|
+
# resp.predictor_monitor_evaluations[0].message #=> String
|
3880
|
+
#
|
3881
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/ListMonitorEvaluations AWS API Documentation
|
3882
|
+
#
|
3883
|
+
# @overload list_monitor_evaluations(params = {})
|
3884
|
+
# @param [Hash] params ({})
|
3885
|
+
def list_monitor_evaluations(params = {}, options = {})
|
3886
|
+
req = build_request(:list_monitor_evaluations, params)
|
3887
|
+
req.send_request(options)
|
3888
|
+
end
|
3889
|
+
|
3890
|
+
# Returns a list of monitors created with the CreateMonitor operation
|
3891
|
+
# and CreateAutoPredictor operation. For each monitor resource, this
|
3892
|
+
# operation returns of a summary of its properties, including its Amazon
|
3893
|
+
# Resource Name (ARN). You can retrieve a complete set of properties of
|
3894
|
+
# a monitor resource by specify the monitor's ARN in the
|
3895
|
+
# DescribeMonitor operation.
|
3896
|
+
#
|
3897
|
+
# @option params [String] :next_token
|
3898
|
+
# If the result of the previous request was truncated, the response
|
3899
|
+
# includes a `NextToken`. To retrieve the next set of results, use the
|
3900
|
+
# token in the next request. Tokens expire after 24 hours.
|
3901
|
+
#
|
3902
|
+
# @option params [Integer] :max_results
|
3903
|
+
# The maximum number of monitors to include in the response.
|
3904
|
+
#
|
3905
|
+
# @option params [Array<Types::Filter>] :filters
|
3906
|
+
# An array of filters. For each filter, provide a condition and a match
|
3907
|
+
# statement. The condition is either `IS` or `IS_NOT`, which specifies
|
3908
|
+
# whether to include or exclude the resources that match the statement
|
3909
|
+
# from the list. The match statement consists of a key and a value.
|
3910
|
+
#
|
3911
|
+
# **Filter properties**
|
3912
|
+
#
|
3913
|
+
# * `Condition` - The condition to apply. Valid values are `IS` and
|
3914
|
+
# `IS_NOT`.
|
3915
|
+
#
|
3916
|
+
# * `Key` - The name of the parameter to filter on. The only valid value
|
3917
|
+
# is `Status`.
|
3918
|
+
#
|
3919
|
+
# * `Value` - The value to match.
|
3920
|
+
#
|
3921
|
+
# For example, to list all monitors who's status is ACTIVE, you would
|
3922
|
+
# specify:
|
3923
|
+
#
|
3924
|
+
# `"Filters": [ \{ "Condition": "IS", "Key": "Status", "Value": "ACTIVE"
|
3925
|
+
# \} ]`
|
3926
|
+
#
|
3927
|
+
# @return [Types::ListMonitorsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
3928
|
+
#
|
3929
|
+
# * {Types::ListMonitorsResponse#monitors #monitors} => Array<Types::MonitorSummary>
|
3930
|
+
# * {Types::ListMonitorsResponse#next_token #next_token} => String
|
3931
|
+
#
|
3932
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
3933
|
+
#
|
3934
|
+
# @example Request syntax with placeholder values
|
3935
|
+
#
|
3936
|
+
# resp = client.list_monitors({
|
3937
|
+
# next_token: "NextToken",
|
3938
|
+
# max_results: 1,
|
3939
|
+
# filters: [
|
3940
|
+
# {
|
3941
|
+
# key: "String", # required
|
3942
|
+
# value: "Arn", # required
|
3943
|
+
# condition: "IS", # required, accepts IS, IS_NOT
|
3944
|
+
# },
|
3945
|
+
# ],
|
3946
|
+
# })
|
3947
|
+
#
|
3948
|
+
# @example Response structure
|
3949
|
+
#
|
3950
|
+
# resp.monitors #=> Array
|
3951
|
+
# resp.monitors[0].monitor_arn #=> String
|
3952
|
+
# resp.monitors[0].monitor_name #=> String
|
3953
|
+
# resp.monitors[0].resource_arn #=> String
|
3954
|
+
# resp.monitors[0].status #=> String
|
3955
|
+
# resp.monitors[0].creation_time #=> Time
|
3956
|
+
# resp.monitors[0].last_modification_time #=> Time
|
3957
|
+
# resp.next_token #=> String
|
3958
|
+
#
|
3959
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/ListMonitors AWS API Documentation
|
3960
|
+
#
|
3961
|
+
# @overload list_monitors(params = {})
|
3962
|
+
# @param [Hash] params ({})
|
3963
|
+
def list_monitors(params = {}, options = {})
|
3964
|
+
req = build_request(:list_monitors, params)
|
3965
|
+
req.send_request(options)
|
3966
|
+
end
|
3967
|
+
|
3429
3968
|
# Returns a list of predictor backtest export jobs created using the
|
3430
3969
|
# CreatePredictorBacktestExportJob operation. This operation returns a
|
3431
3970
|
# summary for each backtest export job. You can filter the list using an
|
@@ -3622,6 +4161,28 @@ module Aws::ForecastService
|
|
3622
4161
|
req.send_request(options)
|
3623
4162
|
end
|
3624
4163
|
|
4164
|
+
# Resumes a stopped monitor resource.
|
4165
|
+
#
|
4166
|
+
# @option params [required, String] :resource_arn
|
4167
|
+
# The Amazon Resource Name (ARN) of the monitor resource to resume.
|
4168
|
+
#
|
4169
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
4170
|
+
#
|
4171
|
+
# @example Request syntax with placeholder values
|
4172
|
+
#
|
4173
|
+
# resp = client.resume_resource({
|
4174
|
+
# resource_arn: "Arn", # required
|
4175
|
+
# })
|
4176
|
+
#
|
4177
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/ResumeResource AWS API Documentation
|
4178
|
+
#
|
4179
|
+
# @overload resume_resource(params = {})
|
4180
|
+
# @param [Hash] params ({})
|
4181
|
+
def resume_resource(params = {}, options = {})
|
4182
|
+
req = build_request(:resume_resource, params)
|
4183
|
+
req.send_request(options)
|
4184
|
+
end
|
4185
|
+
|
3625
4186
|
# Stops a resource.
|
3626
4187
|
#
|
3627
4188
|
# The resource undergoes the following states: `CREATE_STOPPING` and
|
@@ -3761,11 +4322,15 @@ module Aws::ForecastService
|
|
3761
4322
|
# Replaces the datasets in a dataset group with the specified datasets.
|
3762
4323
|
#
|
3763
4324
|
# <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
|
3765
|
-
# operation to get the status.
|
4325
|
+
# the dataset group to create a predictor. Use the
|
4326
|
+
# [DescribeDatasetGroup][1] operation to get the status.
|
3766
4327
|
#
|
3767
4328
|
# </note>
|
3768
4329
|
#
|
4330
|
+
#
|
4331
|
+
#
|
4332
|
+
# [1]: https://docs.aws.amazon.com/forecast/latest/dg/API_DescribeDatasetGroup.html
|
4333
|
+
#
|
3769
4334
|
# @option params [required, String] :dataset_group_arn
|
3770
4335
|
# The ARN of the dataset group.
|
3771
4336
|
#
|
@@ -3804,7 +4369,7 @@ module Aws::ForecastService
|
|
3804
4369
|
params: params,
|
3805
4370
|
config: config)
|
3806
4371
|
context[:gem_name] = 'aws-sdk-forecastservice'
|
3807
|
-
context[:gem_version] = '1.
|
4372
|
+
context[:gem_version] = '1.36.0'
|
3808
4373
|
Seahorse::Client::Request.new(handlers, context)
|
3809
4374
|
end
|
3810
4375
|
|