aws-sdk-forecastservice 1.24.0 → 1.28.0

Sign up to get free protection for your applications and to get access to all the features.
@@ -285,6 +285,15 @@ module Aws::ForecastService
285
285
  # ** Please note ** When response stubbing is enabled, no HTTP
286
286
  # requests are made, and retries are disabled.
287
287
  #
288
+ # @option options [Boolean] :use_dualstack_endpoint
289
+ # When set to `true`, dualstack enabled endpoints (with `.aws` TLD)
290
+ # will be used if available.
291
+ #
292
+ # @option options [Boolean] :use_fips_endpoint
293
+ # When set to `true`, fips compatible endpoints will be used if available.
294
+ # When a `fips` region is used, the region is normalized and this config
295
+ # is set to `true`.
296
+ #
288
297
  # @option options [Boolean] :validate_params (true)
289
298
  # When `true`, request parameters are validated before
290
299
  # sending the request.
@@ -337,6 +346,190 @@ module Aws::ForecastService
337
346
 
338
347
  # @!group API Operations
339
348
 
349
+ # Creates an Amazon Forecast predictor.
350
+ #
351
+ # Amazon Forecast creates predictors with AutoPredictor, which involves
352
+ # applying the optimal combination of algorithms to each time series in
353
+ # your datasets. You can use CreateAutoPredictor to create new
354
+ # predictors or upgrade/retrain existing predictors.
355
+ #
356
+ # **Creating new predictors**
357
+ #
358
+ # The following parameters are required when creating a new predictor:
359
+ #
360
+ # * `PredictorName` - A unique name for the predictor.
361
+ #
362
+ # * `DatasetGroupArn` - The ARN of the dataset group used to train the
363
+ # predictor.
364
+ #
365
+ # * `ForecastFrequency` - The granularity of your forecasts (hourly,
366
+ # daily, weekly, etc).
367
+ #
368
+ # * `ForecastHorizon` - The number of time steps being forecasted.
369
+ #
370
+ # When creating a new predictor, do not specify a value for
371
+ # `ReferencePredictorArn`.
372
+ #
373
+ # **Upgrading and retraining predictors**
374
+ #
375
+ # The following parameters are required when retraining or upgrading a
376
+ # predictor:
377
+ #
378
+ # * `PredictorName` - A unique name for the predictor.
379
+ #
380
+ # * `ReferencePredictorArn` - The ARN of the predictor to retrain or
381
+ # upgrade.
382
+ #
383
+ # When upgrading or retraining a predictor, only specify values for the
384
+ # `ReferencePredictorArn` and `PredictorName`.
385
+ #
386
+ # @option params [required, String] :predictor_name
387
+ # A unique name for the predictor
388
+ #
389
+ # @option params [Integer] :forecast_horizon
390
+ # The number of time-steps that the model predicts. The forecast horizon
391
+ # is also called the prediction length.
392
+ #
393
+ # @option params [Array<String>] :forecast_types
394
+ # The forecast types used to train a predictor. You can specify up to
395
+ # five forecast types. Forecast types can be quantiles from 0.01 to
396
+ # 0.99, by increments of 0.01 or higher. You can also specify the mean
397
+ # forecast with `mean`.
398
+ #
399
+ # @option params [Array<String>] :forecast_dimensions
400
+ # An array of dimension (field) names that specify how to group the
401
+ # generated forecast.
402
+ #
403
+ # For example, if you are generating forecasts for item sales across all
404
+ # your stores, and your dataset contains a `store_id` field, you would
405
+ # specify `store_id` as a dimension to group sales forecasts for each
406
+ # store.
407
+ #
408
+ # @option params [String] :forecast_frequency
409
+ # The frequency of predictions in a forecast.
410
+ #
411
+ # Valid intervals are Y (Year), M (Month), W (Week), D (Day), H (Hour),
412
+ # 30min (30 minutes), 15min (15 minutes), 10min (10 minutes), 5min (5
413
+ # minutes), and 1min (1 minute). For example, "Y" indicates every year
414
+ # and "5min" indicates every five minutes.
415
+ #
416
+ # The frequency must be greater than or equal to the
417
+ # TARGET\_TIME\_SERIES dataset frequency.
418
+ #
419
+ # When a RELATED\_TIME\_SERIES dataset is provided, the frequency must
420
+ # be equal to the RELATED\_TIME\_SERIES dataset frequency.
421
+ #
422
+ # @option params [Types::DataConfig] :data_config
423
+ # The data configuration for your dataset group and any additional
424
+ # datasets.
425
+ #
426
+ # @option params [Types::EncryptionConfig] :encryption_config
427
+ # An AWS Key Management Service (KMS) key and an AWS Identity and Access
428
+ # Management (IAM) role that Amazon Forecast can assume to access the
429
+ # key. You can specify this optional object in the CreateDataset and
430
+ # CreatePredictor requests.
431
+ #
432
+ # @option params [String] :reference_predictor_arn
433
+ # The ARN of the predictor to retrain or upgrade. This parameter is only
434
+ # used when retraining or upgrading a predictor. When creating a new
435
+ # predictor, do not specify a value for this parameter.
436
+ #
437
+ # When upgrading or retraining a predictor, only specify values for the
438
+ # `ReferencePredictorArn` and `PredictorName`. The value for
439
+ # `PredictorName` must be a unique predictor name.
440
+ #
441
+ # @option params [String] :optimization_metric
442
+ # The accuracy metric used to optimize the predictor.
443
+ #
444
+ # @option params [Boolean] :explain_predictor
445
+ #
446
+ # @option params [Array<Types::Tag>] :tags
447
+ # Optional metadata to help you categorize and organize your predictors.
448
+ # Each tag consists of a key and an optional value, both of which you
449
+ # define. Tag keys and values are case sensitive.
450
+ #
451
+ # The following restrictions apply to tags:
452
+ #
453
+ # * For each resource, each tag key must be unique and each tag key must
454
+ # have one value.
455
+ #
456
+ # * Maximum number of tags per resource: 50.
457
+ #
458
+ # * Maximum key length: 128 Unicode characters in UTF-8.
459
+ #
460
+ # * Maximum value length: 256 Unicode characters in UTF-8.
461
+ #
462
+ # * Accepted characters: all letters and numbers, spaces representable
463
+ # in UTF-8, and + - = . \_ : / @. If your tagging schema is used
464
+ # across other services and resources, the character restrictions of
465
+ # those services also apply.
466
+ #
467
+ # * Key prefixes cannot include any upper or lowercase combination of
468
+ # `aws:` or `AWS:`. Values can have this prefix. If a tag value has
469
+ # `aws` as its prefix but the key does not, Forecast considers it to
470
+ # be a user tag and will count against the limit of 50 tags. Tags with
471
+ # only the key prefix of `aws` do not count against your tags per
472
+ # resource limit. You cannot edit or delete tag keys with this prefix.
473
+ #
474
+ # @return [Types::CreateAutoPredictorResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
475
+ #
476
+ # * {Types::CreateAutoPredictorResponse#predictor_arn #predictor_arn} => String
477
+ #
478
+ # @example Request syntax with placeholder values
479
+ #
480
+ # resp = client.create_auto_predictor({
481
+ # predictor_name: "Name", # required
482
+ # forecast_horizon: 1,
483
+ # forecast_types: ["ForecastType"],
484
+ # forecast_dimensions: ["Name"],
485
+ # forecast_frequency: "Frequency",
486
+ # data_config: {
487
+ # dataset_group_arn: "Arn", # required
488
+ # attribute_configs: [
489
+ # {
490
+ # attribute_name: "Name", # required
491
+ # transformations: { # required
492
+ # "Name" => "Value",
493
+ # },
494
+ # },
495
+ # ],
496
+ # additional_datasets: [
497
+ # {
498
+ # name: "Name", # required
499
+ # configuration: {
500
+ # "Name" => ["Value"],
501
+ # },
502
+ # },
503
+ # ],
504
+ # },
505
+ # encryption_config: {
506
+ # role_arn: "Arn", # required
507
+ # kms_key_arn: "KMSKeyArn", # required
508
+ # },
509
+ # reference_predictor_arn: "Arn",
510
+ # optimization_metric: "WAPE", # accepts WAPE, RMSE, AverageWeightedQuantileLoss, MASE, MAPE
511
+ # explain_predictor: false,
512
+ # tags: [
513
+ # {
514
+ # key: "TagKey", # required
515
+ # value: "TagValue", # required
516
+ # },
517
+ # ],
518
+ # })
519
+ #
520
+ # @example Response structure
521
+ #
522
+ # resp.predictor_arn #=> String
523
+ #
524
+ # @see http://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/CreateAutoPredictor AWS API Documentation
525
+ #
526
+ # @overload create_auto_predictor(params = {})
527
+ # @param [Hash] params ({})
528
+ def create_auto_predictor(params = {}, options = {})
529
+ req = build_request(:create_auto_predictor, params)
530
+ req.send_request(options)
531
+ end
532
+
340
533
  # Creates an Amazon Forecast dataset. The information about the dataset
341
534
  # that you provide helps Forecast understand how to consume the data for
342
535
  # model training. This includes the following:
@@ -753,6 +946,293 @@ module Aws::ForecastService
753
946
  req.send_request(options)
754
947
  end
755
948
 
949
+ # <note markdown="1"> Explainability is only available for Forecasts and Predictors
950
+ # generated from an AutoPredictor (CreateAutoPredictor)
951
+ #
952
+ # </note>
953
+ #
954
+ # Creates an Amazon Forecast Explainability.
955
+ #
956
+ # Explainability helps you better understand how the attributes in your
957
+ # datasets impact forecast. Amazon Forecast uses a metric called Impact
958
+ # scores to quantify the relative impact of each attribute and determine
959
+ # whether they increase or decrease forecast values.
960
+ #
961
+ # To enable Forecast Explainability, your predictor must include at
962
+ # least one of the following: related time series, item metadata, or
963
+ # additional datasets like Holidays and the Weather Index.
964
+ #
965
+ # CreateExplainability accepts either a Predictor ARN or Forecast ARN.
966
+ # To receive aggregated Impact scores for all time series and time
967
+ # points in your datasets, provide a Predictor ARN. To receive Impact
968
+ # scores for specific time series and time points, provide a Forecast
969
+ # ARN.
970
+ #
971
+ # **CreateExplainability with a Predictor ARN**
972
+ #
973
+ # <note markdown="1"> You can only have one Explainability resource per predictor. If you
974
+ # already enabled `ExplainPredictor` in CreateAutoPredictor, that
975
+ # predictor already has an Explainability resource.
976
+ #
977
+ # </note>
978
+ #
979
+ # The following parameters are required when providing a Predictor ARN:
980
+ #
981
+ # * `ExplainabilityName` - A unique name for the Explainability.
982
+ #
983
+ # * `ResourceArn` - The Arn of the predictor.
984
+ #
985
+ # * `TimePointGranularity` - Must be set to “ALL”.
986
+ #
987
+ # * `TimeSeriesGranularity` - Must be set to “ALL”.
988
+ #
989
+ # Do not specify a value for the following parameters:
990
+ #
991
+ # * `DataSource` - Only valid when TimeSeriesGranularity is “SPECIFIC”.
992
+ #
993
+ # * `Schema` - Only valid when TimeSeriesGranularity is “SPECIFIC”.
994
+ #
995
+ # * `StartDateTime` - Only valid when TimePointGranularity is
996
+ # “SPECIFIC”.
997
+ #
998
+ # * `EndDateTime` - Only valid when TimePointGranularity is “SPECIFIC”.
999
+ #
1000
+ # **CreateExplainability with a Forecast ARN**
1001
+ #
1002
+ # <note markdown="1"> You can specify a maximum of 50 time series and 1500 time points.
1003
+ #
1004
+ # </note>
1005
+ #
1006
+ # The following parameters are required when providing a Predictor ARN:
1007
+ #
1008
+ # * `ExplainabilityName` - A unique name for the Explainability.
1009
+ #
1010
+ # * `ResourceArn` - The Arn of the forecast.
1011
+ #
1012
+ # * `TimePointGranularity` - Either “ALL” or “SPECIFIC”.
1013
+ #
1014
+ # * `TimeSeriesGranularity` - Either “ALL” or “SPECIFIC”.
1015
+ #
1016
+ # If you set TimeSeriesGranularity to “SPECIFIC”, you must also provide
1017
+ # the following:
1018
+ #
1019
+ # * `DataSource` - The S3 location of the CSV file specifying your time
1020
+ # series.
1021
+ #
1022
+ # * `Schema` - The Schema defines the attributes and attribute types
1023
+ # listed in the Data Source.
1024
+ #
1025
+ # If you set TimePointGranularity to “SPECIFIC”, you must also provide
1026
+ # the following:
1027
+ #
1028
+ # * `StartDateTime` - The first timestamp in the range of time points.
1029
+ #
1030
+ # * `EndDateTime` - The last timestamp in the range of time points.
1031
+ #
1032
+ # @option params [required, String] :explainability_name
1033
+ # A unique name for the Explainability.
1034
+ #
1035
+ # @option params [required, String] :resource_arn
1036
+ # The Amazon Resource Name (ARN) of the Predictor or Forecast used to
1037
+ # create the Explainability.
1038
+ #
1039
+ # @option params [required, Types::ExplainabilityConfig] :explainability_config
1040
+ # The configuration settings that define the granularity of time series
1041
+ # and time points for the Explainability.
1042
+ #
1043
+ # @option params [Types::DataSource] :data_source
1044
+ # The source of your training data, an AWS Identity and Access
1045
+ # Management (IAM) role that allows Amazon Forecast to access the data
1046
+ # and, optionally, an AWS Key Management Service (KMS) key. This object
1047
+ # is submitted in the CreateDatasetImportJob request.
1048
+ #
1049
+ # @option params [Types::Schema] :schema
1050
+ # Defines the fields of a dataset. You specify this object in the
1051
+ # CreateDataset request.
1052
+ #
1053
+ # @option params [Boolean] :enable_visualization
1054
+ # Create an Expainability visualization that is viewable within the AWS
1055
+ # console.
1056
+ #
1057
+ # @option params [String] :start_date_time
1058
+ # If `TimePointGranularity` is set to `SPECIFIC`, define the first point
1059
+ # for the Explainability.
1060
+ #
1061
+ # @option params [String] :end_date_time
1062
+ # If `TimePointGranularity` is set to `SPECIFIC`, define the last time
1063
+ # point for the Explainability.
1064
+ #
1065
+ # @option params [Array<Types::Tag>] :tags
1066
+ # Optional metadata to help you categorize and organize your resources.
1067
+ # Each tag consists of a key and an optional value, both of which you
1068
+ # define. Tag keys and values are case sensitive.
1069
+ #
1070
+ # The following restrictions apply to tags:
1071
+ #
1072
+ # * For each resource, each tag key must be unique and each tag key must
1073
+ # have one value.
1074
+ #
1075
+ # * Maximum number of tags per resource: 50.
1076
+ #
1077
+ # * Maximum key length: 128 Unicode characters in UTF-8.
1078
+ #
1079
+ # * Maximum value length: 256 Unicode characters in UTF-8.
1080
+ #
1081
+ # * Accepted characters: all letters and numbers, spaces representable
1082
+ # in UTF-8, and + - = . \_ : / @. If your tagging schema is used
1083
+ # across other services and resources, the character restrictions of
1084
+ # those services also apply.
1085
+ #
1086
+ # * Key prefixes cannot include any upper or lowercase combination of
1087
+ # `aws:` or `AWS:`. Values can have this prefix. If a tag value has
1088
+ # `aws` as its prefix but the key does not, Forecast considers it to
1089
+ # be a user tag and will count against the limit of 50 tags. Tags with
1090
+ # only the key prefix of `aws` do not count against your tags per
1091
+ # resource limit. You cannot edit or delete tag keys with this prefix.
1092
+ #
1093
+ # @return [Types::CreateExplainabilityResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1094
+ #
1095
+ # * {Types::CreateExplainabilityResponse#explainability_arn #explainability_arn} => String
1096
+ #
1097
+ # @example Request syntax with placeholder values
1098
+ #
1099
+ # resp = client.create_explainability({
1100
+ # explainability_name: "Name", # required
1101
+ # resource_arn: "Arn", # required
1102
+ # explainability_config: { # required
1103
+ # time_series_granularity: "ALL", # required, accepts ALL, SPECIFIC
1104
+ # time_point_granularity: "ALL", # required, accepts ALL, SPECIFIC
1105
+ # },
1106
+ # data_source: {
1107
+ # s3_config: { # required
1108
+ # path: "S3Path", # required
1109
+ # role_arn: "Arn", # required
1110
+ # kms_key_arn: "KMSKeyArn",
1111
+ # },
1112
+ # },
1113
+ # schema: {
1114
+ # attributes: [
1115
+ # {
1116
+ # attribute_name: "Name",
1117
+ # attribute_type: "string", # accepts string, integer, float, timestamp, geolocation
1118
+ # },
1119
+ # ],
1120
+ # },
1121
+ # enable_visualization: false,
1122
+ # start_date_time: "LocalDateTime",
1123
+ # end_date_time: "LocalDateTime",
1124
+ # tags: [
1125
+ # {
1126
+ # key: "TagKey", # required
1127
+ # value: "TagValue", # required
1128
+ # },
1129
+ # ],
1130
+ # })
1131
+ #
1132
+ # @example Response structure
1133
+ #
1134
+ # resp.explainability_arn #=> String
1135
+ #
1136
+ # @see http://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/CreateExplainability AWS API Documentation
1137
+ #
1138
+ # @overload create_explainability(params = {})
1139
+ # @param [Hash] params ({})
1140
+ def create_explainability(params = {}, options = {})
1141
+ req = build_request(:create_explainability, params)
1142
+ req.send_request(options)
1143
+ end
1144
+
1145
+ # Exports an Explainability resource created by the CreateExplainability
1146
+ # operation. Exported files are exported to an Amazon Simple Storage
1147
+ # Service (Amazon S3) bucket.
1148
+ #
1149
+ # You must specify a DataDestination object that includes an Amazon S3
1150
+ # bucket and an AWS Identity and Access Management (IAM) role that
1151
+ # Amazon Forecast can assume to access the Amazon S3 bucket. For more
1152
+ # information, see aws-forecast-iam-roles.
1153
+ #
1154
+ # <note markdown="1"> The `Status` of the export job must be `ACTIVE` before you can access
1155
+ # the export in your Amazon S3 bucket. To get the status, use the
1156
+ # DescribeExplainabilityExport operation.
1157
+ #
1158
+ # </note>
1159
+ #
1160
+ # @option params [required, String] :explainability_export_name
1161
+ # A unique name for the Explainability export.
1162
+ #
1163
+ # @option params [required, String] :explainability_arn
1164
+ # The Amazon Resource Name (ARN) of the Explainability to export.
1165
+ #
1166
+ # @option params [required, Types::DataDestination] :destination
1167
+ # The destination for an export job. Provide an S3 path, an AWS Identity
1168
+ # and Access Management (IAM) role that allows Amazon Forecast to access
1169
+ # the location, and an AWS Key Management Service (KMS) key (optional).
1170
+ #
1171
+ # @option params [Array<Types::Tag>] :tags
1172
+ # Optional metadata to help you categorize and organize your resources.
1173
+ # Each tag consists of a key and an optional value, both of which you
1174
+ # define. Tag keys and values are case sensitive.
1175
+ #
1176
+ # The following restrictions apply to tags:
1177
+ #
1178
+ # * For each resource, each tag key must be unique and each tag key must
1179
+ # have one value.
1180
+ #
1181
+ # * Maximum number of tags per resource: 50.
1182
+ #
1183
+ # * Maximum key length: 128 Unicode characters in UTF-8.
1184
+ #
1185
+ # * Maximum value length: 256 Unicode characters in UTF-8.
1186
+ #
1187
+ # * Accepted characters: all letters and numbers, spaces representable
1188
+ # in UTF-8, and + - = . \_ : / @. If your tagging schema is used
1189
+ # across other services and resources, the character restrictions of
1190
+ # those services also apply.
1191
+ #
1192
+ # * Key prefixes cannot include any upper or lowercase combination of
1193
+ # `aws:` or `AWS:`. Values can have this prefix. If a tag value has
1194
+ # `aws` as its prefix but the key does not, Forecast considers it to
1195
+ # be a user tag and will count against the limit of 50 tags. Tags with
1196
+ # only the key prefix of `aws` do not count against your tags per
1197
+ # resource limit. You cannot edit or delete tag keys with this prefix.
1198
+ #
1199
+ # @return [Types::CreateExplainabilityExportResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1200
+ #
1201
+ # * {Types::CreateExplainabilityExportResponse#explainability_export_arn #explainability_export_arn} => String
1202
+ #
1203
+ # @example Request syntax with placeholder values
1204
+ #
1205
+ # resp = client.create_explainability_export({
1206
+ # explainability_export_name: "Name", # required
1207
+ # explainability_arn: "Arn", # required
1208
+ # destination: { # required
1209
+ # s3_config: { # required
1210
+ # path: "S3Path", # required
1211
+ # role_arn: "Arn", # required
1212
+ # kms_key_arn: "KMSKeyArn",
1213
+ # },
1214
+ # },
1215
+ # tags: [
1216
+ # {
1217
+ # key: "TagKey", # required
1218
+ # value: "TagValue", # required
1219
+ # },
1220
+ # ],
1221
+ # })
1222
+ #
1223
+ # @example Response structure
1224
+ #
1225
+ # resp.explainability_export_arn #=> String
1226
+ #
1227
+ # @see http://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/CreateExplainabilityExport AWS API Documentation
1228
+ #
1229
+ # @overload create_explainability_export(params = {})
1230
+ # @param [Hash] params ({})
1231
+ def create_explainability_export(params = {}, options = {})
1232
+ req = build_request(:create_explainability_export, params)
1233
+ req.send_request(options)
1234
+ end
1235
+
756
1236
  # Creates a forecast for each item in the `TARGET_TIME_SERIES` dataset
757
1237
  # that was used to train the predictor. This is known as inference. To
758
1238
  # retrieve the forecast for a single item at low latency, use the
@@ -969,6 +1449,13 @@ module Aws::ForecastService
969
1449
  req.send_request(options)
970
1450
  end
971
1451
 
1452
+ # <note markdown="1"> This operation creates a legacy predictor that does not include all
1453
+ # the predictor functionalities provided by Amazon Forecast. To create a
1454
+ # predictor that is compatible with all aspects of Forecast, use
1455
+ # CreateAutoPredictor.
1456
+ #
1457
+ # </note>
1458
+ #
972
1459
  # Creates an Amazon Forecast predictor.
973
1460
  #
974
1461
  # In the request, provide a dataset group and either specify an
@@ -1078,6 +1565,12 @@ module Aws::ForecastService
1078
1565
  # for your training data. In this case, `PerformHPO` must be false.
1079
1566
  #
1080
1567
  # @option params [String] :auto_ml_override_strategy
1568
+ # <note markdown="1"> The `LatencyOptimized` AutoML override strategy is only available in
1569
+ # private beta. Contact AWS Support or your account manager to learn
1570
+ # more about access privileges.
1571
+ #
1572
+ # </note>
1573
+ #
1081
1574
  # Used to overide the default AutoML strategy, which is to optimize
1082
1575
  # predictor accuracy. To apply an AutoML strategy that minimizes
1083
1576
  # training time, use `LatencyOptimized`.
@@ -1171,6 +1664,9 @@ module Aws::ForecastService
1171
1664
  # the limit of 50 tags. Tags with only the key prefix of `aws` do not
1172
1665
  # count against your tags per resource limit.
1173
1666
  #
1667
+ # @option params [String] :optimization_metric
1668
+ # The accuracy metric used to optimize the predictor.
1669
+ #
1174
1670
  # @return [Types::CreatePredictorResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1175
1671
  #
1176
1672
  # * {Types::CreatePredictorResponse#predictor_arn #predictor_arn} => String
@@ -1183,7 +1679,7 @@ module Aws::ForecastService
1183
1679
  # forecast_horizon: 1, # required
1184
1680
  # forecast_types: ["ForecastType"],
1185
1681
  # perform_auto_ml: false,
1186
- # auto_ml_override_strategy: "LatencyOptimized", # accepts LatencyOptimized
1682
+ # auto_ml_override_strategy: "LatencyOptimized", # accepts LatencyOptimized, AccuracyOptimized
1187
1683
  # perform_hpo: false,
1188
1684
  # training_parameters: {
1189
1685
  # "ParameterKey" => "ParameterValue",
@@ -1254,6 +1750,7 @@ module Aws::ForecastService
1254
1750
  # value: "TagValue", # required
1255
1751
  # },
1256
1752
  # ],
1753
+ # optimization_metric: "WAPE", # accepts WAPE, RMSE, AverageWeightedQuantileLoss, MASE, MAPE
1257
1754
  # })
1258
1755
  #
1259
1756
  # @example Response structure
@@ -1452,6 +1949,55 @@ module Aws::ForecastService
1452
1949
  req.send_request(options)
1453
1950
  end
1454
1951
 
1952
+ # Deletes an Explainability resource.
1953
+ #
1954
+ # You can delete only predictor that have a status of `ACTIVE` or
1955
+ # `CREATE_FAILED`. To get the status, use the DescribeExplainability
1956
+ # operation.
1957
+ #
1958
+ # @option params [required, String] :explainability_arn
1959
+ # The Amazon Resource Name (ARN) of the Explainability resource to
1960
+ # delete.
1961
+ #
1962
+ # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
1963
+ #
1964
+ # @example Request syntax with placeholder values
1965
+ #
1966
+ # resp = client.delete_explainability({
1967
+ # explainability_arn: "Arn", # required
1968
+ # })
1969
+ #
1970
+ # @see http://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/DeleteExplainability AWS API Documentation
1971
+ #
1972
+ # @overload delete_explainability(params = {})
1973
+ # @param [Hash] params ({})
1974
+ def delete_explainability(params = {}, options = {})
1975
+ req = build_request(:delete_explainability, params)
1976
+ req.send_request(options)
1977
+ end
1978
+
1979
+ # Deletes an Explainability export job.
1980
+ #
1981
+ # @option params [required, String] :explainability_export_arn
1982
+ # The Amazon Resource Name (ARN) of the Explainability export to delete.
1983
+ #
1984
+ # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
1985
+ #
1986
+ # @example Request syntax with placeholder values
1987
+ #
1988
+ # resp = client.delete_explainability_export({
1989
+ # explainability_export_arn: "Arn", # required
1990
+ # })
1991
+ #
1992
+ # @see http://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/DeleteExplainabilityExport AWS API Documentation
1993
+ #
1994
+ # @overload delete_explainability_export(params = {})
1995
+ # @param [Hash] params ({})
1996
+ def delete_explainability_export(params = {}, options = {})
1997
+ req = build_request(:delete_explainability_export, params)
1998
+ req.send_request(options)
1999
+ end
2000
+
1455
2001
  # Deletes a forecast created using the CreateForecast operation. You can
1456
2002
  # delete only forecasts that have a status of `ACTIVE` or
1457
2003
  # `CREATE_FAILED`. To get the status, use the DescribeForecast
@@ -1600,6 +2146,78 @@ module Aws::ForecastService
1600
2146
  req.send_request(options)
1601
2147
  end
1602
2148
 
2149
+ # Describes a predictor created using the CreateAutoPredictor operation.
2150
+ #
2151
+ # @option params [required, String] :predictor_arn
2152
+ # The Amazon Resource Name (ARN) of the predictor.
2153
+ #
2154
+ # @return [Types::DescribeAutoPredictorResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
2155
+ #
2156
+ # * {Types::DescribeAutoPredictorResponse#predictor_arn #predictor_arn} => String
2157
+ # * {Types::DescribeAutoPredictorResponse#predictor_name #predictor_name} => String
2158
+ # * {Types::DescribeAutoPredictorResponse#forecast_horizon #forecast_horizon} => Integer
2159
+ # * {Types::DescribeAutoPredictorResponse#forecast_types #forecast_types} => Array&lt;String&gt;
2160
+ # * {Types::DescribeAutoPredictorResponse#forecast_frequency #forecast_frequency} => String
2161
+ # * {Types::DescribeAutoPredictorResponse#dataset_import_job_arns #dataset_import_job_arns} => Array&lt;String&gt;
2162
+ # * {Types::DescribeAutoPredictorResponse#data_config #data_config} => Types::DataConfig
2163
+ # * {Types::DescribeAutoPredictorResponse#encryption_config #encryption_config} => Types::EncryptionConfig
2164
+ # * {Types::DescribeAutoPredictorResponse#reference_predictor_summary #reference_predictor_summary} => Types::ReferencePredictorSummary
2165
+ # * {Types::DescribeAutoPredictorResponse#estimated_time_remaining_in_minutes #estimated_time_remaining_in_minutes} => Integer
2166
+ # * {Types::DescribeAutoPredictorResponse#status #status} => String
2167
+ # * {Types::DescribeAutoPredictorResponse#message #message} => String
2168
+ # * {Types::DescribeAutoPredictorResponse#creation_time #creation_time} => Time
2169
+ # * {Types::DescribeAutoPredictorResponse#last_modification_time #last_modification_time} => Time
2170
+ # * {Types::DescribeAutoPredictorResponse#optimization_metric #optimization_metric} => String
2171
+ # * {Types::DescribeAutoPredictorResponse#explainability_info #explainability_info} => Types::ExplainabilityInfo
2172
+ #
2173
+ # @example Request syntax with placeholder values
2174
+ #
2175
+ # resp = client.describe_auto_predictor({
2176
+ # predictor_arn: "Arn", # required
2177
+ # })
2178
+ #
2179
+ # @example Response structure
2180
+ #
2181
+ # resp.predictor_arn #=> String
2182
+ # resp.predictor_name #=> String
2183
+ # resp.forecast_horizon #=> Integer
2184
+ # resp.forecast_types #=> Array
2185
+ # resp.forecast_types[0] #=> String
2186
+ # resp.forecast_frequency #=> String
2187
+ # resp.dataset_import_job_arns #=> Array
2188
+ # resp.dataset_import_job_arns[0] #=> String
2189
+ # resp.data_config.dataset_group_arn #=> String
2190
+ # resp.data_config.attribute_configs #=> Array
2191
+ # resp.data_config.attribute_configs[0].attribute_name #=> String
2192
+ # resp.data_config.attribute_configs[0].transformations #=> Hash
2193
+ # resp.data_config.attribute_configs[0].transformations["Name"] #=> String
2194
+ # resp.data_config.additional_datasets #=> Array
2195
+ # resp.data_config.additional_datasets[0].name #=> String
2196
+ # resp.data_config.additional_datasets[0].configuration #=> Hash
2197
+ # resp.data_config.additional_datasets[0].configuration["Name"] #=> Array
2198
+ # resp.data_config.additional_datasets[0].configuration["Name"][0] #=> String
2199
+ # resp.encryption_config.role_arn #=> String
2200
+ # resp.encryption_config.kms_key_arn #=> String
2201
+ # resp.reference_predictor_summary.arn #=> String
2202
+ # resp.reference_predictor_summary.state #=> String, one of "Active", "Deleted"
2203
+ # resp.estimated_time_remaining_in_minutes #=> Integer
2204
+ # resp.status #=> String
2205
+ # resp.message #=> String
2206
+ # resp.creation_time #=> Time
2207
+ # resp.last_modification_time #=> Time
2208
+ # resp.optimization_metric #=> String, one of "WAPE", "RMSE", "AverageWeightedQuantileLoss", "MASE", "MAPE"
2209
+ # resp.explainability_info.explainability_arn #=> String
2210
+ # resp.explainability_info.status #=> String
2211
+ #
2212
+ # @see http://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/DescribeAutoPredictor AWS API Documentation
2213
+ #
2214
+ # @overload describe_auto_predictor(params = {})
2215
+ # @param [Hash] params ({})
2216
+ def describe_auto_predictor(params = {}, options = {})
2217
+ req = build_request(:describe_auto_predictor, params)
2218
+ req.send_request(options)
2219
+ end
2220
+
1603
2221
  # Describes an Amazon Forecast dataset created using the CreateDataset
1604
2222
  # operation.
1605
2223
  #
@@ -1800,6 +2418,111 @@ module Aws::ForecastService
1800
2418
  req.send_request(options)
1801
2419
  end
1802
2420
 
2421
+ # Describes an Explainability resource created using the
2422
+ # CreateExplainability operation.
2423
+ #
2424
+ # @option params [required, String] :explainability_arn
2425
+ # The Amazon Resource Name (ARN) of the Explaianability to describe.
2426
+ #
2427
+ # @return [Types::DescribeExplainabilityResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
2428
+ #
2429
+ # * {Types::DescribeExplainabilityResponse#explainability_arn #explainability_arn} => String
2430
+ # * {Types::DescribeExplainabilityResponse#explainability_name #explainability_name} => String
2431
+ # * {Types::DescribeExplainabilityResponse#resource_arn #resource_arn} => String
2432
+ # * {Types::DescribeExplainabilityResponse#explainability_config #explainability_config} => Types::ExplainabilityConfig
2433
+ # * {Types::DescribeExplainabilityResponse#enable_visualization #enable_visualization} => Boolean
2434
+ # * {Types::DescribeExplainabilityResponse#data_source #data_source} => Types::DataSource
2435
+ # * {Types::DescribeExplainabilityResponse#schema #schema} => Types::Schema
2436
+ # * {Types::DescribeExplainabilityResponse#start_date_time #start_date_time} => String
2437
+ # * {Types::DescribeExplainabilityResponse#end_date_time #end_date_time} => String
2438
+ # * {Types::DescribeExplainabilityResponse#estimated_time_remaining_in_minutes #estimated_time_remaining_in_minutes} => Integer
2439
+ # * {Types::DescribeExplainabilityResponse#message #message} => String
2440
+ # * {Types::DescribeExplainabilityResponse#status #status} => String
2441
+ # * {Types::DescribeExplainabilityResponse#creation_time #creation_time} => Time
2442
+ # * {Types::DescribeExplainabilityResponse#last_modification_time #last_modification_time} => Time
2443
+ #
2444
+ # @example Request syntax with placeholder values
2445
+ #
2446
+ # resp = client.describe_explainability({
2447
+ # explainability_arn: "Arn", # required
2448
+ # })
2449
+ #
2450
+ # @example Response structure
2451
+ #
2452
+ # resp.explainability_arn #=> String
2453
+ # resp.explainability_name #=> String
2454
+ # resp.resource_arn #=> String
2455
+ # resp.explainability_config.time_series_granularity #=> String, one of "ALL", "SPECIFIC"
2456
+ # resp.explainability_config.time_point_granularity #=> String, one of "ALL", "SPECIFIC"
2457
+ # resp.enable_visualization #=> Boolean
2458
+ # resp.data_source.s3_config.path #=> String
2459
+ # resp.data_source.s3_config.role_arn #=> String
2460
+ # resp.data_source.s3_config.kms_key_arn #=> String
2461
+ # resp.schema.attributes #=> Array
2462
+ # resp.schema.attributes[0].attribute_name #=> String
2463
+ # resp.schema.attributes[0].attribute_type #=> String, one of "string", "integer", "float", "timestamp", "geolocation"
2464
+ # resp.start_date_time #=> String
2465
+ # resp.end_date_time #=> String
2466
+ # resp.estimated_time_remaining_in_minutes #=> Integer
2467
+ # resp.message #=> String
2468
+ # resp.status #=> String
2469
+ # resp.creation_time #=> Time
2470
+ # resp.last_modification_time #=> Time
2471
+ #
2472
+ # @see http://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/DescribeExplainability AWS API Documentation
2473
+ #
2474
+ # @overload describe_explainability(params = {})
2475
+ # @param [Hash] params ({})
2476
+ def describe_explainability(params = {}, options = {})
2477
+ req = build_request(:describe_explainability, params)
2478
+ req.send_request(options)
2479
+ end
2480
+
2481
+ # Describes an Explainability export created using the
2482
+ # CreateExplainabilityExport operation.
2483
+ #
2484
+ # @option params [required, String] :explainability_export_arn
2485
+ # The Amazon Resource Name (ARN) of the Explainability export.
2486
+ #
2487
+ # @return [Types::DescribeExplainabilityExportResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
2488
+ #
2489
+ # * {Types::DescribeExplainabilityExportResponse#explainability_export_arn #explainability_export_arn} => String
2490
+ # * {Types::DescribeExplainabilityExportResponse#explainability_export_name #explainability_export_name} => String
2491
+ # * {Types::DescribeExplainabilityExportResponse#explainability_arn #explainability_arn} => String
2492
+ # * {Types::DescribeExplainabilityExportResponse#destination #destination} => Types::DataDestination
2493
+ # * {Types::DescribeExplainabilityExportResponse#message #message} => String
2494
+ # * {Types::DescribeExplainabilityExportResponse#status #status} => String
2495
+ # * {Types::DescribeExplainabilityExportResponse#creation_time #creation_time} => Time
2496
+ # * {Types::DescribeExplainabilityExportResponse#last_modification_time #last_modification_time} => Time
2497
+ #
2498
+ # @example Request syntax with placeholder values
2499
+ #
2500
+ # resp = client.describe_explainability_export({
2501
+ # explainability_export_arn: "Arn", # required
2502
+ # })
2503
+ #
2504
+ # @example Response structure
2505
+ #
2506
+ # resp.explainability_export_arn #=> String
2507
+ # resp.explainability_export_name #=> String
2508
+ # resp.explainability_arn #=> String
2509
+ # resp.destination.s3_config.path #=> String
2510
+ # resp.destination.s3_config.role_arn #=> String
2511
+ # resp.destination.s3_config.kms_key_arn #=> String
2512
+ # resp.message #=> String
2513
+ # resp.status #=> String
2514
+ # resp.creation_time #=> Time
2515
+ # resp.last_modification_time #=> Time
2516
+ #
2517
+ # @see http://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/DescribeExplainabilityExport AWS API Documentation
2518
+ #
2519
+ # @overload describe_explainability_export(params = {})
2520
+ # @param [Hash] params ({})
2521
+ def describe_explainability_export(params = {}, options = {})
2522
+ req = build_request(:describe_explainability_export, params)
2523
+ req.send_request(options)
2524
+ end
2525
+
1803
2526
  # Describes a forecast created using the CreateForecast operation.
1804
2527
  #
1805
2528
  # In addition to listing the properties provided in the `CreateForecast`
@@ -1918,6 +2641,15 @@ module Aws::ForecastService
1918
2641
  req.send_request(options)
1919
2642
  end
1920
2643
 
2644
+ # <note markdown="1"> This operation is only valid for legacy predictors created with
2645
+ # CreatePredictor. If you are not using a legacy predictor, use
2646
+ # DescribeAutoPredictor.
2647
+ #
2648
+ # To upgrade a legacy predictor to AutoPredictor, see Upgrading to
2649
+ # AutoPredictor.
2650
+ #
2651
+ # </note>
2652
+ #
1921
2653
  # Describes a predictor created using the CreatePredictor operation.
1922
2654
  #
1923
2655
  # In addition to listing the properties provided in the
@@ -1947,6 +2679,7 @@ module Aws::ForecastService
1947
2679
  # * {Types::DescribePredictorResponse#predictor_arn #predictor_arn} => String
1948
2680
  # * {Types::DescribePredictorResponse#predictor_name #predictor_name} => String
1949
2681
  # * {Types::DescribePredictorResponse#algorithm_arn #algorithm_arn} => String
2682
+ # * {Types::DescribePredictorResponse#auto_ml_algorithm_arns #auto_ml_algorithm_arns} => Array&lt;String&gt;
1950
2683
  # * {Types::DescribePredictorResponse#forecast_horizon #forecast_horizon} => Integer
1951
2684
  # * {Types::DescribePredictorResponse#forecast_types #forecast_types} => Array&lt;String&gt;
1952
2685
  # * {Types::DescribePredictorResponse#perform_auto_ml #perform_auto_ml} => Boolean
@@ -1960,12 +2693,13 @@ module Aws::ForecastService
1960
2693
  # * {Types::DescribePredictorResponse#encryption_config #encryption_config} => Types::EncryptionConfig
1961
2694
  # * {Types::DescribePredictorResponse#predictor_execution_details #predictor_execution_details} => Types::PredictorExecutionDetails
1962
2695
  # * {Types::DescribePredictorResponse#estimated_time_remaining_in_minutes #estimated_time_remaining_in_minutes} => Integer
2696
+ # * {Types::DescribePredictorResponse#is_auto_predictor #is_auto_predictor} => Boolean
1963
2697
  # * {Types::DescribePredictorResponse#dataset_import_job_arns #dataset_import_job_arns} => Array&lt;String&gt;
1964
- # * {Types::DescribePredictorResponse#auto_ml_algorithm_arns #auto_ml_algorithm_arns} => Array&lt;String&gt;
1965
2698
  # * {Types::DescribePredictorResponse#status #status} => String
1966
2699
  # * {Types::DescribePredictorResponse#message #message} => String
1967
2700
  # * {Types::DescribePredictorResponse#creation_time #creation_time} => Time
1968
2701
  # * {Types::DescribePredictorResponse#last_modification_time #last_modification_time} => Time
2702
+ # * {Types::DescribePredictorResponse#optimization_metric #optimization_metric} => String
1969
2703
  #
1970
2704
  # @example Request syntax with placeholder values
1971
2705
  #
@@ -1978,11 +2712,13 @@ module Aws::ForecastService
1978
2712
  # resp.predictor_arn #=> String
1979
2713
  # resp.predictor_name #=> String
1980
2714
  # resp.algorithm_arn #=> String
2715
+ # resp.auto_ml_algorithm_arns #=> Array
2716
+ # resp.auto_ml_algorithm_arns[0] #=> String
1981
2717
  # resp.forecast_horizon #=> Integer
1982
2718
  # resp.forecast_types #=> Array
1983
2719
  # resp.forecast_types[0] #=> String
1984
2720
  # resp.perform_auto_ml #=> Boolean
1985
- # resp.auto_ml_override_strategy #=> String, one of "LatencyOptimized"
2721
+ # resp.auto_ml_override_strategy #=> String, one of "LatencyOptimized", "AccuracyOptimized"
1986
2722
  # resp.perform_hpo #=> Boolean
1987
2723
  # resp.training_parameters #=> Hash
1988
2724
  # resp.training_parameters["ParameterKey"] #=> String
@@ -2025,14 +2761,14 @@ module Aws::ForecastService
2025
2761
  # resp.predictor_execution_details.predictor_executions[0].test_windows[0].status #=> String
2026
2762
  # resp.predictor_execution_details.predictor_executions[0].test_windows[0].message #=> String
2027
2763
  # resp.estimated_time_remaining_in_minutes #=> Integer
2764
+ # resp.is_auto_predictor #=> Boolean
2028
2765
  # resp.dataset_import_job_arns #=> Array
2029
2766
  # resp.dataset_import_job_arns[0] #=> String
2030
- # resp.auto_ml_algorithm_arns #=> Array
2031
- # resp.auto_ml_algorithm_arns[0] #=> String
2032
2767
  # resp.status #=> String
2033
2768
  # resp.message #=> String
2034
2769
  # resp.creation_time #=> Time
2035
2770
  # resp.last_modification_time #=> Time
2771
+ # resp.optimization_metric #=> String, one of "WAPE", "RMSE", "AverageWeightedQuantileLoss", "MASE", "MAPE"
2036
2772
  #
2037
2773
  # @see http://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/DescribePredictor AWS API Documentation
2038
2774
  #
@@ -2134,7 +2870,9 @@ module Aws::ForecastService
2134
2870
  # @return [Types::GetAccuracyMetricsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
2135
2871
  #
2136
2872
  # * {Types::GetAccuracyMetricsResponse#predictor_evaluation_results #predictor_evaluation_results} => Array&lt;Types::EvaluationResult&gt;
2873
+ # * {Types::GetAccuracyMetricsResponse#is_auto_predictor #is_auto_predictor} => Boolean
2137
2874
  # * {Types::GetAccuracyMetricsResponse#auto_ml_override_strategy #auto_ml_override_strategy} => String
2875
+ # * {Types::GetAccuracyMetricsResponse#optimization_metric #optimization_metric} => String
2138
2876
  #
2139
2877
  # @example Request syntax with placeholder values
2140
2878
  #
@@ -2159,7 +2897,12 @@ module Aws::ForecastService
2159
2897
  # resp.predictor_evaluation_results[0].test_windows[0].metrics.error_metrics[0].forecast_type #=> String
2160
2898
  # resp.predictor_evaluation_results[0].test_windows[0].metrics.error_metrics[0].wape #=> Float
2161
2899
  # resp.predictor_evaluation_results[0].test_windows[0].metrics.error_metrics[0].rmse #=> Float
2162
- # resp.auto_ml_override_strategy #=> String, one of "LatencyOptimized"
2900
+ # resp.predictor_evaluation_results[0].test_windows[0].metrics.error_metrics[0].mase #=> Float
2901
+ # resp.predictor_evaluation_results[0].test_windows[0].metrics.error_metrics[0].mape #=> Float
2902
+ # resp.predictor_evaluation_results[0].test_windows[0].metrics.average_weighted_quantile_loss #=> Float
2903
+ # resp.is_auto_predictor #=> Boolean
2904
+ # resp.auto_ml_override_strategy #=> String, one of "LatencyOptimized", "AccuracyOptimized"
2905
+ # resp.optimization_metric #=> String, one of "WAPE", "RMSE", "AverageWeightedQuantileLoss", "MASE", "MAPE"
2163
2906
  #
2164
2907
  # @see http://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/GetAccuracyMetrics AWS API Documentation
2165
2908
  #
@@ -2346,6 +3089,156 @@ module Aws::ForecastService
2346
3089
  req.send_request(options)
2347
3090
  end
2348
3091
 
3092
+ # Returns a list of Explainability resources created using the
3093
+ # CreateExplainability operation. This operation returns a summary for
3094
+ # each Explainability. You can filter the list using an array of Filter
3095
+ # objects.
3096
+ #
3097
+ # To retrieve the complete set of properties for a particular
3098
+ # Explainability resource, use the ARN with the DescribeExplainability
3099
+ # operation.
3100
+ #
3101
+ # @option params [String] :next_token
3102
+ # If the result of the previous request was truncated, the response
3103
+ # includes a NextToken. To retrieve the next set of results, use the
3104
+ # token in the next request. Tokens expire after 24 hours.
3105
+ #
3106
+ # @option params [Integer] :max_results
3107
+ # The number of items returned in the response.
3108
+ #
3109
+ # @option params [Array<Types::Filter>] :filters
3110
+ # An array of filters. For each filter, provide a condition and a match
3111
+ # statement. The condition is either `IS` or `IS_NOT`, which specifies
3112
+ # whether to include or exclude the resources that match the statement
3113
+ # from the list. The match statement consists of a key and a value.
3114
+ #
3115
+ # **Filter properties**
3116
+ #
3117
+ # * `Condition` - The condition to apply. Valid values are `IS` and
3118
+ # `IS_NOT`.
3119
+ #
3120
+ # * `Key` - The name of the parameter to filter on. Valid values are
3121
+ # `PredictorArn` and `Status`.
3122
+ #
3123
+ # * `Value` - The value to match.
3124
+ #
3125
+ # @return [Types::ListExplainabilitiesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
3126
+ #
3127
+ # * {Types::ListExplainabilitiesResponse#explainabilities #explainabilities} => Array&lt;Types::ExplainabilitySummary&gt;
3128
+ # * {Types::ListExplainabilitiesResponse#next_token #next_token} => String
3129
+ #
3130
+ # @example Request syntax with placeholder values
3131
+ #
3132
+ # resp = client.list_explainabilities({
3133
+ # next_token: "NextToken",
3134
+ # max_results: 1,
3135
+ # filters: [
3136
+ # {
3137
+ # key: "String", # required
3138
+ # value: "Arn", # required
3139
+ # condition: "IS", # required, accepts IS, IS_NOT
3140
+ # },
3141
+ # ],
3142
+ # })
3143
+ #
3144
+ # @example Response structure
3145
+ #
3146
+ # resp.explainabilities #=> Array
3147
+ # resp.explainabilities[0].explainability_arn #=> String
3148
+ # resp.explainabilities[0].explainability_name #=> String
3149
+ # resp.explainabilities[0].resource_arn #=> String
3150
+ # resp.explainabilities[0].explainability_config.time_series_granularity #=> String, one of "ALL", "SPECIFIC"
3151
+ # resp.explainabilities[0].explainability_config.time_point_granularity #=> String, one of "ALL", "SPECIFIC"
3152
+ # resp.explainabilities[0].status #=> String
3153
+ # resp.explainabilities[0].message #=> String
3154
+ # resp.explainabilities[0].creation_time #=> Time
3155
+ # resp.explainabilities[0].last_modification_time #=> Time
3156
+ # resp.next_token #=> String
3157
+ #
3158
+ # @see http://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/ListExplainabilities AWS API Documentation
3159
+ #
3160
+ # @overload list_explainabilities(params = {})
3161
+ # @param [Hash] params ({})
3162
+ def list_explainabilities(params = {}, options = {})
3163
+ req = build_request(:list_explainabilities, params)
3164
+ req.send_request(options)
3165
+ end
3166
+
3167
+ # Returns a list of Explainability exports created using the
3168
+ # CreateExplainabilityExport operation. This operation returns a summary
3169
+ # for each Explainability export. You can filter the list using an array
3170
+ # of Filter objects.
3171
+ #
3172
+ # To retrieve the complete set of properties for a particular
3173
+ # Explainability export, use the ARN with the DescribeExplainability
3174
+ # operation.
3175
+ #
3176
+ # @option params [String] :next_token
3177
+ # If the result of the previous request was truncated, the response
3178
+ # includes a NextToken. To retrieve the next set of results, use the
3179
+ # token in the next request. Tokens expire after 24 hours.
3180
+ #
3181
+ # @option params [Integer] :max_results
3182
+ # The number of items to return in the response.
3183
+ #
3184
+ # @option params [Array<Types::Filter>] :filters
3185
+ # An array of filters. For each filter, provide a condition and a match
3186
+ # statement. The condition is either `IS` or `IS_NOT`, which specifies
3187
+ # whether to include or exclude resources that match the statement from
3188
+ # the list. The match statement consists of a key and a value.
3189
+ #
3190
+ # **Filter properties**
3191
+ #
3192
+ # * `Condition` - The condition to apply. Valid values are `IS` and
3193
+ # `IS_NOT`.
3194
+ #
3195
+ # * `Key` - The name of the parameter to filter on. Valid values are
3196
+ # `PredictorArn` and `Status`.
3197
+ #
3198
+ # * `Value` - The value to match.
3199
+ #
3200
+ # @return [Types::ListExplainabilityExportsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
3201
+ #
3202
+ # * {Types::ListExplainabilityExportsResponse#explainability_exports #explainability_exports} => Array&lt;Types::ExplainabilityExportSummary&gt;
3203
+ # * {Types::ListExplainabilityExportsResponse#next_token #next_token} => String
3204
+ #
3205
+ # @example Request syntax with placeholder values
3206
+ #
3207
+ # resp = client.list_explainability_exports({
3208
+ # next_token: "NextToken",
3209
+ # max_results: 1,
3210
+ # filters: [
3211
+ # {
3212
+ # key: "String", # required
3213
+ # value: "Arn", # required
3214
+ # condition: "IS", # required, accepts IS, IS_NOT
3215
+ # },
3216
+ # ],
3217
+ # })
3218
+ #
3219
+ # @example Response structure
3220
+ #
3221
+ # resp.explainability_exports #=> Array
3222
+ # resp.explainability_exports[0].explainability_export_arn #=> String
3223
+ # resp.explainability_exports[0].explainability_export_name #=> String
3224
+ # resp.explainability_exports[0].destination.s3_config.path #=> String
3225
+ # resp.explainability_exports[0].destination.s3_config.role_arn #=> String
3226
+ # resp.explainability_exports[0].destination.s3_config.kms_key_arn #=> String
3227
+ # resp.explainability_exports[0].status #=> String
3228
+ # resp.explainability_exports[0].message #=> String
3229
+ # resp.explainability_exports[0].creation_time #=> Time
3230
+ # resp.explainability_exports[0].last_modification_time #=> Time
3231
+ # resp.next_token #=> String
3232
+ #
3233
+ # @see http://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/ListExplainabilityExports AWS API Documentation
3234
+ #
3235
+ # @overload list_explainability_exports(params = {})
3236
+ # @param [Hash] params ({})
3237
+ def list_explainability_exports(params = {}, options = {})
3238
+ req = build_request(:list_explainability_exports, params)
3239
+ req.send_request(options)
3240
+ end
3241
+
2349
3242
  # Returns a list of forecast export jobs created using the
2350
3243
  # CreateForecastExportJob operation. For each forecast export job, this
2351
3244
  # operation returns a summary of its properties, including its Amazon
@@ -2496,6 +3389,7 @@ module Aws::ForecastService
2496
3389
  # resp.forecasts[0].forecast_arn #=> String
2497
3390
  # resp.forecasts[0].forecast_name #=> String
2498
3391
  # resp.forecasts[0].predictor_arn #=> String
3392
+ # resp.forecasts[0].created_using_auto_predictor #=> Boolean
2499
3393
  # resp.forecasts[0].dataset_group_arn #=> String
2500
3394
  # resp.forecasts[0].status #=> String
2501
3395
  # resp.forecasts[0].message #=> String
@@ -2658,6 +3552,9 @@ module Aws::ForecastService
2658
3552
  # resp.predictors[0].predictor_arn #=> String
2659
3553
  # resp.predictors[0].predictor_name #=> String
2660
3554
  # resp.predictors[0].dataset_group_arn #=> String
3555
+ # resp.predictors[0].is_auto_predictor #=> Boolean
3556
+ # resp.predictors[0].reference_predictor_summary.arn #=> String
3557
+ # resp.predictors[0].reference_predictor_summary.state #=> String, one of "Active", "Deleted"
2661
3558
  # resp.predictors[0].status #=> String
2662
3559
  # resp.predictors[0].message #=> String
2663
3560
  # resp.predictors[0].creation_time #=> Time
@@ -2887,7 +3784,7 @@ module Aws::ForecastService
2887
3784
  params: params,
2888
3785
  config: config)
2889
3786
  context[:gem_name] = 'aws-sdk-forecastservice'
2890
- context[:gem_version] = '1.24.0'
3787
+ context[:gem_version] = '1.28.0'
2891
3788
  Seahorse::Client::Request.new(handlers, context)
2892
3789
  end
2893
3790