aws-sdk-resourcegroups 1.25.1 → 1.30.0

Sign up to get free protection for your applications and to get access to all the features.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 53fca35ddf6d123773bf7a500846841f05d45475a28084c31b9444cc793eaefc
4
- data.tar.gz: 9e9620290458528ccb7c249aa1885d7a7274c0ec964d95139501f6a81865b1fa
3
+ metadata.gz: 06bd34fe09571c02bdd7dc72cc1a6781e32a8f45d0ec6dd68beb97a827bdbc16
4
+ data.tar.gz: 9ca2226dc1fc13dfb274cf0f743b1b2d8d6d9a045933a3b1d59f4671921dd9c9
5
5
  SHA512:
6
- metadata.gz: 8e015599aaa5a7c03e4011f9209a84f9f8a821e2393b60f2162ac631d2e6ff5f28bcfb2d6f00e49fc56a4a455d55827ee83ec53b84eacd8e162c5c22c4577073
7
- data.tar.gz: 0b5c691e5198a46a93e180927463b63a371adcd6ca4c24cb44d15da25eaa91fcf3c08b9e0c14904de8f5e4e1831071f40596890b76cf167f169aec58ec9a380b
6
+ metadata.gz: f199a00eb06f2c1ba2c58e4a4bbf4aedb82e372e50b63d5f65fe80226c087bdbf01850d49d6e6bd383ee42edf841d07ae926d2d851ec0ef3c743f5973931d2bd
7
+ data.tar.gz: 92b63537b737db78b7d6f58bcdea389f6d4079616a0f38da95413f12141671e6c557bbaaee36ce497d21baf5e6a924efcfffa0af70e44c7ec203fe00216c7c10
@@ -1,3 +1,5 @@
1
+ # frozen_string_literal: true
2
+
1
3
  # WARNING ABOUT GENERATED CODE
2
4
  #
3
5
  # This file is generated. See the contributing guide for more information:
@@ -5,6 +7,7 @@
5
7
  #
6
8
  # WARNING ABOUT GENERATED CODE
7
9
 
10
+
8
11
  require 'aws-sdk-core'
9
12
  require 'aws-sigv4'
10
13
 
@@ -42,9 +45,9 @@ require_relative 'aws-sdk-resourcegroups/customizations'
42
45
  #
43
46
  # See {Errors} for more information.
44
47
  #
45
- # @service
48
+ # @!group service
46
49
  module Aws::ResourceGroups
47
50
 
48
- GEM_VERSION = '1.25.1'
51
+ GEM_VERSION = '1.30.0'
49
52
 
50
53
  end
@@ -1,3 +1,5 @@
1
+ # frozen_string_literal: true
2
+
1
3
  # WARNING ABOUT GENERATED CODE
2
4
  #
3
5
  # This file is generated. See the contributing guide for more information:
@@ -83,13 +85,28 @@ module Aws::ResourceGroups
83
85
  # * `Aws::Credentials` - Used for configuring static, non-refreshing
84
86
  # credentials.
85
87
  #
88
+ # * `Aws::SharedCredentials` - Used for loading static credentials from a
89
+ # shared file, such as `~/.aws/config`.
90
+ #
91
+ # * `Aws::AssumeRoleCredentials` - Used when you need to assume a role.
92
+ #
93
+ # * `Aws::AssumeRoleWebIdentityCredentials` - Used when you need to
94
+ # assume a role after providing credentials via the web.
95
+ #
96
+ # * `Aws::SSOCredentials` - Used for loading credentials from AWS SSO using an
97
+ # access token generated from `aws login`.
98
+ #
99
+ # * `Aws::ProcessCredentials` - Used for loading credentials from a
100
+ # process that outputs to stdout.
101
+ #
86
102
  # * `Aws::InstanceProfileCredentials` - Used for loading credentials
87
103
  # from an EC2 IMDS on an EC2 instance.
88
104
  #
89
- # * `Aws::SharedCredentials` - Used for loading credentials from a
90
- # shared file, such as `~/.aws/config`.
105
+ # * `Aws::ECSCredentials` - Used for loading credentials from
106
+ # instances running in ECS.
91
107
  #
92
- # * `Aws::AssumeRoleCredentials` - Used when you need to assume a role.
108
+ # * `Aws::CognitoIdentityCredentials` - Used for loading credentials
109
+ # from the Cognito Identity service.
93
110
  #
94
111
  # When `:credentials` are not configured directly, the following
95
112
  # locations will be searched for credentials:
@@ -99,10 +116,10 @@ module Aws::ResourceGroups
99
116
  # * ENV['AWS_ACCESS_KEY_ID'], ENV['AWS_SECRET_ACCESS_KEY']
100
117
  # * `~/.aws/credentials`
101
118
  # * `~/.aws/config`
102
- # * EC2 IMDS instance profile - When used by default, the timeouts are
103
- # very aggressive. Construct and pass an instance of
104
- # `Aws::InstanceProfileCredentails` to enable retries and extended
105
- # timeouts.
119
+ # * EC2/ECS IMDS instance profile - When used by default, the timeouts
120
+ # are very aggressive. Construct and pass an instance of
121
+ # `Aws::InstanceProfileCredentails` or `Aws::ECSCredentials` to
122
+ # enable retries and extended timeouts.
106
123
  #
107
124
  # @option options [required, String] :region
108
125
  # The AWS region to connect to. The configured `:region` is
@@ -310,50 +327,73 @@ module Aws::ResourceGroups
310
327
 
311
328
  # @!group API Operations
312
329
 
313
- # Creates a group with a specified name, description, and resource
314
- # query.
330
+ # Creates a resource group with the specified name and description. You
331
+ # can optionally include a resource query, or a service configuration.
315
332
  #
316
333
  # @option params [required, String] :name
317
334
  # The name of the group, which is the identifier of the group in other
318
- # operations. A resource group name cannot be updated after it is
319
- # created. A resource group name can have a maximum of 128 characters,
320
- # including letters, numbers, hyphens, dots, and underscores. The name
321
- # cannot start with `AWS` or `aws`; these are reserved. A resource group
322
- # name must be unique within your account.
335
+ # operations. You can't change the name of a resource group after you
336
+ # create it. A resource group name can consist of letters, numbers,
337
+ # hyphens, periods, and underscores. The name cannot start with `AWS` or
338
+ # `aws`; these are reserved. A resource group name must be unique within
339
+ # each AWS Region in your AWS account.
323
340
  #
324
341
  # @option params [String] :description
325
- # The description of the resource group. Descriptions can have a maximum
326
- # of 511 characters, including letters, numbers, hyphens, underscores,
327
- # punctuation, and spaces.
342
+ # The description of the resource group. Descriptions can consist of
343
+ # letters, numbers, hyphens, underscores, periods, and spaces.
328
344
  #
329
- # @option params [required, Types::ResourceQuery] :resource_query
345
+ # @option params [Types::ResourceQuery] :resource_query
330
346
  # The resource query that determines which AWS resources are members of
331
347
  # this group.
332
348
  #
349
+ # <note markdown="1"> You can specify either a `ResourceQuery` or a `Configuration`, but not
350
+ # both.
351
+ #
352
+ # </note>
353
+ #
333
354
  # @option params [Hash<String,String>] :tags
334
- # The tags to add to the group. A tag is a string-to-string map of
335
- # key-value pairs. Tag keys can have a maximum character length of 128
336
- # characters, and tag values can have a maximum length of 256
337
- # characters.
355
+ # The tags to add to the group. A tag is key-value pair string.
356
+ #
357
+ # @option params [Array<Types::GroupConfigurationItem>] :configuration
358
+ # A configuration associates the resource group with an AWS service and
359
+ # specifies how the service can interact with the resources in the
360
+ # group. A configuration is an array of GroupConfigurationItem elements.
361
+ #
362
+ # <note markdown="1"> You can specify either a `Configuration` or a `ResourceQuery` in a
363
+ # group, but not both.
364
+ #
365
+ # </note>
338
366
  #
339
367
  # @return [Types::CreateGroupOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
340
368
  #
341
369
  # * {Types::CreateGroupOutput#group #group} => Types::Group
342
370
  # * {Types::CreateGroupOutput#resource_query #resource_query} => Types::ResourceQuery
343
371
  # * {Types::CreateGroupOutput#tags #tags} => Hash&lt;String,String&gt;
372
+ # * {Types::CreateGroupOutput#group_configuration #group_configuration} => Types::GroupConfiguration
344
373
  #
345
374
  # @example Request syntax with placeholder values
346
375
  #
347
376
  # resp = client.create_group({
348
377
  # name: "GroupName", # required
349
- # description: "GroupDescription",
350
- # resource_query: { # required
378
+ # description: "Description",
379
+ # resource_query: {
351
380
  # type: "TAG_FILTERS_1_0", # required, accepts TAG_FILTERS_1_0, CLOUDFORMATION_STACK_1_0
352
381
  # query: "Query", # required
353
382
  # },
354
383
  # tags: {
355
384
  # "TagKey" => "TagValue",
356
385
  # },
386
+ # configuration: [
387
+ # {
388
+ # type: "GroupConfigurationType", # required
389
+ # parameters: [
390
+ # {
391
+ # name: "GroupConfigurationParameterName", # required
392
+ # values: ["GroupConfigurationParameterValue"],
393
+ # },
394
+ # ],
395
+ # },
396
+ # ],
357
397
  # })
358
398
  #
359
399
  # @example Response structure
@@ -365,6 +405,20 @@ module Aws::ResourceGroups
365
405
  # resp.resource_query.query #=> String
366
406
  # resp.tags #=> Hash
367
407
  # resp.tags["TagKey"] #=> String
408
+ # resp.group_configuration.configuration #=> Array
409
+ # resp.group_configuration.configuration[0].type #=> String
410
+ # resp.group_configuration.configuration[0].parameters #=> Array
411
+ # resp.group_configuration.configuration[0].parameters[0].name #=> String
412
+ # resp.group_configuration.configuration[0].parameters[0].values #=> Array
413
+ # resp.group_configuration.configuration[0].parameters[0].values[0] #=> String
414
+ # resp.group_configuration.proposed_configuration #=> Array
415
+ # resp.group_configuration.proposed_configuration[0].type #=> String
416
+ # resp.group_configuration.proposed_configuration[0].parameters #=> Array
417
+ # resp.group_configuration.proposed_configuration[0].parameters[0].name #=> String
418
+ # resp.group_configuration.proposed_configuration[0].parameters[0].values #=> Array
419
+ # resp.group_configuration.proposed_configuration[0].parameters[0].values[0] #=> String
420
+ # resp.group_configuration.status #=> String, one of "UPDATING", "UPDATE_COMPLETE", "UPDATE_FAILED"
421
+ # resp.group_configuration.failure_reason #=> String
368
422
  #
369
423
  # @see http://docs.aws.amazon.com/goto/WebAPI/resource-groups-2017-11-27/CreateGroup AWS API Documentation
370
424
  #
@@ -375,12 +429,15 @@ module Aws::ResourceGroups
375
429
  req.send_request(options)
376
430
  end
377
431
 
378
- # Deletes a specified resource group. Deleting a resource group does not
379
- # delete resources that are members of the group; it only deletes the
380
- # group structure.
432
+ # Deletes the specified resource group. Deleting a resource group does
433
+ # not delete any resources that are members of the group; it only
434
+ # deletes the group structure.
381
435
  #
382
- # @option params [required, String] :group_name
383
- # The name of the resource group to delete.
436
+ # @option params [String] :group_name
437
+ # Don't use this parameter. Use `Group` instead.
438
+ #
439
+ # @option params [String] :group
440
+ # The name or the ARN of the resource group to delete.
384
441
  #
385
442
  # @return [Types::DeleteGroupOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
386
443
  #
@@ -389,7 +446,8 @@ module Aws::ResourceGroups
389
446
  # @example Request syntax with placeholder values
390
447
  #
391
448
  # resp = client.delete_group({
392
- # group_name: "GroupName", # required
449
+ # group_name: "GroupName",
450
+ # group: "GroupString",
393
451
  # })
394
452
  #
395
453
  # @example Response structure
@@ -409,8 +467,11 @@ module Aws::ResourceGroups
409
467
 
410
468
  # Returns information about a specified resource group.
411
469
  #
412
- # @option params [required, String] :group_name
413
- # The name of the resource group.
470
+ # @option params [String] :group_name
471
+ # Don't use this parameter. Use `Group` instead.
472
+ #
473
+ # @option params [String] :group
474
+ # The name or the ARN of the resource group to retrieve.
414
475
  #
415
476
  # @return [Types::GetGroupOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
416
477
  #
@@ -419,7 +480,8 @@ module Aws::ResourceGroups
419
480
  # @example Request syntax with placeholder values
420
481
  #
421
482
  # resp = client.get_group({
422
- # group_name: "GroupName", # required
483
+ # group_name: "GroupName",
484
+ # group: "GroupString",
423
485
  # })
424
486
  #
425
487
  # @example Response structure
@@ -437,11 +499,67 @@ module Aws::ResourceGroups
437
499
  req.send_request(options)
438
500
  end
439
501
 
440
- # Returns the resource query associated with the specified resource
502
+ # Returns the service configuration associated with the specified
503
+ # resource group. AWS Resource Groups supports configurations for the
504
+ # following resource group types:
505
+ #
506
+ # * `AWS::EC2::CapacityReservationPool` - Amazon EC2 capacity
507
+ # reservation pools. For more information, see [Working with capacity
508
+ # reservation groups][1] in the *EC2 Users Guide*.
509
+ #
510
+ # ^
511
+ #
512
+ #
513
+ #
514
+ # [1]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/capacity-reservations-using.html#create-cr-group
515
+ #
516
+ # @option params [String] :group
517
+ # The name or the ARN of the resource group.
518
+ #
519
+ # @return [Types::GetGroupConfigurationOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
520
+ #
521
+ # * {Types::GetGroupConfigurationOutput#group_configuration #group_configuration} => Types::GroupConfiguration
522
+ #
523
+ # @example Request syntax with placeholder values
524
+ #
525
+ # resp = client.get_group_configuration({
526
+ # group: "GroupString",
527
+ # })
528
+ #
529
+ # @example Response structure
530
+ #
531
+ # resp.group_configuration.configuration #=> Array
532
+ # resp.group_configuration.configuration[0].type #=> String
533
+ # resp.group_configuration.configuration[0].parameters #=> Array
534
+ # resp.group_configuration.configuration[0].parameters[0].name #=> String
535
+ # resp.group_configuration.configuration[0].parameters[0].values #=> Array
536
+ # resp.group_configuration.configuration[0].parameters[0].values[0] #=> String
537
+ # resp.group_configuration.proposed_configuration #=> Array
538
+ # resp.group_configuration.proposed_configuration[0].type #=> String
539
+ # resp.group_configuration.proposed_configuration[0].parameters #=> Array
540
+ # resp.group_configuration.proposed_configuration[0].parameters[0].name #=> String
541
+ # resp.group_configuration.proposed_configuration[0].parameters[0].values #=> Array
542
+ # resp.group_configuration.proposed_configuration[0].parameters[0].values[0] #=> String
543
+ # resp.group_configuration.status #=> String, one of "UPDATING", "UPDATE_COMPLETE", "UPDATE_FAILED"
544
+ # resp.group_configuration.failure_reason #=> String
545
+ #
546
+ # @see http://docs.aws.amazon.com/goto/WebAPI/resource-groups-2017-11-27/GetGroupConfiguration AWS API Documentation
547
+ #
548
+ # @overload get_group_configuration(params = {})
549
+ # @param [Hash] params ({})
550
+ def get_group_configuration(params = {}, options = {})
551
+ req = build_request(:get_group_configuration, params)
552
+ req.send_request(options)
553
+ end
554
+
555
+ # Retrieves the resource query associated with the specified resource
441
556
  # group.
442
557
  #
443
- # @option params [required, String] :group_name
444
- # The name of the resource group.
558
+ # @option params [String] :group_name
559
+ # Don't use this parameter. Use `Group` instead.
560
+ #
561
+ # @option params [String] :group
562
+ # The name or the ARN of the resource group to query.
445
563
  #
446
564
  # @return [Types::GetGroupQueryOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
447
565
  #
@@ -450,7 +568,8 @@ module Aws::ResourceGroups
450
568
  # @example Request syntax with placeholder values
451
569
  #
452
570
  # resp = client.get_group_query({
453
- # group_name: "GroupName", # required
571
+ # group_name: "GroupName",
572
+ # group: "GroupString",
454
573
  # })
455
574
  #
456
575
  # @example Response structure
@@ -472,8 +591,7 @@ module Aws::ResourceGroups
472
591
  # specified by an ARN.
473
592
  #
474
593
  # @option params [required, String] :arn
475
- # The ARN of the resource group for which you want a list of tags. The
476
- # resource must exist within the account you are using.
594
+ # The ARN of the resource group whose tags you want to retrieve.
477
595
  #
478
596
  # @return [Types::GetTagsOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
479
597
  #
@@ -501,31 +619,101 @@ module Aws::ResourceGroups
501
619
  req.send_request(options)
502
620
  end
503
621
 
504
- # Returns a list of ARNs of resources that are members of a specified
505
- # resource group.
622
+ # Adds the specified resources to the specified group.
623
+ #
624
+ # @option params [required, String] :group
625
+ # The name or the ARN of the resource group to add resources to.
626
+ #
627
+ # @option params [required, Array<String>] :resource_arns
628
+ # The list of ARNs for resources to be added to the group.
629
+ #
630
+ # @return [Types::GroupResourcesOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
631
+ #
632
+ # * {Types::GroupResourcesOutput#succeeded #succeeded} => Array&lt;String&gt;
633
+ # * {Types::GroupResourcesOutput#failed #failed} => Array&lt;Types::FailedResource&gt;
634
+ #
635
+ # @example Request syntax with placeholder values
636
+ #
637
+ # resp = client.group_resources({
638
+ # group: "GroupString", # required
639
+ # resource_arns: ["ResourceArn"], # required
640
+ # })
641
+ #
642
+ # @example Response structure
643
+ #
644
+ # resp.succeeded #=> Array
645
+ # resp.succeeded[0] #=> String
646
+ # resp.failed #=> Array
647
+ # resp.failed[0].resource_arn #=> String
648
+ # resp.failed[0].error_message #=> String
649
+ # resp.failed[0].error_code #=> String
650
+ #
651
+ # @see http://docs.aws.amazon.com/goto/WebAPI/resource-groups-2017-11-27/GroupResources AWS API Documentation
652
+ #
653
+ # @overload group_resources(params = {})
654
+ # @param [Hash] params ({})
655
+ def group_resources(params = {}, options = {})
656
+ req = build_request(:group_resources, params)
657
+ req.send_request(options)
658
+ end
659
+
660
+ # Returns a list of ARNs of the resources that are members of a
661
+ # specified resource group.
662
+ #
663
+ # @option params [String] :group_name
664
+ # Don't use this parameter. Use `Group` instead.
506
665
  #
507
- # @option params [required, String] :group_name
508
- # The name of the resource group.
666
+ # @option params [String] :group
667
+ # The name or the ARN of the resource group
509
668
  #
510
669
  # @option params [Array<Types::ResourceFilter>] :filters
511
670
  # Filters, formatted as ResourceFilter objects, that you want to apply
512
- # to a ListGroupResources operation.
671
+ # to a `ListGroupResources` operation. Filters the results to include
672
+ # only those of the specified resource types.
513
673
  #
514
674
  # * `resource-type` - Filter resources by their type. Specify up to five
515
- # resource types in the format AWS::ServiceCode::ResourceType. For
516
- # example, AWS::EC2::Instance, or AWS::S3::Bucket.
675
+ # resource types in the format `AWS::ServiceCode::ResourceType`. For
676
+ # example, `AWS::EC2::Instance`, or `AWS::S3::Bucket`.
517
677
  #
518
678
  # ^
519
679
  #
680
+ # When you specify a `resource-type` filter for `ListGroupResources`,
681
+ # AWS Resource Groups validates your filter resource types against the
682
+ # types that are defined in the query associated with the group. For
683
+ # example, if a group contains only S3 buckets because its query
684
+ # specifies only that resource type, but your `resource-type` filter
685
+ # includes EC2 instances, AWS Resource Groups does not filter for EC2
686
+ # instances. In this case, a `ListGroupResources` request returns a
687
+ # `BadRequestException` error with a message similar to the following:
688
+ #
689
+ # `The resource types specified as filters in the request are not
690
+ # valid.`
691
+ #
692
+ # The error includes a list of resource types that failed the validation
693
+ # because they are not part of the query associated with the group. This
694
+ # validation doesn't occur when the group query specifies
695
+ # `AWS::AllSupported`, because a group based on such a query can contain
696
+ # any of the allowed resource types for the query type (tag-based or AWS
697
+ # CloudFormation stack-based queries).
698
+ #
520
699
  # @option params [Integer] :max_results
521
- # The maximum number of group member ARNs that are returned in a single
522
- # call by ListGroupResources, in paginated output. By default, this
523
- # number is 50.
700
+ # The total number of results that you want included on each page of the
701
+ # response. If you do not include this parameter, it defaults to a value
702
+ # that is specific to the operation. If additional items exist beyond
703
+ # the maximum you specify, the `NextToken` response element is present
704
+ # and has a value (is not null). Include that value as the `NextToken`
705
+ # request parameter in the next call to the operation to get the next
706
+ # part of the results. Note that the service might return fewer results
707
+ # than the maximum even when there are more results available. You
708
+ # should check `NextToken` after every operation to ensure that you
709
+ # receive all of the results.
524
710
  #
525
711
  # @option params [String] :next_token
526
- # The NextToken value that is returned in a paginated ListGroupResources
527
- # request. To get the next page of results, run the call again, add the
528
- # NextToken parameter, and specify the NextToken value.
712
+ # The parameter for receiving additional results if you receive a
713
+ # `NextToken` response in a previous request. A `NextToken` response
714
+ # indicates that more output is available. Set this parameter to the
715
+ # value provided by a previous call's `NextToken` response to indicate
716
+ # where the output should continue from.
529
717
  #
530
718
  # @return [Types::ListGroupResourcesOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
531
719
  #
@@ -538,7 +726,8 @@ module Aws::ResourceGroups
538
726
  # @example Request syntax with placeholder values
539
727
  #
540
728
  # resp = client.list_group_resources({
541
- # group_name: "GroupName", # required
729
+ # group_name: "GroupName",
730
+ # group: "GroupString",
542
731
  # filters: [
543
732
  # {
544
733
  # name: "resource-type", # required, accepts resource-type
@@ -572,22 +761,39 @@ module Aws::ResourceGroups
572
761
  #
573
762
  # @option params [Array<Types::GroupFilter>] :filters
574
763
  # Filters, formatted as GroupFilter objects, that you want to apply to a
575
- # ListGroups operation.
764
+ # `ListGroups` operation.
576
765
  #
577
- # * `resource-type` - Filter groups by resource type. Specify up to five
578
- # resource types in the format AWS::ServiceCode::ResourceType. For
579
- # example, AWS::EC2::Instance, or AWS::S3::Bucket.
766
+ # * `resource-type` - Filter the results to include only those of the
767
+ # specified resource types. Specify up to five resource types in the
768
+ # format `AWS::ServiceCode::ResourceType `. For example,
769
+ # `AWS::EC2::Instance`, or `AWS::S3::Bucket`.
580
770
  #
581
- # ^
771
+ # * `configuration-type` - Filter the results to include only those
772
+ # groups that have the specified configuration types attached. The
773
+ # current supported values are:
774
+ #
775
+ # * AWS:EC2::CapacityReservationPool
776
+ #
777
+ # ^
582
778
  #
583
779
  # @option params [Integer] :max_results
584
- # The maximum number of resource group results that are returned by
585
- # ListGroups in paginated output. By default, this number is 50.
780
+ # The total number of results that you want included on each page of the
781
+ # response. If you do not include this parameter, it defaults to a value
782
+ # that is specific to the operation. If additional items exist beyond
783
+ # the maximum you specify, the `NextToken` response element is present
784
+ # and has a value (is not null). Include that value as the `NextToken`
785
+ # request parameter in the next call to the operation to get the next
786
+ # part of the results. Note that the service might return fewer results
787
+ # than the maximum even when there are more results available. You
788
+ # should check `NextToken` after every operation to ensure that you
789
+ # receive all of the results.
586
790
  #
587
791
  # @option params [String] :next_token
588
- # The NextToken value that is returned in a paginated `ListGroups`
589
- # request. To get the next page of results, run the call again, add the
590
- # NextToken parameter, and specify the NextToken value.
792
+ # The parameter for receiving additional results if you receive a
793
+ # `NextToken` response in a previous request. A `NextToken` response
794
+ # indicates that more output is available. Set this parameter to the
795
+ # value provided by a previous call's `NextToken` response to indicate
796
+ # where the output should continue from.
591
797
  #
592
798
  # @return [Types::ListGroupsOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
593
799
  #
@@ -602,7 +808,7 @@ module Aws::ResourceGroups
602
808
  # resp = client.list_groups({
603
809
  # filters: [
604
810
  # {
605
- # name: "resource-type", # required, accepts resource-type
811
+ # name: "resource-type", # required, accepts resource-type, configuration-type
606
812
  # values: ["GroupFilterValue"], # required
607
813
  # },
608
814
  # ],
@@ -630,22 +836,32 @@ module Aws::ResourceGroups
630
836
  req.send_request(options)
631
837
  end
632
838
 
633
- # Returns a list of AWS resource identifiers that matches a specified
839
+ # Returns a list of AWS resource identifiers that matches tne specified
634
840
  # query. The query uses the same format as a resource query in a
635
841
  # CreateGroup or UpdateGroupQuery operation.
636
842
  #
637
843
  # @option params [required, Types::ResourceQuery] :resource_query
638
844
  # The search query, using the same formats that are supported for
639
- # resource group definition.
845
+ # resource group definition. For more information, see CreateGroup.
640
846
  #
641
847
  # @option params [Integer] :max_results
642
- # The maximum number of group member ARNs returned by `SearchResources`
643
- # in paginated output. By default, this number is 50.
848
+ # The total number of results that you want included on each page of the
849
+ # response. If you do not include this parameter, it defaults to a value
850
+ # that is specific to the operation. If additional items exist beyond
851
+ # the maximum you specify, the `NextToken` response element is present
852
+ # and has a value (is not null). Include that value as the `NextToken`
853
+ # request parameter in the next call to the operation to get the next
854
+ # part of the results. Note that the service might return fewer results
855
+ # than the maximum even when there are more results available. You
856
+ # should check `NextToken` after every operation to ensure that you
857
+ # receive all of the results.
644
858
  #
645
859
  # @option params [String] :next_token
646
- # The NextToken value that is returned in a paginated `SearchResources`
647
- # request. To get the next page of results, run the call again, add the
648
- # NextToken parameter, and specify the NextToken value.
860
+ # The parameter for receiving additional results if you receive a
861
+ # `NextToken` response in a previous request. A `NextToken` response
862
+ # indicates that more output is available. Set this parameter to the
863
+ # value provided by a previous call's `NextToken` response to indicate
864
+ # where the output should continue from.
649
865
  #
650
866
  # @return [Types::SearchResourcesOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
651
867
  #
@@ -689,14 +905,17 @@ module Aws::ResourceGroups
689
905
  # a resource group are not changed if they are not specified in the
690
906
  # request parameters.
691
907
  #
908
+ # Do not store personally identifiable information (PII) or other
909
+ # confidential or sensitive information in tags. We use tags to provide
910
+ # you with billing and administration services. Tags are not intended to
911
+ # be used for private or sensitive data.
912
+ #
692
913
  # @option params [required, String] :arn
693
- # The ARN of the resource to which to add tags.
914
+ # The ARN of the resource group to which to add tags.
694
915
  #
695
916
  # @option params [required, Hash<String,String>] :tags
696
- # The tags to add to the specified resource. A tag is a string-to-string
697
- # map of key-value pairs. Tag keys can have a maximum character length
698
- # of 128 characters, and tag values can have a maximum length of 256
699
- # characters.
917
+ # The tags to add to the specified resource group. A tag is a
918
+ # string-to-string map of key-value pairs.
700
919
  #
701
920
  # @return [Types::TagOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
702
921
  #
@@ -727,10 +946,51 @@ module Aws::ResourceGroups
727
946
  req.send_request(options)
728
947
  end
729
948
 
730
- # Deletes specified tags from a specified resource.
949
+ # Removes the specified resources from the specified group.
950
+ #
951
+ # @option params [required, String] :group
952
+ # The name or the ARN of the resource group from which to remove the
953
+ # resources.
954
+ #
955
+ # @option params [required, Array<String>] :resource_arns
956
+ # The ARNs of the resources to be removed from the group.
957
+ #
958
+ # @return [Types::UngroupResourcesOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
959
+ #
960
+ # * {Types::UngroupResourcesOutput#succeeded #succeeded} => Array&lt;String&gt;
961
+ # * {Types::UngroupResourcesOutput#failed #failed} => Array&lt;Types::FailedResource&gt;
962
+ #
963
+ # @example Request syntax with placeholder values
964
+ #
965
+ # resp = client.ungroup_resources({
966
+ # group: "GroupString", # required
967
+ # resource_arns: ["ResourceArn"], # required
968
+ # })
969
+ #
970
+ # @example Response structure
971
+ #
972
+ # resp.succeeded #=> Array
973
+ # resp.succeeded[0] #=> String
974
+ # resp.failed #=> Array
975
+ # resp.failed[0].resource_arn #=> String
976
+ # resp.failed[0].error_message #=> String
977
+ # resp.failed[0].error_code #=> String
978
+ #
979
+ # @see http://docs.aws.amazon.com/goto/WebAPI/resource-groups-2017-11-27/UngroupResources AWS API Documentation
980
+ #
981
+ # @overload ungroup_resources(params = {})
982
+ # @param [Hash] params ({})
983
+ def ungroup_resources(params = {}, options = {})
984
+ req = build_request(:ungroup_resources, params)
985
+ req.send_request(options)
986
+ end
987
+
988
+ # Deletes tags from a specified resource group.
731
989
  #
732
990
  # @option params [required, String] :arn
733
- # The ARN of the resource from which to remove tags.
991
+ # The ARN of the resource group from which to remove tags. The command
992
+ # removed both the specified keys and any values associated with those
993
+ # keys.
734
994
  #
735
995
  # @option params [required, Array<String>] :keys
736
996
  # The keys of the tags to be removed.
@@ -762,17 +1022,19 @@ module Aws::ResourceGroups
762
1022
  req.send_request(options)
763
1023
  end
764
1024
 
765
- # Updates an existing group with a new or changed description. You
766
- # cannot update the name of a resource group.
1025
+ # Updates the description for an existing group. You cannot update the
1026
+ # name of a resource group.
1027
+ #
1028
+ # @option params [String] :group_name
1029
+ # Don't use this parameter. Use `Group` instead.
767
1030
  #
768
- # @option params [required, String] :group_name
769
- # The name of the resource group for which you want to update its
770
- # description.
1031
+ # @option params [String] :group
1032
+ # The name or the ARN of the resource group to modify.
771
1033
  #
772
1034
  # @option params [String] :description
773
- # The description of the resource group. Descriptions can have a maximum
774
- # of 511 characters, including letters, numbers, hyphens, underscores,
775
- # punctuation, and spaces.
1035
+ # The new description that you want to update the resource group with.
1036
+ # Descriptions can contain letters, numbers, hyphens, underscores,
1037
+ # periods, and spaces.
776
1038
  #
777
1039
  # @return [Types::UpdateGroupOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
778
1040
  #
@@ -781,8 +1043,9 @@ module Aws::ResourceGroups
781
1043
  # @example Request syntax with placeholder values
782
1044
  #
783
1045
  # resp = client.update_group({
784
- # group_name: "GroupName", # required
785
- # description: "GroupDescription",
1046
+ # group_name: "GroupName",
1047
+ # group: "GroupString",
1048
+ # description: "Description",
786
1049
  # })
787
1050
  #
788
1051
  # @example Response structure
@@ -802,12 +1065,15 @@ module Aws::ResourceGroups
802
1065
 
803
1066
  # Updates the resource query of a group.
804
1067
  #
805
- # @option params [required, String] :group_name
806
- # The name of the resource group for which you want to edit the query.
1068
+ # @option params [String] :group_name
1069
+ # Don't use this parameter. Use `Group` instead.
1070
+ #
1071
+ # @option params [String] :group
1072
+ # The name or the ARN of the resource group to query.
807
1073
  #
808
1074
  # @option params [required, Types::ResourceQuery] :resource_query
809
- # The resource query that determines which AWS resources are members of
810
- # the resource group.
1075
+ # The resource query to determine which AWS resources are members of
1076
+ # this resource group.
811
1077
  #
812
1078
  # @return [Types::UpdateGroupQueryOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
813
1079
  #
@@ -816,7 +1082,8 @@ module Aws::ResourceGroups
816
1082
  # @example Request syntax with placeholder values
817
1083
  #
818
1084
  # resp = client.update_group_query({
819
- # group_name: "GroupName", # required
1085
+ # group_name: "GroupName",
1086
+ # group: "GroupString",
820
1087
  # resource_query: { # required
821
1088
  # type: "TAG_FILTERS_1_0", # required, accepts TAG_FILTERS_1_0, CLOUDFORMATION_STACK_1_0
822
1089
  # query: "Query", # required
@@ -851,7 +1118,7 @@ module Aws::ResourceGroups
851
1118
  params: params,
852
1119
  config: config)
853
1120
  context[:gem_name] = 'aws-sdk-resourcegroups'
854
- context[:gem_version] = '1.25.1'
1121
+ context[:gem_version] = '1.30.0'
855
1122
  Seahorse::Client::Request.new(handlers, context)
856
1123
  end
857
1124