aws-sdk-resourcegroupstaggingapi 1.31.0 → 1.36.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
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 24a882b729c4ef2df14e84d674b893a8e8f24ae57ba8ab3ac732cb1ca1d1c55f
|
4
|
+
data.tar.gz: 2b225eb8852ca42cde5372c19313f223f3255d4e1e6a1984eeb3baa21bd28fb2
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: b0609c6cba8a53d6f68fb18ebd566797f348ad59af02b2cfb37c9c130c7f1a19416a2e8e24f3403ecbc548d8a4359d6e9b33c3ccd0c799ef454415d07b085ac3
|
7
|
+
data.tar.gz: bfad9d817ae9a9551983bb2e85d4f08a2796146f4a476a8f7af4ac12f2efc8af2cad343c1a099b1cbe0b1ad3a4a09d5007bf68b656a08a62ea00ab633b899455
|
@@ -7,6 +7,7 @@
|
|
7
7
|
#
|
8
8
|
# WARNING ABOUT GENERATED CODE
|
9
9
|
|
10
|
+
|
10
11
|
require 'aws-sdk-core'
|
11
12
|
require 'aws-sigv4'
|
12
13
|
|
@@ -47,6 +48,6 @@ require_relative 'aws-sdk-resourcegroupstaggingapi/customizations'
|
|
47
48
|
# @!group service
|
48
49
|
module Aws::ResourceGroupsTaggingAPI
|
49
50
|
|
50
|
-
GEM_VERSION = '1.
|
51
|
+
GEM_VERSION = '1.36.0'
|
51
52
|
|
52
53
|
end
|
@@ -339,7 +339,7 @@ module Aws::ResourceGroupsTaggingAPI
|
|
339
339
|
|
340
340
|
# Describes the status of the `StartReportCreation` operation.
|
341
341
|
#
|
342
|
-
# You can call this operation only from the organization's
|
342
|
+
# You can call this operation only from the organization's management
|
343
343
|
# account and from the us-east-1 Region.
|
344
344
|
#
|
345
345
|
# @return [Types::DescribeReportCreationOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
@@ -369,30 +369,39 @@ module Aws::ResourceGroupsTaggingAPI
|
|
369
369
|
# For more information on tag policies, see [Tag Policies][1] in the
|
370
370
|
# *AWS Organizations User Guide.*
|
371
371
|
#
|
372
|
-
# You can call this operation only from the organization's
|
372
|
+
# You can call this operation only from the organization's management
|
373
373
|
# account and from the us-east-1 Region.
|
374
374
|
#
|
375
|
+
# This operation supports pagination, where the response can be sent in
|
376
|
+
# multiple pages. You should check the `PaginationToken` response
|
377
|
+
# parameter to determine if there are additional results available to
|
378
|
+
# return. Repeat the query, passing the `PaginationToken` response
|
379
|
+
# parameter value as an input to the next request until you recieve a
|
380
|
+
# `null` value. A null value for `PaginationToken` indicates that there
|
381
|
+
# are no more results waiting to be returned.
|
375
382
|
#
|
376
383
|
#
|
377
|
-
#
|
384
|
+
#
|
385
|
+
# [1]: https://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_policies_tag-policies.html
|
378
386
|
#
|
379
387
|
# @option params [Array<String>] :target_id_filters
|
380
|
-
#
|
381
|
-
# output by. If you use this parameter, the count of returned
|
388
|
+
# Specifies target identifiers (usually, specific account IDs) to limit
|
389
|
+
# the output by. If you use this parameter, the count of returned
|
382
390
|
# noncompliant resources includes only resources with the specified
|
383
391
|
# target IDs.
|
384
392
|
#
|
385
393
|
# @option params [Array<String>] :region_filters
|
386
|
-
#
|
387
|
-
# the count of returned noncompliant resources includes
|
388
|
-
# in the specified Regions.
|
394
|
+
# Specifies a list of AWS Regions to limit the output by. If you use
|
395
|
+
# this parameter, the count of returned noncompliant resources includes
|
396
|
+
# only resources in the specified Regions.
|
389
397
|
#
|
390
398
|
# @option params [Array<String>] :resource_type_filters
|
391
|
-
#
|
392
|
-
# each resource type is
|
393
|
-
# specifying a resource type of
|
394
|
-
# (which includes EC2 instances).
|
395
|
-
# `ec2:instance` returns only EC2
|
399
|
+
# Specifies that you want the response to include information for only
|
400
|
+
# resources of the specified types. The format of each resource type is
|
401
|
+
# `service[:resourceType]`. For example, specifying a resource type of
|
402
|
+
# `ec2` returns all Amazon EC2 resources (which includes EC2 instances).
|
403
|
+
# Specifying a resource type of `ec2:instance` returns only EC2
|
404
|
+
# instances.
|
396
405
|
#
|
397
406
|
# The string for each service name and resource type is the same as that
|
398
407
|
# embedded in a resource's Amazon Resource Name (ARN). Consult the *AWS
|
@@ -405,34 +414,37 @@ module Aws::ResourceGroupsTaggingAPI
|
|
405
414
|
# * For more information about ARNs, see [Amazon Resource Names (ARNs)
|
406
415
|
# and AWS Service Namespaces][3].
|
407
416
|
#
|
408
|
-
# You can specify multiple resource types by using
|
409
|
-
# can include up to 100 items. Note that the length
|
410
|
-
# requirement applies to each resource type filter.
|
417
|
+
# You can specify multiple resource types by using a comma separated
|
418
|
+
# array. The array can include up to 100 items. Note that the length
|
419
|
+
# constraint requirement applies to each resource type filter.
|
411
420
|
#
|
412
421
|
#
|
413
422
|
#
|
414
|
-
# [1]:
|
415
|
-
# [2]:
|
416
|
-
# [3]:
|
423
|
+
# [1]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html#genref-aws-service-namespaces
|
424
|
+
# [2]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html#arns-syntax
|
425
|
+
# [3]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html
|
417
426
|
#
|
418
427
|
# @option params [Array<String>] :tag_key_filters
|
419
|
-
#
|
420
|
-
# the
|
421
|
-
#
|
428
|
+
# Specifies that you want the response to include information for only
|
429
|
+
# resources that have tags with the specified tag keys. If you use this
|
430
|
+
# parameter, the count of returned noncompliant resources includes only
|
431
|
+
# resources that have the specified tag keys.
|
422
432
|
#
|
423
433
|
# @option params [Array<String>] :group_by
|
424
|
-
#
|
425
|
-
# If supplied, the counts are sorted by those attributes.
|
434
|
+
# Specifies a list of attributes to group the counts of noncompliant
|
435
|
+
# resources by. If supplied, the counts are sorted by those attributes.
|
426
436
|
#
|
427
437
|
# @option params [Integer] :max_results
|
428
|
-
#
|
429
|
-
#
|
438
|
+
# Specifies the maximum number of results to be returned in each page. A
|
439
|
+
# query can return fewer than this maximum, even if there are more
|
440
|
+
# results still to return. You should always check the `PaginationToken`
|
441
|
+
# response value to see if there are more results. You can specify a
|
442
|
+
# minimum of 1 and a maximum value of 100.
|
430
443
|
#
|
431
444
|
# @option params [String] :pagination_token
|
432
|
-
#
|
433
|
-
#
|
434
|
-
#
|
435
|
-
# additional page of data.
|
445
|
+
# Specifies a `PaginationToken` response value from a previous request
|
446
|
+
# to indicate that you want the next page of results. Leave this
|
447
|
+
# parameter empty in your initial request.
|
436
448
|
#
|
437
449
|
# @return [Types::GetComplianceSummaryOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
438
450
|
#
|
@@ -487,77 +499,77 @@ module Aws::ResourceGroupsTaggingAPI
|
|
487
499
|
# policy. For more information on tag policies, see [Tag Policies][1]
|
488
500
|
# in the *AWS Organizations User Guide.*
|
489
501
|
#
|
490
|
-
#
|
491
|
-
#
|
492
|
-
#
|
493
|
-
#
|
502
|
+
# This operation supports pagination, where the response can be sent in
|
503
|
+
# multiple pages. You should check the `PaginationToken` response
|
504
|
+
# parameter to determine if there are additional results available to
|
505
|
+
# return. Repeat the query, passing the `PaginationToken` response
|
506
|
+
# parameter value as an input to the next request until you recieve a
|
507
|
+
# `null` value. A null value for `PaginationToken` indicates that there
|
508
|
+
# are no more results waiting to be returned.
|
494
509
|
#
|
495
|
-
# </note>
|
496
510
|
#
|
497
511
|
#
|
498
|
-
#
|
499
|
-
# [1]: http://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_policies_tag-policies.html
|
512
|
+
# [1]: https://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_policies_tag-policies.html
|
500
513
|
#
|
501
514
|
# @option params [String] :pagination_token
|
502
|
-
#
|
503
|
-
#
|
504
|
-
#
|
505
|
-
# additional page of data.
|
515
|
+
# Specifies a `PaginationToken` response value from a previous request
|
516
|
+
# to indicate that you want the next page of results. Leave this
|
517
|
+
# parameter empty in your initial request.
|
506
518
|
#
|
507
519
|
# @option params [Array<Types::TagFilter>] :tag_filters
|
508
|
-
#
|
509
|
-
#
|
510
|
-
#
|
520
|
+
# Specifies a list of TagFilters (keys and values) to restrict the
|
521
|
+
# output to only those resources that have the specified tag and, if
|
522
|
+
# included, the specified value. Each `TagFilter` must contain a key
|
523
|
+
# with values optional. A request can include up to 50 keys, and each
|
524
|
+
# key can include up to 20 values.
|
511
525
|
#
|
512
526
|
# Note the following when deciding how to use TagFilters:
|
513
527
|
#
|
514
|
-
# * If you *
|
515
|
-
# resources that are currently
|
516
|
-
#
|
517
|
-
#
|
518
|
-
# resources that were ever associated with tags. Resources that
|
519
|
-
# currently don't have associated tags are shown with an empty tag
|
520
|
-
# set, like this: `"Tags": []`.
|
528
|
+
# * If you *don't* specify a `TagFilter`, the response includes all
|
529
|
+
# resources that are currently tagged or ever had a tag. Resources
|
530
|
+
# that currently don't have tags are shown with an empty tag set,
|
531
|
+
# like this: `"Tags": []`.
|
521
532
|
#
|
522
533
|
# * If you specify more than one filter in a single request, the
|
523
|
-
# response returns only those resources that satisfy all
|
524
|
-
# filters.
|
534
|
+
# response returns only those resources that satisfy all filters.
|
525
535
|
#
|
526
536
|
# * If you specify a filter that contains more than one value for a key,
|
527
537
|
# the response returns resources that match any of the specified
|
528
538
|
# values for that key.
|
529
539
|
#
|
530
540
|
# * If you don't specify any values for a key, the response returns
|
531
|
-
# resources that are tagged with that key
|
541
|
+
# resources that are tagged with that key and any or no value.
|
532
542
|
#
|
533
|
-
# For example, for filters: filter1
|
534
|
-
#
|
535
|
-
#
|
543
|
+
# For example, for the following filters: `filter1=
|
544
|
+
# \{keyA,\{value1\}\}`, `filter2=\{keyB,\{value2,value3,value4\}\}`,
|
545
|
+
# `filter3= \{keyC\}`\:
|
536
546
|
#
|
537
|
-
# * GetResources(
|
538
|
-
# key1=value1
|
547
|
+
# * `GetResources(\{filter1\})` returns resources tagged with
|
548
|
+
# `key1=value1`
|
539
549
|
#
|
540
|
-
# * GetResources(
|
541
|
-
# key2=value2 or key2=value3 or key2=value4
|
550
|
+
# * `GetResources(\{filter2\})` returns resources tagged with
|
551
|
+
# `key2=value2` or `key2=value3` or `key2=value4`
|
542
552
|
#
|
543
|
-
# * GetResources(
|
544
|
-
#
|
553
|
+
# * `GetResources(\{filter3\})` returns resources tagged with any tag
|
554
|
+
# with the key `key3`, and with any or no value
|
545
555
|
#
|
546
|
-
# * GetResources(
|
547
|
-
# tagged with (
|
548
|
-
# key2=value4) and (key3,
|
556
|
+
# * `GetResources(\{filter1,filter2,filter3\})` returns resources
|
557
|
+
# tagged with `(key1=value1) and (key2=value2 or key2=value3 or
|
558
|
+
# key2=value4) and (key3, any or no value)`
|
549
559
|
#
|
550
560
|
# @option params [Integer] :resources_per_page
|
551
|
-
#
|
552
|
-
#
|
553
|
-
#
|
561
|
+
# Specifies the maximum number of results to be returned in each page. A
|
562
|
+
# query can return fewer than this maximum, even if there are more
|
563
|
+
# results still to return. You should always check the `PaginationToken`
|
564
|
+
# response value to see if there are more results. You can specify a
|
565
|
+
# minimum of 1 and a maximum value of 100.
|
554
566
|
#
|
555
567
|
# @option params [Integer] :tags_per_page
|
556
568
|
# AWS recommends using `ResourcesPerPage` instead of this parameter.
|
557
569
|
#
|
558
570
|
# A limit that restricts the number of tags (key and value pairs)
|
559
|
-
# returned by GetResources in paginated output. A resource with no
|
560
|
-
# is counted as having one tag (one key and value pair).
|
571
|
+
# returned by `GetResources` in paginated output. A resource with no
|
572
|
+
# tags is counted as having one tag (one key and value pair).
|
561
573
|
#
|
562
574
|
# `GetResources` does not split a resource and its associated tags
|
563
575
|
# across pages. If the specified `TagsPerPage` would cause such a break,
|
@@ -570,26 +582,22 @@ module Aws::ResourceGroupsTaggingAPI
|
|
570
582
|
# second page displays the next 10 resources, each with its 10 tags. The
|
571
583
|
# third page displays the remaining 2 resources, each with its 10 tags.
|
572
584
|
#
|
573
|
-
# You can set `TagsPerPage` to a minimum of 100 items
|
585
|
+
# You can set `TagsPerPage` to a minimum of 100 items up to a maximum of
|
574
586
|
# 500 items.
|
575
587
|
#
|
576
588
|
# @option params [Array<String>] :resource_type_filters
|
577
|
-
#
|
578
|
-
# each resource type is `service[:resourceType]`. For
|
579
|
-
# specifying a resource type of `ec2` returns all Amazon EC2
|
580
|
-
# (which includes EC2 instances). Specifying a resource type
|
581
|
-
# `ec2:instance` returns only EC2 instances.
|
589
|
+
# Specifies the resource types that you want included in the response.
|
590
|
+
# The format of each resource type is `service[:resourceType]`. For
|
591
|
+
# example, specifying a resource type of `ec2` returns all Amazon EC2
|
592
|
+
# resources (which includes EC2 instances). Specifying a resource type
|
593
|
+
# of `ec2:instance` returns only EC2 instances.
|
582
594
|
#
|
583
595
|
# The string for each service name and resource type is the same as that
|
584
596
|
# embedded in a resource's Amazon Resource Name (ARN). Consult the *AWS
|
585
597
|
# General Reference* for the following:
|
586
598
|
#
|
587
|
-
#
|
588
|
-
#
|
589
|
-
# * For resource type strings, see [Example ARNs][2].
|
590
|
-
#
|
591
|
-
# * For more information about ARNs, see [Amazon Resource Names (ARNs)
|
592
|
-
# and AWS Service Namespaces][3].
|
599
|
+
# For more information about ARNs, see [Amazon Resource Names (ARNs) and
|
600
|
+
# AWS Service Namespaces][1].
|
593
601
|
#
|
594
602
|
# You can specify multiple resource types by using an array. The array
|
595
603
|
# can include up to 100 items. Note that the length constraint
|
@@ -597,9 +605,7 @@ module Aws::ResourceGroupsTaggingAPI
|
|
597
605
|
#
|
598
606
|
#
|
599
607
|
#
|
600
|
-
# [1]:
|
601
|
-
# [2]: http://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html#arns-syntax
|
602
|
-
# [3]: http://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html
|
608
|
+
# [1]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html
|
603
609
|
#
|
604
610
|
# @option params [Boolean] :include_compliance_details
|
605
611
|
# Specifies whether to include details regarding the compliance with the
|
@@ -614,6 +620,24 @@ module Aws::ResourceGroupsTaggingAPI
|
|
614
620
|
# You can use this parameter only if the `IncludeComplianceDetails`
|
615
621
|
# parameter is also set to `true`.
|
616
622
|
#
|
623
|
+
# @option params [Array<String>] :resource_arn_list
|
624
|
+
# Specifies a list of ARNs of resources for which you want to retrieve
|
625
|
+
# tag data. You can't specify both this parameter and any of the
|
626
|
+
# pagination parameters (`ResourcesPerPage`, `TagsPerPage`,
|
627
|
+
# `PaginationToken`) in the same request. If you specify both, you get
|
628
|
+
# an `Invalid Parameter` exception.
|
629
|
+
#
|
630
|
+
# If a resource specified by this parameter doesn't exist, it doesn't
|
631
|
+
# generate an error; it simply isn't included in the response.
|
632
|
+
#
|
633
|
+
# An ARN (Amazon Resource Name) uniquely identifies a resource. For more
|
634
|
+
# information, see [Amazon Resource Names (ARNs) and AWS Service
|
635
|
+
# Namespaces][1] in the *AWS General Reference*.
|
636
|
+
#
|
637
|
+
#
|
638
|
+
#
|
639
|
+
# [1]: http://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html
|
640
|
+
#
|
617
641
|
# @return [Types::GetResourcesOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
618
642
|
#
|
619
643
|
# * {Types::GetResourcesOutput#pagination_token #pagination_token} => String
|
@@ -636,6 +660,7 @@ module Aws::ResourceGroupsTaggingAPI
|
|
636
660
|
# resource_type_filters: ["AmazonResourceType"],
|
637
661
|
# include_compliance_details: false,
|
638
662
|
# exclude_compliant_resources: false,
|
663
|
+
# resource_arn_list: ["ResourceARN"],
|
639
664
|
# })
|
640
665
|
#
|
641
666
|
# @example Response structure
|
@@ -661,13 +686,21 @@ module Aws::ResourceGroupsTaggingAPI
|
|
661
686
|
req.send_request(options)
|
662
687
|
end
|
663
688
|
|
664
|
-
# Returns all tag keys in the specified Region for the
|
689
|
+
# Returns all tag keys currently in use in the specified Region for the
|
690
|
+
# calling AWS account.
|
691
|
+
#
|
692
|
+
# This operation supports pagination, where the response can be sent in
|
693
|
+
# multiple pages. You should check the `PaginationToken` response
|
694
|
+
# parameter to determine if there are additional results available to
|
695
|
+
# return. Repeat the query, passing the `PaginationToken` response
|
696
|
+
# parameter value as an input to the next request until you recieve a
|
697
|
+
# `null` value. A null value for `PaginationToken` indicates that there
|
698
|
+
# are no more results waiting to be returned.
|
665
699
|
#
|
666
700
|
# @option params [String] :pagination_token
|
667
|
-
#
|
668
|
-
#
|
669
|
-
#
|
670
|
-
# additional page of data.
|
701
|
+
# Specifies a `PaginationToken` response value from a previous request
|
702
|
+
# to indicate that you want the next page of results. Leave this
|
703
|
+
# parameter empty in your initial request.
|
671
704
|
#
|
672
705
|
# @return [Types::GetTagKeysOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
673
706
|
#
|
@@ -697,18 +730,26 @@ module Aws::ResourceGroupsTaggingAPI
|
|
697
730
|
req.send_request(options)
|
698
731
|
end
|
699
732
|
|
700
|
-
# Returns all tag values for the specified key in the
|
701
|
-
# for the AWS account.
|
733
|
+
# Returns all tag values for the specified key that are used in the
|
734
|
+
# specified AWS Region for the calling AWS account.
|
735
|
+
#
|
736
|
+
# This operation supports pagination, where the response can be sent in
|
737
|
+
# multiple pages. You should check the `PaginationToken` response
|
738
|
+
# parameter to determine if there are additional results available to
|
739
|
+
# return. Repeat the query, passing the `PaginationToken` response
|
740
|
+
# parameter value as an input to the next request until you recieve a
|
741
|
+
# `null` value. A null value for `PaginationToken` indicates that there
|
742
|
+
# are no more results waiting to be returned.
|
702
743
|
#
|
703
744
|
# @option params [String] :pagination_token
|
704
|
-
#
|
705
|
-
#
|
706
|
-
#
|
707
|
-
# additional page of data.
|
745
|
+
# Specifies a `PaginationToken` response value from a previous request
|
746
|
+
# to indicate that you want the next page of results. Leave this
|
747
|
+
# parameter empty in your initial request.
|
708
748
|
#
|
709
749
|
# @option params [required, String] :key
|
710
|
-
#
|
711
|
-
# specified Region for the
|
750
|
+
# Specifies the tag key for which you want to list all existing values
|
751
|
+
# that are currently used in the specified AWS Region for the calling
|
752
|
+
# AWS account.
|
712
753
|
#
|
713
754
|
# @return [Types::GetTagValuesOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
714
755
|
#
|
@@ -739,15 +780,16 @@ module Aws::ResourceGroupsTaggingAPI
|
|
739
780
|
req.send_request(options)
|
740
781
|
end
|
741
782
|
|
742
|
-
# Generates a report that lists all tagged resources in accounts
|
743
|
-
# your organization and tells whether each resource is compliant
|
744
|
-
# the effective tag policy. Compliance data is refreshed daily.
|
783
|
+
# Generates a report that lists all tagged resources in the accounts
|
784
|
+
# across your organization and tells whether each resource is compliant
|
785
|
+
# with the effective tag policy. Compliance data is refreshed daily. The
|
786
|
+
# report is generated asynchronously.
|
745
787
|
#
|
746
788
|
# The generated report is saved to the following location:
|
747
789
|
#
|
748
790
|
# `s3://example-bucket/AwsTagPolicies/o-exampleorgid/YYYY-MM-ddTHH:mm:ssZ/report.csv`
|
749
791
|
#
|
750
|
-
# You can call this operation only from the organization's
|
792
|
+
# You can call this operation only from the organization's management
|
751
793
|
# account and from the us-east-1 Region.
|
752
794
|
#
|
753
795
|
# @option params [required, String] :s3_bucket
|
@@ -779,18 +821,20 @@ module Aws::ResourceGroupsTaggingAPI
|
|
779
821
|
# Applies one or more tags to the specified resources. Note the
|
780
822
|
# following:
|
781
823
|
#
|
782
|
-
# * Not all resources can have tags. For a list of services
|
783
|
-
# tagging, see [
|
824
|
+
# * Not all resources can have tags. For a list of services with
|
825
|
+
# resources that support tagging using this operation, see [Services
|
826
|
+
# that support the Resource Groups Tagging API][1].
|
784
827
|
#
|
785
828
|
# * Each resource can have up to 50 tags. For other limits, see [Tag
|
786
829
|
# Naming and Usage Conventions][2] in the *AWS General Reference.*
|
787
830
|
#
|
788
|
-
# * You can only tag resources that are located in the specified
|
789
|
-
# for the AWS account.
|
831
|
+
# * You can only tag resources that are located in the specified AWS
|
832
|
+
# Region for the AWS account.
|
790
833
|
#
|
791
834
|
# * To add tags to a resource, you need the necessary permissions for
|
792
835
|
# the service that the resource belongs to as well as permissions for
|
793
|
-
# adding tags. For more information, see
|
836
|
+
# adding tags. For more information, see the documentation for each
|
837
|
+
# service.
|
794
838
|
#
|
795
839
|
# Do not store personally identifiable information (PII) or other
|
796
840
|
# confidential or sensitive information in tags. We use tags to provide
|
@@ -799,21 +843,24 @@ module Aws::ResourceGroupsTaggingAPI
|
|
799
843
|
#
|
800
844
|
#
|
801
845
|
#
|
802
|
-
# [1]:
|
803
|
-
# [2]:
|
846
|
+
# [1]: https://docs.aws.amazon.com/resourcegroupstagging/latest/APIReference/supported-services.html
|
847
|
+
# [2]: https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html#tag-conventions
|
804
848
|
#
|
805
849
|
# @option params [required, Array<String>] :resource_arn_list
|
806
|
-
#
|
807
|
-
#
|
808
|
-
#
|
850
|
+
# Specifies the list of ARNs of the resources that you want to apply
|
851
|
+
# tags to.
|
852
|
+
#
|
853
|
+
# An ARN (Amazon Resource Name) uniquely identifies a resource. For more
|
854
|
+
# information, see [Amazon Resource Names (ARNs) and AWS Service
|
855
|
+
# Namespaces][1] in the *AWS General Reference*.
|
809
856
|
#
|
810
857
|
#
|
811
858
|
#
|
812
859
|
# [1]: http://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html
|
813
860
|
#
|
814
861
|
# @option params [required, Hash<String,String>] :tags
|
815
|
-
#
|
816
|
-
# consists of a key and a value that you define.
|
862
|
+
# Specifies a list of tags that you want to add to the specified
|
863
|
+
# resources. A tag consists of a key and a value that you define.
|
817
864
|
#
|
818
865
|
# @return [Types::TagResourcesOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
819
866
|
#
|
@@ -851,27 +898,27 @@ module Aws::ResourceGroupsTaggingAPI
|
|
851
898
|
#
|
852
899
|
# * To remove tags from a resource, you need the necessary permissions
|
853
900
|
# for the service that the resource belongs to as well as permissions
|
854
|
-
# for removing tags. For more information, see
|
855
|
-
#
|
856
|
-
# * You can only tag resources that are located in the specified Region
|
857
|
-
# for the AWS account.
|
901
|
+
# for removing tags. For more information, see the documentation for
|
902
|
+
# the service whose resource you want to untag.
|
858
903
|
#
|
859
|
-
#
|
860
|
-
#
|
861
|
-
# [1]: http://docs.aws.amazon.com/resourcegroupstagging/latest/APIReference/Welcome.html
|
904
|
+
# * You can only tag resources that are located in the specified AWS
|
905
|
+
# Region for the calling AWS account.
|
862
906
|
#
|
863
907
|
# @option params [required, Array<String>] :resource_arn_list
|
864
|
-
#
|
865
|
-
#
|
866
|
-
#
|
908
|
+
# Specifies a list of ARNs of the resources that you want to remove tags
|
909
|
+
# from.
|
910
|
+
#
|
911
|
+
# An ARN (Amazon Resource Name) uniquely identifies a resource. For more
|
912
|
+
# information, see [Amazon Resource Names (ARNs) and AWS Service
|
913
|
+
# Namespaces][1] in the *AWS General Reference*.
|
867
914
|
#
|
868
915
|
#
|
869
916
|
#
|
870
917
|
# [1]: http://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html
|
871
918
|
#
|
872
919
|
# @option params [required, Array<String>] :tag_keys
|
873
|
-
#
|
874
|
-
# resources.
|
920
|
+
# Specifies a list of tag keys that you want to remove from the
|
921
|
+
# specified resources.
|
875
922
|
#
|
876
923
|
# @return [Types::UntagResourcesOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
877
924
|
#
|
@@ -913,7 +960,7 @@ module Aws::ResourceGroupsTaggingAPI
|
|
913
960
|
params: params,
|
914
961
|
config: config)
|
915
962
|
context[:gem_name] = 'aws-sdk-resourcegroupstaggingapi'
|
916
|
-
context[:gem_version] = '1.
|
963
|
+
context[:gem_version] = '1.36.0'
|
917
964
|
Seahorse::Client::Request.new(handlers, context)
|
918
965
|
end
|
919
966
|
|
@@ -47,7 +47,8 @@ module Aws::ResourceGroupsTaggingAPI
|
|
47
47
|
Region = Shapes::StringShape.new(name: 'Region')
|
48
48
|
RegionFilterList = Shapes::ListShape.new(name: 'RegionFilterList')
|
49
49
|
ResourceARN = Shapes::StringShape.new(name: 'ResourceARN')
|
50
|
-
|
50
|
+
ResourceARNListForGet = Shapes::ListShape.new(name: 'ResourceARNListForGet')
|
51
|
+
ResourceARNListForTagUntag = Shapes::ListShape.new(name: 'ResourceARNListForTagUntag')
|
51
52
|
ResourceTagMapping = Shapes::StructureShape.new(name: 'ResourceTagMapping')
|
52
53
|
ResourceTagMappingList = Shapes::ListShape.new(name: 'ResourceTagMappingList')
|
53
54
|
ResourceTypeFilterList = Shapes::ListShape.new(name: 'ResourceTypeFilterList')
|
@@ -128,6 +129,7 @@ module Aws::ResourceGroupsTaggingAPI
|
|
128
129
|
GetResourcesInput.add_member(:resource_type_filters, Shapes::ShapeRef.new(shape: ResourceTypeFilterList, location_name: "ResourceTypeFilters"))
|
129
130
|
GetResourcesInput.add_member(:include_compliance_details, Shapes::ShapeRef.new(shape: IncludeComplianceDetails, location_name: "IncludeComplianceDetails"))
|
130
131
|
GetResourcesInput.add_member(:exclude_compliant_resources, Shapes::ShapeRef.new(shape: ExcludeCompliantResources, location_name: "ExcludeCompliantResources"))
|
132
|
+
GetResourcesInput.add_member(:resource_arn_list, Shapes::ShapeRef.new(shape: ResourceARNListForGet, location_name: "ResourceARNList"))
|
131
133
|
GetResourcesInput.struct_class = Types::GetResourcesInput
|
132
134
|
|
133
135
|
GetResourcesOutput.add_member(:pagination_token, Shapes::ShapeRef.new(shape: PaginationToken, location_name: "PaginationToken"))
|
@@ -162,7 +164,9 @@ module Aws::ResourceGroupsTaggingAPI
|
|
162
164
|
|
163
165
|
RegionFilterList.member = Shapes::ShapeRef.new(shape: Region)
|
164
166
|
|
165
|
-
|
167
|
+
ResourceARNListForGet.member = Shapes::ShapeRef.new(shape: ResourceARN)
|
168
|
+
|
169
|
+
ResourceARNListForTagUntag.member = Shapes::ShapeRef.new(shape: ResourceARN)
|
166
170
|
|
167
171
|
ResourceTagMapping.add_member(:resource_arn, Shapes::ShapeRef.new(shape: ResourceARN, location_name: "ResourceARN"))
|
168
172
|
ResourceTagMapping.add_member(:tags, Shapes::ShapeRef.new(shape: TagList, location_name: "Tags"))
|
@@ -209,7 +213,7 @@ module Aws::ResourceGroupsTaggingAPI
|
|
209
213
|
TagMap.key = Shapes::ShapeRef.new(shape: TagKey)
|
210
214
|
TagMap.value = Shapes::ShapeRef.new(shape: TagValue)
|
211
215
|
|
212
|
-
TagResourcesInput.add_member(:resource_arn_list, Shapes::ShapeRef.new(shape:
|
216
|
+
TagResourcesInput.add_member(:resource_arn_list, Shapes::ShapeRef.new(shape: ResourceARNListForTagUntag, required: true, location_name: "ResourceARNList"))
|
213
217
|
TagResourcesInput.add_member(:tags, Shapes::ShapeRef.new(shape: TagMap, required: true, location_name: "Tags"))
|
214
218
|
TagResourcesInput.struct_class = Types::TagResourcesInput
|
215
219
|
|
@@ -225,7 +229,7 @@ module Aws::ResourceGroupsTaggingAPI
|
|
225
229
|
ThrottledException.add_member(:message, Shapes::ShapeRef.new(shape: ExceptionMessage, location_name: "Message"))
|
226
230
|
ThrottledException.struct_class = Types::ThrottledException
|
227
231
|
|
228
|
-
UntagResourcesInput.add_member(:resource_arn_list, Shapes::ShapeRef.new(shape:
|
232
|
+
UntagResourcesInput.add_member(:resource_arn_list, Shapes::ShapeRef.new(shape: ResourceARNListForTagUntag, required: true, location_name: "ResourceARNList"))
|
229
233
|
UntagResourcesInput.add_member(:tag_keys, Shapes::ShapeRef.new(shape: TagKeyListForUntag, required: true, location_name: "TagKeys"))
|
230
234
|
UntagResourcesInput.struct_class = Types::UntagResourcesInput
|
231
235
|
|
@@ -198,24 +198,25 @@ module Aws::ResourceGroupsTaggingAPI
|
|
198
198
|
# }
|
199
199
|
#
|
200
200
|
# @!attribute [rw] target_id_filters
|
201
|
-
#
|
202
|
-
# output by. If you use this parameter, the count of
|
203
|
-
# noncompliant resources includes only resources with the
|
204
|
-
# target IDs.
|
201
|
+
# Specifies target identifiers (usually, specific account IDs) to
|
202
|
+
# limit the output by. If you use this parameter, the count of
|
203
|
+
# returned noncompliant resources includes only resources with the
|
204
|
+
# specified target IDs.
|
205
205
|
# @return [Array<String>]
|
206
206
|
#
|
207
207
|
# @!attribute [rw] region_filters
|
208
|
-
#
|
209
|
-
# the count of returned noncompliant resources
|
210
|
-
# in the specified Regions.
|
208
|
+
# Specifies a list of AWS Regions to limit the output by. If you use
|
209
|
+
# this parameter, the count of returned noncompliant resources
|
210
|
+
# includes only resources in the specified Regions.
|
211
211
|
# @return [Array<String>]
|
212
212
|
#
|
213
213
|
# @!attribute [rw] resource_type_filters
|
214
|
-
#
|
215
|
-
# of
|
216
|
-
# specifying a resource type
|
217
|
-
#
|
218
|
-
# `ec2:instance` returns
|
214
|
+
# Specifies that you want the response to include information for only
|
215
|
+
# resources of the specified types. The format of each resource type
|
216
|
+
# is `service[:resourceType]`. For example, specifying a resource type
|
217
|
+
# of `ec2` returns all Amazon EC2 resources (which includes EC2
|
218
|
+
# instances). Specifying a resource type of `ec2:instance` returns
|
219
|
+
# only EC2 instances.
|
219
220
|
#
|
220
221
|
# The string for each service name and resource type is the same as
|
221
222
|
# that embedded in a resource's Amazon Resource Name (ARN). Consult
|
@@ -229,38 +230,42 @@ module Aws::ResourceGroupsTaggingAPI
|
|
229
230
|
# * For more information about ARNs, see [Amazon Resource Names (ARNs)
|
230
231
|
# and AWS Service Namespaces][3].
|
231
232
|
#
|
232
|
-
# You can specify multiple resource types by using
|
233
|
-
# can include up to 100 items. Note that the length
|
234
|
-
# requirement applies to each resource type filter.
|
233
|
+
# You can specify multiple resource types by using a comma separated
|
234
|
+
# array. The array can include up to 100 items. Note that the length
|
235
|
+
# constraint requirement applies to each resource type filter.
|
235
236
|
#
|
236
237
|
#
|
237
238
|
#
|
238
|
-
# [1]:
|
239
|
-
# [2]:
|
240
|
-
# [3]:
|
239
|
+
# [1]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html#genref-aws-service-namespaces
|
240
|
+
# [2]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html#arns-syntax
|
241
|
+
# [3]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html
|
241
242
|
# @return [Array<String>]
|
242
243
|
#
|
243
244
|
# @!attribute [rw] tag_key_filters
|
244
|
-
#
|
245
|
-
#
|
246
|
-
#
|
245
|
+
# Specifies that you want the response to include information for only
|
246
|
+
# resources that have tags with the specified tag keys. If you use
|
247
|
+
# this parameter, the count of returned noncompliant resources
|
248
|
+
# includes only resources that have the specified tag keys.
|
247
249
|
# @return [Array<String>]
|
248
250
|
#
|
249
251
|
# @!attribute [rw] group_by
|
250
|
-
#
|
251
|
-
# by. If supplied, the counts are sorted by those
|
252
|
+
# Specifies a list of attributes to group the counts of noncompliant
|
253
|
+
# resources by. If supplied, the counts are sorted by those
|
254
|
+
# attributes.
|
252
255
|
# @return [Array<String>]
|
253
256
|
#
|
254
257
|
# @!attribute [rw] max_results
|
255
|
-
#
|
256
|
-
#
|
258
|
+
# Specifies the maximum number of results to be returned in each page.
|
259
|
+
# A query can return fewer than this maximum, even if there are more
|
260
|
+
# results still to return. You should always check the
|
261
|
+
# `PaginationToken` response value to see if there are more results.
|
262
|
+
# You can specify a minimum of 1 and a maximum value of 100.
|
257
263
|
# @return [Integer]
|
258
264
|
#
|
259
265
|
# @!attribute [rw] pagination_token
|
260
|
-
#
|
261
|
-
#
|
262
|
-
#
|
263
|
-
# additional page of data.
|
266
|
+
# Specifies a `PaginationToken` response value from a previous request
|
267
|
+
# to indicate that you want the next page of results. Leave this
|
268
|
+
# parameter empty in your initial request.
|
264
269
|
# @return [String]
|
265
270
|
#
|
266
271
|
# @see http://docs.aws.amazon.com/goto/WebAPI/resourcegroupstaggingapi-2017-01-26/GetComplianceSummaryInput AWS API Documentation
|
@@ -282,10 +287,10 @@ module Aws::ResourceGroupsTaggingAPI
|
|
282
287
|
# @return [Array<Types::Summary>]
|
283
288
|
#
|
284
289
|
# @!attribute [rw] pagination_token
|
285
|
-
# A string that indicates that
|
286
|
-
#
|
287
|
-
#
|
288
|
-
#
|
290
|
+
# A string that indicates that there is more data available than this
|
291
|
+
# response contains. To receive the next part of the response, specify
|
292
|
+
# this response value as the `PaginationToken` value in the request
|
293
|
+
# for the next page.
|
289
294
|
# @return [String]
|
290
295
|
#
|
291
296
|
# @see http://docs.aws.amazon.com/goto/WebAPI/resourcegroupstaggingapi-2017-01-26/GetComplianceSummaryOutput AWS API Documentation
|
@@ -313,70 +318,70 @@ module Aws::ResourceGroupsTaggingAPI
|
|
313
318
|
# resource_type_filters: ["AmazonResourceType"],
|
314
319
|
# include_compliance_details: false,
|
315
320
|
# exclude_compliant_resources: false,
|
321
|
+
# resource_arn_list: ["ResourceARN"],
|
316
322
|
# }
|
317
323
|
#
|
318
324
|
# @!attribute [rw] pagination_token
|
319
|
-
#
|
320
|
-
#
|
321
|
-
#
|
322
|
-
# additional page of data.
|
325
|
+
# Specifies a `PaginationToken` response value from a previous request
|
326
|
+
# to indicate that you want the next page of results. Leave this
|
327
|
+
# parameter empty in your initial request.
|
323
328
|
# @return [String]
|
324
329
|
#
|
325
330
|
# @!attribute [rw] tag_filters
|
326
|
-
#
|
327
|
-
#
|
328
|
-
#
|
331
|
+
# Specifies a list of TagFilters (keys and values) to restrict the
|
332
|
+
# output to only those resources that have the specified tag and, if
|
333
|
+
# included, the specified value. Each `TagFilter` must contain a key
|
334
|
+
# with values optional. A request can include up to 50 keys, and each
|
335
|
+
# key can include up to 20 values.
|
329
336
|
#
|
330
337
|
# Note the following when deciding how to use TagFilters:
|
331
338
|
#
|
332
|
-
# * If you *
|
333
|
-
# resources that are currently
|
334
|
-
#
|
335
|
-
#
|
336
|
-
# resources that were ever associated with tags. Resources that
|
337
|
-
# currently don't have associated tags are shown with an empty tag
|
338
|
-
# set, like this: `"Tags": []`.
|
339
|
+
# * If you *don't* specify a `TagFilter`, the response includes all
|
340
|
+
# resources that are currently tagged or ever had a tag. Resources
|
341
|
+
# that currently don't have tags are shown with an empty tag set,
|
342
|
+
# like this: `"Tags": []`.
|
339
343
|
#
|
340
344
|
# * If you specify more than one filter in a single request, the
|
341
|
-
# response returns only those resources that satisfy all
|
342
|
-
# filters.
|
345
|
+
# response returns only those resources that satisfy all filters.
|
343
346
|
#
|
344
347
|
# * If you specify a filter that contains more than one value for a
|
345
348
|
# key, the response returns resources that match any of the
|
346
349
|
# specified values for that key.
|
347
350
|
#
|
348
351
|
# * If you don't specify any values for a key, the response returns
|
349
|
-
# resources that are tagged with that key
|
352
|
+
# resources that are tagged with that key and any or no value.
|
350
353
|
#
|
351
|
-
# For example, for filters: filter1
|
352
|
-
#
|
353
|
-
#
|
354
|
+
# For example, for the following filters: `filter1=
|
355
|
+
# \{keyA,\{value1\}\}`, `filter2=\{keyB,\{value2,value3,value4\}\}`,
|
356
|
+
# `filter3= \{keyC\}`\:
|
354
357
|
#
|
355
|
-
# * GetResources(
|
356
|
-
# key1=value1
|
358
|
+
# * `GetResources(\{filter1\})` returns resources tagged with
|
359
|
+
# `key1=value1`
|
357
360
|
#
|
358
|
-
# * GetResources(
|
359
|
-
# key2=value2 or key2=value3 or key2=value4
|
361
|
+
# * `GetResources(\{filter2\})` returns resources tagged with
|
362
|
+
# `key2=value2` or `key2=value3` or `key2=value4`
|
360
363
|
#
|
361
|
-
# * GetResources(
|
362
|
-
# tag
|
364
|
+
# * `GetResources(\{filter3\})` returns resources tagged with any
|
365
|
+
# tag with the key `key3`, and with any or no value
|
363
366
|
#
|
364
|
-
# * GetResources(
|
365
|
-
# tagged with (
|
366
|
-
# key2=value4) and (key3,
|
367
|
+
# * `GetResources(\{filter1,filter2,filter3\})` returns resources
|
368
|
+
# tagged with `(key1=value1) and (key2=value2 or key2=value3 or
|
369
|
+
# key2=value4) and (key3, any or no value)`
|
367
370
|
# @return [Array<Types::TagFilter>]
|
368
371
|
#
|
369
372
|
# @!attribute [rw] resources_per_page
|
370
|
-
#
|
371
|
-
#
|
372
|
-
#
|
373
|
+
# Specifies the maximum number of results to be returned in each page.
|
374
|
+
# A query can return fewer than this maximum, even if there are more
|
375
|
+
# results still to return. You should always check the
|
376
|
+
# `PaginationToken` response value to see if there are more results.
|
377
|
+
# You can specify a minimum of 1 and a maximum value of 100.
|
373
378
|
# @return [Integer]
|
374
379
|
#
|
375
380
|
# @!attribute [rw] tags_per_page
|
376
381
|
# AWS recommends using `ResourcesPerPage` instead of this parameter.
|
377
382
|
#
|
378
383
|
# A limit that restricts the number of tags (key and value pairs)
|
379
|
-
# returned by GetResources in paginated output. A resource with no
|
384
|
+
# returned by `GetResources` in paginated output. A resource with no
|
380
385
|
# tags is counted as having one tag (one key and value pair).
|
381
386
|
#
|
382
387
|
# `GetResources` does not split a resource and its associated tags
|
@@ -391,28 +396,23 @@ module Aws::ResourceGroupsTaggingAPI
|
|
391
396
|
# each with its 10 tags. The third page displays the remaining 2
|
392
397
|
# resources, each with its 10 tags.
|
393
398
|
#
|
394
|
-
# You can set `TagsPerPage` to a minimum of 100 items
|
399
|
+
# You can set `TagsPerPage` to a minimum of 100 items up to a maximum
|
395
400
|
# of 500 items.
|
396
401
|
# @return [Integer]
|
397
402
|
#
|
398
403
|
# @!attribute [rw] resource_type_filters
|
399
|
-
#
|
400
|
-
# of each resource type is `service[:resourceType]`. For
|
401
|
-
# specifying a resource type of `ec2` returns all Amazon EC2
|
402
|
-
# (which includes EC2 instances). Specifying a resource type
|
403
|
-
# `ec2:instance` returns only EC2 instances.
|
404
|
+
# Specifies the resource types that you want included in the response.
|
405
|
+
# The format of each resource type is `service[:resourceType]`. For
|
406
|
+
# example, specifying a resource type of `ec2` returns all Amazon EC2
|
407
|
+
# resources (which includes EC2 instances). Specifying a resource type
|
408
|
+
# of `ec2:instance` returns only EC2 instances.
|
404
409
|
#
|
405
410
|
# The string for each service name and resource type is the same as
|
406
411
|
# that embedded in a resource's Amazon Resource Name (ARN). Consult
|
407
412
|
# the *AWS General Reference* for the following:
|
408
413
|
#
|
409
|
-
#
|
410
|
-
#
|
411
|
-
#
|
412
|
-
# * For resource type strings, see [Example ARNs][2].
|
413
|
-
#
|
414
|
-
# * For more information about ARNs, see [Amazon Resource Names (ARNs)
|
415
|
-
# and AWS Service Namespaces][3].
|
414
|
+
# For more information about ARNs, see [Amazon Resource Names (ARNs)
|
415
|
+
# and AWS Service Namespaces][1].
|
416
416
|
#
|
417
417
|
# You can specify multiple resource types by using an array. The array
|
418
418
|
# can include up to 100 items. Note that the length constraint
|
@@ -420,9 +420,7 @@ module Aws::ResourceGroupsTaggingAPI
|
|
420
420
|
#
|
421
421
|
#
|
422
422
|
#
|
423
|
-
# [1]:
|
424
|
-
# [2]: http://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html#arns-syntax
|
425
|
-
# [3]: http://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html
|
423
|
+
# [1]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html
|
426
424
|
# @return [Array<String>]
|
427
425
|
#
|
428
426
|
# @!attribute [rw] include_compliance_details
|
@@ -440,6 +438,26 @@ module Aws::ResourceGroupsTaggingAPI
|
|
440
438
|
# parameter is also set to `true`.
|
441
439
|
# @return [Boolean]
|
442
440
|
#
|
441
|
+
# @!attribute [rw] resource_arn_list
|
442
|
+
# Specifies a list of ARNs of resources for which you want to retrieve
|
443
|
+
# tag data. You can't specify both this parameter and any of the
|
444
|
+
# pagination parameters (`ResourcesPerPage`, `TagsPerPage`,
|
445
|
+
# `PaginationToken`) in the same request. If you specify both, you get
|
446
|
+
# an `Invalid Parameter` exception.
|
447
|
+
#
|
448
|
+
# If a resource specified by this parameter doesn't exist, it
|
449
|
+
# doesn't generate an error; it simply isn't included in the
|
450
|
+
# response.
|
451
|
+
#
|
452
|
+
# An ARN (Amazon Resource Name) uniquely identifies a resource. For
|
453
|
+
# more information, see [Amazon Resource Names (ARNs) and AWS Service
|
454
|
+
# Namespaces][1] in the *AWS General Reference*.
|
455
|
+
#
|
456
|
+
#
|
457
|
+
#
|
458
|
+
# [1]: http://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html
|
459
|
+
# @return [Array<String>]
|
460
|
+
#
|
443
461
|
# @see http://docs.aws.amazon.com/goto/WebAPI/resourcegroupstaggingapi-2017-01-26/GetResourcesInput AWS API Documentation
|
444
462
|
#
|
445
463
|
class GetResourcesInput < Struct.new(
|
@@ -449,21 +467,22 @@ module Aws::ResourceGroupsTaggingAPI
|
|
449
467
|
:tags_per_page,
|
450
468
|
:resource_type_filters,
|
451
469
|
:include_compliance_details,
|
452
|
-
:exclude_compliant_resources
|
470
|
+
:exclude_compliant_resources,
|
471
|
+
:resource_arn_list)
|
453
472
|
SENSITIVE = []
|
454
473
|
include Aws::Structure
|
455
474
|
end
|
456
475
|
|
457
476
|
# @!attribute [rw] pagination_token
|
458
|
-
# A string that indicates that
|
459
|
-
#
|
460
|
-
#
|
461
|
-
#
|
477
|
+
# A string that indicates that there is more data available than this
|
478
|
+
# response contains. To receive the next part of the response, specify
|
479
|
+
# this response value as the `PaginationToken` value in the request
|
480
|
+
# for the next page.
|
462
481
|
# @return [String]
|
463
482
|
#
|
464
483
|
# @!attribute [rw] resource_tag_mapping_list
|
465
484
|
# A list of resource ARNs and the tags (keys and values) associated
|
466
|
-
# with
|
485
|
+
# with those ARNs.
|
467
486
|
# @return [Array<Types::ResourceTagMapping>]
|
468
487
|
#
|
469
488
|
# @see http://docs.aws.amazon.com/goto/WebAPI/resourcegroupstaggingapi-2017-01-26/GetResourcesOutput AWS API Documentation
|
@@ -483,10 +502,9 @@ module Aws::ResourceGroupsTaggingAPI
|
|
483
502
|
# }
|
484
503
|
#
|
485
504
|
# @!attribute [rw] pagination_token
|
486
|
-
#
|
487
|
-
#
|
488
|
-
#
|
489
|
-
# additional page of data.
|
505
|
+
# Specifies a `PaginationToken` response value from a previous request
|
506
|
+
# to indicate that you want the next page of results. Leave this
|
507
|
+
# parameter empty in your initial request.
|
490
508
|
# @return [String]
|
491
509
|
#
|
492
510
|
# @see http://docs.aws.amazon.com/goto/WebAPI/resourcegroupstaggingapi-2017-01-26/GetTagKeysInput AWS API Documentation
|
@@ -498,10 +516,10 @@ module Aws::ResourceGroupsTaggingAPI
|
|
498
516
|
end
|
499
517
|
|
500
518
|
# @!attribute [rw] pagination_token
|
501
|
-
# A string that indicates that
|
502
|
-
#
|
503
|
-
#
|
504
|
-
#
|
519
|
+
# A string that indicates that there is more data available than this
|
520
|
+
# response contains. To receive the next part of the response, specify
|
521
|
+
# this response value as the `PaginationToken` value in the request
|
522
|
+
# for the next page.
|
505
523
|
# @return [String]
|
506
524
|
#
|
507
525
|
# @!attribute [rw] tag_keys
|
@@ -526,15 +544,15 @@ module Aws::ResourceGroupsTaggingAPI
|
|
526
544
|
# }
|
527
545
|
#
|
528
546
|
# @!attribute [rw] pagination_token
|
529
|
-
#
|
530
|
-
#
|
531
|
-
#
|
532
|
-
# additional page of data.
|
547
|
+
# Specifies a `PaginationToken` response value from a previous request
|
548
|
+
# to indicate that you want the next page of results. Leave this
|
549
|
+
# parameter empty in your initial request.
|
533
550
|
# @return [String]
|
534
551
|
#
|
535
552
|
# @!attribute [rw] key
|
536
|
-
#
|
537
|
-
# specified Region for the
|
553
|
+
# Specifies the tag key for which you want to list all existing values
|
554
|
+
# that are currently used in the specified AWS Region for the calling
|
555
|
+
# AWS account.
|
538
556
|
# @return [String]
|
539
557
|
#
|
540
558
|
# @see http://docs.aws.amazon.com/goto/WebAPI/resourcegroupstaggingapi-2017-01-26/GetTagValuesInput AWS API Documentation
|
@@ -547,14 +565,15 @@ module Aws::ResourceGroupsTaggingAPI
|
|
547
565
|
end
|
548
566
|
|
549
567
|
# @!attribute [rw] pagination_token
|
550
|
-
# A string that indicates that
|
551
|
-
#
|
552
|
-
#
|
553
|
-
#
|
568
|
+
# A string that indicates that there is more data available than this
|
569
|
+
# response contains. To receive the next part of the response, specify
|
570
|
+
# this response value as the `PaginationToken` value in the request
|
571
|
+
# for the next page.
|
554
572
|
# @return [String]
|
555
573
|
#
|
556
574
|
# @!attribute [rw] tag_values
|
557
|
-
# A list of all tag values for the specified key in the
|
575
|
+
# A list of all tag values for the specified key currently used in the
|
576
|
+
# specified AWS Region for the calling AWS account.
|
558
577
|
# @return [Array<String>]
|
559
578
|
#
|
560
579
|
# @see http://docs.aws.amazon.com/goto/WebAPI/resourcegroupstaggingapi-2017-01-26/GetTagValuesOutput AWS API Documentation
|
@@ -796,9 +815,12 @@ module Aws::ResourceGroupsTaggingAPI
|
|
796
815
|
# }
|
797
816
|
#
|
798
817
|
# @!attribute [rw] resource_arn_list
|
799
|
-
#
|
800
|
-
#
|
801
|
-
#
|
818
|
+
# Specifies the list of ARNs of the resources that you want to apply
|
819
|
+
# tags to.
|
820
|
+
#
|
821
|
+
# An ARN (Amazon Resource Name) uniquely identifies a resource. For
|
822
|
+
# more information, see [Amazon Resource Names (ARNs) and AWS Service
|
823
|
+
# Namespaces][1] in the *AWS General Reference*.
|
802
824
|
#
|
803
825
|
#
|
804
826
|
#
|
@@ -806,8 +828,8 @@ module Aws::ResourceGroupsTaggingAPI
|
|
806
828
|
# @return [Array<String>]
|
807
829
|
#
|
808
830
|
# @!attribute [rw] tags
|
809
|
-
#
|
810
|
-
# consists of a key and a value that you define.
|
831
|
+
# Specifies a list of tags that you want to add to the specified
|
832
|
+
# resources. A tag consists of a key and a value that you define.
|
811
833
|
# @return [Hash<String,String>]
|
812
834
|
#
|
813
835
|
# @see http://docs.aws.amazon.com/goto/WebAPI/resourcegroupstaggingapi-2017-01-26/TagResourcesInput AWS API Documentation
|
@@ -857,9 +879,12 @@ module Aws::ResourceGroupsTaggingAPI
|
|
857
879
|
# }
|
858
880
|
#
|
859
881
|
# @!attribute [rw] resource_arn_list
|
860
|
-
#
|
861
|
-
#
|
862
|
-
#
|
882
|
+
# Specifies a list of ARNs of the resources that you want to remove
|
883
|
+
# tags from.
|
884
|
+
#
|
885
|
+
# An ARN (Amazon Resource Name) uniquely identifies a resource. For
|
886
|
+
# more information, see [Amazon Resource Names (ARNs) and AWS Service
|
887
|
+
# Namespaces][1] in the *AWS General Reference*.
|
863
888
|
#
|
864
889
|
#
|
865
890
|
#
|
@@ -867,8 +892,8 @@ module Aws::ResourceGroupsTaggingAPI
|
|
867
892
|
# @return [Array<String>]
|
868
893
|
#
|
869
894
|
# @!attribute [rw] tag_keys
|
870
|
-
#
|
871
|
-
# resources.
|
895
|
+
# Specifies a list of tag keys that you want to remove from the
|
896
|
+
# specified resources.
|
872
897
|
# @return [Array<String>]
|
873
898
|
#
|
874
899
|
# @see http://docs.aws.amazon.com/goto/WebAPI/resourcegroupstaggingapi-2017-01-26/UntagResourcesInput AWS API Documentation
|
@@ -881,8 +906,11 @@ module Aws::ResourceGroupsTaggingAPI
|
|
881
906
|
end
|
882
907
|
|
883
908
|
# @!attribute [rw] failed_resources_map
|
884
|
-
#
|
885
|
-
#
|
909
|
+
# A map containing a key-value pair for each failed item that
|
910
|
+
# couldn't be untagged. The key is the ARN of the failed resource.
|
911
|
+
# The value is a `FailureInfo` object that contains an error code, a
|
912
|
+
# status code, and an error message. If there are no errors, the
|
913
|
+
# `FailedResourcesMap` is empty.
|
886
914
|
# @return [Hash<String,Types::FailureInfo>]
|
887
915
|
#
|
888
916
|
# @see http://docs.aws.amazon.com/goto/WebAPI/resourcegroupstaggingapi-2017-01-26/UntagResourcesOutput AWS API Documentation
|
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.36.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: 2021-02-02 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.112.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.112.0
|
33
33
|
- !ruby/object:Gem::Dependency
|
34
34
|
name: aws-sigv4
|
35
35
|
requirement: !ruby/object:Gem::Requirement
|