aws-sdk-forecastservice 1.26.0 → 1.30.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/CHANGELOG.md +20 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-forecastservice/client.rb +918 -31
- data/lib/aws-sdk-forecastservice/client_api.rb +328 -1
- data/lib/aws-sdk-forecastservice/types.rb +1812 -276
- data/lib/aws-sdk-forecastservice.rb +2 -2
- metadata +4 -4
@@ -119,7 +119,9 @@ module Aws::ForecastService
|
|
119
119
|
# * EC2/ECS IMDS instance profile - When used by default, the timeouts
|
120
120
|
# are very aggressive. Construct and pass an instance of
|
121
121
|
# `Aws::InstanceProfileCredentails` or `Aws::ECSCredentials` to
|
122
|
-
# enable retries and extended timeouts.
|
122
|
+
# enable retries and extended timeouts. Instance profile credential
|
123
|
+
# fetching can be disabled by setting ENV['AWS_EC2_METADATA_DISABLED']
|
124
|
+
# to true.
|
123
125
|
#
|
124
126
|
# @option options [required, String] :region
|
125
127
|
# The AWS region to connect to. The configured `:region` is
|
@@ -285,6 +287,15 @@ module Aws::ForecastService
|
|
285
287
|
# ** Please note ** When response stubbing is enabled, no HTTP
|
286
288
|
# requests are made, and retries are disabled.
|
287
289
|
#
|
290
|
+
# @option options [Boolean] :use_dualstack_endpoint
|
291
|
+
# When set to `true`, dualstack enabled endpoints (with `.aws` TLD)
|
292
|
+
# will be used if available.
|
293
|
+
#
|
294
|
+
# @option options [Boolean] :use_fips_endpoint
|
295
|
+
# When set to `true`, fips compatible endpoints will be used if available.
|
296
|
+
# When a `fips` region is used, the region is normalized and this config
|
297
|
+
# is set to `true`.
|
298
|
+
#
|
288
299
|
# @option options [Boolean] :validate_params (true)
|
289
300
|
# When `true`, request parameters are validated before
|
290
301
|
# sending the request.
|
@@ -337,6 +348,191 @@ module Aws::ForecastService
|
|
337
348
|
|
338
349
|
# @!group API Operations
|
339
350
|
|
351
|
+
# Creates an Amazon Forecast predictor.
|
352
|
+
#
|
353
|
+
# Amazon Forecast creates predictors with AutoPredictor, which involves
|
354
|
+
# applying the optimal combination of algorithms to each time series in
|
355
|
+
# your datasets. You can use CreateAutoPredictor to create new
|
356
|
+
# predictors or upgrade/retrain existing predictors.
|
357
|
+
#
|
358
|
+
# **Creating new predictors**
|
359
|
+
#
|
360
|
+
# The following parameters are required when creating a new predictor:
|
361
|
+
#
|
362
|
+
# * `PredictorName` - A unique name for the predictor.
|
363
|
+
#
|
364
|
+
# * `DatasetGroupArn` - The ARN of the dataset group used to train the
|
365
|
+
# predictor.
|
366
|
+
#
|
367
|
+
# * `ForecastFrequency` - The granularity of your forecasts (hourly,
|
368
|
+
# daily, weekly, etc).
|
369
|
+
#
|
370
|
+
# * `ForecastHorizon` - The number of time steps being forecasted.
|
371
|
+
#
|
372
|
+
# When creating a new predictor, do not specify a value for
|
373
|
+
# `ReferencePredictorArn`.
|
374
|
+
#
|
375
|
+
# **Upgrading and retraining predictors**
|
376
|
+
#
|
377
|
+
# The following parameters are required when retraining or upgrading a
|
378
|
+
# predictor:
|
379
|
+
#
|
380
|
+
# * `PredictorName` - A unique name for the predictor.
|
381
|
+
#
|
382
|
+
# * `ReferencePredictorArn` - The ARN of the predictor to retrain or
|
383
|
+
# upgrade.
|
384
|
+
#
|
385
|
+
# When upgrading or retraining a predictor, only specify values for the
|
386
|
+
# `ReferencePredictorArn` and `PredictorName`.
|
387
|
+
#
|
388
|
+
# @option params [required, String] :predictor_name
|
389
|
+
# A unique name for the predictor
|
390
|
+
#
|
391
|
+
# @option params [Integer] :forecast_horizon
|
392
|
+
# The number of time-steps that the model predicts. The forecast horizon
|
393
|
+
# is also called the prediction length.
|
394
|
+
#
|
395
|
+
# @option params [Array<String>] :forecast_types
|
396
|
+
# The forecast types used to train a predictor. You can specify up to
|
397
|
+
# five forecast types. Forecast types can be quantiles from 0.01 to
|
398
|
+
# 0.99, by increments of 0.01 or higher. You can also specify the mean
|
399
|
+
# forecast with `mean`.
|
400
|
+
#
|
401
|
+
# @option params [Array<String>] :forecast_dimensions
|
402
|
+
# An array of dimension (field) names that specify how to group the
|
403
|
+
# generated forecast.
|
404
|
+
#
|
405
|
+
# For example, if you are generating forecasts for item sales across all
|
406
|
+
# your stores, and your dataset contains a `store_id` field, you would
|
407
|
+
# specify `store_id` as a dimension to group sales forecasts for each
|
408
|
+
# store.
|
409
|
+
#
|
410
|
+
# @option params [String] :forecast_frequency
|
411
|
+
# The frequency of predictions in a forecast.
|
412
|
+
#
|
413
|
+
# Valid intervals are Y (Year), M (Month), W (Week), D (Day), H (Hour),
|
414
|
+
# 30min (30 minutes), 15min (15 minutes), 10min (10 minutes), 5min (5
|
415
|
+
# minutes), and 1min (1 minute). For example, "Y" indicates every year
|
416
|
+
# and "5min" indicates every five minutes.
|
417
|
+
#
|
418
|
+
# The frequency must be greater than or equal to the
|
419
|
+
# TARGET\_TIME\_SERIES dataset frequency.
|
420
|
+
#
|
421
|
+
# When a RELATED\_TIME\_SERIES dataset is provided, the frequency must
|
422
|
+
# be equal to the RELATED\_TIME\_SERIES dataset frequency.
|
423
|
+
#
|
424
|
+
# @option params [Types::DataConfig] :data_config
|
425
|
+
# The data configuration for your dataset group and any additional
|
426
|
+
# datasets.
|
427
|
+
#
|
428
|
+
# @option params [Types::EncryptionConfig] :encryption_config
|
429
|
+
# An AWS Key Management Service (KMS) key and an AWS Identity and Access
|
430
|
+
# Management (IAM) role that Amazon Forecast can assume to access the
|
431
|
+
# key. You can specify this optional object in the CreateDataset and
|
432
|
+
# CreatePredictor requests.
|
433
|
+
#
|
434
|
+
# @option params [String] :reference_predictor_arn
|
435
|
+
# The ARN of the predictor to retrain or upgrade. This parameter is only
|
436
|
+
# used when retraining or upgrading a predictor. When creating a new
|
437
|
+
# predictor, do not specify a value for this parameter.
|
438
|
+
#
|
439
|
+
# When upgrading or retraining a predictor, only specify values for the
|
440
|
+
# `ReferencePredictorArn` and `PredictorName`. The value for
|
441
|
+
# `PredictorName` must be a unique predictor name.
|
442
|
+
#
|
443
|
+
# @option params [String] :optimization_metric
|
444
|
+
# The accuracy metric used to optimize the predictor.
|
445
|
+
#
|
446
|
+
# @option params [Boolean] :explain_predictor
|
447
|
+
# Create an Explainability resource for the predictor.
|
448
|
+
#
|
449
|
+
# @option params [Array<Types::Tag>] :tags
|
450
|
+
# Optional metadata to help you categorize and organize your predictors.
|
451
|
+
# Each tag consists of a key and an optional value, both of which you
|
452
|
+
# define. Tag keys and values are case sensitive.
|
453
|
+
#
|
454
|
+
# The following restrictions apply to tags:
|
455
|
+
#
|
456
|
+
# * For each resource, each tag key must be unique and each tag key must
|
457
|
+
# have one value.
|
458
|
+
#
|
459
|
+
# * Maximum number of tags per resource: 50.
|
460
|
+
#
|
461
|
+
# * Maximum key length: 128 Unicode characters in UTF-8.
|
462
|
+
#
|
463
|
+
# * Maximum value length: 256 Unicode characters in UTF-8.
|
464
|
+
#
|
465
|
+
# * Accepted characters: all letters and numbers, spaces representable
|
466
|
+
# in UTF-8, and + - = . \_ : / @. If your tagging schema is used
|
467
|
+
# across other services and resources, the character restrictions of
|
468
|
+
# those services also apply.
|
469
|
+
#
|
470
|
+
# * Key prefixes cannot include any upper or lowercase combination of
|
471
|
+
# `aws:` or `AWS:`. Values can have this prefix. If a tag value has
|
472
|
+
# `aws` as its prefix but the key does not, Forecast considers it to
|
473
|
+
# be a user tag and will count against the limit of 50 tags. Tags with
|
474
|
+
# only the key prefix of `aws` do not count against your tags per
|
475
|
+
# resource limit. You cannot edit or delete tag keys with this prefix.
|
476
|
+
#
|
477
|
+
# @return [Types::CreateAutoPredictorResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
478
|
+
#
|
479
|
+
# * {Types::CreateAutoPredictorResponse#predictor_arn #predictor_arn} => String
|
480
|
+
#
|
481
|
+
# @example Request syntax with placeholder values
|
482
|
+
#
|
483
|
+
# resp = client.create_auto_predictor({
|
484
|
+
# predictor_name: "Name", # required
|
485
|
+
# forecast_horizon: 1,
|
486
|
+
# forecast_types: ["ForecastType"],
|
487
|
+
# forecast_dimensions: ["Name"],
|
488
|
+
# forecast_frequency: "Frequency",
|
489
|
+
# data_config: {
|
490
|
+
# dataset_group_arn: "Arn", # required
|
491
|
+
# attribute_configs: [
|
492
|
+
# {
|
493
|
+
# attribute_name: "Name", # required
|
494
|
+
# transformations: { # required
|
495
|
+
# "Name" => "Value",
|
496
|
+
# },
|
497
|
+
# },
|
498
|
+
# ],
|
499
|
+
# additional_datasets: [
|
500
|
+
# {
|
501
|
+
# name: "Name", # required
|
502
|
+
# configuration: {
|
503
|
+
# "Name" => ["Value"],
|
504
|
+
# },
|
505
|
+
# },
|
506
|
+
# ],
|
507
|
+
# },
|
508
|
+
# encryption_config: {
|
509
|
+
# role_arn: "Arn", # required
|
510
|
+
# kms_key_arn: "KMSKeyArn", # required
|
511
|
+
# },
|
512
|
+
# reference_predictor_arn: "Arn",
|
513
|
+
# optimization_metric: "WAPE", # accepts WAPE, RMSE, AverageWeightedQuantileLoss, MASE, MAPE
|
514
|
+
# explain_predictor: false,
|
515
|
+
# tags: [
|
516
|
+
# {
|
517
|
+
# key: "TagKey", # required
|
518
|
+
# value: "TagValue", # required
|
519
|
+
# },
|
520
|
+
# ],
|
521
|
+
# })
|
522
|
+
#
|
523
|
+
# @example Response structure
|
524
|
+
#
|
525
|
+
# resp.predictor_arn #=> String
|
526
|
+
#
|
527
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/CreateAutoPredictor AWS API Documentation
|
528
|
+
#
|
529
|
+
# @overload create_auto_predictor(params = {})
|
530
|
+
# @param [Hash] params ({})
|
531
|
+
def create_auto_predictor(params = {}, options = {})
|
532
|
+
req = build_request(:create_auto_predictor, params)
|
533
|
+
req.send_request(options)
|
534
|
+
end
|
535
|
+
|
340
536
|
# Creates an Amazon Forecast dataset. The information about the dataset
|
341
537
|
# that you provide helps Forecast understand how to consume the data for
|
342
538
|
# model training. This includes the following:
|
@@ -753,6 +949,297 @@ module Aws::ForecastService
|
|
753
949
|
req.send_request(options)
|
754
950
|
end
|
755
951
|
|
952
|
+
# <note markdown="1"> Explainability is only available for Forecasts and Predictors
|
953
|
+
# generated from an AutoPredictor (CreateAutoPredictor)
|
954
|
+
#
|
955
|
+
# </note>
|
956
|
+
#
|
957
|
+
# Creates an Amazon Forecast Explainability.
|
958
|
+
#
|
959
|
+
# Explainability helps you better understand how the attributes in your
|
960
|
+
# datasets impact forecast. Amazon Forecast uses a metric called Impact
|
961
|
+
# scores to quantify the relative impact of each attribute and determine
|
962
|
+
# whether they increase or decrease forecast values.
|
963
|
+
#
|
964
|
+
# To enable Forecast Explainability, your predictor must include at
|
965
|
+
# least one of the following: related time series, item metadata, or
|
966
|
+
# additional datasets like Holidays and the Weather Index.
|
967
|
+
#
|
968
|
+
# CreateExplainability accepts either a Predictor ARN or Forecast ARN.
|
969
|
+
# To receive aggregated Impact scores for all time series and time
|
970
|
+
# points in your datasets, provide a Predictor ARN. To receive Impact
|
971
|
+
# scores for specific time series and time points, provide a Forecast
|
972
|
+
# ARN.
|
973
|
+
#
|
974
|
+
# **CreateExplainability with a Predictor ARN**
|
975
|
+
#
|
976
|
+
# <note markdown="1"> You can only have one Explainability resource per predictor. If you
|
977
|
+
# already enabled `ExplainPredictor` in CreateAutoPredictor, that
|
978
|
+
# predictor already has an Explainability resource.
|
979
|
+
#
|
980
|
+
# </note>
|
981
|
+
#
|
982
|
+
# The following parameters are required when providing a Predictor ARN:
|
983
|
+
#
|
984
|
+
# * `ExplainabilityName` - A unique name for the Explainability.
|
985
|
+
#
|
986
|
+
# * `ResourceArn` - The Arn of the predictor.
|
987
|
+
#
|
988
|
+
# * `TimePointGranularity` - Must be set to “ALL”.
|
989
|
+
#
|
990
|
+
# * `TimeSeriesGranularity` - Must be set to “ALL”.
|
991
|
+
#
|
992
|
+
# Do not specify a value for the following parameters:
|
993
|
+
#
|
994
|
+
# * `DataSource` - Only valid when TimeSeriesGranularity is “SPECIFIC”.
|
995
|
+
#
|
996
|
+
# * `Schema` - Only valid when TimeSeriesGranularity is “SPECIFIC”.
|
997
|
+
#
|
998
|
+
# * `StartDateTime` - Only valid when TimePointGranularity is
|
999
|
+
# “SPECIFIC”.
|
1000
|
+
#
|
1001
|
+
# * `EndDateTime` - Only valid when TimePointGranularity is “SPECIFIC”.
|
1002
|
+
#
|
1003
|
+
# **CreateExplainability with a Forecast ARN**
|
1004
|
+
#
|
1005
|
+
# <note markdown="1"> You can specify a maximum of 50 time series and 500 time points.
|
1006
|
+
#
|
1007
|
+
# </note>
|
1008
|
+
#
|
1009
|
+
# The following parameters are required when providing a Predictor ARN:
|
1010
|
+
#
|
1011
|
+
# * `ExplainabilityName` - A unique name for the Explainability.
|
1012
|
+
#
|
1013
|
+
# * `ResourceArn` - The Arn of the forecast.
|
1014
|
+
#
|
1015
|
+
# * `TimePointGranularity` - Either “ALL” or “SPECIFIC”.
|
1016
|
+
#
|
1017
|
+
# * `TimeSeriesGranularity` - Either “ALL” or “SPECIFIC”.
|
1018
|
+
#
|
1019
|
+
# If you set TimeSeriesGranularity to “SPECIFIC”, you must also provide
|
1020
|
+
# the following:
|
1021
|
+
#
|
1022
|
+
# * `DataSource` - The S3 location of the CSV file specifying your time
|
1023
|
+
# series.
|
1024
|
+
#
|
1025
|
+
# * `Schema` - The Schema defines the attributes and attribute types
|
1026
|
+
# listed in the Data Source.
|
1027
|
+
#
|
1028
|
+
# If you set TimePointGranularity to “SPECIFIC”, you must also provide
|
1029
|
+
# the following:
|
1030
|
+
#
|
1031
|
+
# * `StartDateTime` - The first timestamp in the range of time points.
|
1032
|
+
#
|
1033
|
+
# * `EndDateTime` - The last timestamp in the range of time points.
|
1034
|
+
#
|
1035
|
+
# @option params [required, String] :explainability_name
|
1036
|
+
# A unique name for the Explainability.
|
1037
|
+
#
|
1038
|
+
# @option params [required, String] :resource_arn
|
1039
|
+
# The Amazon Resource Name (ARN) of the Predictor or Forecast used to
|
1040
|
+
# create the Explainability.
|
1041
|
+
#
|
1042
|
+
# @option params [required, Types::ExplainabilityConfig] :explainability_config
|
1043
|
+
# The configuration settings that define the granularity of time series
|
1044
|
+
# and time points for the Explainability.
|
1045
|
+
#
|
1046
|
+
# @option params [Types::DataSource] :data_source
|
1047
|
+
# The source of your data, an AWS Identity and Access Management (IAM)
|
1048
|
+
# role that allows Amazon Forecast to access the data and, optionally,
|
1049
|
+
# an AWS Key Management Service (KMS) key.
|
1050
|
+
#
|
1051
|
+
# @option params [Types::Schema] :schema
|
1052
|
+
# Defines the fields of a dataset.
|
1053
|
+
#
|
1054
|
+
# @option params [Boolean] :enable_visualization
|
1055
|
+
# Create an Expainability visualization that is viewable within the AWS
|
1056
|
+
# console.
|
1057
|
+
#
|
1058
|
+
# @option params [String] :start_date_time
|
1059
|
+
# If `TimePointGranularity` is set to `SPECIFIC`, define the first point
|
1060
|
+
# for the Explainability.
|
1061
|
+
#
|
1062
|
+
# Use the following timestamp format: yyyy-MM-ddTHH:mm:ss (example:
|
1063
|
+
# 2015-01-01T20:00:00)
|
1064
|
+
#
|
1065
|
+
# @option params [String] :end_date_time
|
1066
|
+
# If `TimePointGranularity` is set to `SPECIFIC`, define the last time
|
1067
|
+
# point for the Explainability.
|
1068
|
+
#
|
1069
|
+
# Use the following timestamp format: yyyy-MM-ddTHH:mm:ss (example:
|
1070
|
+
# 2015-01-01T20:00:00)
|
1071
|
+
#
|
1072
|
+
# @option params [Array<Types::Tag>] :tags
|
1073
|
+
# Optional metadata to help you categorize and organize your resources.
|
1074
|
+
# Each tag consists of a key and an optional value, both of which you
|
1075
|
+
# define. Tag keys and values are case sensitive.
|
1076
|
+
#
|
1077
|
+
# The following restrictions apply to tags:
|
1078
|
+
#
|
1079
|
+
# * For each resource, each tag key must be unique and each tag key must
|
1080
|
+
# have one value.
|
1081
|
+
#
|
1082
|
+
# * Maximum number of tags per resource: 50.
|
1083
|
+
#
|
1084
|
+
# * Maximum key length: 128 Unicode characters in UTF-8.
|
1085
|
+
#
|
1086
|
+
# * Maximum value length: 256 Unicode characters in UTF-8.
|
1087
|
+
#
|
1088
|
+
# * Accepted characters: all letters and numbers, spaces representable
|
1089
|
+
# in UTF-8, and + - = . \_ : / @. If your tagging schema is used
|
1090
|
+
# across other services and resources, the character restrictions of
|
1091
|
+
# those services also apply.
|
1092
|
+
#
|
1093
|
+
# * Key prefixes cannot include any upper or lowercase combination of
|
1094
|
+
# `aws:` or `AWS:`. Values can have this prefix. If a tag value has
|
1095
|
+
# `aws` as its prefix but the key does not, Forecast considers it to
|
1096
|
+
# be a user tag and will count against the limit of 50 tags. Tags with
|
1097
|
+
# only the key prefix of `aws` do not count against your tags per
|
1098
|
+
# resource limit. You cannot edit or delete tag keys with this prefix.
|
1099
|
+
#
|
1100
|
+
# @return [Types::CreateExplainabilityResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1101
|
+
#
|
1102
|
+
# * {Types::CreateExplainabilityResponse#explainability_arn #explainability_arn} => String
|
1103
|
+
#
|
1104
|
+
# @example Request syntax with placeholder values
|
1105
|
+
#
|
1106
|
+
# resp = client.create_explainability({
|
1107
|
+
# explainability_name: "Name", # required
|
1108
|
+
# resource_arn: "Arn", # required
|
1109
|
+
# explainability_config: { # required
|
1110
|
+
# time_series_granularity: "ALL", # required, accepts ALL, SPECIFIC
|
1111
|
+
# time_point_granularity: "ALL", # required, accepts ALL, SPECIFIC
|
1112
|
+
# },
|
1113
|
+
# data_source: {
|
1114
|
+
# s3_config: { # required
|
1115
|
+
# path: "S3Path", # required
|
1116
|
+
# role_arn: "Arn", # required
|
1117
|
+
# kms_key_arn: "KMSKeyArn",
|
1118
|
+
# },
|
1119
|
+
# },
|
1120
|
+
# schema: {
|
1121
|
+
# attributes: [
|
1122
|
+
# {
|
1123
|
+
# attribute_name: "Name",
|
1124
|
+
# attribute_type: "string", # accepts string, integer, float, timestamp, geolocation
|
1125
|
+
# },
|
1126
|
+
# ],
|
1127
|
+
# },
|
1128
|
+
# enable_visualization: false,
|
1129
|
+
# start_date_time: "LocalDateTime",
|
1130
|
+
# end_date_time: "LocalDateTime",
|
1131
|
+
# tags: [
|
1132
|
+
# {
|
1133
|
+
# key: "TagKey", # required
|
1134
|
+
# value: "TagValue", # required
|
1135
|
+
# },
|
1136
|
+
# ],
|
1137
|
+
# })
|
1138
|
+
#
|
1139
|
+
# @example Response structure
|
1140
|
+
#
|
1141
|
+
# resp.explainability_arn #=> String
|
1142
|
+
#
|
1143
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/CreateExplainability AWS API Documentation
|
1144
|
+
#
|
1145
|
+
# @overload create_explainability(params = {})
|
1146
|
+
# @param [Hash] params ({})
|
1147
|
+
def create_explainability(params = {}, options = {})
|
1148
|
+
req = build_request(:create_explainability, params)
|
1149
|
+
req.send_request(options)
|
1150
|
+
end
|
1151
|
+
|
1152
|
+
# Exports an Explainability resource created by the CreateExplainability
|
1153
|
+
# operation. Exported files are exported to an Amazon Simple Storage
|
1154
|
+
# Service (Amazon S3) bucket.
|
1155
|
+
#
|
1156
|
+
# You must specify a DataDestination object that includes an Amazon S3
|
1157
|
+
# bucket and an AWS Identity and Access Management (IAM) role that
|
1158
|
+
# Amazon Forecast can assume to access the Amazon S3 bucket. For more
|
1159
|
+
# information, see aws-forecast-iam-roles.
|
1160
|
+
#
|
1161
|
+
# <note markdown="1"> The `Status` of the export job must be `ACTIVE` before you can access
|
1162
|
+
# the export in your Amazon S3 bucket. To get the status, use the
|
1163
|
+
# DescribeExplainabilityExport operation.
|
1164
|
+
#
|
1165
|
+
# </note>
|
1166
|
+
#
|
1167
|
+
# @option params [required, String] :explainability_export_name
|
1168
|
+
# A unique name for the Explainability export.
|
1169
|
+
#
|
1170
|
+
# @option params [required, String] :explainability_arn
|
1171
|
+
# The Amazon Resource Name (ARN) of the Explainability to export.
|
1172
|
+
#
|
1173
|
+
# @option params [required, Types::DataDestination] :destination
|
1174
|
+
# The destination for an export job. Provide an S3 path, an AWS Identity
|
1175
|
+
# and Access Management (IAM) role that allows Amazon Forecast to access
|
1176
|
+
# the location, and an AWS Key Management Service (KMS) key (optional).
|
1177
|
+
#
|
1178
|
+
# @option params [Array<Types::Tag>] :tags
|
1179
|
+
# Optional metadata to help you categorize and organize your resources.
|
1180
|
+
# Each tag consists of a key and an optional value, both of which you
|
1181
|
+
# define. Tag keys and values are case sensitive.
|
1182
|
+
#
|
1183
|
+
# The following restrictions apply to tags:
|
1184
|
+
#
|
1185
|
+
# * For each resource, each tag key must be unique and each tag key must
|
1186
|
+
# have one value.
|
1187
|
+
#
|
1188
|
+
# * Maximum number of tags per resource: 50.
|
1189
|
+
#
|
1190
|
+
# * Maximum key length: 128 Unicode characters in UTF-8.
|
1191
|
+
#
|
1192
|
+
# * Maximum value length: 256 Unicode characters in UTF-8.
|
1193
|
+
#
|
1194
|
+
# * Accepted characters: all letters and numbers, spaces representable
|
1195
|
+
# in UTF-8, and + - = . \_ : / @. If your tagging schema is used
|
1196
|
+
# across other services and resources, the character restrictions of
|
1197
|
+
# those services also apply.
|
1198
|
+
#
|
1199
|
+
# * Key prefixes cannot include any upper or lowercase combination of
|
1200
|
+
# `aws:` or `AWS:`. Values can have this prefix. If a tag value has
|
1201
|
+
# `aws` as its prefix but the key does not, Forecast considers it to
|
1202
|
+
# be a user tag and will count against the limit of 50 tags. Tags with
|
1203
|
+
# only the key prefix of `aws` do not count against your tags per
|
1204
|
+
# resource limit. You cannot edit or delete tag keys with this prefix.
|
1205
|
+
#
|
1206
|
+
# @return [Types::CreateExplainabilityExportResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1207
|
+
#
|
1208
|
+
# * {Types::CreateExplainabilityExportResponse#explainability_export_arn #explainability_export_arn} => String
|
1209
|
+
#
|
1210
|
+
# @example Request syntax with placeholder values
|
1211
|
+
#
|
1212
|
+
# resp = client.create_explainability_export({
|
1213
|
+
# explainability_export_name: "Name", # required
|
1214
|
+
# explainability_arn: "Arn", # required
|
1215
|
+
# destination: { # required
|
1216
|
+
# s3_config: { # required
|
1217
|
+
# path: "S3Path", # required
|
1218
|
+
# role_arn: "Arn", # required
|
1219
|
+
# kms_key_arn: "KMSKeyArn",
|
1220
|
+
# },
|
1221
|
+
# },
|
1222
|
+
# tags: [
|
1223
|
+
# {
|
1224
|
+
# key: "TagKey", # required
|
1225
|
+
# value: "TagValue", # required
|
1226
|
+
# },
|
1227
|
+
# ],
|
1228
|
+
# })
|
1229
|
+
#
|
1230
|
+
# @example Response structure
|
1231
|
+
#
|
1232
|
+
# resp.explainability_export_arn #=> String
|
1233
|
+
#
|
1234
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/CreateExplainabilityExport AWS API Documentation
|
1235
|
+
#
|
1236
|
+
# @overload create_explainability_export(params = {})
|
1237
|
+
# @param [Hash] params ({})
|
1238
|
+
def create_explainability_export(params = {}, options = {})
|
1239
|
+
req = build_request(:create_explainability_export, params)
|
1240
|
+
req.send_request(options)
|
1241
|
+
end
|
1242
|
+
|
756
1243
|
# Creates a forecast for each item in the `TARGET_TIME_SERIES` dataset
|
757
1244
|
# that was used to train the predictor. This is known as inference. To
|
758
1245
|
# retrieve the forecast for a single item at low latency, use the
|
@@ -969,6 +1456,13 @@ module Aws::ForecastService
|
|
969
1456
|
req.send_request(options)
|
970
1457
|
end
|
971
1458
|
|
1459
|
+
# <note markdown="1"> This operation creates a legacy predictor that does not include all
|
1460
|
+
# the predictor functionalities provided by Amazon Forecast. To create a
|
1461
|
+
# predictor that is compatible with all aspects of Forecast, use
|
1462
|
+
# CreateAutoPredictor.
|
1463
|
+
#
|
1464
|
+
# </note>
|
1465
|
+
#
|
972
1466
|
# Creates an Amazon Forecast predictor.
|
973
1467
|
#
|
974
1468
|
# In the request, provide a dataset group and either specify an
|
@@ -1192,7 +1686,7 @@ module Aws::ForecastService
|
|
1192
1686
|
# forecast_horizon: 1, # required
|
1193
1687
|
# forecast_types: ["ForecastType"],
|
1194
1688
|
# perform_auto_ml: false,
|
1195
|
-
# auto_ml_override_strategy: "LatencyOptimized", # accepts LatencyOptimized
|
1689
|
+
# auto_ml_override_strategy: "LatencyOptimized", # accepts LatencyOptimized, AccuracyOptimized
|
1196
1690
|
# perform_hpo: false,
|
1197
1691
|
# training_parameters: {
|
1198
1692
|
# "ParameterKey" => "ParameterValue",
|
@@ -1280,8 +1774,8 @@ module Aws::ForecastService
|
|
1280
1774
|
end
|
1281
1775
|
|
1282
1776
|
# Exports backtest forecasts and accuracy metrics generated by the
|
1283
|
-
# CreatePredictor
|
1284
|
-
# exported to your specified S3 bucket.
|
1777
|
+
# CreateAutoPredictor or CreatePredictor operations. Two folders
|
1778
|
+
# containing CSV files are exported to your specified S3 bucket.
|
1285
1779
|
#
|
1286
1780
|
# The export file names will match the following conventions:
|
1287
1781
|
#
|
@@ -1462,6 +1956,55 @@ module Aws::ForecastService
|
|
1462
1956
|
req.send_request(options)
|
1463
1957
|
end
|
1464
1958
|
|
1959
|
+
# Deletes an Explainability resource.
|
1960
|
+
#
|
1961
|
+
# You can delete only predictor that have a status of `ACTIVE` or
|
1962
|
+
# `CREATE_FAILED`. To get the status, use the DescribeExplainability
|
1963
|
+
# operation.
|
1964
|
+
#
|
1965
|
+
# @option params [required, String] :explainability_arn
|
1966
|
+
# The Amazon Resource Name (ARN) of the Explainability resource to
|
1967
|
+
# delete.
|
1968
|
+
#
|
1969
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
1970
|
+
#
|
1971
|
+
# @example Request syntax with placeholder values
|
1972
|
+
#
|
1973
|
+
# resp = client.delete_explainability({
|
1974
|
+
# explainability_arn: "Arn", # required
|
1975
|
+
# })
|
1976
|
+
#
|
1977
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/DeleteExplainability AWS API Documentation
|
1978
|
+
#
|
1979
|
+
# @overload delete_explainability(params = {})
|
1980
|
+
# @param [Hash] params ({})
|
1981
|
+
def delete_explainability(params = {}, options = {})
|
1982
|
+
req = build_request(:delete_explainability, params)
|
1983
|
+
req.send_request(options)
|
1984
|
+
end
|
1985
|
+
|
1986
|
+
# Deletes an Explainability export.
|
1987
|
+
#
|
1988
|
+
# @option params [required, String] :explainability_export_arn
|
1989
|
+
# The Amazon Resource Name (ARN) of the Explainability export to delete.
|
1990
|
+
#
|
1991
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
1992
|
+
#
|
1993
|
+
# @example Request syntax with placeholder values
|
1994
|
+
#
|
1995
|
+
# resp = client.delete_explainability_export({
|
1996
|
+
# explainability_export_arn: "Arn", # required
|
1997
|
+
# })
|
1998
|
+
#
|
1999
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/DeleteExplainabilityExport AWS API Documentation
|
2000
|
+
#
|
2001
|
+
# @overload delete_explainability_export(params = {})
|
2002
|
+
# @param [Hash] params ({})
|
2003
|
+
def delete_explainability_export(params = {}, options = {})
|
2004
|
+
req = build_request(:delete_explainability_export, params)
|
2005
|
+
req.send_request(options)
|
2006
|
+
end
|
2007
|
+
|
1465
2008
|
# Deletes a forecast created using the CreateForecast operation. You can
|
1466
2009
|
# delete only forecasts that have a status of `ACTIVE` or
|
1467
2010
|
# `CREATE_FAILED`. To get the status, use the DescribeForecast
|
@@ -1515,10 +2058,10 @@ module Aws::ForecastService
|
|
1515
2058
|
req.send_request(options)
|
1516
2059
|
end
|
1517
2060
|
|
1518
|
-
# Deletes a predictor created using the
|
1519
|
-
# can delete only predictor that have a
|
1520
|
-
# `CREATE_FAILED`. To get the status, use the
|
1521
|
-
# operation.
|
2061
|
+
# Deletes a predictor created using the DescribePredictor or
|
2062
|
+
# CreatePredictor operations. You can delete only predictor that have a
|
2063
|
+
# status of `ACTIVE` or `CREATE_FAILED`. To get the status, use the
|
2064
|
+
# DescribePredictor operation.
|
1522
2065
|
#
|
1523
2066
|
# @option params [required, String] :predictor_arn
|
1524
2067
|
# The Amazon Resource Name (ARN) of the predictor to delete.
|
@@ -1610,6 +2153,81 @@ module Aws::ForecastService
|
|
1610
2153
|
req.send_request(options)
|
1611
2154
|
end
|
1612
2155
|
|
2156
|
+
# Describes a predictor created using the CreateAutoPredictor operation.
|
2157
|
+
#
|
2158
|
+
# @option params [required, String] :predictor_arn
|
2159
|
+
# The Amazon Resource Name (ARN) of the predictor.
|
2160
|
+
#
|
2161
|
+
# @return [Types::DescribeAutoPredictorResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2162
|
+
#
|
2163
|
+
# * {Types::DescribeAutoPredictorResponse#predictor_arn #predictor_arn} => String
|
2164
|
+
# * {Types::DescribeAutoPredictorResponse#predictor_name #predictor_name} => String
|
2165
|
+
# * {Types::DescribeAutoPredictorResponse#forecast_horizon #forecast_horizon} => Integer
|
2166
|
+
# * {Types::DescribeAutoPredictorResponse#forecast_types #forecast_types} => Array<String>
|
2167
|
+
# * {Types::DescribeAutoPredictorResponse#forecast_frequency #forecast_frequency} => String
|
2168
|
+
# * {Types::DescribeAutoPredictorResponse#forecast_dimensions #forecast_dimensions} => Array<String>
|
2169
|
+
# * {Types::DescribeAutoPredictorResponse#dataset_import_job_arns #dataset_import_job_arns} => Array<String>
|
2170
|
+
# * {Types::DescribeAutoPredictorResponse#data_config #data_config} => Types::DataConfig
|
2171
|
+
# * {Types::DescribeAutoPredictorResponse#encryption_config #encryption_config} => Types::EncryptionConfig
|
2172
|
+
# * {Types::DescribeAutoPredictorResponse#reference_predictor_summary #reference_predictor_summary} => Types::ReferencePredictorSummary
|
2173
|
+
# * {Types::DescribeAutoPredictorResponse#estimated_time_remaining_in_minutes #estimated_time_remaining_in_minutes} => Integer
|
2174
|
+
# * {Types::DescribeAutoPredictorResponse#status #status} => String
|
2175
|
+
# * {Types::DescribeAutoPredictorResponse#message #message} => String
|
2176
|
+
# * {Types::DescribeAutoPredictorResponse#creation_time #creation_time} => Time
|
2177
|
+
# * {Types::DescribeAutoPredictorResponse#last_modification_time #last_modification_time} => Time
|
2178
|
+
# * {Types::DescribeAutoPredictorResponse#optimization_metric #optimization_metric} => String
|
2179
|
+
# * {Types::DescribeAutoPredictorResponse#explainability_info #explainability_info} => Types::ExplainabilityInfo
|
2180
|
+
#
|
2181
|
+
# @example Request syntax with placeholder values
|
2182
|
+
#
|
2183
|
+
# resp = client.describe_auto_predictor({
|
2184
|
+
# predictor_arn: "Arn", # required
|
2185
|
+
# })
|
2186
|
+
#
|
2187
|
+
# @example Response structure
|
2188
|
+
#
|
2189
|
+
# resp.predictor_arn #=> String
|
2190
|
+
# resp.predictor_name #=> String
|
2191
|
+
# resp.forecast_horizon #=> Integer
|
2192
|
+
# resp.forecast_types #=> Array
|
2193
|
+
# resp.forecast_types[0] #=> String
|
2194
|
+
# resp.forecast_frequency #=> String
|
2195
|
+
# resp.forecast_dimensions #=> Array
|
2196
|
+
# resp.forecast_dimensions[0] #=> String
|
2197
|
+
# resp.dataset_import_job_arns #=> Array
|
2198
|
+
# resp.dataset_import_job_arns[0] #=> String
|
2199
|
+
# resp.data_config.dataset_group_arn #=> String
|
2200
|
+
# resp.data_config.attribute_configs #=> Array
|
2201
|
+
# resp.data_config.attribute_configs[0].attribute_name #=> String
|
2202
|
+
# resp.data_config.attribute_configs[0].transformations #=> Hash
|
2203
|
+
# resp.data_config.attribute_configs[0].transformations["Name"] #=> String
|
2204
|
+
# resp.data_config.additional_datasets #=> Array
|
2205
|
+
# resp.data_config.additional_datasets[0].name #=> String
|
2206
|
+
# resp.data_config.additional_datasets[0].configuration #=> Hash
|
2207
|
+
# resp.data_config.additional_datasets[0].configuration["Name"] #=> Array
|
2208
|
+
# resp.data_config.additional_datasets[0].configuration["Name"][0] #=> String
|
2209
|
+
# resp.encryption_config.role_arn #=> String
|
2210
|
+
# resp.encryption_config.kms_key_arn #=> String
|
2211
|
+
# resp.reference_predictor_summary.arn #=> String
|
2212
|
+
# resp.reference_predictor_summary.state #=> String, one of "Active", "Deleted"
|
2213
|
+
# resp.estimated_time_remaining_in_minutes #=> Integer
|
2214
|
+
# resp.status #=> String
|
2215
|
+
# resp.message #=> String
|
2216
|
+
# resp.creation_time #=> Time
|
2217
|
+
# resp.last_modification_time #=> Time
|
2218
|
+
# resp.optimization_metric #=> String, one of "WAPE", "RMSE", "AverageWeightedQuantileLoss", "MASE", "MAPE"
|
2219
|
+
# resp.explainability_info.explainability_arn #=> String
|
2220
|
+
# resp.explainability_info.status #=> String
|
2221
|
+
#
|
2222
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/DescribeAutoPredictor AWS API Documentation
|
2223
|
+
#
|
2224
|
+
# @overload describe_auto_predictor(params = {})
|
2225
|
+
# @param [Hash] params ({})
|
2226
|
+
def describe_auto_predictor(params = {}, options = {})
|
2227
|
+
req = build_request(:describe_auto_predictor, params)
|
2228
|
+
req.send_request(options)
|
2229
|
+
end
|
2230
|
+
|
1613
2231
|
# Describes an Amazon Forecast dataset created using the CreateDataset
|
1614
2232
|
# operation.
|
1615
2233
|
#
|
@@ -1810,6 +2428,111 @@ module Aws::ForecastService
|
|
1810
2428
|
req.send_request(options)
|
1811
2429
|
end
|
1812
2430
|
|
2431
|
+
# Describes an Explainability resource created using the
|
2432
|
+
# CreateExplainability operation.
|
2433
|
+
#
|
2434
|
+
# @option params [required, String] :explainability_arn
|
2435
|
+
# The Amazon Resource Name (ARN) of the Explaianability to describe.
|
2436
|
+
#
|
2437
|
+
# @return [Types::DescribeExplainabilityResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2438
|
+
#
|
2439
|
+
# * {Types::DescribeExplainabilityResponse#explainability_arn #explainability_arn} => String
|
2440
|
+
# * {Types::DescribeExplainabilityResponse#explainability_name #explainability_name} => String
|
2441
|
+
# * {Types::DescribeExplainabilityResponse#resource_arn #resource_arn} => String
|
2442
|
+
# * {Types::DescribeExplainabilityResponse#explainability_config #explainability_config} => Types::ExplainabilityConfig
|
2443
|
+
# * {Types::DescribeExplainabilityResponse#enable_visualization #enable_visualization} => Boolean
|
2444
|
+
# * {Types::DescribeExplainabilityResponse#data_source #data_source} => Types::DataSource
|
2445
|
+
# * {Types::DescribeExplainabilityResponse#schema #schema} => Types::Schema
|
2446
|
+
# * {Types::DescribeExplainabilityResponse#start_date_time #start_date_time} => String
|
2447
|
+
# * {Types::DescribeExplainabilityResponse#end_date_time #end_date_time} => String
|
2448
|
+
# * {Types::DescribeExplainabilityResponse#estimated_time_remaining_in_minutes #estimated_time_remaining_in_minutes} => Integer
|
2449
|
+
# * {Types::DescribeExplainabilityResponse#message #message} => String
|
2450
|
+
# * {Types::DescribeExplainabilityResponse#status #status} => String
|
2451
|
+
# * {Types::DescribeExplainabilityResponse#creation_time #creation_time} => Time
|
2452
|
+
# * {Types::DescribeExplainabilityResponse#last_modification_time #last_modification_time} => Time
|
2453
|
+
#
|
2454
|
+
# @example Request syntax with placeholder values
|
2455
|
+
#
|
2456
|
+
# resp = client.describe_explainability({
|
2457
|
+
# explainability_arn: "Arn", # required
|
2458
|
+
# })
|
2459
|
+
#
|
2460
|
+
# @example Response structure
|
2461
|
+
#
|
2462
|
+
# resp.explainability_arn #=> String
|
2463
|
+
# resp.explainability_name #=> String
|
2464
|
+
# resp.resource_arn #=> String
|
2465
|
+
# resp.explainability_config.time_series_granularity #=> String, one of "ALL", "SPECIFIC"
|
2466
|
+
# resp.explainability_config.time_point_granularity #=> String, one of "ALL", "SPECIFIC"
|
2467
|
+
# resp.enable_visualization #=> Boolean
|
2468
|
+
# resp.data_source.s3_config.path #=> String
|
2469
|
+
# resp.data_source.s3_config.role_arn #=> String
|
2470
|
+
# resp.data_source.s3_config.kms_key_arn #=> String
|
2471
|
+
# resp.schema.attributes #=> Array
|
2472
|
+
# resp.schema.attributes[0].attribute_name #=> String
|
2473
|
+
# resp.schema.attributes[0].attribute_type #=> String, one of "string", "integer", "float", "timestamp", "geolocation"
|
2474
|
+
# resp.start_date_time #=> String
|
2475
|
+
# resp.end_date_time #=> String
|
2476
|
+
# resp.estimated_time_remaining_in_minutes #=> Integer
|
2477
|
+
# resp.message #=> String
|
2478
|
+
# resp.status #=> String
|
2479
|
+
# resp.creation_time #=> Time
|
2480
|
+
# resp.last_modification_time #=> Time
|
2481
|
+
#
|
2482
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/DescribeExplainability AWS API Documentation
|
2483
|
+
#
|
2484
|
+
# @overload describe_explainability(params = {})
|
2485
|
+
# @param [Hash] params ({})
|
2486
|
+
def describe_explainability(params = {}, options = {})
|
2487
|
+
req = build_request(:describe_explainability, params)
|
2488
|
+
req.send_request(options)
|
2489
|
+
end
|
2490
|
+
|
2491
|
+
# Describes an Explainability export created using the
|
2492
|
+
# CreateExplainabilityExport operation.
|
2493
|
+
#
|
2494
|
+
# @option params [required, String] :explainability_export_arn
|
2495
|
+
# The Amazon Resource Name (ARN) of the Explainability export.
|
2496
|
+
#
|
2497
|
+
# @return [Types::DescribeExplainabilityExportResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2498
|
+
#
|
2499
|
+
# * {Types::DescribeExplainabilityExportResponse#explainability_export_arn #explainability_export_arn} => String
|
2500
|
+
# * {Types::DescribeExplainabilityExportResponse#explainability_export_name #explainability_export_name} => String
|
2501
|
+
# * {Types::DescribeExplainabilityExportResponse#explainability_arn #explainability_arn} => String
|
2502
|
+
# * {Types::DescribeExplainabilityExportResponse#destination #destination} => Types::DataDestination
|
2503
|
+
# * {Types::DescribeExplainabilityExportResponse#message #message} => String
|
2504
|
+
# * {Types::DescribeExplainabilityExportResponse#status #status} => String
|
2505
|
+
# * {Types::DescribeExplainabilityExportResponse#creation_time #creation_time} => Time
|
2506
|
+
# * {Types::DescribeExplainabilityExportResponse#last_modification_time #last_modification_time} => Time
|
2507
|
+
#
|
2508
|
+
# @example Request syntax with placeholder values
|
2509
|
+
#
|
2510
|
+
# resp = client.describe_explainability_export({
|
2511
|
+
# explainability_export_arn: "Arn", # required
|
2512
|
+
# })
|
2513
|
+
#
|
2514
|
+
# @example Response structure
|
2515
|
+
#
|
2516
|
+
# resp.explainability_export_arn #=> String
|
2517
|
+
# resp.explainability_export_name #=> String
|
2518
|
+
# resp.explainability_arn #=> String
|
2519
|
+
# resp.destination.s3_config.path #=> String
|
2520
|
+
# resp.destination.s3_config.role_arn #=> String
|
2521
|
+
# resp.destination.s3_config.kms_key_arn #=> String
|
2522
|
+
# resp.message #=> String
|
2523
|
+
# resp.status #=> String
|
2524
|
+
# resp.creation_time #=> Time
|
2525
|
+
# resp.last_modification_time #=> Time
|
2526
|
+
#
|
2527
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/DescribeExplainabilityExport AWS API Documentation
|
2528
|
+
#
|
2529
|
+
# @overload describe_explainability_export(params = {})
|
2530
|
+
# @param [Hash] params ({})
|
2531
|
+
def describe_explainability_export(params = {}, options = {})
|
2532
|
+
req = build_request(:describe_explainability_export, params)
|
2533
|
+
req.send_request(options)
|
2534
|
+
end
|
2535
|
+
|
1813
2536
|
# Describes a forecast created using the CreateForecast operation.
|
1814
2537
|
#
|
1815
2538
|
# In addition to listing the properties provided in the `CreateForecast`
|
@@ -1928,6 +2651,12 @@ module Aws::ForecastService
|
|
1928
2651
|
req.send_request(options)
|
1929
2652
|
end
|
1930
2653
|
|
2654
|
+
# <note markdown="1"> This operation is only valid for legacy predictors created with
|
2655
|
+
# CreatePredictor. If you are not using a legacy predictor, use
|
2656
|
+
# DescribeAutoPredictor.
|
2657
|
+
#
|
2658
|
+
# </note>
|
2659
|
+
#
|
1931
2660
|
# Describes a predictor created using the CreatePredictor operation.
|
1932
2661
|
#
|
1933
2662
|
# In addition to listing the properties provided in the
|
@@ -1957,6 +2686,7 @@ module Aws::ForecastService
|
|
1957
2686
|
# * {Types::DescribePredictorResponse#predictor_arn #predictor_arn} => String
|
1958
2687
|
# * {Types::DescribePredictorResponse#predictor_name #predictor_name} => String
|
1959
2688
|
# * {Types::DescribePredictorResponse#algorithm_arn #algorithm_arn} => String
|
2689
|
+
# * {Types::DescribePredictorResponse#auto_ml_algorithm_arns #auto_ml_algorithm_arns} => Array<String>
|
1960
2690
|
# * {Types::DescribePredictorResponse#forecast_horizon #forecast_horizon} => Integer
|
1961
2691
|
# * {Types::DescribePredictorResponse#forecast_types #forecast_types} => Array<String>
|
1962
2692
|
# * {Types::DescribePredictorResponse#perform_auto_ml #perform_auto_ml} => Boolean
|
@@ -1970,8 +2700,8 @@ module Aws::ForecastService
|
|
1970
2700
|
# * {Types::DescribePredictorResponse#encryption_config #encryption_config} => Types::EncryptionConfig
|
1971
2701
|
# * {Types::DescribePredictorResponse#predictor_execution_details #predictor_execution_details} => Types::PredictorExecutionDetails
|
1972
2702
|
# * {Types::DescribePredictorResponse#estimated_time_remaining_in_minutes #estimated_time_remaining_in_minutes} => Integer
|
2703
|
+
# * {Types::DescribePredictorResponse#is_auto_predictor #is_auto_predictor} => Boolean
|
1973
2704
|
# * {Types::DescribePredictorResponse#dataset_import_job_arns #dataset_import_job_arns} => Array<String>
|
1974
|
-
# * {Types::DescribePredictorResponse#auto_ml_algorithm_arns #auto_ml_algorithm_arns} => Array<String>
|
1975
2705
|
# * {Types::DescribePredictorResponse#status #status} => String
|
1976
2706
|
# * {Types::DescribePredictorResponse#message #message} => String
|
1977
2707
|
# * {Types::DescribePredictorResponse#creation_time #creation_time} => Time
|
@@ -1989,11 +2719,13 @@ module Aws::ForecastService
|
|
1989
2719
|
# resp.predictor_arn #=> String
|
1990
2720
|
# resp.predictor_name #=> String
|
1991
2721
|
# resp.algorithm_arn #=> String
|
2722
|
+
# resp.auto_ml_algorithm_arns #=> Array
|
2723
|
+
# resp.auto_ml_algorithm_arns[0] #=> String
|
1992
2724
|
# resp.forecast_horizon #=> Integer
|
1993
2725
|
# resp.forecast_types #=> Array
|
1994
2726
|
# resp.forecast_types[0] #=> String
|
1995
2727
|
# resp.perform_auto_ml #=> Boolean
|
1996
|
-
# resp.auto_ml_override_strategy #=> String, one of "LatencyOptimized"
|
2728
|
+
# resp.auto_ml_override_strategy #=> String, one of "LatencyOptimized", "AccuracyOptimized"
|
1997
2729
|
# resp.perform_hpo #=> Boolean
|
1998
2730
|
# resp.training_parameters #=> Hash
|
1999
2731
|
# resp.training_parameters["ParameterKey"] #=> String
|
@@ -2036,10 +2768,9 @@ module Aws::ForecastService
|
|
2036
2768
|
# resp.predictor_execution_details.predictor_executions[0].test_windows[0].status #=> String
|
2037
2769
|
# resp.predictor_execution_details.predictor_executions[0].test_windows[0].message #=> String
|
2038
2770
|
# resp.estimated_time_remaining_in_minutes #=> Integer
|
2771
|
+
# resp.is_auto_predictor #=> Boolean
|
2039
2772
|
# resp.dataset_import_job_arns #=> Array
|
2040
2773
|
# resp.dataset_import_job_arns[0] #=> String
|
2041
|
-
# resp.auto_ml_algorithm_arns #=> Array
|
2042
|
-
# resp.auto_ml_algorithm_arns[0] #=> String
|
2043
2774
|
# resp.status #=> String
|
2044
2775
|
# resp.message #=> String
|
2045
2776
|
# resp.creation_time #=> Time
|
@@ -2146,6 +2877,7 @@ module Aws::ForecastService
|
|
2146
2877
|
# @return [Types::GetAccuracyMetricsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2147
2878
|
#
|
2148
2879
|
# * {Types::GetAccuracyMetricsResponse#predictor_evaluation_results #predictor_evaluation_results} => Array<Types::EvaluationResult>
|
2880
|
+
# * {Types::GetAccuracyMetricsResponse#is_auto_predictor #is_auto_predictor} => Boolean
|
2149
2881
|
# * {Types::GetAccuracyMetricsResponse#auto_ml_override_strategy #auto_ml_override_strategy} => String
|
2150
2882
|
# * {Types::GetAccuracyMetricsResponse#optimization_metric #optimization_metric} => String
|
2151
2883
|
#
|
@@ -2175,7 +2907,8 @@ module Aws::ForecastService
|
|
2175
2907
|
# resp.predictor_evaluation_results[0].test_windows[0].metrics.error_metrics[0].mase #=> Float
|
2176
2908
|
# resp.predictor_evaluation_results[0].test_windows[0].metrics.error_metrics[0].mape #=> Float
|
2177
2909
|
# resp.predictor_evaluation_results[0].test_windows[0].metrics.average_weighted_quantile_loss #=> Float
|
2178
|
-
# resp.
|
2910
|
+
# resp.is_auto_predictor #=> Boolean
|
2911
|
+
# resp.auto_ml_override_strategy #=> String, one of "LatencyOptimized", "AccuracyOptimized"
|
2179
2912
|
# resp.optimization_metric #=> String, one of "WAPE", "RMSE", "AverageWeightedQuantileLoss", "MASE", "MAPE"
|
2180
2913
|
#
|
2181
2914
|
# @see http://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/GetAccuracyMetrics AWS API Documentation
|
@@ -2363,6 +3096,156 @@ module Aws::ForecastService
|
|
2363
3096
|
req.send_request(options)
|
2364
3097
|
end
|
2365
3098
|
|
3099
|
+
# Returns a list of Explainability resources created using the
|
3100
|
+
# CreateExplainability operation. This operation returns a summary for
|
3101
|
+
# each Explainability. You can filter the list using an array of Filter
|
3102
|
+
# objects.
|
3103
|
+
#
|
3104
|
+
# To retrieve the complete set of properties for a particular
|
3105
|
+
# Explainability resource, use the ARN with the DescribeExplainability
|
3106
|
+
# operation.
|
3107
|
+
#
|
3108
|
+
# @option params [String] :next_token
|
3109
|
+
# If the result of the previous request was truncated, the response
|
3110
|
+
# includes a NextToken. To retrieve the next set of results, use the
|
3111
|
+
# token in the next request. Tokens expire after 24 hours.
|
3112
|
+
#
|
3113
|
+
# @option params [Integer] :max_results
|
3114
|
+
# The number of items returned in the response.
|
3115
|
+
#
|
3116
|
+
# @option params [Array<Types::Filter>] :filters
|
3117
|
+
# An array of filters. For each filter, provide a condition and a match
|
3118
|
+
# statement. The condition is either `IS` or `IS_NOT`, which specifies
|
3119
|
+
# whether to include or exclude the resources that match the statement
|
3120
|
+
# from the list. The match statement consists of a key and a value.
|
3121
|
+
#
|
3122
|
+
# **Filter properties**
|
3123
|
+
#
|
3124
|
+
# * `Condition` - The condition to apply. Valid values are `IS` and
|
3125
|
+
# `IS_NOT`.
|
3126
|
+
#
|
3127
|
+
# * `Key` - The name of the parameter to filter on. Valid values are
|
3128
|
+
# `ResourceArn` and `Status`.
|
3129
|
+
#
|
3130
|
+
# * `Value` - The value to match.
|
3131
|
+
#
|
3132
|
+
# @return [Types::ListExplainabilitiesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
3133
|
+
#
|
3134
|
+
# * {Types::ListExplainabilitiesResponse#explainabilities #explainabilities} => Array<Types::ExplainabilitySummary>
|
3135
|
+
# * {Types::ListExplainabilitiesResponse#next_token #next_token} => String
|
3136
|
+
#
|
3137
|
+
# @example Request syntax with placeholder values
|
3138
|
+
#
|
3139
|
+
# resp = client.list_explainabilities({
|
3140
|
+
# next_token: "NextToken",
|
3141
|
+
# max_results: 1,
|
3142
|
+
# filters: [
|
3143
|
+
# {
|
3144
|
+
# key: "String", # required
|
3145
|
+
# value: "Arn", # required
|
3146
|
+
# condition: "IS", # required, accepts IS, IS_NOT
|
3147
|
+
# },
|
3148
|
+
# ],
|
3149
|
+
# })
|
3150
|
+
#
|
3151
|
+
# @example Response structure
|
3152
|
+
#
|
3153
|
+
# resp.explainabilities #=> Array
|
3154
|
+
# resp.explainabilities[0].explainability_arn #=> String
|
3155
|
+
# resp.explainabilities[0].explainability_name #=> String
|
3156
|
+
# resp.explainabilities[0].resource_arn #=> String
|
3157
|
+
# resp.explainabilities[0].explainability_config.time_series_granularity #=> String, one of "ALL", "SPECIFIC"
|
3158
|
+
# resp.explainabilities[0].explainability_config.time_point_granularity #=> String, one of "ALL", "SPECIFIC"
|
3159
|
+
# resp.explainabilities[0].status #=> String
|
3160
|
+
# resp.explainabilities[0].message #=> String
|
3161
|
+
# resp.explainabilities[0].creation_time #=> Time
|
3162
|
+
# resp.explainabilities[0].last_modification_time #=> Time
|
3163
|
+
# resp.next_token #=> String
|
3164
|
+
#
|
3165
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/ListExplainabilities AWS API Documentation
|
3166
|
+
#
|
3167
|
+
# @overload list_explainabilities(params = {})
|
3168
|
+
# @param [Hash] params ({})
|
3169
|
+
def list_explainabilities(params = {}, options = {})
|
3170
|
+
req = build_request(:list_explainabilities, params)
|
3171
|
+
req.send_request(options)
|
3172
|
+
end
|
3173
|
+
|
3174
|
+
# Returns a list of Explainability exports created using the
|
3175
|
+
# CreateExplainabilityExport operation. This operation returns a summary
|
3176
|
+
# for each Explainability export. You can filter the list using an array
|
3177
|
+
# of Filter objects.
|
3178
|
+
#
|
3179
|
+
# To retrieve the complete set of properties for a particular
|
3180
|
+
# Explainability export, use the ARN with the DescribeExplainability
|
3181
|
+
# operation.
|
3182
|
+
#
|
3183
|
+
# @option params [String] :next_token
|
3184
|
+
# If the result of the previous request was truncated, the response
|
3185
|
+
# includes a NextToken. To retrieve the next set of results, use the
|
3186
|
+
# token in the next request. Tokens expire after 24 hours.
|
3187
|
+
#
|
3188
|
+
# @option params [Integer] :max_results
|
3189
|
+
# The number of items to return in the response.
|
3190
|
+
#
|
3191
|
+
# @option params [Array<Types::Filter>] :filters
|
3192
|
+
# An array of filters. For each filter, provide a condition and a match
|
3193
|
+
# statement. The condition is either `IS` or `IS_NOT`, which specifies
|
3194
|
+
# whether to include or exclude resources that match the statement from
|
3195
|
+
# the list. The match statement consists of a key and a value.
|
3196
|
+
#
|
3197
|
+
# **Filter properties**
|
3198
|
+
#
|
3199
|
+
# * `Condition` - The condition to apply. Valid values are `IS` and
|
3200
|
+
# `IS_NOT`.
|
3201
|
+
#
|
3202
|
+
# * `Key` - The name of the parameter to filter on. Valid values are
|
3203
|
+
# `ResourceArn` and `Status`.
|
3204
|
+
#
|
3205
|
+
# * `Value` - The value to match.
|
3206
|
+
#
|
3207
|
+
# @return [Types::ListExplainabilityExportsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
3208
|
+
#
|
3209
|
+
# * {Types::ListExplainabilityExportsResponse#explainability_exports #explainability_exports} => Array<Types::ExplainabilityExportSummary>
|
3210
|
+
# * {Types::ListExplainabilityExportsResponse#next_token #next_token} => String
|
3211
|
+
#
|
3212
|
+
# @example Request syntax with placeholder values
|
3213
|
+
#
|
3214
|
+
# resp = client.list_explainability_exports({
|
3215
|
+
# next_token: "NextToken",
|
3216
|
+
# max_results: 1,
|
3217
|
+
# filters: [
|
3218
|
+
# {
|
3219
|
+
# key: "String", # required
|
3220
|
+
# value: "Arn", # required
|
3221
|
+
# condition: "IS", # required, accepts IS, IS_NOT
|
3222
|
+
# },
|
3223
|
+
# ],
|
3224
|
+
# })
|
3225
|
+
#
|
3226
|
+
# @example Response structure
|
3227
|
+
#
|
3228
|
+
# resp.explainability_exports #=> Array
|
3229
|
+
# resp.explainability_exports[0].explainability_export_arn #=> String
|
3230
|
+
# resp.explainability_exports[0].explainability_export_name #=> String
|
3231
|
+
# resp.explainability_exports[0].destination.s3_config.path #=> String
|
3232
|
+
# resp.explainability_exports[0].destination.s3_config.role_arn #=> String
|
3233
|
+
# resp.explainability_exports[0].destination.s3_config.kms_key_arn #=> String
|
3234
|
+
# resp.explainability_exports[0].status #=> String
|
3235
|
+
# resp.explainability_exports[0].message #=> String
|
3236
|
+
# resp.explainability_exports[0].creation_time #=> Time
|
3237
|
+
# resp.explainability_exports[0].last_modification_time #=> Time
|
3238
|
+
# resp.next_token #=> String
|
3239
|
+
#
|
3240
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/ListExplainabilityExports AWS API Documentation
|
3241
|
+
#
|
3242
|
+
# @overload list_explainability_exports(params = {})
|
3243
|
+
# @param [Hash] params ({})
|
3244
|
+
def list_explainability_exports(params = {}, options = {})
|
3245
|
+
req = build_request(:list_explainability_exports, params)
|
3246
|
+
req.send_request(options)
|
3247
|
+
end
|
3248
|
+
|
2366
3249
|
# Returns a list of forecast export jobs created using the
|
2367
3250
|
# CreateForecastExportJob operation. For each forecast export job, this
|
2368
3251
|
# operation returns a summary of its properties, including its Amazon
|
@@ -2513,6 +3396,7 @@ module Aws::ForecastService
|
|
2513
3396
|
# resp.forecasts[0].forecast_arn #=> String
|
2514
3397
|
# resp.forecasts[0].forecast_name #=> String
|
2515
3398
|
# resp.forecasts[0].predictor_arn #=> String
|
3399
|
+
# resp.forecasts[0].created_using_auto_predictor #=> Boolean
|
2516
3400
|
# resp.forecasts[0].dataset_group_arn #=> String
|
2517
3401
|
# resp.forecasts[0].status #=> String
|
2518
3402
|
# resp.forecasts[0].message #=> String
|
@@ -2609,12 +3493,13 @@ module Aws::ForecastService
|
|
2609
3493
|
req.send_request(options)
|
2610
3494
|
end
|
2611
3495
|
|
2612
|
-
# Returns a list of predictors created using the
|
2613
|
-
#
|
2614
|
-
# properties, including its Amazon Resource Name (ARN).
|
2615
|
-
#
|
2616
|
-
#
|
2617
|
-
#
|
3496
|
+
# Returns a list of predictors created using the CreateAutoPredictor or
|
3497
|
+
# CreatePredictor operations. For each predictor, this operation returns
|
3498
|
+
# a summary of its properties, including its Amazon Resource Name (ARN).
|
3499
|
+
#
|
3500
|
+
# You can retrieve the complete set of properties by using the ARN with
|
3501
|
+
# the DescribeAutoPredictor and DescribePredictor operations. You can
|
3502
|
+
# filter the list using an array of Filter objects.
|
2618
3503
|
#
|
2619
3504
|
# @option params [String] :next_token
|
2620
3505
|
# If the result of the previous request was truncated, the response
|
@@ -2675,6 +3560,9 @@ module Aws::ForecastService
|
|
2675
3560
|
# resp.predictors[0].predictor_arn #=> String
|
2676
3561
|
# resp.predictors[0].predictor_name #=> String
|
2677
3562
|
# resp.predictors[0].dataset_group_arn #=> String
|
3563
|
+
# resp.predictors[0].is_auto_predictor #=> Boolean
|
3564
|
+
# resp.predictors[0].reference_predictor_summary.arn #=> String
|
3565
|
+
# resp.predictors[0].reference_predictor_summary.state #=> String, one of "Active", "Deleted"
|
2678
3566
|
# resp.predictors[0].status #=> String
|
2679
3567
|
# resp.predictors[0].message #=> String
|
2680
3568
|
# resp.predictors[0].creation_time #=> Time
|
@@ -2694,9 +3582,7 @@ module Aws::ForecastService
|
|
2694
3582
|
#
|
2695
3583
|
# @option params [required, String] :resource_arn
|
2696
3584
|
# The Amazon Resource Name (ARN) that identifies the resource for which
|
2697
|
-
# to list the tags.
|
2698
|
-
# dataset groups, datasets, dataset import jobs, predictors, forecasts,
|
2699
|
-
# and forecast export jobs.
|
3585
|
+
# to list the tags.
|
2700
3586
|
#
|
2701
3587
|
# @return [Types::ListTagsForResourceResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2702
3588
|
#
|
@@ -2742,11 +3628,16 @@ module Aws::ForecastService
|
|
2742
3628
|
#
|
2743
3629
|
# * Predictor Backtest Export Job
|
2744
3630
|
#
|
3631
|
+
# * Explainability Job
|
3632
|
+
#
|
3633
|
+
# * Explainability Export Job
|
3634
|
+
#
|
2745
3635
|
# @option params [required, String] :resource_arn
|
2746
3636
|
# The Amazon Resource Name (ARN) that identifies the resource to stop.
|
2747
3637
|
# The supported ARNs are `DatasetImportJobArn`, `PredictorArn`,
|
2748
|
-
# `PredictorBacktestExportJobArn`, `ForecastArn`,
|
2749
|
-
# `ForecastExportJobArn
|
3638
|
+
# `PredictorBacktestExportJobArn`, `ForecastArn`,
|
3639
|
+
# `ForecastExportJobArn`, `ExplainabilityArn`, and
|
3640
|
+
# `ExplainabilityExportArn`.
|
2750
3641
|
#
|
2751
3642
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
2752
3643
|
#
|
@@ -2772,9 +3663,7 @@ module Aws::ForecastService
|
|
2772
3663
|
#
|
2773
3664
|
# @option params [required, String] :resource_arn
|
2774
3665
|
# The Amazon Resource Name (ARN) that identifies the resource for which
|
2775
|
-
# to list the tags.
|
2776
|
-
# dataset groups, datasets, dataset import jobs, predictors, forecasts,
|
2777
|
-
# and forecast export jobs.
|
3666
|
+
# to list the tags.
|
2778
3667
|
#
|
2779
3668
|
# @option params [required, Array<Types::Tag>] :tags
|
2780
3669
|
# The tags to add to the resource. A tag is an array of key-value pairs.
|
@@ -2833,9 +3722,7 @@ module Aws::ForecastService
|
|
2833
3722
|
#
|
2834
3723
|
# @option params [required, String] :resource_arn
|
2835
3724
|
# The Amazon Resource Name (ARN) that identifies the resource for which
|
2836
|
-
# to list the tags.
|
2837
|
-
# dataset groups, datasets, dataset import jobs, predictors, forecasts,
|
2838
|
-
# and forecast exports.
|
3725
|
+
# to list the tags.
|
2839
3726
|
#
|
2840
3727
|
# @option params [required, Array<String>] :tag_keys
|
2841
3728
|
# The keys of the tags to be removed.
|
@@ -2904,7 +3791,7 @@ module Aws::ForecastService
|
|
2904
3791
|
params: params,
|
2905
3792
|
config: config)
|
2906
3793
|
context[:gem_name] = 'aws-sdk-forecastservice'
|
2907
|
-
context[:gem_version] = '1.
|
3794
|
+
context[:gem_version] = '1.30.0'
|
2908
3795
|
Seahorse::Client::Request.new(handlers, context)
|
2909
3796
|
end
|
2910
3797
|
|