aws-sdk-resourcegroups 1.46.0 → 1.48.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.
@@ -10,6 +10,31 @@
10
10
  module Aws::ResourceGroups
11
11
  module Types
12
12
 
13
+ # The Resource Groups settings for this Amazon Web Services account.
14
+ #
15
+ # @!attribute [rw] group_lifecycle_events_desired_status
16
+ # The desired target status of the group lifecycle events feature. If
17
+ # @return [String]
18
+ #
19
+ # @!attribute [rw] group_lifecycle_events_status
20
+ # The current status of the group lifecycle events feature.
21
+ # @return [String]
22
+ #
23
+ # @!attribute [rw] group_lifecycle_events_status_message
24
+ # The text of any error message occurs during an attempt to turn group
25
+ # lifecycle events on or off.
26
+ # @return [String]
27
+ #
28
+ # @see http://docs.aws.amazon.com/goto/WebAPI/resource-groups-2017-11-27/AccountSettings AWS API Documentation
29
+ #
30
+ class AccountSettings < Struct.new(
31
+ :group_lifecycle_events_desired_status,
32
+ :group_lifecycle_events_status,
33
+ :group_lifecycle_events_status_message)
34
+ SENSITIVE = []
35
+ include Aws::Structure
36
+ end
37
+
13
38
  # The request includes one or more parameters that violate validation
14
39
  # rules.
15
40
  #
@@ -24,39 +49,14 @@ module Aws::ResourceGroups
24
49
  include Aws::Structure
25
50
  end
26
51
 
27
- # @note When making an API call, you may pass CreateGroupInput
28
- # data as a hash:
29
- #
30
- # {
31
- # name: "GroupName", # required
32
- # description: "Description",
33
- # resource_query: {
34
- # type: "TAG_FILTERS_1_0", # required, accepts TAG_FILTERS_1_0, CLOUDFORMATION_STACK_1_0
35
- # query: "Query", # required
36
- # },
37
- # tags: {
38
- # "TagKey" => "TagValue",
39
- # },
40
- # configuration: [
41
- # {
42
- # type: "GroupConfigurationType", # required
43
- # parameters: [
44
- # {
45
- # name: "GroupConfigurationParameterName", # required
46
- # values: ["GroupConfigurationParameterValue"],
47
- # },
48
- # ],
49
- # },
50
- # ],
51
- # }
52
- #
53
52
  # @!attribute [rw] name
54
53
  # The name of the group, which is the identifier of the group in other
55
54
  # operations. You can't change the name of a resource group after you
56
55
  # create it. A resource group name can consist of letters, numbers,
57
56
  # hyphens, periods, and underscores. The name cannot start with `AWS`
58
57
  # or `aws`; these are reserved. A resource group name must be unique
59
- # within each AWS Region in your AWS account.
58
+ # within each Amazon Web Services Region in your Amazon Web Services
59
+ # account.
60
60
  # @return [String]
61
61
  #
62
62
  # @!attribute [rw] description
@@ -65,9 +65,10 @@ module Aws::ResourceGroups
65
65
  # @return [String]
66
66
  #
67
67
  # @!attribute [rw] resource_query
68
- # The resource query that determines which AWS resources are members
69
- # of this group. For more information about resource queries, see
70
- # [Create a tag-based group in Resource Groups][1].
68
+ # The resource query that determines which Amazon Web Services
69
+ # resources are members of this group. For more information about
70
+ # resource queries, see [Create a tag-based group in Resource
71
+ # Groups][1].
71
72
  #
72
73
  # <note markdown="1"> A resource group can contain either a `ResourceQuery` or a
73
74
  # `Configuration`, but not both.
@@ -84,11 +85,12 @@ module Aws::ResourceGroups
84
85
  # @return [Hash<String,String>]
85
86
  #
86
87
  # @!attribute [rw] configuration
87
- # A configuration associates the resource group with an AWS service
88
- # and specifies how the service can interact with the resources in the
89
- # group. A configuration is an array of GroupConfigurationItem
90
- # elements. For details about the syntax of service configurations,
91
- # see [Service configurations for resource groups][1].
88
+ # A configuration associates the resource group with an Amazon Web
89
+ # Services service and specifies how the service can interact with the
90
+ # resources in the group. A configuration is an array of
91
+ # GroupConfigurationItem elements. For details about the syntax of
92
+ # service configurations, see [Service configurations for Resource
93
+ # Groups][1].
92
94
  #
93
95
  # <note markdown="1"> A resource group can contain either a `Configuration` or a
94
96
  # `ResourceQuery`, but not both.
@@ -133,7 +135,7 @@ module Aws::ResourceGroups
133
135
  # @!attribute [rw] group_configuration
134
136
  # The service configuration associated with the resource group. For
135
137
  # details about the syntax of a service configuration, see [Service
136
- # configurations for resource groups][1].
138
+ # configurations for Resource Groups][1].
137
139
  #
138
140
  #
139
141
  #
@@ -151,14 +153,6 @@ module Aws::ResourceGroups
151
153
  include Aws::Structure
152
154
  end
153
155
 
154
- # @note When making an API call, you may pass DeleteGroupInput
155
- # data as a hash:
156
- #
157
- # {
158
- # group_name: "GroupName",
159
- # group: "GroupString",
160
- # }
161
- #
162
156
  # @!attribute [rw] group_name
163
157
  # Deprecated - don't use this parameter. Use `Group` instead.
164
158
  # @return [String]
@@ -225,15 +219,21 @@ module Aws::ResourceGroups
225
219
  include Aws::Structure
226
220
  end
227
221
 
228
- # @note When making an API call, you may pass GetGroupConfigurationInput
229
- # data as a hash:
222
+ # @!attribute [rw] account_settings
223
+ # The current settings for the optional features in Resource Groups.
224
+ # @return [Types::AccountSettings]
230
225
  #
231
- # {
232
- # group: "GroupString",
233
- # }
226
+ # @see http://docs.aws.amazon.com/goto/WebAPI/resource-groups-2017-11-27/GetAccountSettingsOutput AWS API Documentation
234
227
  #
228
+ class GetAccountSettingsOutput < Struct.new(
229
+ :account_settings)
230
+ SENSITIVE = []
231
+ include Aws::Structure
232
+ end
233
+
235
234
  # @!attribute [rw] group
236
- # The name or the ARN of the resource group.
235
+ # The name or the ARN of the resource group for which you want to
236
+ # retrive the service configuration.
237
237
  # @return [String]
238
238
  #
239
239
  # @see http://docs.aws.amazon.com/goto/WebAPI/resource-groups-2017-11-27/GetGroupConfigurationInput AWS API Documentation
@@ -245,9 +245,9 @@ module Aws::ResourceGroups
245
245
  end
246
246
 
247
247
  # @!attribute [rw] group_configuration
248
- # The service configuration associated with the specified group. For
249
- # details about the service configuration syntax, see [Service
250
- # configurations for resource groups][1].
248
+ # A structure that describes the service configuration attached with
249
+ # the specified group. For details about the service configuration
250
+ # syntax, see [Service configurations for Resource Groups][1].
251
251
  #
252
252
  #
253
253
  #
@@ -262,14 +262,6 @@ module Aws::ResourceGroups
262
262
  include Aws::Structure
263
263
  end
264
264
 
265
- # @note When making an API call, you may pass GetGroupInput
266
- # data as a hash:
267
- #
268
- # {
269
- # group_name: "GroupName",
270
- # group: "GroupString",
271
- # }
272
- #
273
265
  # @!attribute [rw] group_name
274
266
  # Deprecated - don't use this parameter. Use `Group` instead.
275
267
  # @return [String]
@@ -288,7 +280,9 @@ module Aws::ResourceGroups
288
280
  end
289
281
 
290
282
  # @!attribute [rw] group
291
- # A full description of the resource group.
283
+ # A structure that contains the metadata details for the specified
284
+ # resource group. Use GetGroupQuery and GetGroupConfiguration to get
285
+ # those additional details of the resource group.
292
286
  # @return [Types::Group]
293
287
  #
294
288
  # @see http://docs.aws.amazon.com/goto/WebAPI/resource-groups-2017-11-27/GetGroupOutput AWS API Documentation
@@ -299,14 +293,6 @@ module Aws::ResourceGroups
299
293
  include Aws::Structure
300
294
  end
301
295
 
302
- # @note When making an API call, you may pass GetGroupQueryInput
303
- # data as a hash:
304
- #
305
- # {
306
- # group_name: "GroupName",
307
- # group: "GroupString",
308
- # }
309
- #
310
296
  # @!attribute [rw] group_name
311
297
  # Don't use this parameter. Use `Group` instead.
312
298
  # @return [String]
@@ -342,13 +328,6 @@ module Aws::ResourceGroups
342
328
  include Aws::Structure
343
329
  end
344
330
 
345
- # @note When making an API call, you may pass GetTagsInput
346
- # data as a hash:
347
- #
348
- # {
349
- # arn: "GroupArn", # required
350
- # }
351
- #
352
331
  # @!attribute [rw] arn
353
332
  # The ARN of the resource group whose tags you want to retrieve.
354
333
  # @return [String]
@@ -378,19 +357,20 @@ module Aws::ResourceGroups
378
357
  include Aws::Structure
379
358
  end
380
359
 
381
- # A resource group that contains AWS resources. You can assign resources
382
- # to the group by associating either of the following elements with the
383
- # group:
360
+ # A resource group that contains Amazon Web Services resources. You can
361
+ # assign resources to the group by associating either of the following
362
+ # elements with the group:
384
363
  #
385
364
  # * ResourceQuery - Use a resource query to specify a set of tag keys
386
- # and values. All resources in the same AWS Region and AWS account
387
- # that have those keys with the same values are included in the group.
388
- # You can add a resource query when you create the group, or later by
389
- # using the PutGroupConfiguration operation.
365
+ # and values. All resources in the same Amazon Web Services Region and
366
+ # Amazon Web Services account that have those keys with the same
367
+ # values are included in the group. You can add a resource query when
368
+ # you create the group, or later by using the PutGroupConfiguration
369
+ # operation.
390
370
  #
391
371
  # * GroupConfiguration - Use a service configuration to associate the
392
- # group with an AWS service. The configuration specifies which
393
- # resource types can be included in the group.
372
+ # group with an Amazon Web Services service. The configuration
373
+ # specifies which resource types can be included in the group.
394
374
  #
395
375
  # @!attribute [rw] group_arn
396
376
  # The ARN of the resource group.
@@ -415,12 +395,13 @@ module Aws::ResourceGroups
415
395
  end
416
396
 
417
397
  # A service configuration associated with a resource group. The
418
- # configuration options are determined by the AWS service that defines
419
- # the `Type`, and specifies which resources can be included in the
420
- # group. You can add a service configuration when you create the group
421
- # by using CreateGroup, or later by using the PutGroupConfiguration
422
- # operation. For details about group service configuration syntax, see
423
- # [Service configurations for resource groups][1].
398
+ # configuration options are determined by the Amazon Web Services
399
+ # service that defines the `Type`, and specifies which resources can be
400
+ # included in the group. You can add a service configuration when you
401
+ # create the group by using CreateGroup, or later by using the
402
+ # PutGroupConfiguration operation. For details about group service
403
+ # configuration syntax, see [Service configurations for resource
404
+ # groups][1].
424
405
  #
425
406
  #
426
407
  #
@@ -463,19 +444,6 @@ module Aws::ResourceGroups
463
444
  #
464
445
  # [1]: https://docs.aws.amazon.com/ARG/latest/APIReference/about-slg.html
465
446
  #
466
- # @note When making an API call, you may pass GroupConfigurationItem
467
- # data as a hash:
468
- #
469
- # {
470
- # type: "GroupConfigurationType", # required
471
- # parameters: [
472
- # {
473
- # name: "GroupConfigurationParameterName", # required
474
- # values: ["GroupConfigurationParameterValue"],
475
- # },
476
- # ],
477
- # }
478
- #
479
447
  # @!attribute [rw] type
480
448
  # Specifies the type of group configuration item. Each item must have
481
449
  # a unique value for `type`. For the list of types that you can
@@ -514,14 +482,6 @@ module Aws::ResourceGroups
514
482
  #
515
483
  # [1]: https://docs.aws.amazon.com/ARG/latest/APIReference/about-slg.html
516
484
  #
517
- # @note When making an API call, you may pass GroupConfigurationParameter
518
- # data as a hash:
519
- #
520
- # {
521
- # name: "GroupConfigurationParameterName", # required
522
- # values: ["GroupConfigurationParameterValue"],
523
- # }
524
- #
525
485
  # @!attribute [rw] name
526
486
  # The name of the group configuration parameter. For the list of
527
487
  # parameters that you can use with each configuration item type, see
@@ -554,14 +514,6 @@ module Aws::ResourceGroups
554
514
  # A filter collection that you can use to restrict the results from a
555
515
  # `List` operation to only those you want to include.
556
516
  #
557
- # @note When making an API call, you may pass GroupFilter
558
- # data as a hash:
559
- #
560
- # {
561
- # name: "resource-type", # required, accepts resource-type, configuration-type
562
- # values: ["GroupFilterValue"], # required
563
- # }
564
- #
565
517
  # @!attribute [rw] name
566
518
  # The name of the filter. Filter names are case-sensitive.
567
519
  # @return [String]
@@ -600,7 +552,7 @@ module Aws::ResourceGroups
600
552
  end
601
553
 
602
554
  # A mapping of a query attached to a resource group that determines the
603
- # AWS resources that are members of the group.
555
+ # Amazon Web Services resources that are members of the group.
604
556
  #
605
557
  # @!attribute [rw] group_name
606
558
  # The name of the resource group that is associated with the specified
@@ -608,8 +560,8 @@ module Aws::ResourceGroups
608
560
  # @return [String]
609
561
  #
610
562
  # @!attribute [rw] resource_query
611
- # The resource query that determines which AWS resources are members
612
- # of the associated resource group.
563
+ # The resource query that determines which Amazon Web Services
564
+ # resources are members of the associated resource group.
613
565
  # @return [Types::ResourceQuery]
614
566
  #
615
567
  # @see http://docs.aws.amazon.com/goto/WebAPI/resource-groups-2017-11-27/GroupQuery AWS API Documentation
@@ -621,20 +573,12 @@ module Aws::ResourceGroups
621
573
  include Aws::Structure
622
574
  end
623
575
 
624
- # @note When making an API call, you may pass GroupResourcesInput
625
- # data as a hash:
626
- #
627
- # {
628
- # group: "GroupString", # required
629
- # resource_arns: ["ResourceArn"], # required
630
- # }
631
- #
632
576
  # @!attribute [rw] group
633
577
  # The name or the ARN of the resource group to add resources to.
634
578
  # @return [String]
635
579
  #
636
580
  # @!attribute [rw] resource_arns
637
- # The list of ARNs for resources to be added to the group.
581
+ # The list of ARNs of the resources to be added to the group.
638
582
  # @return [Array<String>]
639
583
  #
640
584
  # @see http://docs.aws.amazon.com/goto/WebAPI/resource-groups-2017-11-27/GroupResourcesInput AWS API Documentation
@@ -647,22 +591,22 @@ module Aws::ResourceGroups
647
591
  end
648
592
 
649
593
  # @!attribute [rw] succeeded
650
- # A list of ARNs of resources that were successfully added to the
651
- # group by this operation.
594
+ # A list of ARNs of the resources that this operation successfully
595
+ # added to the group.
652
596
  # @return [Array<String>]
653
597
  #
654
598
  # @!attribute [rw] failed
655
- # A list of ARNs of any resources that failed to be added to the group
656
- # by this operation.
599
+ # A list of ARNs of any resources that this operation failed to add to
600
+ # the group.
657
601
  # @return [Array<Types::FailedResource>]
658
602
  #
659
603
  # @!attribute [rw] pending
660
- # A list of ARNs of any resources that are still in the process of
661
- # being added to the group by this operation. These pending additions
662
- # continue asynchronously. You can check the status of pending
663
- # additions by using the ` ListGroupResources ` operation, and
664
- # checking the `Resources` array in the response and the `Status`
665
- # field of each object in that array.
604
+ # A list of ARNs of any resources that this operation is still in the
605
+ # process adding to the group. These pending additions continue
606
+ # asynchronously. You can check the status of pending additions by
607
+ # using the ` ListGroupResources ` operation, and checking the
608
+ # `Resources` array in the response and the `Status` field of each
609
+ # object in that array.
666
610
  # @return [Array<Types::PendingResource>]
667
611
  #
668
612
  # @see http://docs.aws.amazon.com/goto/WebAPI/resource-groups-2017-11-27/GroupResourcesOutput AWS API Documentation
@@ -689,22 +633,6 @@ module Aws::ResourceGroups
689
633
  include Aws::Structure
690
634
  end
691
635
 
692
- # @note When making an API call, you may pass ListGroupResourcesInput
693
- # data as a hash:
694
- #
695
- # {
696
- # group_name: "GroupName",
697
- # group: "GroupString",
698
- # filters: [
699
- # {
700
- # name: "resource-type", # required, accepts resource-type
701
- # values: ["ResourceFilterValue"], # required
702
- # },
703
- # ],
704
- # max_results: 1,
705
- # next_token: "NextToken",
706
- # }
707
- #
708
636
  # @!attribute [rw] group_name
709
637
  # <i> <b>Deprecated - don't use this parameter. Use the
710
638
  # <code>Group</code> request field instead.</b> </i>
@@ -727,7 +655,7 @@ module Aws::ResourceGroups
727
655
  # ^
728
656
  #
729
657
  # When you specify a `resource-type` filter for `ListGroupResources`,
730
- # AWS Resource Groups validates your filter resource types against the
658
+ # Resource Groups validates your filter resource types against the
731
659
  # types that are defined in the query associated with the group. For
732
660
  # example, if a group contains only S3 buckets because its query
733
661
  # specifies only that resource type, but your `resource-type` filter
@@ -743,7 +671,7 @@ module Aws::ResourceGroups
743
671
  # the group. This validation doesn't occur when the group query
744
672
  # specifies `AWS::AllSupported`, because a group based on such a query
745
673
  # can contain any of the allowed resource types for the query type
746
- # (tag-based or AWS CloudFormation stack-based queries).
674
+ # (tag-based or Amazon CloudFront stack-based queries).
747
675
  # @return [Array<Types::ResourceFilter>]
748
676
  #
749
677
  # @!attribute [rw] max_results
@@ -843,20 +771,6 @@ module Aws::ResourceGroups
843
771
  include Aws::Structure
844
772
  end
845
773
 
846
- # @note When making an API call, you may pass ListGroupsInput
847
- # data as a hash:
848
- #
849
- # {
850
- # filters: [
851
- # {
852
- # name: "resource-type", # required, accepts resource-type, configuration-type
853
- # values: ["GroupFilterValue"], # required
854
- # },
855
- # ],
856
- # max_results: 1,
857
- # next_token: "NextToken",
858
- # }
859
- #
860
774
  # @!attribute [rw] filters
861
775
  # Filters, formatted as GroupFilter objects, that you want to apply to
862
776
  # a `ListGroups` operation.
@@ -870,9 +784,9 @@ module Aws::ResourceGroups
870
784
  # groups that have the specified configuration types attached. The
871
785
  # current supported values are:
872
786
  #
873
- # * `AWS:EC2::CapacityReservationPool`
787
+ # * `AWS::EC2::CapacityReservationPool`
874
788
  #
875
- # * `AWS:EC2::HostManagement`
789
+ # * `AWS::EC2::HostManagement`
876
790
  # @return [Array<Types::GroupFilter>]
877
791
  #
878
792
  # @!attribute [rw] max_results
@@ -979,24 +893,6 @@ module Aws::ResourceGroups
979
893
  include Aws::Structure
980
894
  end
981
895
 
982
- # @note When making an API call, you may pass PutGroupConfigurationInput
983
- # data as a hash:
984
- #
985
- # {
986
- # group: "GroupString",
987
- # configuration: [
988
- # {
989
- # type: "GroupConfigurationType", # required
990
- # parameters: [
991
- # {
992
- # name: "GroupConfigurationParameterName", # required
993
- # values: ["GroupConfigurationParameterValue"],
994
- # },
995
- # ],
996
- # },
997
- # ],
998
- # }
999
- #
1000
896
  # @!attribute [rw] group
1001
897
  # The name or ARN of the resource group with the configuration that
1002
898
  # you want to update.
@@ -1004,13 +900,13 @@ module Aws::ResourceGroups
1004
900
  #
1005
901
  # @!attribute [rw] configuration
1006
902
  # The new configuration to associate with the specified group. A
1007
- # configuration associates the resource group with an AWS service and
1008
- # specifies how the service can interact with the resources in the
1009
- # group. A configuration is an array of GroupConfigurationItem
1010
- # elements.
903
+ # configuration associates the resource group with an Amazon Web
904
+ # Services service and specifies how the service can interact with the
905
+ # resources in the group. A configuration is an array of
906
+ # GroupConfigurationItem elements.
1011
907
  #
1012
908
  # For information about the syntax of a service configuration, see
1013
- # [Service configurations for resource groups][1].
909
+ # [Service configurations for Resource Groups][1].
1014
910
  #
1015
911
  # <note markdown="1"> A resource group can contain either a `Configuration` or a
1016
912
  # `ResourceQuery`, but not both.
@@ -1036,23 +932,22 @@ module Aws::ResourceGroups
1036
932
  class PutGroupConfigurationOutput < Aws::EmptyStructure; end
1037
933
 
1038
934
  # A two-part error structure that can occur in `ListGroupResources` or
1039
- # `SearchResources` operations on CloudFormation stack-based queries.
1040
- # The error occurs if the CloudFormation stack on which the query is
1041
- # based either does not exist, or has a status that renders the stack
1042
- # inactive. A `QueryError` occurrence does not necessarily mean that AWS
935
+ # `SearchResources` operations on CloudFront stack-based queries. The
936
+ # error occurs if the CloudFront stack on which the query is based
937
+ # either does not exist, or has a status that renders the stack
938
+ # inactive. A `QueryError` occurrence does not necessarily mean that
1043
939
  # Resource Groups could not complete the operation, but the resulting
1044
940
  # group might have no member resources.
1045
941
  #
1046
942
  # @!attribute [rw] error_code
1047
- # Possible values are `CLOUDFORMATION_STACK_INACTIVE` and
1048
- # `CLOUDFORMATION_STACK_NOT_EXISTING`.
943
+ # Specifies the error code that was raised.
1049
944
  # @return [String]
1050
945
  #
1051
946
  # @!attribute [rw] message
1052
947
  # A message that explains the `ErrorCode` value. Messages might state
1053
- # that the specified CloudFormation stack does not exist (or no longer
948
+ # that the specified CloudFront stack does not exist (or no longer
1054
949
  # exists). For `CLOUDFORMATION_STACK_INACTIVE`, the message typically
1055
- # states that the CloudFormation stack has a status that is not (or no
950
+ # states that the CloudFront stack has a status that is not (or no
1056
951
  # longer) active, such as `CREATE_FAILED`.
1057
952
  # @return [String]
1058
953
  #
@@ -1068,14 +963,6 @@ module Aws::ResourceGroups
1068
963
  # A filter name and value pair that is used to obtain more specific
1069
964
  # results from a list of resources.
1070
965
  #
1071
- # @note When making an API call, you may pass ResourceFilter
1072
- # data as a hash:
1073
- #
1074
- # {
1075
- # name: "resource-type", # required, accepts resource-type
1076
- # values: ["ResourceFilterValue"], # required
1077
- # }
1078
- #
1079
966
  # @!attribute [rw] name
1080
967
  # The name of the filter. Filter names are case-sensitive.
1081
968
  # @return [String]
@@ -1113,116 +1000,101 @@ module Aws::ResourceGroups
1113
1000
  include Aws::Structure
1114
1001
  end
1115
1002
 
1116
- # The query that is used to define a resource group or a search for
1117
- # resources. A query specifies both a query type and a query string as a
1118
- # JSON object. See the examples section for example JSON strings.
1119
- #
1120
- # The examples that follow are shown as standard JSON strings. If you
1121
- # include such a string as a parameter to the AWS CLI or an SDK API, you
1122
- # might need to 'escape' the string into a single line. For example,
1123
- # see the [Quoting strings][1] in the *AWS CLI User Guide*.
1124
- #
1125
- # **Example 1**
1126
- #
1127
- # The following generic example shows a resource query JSON string that
1128
- # includes only resources that meet the following criteria:
1129
- #
1130
- # * The resource type must be either `resource_type1` or
1131
- # `resource_type2`.
1003
+ # The query you can use to define a resource group or a search for
1004
+ # resources. A `ResourceQuery` specifies both a query `Type` and a
1005
+ # `Query` string as JSON string objects. See the examples section for
1006
+ # example JSON strings. For more information about creating a resource
1007
+ # group with a resource query, see [Build queries and groups in Resource
1008
+ # Groups][1] in the *Resource Groups User Guide*
1132
1009
  #
1133
- # * The resource must have a tag `Key1` with a value of either `ValueA`
1134
- # or `ValueB`.
1010
+ # When you combine all of the elements together into a single string,
1011
+ # any double quotes that are embedded inside another double quote pair
1012
+ # must be escaped by preceding the embedded double quote with a
1013
+ # backslash character (\\). For example, a complete `ResourceQuery`
1014
+ # parameter must be formatted like the following CLI parameter example:
1135
1015
  #
1136
- # * The resource must have a tag `Key2` with a value of either `ValueC`
1137
- # or `ValueD`.
1016
+ # `--resource-query
1017
+ # '\{"Type":"TAG_FILTERS_1_0","Query":"\{"ResourceTypeFilters":["AWS::AllSupported"],"TagFilters":[\{"Key":"Stage","Values":["Test"]\}]\}"\}'`
1138
1018
  #
1139
- # `\{ "Type": "TAG_FILTERS_1_0", "Query": \{ "ResourceTypeFilters": [
1140
- # "resource_type1", "resource_type2"], "TagFilters": [ \{ "Key": "Key1",
1141
- # "Values": ["ValueA","ValueB"] \}, \{ "Key":"Key2",
1142
- # "Values":["ValueC","ValueD"] \} ] \} \}`
1019
+ # In the preceding example, all of the double quote characters in the
1020
+ # value part of the `Query` element must be escaped because the value
1021
+ # itself is surrounded by double quotes. For more information, see
1022
+ # [Quoting strings][2] in the *Command Line Interface User Guide*.
1143
1023
  #
1144
- # This has the equivalent "shortcut" syntax of the following:
1024
+ # For the complete list of resource types that you can use in the array
1025
+ # value for `ResourceTypeFilters`, see [Resources you can use with
1026
+ # Resource Groups and Tag Editor][3] in the *Resource Groups User
1027
+ # Guide*. For example:
1145
1028
  #
1146
- # `\{ "Type": "TAG_FILTERS_1_0", "Query": \{ "ResourceTypeFilters": [
1147
- # "resource_type1", "resource_type2"], "TagFilters": [ \{ "Key1":
1148
- # ["ValueA","ValueB"] \}, \{ "Key2": ["ValueC","ValueD"] \} ] \} \}`
1029
+ # `"ResourceTypeFilters":["AWS::S3::Bucket", "AWS::EC2::Instance"]`
1149
1030
  #
1150
- # **Example 2**
1151
1031
  #
1152
- # The following example shows a resource query JSON string that includes
1153
- # only Amazon EC2 instances that are tagged `Stage` with a value of
1154
- # `Test`.
1155
1032
  #
1156
- # `\{ "Type": "TAG_FILTERS_1_0", "Query": "\{ "ResourceTypeFilters":
1157
- # "AWS::EC2::Instance", "TagFilters": \{ "Stage": "Test" \} \} \}`
1033
+ # [1]: https://docs.aws.amazon.com/ARG/latest/userguide/gettingstarted-query.html
1034
+ # [2]: https://docs.aws.amazon.com/cli/latest/userguide/cli-usage-parameters-quoting-strings.html
1035
+ # [3]: https://docs.aws.amazon.com/ARG/latest/userguide/supported-resources.html
1158
1036
  #
1159
- # **Example 3**
1160
- #
1161
- # The following example shows a resource query JSON string that includes
1162
- # resource of any supported type as long as it is tagged `Stage` with a
1163
- # value of `Prod`.
1164
- #
1165
- # `\{ "Type": "TAG_FILTERS_1_0", "Query": \{ "ResourceTypeFilters":
1166
- # "AWS::AllSupported", "TagFilters": \{ "Stage": "Prod" \} \} \}`
1167
- #
1168
- # **Example 4**
1169
- #
1170
- # The following example shows a resource query JSON string that includes
1171
- # only Amazon EC2 instances and Amazon S3 buckets that are part of the
1172
- # specified AWS CloudFormation stack.
1173
- #
1174
- # `\{ "Type": "CLOUDFORMATION_STACK_1_0", "Query": \{
1175
- # "ResourceTypeFilters": [ "AWS::EC2::Instance", "AWS::S3::Bucket" ],
1176
- # "StackIdentifier":
1177
- # "arn:aws:cloudformation:us-west-2:123456789012:stack/AWStestuseraccount/fb0d5000-aba8-00e8-aa9e-50d5cEXAMPLE"
1178
- # \} \}`
1179
- #
1180
- #
1181
- #
1182
- # [1]: https://docs.aws.amazon.com/cli/latest/userguide/cli-usage-parameters-quoting-strings.html
1037
+ # @!attribute [rw] type
1038
+ # The type of the query to perform. This can have one of two values:
1183
1039
  #
1184
- # @note When making an API call, you may pass ResourceQuery
1185
- # data as a hash:
1040
+ # * <i> <code>CLOUDFORMATION_STACK_1_0:</code> </i> Specifies that you
1041
+ # want the group to contain the members of an CloudFormation stack.
1042
+ # The `Query` contains a `StackIdentifier` element with an ARN for a
1043
+ # CloudFormation stack.
1186
1044
  #
1187
- # {
1188
- # type: "TAG_FILTERS_1_0", # required, accepts TAG_FILTERS_1_0, CLOUDFORMATION_STACK_1_0
1189
- # query: "Query", # required
1190
- # }
1045
+ # * <i> <code>TAG_FILTERS_1_0:</code> </i> Specifies that you want the
1046
+ # group to include resource that have tags that match the query.
1047
+ # @return [String]
1191
1048
  #
1192
- # @!attribute [rw] type
1193
- # The type of the query. You can use the following values:
1194
- #
1195
- # * <i> <code>CLOUDFORMATION_STACK_1_0:</code> </i>Specifies that the
1196
- # `Query` contains an ARN for a CloudFormation stack.
1197
- #
1198
- # * <i> <code>TAG_FILTERS_1_0:</code> </i>Specifies that the `Query`
1199
- # parameter contains a JSON string that represents a collection of
1200
- # simple tag filters for resource types and tags. The JSON string
1201
- # uses a syntax similar to the ` GetResources ` operation, but uses
1202
- # only the ` ResourceTypeFilters ` and ` TagFilters ` fields. If
1203
- # you specify more than one tag key, only resources that match all
1204
- # tag keys, and at least one value of each specified tag key, are
1205
- # returned in your query. If you specify more than one value for a
1206
- # tag key, a resource matches the filter if it has a tag key value
1207
- # that matches *any* of the specified values.
1049
+ # @!attribute [rw] query
1050
+ # The query that defines a group or a search. The contents depends on
1051
+ # the value of the `Type` element.
1052
+ #
1053
+ # * `ResourceTypeFilters` Applies to all `ResourceQuery` objects of
1054
+ # either `Type`. This element contains one of the following two
1055
+ # items:
1056
+ #
1057
+ # * The value `AWS::AllSupported`. This causes the ResourceQuery to
1058
+ # match resources of any resource type that also match the query.
1059
+ #
1060
+ # * A list (a JSON array) of resource type identifiers that limit
1061
+ # the query to only resources of the specified types. For the
1062
+ # complete list of resource types that you can use in the array
1063
+ # value for `ResourceTypeFilters`, see [Resources you can use with
1064
+ # Resource Groups and Tag Editor][1] in the *Resource Groups User
1065
+ # Guide*.
1066
+ #
1067
+ # Example: `"ResourceTypeFilters": ["AWS::AllSupported"]` or
1068
+ # `"ResourceTypeFilters": ["AWS::EC2::Instance", "AWS::S3::Bucket"]`
1069
+ #
1070
+ # * `TagFilters` – applicable only if `Type` = `TAG_FILTERS_1_0`. The
1071
+ # `Query` contains a JSON string that represents a collection of
1072
+ # simple tag filters. The JSON string uses a syntax similar to the `
1073
+ # GetResources ` operation, but uses only the ` ResourceTypeFilters
1074
+ # ` and ` TagFilters ` fields. If you specify more than one tag key,
1075
+ # only resources that match all tag keys, and at least one value of
1076
+ # each specified tag key, are returned in your query. If you specify
1077
+ # more than one value for a tag key, a resource matches the filter
1078
+ # if it has a tag key value that matches *any* of the specified
1079
+ # values.
1208
1080
  #
1209
1081
  # For example, consider the following sample query for resources
1210
1082
  # that have two tags, `Stage` and `Version`, with two values each:
1211
1083
  #
1212
1084
  # `[\{"Stage":["Test","Deploy"]\},\{"Version":["1","2"]\}]`
1213
1085
  #
1214
- # The results of this query could include the following.
1086
+ # The results of this resource query could include the following.
1215
1087
  #
1216
- # * An EC2 instance that has the following two tags:
1088
+ # * An Amazon EC2 instance that has the following two tags:
1217
1089
  # `\{"Stage":"Deploy"\}`, and `\{"Version":"2"\}`
1218
1090
  #
1219
1091
  # * An S3 bucket that has the following two tags:
1220
1092
  # `\{"Stage":"Test"\}`, and `\{"Version":"1"\}`
1221
1093
  #
1222
- # The query would not include the following items in the results,
1223
- # however.
1094
+ # The resource query results would *not* include the following items
1095
+ # in the results, however.
1224
1096
  #
1225
- # * An EC2 instance that has only the following tag:
1097
+ # * An Amazon EC2 instance that has only the following tag:
1226
1098
  # `\{"Stage":"Deploy"\}`.
1227
1099
  #
1228
1100
  # The instance does not have **all** of the tag keys specified in
@@ -1234,10 +1106,18 @@ module Aws::ResourceGroups
1234
1106
  # The database has all of the tag keys, but none of those keys has
1235
1107
  # an associated value that matches at least one of the specified
1236
1108
  # values in the filter.
1237
- # @return [String]
1238
1109
  #
1239
- # @!attribute [rw] query
1240
- # The query that defines a group or a search.
1110
+ # Example: `"TagFilters": [ \{ "Key": "Stage", "Values": [ "Gamma",
1111
+ # "Beta" ] \}`
1112
+ #
1113
+ # * `StackIdentifier` – applicable only if `Type` =
1114
+ # `CLOUDFORMATION_STACK_1_0`. The value of this parameter is the
1115
+ # Amazon Resource Name (ARN) of the CloudFormation stack whose
1116
+ # resources you want included in the group.
1117
+ #
1118
+ #
1119
+ #
1120
+ # [1]: https://docs.aws.amazon.com/ARG/latest/userguide/supported-resources.html
1241
1121
  # @return [String]
1242
1122
  #
1243
1123
  # @see http://docs.aws.amazon.com/goto/WebAPI/resource-groups-2017-11-27/ResourceQuery AWS API Documentation
@@ -1266,18 +1146,6 @@ module Aws::ResourceGroups
1266
1146
  include Aws::Structure
1267
1147
  end
1268
1148
 
1269
- # @note When making an API call, you may pass SearchResourcesInput
1270
- # data as a hash:
1271
- #
1272
- # {
1273
- # resource_query: { # required
1274
- # type: "TAG_FILTERS_1_0", # required, accepts TAG_FILTERS_1_0, CLOUDFORMATION_STACK_1_0
1275
- # query: "Query", # required
1276
- # },
1277
- # max_results: 1,
1278
- # next_token: "NextToken",
1279
- # }
1280
- #
1281
1149
  # @!attribute [rw] resource_query
1282
1150
  # The search query, using the same formats that are supported for
1283
1151
  # resource group definition. For more information, see CreateGroup.
@@ -1329,9 +1197,13 @@ module Aws::ResourceGroups
1329
1197
  #
1330
1198
  # @!attribute [rw] query_errors
1331
1199
  # A list of `QueryError` objects. Each error is an object that
1332
- # contains `ErrorCode` and `Message` structures. Possible values for
1333
- # `ErrorCode` are `CLOUDFORMATION_STACK_INACTIVE` and
1334
- # `CLOUDFORMATION_STACK_NOT_EXISTING`.
1200
+ # contains `ErrorCode` and `Message` structures.
1201
+ #
1202
+ # Possible values for `ErrorCode`\:
1203
+ #
1204
+ # * `CLOUDFORMATION_STACK_INACTIVE`
1205
+ #
1206
+ # * `CLOUDFORMATION_STACK_NOT_EXISTING`
1335
1207
  # @return [Array<Types::QueryError>]
1336
1208
  #
1337
1209
  # @see http://docs.aws.amazon.com/goto/WebAPI/resource-groups-2017-11-27/SearchResourcesOutput AWS API Documentation
@@ -1344,16 +1216,6 @@ module Aws::ResourceGroups
1344
1216
  include Aws::Structure
1345
1217
  end
1346
1218
 
1347
- # @note When making an API call, you may pass TagInput
1348
- # data as a hash:
1349
- #
1350
- # {
1351
- # arn: "GroupArn", # required
1352
- # tags: { # required
1353
- # "TagKey" => "TagValue",
1354
- # },
1355
- # }
1356
- #
1357
1219
  # @!attribute [rw] arn
1358
1220
  # The ARN of the resource group to which to add tags.
1359
1221
  # @return [String]
@@ -1417,14 +1279,6 @@ module Aws::ResourceGroups
1417
1279
  include Aws::Structure
1418
1280
  end
1419
1281
 
1420
- # @note When making an API call, you may pass UngroupResourcesInput
1421
- # data as a hash:
1422
- #
1423
- # {
1424
- # group: "GroupString", # required
1425
- # resource_arns: ["ResourceArn"], # required
1426
- # }
1427
- #
1428
1282
  # @!attribute [rw] group
1429
1283
  # The name or the ARN of the resource group from which to remove the
1430
1284
  # resources.
@@ -1472,14 +1326,6 @@ module Aws::ResourceGroups
1472
1326
  include Aws::Structure
1473
1327
  end
1474
1328
 
1475
- # @note When making an API call, you may pass UntagInput
1476
- # data as a hash:
1477
- #
1478
- # {
1479
- # arn: "GroupArn", # required
1480
- # keys: ["TagKey"], # required
1481
- # }
1482
- #
1483
1329
  # @!attribute [rw] arn
1484
1330
  # The ARN of the resource group from which to remove tags. The command
1485
1331
  # removed both the specified keys and any values associated with those
@@ -1516,15 +1362,36 @@ module Aws::ResourceGroups
1516
1362
  include Aws::Structure
1517
1363
  end
1518
1364
 
1519
- # @note When making an API call, you may pass UpdateGroupInput
1520
- # data as a hash:
1365
+ # @!attribute [rw] group_lifecycle_events_desired_status
1366
+ # Specifies whether you want to turn [group lifecycle events][1] on or
1367
+ # off.
1368
+ #
1369
+ #
1370
+ #
1371
+ # [1]: https://docs.aws.amazon.com/ARG/latest/userguide/monitor-groups.html
1372
+ # @return [String]
1521
1373
  #
1522
- # {
1523
- # group_name: "GroupName",
1524
- # group: "GroupString",
1525
- # description: "Description",
1526
- # }
1374
+ # @see http://docs.aws.amazon.com/goto/WebAPI/resource-groups-2017-11-27/UpdateAccountSettingsInput AWS API Documentation
1527
1375
  #
1376
+ class UpdateAccountSettingsInput < Struct.new(
1377
+ :group_lifecycle_events_desired_status)
1378
+ SENSITIVE = []
1379
+ include Aws::Structure
1380
+ end
1381
+
1382
+ # @!attribute [rw] account_settings
1383
+ # A structure that displays the status of the optional features in the
1384
+ # account.
1385
+ # @return [Types::AccountSettings]
1386
+ #
1387
+ # @see http://docs.aws.amazon.com/goto/WebAPI/resource-groups-2017-11-27/UpdateAccountSettingsOutput AWS API Documentation
1388
+ #
1389
+ class UpdateAccountSettingsOutput < Struct.new(
1390
+ :account_settings)
1391
+ SENSITIVE = []
1392
+ include Aws::Structure
1393
+ end
1394
+
1528
1395
  # @!attribute [rw] group_name
1529
1396
  # Don't use this parameter. Use `Group` instead.
1530
1397
  # @return [String]
@@ -1561,18 +1428,6 @@ module Aws::ResourceGroups
1561
1428
  include Aws::Structure
1562
1429
  end
1563
1430
 
1564
- # @note When making an API call, you may pass UpdateGroupQueryInput
1565
- # data as a hash:
1566
- #
1567
- # {
1568
- # group_name: "GroupName",
1569
- # group: "GroupString",
1570
- # resource_query: { # required
1571
- # type: "TAG_FILTERS_1_0", # required, accepts TAG_FILTERS_1_0, CLOUDFORMATION_STACK_1_0
1572
- # query: "Query", # required
1573
- # },
1574
- # }
1575
- #
1576
1431
  # @!attribute [rw] group_name
1577
1432
  # Don't use this parameter. Use `Group` instead.
1578
1433
  # @return [String]
@@ -1582,8 +1437,8 @@ module Aws::ResourceGroups
1582
1437
  # @return [String]
1583
1438
  #
1584
1439
  # @!attribute [rw] resource_query
1585
- # The resource query to determine which AWS resources are members of
1586
- # this resource group.
1440
+ # The resource query to determine which Amazon Web Services resources
1441
+ # are members of this resource group.
1587
1442
  #
1588
1443
  # <note markdown="1"> A resource group can contain either a `Configuration` or a
1589
1444
  # `ResourceQuery`, but not both.