aws-sdk-resourcegroupstaggingapi 1.42.0 → 1.46.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/CHANGELOG.md +20 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-resourcegroupstaggingapi/client.rb +94 -48
- data/lib/aws-sdk-resourcegroupstaggingapi/types.rb +83 -73
- data/lib/aws-sdk-resourcegroupstaggingapi.rb +1 -1
- 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: ef3688293241d62cabea85ac7ab204fbf6aba85e142600b8cd52a1d86314c5dd
|
4
|
+
data.tar.gz: d26fafb23bc98cbbaa8db2dd3e84d83463de6cc97ae1c839dff7917ec297038e
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 006dcde0306185a77d9e0f20c7492fa9821e2a55a34f7f93ff40b73269b0e021e2e4ef02fa2347664cbfa3ef9b727109c4a03c0e3987469176b17d9d6a45dd94
|
7
|
+
data.tar.gz: 619112314f51da8a72aee6b046feb56787c44516e8e715d8e57a1c74ca1a5cacc868a42746dd5ee6b684b6390a84c396cd40209525c47d339409fce967479d0f
|
data/CHANGELOG.md
CHANGED
@@ -1,6 +1,26 @@
|
|
1
1
|
Unreleased Changes
|
2
2
|
------------------
|
3
3
|
|
4
|
+
1.46.0 (2022-02-03)
|
5
|
+
------------------
|
6
|
+
|
7
|
+
* Feature - Code Generated Changes, see `./build_tools` or `aws-sdk-core`'s CHANGELOG.md for details.
|
8
|
+
|
9
|
+
1.45.0 (2021-12-21)
|
10
|
+
------------------
|
11
|
+
|
12
|
+
* Feature - Code Generated Changes, see `./build_tools` or `aws-sdk-core`'s CHANGELOG.md for details.
|
13
|
+
|
14
|
+
1.44.0 (2021-11-30)
|
15
|
+
------------------
|
16
|
+
|
17
|
+
* Feature - Code Generated Changes, see `./build_tools` or `aws-sdk-core`'s CHANGELOG.md for details.
|
18
|
+
|
19
|
+
1.43.0 (2021-11-05)
|
20
|
+
------------------
|
21
|
+
|
22
|
+
* Feature - Documentation updates and improvements.
|
23
|
+
|
4
24
|
1.42.0 (2021-11-04)
|
5
25
|
------------------
|
6
26
|
|
data/VERSION
CHANGED
@@ -1 +1 @@
|
|
1
|
-
1.
|
1
|
+
1.46.0
|
@@ -27,6 +27,8 @@ require 'aws-sdk-core/plugins/client_metrics_plugin.rb'
|
|
27
27
|
require 'aws-sdk-core/plugins/client_metrics_send_plugin.rb'
|
28
28
|
require 'aws-sdk-core/plugins/transfer_encoding.rb'
|
29
29
|
require 'aws-sdk-core/plugins/http_checksum.rb'
|
30
|
+
require 'aws-sdk-core/plugins/defaults_mode.rb'
|
31
|
+
require 'aws-sdk-core/plugins/recursion_detection.rb'
|
30
32
|
require 'aws-sdk-core/plugins/signature_v4.rb'
|
31
33
|
require 'aws-sdk-core/plugins/protocols/json_rpc.rb'
|
32
34
|
|
@@ -73,6 +75,8 @@ module Aws::ResourceGroupsTaggingAPI
|
|
73
75
|
add_plugin(Aws::Plugins::ClientMetricsSendPlugin)
|
74
76
|
add_plugin(Aws::Plugins::TransferEncoding)
|
75
77
|
add_plugin(Aws::Plugins::HttpChecksum)
|
78
|
+
add_plugin(Aws::Plugins::DefaultsMode)
|
79
|
+
add_plugin(Aws::Plugins::RecursionDetection)
|
76
80
|
add_plugin(Aws::Plugins::SignatureV4)
|
77
81
|
add_plugin(Aws::Plugins::Protocols::JsonRpc)
|
78
82
|
|
@@ -119,7 +123,9 @@ module Aws::ResourceGroupsTaggingAPI
|
|
119
123
|
# * EC2/ECS IMDS instance profile - When used by default, the timeouts
|
120
124
|
# are very aggressive. Construct and pass an instance of
|
121
125
|
# `Aws::InstanceProfileCredentails` or `Aws::ECSCredentials` to
|
122
|
-
# enable retries and extended timeouts.
|
126
|
+
# enable retries and extended timeouts. Instance profile credential
|
127
|
+
# fetching can be disabled by setting ENV['AWS_EC2_METADATA_DISABLED']
|
128
|
+
# to true.
|
123
129
|
#
|
124
130
|
# @option options [required, String] :region
|
125
131
|
# The AWS region to connect to. The configured `:region` is
|
@@ -173,6 +179,10 @@ module Aws::ResourceGroupsTaggingAPI
|
|
173
179
|
# Used only in `standard` and adaptive retry modes. Specifies whether to apply
|
174
180
|
# a clock skew correction and retry requests with skewed client clocks.
|
175
181
|
#
|
182
|
+
# @option options [String] :defaults_mode ("legacy")
|
183
|
+
# See {Aws::DefaultsModeConfiguration} for a list of the
|
184
|
+
# accepted modes and the configuration defaults that are included.
|
185
|
+
#
|
176
186
|
# @option options [Boolean] :disable_host_prefix_injection (false)
|
177
187
|
# Set to true to disable SDK automatically adding host prefix
|
178
188
|
# to default service endpoint when available.
|
@@ -305,7 +315,7 @@ module Aws::ResourceGroupsTaggingAPI
|
|
305
315
|
# seconds to wait when opening a HTTP session before raising a
|
306
316
|
# `Timeout::Error`.
|
307
317
|
#
|
308
|
-
# @option options [
|
318
|
+
# @option options [Float] :http_read_timeout (60) The default
|
309
319
|
# number of seconds to wait for response data. This value can
|
310
320
|
# safely be set per-request on the session.
|
311
321
|
#
|
@@ -321,6 +331,9 @@ module Aws::ResourceGroupsTaggingAPI
|
|
321
331
|
# disables this behaviour. This value can safely be set per
|
322
332
|
# request on the session.
|
323
333
|
#
|
334
|
+
# @option options [Float] :ssl_timeout (nil) Sets the SSL timeout
|
335
|
+
# in seconds.
|
336
|
+
#
|
324
337
|
# @option options [Boolean] :http_wire_trace (false) When `true`,
|
325
338
|
# HTTP debug output will be sent to the `:logger`.
|
326
339
|
#
|
@@ -376,7 +389,7 @@ module Aws::ResourceGroupsTaggingAPI
|
|
376
389
|
# with their tag policies.
|
377
390
|
#
|
378
391
|
# For more information on tag policies, see [Tag Policies][1] in the
|
379
|
-
# *
|
392
|
+
# *Organizations User Guide.*
|
380
393
|
#
|
381
394
|
# You can call this operation only from the organization's management
|
382
395
|
# account and from the us-east-1 Region.
|
@@ -400,9 +413,9 @@ module Aws::ResourceGroupsTaggingAPI
|
|
400
413
|
# target IDs.
|
401
414
|
#
|
402
415
|
# @option params [Array<String>] :region_filters
|
403
|
-
# Specifies a list of
|
404
|
-
# this parameter, the count of returned noncompliant
|
405
|
-
# only resources in the specified Regions.
|
416
|
+
# Specifies a list of Amazon Web Services Regions to limit the output
|
417
|
+
# to. If you use this parameter, the count of returned noncompliant
|
418
|
+
# resources includes only resources in the specified Regions.
|
406
419
|
#
|
407
420
|
# @option params [Array<String>] :resource_type_filters
|
408
421
|
# Specifies that you want the response to include information for only
|
@@ -413,15 +426,17 @@ module Aws::ResourceGroupsTaggingAPI
|
|
413
426
|
# instances.
|
414
427
|
#
|
415
428
|
# The string for each service name and resource type is the same as that
|
416
|
-
# embedded in a resource's Amazon Resource Name (ARN). Consult the
|
417
|
-
#
|
429
|
+
# embedded in a resource's Amazon Resource Name (ARN). Consult the <i>
|
430
|
+
# <a href="https://docs.aws.amazon.com/general/latest/gr/">Amazon Web
|
431
|
+
# Services General Reference</a> </i> for the following:
|
418
432
|
#
|
419
|
-
# * For a list of service name strings, see [
|
433
|
+
# * For a list of service name strings, see [Amazon Web Services Service
|
434
|
+
# Namespaces][1].
|
420
435
|
#
|
421
436
|
# * For resource type strings, see [Example ARNs][2].
|
422
437
|
#
|
423
438
|
# * For more information about ARNs, see [Amazon Resource Names (ARNs)
|
424
|
-
# and
|
439
|
+
# and Amazon Web Services Service Namespaces][3].
|
425
440
|
#
|
426
441
|
# You can specify multiple resource types by using a comma separated
|
427
442
|
# array. The array can include up to 100 items. Note that the length
|
@@ -495,7 +510,7 @@ module Aws::ResourceGroupsTaggingAPI
|
|
495
510
|
end
|
496
511
|
|
497
512
|
# Returns all the tagged or previously tagged resources that are located
|
498
|
-
# in the specified Region for the
|
513
|
+
# in the specified Amazon Web Services Region for the account.
|
499
514
|
#
|
500
515
|
# Depending on what information you want returned, you can also specify
|
501
516
|
# the following:
|
@@ -506,7 +521,7 @@ module Aws::ResourceGroupsTaggingAPI
|
|
506
521
|
#
|
507
522
|
# * Information about compliance with the account's effective tag
|
508
523
|
# policy. For more information on tag policies, see [Tag Policies][1]
|
509
|
-
# in the *
|
524
|
+
# in the *Organizations User Guide.*
|
510
525
|
#
|
511
526
|
# This operation supports pagination, where the response can be sent in
|
512
527
|
# multiple pages. You should check the `PaginationToken` response
|
@@ -527,10 +542,10 @@ module Aws::ResourceGroupsTaggingAPI
|
|
527
542
|
#
|
528
543
|
# @option params [Array<Types::TagFilter>] :tag_filters
|
529
544
|
# Specifies a list of TagFilters (keys and values) to restrict the
|
530
|
-
# output to only those resources that have the specified
|
531
|
-
# included, the specified
|
532
|
-
# with values optional. A request can include up to 50 keys, and
|
533
|
-
# key can include up to 20 values.
|
545
|
+
# output to only those resources that have tags with the specified keys
|
546
|
+
# and, if included, the specified values. Each `TagFilter` must contain
|
547
|
+
# a key with values optional. A request can include up to 50 keys, and
|
548
|
+
# each key can include up to 20 values.
|
534
549
|
#
|
535
550
|
# Note the following when deciding how to use TagFilters:
|
536
551
|
#
|
@@ -543,11 +558,11 @@ module Aws::ResourceGroupsTaggingAPI
|
|
543
558
|
# response returns only those resources that satisfy all filters.
|
544
559
|
#
|
545
560
|
# * If you specify a filter that contains more than one value for a key,
|
546
|
-
# the response returns resources that match any of the specified
|
561
|
+
# the response returns resources that match *any* of the specified
|
547
562
|
# values for that key.
|
548
563
|
#
|
549
|
-
# * If you don't specify
|
550
|
-
# resources that are tagged with that key
|
564
|
+
# * If you don't specify a value for a key, the response returns all
|
565
|
+
# resources that are tagged with that key, with any or no value.
|
551
566
|
#
|
552
567
|
# For example, for the following filters: `filter1=
|
553
568
|
# \{keyA,\{value1\}\}`, `filter2=\{keyB,\{value2,value3,value4\}\}`,
|
@@ -574,7 +589,8 @@ module Aws::ResourceGroupsTaggingAPI
|
|
574
589
|
# minimum of 1 and a maximum value of 100.
|
575
590
|
#
|
576
591
|
# @option params [Integer] :tags_per_page
|
577
|
-
#
|
592
|
+
# Amazon Web Services recommends using `ResourcesPerPage` instead of
|
593
|
+
# this parameter.
|
578
594
|
#
|
579
595
|
# A limit that restricts the number of tags (key and value pairs)
|
580
596
|
# returned by `GetResources` in paginated output. A resource with no
|
@@ -602,19 +618,21 @@ module Aws::ResourceGroupsTaggingAPI
|
|
602
618
|
# of `ec2:instance` returns only EC2 instances.
|
603
619
|
#
|
604
620
|
# The string for each service name and resource type is the same as that
|
605
|
-
# embedded in a resource's Amazon Resource Name (ARN).
|
606
|
-
#
|
607
|
-
#
|
608
|
-
# For more information about ARNs, see [Amazon Resource Names (ARNs) and
|
609
|
-
# AWS Service Namespaces][1].
|
621
|
+
# embedded in a resource's Amazon Resource Name (ARN). For the list of
|
622
|
+
# services whose resources you can use in this parameter, see [Services
|
623
|
+
# that support the Resource Groups Tagging API][1].
|
610
624
|
#
|
611
625
|
# You can specify multiple resource types by using an array. The array
|
612
626
|
# can include up to 100 items. Note that the length constraint
|
613
|
-
# requirement applies to each resource type filter.
|
627
|
+
# requirement applies to each resource type filter. For example, the
|
628
|
+
# following string would limit the response to only Amazon EC2
|
629
|
+
# instances, Amazon S3 buckets, or any Audit Manager resource:
|
614
630
|
#
|
631
|
+
# `ec2:instance,s3:bucket,auditmanager`
|
615
632
|
#
|
616
633
|
#
|
617
|
-
#
|
634
|
+
#
|
635
|
+
# [1]: https://docs.aws.amazon.com/resourcegroupstagging/latest/APIReference/supported-services.html
|
618
636
|
#
|
619
637
|
# @option params [Boolean] :include_compliance_details
|
620
638
|
# Specifies whether to include details regarding the compliance with the
|
@@ -640,12 +658,12 @@ module Aws::ResourceGroupsTaggingAPI
|
|
640
658
|
# generate an error; it simply isn't included in the response.
|
641
659
|
#
|
642
660
|
# An ARN (Amazon Resource Name) uniquely identifies a resource. For more
|
643
|
-
# information, see [Amazon Resource Names (ARNs) and
|
644
|
-
# Namespaces][1] in the *
|
661
|
+
# information, see [Amazon Resource Names (ARNs) and Amazon Web Services
|
662
|
+
# Service Namespaces][1] in the *Amazon Web Services General Reference*.
|
645
663
|
#
|
646
664
|
#
|
647
665
|
#
|
648
|
-
# [1]:
|
666
|
+
# [1]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html
|
649
667
|
#
|
650
668
|
# @return [Types::GetResourcesOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
651
669
|
#
|
@@ -695,8 +713,8 @@ module Aws::ResourceGroupsTaggingAPI
|
|
695
713
|
req.send_request(options)
|
696
714
|
end
|
697
715
|
|
698
|
-
# Returns all tag keys currently in use in the specified
|
699
|
-
# calling
|
716
|
+
# Returns all tag keys currently in use in the specified Amazon Web
|
717
|
+
# Services Region for the calling account.
|
700
718
|
#
|
701
719
|
# This operation supports pagination, where the response can be sent in
|
702
720
|
# multiple pages. You should check the `PaginationToken` response
|
@@ -740,7 +758,7 @@ module Aws::ResourceGroupsTaggingAPI
|
|
740
758
|
end
|
741
759
|
|
742
760
|
# Returns all tag values for the specified key that are used in the
|
743
|
-
# specified
|
761
|
+
# specified Amazon Web Services Region for the calling account.
|
744
762
|
#
|
745
763
|
# This operation supports pagination, where the response can be sent in
|
746
764
|
# multiple pages. You should check the `PaginationToken` response
|
@@ -757,8 +775,8 @@ module Aws::ResourceGroupsTaggingAPI
|
|
757
775
|
#
|
758
776
|
# @option params [required, String] :key
|
759
777
|
# Specifies the tag key for which you want to list all existing values
|
760
|
-
# that are currently used in the specified
|
761
|
-
#
|
778
|
+
# that are currently used in the specified Amazon Web Services Region
|
779
|
+
# for the calling account.
|
762
780
|
#
|
763
781
|
# @return [Types::GetTagValuesOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
764
782
|
#
|
@@ -832,13 +850,17 @@ module Aws::ResourceGroupsTaggingAPI
|
|
832
850
|
#
|
833
851
|
# * Not all resources can have tags. For a list of services with
|
834
852
|
# resources that support tagging using this operation, see [Services
|
835
|
-
# that support the Resource Groups Tagging API][1].
|
853
|
+
# that support the Resource Groups Tagging API][1]. If the resource
|
854
|
+
# doesn't yet support this operation, the resource's service might
|
855
|
+
# support tagging using its own API operations. For more information,
|
856
|
+
# refer to the documentation for that service.
|
836
857
|
#
|
837
858
|
# * Each resource can have up to 50 tags. For other limits, see [Tag
|
838
|
-
# Naming and Usage Conventions][2] in the *
|
859
|
+
# Naming and Usage Conventions][2] in the *Amazon Web Services General
|
860
|
+
# Reference.*
|
839
861
|
#
|
840
|
-
# * You can only tag resources that are located in the specified
|
841
|
-
# Region for the
|
862
|
+
# * You can only tag resources that are located in the specified Amazon
|
863
|
+
# Web Services Region for the Amazon Web Services account.
|
842
864
|
#
|
843
865
|
# * To add tags to a resource, you need the necessary permissions for
|
844
866
|
# the service that the resource belongs to as well as permissions for
|
@@ -850,6 +872,18 @@ module Aws::ResourceGroupsTaggingAPI
|
|
850
872
|
# you with billing and administration services. Tags are not intended to
|
851
873
|
# be used for private or sensitive data.
|
852
874
|
#
|
875
|
+
# **Minimum permissions**
|
876
|
+
#
|
877
|
+
# In addition to the `tag:TagResources` permission required by this
|
878
|
+
# operation, you must also have the tagging permission defined by the
|
879
|
+
# service that created the resource. For example, to tag an Amazon EC2
|
880
|
+
# instance using the `TagResources` operation, you must have both of the
|
881
|
+
# following permissions:
|
882
|
+
#
|
883
|
+
# * `tag:TagResource`
|
884
|
+
#
|
885
|
+
# * `ec2:CreateTags`
|
886
|
+
#
|
853
887
|
#
|
854
888
|
#
|
855
889
|
# [1]: https://docs.aws.amazon.com/resourcegroupstagging/latest/APIReference/supported-services.html
|
@@ -860,12 +894,12 @@ module Aws::ResourceGroupsTaggingAPI
|
|
860
894
|
# tags to.
|
861
895
|
#
|
862
896
|
# An ARN (Amazon Resource Name) uniquely identifies a resource. For more
|
863
|
-
# information, see [Amazon Resource Names (ARNs) and
|
864
|
-
# Namespaces][1] in the *
|
897
|
+
# information, see [Amazon Resource Names (ARNs) and Amazon Web Services
|
898
|
+
# Service Namespaces][1] in the *Amazon Web Services General Reference*.
|
865
899
|
#
|
866
900
|
#
|
867
901
|
#
|
868
|
-
# [1]:
|
902
|
+
# [1]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html
|
869
903
|
#
|
870
904
|
# @option params [required, Hash<String,String>] :tags
|
871
905
|
# Specifies a list of tags that you want to add to the specified
|
@@ -910,20 +944,32 @@ module Aws::ResourceGroupsTaggingAPI
|
|
910
944
|
# for removing tags. For more information, see the documentation for
|
911
945
|
# the service whose resource you want to untag.
|
912
946
|
#
|
913
|
-
# * You can only tag resources that are located in the specified
|
914
|
-
# Region for the calling
|
947
|
+
# * You can only tag resources that are located in the specified Amazon
|
948
|
+
# Web Services Region for the calling Amazon Web Services account.
|
949
|
+
#
|
950
|
+
# **Minimum permissions**
|
951
|
+
#
|
952
|
+
# In addition to the `tag:UntagResources` permission required by this
|
953
|
+
# operation, you must also have the remove tags permission defined by
|
954
|
+
# the service that created the resource. For example, to remove the tags
|
955
|
+
# from an Amazon EC2 instance using the `UntagResources` operation, you
|
956
|
+
# must have both of the following permissions:
|
957
|
+
#
|
958
|
+
# * `tag:UntagResource`
|
959
|
+
#
|
960
|
+
# * `ec2:DeleteTags`
|
915
961
|
#
|
916
962
|
# @option params [required, Array<String>] :resource_arn_list
|
917
963
|
# Specifies a list of ARNs of the resources that you want to remove tags
|
918
964
|
# from.
|
919
965
|
#
|
920
966
|
# An ARN (Amazon Resource Name) uniquely identifies a resource. For more
|
921
|
-
# information, see [Amazon Resource Names (ARNs) and
|
922
|
-
# Namespaces][1] in the *
|
967
|
+
# information, see [Amazon Resource Names (ARNs) and Amazon Web Services
|
968
|
+
# Service Namespaces][1] in the *Amazon Web Services General Reference*.
|
923
969
|
#
|
924
970
|
#
|
925
971
|
#
|
926
|
-
# [1]:
|
972
|
+
# [1]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html
|
927
973
|
#
|
928
974
|
# @option params [required, Array<String>] :tag_keys
|
929
975
|
# Specifies a list of tag keys that you want to remove from the
|
@@ -969,7 +1015,7 @@ module Aws::ResourceGroupsTaggingAPI
|
|
969
1015
|
params: params,
|
970
1016
|
config: config)
|
971
1017
|
context[:gem_name] = 'aws-sdk-resourcegroupstaggingapi'
|
972
|
-
context[:gem_version] = '1.
|
1018
|
+
context[:gem_version] = '1.46.0'
|
973
1019
|
Seahorse::Client::Request.new(handlers, context)
|
974
1020
|
end
|
975
1021
|
|
@@ -60,19 +60,19 @@ module Aws::ResourceGroupsTaggingAPI
|
|
60
60
|
#
|
61
61
|
# * You must meet the prerequisites for using tag policies. For
|
62
62
|
# information, see [Prerequisites and Permissions for Using Tag
|
63
|
-
# Policies][1] in the *
|
63
|
+
# Policies][1] in the *Organizations User Guide.*
|
64
64
|
#
|
65
65
|
# * You must enable the tag policies service principal
|
66
|
-
# (`tagpolicies.tag.amazonaws.com`) to integrate with
|
67
|
-
#
|
66
|
+
# (`tagpolicies.tag.amazonaws.com`) to integrate with Organizations
|
67
|
+
# For information, see [EnableAWSServiceAccess][2].
|
68
68
|
#
|
69
69
|
# * You must have a tag policy attached to the organization root, an OU,
|
70
70
|
# or an account.
|
71
71
|
#
|
72
72
|
#
|
73
73
|
#
|
74
|
-
# [1]:
|
75
|
-
# [2]:
|
74
|
+
# [1]: https://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_policies_tag-policies-prereqs.html
|
75
|
+
# [2]: https://docs.aws.amazon.com/organizations/latest/APIReference/API_EnableAWSServiceAccess.html
|
76
76
|
#
|
77
77
|
# @!attribute [rw] message
|
78
78
|
# @return [String]
|
@@ -130,34 +130,34 @@ module Aws::ResourceGroupsTaggingAPI
|
|
130
130
|
# Information about the errors that are returned for each failed
|
131
131
|
# resource. This information can include `InternalServiceException` and
|
132
132
|
# `InvalidParameterException` errors. It can also include any valid
|
133
|
-
# error code returned by the
|
134
|
-
# the ARN key represents.
|
133
|
+
# error code returned by the Amazon Web Services service that hosts the
|
134
|
+
# resource that the ARN key represents.
|
135
135
|
#
|
136
136
|
# The following are common error codes that you might receive from other
|
137
|
-
#
|
137
|
+
# Amazon Web Services services:
|
138
138
|
#
|
139
139
|
# * **InternalServiceException** – This can mean that the Resource
|
140
|
-
# Groups Tagging API didn't receive a response from another
|
141
|
-
# service. It can also mean
|
142
|
-
# not supported by the Resource Groups Tagging API. In
|
143
|
-
# it's safe to retry the request and then call
|
144
|
-
# verify the changes.
|
140
|
+
# Groups Tagging API didn't receive a response from another Amazon
|
141
|
+
# Web Services service. It can also mean that the resource type in the
|
142
|
+
# request is not supported by the Resource Groups Tagging API. In
|
143
|
+
# these cases, it's safe to retry the request and then call
|
144
|
+
# [GetResources][1] to verify the changes.
|
145
145
|
#
|
146
146
|
# * **AccessDeniedException** – This can mean that you need permission
|
147
|
-
# to
|
148
|
-
# resource. For example, to use the Resource Groups
|
149
|
-
# a CloudWatch alarm resource, you need
|
150
|
-
# `TagResources` ][2] *and* [ `TagResource`
|
151
|
-
# API.
|
147
|
+
# to call the tagging operations in the Amazon Web Services service
|
148
|
+
# that contains the resource. For example, to use the Resource Groups
|
149
|
+
# Tagging API to tag a Amazon CloudWatch alarm resource, you need
|
150
|
+
# permission to call both [ `TagResources` ][2] *and* [ `TagResource`
|
151
|
+
# ][3] in the CloudWatch API.
|
152
152
|
#
|
153
|
-
# For more information on errors that are generated from other
|
154
|
-
# services, see the documentation for that service.
|
153
|
+
# For more information on errors that are generated from other Amazon
|
154
|
+
# Web Services services, see the documentation for that service.
|
155
155
|
#
|
156
156
|
#
|
157
157
|
#
|
158
|
-
# [1]:
|
159
|
-
# [2]:
|
160
|
-
# [3]:
|
158
|
+
# [1]: https://docs.aws.amazon.com/resourcegroupstagging/latest/APIReference/API_GetResources.html
|
159
|
+
# [2]: https://docs.aws.amazon.com/resourcegroupstagging/latest/APIReference/API_TagResources.html
|
160
|
+
# [3]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_TagResource.html
|
161
161
|
#
|
162
162
|
# @!attribute [rw] status_code
|
163
163
|
# The HTTP status code of the common error.
|
@@ -166,8 +166,8 @@ module Aws::ResourceGroupsTaggingAPI
|
|
166
166
|
# @!attribute [rw] error_code
|
167
167
|
# The code of the common error. Valid values include
|
168
168
|
# `InternalServiceException`, `InvalidParameterException`, and any
|
169
|
-
# valid error code returned by the
|
170
|
-
# that you want to tag.
|
169
|
+
# valid error code returned by the Amazon Web Services service that
|
170
|
+
# hosts the resource that you want to tag.
|
171
171
|
# @return [String]
|
172
172
|
#
|
173
173
|
# @!attribute [rw] error_message
|
@@ -205,9 +205,9 @@ module Aws::ResourceGroupsTaggingAPI
|
|
205
205
|
# @return [Array<String>]
|
206
206
|
#
|
207
207
|
# @!attribute [rw] region_filters
|
208
|
-
# Specifies a list of
|
209
|
-
# this parameter, the count of returned noncompliant
|
210
|
-
# includes only resources in the specified Regions.
|
208
|
+
# Specifies a list of Amazon Web Services Regions to limit the output
|
209
|
+
# to. If you use this parameter, the count of returned noncompliant
|
210
|
+
# resources includes only resources in the specified Regions.
|
211
211
|
# @return [Array<String>]
|
212
212
|
#
|
213
213
|
# @!attribute [rw] resource_type_filters
|
@@ -220,15 +220,17 @@ module Aws::ResourceGroupsTaggingAPI
|
|
220
220
|
#
|
221
221
|
# The string for each service name and resource type is the same as
|
222
222
|
# that embedded in a resource's Amazon Resource Name (ARN). Consult
|
223
|
-
# the
|
223
|
+
# the <i> <a
|
224
|
+
# href="https://docs.aws.amazon.com/general/latest/gr/">Amazon Web
|
225
|
+
# Services General Reference</a> </i> for the following:
|
224
226
|
#
|
225
|
-
# * For a list of service name strings, see [
|
226
|
-
# Namespaces][1].
|
227
|
+
# * For a list of service name strings, see [Amazon Web Services
|
228
|
+
# Service Namespaces][1].
|
227
229
|
#
|
228
230
|
# * For resource type strings, see [Example ARNs][2].
|
229
231
|
#
|
230
232
|
# * For more information about ARNs, see [Amazon Resource Names (ARNs)
|
231
|
-
# and
|
233
|
+
# and Amazon Web Services Service Namespaces][3].
|
232
234
|
#
|
233
235
|
# You can specify multiple resource types by using a comma separated
|
234
236
|
# array. The array can include up to 100 items. Note that the length
|
@@ -329,10 +331,10 @@ module Aws::ResourceGroupsTaggingAPI
|
|
329
331
|
#
|
330
332
|
# @!attribute [rw] tag_filters
|
331
333
|
# Specifies a list of TagFilters (keys and values) to restrict the
|
332
|
-
# output to only those resources that have the specified
|
333
|
-
# included, the specified
|
334
|
-
# with values optional. A request can include up to 50
|
335
|
-
# key can include up to 20 values.
|
334
|
+
# output to only those resources that have tags with the specified
|
335
|
+
# keys and, if included, the specified values. Each `TagFilter` must
|
336
|
+
# contain a key with values optional. A request can include up to 50
|
337
|
+
# keys, and each key can include up to 20 values.
|
336
338
|
#
|
337
339
|
# Note the following when deciding how to use TagFilters:
|
338
340
|
#
|
@@ -345,11 +347,11 @@ module Aws::ResourceGroupsTaggingAPI
|
|
345
347
|
# response returns only those resources that satisfy all filters.
|
346
348
|
#
|
347
349
|
# * If you specify a filter that contains more than one value for a
|
348
|
-
# key, the response returns resources that match any of the
|
350
|
+
# key, the response returns resources that match *any* of the
|
349
351
|
# specified values for that key.
|
350
352
|
#
|
351
|
-
# * If you don't specify
|
352
|
-
# resources that are tagged with that key
|
353
|
+
# * If you don't specify a value for a key, the response returns all
|
354
|
+
# resources that are tagged with that key, with any or no value.
|
353
355
|
#
|
354
356
|
# For example, for the following filters: `filter1=
|
355
357
|
# \{keyA,\{value1\}\}`, `filter2=\{keyB,\{value2,value3,value4\}\}`,
|
@@ -378,7 +380,8 @@ module Aws::ResourceGroupsTaggingAPI
|
|
378
380
|
# @return [Integer]
|
379
381
|
#
|
380
382
|
# @!attribute [rw] tags_per_page
|
381
|
-
#
|
383
|
+
# Amazon Web Services recommends using `ResourcesPerPage` instead of
|
384
|
+
# this parameter.
|
382
385
|
#
|
383
386
|
# A limit that restricts the number of tags (key and value pairs)
|
384
387
|
# returned by `GetResources` in paginated output. A resource with no
|
@@ -408,19 +411,21 @@ module Aws::ResourceGroupsTaggingAPI
|
|
408
411
|
# of `ec2:instance` returns only EC2 instances.
|
409
412
|
#
|
410
413
|
# The string for each service name and resource type is the same as
|
411
|
-
# that embedded in a resource's Amazon Resource Name (ARN).
|
412
|
-
#
|
413
|
-
#
|
414
|
-
# For more information about ARNs, see [Amazon Resource Names (ARNs)
|
415
|
-
# and AWS Service Namespaces][1].
|
414
|
+
# that embedded in a resource's Amazon Resource Name (ARN). For the
|
415
|
+
# list of services whose resources you can use in this parameter, see
|
416
|
+
# [Services that support the Resource Groups Tagging API][1].
|
416
417
|
#
|
417
418
|
# You can specify multiple resource types by using an array. The array
|
418
419
|
# can include up to 100 items. Note that the length constraint
|
419
|
-
# requirement applies to each resource type filter.
|
420
|
+
# requirement applies to each resource type filter. For example, the
|
421
|
+
# following string would limit the response to only Amazon EC2
|
422
|
+
# instances, Amazon S3 buckets, or any Audit Manager resource:
|
420
423
|
#
|
424
|
+
# `ec2:instance,s3:bucket,auditmanager`
|
421
425
|
#
|
422
426
|
#
|
423
|
-
#
|
427
|
+
#
|
428
|
+
# [1]: https://docs.aws.amazon.com/resourcegroupstagging/latest/APIReference/supported-services.html
|
424
429
|
# @return [Array<String>]
|
425
430
|
#
|
426
431
|
# @!attribute [rw] include_compliance_details
|
@@ -450,12 +455,13 @@ module Aws::ResourceGroupsTaggingAPI
|
|
450
455
|
# response.
|
451
456
|
#
|
452
457
|
# An ARN (Amazon Resource Name) uniquely identifies a resource. For
|
453
|
-
# more information, see [Amazon Resource Names (ARNs) and
|
454
|
-
# Namespaces][1] in the *
|
458
|
+
# more information, see [Amazon Resource Names (ARNs) and Amazon Web
|
459
|
+
# Services Service Namespaces][1] in the *Amazon Web Services General
|
460
|
+
# Reference*.
|
455
461
|
#
|
456
462
|
#
|
457
463
|
#
|
458
|
-
# [1]:
|
464
|
+
# [1]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html
|
459
465
|
# @return [Array<String>]
|
460
466
|
#
|
461
467
|
# @see http://docs.aws.amazon.com/goto/WebAPI/resourcegroupstaggingapi-2017-01-26/GetResourcesInput AWS API Documentation
|
@@ -482,7 +488,7 @@ module Aws::ResourceGroupsTaggingAPI
|
|
482
488
|
#
|
483
489
|
# @!attribute [rw] resource_tag_mapping_list
|
484
490
|
# A list of resource ARNs and the tags (keys and values) associated
|
485
|
-
# with
|
491
|
+
# with each.
|
486
492
|
# @return [Array<Types::ResourceTagMapping>]
|
487
493
|
#
|
488
494
|
# @see http://docs.aws.amazon.com/goto/WebAPI/resourcegroupstaggingapi-2017-01-26/GetResourcesOutput AWS API Documentation
|
@@ -523,7 +529,7 @@ module Aws::ResourceGroupsTaggingAPI
|
|
523
529
|
# @return [String]
|
524
530
|
#
|
525
531
|
# @!attribute [rw] tag_keys
|
526
|
-
# A list of all tag keys in the
|
532
|
+
# A list of all tag keys in the Amazon Web Services account.
|
527
533
|
# @return [Array<String>]
|
528
534
|
#
|
529
535
|
# @see http://docs.aws.amazon.com/goto/WebAPI/resourcegroupstaggingapi-2017-01-26/GetTagKeysOutput AWS API Documentation
|
@@ -551,8 +557,8 @@ module Aws::ResourceGroupsTaggingAPI
|
|
551
557
|
#
|
552
558
|
# @!attribute [rw] key
|
553
559
|
# Specifies the tag key for which you want to list all existing values
|
554
|
-
# that are currently used in the specified
|
555
|
-
#
|
560
|
+
# that are currently used in the specified Amazon Web Services Region
|
561
|
+
# for the calling account.
|
556
562
|
# @return [String]
|
557
563
|
#
|
558
564
|
# @see http://docs.aws.amazon.com/goto/WebAPI/resourcegroupstaggingapi-2017-01-26/GetTagValuesInput AWS API Documentation
|
@@ -573,7 +579,7 @@ module Aws::ResourceGroupsTaggingAPI
|
|
573
579
|
#
|
574
580
|
# @!attribute [rw] tag_values
|
575
581
|
# A list of all tag values for the specified key currently used in the
|
576
|
-
# specified
|
582
|
+
# specified Amazon Web Services Region for the calling account.
|
577
583
|
# @return [Array<String>]
|
578
584
|
#
|
579
585
|
# @see http://docs.aws.amazon.com/goto/WebAPI/resourcegroupstaggingapi-2017-01-26/GetTagValuesOutput AWS API Documentation
|
@@ -611,11 +617,11 @@ module Aws::ResourceGroupsTaggingAPI
|
|
611
617
|
#
|
612
618
|
# * You can't access the Amazon S3 bucket for report storage. For more
|
613
619
|
# information, see [Additional Requirements for Organization-wide Tag
|
614
|
-
# Compliance Reports][1] in the *
|
620
|
+
# Compliance Reports][1] in the *Organizations User Guide.*
|
615
621
|
#
|
616
622
|
#
|
617
623
|
#
|
618
|
-
# [1]:
|
624
|
+
# [1]: https://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_policies_tag-policies-prereqs.html#bucket-policies-org-report
|
619
625
|
#
|
620
626
|
# @!attribute [rw] message
|
621
627
|
# @return [String]
|
@@ -650,7 +656,8 @@ module Aws::ResourceGroupsTaggingAPI
|
|
650
656
|
# @return [String]
|
651
657
|
#
|
652
658
|
# @!attribute [rw] tags
|
653
|
-
# The tags that have been applied to one or more
|
659
|
+
# The tags that have been applied to one or more Amazon Web Services
|
660
|
+
# resources.
|
654
661
|
# @return [Array<Types::Tag>]
|
655
662
|
#
|
656
663
|
# @!attribute [rw] compliance_details
|
@@ -707,12 +714,12 @@ module Aws::ResourceGroupsTaggingAPI
|
|
707
714
|
#
|
708
715
|
# @!attribute [rw] target_id
|
709
716
|
# The account identifier or the root identifier of the organization.
|
710
|
-
# If you don't know the root ID, you can call the
|
717
|
+
# If you don't know the root ID, you can call the Organizations
|
711
718
|
# [ListRoots][1] API.
|
712
719
|
#
|
713
720
|
#
|
714
721
|
#
|
715
|
-
# [1]:
|
722
|
+
# [1]: https://docs.aws.amazon.com/organizations/latest/APIReference/API_ListRoots.html
|
716
723
|
# @return [String]
|
717
724
|
#
|
718
725
|
# @!attribute [rw] target_id_type
|
@@ -720,11 +727,11 @@ module Aws::ResourceGroupsTaggingAPI
|
|
720
727
|
# @return [String]
|
721
728
|
#
|
722
729
|
# @!attribute [rw] region
|
723
|
-
# The
|
730
|
+
# The Amazon Web Services Region that the summary applies to.
|
724
731
|
# @return [String]
|
725
732
|
#
|
726
733
|
# @!attribute [rw] resource_type
|
727
|
-
# The
|
734
|
+
# The Amazon Web Services resource type.
|
728
735
|
# @return [String]
|
729
736
|
#
|
730
737
|
# @!attribute [rw] non_compliant_resources
|
@@ -744,14 +751,15 @@ module Aws::ResourceGroupsTaggingAPI
|
|
744
751
|
include Aws::Structure
|
745
752
|
end
|
746
753
|
|
747
|
-
# The metadata that you apply to
|
748
|
-
# and organize them. Each tag consists of a key and a
|
749
|
-
# which you define. For more information, see [Tagging
|
750
|
-
# in the *
|
754
|
+
# The metadata that you apply to Amazon Web Services resources to help
|
755
|
+
# you categorize and organize them. Each tag consists of a key and a
|
756
|
+
# value, both of which you define. For more information, see [Tagging
|
757
|
+
# Amazon Web Services Resources][1] in the *Amazon Web Services General
|
758
|
+
# Reference*.
|
751
759
|
#
|
752
760
|
#
|
753
761
|
#
|
754
|
-
# [1]:
|
762
|
+
# [1]: https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html
|
755
763
|
#
|
756
764
|
# @!attribute [rw] key
|
757
765
|
# One part of a key-value pair that makes up a tag. A key is a general
|
@@ -819,12 +827,13 @@ module Aws::ResourceGroupsTaggingAPI
|
|
819
827
|
# tags to.
|
820
828
|
#
|
821
829
|
# An ARN (Amazon Resource Name) uniquely identifies a resource. For
|
822
|
-
# more information, see [Amazon Resource Names (ARNs) and
|
823
|
-
# Namespaces][1] in the *
|
830
|
+
# more information, see [Amazon Resource Names (ARNs) and Amazon Web
|
831
|
+
# Services Service Namespaces][1] in the *Amazon Web Services General
|
832
|
+
# Reference*.
|
824
833
|
#
|
825
834
|
#
|
826
835
|
#
|
827
|
-
# [1]:
|
836
|
+
# [1]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html
|
828
837
|
# @return [Array<String>]
|
829
838
|
#
|
830
839
|
# @!attribute [rw] tags
|
@@ -883,12 +892,13 @@ module Aws::ResourceGroupsTaggingAPI
|
|
883
892
|
# tags from.
|
884
893
|
#
|
885
894
|
# An ARN (Amazon Resource Name) uniquely identifies a resource. For
|
886
|
-
# more information, see [Amazon Resource Names (ARNs) and
|
887
|
-
# Namespaces][1] in the *
|
895
|
+
# more information, see [Amazon Resource Names (ARNs) and Amazon Web
|
896
|
+
# Services Service Namespaces][1] in the *Amazon Web Services General
|
897
|
+
# Reference*.
|
888
898
|
#
|
889
899
|
#
|
890
900
|
#
|
891
|
-
# [1]:
|
901
|
+
# [1]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html
|
892
902
|
# @return [Array<String>]
|
893
903
|
#
|
894
904
|
# @!attribute [rw] tag_keys
|
metadata
CHANGED
@@ -1,14 +1,14 @@
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
2
2
|
name: aws-sdk-resourcegroupstaggingapi
|
3
3
|
version: !ruby/object:Gem::Version
|
4
|
-
version: 1.
|
4
|
+
version: 1.46.0
|
5
5
|
platform: ruby
|
6
6
|
authors:
|
7
7
|
- Amazon Web Services
|
8
8
|
autorequire:
|
9
9
|
bindir: bin
|
10
10
|
cert_chain: []
|
11
|
-
date:
|
11
|
+
date: 2022-02-03 00:00:00.000000000 Z
|
12
12
|
dependencies:
|
13
13
|
- !ruby/object:Gem::Dependency
|
14
14
|
name: aws-sdk-core
|
@@ -19,7 +19,7 @@ dependencies:
|
|
19
19
|
version: '3'
|
20
20
|
- - ">="
|
21
21
|
- !ruby/object:Gem::Version
|
22
|
-
version: 3.
|
22
|
+
version: 3.126.0
|
23
23
|
type: :runtime
|
24
24
|
prerelease: false
|
25
25
|
version_requirements: !ruby/object:Gem::Requirement
|
@@ -29,7 +29,7 @@ dependencies:
|
|
29
29
|
version: '3'
|
30
30
|
- - ">="
|
31
31
|
- !ruby/object:Gem::Version
|
32
|
-
version: 3.
|
32
|
+
version: 3.126.0
|
33
33
|
- !ruby/object:Gem::Dependency
|
34
34
|
name: aws-sigv4
|
35
35
|
requirement: !ruby/object:Gem::Requirement
|