aws-sdk-forecastservice 1.27.0 → 1.31.0

Sign up to get free protection for your applications and to get access to all the features.
@@ -27,6 +27,7 @@ require 'aws-sdk-core/plugins/client_metrics_plugin.rb'
27
27
  require 'aws-sdk-core/plugins/client_metrics_send_plugin.rb'
28
28
  require 'aws-sdk-core/plugins/transfer_encoding.rb'
29
29
  require 'aws-sdk-core/plugins/http_checksum.rb'
30
+ require 'aws-sdk-core/plugins/defaults_mode.rb'
30
31
  require 'aws-sdk-core/plugins/signature_v4.rb'
31
32
  require 'aws-sdk-core/plugins/protocols/json_rpc.rb'
32
33
 
@@ -73,6 +74,7 @@ module Aws::ForecastService
73
74
  add_plugin(Aws::Plugins::ClientMetricsSendPlugin)
74
75
  add_plugin(Aws::Plugins::TransferEncoding)
75
76
  add_plugin(Aws::Plugins::HttpChecksum)
77
+ add_plugin(Aws::Plugins::DefaultsMode)
76
78
  add_plugin(Aws::Plugins::SignatureV4)
77
79
  add_plugin(Aws::Plugins::Protocols::JsonRpc)
78
80
 
@@ -119,7 +121,9 @@ module Aws::ForecastService
119
121
  # * EC2/ECS IMDS instance profile - When used by default, the timeouts
120
122
  # are very aggressive. Construct and pass an instance of
121
123
  # `Aws::InstanceProfileCredentails` or `Aws::ECSCredentials` to
122
- # enable retries and extended timeouts.
124
+ # enable retries and extended timeouts. Instance profile credential
125
+ # fetching can be disabled by setting ENV['AWS_EC2_METADATA_DISABLED']
126
+ # to true.
123
127
  #
124
128
  # @option options [required, String] :region
125
129
  # The AWS region to connect to. The configured `:region` is
@@ -173,6 +177,10 @@ module Aws::ForecastService
173
177
  # Used only in `standard` and adaptive retry modes. Specifies whether to apply
174
178
  # a clock skew correction and retry requests with skewed client clocks.
175
179
  #
180
+ # @option options [String] :defaults_mode ("legacy")
181
+ # See {Aws::DefaultsModeConfiguration} for a list of the
182
+ # accepted modes and the configuration defaults that are included.
183
+ #
176
184
  # @option options [Boolean] :disable_host_prefix_injection (false)
177
185
  # Set to true to disable SDK automatically adding host prefix
178
186
  # to default service endpoint when available.
@@ -305,7 +313,7 @@ module Aws::ForecastService
305
313
  # seconds to wait when opening a HTTP session before raising a
306
314
  # `Timeout::Error`.
307
315
  #
308
- # @option options [Integer] :http_read_timeout (60) The default
316
+ # @option options [Float] :http_read_timeout (60) The default
309
317
  # number of seconds to wait for response data. This value can
310
318
  # safely be set per-request on the session.
311
319
  #
@@ -321,6 +329,9 @@ module Aws::ForecastService
321
329
  # disables this behaviour. This value can safely be set per
322
330
  # request on the session.
323
331
  #
332
+ # @option options [Float] :ssl_timeout (nil) Sets the SSL timeout
333
+ # in seconds.
334
+ #
324
335
  # @option options [Boolean] :http_wire_trace (false) When `true`,
325
336
  # HTTP debug output will be sent to the `:logger`.
326
337
  #
@@ -346,6 +357,191 @@ module Aws::ForecastService
346
357
 
347
358
  # @!group API Operations
348
359
 
360
+ # Creates an Amazon Forecast predictor.
361
+ #
362
+ # Amazon Forecast creates predictors with AutoPredictor, which involves
363
+ # applying the optimal combination of algorithms to each time series in
364
+ # your datasets. You can use CreateAutoPredictor to create new
365
+ # predictors or upgrade/retrain existing predictors.
366
+ #
367
+ # **Creating new predictors**
368
+ #
369
+ # The following parameters are required when creating a new predictor:
370
+ #
371
+ # * `PredictorName` - A unique name for the predictor.
372
+ #
373
+ # * `DatasetGroupArn` - The ARN of the dataset group used to train the
374
+ # predictor.
375
+ #
376
+ # * `ForecastFrequency` - The granularity of your forecasts (hourly,
377
+ # daily, weekly, etc).
378
+ #
379
+ # * `ForecastHorizon` - The number of time steps being forecasted.
380
+ #
381
+ # When creating a new predictor, do not specify a value for
382
+ # `ReferencePredictorArn`.
383
+ #
384
+ # **Upgrading and retraining predictors**
385
+ #
386
+ # The following parameters are required when retraining or upgrading a
387
+ # predictor:
388
+ #
389
+ # * `PredictorName` - A unique name for the predictor.
390
+ #
391
+ # * `ReferencePredictorArn` - The ARN of the predictor to retrain or
392
+ # upgrade.
393
+ #
394
+ # When upgrading or retraining a predictor, only specify values for the
395
+ # `ReferencePredictorArn` and `PredictorName`.
396
+ #
397
+ # @option params [required, String] :predictor_name
398
+ # A unique name for the predictor
399
+ #
400
+ # @option params [Integer] :forecast_horizon
401
+ # The number of time-steps that the model predicts. The forecast horizon
402
+ # is also called the prediction length.
403
+ #
404
+ # @option params [Array<String>] :forecast_types
405
+ # The forecast types used to train a predictor. You can specify up to
406
+ # five forecast types. Forecast types can be quantiles from 0.01 to
407
+ # 0.99, by increments of 0.01 or higher. You can also specify the mean
408
+ # forecast with `mean`.
409
+ #
410
+ # @option params [Array<String>] :forecast_dimensions
411
+ # An array of dimension (field) names that specify how to group the
412
+ # generated forecast.
413
+ #
414
+ # For example, if you are generating forecasts for item sales across all
415
+ # your stores, and your dataset contains a `store_id` field, you would
416
+ # specify `store_id` as a dimension to group sales forecasts for each
417
+ # store.
418
+ #
419
+ # @option params [String] :forecast_frequency
420
+ # The frequency of predictions in a forecast.
421
+ #
422
+ # Valid intervals are Y (Year), M (Month), W (Week), D (Day), H (Hour),
423
+ # 30min (30 minutes), 15min (15 minutes), 10min (10 minutes), 5min (5
424
+ # minutes), and 1min (1 minute). For example, "Y" indicates every year
425
+ # and "5min" indicates every five minutes.
426
+ #
427
+ # The frequency must be greater than or equal to the
428
+ # TARGET\_TIME\_SERIES dataset frequency.
429
+ #
430
+ # When a RELATED\_TIME\_SERIES dataset is provided, the frequency must
431
+ # be equal to the RELATED\_TIME\_SERIES dataset frequency.
432
+ #
433
+ # @option params [Types::DataConfig] :data_config
434
+ # The data configuration for your dataset group and any additional
435
+ # datasets.
436
+ #
437
+ # @option params [Types::EncryptionConfig] :encryption_config
438
+ # An AWS Key Management Service (KMS) key and an AWS Identity and Access
439
+ # Management (IAM) role that Amazon Forecast can assume to access the
440
+ # key. You can specify this optional object in the CreateDataset and
441
+ # CreatePredictor requests.
442
+ #
443
+ # @option params [String] :reference_predictor_arn
444
+ # The ARN of the predictor to retrain or upgrade. This parameter is only
445
+ # used when retraining or upgrading a predictor. When creating a new
446
+ # predictor, do not specify a value for this parameter.
447
+ #
448
+ # When upgrading or retraining a predictor, only specify values for the
449
+ # `ReferencePredictorArn` and `PredictorName`. The value for
450
+ # `PredictorName` must be a unique predictor name.
451
+ #
452
+ # @option params [String] :optimization_metric
453
+ # The accuracy metric used to optimize the predictor.
454
+ #
455
+ # @option params [Boolean] :explain_predictor
456
+ # Create an Explainability resource for the predictor.
457
+ #
458
+ # @option params [Array<Types::Tag>] :tags
459
+ # Optional metadata to help you categorize and organize your predictors.
460
+ # Each tag consists of a key and an optional value, both of which you
461
+ # define. Tag keys and values are case sensitive.
462
+ #
463
+ # The following restrictions apply to tags:
464
+ #
465
+ # * For each resource, each tag key must be unique and each tag key must
466
+ # have one value.
467
+ #
468
+ # * Maximum number of tags per resource: 50.
469
+ #
470
+ # * Maximum key length: 128 Unicode characters in UTF-8.
471
+ #
472
+ # * Maximum value length: 256 Unicode characters in UTF-8.
473
+ #
474
+ # * Accepted characters: all letters and numbers, spaces representable
475
+ # in UTF-8, and + - = . \_ : / @. If your tagging schema is used
476
+ # across other services and resources, the character restrictions of
477
+ # those services also apply.
478
+ #
479
+ # * Key prefixes cannot include any upper or lowercase combination of
480
+ # `aws:` or `AWS:`. Values can have this prefix. If a tag value has
481
+ # `aws` as its prefix but the key does not, Forecast considers it to
482
+ # be a user tag and will count against the limit of 50 tags. Tags with
483
+ # only the key prefix of `aws` do not count against your tags per
484
+ # resource limit. You cannot edit or delete tag keys with this prefix.
485
+ #
486
+ # @return [Types::CreateAutoPredictorResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
487
+ #
488
+ # * {Types::CreateAutoPredictorResponse#predictor_arn #predictor_arn} => String
489
+ #
490
+ # @example Request syntax with placeholder values
491
+ #
492
+ # resp = client.create_auto_predictor({
493
+ # predictor_name: "Name", # required
494
+ # forecast_horizon: 1,
495
+ # forecast_types: ["ForecastType"],
496
+ # forecast_dimensions: ["Name"],
497
+ # forecast_frequency: "Frequency",
498
+ # data_config: {
499
+ # dataset_group_arn: "Arn", # required
500
+ # attribute_configs: [
501
+ # {
502
+ # attribute_name: "Name", # required
503
+ # transformations: { # required
504
+ # "Name" => "Value",
505
+ # },
506
+ # },
507
+ # ],
508
+ # additional_datasets: [
509
+ # {
510
+ # name: "Name", # required
511
+ # configuration: {
512
+ # "Name" => ["Value"],
513
+ # },
514
+ # },
515
+ # ],
516
+ # },
517
+ # encryption_config: {
518
+ # role_arn: "Arn", # required
519
+ # kms_key_arn: "KMSKeyArn", # required
520
+ # },
521
+ # reference_predictor_arn: "Arn",
522
+ # optimization_metric: "WAPE", # accepts WAPE, RMSE, AverageWeightedQuantileLoss, MASE, MAPE
523
+ # explain_predictor: false,
524
+ # tags: [
525
+ # {
526
+ # key: "TagKey", # required
527
+ # value: "TagValue", # required
528
+ # },
529
+ # ],
530
+ # })
531
+ #
532
+ # @example Response structure
533
+ #
534
+ # resp.predictor_arn #=> String
535
+ #
536
+ # @see http://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/CreateAutoPredictor AWS API Documentation
537
+ #
538
+ # @overload create_auto_predictor(params = {})
539
+ # @param [Hash] params ({})
540
+ def create_auto_predictor(params = {}, options = {})
541
+ req = build_request(:create_auto_predictor, params)
542
+ req.send_request(options)
543
+ end
544
+
349
545
  # Creates an Amazon Forecast dataset. The information about the dataset
350
546
  # that you provide helps Forecast understand how to consume the data for
351
547
  # model training. This includes the following:
@@ -762,6 +958,297 @@ module Aws::ForecastService
762
958
  req.send_request(options)
763
959
  end
764
960
 
961
+ # <note markdown="1"> Explainability is only available for Forecasts and Predictors
962
+ # generated from an AutoPredictor (CreateAutoPredictor)
963
+ #
964
+ # </note>
965
+ #
966
+ # Creates an Amazon Forecast Explainability.
967
+ #
968
+ # Explainability helps you better understand how the attributes in your
969
+ # datasets impact forecast. Amazon Forecast uses a metric called Impact
970
+ # scores to quantify the relative impact of each attribute and determine
971
+ # whether they increase or decrease forecast values.
972
+ #
973
+ # To enable Forecast Explainability, your predictor must include at
974
+ # least one of the following: related time series, item metadata, or
975
+ # additional datasets like Holidays and the Weather Index.
976
+ #
977
+ # CreateExplainability accepts either a Predictor ARN or Forecast ARN.
978
+ # To receive aggregated Impact scores for all time series and time
979
+ # points in your datasets, provide a Predictor ARN. To receive Impact
980
+ # scores for specific time series and time points, provide a Forecast
981
+ # ARN.
982
+ #
983
+ # **CreateExplainability with a Predictor ARN**
984
+ #
985
+ # <note markdown="1"> You can only have one Explainability resource per predictor. If you
986
+ # already enabled `ExplainPredictor` in CreateAutoPredictor, that
987
+ # predictor already has an Explainability resource.
988
+ #
989
+ # </note>
990
+ #
991
+ # The following parameters are required when providing a Predictor ARN:
992
+ #
993
+ # * `ExplainabilityName` - A unique name for the Explainability.
994
+ #
995
+ # * `ResourceArn` - The Arn of the predictor.
996
+ #
997
+ # * `TimePointGranularity` - Must be set to “ALL”.
998
+ #
999
+ # * `TimeSeriesGranularity` - Must be set to “ALL”.
1000
+ #
1001
+ # Do not specify a value for the following parameters:
1002
+ #
1003
+ # * `DataSource` - Only valid when TimeSeriesGranularity is “SPECIFIC”.
1004
+ #
1005
+ # * `Schema` - Only valid when TimeSeriesGranularity is “SPECIFIC”.
1006
+ #
1007
+ # * `StartDateTime` - Only valid when TimePointGranularity is
1008
+ # “SPECIFIC”.
1009
+ #
1010
+ # * `EndDateTime` - Only valid when TimePointGranularity is “SPECIFIC”.
1011
+ #
1012
+ # **CreateExplainability with a Forecast ARN**
1013
+ #
1014
+ # <note markdown="1"> You can specify a maximum of 50 time series and 500 time points.
1015
+ #
1016
+ # </note>
1017
+ #
1018
+ # The following parameters are required when providing a Predictor ARN:
1019
+ #
1020
+ # * `ExplainabilityName` - A unique name for the Explainability.
1021
+ #
1022
+ # * `ResourceArn` - The Arn of the forecast.
1023
+ #
1024
+ # * `TimePointGranularity` - Either “ALL” or “SPECIFIC”.
1025
+ #
1026
+ # * `TimeSeriesGranularity` - Either “ALL” or “SPECIFIC”.
1027
+ #
1028
+ # If you set TimeSeriesGranularity to “SPECIFIC”, you must also provide
1029
+ # the following:
1030
+ #
1031
+ # * `DataSource` - The S3 location of the CSV file specifying your time
1032
+ # series.
1033
+ #
1034
+ # * `Schema` - The Schema defines the attributes and attribute types
1035
+ # listed in the Data Source.
1036
+ #
1037
+ # If you set TimePointGranularity to “SPECIFIC”, you must also provide
1038
+ # the following:
1039
+ #
1040
+ # * `StartDateTime` - The first timestamp in the range of time points.
1041
+ #
1042
+ # * `EndDateTime` - The last timestamp in the range of time points.
1043
+ #
1044
+ # @option params [required, String] :explainability_name
1045
+ # A unique name for the Explainability.
1046
+ #
1047
+ # @option params [required, String] :resource_arn
1048
+ # The Amazon Resource Name (ARN) of the Predictor or Forecast used to
1049
+ # create the Explainability.
1050
+ #
1051
+ # @option params [required, Types::ExplainabilityConfig] :explainability_config
1052
+ # The configuration settings that define the granularity of time series
1053
+ # and time points for the Explainability.
1054
+ #
1055
+ # @option params [Types::DataSource] :data_source
1056
+ # The source of your data, an AWS Identity and Access Management (IAM)
1057
+ # role that allows Amazon Forecast to access the data and, optionally,
1058
+ # an AWS Key Management Service (KMS) key.
1059
+ #
1060
+ # @option params [Types::Schema] :schema
1061
+ # Defines the fields of a dataset.
1062
+ #
1063
+ # @option params [Boolean] :enable_visualization
1064
+ # Create an Expainability visualization that is viewable within the AWS
1065
+ # console.
1066
+ #
1067
+ # @option params [String] :start_date_time
1068
+ # If `TimePointGranularity` is set to `SPECIFIC`, define the first point
1069
+ # for the Explainability.
1070
+ #
1071
+ # Use the following timestamp format: yyyy-MM-ddTHH:mm:ss (example:
1072
+ # 2015-01-01T20:00:00)
1073
+ #
1074
+ # @option params [String] :end_date_time
1075
+ # If `TimePointGranularity` is set to `SPECIFIC`, define the last time
1076
+ # point for the Explainability.
1077
+ #
1078
+ # Use the following timestamp format: yyyy-MM-ddTHH:mm:ss (example:
1079
+ # 2015-01-01T20:00:00)
1080
+ #
1081
+ # @option params [Array<Types::Tag>] :tags
1082
+ # Optional metadata to help you categorize and organize your resources.
1083
+ # Each tag consists of a key and an optional value, both of which you
1084
+ # define. Tag keys and values are case sensitive.
1085
+ #
1086
+ # The following restrictions apply to tags:
1087
+ #
1088
+ # * For each resource, each tag key must be unique and each tag key must
1089
+ # have one value.
1090
+ #
1091
+ # * Maximum number of tags per resource: 50.
1092
+ #
1093
+ # * Maximum key length: 128 Unicode characters in UTF-8.
1094
+ #
1095
+ # * Maximum value length: 256 Unicode characters in UTF-8.
1096
+ #
1097
+ # * Accepted characters: all letters and numbers, spaces representable
1098
+ # in UTF-8, and + - = . \_ : / @. If your tagging schema is used
1099
+ # across other services and resources, the character restrictions of
1100
+ # those services also apply.
1101
+ #
1102
+ # * Key prefixes cannot include any upper or lowercase combination of
1103
+ # `aws:` or `AWS:`. Values can have this prefix. If a tag value has
1104
+ # `aws` as its prefix but the key does not, Forecast considers it to
1105
+ # be a user tag and will count against the limit of 50 tags. Tags with
1106
+ # only the key prefix of `aws` do not count against your tags per
1107
+ # resource limit. You cannot edit or delete tag keys with this prefix.
1108
+ #
1109
+ # @return [Types::CreateExplainabilityResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1110
+ #
1111
+ # * {Types::CreateExplainabilityResponse#explainability_arn #explainability_arn} => String
1112
+ #
1113
+ # @example Request syntax with placeholder values
1114
+ #
1115
+ # resp = client.create_explainability({
1116
+ # explainability_name: "Name", # required
1117
+ # resource_arn: "Arn", # required
1118
+ # explainability_config: { # required
1119
+ # time_series_granularity: "ALL", # required, accepts ALL, SPECIFIC
1120
+ # time_point_granularity: "ALL", # required, accepts ALL, SPECIFIC
1121
+ # },
1122
+ # data_source: {
1123
+ # s3_config: { # required
1124
+ # path: "S3Path", # required
1125
+ # role_arn: "Arn", # required
1126
+ # kms_key_arn: "KMSKeyArn",
1127
+ # },
1128
+ # },
1129
+ # schema: {
1130
+ # attributes: [
1131
+ # {
1132
+ # attribute_name: "Name",
1133
+ # attribute_type: "string", # accepts string, integer, float, timestamp, geolocation
1134
+ # },
1135
+ # ],
1136
+ # },
1137
+ # enable_visualization: false,
1138
+ # start_date_time: "LocalDateTime",
1139
+ # end_date_time: "LocalDateTime",
1140
+ # tags: [
1141
+ # {
1142
+ # key: "TagKey", # required
1143
+ # value: "TagValue", # required
1144
+ # },
1145
+ # ],
1146
+ # })
1147
+ #
1148
+ # @example Response structure
1149
+ #
1150
+ # resp.explainability_arn #=> String
1151
+ #
1152
+ # @see http://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/CreateExplainability AWS API Documentation
1153
+ #
1154
+ # @overload create_explainability(params = {})
1155
+ # @param [Hash] params ({})
1156
+ def create_explainability(params = {}, options = {})
1157
+ req = build_request(:create_explainability, params)
1158
+ req.send_request(options)
1159
+ end
1160
+
1161
+ # Exports an Explainability resource created by the CreateExplainability
1162
+ # operation. Exported files are exported to an Amazon Simple Storage
1163
+ # Service (Amazon S3) bucket.
1164
+ #
1165
+ # You must specify a DataDestination object that includes an Amazon S3
1166
+ # bucket and an AWS Identity and Access Management (IAM) role that
1167
+ # Amazon Forecast can assume to access the Amazon S3 bucket. For more
1168
+ # information, see aws-forecast-iam-roles.
1169
+ #
1170
+ # <note markdown="1"> The `Status` of the export job must be `ACTIVE` before you can access
1171
+ # the export in your Amazon S3 bucket. To get the status, use the
1172
+ # DescribeExplainabilityExport operation.
1173
+ #
1174
+ # </note>
1175
+ #
1176
+ # @option params [required, String] :explainability_export_name
1177
+ # A unique name for the Explainability export.
1178
+ #
1179
+ # @option params [required, String] :explainability_arn
1180
+ # The Amazon Resource Name (ARN) of the Explainability to export.
1181
+ #
1182
+ # @option params [required, Types::DataDestination] :destination
1183
+ # The destination for an export job. Provide an S3 path, an AWS Identity
1184
+ # and Access Management (IAM) role that allows Amazon Forecast to access
1185
+ # the location, and an AWS Key Management Service (KMS) key (optional).
1186
+ #
1187
+ # @option params [Array<Types::Tag>] :tags
1188
+ # Optional metadata to help you categorize and organize your resources.
1189
+ # Each tag consists of a key and an optional value, both of which you
1190
+ # define. Tag keys and values are case sensitive.
1191
+ #
1192
+ # The following restrictions apply to tags:
1193
+ #
1194
+ # * For each resource, each tag key must be unique and each tag key must
1195
+ # have one value.
1196
+ #
1197
+ # * Maximum number of tags per resource: 50.
1198
+ #
1199
+ # * Maximum key length: 128 Unicode characters in UTF-8.
1200
+ #
1201
+ # * Maximum value length: 256 Unicode characters in UTF-8.
1202
+ #
1203
+ # * Accepted characters: all letters and numbers, spaces representable
1204
+ # in UTF-8, and + - = . \_ : / @. If your tagging schema is used
1205
+ # across other services and resources, the character restrictions of
1206
+ # those services also apply.
1207
+ #
1208
+ # * Key prefixes cannot include any upper or lowercase combination of
1209
+ # `aws:` or `AWS:`. Values can have this prefix. If a tag value has
1210
+ # `aws` as its prefix but the key does not, Forecast considers it to
1211
+ # be a user tag and will count against the limit of 50 tags. Tags with
1212
+ # only the key prefix of `aws` do not count against your tags per
1213
+ # resource limit. You cannot edit or delete tag keys with this prefix.
1214
+ #
1215
+ # @return [Types::CreateExplainabilityExportResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1216
+ #
1217
+ # * {Types::CreateExplainabilityExportResponse#explainability_export_arn #explainability_export_arn} => String
1218
+ #
1219
+ # @example Request syntax with placeholder values
1220
+ #
1221
+ # resp = client.create_explainability_export({
1222
+ # explainability_export_name: "Name", # required
1223
+ # explainability_arn: "Arn", # required
1224
+ # destination: { # required
1225
+ # s3_config: { # required
1226
+ # path: "S3Path", # required
1227
+ # role_arn: "Arn", # required
1228
+ # kms_key_arn: "KMSKeyArn",
1229
+ # },
1230
+ # },
1231
+ # tags: [
1232
+ # {
1233
+ # key: "TagKey", # required
1234
+ # value: "TagValue", # required
1235
+ # },
1236
+ # ],
1237
+ # })
1238
+ #
1239
+ # @example Response structure
1240
+ #
1241
+ # resp.explainability_export_arn #=> String
1242
+ #
1243
+ # @see http://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/CreateExplainabilityExport AWS API Documentation
1244
+ #
1245
+ # @overload create_explainability_export(params = {})
1246
+ # @param [Hash] params ({})
1247
+ def create_explainability_export(params = {}, options = {})
1248
+ req = build_request(:create_explainability_export, params)
1249
+ req.send_request(options)
1250
+ end
1251
+
765
1252
  # Creates a forecast for each item in the `TARGET_TIME_SERIES` dataset
766
1253
  # that was used to train the predictor. This is known as inference. To
767
1254
  # retrieve the forecast for a single item at low latency, use the
@@ -978,6 +1465,13 @@ module Aws::ForecastService
978
1465
  req.send_request(options)
979
1466
  end
980
1467
 
1468
+ # <note markdown="1"> This operation creates a legacy predictor that does not include all
1469
+ # the predictor functionalities provided by Amazon Forecast. To create a
1470
+ # predictor that is compatible with all aspects of Forecast, use
1471
+ # CreateAutoPredictor.
1472
+ #
1473
+ # </note>
1474
+ #
981
1475
  # Creates an Amazon Forecast predictor.
982
1476
  #
983
1477
  # In the request, provide a dataset group and either specify an
@@ -1201,7 +1695,7 @@ module Aws::ForecastService
1201
1695
  # forecast_horizon: 1, # required
1202
1696
  # forecast_types: ["ForecastType"],
1203
1697
  # perform_auto_ml: false,
1204
- # auto_ml_override_strategy: "LatencyOptimized", # accepts LatencyOptimized
1698
+ # auto_ml_override_strategy: "LatencyOptimized", # accepts LatencyOptimized, AccuracyOptimized
1205
1699
  # perform_hpo: false,
1206
1700
  # training_parameters: {
1207
1701
  # "ParameterKey" => "ParameterValue",
@@ -1289,8 +1783,8 @@ module Aws::ForecastService
1289
1783
  end
1290
1784
 
1291
1785
  # Exports backtest forecasts and accuracy metrics generated by the
1292
- # CreatePredictor operation. Two folders containing CSV files are
1293
- # exported to your specified S3 bucket.
1786
+ # CreateAutoPredictor or CreatePredictor operations. Two folders
1787
+ # containing CSV files are exported to your specified S3 bucket.
1294
1788
  #
1295
1789
  # The export file names will match the following conventions:
1296
1790
  #
@@ -1471,6 +1965,55 @@ module Aws::ForecastService
1471
1965
  req.send_request(options)
1472
1966
  end
1473
1967
 
1968
+ # Deletes an Explainability resource.
1969
+ #
1970
+ # You can delete only predictor that have a status of `ACTIVE` or
1971
+ # `CREATE_FAILED`. To get the status, use the DescribeExplainability
1972
+ # operation.
1973
+ #
1974
+ # @option params [required, String] :explainability_arn
1975
+ # The Amazon Resource Name (ARN) of the Explainability resource to
1976
+ # delete.
1977
+ #
1978
+ # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
1979
+ #
1980
+ # @example Request syntax with placeholder values
1981
+ #
1982
+ # resp = client.delete_explainability({
1983
+ # explainability_arn: "Arn", # required
1984
+ # })
1985
+ #
1986
+ # @see http://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/DeleteExplainability AWS API Documentation
1987
+ #
1988
+ # @overload delete_explainability(params = {})
1989
+ # @param [Hash] params ({})
1990
+ def delete_explainability(params = {}, options = {})
1991
+ req = build_request(:delete_explainability, params)
1992
+ req.send_request(options)
1993
+ end
1994
+
1995
+ # Deletes an Explainability export.
1996
+ #
1997
+ # @option params [required, String] :explainability_export_arn
1998
+ # The Amazon Resource Name (ARN) of the Explainability export to delete.
1999
+ #
2000
+ # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
2001
+ #
2002
+ # @example Request syntax with placeholder values
2003
+ #
2004
+ # resp = client.delete_explainability_export({
2005
+ # explainability_export_arn: "Arn", # required
2006
+ # })
2007
+ #
2008
+ # @see http://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/DeleteExplainabilityExport AWS API Documentation
2009
+ #
2010
+ # @overload delete_explainability_export(params = {})
2011
+ # @param [Hash] params ({})
2012
+ def delete_explainability_export(params = {}, options = {})
2013
+ req = build_request(:delete_explainability_export, params)
2014
+ req.send_request(options)
2015
+ end
2016
+
1474
2017
  # Deletes a forecast created using the CreateForecast operation. You can
1475
2018
  # delete only forecasts that have a status of `ACTIVE` or
1476
2019
  # `CREATE_FAILED`. To get the status, use the DescribeForecast
@@ -1524,10 +2067,10 @@ module Aws::ForecastService
1524
2067
  req.send_request(options)
1525
2068
  end
1526
2069
 
1527
- # Deletes a predictor created using the CreatePredictor operation. You
1528
- # can delete only predictor that have a status of `ACTIVE` or
1529
- # `CREATE_FAILED`. To get the status, use the DescribePredictor
1530
- # operation.
2070
+ # Deletes a predictor created using the DescribePredictor or
2071
+ # CreatePredictor operations. You can delete only predictor that have a
2072
+ # status of `ACTIVE` or `CREATE_FAILED`. To get the status, use the
2073
+ # DescribePredictor operation.
1531
2074
  #
1532
2075
  # @option params [required, String] :predictor_arn
1533
2076
  # The Amazon Resource Name (ARN) of the predictor to delete.
@@ -1619,6 +2162,81 @@ module Aws::ForecastService
1619
2162
  req.send_request(options)
1620
2163
  end
1621
2164
 
2165
+ # Describes a predictor created using the CreateAutoPredictor operation.
2166
+ #
2167
+ # @option params [required, String] :predictor_arn
2168
+ # The Amazon Resource Name (ARN) of the predictor.
2169
+ #
2170
+ # @return [Types::DescribeAutoPredictorResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
2171
+ #
2172
+ # * {Types::DescribeAutoPredictorResponse#predictor_arn #predictor_arn} => String
2173
+ # * {Types::DescribeAutoPredictorResponse#predictor_name #predictor_name} => String
2174
+ # * {Types::DescribeAutoPredictorResponse#forecast_horizon #forecast_horizon} => Integer
2175
+ # * {Types::DescribeAutoPredictorResponse#forecast_types #forecast_types} => Array&lt;String&gt;
2176
+ # * {Types::DescribeAutoPredictorResponse#forecast_frequency #forecast_frequency} => String
2177
+ # * {Types::DescribeAutoPredictorResponse#forecast_dimensions #forecast_dimensions} => Array&lt;String&gt;
2178
+ # * {Types::DescribeAutoPredictorResponse#dataset_import_job_arns #dataset_import_job_arns} => Array&lt;String&gt;
2179
+ # * {Types::DescribeAutoPredictorResponse#data_config #data_config} => Types::DataConfig
2180
+ # * {Types::DescribeAutoPredictorResponse#encryption_config #encryption_config} => Types::EncryptionConfig
2181
+ # * {Types::DescribeAutoPredictorResponse#reference_predictor_summary #reference_predictor_summary} => Types::ReferencePredictorSummary
2182
+ # * {Types::DescribeAutoPredictorResponse#estimated_time_remaining_in_minutes #estimated_time_remaining_in_minutes} => Integer
2183
+ # * {Types::DescribeAutoPredictorResponse#status #status} => String
2184
+ # * {Types::DescribeAutoPredictorResponse#message #message} => String
2185
+ # * {Types::DescribeAutoPredictorResponse#creation_time #creation_time} => Time
2186
+ # * {Types::DescribeAutoPredictorResponse#last_modification_time #last_modification_time} => Time
2187
+ # * {Types::DescribeAutoPredictorResponse#optimization_metric #optimization_metric} => String
2188
+ # * {Types::DescribeAutoPredictorResponse#explainability_info #explainability_info} => Types::ExplainabilityInfo
2189
+ #
2190
+ # @example Request syntax with placeholder values
2191
+ #
2192
+ # resp = client.describe_auto_predictor({
2193
+ # predictor_arn: "Arn", # required
2194
+ # })
2195
+ #
2196
+ # @example Response structure
2197
+ #
2198
+ # resp.predictor_arn #=> String
2199
+ # resp.predictor_name #=> String
2200
+ # resp.forecast_horizon #=> Integer
2201
+ # resp.forecast_types #=> Array
2202
+ # resp.forecast_types[0] #=> String
2203
+ # resp.forecast_frequency #=> String
2204
+ # resp.forecast_dimensions #=> Array
2205
+ # resp.forecast_dimensions[0] #=> String
2206
+ # resp.dataset_import_job_arns #=> Array
2207
+ # resp.dataset_import_job_arns[0] #=> String
2208
+ # resp.data_config.dataset_group_arn #=> String
2209
+ # resp.data_config.attribute_configs #=> Array
2210
+ # resp.data_config.attribute_configs[0].attribute_name #=> String
2211
+ # resp.data_config.attribute_configs[0].transformations #=> Hash
2212
+ # resp.data_config.attribute_configs[0].transformations["Name"] #=> String
2213
+ # resp.data_config.additional_datasets #=> Array
2214
+ # resp.data_config.additional_datasets[0].name #=> String
2215
+ # resp.data_config.additional_datasets[0].configuration #=> Hash
2216
+ # resp.data_config.additional_datasets[0].configuration["Name"] #=> Array
2217
+ # resp.data_config.additional_datasets[0].configuration["Name"][0] #=> String
2218
+ # resp.encryption_config.role_arn #=> String
2219
+ # resp.encryption_config.kms_key_arn #=> String
2220
+ # resp.reference_predictor_summary.arn #=> String
2221
+ # resp.reference_predictor_summary.state #=> String, one of "Active", "Deleted"
2222
+ # resp.estimated_time_remaining_in_minutes #=> Integer
2223
+ # resp.status #=> String
2224
+ # resp.message #=> String
2225
+ # resp.creation_time #=> Time
2226
+ # resp.last_modification_time #=> Time
2227
+ # resp.optimization_metric #=> String, one of "WAPE", "RMSE", "AverageWeightedQuantileLoss", "MASE", "MAPE"
2228
+ # resp.explainability_info.explainability_arn #=> String
2229
+ # resp.explainability_info.status #=> String
2230
+ #
2231
+ # @see http://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/DescribeAutoPredictor AWS API Documentation
2232
+ #
2233
+ # @overload describe_auto_predictor(params = {})
2234
+ # @param [Hash] params ({})
2235
+ def describe_auto_predictor(params = {}, options = {})
2236
+ req = build_request(:describe_auto_predictor, params)
2237
+ req.send_request(options)
2238
+ end
2239
+
1622
2240
  # Describes an Amazon Forecast dataset created using the CreateDataset
1623
2241
  # operation.
1624
2242
  #
@@ -1819,6 +2437,111 @@ module Aws::ForecastService
1819
2437
  req.send_request(options)
1820
2438
  end
1821
2439
 
2440
+ # Describes an Explainability resource created using the
2441
+ # CreateExplainability operation.
2442
+ #
2443
+ # @option params [required, String] :explainability_arn
2444
+ # The Amazon Resource Name (ARN) of the Explaianability to describe.
2445
+ #
2446
+ # @return [Types::DescribeExplainabilityResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
2447
+ #
2448
+ # * {Types::DescribeExplainabilityResponse#explainability_arn #explainability_arn} => String
2449
+ # * {Types::DescribeExplainabilityResponse#explainability_name #explainability_name} => String
2450
+ # * {Types::DescribeExplainabilityResponse#resource_arn #resource_arn} => String
2451
+ # * {Types::DescribeExplainabilityResponse#explainability_config #explainability_config} => Types::ExplainabilityConfig
2452
+ # * {Types::DescribeExplainabilityResponse#enable_visualization #enable_visualization} => Boolean
2453
+ # * {Types::DescribeExplainabilityResponse#data_source #data_source} => Types::DataSource
2454
+ # * {Types::DescribeExplainabilityResponse#schema #schema} => Types::Schema
2455
+ # * {Types::DescribeExplainabilityResponse#start_date_time #start_date_time} => String
2456
+ # * {Types::DescribeExplainabilityResponse#end_date_time #end_date_time} => String
2457
+ # * {Types::DescribeExplainabilityResponse#estimated_time_remaining_in_minutes #estimated_time_remaining_in_minutes} => Integer
2458
+ # * {Types::DescribeExplainabilityResponse#message #message} => String
2459
+ # * {Types::DescribeExplainabilityResponse#status #status} => String
2460
+ # * {Types::DescribeExplainabilityResponse#creation_time #creation_time} => Time
2461
+ # * {Types::DescribeExplainabilityResponse#last_modification_time #last_modification_time} => Time
2462
+ #
2463
+ # @example Request syntax with placeholder values
2464
+ #
2465
+ # resp = client.describe_explainability({
2466
+ # explainability_arn: "Arn", # required
2467
+ # })
2468
+ #
2469
+ # @example Response structure
2470
+ #
2471
+ # resp.explainability_arn #=> String
2472
+ # resp.explainability_name #=> String
2473
+ # resp.resource_arn #=> String
2474
+ # resp.explainability_config.time_series_granularity #=> String, one of "ALL", "SPECIFIC"
2475
+ # resp.explainability_config.time_point_granularity #=> String, one of "ALL", "SPECIFIC"
2476
+ # resp.enable_visualization #=> Boolean
2477
+ # resp.data_source.s3_config.path #=> String
2478
+ # resp.data_source.s3_config.role_arn #=> String
2479
+ # resp.data_source.s3_config.kms_key_arn #=> String
2480
+ # resp.schema.attributes #=> Array
2481
+ # resp.schema.attributes[0].attribute_name #=> String
2482
+ # resp.schema.attributes[0].attribute_type #=> String, one of "string", "integer", "float", "timestamp", "geolocation"
2483
+ # resp.start_date_time #=> String
2484
+ # resp.end_date_time #=> String
2485
+ # resp.estimated_time_remaining_in_minutes #=> Integer
2486
+ # resp.message #=> String
2487
+ # resp.status #=> String
2488
+ # resp.creation_time #=> Time
2489
+ # resp.last_modification_time #=> Time
2490
+ #
2491
+ # @see http://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/DescribeExplainability AWS API Documentation
2492
+ #
2493
+ # @overload describe_explainability(params = {})
2494
+ # @param [Hash] params ({})
2495
+ def describe_explainability(params = {}, options = {})
2496
+ req = build_request(:describe_explainability, params)
2497
+ req.send_request(options)
2498
+ end
2499
+
2500
+ # Describes an Explainability export created using the
2501
+ # CreateExplainabilityExport operation.
2502
+ #
2503
+ # @option params [required, String] :explainability_export_arn
2504
+ # The Amazon Resource Name (ARN) of the Explainability export.
2505
+ #
2506
+ # @return [Types::DescribeExplainabilityExportResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
2507
+ #
2508
+ # * {Types::DescribeExplainabilityExportResponse#explainability_export_arn #explainability_export_arn} => String
2509
+ # * {Types::DescribeExplainabilityExportResponse#explainability_export_name #explainability_export_name} => String
2510
+ # * {Types::DescribeExplainabilityExportResponse#explainability_arn #explainability_arn} => String
2511
+ # * {Types::DescribeExplainabilityExportResponse#destination #destination} => Types::DataDestination
2512
+ # * {Types::DescribeExplainabilityExportResponse#message #message} => String
2513
+ # * {Types::DescribeExplainabilityExportResponse#status #status} => String
2514
+ # * {Types::DescribeExplainabilityExportResponse#creation_time #creation_time} => Time
2515
+ # * {Types::DescribeExplainabilityExportResponse#last_modification_time #last_modification_time} => Time
2516
+ #
2517
+ # @example Request syntax with placeholder values
2518
+ #
2519
+ # resp = client.describe_explainability_export({
2520
+ # explainability_export_arn: "Arn", # required
2521
+ # })
2522
+ #
2523
+ # @example Response structure
2524
+ #
2525
+ # resp.explainability_export_arn #=> String
2526
+ # resp.explainability_export_name #=> String
2527
+ # resp.explainability_arn #=> String
2528
+ # resp.destination.s3_config.path #=> String
2529
+ # resp.destination.s3_config.role_arn #=> String
2530
+ # resp.destination.s3_config.kms_key_arn #=> String
2531
+ # resp.message #=> String
2532
+ # resp.status #=> String
2533
+ # resp.creation_time #=> Time
2534
+ # resp.last_modification_time #=> Time
2535
+ #
2536
+ # @see http://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/DescribeExplainabilityExport AWS API Documentation
2537
+ #
2538
+ # @overload describe_explainability_export(params = {})
2539
+ # @param [Hash] params ({})
2540
+ def describe_explainability_export(params = {}, options = {})
2541
+ req = build_request(:describe_explainability_export, params)
2542
+ req.send_request(options)
2543
+ end
2544
+
1822
2545
  # Describes a forecast created using the CreateForecast operation.
1823
2546
  #
1824
2547
  # In addition to listing the properties provided in the `CreateForecast`
@@ -1937,6 +2660,12 @@ module Aws::ForecastService
1937
2660
  req.send_request(options)
1938
2661
  end
1939
2662
 
2663
+ # <note markdown="1"> This operation is only valid for legacy predictors created with
2664
+ # CreatePredictor. If you are not using a legacy predictor, use
2665
+ # DescribeAutoPredictor.
2666
+ #
2667
+ # </note>
2668
+ #
1940
2669
  # Describes a predictor created using the CreatePredictor operation.
1941
2670
  #
1942
2671
  # In addition to listing the properties provided in the
@@ -1966,6 +2695,7 @@ module Aws::ForecastService
1966
2695
  # * {Types::DescribePredictorResponse#predictor_arn #predictor_arn} => String
1967
2696
  # * {Types::DescribePredictorResponse#predictor_name #predictor_name} => String
1968
2697
  # * {Types::DescribePredictorResponse#algorithm_arn #algorithm_arn} => String
2698
+ # * {Types::DescribePredictorResponse#auto_ml_algorithm_arns #auto_ml_algorithm_arns} => Array&lt;String&gt;
1969
2699
  # * {Types::DescribePredictorResponse#forecast_horizon #forecast_horizon} => Integer
1970
2700
  # * {Types::DescribePredictorResponse#forecast_types #forecast_types} => Array&lt;String&gt;
1971
2701
  # * {Types::DescribePredictorResponse#perform_auto_ml #perform_auto_ml} => Boolean
@@ -1979,8 +2709,8 @@ module Aws::ForecastService
1979
2709
  # * {Types::DescribePredictorResponse#encryption_config #encryption_config} => Types::EncryptionConfig
1980
2710
  # * {Types::DescribePredictorResponse#predictor_execution_details #predictor_execution_details} => Types::PredictorExecutionDetails
1981
2711
  # * {Types::DescribePredictorResponse#estimated_time_remaining_in_minutes #estimated_time_remaining_in_minutes} => Integer
2712
+ # * {Types::DescribePredictorResponse#is_auto_predictor #is_auto_predictor} => Boolean
1982
2713
  # * {Types::DescribePredictorResponse#dataset_import_job_arns #dataset_import_job_arns} => Array&lt;String&gt;
1983
- # * {Types::DescribePredictorResponse#auto_ml_algorithm_arns #auto_ml_algorithm_arns} => Array&lt;String&gt;
1984
2714
  # * {Types::DescribePredictorResponse#status #status} => String
1985
2715
  # * {Types::DescribePredictorResponse#message #message} => String
1986
2716
  # * {Types::DescribePredictorResponse#creation_time #creation_time} => Time
@@ -1998,11 +2728,13 @@ module Aws::ForecastService
1998
2728
  # resp.predictor_arn #=> String
1999
2729
  # resp.predictor_name #=> String
2000
2730
  # resp.algorithm_arn #=> String
2731
+ # resp.auto_ml_algorithm_arns #=> Array
2732
+ # resp.auto_ml_algorithm_arns[0] #=> String
2001
2733
  # resp.forecast_horizon #=> Integer
2002
2734
  # resp.forecast_types #=> Array
2003
2735
  # resp.forecast_types[0] #=> String
2004
2736
  # resp.perform_auto_ml #=> Boolean
2005
- # resp.auto_ml_override_strategy #=> String, one of "LatencyOptimized"
2737
+ # resp.auto_ml_override_strategy #=> String, one of "LatencyOptimized", "AccuracyOptimized"
2006
2738
  # resp.perform_hpo #=> Boolean
2007
2739
  # resp.training_parameters #=> Hash
2008
2740
  # resp.training_parameters["ParameterKey"] #=> String
@@ -2045,10 +2777,9 @@ module Aws::ForecastService
2045
2777
  # resp.predictor_execution_details.predictor_executions[0].test_windows[0].status #=> String
2046
2778
  # resp.predictor_execution_details.predictor_executions[0].test_windows[0].message #=> String
2047
2779
  # resp.estimated_time_remaining_in_minutes #=> Integer
2780
+ # resp.is_auto_predictor #=> Boolean
2048
2781
  # resp.dataset_import_job_arns #=> Array
2049
2782
  # resp.dataset_import_job_arns[0] #=> String
2050
- # resp.auto_ml_algorithm_arns #=> Array
2051
- # resp.auto_ml_algorithm_arns[0] #=> String
2052
2783
  # resp.status #=> String
2053
2784
  # resp.message #=> String
2054
2785
  # resp.creation_time #=> Time
@@ -2155,6 +2886,7 @@ module Aws::ForecastService
2155
2886
  # @return [Types::GetAccuracyMetricsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
2156
2887
  #
2157
2888
  # * {Types::GetAccuracyMetricsResponse#predictor_evaluation_results #predictor_evaluation_results} => Array&lt;Types::EvaluationResult&gt;
2889
+ # * {Types::GetAccuracyMetricsResponse#is_auto_predictor #is_auto_predictor} => Boolean
2158
2890
  # * {Types::GetAccuracyMetricsResponse#auto_ml_override_strategy #auto_ml_override_strategy} => String
2159
2891
  # * {Types::GetAccuracyMetricsResponse#optimization_metric #optimization_metric} => String
2160
2892
  #
@@ -2184,7 +2916,8 @@ module Aws::ForecastService
2184
2916
  # resp.predictor_evaluation_results[0].test_windows[0].metrics.error_metrics[0].mase #=> Float
2185
2917
  # resp.predictor_evaluation_results[0].test_windows[0].metrics.error_metrics[0].mape #=> Float
2186
2918
  # resp.predictor_evaluation_results[0].test_windows[0].metrics.average_weighted_quantile_loss #=> Float
2187
- # resp.auto_ml_override_strategy #=> String, one of "LatencyOptimized"
2919
+ # resp.is_auto_predictor #=> Boolean
2920
+ # resp.auto_ml_override_strategy #=> String, one of "LatencyOptimized", "AccuracyOptimized"
2188
2921
  # resp.optimization_metric #=> String, one of "WAPE", "RMSE", "AverageWeightedQuantileLoss", "MASE", "MAPE"
2189
2922
  #
2190
2923
  # @see http://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/GetAccuracyMetrics AWS API Documentation
@@ -2372,6 +3105,156 @@ module Aws::ForecastService
2372
3105
  req.send_request(options)
2373
3106
  end
2374
3107
 
3108
+ # Returns a list of Explainability resources created using the
3109
+ # CreateExplainability operation. This operation returns a summary for
3110
+ # each Explainability. You can filter the list using an array of Filter
3111
+ # objects.
3112
+ #
3113
+ # To retrieve the complete set of properties for a particular
3114
+ # Explainability resource, use the ARN with the DescribeExplainability
3115
+ # operation.
3116
+ #
3117
+ # @option params [String] :next_token
3118
+ # If the result of the previous request was truncated, the response
3119
+ # includes a NextToken. To retrieve the next set of results, use the
3120
+ # token in the next request. Tokens expire after 24 hours.
3121
+ #
3122
+ # @option params [Integer] :max_results
3123
+ # The number of items returned in the response.
3124
+ #
3125
+ # @option params [Array<Types::Filter>] :filters
3126
+ # An array of filters. For each filter, provide a condition and a match
3127
+ # statement. The condition is either `IS` or `IS_NOT`, which specifies
3128
+ # whether to include or exclude the resources that match the statement
3129
+ # from the list. The match statement consists of a key and a value.
3130
+ #
3131
+ # **Filter properties**
3132
+ #
3133
+ # * `Condition` - The condition to apply. Valid values are `IS` and
3134
+ # `IS_NOT`.
3135
+ #
3136
+ # * `Key` - The name of the parameter to filter on. Valid values are
3137
+ # `ResourceArn` and `Status`.
3138
+ #
3139
+ # * `Value` - The value to match.
3140
+ #
3141
+ # @return [Types::ListExplainabilitiesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
3142
+ #
3143
+ # * {Types::ListExplainabilitiesResponse#explainabilities #explainabilities} => Array&lt;Types::ExplainabilitySummary&gt;
3144
+ # * {Types::ListExplainabilitiesResponse#next_token #next_token} => String
3145
+ #
3146
+ # @example Request syntax with placeholder values
3147
+ #
3148
+ # resp = client.list_explainabilities({
3149
+ # next_token: "NextToken",
3150
+ # max_results: 1,
3151
+ # filters: [
3152
+ # {
3153
+ # key: "String", # required
3154
+ # value: "Arn", # required
3155
+ # condition: "IS", # required, accepts IS, IS_NOT
3156
+ # },
3157
+ # ],
3158
+ # })
3159
+ #
3160
+ # @example Response structure
3161
+ #
3162
+ # resp.explainabilities #=> Array
3163
+ # resp.explainabilities[0].explainability_arn #=> String
3164
+ # resp.explainabilities[0].explainability_name #=> String
3165
+ # resp.explainabilities[0].resource_arn #=> String
3166
+ # resp.explainabilities[0].explainability_config.time_series_granularity #=> String, one of "ALL", "SPECIFIC"
3167
+ # resp.explainabilities[0].explainability_config.time_point_granularity #=> String, one of "ALL", "SPECIFIC"
3168
+ # resp.explainabilities[0].status #=> String
3169
+ # resp.explainabilities[0].message #=> String
3170
+ # resp.explainabilities[0].creation_time #=> Time
3171
+ # resp.explainabilities[0].last_modification_time #=> Time
3172
+ # resp.next_token #=> String
3173
+ #
3174
+ # @see http://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/ListExplainabilities AWS API Documentation
3175
+ #
3176
+ # @overload list_explainabilities(params = {})
3177
+ # @param [Hash] params ({})
3178
+ def list_explainabilities(params = {}, options = {})
3179
+ req = build_request(:list_explainabilities, params)
3180
+ req.send_request(options)
3181
+ end
3182
+
3183
+ # Returns a list of Explainability exports created using the
3184
+ # CreateExplainabilityExport operation. This operation returns a summary
3185
+ # for each Explainability export. You can filter the list using an array
3186
+ # of Filter objects.
3187
+ #
3188
+ # To retrieve the complete set of properties for a particular
3189
+ # Explainability export, use the ARN with the DescribeExplainability
3190
+ # operation.
3191
+ #
3192
+ # @option params [String] :next_token
3193
+ # If the result of the previous request was truncated, the response
3194
+ # includes a NextToken. To retrieve the next set of results, use the
3195
+ # token in the next request. Tokens expire after 24 hours.
3196
+ #
3197
+ # @option params [Integer] :max_results
3198
+ # The number of items to return in the response.
3199
+ #
3200
+ # @option params [Array<Types::Filter>] :filters
3201
+ # An array of filters. For each filter, provide a condition and a match
3202
+ # statement. The condition is either `IS` or `IS_NOT`, which specifies
3203
+ # whether to include or exclude resources that match the statement from
3204
+ # the list. The match statement consists of a key and a value.
3205
+ #
3206
+ # **Filter properties**
3207
+ #
3208
+ # * `Condition` - The condition to apply. Valid values are `IS` and
3209
+ # `IS_NOT`.
3210
+ #
3211
+ # * `Key` - The name of the parameter to filter on. Valid values are
3212
+ # `ResourceArn` and `Status`.
3213
+ #
3214
+ # * `Value` - The value to match.
3215
+ #
3216
+ # @return [Types::ListExplainabilityExportsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
3217
+ #
3218
+ # * {Types::ListExplainabilityExportsResponse#explainability_exports #explainability_exports} => Array&lt;Types::ExplainabilityExportSummary&gt;
3219
+ # * {Types::ListExplainabilityExportsResponse#next_token #next_token} => String
3220
+ #
3221
+ # @example Request syntax with placeholder values
3222
+ #
3223
+ # resp = client.list_explainability_exports({
3224
+ # next_token: "NextToken",
3225
+ # max_results: 1,
3226
+ # filters: [
3227
+ # {
3228
+ # key: "String", # required
3229
+ # value: "Arn", # required
3230
+ # condition: "IS", # required, accepts IS, IS_NOT
3231
+ # },
3232
+ # ],
3233
+ # })
3234
+ #
3235
+ # @example Response structure
3236
+ #
3237
+ # resp.explainability_exports #=> Array
3238
+ # resp.explainability_exports[0].explainability_export_arn #=> String
3239
+ # resp.explainability_exports[0].explainability_export_name #=> String
3240
+ # resp.explainability_exports[0].destination.s3_config.path #=> String
3241
+ # resp.explainability_exports[0].destination.s3_config.role_arn #=> String
3242
+ # resp.explainability_exports[0].destination.s3_config.kms_key_arn #=> String
3243
+ # resp.explainability_exports[0].status #=> String
3244
+ # resp.explainability_exports[0].message #=> String
3245
+ # resp.explainability_exports[0].creation_time #=> Time
3246
+ # resp.explainability_exports[0].last_modification_time #=> Time
3247
+ # resp.next_token #=> String
3248
+ #
3249
+ # @see http://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/ListExplainabilityExports AWS API Documentation
3250
+ #
3251
+ # @overload list_explainability_exports(params = {})
3252
+ # @param [Hash] params ({})
3253
+ def list_explainability_exports(params = {}, options = {})
3254
+ req = build_request(:list_explainability_exports, params)
3255
+ req.send_request(options)
3256
+ end
3257
+
2375
3258
  # Returns a list of forecast export jobs created using the
2376
3259
  # CreateForecastExportJob operation. For each forecast export job, this
2377
3260
  # operation returns a summary of its properties, including its Amazon
@@ -2522,6 +3405,7 @@ module Aws::ForecastService
2522
3405
  # resp.forecasts[0].forecast_arn #=> String
2523
3406
  # resp.forecasts[0].forecast_name #=> String
2524
3407
  # resp.forecasts[0].predictor_arn #=> String
3408
+ # resp.forecasts[0].created_using_auto_predictor #=> Boolean
2525
3409
  # resp.forecasts[0].dataset_group_arn #=> String
2526
3410
  # resp.forecasts[0].status #=> String
2527
3411
  # resp.forecasts[0].message #=> String
@@ -2618,12 +3502,13 @@ module Aws::ForecastService
2618
3502
  req.send_request(options)
2619
3503
  end
2620
3504
 
2621
- # Returns a list of predictors created using the CreatePredictor
2622
- # operation. For each predictor, this operation returns a summary of its
2623
- # properties, including its Amazon Resource Name (ARN). You can retrieve
2624
- # the complete set of properties by using the ARN with the
2625
- # DescribePredictor operation. You can filter the list using an array of
2626
- # Filter objects.
3505
+ # Returns a list of predictors created using the CreateAutoPredictor or
3506
+ # CreatePredictor operations. For each predictor, this operation returns
3507
+ # a summary of its properties, including its Amazon Resource Name (ARN).
3508
+ #
3509
+ # You can retrieve the complete set of properties by using the ARN with
3510
+ # the DescribeAutoPredictor and DescribePredictor operations. You can
3511
+ # filter the list using an array of Filter objects.
2627
3512
  #
2628
3513
  # @option params [String] :next_token
2629
3514
  # If the result of the previous request was truncated, the response
@@ -2684,6 +3569,9 @@ module Aws::ForecastService
2684
3569
  # resp.predictors[0].predictor_arn #=> String
2685
3570
  # resp.predictors[0].predictor_name #=> String
2686
3571
  # resp.predictors[0].dataset_group_arn #=> String
3572
+ # resp.predictors[0].is_auto_predictor #=> Boolean
3573
+ # resp.predictors[0].reference_predictor_summary.arn #=> String
3574
+ # resp.predictors[0].reference_predictor_summary.state #=> String, one of "Active", "Deleted"
2687
3575
  # resp.predictors[0].status #=> String
2688
3576
  # resp.predictors[0].message #=> String
2689
3577
  # resp.predictors[0].creation_time #=> Time
@@ -2703,9 +3591,7 @@ module Aws::ForecastService
2703
3591
  #
2704
3592
  # @option params [required, String] :resource_arn
2705
3593
  # The Amazon Resource Name (ARN) that identifies the resource for which
2706
- # to list the tags. Currently, the supported resources are Forecast
2707
- # dataset groups, datasets, dataset import jobs, predictors, forecasts,
2708
- # and forecast export jobs.
3594
+ # to list the tags.
2709
3595
  #
2710
3596
  # @return [Types::ListTagsForResourceResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
2711
3597
  #
@@ -2751,11 +3637,16 @@ module Aws::ForecastService
2751
3637
  #
2752
3638
  # * Predictor Backtest Export Job
2753
3639
  #
3640
+ # * Explainability Job
3641
+ #
3642
+ # * Explainability Export Job
3643
+ #
2754
3644
  # @option params [required, String] :resource_arn
2755
3645
  # The Amazon Resource Name (ARN) that identifies the resource to stop.
2756
3646
  # The supported ARNs are `DatasetImportJobArn`, `PredictorArn`,
2757
- # `PredictorBacktestExportJobArn`, `ForecastArn`, and
2758
- # `ForecastExportJobArn`.
3647
+ # `PredictorBacktestExportJobArn`, `ForecastArn`,
3648
+ # `ForecastExportJobArn`, `ExplainabilityArn`, and
3649
+ # `ExplainabilityExportArn`.
2759
3650
  #
2760
3651
  # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
2761
3652
  #
@@ -2781,9 +3672,7 @@ module Aws::ForecastService
2781
3672
  #
2782
3673
  # @option params [required, String] :resource_arn
2783
3674
  # The Amazon Resource Name (ARN) that identifies the resource for which
2784
- # to list the tags. Currently, the supported resources are Forecast
2785
- # dataset groups, datasets, dataset import jobs, predictors, forecasts,
2786
- # and forecast export jobs.
3675
+ # to list the tags.
2787
3676
  #
2788
3677
  # @option params [required, Array<Types::Tag>] :tags
2789
3678
  # The tags to add to the resource. A tag is an array of key-value pairs.
@@ -2842,9 +3731,7 @@ module Aws::ForecastService
2842
3731
  #
2843
3732
  # @option params [required, String] :resource_arn
2844
3733
  # The Amazon Resource Name (ARN) that identifies the resource for which
2845
- # to list the tags. Currently, the supported resources are Forecast
2846
- # dataset groups, datasets, dataset import jobs, predictors, forecasts,
2847
- # and forecast exports.
3734
+ # to list the tags.
2848
3735
  #
2849
3736
  # @option params [required, Array<String>] :tag_keys
2850
3737
  # The keys of the tags to be removed.
@@ -2913,7 +3800,7 @@ module Aws::ForecastService
2913
3800
  params: params,
2914
3801
  config: config)
2915
3802
  context[:gem_name] = 'aws-sdk-forecastservice'
2916
- context[:gem_version] = '1.27.0'
3803
+ context[:gem_version] = '1.31.0'
2917
3804
  Seahorse::Client::Request.new(handlers, context)
2918
3805
  end
2919
3806