aws-sdk-forecastservice 1.0.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.
@@ -0,0 +1,7 @@
1
+ ---
2
+ SHA1:
3
+ metadata.gz: 0f6a8f3f456cac0d2acead080cc4cccfa4b792fb
4
+ data.tar.gz: 8b12f08355294e952c40c05eb031f0e37525dfed
5
+ SHA512:
6
+ metadata.gz: 30c98fbd12eb339df5b6eaa0bfcf86d37bbdd1318fa604ef2a42520f171610e773ea24e11618828f5c02994ddc2a797867d5b017c815f364dea141b88abe232c
7
+ data.tar.gz: 1d0db6216a5364ffeaa9b54414ee0c67019139d0e8758ed27c3472975ece25e1c327becfc98c3de02e2bfdc27b94e48ccadda5bf032a56cc098bb132148bd4f0
@@ -0,0 +1,47 @@
1
+ # WARNING ABOUT GENERATED CODE
2
+ #
3
+ # This file is generated. See the contributing guide for more information:
4
+ # https://github.com/aws/aws-sdk-ruby/blob/master/CONTRIBUTING.md
5
+ #
6
+ # WARNING ABOUT GENERATED CODE
7
+
8
+ require 'aws-sdk-core'
9
+ require 'aws-sigv4'
10
+
11
+ require_relative 'aws-sdk-forecastservice/types'
12
+ require_relative 'aws-sdk-forecastservice/client_api'
13
+ require_relative 'aws-sdk-forecastservice/client'
14
+ require_relative 'aws-sdk-forecastservice/errors'
15
+ require_relative 'aws-sdk-forecastservice/resource'
16
+ require_relative 'aws-sdk-forecastservice/customizations'
17
+
18
+ # This module provides support for Amazon Forecast Service. This module is available in the
19
+ # `aws-sdk-forecastservice` gem.
20
+ #
21
+ # # Client
22
+ #
23
+ # The {Client} class provides one method for each API operation. Operation
24
+ # methods each accept a hash of request parameters and return a response
25
+ # structure.
26
+ #
27
+ # See {Client} for more information.
28
+ #
29
+ # # Errors
30
+ #
31
+ # Errors returned from Amazon Forecast Service all
32
+ # extend {Errors::ServiceError}.
33
+ #
34
+ # begin
35
+ # # do stuff
36
+ # rescue Aws::ForecastService::Errors::ServiceError
37
+ # # rescues all service API errors
38
+ # end
39
+ #
40
+ # See {Errors} for more information.
41
+ #
42
+ # @service
43
+ module Aws::ForecastService
44
+
45
+ GEM_VERSION = '1.0.0'
46
+
47
+ end
@@ -0,0 +1,1953 @@
1
+ # WARNING ABOUT GENERATED CODE
2
+ #
3
+ # This file is generated. See the contributing guide for more information:
4
+ # https://github.com/aws/aws-sdk-ruby/blob/master/CONTRIBUTING.md
5
+ #
6
+ # WARNING ABOUT GENERATED CODE
7
+
8
+ require 'seahorse/client/plugins/content_length.rb'
9
+ require 'aws-sdk-core/plugins/credentials_configuration.rb'
10
+ require 'aws-sdk-core/plugins/logging.rb'
11
+ require 'aws-sdk-core/plugins/param_converter.rb'
12
+ require 'aws-sdk-core/plugins/param_validator.rb'
13
+ require 'aws-sdk-core/plugins/user_agent.rb'
14
+ require 'aws-sdk-core/plugins/helpful_socket_errors.rb'
15
+ require 'aws-sdk-core/plugins/retry_errors.rb'
16
+ require 'aws-sdk-core/plugins/global_configuration.rb'
17
+ require 'aws-sdk-core/plugins/regional_endpoint.rb'
18
+ require 'aws-sdk-core/plugins/endpoint_discovery.rb'
19
+ require 'aws-sdk-core/plugins/endpoint_pattern.rb'
20
+ require 'aws-sdk-core/plugins/response_paging.rb'
21
+ require 'aws-sdk-core/plugins/stub_responses.rb'
22
+ require 'aws-sdk-core/plugins/idempotency_token.rb'
23
+ require 'aws-sdk-core/plugins/jsonvalue_converter.rb'
24
+ require 'aws-sdk-core/plugins/client_metrics_plugin.rb'
25
+ require 'aws-sdk-core/plugins/client_metrics_send_plugin.rb'
26
+ require 'aws-sdk-core/plugins/transfer_encoding.rb'
27
+ require 'aws-sdk-core/plugins/signature_v4.rb'
28
+ require 'aws-sdk-core/plugins/protocols/json_rpc.rb'
29
+
30
+ Aws::Plugins::GlobalConfiguration.add_identifier(:forecastservice)
31
+
32
+ module Aws::ForecastService
33
+ class Client < Seahorse::Client::Base
34
+
35
+ include Aws::ClientStubs
36
+
37
+ @identifier = :forecastservice
38
+
39
+ set_api(ClientApi::API)
40
+
41
+ add_plugin(Seahorse::Client::Plugins::ContentLength)
42
+ add_plugin(Aws::Plugins::CredentialsConfiguration)
43
+ add_plugin(Aws::Plugins::Logging)
44
+ add_plugin(Aws::Plugins::ParamConverter)
45
+ add_plugin(Aws::Plugins::ParamValidator)
46
+ add_plugin(Aws::Plugins::UserAgent)
47
+ add_plugin(Aws::Plugins::HelpfulSocketErrors)
48
+ add_plugin(Aws::Plugins::RetryErrors)
49
+ add_plugin(Aws::Plugins::GlobalConfiguration)
50
+ add_plugin(Aws::Plugins::RegionalEndpoint)
51
+ add_plugin(Aws::Plugins::EndpointDiscovery)
52
+ add_plugin(Aws::Plugins::EndpointPattern)
53
+ add_plugin(Aws::Plugins::ResponsePaging)
54
+ add_plugin(Aws::Plugins::StubResponses)
55
+ add_plugin(Aws::Plugins::IdempotencyToken)
56
+ add_plugin(Aws::Plugins::JsonvalueConverter)
57
+ add_plugin(Aws::Plugins::ClientMetricsPlugin)
58
+ add_plugin(Aws::Plugins::ClientMetricsSendPlugin)
59
+ add_plugin(Aws::Plugins::TransferEncoding)
60
+ add_plugin(Aws::Plugins::SignatureV4)
61
+ add_plugin(Aws::Plugins::Protocols::JsonRpc)
62
+
63
+ # @overload initialize(options)
64
+ # @param [Hash] options
65
+ # @option options [required, Aws::CredentialProvider] :credentials
66
+ # Your AWS credentials. This can be an instance of any one of the
67
+ # following classes:
68
+ #
69
+ # * `Aws::Credentials` - Used for configuring static, non-refreshing
70
+ # credentials.
71
+ #
72
+ # * `Aws::InstanceProfileCredentials` - Used for loading credentials
73
+ # from an EC2 IMDS on an EC2 instance.
74
+ #
75
+ # * `Aws::SharedCredentials` - Used for loading credentials from a
76
+ # shared file, such as `~/.aws/config`.
77
+ #
78
+ # * `Aws::AssumeRoleCredentials` - Used when you need to assume a role.
79
+ #
80
+ # When `:credentials` are not configured directly, the following
81
+ # locations will be searched for credentials:
82
+ #
83
+ # * `Aws.config[:credentials]`
84
+ # * The `:access_key_id`, `:secret_access_key`, and `:session_token` options.
85
+ # * ENV['AWS_ACCESS_KEY_ID'], ENV['AWS_SECRET_ACCESS_KEY']
86
+ # * `~/.aws/credentials`
87
+ # * `~/.aws/config`
88
+ # * EC2 IMDS instance profile - When used by default, the timeouts are
89
+ # very aggressive. Construct and pass an instance of
90
+ # `Aws::InstanceProfileCredentails` to enable retries and extended
91
+ # timeouts.
92
+ #
93
+ # @option options [required, String] :region
94
+ # The AWS region to connect to. The configured `:region` is
95
+ # used to determine the service `:endpoint`. When not passed,
96
+ # a default `:region` is search for in the following locations:
97
+ #
98
+ # * `Aws.config[:region]`
99
+ # * `ENV['AWS_REGION']`
100
+ # * `ENV['AMAZON_REGION']`
101
+ # * `ENV['AWS_DEFAULT_REGION']`
102
+ # * `~/.aws/credentials`
103
+ # * `~/.aws/config`
104
+ #
105
+ # @option options [String] :access_key_id
106
+ #
107
+ # @option options [Boolean] :active_endpoint_cache (false)
108
+ # When set to `true`, a thread polling for endpoints will be running in
109
+ # the background every 60 secs (default). Defaults to `false`.
110
+ #
111
+ # @option options [Boolean] :client_side_monitoring (false)
112
+ # When `true`, client-side metrics will be collected for all API requests from
113
+ # this client.
114
+ #
115
+ # @option options [String] :client_side_monitoring_client_id ("")
116
+ # Allows you to provide an identifier for this client which will be attached to
117
+ # all generated client side metrics. Defaults to an empty string.
118
+ #
119
+ # @option options [String] :client_side_monitoring_host ("127.0.0.1")
120
+ # Allows you to specify the DNS hostname or IPv4 or IPv6 address that the client
121
+ # side monitoring agent is running on, where client metrics will be published via UDP.
122
+ #
123
+ # @option options [Integer] :client_side_monitoring_port (31000)
124
+ # Required for publishing client metrics. The port that the client side monitoring
125
+ # agent is running on, where client metrics will be published via UDP.
126
+ #
127
+ # @option options [Aws::ClientSideMonitoring::Publisher] :client_side_monitoring_publisher (Aws::ClientSideMonitoring::Publisher)
128
+ # Allows you to provide a custom client-side monitoring publisher class. By default,
129
+ # will use the Client Side Monitoring Agent Publisher.
130
+ #
131
+ # @option options [Boolean] :convert_params (true)
132
+ # When `true`, an attempt is made to coerce request parameters into
133
+ # the required types.
134
+ #
135
+ # @option options [Boolean] :disable_host_prefix_injection (false)
136
+ # Set to true to disable SDK automatically adding host prefix
137
+ # to default service endpoint when available.
138
+ #
139
+ # @option options [String] :endpoint
140
+ # The client endpoint is normally constructed from the `:region`
141
+ # option. You should only configure an `:endpoint` when connecting
142
+ # to test endpoints. This should be avalid HTTP(S) URI.
143
+ #
144
+ # @option options [Integer] :endpoint_cache_max_entries (1000)
145
+ # Used for the maximum size limit of the LRU cache storing endpoints data
146
+ # for endpoint discovery enabled operations. Defaults to 1000.
147
+ #
148
+ # @option options [Integer] :endpoint_cache_max_threads (10)
149
+ # Used for the maximum threads in use for polling endpoints to be cached, defaults to 10.
150
+ #
151
+ # @option options [Integer] :endpoint_cache_poll_interval (60)
152
+ # When :endpoint_discovery and :active_endpoint_cache is enabled,
153
+ # Use this option to config the time interval in seconds for making
154
+ # requests fetching endpoints information. Defaults to 60 sec.
155
+ #
156
+ # @option options [Boolean] :endpoint_discovery (false)
157
+ # When set to `true`, endpoint discovery will be enabled for operations when available. Defaults to `false`.
158
+ #
159
+ # @option options [Aws::Log::Formatter] :log_formatter (Aws::Log::Formatter.default)
160
+ # The log formatter.
161
+ #
162
+ # @option options [Symbol] :log_level (:info)
163
+ # The log level to send messages to the `:logger` at.
164
+ #
165
+ # @option options [Logger] :logger
166
+ # The Logger instance to send log messages to. If this option
167
+ # is not set, logging will be disabled.
168
+ #
169
+ # @option options [String] :profile ("default")
170
+ # Used when loading credentials from the shared credentials file
171
+ # at HOME/.aws/credentials. When not specified, 'default' is used.
172
+ #
173
+ # @option options [Float] :retry_base_delay (0.3)
174
+ # The base delay in seconds used by the default backoff function.
175
+ #
176
+ # @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.
178
+ #
179
+ # @see https://www.awsarchitectureblog.com/2015/03/backoff.html
180
+ #
181
+ # @option options [Integer] :retry_limit (3)
182
+ # The maximum number of times to retry failed requests. Only
183
+ # ~ 500 level server errors and certain ~ 400 level client errors
184
+ # are retried. Generally, these are throttling errors, data
185
+ # checksum errors, networking errors, timeout errors and auth
186
+ # errors from expired credentials.
187
+ #
188
+ # @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.
190
+ #
191
+ # @option options [String] :secret_access_key
192
+ #
193
+ # @option options [String] :session_token
194
+ #
195
+ # @option options [Boolean] :simple_json (false)
196
+ # Disables request parameter conversion, validation, and formatting.
197
+ # Also disable response data type conversions. This option is useful
198
+ # when you want to ensure the highest level of performance by
199
+ # avoiding overhead of walking request parameters and response data
200
+ # structures.
201
+ #
202
+ # When `:simple_json` is enabled, the request parameters hash must
203
+ # be formatted exactly as the DynamoDB API expects.
204
+ #
205
+ # @option options [Boolean] :stub_responses (false)
206
+ # Causes the client to return stubbed responses. By default
207
+ # fake responses are generated and returned. You can specify
208
+ # the response data to return or errors to raise by calling
209
+ # {ClientStubs#stub_responses}. See {ClientStubs} for more information.
210
+ #
211
+ # ** Please note ** When response stubbing is enabled, no HTTP
212
+ # requests are made, and retries are disabled.
213
+ #
214
+ # @option options [Boolean] :validate_params (true)
215
+ # When `true`, request parameters are validated before
216
+ # sending the request.
217
+ #
218
+ # @option options [URI::HTTP,String] :http_proxy A proxy to send
219
+ # requests through. Formatted like 'http://proxy.com:123'.
220
+ #
221
+ # @option options [Float] :http_open_timeout (15) The number of
222
+ # seconds to wait when opening a HTTP session before rasing a
223
+ # `Timeout::Error`.
224
+ #
225
+ # @option options [Integer] :http_read_timeout (60) The default
226
+ # 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}.
229
+ #
230
+ # @option options [Float] :http_idle_timeout (5) The number of
231
+ # seconds a connection is allowed to sit idble before it is
232
+ # considered stale. Stale connections are closed and removed
233
+ # from the pool before making a request.
234
+ #
235
+ # @option options [Float] :http_continue_timeout (1) The number of
236
+ # seconds to wait for a 100-continue response before sending the
237
+ # request body. This option has no effect unless the request has
238
+ # "Expect" header set to "100-continue". Defaults to `nil` which
239
+ # disables this behaviour. This value can safely be set per
240
+ # request on the session yeidled by {#session_for}.
241
+ #
242
+ # @option options [Boolean] :http_wire_trace (false) When `true`,
243
+ # HTTP debug output will be sent to the `:logger`.
244
+ #
245
+ # @option options [Boolean] :ssl_verify_peer (true) When `true`,
246
+ # SSL peer certificates are verified when establishing a
247
+ # connection.
248
+ #
249
+ # @option options [String] :ssl_ca_bundle Full path to the SSL
250
+ # certificate authority bundle file that should be used when
251
+ # verifying peer certificates. If you do not pass
252
+ # `:ssl_ca_bundle` or `:ssl_ca_directory` the the system default
253
+ # will be used if available.
254
+ #
255
+ # @option options [String] :ssl_ca_directory Full path of the
256
+ # directory that contains the unbundled SSL certificate
257
+ # authority files for verifying peer certificates. If you do
258
+ # not pass `:ssl_ca_bundle` or `:ssl_ca_directory` the the
259
+ # system default will be used if available.
260
+ #
261
+ def initialize(*args)
262
+ super
263
+ end
264
+
265
+ # @!group API Operations
266
+
267
+ # Creates an Amazon Forecast dataset. The information about the dataset
268
+ # that you provide helps Forecast understand how to consume the data for
269
+ # model training. This includes the following:
270
+ #
271
+ # * <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.
274
+ #
275
+ # * <i> <code>Domain</code> </i> and <i> <code>DatasetType</code> </i> -
276
+ # Each dataset has an associated dataset domain and a type within the
277
+ # domain. Amazon Forecast provides a list of predefined domains and
278
+ # types within each domain. For each unique dataset domain and type
279
+ # within the domain, Amazon Forecast requires your data to include a
280
+ # minimum set of predefined fields.
281
+ #
282
+ # * <i> <code>Schema</code> </i> - A schema specifies the fields of the
283
+ # dataset, including the field name and data type.
284
+ #
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
288
+ # howitworks-datasets-groups.
289
+ #
290
+ # To get a list of all your datasets, use the ListDatasets operation.
291
+ #
292
+ # <note markdown="1"> The `Status` of a dataset must be `ACTIVE` before you can import
293
+ # training data. Use the DescribeDataset operation to get the status.
294
+ #
295
+ # </note>
296
+ #
297
+ # @option params [required, String] :dataset_name
298
+ # A name for the dataset.
299
+ #
300
+ # @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.
308
+ #
309
+ # @option params [required, String] :dataset_type
310
+ # The dataset type. Valid values depend on the chosen `Domain`.
311
+ #
312
+ # @option params [String] :data_frequency
313
+ # The frequency of data collection.
314
+ #
315
+ # Valid intervals are Y (Year), M (Month), W (Week), D (Day), H (Hour),
316
+ # 30min (30 minutes), 15min (15 minutes), 10min (10 minutes), 5min (5
317
+ # minutes), and 1min (1 minute). For example, "D" indicates every day
318
+ # and "15min" indicates every 15 minutes.
319
+ #
320
+ # @option params [required, Types::Schema] :schema
321
+ # The schema for the dataset. The schema attributes and their order must
322
+ # match the fields in your data. The dataset `Domain` and `DatasetType`
323
+ # that you choose determine the minimum required fields in your training
324
+ # data. For information about the required fields for a specific dataset
325
+ # domain and type, see howitworks-domains-ds-types.
326
+ #
327
+ # @option params [Types::EncryptionConfig] :encryption_config
328
+ # An AWS Key Management Service (KMS) key and the AWS Identity and
329
+ # Access Management (IAM) role that Amazon Forecast can assume to access
330
+ # the key.
331
+ #
332
+ # @return [Types::CreateDatasetResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
333
+ #
334
+ # * {Types::CreateDatasetResponse#dataset_arn #dataset_arn} => String
335
+ #
336
+ # @example Request syntax with placeholder values
337
+ #
338
+ # resp = client.create_dataset({
339
+ # dataset_name: "Name", # required
340
+ # domain: "RETAIL", # required, accepts RETAIL, CUSTOM, INVENTORY_PLANNING, EC2_CAPACITY, WORK_FORCE, WEB_TRAFFIC, METRICS
341
+ # dataset_type: "TARGET_TIME_SERIES", # required, accepts TARGET_TIME_SERIES, RELATED_TIME_SERIES, ITEM_METADATA
342
+ # data_frequency: "Frequency",
343
+ # schema: { # required
344
+ # attributes: [
345
+ # {
346
+ # attribute_name: "Name",
347
+ # attribute_type: "string", # accepts string, integer, float, timestamp
348
+ # },
349
+ # ],
350
+ # },
351
+ # encryption_config: {
352
+ # role_arn: "Arn", # required
353
+ # kms_key_arn: "KMSKeyArn", # required
354
+ # },
355
+ # })
356
+ #
357
+ # @example Response structure
358
+ #
359
+ # resp.dataset_arn #=> String
360
+ #
361
+ # @see http://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/CreateDataset AWS API Documentation
362
+ #
363
+ # @overload create_dataset(params = {})
364
+ # @param [Hash] params ({})
365
+ def create_dataset(params = {}, options = {})
366
+ req = build_request(:create_dataset, params)
367
+ req.send_request(options)
368
+ end
369
+
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.
374
+ #
375
+ # After creating a dataset group and adding datasets, you use the
376
+ # dataset group when you create a predictor. For more information, see
377
+ # howitworks-datasets-groups.
378
+ #
379
+ # To get a list of all your datasets groups, use the ListDatasetGroups
380
+ # operation.
381
+ #
382
+ # <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.
385
+ #
386
+ # </note>
387
+ #
388
+ # @option params [required, String] :dataset_group_name
389
+ # A name for the dataset group.
390
+ #
391
+ # @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.
399
+ #
400
+ # @option params [Array<String>] :dataset_arns
401
+ # An array of Amazon Resource Names (ARNs) of the datasets that you want
402
+ # to include in the dataset group.
403
+ #
404
+ # @return [Types::CreateDatasetGroupResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
405
+ #
406
+ # * {Types::CreateDatasetGroupResponse#dataset_group_arn #dataset_group_arn} => String
407
+ #
408
+ # @example Request syntax with placeholder values
409
+ #
410
+ # resp = client.create_dataset_group({
411
+ # dataset_group_name: "Name", # required
412
+ # domain: "RETAIL", # required, accepts RETAIL, CUSTOM, INVENTORY_PLANNING, EC2_CAPACITY, WORK_FORCE, WEB_TRAFFIC, METRICS
413
+ # dataset_arns: ["Arn"],
414
+ # })
415
+ #
416
+ # @example Response structure
417
+ #
418
+ # resp.dataset_group_arn #=> String
419
+ #
420
+ # @see http://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/CreateDatasetGroup AWS API Documentation
421
+ #
422
+ # @overload create_dataset_group(params = {})
423
+ # @param [Hash] params ({})
424
+ def create_dataset_group(params = {}, options = {})
425
+ req = build_request(:create_dataset_group, params)
426
+ req.send_request(options)
427
+ end
428
+
429
+ # Imports your training data to an Amazon Forecast dataset. You provide
430
+ # the location of your training data in an Amazon Simple Storage Service
431
+ # (Amazon S3) bucket and the Amazon Resource Name (ARN) of the dataset
432
+ # that you want to import the data to.
433
+ #
434
+ # You must specify a DataSource object that includes an AWS Identity and
435
+ # Access Management (IAM) role that Amazon Forecast can assume to access
436
+ # the data. For more information, see aws-forecast-iam-roles.
437
+ #
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.
446
+ #
447
+ # If the format is not specified, Amazon Forecast expects the format
448
+ # to be "yyyy-MM-dd HH:mm:ss".
449
+ #
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.
461
+ #
462
+ # @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`.
467
+ #
468
+ # @option params [required, String] :dataset_arn
469
+ # The Amazon Resource Name (ARN) of the Amazon Forecast dataset that you
470
+ # want to import data to.
471
+ #
472
+ # @option params [required, Types::DataSource] :data_source
473
+ # The location of the training data to import and an AWS Identity and
474
+ # Access Management (IAM) role that Amazon Forecast can assume to access
475
+ # the data.
476
+ #
477
+ # @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.
481
+ #
482
+ # * "yyyy-MM-dd"
483
+ #
484
+ # For data frequencies: Y, M, W, and D
485
+ #
486
+ # * "yyyy-MM-dd HH:mm:ss"
487
+ #
488
+ # For data frequencies: H, 30min, 15min, and 1min; and optionally,
489
+ # for: Y, M, W, and D
490
+ #
491
+ # @return [Types::CreateDatasetImportJobResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
492
+ #
493
+ # * {Types::CreateDatasetImportJobResponse#dataset_import_job_arn #dataset_import_job_arn} => String
494
+ #
495
+ # @example Request syntax with placeholder values
496
+ #
497
+ # resp = client.create_dataset_import_job({
498
+ # dataset_import_job_name: "Name", # required
499
+ # dataset_arn: "Arn", # required
500
+ # data_source: { # required
501
+ # s3_config: { # required
502
+ # path: "S3Path", # required
503
+ # role_arn: "Arn", # required
504
+ # kms_key_arn: "KMSKeyArn",
505
+ # },
506
+ # },
507
+ # timestamp_format: "TimestampFormat",
508
+ # })
509
+ #
510
+ # @example Response structure
511
+ #
512
+ # resp.dataset_import_job_arn #=> String
513
+ #
514
+ # @see http://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/CreateDatasetImportJob AWS API Documentation
515
+ #
516
+ # @overload create_dataset_import_job(params = {})
517
+ # @param [Hash] params ({})
518
+ def create_dataset_import_job(params = {}, options = {})
519
+ req = build_request(:create_dataset_import_job, params)
520
+ req.send_request(options)
521
+ end
522
+
523
+ # Creates a forecast for each item in the `TARGET_TIME_SERIES` dataset
524
+ # that was used to train the predictor. This is known as inference. To
525
+ # retrieve the forecast for a single item at low latency, use the
526
+ # operation. To export the complete forecast into your Amazon Simple
527
+ # Storage Service (Amazon S3), use the CreateForecastExportJob
528
+ # operation.
529
+ #
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.
535
+ #
536
+ # To get a list of all your forecasts, use the ListForecasts operation.
537
+ #
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.
540
+ #
541
+ # </note>
542
+ #
543
+ # For more information, see howitworks-forecast.
544
+ #
545
+ # <note markdown="1"> The `Status` of the forecast must be `ACTIVE` before you can query or
546
+ # export the forecast. Use the DescribeForecast operation to get the
547
+ # status.
548
+ #
549
+ # </note>
550
+ #
551
+ # @option params [required, String] :forecast_name
552
+ # The name for the forecast.
553
+ #
554
+ # @option params [required, String] :predictor_arn
555
+ # The Amazon Resource Name (ARN) of the predictor to use to generate the
556
+ # forecast.
557
+ #
558
+ # @return [Types::CreateForecastResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
559
+ #
560
+ # * {Types::CreateForecastResponse#forecast_arn #forecast_arn} => String
561
+ #
562
+ # @example Request syntax with placeholder values
563
+ #
564
+ # resp = client.create_forecast({
565
+ # forecast_name: "Name", # required
566
+ # predictor_arn: "Arn", # required
567
+ # })
568
+ #
569
+ # @example Response structure
570
+ #
571
+ # resp.forecast_arn #=> String
572
+ #
573
+ # @see http://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/CreateForecast AWS API Documentation
574
+ #
575
+ # @overload create_forecast(params = {})
576
+ # @param [Hash] params ({})
577
+ def create_forecast(params = {}, options = {})
578
+ req = build_request(:create_forecast, params)
579
+ req.send_request(options)
580
+ end
581
+
582
+ # Exports a forecast created by the CreateForecast operation to your
583
+ # Amazon Simple Storage Service (Amazon S3) bucket.
584
+ #
585
+ # You must specify a DataDestination object that includes an AWS
586
+ # Identity and Access Management (IAM) role that Amazon Forecast can
587
+ # assume to access the Amazon S3 bucket. For more information, see
588
+ # aws-forecast-iam-roles.
589
+ #
590
+ # For more information, see howitworks-forecast.
591
+ #
592
+ # To get a list of all your forecast export jobs, use the
593
+ # ListForecastExportJobs operation.
594
+ #
595
+ # <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.
598
+ #
599
+ # </note>
600
+ #
601
+ # @option params [required, String] :forecast_export_job_name
602
+ # The name for the forecast export job.
603
+ #
604
+ # @option params [required, String] :forecast_arn
605
+ # The Amazon Resource Name (ARN) of the forecast that you want to
606
+ # export.
607
+ #
608
+ # @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.
612
+ #
613
+ # @return [Types::CreateForecastExportJobResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
614
+ #
615
+ # * {Types::CreateForecastExportJobResponse#forecast_export_job_arn #forecast_export_job_arn} => String
616
+ #
617
+ # @example Request syntax with placeholder values
618
+ #
619
+ # resp = client.create_forecast_export_job({
620
+ # forecast_export_job_name: "Name", # required
621
+ # forecast_arn: "Arn", # required
622
+ # destination: { # required
623
+ # s3_config: { # required
624
+ # path: "S3Path", # required
625
+ # role_arn: "Arn", # required
626
+ # kms_key_arn: "KMSKeyArn",
627
+ # },
628
+ # },
629
+ # })
630
+ #
631
+ # @example Response structure
632
+ #
633
+ # resp.forecast_export_job_arn #=> String
634
+ #
635
+ # @see http://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/CreateForecastExportJob AWS API Documentation
636
+ #
637
+ # @overload create_forecast_export_job(params = {})
638
+ # @param [Hash] params ({})
639
+ def create_forecast_export_job(params = {}, options = {})
640
+ req = build_request(:create_forecast_export_job, params)
641
+ req.send_request(options)
642
+ end
643
+
644
+ # Creates an Amazon Forecast predictor.
645
+ #
646
+ # In the request, you provide a dataset group and either specify an
647
+ # algorithm or let Amazon Forecast choose the algorithm for you using
648
+ # AutoML. If you specify an algorithm, you also can override
649
+ # algorithm-specific hyperparameters.
650
+ #
651
+ # Amazon Forecast uses the chosen algorithm to train a model using the
652
+ # latest version of the datasets in the specified dataset group. The
653
+ # result is called a predictor. You then generate a forecast using the
654
+ # CreateForecast operation.
655
+ #
656
+ # After training a model, the `CreatePredictor` operation also evaluates
657
+ # it. To see the evaluation metrics, use the GetAccuracyMetrics
658
+ # operation. Always review the evaluation metrics before deciding to use
659
+ # the predictor to generate a forecast.
660
+ #
661
+ # Optionally, you can specify a featurization configuration to fill and
662
+ # aggragate the data fields in the `TARGET_TIME_SERIES` dataset to
663
+ # improve model training. For more information, see FeaturizationConfig.
664
+ #
665
+ # **AutoML**
666
+ #
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
671
+ # EvaluationResult.
672
+ #
673
+ # When AutoML is enabled, the following properties are disallowed:
674
+ #
675
+ # * `AlgorithmArn`
676
+ #
677
+ # * `HPOConfig`
678
+ #
679
+ # * `PerformHPO`
680
+ #
681
+ # * `TrainingParameters`
682
+ #
683
+ # To get a list of all your predictors, use the ListPredictors
684
+ # operation.
685
+ #
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.
689
+ #
690
+ # </note>
691
+ #
692
+ # @option params [required, String] :predictor_name
693
+ # A name for the predictor.
694
+ #
695
+ # @option params [String] :algorithm_arn
696
+ # The Amazon Resource Name (ARN) of the algorithm to use for model
697
+ # training. Required if `PerformAutoML` is not set to `true`.
698
+ #
699
+ # **Supported algorithms**
700
+ #
701
+ # * `arn:aws:forecast:::algorithm/ARIMA`
702
+ #
703
+ # * `arn:aws:forecast:::algorithm/Deep_AR_Plus`
704
+ #
705
+ # `- supports hyperparameter optimization (HPO)`
706
+ #
707
+ # * `arn:aws:forecast:::algorithm/ETS`
708
+ #
709
+ # * `arn:aws:forecast:::algorithm/NPTS`
710
+ #
711
+ # * `arn:aws:forecast:::algorithm/Prophet`
712
+ #
713
+ # @option params [required, Integer] :forecast_horizon
714
+ # Specifies the number of time-steps that the model is trained to
715
+ # predict. The forecast horizon is also called the prediction length.
716
+ #
717
+ # For example, if you configure a dataset for daily data collection
718
+ # (using the `DataFrequency` parameter of the CreateDataset operation)
719
+ # and set the forecast horizon to 10, the model returns predictions for
720
+ # 10 days.
721
+ #
722
+ # @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.
725
+ #
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.
730
+ #
731
+ # @option params [Boolean] :perform_hpo
732
+ # Whether to perform hyperparameter optimization (HPO). HPO finds
733
+ # optimal hyperparameter values for your training data. The process of
734
+ # performing HPO is known as a hyperparameter tuning job.
735
+ #
736
+ # The default value is `false`. In this case, Amazon Forecast uses
737
+ # default hyperparameter values from the chosen algorithm.
738
+ #
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.
743
+ #
744
+ # The following algorithms support HPO:
745
+ #
746
+ # * DeepAR+
747
+ #
748
+ # ^
749
+ #
750
+ # @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
753
+ # aws-forecast-choosing-recipes.
754
+ #
755
+ # @option params [Types::EvaluationParameters] :evaluation_parameters
756
+ # Used to override the default evaluation parameters of the specified
757
+ # algorithm. Amazon Forecast evaluates a predictor by splitting a
758
+ # dataset into training data and testing data. The evaluation parameters
759
+ # define how to perform the split and the number of iterations.
760
+ #
761
+ # @option params [Types::HyperParameterTuningJobConfig] :hpo_config
762
+ # Provides hyperparameter override values for the algorithm. If you
763
+ # don't provide this parameter, Amazon Forecast uses default values.
764
+ # The individual algorithms specify which hyperparameters support
765
+ # hyperparameter optimization (HPO). For more information, see
766
+ # aws-forecast-choosing-recipes.
767
+ #
768
+ # @option params [required, Types::InputDataConfig] :input_data_config
769
+ # Describes the dataset group that contains the data to use to train the
770
+ # predictor.
771
+ #
772
+ # @option params [required, Types::FeaturizationConfig] :featurization_config
773
+ # The featurization configuration.
774
+ #
775
+ # @option params [Types::EncryptionConfig] :encryption_config
776
+ # An AWS Key Management Service (KMS) key and the AWS Identity and
777
+ # Access Management (IAM) role that Amazon Forecast can assume to access
778
+ # the key.
779
+ #
780
+ # @return [Types::CreatePredictorResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
781
+ #
782
+ # * {Types::CreatePredictorResponse#predictor_arn #predictor_arn} => String
783
+ #
784
+ # @example Request syntax with placeholder values
785
+ #
786
+ # resp = client.create_predictor({
787
+ # predictor_name: "Name", # required
788
+ # algorithm_arn: "Arn",
789
+ # forecast_horizon: 1, # required
790
+ # perform_auto_ml: false,
791
+ # perform_hpo: false,
792
+ # training_parameters: {
793
+ # "ParameterKey" => "ParameterValue",
794
+ # },
795
+ # evaluation_parameters: {
796
+ # number_of_backtest_windows: 1,
797
+ # back_test_window_offset: 1,
798
+ # },
799
+ # hpo_config: {
800
+ # parameter_ranges: {
801
+ # categorical_parameter_ranges: [
802
+ # {
803
+ # name: "Name", # required
804
+ # values: ["Value"], # required
805
+ # },
806
+ # ],
807
+ # continuous_parameter_ranges: [
808
+ # {
809
+ # name: "Name", # required
810
+ # max_value: 1.0, # required
811
+ # min_value: 1.0, # required
812
+ # scaling_type: "Auto", # accepts Auto, Linear, Logarithmic, ReverseLogarithmic
813
+ # },
814
+ # ],
815
+ # integer_parameter_ranges: [
816
+ # {
817
+ # name: "Name", # required
818
+ # max_value: 1, # required
819
+ # min_value: 1, # required
820
+ # scaling_type: "Auto", # accepts Auto, Linear, Logarithmic, ReverseLogarithmic
821
+ # },
822
+ # ],
823
+ # },
824
+ # },
825
+ # input_data_config: { # required
826
+ # dataset_group_arn: "Arn", # required
827
+ # supplementary_features: [
828
+ # {
829
+ # name: "Name", # required
830
+ # value: "Value", # required
831
+ # },
832
+ # ],
833
+ # },
834
+ # featurization_config: { # required
835
+ # forecast_frequency: "Frequency", # required
836
+ # forecast_dimensions: ["Name"],
837
+ # featurizations: [
838
+ # {
839
+ # attribute_name: "Name", # required
840
+ # featurization_pipeline: [
841
+ # {
842
+ # featurization_method_name: "filling", # required, accepts filling
843
+ # featurization_method_parameters: {
844
+ # "ParameterKey" => "ParameterValue",
845
+ # },
846
+ # },
847
+ # ],
848
+ # },
849
+ # ],
850
+ # },
851
+ # encryption_config: {
852
+ # role_arn: "Arn", # required
853
+ # kms_key_arn: "KMSKeyArn", # required
854
+ # },
855
+ # })
856
+ #
857
+ # @example Response structure
858
+ #
859
+ # resp.predictor_arn #=> String
860
+ #
861
+ # @see http://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/CreatePredictor AWS API Documentation
862
+ #
863
+ # @overload create_predictor(params = {})
864
+ # @param [Hash] params ({})
865
+ def create_predictor(params = {}, options = {})
866
+ req = build_request(:create_predictor, params)
867
+ req.send_request(options)
868
+ end
869
+
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.
874
+ #
875
+ # @option params [required, String] :dataset_arn
876
+ # The Amazon Resource Name (ARN) of the dataset to delete.
877
+ #
878
+ # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
879
+ #
880
+ # @example Request syntax with placeholder values
881
+ #
882
+ # resp = client.delete_dataset({
883
+ # dataset_arn: "Arn", # required
884
+ # })
885
+ #
886
+ # @see http://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/DeleteDataset AWS API Documentation
887
+ #
888
+ # @overload delete_dataset(params = {})
889
+ # @param [Hash] params ({})
890
+ def delete_dataset(params = {}, options = {})
891
+ req = build_request(:delete_dataset, params)
892
+ req.send_request(options)
893
+ end
894
+
895
+ # 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.
899
+ #
900
+ # The operation deletes only the dataset group, not the datasets in the
901
+ # group.
902
+ #
903
+ # @option params [required, String] :dataset_group_arn
904
+ # The Amazon Resource Name (ARN) of the dataset group to delete.
905
+ #
906
+ # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
907
+ #
908
+ # @example Request syntax with placeholder values
909
+ #
910
+ # resp = client.delete_dataset_group({
911
+ # dataset_group_arn: "Arn", # required
912
+ # })
913
+ #
914
+ # @see http://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/DeleteDatasetGroup AWS API Documentation
915
+ #
916
+ # @overload delete_dataset_group(params = {})
917
+ # @param [Hash] params ({})
918
+ def delete_dataset_group(params = {}, options = {})
919
+ req = build_request(:delete_dataset_group, params)
920
+ req.send_request(options)
921
+ end
922
+
923
+ # 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.
927
+ #
928
+ # @option params [required, String] :dataset_import_job_arn
929
+ # The Amazon Resource Name (ARN) of the dataset import job to delete.
930
+ #
931
+ # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
932
+ #
933
+ # @example Request syntax with placeholder values
934
+ #
935
+ # resp = client.delete_dataset_import_job({
936
+ # dataset_import_job_arn: "Arn", # required
937
+ # })
938
+ #
939
+ # @see http://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/DeleteDatasetImportJob AWS API Documentation
940
+ #
941
+ # @overload delete_dataset_import_job(params = {})
942
+ # @param [Hash] params ({})
943
+ def delete_dataset_import_job(params = {}, options = {})
944
+ req = build_request(:delete_dataset_import_job, params)
945
+ req.send_request(options)
946
+ end
947
+
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.
951
+ #
952
+ # You can't delete a forecast while it is being exported.
953
+ #
954
+ # @option params [required, String] :forecast_arn
955
+ # The Amazon Resource Name (ARN) of the forecast to delete.
956
+ #
957
+ # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
958
+ #
959
+ # @example Request syntax with placeholder values
960
+ #
961
+ # resp = client.delete_forecast({
962
+ # forecast_arn: "Arn", # required
963
+ # })
964
+ #
965
+ # @see http://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/DeleteForecast AWS API Documentation
966
+ #
967
+ # @overload delete_forecast(params = {})
968
+ # @param [Hash] params ({})
969
+ def delete_forecast(params = {}, options = {})
970
+ req = build_request(:delete_forecast, params)
971
+ req.send_request(options)
972
+ end
973
+
974
+ # 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.
978
+ #
979
+ # @option params [required, String] :forecast_export_job_arn
980
+ # The Amazon Resource Name (ARN) of the forecast export job to delete.
981
+ #
982
+ # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
983
+ #
984
+ # @example Request syntax with placeholder values
985
+ #
986
+ # resp = client.delete_forecast_export_job({
987
+ # forecast_export_job_arn: "Arn", # required
988
+ # })
989
+ #
990
+ # @see http://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/DeleteForecastExportJob AWS API Documentation
991
+ #
992
+ # @overload delete_forecast_export_job(params = {})
993
+ # @param [Hash] params ({})
994
+ def delete_forecast_export_job(params = {}, options = {})
995
+ req = build_request(:delete_forecast_export_job, params)
996
+ req.send_request(options)
997
+ end
998
+
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.
1005
+ #
1006
+ # @option params [required, String] :predictor_arn
1007
+ # The Amazon Resource Name (ARN) of the predictor to delete.
1008
+ #
1009
+ # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
1010
+ #
1011
+ # @example Request syntax with placeholder values
1012
+ #
1013
+ # resp = client.delete_predictor({
1014
+ # predictor_arn: "Arn", # required
1015
+ # })
1016
+ #
1017
+ # @see http://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/DeletePredictor AWS API Documentation
1018
+ #
1019
+ # @overload delete_predictor(params = {})
1020
+ # @param [Hash] params ({})
1021
+ def delete_predictor(params = {}, options = {})
1022
+ req = build_request(:delete_predictor, params)
1023
+ req.send_request(options)
1024
+ end
1025
+
1026
+ # Describes an Amazon Forecast dataset created using the CreateDataset
1027
+ # operation.
1028
+ #
1029
+ # In addition to listing the properties provided by the user in the
1030
+ # `CreateDataset` request, this operation includes the following
1031
+ # properties:
1032
+ #
1033
+ # * `CreationTime`
1034
+ #
1035
+ # * `LastModificationTime`
1036
+ #
1037
+ # * `Status`
1038
+ #
1039
+ # @option params [required, String] :dataset_arn
1040
+ # The Amazon Resource Name (ARN) of the dataset.
1041
+ #
1042
+ # @return [Types::DescribeDatasetResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1043
+ #
1044
+ # * {Types::DescribeDatasetResponse#dataset_arn #dataset_arn} => String
1045
+ # * {Types::DescribeDatasetResponse#dataset_name #dataset_name} => String
1046
+ # * {Types::DescribeDatasetResponse#domain #domain} => String
1047
+ # * {Types::DescribeDatasetResponse#dataset_type #dataset_type} => String
1048
+ # * {Types::DescribeDatasetResponse#data_frequency #data_frequency} => String
1049
+ # * {Types::DescribeDatasetResponse#schema #schema} => Types::Schema
1050
+ # * {Types::DescribeDatasetResponse#encryption_config #encryption_config} => Types::EncryptionConfig
1051
+ # * {Types::DescribeDatasetResponse#status #status} => String
1052
+ # * {Types::DescribeDatasetResponse#creation_time #creation_time} => Time
1053
+ # * {Types::DescribeDatasetResponse#last_modification_time #last_modification_time} => Time
1054
+ #
1055
+ # @example Request syntax with placeholder values
1056
+ #
1057
+ # resp = client.describe_dataset({
1058
+ # dataset_arn: "Arn", # required
1059
+ # })
1060
+ #
1061
+ # @example Response structure
1062
+ #
1063
+ # resp.dataset_arn #=> String
1064
+ # resp.dataset_name #=> String
1065
+ # resp.domain #=> String, one of "RETAIL", "CUSTOM", "INVENTORY_PLANNING", "EC2_CAPACITY", "WORK_FORCE", "WEB_TRAFFIC", "METRICS"
1066
+ # resp.dataset_type #=> String, one of "TARGET_TIME_SERIES", "RELATED_TIME_SERIES", "ITEM_METADATA"
1067
+ # resp.data_frequency #=> String
1068
+ # resp.schema.attributes #=> Array
1069
+ # resp.schema.attributes[0].attribute_name #=> String
1070
+ # resp.schema.attributes[0].attribute_type #=> String, one of "string", "integer", "float", "timestamp"
1071
+ # resp.encryption_config.role_arn #=> String
1072
+ # resp.encryption_config.kms_key_arn #=> String
1073
+ # resp.status #=> String
1074
+ # resp.creation_time #=> Time
1075
+ # resp.last_modification_time #=> Time
1076
+ #
1077
+ # @see http://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/DescribeDataset AWS API Documentation
1078
+ #
1079
+ # @overload describe_dataset(params = {})
1080
+ # @param [Hash] params ({})
1081
+ def describe_dataset(params = {}, options = {})
1082
+ req = build_request(:describe_dataset, params)
1083
+ req.send_request(options)
1084
+ end
1085
+
1086
+ # Describes a dataset group created using the CreateDatasetGroup
1087
+ # operation.
1088
+ #
1089
+ # In addition to listing the properties provided by the user in the
1090
+ # `CreateDatasetGroup` request, this operation includes the following
1091
+ # properties:
1092
+ #
1093
+ # * `DatasetArns` - The datasets belonging to the group.
1094
+ #
1095
+ # * `CreationTime`
1096
+ #
1097
+ # * `LastModificationTime`
1098
+ #
1099
+ # * `Status`
1100
+ #
1101
+ # @option params [required, String] :dataset_group_arn
1102
+ # The Amazon Resource Name (ARN) of the dataset group.
1103
+ #
1104
+ # @return [Types::DescribeDatasetGroupResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1105
+ #
1106
+ # * {Types::DescribeDatasetGroupResponse#dataset_group_name #dataset_group_name} => String
1107
+ # * {Types::DescribeDatasetGroupResponse#dataset_group_arn #dataset_group_arn} => String
1108
+ # * {Types::DescribeDatasetGroupResponse#dataset_arns #dataset_arns} => Array&lt;String&gt;
1109
+ # * {Types::DescribeDatasetGroupResponse#domain #domain} => String
1110
+ # * {Types::DescribeDatasetGroupResponse#status #status} => String
1111
+ # * {Types::DescribeDatasetGroupResponse#creation_time #creation_time} => Time
1112
+ # * {Types::DescribeDatasetGroupResponse#last_modification_time #last_modification_time} => Time
1113
+ #
1114
+ # @example Request syntax with placeholder values
1115
+ #
1116
+ # resp = client.describe_dataset_group({
1117
+ # dataset_group_arn: "Arn", # required
1118
+ # })
1119
+ #
1120
+ # @example Response structure
1121
+ #
1122
+ # resp.dataset_group_name #=> String
1123
+ # resp.dataset_group_arn #=> String
1124
+ # resp.dataset_arns #=> Array
1125
+ # resp.dataset_arns[0] #=> String
1126
+ # resp.domain #=> String, one of "RETAIL", "CUSTOM", "INVENTORY_PLANNING", "EC2_CAPACITY", "WORK_FORCE", "WEB_TRAFFIC", "METRICS"
1127
+ # resp.status #=> String
1128
+ # resp.creation_time #=> Time
1129
+ # resp.last_modification_time #=> Time
1130
+ #
1131
+ # @see http://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/DescribeDatasetGroup AWS API Documentation
1132
+ #
1133
+ # @overload describe_dataset_group(params = {})
1134
+ # @param [Hash] params ({})
1135
+ def describe_dataset_group(params = {}, options = {})
1136
+ req = build_request(:describe_dataset_group, params)
1137
+ req.send_request(options)
1138
+ end
1139
+
1140
+ # Describes a dataset import job created using the
1141
+ # CreateDatasetImportJob operation.
1142
+ #
1143
+ # In addition to listing the properties provided by the user in the
1144
+ # `CreateDatasetImportJob` request, this operation includes the
1145
+ # following properties:
1146
+ #
1147
+ # * `CreationTime`
1148
+ #
1149
+ # * `LastModificationTime`
1150
+ #
1151
+ # * `DataSize`
1152
+ #
1153
+ # * `FieldStatistics`
1154
+ #
1155
+ # * `Status`
1156
+ #
1157
+ # * `Message` - If an error occurred, information about the error.
1158
+ #
1159
+ # @option params [required, String] :dataset_import_job_arn
1160
+ # The Amazon Resource Name (ARN) of the dataset import job.
1161
+ #
1162
+ # @return [Types::DescribeDatasetImportJobResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1163
+ #
1164
+ # * {Types::DescribeDatasetImportJobResponse#dataset_import_job_name #dataset_import_job_name} => String
1165
+ # * {Types::DescribeDatasetImportJobResponse#dataset_import_job_arn #dataset_import_job_arn} => String
1166
+ # * {Types::DescribeDatasetImportJobResponse#dataset_arn #dataset_arn} => String
1167
+ # * {Types::DescribeDatasetImportJobResponse#timestamp_format #timestamp_format} => String
1168
+ # * {Types::DescribeDatasetImportJobResponse#data_source #data_source} => Types::DataSource
1169
+ # * {Types::DescribeDatasetImportJobResponse#field_statistics #field_statistics} => Hash&lt;String,Types::Statistics&gt;
1170
+ # * {Types::DescribeDatasetImportJobResponse#data_size #data_size} => Float
1171
+ # * {Types::DescribeDatasetImportJobResponse#status #status} => String
1172
+ # * {Types::DescribeDatasetImportJobResponse#message #message} => String
1173
+ # * {Types::DescribeDatasetImportJobResponse#creation_time #creation_time} => Time
1174
+ # * {Types::DescribeDatasetImportJobResponse#last_modification_time #last_modification_time} => Time
1175
+ #
1176
+ # @example Request syntax with placeholder values
1177
+ #
1178
+ # resp = client.describe_dataset_import_job({
1179
+ # dataset_import_job_arn: "Arn", # required
1180
+ # })
1181
+ #
1182
+ # @example Response structure
1183
+ #
1184
+ # resp.dataset_import_job_name #=> String
1185
+ # resp.dataset_import_job_arn #=> String
1186
+ # resp.dataset_arn #=> String
1187
+ # resp.timestamp_format #=> String
1188
+ # resp.data_source.s3_config.path #=> String
1189
+ # resp.data_source.s3_config.role_arn #=> String
1190
+ # resp.data_source.s3_config.kms_key_arn #=> String
1191
+ # resp.field_statistics #=> Hash
1192
+ # resp.field_statistics["String"].count #=> Integer
1193
+ # resp.field_statistics["String"].count_distinct #=> Integer
1194
+ # resp.field_statistics["String"].count_null #=> Integer
1195
+ # resp.field_statistics["String"].count_nan #=> Integer
1196
+ # resp.field_statistics["String"].min #=> String
1197
+ # resp.field_statistics["String"].max #=> String
1198
+ # resp.field_statistics["String"].avg #=> Float
1199
+ # resp.field_statistics["String"].stddev #=> Float
1200
+ # resp.data_size #=> Float
1201
+ # resp.status #=> String
1202
+ # resp.message #=> String
1203
+ # resp.creation_time #=> Time
1204
+ # resp.last_modification_time #=> Time
1205
+ #
1206
+ # @see http://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/DescribeDatasetImportJob AWS API Documentation
1207
+ #
1208
+ # @overload describe_dataset_import_job(params = {})
1209
+ # @param [Hash] params ({})
1210
+ def describe_dataset_import_job(params = {}, options = {})
1211
+ req = build_request(:describe_dataset_import_job, params)
1212
+ req.send_request(options)
1213
+ end
1214
+
1215
+ # Describes a forecast created using the CreateForecast operation.
1216
+ #
1217
+ # In addition to listing the properties provided by the user in the
1218
+ # `CreateForecast` request, this operation includes the following
1219
+ # properties:
1220
+ #
1221
+ # * `DatasetGroupArn` - The dataset group that provided the training
1222
+ # data.
1223
+ #
1224
+ # * `CreationTime`
1225
+ #
1226
+ # * `LastModificationTime`
1227
+ #
1228
+ # * `Status`
1229
+ #
1230
+ # * `Message` - If an error occurred, information about the error.
1231
+ #
1232
+ # @option params [required, String] :forecast_arn
1233
+ # The Amazon Resource Name (ARN) of the forecast.
1234
+ #
1235
+ # @return [Types::DescribeForecastResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1236
+ #
1237
+ # * {Types::DescribeForecastResponse#forecast_arn #forecast_arn} => String
1238
+ # * {Types::DescribeForecastResponse#forecast_name #forecast_name} => String
1239
+ # * {Types::DescribeForecastResponse#predictor_arn #predictor_arn} => String
1240
+ # * {Types::DescribeForecastResponse#dataset_group_arn #dataset_group_arn} => String
1241
+ # * {Types::DescribeForecastResponse#status #status} => String
1242
+ # * {Types::DescribeForecastResponse#message #message} => String
1243
+ # * {Types::DescribeForecastResponse#creation_time #creation_time} => Time
1244
+ # * {Types::DescribeForecastResponse#last_modification_time #last_modification_time} => Time
1245
+ #
1246
+ # @example Request syntax with placeholder values
1247
+ #
1248
+ # resp = client.describe_forecast({
1249
+ # forecast_arn: "Arn", # required
1250
+ # })
1251
+ #
1252
+ # @example Response structure
1253
+ #
1254
+ # resp.forecast_arn #=> String
1255
+ # resp.forecast_name #=> String
1256
+ # resp.predictor_arn #=> String
1257
+ # resp.dataset_group_arn #=> String
1258
+ # resp.status #=> String
1259
+ # resp.message #=> String
1260
+ # resp.creation_time #=> Time
1261
+ # resp.last_modification_time #=> Time
1262
+ #
1263
+ # @see http://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/DescribeForecast AWS API Documentation
1264
+ #
1265
+ # @overload describe_forecast(params = {})
1266
+ # @param [Hash] params ({})
1267
+ def describe_forecast(params = {}, options = {})
1268
+ req = build_request(:describe_forecast, params)
1269
+ req.send_request(options)
1270
+ end
1271
+
1272
+ # Describes a forecast export job created using the
1273
+ # CreateForecastExportJob operation.
1274
+ #
1275
+ # In addition to listing the properties provided by the user in the
1276
+ # `CreateForecastExportJob` request, this operation includes the
1277
+ # following properties:
1278
+ #
1279
+ # * `CreationTime`
1280
+ #
1281
+ # * `LastModificationTime`
1282
+ #
1283
+ # * `Status`
1284
+ #
1285
+ # * `Message` - If an error occurred, information about the error.
1286
+ #
1287
+ # @option params [required, String] :forecast_export_job_arn
1288
+ # The Amazon Resource Name (ARN) of the forecast export job.
1289
+ #
1290
+ # @return [Types::DescribeForecastExportJobResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1291
+ #
1292
+ # * {Types::DescribeForecastExportJobResponse#forecast_export_job_arn #forecast_export_job_arn} => String
1293
+ # * {Types::DescribeForecastExportJobResponse#forecast_export_job_name #forecast_export_job_name} => String
1294
+ # * {Types::DescribeForecastExportJobResponse#forecast_arn #forecast_arn} => String
1295
+ # * {Types::DescribeForecastExportJobResponse#destination #destination} => Types::DataDestination
1296
+ # * {Types::DescribeForecastExportJobResponse#message #message} => String
1297
+ # * {Types::DescribeForecastExportJobResponse#status #status} => String
1298
+ # * {Types::DescribeForecastExportJobResponse#creation_time #creation_time} => Time
1299
+ # * {Types::DescribeForecastExportJobResponse#last_modification_time #last_modification_time} => Time
1300
+ #
1301
+ # @example Request syntax with placeholder values
1302
+ #
1303
+ # resp = client.describe_forecast_export_job({
1304
+ # forecast_export_job_arn: "Arn", # required
1305
+ # })
1306
+ #
1307
+ # @example Response structure
1308
+ #
1309
+ # resp.forecast_export_job_arn #=> String
1310
+ # resp.forecast_export_job_name #=> String
1311
+ # resp.forecast_arn #=> String
1312
+ # resp.destination.s3_config.path #=> String
1313
+ # resp.destination.s3_config.role_arn #=> String
1314
+ # resp.destination.s3_config.kms_key_arn #=> String
1315
+ # resp.message #=> String
1316
+ # resp.status #=> String
1317
+ # resp.creation_time #=> Time
1318
+ # resp.last_modification_time #=> Time
1319
+ #
1320
+ # @see http://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/DescribeForecastExportJob AWS API Documentation
1321
+ #
1322
+ # @overload describe_forecast_export_job(params = {})
1323
+ # @param [Hash] params ({})
1324
+ def describe_forecast_export_job(params = {}, options = {})
1325
+ req = build_request(:describe_forecast_export_job, params)
1326
+ req.send_request(options)
1327
+ end
1328
+
1329
+ # Describes a predictor created using the CreatePredictor operation.
1330
+ #
1331
+ # In addition to listing the properties provided by the user in the
1332
+ # `CreatePredictor` request, this operation includes the following
1333
+ # properties:
1334
+ #
1335
+ # * `DatasetImportJobArns` - The dataset import jobs used to import
1336
+ # training data.
1337
+ #
1338
+ # * `AutoMLAlgorithmArns` - If AutoML is performed, the algorithms
1339
+ # evaluated.
1340
+ #
1341
+ # * `CreationTime`
1342
+ #
1343
+ # * `LastModificationTime`
1344
+ #
1345
+ # * `Status`
1346
+ #
1347
+ # * `Message` - If an error occurred, information about the error.
1348
+ #
1349
+ # @option params [required, String] :predictor_arn
1350
+ # The Amazon Resource Name (ARN) of the predictor that you want
1351
+ # information about.
1352
+ #
1353
+ # @return [Types::DescribePredictorResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1354
+ #
1355
+ # * {Types::DescribePredictorResponse#predictor_arn #predictor_arn} => String
1356
+ # * {Types::DescribePredictorResponse#predictor_name #predictor_name} => String
1357
+ # * {Types::DescribePredictorResponse#algorithm_arn #algorithm_arn} => String
1358
+ # * {Types::DescribePredictorResponse#forecast_horizon #forecast_horizon} => Integer
1359
+ # * {Types::DescribePredictorResponse#perform_auto_ml #perform_auto_ml} => Boolean
1360
+ # * {Types::DescribePredictorResponse#perform_hpo #perform_hpo} => Boolean
1361
+ # * {Types::DescribePredictorResponse#training_parameters #training_parameters} => Hash&lt;String,String&gt;
1362
+ # * {Types::DescribePredictorResponse#evaluation_parameters #evaluation_parameters} => Types::EvaluationParameters
1363
+ # * {Types::DescribePredictorResponse#hpo_config #hpo_config} => Types::HyperParameterTuningJobConfig
1364
+ # * {Types::DescribePredictorResponse#input_data_config #input_data_config} => Types::InputDataConfig
1365
+ # * {Types::DescribePredictorResponse#featurization_config #featurization_config} => Types::FeaturizationConfig
1366
+ # * {Types::DescribePredictorResponse#encryption_config #encryption_config} => Types::EncryptionConfig
1367
+ # * {Types::DescribePredictorResponse#dataset_import_job_arns #dataset_import_job_arns} => Array&lt;String&gt;
1368
+ # * {Types::DescribePredictorResponse#auto_ml_algorithm_arns #auto_ml_algorithm_arns} => Array&lt;String&gt;
1369
+ # * {Types::DescribePredictorResponse#status #status} => String
1370
+ # * {Types::DescribePredictorResponse#message #message} => String
1371
+ # * {Types::DescribePredictorResponse#creation_time #creation_time} => Time
1372
+ # * {Types::DescribePredictorResponse#last_modification_time #last_modification_time} => Time
1373
+ #
1374
+ # @example Request syntax with placeholder values
1375
+ #
1376
+ # resp = client.describe_predictor({
1377
+ # predictor_arn: "Arn", # required
1378
+ # })
1379
+ #
1380
+ # @example Response structure
1381
+ #
1382
+ # resp.predictor_arn #=> String
1383
+ # resp.predictor_name #=> String
1384
+ # resp.algorithm_arn #=> String
1385
+ # resp.forecast_horizon #=> Integer
1386
+ # resp.perform_auto_ml #=> Boolean
1387
+ # resp.perform_hpo #=> Boolean
1388
+ # resp.training_parameters #=> Hash
1389
+ # resp.training_parameters["ParameterKey"] #=> String
1390
+ # resp.evaluation_parameters.number_of_backtest_windows #=> Integer
1391
+ # resp.evaluation_parameters.back_test_window_offset #=> Integer
1392
+ # resp.hpo_config.parameter_ranges.categorical_parameter_ranges #=> Array
1393
+ # resp.hpo_config.parameter_ranges.categorical_parameter_ranges[0].name #=> String
1394
+ # resp.hpo_config.parameter_ranges.categorical_parameter_ranges[0].values #=> Array
1395
+ # resp.hpo_config.parameter_ranges.categorical_parameter_ranges[0].values[0] #=> String
1396
+ # resp.hpo_config.parameter_ranges.continuous_parameter_ranges #=> Array
1397
+ # resp.hpo_config.parameter_ranges.continuous_parameter_ranges[0].name #=> String
1398
+ # resp.hpo_config.parameter_ranges.continuous_parameter_ranges[0].max_value #=> Float
1399
+ # resp.hpo_config.parameter_ranges.continuous_parameter_ranges[0].min_value #=> Float
1400
+ # resp.hpo_config.parameter_ranges.continuous_parameter_ranges[0].scaling_type #=> String, one of "Auto", "Linear", "Logarithmic", "ReverseLogarithmic"
1401
+ # resp.hpo_config.parameter_ranges.integer_parameter_ranges #=> Array
1402
+ # resp.hpo_config.parameter_ranges.integer_parameter_ranges[0].name #=> String
1403
+ # resp.hpo_config.parameter_ranges.integer_parameter_ranges[0].max_value #=> Integer
1404
+ # resp.hpo_config.parameter_ranges.integer_parameter_ranges[0].min_value #=> Integer
1405
+ # resp.hpo_config.parameter_ranges.integer_parameter_ranges[0].scaling_type #=> String, one of "Auto", "Linear", "Logarithmic", "ReverseLogarithmic"
1406
+ # resp.input_data_config.dataset_group_arn #=> String
1407
+ # resp.input_data_config.supplementary_features #=> Array
1408
+ # resp.input_data_config.supplementary_features[0].name #=> String
1409
+ # resp.input_data_config.supplementary_features[0].value #=> String
1410
+ # resp.featurization_config.forecast_frequency #=> String
1411
+ # resp.featurization_config.forecast_dimensions #=> Array
1412
+ # resp.featurization_config.forecast_dimensions[0] #=> String
1413
+ # resp.featurization_config.featurizations #=> Array
1414
+ # resp.featurization_config.featurizations[0].attribute_name #=> String
1415
+ # resp.featurization_config.featurizations[0].featurization_pipeline #=> Array
1416
+ # resp.featurization_config.featurizations[0].featurization_pipeline[0].featurization_method_name #=> String, one of "filling"
1417
+ # resp.featurization_config.featurizations[0].featurization_pipeline[0].featurization_method_parameters #=> Hash
1418
+ # resp.featurization_config.featurizations[0].featurization_pipeline[0].featurization_method_parameters["ParameterKey"] #=> String
1419
+ # resp.encryption_config.role_arn #=> String
1420
+ # resp.encryption_config.kms_key_arn #=> String
1421
+ # resp.dataset_import_job_arns #=> Array
1422
+ # resp.dataset_import_job_arns[0] #=> String
1423
+ # resp.auto_ml_algorithm_arns #=> Array
1424
+ # resp.auto_ml_algorithm_arns[0] #=> String
1425
+ # resp.status #=> String
1426
+ # resp.message #=> String
1427
+ # resp.creation_time #=> Time
1428
+ # resp.last_modification_time #=> Time
1429
+ #
1430
+ # @see http://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/DescribePredictor AWS API Documentation
1431
+ #
1432
+ # @overload describe_predictor(params = {})
1433
+ # @param [Hash] params ({})
1434
+ def describe_predictor(params = {}, options = {})
1435
+ req = build_request(:describe_predictor, params)
1436
+ req.send_request(options)
1437
+ end
1438
+
1439
+ # Provides metrics on the accuracy of the models that were trained by
1440
+ # the CreatePredictor operation. Use metrics to see how well the model
1441
+ # performed and to decide whether to use the predictor to generate a
1442
+ # forecast.
1443
+ #
1444
+ # Metrics are generated for each backtest window evaluated. For more
1445
+ # information, see EvaluationParameters.
1446
+ #
1447
+ # 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.
1452
+ #
1453
+ # For an example of how to train a model and review metrics, see
1454
+ # getting-started.
1455
+ #
1456
+ # @option params [required, String] :predictor_arn
1457
+ # The Amazon Resource Name (ARN) of the predictor to get metrics for.
1458
+ #
1459
+ # @return [Types::GetAccuracyMetricsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1460
+ #
1461
+ # * {Types::GetAccuracyMetricsResponse#predictor_evaluation_results #predictor_evaluation_results} => Array&lt;Types::EvaluationResult&gt;
1462
+ #
1463
+ # @example Request syntax with placeholder values
1464
+ #
1465
+ # resp = client.get_accuracy_metrics({
1466
+ # predictor_arn: "Arn", # required
1467
+ # })
1468
+ #
1469
+ # @example Response structure
1470
+ #
1471
+ # resp.predictor_evaluation_results #=> Array
1472
+ # resp.predictor_evaluation_results[0].algorithm_arn #=> String
1473
+ # resp.predictor_evaluation_results[0].test_windows #=> Array
1474
+ # resp.predictor_evaluation_results[0].test_windows[0].test_window_start #=> Time
1475
+ # resp.predictor_evaluation_results[0].test_windows[0].test_window_end #=> Time
1476
+ # resp.predictor_evaluation_results[0].test_windows[0].item_count #=> Integer
1477
+ # resp.predictor_evaluation_results[0].test_windows[0].evaluation_type #=> String, one of "SUMMARY", "COMPUTED"
1478
+ # resp.predictor_evaluation_results[0].test_windows[0].metrics.rmse #=> Float
1479
+ # resp.predictor_evaluation_results[0].test_windows[0].metrics.weighted_quantile_losses #=> Array
1480
+ # resp.predictor_evaluation_results[0].test_windows[0].metrics.weighted_quantile_losses[0].quantile #=> Float
1481
+ # resp.predictor_evaluation_results[0].test_windows[0].metrics.weighted_quantile_losses[0].loss_value #=> Float
1482
+ #
1483
+ # @see http://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/GetAccuracyMetrics AWS API Documentation
1484
+ #
1485
+ # @overload get_accuracy_metrics(params = {})
1486
+ # @param [Hash] params ({})
1487
+ def get_accuracy_metrics(params = {}, options = {})
1488
+ req = build_request(:get_accuracy_metrics, params)
1489
+ req.send_request(options)
1490
+ end
1491
+
1492
+ # 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.
1497
+ #
1498
+ # @option params [String] :next_token
1499
+ # If the result of the previous request was truncated, the response
1500
+ # includes a `NextToken`. To retrieve the next set of results, use the
1501
+ # token in the next request. Tokens expire after 24 hours.
1502
+ #
1503
+ # @option params [Integer] :max_results
1504
+ # The number of items to return in the response.
1505
+ #
1506
+ # @return [Types::ListDatasetGroupsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1507
+ #
1508
+ # * {Types::ListDatasetGroupsResponse#dataset_groups #dataset_groups} => Array&lt;Types::DatasetGroupSummary&gt;
1509
+ # * {Types::ListDatasetGroupsResponse#next_token #next_token} => String
1510
+ #
1511
+ # @example Request syntax with placeholder values
1512
+ #
1513
+ # resp = client.list_dataset_groups({
1514
+ # next_token: "NextToken",
1515
+ # max_results: 1,
1516
+ # })
1517
+ #
1518
+ # @example Response structure
1519
+ #
1520
+ # resp.dataset_groups #=> Array
1521
+ # resp.dataset_groups[0].dataset_group_arn #=> String
1522
+ # resp.dataset_groups[0].dataset_group_name #=> String
1523
+ # resp.dataset_groups[0].creation_time #=> Time
1524
+ # resp.dataset_groups[0].last_modification_time #=> Time
1525
+ # resp.next_token #=> String
1526
+ #
1527
+ # @see http://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/ListDatasetGroups AWS API Documentation
1528
+ #
1529
+ # @overload list_dataset_groups(params = {})
1530
+ # @param [Hash] params ({})
1531
+ def list_dataset_groups(params = {}, options = {})
1532
+ req = build_request(:list_dataset_groups, params)
1533
+ req.send_request(options)
1534
+ end
1535
+
1536
+ # 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.
1542
+ #
1543
+ # @option params [String] :next_token
1544
+ # If the result of the previous request was truncated, the response
1545
+ # includes a `NextToken`. To retrieve the next set of results, use the
1546
+ # token in the next request. Tokens expire after 24 hours.
1547
+ #
1548
+ # @option params [Integer] :max_results
1549
+ # The number of items to return in the response.
1550
+ #
1551
+ # @option params [Array<Types::Filter>] :filters
1552
+ # An array of filters. For each filter, you provide a condition and a
1553
+ # 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.
1558
+ #
1559
+ # * `Condition` - `IS` or `IS_NOT`
1560
+ #
1561
+ # * `Key` - `Name`
1562
+ #
1563
+ # * `Value` - the value to match
1564
+ #
1565
+ # For example, to list all dataset import jobs named
1566
+ # *my\_dataset\_import\_job*, you would specify:
1567
+ #
1568
+ # `"Filters": [ \{ "Condition": "IS", "Key": "Name", "Value":
1569
+ # "my_dataset_import_job" \} ]`
1570
+ #
1571
+ # @return [Types::ListDatasetImportJobsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1572
+ #
1573
+ # * {Types::ListDatasetImportJobsResponse#dataset_import_jobs #dataset_import_jobs} => Array&lt;Types::DatasetImportJobSummary&gt;
1574
+ # * {Types::ListDatasetImportJobsResponse#next_token #next_token} => String
1575
+ #
1576
+ # @example Request syntax with placeholder values
1577
+ #
1578
+ # resp = client.list_dataset_import_jobs({
1579
+ # next_token: "NextToken",
1580
+ # max_results: 1,
1581
+ # filters: [
1582
+ # {
1583
+ # key: "String", # required
1584
+ # value: "Arn", # required
1585
+ # condition: "IS", # required, accepts IS, IS_NOT
1586
+ # },
1587
+ # ],
1588
+ # })
1589
+ #
1590
+ # @example Response structure
1591
+ #
1592
+ # resp.dataset_import_jobs #=> Array
1593
+ # resp.dataset_import_jobs[0].dataset_import_job_arn #=> String
1594
+ # resp.dataset_import_jobs[0].dataset_import_job_name #=> String
1595
+ # resp.dataset_import_jobs[0].data_source.s3_config.path #=> String
1596
+ # resp.dataset_import_jobs[0].data_source.s3_config.role_arn #=> String
1597
+ # resp.dataset_import_jobs[0].data_source.s3_config.kms_key_arn #=> String
1598
+ # resp.dataset_import_jobs[0].status #=> String
1599
+ # resp.dataset_import_jobs[0].message #=> String
1600
+ # resp.dataset_import_jobs[0].creation_time #=> Time
1601
+ # resp.dataset_import_jobs[0].last_modification_time #=> Time
1602
+ # resp.next_token #=> String
1603
+ #
1604
+ # @see http://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/ListDatasetImportJobs AWS API Documentation
1605
+ #
1606
+ # @overload list_dataset_import_jobs(params = {})
1607
+ # @param [Hash] params ({})
1608
+ def list_dataset_import_jobs(params = {}, options = {})
1609
+ req = build_request(:list_dataset_import_jobs, params)
1610
+ req.send_request(options)
1611
+ end
1612
+
1613
+ # Returns a list of datasets created using the CreateDataset operation.
1614
+ # 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.
1617
+ #
1618
+ # @option params [String] :next_token
1619
+ # If the result of the previous request was truncated, the response
1620
+ # includes a `NextToken`. To retrieve the next set of results, use the
1621
+ # token in the next request. Tokens expire after 24 hours.
1622
+ #
1623
+ # @option params [Integer] :max_results
1624
+ # The number of items to return in the response.
1625
+ #
1626
+ # @return [Types::ListDatasetsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1627
+ #
1628
+ # * {Types::ListDatasetsResponse#datasets #datasets} => Array&lt;Types::DatasetSummary&gt;
1629
+ # * {Types::ListDatasetsResponse#next_token #next_token} => String
1630
+ #
1631
+ # @example Request syntax with placeholder values
1632
+ #
1633
+ # resp = client.list_datasets({
1634
+ # next_token: "NextToken",
1635
+ # max_results: 1,
1636
+ # })
1637
+ #
1638
+ # @example Response structure
1639
+ #
1640
+ # resp.datasets #=> Array
1641
+ # resp.datasets[0].dataset_arn #=> String
1642
+ # resp.datasets[0].dataset_name #=> String
1643
+ # resp.datasets[0].dataset_type #=> String, one of "TARGET_TIME_SERIES", "RELATED_TIME_SERIES", "ITEM_METADATA"
1644
+ # resp.datasets[0].domain #=> String, one of "RETAIL", "CUSTOM", "INVENTORY_PLANNING", "EC2_CAPACITY", "WORK_FORCE", "WEB_TRAFFIC", "METRICS"
1645
+ # resp.datasets[0].creation_time #=> Time
1646
+ # resp.datasets[0].last_modification_time #=> Time
1647
+ # resp.next_token #=> String
1648
+ #
1649
+ # @see http://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/ListDatasets AWS API Documentation
1650
+ #
1651
+ # @overload list_datasets(params = {})
1652
+ # @param [Hash] params ({})
1653
+ def list_datasets(params = {}, options = {})
1654
+ req = build_request(:list_datasets, params)
1655
+ req.send_request(options)
1656
+ end
1657
+
1658
+ # 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.
1664
+ #
1665
+ # @option params [String] :next_token
1666
+ # If the result of the previous request was truncated, the response
1667
+ # includes a `NextToken`. To retrieve the next set of results, use the
1668
+ # token in the next request. Tokens expire after 24 hours.
1669
+ #
1670
+ # @option params [Integer] :max_results
1671
+ # The number of items to return in the response.
1672
+ #
1673
+ # @option params [Array<Types::Filter>] :filters
1674
+ # An array of filters. For each filter, you provide a condition and a
1675
+ # 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.
1680
+ #
1681
+ # * `Condition` - `IS` or `IS_NOT`
1682
+ #
1683
+ # * `Key` - `Name`
1684
+ #
1685
+ # * `Value` - the value to match
1686
+ #
1687
+ # For example, to list all forecast export jobs named
1688
+ # *my\_forecast\_export\_job*, you would specify:
1689
+ #
1690
+ # `"Filters": [ \{ "Condition": "IS", "Key": "Name", "Value":
1691
+ # "my_forecast_export_job" \} ]`
1692
+ #
1693
+ # @return [Types::ListForecastExportJobsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1694
+ #
1695
+ # * {Types::ListForecastExportJobsResponse#forecast_export_jobs #forecast_export_jobs} => Array&lt;Types::ForecastExportJobSummary&gt;
1696
+ # * {Types::ListForecastExportJobsResponse#next_token #next_token} => String
1697
+ #
1698
+ # @example Request syntax with placeholder values
1699
+ #
1700
+ # resp = client.list_forecast_export_jobs({
1701
+ # next_token: "NextToken",
1702
+ # max_results: 1,
1703
+ # filters: [
1704
+ # {
1705
+ # key: "String", # required
1706
+ # value: "Arn", # required
1707
+ # condition: "IS", # required, accepts IS, IS_NOT
1708
+ # },
1709
+ # ],
1710
+ # })
1711
+ #
1712
+ # @example Response structure
1713
+ #
1714
+ # resp.forecast_export_jobs #=> Array
1715
+ # resp.forecast_export_jobs[0].forecast_export_job_arn #=> String
1716
+ # resp.forecast_export_jobs[0].forecast_export_job_name #=> String
1717
+ # resp.forecast_export_jobs[0].destination.s3_config.path #=> String
1718
+ # resp.forecast_export_jobs[0].destination.s3_config.role_arn #=> String
1719
+ # resp.forecast_export_jobs[0].destination.s3_config.kms_key_arn #=> String
1720
+ # resp.forecast_export_jobs[0].status #=> String
1721
+ # resp.forecast_export_jobs[0].message #=> String
1722
+ # resp.forecast_export_jobs[0].creation_time #=> Time
1723
+ # resp.forecast_export_jobs[0].last_modification_time #=> Time
1724
+ # resp.next_token #=> String
1725
+ #
1726
+ # @see http://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/ListForecastExportJobs AWS API Documentation
1727
+ #
1728
+ # @overload list_forecast_export_jobs(params = {})
1729
+ # @param [Hash] params ({})
1730
+ def list_forecast_export_jobs(params = {}, options = {})
1731
+ req = build_request(:list_forecast_export_jobs, params)
1732
+ req.send_request(options)
1733
+ end
1734
+
1735
+ # 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.
1740
+ #
1741
+ # @option params [String] :next_token
1742
+ # If the result of the previous request was truncated, the response
1743
+ # includes a `NextToken`. To retrieve the next set of results, use the
1744
+ # token in the next request. Tokens expire after 24 hours.
1745
+ #
1746
+ # @option params [Integer] :max_results
1747
+ # The number of items to return in the response.
1748
+ #
1749
+ # @option params [Array<Types::Filter>] :filters
1750
+ # An array of filters. For each filter, you provide a condition and a
1751
+ # 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.
1756
+ #
1757
+ # * `Condition` - `IS` or `IS_NOT`
1758
+ #
1759
+ # * `Key` - `Name`
1760
+ #
1761
+ # * `Value` - the value to match
1762
+ #
1763
+ # For example, to list all forecasts named *my\_forecast*, you would
1764
+ # specify:
1765
+ #
1766
+ # `"Filters": [ \{ "Condition": "IS", "Key": "Name", "Value":
1767
+ # "my_forecast" \} ]`
1768
+ #
1769
+ # @return [Types::ListForecastsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1770
+ #
1771
+ # * {Types::ListForecastsResponse#forecasts #forecasts} => Array&lt;Types::ForecastSummary&gt;
1772
+ # * {Types::ListForecastsResponse#next_token #next_token} => String
1773
+ #
1774
+ # @example Request syntax with placeholder values
1775
+ #
1776
+ # resp = client.list_forecasts({
1777
+ # next_token: "NextToken",
1778
+ # max_results: 1,
1779
+ # filters: [
1780
+ # {
1781
+ # key: "String", # required
1782
+ # value: "Arn", # required
1783
+ # condition: "IS", # required, accepts IS, IS_NOT
1784
+ # },
1785
+ # ],
1786
+ # })
1787
+ #
1788
+ # @example Response structure
1789
+ #
1790
+ # resp.forecasts #=> Array
1791
+ # resp.forecasts[0].forecast_arn #=> String
1792
+ # resp.forecasts[0].forecast_name #=> String
1793
+ # resp.forecasts[0].predictor_arn #=> String
1794
+ # resp.forecasts[0].dataset_group_arn #=> String
1795
+ # resp.forecasts[0].status #=> String
1796
+ # resp.forecasts[0].message #=> String
1797
+ # resp.forecasts[0].creation_time #=> Time
1798
+ # resp.forecasts[0].last_modification_time #=> Time
1799
+ # resp.next_token #=> String
1800
+ #
1801
+ # @see http://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/ListForecasts AWS API Documentation
1802
+ #
1803
+ # @overload list_forecasts(params = {})
1804
+ # @param [Hash] params ({})
1805
+ def list_forecasts(params = {}, options = {})
1806
+ req = build_request(:list_forecasts, params)
1807
+ req.send_request(options)
1808
+ end
1809
+
1810
+ # 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.
1815
+ #
1816
+ # @option params [String] :next_token
1817
+ # If the result of the previous request was truncated, the response
1818
+ # includes a `NextToken`. To retrieve the next set of results, use the
1819
+ # token in the next request. Tokens expire after 24 hours.
1820
+ #
1821
+ # @option params [Integer] :max_results
1822
+ # The number of items to return in the response.
1823
+ #
1824
+ # @option params [Array<Types::Filter>] :filters
1825
+ # An array of filters. For each filter, you provide a condition and a
1826
+ # 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.
1831
+ #
1832
+ # * `Condition` - `IS` or `IS_NOT`
1833
+ #
1834
+ # * `Key` - `Name`
1835
+ #
1836
+ # * `Value` - the value to match
1837
+ #
1838
+ # For example, to list all predictors named *my\_predictor*, you would
1839
+ # specify:
1840
+ #
1841
+ # `"Filters": [ \{ "Condition": "IS", "Key": "Name", "Value":
1842
+ # "my_predictor" \} ]`
1843
+ #
1844
+ # @return [Types::ListPredictorsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1845
+ #
1846
+ # * {Types::ListPredictorsResponse#predictors #predictors} => Array&lt;Types::PredictorSummary&gt;
1847
+ # * {Types::ListPredictorsResponse#next_token #next_token} => String
1848
+ #
1849
+ # @example Request syntax with placeholder values
1850
+ #
1851
+ # resp = client.list_predictors({
1852
+ # next_token: "NextToken",
1853
+ # max_results: 1,
1854
+ # filters: [
1855
+ # {
1856
+ # key: "String", # required
1857
+ # value: "Arn", # required
1858
+ # condition: "IS", # required, accepts IS, IS_NOT
1859
+ # },
1860
+ # ],
1861
+ # })
1862
+ #
1863
+ # @example Response structure
1864
+ #
1865
+ # resp.predictors #=> Array
1866
+ # resp.predictors[0].predictor_arn #=> String
1867
+ # resp.predictors[0].predictor_name #=> String
1868
+ # resp.predictors[0].dataset_group_arn #=> String
1869
+ # resp.predictors[0].status #=> String
1870
+ # resp.predictors[0].message #=> String
1871
+ # resp.predictors[0].creation_time #=> Time
1872
+ # resp.predictors[0].last_modification_time #=> Time
1873
+ # resp.next_token #=> String
1874
+ #
1875
+ # @see http://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/ListPredictors AWS API Documentation
1876
+ #
1877
+ # @overload list_predictors(params = {})
1878
+ # @param [Hash] params ({})
1879
+ def list_predictors(params = {}, options = {})
1880
+ req = build_request(:list_predictors, params)
1881
+ req.send_request(options)
1882
+ end
1883
+
1884
+ # Replaces any existing datasets in the dataset group with the specified
1885
+ # datasets.
1886
+ #
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
1889
+ # operation to get the status.
1890
+ #
1891
+ # </note>
1892
+ #
1893
+ # @option params [required, String] :dataset_group_arn
1894
+ # The ARN of the dataset group.
1895
+ #
1896
+ # @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.
1899
+ #
1900
+ # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
1901
+ #
1902
+ # @example Request syntax with placeholder values
1903
+ #
1904
+ # resp = client.update_dataset_group({
1905
+ # dataset_group_arn: "Arn", # required
1906
+ # dataset_arns: ["Arn"], # required
1907
+ # })
1908
+ #
1909
+ # @see http://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/UpdateDatasetGroup AWS API Documentation
1910
+ #
1911
+ # @overload update_dataset_group(params = {})
1912
+ # @param [Hash] params ({})
1913
+ def update_dataset_group(params = {}, options = {})
1914
+ req = build_request(:update_dataset_group, params)
1915
+ req.send_request(options)
1916
+ end
1917
+
1918
+ # @!endgroup
1919
+
1920
+ # @param params ({})
1921
+ # @api private
1922
+ def build_request(operation_name, params = {})
1923
+ handlers = @handlers.for(operation_name)
1924
+ context = Seahorse::Client::RequestContext.new(
1925
+ operation_name: operation_name,
1926
+ operation: config.api.operation(operation_name),
1927
+ client: self,
1928
+ params: params,
1929
+ config: config)
1930
+ context[:gem_name] = 'aws-sdk-forecastservice'
1931
+ context[:gem_version] = '1.0.0'
1932
+ Seahorse::Client::Request.new(handlers, context)
1933
+ end
1934
+
1935
+ # @api private
1936
+ # @deprecated
1937
+ def waiter_names
1938
+ []
1939
+ end
1940
+
1941
+ class << self
1942
+
1943
+ # @api private
1944
+ attr_reader :identifier
1945
+
1946
+ # @api private
1947
+ def errors_module
1948
+ Errors
1949
+ end
1950
+
1951
+ end
1952
+ end
1953
+ end