aws-sdk-resourcegroups 1.24.0 → 1.29.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 0a8b90741a021fa1079caa73d999eea37d6849c346ce239731c4e01749bf0b5e
4
- data.tar.gz: 184b5444103bc7b57b75385f094bd74f8097a4125fc32f7fa04f659133ece701
3
+ metadata.gz: 1e73441e030d4bf3c1da1734f62ba99f3e3b3505ae83d47d76b7c445ddc28f1a
4
+ data.tar.gz: a83db964787a0a759c82a775df8e7e2aeecca0c2176fe4cdcec2f11d048b30fc
5
5
  SHA512:
6
- metadata.gz: fe16951f255a2ec83236152046c625996cb49613836e703489e1917fcb7182c08a477e9f009f7704d0ecf1907fe2361f3ad09c1790aa62d19a0a399443b95166
7
- data.tar.gz: febdadc86674d0d6a1affa10533db94eaa7daa7c3baddc42d3b8e6646ffecda43b47a110f3eaf63c895847b8d036fa33cf714f5338eb18078d5f20613bdacad1
6
+ metadata.gz: e68ffa7ee586514d296bd1c0c4e26791124771e0ad40220c9f2d102d7e7aac53e861fe523dd2a2d6ac87795eadc63154e27f353d12c61ab72e5c256787e41329
7
+ data.tar.gz: 55f4ef35e33844de839a8bcc2afaf60df6b1b8ce73a8692e06febae2c0a5ae09c324ceec549c012ed5e987d7219771de824b1a4457959b0417c4bbade88e6dd6
@@ -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:
@@ -42,9 +44,9 @@ require_relative 'aws-sdk-resourcegroups/customizations'
42
44
  #
43
45
  # See {Errors} for more information.
44
46
  #
45
- # @service
47
+ # @!group service
46
48
  module Aws::ResourceGroups
47
49
 
48
- GEM_VERSION = '1.24.0'
50
+ GEM_VERSION = '1.29.0'
49
51
 
50
52
  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:
@@ -24,6 +26,7 @@ require 'aws-sdk-core/plugins/jsonvalue_converter.rb'
24
26
  require 'aws-sdk-core/plugins/client_metrics_plugin.rb'
25
27
  require 'aws-sdk-core/plugins/client_metrics_send_plugin.rb'
26
28
  require 'aws-sdk-core/plugins/transfer_encoding.rb'
29
+ require 'aws-sdk-core/plugins/http_checksum.rb'
27
30
  require 'aws-sdk-core/plugins/signature_v4.rb'
28
31
  require 'aws-sdk-core/plugins/protocols/rest_json.rb'
29
32
 
@@ -69,6 +72,7 @@ module Aws::ResourceGroups
69
72
  add_plugin(Aws::Plugins::ClientMetricsPlugin)
70
73
  add_plugin(Aws::Plugins::ClientMetricsSendPlugin)
71
74
  add_plugin(Aws::Plugins::TransferEncoding)
75
+ add_plugin(Aws::Plugins::HttpChecksum)
72
76
  add_plugin(Aws::Plugins::SignatureV4)
73
77
  add_plugin(Aws::Plugins::Protocols::RestJson)
74
78
 
@@ -81,13 +85,28 @@ module Aws::ResourceGroups
81
85
  # * `Aws::Credentials` - Used for configuring static, non-refreshing
82
86
  # credentials.
83
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
+ #
84
102
  # * `Aws::InstanceProfileCredentials` - Used for loading credentials
85
103
  # from an EC2 IMDS on an EC2 instance.
86
104
  #
87
- # * `Aws::SharedCredentials` - Used for loading credentials from a
88
- # shared file, such as `~/.aws/config`.
105
+ # * `Aws::ECSCredentials` - Used for loading credentials from
106
+ # instances running in ECS.
89
107
  #
90
- # * `Aws::AssumeRoleCredentials` - Used when you need to assume a role.
108
+ # * `Aws::CognitoIdentityCredentials` - Used for loading credentials
109
+ # from the Cognito Identity service.
91
110
  #
92
111
  # When `:credentials` are not configured directly, the following
93
112
  # locations will be searched for credentials:
@@ -97,10 +116,10 @@ module Aws::ResourceGroups
97
116
  # * ENV['AWS_ACCESS_KEY_ID'], ENV['AWS_SECRET_ACCESS_KEY']
98
117
  # * `~/.aws/credentials`
99
118
  # * `~/.aws/config`
100
- # * EC2 IMDS instance profile - When used by default, the timeouts are
101
- # very aggressive. Construct and pass an instance of
102
- # `Aws::InstanceProfileCredentails` to enable retries and extended
103
- # 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.
104
123
  #
105
124
  # @option options [required, String] :region
106
125
  # The AWS region to connect to. The configured `:region` is
@@ -161,7 +180,7 @@ module Aws::ResourceGroups
161
180
  # @option options [String] :endpoint
162
181
  # The client endpoint is normally constructed from the `:region`
163
182
  # option. You should only configure an `:endpoint` when connecting
164
- # to test endpoints. This should be a valid HTTP(S) URI.
183
+ # to test or custom endpoints. This should be a valid HTTP(S) URI.
165
184
  #
166
185
  # @option options [Integer] :endpoint_cache_max_entries (1000)
167
186
  # Used for the maximum size limit of the LRU cache storing endpoints data
@@ -308,50 +327,73 @@ module Aws::ResourceGroups
308
327
 
309
328
  # @!group API Operations
310
329
 
311
- # Creates a group with a specified name, description, and resource
312
- # query.
330
+ # Creates a resource group with the specified name and description. You
331
+ # can optionally include a resource query, or a service configuration.
313
332
  #
314
333
  # @option params [required, String] :name
315
334
  # The name of the group, which is the identifier of the group in other
316
- # operations. A resource group name cannot be updated after it is
317
- # created. A resource group name can have a maximum of 128 characters,
318
- # including letters, numbers, hyphens, dots, and underscores. The name
319
- # cannot start with `AWS` or `aws`; these are reserved. A resource group
320
- # 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.
321
340
  #
322
341
  # @option params [String] :description
323
- # The description of the resource group. Descriptions can have a maximum
324
- # of 511 characters, including letters, numbers, hyphens, underscores,
325
- # punctuation, and spaces.
342
+ # The description of the resource group. Descriptions can consist of
343
+ # letters, numbers, hyphens, underscores, periods, and spaces.
326
344
  #
327
- # @option params [required, Types::ResourceQuery] :resource_query
345
+ # @option params [Types::ResourceQuery] :resource_query
328
346
  # The resource query that determines which AWS resources are members of
329
347
  # this group.
330
348
  #
349
+ # <note markdown="1"> You can specify either a `ResourceQuery` or a `Configuration`, but not
350
+ # both.
351
+ #
352
+ # </note>
353
+ #
331
354
  # @option params [Hash<String,String>] :tags
332
- # The tags to add to the group. A tag is a string-to-string map of
333
- # key-value pairs. Tag keys can have a maximum character length of 128
334
- # characters, and tag values can have a maximum length of 256
335
- # 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>
336
366
  #
337
367
  # @return [Types::CreateGroupOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
338
368
  #
339
369
  # * {Types::CreateGroupOutput#group #group} => Types::Group
340
370
  # * {Types::CreateGroupOutput#resource_query #resource_query} => Types::ResourceQuery
341
371
  # * {Types::CreateGroupOutput#tags #tags} => Hash&lt;String,String&gt;
372
+ # * {Types::CreateGroupOutput#group_configuration #group_configuration} => Types::GroupConfiguration
342
373
  #
343
374
  # @example Request syntax with placeholder values
344
375
  #
345
376
  # resp = client.create_group({
346
377
  # name: "GroupName", # required
347
- # description: "GroupDescription",
348
- # resource_query: { # required
378
+ # description: "Description",
379
+ # resource_query: {
349
380
  # type: "TAG_FILTERS_1_0", # required, accepts TAG_FILTERS_1_0, CLOUDFORMATION_STACK_1_0
350
381
  # query: "Query", # required
351
382
  # },
352
383
  # tags: {
353
384
  # "TagKey" => "TagValue",
354
385
  # },
386
+ # configuration: [
387
+ # {
388
+ # type: "GroupConfigurationType", # required
389
+ # parameters: [
390
+ # {
391
+ # name: "GroupConfigurationParameterName", # required
392
+ # values: ["GroupConfigurationParameterValue"],
393
+ # },
394
+ # ],
395
+ # },
396
+ # ],
355
397
  # })
356
398
  #
357
399
  # @example Response structure
@@ -363,6 +405,20 @@ module Aws::ResourceGroups
363
405
  # resp.resource_query.query #=> String
364
406
  # resp.tags #=> Hash
365
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
366
422
  #
367
423
  # @see http://docs.aws.amazon.com/goto/WebAPI/resource-groups-2017-11-27/CreateGroup AWS API Documentation
368
424
  #
@@ -373,12 +429,15 @@ module Aws::ResourceGroups
373
429
  req.send_request(options)
374
430
  end
375
431
 
376
- # Deletes a specified resource group. Deleting a resource group does not
377
- # delete resources that are members of the group; it only deletes the
378
- # 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.
379
435
  #
380
- # @option params [required, String] :group_name
381
- # 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.
382
441
  #
383
442
  # @return [Types::DeleteGroupOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
384
443
  #
@@ -387,7 +446,8 @@ module Aws::ResourceGroups
387
446
  # @example Request syntax with placeholder values
388
447
  #
389
448
  # resp = client.delete_group({
390
- # group_name: "GroupName", # required
449
+ # group_name: "GroupName",
450
+ # group: "GroupString",
391
451
  # })
392
452
  #
393
453
  # @example Response structure
@@ -407,8 +467,11 @@ module Aws::ResourceGroups
407
467
 
408
468
  # Returns information about a specified resource group.
409
469
  #
410
- # @option params [required, String] :group_name
411
- # 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.
412
475
  #
413
476
  # @return [Types::GetGroupOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
414
477
  #
@@ -417,7 +480,8 @@ module Aws::ResourceGroups
417
480
  # @example Request syntax with placeholder values
418
481
  #
419
482
  # resp = client.get_group({
420
- # group_name: "GroupName", # required
483
+ # group_name: "GroupName",
484
+ # group: "GroupString",
421
485
  # })
422
486
  #
423
487
  # @example Response structure
@@ -435,11 +499,67 @@ module Aws::ResourceGroups
435
499
  req.send_request(options)
436
500
  end
437
501
 
438
- # 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
439
556
  # group.
440
557
  #
441
- # @option params [required, String] :group_name
442
- # 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.
443
563
  #
444
564
  # @return [Types::GetGroupQueryOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
445
565
  #
@@ -448,7 +568,8 @@ module Aws::ResourceGroups
448
568
  # @example Request syntax with placeholder values
449
569
  #
450
570
  # resp = client.get_group_query({
451
- # group_name: "GroupName", # required
571
+ # group_name: "GroupName",
572
+ # group: "GroupString",
452
573
  # })
453
574
  #
454
575
  # @example Response structure
@@ -470,8 +591,7 @@ module Aws::ResourceGroups
470
591
  # specified by an ARN.
471
592
  #
472
593
  # @option params [required, String] :arn
473
- # The ARN of the resource group for which you want a list of tags. The
474
- # resource must exist within the account you are using.
594
+ # The ARN of the resource group whose tags you want to retrieve.
475
595
  #
476
596
  # @return [Types::GetTagsOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
477
597
  #
@@ -499,31 +619,101 @@ module Aws::ResourceGroups
499
619
  req.send_request(options)
500
620
  end
501
621
 
502
- # Returns a list of ARNs of resources that are members of a specified
503
- # 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.
504
665
  #
505
- # @option params [required, String] :group_name
506
- # The name of the resource group.
666
+ # @option params [String] :group
667
+ # The name or the ARN of the resource group
507
668
  #
508
669
  # @option params [Array<Types::ResourceFilter>] :filters
509
670
  # Filters, formatted as ResourceFilter objects, that you want to apply
510
- # to a ListGroupResources operation.
671
+ # to a `ListGroupResources` operation. Filters the results to include
672
+ # only those of the specified resource types.
511
673
  #
512
674
  # * `resource-type` - Filter resources by their type. Specify up to five
513
- # resource types in the format AWS::ServiceCode::ResourceType. For
514
- # 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`.
515
677
  #
516
678
  # ^
517
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
+ #
518
699
  # @option params [Integer] :max_results
519
- # The maximum number of group member ARNs that are returned in a single
520
- # call by ListGroupResources, in paginated output. By default, this
521
- # 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.
522
710
  #
523
711
  # @option params [String] :next_token
524
- # The NextToken value that is returned in a paginated ListGroupResources
525
- # request. To get the next page of results, run the call again, add the
526
- # 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.
527
717
  #
528
718
  # @return [Types::ListGroupResourcesOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
529
719
  #
@@ -536,7 +726,8 @@ module Aws::ResourceGroups
536
726
  # @example Request syntax with placeholder values
537
727
  #
538
728
  # resp = client.list_group_resources({
539
- # group_name: "GroupName", # required
729
+ # group_name: "GroupName",
730
+ # group: "GroupString",
540
731
  # filters: [
541
732
  # {
542
733
  # name: "resource-type", # required, accepts resource-type
@@ -570,22 +761,39 @@ module Aws::ResourceGroups
570
761
  #
571
762
  # @option params [Array<Types::GroupFilter>] :filters
572
763
  # Filters, formatted as GroupFilter objects, that you want to apply to a
573
- # ListGroups operation.
764
+ # `ListGroups` operation.
574
765
  #
575
- # * `resource-type` - Filter groups by resource type. Specify up to five
576
- # resource types in the format AWS::ServiceCode::ResourceType. For
577
- # 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`.
578
770
  #
579
- # ^
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
+ # ^
580
778
  #
581
779
  # @option params [Integer] :max_results
582
- # The maximum number of resource group results that are returned by
583
- # 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.
584
790
  #
585
791
  # @option params [String] :next_token
586
- # The NextToken value that is returned in a paginated `ListGroups`
587
- # request. To get the next page of results, run the call again, add the
588
- # 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.
589
797
  #
590
798
  # @return [Types::ListGroupsOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
591
799
  #
@@ -600,7 +808,7 @@ module Aws::ResourceGroups
600
808
  # resp = client.list_groups({
601
809
  # filters: [
602
810
  # {
603
- # name: "resource-type", # required, accepts resource-type
811
+ # name: "resource-type", # required, accepts resource-type, configuration-type
604
812
  # values: ["GroupFilterValue"], # required
605
813
  # },
606
814
  # ],
@@ -628,22 +836,32 @@ module Aws::ResourceGroups
628
836
  req.send_request(options)
629
837
  end
630
838
 
631
- # Returns a list of AWS resource identifiers that matches a specified
839
+ # Returns a list of AWS resource identifiers that matches tne specified
632
840
  # query. The query uses the same format as a resource query in a
633
841
  # CreateGroup or UpdateGroupQuery operation.
634
842
  #
635
843
  # @option params [required, Types::ResourceQuery] :resource_query
636
844
  # The search query, using the same formats that are supported for
637
- # resource group definition.
845
+ # resource group definition. For more information, see CreateGroup.
638
846
  #
639
847
  # @option params [Integer] :max_results
640
- # The maximum number of group member ARNs returned by `SearchResources`
641
- # 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.
642
858
  #
643
859
  # @option params [String] :next_token
644
- # The NextToken value that is returned in a paginated `SearchResources`
645
- # request. To get the next page of results, run the call again, add the
646
- # 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.
647
865
  #
648
866
  # @return [Types::SearchResourcesOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
649
867
  #
@@ -687,14 +905,17 @@ module Aws::ResourceGroups
687
905
  # a resource group are not changed if they are not specified in the
688
906
  # request parameters.
689
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
+ #
690
913
  # @option params [required, String] :arn
691
- # The ARN of the resource to which to add tags.
914
+ # The ARN of the resource group to which to add tags.
692
915
  #
693
916
  # @option params [required, Hash<String,String>] :tags
694
- # The tags to add to the specified resource. A tag is a string-to-string
695
- # map of key-value pairs. Tag keys can have a maximum character length
696
- # of 128 characters, and tag values can have a maximum length of 256
697
- # characters.
917
+ # The tags to add to the specified resource group. A tag is a
918
+ # string-to-string map of key-value pairs.
698
919
  #
699
920
  # @return [Types::TagOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
700
921
  #
@@ -725,10 +946,51 @@ module Aws::ResourceGroups
725
946
  req.send_request(options)
726
947
  end
727
948
 
728
- # 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.
729
989
  #
730
990
  # @option params [required, String] :arn
731
- # 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.
732
994
  #
733
995
  # @option params [required, Array<String>] :keys
734
996
  # The keys of the tags to be removed.
@@ -760,17 +1022,19 @@ module Aws::ResourceGroups
760
1022
  req.send_request(options)
761
1023
  end
762
1024
 
763
- # Updates an existing group with a new or changed description. You
764
- # 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.
765
1030
  #
766
- # @option params [required, String] :group_name
767
- # The name of the resource group for which you want to update its
768
- # description.
1031
+ # @option params [String] :group
1032
+ # The name or the ARN of the resource group to modify.
769
1033
  #
770
1034
  # @option params [String] :description
771
- # The description of the resource group. Descriptions can have a maximum
772
- # of 511 characters, including letters, numbers, hyphens, underscores,
773
- # 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.
774
1038
  #
775
1039
  # @return [Types::UpdateGroupOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
776
1040
  #
@@ -779,8 +1043,9 @@ module Aws::ResourceGroups
779
1043
  # @example Request syntax with placeholder values
780
1044
  #
781
1045
  # resp = client.update_group({
782
- # group_name: "GroupName", # required
783
- # description: "GroupDescription",
1046
+ # group_name: "GroupName",
1047
+ # group: "GroupString",
1048
+ # description: "Description",
784
1049
  # })
785
1050
  #
786
1051
  # @example Response structure
@@ -800,12 +1065,15 @@ module Aws::ResourceGroups
800
1065
 
801
1066
  # Updates the resource query of a group.
802
1067
  #
803
- # @option params [required, String] :group_name
804
- # 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.
805
1073
  #
806
1074
  # @option params [required, Types::ResourceQuery] :resource_query
807
- # The resource query that determines which AWS resources are members of
808
- # the resource group.
1075
+ # The resource query to determine which AWS resources are members of
1076
+ # this resource group.
809
1077
  #
810
1078
  # @return [Types::UpdateGroupQueryOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
811
1079
  #
@@ -814,7 +1082,8 @@ module Aws::ResourceGroups
814
1082
  # @example Request syntax with placeholder values
815
1083
  #
816
1084
  # resp = client.update_group_query({
817
- # group_name: "GroupName", # required
1085
+ # group_name: "GroupName",
1086
+ # group: "GroupString",
818
1087
  # resource_query: { # required
819
1088
  # type: "TAG_FILTERS_1_0", # required, accepts TAG_FILTERS_1_0, CLOUDFORMATION_STACK_1_0
820
1089
  # query: "Query", # required
@@ -849,7 +1118,7 @@ module Aws::ResourceGroups
849
1118
  params: params,
850
1119
  config: config)
851
1120
  context[:gem_name] = 'aws-sdk-resourcegroups'
852
- context[:gem_version] = '1.24.0'
1121
+ context[:gem_version] = '1.29.0'
853
1122
  Seahorse::Client::Request.new(handlers, context)
854
1123
  end
855
1124