aws-sdk-resourcegroupstaggingapi 1.41.0 → 1.45.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/CHANGELOG.md +20 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-resourcegroupstaggingapi/client.rb +101 -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: 6f5db19ba5e17a6b8b3dd46f8a49e1d11cbd723944e8544304e839055feb7efe
|
|
4
|
+
data.tar.gz: af4bdd8e7deb4dd93955558da3b6dbfc487020bb2923e8f2c326890aa382bdeb
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: 8b303ac2c22c2a8d56613bd8c41599aef0a6f58327d0b44836f44152643bb34fbd9a32ecba3c079be8a8b62966f5f208f48a3622d44a08c3939162394a85dd18
|
|
7
|
+
data.tar.gz: 3473cdc77b5e77e943c367f6479cd5ad0df9e56e77fae4d9aadd7a94959f195dc24a2c3160b3a7e74340dc223d69756217f0f4e23b790f1606fc12ba8aa5eb8a
|
data/CHANGELOG.md
CHANGED
|
@@ -1,6 +1,26 @@
|
|
|
1
1
|
Unreleased Changes
|
|
2
2
|
------------------
|
|
3
3
|
|
|
4
|
+
1.45.0 (2021-12-21)
|
|
5
|
+
------------------
|
|
6
|
+
|
|
7
|
+
* Feature - Code Generated Changes, see `./build_tools` or `aws-sdk-core`'s CHANGELOG.md for details.
|
|
8
|
+
|
|
9
|
+
1.44.0 (2021-11-30)
|
|
10
|
+
------------------
|
|
11
|
+
|
|
12
|
+
* Feature - Code Generated Changes, see `./build_tools` or `aws-sdk-core`'s CHANGELOG.md for details.
|
|
13
|
+
|
|
14
|
+
1.43.0 (2021-11-05)
|
|
15
|
+
------------------
|
|
16
|
+
|
|
17
|
+
* Feature - Documentation updates and improvements.
|
|
18
|
+
|
|
19
|
+
1.42.0 (2021-11-04)
|
|
20
|
+
------------------
|
|
21
|
+
|
|
22
|
+
* Feature - Code Generated Changes, see `./build_tools` or `aws-sdk-core`'s CHANGELOG.md for details.
|
|
23
|
+
|
|
4
24
|
1.41.0 (2021-10-18)
|
|
5
25
|
------------------
|
|
6
26
|
|
data/VERSION
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
1.
|
|
1
|
+
1.45.0
|
|
@@ -27,6 +27,7 @@ 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'
|
|
30
31
|
require 'aws-sdk-core/plugins/signature_v4.rb'
|
|
31
32
|
require 'aws-sdk-core/plugins/protocols/json_rpc.rb'
|
|
32
33
|
|
|
@@ -73,6 +74,7 @@ module Aws::ResourceGroupsTaggingAPI
|
|
|
73
74
|
add_plugin(Aws::Plugins::ClientMetricsSendPlugin)
|
|
74
75
|
add_plugin(Aws::Plugins::TransferEncoding)
|
|
75
76
|
add_plugin(Aws::Plugins::HttpChecksum)
|
|
77
|
+
add_plugin(Aws::Plugins::DefaultsMode)
|
|
76
78
|
add_plugin(Aws::Plugins::SignatureV4)
|
|
77
79
|
add_plugin(Aws::Plugins::Protocols::JsonRpc)
|
|
78
80
|
|
|
@@ -119,7 +121,9 @@ module Aws::ResourceGroupsTaggingAPI
|
|
|
119
121
|
# * EC2/ECS IMDS instance profile - When used by default, the timeouts
|
|
120
122
|
# are very aggressive. Construct and pass an instance of
|
|
121
123
|
# `Aws::InstanceProfileCredentails` or `Aws::ECSCredentials` to
|
|
122
|
-
# enable retries and extended timeouts.
|
|
124
|
+
# enable retries and extended timeouts. Instance profile credential
|
|
125
|
+
# fetching can be disabled by setting ENV['AWS_EC2_METADATA_DISABLED']
|
|
126
|
+
# to true.
|
|
123
127
|
#
|
|
124
128
|
# @option options [required, String] :region
|
|
125
129
|
# The AWS region to connect to. The configured `:region` is
|
|
@@ -173,6 +177,10 @@ module Aws::ResourceGroupsTaggingAPI
|
|
|
173
177
|
# Used only in `standard` and adaptive retry modes. Specifies whether to apply
|
|
174
178
|
# a clock skew correction and retry requests with skewed client clocks.
|
|
175
179
|
#
|
|
180
|
+
# @option options [String] :defaults_mode ("legacy")
|
|
181
|
+
# See {Aws::DefaultsModeConfiguration} for a list of the
|
|
182
|
+
# accepted modes and the configuration defaults that are included.
|
|
183
|
+
#
|
|
176
184
|
# @option options [Boolean] :disable_host_prefix_injection (false)
|
|
177
185
|
# Set to true to disable SDK automatically adding host prefix
|
|
178
186
|
# to default service endpoint when available.
|
|
@@ -285,6 +293,15 @@ module Aws::ResourceGroupsTaggingAPI
|
|
|
285
293
|
# ** Please note ** When response stubbing is enabled, no HTTP
|
|
286
294
|
# requests are made, and retries are disabled.
|
|
287
295
|
#
|
|
296
|
+
# @option options [Boolean] :use_dualstack_endpoint
|
|
297
|
+
# When set to `true`, dualstack enabled endpoints (with `.aws` TLD)
|
|
298
|
+
# will be used if available.
|
|
299
|
+
#
|
|
300
|
+
# @option options [Boolean] :use_fips_endpoint
|
|
301
|
+
# When set to `true`, fips compatible endpoints will be used if available.
|
|
302
|
+
# When a `fips` region is used, the region is normalized and this config
|
|
303
|
+
# is set to `true`.
|
|
304
|
+
#
|
|
288
305
|
# @option options [Boolean] :validate_params (true)
|
|
289
306
|
# When `true`, request parameters are validated before
|
|
290
307
|
# sending the request.
|
|
@@ -296,7 +313,7 @@ module Aws::ResourceGroupsTaggingAPI
|
|
|
296
313
|
# seconds to wait when opening a HTTP session before raising a
|
|
297
314
|
# `Timeout::Error`.
|
|
298
315
|
#
|
|
299
|
-
# @option options [
|
|
316
|
+
# @option options [Float] :http_read_timeout (60) The default
|
|
300
317
|
# number of seconds to wait for response data. This value can
|
|
301
318
|
# safely be set per-request on the session.
|
|
302
319
|
#
|
|
@@ -312,6 +329,9 @@ module Aws::ResourceGroupsTaggingAPI
|
|
|
312
329
|
# disables this behaviour. This value can safely be set per
|
|
313
330
|
# request on the session.
|
|
314
331
|
#
|
|
332
|
+
# @option options [Float] :ssl_timeout (nil) Sets the SSL timeout
|
|
333
|
+
# in seconds.
|
|
334
|
+
#
|
|
315
335
|
# @option options [Boolean] :http_wire_trace (false) When `true`,
|
|
316
336
|
# HTTP debug output will be sent to the `:logger`.
|
|
317
337
|
#
|
|
@@ -367,7 +387,7 @@ module Aws::ResourceGroupsTaggingAPI
|
|
|
367
387
|
# with their tag policies.
|
|
368
388
|
#
|
|
369
389
|
# For more information on tag policies, see [Tag Policies][1] in the
|
|
370
|
-
# *
|
|
390
|
+
# *Organizations User Guide.*
|
|
371
391
|
#
|
|
372
392
|
# You can call this operation only from the organization's management
|
|
373
393
|
# account and from the us-east-1 Region.
|
|
@@ -391,9 +411,9 @@ module Aws::ResourceGroupsTaggingAPI
|
|
|
391
411
|
# target IDs.
|
|
392
412
|
#
|
|
393
413
|
# @option params [Array<String>] :region_filters
|
|
394
|
-
# Specifies a list of
|
|
395
|
-
# this parameter, the count of returned noncompliant
|
|
396
|
-
# only resources in the specified Regions.
|
|
414
|
+
# Specifies a list of Amazon Web Services Regions to limit the output
|
|
415
|
+
# to. If you use this parameter, the count of returned noncompliant
|
|
416
|
+
# resources includes only resources in the specified Regions.
|
|
397
417
|
#
|
|
398
418
|
# @option params [Array<String>] :resource_type_filters
|
|
399
419
|
# Specifies that you want the response to include information for only
|
|
@@ -404,15 +424,17 @@ module Aws::ResourceGroupsTaggingAPI
|
|
|
404
424
|
# instances.
|
|
405
425
|
#
|
|
406
426
|
# The string for each service name and resource type is the same as that
|
|
407
|
-
# embedded in a resource's Amazon Resource Name (ARN). Consult the
|
|
408
|
-
#
|
|
427
|
+
# embedded in a resource's Amazon Resource Name (ARN). Consult the <i>
|
|
428
|
+
# <a href="https://docs.aws.amazon.com/general/latest/gr/">Amazon Web
|
|
429
|
+
# Services General Reference</a> </i> for the following:
|
|
409
430
|
#
|
|
410
|
-
# * For a list of service name strings, see [
|
|
431
|
+
# * For a list of service name strings, see [Amazon Web Services Service
|
|
432
|
+
# Namespaces][1].
|
|
411
433
|
#
|
|
412
434
|
# * For resource type strings, see [Example ARNs][2].
|
|
413
435
|
#
|
|
414
436
|
# * For more information about ARNs, see [Amazon Resource Names (ARNs)
|
|
415
|
-
# and
|
|
437
|
+
# and Amazon Web Services Service Namespaces][3].
|
|
416
438
|
#
|
|
417
439
|
# You can specify multiple resource types by using a comma separated
|
|
418
440
|
# array. The array can include up to 100 items. Note that the length
|
|
@@ -486,7 +508,7 @@ module Aws::ResourceGroupsTaggingAPI
|
|
|
486
508
|
end
|
|
487
509
|
|
|
488
510
|
# Returns all the tagged or previously tagged resources that are located
|
|
489
|
-
# in the specified Region for the
|
|
511
|
+
# in the specified Amazon Web Services Region for the account.
|
|
490
512
|
#
|
|
491
513
|
# Depending on what information you want returned, you can also specify
|
|
492
514
|
# the following:
|
|
@@ -497,7 +519,7 @@ module Aws::ResourceGroupsTaggingAPI
|
|
|
497
519
|
#
|
|
498
520
|
# * Information about compliance with the account's effective tag
|
|
499
521
|
# policy. For more information on tag policies, see [Tag Policies][1]
|
|
500
|
-
# in the *
|
|
522
|
+
# in the *Organizations User Guide.*
|
|
501
523
|
#
|
|
502
524
|
# This operation supports pagination, where the response can be sent in
|
|
503
525
|
# multiple pages. You should check the `PaginationToken` response
|
|
@@ -518,10 +540,10 @@ module Aws::ResourceGroupsTaggingAPI
|
|
|
518
540
|
#
|
|
519
541
|
# @option params [Array<Types::TagFilter>] :tag_filters
|
|
520
542
|
# Specifies a list of TagFilters (keys and values) to restrict the
|
|
521
|
-
# output to only those resources that have the specified
|
|
522
|
-
# included, the specified
|
|
523
|
-
# with values optional. A request can include up to 50 keys, and
|
|
524
|
-
# key can include up to 20 values.
|
|
543
|
+
# output to only those resources that have tags with the specified keys
|
|
544
|
+
# and, if included, the specified values. Each `TagFilter` must contain
|
|
545
|
+
# a key with values optional. A request can include up to 50 keys, and
|
|
546
|
+
# each key can include up to 20 values.
|
|
525
547
|
#
|
|
526
548
|
# Note the following when deciding how to use TagFilters:
|
|
527
549
|
#
|
|
@@ -534,11 +556,11 @@ module Aws::ResourceGroupsTaggingAPI
|
|
|
534
556
|
# response returns only those resources that satisfy all filters.
|
|
535
557
|
#
|
|
536
558
|
# * If you specify a filter that contains more than one value for a key,
|
|
537
|
-
# the response returns resources that match any of the specified
|
|
559
|
+
# the response returns resources that match *any* of the specified
|
|
538
560
|
# values for that key.
|
|
539
561
|
#
|
|
540
|
-
# * If you don't specify
|
|
541
|
-
# resources that are tagged with that key
|
|
562
|
+
# * If you don't specify a value for a key, the response returns all
|
|
563
|
+
# resources that are tagged with that key, with any or no value.
|
|
542
564
|
#
|
|
543
565
|
# For example, for the following filters: `filter1=
|
|
544
566
|
# \{keyA,\{value1\}\}`, `filter2=\{keyB,\{value2,value3,value4\}\}`,
|
|
@@ -565,7 +587,8 @@ module Aws::ResourceGroupsTaggingAPI
|
|
|
565
587
|
# minimum of 1 and a maximum value of 100.
|
|
566
588
|
#
|
|
567
589
|
# @option params [Integer] :tags_per_page
|
|
568
|
-
#
|
|
590
|
+
# Amazon Web Services recommends using `ResourcesPerPage` instead of
|
|
591
|
+
# this parameter.
|
|
569
592
|
#
|
|
570
593
|
# A limit that restricts the number of tags (key and value pairs)
|
|
571
594
|
# returned by `GetResources` in paginated output. A resource with no
|
|
@@ -593,19 +616,21 @@ module Aws::ResourceGroupsTaggingAPI
|
|
|
593
616
|
# of `ec2:instance` returns only EC2 instances.
|
|
594
617
|
#
|
|
595
618
|
# The string for each service name and resource type is the same as that
|
|
596
|
-
# embedded in a resource's Amazon Resource Name (ARN).
|
|
597
|
-
#
|
|
598
|
-
#
|
|
599
|
-
# For more information about ARNs, see [Amazon Resource Names (ARNs) and
|
|
600
|
-
# AWS Service Namespaces][1].
|
|
619
|
+
# embedded in a resource's Amazon Resource Name (ARN). For the list of
|
|
620
|
+
# services whose resources you can use in this parameter, see [Services
|
|
621
|
+
# that support the Resource Groups Tagging API][1].
|
|
601
622
|
#
|
|
602
623
|
# You can specify multiple resource types by using an array. The array
|
|
603
624
|
# can include up to 100 items. Note that the length constraint
|
|
604
|
-
# requirement applies to each resource type filter.
|
|
625
|
+
# requirement applies to each resource type filter. For example, the
|
|
626
|
+
# following string would limit the response to only Amazon EC2
|
|
627
|
+
# instances, Amazon S3 buckets, or any Audit Manager resource:
|
|
605
628
|
#
|
|
629
|
+
# `ec2:instance,s3:bucket,auditmanager`
|
|
606
630
|
#
|
|
607
631
|
#
|
|
608
|
-
#
|
|
632
|
+
#
|
|
633
|
+
# [1]: https://docs.aws.amazon.com/resourcegroupstagging/latest/APIReference/supported-services.html
|
|
609
634
|
#
|
|
610
635
|
# @option params [Boolean] :include_compliance_details
|
|
611
636
|
# Specifies whether to include details regarding the compliance with the
|
|
@@ -631,12 +656,12 @@ module Aws::ResourceGroupsTaggingAPI
|
|
|
631
656
|
# generate an error; it simply isn't included in the response.
|
|
632
657
|
#
|
|
633
658
|
# An ARN (Amazon Resource Name) uniquely identifies a resource. For more
|
|
634
|
-
# information, see [Amazon Resource Names (ARNs) and
|
|
635
|
-
# Namespaces][1] in the *
|
|
659
|
+
# information, see [Amazon Resource Names (ARNs) and Amazon Web Services
|
|
660
|
+
# Service Namespaces][1] in the *Amazon Web Services General Reference*.
|
|
636
661
|
#
|
|
637
662
|
#
|
|
638
663
|
#
|
|
639
|
-
# [1]:
|
|
664
|
+
# [1]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html
|
|
640
665
|
#
|
|
641
666
|
# @return [Types::GetResourcesOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
642
667
|
#
|
|
@@ -686,8 +711,8 @@ module Aws::ResourceGroupsTaggingAPI
|
|
|
686
711
|
req.send_request(options)
|
|
687
712
|
end
|
|
688
713
|
|
|
689
|
-
# Returns all tag keys currently in use in the specified
|
|
690
|
-
# calling
|
|
714
|
+
# Returns all tag keys currently in use in the specified Amazon Web
|
|
715
|
+
# Services Region for the calling account.
|
|
691
716
|
#
|
|
692
717
|
# This operation supports pagination, where the response can be sent in
|
|
693
718
|
# multiple pages. You should check the `PaginationToken` response
|
|
@@ -731,7 +756,7 @@ module Aws::ResourceGroupsTaggingAPI
|
|
|
731
756
|
end
|
|
732
757
|
|
|
733
758
|
# Returns all tag values for the specified key that are used in the
|
|
734
|
-
# specified
|
|
759
|
+
# specified Amazon Web Services Region for the calling account.
|
|
735
760
|
#
|
|
736
761
|
# This operation supports pagination, where the response can be sent in
|
|
737
762
|
# multiple pages. You should check the `PaginationToken` response
|
|
@@ -748,8 +773,8 @@ module Aws::ResourceGroupsTaggingAPI
|
|
|
748
773
|
#
|
|
749
774
|
# @option params [required, String] :key
|
|
750
775
|
# Specifies the tag key for which you want to list all existing values
|
|
751
|
-
# that are currently used in the specified
|
|
752
|
-
#
|
|
776
|
+
# that are currently used in the specified Amazon Web Services Region
|
|
777
|
+
# for the calling account.
|
|
753
778
|
#
|
|
754
779
|
# @return [Types::GetTagValuesOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
755
780
|
#
|
|
@@ -823,13 +848,17 @@ module Aws::ResourceGroupsTaggingAPI
|
|
|
823
848
|
#
|
|
824
849
|
# * Not all resources can have tags. For a list of services with
|
|
825
850
|
# resources that support tagging using this operation, see [Services
|
|
826
|
-
# that support the Resource Groups Tagging API][1].
|
|
851
|
+
# that support the Resource Groups Tagging API][1]. If the resource
|
|
852
|
+
# doesn't yet support this operation, the resource's service might
|
|
853
|
+
# support tagging using its own API operations. For more information,
|
|
854
|
+
# refer to the documentation for that service.
|
|
827
855
|
#
|
|
828
856
|
# * Each resource can have up to 50 tags. For other limits, see [Tag
|
|
829
|
-
# Naming and Usage Conventions][2] in the *
|
|
857
|
+
# Naming and Usage Conventions][2] in the *Amazon Web Services General
|
|
858
|
+
# Reference.*
|
|
830
859
|
#
|
|
831
|
-
# * You can only tag resources that are located in the specified
|
|
832
|
-
# Region for the
|
|
860
|
+
# * You can only tag resources that are located in the specified Amazon
|
|
861
|
+
# Web Services Region for the Amazon Web Services account.
|
|
833
862
|
#
|
|
834
863
|
# * To add tags to a resource, you need the necessary permissions for
|
|
835
864
|
# the service that the resource belongs to as well as permissions for
|
|
@@ -841,6 +870,18 @@ module Aws::ResourceGroupsTaggingAPI
|
|
|
841
870
|
# you with billing and administration services. Tags are not intended to
|
|
842
871
|
# be used for private or sensitive data.
|
|
843
872
|
#
|
|
873
|
+
# **Minimum permissions**
|
|
874
|
+
#
|
|
875
|
+
# In addition to the `tag:TagResources` permission required by this
|
|
876
|
+
# operation, you must also have the tagging permission defined by the
|
|
877
|
+
# service that created the resource. For example, to tag an Amazon EC2
|
|
878
|
+
# instance using the `TagResources` operation, you must have both of the
|
|
879
|
+
# following permissions:
|
|
880
|
+
#
|
|
881
|
+
# * `tag:TagResource`
|
|
882
|
+
#
|
|
883
|
+
# * `ec2:CreateTags`
|
|
884
|
+
#
|
|
844
885
|
#
|
|
845
886
|
#
|
|
846
887
|
# [1]: https://docs.aws.amazon.com/resourcegroupstagging/latest/APIReference/supported-services.html
|
|
@@ -851,12 +892,12 @@ module Aws::ResourceGroupsTaggingAPI
|
|
|
851
892
|
# tags to.
|
|
852
893
|
#
|
|
853
894
|
# An ARN (Amazon Resource Name) uniquely identifies a resource. For more
|
|
854
|
-
# information, see [Amazon Resource Names (ARNs) and
|
|
855
|
-
# Namespaces][1] in the *
|
|
895
|
+
# information, see [Amazon Resource Names (ARNs) and Amazon Web Services
|
|
896
|
+
# Service Namespaces][1] in the *Amazon Web Services General Reference*.
|
|
856
897
|
#
|
|
857
898
|
#
|
|
858
899
|
#
|
|
859
|
-
# [1]:
|
|
900
|
+
# [1]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html
|
|
860
901
|
#
|
|
861
902
|
# @option params [required, Hash<String,String>] :tags
|
|
862
903
|
# Specifies a list of tags that you want to add to the specified
|
|
@@ -901,20 +942,32 @@ module Aws::ResourceGroupsTaggingAPI
|
|
|
901
942
|
# for removing tags. For more information, see the documentation for
|
|
902
943
|
# the service whose resource you want to untag.
|
|
903
944
|
#
|
|
904
|
-
# * You can only tag resources that are located in the specified
|
|
905
|
-
# Region for the calling
|
|
945
|
+
# * You can only tag resources that are located in the specified Amazon
|
|
946
|
+
# Web Services Region for the calling Amazon Web Services account.
|
|
947
|
+
#
|
|
948
|
+
# **Minimum permissions**
|
|
949
|
+
#
|
|
950
|
+
# In addition to the `tag:UntagResources` permission required by this
|
|
951
|
+
# operation, you must also have the remove tags permission defined by
|
|
952
|
+
# the service that created the resource. For example, to remove the tags
|
|
953
|
+
# from an Amazon EC2 instance using the `UntagResources` operation, you
|
|
954
|
+
# must have both of the following permissions:
|
|
955
|
+
#
|
|
956
|
+
# * `tag:UntagResource`
|
|
957
|
+
#
|
|
958
|
+
# * `ec2:DeleteTags`
|
|
906
959
|
#
|
|
907
960
|
# @option params [required, Array<String>] :resource_arn_list
|
|
908
961
|
# Specifies a list of ARNs of the resources that you want to remove tags
|
|
909
962
|
# from.
|
|
910
963
|
#
|
|
911
964
|
# An ARN (Amazon Resource Name) uniquely identifies a resource. For more
|
|
912
|
-
# information, see [Amazon Resource Names (ARNs) and
|
|
913
|
-
# Namespaces][1] in the *
|
|
965
|
+
# information, see [Amazon Resource Names (ARNs) and Amazon Web Services
|
|
966
|
+
# Service Namespaces][1] in the *Amazon Web Services General Reference*.
|
|
914
967
|
#
|
|
915
968
|
#
|
|
916
969
|
#
|
|
917
|
-
# [1]:
|
|
970
|
+
# [1]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html
|
|
918
971
|
#
|
|
919
972
|
# @option params [required, Array<String>] :tag_keys
|
|
920
973
|
# Specifies a list of tag keys that you want to remove from the
|
|
@@ -960,7 +1013,7 @@ module Aws::ResourceGroupsTaggingAPI
|
|
|
960
1013
|
params: params,
|
|
961
1014
|
config: config)
|
|
962
1015
|
context[:gem_name] = 'aws-sdk-resourcegroupstaggingapi'
|
|
963
|
-
context[:gem_version] = '1.
|
|
1016
|
+
context[:gem_version] = '1.45.0'
|
|
964
1017
|
Seahorse::Client::Request.new(handlers, context)
|
|
965
1018
|
end
|
|
966
1019
|
|
|
@@ -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.45.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: 2021-
|
|
11
|
+
date: 2021-12-21 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.125.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.125.0
|
|
33
33
|
- !ruby/object:Gem::Dependency
|
|
34
34
|
name: aws-sigv4
|
|
35
35
|
requirement: !ruby/object:Gem::Requirement
|