aws-sdk-forecastservice 1.1.0 → 1.6.1

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