aws-sdk-forecastservice 1.3.0 → 1.8.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +5 -5
- data/lib/aws-sdk-forecastservice.rb +3 -1
- data/lib/aws-sdk-forecastservice/client.rb +420 -34
- data/lib/aws-sdk-forecastservice/client_api.rb +76 -0
- data/lib/aws-sdk-forecastservice/errors.rb +2 -0
- data/lib/aws-sdk-forecastservice/resource.rb +3 -7
- data/lib/aws-sdk-forecastservice/types.rb +645 -32
- metadata +5 -5
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
|
-
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
2
|
+
SHA256:
|
3
|
+
metadata.gz: 7188b2b8177c8ff008876502d1cbb3be0d79c77877399db5b926aba1ee98e897
|
4
|
+
data.tar.gz: a9ce7f2ff4bd6e8ede3b693077bdeeb8a56fe406987d588678c2d99d249a1844
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 17ec0ab1db54e390b77d9b8691f2e5bcea17974609021b1d9c432a53a3f6e1c2bf1c5b138f37ebbe27d1ed830a4981ab851c7e4b03a988680769bb2df66f181e
|
7
|
+
data.tar.gz: 80f82e9c01392cdc5f543fae6023269122210d373447d744f9ecd0447a42e24feaaf355b528d1273c9fdcc5e3d7b970a4a5260fefa640cc46e985f8a33711d56
|
@@ -1,3 +1,5 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
1
3
|
# WARNING ABOUT GENERATED CODE
|
2
4
|
#
|
3
5
|
# This file is generated. See the contributing guide for more information:
|
@@ -45,6 +47,6 @@ require_relative 'aws-sdk-forecastservice/customizations'
|
|
45
47
|
# @service
|
46
48
|
module Aws::ForecastService
|
47
49
|
|
48
|
-
GEM_VERSION = '1.
|
50
|
+
GEM_VERSION = '1.8.0'
|
49
51
|
|
50
52
|
end
|
@@ -1,3 +1,5 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
1
3
|
# WARNING ABOUT GENERATED CODE
|
2
4
|
#
|
3
5
|
# This file is generated. See the contributing guide for more information:
|
@@ -24,6 +26,7 @@ require 'aws-sdk-core/plugins/jsonvalue_converter.rb'
|
|
24
26
|
require 'aws-sdk-core/plugins/client_metrics_plugin.rb'
|
25
27
|
require 'aws-sdk-core/plugins/client_metrics_send_plugin.rb'
|
26
28
|
require 'aws-sdk-core/plugins/transfer_encoding.rb'
|
29
|
+
require 'aws-sdk-core/plugins/http_checksum.rb'
|
27
30
|
require 'aws-sdk-core/plugins/signature_v4.rb'
|
28
31
|
require 'aws-sdk-core/plugins/protocols/json_rpc.rb'
|
29
32
|
|
@@ -32,11 +35,11 @@ Aws::Plugins::GlobalConfiguration.add_identifier(:forecastservice)
|
|
32
35
|
module Aws::ForecastService
|
33
36
|
# An API client for ForecastService. To construct a client, you need to configure a `:region` and `:credentials`.
|
34
37
|
#
|
35
|
-
#
|
36
|
-
#
|
37
|
-
#
|
38
|
-
#
|
39
|
-
#
|
38
|
+
# client = Aws::ForecastService::Client.new(
|
39
|
+
# region: region_name,
|
40
|
+
# credentials: credentials,
|
41
|
+
# # ...
|
42
|
+
# )
|
40
43
|
#
|
41
44
|
# For details on configuring region and credentials see
|
42
45
|
# the [developer guide](/sdk-for-ruby/v3/developer-guide/setup-config.html).
|
@@ -69,6 +72,7 @@ module Aws::ForecastService
|
|
69
72
|
add_plugin(Aws::Plugins::ClientMetricsPlugin)
|
70
73
|
add_plugin(Aws::Plugins::ClientMetricsSendPlugin)
|
71
74
|
add_plugin(Aws::Plugins::TransferEncoding)
|
75
|
+
add_plugin(Aws::Plugins::HttpChecksum)
|
72
76
|
add_plugin(Aws::Plugins::SignatureV4)
|
73
77
|
add_plugin(Aws::Plugins::Protocols::JsonRpc)
|
74
78
|
|
@@ -105,7 +109,7 @@ module Aws::ForecastService
|
|
105
109
|
# @option options [required, String] :region
|
106
110
|
# The AWS region to connect to. The configured `:region` is
|
107
111
|
# used to determine the service `:endpoint`. When not passed,
|
108
|
-
# a default `:region` is
|
112
|
+
# a default `:region` is searched for in the following locations:
|
109
113
|
#
|
110
114
|
# * `Aws.config[:region]`
|
111
115
|
# * `ENV['AWS_REGION']`
|
@@ -161,7 +165,7 @@ module Aws::ForecastService
|
|
161
165
|
# @option options [String] :endpoint
|
162
166
|
# The client endpoint is normally constructed from the `:region`
|
163
167
|
# option. You should only configure an `:endpoint` when connecting
|
164
|
-
# to test endpoints. This should be
|
168
|
+
# to test or custom endpoints. This should be a valid HTTP(S) URI.
|
165
169
|
#
|
166
170
|
# @option options [Integer] :endpoint_cache_max_entries (1000)
|
167
171
|
# Used for the maximum size limit of the LRU cache storing endpoints data
|
@@ -176,7 +180,7 @@ module Aws::ForecastService
|
|
176
180
|
# requests fetching endpoints information. Defaults to 60 sec.
|
177
181
|
#
|
178
182
|
# @option options [Boolean] :endpoint_discovery (false)
|
179
|
-
# When set to `true`, endpoint discovery will be enabled for operations when available.
|
183
|
+
# When set to `true`, endpoint discovery will be enabled for operations when available.
|
180
184
|
#
|
181
185
|
# @option options [Aws::Log::Formatter] :log_formatter (Aws::Log::Formatter.default)
|
182
186
|
# The log formatter.
|
@@ -229,15 +233,19 @@ module Aws::ForecastService
|
|
229
233
|
#
|
230
234
|
# @option options [String] :retry_mode ("legacy")
|
231
235
|
# Specifies which retry algorithm to use. Values are:
|
232
|
-
#
|
233
|
-
#
|
234
|
-
#
|
235
|
-
#
|
236
|
-
#
|
237
|
-
#
|
238
|
-
#
|
239
|
-
#
|
240
|
-
#
|
236
|
+
#
|
237
|
+
# * `legacy` - The pre-existing retry behavior. This is default value if
|
238
|
+
# no retry mode is provided.
|
239
|
+
#
|
240
|
+
# * `standard` - A standardized set of retry rules across the AWS SDKs.
|
241
|
+
# This includes support for retry quotas, which limit the number of
|
242
|
+
# unsuccessful retries a client can make.
|
243
|
+
#
|
244
|
+
# * `adaptive` - An experimental retry mode that includes all the
|
245
|
+
# functionality of `standard` mode along with automatic client side
|
246
|
+
# throttling. This is a provisional mode that may change behavior
|
247
|
+
# in the future.
|
248
|
+
#
|
241
249
|
#
|
242
250
|
# @option options [String] :secret_access_key
|
243
251
|
#
|
@@ -275,8 +283,7 @@ module Aws::ForecastService
|
|
275
283
|
#
|
276
284
|
# @option options [Integer] :http_read_timeout (60) The default
|
277
285
|
# number of seconds to wait for response data. This value can
|
278
|
-
# safely be set
|
279
|
-
# per-request on the session yielded by {#session_for}.
|
286
|
+
# safely be set per-request on the session.
|
280
287
|
#
|
281
288
|
# @option options [Float] :http_idle_timeout (5) The number of
|
282
289
|
# seconds a connection is allowed to sit idle before it is
|
@@ -288,7 +295,7 @@ module Aws::ForecastService
|
|
288
295
|
# request body. This option has no effect unless the request has
|
289
296
|
# "Expect" header set to "100-continue". Defaults to `nil` which
|
290
297
|
# disables this behaviour. This value can safely be set per
|
291
|
-
# request on the session
|
298
|
+
# request on the session.
|
292
299
|
#
|
293
300
|
# @option options [Boolean] :http_wire_trace (false) When `true`,
|
294
301
|
# HTTP debug output will be sent to the `:logger`.
|
@@ -349,7 +356,7 @@ module Aws::ForecastService
|
|
349
356
|
#
|
350
357
|
#
|
351
358
|
#
|
352
|
-
# [1]: https://github.com/aws-samples/amazon-forecast-samples
|
359
|
+
# [1]: https://github.com/aws-samples/amazon-forecast-samples
|
353
360
|
#
|
354
361
|
# @option params [required, String] :dataset_name
|
355
362
|
# A name for the dataset.
|
@@ -390,6 +397,38 @@ module Aws::ForecastService
|
|
390
397
|
# Access Management (IAM) role that Amazon Forecast can assume to access
|
391
398
|
# the key.
|
392
399
|
#
|
400
|
+
# @option params [Array<Types::Tag>] :tags
|
401
|
+
# The optional metadata that you apply to the dataset to help you
|
402
|
+
# categorize and organize them. Each tag consists of a key and an
|
403
|
+
# optional value, both of which you define.
|
404
|
+
#
|
405
|
+
# The following basic restrictions apply to tags:
|
406
|
+
#
|
407
|
+
# * Maximum number of tags per resource - 50.
|
408
|
+
#
|
409
|
+
# * For each resource, each tag key must be unique, and each tag key can
|
410
|
+
# have only one value.
|
411
|
+
#
|
412
|
+
# * Maximum key length - 128 Unicode characters in UTF-8.
|
413
|
+
#
|
414
|
+
# * Maximum value length - 256 Unicode characters in UTF-8.
|
415
|
+
#
|
416
|
+
# * If your tagging schema is used across multiple services and
|
417
|
+
# resources, remember that other services may have restrictions on
|
418
|
+
# allowed characters. Generally allowed characters are: letters,
|
419
|
+
# numbers, and spaces representable in UTF-8, and the following
|
420
|
+
# characters: + - = . \_ : / @.
|
421
|
+
#
|
422
|
+
# * Tag keys and values are case sensitive.
|
423
|
+
#
|
424
|
+
# * Do not use `aws:`, `AWS:`, or any upper or lowercase combination of
|
425
|
+
# such as a prefix for keys as it is reserved for AWS use. You cannot
|
426
|
+
# edit or delete tag keys with this prefix. Values can have this
|
427
|
+
# prefix. If a tag value has `aws` as its prefix but the key does not,
|
428
|
+
# then Forecast considers it to be a user tag and will count against
|
429
|
+
# the limit of 50 tags. Tags with only the key prefix of `aws` do not
|
430
|
+
# count against your tags per resource limit.
|
431
|
+
#
|
393
432
|
# @return [Types::CreateDatasetResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
394
433
|
#
|
395
434
|
# * {Types::CreateDatasetResponse#dataset_arn #dataset_arn} => String
|
@@ -413,6 +452,12 @@ module Aws::ForecastService
|
|
413
452
|
# role_arn: "Arn", # required
|
414
453
|
# kms_key_arn: "KMSKeyArn", # required
|
415
454
|
# },
|
455
|
+
# tags: [
|
456
|
+
# {
|
457
|
+
# key: "TagKey", # required
|
458
|
+
# value: "TagValue", # required
|
459
|
+
# },
|
460
|
+
# ],
|
416
461
|
# })
|
417
462
|
#
|
418
463
|
# @example Response structure
|
@@ -464,6 +509,38 @@ module Aws::ForecastService
|
|
464
509
|
# An array of Amazon Resource Names (ARNs) of the datasets that you want
|
465
510
|
# to include in the dataset group.
|
466
511
|
#
|
512
|
+
# @option params [Array<Types::Tag>] :tags
|
513
|
+
# The optional metadata that you apply to the dataset group to help you
|
514
|
+
# categorize and organize them. Each tag consists of a key and an
|
515
|
+
# optional value, both of which you define.
|
516
|
+
#
|
517
|
+
# The following basic restrictions apply to tags:
|
518
|
+
#
|
519
|
+
# * Maximum number of tags per resource - 50.
|
520
|
+
#
|
521
|
+
# * For each resource, each tag key must be unique, and each tag key can
|
522
|
+
# have only one value.
|
523
|
+
#
|
524
|
+
# * Maximum key length - 128 Unicode characters in UTF-8.
|
525
|
+
#
|
526
|
+
# * Maximum value length - 256 Unicode characters in UTF-8.
|
527
|
+
#
|
528
|
+
# * If your tagging schema is used across multiple services and
|
529
|
+
# resources, remember that other services may have restrictions on
|
530
|
+
# allowed characters. Generally allowed characters are: letters,
|
531
|
+
# numbers, and spaces representable in UTF-8, and the following
|
532
|
+
# characters: + - = . \_ : / @.
|
533
|
+
#
|
534
|
+
# * Tag keys and values are case sensitive.
|
535
|
+
#
|
536
|
+
# * Do not use `aws:`, `AWS:`, or any upper or lowercase combination of
|
537
|
+
# such as a prefix for keys as it is reserved for AWS use. You cannot
|
538
|
+
# edit or delete tag keys with this prefix. Values can have this
|
539
|
+
# prefix. If a tag value has `aws` as its prefix but the key does not,
|
540
|
+
# then Forecast considers it to be a user tag and will count against
|
541
|
+
# the limit of 50 tags. Tags with only the key prefix of `aws` do not
|
542
|
+
# count against your tags per resource limit.
|
543
|
+
#
|
467
544
|
# @return [Types::CreateDatasetGroupResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
468
545
|
#
|
469
546
|
# * {Types::CreateDatasetGroupResponse#dataset_group_arn #dataset_group_arn} => String
|
@@ -474,6 +551,12 @@ module Aws::ForecastService
|
|
474
551
|
# dataset_group_name: "Name", # required
|
475
552
|
# domain: "RETAIL", # required, accepts RETAIL, CUSTOM, INVENTORY_PLANNING, EC2_CAPACITY, WORK_FORCE, WEB_TRAFFIC, METRICS
|
476
553
|
# dataset_arns: ["Arn"],
|
554
|
+
# tags: [
|
555
|
+
# {
|
556
|
+
# key: "TagKey", # required
|
557
|
+
# value: "TagValue", # required
|
558
|
+
# },
|
559
|
+
# ],
|
477
560
|
# })
|
478
561
|
#
|
479
562
|
# @example Response structure
|
@@ -496,7 +579,9 @@ module Aws::ForecastService
|
|
496
579
|
#
|
497
580
|
# You must specify a DataSource object that includes an AWS Identity and
|
498
581
|
# Access Management (IAM) role that Amazon Forecast can assume to access
|
499
|
-
# the data
|
582
|
+
# the data, as Amazon Forecast makes a copy of your data and processes
|
583
|
+
# it in an internal AWS system. For more information, see
|
584
|
+
# aws-forecast-iam-roles.
|
500
585
|
#
|
501
586
|
# The training data must be in CSV format. The delimiter must be a comma
|
502
587
|
# (,).
|
@@ -505,6 +590,12 @@ module Aws::ForecastService
|
|
505
590
|
# a folder in the S3 bucket. For the latter two cases, Amazon Forecast
|
506
591
|
# imports all files up to the limit of 10,000 files.
|
507
592
|
#
|
593
|
+
# Because dataset imports are not aggregated, your most recent dataset
|
594
|
+
# import is the one that is used when training a predictor or generating
|
595
|
+
# a forecast. Make sure that your most recent dataset import contains
|
596
|
+
# all of the data you want to model off of, and not just the new data
|
597
|
+
# collected since the previous import.
|
598
|
+
#
|
508
599
|
# To get a list of all your dataset import jobs, filtered by specified
|
509
600
|
# criteria, use the ListDatasetImportJobs operation.
|
510
601
|
#
|
@@ -546,6 +637,38 @@ module Aws::ForecastService
|
|
546
637
|
# If the format isn't specified, Amazon Forecast expects the format to
|
547
638
|
# be "yyyy-MM-dd HH:mm:ss".
|
548
639
|
#
|
640
|
+
# @option params [Array<Types::Tag>] :tags
|
641
|
+
# The optional metadata that you apply to the dataset import job to help
|
642
|
+
# you categorize and organize them. Each tag consists of a key and an
|
643
|
+
# optional value, both of which you define.
|
644
|
+
#
|
645
|
+
# The following basic restrictions apply to tags:
|
646
|
+
#
|
647
|
+
# * Maximum number of tags per resource - 50.
|
648
|
+
#
|
649
|
+
# * For each resource, each tag key must be unique, and each tag key can
|
650
|
+
# have only one value.
|
651
|
+
#
|
652
|
+
# * Maximum key length - 128 Unicode characters in UTF-8.
|
653
|
+
#
|
654
|
+
# * Maximum value length - 256 Unicode characters in UTF-8.
|
655
|
+
#
|
656
|
+
# * If your tagging schema is used across multiple services and
|
657
|
+
# resources, remember that other services may have restrictions on
|
658
|
+
# allowed characters. Generally allowed characters are: letters,
|
659
|
+
# numbers, and spaces representable in UTF-8, and the following
|
660
|
+
# characters: + - = . \_ : / @.
|
661
|
+
#
|
662
|
+
# * Tag keys and values are case sensitive.
|
663
|
+
#
|
664
|
+
# * Do not use `aws:`, `AWS:`, or any upper or lowercase combination of
|
665
|
+
# such as a prefix for keys as it is reserved for AWS use. You cannot
|
666
|
+
# edit or delete tag keys with this prefix. Values can have this
|
667
|
+
# prefix. If a tag value has `aws` as its prefix but the key does not,
|
668
|
+
# then Forecast considers it to be a user tag and will count against
|
669
|
+
# the limit of 50 tags. Tags with only the key prefix of `aws` do not
|
670
|
+
# count against your tags per resource limit.
|
671
|
+
#
|
549
672
|
# @return [Types::CreateDatasetImportJobResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
550
673
|
#
|
551
674
|
# * {Types::CreateDatasetImportJobResponse#dataset_import_job_arn #dataset_import_job_arn} => String
|
@@ -563,6 +686,12 @@ module Aws::ForecastService
|
|
563
686
|
# },
|
564
687
|
# },
|
565
688
|
# timestamp_format: "TimestampFormat",
|
689
|
+
# tags: [
|
690
|
+
# {
|
691
|
+
# key: "TagKey", # required
|
692
|
+
# value: "TagValue", # required
|
693
|
+
# },
|
694
|
+
# ],
|
566
695
|
# })
|
567
696
|
#
|
568
697
|
# @example Response structure
|
@@ -586,10 +715,9 @@ module Aws::ForecastService
|
|
586
715
|
# operation.
|
587
716
|
#
|
588
717
|
# The range of the forecast is determined by the `ForecastHorizon`
|
589
|
-
# value, which you specify in the CreatePredictor request
|
590
|
-
#
|
591
|
-
#
|
592
|
-
# range within the forecast.
|
718
|
+
# value, which you specify in the CreatePredictor request. When you
|
719
|
+
# query a forecast, you can request a specific date range within the
|
720
|
+
# forecast.
|
593
721
|
#
|
594
722
|
# To get a list of all your forecasts, use the ListForecasts operation.
|
595
723
|
#
|
@@ -614,12 +742,44 @@ module Aws::ForecastService
|
|
614
742
|
# forecast.
|
615
743
|
#
|
616
744
|
# @option params [Array<String>] :forecast_types
|
617
|
-
# The quantiles at which probabilistic forecasts are generated. You
|
618
|
-
# specify up to 5 quantiles per forecast
|
619
|
-
# to 0.99` (increments of .01 only) and `mean`. The
|
620
|
-
# different from the median (0.50) when the
|
621
|
-
# symmetric (
|
622
|
-
# `["0.1", "0.5", "0.9"]`.
|
745
|
+
# The quantiles at which probabilistic forecasts are generated. **You
|
746
|
+
# can currently specify up to 5 quantiles per forecast**. Accepted
|
747
|
+
# values include `0.01 to 0.99` (increments of .01 only) and `mean`. The
|
748
|
+
# mean forecast is different from the median (0.50) when the
|
749
|
+
# distribution is not symmetric (for example, Beta and Negative
|
750
|
+
# Binomial). The default value is `["0.1", "0.5", "0.9"]`.
|
751
|
+
#
|
752
|
+
# @option params [Array<Types::Tag>] :tags
|
753
|
+
# The optional metadata that you apply to the forecast to help you
|
754
|
+
# categorize and organize them. Each tag consists of a key and an
|
755
|
+
# optional value, both of which you define.
|
756
|
+
#
|
757
|
+
# The following basic restrictions apply to tags:
|
758
|
+
#
|
759
|
+
# * Maximum number of tags per resource - 50.
|
760
|
+
#
|
761
|
+
# * For each resource, each tag key must be unique, and each tag key can
|
762
|
+
# have only one value.
|
763
|
+
#
|
764
|
+
# * Maximum key length - 128 Unicode characters in UTF-8.
|
765
|
+
#
|
766
|
+
# * Maximum value length - 256 Unicode characters in UTF-8.
|
767
|
+
#
|
768
|
+
# * If your tagging schema is used across multiple services and
|
769
|
+
# resources, remember that other services may have restrictions on
|
770
|
+
# allowed characters. Generally allowed characters are: letters,
|
771
|
+
# numbers, and spaces representable in UTF-8, and the following
|
772
|
+
# characters: + - = . \_ : / @.
|
773
|
+
#
|
774
|
+
# * Tag keys and values are case sensitive.
|
775
|
+
#
|
776
|
+
# * Do not use `aws:`, `AWS:`, or any upper or lowercase combination of
|
777
|
+
# such as a prefix for keys as it is reserved for AWS use. You cannot
|
778
|
+
# edit or delete tag keys with this prefix. Values can have this
|
779
|
+
# prefix. If a tag value has `aws` as its prefix but the key does not,
|
780
|
+
# then Forecast considers it to be a user tag and will count against
|
781
|
+
# the limit of 50 tags. Tags with only the key prefix of `aws` do not
|
782
|
+
# count against your tags per resource limit.
|
623
783
|
#
|
624
784
|
# @return [Types::CreateForecastResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
625
785
|
#
|
@@ -631,6 +791,12 @@ module Aws::ForecastService
|
|
631
791
|
# forecast_name: "Name", # required
|
632
792
|
# predictor_arn: "Arn", # required
|
633
793
|
# forecast_types: ["ForecastType"],
|
794
|
+
# tags: [
|
795
|
+
# {
|
796
|
+
# key: "TagKey", # required
|
797
|
+
# value: "TagValue", # required
|
798
|
+
# },
|
799
|
+
# ],
|
634
800
|
# })
|
635
801
|
#
|
636
802
|
# @example Response structure
|
@@ -650,7 +816,7 @@ module Aws::ForecastService
|
|
650
816
|
# Amazon Simple Storage Service (Amazon S3) bucket. The forecast file
|
651
817
|
# name will match the following conventions:
|
652
818
|
#
|
653
|
-
# <ForecastExportJobName>\_<ExportTimestamp>\_<
|
819
|
+
# <ForecastExportJobName>\_<ExportTimestamp>\_<PartNumber>
|
654
820
|
#
|
655
821
|
# where the <ExportTimestamp> component is in Java
|
656
822
|
# SimpleDateFormat (yyyy-MM-ddTHH-mm-ssZ).
|
@@ -688,6 +854,38 @@ module Aws::ForecastService
|
|
688
854
|
# Management Service (KMS) key. The IAM role must allow Amazon Forecast
|
689
855
|
# permission to access the key.
|
690
856
|
#
|
857
|
+
# @option params [Array<Types::Tag>] :tags
|
858
|
+
# The optional metadata that you apply to the forecast export job to
|
859
|
+
# help you categorize and organize them. Each tag consists of a key and
|
860
|
+
# an optional value, both of which you define.
|
861
|
+
#
|
862
|
+
# The following basic restrictions apply to tags:
|
863
|
+
#
|
864
|
+
# * Maximum number of tags per resource - 50.
|
865
|
+
#
|
866
|
+
# * For each resource, each tag key must be unique, and each tag key can
|
867
|
+
# have only one value.
|
868
|
+
#
|
869
|
+
# * Maximum key length - 128 Unicode characters in UTF-8.
|
870
|
+
#
|
871
|
+
# * Maximum value length - 256 Unicode characters in UTF-8.
|
872
|
+
#
|
873
|
+
# * If your tagging schema is used across multiple services and
|
874
|
+
# resources, remember that other services may have restrictions on
|
875
|
+
# allowed characters. Generally allowed characters are: letters,
|
876
|
+
# numbers, and spaces representable in UTF-8, and the following
|
877
|
+
# characters: + - = . \_ : / @.
|
878
|
+
#
|
879
|
+
# * Tag keys and values are case sensitive.
|
880
|
+
#
|
881
|
+
# * Do not use `aws:`, `AWS:`, or any upper or lowercase combination of
|
882
|
+
# such as a prefix for keys as it is reserved for AWS use. You cannot
|
883
|
+
# edit or delete tag keys with this prefix. Values can have this
|
884
|
+
# prefix. If a tag value has `aws` as its prefix but the key does not,
|
885
|
+
# then Forecast considers it to be a user tag and will count against
|
886
|
+
# the limit of 50 tags. Tags with only the key prefix of `aws` do not
|
887
|
+
# count against your tags per resource limit.
|
888
|
+
#
|
691
889
|
# @return [Types::CreateForecastExportJobResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
692
890
|
#
|
693
891
|
# * {Types::CreateForecastExportJobResponse#forecast_export_job_arn #forecast_export_job_arn} => String
|
@@ -704,6 +902,12 @@ module Aws::ForecastService
|
|
704
902
|
# kms_key_arn: "KMSKeyArn",
|
705
903
|
# },
|
706
904
|
# },
|
905
|
+
# tags: [
|
906
|
+
# {
|
907
|
+
# key: "TagKey", # required
|
908
|
+
# value: "TagValue", # required
|
909
|
+
# },
|
910
|
+
# ],
|
707
911
|
# })
|
708
912
|
#
|
709
913
|
# @example Response structure
|
@@ -873,6 +1077,38 @@ module Aws::ForecastService
|
|
873
1077
|
# Access Management (IAM) role that Amazon Forecast can assume to access
|
874
1078
|
# the key.
|
875
1079
|
#
|
1080
|
+
# @option params [Array<Types::Tag>] :tags
|
1081
|
+
# The optional metadata that you apply to the predictor to help you
|
1082
|
+
# categorize and organize them. Each tag consists of a key and an
|
1083
|
+
# optional value, both of which you define.
|
1084
|
+
#
|
1085
|
+
# The following basic restrictions apply to tags:
|
1086
|
+
#
|
1087
|
+
# * Maximum number of tags per resource - 50.
|
1088
|
+
#
|
1089
|
+
# * For each resource, each tag key must be unique, and each tag key can
|
1090
|
+
# have only one value.
|
1091
|
+
#
|
1092
|
+
# * Maximum key length - 128 Unicode characters in UTF-8.
|
1093
|
+
#
|
1094
|
+
# * Maximum value length - 256 Unicode characters in UTF-8.
|
1095
|
+
#
|
1096
|
+
# * If your tagging schema is used across multiple services and
|
1097
|
+
# resources, remember that other services may have restrictions on
|
1098
|
+
# allowed characters. Generally allowed characters are: letters,
|
1099
|
+
# numbers, and spaces representable in UTF-8, and the following
|
1100
|
+
# characters: + - = . \_ : / @.
|
1101
|
+
#
|
1102
|
+
# * Tag keys and values are case sensitive.
|
1103
|
+
#
|
1104
|
+
# * Do not use `aws:`, `AWS:`, or any upper or lowercase combination of
|
1105
|
+
# such as a prefix for keys as it is reserved for AWS use. You cannot
|
1106
|
+
# edit or delete tag keys with this prefix. Values can have this
|
1107
|
+
# prefix. If a tag value has `aws` as its prefix but the key does not,
|
1108
|
+
# then Forecast considers it to be a user tag and will count against
|
1109
|
+
# the limit of 50 tags. Tags with only the key prefix of `aws` do not
|
1110
|
+
# count against your tags per resource limit.
|
1111
|
+
#
|
876
1112
|
# @return [Types::CreatePredictorResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
877
1113
|
#
|
878
1114
|
# * {Types::CreatePredictorResponse#predictor_arn #predictor_arn} => String
|
@@ -948,6 +1184,12 @@ module Aws::ForecastService
|
|
948
1184
|
# role_arn: "Arn", # required
|
949
1185
|
# kms_key_arn: "KMSKeyArn", # required
|
950
1186
|
# },
|
1187
|
+
# tags: [
|
1188
|
+
# {
|
1189
|
+
# key: "TagKey", # required
|
1190
|
+
# value: "TagValue", # required
|
1191
|
+
# },
|
1192
|
+
# ],
|
951
1193
|
# })
|
952
1194
|
#
|
953
1195
|
# @example Response structure
|
@@ -968,6 +1210,12 @@ module Aws::ForecastService
|
|
968
1210
|
# status of `ACTIVE` or `CREATE_FAILED`. To get the status use the
|
969
1211
|
# DescribeDataset operation.
|
970
1212
|
#
|
1213
|
+
# <note markdown="1"> Forecast does not automatically update any dataset groups that contain
|
1214
|
+
# the deleted dataset. In order to update the dataset group, use the
|
1215
|
+
# operation, omitting the deleted dataset's ARN.
|
1216
|
+
#
|
1217
|
+
# </note>
|
1218
|
+
#
|
971
1219
|
# @option params [required, String] :dataset_arn
|
972
1220
|
# The Amazon Resource Name (ARN) of the dataset to delete.
|
973
1221
|
#
|
@@ -1620,6 +1868,8 @@ module Aws::ForecastService
|
|
1620
1868
|
# * {Types::ListDatasetGroupsResponse#dataset_groups #dataset_groups} => Array<Types::DatasetGroupSummary>
|
1621
1869
|
# * {Types::ListDatasetGroupsResponse#next_token #next_token} => String
|
1622
1870
|
#
|
1871
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
1872
|
+
#
|
1623
1873
|
# @example Request syntax with placeholder values
|
1624
1874
|
#
|
1625
1875
|
# resp = client.list_dataset_groups({
|
@@ -1689,6 +1939,8 @@ module Aws::ForecastService
|
|
1689
1939
|
# * {Types::ListDatasetImportJobsResponse#dataset_import_jobs #dataset_import_jobs} => Array<Types::DatasetImportJobSummary>
|
1690
1940
|
# * {Types::ListDatasetImportJobsResponse#next_token #next_token} => String
|
1691
1941
|
#
|
1942
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
1943
|
+
#
|
1692
1944
|
# @example Request syntax with placeholder values
|
1693
1945
|
#
|
1694
1946
|
# resp = client.list_dataset_import_jobs({
|
@@ -1744,6 +1996,8 @@ module Aws::ForecastService
|
|
1744
1996
|
# * {Types::ListDatasetsResponse#datasets #datasets} => Array<Types::DatasetSummary>
|
1745
1997
|
# * {Types::ListDatasetsResponse#next_token #next_token} => String
|
1746
1998
|
#
|
1999
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
2000
|
+
#
|
1747
2001
|
# @example Request syntax with placeholder values
|
1748
2002
|
#
|
1749
2003
|
# resp = client.list_datasets({
|
@@ -1817,6 +2071,8 @@ module Aws::ForecastService
|
|
1817
2071
|
# * {Types::ListForecastExportJobsResponse#forecast_export_jobs #forecast_export_jobs} => Array<Types::ForecastExportJobSummary>
|
1818
2072
|
# * {Types::ListForecastExportJobsResponse#next_token #next_token} => String
|
1819
2073
|
#
|
2074
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
2075
|
+
#
|
1820
2076
|
# @example Request syntax with placeholder values
|
1821
2077
|
#
|
1822
2078
|
# resp = client.list_forecast_export_jobs({
|
@@ -1897,6 +2153,8 @@ module Aws::ForecastService
|
|
1897
2153
|
# * {Types::ListForecastsResponse#forecasts #forecasts} => Array<Types::ForecastSummary>
|
1898
2154
|
# * {Types::ListForecastsResponse#next_token #next_token} => String
|
1899
2155
|
#
|
2156
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
2157
|
+
#
|
1900
2158
|
# @example Request syntax with placeholder values
|
1901
2159
|
#
|
1902
2160
|
# resp = client.list_forecasts({
|
@@ -1977,6 +2235,8 @@ module Aws::ForecastService
|
|
1977
2235
|
# * {Types::ListPredictorsResponse#predictors #predictors} => Array<Types::PredictorSummary>
|
1978
2236
|
# * {Types::ListPredictorsResponse#next_token #next_token} => String
|
1979
2237
|
#
|
2238
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
2239
|
+
#
|
1980
2240
|
# @example Request syntax with placeholder values
|
1981
2241
|
#
|
1982
2242
|
# resp = client.list_predictors({
|
@@ -2012,6 +2272,132 @@ module Aws::ForecastService
|
|
2012
2272
|
req.send_request(options)
|
2013
2273
|
end
|
2014
2274
|
|
2275
|
+
# Lists the tags for an Amazon Forecast resource.
|
2276
|
+
#
|
2277
|
+
# @option params [required, String] :resource_arn
|
2278
|
+
# The Amazon Resource Name (ARN) that identifies the resource for which
|
2279
|
+
# to list the tags. Currently, the supported resources are Forecast
|
2280
|
+
# dataset groups, datasets, dataset import jobs, predictors, forecasts,
|
2281
|
+
# and forecast export jobs.
|
2282
|
+
#
|
2283
|
+
# @return [Types::ListTagsForResourceResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2284
|
+
#
|
2285
|
+
# * {Types::ListTagsForResourceResponse#tags #tags} => Array<Types::Tag>
|
2286
|
+
#
|
2287
|
+
# @example Request syntax with placeholder values
|
2288
|
+
#
|
2289
|
+
# resp = client.list_tags_for_resource({
|
2290
|
+
# resource_arn: "Arn", # required
|
2291
|
+
# })
|
2292
|
+
#
|
2293
|
+
# @example Response structure
|
2294
|
+
#
|
2295
|
+
# resp.tags #=> Array
|
2296
|
+
# resp.tags[0].key #=> String
|
2297
|
+
# resp.tags[0].value #=> String
|
2298
|
+
#
|
2299
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/ListTagsForResource AWS API Documentation
|
2300
|
+
#
|
2301
|
+
# @overload list_tags_for_resource(params = {})
|
2302
|
+
# @param [Hash] params ({})
|
2303
|
+
def list_tags_for_resource(params = {}, options = {})
|
2304
|
+
req = build_request(:list_tags_for_resource, params)
|
2305
|
+
req.send_request(options)
|
2306
|
+
end
|
2307
|
+
|
2308
|
+
# Associates the specified tags to a resource with the specified
|
2309
|
+
# `resourceArn`. If existing tags on a resource are not specified in the
|
2310
|
+
# request parameters, they are not changed. When a resource is deleted,
|
2311
|
+
# the tags associated with that resource are also deleted.
|
2312
|
+
#
|
2313
|
+
# @option params [required, String] :resource_arn
|
2314
|
+
# The Amazon Resource Name (ARN) that identifies the resource for which
|
2315
|
+
# to list the tags. Currently, the supported resources are Forecast
|
2316
|
+
# dataset groups, datasets, dataset import jobs, predictors, forecasts,
|
2317
|
+
# and forecast export jobs.
|
2318
|
+
#
|
2319
|
+
# @option params [required, Array<Types::Tag>] :tags
|
2320
|
+
# The tags to add to the resource. A tag is an array of key-value pairs.
|
2321
|
+
#
|
2322
|
+
# The following basic restrictions apply to tags:
|
2323
|
+
#
|
2324
|
+
# * Maximum number of tags per resource - 50.
|
2325
|
+
#
|
2326
|
+
# * For each resource, each tag key must be unique, and each tag key can
|
2327
|
+
# have only one value.
|
2328
|
+
#
|
2329
|
+
# * Maximum key length - 128 Unicode characters in UTF-8.
|
2330
|
+
#
|
2331
|
+
# * Maximum value length - 256 Unicode characters in UTF-8.
|
2332
|
+
#
|
2333
|
+
# * If your tagging schema is used across multiple services and
|
2334
|
+
# resources, remember that other services may have restrictions on
|
2335
|
+
# allowed characters. Generally allowed characters are: letters,
|
2336
|
+
# numbers, and spaces representable in UTF-8, and the following
|
2337
|
+
# characters: + - = . \_ : / @.
|
2338
|
+
#
|
2339
|
+
# * Tag keys and values are case sensitive.
|
2340
|
+
#
|
2341
|
+
# * Do not use `aws:`, `AWS:`, or any upper or lowercase combination of
|
2342
|
+
# such as a prefix for keys as it is reserved for AWS use. You cannot
|
2343
|
+
# edit or delete tag keys with this prefix. Values can have this
|
2344
|
+
# prefix. If a tag value has `aws` as its prefix but the key does not,
|
2345
|
+
# then Forecast considers it to be a user tag and will count against
|
2346
|
+
# the limit of 50 tags. Tags with only the key prefix of `aws` do not
|
2347
|
+
# count against your tags per resource limit.
|
2348
|
+
#
|
2349
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
2350
|
+
#
|
2351
|
+
# @example Request syntax with placeholder values
|
2352
|
+
#
|
2353
|
+
# resp = client.tag_resource({
|
2354
|
+
# resource_arn: "Arn", # required
|
2355
|
+
# tags: [ # required
|
2356
|
+
# {
|
2357
|
+
# key: "TagKey", # required
|
2358
|
+
# value: "TagValue", # required
|
2359
|
+
# },
|
2360
|
+
# ],
|
2361
|
+
# })
|
2362
|
+
#
|
2363
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/TagResource AWS API Documentation
|
2364
|
+
#
|
2365
|
+
# @overload tag_resource(params = {})
|
2366
|
+
# @param [Hash] params ({})
|
2367
|
+
def tag_resource(params = {}, options = {})
|
2368
|
+
req = build_request(:tag_resource, params)
|
2369
|
+
req.send_request(options)
|
2370
|
+
end
|
2371
|
+
|
2372
|
+
# Deletes the specified tags from a resource.
|
2373
|
+
#
|
2374
|
+
# @option params [required, String] :resource_arn
|
2375
|
+
# The Amazon Resource Name (ARN) that identifies the resource for which
|
2376
|
+
# to list the tags. Currently, the supported resources are Forecast
|
2377
|
+
# dataset groups, datasets, dataset import jobs, predictors, forecasts,
|
2378
|
+
# and forecast exports.
|
2379
|
+
#
|
2380
|
+
# @option params [required, Array<String>] :tag_keys
|
2381
|
+
# The keys of the tags to be removed.
|
2382
|
+
#
|
2383
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
2384
|
+
#
|
2385
|
+
# @example Request syntax with placeholder values
|
2386
|
+
#
|
2387
|
+
# resp = client.untag_resource({
|
2388
|
+
# resource_arn: "Arn", # required
|
2389
|
+
# tag_keys: ["TagKey"], # required
|
2390
|
+
# })
|
2391
|
+
#
|
2392
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/UntagResource AWS API Documentation
|
2393
|
+
#
|
2394
|
+
# @overload untag_resource(params = {})
|
2395
|
+
# @param [Hash] params ({})
|
2396
|
+
def untag_resource(params = {}, options = {})
|
2397
|
+
req = build_request(:untag_resource, params)
|
2398
|
+
req.send_request(options)
|
2399
|
+
end
|
2400
|
+
|
2015
2401
|
# Replaces the datasets in a dataset group with the specified datasets.
|
2016
2402
|
#
|
2017
2403
|
# <note markdown="1"> The `Status` of the dataset group must be `ACTIVE` before you can use
|
@@ -2058,7 +2444,7 @@ module Aws::ForecastService
|
|
2058
2444
|
params: params,
|
2059
2445
|
config: config)
|
2060
2446
|
context[:gem_name] = 'aws-sdk-forecastservice'
|
2061
|
-
context[:gem_version] = '1.
|
2447
|
+
context[:gem_version] = '1.8.0'
|
2062
2448
|
Seahorse::Client::Request.new(handlers, context)
|
2063
2449
|
end
|
2064
2450
|
|