aws-sdk-resourcegroupstaggingapi 1.14.0 → 1.15.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/lib/aws-sdk-resourcegroupstaggingapi.rb +1 -1
- data/lib/aws-sdk-resourcegroupstaggingapi/client.rb +37 -507
- data/lib/aws-sdk-resourcegroupstaggingapi/client_api.rb +0 -256
- data/lib/aws-sdk-resourcegroupstaggingapi/errors.rb +0 -32
- data/lib/aws-sdk-resourcegroupstaggingapi/types.rb +22 -555
- metadata +2 -2
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA1:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: fc3c58d0fbe4e15efc78ed9c78379e23688867d3
|
4
|
+
data.tar.gz: 2f36cee9591c50eff2a6bd294d2d83774b55254d
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 9dce6533167fd451473b19a9b9c9c313de0d5f2b0344370b70d06aa44af38150d89b14b911bccb73b3c5068f1d95d52445ffc376641b748d6d1f69a6f36e2b34
|
7
|
+
data.tar.gz: 948e36154fb8eb0978945d36eba5f79dfd3935e2600f57ed1350907cde98306b0fbbdc332bb8caf648a1def77d0f83cee08c1b64b9134e6b2d37c5a8795d918d
|
@@ -264,299 +264,11 @@ module Aws::ResourceGroupsTaggingAPI
|
|
264
264
|
|
265
265
|
# @!group API Operations
|
266
266
|
|
267
|
-
# Deletes the policy that is attached to the specified organization root
|
268
|
-
# or account.
|
269
|
-
#
|
270
|
-
# You can call this operation from the organization's master account
|
271
|
-
# only and from the us-east-1 Region only.
|
272
|
-
#
|
273
|
-
# @option params [required, String] :target_id
|
274
|
-
# The account ID or the root identifier of the organization. If you
|
275
|
-
# don't know the root ID, you can call the AWS Organizations
|
276
|
-
# [ListRoots][1] API to find it.
|
277
|
-
#
|
278
|
-
#
|
279
|
-
#
|
280
|
-
# [1]: http://docs.aws.amazon.com/organizations/latest/APIReference/API_ListRoots.html
|
281
|
-
#
|
282
|
-
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
283
|
-
#
|
284
|
-
# @example Request syntax with placeholder values
|
285
|
-
#
|
286
|
-
# resp = client.delete_tag_policy({
|
287
|
-
# target_id: "TargetId", # required
|
288
|
-
# })
|
289
|
-
#
|
290
|
-
# @see http://docs.aws.amazon.com/goto/WebAPI/resourcegroupstaggingapi-2017-01-26/DeleteTagPolicy AWS API Documentation
|
291
|
-
#
|
292
|
-
# @overload delete_tag_policy(params = {})
|
293
|
-
# @param [Hash] params ({})
|
294
|
-
def delete_tag_policy(params = {}, options = {})
|
295
|
-
req = build_request(:delete_tag_policy, params)
|
296
|
-
req.send_request(options)
|
297
|
-
end
|
298
|
-
|
299
|
-
# Describes the status of the `StartReportCreation` operation.
|
300
|
-
#
|
301
|
-
# You can call this operation from the organization's master account
|
302
|
-
# only and from the us-east-1 Region only.
|
303
|
-
#
|
304
|
-
# @return [Types::DescribeReportCreationOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
305
|
-
#
|
306
|
-
# * {Types::DescribeReportCreationOutput#status #status} => String
|
307
|
-
# * {Types::DescribeReportCreationOutput#s3_location #s3_location} => String
|
308
|
-
# * {Types::DescribeReportCreationOutput#error_message #error_message} => String
|
309
|
-
#
|
310
|
-
# @example Response structure
|
311
|
-
#
|
312
|
-
# resp.status #=> String
|
313
|
-
# resp.s3_location #=> String
|
314
|
-
# resp.error_message #=> String
|
315
|
-
#
|
316
|
-
# @see http://docs.aws.amazon.com/goto/WebAPI/resourcegroupstaggingapi-2017-01-26/DescribeReportCreation AWS API Documentation
|
317
|
-
#
|
318
|
-
# @overload describe_report_creation(params = {})
|
319
|
-
# @param [Hash] params ({})
|
320
|
-
def describe_report_creation(params = {}, options = {})
|
321
|
-
req = build_request(:describe_report_creation, params)
|
322
|
-
req.send_request(options)
|
323
|
-
end
|
324
|
-
|
325
|
-
# Disables tag policies for your organization and deletes all tag
|
326
|
-
# policies.
|
327
|
-
#
|
328
|
-
# You can call this operation from the organization's master account
|
329
|
-
# only and from the us-east-1 Region only.
|
330
|
-
#
|
331
|
-
# Use caution when disabling tag policies, as this is a destructive
|
332
|
-
# operation that applies to your entire organization. You cannot undo
|
333
|
-
# this operation.
|
334
|
-
#
|
335
|
-
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
336
|
-
#
|
337
|
-
# @see http://docs.aws.amazon.com/goto/WebAPI/resourcegroupstaggingapi-2017-01-26/DisableTagPolicies AWS API Documentation
|
338
|
-
#
|
339
|
-
# @overload disable_tag_policies(params = {})
|
340
|
-
# @param [Hash] params ({})
|
341
|
-
def disable_tag_policies(params = {}, options = {})
|
342
|
-
req = build_request(:disable_tag_policies, params)
|
343
|
-
req.send_request(options)
|
344
|
-
end
|
345
|
-
|
346
|
-
# Enables tag policies for your organization. To use tag policies, you
|
347
|
-
# must be using AWS Organizations with all features enabled.
|
348
|
-
#
|
349
|
-
# You can call this operation from the organization's master account
|
350
|
-
# only and from the us-east-1 Region only.
|
351
|
-
#
|
352
|
-
# This operation does the following:
|
353
|
-
#
|
354
|
-
# * Enables tag policies for the specified organization.
|
355
|
-
#
|
356
|
-
# * Calls the [EnableAWSServiceAccess][1] API on your behalf to allow
|
357
|
-
# service access with the `tagpolicies.tag.amazonaws.com` service
|
358
|
-
# principal.
|
359
|
-
#
|
360
|
-
# * Creates a [service-linked role][2] named
|
361
|
-
# `AWSServiceRoleForTagPolicies`.
|
362
|
-
#
|
363
|
-
# For more information on tag policies, see [Tag Policies][3] in the
|
364
|
-
# *AWS Resource Groups User Guide.*
|
365
|
-
#
|
366
|
-
#
|
367
|
-
#
|
368
|
-
# [1]: http://docs.aws.amazon.com/organizations/latest/APIReference/API_EnableAWSServiceAccess.html
|
369
|
-
# [2]: http://docs.aws.amazon.com/IAM/latest/UserGuide/using-service-linked-roles.html
|
370
|
-
# [3]: http://docs.aws.amazon.com/ARG/latest/userguide/tag-policies.html
|
371
|
-
#
|
372
|
-
# @option params [required, String] :root_id
|
373
|
-
# The root identifier of the organization. If you don't know the root
|
374
|
-
# ID, you can call the AWS Organizations [ListRoots][1] API to find it.
|
375
|
-
#
|
376
|
-
#
|
377
|
-
#
|
378
|
-
# [1]: http://docs.aws.amazon.com/organizations/latest/APIReference/API_ListRoots.html
|
379
|
-
#
|
380
|
-
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
381
|
-
#
|
382
|
-
# @example Request syntax with placeholder values
|
383
|
-
#
|
384
|
-
# resp = client.enable_tag_policies({
|
385
|
-
# root_id: "RootId", # required
|
386
|
-
# })
|
387
|
-
#
|
388
|
-
# @see http://docs.aws.amazon.com/goto/WebAPI/resourcegroupstaggingapi-2017-01-26/EnableTagPolicies AWS API Documentation
|
389
|
-
#
|
390
|
-
# @overload enable_tag_policies(params = {})
|
391
|
-
# @param [Hash] params ({})
|
392
|
-
def enable_tag_policies(params = {}, options = {})
|
393
|
-
req = build_request(:enable_tag_policies, params)
|
394
|
-
req.send_request(options)
|
395
|
-
end
|
396
|
-
|
397
|
-
# Returns a table that shows counts of resources that are noncompliant
|
398
|
-
# with their tag policies.
|
399
|
-
#
|
400
|
-
# For more information on tag policies, see [Tag Policies][1] in the
|
401
|
-
# *AWS Resource Groups User Guide.*
|
402
|
-
#
|
403
|
-
# You can call this operation from the organization's master account
|
404
|
-
# only and from the us-east-1 Region only.
|
405
|
-
#
|
406
|
-
#
|
407
|
-
#
|
408
|
-
# [1]: http://docs.aws.amazon.com/ARG/latest/userguide/tag-policies.html
|
409
|
-
#
|
410
|
-
# @option params [Array<String>] :target_id_filters
|
411
|
-
# The target identifiers (usually, specific account IDs) to limit the
|
412
|
-
# output by. If you use this parameter, the count of returned
|
413
|
-
# noncompliant resources includes only resources in the specified target
|
414
|
-
# IDs.
|
415
|
-
#
|
416
|
-
# @option params [Array<String>] :region_filters
|
417
|
-
# A list of Regions to limit the output by. If you use this parameter,
|
418
|
-
# the count of returned noncompliant resources includes only resources
|
419
|
-
# in the specified Regions.
|
420
|
-
#
|
421
|
-
# @option params [Array<String>] :resource_type_filters
|
422
|
-
# The constraints on the resources that you want returned. The format of
|
423
|
-
# each resource type is `service[:resourceType]`. For example,
|
424
|
-
# specifying a resource type of `ec2` returns all Amazon EC2 resources
|
425
|
-
# (which includes EC2 instances). Specifying a resource type of
|
426
|
-
# `ec2:instance` returns only EC2 instances.
|
427
|
-
#
|
428
|
-
# The string for each service name and resource type is the same as that
|
429
|
-
# embedded in a resource's Amazon Resource Name (ARN). Consult the *AWS
|
430
|
-
# General Reference* for the following:
|
431
|
-
#
|
432
|
-
# * For a list of service name strings, see [AWS Service Namespaces][1].
|
433
|
-
#
|
434
|
-
# * For resource type strings, see [Example ARNs][2].
|
435
|
-
#
|
436
|
-
# * For more information about ARNs, see [Amazon Resource Names (ARNs)
|
437
|
-
# and AWS Service Namespaces][3].
|
438
|
-
#
|
439
|
-
# You can specify multiple resource types by using an array. The array
|
440
|
-
# can include up to 100 items. Note that the length constraint
|
441
|
-
# requirement applies to each resource type filter.
|
442
|
-
#
|
443
|
-
#
|
444
|
-
#
|
445
|
-
# [1]: http://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html#genref-aws-service-namespaces
|
446
|
-
# [2]: http://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html#arns-syntax
|
447
|
-
# [3]: http://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html
|
448
|
-
#
|
449
|
-
# @option params [Array<String>] :tag_key_filters
|
450
|
-
# A list of tag keys to limit the output by. If you use this parameter,
|
451
|
-
# the count of returned noncompliant resources includes only resources
|
452
|
-
# that have the specified tag keys.
|
453
|
-
#
|
454
|
-
# @option params [Array<String>] :group_by
|
455
|
-
# A list of attributes to group the counts of noncompliant resources by.
|
456
|
-
# If supplied, the counts are sorted by those attributes.
|
457
|
-
#
|
458
|
-
# @option params [Integer] :max_results
|
459
|
-
# A limit that restricts the number of results that are returned per
|
460
|
-
# page.
|
461
|
-
#
|
462
|
-
# @option params [String] :pagination_token
|
463
|
-
# A string that indicates that additional data is available. Leave this
|
464
|
-
# value empty for your initial request. If the response includes a
|
465
|
-
# `PaginationToken`, use that string for this value to request an
|
466
|
-
# additional page of data.
|
467
|
-
#
|
468
|
-
# @return [Types::GetComplianceSummaryOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
469
|
-
#
|
470
|
-
# * {Types::GetComplianceSummaryOutput#summary_list #summary_list} => Array<Types::Summary>
|
471
|
-
# * {Types::GetComplianceSummaryOutput#pagination_token #pagination_token} => String
|
472
|
-
#
|
473
|
-
# @example Request syntax with placeholder values
|
474
|
-
#
|
475
|
-
# resp = client.get_compliance_summary({
|
476
|
-
# target_id_filters: ["TargetId"],
|
477
|
-
# region_filters: ["Region"],
|
478
|
-
# resource_type_filters: ["AmazonResourceType"],
|
479
|
-
# tag_key_filters: ["TagKey"],
|
480
|
-
# group_by: ["TARGET_ID"], # accepts TARGET_ID, REGION, RESOURCE_TYPE
|
481
|
-
# max_results: 1,
|
482
|
-
# pagination_token: "PaginationToken",
|
483
|
-
# })
|
484
|
-
#
|
485
|
-
# @example Response structure
|
486
|
-
#
|
487
|
-
# resp.summary_list #=> Array
|
488
|
-
# resp.summary_list[0].last_updated #=> Time
|
489
|
-
# resp.summary_list[0].target_id #=> String
|
490
|
-
# resp.summary_list[0].region #=> String
|
491
|
-
# resp.summary_list[0].resource_type #=> String
|
492
|
-
# resp.summary_list[0].non_compliant_resources #=> Integer
|
493
|
-
# resp.pagination_token #=> String
|
494
|
-
#
|
495
|
-
# @see http://docs.aws.amazon.com/goto/WebAPI/resourcegroupstaggingapi-2017-01-26/GetComplianceSummary AWS API Documentation
|
496
|
-
#
|
497
|
-
# @overload get_compliance_summary(params = {})
|
498
|
-
# @param [Hash] params ({})
|
499
|
-
def get_compliance_summary(params = {}, options = {})
|
500
|
-
req = build_request(:get_compliance_summary, params)
|
501
|
-
req.send_request(options)
|
502
|
-
end
|
503
|
-
|
504
|
-
# Returns the contents of the effective tag policy for the AWS account.
|
505
|
-
# Depending on how you use tag policies, the effective tag policy for an
|
506
|
-
# account is one of the following:
|
507
|
-
#
|
508
|
-
# * The tag policy attached to the organization that the account belongs
|
509
|
-
# to.
|
510
|
-
#
|
511
|
-
# * The tag policy attached to the account.
|
512
|
-
#
|
513
|
-
# * The combination of both policies if tag policies are attached to the
|
514
|
-
# organization root and account.
|
515
|
-
#
|
516
|
-
# @option params [String] :target_id
|
517
|
-
# The unique identifier of the organization root or account whose tag
|
518
|
-
# policy you want returned.
|
519
|
-
#
|
520
|
-
# @return [Types::GetEffectiveTagPolicyOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
521
|
-
#
|
522
|
-
# * {Types::GetEffectiveTagPolicyOutput#policy #policy} => String
|
523
|
-
# * {Types::GetEffectiveTagPolicyOutput#last_updated #last_updated} => Time
|
524
|
-
#
|
525
|
-
# @example Request syntax with placeholder values
|
526
|
-
#
|
527
|
-
# resp = client.get_effective_tag_policy({
|
528
|
-
# target_id: "TargetId",
|
529
|
-
# })
|
530
|
-
#
|
531
|
-
# @example Response structure
|
532
|
-
#
|
533
|
-
# resp.policy #=> String
|
534
|
-
# resp.last_updated #=> Time
|
535
|
-
#
|
536
|
-
# @see http://docs.aws.amazon.com/goto/WebAPI/resourcegroupstaggingapi-2017-01-26/GetEffectiveTagPolicy AWS API Documentation
|
537
|
-
#
|
538
|
-
# @overload get_effective_tag_policy(params = {})
|
539
|
-
# @param [Hash] params ({})
|
540
|
-
def get_effective_tag_policy(params = {}, options = {})
|
541
|
-
req = build_request(:get_effective_tag_policy, params)
|
542
|
-
req.send_request(options)
|
543
|
-
end
|
544
|
-
|
545
267
|
# Returns all the tagged or previously tagged resources that are located
|
546
|
-
# in the specified
|
547
|
-
#
|
548
|
-
#
|
549
|
-
# the
|
550
|
-
#
|
551
|
-
# * *Filters* that specify what tags and resource types you want
|
552
|
-
# returned. The response includes all tags that are associated with
|
553
|
-
# the requested resources.
|
554
|
-
#
|
555
|
-
# * Information about compliance with tag policies. If supplied, the
|
556
|
-
# compliance check follows the specified tag policy instead of
|
557
|
-
# following the effective tag policy. For more information on tag
|
558
|
-
# policies, see [Tag Policies][1] in the *AWS Resource Groups User
|
559
|
-
# Guide.*
|
268
|
+
# in the specified region for the AWS account. You can optionally
|
269
|
+
# specify *filters* (tags and resource types) in your request, depending
|
270
|
+
# on what information you want returned. The response includes all tags
|
271
|
+
# that are associated with the requested resources.
|
560
272
|
#
|
561
273
|
# <note markdown="1"> You can check the `PaginationToken` response parameter to determine if
|
562
274
|
# a query completed. Queries can occasionally return fewer results on a
|
@@ -565,10 +277,6 @@ module Aws::ResourceGroupsTaggingAPI
|
|
565
277
|
#
|
566
278
|
# </note>
|
567
279
|
#
|
568
|
-
#
|
569
|
-
#
|
570
|
-
# [1]: http://docs.aws.amazon.com/ARG/latest/userguide/tag-policies.html
|
571
|
-
#
|
572
280
|
# @option params [String] :pagination_token
|
573
281
|
# A string that indicates that additional data is available. Leave this
|
574
282
|
# value empty for your initial request. If the response includes a
|
@@ -601,19 +309,20 @@ module Aws::ResourceGroupsTaggingAPI
|
|
601
309
|
# * If you don't specify any values for a key, the response returns
|
602
310
|
# resources that are tagged with that key irrespective of the value.
|
603
311
|
#
|
604
|
-
# For example, for filters:
|
605
|
-
#
|
312
|
+
# For example, for filters: filter1 = \\\{key1, \\\{value1\\}\\},
|
313
|
+
# filter2 = \\\{key2, \\\{value2,value3,value4\\}\\} , filter3 =
|
314
|
+
# \\\{key3\\}:
|
606
315
|
#
|
607
|
-
# *
|
316
|
+
# * GetResources( \\\{filter1\\} ) returns resources tagged with
|
608
317
|
# key1=value1
|
609
318
|
#
|
610
|
-
# *
|
319
|
+
# * GetResources( \\\{filter2\\} ) returns resources tagged with
|
611
320
|
# key2=value2 or key2=value3 or key2=value4
|
612
321
|
#
|
613
|
-
# *
|
322
|
+
# * GetResources( \\\{filter3\\} ) returns resources tagged with any
|
614
323
|
# tag containing key3 as its tag key, irrespective of its value
|
615
324
|
#
|
616
|
-
# *
|
325
|
+
# * GetResources( \\\{filter1,filter2,filter3\\} ) returns resources
|
617
326
|
# tagged with ( key1=value1) and ( key2=value2 or key2=value3 or
|
618
327
|
# key2=value4) and (key3, irrespective of the value)
|
619
328
|
#
|
@@ -670,29 +379,6 @@ module Aws::ResourceGroupsTaggingAPI
|
|
670
379
|
# [2]: http://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html#arns-syntax
|
671
380
|
# [3]: http://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html
|
672
381
|
#
|
673
|
-
# @option params [Boolean] :include_compliance_details
|
674
|
-
# Specifies whether to include details regarding the compliance with the
|
675
|
-
# effective tag policy. Set this to `true` to determine whether
|
676
|
-
# resources are compliant with the tag policy and to get details.
|
677
|
-
#
|
678
|
-
# @option params [Boolean] :exclude_compliant_resources
|
679
|
-
# Specifies whether to exclude resources that are compliant with the tag
|
680
|
-
# policy. Set this to `true` if you are interested in retrieving
|
681
|
-
# information on noncompliant resources only.
|
682
|
-
#
|
683
|
-
# You can use this parameter only if the `IncludeComplianceDetails`
|
684
|
-
# parameter is also set to `true`.
|
685
|
-
#
|
686
|
-
# @option params [String] :policy
|
687
|
-
# The tag policy to check resources against for compliance. If supplied,
|
688
|
-
# the compliance check follows the specified tag policy instead of
|
689
|
-
# following the effective tag policy. Using this parameter to specify a
|
690
|
-
# tag policy is useful for testing new tag policies before attaching
|
691
|
-
# them to a target.
|
692
|
-
#
|
693
|
-
# You can only use this parameter if the `IncludeComplianceDetails`
|
694
|
-
# parameter is also set to `true`.
|
695
|
-
#
|
696
382
|
# @return [Types::GetResourcesOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
697
383
|
#
|
698
384
|
# * {Types::GetResourcesOutput#pagination_token #pagination_token} => String
|
@@ -711,9 +397,6 @@ module Aws::ResourceGroupsTaggingAPI
|
|
711
397
|
# resources_per_page: 1,
|
712
398
|
# tags_per_page: 1,
|
713
399
|
# resource_type_filters: ["AmazonResourceType"],
|
714
|
-
# include_compliance_details: false,
|
715
|
-
# exclude_compliant_resources: false,
|
716
|
-
# policy: "Policy",
|
717
400
|
# })
|
718
401
|
#
|
719
402
|
# @example Response structure
|
@@ -724,13 +407,6 @@ module Aws::ResourceGroupsTaggingAPI
|
|
724
407
|
# resp.resource_tag_mapping_list[0].tags #=> Array
|
725
408
|
# resp.resource_tag_mapping_list[0].tags[0].key #=> String
|
726
409
|
# resp.resource_tag_mapping_list[0].tags[0].value #=> String
|
727
|
-
# resp.resource_tag_mapping_list[0].compliance_details.missing_keys #=> Array
|
728
|
-
# resp.resource_tag_mapping_list[0].compliance_details.missing_keys[0] #=> String
|
729
|
-
# resp.resource_tag_mapping_list[0].compliance_details.invalid_keys #=> Array
|
730
|
-
# resp.resource_tag_mapping_list[0].compliance_details.invalid_keys[0] #=> String
|
731
|
-
# resp.resource_tag_mapping_list[0].compliance_details.invalid_values #=> Array
|
732
|
-
# resp.resource_tag_mapping_list[0].compliance_details.invalid_values[0] #=> String
|
733
|
-
# resp.resource_tag_mapping_list[0].compliance_details.compliance_status #=> Boolean
|
734
410
|
#
|
735
411
|
# @see http://docs.aws.amazon.com/goto/WebAPI/resourcegroupstaggingapi-2017-01-26/GetResources AWS API Documentation
|
736
412
|
#
|
@@ -741,25 +417,14 @@ module Aws::ResourceGroupsTaggingAPI
|
|
741
417
|
req.send_request(options)
|
742
418
|
end
|
743
419
|
|
744
|
-
# Returns all tag keys in the specified
|
745
|
-
#
|
746
|
-
# <note markdown="1"> You can check the `PaginationToken` response parameter to determine if
|
747
|
-
# a query completed. Queries can occasionally return fewer results on a
|
748
|
-
# page than allowed. The `PaginationToken` response parameter value is
|
749
|
-
# `null` *only* when there are no more results to display.
|
750
|
-
#
|
751
|
-
# </note>
|
420
|
+
# Returns all tag keys in the specified region for the AWS account.
|
752
421
|
#
|
753
422
|
# @option params [String] :pagination_token
|
754
423
|
# A string that indicates that additional data is available. Leave this
|
755
424
|
# value empty for your initial request. If the response includes a
|
756
|
-
#
|
425
|
+
# PaginationToken, use that string for this value to request an
|
757
426
|
# additional page of data.
|
758
427
|
#
|
759
|
-
# @option params [Integer] :max_results
|
760
|
-
# A limit that restricts the number of results that are returned per
|
761
|
-
# page.
|
762
|
-
#
|
763
428
|
# @return [Types::GetTagKeysOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
764
429
|
#
|
765
430
|
# * {Types::GetTagKeysOutput#pagination_token #pagination_token} => String
|
@@ -769,7 +434,6 @@ module Aws::ResourceGroupsTaggingAPI
|
|
769
434
|
#
|
770
435
|
# resp = client.get_tag_keys({
|
771
436
|
# pagination_token: "PaginationToken",
|
772
|
-
# max_results: 1,
|
773
437
|
# })
|
774
438
|
#
|
775
439
|
# @example Response structure
|
@@ -787,68 +451,18 @@ module Aws::ResourceGroupsTaggingAPI
|
|
787
451
|
req.send_request(options)
|
788
452
|
end
|
789
453
|
|
790
|
-
# Returns
|
791
|
-
#
|
792
|
-
# You can call this operation from the organization's master account
|
793
|
-
# only and from the us-east-1 Region only.
|
794
|
-
#
|
795
|
-
# @option params [required, String] :target_id
|
796
|
-
# The account ID or the root identifier of the organization. If you
|
797
|
-
# don't know the root ID, you can call the AWS Organizations
|
798
|
-
# [ListRoots][1] API to find it.
|
799
|
-
#
|
800
|
-
#
|
801
|
-
#
|
802
|
-
# [1]: http://docs.aws.amazon.com/organizations/latest/APIReference/API_ListRoots.html
|
803
|
-
#
|
804
|
-
# @return [Types::GetTagPolicyOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
805
|
-
#
|
806
|
-
# * {Types::GetTagPolicyOutput#policy #policy} => String
|
807
|
-
# * {Types::GetTagPolicyOutput#last_updated #last_updated} => Time
|
808
|
-
#
|
809
|
-
# @example Request syntax with placeholder values
|
810
|
-
#
|
811
|
-
# resp = client.get_tag_policy({
|
812
|
-
# target_id: "TargetId", # required
|
813
|
-
# })
|
814
|
-
#
|
815
|
-
# @example Response structure
|
816
|
-
#
|
817
|
-
# resp.policy #=> String
|
818
|
-
# resp.last_updated #=> Time
|
819
|
-
#
|
820
|
-
# @see http://docs.aws.amazon.com/goto/WebAPI/resourcegroupstaggingapi-2017-01-26/GetTagPolicy AWS API Documentation
|
821
|
-
#
|
822
|
-
# @overload get_tag_policy(params = {})
|
823
|
-
# @param [Hash] params ({})
|
824
|
-
def get_tag_policy(params = {}, options = {})
|
825
|
-
req = build_request(:get_tag_policy, params)
|
826
|
-
req.send_request(options)
|
827
|
-
end
|
828
|
-
|
829
|
-
# Returns all tag values for the specified key in the specified Region
|
454
|
+
# Returns all tag values for the specified key in the specified region
|
830
455
|
# for the AWS account.
|
831
456
|
#
|
832
|
-
# <note markdown="1"> You can check the `PaginationToken` response parameter to determine if
|
833
|
-
# a query completed. Queries can occasionally return fewer results on a
|
834
|
-
# page than allowed. The `PaginationToken` response parameter value is
|
835
|
-
# `null` *only* when there are no more results to display.
|
836
|
-
#
|
837
|
-
# </note>
|
838
|
-
#
|
839
457
|
# @option params [String] :pagination_token
|
840
458
|
# A string that indicates that additional data is available. Leave this
|
841
459
|
# value empty for your initial request. If the response includes a
|
842
|
-
#
|
460
|
+
# PaginationToken, use that string for this value to request an
|
843
461
|
# additional page of data.
|
844
462
|
#
|
845
463
|
# @option params [required, String] :key
|
846
464
|
# The key for which you want to list all existing values in the
|
847
|
-
# specified
|
848
|
-
#
|
849
|
-
# @option params [Integer] :max_results
|
850
|
-
# A limit that restricts the number of results that are returned per
|
851
|
-
# page.
|
465
|
+
# specified region for the AWS account.
|
852
466
|
#
|
853
467
|
# @return [Types::GetTagValuesOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
854
468
|
#
|
@@ -860,7 +474,6 @@ module Aws::ResourceGroupsTaggingAPI
|
|
860
474
|
# resp = client.get_tag_values({
|
861
475
|
# pagination_token: "PaginationToken",
|
862
476
|
# key: "TagKey", # required
|
863
|
-
# max_results: 1,
|
864
477
|
# })
|
865
478
|
#
|
866
479
|
# @example Response structure
|
@@ -878,120 +491,36 @@ module Aws::ResourceGroupsTaggingAPI
|
|
878
491
|
req.send_request(options)
|
879
492
|
end
|
880
493
|
|
881
|
-
# Validates the tag policy and then attaches it to the account or
|
882
|
-
# organization root. This policy determines whether a resource is
|
883
|
-
# compliant.
|
884
|
-
#
|
885
|
-
# Validating the tag policy includes checking that the tag policy
|
886
|
-
# document includes the required components, uses JSON syntax, and has
|
887
|
-
# fewer than 5,000 characters (including spaces). For more information,
|
888
|
-
# see [Tag Policy Structure][1] in the *AWS Resource Groups User Guide.*
|
889
|
-
#
|
890
|
-
# <note markdown="1"> If you later call this operation to attach a tag policy to the same
|
891
|
-
# organization root or account, it overwrites the original call without
|
892
|
-
# prompting you to confirm.
|
893
|
-
#
|
894
|
-
# </note>
|
895
|
-
#
|
896
|
-
# You can call this operation from the organization's master account
|
897
|
-
# only, and from the us-east-1 Region only.
|
898
|
-
#
|
899
|
-
#
|
900
|
-
#
|
901
|
-
# [1]: http://docs.aws.amazon.com/ARG/latest/userguide/tag-policies-structure.html
|
902
|
-
#
|
903
|
-
# @option params [required, String] :target_id
|
904
|
-
# The account ID or the root identifier of the organization. If you
|
905
|
-
# don't know the root ID, you can call the AWS Organizations
|
906
|
-
# [ListRoots][1] API to find it.
|
907
|
-
#
|
908
|
-
#
|
909
|
-
#
|
910
|
-
# [1]: http://docs.aws.amazon.com/organizations/latest/APIReference/API_ListRoots.html
|
911
|
-
#
|
912
|
-
# @option params [required, String] :policy
|
913
|
-
# The tag policy to attach to the target.
|
914
|
-
#
|
915
|
-
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
916
|
-
#
|
917
|
-
# @example Request syntax with placeholder values
|
918
|
-
#
|
919
|
-
# resp = client.put_tag_policy({
|
920
|
-
# target_id: "TargetId", # required
|
921
|
-
# policy: "Policy", # required
|
922
|
-
# })
|
923
|
-
#
|
924
|
-
# @see http://docs.aws.amazon.com/goto/WebAPI/resourcegroupstaggingapi-2017-01-26/PutTagPolicy AWS API Documentation
|
925
|
-
#
|
926
|
-
# @overload put_tag_policy(params = {})
|
927
|
-
# @param [Hash] params ({})
|
928
|
-
def put_tag_policy(params = {}, options = {})
|
929
|
-
req = build_request(:put_tag_policy, params)
|
930
|
-
req.send_request(options)
|
931
|
-
end
|
932
|
-
|
933
|
-
# Generates a report that lists all tagged resources in accounts across
|
934
|
-
# your organization, and whether each resource is compliant with the
|
935
|
-
# effective tag policy.
|
936
|
-
#
|
937
|
-
# You can call this operation from the organization's master account
|
938
|
-
# only and from the us-east-1 Region only.
|
939
|
-
#
|
940
|
-
# @option params [required, String] :s3_bucket
|
941
|
-
# The name of the Amazon S3 bucket where the report will be stored.
|
942
|
-
#
|
943
|
-
# For more information on S3 bucket requirements, including an example
|
944
|
-
# bucket policy, see [Additional Requirements for Running
|
945
|
-
# Organization-Wide Tag Compliance Report][1] in the *AWS Resource
|
946
|
-
# Groups User Guide.*
|
947
|
-
#
|
948
|
-
#
|
949
|
-
#
|
950
|
-
# [1]: http://docs.aws.amazon.com/ARG/latest/userguide/tag-policies-prereqs.html#bucket-policy-org-report
|
951
|
-
#
|
952
|
-
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
953
|
-
#
|
954
|
-
# @example Request syntax with placeholder values
|
955
|
-
#
|
956
|
-
# resp = client.start_report_creation({
|
957
|
-
# s3_bucket: "S3Bucket", # required
|
958
|
-
# })
|
959
|
-
#
|
960
|
-
# @see http://docs.aws.amazon.com/goto/WebAPI/resourcegroupstaggingapi-2017-01-26/StartReportCreation AWS API Documentation
|
961
|
-
#
|
962
|
-
# @overload start_report_creation(params = {})
|
963
|
-
# @param [Hash] params ({})
|
964
|
-
def start_report_creation(params = {}, options = {})
|
965
|
-
req = build_request(:start_report_creation, params)
|
966
|
-
req.send_request(options)
|
967
|
-
end
|
968
|
-
|
969
494
|
# Applies one or more tags to the specified resources. Note the
|
970
495
|
# following:
|
971
496
|
#
|
972
497
|
# * Not all resources can have tags. For a list of resources that
|
973
|
-
# support tagging, see [
|
498
|
+
# support tagging, see [Supported Resources][1] in the *AWS Resource
|
499
|
+
# Groups User Guide*.
|
974
500
|
#
|
975
|
-
# * Each resource can have up to 50 tags.
|
501
|
+
# * Each resource can have up to 50 tags. For other limits, see [Tag
|
502
|
+
# Restrictions][2] in the *Amazon EC2 User Guide for Linux Instances*.
|
976
503
|
#
|
977
|
-
# * You can only tag resources that are located in the specified
|
504
|
+
# * You can only tag resources that are located in the specified region
|
978
505
|
# for the AWS account.
|
979
506
|
#
|
980
507
|
# * To add tags to a resource, you need the necessary permissions for
|
981
508
|
# the service that the resource belongs to as well as permissions for
|
982
|
-
# adding tags. For more information, see [
|
983
|
-
# the *AWS Resource Groups User Guide
|
509
|
+
# adding tags. For more information, see [Obtaining Permissions for
|
510
|
+
# Tagging][3] in the *AWS Resource Groups User Guide*.
|
984
511
|
#
|
985
512
|
#
|
986
513
|
#
|
987
|
-
# [1]:
|
988
|
-
# [2]: http://docs.aws.amazon.com/
|
514
|
+
# [1]: http://docs.aws.amazon.com/ARG/latest/userguide/supported-resources.html
|
515
|
+
# [2]: http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/Using_Tags.html#tag-restrictions
|
516
|
+
# [3]: http://docs.aws.amazon.com/ARG/latest/userguide/obtaining-permissions-for-tagging.html
|
989
517
|
#
|
990
518
|
# @option params [required, Array<String>] :resource_arn_list
|
991
519
|
# A list of ARNs. An ARN (Amazon Resource Name) uniquely identifies a
|
992
520
|
# resource. You can specify a minimum of 1 and a maximum of 20 ARNs
|
993
|
-
# (resources) to tag.
|
994
|
-
#
|
521
|
+
# (resources) to tag. An ARN can be set to a maximum of 1600 characters.
|
522
|
+
# For more information, see [Amazon Resource Names (ARNs) and AWS
|
523
|
+
# Service Namespaces][1] in the *AWS General Reference*.
|
995
524
|
#
|
996
525
|
#
|
997
526
|
#
|
@@ -1037,21 +566,22 @@ module Aws::ResourceGroupsTaggingAPI
|
|
1037
566
|
#
|
1038
567
|
# * To remove tags from a resource, you need the necessary permissions
|
1039
568
|
# for the service that the resource belongs to as well as permissions
|
1040
|
-
# for removing tags. For more information, see [
|
1041
|
-
# in the *AWS Resource Groups User Guide
|
569
|
+
# for removing tags. For more information, see [Obtaining Permissions
|
570
|
+
# for Tagging][1] in the *AWS Resource Groups User Guide*.
|
1042
571
|
#
|
1043
|
-
# * You can only tag resources that are located in the specified
|
572
|
+
# * You can only tag resources that are located in the specified region
|
1044
573
|
# for the AWS account.
|
1045
574
|
#
|
1046
575
|
#
|
1047
576
|
#
|
1048
|
-
# [1]: http://docs.aws.amazon.com/ARG/latest/userguide/
|
577
|
+
# [1]: http://docs.aws.amazon.com/ARG/latest/userguide/obtaining-permissions-for-tagging.html
|
1049
578
|
#
|
1050
579
|
# @option params [required, Array<String>] :resource_arn_list
|
1051
580
|
# A list of ARNs. An ARN (Amazon Resource Name) uniquely identifies a
|
1052
581
|
# resource. You can specify a minimum of 1 and a maximum of 20 ARNs
|
1053
|
-
# (resources) to untag.
|
1054
|
-
#
|
582
|
+
# (resources) to untag. An ARN can be set to a maximum of 1600
|
583
|
+
# characters. For more information, see [Amazon Resource Names (ARNs)
|
584
|
+
# and AWS Service Namespaces][1] in the *AWS General Reference*.
|
1055
585
|
#
|
1056
586
|
#
|
1057
587
|
#
|
@@ -1101,7 +631,7 @@ module Aws::ResourceGroupsTaggingAPI
|
|
1101
631
|
params: params,
|
1102
632
|
config: config)
|
1103
633
|
context[:gem_name] = 'aws-sdk-resourcegroupstaggingapi'
|
1104
|
-
context[:gem_version] = '1.
|
634
|
+
context[:gem_version] = '1.15.0'
|
1105
635
|
Seahorse::Client::Request.new(handlers, context)
|
1106
636
|
end
|
1107
637
|
|