aws-sdk-resourcegroups 1.26.0 → 1.27.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/lib/aws-sdk-resourcegroups.rb +1 -1
- data/lib/aws-sdk-resourcegroups/client.rb +334 -84
- data/lib/aws-sdk-resourcegroups/client_api.rb +147 -24
- data/lib/aws-sdk-resourcegroups/types.rb +581 -145
- metadata +2 -2
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: d11deac8aab073e36e5c1f6ed18e872b6e532cddbede52d9a6eea6e6e39d24f1
|
4
|
+
data.tar.gz: c846995796d93f43edf31e8a61b0b152f6a6fa2b44fb785b576151586fa7fb02
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 57b6f38164521ee6695549f76e12e8880ec4dedf4c8fc4564f8cd4ff291cca6b9129858a527dc8ab2432508c971ba209ac665b8cc6f8ace3c4e57ea4716f80ab
|
7
|
+
data.tar.gz: bf6d5bc545861c81229f61123123bc7b74f242c72d4ada99248c02153e5a26963283ac5e924818a6d3523cdb56ec0e6eeb4fc40c90eda783015f16ecf7d784cd
|
@@ -312,50 +312,73 @@ module Aws::ResourceGroups
|
|
312
312
|
|
313
313
|
# @!group API Operations
|
314
314
|
|
315
|
-
# Creates a group with
|
316
|
-
# query.
|
315
|
+
# Creates a resource group with the specified name and description. You
|
316
|
+
# can optionally include a resource query, or a service configuration.
|
317
317
|
#
|
318
318
|
# @option params [required, String] :name
|
319
319
|
# The name of the group, which is the identifier of the group in other
|
320
|
-
# operations.
|
321
|
-
#
|
322
|
-
#
|
323
|
-
#
|
324
|
-
#
|
320
|
+
# operations. You can't change the name of a resource group after you
|
321
|
+
# create it. A resource group name can consist of letters, numbers,
|
322
|
+
# hyphens, periods, and underscores. The name cannot start with `AWS` or
|
323
|
+
# `aws`; these are reserved. A resource group name must be unique within
|
324
|
+
# each AWS Region in your AWS account.
|
325
325
|
#
|
326
326
|
# @option params [String] :description
|
327
|
-
# The description of the resource group. Descriptions can
|
328
|
-
#
|
329
|
-
# punctuation, and spaces.
|
327
|
+
# The description of the resource group. Descriptions can consist of
|
328
|
+
# letters, numbers, hyphens, underscores, periods, and spaces.
|
330
329
|
#
|
331
|
-
# @option params [
|
330
|
+
# @option params [Types::ResourceQuery] :resource_query
|
332
331
|
# The resource query that determines which AWS resources are members of
|
333
332
|
# this group.
|
334
333
|
#
|
334
|
+
# <note markdown="1"> You can specify either a `ResourceQuery` or a `Configuration`, but not
|
335
|
+
# both.
|
336
|
+
#
|
337
|
+
# </note>
|
338
|
+
#
|
335
339
|
# @option params [Hash<String,String>] :tags
|
336
|
-
# The tags to add to the group. A tag is
|
337
|
-
#
|
338
|
-
#
|
339
|
-
#
|
340
|
+
# The tags to add to the group. A tag is key-value pair string.
|
341
|
+
#
|
342
|
+
# @option params [Array<Types::GroupConfigurationItem>] :configuration
|
343
|
+
# A configuration associates the resource group with an AWS service and
|
344
|
+
# specifies how the service can interact with the resources in the
|
345
|
+
# group. A configuration is an array of GroupConfigurationItem elements.
|
346
|
+
#
|
347
|
+
# <note markdown="1"> You can specify either a `Configuration` or a `ResourceQuery` in a
|
348
|
+
# group, but not both.
|
349
|
+
#
|
350
|
+
# </note>
|
340
351
|
#
|
341
352
|
# @return [Types::CreateGroupOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
342
353
|
#
|
343
354
|
# * {Types::CreateGroupOutput#group #group} => Types::Group
|
344
355
|
# * {Types::CreateGroupOutput#resource_query #resource_query} => Types::ResourceQuery
|
345
356
|
# * {Types::CreateGroupOutput#tags #tags} => Hash<String,String>
|
357
|
+
# * {Types::CreateGroupOutput#group_configuration #group_configuration} => Types::GroupConfiguration
|
346
358
|
#
|
347
359
|
# @example Request syntax with placeholder values
|
348
360
|
#
|
349
361
|
# resp = client.create_group({
|
350
362
|
# name: "GroupName", # required
|
351
|
-
# description: "
|
352
|
-
# resource_query: {
|
363
|
+
# description: "Description",
|
364
|
+
# resource_query: {
|
353
365
|
# type: "TAG_FILTERS_1_0", # required, accepts TAG_FILTERS_1_0, CLOUDFORMATION_STACK_1_0
|
354
366
|
# query: "Query", # required
|
355
367
|
# },
|
356
368
|
# tags: {
|
357
369
|
# "TagKey" => "TagValue",
|
358
370
|
# },
|
371
|
+
# configuration: [
|
372
|
+
# {
|
373
|
+
# type: "GroupConfigurationType", # required
|
374
|
+
# parameters: [
|
375
|
+
# {
|
376
|
+
# name: "GroupConfigurationParameterName", # required
|
377
|
+
# values: ["GroupConfigurationParameterValue"],
|
378
|
+
# },
|
379
|
+
# ],
|
380
|
+
# },
|
381
|
+
# ],
|
359
382
|
# })
|
360
383
|
#
|
361
384
|
# @example Response structure
|
@@ -367,6 +390,20 @@ module Aws::ResourceGroups
|
|
367
390
|
# resp.resource_query.query #=> String
|
368
391
|
# resp.tags #=> Hash
|
369
392
|
# resp.tags["TagKey"] #=> String
|
393
|
+
# resp.group_configuration.configuration #=> Array
|
394
|
+
# resp.group_configuration.configuration[0].type #=> String
|
395
|
+
# resp.group_configuration.configuration[0].parameters #=> Array
|
396
|
+
# resp.group_configuration.configuration[0].parameters[0].name #=> String
|
397
|
+
# resp.group_configuration.configuration[0].parameters[0].values #=> Array
|
398
|
+
# resp.group_configuration.configuration[0].parameters[0].values[0] #=> String
|
399
|
+
# resp.group_configuration.proposed_configuration #=> Array
|
400
|
+
# resp.group_configuration.proposed_configuration[0].type #=> String
|
401
|
+
# resp.group_configuration.proposed_configuration[0].parameters #=> Array
|
402
|
+
# resp.group_configuration.proposed_configuration[0].parameters[0].name #=> String
|
403
|
+
# resp.group_configuration.proposed_configuration[0].parameters[0].values #=> Array
|
404
|
+
# resp.group_configuration.proposed_configuration[0].parameters[0].values[0] #=> String
|
405
|
+
# resp.group_configuration.status #=> String, one of "UPDATING", "UPDATE_COMPLETE", "UPDATE_FAILED"
|
406
|
+
# resp.group_configuration.failure_reason #=> String
|
370
407
|
#
|
371
408
|
# @see http://docs.aws.amazon.com/goto/WebAPI/resource-groups-2017-11-27/CreateGroup AWS API Documentation
|
372
409
|
#
|
@@ -377,12 +414,15 @@ module Aws::ResourceGroups
|
|
377
414
|
req.send_request(options)
|
378
415
|
end
|
379
416
|
|
380
|
-
# Deletes
|
381
|
-
# delete resources that are members of the group; it only
|
382
|
-
# group structure.
|
417
|
+
# Deletes the specified resource group. Deleting a resource group does
|
418
|
+
# not delete any resources that are members of the group; it only
|
419
|
+
# deletes the group structure.
|
383
420
|
#
|
384
|
-
# @option params [
|
385
|
-
#
|
421
|
+
# @option params [String] :group_name
|
422
|
+
# Don't use this parameter. Use `Group` instead.
|
423
|
+
#
|
424
|
+
# @option params [String] :group
|
425
|
+
# The name or the ARN of the resource group to delete.
|
386
426
|
#
|
387
427
|
# @return [Types::DeleteGroupOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
388
428
|
#
|
@@ -391,7 +431,8 @@ module Aws::ResourceGroups
|
|
391
431
|
# @example Request syntax with placeholder values
|
392
432
|
#
|
393
433
|
# resp = client.delete_group({
|
394
|
-
# group_name: "GroupName",
|
434
|
+
# group_name: "GroupName",
|
435
|
+
# group: "GroupString",
|
395
436
|
# })
|
396
437
|
#
|
397
438
|
# @example Response structure
|
@@ -411,8 +452,11 @@ module Aws::ResourceGroups
|
|
411
452
|
|
412
453
|
# Returns information about a specified resource group.
|
413
454
|
#
|
414
|
-
# @option params [
|
415
|
-
#
|
455
|
+
# @option params [String] :group_name
|
456
|
+
# Don't use this parameter. Use `Group` instead.
|
457
|
+
#
|
458
|
+
# @option params [String] :group
|
459
|
+
# The name or the ARN of the resource group to retrieve.
|
416
460
|
#
|
417
461
|
# @return [Types::GetGroupOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
418
462
|
#
|
@@ -421,7 +465,8 @@ module Aws::ResourceGroups
|
|
421
465
|
# @example Request syntax with placeholder values
|
422
466
|
#
|
423
467
|
# resp = client.get_group({
|
424
|
-
# group_name: "GroupName",
|
468
|
+
# group_name: "GroupName",
|
469
|
+
# group: "GroupString",
|
425
470
|
# })
|
426
471
|
#
|
427
472
|
# @example Response structure
|
@@ -439,11 +484,67 @@ module Aws::ResourceGroups
|
|
439
484
|
req.send_request(options)
|
440
485
|
end
|
441
486
|
|
442
|
-
# Returns the
|
487
|
+
# Returns the service configuration associated with the specified
|
488
|
+
# resource group. AWS Resource Groups supports configurations for the
|
489
|
+
# following resource group types:
|
490
|
+
#
|
491
|
+
# * `AWS::EC2::CapacityReservationPool` - Amazon EC2 capacity
|
492
|
+
# reservation pools. For more information, see [Working with capacity
|
493
|
+
# reservation groups][1] in the *EC2 Users Guide*.
|
494
|
+
#
|
495
|
+
# ^
|
496
|
+
#
|
497
|
+
#
|
498
|
+
#
|
499
|
+
# [1]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/capacity-reservations-using.html#create-cr-group
|
500
|
+
#
|
501
|
+
# @option params [String] :group
|
502
|
+
# The name or the ARN of the resource group.
|
503
|
+
#
|
504
|
+
# @return [Types::GetGroupConfigurationOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
505
|
+
#
|
506
|
+
# * {Types::GetGroupConfigurationOutput#group_configuration #group_configuration} => Types::GroupConfiguration
|
507
|
+
#
|
508
|
+
# @example Request syntax with placeholder values
|
509
|
+
#
|
510
|
+
# resp = client.get_group_configuration({
|
511
|
+
# group: "GroupString",
|
512
|
+
# })
|
513
|
+
#
|
514
|
+
# @example Response structure
|
515
|
+
#
|
516
|
+
# resp.group_configuration.configuration #=> Array
|
517
|
+
# resp.group_configuration.configuration[0].type #=> String
|
518
|
+
# resp.group_configuration.configuration[0].parameters #=> Array
|
519
|
+
# resp.group_configuration.configuration[0].parameters[0].name #=> String
|
520
|
+
# resp.group_configuration.configuration[0].parameters[0].values #=> Array
|
521
|
+
# resp.group_configuration.configuration[0].parameters[0].values[0] #=> String
|
522
|
+
# resp.group_configuration.proposed_configuration #=> Array
|
523
|
+
# resp.group_configuration.proposed_configuration[0].type #=> String
|
524
|
+
# resp.group_configuration.proposed_configuration[0].parameters #=> Array
|
525
|
+
# resp.group_configuration.proposed_configuration[0].parameters[0].name #=> String
|
526
|
+
# resp.group_configuration.proposed_configuration[0].parameters[0].values #=> Array
|
527
|
+
# resp.group_configuration.proposed_configuration[0].parameters[0].values[0] #=> String
|
528
|
+
# resp.group_configuration.status #=> String, one of "UPDATING", "UPDATE_COMPLETE", "UPDATE_FAILED"
|
529
|
+
# resp.group_configuration.failure_reason #=> String
|
530
|
+
#
|
531
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/resource-groups-2017-11-27/GetGroupConfiguration AWS API Documentation
|
532
|
+
#
|
533
|
+
# @overload get_group_configuration(params = {})
|
534
|
+
# @param [Hash] params ({})
|
535
|
+
def get_group_configuration(params = {}, options = {})
|
536
|
+
req = build_request(:get_group_configuration, params)
|
537
|
+
req.send_request(options)
|
538
|
+
end
|
539
|
+
|
540
|
+
# Retrieves the resource query associated with the specified resource
|
443
541
|
# group.
|
444
542
|
#
|
445
|
-
# @option params [
|
446
|
-
#
|
543
|
+
# @option params [String] :group_name
|
544
|
+
# Don't use this parameter. Use `Group` instead.
|
545
|
+
#
|
546
|
+
# @option params [String] :group
|
547
|
+
# The name or the ARN of the resource group to query.
|
447
548
|
#
|
448
549
|
# @return [Types::GetGroupQueryOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
449
550
|
#
|
@@ -452,7 +553,8 @@ module Aws::ResourceGroups
|
|
452
553
|
# @example Request syntax with placeholder values
|
453
554
|
#
|
454
555
|
# resp = client.get_group_query({
|
455
|
-
# group_name: "GroupName",
|
556
|
+
# group_name: "GroupName",
|
557
|
+
# group: "GroupString",
|
456
558
|
# })
|
457
559
|
#
|
458
560
|
# @example Response structure
|
@@ -474,8 +576,7 @@ module Aws::ResourceGroups
|
|
474
576
|
# specified by an ARN.
|
475
577
|
#
|
476
578
|
# @option params [required, String] :arn
|
477
|
-
# The ARN of the resource group
|
478
|
-
# resource must exist within the account you are using.
|
579
|
+
# The ARN of the resource group whose tags you want to retrieve.
|
479
580
|
#
|
480
581
|
# @return [Types::GetTagsOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
481
582
|
#
|
@@ -503,31 +604,101 @@ module Aws::ResourceGroups
|
|
503
604
|
req.send_request(options)
|
504
605
|
end
|
505
606
|
|
607
|
+
# Adds the specified resources to the specified group.
|
608
|
+
#
|
609
|
+
# @option params [required, String] :group
|
610
|
+
# The name or the ARN of the resource group to add resources to.
|
611
|
+
#
|
612
|
+
# @option params [required, Array<String>] :resource_arns
|
613
|
+
# The list of ARNs for resources to be added to the group.
|
614
|
+
#
|
615
|
+
# @return [Types::GroupResourcesOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
616
|
+
#
|
617
|
+
# * {Types::GroupResourcesOutput#succeeded #succeeded} => Array<String>
|
618
|
+
# * {Types::GroupResourcesOutput#failed #failed} => Array<Types::FailedResource>
|
619
|
+
#
|
620
|
+
# @example Request syntax with placeholder values
|
621
|
+
#
|
622
|
+
# resp = client.group_resources({
|
623
|
+
# group: "GroupString", # required
|
624
|
+
# resource_arns: ["ResourceArn"], # required
|
625
|
+
# })
|
626
|
+
#
|
627
|
+
# @example Response structure
|
628
|
+
#
|
629
|
+
# resp.succeeded #=> Array
|
630
|
+
# resp.succeeded[0] #=> String
|
631
|
+
# resp.failed #=> Array
|
632
|
+
# resp.failed[0].resource_arn #=> String
|
633
|
+
# resp.failed[0].error_message #=> String
|
634
|
+
# resp.failed[0].error_code #=> String
|
635
|
+
#
|
636
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/resource-groups-2017-11-27/GroupResources AWS API Documentation
|
637
|
+
#
|
638
|
+
# @overload group_resources(params = {})
|
639
|
+
# @param [Hash] params ({})
|
640
|
+
def group_resources(params = {}, options = {})
|
641
|
+
req = build_request(:group_resources, params)
|
642
|
+
req.send_request(options)
|
643
|
+
end
|
644
|
+
|
506
645
|
# Returns a list of ARNs of resources that are members of a specified
|
507
646
|
# resource group.
|
508
647
|
#
|
509
|
-
# @option params [
|
510
|
-
#
|
648
|
+
# @option params [String] :group_name
|
649
|
+
# Don't use this parameter. Use `Group` instead.
|
650
|
+
#
|
651
|
+
# @option params [String] :group
|
652
|
+
# The name or the ARN of the resource group
|
511
653
|
#
|
512
654
|
# @option params [Array<Types::ResourceFilter>] :filters
|
513
655
|
# Filters, formatted as ResourceFilter objects, that you want to apply
|
514
|
-
# to a ListGroupResources operation.
|
656
|
+
# to a `ListGroupResources` operation. Filters the results to include
|
657
|
+
# only those of the specified resource types.
|
515
658
|
#
|
516
659
|
# * `resource-type` - Filter resources by their type. Specify up to five
|
517
|
-
# resource types in the format AWS::ServiceCode::ResourceType
|
518
|
-
# example, AWS::EC2::Instance
|
660
|
+
# resource types in the format `AWS::ServiceCode::ResourceType`. For
|
661
|
+
# example, `AWS::EC2::Instance`, or `AWS::S3::Bucket`.
|
519
662
|
#
|
520
663
|
# ^
|
521
664
|
#
|
665
|
+
# When you specify a `resource-type` filter for `ListGroupResources`,
|
666
|
+
# AWS Resource Groups validates your filter resource types against the
|
667
|
+
# types that are defined in the query associated with the group. For
|
668
|
+
# example, if a group contains only S3 buckets because its query
|
669
|
+
# specifies only that resource type, but your `resource-type` filter
|
670
|
+
# includes EC2 instances, AWS Resource Groups does not filter for EC2
|
671
|
+
# instances. In this case, a `ListGroupResources` request returns a
|
672
|
+
# `BadRequestException` error with a message similar to the following:
|
673
|
+
#
|
674
|
+
# `The resource types specified as filters in the request are not
|
675
|
+
# valid.`
|
676
|
+
#
|
677
|
+
# The error includes a list of resource types that failed the validation
|
678
|
+
# because they are not part of the query associated with the group. This
|
679
|
+
# validation doesn't occur when the group query specifies
|
680
|
+
# `AWS::AllSupported`, because a group based on such a query can contain
|
681
|
+
# any of the allowed resource types for the query type (tag-based or AWS
|
682
|
+
# CloudFormation stack-based queries).
|
683
|
+
#
|
522
684
|
# @option params [Integer] :max_results
|
523
|
-
# The
|
524
|
-
#
|
525
|
-
#
|
685
|
+
# The total number of results that you want included on each page of the
|
686
|
+
# response. If you do not include this parameter, it defaults to a value
|
687
|
+
# that is specific to the operation. If additional items exist beyond
|
688
|
+
# the maximum you specify, the `NextToken` response element is present
|
689
|
+
# and has a value (is not null). Include that value as the `NextToken`
|
690
|
+
# request parameter in the next call to the operation to get the next
|
691
|
+
# part of the results. Note that the service might return fewer results
|
692
|
+
# than the maximum even when there are more results available. You
|
693
|
+
# should check `NextToken` after every operation to ensure that you
|
694
|
+
# receive all of the results.
|
526
695
|
#
|
527
696
|
# @option params [String] :next_token
|
528
|
-
# The
|
529
|
-
#
|
530
|
-
#
|
697
|
+
# The parameter for receiving additional results if you receive a
|
698
|
+
# `NextToken` response in a previous request. A `NextToken` response
|
699
|
+
# indicates that more output is available. Set this parameter to the
|
700
|
+
# value provided by a previous call's `NextToken` response to indicate
|
701
|
+
# where the output should continue from.
|
531
702
|
#
|
532
703
|
# @return [Types::ListGroupResourcesOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
533
704
|
#
|
@@ -540,7 +711,8 @@ module Aws::ResourceGroups
|
|
540
711
|
# @example Request syntax with placeholder values
|
541
712
|
#
|
542
713
|
# resp = client.list_group_resources({
|
543
|
-
# group_name: "GroupName",
|
714
|
+
# group_name: "GroupName",
|
715
|
+
# group: "GroupString",
|
544
716
|
# filters: [
|
545
717
|
# {
|
546
718
|
# name: "resource-type", # required, accepts resource-type
|
@@ -574,22 +746,39 @@ module Aws::ResourceGroups
|
|
574
746
|
#
|
575
747
|
# @option params [Array<Types::GroupFilter>] :filters
|
576
748
|
# Filters, formatted as GroupFilter objects, that you want to apply to a
|
577
|
-
# ListGroups operation.
|
749
|
+
# `ListGroups` operation.
|
578
750
|
#
|
579
|
-
# * `resource-type` - Filter
|
580
|
-
# resource types
|
581
|
-
#
|
751
|
+
# * `resource-type` - Filter the results to include only those of the
|
752
|
+
# specified resource types. Specify up to five resource types in the
|
753
|
+
# format `AWS::ServiceCode::ResourceType `. For example,
|
754
|
+
# `AWS::EC2::Instance`, or `AWS::S3::Bucket`.
|
582
755
|
#
|
583
|
-
#
|
756
|
+
# * `configuration-type` - Filter the results to include only those
|
757
|
+
# groups that have the specified configuration types attached. The
|
758
|
+
# current supported values are:
|
759
|
+
#
|
760
|
+
# * AWS:EC2::CapacityReservationPool
|
761
|
+
#
|
762
|
+
# ^
|
584
763
|
#
|
585
764
|
# @option params [Integer] :max_results
|
586
|
-
# The
|
587
|
-
#
|
765
|
+
# The total number of results that you want included on each page of the
|
766
|
+
# response. If you do not include this parameter, it defaults to a value
|
767
|
+
# that is specific to the operation. If additional items exist beyond
|
768
|
+
# the maximum you specify, the `NextToken` response element is present
|
769
|
+
# and has a value (is not null). Include that value as the `NextToken`
|
770
|
+
# request parameter in the next call to the operation to get the next
|
771
|
+
# part of the results. Note that the service might return fewer results
|
772
|
+
# than the maximum even when there are more results available. You
|
773
|
+
# should check `NextToken` after every operation to ensure that you
|
774
|
+
# receive all of the results.
|
588
775
|
#
|
589
776
|
# @option params [String] :next_token
|
590
|
-
# The
|
591
|
-
#
|
592
|
-
#
|
777
|
+
# The parameter for receiving additional results if you receive a
|
778
|
+
# `NextToken` response in a previous request. A `NextToken` response
|
779
|
+
# indicates that more output is available. Set this parameter to the
|
780
|
+
# value provided by a previous call's `NextToken` response to indicate
|
781
|
+
# where the output should continue from.
|
593
782
|
#
|
594
783
|
# @return [Types::ListGroupsOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
595
784
|
#
|
@@ -604,7 +793,7 @@ module Aws::ResourceGroups
|
|
604
793
|
# resp = client.list_groups({
|
605
794
|
# filters: [
|
606
795
|
# {
|
607
|
-
# name: "resource-type", # required, accepts resource-type
|
796
|
+
# name: "resource-type", # required, accepts resource-type, configuration-type
|
608
797
|
# values: ["GroupFilterValue"], # required
|
609
798
|
# },
|
610
799
|
# ],
|
@@ -638,16 +827,26 @@ module Aws::ResourceGroups
|
|
638
827
|
#
|
639
828
|
# @option params [required, Types::ResourceQuery] :resource_query
|
640
829
|
# The search query, using the same formats that are supported for
|
641
|
-
# resource group definition.
|
830
|
+
# resource group definition. For more information, see CreateGroup.
|
642
831
|
#
|
643
832
|
# @option params [Integer] :max_results
|
644
|
-
# The
|
645
|
-
#
|
833
|
+
# The total number of results that you want included on each page of the
|
834
|
+
# response. If you do not include this parameter, it defaults to a value
|
835
|
+
# that is specific to the operation. If additional items exist beyond
|
836
|
+
# the maximum you specify, the `NextToken` response element is present
|
837
|
+
# and has a value (is not null). Include that value as the `NextToken`
|
838
|
+
# request parameter in the next call to the operation to get the next
|
839
|
+
# part of the results. Note that the service might return fewer results
|
840
|
+
# than the maximum even when there are more results available. You
|
841
|
+
# should check `NextToken` after every operation to ensure that you
|
842
|
+
# receive all of the results.
|
646
843
|
#
|
647
844
|
# @option params [String] :next_token
|
648
|
-
# The
|
649
|
-
#
|
650
|
-
#
|
845
|
+
# The parameter for receiving additional results if you receive a
|
846
|
+
# `NextToken` response in a previous request. A `NextToken` response
|
847
|
+
# indicates that more output is available. Set this parameter to the
|
848
|
+
# value provided by a previous call's `NextToken` response to indicate
|
849
|
+
# where the output should continue from.
|
651
850
|
#
|
652
851
|
# @return [Types::SearchResourcesOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
653
852
|
#
|
@@ -691,14 +890,17 @@ module Aws::ResourceGroups
|
|
691
890
|
# a resource group are not changed if they are not specified in the
|
692
891
|
# request parameters.
|
693
892
|
#
|
893
|
+
# Do not store personally identifiable information (PII) or other
|
894
|
+
# confidential or sensitive information in tags. We use tags to provide
|
895
|
+
# you with billing and administration services. Tags are not intended to
|
896
|
+
# be used for private or sensitive data.
|
897
|
+
#
|
694
898
|
# @option params [required, String] :arn
|
695
|
-
# The ARN of the resource to which to add tags.
|
899
|
+
# The ARN of the resource group to which to add tags.
|
696
900
|
#
|
697
901
|
# @option params [required, Hash<String,String>] :tags
|
698
|
-
# The tags to add to the specified resource. A tag is a
|
699
|
-
# map of key-value pairs.
|
700
|
-
# of 128 characters, and tag values can have a maximum length of 256
|
701
|
-
# characters.
|
902
|
+
# The tags to add to the specified resource group. A tag is a
|
903
|
+
# string-to-string map of key-value pairs.
|
702
904
|
#
|
703
905
|
# @return [Types::TagOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
704
906
|
#
|
@@ -729,10 +931,51 @@ module Aws::ResourceGroups
|
|
729
931
|
req.send_request(options)
|
730
932
|
end
|
731
933
|
|
732
|
-
#
|
934
|
+
# Removes the specified resources from the specified group.
|
935
|
+
#
|
936
|
+
# @option params [required, String] :group
|
937
|
+
# The name or the ARN of the resource group from which to remove the
|
938
|
+
# resources.
|
939
|
+
#
|
940
|
+
# @option params [required, Array<String>] :resource_arns
|
941
|
+
# The ARNs of the resources to be removed from the group.
|
942
|
+
#
|
943
|
+
# @return [Types::UngroupResourcesOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
944
|
+
#
|
945
|
+
# * {Types::UngroupResourcesOutput#succeeded #succeeded} => Array<String>
|
946
|
+
# * {Types::UngroupResourcesOutput#failed #failed} => Array<Types::FailedResource>
|
947
|
+
#
|
948
|
+
# @example Request syntax with placeholder values
|
949
|
+
#
|
950
|
+
# resp = client.ungroup_resources({
|
951
|
+
# group: "GroupString", # required
|
952
|
+
# resource_arns: ["ResourceArn"], # required
|
953
|
+
# })
|
954
|
+
#
|
955
|
+
# @example Response structure
|
956
|
+
#
|
957
|
+
# resp.succeeded #=> Array
|
958
|
+
# resp.succeeded[0] #=> String
|
959
|
+
# resp.failed #=> Array
|
960
|
+
# resp.failed[0].resource_arn #=> String
|
961
|
+
# resp.failed[0].error_message #=> String
|
962
|
+
# resp.failed[0].error_code #=> String
|
963
|
+
#
|
964
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/resource-groups-2017-11-27/UngroupResources AWS API Documentation
|
965
|
+
#
|
966
|
+
# @overload ungroup_resources(params = {})
|
967
|
+
# @param [Hash] params ({})
|
968
|
+
def ungroup_resources(params = {}, options = {})
|
969
|
+
req = build_request(:ungroup_resources, params)
|
970
|
+
req.send_request(options)
|
971
|
+
end
|
972
|
+
|
973
|
+
# Deletes tags from a specified resource group.
|
733
974
|
#
|
734
975
|
# @option params [required, String] :arn
|
735
|
-
# The ARN of the resource from which to remove tags.
|
976
|
+
# The ARN of the resource group from which to remove tags. The command
|
977
|
+
# removed both the specified keys and any values associated with those
|
978
|
+
# keys.
|
736
979
|
#
|
737
980
|
# @option params [required, Array<String>] :keys
|
738
981
|
# The keys of the tags to be removed.
|
@@ -764,17 +1007,19 @@ module Aws::ResourceGroups
|
|
764
1007
|
req.send_request(options)
|
765
1008
|
end
|
766
1009
|
|
767
|
-
# Updates an existing group
|
768
|
-
#
|
1010
|
+
# Updates the description for an existing group. You cannot update the
|
1011
|
+
# name of a resource group.
|
1012
|
+
#
|
1013
|
+
# @option params [String] :group_name
|
1014
|
+
# Don't use this parameter. Use `Group` instead.
|
769
1015
|
#
|
770
|
-
# @option params [
|
771
|
-
# The name of the resource group
|
772
|
-
# description.
|
1016
|
+
# @option params [String] :group
|
1017
|
+
# The name or the ARN of the resource group to modify.
|
773
1018
|
#
|
774
1019
|
# @option params [String] :description
|
775
|
-
# The description
|
776
|
-
#
|
777
|
-
#
|
1020
|
+
# The new description that you want to update the resource group with.
|
1021
|
+
# Descriptions can contain letters, numbers, hyphens, underscores,
|
1022
|
+
# periods, and spaces.
|
778
1023
|
#
|
779
1024
|
# @return [Types::UpdateGroupOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
780
1025
|
#
|
@@ -783,8 +1028,9 @@ module Aws::ResourceGroups
|
|
783
1028
|
# @example Request syntax with placeholder values
|
784
1029
|
#
|
785
1030
|
# resp = client.update_group({
|
786
|
-
# group_name: "GroupName",
|
787
|
-
#
|
1031
|
+
# group_name: "GroupName",
|
1032
|
+
# group: "GroupString",
|
1033
|
+
# description: "Description",
|
788
1034
|
# })
|
789
1035
|
#
|
790
1036
|
# @example Response structure
|
@@ -804,12 +1050,15 @@ module Aws::ResourceGroups
|
|
804
1050
|
|
805
1051
|
# Updates the resource query of a group.
|
806
1052
|
#
|
807
|
-
# @option params [
|
808
|
-
#
|
1053
|
+
# @option params [String] :group_name
|
1054
|
+
# Don't use this parameter. Use `Group` instead.
|
1055
|
+
#
|
1056
|
+
# @option params [String] :group
|
1057
|
+
# The name or the ARN of the resource group to query.
|
809
1058
|
#
|
810
1059
|
# @option params [required, Types::ResourceQuery] :resource_query
|
811
|
-
# The resource query
|
812
|
-
#
|
1060
|
+
# The resource query to determine which AWS resources are members of
|
1061
|
+
# this resource group.
|
813
1062
|
#
|
814
1063
|
# @return [Types::UpdateGroupQueryOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
815
1064
|
#
|
@@ -818,7 +1067,8 @@ module Aws::ResourceGroups
|
|
818
1067
|
# @example Request syntax with placeholder values
|
819
1068
|
#
|
820
1069
|
# resp = client.update_group_query({
|
821
|
-
# group_name: "GroupName",
|
1070
|
+
# group_name: "GroupName",
|
1071
|
+
# group: "GroupString",
|
822
1072
|
# resource_query: { # required
|
823
1073
|
# type: "TAG_FILTERS_1_0", # required, accepts TAG_FILTERS_1_0, CLOUDFORMATION_STACK_1_0
|
824
1074
|
# query: "Query", # required
|
@@ -853,7 +1103,7 @@ module Aws::ResourceGroups
|
|
853
1103
|
params: params,
|
854
1104
|
config: config)
|
855
1105
|
context[:gem_name] = 'aws-sdk-resourcegroups'
|
856
|
-
context[:gem_version] = '1.
|
1106
|
+
context[:gem_version] = '1.27.0'
|
857
1107
|
Seahorse::Client::Request.new(handlers, context)
|
858
1108
|
end
|
859
1109
|
|