aws-sdk-forecastservice 1.0.0 → 1.5.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
- SHA1:
3
- metadata.gz: 0f6a8f3f456cac0d2acead080cc4cccfa4b792fb
4
- data.tar.gz: 8b12f08355294e952c40c05eb031f0e37525dfed
2
+ SHA256:
3
+ metadata.gz: f5fdc20c630a2a716d69aafa8f12c100e1e00898b3c49697f1cba2c74ac59ced
4
+ data.tar.gz: 076cf704451389213f883696c550c6f19b855dac76ef76c2745f8d49979a4238
5
5
  SHA512:
6
- metadata.gz: 30c98fbd12eb339df5b6eaa0bfcf86d37bbdd1318fa604ef2a42520f171610e773ea24e11618828f5c02994ddc2a797867d5b017c815f364dea141b88abe232c
7
- data.tar.gz: 1d0db6216a5364ffeaa9b54414ee0c67019139d0e8758ed27c3472975ece25e1c327becfc98c3de02e2bfdc27b94e48ccadda5bf032a56cc098bb132148bd4f0
6
+ metadata.gz: 17226b5a013d1d70ecc2d346268e7245a008edaea671c57e8b63926c2f75373db1b6d9060694ea2c747b778192910618b831c8861b8b3cf6e1fa26b3dd837830
7
+ data.tar.gz: 9545ba9b5221ad7945525c943be739eba2b22b79a5c2b48f2ce1c243f8aabdcc72412cd8e24f51448361d9fcf730425df0bc6f7b462fdf9d596ca1260da52209
@@ -24,17 +24,20 @@ require_relative 'aws-sdk-forecastservice/customizations'
24
24
  # methods each accept a hash of request parameters and return a response
25
25
  # structure.
26
26
  #
27
+ # forecast_service = Aws::ForecastService::Client.new
28
+ # resp = forecast_service.create_dataset(params)
29
+ #
27
30
  # See {Client} for more information.
28
31
  #
29
32
  # # Errors
30
33
  #
31
- # Errors returned from Amazon Forecast Service all
32
- # extend {Errors::ServiceError}.
34
+ # Errors returned from Amazon Forecast Service are defined in the
35
+ # {Errors} module and all extend {Errors::ServiceError}.
33
36
  #
34
37
  # begin
35
38
  # # do stuff
36
39
  # rescue Aws::ForecastService::Errors::ServiceError
37
- # # rescues all service API errors
40
+ # # rescues all Amazon Forecast Service API errors
38
41
  # end
39
42
  #
40
43
  # See {Errors} for more information.
@@ -42,6 +45,6 @@ require_relative 'aws-sdk-forecastservice/customizations'
42
45
  # @service
43
46
  module Aws::ForecastService
44
47
 
45
- GEM_VERSION = '1.0.0'
48
+ GEM_VERSION = '1.5.0'
46
49
 
47
50
  end
@@ -30,6 +30,18 @@ require 'aws-sdk-core/plugins/protocols/json_rpc.rb'
30
30
  Aws::Plugins::GlobalConfiguration.add_identifier(:forecastservice)
31
31
 
32
32
  module Aws::ForecastService
33
+ # An API client for ForecastService. To construct a client, you need to configure a `:region` and `:credentials`.
34
+ #
35
+ # client = Aws::ForecastService::Client.new(
36
+ # region: region_name,
37
+ # credentials: credentials,
38
+ # # ...
39
+ # )
40
+ #
41
+ # For details on configuring region and credentials see
42
+ # the [developer guide](/sdk-for-ruby/v3/developer-guide/setup-config.html).
43
+ #
44
+ # See {#initialize} for a full list of supported configuration options.
33
45
  class Client < Seahorse::Client::Base
34
46
 
35
47
  include Aws::ClientStubs
@@ -93,7 +105,7 @@ module Aws::ForecastService
93
105
  # @option options [required, String] :region
94
106
  # The AWS region to connect to. The configured `:region` is
95
107
  # used to determine the service `:endpoint`. When not passed,
96
- # a default `:region` is search for in the following locations:
108
+ # a default `:region` is searched for in the following locations:
97
109
  #
98
110
  # * `Aws.config[:region]`
99
111
  # * `ENV['AWS_REGION']`
@@ -108,6 +120,12 @@ module Aws::ForecastService
108
120
  # When set to `true`, a thread polling for endpoints will be running in
109
121
  # the background every 60 secs (default). Defaults to `false`.
110
122
  #
123
+ # @option options [Boolean] :adaptive_retry_wait_to_fill (true)
124
+ # Used only in `adaptive` retry mode. When true, the request will sleep
125
+ # until there is sufficent client side capacity to retry the request.
126
+ # When false, the request will raise a `RetryCapacityNotAvailableError` and will
127
+ # not retry instead of sleeping.
128
+ #
111
129
  # @option options [Boolean] :client_side_monitoring (false)
112
130
  # When `true`, client-side metrics will be collected for all API requests from
113
131
  # this client.
@@ -132,6 +150,10 @@ module Aws::ForecastService
132
150
  # When `true`, an attempt is made to coerce request parameters into
133
151
  # the required types.
134
152
  #
153
+ # @option options [Boolean] :correct_clock_skew (true)
154
+ # Used only in `standard` and adaptive retry modes. Specifies whether to apply
155
+ # a clock skew correction and retry requests with skewed client clocks.
156
+ #
135
157
  # @option options [Boolean] :disable_host_prefix_injection (false)
136
158
  # Set to true to disable SDK automatically adding host prefix
137
159
  # to default service endpoint when available.
@@ -139,7 +161,7 @@ module Aws::ForecastService
139
161
  # @option options [String] :endpoint
140
162
  # The client endpoint is normally constructed from the `:region`
141
163
  # option. You should only configure an `:endpoint` when connecting
142
- # to test endpoints. This should be avalid HTTP(S) URI.
164
+ # to test endpoints. This should be a valid HTTP(S) URI.
143
165
  #
144
166
  # @option options [Integer] :endpoint_cache_max_entries (1000)
145
167
  # Used for the maximum size limit of the LRU cache storing endpoints data
@@ -154,7 +176,7 @@ module Aws::ForecastService
154
176
  # requests fetching endpoints information. Defaults to 60 sec.
155
177
  #
156
178
  # @option options [Boolean] :endpoint_discovery (false)
157
- # When set to `true`, endpoint discovery will be enabled for operations when available. Defaults to `false`.
179
+ # When set to `true`, endpoint discovery will be enabled for operations when available.
158
180
  #
159
181
  # @option options [Aws::Log::Formatter] :log_formatter (Aws::Log::Formatter.default)
160
182
  # The log formatter.
@@ -166,15 +188,29 @@ module Aws::ForecastService
166
188
  # The Logger instance to send log messages to. If this option
167
189
  # is not set, logging will be disabled.
168
190
  #
191
+ # @option options [Integer] :max_attempts (3)
192
+ # An integer representing the maximum number attempts that will be made for
193
+ # a single request, including the initial attempt. For example,
194
+ # setting this value to 5 will result in a request being retried up to
195
+ # 4 times. Used in `standard` and `adaptive` retry modes.
196
+ #
169
197
  # @option options [String] :profile ("default")
170
198
  # Used when loading credentials from the shared credentials file
171
199
  # at HOME/.aws/credentials. When not specified, 'default' is used.
172
200
  #
201
+ # @option options [Proc] :retry_backoff
202
+ # A proc or lambda used for backoff. Defaults to 2**retries * retry_base_delay.
203
+ # This option is only used in the `legacy` retry mode.
204
+ #
173
205
  # @option options [Float] :retry_base_delay (0.3)
174
- # The base delay in seconds used by the default backoff function.
206
+ # The base delay in seconds used by the default backoff function. This option
207
+ # is only used in the `legacy` retry mode.
175
208
  #
176
209
  # @option options [Symbol] :retry_jitter (:none)
177
- # A delay randomiser function used by the default backoff function. Some predefined functions can be referenced by name - :none, :equal, :full, otherwise a Proc that takes and returns a number.
210
+ # A delay randomiser function used by the default backoff function.
211
+ # Some predefined functions can be referenced by name - :none, :equal, :full,
212
+ # otherwise a Proc that takes and returns a number. This option is only used
213
+ # in the `legacy` retry mode.
178
214
  #
179
215
  # @see https://www.awsarchitectureblog.com/2015/03/backoff.html
180
216
  #
@@ -182,11 +218,30 @@ module Aws::ForecastService
182
218
  # The maximum number of times to retry failed requests. Only
183
219
  # ~ 500 level server errors and certain ~ 400 level client errors
184
220
  # are retried. Generally, these are throttling errors, data
185
- # checksum errors, networking errors, timeout errors and auth
186
- # errors from expired credentials.
221
+ # checksum errors, networking errors, timeout errors, auth errors,
222
+ # endpoint discovery, and errors from expired credentials.
223
+ # This option is only used in the `legacy` retry mode.
187
224
  #
188
225
  # @option options [Integer] :retry_max_delay (0)
189
- # The maximum number of seconds to delay between retries (0 for no limit) used by the default backoff function.
226
+ # The maximum number of seconds to delay between retries (0 for no limit)
227
+ # used by the default backoff function. This option is only used in the
228
+ # `legacy` retry mode.
229
+ #
230
+ # @option options [String] :retry_mode ("legacy")
231
+ # Specifies which retry algorithm to use. Values are:
232
+ #
233
+ # * `legacy` - The pre-existing retry behavior. This is default value if
234
+ # no retry mode is provided.
235
+ #
236
+ # * `standard` - A standardized set of retry rules across the AWS SDKs.
237
+ # This includes support for retry quotas, which limit the number of
238
+ # unsuccessful retries a client can make.
239
+ #
240
+ # * `adaptive` - An experimental retry mode that includes all the
241
+ # functionality of `standard` mode along with automatic client side
242
+ # throttling. This is a provisional mode that may change behavior
243
+ # in the future.
244
+ #
190
245
  #
191
246
  # @option options [String] :secret_access_key
192
247
  #
@@ -219,16 +274,15 @@ module Aws::ForecastService
219
274
  # requests through. Formatted like 'http://proxy.com:123'.
220
275
  #
221
276
  # @option options [Float] :http_open_timeout (15) The number of
222
- # seconds to wait when opening a HTTP session before rasing a
277
+ # seconds to wait when opening a HTTP session before raising a
223
278
  # `Timeout::Error`.
224
279
  #
225
280
  # @option options [Integer] :http_read_timeout (60) The default
226
281
  # number of seconds to wait for response data. This value can
227
- # safely be set
228
- # per-request on the session yeidled by {#session_for}.
282
+ # safely be set per-request on the session.
229
283
  #
230
284
  # @option options [Float] :http_idle_timeout (5) The number of
231
- # seconds a connection is allowed to sit idble before it is
285
+ # seconds a connection is allowed to sit idle before it is
232
286
  # considered stale. Stale connections are closed and removed
233
287
  # from the pool before making a request.
234
288
  #
@@ -237,7 +291,7 @@ module Aws::ForecastService
237
291
  # request body. This option has no effect unless the request has
238
292
  # "Expect" header set to "100-continue". Defaults to `nil` which
239
293
  # disables this behaviour. This value can safely be set per
240
- # request on the session yeidled by {#session_for}.
294
+ # request on the session.
241
295
  #
242
296
  # @option options [Boolean] :http_wire_trace (false) When `true`,
243
297
  # HTTP debug output will be sent to the `:logger`.
@@ -269,8 +323,7 @@ module Aws::ForecastService
269
323
  # model training. This includes the following:
270
324
  #
271
325
  # * <i> <code>DataFrequency</code> </i> - How frequently your historical
272
- # time-series data is collected. Amazon Forecast uses this information
273
- # when training the model and generating a forecast.
326
+ # time-series data is collected.
274
327
  #
275
328
  # * <i> <code>Domain</code> </i> and <i> <code>DatasetType</code> </i> -
276
329
  # Each dataset has an associated dataset domain and a type within the
@@ -279,38 +332,49 @@ module Aws::ForecastService
279
332
  # within the domain, Amazon Forecast requires your data to include a
280
333
  # minimum set of predefined fields.
281
334
  #
282
- # * <i> <code>Schema</code> </i> - A schema specifies the fields of the
335
+ # * <i> <code>Schema</code> </i> - A schema specifies the fields in the
283
336
  # dataset, including the field name and data type.
284
337
  #
285
- # After creating a dataset, you import your training data into the
286
- # dataset and add the dataset to a dataset group. You then use the
287
- # dataset group to create a predictor. For more information, see
338
+ # After creating a dataset, you import your training data into it and
339
+ # add the dataset to a dataset group. You use the dataset group to
340
+ # create a predictor. For more information, see
288
341
  # howitworks-datasets-groups.
289
342
  #
290
343
  # To get a list of all your datasets, use the ListDatasets operation.
291
344
  #
345
+ # For example Forecast datasets, see the [Amazon Forecast Sample GitHub
346
+ # repository][1].
347
+ #
292
348
  # <note markdown="1"> The `Status` of a dataset must be `ACTIVE` before you can import
293
349
  # training data. Use the DescribeDataset operation to get the status.
294
350
  #
295
351
  # </note>
296
352
  #
353
+ #
354
+ #
355
+ # [1]: https://github.com/aws-samples/amazon-forecast-samples/tree/master/data
356
+ #
297
357
  # @option params [required, String] :dataset_name
298
358
  # A name for the dataset.
299
359
  #
300
360
  # @option params [required, String] :domain
301
- # The domain associated with the dataset. The `Domain` and `DatasetType`
302
- # that you choose determine the fields that must be present in the
303
- # training data that you import to the dataset. For example, if you
304
- # choose the `RETAIL` domain and `TARGET_TIME_SERIES` as the
305
- # `DatasetType`, Amazon Forecast requires `item_id`, `timestamp`, and
306
- # `demand` fields to be present in your data. For more information, see
307
- # howitworks-datasets-groups.
361
+ # The domain associated with the dataset. When you add a dataset to a
362
+ # dataset group, this value and the value specified for the `Domain`
363
+ # parameter of the CreateDatasetGroup operation must match.
364
+ #
365
+ # The `Domain` and `DatasetType` that you choose determine the fields
366
+ # that must be present in the training data that you import to the
367
+ # dataset. For example, if you choose the `RETAIL` domain and
368
+ # `TARGET_TIME_SERIES` as the `DatasetType`, Amazon Forecast requires
369
+ # `item_id`, `timestamp`, and `demand` fields to be present in your
370
+ # data. For more information, see howitworks-datasets-groups.
308
371
  #
309
372
  # @option params [required, String] :dataset_type
310
373
  # The dataset type. Valid values depend on the chosen `Domain`.
311
374
  #
312
375
  # @option params [String] :data_frequency
313
- # The frequency of data collection.
376
+ # The frequency of data collection. This parameter is required for
377
+ # RELATED\_TIME\_SERIES datasets.
314
378
  #
315
379
  # Valid intervals are Y (Year), M (Month), W (Week), D (Day), H (Hour),
316
380
  # 30min (30 minutes), 15min (15 minutes), 10min (10 minutes), 5min (5
@@ -367,10 +431,9 @@ module Aws::ForecastService
367
431
  req.send_request(options)
368
432
  end
369
433
 
370
- # Creates an Amazon Forecast dataset group, which holds a collection of
371
- # related datasets. You can add datasets to the dataset group when you
372
- # create the dataset group, or you can add datasets later with the
373
- # UpdateDatasetGroup operation.
434
+ # Creates a dataset group, which holds a collection of related datasets.
435
+ # You can add datasets to the dataset group when you create the dataset
436
+ # group, or later by using the UpdateDatasetGroup operation.
374
437
  #
375
438
  # After creating a dataset group and adding datasets, you use the
376
439
  # dataset group when you create a predictor. For more information, see
@@ -380,8 +443,8 @@ module Aws::ForecastService
380
443
  # operation.
381
444
  #
382
445
  # <note markdown="1"> The `Status` of a dataset group must be `ACTIVE` before you can create
383
- # a predictor using the dataset group. Use the DescribeDatasetGroup
384
- # operation to get the status.
446
+ # use the dataset group to create a predictor. To get the status, use
447
+ # the DescribeDatasetGroup operation.
385
448
  #
386
449
  # </note>
387
450
  #
@@ -389,13 +452,16 @@ module Aws::ForecastService
389
452
  # A name for the dataset group.
390
453
  #
391
454
  # @option params [required, String] :domain
392
- # The domain associated with the dataset group. The `Domain` and
393
- # `DatasetType` that you choose determine the fields that must be
394
- # present in the training data that you import to the dataset. For
395
- # example, if you choose the `RETAIL` domain and `TARGET_TIME_SERIES` as
396
- # the `DatasetType`, Amazon Forecast requires `item_id`, `timestamp`,
397
- # and `demand` fields to be present in your data. For more information,
398
- # see howitworks-datasets-groups.
455
+ # The domain associated with the dataset group. When you add a dataset
456
+ # to a dataset group, this value and the value specified for the
457
+ # `Domain` parameter of the CreateDataset operation must match.
458
+ #
459
+ # The `Domain` and `DatasetType` that you choose determine the fields
460
+ # that must be present in training data that you import to a dataset.
461
+ # For example, if you choose the `RETAIL` domain and
462
+ # `TARGET_TIME_SERIES` as the `DatasetType`, Amazon Forecast requires
463
+ # that `item_id`, `timestamp`, and `demand` fields are present in your
464
+ # data. For more information, see howitworks-datasets-groups.
399
465
  #
400
466
  # @option params [Array<String>] :dataset_arns
401
467
  # An array of Amazon Resource Names (ARNs) of the datasets that you want
@@ -435,35 +501,21 @@ module Aws::ForecastService
435
501
  # Access Management (IAM) role that Amazon Forecast can assume to access
436
502
  # the data. For more information, see aws-forecast-iam-roles.
437
503
  #
438
- # Two properties of the training data are optionally specified:
439
- #
440
- # * The delimiter that separates the data fields.
441
- #
442
- # The default delimiter is a comma (,), which is the only supported
443
- # delimiter in this release.
444
- #
445
- # * The format of timestamps.
504
+ # The training data must be in CSV format. The delimiter must be a comma
505
+ # (,).
446
506
  #
447
- # If the format is not specified, Amazon Forecast expects the format
448
- # to be "yyyy-MM-dd HH:mm:ss".
507
+ # You can specify the path to a specific CSV file, the S3 bucket, or to
508
+ # a folder in the S3 bucket. For the latter two cases, Amazon Forecast
509
+ # imports all files up to the limit of 10,000 files.
449
510
  #
450
- # When Amazon Forecast uploads your training data, it verifies that the
451
- # data was collected at the `DataFrequency` specified when the target
452
- # dataset was created. For more information, see CreateDataset and
453
- # howitworks-datasets-groups. Amazon Forecast also verifies the
454
- # delimiter and timestamp format.
455
- #
456
- # You can use the ListDatasetImportJobs operation to get a list of all
457
- # your dataset import jobs, filtered by specified criteria.
458
- #
459
- # To get a list of all your dataset import jobs, filtered by the
460
- # specified criteria, use the ListDatasetGroups operation.
511
+ # To get a list of all your dataset import jobs, filtered by specified
512
+ # criteria, use the ListDatasetImportJobs operation.
461
513
  #
462
514
  # @option params [required, String] :dataset_import_job_name
463
- # The name for the dataset import job. It is recommended to include the
464
- # current timestamp in the name to guard against getting a
465
- # `ResourceAlreadyExistsException` exception, for example,
466
- # `20190721DatasetImport`.
515
+ # The name for the dataset import job. We recommend including the
516
+ # current timestamp in the name, for example, `20190721DatasetImport`.
517
+ # This can help you avoid getting a `ResourceAlreadyExistsException`
518
+ # exception.
467
519
  #
468
520
  # @option params [required, String] :dataset_arn
469
521
  # The Amazon Resource Name (ARN) of the Amazon Forecast dataset that you
@@ -472,21 +524,30 @@ module Aws::ForecastService
472
524
  # @option params [required, Types::DataSource] :data_source
473
525
  # The location of the training data to import and an AWS Identity and
474
526
  # Access Management (IAM) role that Amazon Forecast can assume to access
475
- # the data.
527
+ # the data. The training data must be stored in an Amazon S3 bucket.
528
+ #
529
+ # If encryption is used, `DataSource` must include an AWS Key Management
530
+ # Service (KMS) key and the IAM role must allow Amazon Forecast
531
+ # permission to access the key. The KMS key and IAM role must match
532
+ # those specified in the `EncryptionConfig` parameter of the
533
+ # CreateDataset operation.
476
534
  #
477
535
  # @option params [String] :timestamp_format
478
- # The format of timestamps in the dataset. Two formats are supported,
479
- # dependent on the `DataFrequency` specified when the dataset was
480
- # created.
536
+ # The format of timestamps in the dataset. The format that you specify
537
+ # depends on the `DataFrequency` specified when the dataset was created.
538
+ # The following formats are supported
481
539
  #
482
540
  # * "yyyy-MM-dd"
483
541
  #
484
- # For data frequencies: Y, M, W, and D
542
+ # For the following data frequencies: Y, M, W, and D
485
543
  #
486
544
  # * "yyyy-MM-dd HH:mm:ss"
487
545
  #
488
- # For data frequencies: H, 30min, 15min, and 1min; and optionally,
489
- # for: Y, M, W, and D
546
+ # For the following data frequencies: H, 30min, 15min, and 1min; and
547
+ # optionally, for: Y, M, W, and D
548
+ #
549
+ # If the format isn't specified, Amazon Forecast expects the format to
550
+ # be "yyyy-MM-dd HH:mm:ss".
490
551
  #
491
552
  # @return [Types::CreateDatasetImportJobResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
492
553
  #
@@ -524,19 +585,19 @@ module Aws::ForecastService
524
585
  # that was used to train the predictor. This is known as inference. To
525
586
  # retrieve the forecast for a single item at low latency, use the
526
587
  # operation. To export the complete forecast into your Amazon Simple
527
- # Storage Service (Amazon S3), use the CreateForecastExportJob
588
+ # Storage Service (Amazon S3) bucket, use the CreateForecastExportJob
528
589
  # operation.
529
590
  #
530
- # The range of the forecast is determined by the `ForecastHorizon`,
531
- # specified in the CreatePredictor request, multiplied by the
532
- # `DataFrequency`, specified in the CreateDataset request. When you
533
- # query a forecast, you can request a specific date range within the
534
- # complete forecast.
591
+ # The range of the forecast is determined by the `ForecastHorizon`
592
+ # value, which you specify in the CreatePredictor request, multiplied by
593
+ # the `DataFrequency` value, which you specify in the CreateDataset
594
+ # request. When you query a forecast, you can request a specific date
595
+ # range within the forecast.
535
596
  #
536
597
  # To get a list of all your forecasts, use the ListForecasts operation.
537
598
  #
538
- # <note markdown="1"> The forecasts generated by Amazon Forecast are in the same timezone as
539
- # the dataset that was used to create the predictor.
599
+ # <note markdown="1"> The forecasts generated by Amazon Forecast are in the same time zone
600
+ # as the dataset that was used to create the predictor.
540
601
  #
541
602
  # </note>
542
603
  #
@@ -549,12 +610,20 @@ module Aws::ForecastService
549
610
  # </note>
550
611
  #
551
612
  # @option params [required, String] :forecast_name
552
- # The name for the forecast.
613
+ # A name for the forecast.
553
614
  #
554
615
  # @option params [required, String] :predictor_arn
555
616
  # The Amazon Resource Name (ARN) of the predictor to use to generate the
556
617
  # forecast.
557
618
  #
619
+ # @option params [Array<String>] :forecast_types
620
+ # The quantiles at which probabilistic forecasts are generated. You can
621
+ # specify up to 5 quantiles per forecast. Accepted values include `0.01
622
+ # to 0.99` (increments of .01 only) and `mean`. The mean forecast is
623
+ # different from the median (0.50) when the distribution is not
624
+ # symmetric (e.g. Beta, Negative Binomial). The default value is
625
+ # `["0.1", "0.5", "0.9"]`.
626
+ #
558
627
  # @return [Types::CreateForecastResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
559
628
  #
560
629
  # * {Types::CreateForecastResponse#forecast_arn #forecast_arn} => String
@@ -564,6 +633,7 @@ module Aws::ForecastService
564
633
  # resp = client.create_forecast({
565
634
  # forecast_name: "Name", # required
566
635
  # predictor_arn: "Arn", # required
636
+ # forecast_types: ["ForecastType"],
567
637
  # })
568
638
  #
569
639
  # @example Response structure
@@ -580,7 +650,13 @@ module Aws::ForecastService
580
650
  end
581
651
 
582
652
  # Exports a forecast created by the CreateForecast operation to your
583
- # Amazon Simple Storage Service (Amazon S3) bucket.
653
+ # Amazon Simple Storage Service (Amazon S3) bucket. The forecast file
654
+ # name will match the following conventions:
655
+ #
656
+ # &lt;ForecastExportJobName&gt;\_&lt;ExportTimestamp&gt;\_&lt;PageNumber&gt;
657
+ #
658
+ # where the &lt;ExportTimestamp&gt; component is in Java
659
+ # SimpleDateFormat (yyyy-MM-ddTHH-mm-ssZ).
584
660
  #
585
661
  # You must specify a DataDestination object that includes an AWS
586
662
  # Identity and Access Management (IAM) role that Amazon Forecast can
@@ -593,8 +669,8 @@ module Aws::ForecastService
593
669
  # ListForecastExportJobs operation.
594
670
  #
595
671
  # <note markdown="1"> The `Status` of the forecast export job must be `ACTIVE` before you
596
- # can access the forecast in your Amazon S3 bucket. Use the
597
- # DescribeForecastExportJob operation to get the status.
672
+ # can access the forecast in your Amazon S3 bucket. To get the status,
673
+ # use the DescribeForecastExportJob operation.
598
674
  #
599
675
  # </note>
600
676
  #
@@ -606,9 +682,14 @@ module Aws::ForecastService
606
682
  # export.
607
683
  #
608
684
  # @option params [required, Types::DataDestination] :destination
609
- # The path to the Amazon S3 bucket where you want to save the forecast
610
- # and an AWS Identity and Access Management (IAM) role that Amazon
611
- # Forecast can assume to access the bucket.
685
+ # The location where you want to save the forecast and an AWS Identity
686
+ # and Access Management (IAM) role that Amazon Forecast can assume to
687
+ # access the location. The forecast must be exported to an Amazon S3
688
+ # bucket.
689
+ #
690
+ # If encryption is used, `Destination` must include an AWS Key
691
+ # Management Service (KMS) key. The IAM role must allow Amazon Forecast
692
+ # permission to access the key.
612
693
  #
613
694
  # @return [Types::CreateForecastExportJobResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
614
695
  #
@@ -659,15 +740,21 @@ module Aws::ForecastService
659
740
  # the predictor to generate a forecast.
660
741
  #
661
742
  # Optionally, you can specify a featurization configuration to fill and
662
- # aggragate the data fields in the `TARGET_TIME_SERIES` dataset to
743
+ # aggregate the data fields in the `TARGET_TIME_SERIES` dataset to
663
744
  # improve model training. For more information, see FeaturizationConfig.
664
745
  #
746
+ # For RELATED\_TIME\_SERIES datasets, `CreatePredictor` verifies that
747
+ # the `DataFrequency` specified when the dataset was created matches the
748
+ # `ForecastFrequency`. TARGET\_TIME\_SERIES datasets don't have this
749
+ # restriction. Amazon Forecast also verifies the delimiter and timestamp
750
+ # format. For more information, see howitworks-datasets-groups.
751
+ #
665
752
  # **AutoML**
666
753
  #
667
- # If you set `PerformAutoML` to `true`, Amazon Forecast evaluates each
668
- # algorithm and chooses the one that minimizes the `objective function`.
669
- # The `objective function` is defined as the mean of the weighted p10,
670
- # p50, and p90 quantile losses. For more information, see
754
+ # If you want Amazon Forecast to evaluate each algorithm and choose the
755
+ # one that minimizes the `objective function`, set `PerformAutoML` to
756
+ # `true`. The `objective function` is defined as the mean of the
757
+ # weighted p10, p50, and p90 quantile losses. For more information, see
671
758
  # EvaluationResult.
672
759
  #
673
760
  # When AutoML is enabled, the following properties are disallowed:
@@ -680,12 +767,12 @@ module Aws::ForecastService
680
767
  #
681
768
  # * `TrainingParameters`
682
769
  #
683
- # To get a list of all your predictors, use the ListPredictors
770
+ # To get a list of all of your predictors, use the ListPredictors
684
771
  # operation.
685
772
  #
686
- # <note markdown="1"> The `Status` of the predictor must be `ACTIVE`, signifying that
687
- # training has completed, before you can use the predictor to create a
688
- # forecast. Use the DescribePredictor operation to get the status.
773
+ # <note markdown="1"> Before you can use the predictor to create a forecast, the `Status` of
774
+ # the predictor must be `ACTIVE`, signifying that training has
775
+ # completed. To get the status, use the DescribePredictor operation.
689
776
  #
690
777
  # </note>
691
778
  #
@@ -696,13 +783,13 @@ module Aws::ForecastService
696
783
  # The Amazon Resource Name (ARN) of the algorithm to use for model
697
784
  # training. Required if `PerformAutoML` is not set to `true`.
698
785
  #
699
- # **Supported algorithms**
786
+ # **Supported algorithms:**
700
787
  #
701
788
  # * `arn:aws:forecast:::algorithm/ARIMA`
702
789
  #
703
790
  # * `arn:aws:forecast:::algorithm/Deep_AR_Plus`
704
791
  #
705
- # `- supports hyperparameter optimization (HPO)`
792
+ # Supports hyperparameter optimization (HPO)
706
793
  #
707
794
  # * `arn:aws:forecast:::algorithm/ETS`
708
795
  #
@@ -719,37 +806,46 @@ module Aws::ForecastService
719
806
  # and set the forecast horizon to 10, the model returns predictions for
720
807
  # 10 days.
721
808
  #
809
+ # The maximum forecast horizon is the lesser of 500 time-steps or 1/3 of
810
+ # the TARGET\_TIME\_SERIES dataset length.
811
+ #
722
812
  # @option params [Boolean] :perform_auto_ml
723
- # Whether to perform AutoML. The default value is `false`. In this case,
724
- # you are required to specify an algorithm.
813
+ # Whether to perform AutoML. When Amazon Forecast performs AutoML, it
814
+ # evaluates the algorithms it provides and chooses the best algorithm
815
+ # and configuration for your training dataset.
816
+ #
817
+ # The default value is `false`. In this case, you are required to
818
+ # specify an algorithm.
725
819
  #
726
- # If you want Amazon Forecast to evaluate the algorithms it provides and
727
- # choose the best algorithm and configuration for your training dataset,
728
- # set `PerformAutoML` to `true`. This is a good option if you aren't
729
- # sure which algorithm is suitable for your application.
820
+ # Set `PerformAutoML` to `true` to have Amazon Forecast perform AutoML.
821
+ # This is a good option if you aren't sure which algorithm is suitable
822
+ # for your training data. In this case, `PerformHPO` must be false.
730
823
  #
731
824
  # @option params [Boolean] :perform_hpo
732
825
  # Whether to perform hyperparameter optimization (HPO). HPO finds
733
826
  # optimal hyperparameter values for your training data. The process of
734
- # performing HPO is known as a hyperparameter tuning job.
827
+ # performing HPO is known as running a hyperparameter tuning job.
735
828
  #
736
829
  # The default value is `false`. In this case, Amazon Forecast uses
737
830
  # default hyperparameter values from the chosen algorithm.
738
831
  #
739
- # To override the default values, set `PerformHPO` to `true` and supply
740
- # the HyperParameterTuningJobConfig object. The tuning job specifies an
741
- # objective metric, the hyperparameters to optimize, and the valid range
742
- # for each hyperparameter.
832
+ # To override the default values, set `PerformHPO` to `true` and,
833
+ # optionally, supply the HyperParameterTuningJobConfig object. The
834
+ # tuning job specifies a metric to optimize, which hyperparameters
835
+ # participate in tuning, and the valid range for each tunable
836
+ # hyperparameter. In this case, you are required to specify an algorithm
837
+ # and `PerformAutoML` must be false.
743
838
  #
744
- # The following algorithms support HPO:
839
+ # The following algorithm supports HPO:
745
840
  #
746
841
  # * DeepAR+
747
842
  #
748
843
  # ^
749
844
  #
750
845
  # @option params [Hash<String,String>] :training_parameters
751
- # The training parameters to override for model training. The parameters
752
- # that you can override are listed in the individual algorithms in
846
+ # The hyperparameters to override for model training. The
847
+ # hyperparameters that you can override are listed in the individual
848
+ # algorithms. For the list of supported algorithms, see
753
849
  # aws-forecast-choosing-recipes.
754
850
  #
755
851
  # @option params [Types::EvaluationParameters] :evaluation_parameters
@@ -765,6 +861,9 @@ module Aws::ForecastService
765
861
  # hyperparameter optimization (HPO). For more information, see
766
862
  # aws-forecast-choosing-recipes.
767
863
  #
864
+ # If you included the `HPOConfig` object, you must set `PerformHPO` to
865
+ # true.
866
+ #
768
867
  # @option params [required, Types::InputDataConfig] :input_data_config
769
868
  # Describes the dataset group that contains the data to use to train the
770
869
  # predictor.
@@ -867,10 +966,10 @@ module Aws::ForecastService
867
966
  req.send_request(options)
868
967
  end
869
968
 
870
- # Deletes an Amazon Forecast dataset created using the CreateDataset
871
- # operation. To be deleted, the dataset must have a status of `ACTIVE`
872
- # or `CREATE_FAILED`. Use the DescribeDataset operation to get the
873
- # status.
969
+ # Deletes an Amazon Forecast dataset that was created using the
970
+ # CreateDataset operation. You can only delete datasets that have a
971
+ # status of `ACTIVE` or `CREATE_FAILED`. To get the status use the
972
+ # DescribeDataset operation.
874
973
  #
875
974
  # @option params [required, String] :dataset_arn
876
975
  # The Amazon Resource Name (ARN) of the dataset to delete.
@@ -893,11 +992,11 @@ module Aws::ForecastService
893
992
  end
894
993
 
895
994
  # Deletes a dataset group created using the CreateDatasetGroup
896
- # operation. To be deleted, the dataset group must have a status of
897
- # `ACTIVE`, `CREATE_FAILED`, or `UPDATE_FAILED`. Use the
898
- # DescribeDatasetGroup operation to get the status.
995
+ # operation. You can only delete dataset groups that have a status of
996
+ # `ACTIVE`, `CREATE_FAILED`, or `UPDATE_FAILED`. To get the status, use
997
+ # the DescribeDatasetGroup operation.
899
998
  #
900
- # The operation deletes only the dataset group, not the datasets in the
999
+ # This operation deletes only the dataset group, not the datasets in the
901
1000
  # group.
902
1001
  #
903
1002
  # @option params [required, String] :dataset_group_arn
@@ -921,9 +1020,9 @@ module Aws::ForecastService
921
1020
  end
922
1021
 
923
1022
  # Deletes a dataset import job created using the CreateDatasetImportJob
924
- # operation. To be deleted, the import job must have a status of
925
- # `ACTIVE` or `CREATE_FAILED`. Use the DescribeDatasetImportJob
926
- # operation to get the status.
1023
+ # operation. You can delete only dataset import jobs that have a status
1024
+ # of `ACTIVE` or `CREATE_FAILED`. To get the status, use the
1025
+ # DescribeDatasetImportJob operation.
927
1026
  #
928
1027
  # @option params [required, String] :dataset_import_job_arn
929
1028
  # The Amazon Resource Name (ARN) of the dataset import job to delete.
@@ -945,11 +1044,13 @@ module Aws::ForecastService
945
1044
  req.send_request(options)
946
1045
  end
947
1046
 
948
- # Deletes a forecast created using the CreateForecast operation. To be
949
- # deleted, the forecast must have a status of `ACTIVE` or
950
- # `CREATE_FAILED`. Use the DescribeForecast operation to get the status.
1047
+ # Deletes a forecast created using the CreateForecast operation. You can
1048
+ # delete only forecasts that have a status of `ACTIVE` or
1049
+ # `CREATE_FAILED`. To get the status, use the DescribeForecast
1050
+ # operation.
951
1051
  #
952
- # You can't delete a forecast while it is being exported.
1052
+ # You can't delete a forecast while it is being exported. After a
1053
+ # forecast is deleted, you can no longer query the forecast.
953
1054
  #
954
1055
  # @option params [required, String] :forecast_arn
955
1056
  # The Amazon Resource Name (ARN) of the forecast to delete.
@@ -972,9 +1073,9 @@ module Aws::ForecastService
972
1073
  end
973
1074
 
974
1075
  # Deletes a forecast export job created using the
975
- # CreateForecastExportJob operation. To be deleted, the export job must
976
- # have a status of `ACTIVE` or `CREATE_FAILED`. Use the
977
- # DescribeForecastExportJob operation to get the status.
1076
+ # CreateForecastExportJob operation. You can delete only export jobs
1077
+ # that have a status of `ACTIVE` or `CREATE_FAILED`. To get the status,
1078
+ # use the DescribeForecastExportJob operation.
978
1079
  #
979
1080
  # @option params [required, String] :forecast_export_job_arn
980
1081
  # The Amazon Resource Name (ARN) of the forecast export job to delete.
@@ -996,12 +1097,10 @@ module Aws::ForecastService
996
1097
  req.send_request(options)
997
1098
  end
998
1099
 
999
- # Deletes a predictor created using the CreatePredictor operation. To be
1000
- # deleted, the predictor must have a status of `ACTIVE` or
1001
- # `CREATE_FAILED`. Use the DescribePredictor operation to get the
1002
- # status.
1003
- #
1004
- # Any forecasts generated by the predictor will no longer be available.
1100
+ # Deletes a predictor created using the CreatePredictor operation. You
1101
+ # can delete only predictor that have a status of `ACTIVE` or
1102
+ # `CREATE_FAILED`. To get the status, use the DescribePredictor
1103
+ # operation.
1005
1104
  #
1006
1105
  # @option params [required, String] :predictor_arn
1007
1106
  # The Amazon Resource Name (ARN) of the predictor to delete.
@@ -1026,9 +1125,8 @@ module Aws::ForecastService
1026
1125
  # Describes an Amazon Forecast dataset created using the CreateDataset
1027
1126
  # operation.
1028
1127
  #
1029
- # In addition to listing the properties provided by the user in the
1030
- # `CreateDataset` request, this operation includes the following
1031
- # properties:
1128
+ # In addition to listing the parameters specified in the `CreateDataset`
1129
+ # request, this operation includes the following dataset properties:
1032
1130
  #
1033
1131
  # * `CreationTime`
1034
1132
  #
@@ -1086,7 +1184,7 @@ module Aws::ForecastService
1086
1184
  # Describes a dataset group created using the CreateDatasetGroup
1087
1185
  # operation.
1088
1186
  #
1089
- # In addition to listing the properties provided by the user in the
1187
+ # In addition to listing the parameters provided in the
1090
1188
  # `CreateDatasetGroup` request, this operation includes the following
1091
1189
  # properties:
1092
1190
  #
@@ -1140,7 +1238,7 @@ module Aws::ForecastService
1140
1238
  # Describes a dataset import job created using the
1141
1239
  # CreateDatasetImportJob operation.
1142
1240
  #
1143
- # In addition to listing the properties provided by the user in the
1241
+ # In addition to listing the parameters provided in the
1144
1242
  # `CreateDatasetImportJob` request, this operation includes the
1145
1243
  # following properties:
1146
1244
  #
@@ -1214,9 +1312,8 @@ module Aws::ForecastService
1214
1312
 
1215
1313
  # Describes a forecast created using the CreateForecast operation.
1216
1314
  #
1217
- # In addition to listing the properties provided by the user in the
1218
- # `CreateForecast` request, this operation includes the following
1219
- # properties:
1315
+ # In addition to listing the properties provided in the `CreateForecast`
1316
+ # request, this operation lists the following properties:
1220
1317
  #
1221
1318
  # * `DatasetGroupArn` - The dataset group that provided the training
1222
1319
  # data.
@@ -1236,6 +1333,7 @@ module Aws::ForecastService
1236
1333
  #
1237
1334
  # * {Types::DescribeForecastResponse#forecast_arn #forecast_arn} => String
1238
1335
  # * {Types::DescribeForecastResponse#forecast_name #forecast_name} => String
1336
+ # * {Types::DescribeForecastResponse#forecast_types #forecast_types} => Array&lt;String&gt;
1239
1337
  # * {Types::DescribeForecastResponse#predictor_arn #predictor_arn} => String
1240
1338
  # * {Types::DescribeForecastResponse#dataset_group_arn #dataset_group_arn} => String
1241
1339
  # * {Types::DescribeForecastResponse#status #status} => String
@@ -1253,6 +1351,8 @@ module Aws::ForecastService
1253
1351
  #
1254
1352
  # resp.forecast_arn #=> String
1255
1353
  # resp.forecast_name #=> String
1354
+ # resp.forecast_types #=> Array
1355
+ # resp.forecast_types[0] #=> String
1256
1356
  # resp.predictor_arn #=> String
1257
1357
  # resp.dataset_group_arn #=> String
1258
1358
  # resp.status #=> String
@@ -1273,8 +1373,8 @@ module Aws::ForecastService
1273
1373
  # CreateForecastExportJob operation.
1274
1374
  #
1275
1375
  # In addition to listing the properties provided by the user in the
1276
- # `CreateForecastExportJob` request, this operation includes the
1277
- # following properties:
1376
+ # `CreateForecastExportJob` request, this operation lists the following
1377
+ # properties:
1278
1378
  #
1279
1379
  # * `CreationTime`
1280
1380
  #
@@ -1328,15 +1428,15 @@ module Aws::ForecastService
1328
1428
 
1329
1429
  # Describes a predictor created using the CreatePredictor operation.
1330
1430
  #
1331
- # In addition to listing the properties provided by the user in the
1332
- # `CreatePredictor` request, this operation includes the following
1431
+ # In addition to listing the properties provided in the
1432
+ # `CreatePredictor` request, this operation lists the following
1333
1433
  # properties:
1334
1434
  #
1335
1435
  # * `DatasetImportJobArns` - The dataset import jobs used to import
1336
1436
  # training data.
1337
1437
  #
1338
- # * `AutoMLAlgorithmArns` - If AutoML is performed, the algorithms
1339
- # evaluated.
1438
+ # * `AutoMLAlgorithmArns` - If AutoML is performed, the algorithms that
1439
+ # were evaluated.
1340
1440
  #
1341
1441
  # * `CreationTime`
1342
1442
  #
@@ -1364,6 +1464,7 @@ module Aws::ForecastService
1364
1464
  # * {Types::DescribePredictorResponse#input_data_config #input_data_config} => Types::InputDataConfig
1365
1465
  # * {Types::DescribePredictorResponse#featurization_config #featurization_config} => Types::FeaturizationConfig
1366
1466
  # * {Types::DescribePredictorResponse#encryption_config #encryption_config} => Types::EncryptionConfig
1467
+ # * {Types::DescribePredictorResponse#predictor_execution_details #predictor_execution_details} => Types::PredictorExecutionDetails
1367
1468
  # * {Types::DescribePredictorResponse#dataset_import_job_arns #dataset_import_job_arns} => Array&lt;String&gt;
1368
1469
  # * {Types::DescribePredictorResponse#auto_ml_algorithm_arns #auto_ml_algorithm_arns} => Array&lt;String&gt;
1369
1470
  # * {Types::DescribePredictorResponse#status #status} => String
@@ -1418,6 +1519,13 @@ module Aws::ForecastService
1418
1519
  # resp.featurization_config.featurizations[0].featurization_pipeline[0].featurization_method_parameters["ParameterKey"] #=> String
1419
1520
  # resp.encryption_config.role_arn #=> String
1420
1521
  # resp.encryption_config.kms_key_arn #=> String
1522
+ # resp.predictor_execution_details.predictor_executions #=> Array
1523
+ # resp.predictor_execution_details.predictor_executions[0].algorithm_arn #=> String
1524
+ # resp.predictor_execution_details.predictor_executions[0].test_windows #=> Array
1525
+ # resp.predictor_execution_details.predictor_executions[0].test_windows[0].test_window_start #=> Time
1526
+ # resp.predictor_execution_details.predictor_executions[0].test_windows[0].test_window_end #=> Time
1527
+ # resp.predictor_execution_details.predictor_executions[0].test_windows[0].status #=> String
1528
+ # resp.predictor_execution_details.predictor_executions[0].test_windows[0].message #=> String
1421
1529
  # resp.dataset_import_job_arns #=> Array
1422
1530
  # resp.dataset_import_job_arns[0] #=> String
1423
1531
  # resp.auto_ml_algorithm_arns #=> Array
@@ -1439,19 +1547,26 @@ module Aws::ForecastService
1439
1547
  # Provides metrics on the accuracy of the models that were trained by
1440
1548
  # the CreatePredictor operation. Use metrics to see how well the model
1441
1549
  # performed and to decide whether to use the predictor to generate a
1442
- # forecast.
1550
+ # forecast. For more information, see metrics.
1443
1551
  #
1444
- # Metrics are generated for each backtest window evaluated. For more
1445
- # information, see EvaluationParameters.
1552
+ # This operation generates metrics for each backtest window that was
1553
+ # evaluated. The number of backtest windows (`NumberOfBacktestWindows`)
1554
+ # is specified using the EvaluationParameters object, which is
1555
+ # optionally included in the `CreatePredictor` request. If
1556
+ # `NumberOfBacktestWindows` isn't specified, the number defaults to
1557
+ # one.
1446
1558
  #
1447
1559
  # The parameters of the `filling` method determine which items
1448
- # contribute to the metrics. If `zero` is specified, all items
1449
- # contribute. If `nan` is specified, only those items that have complete
1450
- # data in the range being evaluated contribute. For more information,
1451
- # see FeaturizationMethod.
1560
+ # contribute to the metrics. If you want all items to contribute,
1561
+ # specify `zero`. If you want only those items that have complete data
1562
+ # in the range being evaluated to contribute, specify `nan`. For more
1563
+ # information, see FeaturizationMethod.
1564
+ #
1565
+ # <note markdown="1"> Before you can get accuracy metrics, the `Status` of the predictor
1566
+ # must be `ACTIVE`, signifying that training has completed. To get the
1567
+ # status, use the DescribePredictor operation.
1452
1568
  #
1453
- # For an example of how to train a model and review metrics, see
1454
- # getting-started.
1569
+ # </note>
1455
1570
  #
1456
1571
  # @option params [required, String] :predictor_arn
1457
1572
  # The Amazon Resource Name (ARN) of the predictor to get metrics for.
@@ -1490,10 +1605,10 @@ module Aws::ForecastService
1490
1605
  end
1491
1606
 
1492
1607
  # Returns a list of dataset groups created using the CreateDatasetGroup
1493
- # operation. For each dataset group, a summary of its properties,
1494
- # including its Amazon Resource Name (ARN), is returned. You can
1495
- # retrieve the complete set of properties by using the ARN with the
1496
- # DescribeDatasetGroup operation.
1608
+ # operation. For each dataset group, this operation returns a summary of
1609
+ # its properties, including its Amazon Resource Name (ARN). You can
1610
+ # retrieve the complete set of properties by using the dataset group ARN
1611
+ # with the DescribeDatasetGroup operation.
1497
1612
  #
1498
1613
  # @option params [String] :next_token
1499
1614
  # If the result of the previous request was truncated, the response
@@ -1508,6 +1623,8 @@ module Aws::ForecastService
1508
1623
  # * {Types::ListDatasetGroupsResponse#dataset_groups #dataset_groups} => Array&lt;Types::DatasetGroupSummary&gt;
1509
1624
  # * {Types::ListDatasetGroupsResponse#next_token #next_token} => String
1510
1625
  #
1626
+ # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
1627
+ #
1511
1628
  # @example Request syntax with placeholder values
1512
1629
  #
1513
1630
  # resp = client.list_dataset_groups({
@@ -1534,11 +1651,11 @@ module Aws::ForecastService
1534
1651
  end
1535
1652
 
1536
1653
  # Returns a list of dataset import jobs created using the
1537
- # CreateDatasetImportJob operation. For each import job, a summary of
1538
- # its properties, including its Amazon Resource Name (ARN), is returned.
1539
- # You can retrieve the complete set of properties by using the ARN with
1540
- # the DescribeDatasetImportJob operation. You can filter the list by
1541
- # providing an array of Filter objects.
1654
+ # CreateDatasetImportJob operation. For each import job, this operation
1655
+ # returns a summary of its properties, including its Amazon Resource
1656
+ # Name (ARN). You can retrieve the complete set of properties by using
1657
+ # the ARN with the DescribeDatasetImportJob operation. You can filter
1658
+ # the list by providing an array of Filter objects.
1542
1659
  #
1543
1660
  # @option params [String] :next_token
1544
1661
  # If the result of the previous request was truncated, the response
@@ -1551,28 +1668,34 @@ module Aws::ForecastService
1551
1668
  # @option params [Array<Types::Filter>] :filters
1552
1669
  # An array of filters. For each filter, you provide a condition and a
1553
1670
  # match statement. The condition is either `IS` or `IS_NOT`, which
1554
- # specifies whether to include or exclude, respectively, from the list,
1555
- # the predictors that match the statement. The match statement consists
1556
- # of a key and a value. In this release, `Name` is the only valid key,
1557
- # which filters on the `DatasetImportJobName` property.
1671
+ # specifies whether to include or exclude the datasets that match the
1672
+ # statement from the list, respectively. The match statement consists of
1673
+ # a key and a value.
1558
1674
  #
1559
- # * `Condition` - `IS` or `IS_NOT`
1675
+ # **Filter properties**
1560
1676
  #
1561
- # * `Key` - `Name`
1677
+ # * `Condition` - The condition to apply. Valid values are `IS` and
1678
+ # `IS_NOT`. To include the datasets that match the statement, specify
1679
+ # `IS`. To exclude matching datasets, specify `IS_NOT`.
1562
1680
  #
1563
- # * `Value` - the value to match
1681
+ # * `Key` - The name of the parameter to filter on. Valid values are
1682
+ # `DatasetArn` and `Status`.
1564
1683
  #
1565
- # For example, to list all dataset import jobs named
1566
- # *my\_dataset\_import\_job*, you would specify:
1684
+ # * `Value` - The value to match.
1567
1685
  #
1568
- # `"Filters": [ \{ "Condition": "IS", "Key": "Name", "Value":
1569
- # "my_dataset_import_job" \} ]`
1686
+ # For example, to list all dataset import jobs whose status is ACTIVE,
1687
+ # you specify the following filter:
1688
+ #
1689
+ # `"Filters": [ \{ "Condition": "IS", "Key": "Status", "Value": "ACTIVE"
1690
+ # \} ]`
1570
1691
  #
1571
1692
  # @return [Types::ListDatasetImportJobsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1572
1693
  #
1573
1694
  # * {Types::ListDatasetImportJobsResponse#dataset_import_jobs #dataset_import_jobs} => Array&lt;Types::DatasetImportJobSummary&gt;
1574
1695
  # * {Types::ListDatasetImportJobsResponse#next_token #next_token} => String
1575
1696
  #
1697
+ # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
1698
+ #
1576
1699
  # @example Request syntax with placeholder values
1577
1700
  #
1578
1701
  # resp = client.list_dataset_import_jobs({
@@ -1612,8 +1735,8 @@ module Aws::ForecastService
1612
1735
 
1613
1736
  # Returns a list of datasets created using the CreateDataset operation.
1614
1737
  # For each dataset, a summary of its properties, including its Amazon
1615
- # Resource Name (ARN), is returned. You can retrieve the complete set of
1616
- # properties by using the ARN with the DescribeDataset operation.
1738
+ # Resource Name (ARN), is returned. To retrieve the complete set of
1739
+ # properties, use the ARN with the DescribeDataset operation.
1617
1740
  #
1618
1741
  # @option params [String] :next_token
1619
1742
  # If the result of the previous request was truncated, the response
@@ -1628,6 +1751,8 @@ module Aws::ForecastService
1628
1751
  # * {Types::ListDatasetsResponse#datasets #datasets} => Array&lt;Types::DatasetSummary&gt;
1629
1752
  # * {Types::ListDatasetsResponse#next_token #next_token} => String
1630
1753
  #
1754
+ # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
1755
+ #
1631
1756
  # @example Request syntax with placeholder values
1632
1757
  #
1633
1758
  # resp = client.list_datasets({
@@ -1656,11 +1781,11 @@ module Aws::ForecastService
1656
1781
  end
1657
1782
 
1658
1783
  # Returns a list of forecast export jobs created using the
1659
- # CreateForecastExportJob operation. For each forecast export job, a
1660
- # summary of its properties, including its Amazon Resource Name (ARN),
1661
- # is returned. You can retrieve the complete set of properties by using
1662
- # the ARN with the DescribeForecastExportJob operation. The list can be
1663
- # filtered using an array of Filter objects.
1784
+ # CreateForecastExportJob operation. For each forecast export job, this
1785
+ # operation returns a summary of its properties, including its Amazon
1786
+ # Resource Name (ARN). To retrieve the complete set of properties, use
1787
+ # the ARN with the DescribeForecastExportJob operation. You can filter
1788
+ # the list using an array of Filter objects.
1664
1789
  #
1665
1790
  # @option params [String] :next_token
1666
1791
  # If the result of the previous request was truncated, the response
@@ -1673,28 +1798,36 @@ module Aws::ForecastService
1673
1798
  # @option params [Array<Types::Filter>] :filters
1674
1799
  # An array of filters. For each filter, you provide a condition and a
1675
1800
  # match statement. The condition is either `IS` or `IS_NOT`, which
1676
- # specifies whether to include or exclude, respectively, from the list,
1677
- # the predictors that match the statement. The match statement consists
1678
- # of a key and a value. In this release, `Name` is the only valid key,
1679
- # which filters on the `ForecastExportJobName` property.
1801
+ # specifies whether to include or exclude the forecast export jobs that
1802
+ # match the statement from the list, respectively. The match statement
1803
+ # consists of a key and a value.
1680
1804
  #
1681
- # * `Condition` - `IS` or `IS_NOT`
1805
+ # **Filter properties**
1682
1806
  #
1683
- # * `Key` - `Name`
1807
+ # * `Condition` - The condition to apply. Valid values are `IS` and
1808
+ # `IS_NOT`. To include the forecast export jobs that match the
1809
+ # statement, specify `IS`. To exclude matching forecast export jobs,
1810
+ # specify `IS_NOT`.
1684
1811
  #
1685
- # * `Value` - the value to match
1812
+ # * `Key` - The name of the parameter to filter on. Valid values are
1813
+ # `ForecastArn` and `Status`.
1686
1814
  #
1687
- # For example, to list all forecast export jobs named
1688
- # *my\_forecast\_export\_job*, you would specify:
1815
+ # * `Value` - The value to match.
1689
1816
  #
1690
- # `"Filters": [ \{ "Condition": "IS", "Key": "Name", "Value":
1691
- # "my_forecast_export_job" \} ]`
1817
+ # For example, to list all jobs that export a forecast named
1818
+ # *electricityforecast*, specify the following filter:
1819
+ #
1820
+ # `"Filters": [ \{ "Condition": "IS", "Key": "ForecastArn", "Value":
1821
+ # "arn:aws:forecast:us-west-2:<acct-id>:forecast/electricityforecast" \}
1822
+ # ]`
1692
1823
  #
1693
1824
  # @return [Types::ListForecastExportJobsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1694
1825
  #
1695
1826
  # * {Types::ListForecastExportJobsResponse#forecast_export_jobs #forecast_export_jobs} => Array&lt;Types::ForecastExportJobSummary&gt;
1696
1827
  # * {Types::ListForecastExportJobsResponse#next_token #next_token} => String
1697
1828
  #
1829
+ # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
1830
+ #
1698
1831
  # @example Request syntax with placeholder values
1699
1832
  #
1700
1833
  # resp = client.list_forecast_export_jobs({
@@ -1733,10 +1866,10 @@ module Aws::ForecastService
1733
1866
  end
1734
1867
 
1735
1868
  # Returns a list of forecasts created using the CreateForecast
1736
- # operation. For each forecast, a summary of its properties, including
1737
- # its Amazon Resource Name (ARN), is returned. You can retrieve the
1738
- # complete set of properties by using the ARN with the DescribeForecast
1739
- # operation. The list can be filtered using an array of Filter objects.
1869
+ # operation. For each forecast, this operation returns a summary of its
1870
+ # properties, including its Amazon Resource Name (ARN). To retrieve the
1871
+ # complete set of properties, specify the ARN with the DescribeForecast
1872
+ # operation. You can filter the list using an array of Filter objects.
1740
1873
  #
1741
1874
  # @option params [String] :next_token
1742
1875
  # If the result of the previous request was truncated, the response
@@ -1749,28 +1882,34 @@ module Aws::ForecastService
1749
1882
  # @option params [Array<Types::Filter>] :filters
1750
1883
  # An array of filters. For each filter, you provide a condition and a
1751
1884
  # match statement. The condition is either `IS` or `IS_NOT`, which
1752
- # specifies whether to include or exclude, respectively, from the list,
1753
- # the predictors that match the statement. The match statement consists
1754
- # of a key and a value. In this release, `Name` is the only valid key,
1755
- # which filters on the `ForecastName` property.
1885
+ # specifies whether to include or exclude the forecasts that match the
1886
+ # statement from the list, respectively. The match statement consists of
1887
+ # a key and a value.
1756
1888
  #
1757
- # * `Condition` - `IS` or `IS_NOT`
1889
+ # **Filter properties**
1758
1890
  #
1759
- # * `Key` - `Name`
1891
+ # * `Condition` - The condition to apply. Valid values are `IS` and
1892
+ # `IS_NOT`. To include the forecasts that match the statement, specify
1893
+ # `IS`. To exclude matching forecasts, specify `IS_NOT`.
1760
1894
  #
1761
- # * `Value` - the value to match
1895
+ # * `Key` - The name of the parameter to filter on. Valid values are
1896
+ # `DatasetGroupArn`, `PredictorArn`, and `Status`.
1762
1897
  #
1763
- # For example, to list all forecasts named *my\_forecast*, you would
1764
- # specify:
1898
+ # * `Value` - The value to match.
1899
+ #
1900
+ # For example, to list all forecasts whose status is not ACTIVE, you
1901
+ # would specify:
1765
1902
  #
1766
- # `"Filters": [ \{ "Condition": "IS", "Key": "Name", "Value":
1767
- # "my_forecast" \} ]`
1903
+ # `"Filters": [ \{ "Condition": "IS_NOT", "Key": "Status", "Value":
1904
+ # "ACTIVE" \} ]`
1768
1905
  #
1769
1906
  # @return [Types::ListForecastsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1770
1907
  #
1771
1908
  # * {Types::ListForecastsResponse#forecasts #forecasts} => Array&lt;Types::ForecastSummary&gt;
1772
1909
  # * {Types::ListForecastsResponse#next_token #next_token} => String
1773
1910
  #
1911
+ # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
1912
+ #
1774
1913
  # @example Request syntax with placeholder values
1775
1914
  #
1776
1915
  # resp = client.list_forecasts({
@@ -1808,10 +1947,11 @@ module Aws::ForecastService
1808
1947
  end
1809
1948
 
1810
1949
  # Returns a list of predictors created using the CreatePredictor
1811
- # operation. For each predictor, a summary of its properties, including
1812
- # its Amazon Resource Name (ARN), is returned. You can retrieve the
1813
- # complete set of properties by using the ARN with the DescribePredictor
1814
- # operation. The list can be filtered using an array of Filter objects.
1950
+ # operation. For each predictor, this operation returns a summary of its
1951
+ # properties, including its Amazon Resource Name (ARN). You can retrieve
1952
+ # the complete set of properties by using the ARN with the
1953
+ # DescribePredictor operation. You can filter the list using an array of
1954
+ # Filter objects.
1815
1955
  #
1816
1956
  # @option params [String] :next_token
1817
1957
  # If the result of the previous request was truncated, the response
@@ -1824,28 +1964,34 @@ module Aws::ForecastService
1824
1964
  # @option params [Array<Types::Filter>] :filters
1825
1965
  # An array of filters. For each filter, you provide a condition and a
1826
1966
  # match statement. The condition is either `IS` or `IS_NOT`, which
1827
- # specifies whether to include or exclude, respectively, from the list,
1828
- # the predictors that match the statement. The match statement consists
1829
- # of a key and a value. In this release, `Name` is the only valid key,
1830
- # which filters on the `PredictorName` property.
1967
+ # specifies whether to include or exclude the predictors that match the
1968
+ # statement from the list, respectively. The match statement consists of
1969
+ # a key and a value.
1970
+ #
1971
+ # **Filter properties**
1831
1972
  #
1832
- # * `Condition` - `IS` or `IS_NOT`
1973
+ # * `Condition` - The condition to apply. Valid values are `IS` and
1974
+ # `IS_NOT`. To include the predictors that match the statement,
1975
+ # specify `IS`. To exclude matching predictors, specify `IS_NOT`.
1833
1976
  #
1834
- # * `Key` - `Name`
1977
+ # * `Key` - The name of the parameter to filter on. Valid values are
1978
+ # `DatasetGroupArn` and `Status`.
1835
1979
  #
1836
- # * `Value` - the value to match
1980
+ # * `Value` - The value to match.
1837
1981
  #
1838
- # For example, to list all predictors named *my\_predictor*, you would
1982
+ # For example, to list all predictors whose status is ACTIVE, you would
1839
1983
  # specify:
1840
1984
  #
1841
- # `"Filters": [ \{ "Condition": "IS", "Key": "Name", "Value":
1842
- # "my_predictor" \} ]`
1985
+ # `"Filters": [ \{ "Condition": "IS", "Key": "Status", "Value": "ACTIVE"
1986
+ # \} ]`
1843
1987
  #
1844
1988
  # @return [Types::ListPredictorsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1845
1989
  #
1846
1990
  # * {Types::ListPredictorsResponse#predictors #predictors} => Array&lt;Types::PredictorSummary&gt;
1847
1991
  # * {Types::ListPredictorsResponse#next_token #next_token} => String
1848
1992
  #
1993
+ # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
1994
+ #
1849
1995
  # @example Request syntax with placeholder values
1850
1996
  #
1851
1997
  # resp = client.list_predictors({
@@ -1881,11 +2027,10 @@ module Aws::ForecastService
1881
2027
  req.send_request(options)
1882
2028
  end
1883
2029
 
1884
- # Replaces any existing datasets in the dataset group with the specified
1885
- # datasets.
2030
+ # Replaces the datasets in a dataset group with the specified datasets.
1886
2031
  #
1887
- # <note markdown="1"> The `Status` of the dataset group must be `ACTIVE` before creating a
1888
- # predictor using the dataset group. Use the DescribeDatasetGroup
2032
+ # <note markdown="1"> The `Status` of the dataset group must be `ACTIVE` before you can use
2033
+ # the dataset group to create a predictor. Use the DescribeDatasetGroup
1889
2034
  # operation to get the status.
1890
2035
  #
1891
2036
  # </note>
@@ -1894,8 +2039,8 @@ module Aws::ForecastService
1894
2039
  # The ARN of the dataset group.
1895
2040
  #
1896
2041
  # @option params [required, Array<String>] :dataset_arns
1897
- # An array of Amazon Resource Names (ARNs) of the datasets to add to the
1898
- # dataset group.
2042
+ # An array of the Amazon Resource Names (ARNs) of the datasets to add to
2043
+ # the dataset group.
1899
2044
  #
1900
2045
  # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
1901
2046
  #
@@ -1928,7 +2073,7 @@ module Aws::ForecastService
1928
2073
  params: params,
1929
2074
  config: config)
1930
2075
  context[:gem_name] = 'aws-sdk-forecastservice'
1931
- context[:gem_version] = '1.0.0'
2076
+ context[:gem_version] = '1.5.0'
1932
2077
  Seahorse::Client::Request.new(handlers, context)
1933
2078
  end
1934
2079