aws-sdk-resourcegroupstaggingapi 1.40.0 → 1.44.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 +91 -47
- 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: 69e048331f03a9a6334fff3a43938d2b0ebbe4be44e0da9e4d7c64fbe3172c30
|
|
4
|
+
data.tar.gz: 9724e2686a2f952071e111f4e401bd185834c54e5ecca227573cab7893438b98
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: d2eb978eed2b7d1066816ae8f17d903d78a1951ec35790420d3e6a8fce037b9900e33e4805bf95c4a0c613ff690d92abce2147dd32ecf621c7a10de74a1be872
|
|
7
|
+
data.tar.gz: 95f857a844bdcc29196421bd8a941b3c6fbbe5aca038f3870ae98180bb251a114ad06d013257223e3a2e197dd208a78825cf61630abc5537e81f26733153931e
|
data/CHANGELOG.md
CHANGED
|
@@ -1,6 +1,26 @@
|
|
|
1
1
|
Unreleased Changes
|
|
2
2
|
------------------
|
|
3
3
|
|
|
4
|
+
1.44.0 (2021-11-30)
|
|
5
|
+
------------------
|
|
6
|
+
|
|
7
|
+
* Feature - Code Generated Changes, see `./build_tools` or `aws-sdk-core`'s CHANGELOG.md for details.
|
|
8
|
+
|
|
9
|
+
1.43.0 (2021-11-05)
|
|
10
|
+
------------------
|
|
11
|
+
|
|
12
|
+
* Feature - Documentation updates and improvements.
|
|
13
|
+
|
|
14
|
+
1.42.0 (2021-11-04)
|
|
15
|
+
------------------
|
|
16
|
+
|
|
17
|
+
* Feature - Code Generated Changes, see `./build_tools` or `aws-sdk-core`'s CHANGELOG.md for details.
|
|
18
|
+
|
|
19
|
+
1.41.0 (2021-10-18)
|
|
20
|
+
------------------
|
|
21
|
+
|
|
22
|
+
* Feature - Code Generated Changes, see `./build_tools` or `aws-sdk-core`'s CHANGELOG.md for details.
|
|
23
|
+
|
|
4
24
|
1.40.0 (2021-09-01)
|
|
5
25
|
------------------
|
|
6
26
|
|
data/VERSION
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
1.
|
|
1
|
+
1.44.0
|
|
@@ -119,7 +119,9 @@ module Aws::ResourceGroupsTaggingAPI
|
|
|
119
119
|
# * EC2/ECS IMDS instance profile - When used by default, the timeouts
|
|
120
120
|
# are very aggressive. Construct and pass an instance of
|
|
121
121
|
# `Aws::InstanceProfileCredentails` or `Aws::ECSCredentials` to
|
|
122
|
-
# enable retries and extended timeouts.
|
|
122
|
+
# enable retries and extended timeouts. Instance profile credential
|
|
123
|
+
# fetching can be disabled by setting ENV['AWS_EC2_METADATA_DISABLED']
|
|
124
|
+
# to true.
|
|
123
125
|
#
|
|
124
126
|
# @option options [required, String] :region
|
|
125
127
|
# The AWS region to connect to. The configured `:region` is
|
|
@@ -285,6 +287,15 @@ module Aws::ResourceGroupsTaggingAPI
|
|
|
285
287
|
# ** Please note ** When response stubbing is enabled, no HTTP
|
|
286
288
|
# requests are made, and retries are disabled.
|
|
287
289
|
#
|
|
290
|
+
# @option options [Boolean] :use_dualstack_endpoint
|
|
291
|
+
# When set to `true`, dualstack enabled endpoints (with `.aws` TLD)
|
|
292
|
+
# will be used if available.
|
|
293
|
+
#
|
|
294
|
+
# @option options [Boolean] :use_fips_endpoint
|
|
295
|
+
# When set to `true`, fips compatible endpoints will be used if available.
|
|
296
|
+
# When a `fips` region is used, the region is normalized and this config
|
|
297
|
+
# is set to `true`.
|
|
298
|
+
#
|
|
288
299
|
# @option options [Boolean] :validate_params (true)
|
|
289
300
|
# When `true`, request parameters are validated before
|
|
290
301
|
# sending the request.
|
|
@@ -367,7 +378,7 @@ module Aws::ResourceGroupsTaggingAPI
|
|
|
367
378
|
# with their tag policies.
|
|
368
379
|
#
|
|
369
380
|
# For more information on tag policies, see [Tag Policies][1] in the
|
|
370
|
-
# *
|
|
381
|
+
# *Organizations User Guide.*
|
|
371
382
|
#
|
|
372
383
|
# You can call this operation only from the organization's management
|
|
373
384
|
# account and from the us-east-1 Region.
|
|
@@ -391,9 +402,9 @@ module Aws::ResourceGroupsTaggingAPI
|
|
|
391
402
|
# target IDs.
|
|
392
403
|
#
|
|
393
404
|
# @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.
|
|
405
|
+
# Specifies a list of Amazon Web Services Regions to limit the output
|
|
406
|
+
# to. If you use this parameter, the count of returned noncompliant
|
|
407
|
+
# resources includes only resources in the specified Regions.
|
|
397
408
|
#
|
|
398
409
|
# @option params [Array<String>] :resource_type_filters
|
|
399
410
|
# Specifies that you want the response to include information for only
|
|
@@ -404,15 +415,17 @@ module Aws::ResourceGroupsTaggingAPI
|
|
|
404
415
|
# instances.
|
|
405
416
|
#
|
|
406
417
|
# 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
|
-
#
|
|
418
|
+
# embedded in a resource's Amazon Resource Name (ARN). Consult the <i>
|
|
419
|
+
# <a href="https://docs.aws.amazon.com/general/latest/gr/">Amazon Web
|
|
420
|
+
# Services General Reference</a> </i> for the following:
|
|
409
421
|
#
|
|
410
|
-
# * For a list of service name strings, see [
|
|
422
|
+
# * For a list of service name strings, see [Amazon Web Services Service
|
|
423
|
+
# Namespaces][1].
|
|
411
424
|
#
|
|
412
425
|
# * For resource type strings, see [Example ARNs][2].
|
|
413
426
|
#
|
|
414
427
|
# * For more information about ARNs, see [Amazon Resource Names (ARNs)
|
|
415
|
-
# and
|
|
428
|
+
# and Amazon Web Services Service Namespaces][3].
|
|
416
429
|
#
|
|
417
430
|
# You can specify multiple resource types by using a comma separated
|
|
418
431
|
# array. The array can include up to 100 items. Note that the length
|
|
@@ -486,7 +499,7 @@ module Aws::ResourceGroupsTaggingAPI
|
|
|
486
499
|
end
|
|
487
500
|
|
|
488
501
|
# Returns all the tagged or previously tagged resources that are located
|
|
489
|
-
# in the specified Region for the
|
|
502
|
+
# in the specified Amazon Web Services Region for the account.
|
|
490
503
|
#
|
|
491
504
|
# Depending on what information you want returned, you can also specify
|
|
492
505
|
# the following:
|
|
@@ -497,7 +510,7 @@ module Aws::ResourceGroupsTaggingAPI
|
|
|
497
510
|
#
|
|
498
511
|
# * Information about compliance with the account's effective tag
|
|
499
512
|
# policy. For more information on tag policies, see [Tag Policies][1]
|
|
500
|
-
# in the *
|
|
513
|
+
# in the *Organizations User Guide.*
|
|
501
514
|
#
|
|
502
515
|
# This operation supports pagination, where the response can be sent in
|
|
503
516
|
# multiple pages. You should check the `PaginationToken` response
|
|
@@ -518,10 +531,10 @@ module Aws::ResourceGroupsTaggingAPI
|
|
|
518
531
|
#
|
|
519
532
|
# @option params [Array<Types::TagFilter>] :tag_filters
|
|
520
533
|
# 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.
|
|
534
|
+
# output to only those resources that have tags with the specified keys
|
|
535
|
+
# and, if included, the specified values. Each `TagFilter` must contain
|
|
536
|
+
# a key with values optional. A request can include up to 50 keys, and
|
|
537
|
+
# each key can include up to 20 values.
|
|
525
538
|
#
|
|
526
539
|
# Note the following when deciding how to use TagFilters:
|
|
527
540
|
#
|
|
@@ -534,11 +547,11 @@ module Aws::ResourceGroupsTaggingAPI
|
|
|
534
547
|
# response returns only those resources that satisfy all filters.
|
|
535
548
|
#
|
|
536
549
|
# * 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
|
|
550
|
+
# the response returns resources that match *any* of the specified
|
|
538
551
|
# values for that key.
|
|
539
552
|
#
|
|
540
|
-
# * If you don't specify
|
|
541
|
-
# resources that are tagged with that key
|
|
553
|
+
# * If you don't specify a value for a key, the response returns all
|
|
554
|
+
# resources that are tagged with that key, with any or no value.
|
|
542
555
|
#
|
|
543
556
|
# For example, for the following filters: `filter1=
|
|
544
557
|
# \{keyA,\{value1\}\}`, `filter2=\{keyB,\{value2,value3,value4\}\}`,
|
|
@@ -565,7 +578,8 @@ module Aws::ResourceGroupsTaggingAPI
|
|
|
565
578
|
# minimum of 1 and a maximum value of 100.
|
|
566
579
|
#
|
|
567
580
|
# @option params [Integer] :tags_per_page
|
|
568
|
-
#
|
|
581
|
+
# Amazon Web Services recommends using `ResourcesPerPage` instead of
|
|
582
|
+
# this parameter.
|
|
569
583
|
#
|
|
570
584
|
# A limit that restricts the number of tags (key and value pairs)
|
|
571
585
|
# returned by `GetResources` in paginated output. A resource with no
|
|
@@ -593,19 +607,21 @@ module Aws::ResourceGroupsTaggingAPI
|
|
|
593
607
|
# of `ec2:instance` returns only EC2 instances.
|
|
594
608
|
#
|
|
595
609
|
# 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].
|
|
610
|
+
# embedded in a resource's Amazon Resource Name (ARN). For the list of
|
|
611
|
+
# services whose resources you can use in this parameter, see [Services
|
|
612
|
+
# that support the Resource Groups Tagging API][1].
|
|
601
613
|
#
|
|
602
614
|
# You can specify multiple resource types by using an array. The array
|
|
603
615
|
# can include up to 100 items. Note that the length constraint
|
|
604
|
-
# requirement applies to each resource type filter.
|
|
616
|
+
# requirement applies to each resource type filter. For example, the
|
|
617
|
+
# following string would limit the response to only Amazon EC2
|
|
618
|
+
# instances, Amazon S3 buckets, or any Audit Manager resource:
|
|
605
619
|
#
|
|
620
|
+
# `ec2:instance,s3:bucket,auditmanager`
|
|
606
621
|
#
|
|
607
622
|
#
|
|
608
|
-
#
|
|
623
|
+
#
|
|
624
|
+
# [1]: https://docs.aws.amazon.com/resourcegroupstagging/latest/APIReference/supported-services.html
|
|
609
625
|
#
|
|
610
626
|
# @option params [Boolean] :include_compliance_details
|
|
611
627
|
# Specifies whether to include details regarding the compliance with the
|
|
@@ -631,12 +647,12 @@ module Aws::ResourceGroupsTaggingAPI
|
|
|
631
647
|
# generate an error; it simply isn't included in the response.
|
|
632
648
|
#
|
|
633
649
|
# An ARN (Amazon Resource Name) uniquely identifies a resource. For more
|
|
634
|
-
# information, see [Amazon Resource Names (ARNs) and
|
|
635
|
-
# Namespaces][1] in the *
|
|
650
|
+
# information, see [Amazon Resource Names (ARNs) and Amazon Web Services
|
|
651
|
+
# Service Namespaces][1] in the *Amazon Web Services General Reference*.
|
|
636
652
|
#
|
|
637
653
|
#
|
|
638
654
|
#
|
|
639
|
-
# [1]:
|
|
655
|
+
# [1]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html
|
|
640
656
|
#
|
|
641
657
|
# @return [Types::GetResourcesOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
642
658
|
#
|
|
@@ -686,8 +702,8 @@ module Aws::ResourceGroupsTaggingAPI
|
|
|
686
702
|
req.send_request(options)
|
|
687
703
|
end
|
|
688
704
|
|
|
689
|
-
# Returns all tag keys currently in use in the specified
|
|
690
|
-
# calling
|
|
705
|
+
# Returns all tag keys currently in use in the specified Amazon Web
|
|
706
|
+
# Services Region for the calling account.
|
|
691
707
|
#
|
|
692
708
|
# This operation supports pagination, where the response can be sent in
|
|
693
709
|
# multiple pages. You should check the `PaginationToken` response
|
|
@@ -731,7 +747,7 @@ module Aws::ResourceGroupsTaggingAPI
|
|
|
731
747
|
end
|
|
732
748
|
|
|
733
749
|
# Returns all tag values for the specified key that are used in the
|
|
734
|
-
# specified
|
|
750
|
+
# specified Amazon Web Services Region for the calling account.
|
|
735
751
|
#
|
|
736
752
|
# This operation supports pagination, where the response can be sent in
|
|
737
753
|
# multiple pages. You should check the `PaginationToken` response
|
|
@@ -748,8 +764,8 @@ module Aws::ResourceGroupsTaggingAPI
|
|
|
748
764
|
#
|
|
749
765
|
# @option params [required, String] :key
|
|
750
766
|
# Specifies the tag key for which you want to list all existing values
|
|
751
|
-
# that are currently used in the specified
|
|
752
|
-
#
|
|
767
|
+
# that are currently used in the specified Amazon Web Services Region
|
|
768
|
+
# for the calling account.
|
|
753
769
|
#
|
|
754
770
|
# @return [Types::GetTagValuesOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
755
771
|
#
|
|
@@ -823,13 +839,17 @@ module Aws::ResourceGroupsTaggingAPI
|
|
|
823
839
|
#
|
|
824
840
|
# * Not all resources can have tags. For a list of services with
|
|
825
841
|
# resources that support tagging using this operation, see [Services
|
|
826
|
-
# that support the Resource Groups Tagging API][1].
|
|
842
|
+
# that support the Resource Groups Tagging API][1]. If the resource
|
|
843
|
+
# doesn't yet support this operation, the resource's service might
|
|
844
|
+
# support tagging using its own API operations. For more information,
|
|
845
|
+
# refer to the documentation for that service.
|
|
827
846
|
#
|
|
828
847
|
# * Each resource can have up to 50 tags. For other limits, see [Tag
|
|
829
|
-
# Naming and Usage Conventions][2] in the *
|
|
848
|
+
# Naming and Usage Conventions][2] in the *Amazon Web Services General
|
|
849
|
+
# Reference.*
|
|
830
850
|
#
|
|
831
|
-
# * You can only tag resources that are located in the specified
|
|
832
|
-
# Region for the
|
|
851
|
+
# * You can only tag resources that are located in the specified Amazon
|
|
852
|
+
# Web Services Region for the Amazon Web Services account.
|
|
833
853
|
#
|
|
834
854
|
# * To add tags to a resource, you need the necessary permissions for
|
|
835
855
|
# the service that the resource belongs to as well as permissions for
|
|
@@ -841,6 +861,18 @@ module Aws::ResourceGroupsTaggingAPI
|
|
|
841
861
|
# you with billing and administration services. Tags are not intended to
|
|
842
862
|
# be used for private or sensitive data.
|
|
843
863
|
#
|
|
864
|
+
# **Minimum permissions**
|
|
865
|
+
#
|
|
866
|
+
# In addition to the `tag:TagResources` permission required by this
|
|
867
|
+
# operation, you must also have the tagging permission defined by the
|
|
868
|
+
# service that created the resource. For example, to tag an Amazon EC2
|
|
869
|
+
# instance using the `TagResources` operation, you must have both of the
|
|
870
|
+
# following permissions:
|
|
871
|
+
#
|
|
872
|
+
# * `tag:TagResource`
|
|
873
|
+
#
|
|
874
|
+
# * `ec2:CreateTags`
|
|
875
|
+
#
|
|
844
876
|
#
|
|
845
877
|
#
|
|
846
878
|
# [1]: https://docs.aws.amazon.com/resourcegroupstagging/latest/APIReference/supported-services.html
|
|
@@ -851,12 +883,12 @@ module Aws::ResourceGroupsTaggingAPI
|
|
|
851
883
|
# tags to.
|
|
852
884
|
#
|
|
853
885
|
# An ARN (Amazon Resource Name) uniquely identifies a resource. For more
|
|
854
|
-
# information, see [Amazon Resource Names (ARNs) and
|
|
855
|
-
# Namespaces][1] in the *
|
|
886
|
+
# information, see [Amazon Resource Names (ARNs) and Amazon Web Services
|
|
887
|
+
# Service Namespaces][1] in the *Amazon Web Services General Reference*.
|
|
856
888
|
#
|
|
857
889
|
#
|
|
858
890
|
#
|
|
859
|
-
# [1]:
|
|
891
|
+
# [1]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html
|
|
860
892
|
#
|
|
861
893
|
# @option params [required, Hash<String,String>] :tags
|
|
862
894
|
# Specifies a list of tags that you want to add to the specified
|
|
@@ -901,20 +933,32 @@ module Aws::ResourceGroupsTaggingAPI
|
|
|
901
933
|
# for removing tags. For more information, see the documentation for
|
|
902
934
|
# the service whose resource you want to untag.
|
|
903
935
|
#
|
|
904
|
-
# * You can only tag resources that are located in the specified
|
|
905
|
-
# Region for the calling
|
|
936
|
+
# * You can only tag resources that are located in the specified Amazon
|
|
937
|
+
# Web Services Region for the calling Amazon Web Services account.
|
|
938
|
+
#
|
|
939
|
+
# **Minimum permissions**
|
|
940
|
+
#
|
|
941
|
+
# In addition to the `tag:UntagResources` permission required by this
|
|
942
|
+
# operation, you must also have the remove tags permission defined by
|
|
943
|
+
# the service that created the resource. For example, to remove the tags
|
|
944
|
+
# from an Amazon EC2 instance using the `UntagResources` operation, you
|
|
945
|
+
# must have both of the following permissions:
|
|
946
|
+
#
|
|
947
|
+
# * `tag:UntagResource`
|
|
948
|
+
#
|
|
949
|
+
# * `ec2:DeleteTags`
|
|
906
950
|
#
|
|
907
951
|
# @option params [required, Array<String>] :resource_arn_list
|
|
908
952
|
# Specifies a list of ARNs of the resources that you want to remove tags
|
|
909
953
|
# from.
|
|
910
954
|
#
|
|
911
955
|
# An ARN (Amazon Resource Name) uniquely identifies a resource. For more
|
|
912
|
-
# information, see [Amazon Resource Names (ARNs) and
|
|
913
|
-
# Namespaces][1] in the *
|
|
956
|
+
# information, see [Amazon Resource Names (ARNs) and Amazon Web Services
|
|
957
|
+
# Service Namespaces][1] in the *Amazon Web Services General Reference*.
|
|
914
958
|
#
|
|
915
959
|
#
|
|
916
960
|
#
|
|
917
|
-
# [1]:
|
|
961
|
+
# [1]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html
|
|
918
962
|
#
|
|
919
963
|
# @option params [required, Array<String>] :tag_keys
|
|
920
964
|
# Specifies a list of tag keys that you want to remove from the
|
|
@@ -960,7 +1004,7 @@ module Aws::ResourceGroupsTaggingAPI
|
|
|
960
1004
|
params: params,
|
|
961
1005
|
config: config)
|
|
962
1006
|
context[:gem_name] = 'aws-sdk-resourcegroupstaggingapi'
|
|
963
|
-
context[:gem_version] = '1.
|
|
1007
|
+
context[:gem_version] = '1.44.0'
|
|
964
1008
|
Seahorse::Client::Request.new(handlers, context)
|
|
965
1009
|
end
|
|
966
1010
|
|
|
@@ -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.44.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-11-30 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.122.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.122.0
|
|
33
33
|
- !ruby/object:Gem::Dependency
|
|
34
34
|
name: aws-sigv4
|
|
35
35
|
requirement: !ruby/object:Gem::Requirement
|