aws-sdk-resourcegroupstaggingapi 1.13.0 → 1.14.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 +555 -48
- data/lib/aws-sdk-resourcegroupstaggingapi/client_api.rb +257 -0
- data/lib/aws-sdk-resourcegroupstaggingapi/errors.rb +32 -0
- data/lib/aws-sdk-resourcegroupstaggingapi/types.rb +596 -31
- 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: 02f79fcf224e6af22954524f0030dfd7bdd3d191
|
4
|
+
data.tar.gz: 8d8acebc5c70e06018bbf0dc7f6af68f03a38071
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: b094878e241eecfd8d9c00e57b45df4b8d3fbe0cf8dc6c7c44d35422c9afa6288643da009a86d68578b0cee0250eea0a2c139caac1bae34c4b5fc90de0ef7817
|
7
|
+
data.tar.gz: 2eef30b33801a836cdcbf32544562c4186a2fc3c7bffdf8005de672e004177605b7adc21d5b83b4c3e2c70cbdf65f24f5d64b2406860c8d6670852e6edc3038d
|
@@ -264,13 +264,310 @@ module Aws::ResourceGroupsTaggingAPI
|
|
264
264
|
|
265
265
|
# @!group API Operations
|
266
266
|
|
267
|
-
#
|
268
|
-
#
|
269
|
-
#
|
270
|
-
#
|
271
|
-
#
|
272
|
-
#
|
273
|
-
#
|
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
|
+
# Returns all the tagged or previously tagged resources that are located
|
546
|
+
# in the specified Region for the AWS account.
|
547
|
+
#
|
548
|
+
# Depending on what information you want returned, you can also specify
|
549
|
+
# the following:
|
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.*
|
560
|
+
#
|
561
|
+
# <note markdown="1"> You can check the `PaginationToken` response parameter to determine if
|
562
|
+
# a query completed. Queries can occasionally return fewer results on a
|
563
|
+
# page than allowed. The `PaginationToken` response parameter value is
|
564
|
+
# `null` *only* when there are no more results to display.
|
565
|
+
#
|
566
|
+
# </note>
|
567
|
+
#
|
568
|
+
#
|
569
|
+
#
|
570
|
+
# [1]: http://docs.aws.amazon.com/ARG/latest/userguide/tag-policies.html
|
274
571
|
#
|
275
572
|
# @option params [String] :pagination_token
|
276
573
|
# A string that indicates that additional data is available. Leave this
|
@@ -279,21 +576,51 @@ module Aws::ResourceGroupsTaggingAPI
|
|
279
576
|
# additional page of data.
|
280
577
|
#
|
281
578
|
# @option params [Array<Types::TagFilter>] :tag_filters
|
282
|
-
# A list of
|
283
|
-
#
|
579
|
+
# A list of TagFilters (keys and values). Each TagFilter specified must
|
580
|
+
# contain a key with values as optional. A request can include up to 50
|
581
|
+
# keys, and each key can include up to 20 values.
|
284
582
|
#
|
285
|
-
#
|
286
|
-
# single request, the response returns only those resources that are
|
287
|
-
# associated with every specified filter.
|
583
|
+
# Note the following when deciding how to use TagFilters:
|
288
584
|
#
|
289
|
-
# If you specify
|
290
|
-
#
|
291
|
-
#
|
585
|
+
# * If you *do* specify a TagFilter, the response returns only those
|
586
|
+
# resources that are currently associated with the specified tag.
|
587
|
+
#
|
588
|
+
# * If you *don't* specify a TagFilter, the response includes all
|
589
|
+
# resources that were ever associated with tags. Resources that
|
590
|
+
# currently don't have associated tags are shown with an empty tag
|
591
|
+
# set, like this: `"Tags": []`.
|
592
|
+
#
|
593
|
+
# * If you specify more than one filter in a single request, the
|
594
|
+
# response returns only those resources that satisfy all specified
|
595
|
+
# filters.
|
596
|
+
#
|
597
|
+
# * If you specify a filter that contains more than one value for a key,
|
598
|
+
# the response returns resources that match any of the specified
|
599
|
+
# values for that key.
|
600
|
+
#
|
601
|
+
# * If you don't specify any values for a key, the response returns
|
602
|
+
# resources that are tagged with that key irrespective of the value.
|
603
|
+
#
|
604
|
+
# For example, for filters: `filter1 = \{key1, \{value1\}\}, filter2 =
|
605
|
+
# \{key2, \{value2,value3,value4\}\} , filter3 = \{key3\}`\:
|
606
|
+
#
|
607
|
+
# * `GetResources( \{filter1\} )` returns resources tagged with
|
608
|
+
# key1=value1
|
609
|
+
#
|
610
|
+
# * `GetResources( \{filter2\} )` returns resources tagged with
|
611
|
+
# key2=value2 or key2=value3 or key2=value4
|
612
|
+
#
|
613
|
+
# * `GetResources( \{filter3\} )` returns resources tagged with any
|
614
|
+
# tag containing key3 as its tag key, irrespective of its value
|
615
|
+
#
|
616
|
+
# * `GetResources( \{filter1,filter2,filter3\} )` returns resources
|
617
|
+
# tagged with ( key1=value1) and ( key2=value2 or key2=value3 or
|
618
|
+
# key2=value4) and (key3, irrespective of the value)
|
292
619
|
#
|
293
620
|
# @option params [Integer] :resources_per_page
|
294
621
|
# A limit that restricts the number of resources returned by
|
295
622
|
# GetResources in paginated output. You can set ResourcesPerPage to a
|
296
|
-
# minimum of 1 item and the maximum of
|
623
|
+
# minimum of 1 item and the maximum of 100 items.
|
297
624
|
#
|
298
625
|
# @option params [Integer] :tags_per_page
|
299
626
|
# A limit that restricts the number of tags (key and value pairs)
|
@@ -312,17 +639,15 @@ module Aws::ResourceGroupsTaggingAPI
|
|
312
639
|
# tags, and the third page displaying the remaining 2 resources, each
|
313
640
|
# with its 10 tags.
|
314
641
|
#
|
315
|
-
#
|
316
|
-
#
|
317
642
|
# You can set `TagsPerPage` to a minimum of 100 items and the maximum of
|
318
643
|
# 500 items.
|
319
644
|
#
|
320
645
|
# @option params [Array<String>] :resource_type_filters
|
321
646
|
# The constraints on the resources that you want returned. The format of
|
322
647
|
# each resource type is `service[:resourceType]`. For example,
|
323
|
-
# specifying a resource type of `ec2` returns all
|
324
|
-
#
|
325
|
-
#
|
648
|
+
# specifying a resource type of `ec2` returns all Amazon EC2 resources
|
649
|
+
# (which includes EC2 instances). Specifying a resource type of
|
650
|
+
# `ec2:instance` returns only EC2 instances.
|
326
651
|
#
|
327
652
|
# The string for each service name and resource type is the same as that
|
328
653
|
# embedded in a resource's Amazon Resource Name (ARN). Consult the *AWS
|
@@ -335,12 +660,39 @@ module Aws::ResourceGroupsTaggingAPI
|
|
335
660
|
# * For more information about ARNs, see [Amazon Resource Names (ARNs)
|
336
661
|
# and AWS Service Namespaces][3].
|
337
662
|
#
|
663
|
+
# You can specify multiple resource types by using an array. The array
|
664
|
+
# can include up to 100 items. Note that the length constraint
|
665
|
+
# requirement applies to each resource type filter.
|
666
|
+
#
|
338
667
|
#
|
339
668
|
#
|
340
669
|
# [1]: http://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html#genref-aws-service-namespaces
|
341
670
|
# [2]: http://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html#arns-syntax
|
342
671
|
# [3]: http://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html
|
343
672
|
#
|
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
|
+
#
|
344
696
|
# @return [Types::GetResourcesOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
345
697
|
#
|
346
698
|
# * {Types::GetResourcesOutput#pagination_token #pagination_token} => String
|
@@ -359,6 +711,9 @@ module Aws::ResourceGroupsTaggingAPI
|
|
359
711
|
# resources_per_page: 1,
|
360
712
|
# tags_per_page: 1,
|
361
713
|
# resource_type_filters: ["AmazonResourceType"],
|
714
|
+
# include_compliance_details: false,
|
715
|
+
# exclude_compliant_resources: false,
|
716
|
+
# policy: "Policy",
|
362
717
|
# })
|
363
718
|
#
|
364
719
|
# @example Response structure
|
@@ -369,6 +724,13 @@ module Aws::ResourceGroupsTaggingAPI
|
|
369
724
|
# resp.resource_tag_mapping_list[0].tags #=> Array
|
370
725
|
# resp.resource_tag_mapping_list[0].tags[0].key #=> String
|
371
726
|
# 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
|
372
734
|
#
|
373
735
|
# @see http://docs.aws.amazon.com/goto/WebAPI/resourcegroupstaggingapi-2017-01-26/GetResources AWS API Documentation
|
374
736
|
#
|
@@ -379,14 +741,25 @@ module Aws::ResourceGroupsTaggingAPI
|
|
379
741
|
req.send_request(options)
|
380
742
|
end
|
381
743
|
|
382
|
-
# Returns all tag keys in the specified
|
744
|
+
# Returns all tag keys in the specified Region for the AWS account.
|
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>
|
383
752
|
#
|
384
753
|
# @option params [String] :pagination_token
|
385
754
|
# A string that indicates that additional data is available. Leave this
|
386
755
|
# value empty for your initial request. If the response includes a
|
387
|
-
# PaginationToken
|
756
|
+
# `PaginationToken`, use that string for this value to request an
|
388
757
|
# additional page of data.
|
389
758
|
#
|
759
|
+
# @option params [Integer] :max_results
|
760
|
+
# A limit that restricts the number of results that are returned per
|
761
|
+
# page.
|
762
|
+
#
|
390
763
|
# @return [Types::GetTagKeysOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
391
764
|
#
|
392
765
|
# * {Types::GetTagKeysOutput#pagination_token #pagination_token} => String
|
@@ -396,6 +769,7 @@ module Aws::ResourceGroupsTaggingAPI
|
|
396
769
|
#
|
397
770
|
# resp = client.get_tag_keys({
|
398
771
|
# pagination_token: "PaginationToken",
|
772
|
+
# max_results: 1,
|
399
773
|
# })
|
400
774
|
#
|
401
775
|
# @example Response structure
|
@@ -413,18 +787,68 @@ module Aws::ResourceGroupsTaggingAPI
|
|
413
787
|
req.send_request(options)
|
414
788
|
end
|
415
789
|
|
416
|
-
# Returns
|
790
|
+
# Returns the policy that is attached to the specified target.
|
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
|
417
830
|
# for the AWS account.
|
418
831
|
#
|
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
|
+
#
|
419
839
|
# @option params [String] :pagination_token
|
420
840
|
# A string that indicates that additional data is available. Leave this
|
421
841
|
# value empty for your initial request. If the response includes a
|
422
|
-
# PaginationToken
|
842
|
+
# `PaginationToken`, use that string for this value to request an
|
423
843
|
# additional page of data.
|
424
844
|
#
|
425
845
|
# @option params [required, String] :key
|
426
846
|
# The key for which you want to list all existing values in the
|
427
|
-
# specified
|
847
|
+
# specified Region for the AWS account.
|
848
|
+
#
|
849
|
+
# @option params [Integer] :max_results
|
850
|
+
# A limit that restricts the number of results that are returned per
|
851
|
+
# page.
|
428
852
|
#
|
429
853
|
# @return [Types::GetTagValuesOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
430
854
|
#
|
@@ -436,6 +860,7 @@ module Aws::ResourceGroupsTaggingAPI
|
|
436
860
|
# resp = client.get_tag_values({
|
437
861
|
# pagination_token: "PaginationToken",
|
438
862
|
# key: "TagKey", # required
|
863
|
+
# max_results: 1,
|
439
864
|
# })
|
440
865
|
#
|
441
866
|
# @example Response structure
|
@@ -453,36 +878,120 @@ module Aws::ResourceGroupsTaggingAPI
|
|
453
878
|
req.send_request(options)
|
454
879
|
end
|
455
880
|
|
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
|
+
|
456
969
|
# Applies one or more tags to the specified resources. Note the
|
457
970
|
# following:
|
458
971
|
#
|
459
972
|
# * Not all resources can have tags. For a list of resources that
|
460
|
-
# support tagging, see [
|
461
|
-
# Groups and Tag Editor User Guide*.
|
973
|
+
# support tagging, see [this list][1].
|
462
974
|
#
|
463
|
-
# * Each resource can have up to 50 tags.
|
464
|
-
# Restrictions][2] in the *Amazon EC2 User Guide for Linux Instances*.
|
975
|
+
# * Each resource can have up to 50 tags.
|
465
976
|
#
|
466
|
-
# * You can only tag resources that are located in the specified
|
977
|
+
# * You can only tag resources that are located in the specified Region
|
467
978
|
# for the AWS account.
|
468
979
|
#
|
469
980
|
# * To add tags to a resource, you need the necessary permissions for
|
470
981
|
# the service that the resource belongs to as well as permissions for
|
471
|
-
# adding tags. For more information, see [
|
472
|
-
#
|
982
|
+
# adding tags. For more information, see [Set Up Permissions][2] in
|
983
|
+
# the *AWS Resource Groups User Guide.*
|
473
984
|
#
|
474
985
|
#
|
475
986
|
#
|
476
|
-
# [1]:
|
477
|
-
# [2]: http://docs.aws.amazon.com/
|
478
|
-
# [3]: http://docs.aws.amazon.com/awsconsolehelpdocs/latest/gsg/obtaining-permissions-for-tagging.html
|
987
|
+
# [1]: https://docs.aws.amazon.com/resourcegroupstagging/latest/APIReference/Welcome.html
|
988
|
+
# [2]: http://docs.aws.amazon.com/ARG/latest/userguide/gettingstarted-prereqs.html#rg-permissions
|
479
989
|
#
|
480
990
|
# @option params [required, Array<String>] :resource_arn_list
|
481
991
|
# A list of ARNs. An ARN (Amazon Resource Name) uniquely identifies a
|
482
992
|
# resource. You can specify a minimum of 1 and a maximum of 20 ARNs
|
483
|
-
# (resources) to tag.
|
484
|
-
#
|
485
|
-
# Service Namespaces][1] in the *AWS General Reference*.
|
993
|
+
# (resources) to tag. For more information, see [Amazon Resource Names
|
994
|
+
# (ARNs) and AWS Service Namespaces][1] in the *AWS General Reference*.
|
486
995
|
#
|
487
996
|
#
|
488
997
|
#
|
@@ -528,23 +1037,21 @@ module Aws::ResourceGroupsTaggingAPI
|
|
528
1037
|
#
|
529
1038
|
# * To remove tags from a resource, you need the necessary permissions
|
530
1039
|
# for the service that the resource belongs to as well as permissions
|
531
|
-
# for removing tags. For more information, see [
|
532
|
-
#
|
533
|
-
# Guide*.
|
1040
|
+
# for removing tags. For more information, see [Set Up Permissions][1]
|
1041
|
+
# in the *AWS Resource Groups User Guide.*
|
534
1042
|
#
|
535
|
-
# * You can only tag resources that are located in the specified
|
1043
|
+
# * You can only tag resources that are located in the specified Region
|
536
1044
|
# for the AWS account.
|
537
1045
|
#
|
538
1046
|
#
|
539
1047
|
#
|
540
|
-
# [1]: http://docs.aws.amazon.com/
|
1048
|
+
# [1]: http://docs.aws.amazon.com/ARG/latest/userguide/gettingstarted-prereqs.html#rg-permissions
|
541
1049
|
#
|
542
1050
|
# @option params [required, Array<String>] :resource_arn_list
|
543
1051
|
# A list of ARNs. An ARN (Amazon Resource Name) uniquely identifies a
|
544
1052
|
# resource. You can specify a minimum of 1 and a maximum of 20 ARNs
|
545
|
-
# (resources) to untag.
|
546
|
-
#
|
547
|
-
# and AWS Service Namespaces][1] in the *AWS General Reference*.
|
1053
|
+
# (resources) to untag. For more information, see [Amazon Resource Names
|
1054
|
+
# (ARNs) and AWS Service Namespaces][1] in the *AWS General Reference*.
|
548
1055
|
#
|
549
1056
|
#
|
550
1057
|
#
|
@@ -594,7 +1101,7 @@ module Aws::ResourceGroupsTaggingAPI
|
|
594
1101
|
params: params,
|
595
1102
|
config: config)
|
596
1103
|
context[:gem_name] = 'aws-sdk-resourcegroupstaggingapi'
|
597
|
-
context[:gem_version] = '1.
|
1104
|
+
context[:gem_version] = '1.14.0'
|
598
1105
|
Seahorse::Client::Request.new(handlers, context)
|
599
1106
|
end
|
600
1107
|
|