aws-sdk-forecastservice 1.6.1 → 1.11.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 +405 -21
- 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: 70b267366d492acd5e216dd6845914afbe9a22d5715c170112b9cfe2acabf577
|
4
|
+
data.tar.gz: 8ef8bec9a516306642555b10bb837453870a243698041a59d3ec971464f5db02
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 40ce700ff5c1e8f81b92cc2b9bad79fdd26a2a0bcdd9de2a1a4f035db7fa310704d45c0e8604d20257944e740fc11403b32acc6f0e9798f5c727644795688601
|
7
|
+
data.tar.gz: 7e33d26ca12568a648ae2207f9e1b525f471a11cf1c00faa589b1005da22cd9932ba302472d4023ed4cf19eda8ab5a737c6574aa55221e6118e6ea2702c9b050
|
@@ -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.11.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:
|
@@ -83,13 +85,28 @@ module Aws::ForecastService
|
|
83
85
|
# * `Aws::Credentials` - Used for configuring static, non-refreshing
|
84
86
|
# credentials.
|
85
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
|
+
#
|
86
102
|
# * `Aws::InstanceProfileCredentials` - Used for loading credentials
|
87
103
|
# from an EC2 IMDS on an EC2 instance.
|
88
104
|
#
|
89
|
-
# * `Aws::
|
90
|
-
#
|
105
|
+
# * `Aws::ECSCredentials` - Used for loading credentials from
|
106
|
+
# instances running in ECS.
|
91
107
|
#
|
92
|
-
# * `Aws::
|
108
|
+
# * `Aws::CognitoIdentityCredentials` - Used for loading credentials
|
109
|
+
# from the Cognito Identity service.
|
93
110
|
#
|
94
111
|
# When `:credentials` are not configured directly, the following
|
95
112
|
# locations will be searched for credentials:
|
@@ -99,10 +116,10 @@ module Aws::ForecastService
|
|
99
116
|
# * ENV['AWS_ACCESS_KEY_ID'], ENV['AWS_SECRET_ACCESS_KEY']
|
100
117
|
# * `~/.aws/credentials`
|
101
118
|
# * `~/.aws/config`
|
102
|
-
# * EC2 IMDS instance profile - When used by default, the timeouts
|
103
|
-
# very aggressive. Construct and pass an instance of
|
104
|
-
# `Aws::InstanceProfileCredentails`
|
105
|
-
# 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.
|
106
123
|
#
|
107
124
|
# @option options [required, String] :region
|
108
125
|
# The AWS region to connect to. The configured `:region` is
|
@@ -354,7 +371,7 @@ module Aws::ForecastService
|
|
354
371
|
#
|
355
372
|
#
|
356
373
|
#
|
357
|
-
# [1]: https://github.com/aws-samples/amazon-forecast-samples
|
374
|
+
# [1]: https://github.com/aws-samples/amazon-forecast-samples
|
358
375
|
#
|
359
376
|
# @option params [required, String] :dataset_name
|
360
377
|
# A name for the dataset.
|
@@ -395,6 +412,38 @@ module Aws::ForecastService
|
|
395
412
|
# Access Management (IAM) role that Amazon Forecast can assume to access
|
396
413
|
# the key.
|
397
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
|
+
#
|
398
447
|
# @return [Types::CreateDatasetResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
399
448
|
#
|
400
449
|
# * {Types::CreateDatasetResponse#dataset_arn #dataset_arn} => String
|
@@ -418,6 +467,12 @@ module Aws::ForecastService
|
|
418
467
|
# role_arn: "Arn", # required
|
419
468
|
# kms_key_arn: "KMSKeyArn", # required
|
420
469
|
# },
|
470
|
+
# tags: [
|
471
|
+
# {
|
472
|
+
# key: "TagKey", # required
|
473
|
+
# value: "TagValue", # required
|
474
|
+
# },
|
475
|
+
# ],
|
421
476
|
# })
|
422
477
|
#
|
423
478
|
# @example Response structure
|
@@ -469,6 +524,38 @@ module Aws::ForecastService
|
|
469
524
|
# An array of Amazon Resource Names (ARNs) of the datasets that you want
|
470
525
|
# to include in the dataset group.
|
471
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
|
+
#
|
472
559
|
# @return [Types::CreateDatasetGroupResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
473
560
|
#
|
474
561
|
# * {Types::CreateDatasetGroupResponse#dataset_group_arn #dataset_group_arn} => String
|
@@ -479,6 +566,12 @@ module Aws::ForecastService
|
|
479
566
|
# dataset_group_name: "Name", # required
|
480
567
|
# domain: "RETAIL", # required, accepts RETAIL, CUSTOM, INVENTORY_PLANNING, EC2_CAPACITY, WORK_FORCE, WEB_TRAFFIC, METRICS
|
481
568
|
# dataset_arns: ["Arn"],
|
569
|
+
# tags: [
|
570
|
+
# {
|
571
|
+
# key: "TagKey", # required
|
572
|
+
# value: "TagValue", # required
|
573
|
+
# },
|
574
|
+
# ],
|
482
575
|
# })
|
483
576
|
#
|
484
577
|
# @example Response structure
|
@@ -501,7 +594,9 @@ module Aws::ForecastService
|
|
501
594
|
#
|
502
595
|
# You must specify a DataSource object that includes an AWS Identity and
|
503
596
|
# Access Management (IAM) role that Amazon Forecast can assume to access
|
504
|
-
# 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.
|
505
600
|
#
|
506
601
|
# The training data must be in CSV format. The delimiter must be a comma
|
507
602
|
# (,).
|
@@ -510,6 +605,12 @@ module Aws::ForecastService
|
|
510
605
|
# a folder in the S3 bucket. For the latter two cases, Amazon Forecast
|
511
606
|
# imports all files up to the limit of 10,000 files.
|
512
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
|
+
#
|
513
614
|
# To get a list of all your dataset import jobs, filtered by specified
|
514
615
|
# criteria, use the ListDatasetImportJobs operation.
|
515
616
|
#
|
@@ -551,6 +652,38 @@ module Aws::ForecastService
|
|
551
652
|
# If the format isn't specified, Amazon Forecast expects the format to
|
552
653
|
# be "yyyy-MM-dd HH:mm:ss".
|
553
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
|
+
#
|
554
687
|
# @return [Types::CreateDatasetImportJobResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
555
688
|
#
|
556
689
|
# * {Types::CreateDatasetImportJobResponse#dataset_import_job_arn #dataset_import_job_arn} => String
|
@@ -568,6 +701,12 @@ module Aws::ForecastService
|
|
568
701
|
# },
|
569
702
|
# },
|
570
703
|
# timestamp_format: "TimestampFormat",
|
704
|
+
# tags: [
|
705
|
+
# {
|
706
|
+
# key: "TagKey", # required
|
707
|
+
# value: "TagValue", # required
|
708
|
+
# },
|
709
|
+
# ],
|
571
710
|
# })
|
572
711
|
#
|
573
712
|
# @example Response structure
|
@@ -591,10 +730,9 @@ module Aws::ForecastService
|
|
591
730
|
# operation.
|
592
731
|
#
|
593
732
|
# The range of the forecast is determined by the `ForecastHorizon`
|
594
|
-
# value, which you specify in the CreatePredictor request
|
595
|
-
#
|
596
|
-
#
|
597
|
-
# 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.
|
598
736
|
#
|
599
737
|
# To get a list of all your forecasts, use the ListForecasts operation.
|
600
738
|
#
|
@@ -619,12 +757,44 @@ module Aws::ForecastService
|
|
619
757
|
# forecast.
|
620
758
|
#
|
621
759
|
# @option params [Array<String>] :forecast_types
|
622
|
-
# The quantiles at which probabilistic forecasts are generated. You
|
623
|
-
# specify up to 5 quantiles per forecast
|
624
|
-
# to 0.99` (increments of .01 only) and `mean`. The
|
625
|
-
# different from the median (0.50) when the
|
626
|
-
# symmetric (
|
627
|
-
# `["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.
|
628
798
|
#
|
629
799
|
# @return [Types::CreateForecastResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
630
800
|
#
|
@@ -636,6 +806,12 @@ module Aws::ForecastService
|
|
636
806
|
# forecast_name: "Name", # required
|
637
807
|
# predictor_arn: "Arn", # required
|
638
808
|
# forecast_types: ["ForecastType"],
|
809
|
+
# tags: [
|
810
|
+
# {
|
811
|
+
# key: "TagKey", # required
|
812
|
+
# value: "TagValue", # required
|
813
|
+
# },
|
814
|
+
# ],
|
639
815
|
# })
|
640
816
|
#
|
641
817
|
# @example Response structure
|
@@ -655,7 +831,7 @@ module Aws::ForecastService
|
|
655
831
|
# Amazon Simple Storage Service (Amazon S3) bucket. The forecast file
|
656
832
|
# name will match the following conventions:
|
657
833
|
#
|
658
|
-
# <ForecastExportJobName>\_<ExportTimestamp>\_<
|
834
|
+
# <ForecastExportJobName>\_<ExportTimestamp>\_<PartNumber>
|
659
835
|
#
|
660
836
|
# where the <ExportTimestamp> component is in Java
|
661
837
|
# SimpleDateFormat (yyyy-MM-ddTHH-mm-ssZ).
|
@@ -693,6 +869,38 @@ module Aws::ForecastService
|
|
693
869
|
# Management Service (KMS) key. The IAM role must allow Amazon Forecast
|
694
870
|
# permission to access the key.
|
695
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
|
+
#
|
696
904
|
# @return [Types::CreateForecastExportJobResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
697
905
|
#
|
698
906
|
# * {Types::CreateForecastExportJobResponse#forecast_export_job_arn #forecast_export_job_arn} => String
|
@@ -709,6 +917,12 @@ module Aws::ForecastService
|
|
709
917
|
# kms_key_arn: "KMSKeyArn",
|
710
918
|
# },
|
711
919
|
# },
|
920
|
+
# tags: [
|
921
|
+
# {
|
922
|
+
# key: "TagKey", # required
|
923
|
+
# value: "TagValue", # required
|
924
|
+
# },
|
925
|
+
# ],
|
712
926
|
# })
|
713
927
|
#
|
714
928
|
# @example Response structure
|
@@ -878,6 +1092,38 @@ module Aws::ForecastService
|
|
878
1092
|
# Access Management (IAM) role that Amazon Forecast can assume to access
|
879
1093
|
# the key.
|
880
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
|
+
#
|
881
1127
|
# @return [Types::CreatePredictorResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
882
1128
|
#
|
883
1129
|
# * {Types::CreatePredictorResponse#predictor_arn #predictor_arn} => String
|
@@ -953,6 +1199,12 @@ module Aws::ForecastService
|
|
953
1199
|
# role_arn: "Arn", # required
|
954
1200
|
# kms_key_arn: "KMSKeyArn", # required
|
955
1201
|
# },
|
1202
|
+
# tags: [
|
1203
|
+
# {
|
1204
|
+
# key: "TagKey", # required
|
1205
|
+
# value: "TagValue", # required
|
1206
|
+
# },
|
1207
|
+
# ],
|
956
1208
|
# })
|
957
1209
|
#
|
958
1210
|
# @example Response structure
|
@@ -973,6 +1225,12 @@ module Aws::ForecastService
|
|
973
1225
|
# status of `ACTIVE` or `CREATE_FAILED`. To get the status use the
|
974
1226
|
# DescribeDataset operation.
|
975
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
|
+
#
|
976
1234
|
# @option params [required, String] :dataset_arn
|
977
1235
|
# The Amazon Resource Name (ARN) of the dataset to delete.
|
978
1236
|
#
|
@@ -2029,6 +2287,132 @@ module Aws::ForecastService
|
|
2029
2287
|
req.send_request(options)
|
2030
2288
|
end
|
2031
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
|
+
|
2032
2416
|
# Replaces the datasets in a dataset group with the specified datasets.
|
2033
2417
|
#
|
2034
2418
|
# <note markdown="1"> The `Status` of the dataset group must be `ACTIVE` before you can use
|
@@ -2075,7 +2459,7 @@ module Aws::ForecastService
|
|
2075
2459
|
params: params,
|
2076
2460
|
config: config)
|
2077
2461
|
context[:gem_name] = 'aws-sdk-forecastservice'
|
2078
|
-
context[:gem_version] = '1.
|
2462
|
+
context[:gem_version] = '1.11.0'
|
2079
2463
|
Seahorse::Client::Request.new(handlers, context)
|
2080
2464
|
end
|
2081
2465
|
|