aws-sdk-forecastservice 1.5.0 → 1.10.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/lib/aws-sdk-forecastservice.rb +5 -2
- data/lib/aws-sdk-forecastservice/client.rb +408 -22
- 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 +2 -0
- data/lib/aws-sdk-forecastservice/types.rb +645 -32
- metadata +4 -4
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: cfdfc38c0c409d597c50156d7f9923439fa635f342b5e8d0a7e1c580032a0f33
|
4
|
+
data.tar.gz: aaf2052ecd0986cc1fd7c229115f50c002a3601b09936655b066cd583939e032
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: e5ce44117dde7ae766907946c6c9a5ef05e9c12e391c5ed3ff95bc6b0945858e918cdf6cb4dd760f4814db214551b00049230f6a5874c8c030dbf267d1265dcd
|
7
|
+
data.tar.gz: 588dc639d1f64c011232f7db41faa392846927740140058b8dd29425435854367f7b817dfd09df5b5abfaa9d68ed9b15ee6ea92488fc325ff6ee6b385fb6afc3
|
@@ -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:
|
@@ -5,6 +7,7 @@
|
|
5
7
|
#
|
6
8
|
# WARNING ABOUT GENERATED CODE
|
7
9
|
|
10
|
+
|
8
11
|
require 'aws-sdk-core'
|
9
12
|
require 'aws-sigv4'
|
10
13
|
|
@@ -42,9 +45,9 @@ require_relative 'aws-sdk-forecastservice/customizations'
|
|
42
45
|
#
|
43
46
|
# See {Errors} for more information.
|
44
47
|
#
|
45
|
-
#
|
48
|
+
# @!group service
|
46
49
|
module Aws::ForecastService
|
47
50
|
|
48
|
-
GEM_VERSION = '1.
|
51
|
+
GEM_VERSION = '1.10.0'
|
49
52
|
|
50
53
|
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
|
|
@@ -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
|
|
@@ -81,13 +85,28 @@ module Aws::ForecastService
|
|
81
85
|
# * `Aws::Credentials` - Used for configuring static, non-refreshing
|
82
86
|
# credentials.
|
83
87
|
#
|
88
|
+
# * `Aws::SharedCredentials` - Used for loading static credentials from a
|
89
|
+
# shared file, such as `~/.aws/config`.
|
90
|
+
#
|
91
|
+
# * `Aws::AssumeRoleCredentials` - Used when you need to assume a role.
|
92
|
+
#
|
93
|
+
# * `Aws::AssumeRoleWebIdentityCredentials` - Used when you need to
|
94
|
+
# assume a role after providing credentials via the web.
|
95
|
+
#
|
96
|
+
# * `Aws::SSOCredentials` - Used for loading credentials from AWS SSO using an
|
97
|
+
# access token generated from `aws login`.
|
98
|
+
#
|
99
|
+
# * `Aws::ProcessCredentials` - Used for loading credentials from a
|
100
|
+
# process that outputs to stdout.
|
101
|
+
#
|
84
102
|
# * `Aws::InstanceProfileCredentials` - Used for loading credentials
|
85
103
|
# from an EC2 IMDS on an EC2 instance.
|
86
104
|
#
|
87
|
-
# * `Aws::
|
88
|
-
#
|
105
|
+
# * `Aws::ECSCredentials` - Used for loading credentials from
|
106
|
+
# instances running in ECS.
|
89
107
|
#
|
90
|
-
# * `Aws::
|
108
|
+
# * `Aws::CognitoIdentityCredentials` - Used for loading credentials
|
109
|
+
# from the Cognito Identity service.
|
91
110
|
#
|
92
111
|
# When `:credentials` are not configured directly, the following
|
93
112
|
# locations will be searched for credentials:
|
@@ -97,10 +116,10 @@ module Aws::ForecastService
|
|
97
116
|
# * ENV['AWS_ACCESS_KEY_ID'], ENV['AWS_SECRET_ACCESS_KEY']
|
98
117
|
# * `~/.aws/credentials`
|
99
118
|
# * `~/.aws/config`
|
100
|
-
# * EC2 IMDS instance profile - When used by default, the timeouts
|
101
|
-
# very aggressive. Construct and pass an instance of
|
102
|
-
# `Aws::InstanceProfileCredentails`
|
103
|
-
# timeouts.
|
119
|
+
# * EC2/ECS IMDS instance profile - When used by default, the timeouts
|
120
|
+
# are very aggressive. Construct and pass an instance of
|
121
|
+
# `Aws::InstanceProfileCredentails` or `Aws::ECSCredentials` to
|
122
|
+
# enable retries and extended timeouts.
|
104
123
|
#
|
105
124
|
# @option options [required, String] :region
|
106
125
|
# The AWS region to connect to. The configured `:region` is
|
@@ -161,7 +180,7 @@ module Aws::ForecastService
|
|
161
180
|
# @option options [String] :endpoint
|
162
181
|
# The client endpoint is normally constructed from the `:region`
|
163
182
|
# option. You should only configure an `:endpoint` when connecting
|
164
|
-
# to test endpoints. This should be a valid HTTP(S) URI.
|
183
|
+
# to test or custom endpoints. This should be a valid HTTP(S) URI.
|
165
184
|
#
|
166
185
|
# @option options [Integer] :endpoint_cache_max_entries (1000)
|
167
186
|
# Used for the maximum size limit of the LRU cache storing endpoints data
|
@@ -352,7 +371,7 @@ module Aws::ForecastService
|
|
352
371
|
#
|
353
372
|
#
|
354
373
|
#
|
355
|
-
# [1]: https://github.com/aws-samples/amazon-forecast-samples
|
374
|
+
# [1]: https://github.com/aws-samples/amazon-forecast-samples
|
356
375
|
#
|
357
376
|
# @option params [required, String] :dataset_name
|
358
377
|
# A name for the dataset.
|
@@ -393,6 +412,38 @@ module Aws::ForecastService
|
|
393
412
|
# Access Management (IAM) role that Amazon Forecast can assume to access
|
394
413
|
# the key.
|
395
414
|
#
|
415
|
+
# @option params [Array<Types::Tag>] :tags
|
416
|
+
# The optional metadata that you apply to the dataset to help you
|
417
|
+
# categorize and organize them. Each tag consists of a key and an
|
418
|
+
# optional value, both of which you define.
|
419
|
+
#
|
420
|
+
# The following basic restrictions apply to tags:
|
421
|
+
#
|
422
|
+
# * Maximum number of tags per resource - 50.
|
423
|
+
#
|
424
|
+
# * For each resource, each tag key must be unique, and each tag key can
|
425
|
+
# have only one value.
|
426
|
+
#
|
427
|
+
# * Maximum key length - 128 Unicode characters in UTF-8.
|
428
|
+
#
|
429
|
+
# * Maximum value length - 256 Unicode characters in UTF-8.
|
430
|
+
#
|
431
|
+
# * If your tagging schema is used across multiple services and
|
432
|
+
# resources, remember that other services may have restrictions on
|
433
|
+
# allowed characters. Generally allowed characters are: letters,
|
434
|
+
# numbers, and spaces representable in UTF-8, and the following
|
435
|
+
# characters: + - = . \_ : / @.
|
436
|
+
#
|
437
|
+
# * Tag keys and values are case sensitive.
|
438
|
+
#
|
439
|
+
# * Do not use `aws:`, `AWS:`, or any upper or lowercase combination of
|
440
|
+
# such as a prefix for keys as it is reserved for AWS use. You cannot
|
441
|
+
# edit or delete tag keys with this prefix. Values can have this
|
442
|
+
# prefix. If a tag value has `aws` as its prefix but the key does not,
|
443
|
+
# then Forecast considers it to be a user tag and will count against
|
444
|
+
# the limit of 50 tags. Tags with only the key prefix of `aws` do not
|
445
|
+
# count against your tags per resource limit.
|
446
|
+
#
|
396
447
|
# @return [Types::CreateDatasetResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
397
448
|
#
|
398
449
|
# * {Types::CreateDatasetResponse#dataset_arn #dataset_arn} => String
|
@@ -416,6 +467,12 @@ module Aws::ForecastService
|
|
416
467
|
# role_arn: "Arn", # required
|
417
468
|
# kms_key_arn: "KMSKeyArn", # required
|
418
469
|
# },
|
470
|
+
# tags: [
|
471
|
+
# {
|
472
|
+
# key: "TagKey", # required
|
473
|
+
# value: "TagValue", # required
|
474
|
+
# },
|
475
|
+
# ],
|
419
476
|
# })
|
420
477
|
#
|
421
478
|
# @example Response structure
|
@@ -467,6 +524,38 @@ module Aws::ForecastService
|
|
467
524
|
# An array of Amazon Resource Names (ARNs) of the datasets that you want
|
468
525
|
# to include in the dataset group.
|
469
526
|
#
|
527
|
+
# @option params [Array<Types::Tag>] :tags
|
528
|
+
# The optional metadata that you apply to the dataset group to help you
|
529
|
+
# categorize and organize them. Each tag consists of a key and an
|
530
|
+
# optional value, both of which you define.
|
531
|
+
#
|
532
|
+
# The following basic restrictions apply to tags:
|
533
|
+
#
|
534
|
+
# * Maximum number of tags per resource - 50.
|
535
|
+
#
|
536
|
+
# * For each resource, each tag key must be unique, and each tag key can
|
537
|
+
# have only one value.
|
538
|
+
#
|
539
|
+
# * Maximum key length - 128 Unicode characters in UTF-8.
|
540
|
+
#
|
541
|
+
# * Maximum value length - 256 Unicode characters in UTF-8.
|
542
|
+
#
|
543
|
+
# * If your tagging schema is used across multiple services and
|
544
|
+
# resources, remember that other services may have restrictions on
|
545
|
+
# allowed characters. Generally allowed characters are: letters,
|
546
|
+
# numbers, and spaces representable in UTF-8, and the following
|
547
|
+
# characters: + - = . \_ : / @.
|
548
|
+
#
|
549
|
+
# * Tag keys and values are case sensitive.
|
550
|
+
#
|
551
|
+
# * Do not use `aws:`, `AWS:`, or any upper or lowercase combination of
|
552
|
+
# such as a prefix for keys as it is reserved for AWS use. You cannot
|
553
|
+
# edit or delete tag keys with this prefix. Values can have this
|
554
|
+
# prefix. If a tag value has `aws` as its prefix but the key does not,
|
555
|
+
# then Forecast considers it to be a user tag and will count against
|
556
|
+
# the limit of 50 tags. Tags with only the key prefix of `aws` do not
|
557
|
+
# count against your tags per resource limit.
|
558
|
+
#
|
470
559
|
# @return [Types::CreateDatasetGroupResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
471
560
|
#
|
472
561
|
# * {Types::CreateDatasetGroupResponse#dataset_group_arn #dataset_group_arn} => String
|
@@ -477,6 +566,12 @@ module Aws::ForecastService
|
|
477
566
|
# dataset_group_name: "Name", # required
|
478
567
|
# domain: "RETAIL", # required, accepts RETAIL, CUSTOM, INVENTORY_PLANNING, EC2_CAPACITY, WORK_FORCE, WEB_TRAFFIC, METRICS
|
479
568
|
# dataset_arns: ["Arn"],
|
569
|
+
# tags: [
|
570
|
+
# {
|
571
|
+
# key: "TagKey", # required
|
572
|
+
# value: "TagValue", # required
|
573
|
+
# },
|
574
|
+
# ],
|
480
575
|
# })
|
481
576
|
#
|
482
577
|
# @example Response structure
|
@@ -499,7 +594,9 @@ module Aws::ForecastService
|
|
499
594
|
#
|
500
595
|
# You must specify a DataSource object that includes an AWS Identity and
|
501
596
|
# Access Management (IAM) role that Amazon Forecast can assume to access
|
502
|
-
# the data
|
597
|
+
# the data, as Amazon Forecast makes a copy of your data and processes
|
598
|
+
# it in an internal AWS system. For more information, see
|
599
|
+
# aws-forecast-iam-roles.
|
503
600
|
#
|
504
601
|
# The training data must be in CSV format. The delimiter must be a comma
|
505
602
|
# (,).
|
@@ -508,6 +605,12 @@ module Aws::ForecastService
|
|
508
605
|
# a folder in the S3 bucket. For the latter two cases, Amazon Forecast
|
509
606
|
# imports all files up to the limit of 10,000 files.
|
510
607
|
#
|
608
|
+
# Because dataset imports are not aggregated, your most recent dataset
|
609
|
+
# import is the one that is used when training a predictor or generating
|
610
|
+
# a forecast. Make sure that your most recent dataset import contains
|
611
|
+
# all of the data you want to model off of, and not just the new data
|
612
|
+
# collected since the previous import.
|
613
|
+
#
|
511
614
|
# To get a list of all your dataset import jobs, filtered by specified
|
512
615
|
# criteria, use the ListDatasetImportJobs operation.
|
513
616
|
#
|
@@ -549,6 +652,38 @@ module Aws::ForecastService
|
|
549
652
|
# If the format isn't specified, Amazon Forecast expects the format to
|
550
653
|
# be "yyyy-MM-dd HH:mm:ss".
|
551
654
|
#
|
655
|
+
# @option params [Array<Types::Tag>] :tags
|
656
|
+
# The optional metadata that you apply to the dataset import job to help
|
657
|
+
# you categorize and organize them. Each tag consists of a key and an
|
658
|
+
# optional value, both of which you define.
|
659
|
+
#
|
660
|
+
# The following basic restrictions apply to tags:
|
661
|
+
#
|
662
|
+
# * Maximum number of tags per resource - 50.
|
663
|
+
#
|
664
|
+
# * For each resource, each tag key must be unique, and each tag key can
|
665
|
+
# have only one value.
|
666
|
+
#
|
667
|
+
# * Maximum key length - 128 Unicode characters in UTF-8.
|
668
|
+
#
|
669
|
+
# * Maximum value length - 256 Unicode characters in UTF-8.
|
670
|
+
#
|
671
|
+
# * If your tagging schema is used across multiple services and
|
672
|
+
# resources, remember that other services may have restrictions on
|
673
|
+
# allowed characters. Generally allowed characters are: letters,
|
674
|
+
# numbers, and spaces representable in UTF-8, and the following
|
675
|
+
# characters: + - = . \_ : / @.
|
676
|
+
#
|
677
|
+
# * Tag keys and values are case sensitive.
|
678
|
+
#
|
679
|
+
# * Do not use `aws:`, `AWS:`, or any upper or lowercase combination of
|
680
|
+
# such as a prefix for keys as it is reserved for AWS use. You cannot
|
681
|
+
# edit or delete tag keys with this prefix. Values can have this
|
682
|
+
# prefix. If a tag value has `aws` as its prefix but the key does not,
|
683
|
+
# then Forecast considers it to be a user tag and will count against
|
684
|
+
# the limit of 50 tags. Tags with only the key prefix of `aws` do not
|
685
|
+
# count against your tags per resource limit.
|
686
|
+
#
|
552
687
|
# @return [Types::CreateDatasetImportJobResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
553
688
|
#
|
554
689
|
# * {Types::CreateDatasetImportJobResponse#dataset_import_job_arn #dataset_import_job_arn} => String
|
@@ -566,6 +701,12 @@ module Aws::ForecastService
|
|
566
701
|
# },
|
567
702
|
# },
|
568
703
|
# timestamp_format: "TimestampFormat",
|
704
|
+
# tags: [
|
705
|
+
# {
|
706
|
+
# key: "TagKey", # required
|
707
|
+
# value: "TagValue", # required
|
708
|
+
# },
|
709
|
+
# ],
|
569
710
|
# })
|
570
711
|
#
|
571
712
|
# @example Response structure
|
@@ -589,10 +730,9 @@ module Aws::ForecastService
|
|
589
730
|
# operation.
|
590
731
|
#
|
591
732
|
# The range of the forecast is determined by the `ForecastHorizon`
|
592
|
-
# value, which you specify in the CreatePredictor request
|
593
|
-
#
|
594
|
-
#
|
595
|
-
# range within the forecast.
|
733
|
+
# value, which you specify in the CreatePredictor request. When you
|
734
|
+
# query a forecast, you can request a specific date range within the
|
735
|
+
# forecast.
|
596
736
|
#
|
597
737
|
# To get a list of all your forecasts, use the ListForecasts operation.
|
598
738
|
#
|
@@ -617,12 +757,44 @@ module Aws::ForecastService
|
|
617
757
|
# forecast.
|
618
758
|
#
|
619
759
|
# @option params [Array<String>] :forecast_types
|
620
|
-
# The quantiles at which probabilistic forecasts are generated. You
|
621
|
-
# specify up to 5 quantiles per forecast
|
622
|
-
# to 0.99` (increments of .01 only) and `mean`. The
|
623
|
-
# different from the median (0.50) when the
|
624
|
-
# symmetric (
|
625
|
-
# `["0.1", "0.5", "0.9"]`.
|
760
|
+
# The quantiles at which probabilistic forecasts are generated. **You
|
761
|
+
# can currently specify up to 5 quantiles per forecast**. Accepted
|
762
|
+
# values include `0.01 to 0.99` (increments of .01 only) and `mean`. The
|
763
|
+
# mean forecast is different from the median (0.50) when the
|
764
|
+
# distribution is not symmetric (for example, Beta and Negative
|
765
|
+
# Binomial). The default value is `["0.1", "0.5", "0.9"]`.
|
766
|
+
#
|
767
|
+
# @option params [Array<Types::Tag>] :tags
|
768
|
+
# The optional metadata that you apply to the forecast to help you
|
769
|
+
# categorize and organize them. Each tag consists of a key and an
|
770
|
+
# optional value, both of which you define.
|
771
|
+
#
|
772
|
+
# The following basic restrictions apply to tags:
|
773
|
+
#
|
774
|
+
# * Maximum number of tags per resource - 50.
|
775
|
+
#
|
776
|
+
# * For each resource, each tag key must be unique, and each tag key can
|
777
|
+
# have only one value.
|
778
|
+
#
|
779
|
+
# * Maximum key length - 128 Unicode characters in UTF-8.
|
780
|
+
#
|
781
|
+
# * Maximum value length - 256 Unicode characters in UTF-8.
|
782
|
+
#
|
783
|
+
# * If your tagging schema is used across multiple services and
|
784
|
+
# resources, remember that other services may have restrictions on
|
785
|
+
# allowed characters. Generally allowed characters are: letters,
|
786
|
+
# numbers, and spaces representable in UTF-8, and the following
|
787
|
+
# characters: + - = . \_ : / @.
|
788
|
+
#
|
789
|
+
# * Tag keys and values are case sensitive.
|
790
|
+
#
|
791
|
+
# * Do not use `aws:`, `AWS:`, or any upper or lowercase combination of
|
792
|
+
# such as a prefix for keys as it is reserved for AWS use. You cannot
|
793
|
+
# edit or delete tag keys with this prefix. Values can have this
|
794
|
+
# prefix. If a tag value has `aws` as its prefix but the key does not,
|
795
|
+
# then Forecast considers it to be a user tag and will count against
|
796
|
+
# the limit of 50 tags. Tags with only the key prefix of `aws` do not
|
797
|
+
# count against your tags per resource limit.
|
626
798
|
#
|
627
799
|
# @return [Types::CreateForecastResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
628
800
|
#
|
@@ -634,6 +806,12 @@ module Aws::ForecastService
|
|
634
806
|
# forecast_name: "Name", # required
|
635
807
|
# predictor_arn: "Arn", # required
|
636
808
|
# forecast_types: ["ForecastType"],
|
809
|
+
# tags: [
|
810
|
+
# {
|
811
|
+
# key: "TagKey", # required
|
812
|
+
# value: "TagValue", # required
|
813
|
+
# },
|
814
|
+
# ],
|
637
815
|
# })
|
638
816
|
#
|
639
817
|
# @example Response structure
|
@@ -653,7 +831,7 @@ module Aws::ForecastService
|
|
653
831
|
# Amazon Simple Storage Service (Amazon S3) bucket. The forecast file
|
654
832
|
# name will match the following conventions:
|
655
833
|
#
|
656
|
-
# <ForecastExportJobName>\_<ExportTimestamp>\_<
|
834
|
+
# <ForecastExportJobName>\_<ExportTimestamp>\_<PartNumber>
|
657
835
|
#
|
658
836
|
# where the <ExportTimestamp> component is in Java
|
659
837
|
# SimpleDateFormat (yyyy-MM-ddTHH-mm-ssZ).
|
@@ -691,6 +869,38 @@ module Aws::ForecastService
|
|
691
869
|
# Management Service (KMS) key. The IAM role must allow Amazon Forecast
|
692
870
|
# permission to access the key.
|
693
871
|
#
|
872
|
+
# @option params [Array<Types::Tag>] :tags
|
873
|
+
# The optional metadata that you apply to the forecast export job to
|
874
|
+
# help you categorize and organize them. Each tag consists of a key and
|
875
|
+
# an optional value, both of which you define.
|
876
|
+
#
|
877
|
+
# The following basic restrictions apply to tags:
|
878
|
+
#
|
879
|
+
# * Maximum number of tags per resource - 50.
|
880
|
+
#
|
881
|
+
# * For each resource, each tag key must be unique, and each tag key can
|
882
|
+
# have only one value.
|
883
|
+
#
|
884
|
+
# * Maximum key length - 128 Unicode characters in UTF-8.
|
885
|
+
#
|
886
|
+
# * Maximum value length - 256 Unicode characters in UTF-8.
|
887
|
+
#
|
888
|
+
# * If your tagging schema is used across multiple services and
|
889
|
+
# resources, remember that other services may have restrictions on
|
890
|
+
# allowed characters. Generally allowed characters are: letters,
|
891
|
+
# numbers, and spaces representable in UTF-8, and the following
|
892
|
+
# characters: + - = . \_ : / @.
|
893
|
+
#
|
894
|
+
# * Tag keys and values are case sensitive.
|
895
|
+
#
|
896
|
+
# * Do not use `aws:`, `AWS:`, or any upper or lowercase combination of
|
897
|
+
# such as a prefix for keys as it is reserved for AWS use. You cannot
|
898
|
+
# edit or delete tag keys with this prefix. Values can have this
|
899
|
+
# prefix. If a tag value has `aws` as its prefix but the key does not,
|
900
|
+
# then Forecast considers it to be a user tag and will count against
|
901
|
+
# the limit of 50 tags. Tags with only the key prefix of `aws` do not
|
902
|
+
# count against your tags per resource limit.
|
903
|
+
#
|
694
904
|
# @return [Types::CreateForecastExportJobResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
695
905
|
#
|
696
906
|
# * {Types::CreateForecastExportJobResponse#forecast_export_job_arn #forecast_export_job_arn} => String
|
@@ -707,6 +917,12 @@ module Aws::ForecastService
|
|
707
917
|
# kms_key_arn: "KMSKeyArn",
|
708
918
|
# },
|
709
919
|
# },
|
920
|
+
# tags: [
|
921
|
+
# {
|
922
|
+
# key: "TagKey", # required
|
923
|
+
# value: "TagValue", # required
|
924
|
+
# },
|
925
|
+
# ],
|
710
926
|
# })
|
711
927
|
#
|
712
928
|
# @example Response structure
|
@@ -876,6 +1092,38 @@ module Aws::ForecastService
|
|
876
1092
|
# Access Management (IAM) role that Amazon Forecast can assume to access
|
877
1093
|
# the key.
|
878
1094
|
#
|
1095
|
+
# @option params [Array<Types::Tag>] :tags
|
1096
|
+
# The optional metadata that you apply to the predictor to help you
|
1097
|
+
# categorize and organize them. Each tag consists of a key and an
|
1098
|
+
# optional value, both of which you define.
|
1099
|
+
#
|
1100
|
+
# The following basic restrictions apply to tags:
|
1101
|
+
#
|
1102
|
+
# * Maximum number of tags per resource - 50.
|
1103
|
+
#
|
1104
|
+
# * For each resource, each tag key must be unique, and each tag key can
|
1105
|
+
# have only one value.
|
1106
|
+
#
|
1107
|
+
# * Maximum key length - 128 Unicode characters in UTF-8.
|
1108
|
+
#
|
1109
|
+
# * Maximum value length - 256 Unicode characters in UTF-8.
|
1110
|
+
#
|
1111
|
+
# * If your tagging schema is used across multiple services and
|
1112
|
+
# resources, remember that other services may have restrictions on
|
1113
|
+
# allowed characters. Generally allowed characters are: letters,
|
1114
|
+
# numbers, and spaces representable in UTF-8, and the following
|
1115
|
+
# characters: + - = . \_ : / @.
|
1116
|
+
#
|
1117
|
+
# * Tag keys and values are case sensitive.
|
1118
|
+
#
|
1119
|
+
# * Do not use `aws:`, `AWS:`, or any upper or lowercase combination of
|
1120
|
+
# such as a prefix for keys as it is reserved for AWS use. You cannot
|
1121
|
+
# edit or delete tag keys with this prefix. Values can have this
|
1122
|
+
# prefix. If a tag value has `aws` as its prefix but the key does not,
|
1123
|
+
# then Forecast considers it to be a user tag and will count against
|
1124
|
+
# the limit of 50 tags. Tags with only the key prefix of `aws` do not
|
1125
|
+
# count against your tags per resource limit.
|
1126
|
+
#
|
879
1127
|
# @return [Types::CreatePredictorResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
880
1128
|
#
|
881
1129
|
# * {Types::CreatePredictorResponse#predictor_arn #predictor_arn} => String
|
@@ -951,6 +1199,12 @@ module Aws::ForecastService
|
|
951
1199
|
# role_arn: "Arn", # required
|
952
1200
|
# kms_key_arn: "KMSKeyArn", # required
|
953
1201
|
# },
|
1202
|
+
# tags: [
|
1203
|
+
# {
|
1204
|
+
# key: "TagKey", # required
|
1205
|
+
# value: "TagValue", # required
|
1206
|
+
# },
|
1207
|
+
# ],
|
954
1208
|
# })
|
955
1209
|
#
|
956
1210
|
# @example Response structure
|
@@ -971,6 +1225,12 @@ module Aws::ForecastService
|
|
971
1225
|
# status of `ACTIVE` or `CREATE_FAILED`. To get the status use the
|
972
1226
|
# DescribeDataset operation.
|
973
1227
|
#
|
1228
|
+
# <note markdown="1"> Forecast does not automatically update any dataset groups that contain
|
1229
|
+
# the deleted dataset. In order to update the dataset group, use the
|
1230
|
+
# operation, omitting the deleted dataset's ARN.
|
1231
|
+
#
|
1232
|
+
# </note>
|
1233
|
+
#
|
974
1234
|
# @option params [required, String] :dataset_arn
|
975
1235
|
# The Amazon Resource Name (ARN) of the dataset to delete.
|
976
1236
|
#
|
@@ -2027,6 +2287,132 @@ module Aws::ForecastService
|
|
2027
2287
|
req.send_request(options)
|
2028
2288
|
end
|
2029
2289
|
|
2290
|
+
# Lists the tags for an Amazon Forecast resource.
|
2291
|
+
#
|
2292
|
+
# @option params [required, String] :resource_arn
|
2293
|
+
# The Amazon Resource Name (ARN) that identifies the resource for which
|
2294
|
+
# to list the tags. Currently, the supported resources are Forecast
|
2295
|
+
# dataset groups, datasets, dataset import jobs, predictors, forecasts,
|
2296
|
+
# and forecast export jobs.
|
2297
|
+
#
|
2298
|
+
# @return [Types::ListTagsForResourceResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2299
|
+
#
|
2300
|
+
# * {Types::ListTagsForResourceResponse#tags #tags} => Array<Types::Tag>
|
2301
|
+
#
|
2302
|
+
# @example Request syntax with placeholder values
|
2303
|
+
#
|
2304
|
+
# resp = client.list_tags_for_resource({
|
2305
|
+
# resource_arn: "Arn", # required
|
2306
|
+
# })
|
2307
|
+
#
|
2308
|
+
# @example Response structure
|
2309
|
+
#
|
2310
|
+
# resp.tags #=> Array
|
2311
|
+
# resp.tags[0].key #=> String
|
2312
|
+
# resp.tags[0].value #=> String
|
2313
|
+
#
|
2314
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/ListTagsForResource AWS API Documentation
|
2315
|
+
#
|
2316
|
+
# @overload list_tags_for_resource(params = {})
|
2317
|
+
# @param [Hash] params ({})
|
2318
|
+
def list_tags_for_resource(params = {}, options = {})
|
2319
|
+
req = build_request(:list_tags_for_resource, params)
|
2320
|
+
req.send_request(options)
|
2321
|
+
end
|
2322
|
+
|
2323
|
+
# Associates the specified tags to a resource with the specified
|
2324
|
+
# `resourceArn`. If existing tags on a resource are not specified in the
|
2325
|
+
# request parameters, they are not changed. When a resource is deleted,
|
2326
|
+
# the tags associated with that resource are also deleted.
|
2327
|
+
#
|
2328
|
+
# @option params [required, String] :resource_arn
|
2329
|
+
# The Amazon Resource Name (ARN) that identifies the resource for which
|
2330
|
+
# to list the tags. Currently, the supported resources are Forecast
|
2331
|
+
# dataset groups, datasets, dataset import jobs, predictors, forecasts,
|
2332
|
+
# and forecast export jobs.
|
2333
|
+
#
|
2334
|
+
# @option params [required, Array<Types::Tag>] :tags
|
2335
|
+
# The tags to add to the resource. A tag is an array of key-value pairs.
|
2336
|
+
#
|
2337
|
+
# The following basic restrictions apply to tags:
|
2338
|
+
#
|
2339
|
+
# * Maximum number of tags per resource - 50.
|
2340
|
+
#
|
2341
|
+
# * For each resource, each tag key must be unique, and each tag key can
|
2342
|
+
# have only one value.
|
2343
|
+
#
|
2344
|
+
# * Maximum key length - 128 Unicode characters in UTF-8.
|
2345
|
+
#
|
2346
|
+
# * Maximum value length - 256 Unicode characters in UTF-8.
|
2347
|
+
#
|
2348
|
+
# * If your tagging schema is used across multiple services and
|
2349
|
+
# resources, remember that other services may have restrictions on
|
2350
|
+
# allowed characters. Generally allowed characters are: letters,
|
2351
|
+
# numbers, and spaces representable in UTF-8, and the following
|
2352
|
+
# characters: + - = . \_ : / @.
|
2353
|
+
#
|
2354
|
+
# * Tag keys and values are case sensitive.
|
2355
|
+
#
|
2356
|
+
# * Do not use `aws:`, `AWS:`, or any upper or lowercase combination of
|
2357
|
+
# such as a prefix for keys as it is reserved for AWS use. You cannot
|
2358
|
+
# edit or delete tag keys with this prefix. Values can have this
|
2359
|
+
# prefix. If a tag value has `aws` as its prefix but the key does not,
|
2360
|
+
# then Forecast considers it to be a user tag and will count against
|
2361
|
+
# the limit of 50 tags. Tags with only the key prefix of `aws` do not
|
2362
|
+
# count against your tags per resource limit.
|
2363
|
+
#
|
2364
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
2365
|
+
#
|
2366
|
+
# @example Request syntax with placeholder values
|
2367
|
+
#
|
2368
|
+
# resp = client.tag_resource({
|
2369
|
+
# resource_arn: "Arn", # required
|
2370
|
+
# tags: [ # required
|
2371
|
+
# {
|
2372
|
+
# key: "TagKey", # required
|
2373
|
+
# value: "TagValue", # required
|
2374
|
+
# },
|
2375
|
+
# ],
|
2376
|
+
# })
|
2377
|
+
#
|
2378
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/TagResource AWS API Documentation
|
2379
|
+
#
|
2380
|
+
# @overload tag_resource(params = {})
|
2381
|
+
# @param [Hash] params ({})
|
2382
|
+
def tag_resource(params = {}, options = {})
|
2383
|
+
req = build_request(:tag_resource, params)
|
2384
|
+
req.send_request(options)
|
2385
|
+
end
|
2386
|
+
|
2387
|
+
# Deletes the specified tags from a resource.
|
2388
|
+
#
|
2389
|
+
# @option params [required, String] :resource_arn
|
2390
|
+
# The Amazon Resource Name (ARN) that identifies the resource for which
|
2391
|
+
# to list the tags. Currently, the supported resources are Forecast
|
2392
|
+
# dataset groups, datasets, dataset import jobs, predictors, forecasts,
|
2393
|
+
# and forecast exports.
|
2394
|
+
#
|
2395
|
+
# @option params [required, Array<String>] :tag_keys
|
2396
|
+
# The keys of the tags to be removed.
|
2397
|
+
#
|
2398
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
2399
|
+
#
|
2400
|
+
# @example Request syntax with placeholder values
|
2401
|
+
#
|
2402
|
+
# resp = client.untag_resource({
|
2403
|
+
# resource_arn: "Arn", # required
|
2404
|
+
# tag_keys: ["TagKey"], # required
|
2405
|
+
# })
|
2406
|
+
#
|
2407
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/UntagResource AWS API Documentation
|
2408
|
+
#
|
2409
|
+
# @overload untag_resource(params = {})
|
2410
|
+
# @param [Hash] params ({})
|
2411
|
+
def untag_resource(params = {}, options = {})
|
2412
|
+
req = build_request(:untag_resource, params)
|
2413
|
+
req.send_request(options)
|
2414
|
+
end
|
2415
|
+
|
2030
2416
|
# Replaces the datasets in a dataset group with the specified datasets.
|
2031
2417
|
#
|
2032
2418
|
# <note markdown="1"> The `Status` of the dataset group must be `ACTIVE` before you can use
|
@@ -2073,7 +2459,7 @@ module Aws::ForecastService
|
|
2073
2459
|
params: params,
|
2074
2460
|
config: config)
|
2075
2461
|
context[:gem_name] = 'aws-sdk-forecastservice'
|
2076
|
-
context[:gem_version] = '1.
|
2462
|
+
context[:gem_version] = '1.10.0'
|
2077
2463
|
Seahorse::Client::Request.new(handlers, context)
|
2078
2464
|
end
|
2079
2465
|
|