@aws-sdk/client-resource-groups 3.241.0 → 3.251.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.
Files changed (48) hide show
  1. package/README.md +8 -10
  2. package/dist-cjs/ResourceGroups.js +30 -0
  3. package/dist-cjs/commands/GetAccountSettingsCommand.js +46 -0
  4. package/dist-cjs/commands/UpdateAccountSettingsCommand.js +46 -0
  5. package/dist-cjs/commands/index.js +2 -0
  6. package/dist-cjs/endpoint/ruleset.js +3 -3
  7. package/dist-cjs/models/models_0.js +31 -2
  8. package/dist-cjs/protocols/Aws_restJson1.js +142 -1
  9. package/dist-es/ResourceGroups.js +30 -0
  10. package/dist-es/commands/GetAccountSettingsCommand.js +42 -0
  11. package/dist-es/commands/UpdateAccountSettingsCommand.js +42 -0
  12. package/dist-es/commands/index.js +2 -0
  13. package/dist-es/endpoint/ruleset.js +3 -3
  14. package/dist-es/models/models_0.js +25 -0
  15. package/dist-es/protocols/Aws_restJson1.js +137 -0
  16. package/dist-types/ResourceGroups.d.ts +120 -84
  17. package/dist-types/ResourceGroupsClient.d.ts +18 -18
  18. package/dist-types/commands/CreateGroupCommand.d.ts +7 -7
  19. package/dist-types/commands/DeleteGroupCommand.d.ts +3 -3
  20. package/dist-types/commands/GetAccountSettingsCommand.d.ts +37 -0
  21. package/dist-types/commands/GetGroupCommand.d.ts +3 -3
  22. package/dist-types/commands/GetGroupConfigurationCommand.d.ts +5 -6
  23. package/dist-types/commands/GetGroupQueryCommand.d.ts +3 -3
  24. package/dist-types/commands/GetTagsCommand.d.ts +3 -3
  25. package/dist-types/commands/GroupResourcesCommand.d.ts +21 -3
  26. package/dist-types/commands/ListGroupResourcesCommand.d.ts +6 -6
  27. package/dist-types/commands/ListGroupsCommand.d.ts +4 -4
  28. package/dist-types/commands/PutGroupConfigurationCommand.d.ts +3 -3
  29. package/dist-types/commands/SearchResourcesCommand.d.ts +9 -9
  30. package/dist-types/commands/TagCommand.d.ts +5 -5
  31. package/dist-types/commands/UngroupResourcesCommand.d.ts +7 -4
  32. package/dist-types/commands/UntagCommand.d.ts +3 -3
  33. package/dist-types/commands/UpdateAccountSettingsCommand.d.ts +41 -0
  34. package/dist-types/commands/UpdateGroupCommand.d.ts +3 -3
  35. package/dist-types/commands/UpdateGroupQueryCommand.d.ts +3 -3
  36. package/dist-types/commands/index.d.ts +2 -0
  37. package/dist-types/endpoint/EndpointParameters.d.ts +1 -1
  38. package/dist-types/models/models_0.d.ts +251 -207
  39. package/dist-types/protocols/Aws_restJson1.d.ts +6 -0
  40. package/dist-types/ts3.4/ResourceGroups.d.ts +34 -0
  41. package/dist-types/ts3.4/ResourceGroupsClient.d.ts +12 -0
  42. package/dist-types/ts3.4/commands/GetAccountSettingsCommand.d.ts +34 -0
  43. package/dist-types/ts3.4/commands/UpdateAccountSettingsCommand.d.ts +41 -0
  44. package/dist-types/ts3.4/commands/index.d.ts +2 -0
  45. package/dist-types/ts3.4/endpoint/EndpointParameters.d.ts +1 -1
  46. package/dist-types/ts3.4/models/models_0.d.ts +41 -0
  47. package/dist-types/ts3.4/protocols/Aws_restJson1.d.ts +24 -0
  48. package/package.json +4 -4
@@ -1,5 +1,32 @@
1
1
  import { ExceptionOptionType as __ExceptionOptionType } from "@aws-sdk/smithy-client";
2
2
  import { ResourceGroupsServiceException as __BaseException } from "./ResourceGroupsServiceException";
3
+ export declare enum GroupLifecycleEventsDesiredStatus {
4
+ ACTIVE = "ACTIVE",
5
+ INACTIVE = "INACTIVE"
6
+ }
7
+ export declare enum GroupLifecycleEventsStatus {
8
+ ACTIVE = "ACTIVE",
9
+ ERROR = "ERROR",
10
+ INACTIVE = "INACTIVE",
11
+ IN_PROGRESS = "IN_PROGRESS"
12
+ }
13
+ /**
14
+ * <p>The Resource Groups settings for this Amazon Web Services account.</p>
15
+ */
16
+ export interface AccountSettings {
17
+ /**
18
+ * <p>The desired target status of the group lifecycle events feature. If</p>
19
+ */
20
+ GroupLifecycleEventsDesiredStatus?: GroupLifecycleEventsDesiredStatus | string;
21
+ /**
22
+ * <p>The current status of the group lifecycle events feature.</p>
23
+ */
24
+ GroupLifecycleEventsStatus?: GroupLifecycleEventsStatus | string;
25
+ /**
26
+ * <p>The text of any error message occurs during an attempt to turn group lifecycle events on or off.</p>
27
+ */
28
+ GroupLifecycleEventsStatusMessage?: string;
29
+ }
3
30
  /**
4
31
  * <p>The request includes one or more parameters that violate validation rules.</p>
5
32
  */
@@ -56,127 +83,91 @@ export declare enum QueryType {
56
83
  TAG_FILTERS_1_0 = "TAG_FILTERS_1_0"
57
84
  }
58
85
  /**
59
- * <p>The query that is used to define a resource group or a search for resources. A query
60
- * specifies both a query type and a query string as a JSON object. See the examples
61
- * section for example JSON strings.</p>
62
- * <p>The examples that follow are shown as standard JSON strings. If you include such a
63
- * string as a parameter to the AWS CLI or an SDK API, you might need to 'escape' the
64
- * string into a single line. For example, see the <a href="https://docs.aws.amazon.com/cli/latest/userguide/cli-usage-parameters-quoting-strings.html">Quoting
65
- * strings</a> in the <i>AWS CLI User Guide</i>.</p>
66
- * <p>
67
- * <b>Example 1</b>
68
- * </p>
69
- * <p>The following generic example shows a resource query JSON string that includes only
70
- * resources that meet the following criteria:</p>
71
- * <ul>
72
- * <li>
73
- * <p>The resource type must be either <code>resource_type1</code> or
74
- * <code>resource_type2</code>.</p>
75
- * </li>
76
- * <li>
77
- * <p>The resource must have a tag <code>Key1</code> with a value of either
78
- * <code>ValueA</code> or <code>ValueB</code>.</p>
79
- * </li>
80
- * <li>
81
- * <p>The resource must have a tag <code>Key2</code> with a value of either
82
- * <code>ValueC</code> or <code>ValueD</code>.</p>
83
- * </li>
84
- * </ul>
85
- * <p>
86
- * <code>{
87
- * "Type": "TAG_FILTERS_1_0",
88
- * "Query": {
89
- * "ResourceTypeFilters": [ "resource_type1", "resource_type2"],
90
- * "TagFilters": [
91
- * {
92
- * "Key": "Key1",
93
- * "Values": ["ValueA","ValueB"]
94
- * },
95
- * {
96
- * "Key":"Key2",
97
- * "Values":["ValueC","ValueD"]
98
- * }
99
- * ]
100
- * }
101
- * }</code>
102
- * </p>
103
- * <p>This has the equivalent "shortcut" syntax of the following:</p>
104
- * <p>
105
- * <code>{
106
- * "Type": "TAG_FILTERS_1_0",
107
- * "Query": {
108
- * "ResourceTypeFilters": [ "resource_type1", "resource_type2"],
109
- * "TagFilters": [
110
- * { "Key1": ["ValueA","ValueB"] },
111
- * { "Key2": ["ValueC","ValueD"]
112
- * }
113
- * ]
114
- * }
115
- * }</code>
86
+ * <p>The query you can use to define a resource group or a search for resources. A
87
+ * <code>ResourceQuery</code> specifies both a query <code>Type</code> and a
88
+ * <code>Query</code> string as JSON string objects. See the examples section for
89
+ * example JSON strings. For more information about creating a resource group with a
90
+ * resource query, see <a href="https://docs.aws.amazon.com/ARG/latest/userguide/gettingstarted-query.html">Build queries and groups in
91
+ * Resource Groups</a> in the <i>Resource Groups User Guide</i>
116
92
  * </p>
117
- * <p>
118
- * <b>Example 2</b>
93
+ * <p>When you combine all of the elements together into a single string, any double quotes
94
+ * that are embedded inside another double quote pair must be escaped by preceding the
95
+ * embedded double quote with a backslash character (\). For example, a complete
96
+ * <code>ResourceQuery</code> parameter must be formatted like the following CLI
97
+ * parameter example:</p>
98
+ * <p>
99
+ * <code>--resource-query
100
+ * '{"Type":"TAG_FILTERS_1_0","Query":"{\"ResourceTypeFilters\":[\"AWS::AllSupported\"],\"TagFilters\":[{\"Key\":\"Stage\",\"Values\":[\"Test\"]}]}"}'</code>
119
101
  * </p>
120
- * <p>The following example shows a resource query JSON string that includes only Amazon EC2
121
- * instances that are tagged <code>Stage</code> with a value of <code>Test</code>.</p>
122
- * <p>
123
- * <code>{
124
- * "Type": "TAG_FILTERS_1_0",
125
- * "Query": "{
126
- * "ResourceTypeFilters": "AWS::EC2::Instance",
127
- * "TagFilters": { "Stage": "Test" }
128
- * }
129
- * }</code>
130
- * </p>
131
- * <p>
132
- * <b>Example 3</b>
133
- * </p>
134
- * <p>The following example shows a resource query JSON string that includes resource of any
135
- * supported type as long as it is tagged <code>Stage</code> with a value of
136
- * <code>Prod</code>.</p>
137
- * <p>
138
- * <code>{
139
- * "Type": "TAG_FILTERS_1_0",
140
- * "Query": {
141
- * "ResourceTypeFilters": "AWS::AllSupported",
142
- * "TagFilters": { "Stage": "Prod" }
143
- * }
144
- * }</code>
145
- * </p>
146
- * <p>
147
- * <b>Example 4</b>
148
- * </p>
149
- * <p>The following example shows a resource query JSON string that includes only Amazon EC2
150
- * instances and Amazon S3 buckets that are part of the specified AWS CloudFormation stack.</p>
151
- * <p>
152
- * <code>{
153
- * "Type": "CLOUDFORMATION_STACK_1_0",
154
- * "Query": {
155
- * "ResourceTypeFilters": [ "AWS::EC2::Instance", "AWS::S3::Bucket" ],
156
- * "StackIdentifier": "arn:aws:cloudformation:us-west-2:123456789012:stack/AWStestuseraccount/fb0d5000-aba8-00e8-aa9e-50d5cEXAMPLE"
157
- * }
158
- * }</code>
102
+ * <p>In the preceding example, all of the double quote characters in the value part of the
103
+ * <code>Query</code> element must be escaped because the value itself is surrounded by
104
+ * double quotes. For more information, see <a href="https://docs.aws.amazon.com/cli/latest/userguide/cli-usage-parameters-quoting-strings.html">Quoting
105
+ * strings</a> in the <i>Command Line Interface User Guide</i>.</p>
106
+ * <p>For the complete list of resource types that you can use in the array value for
107
+ * <code>ResourceTypeFilters</code>, see <a href="https://docs.aws.amazon.com/ARG/latest/userguide/supported-resources.html">Resources
108
+ * you can use with Resource Groups and Tag Editor</a> in the
109
+ * <i>Resource Groups User Guide</i>. For example:</p>
110
+ * <p>
111
+ * <code>"ResourceTypeFilters":["AWS::S3::Bucket", "AWS::EC2::Instance"]</code>
159
112
  * </p>
160
113
  */
161
114
  export interface ResourceQuery {
162
115
  /**
163
- * <p>The type of the query. You can use the following values:</p>
164
- * <ul>
116
+ * <p>The type of the query to perform. This can have one of two values:</p>
117
+ * <ul>
165
118
  * <li>
166
- * <p>
119
+ * <p>
167
120
  * <i>
168
121
  * <code>CLOUDFORMATION_STACK_1_0:</code>
169
- * </i>Specifies that the
170
- * <code>Query</code> contains an ARN for a CloudFormation stack.</p>
122
+ * </i> Specifies that you
123
+ * want the group to contain the members of an CloudFormation stack. The <code>Query</code>
124
+ * contains a <code>StackIdentifier</code> element with an ARN for a CloudFormation
125
+ * stack.</p>
171
126
  * </li>
172
127
  * <li>
173
- * <p>
128
+ * <p>
174
129
  * <i>
175
130
  * <code>TAG_FILTERS_1_0:</code>
176
- * </i>Specifies that the
177
- * <code>Query</code> parameter contains a JSON string that represents a
178
- * collection of simple tag filters for resource types and tags. The JSON string
179
- * uses a syntax similar to the <code>
131
+ * </i> Specifies that you want the
132
+ * group to include resource that have tags that match the query. </p>
133
+ * </li>
134
+ * </ul>
135
+ */
136
+ Type: QueryType | string | undefined;
137
+ /**
138
+ * <p>The query that defines a group or a search. The contents depends on the value of the
139
+ * <code>Type</code> element.</p>
140
+ * <ul>
141
+ * <li>
142
+ * <p>
143
+ * <code>ResourceTypeFilters</code> – Applies to all
144
+ * <code>ResourceQuery</code> objects of either <code>Type</code>. This element
145
+ * contains one of the following two items:</p>
146
+ * <ul>
147
+ * <li>
148
+ * <p>The value <code>AWS::AllSupported</code>. This causes the
149
+ * ResourceQuery to match resources of any resource type that also match
150
+ * the query.</p>
151
+ * </li>
152
+ * <li>
153
+ * <p>A list (a JSON array) of resource type identifiers that limit the
154
+ * query to only resources of the specified types. For the complete list of
155
+ * resource types that you can use in the array value for
156
+ * <code>ResourceTypeFilters</code>, see <a href="https://docs.aws.amazon.com/ARG/latest/userguide/supported-resources.html">Resources you can use with Resource Groups and Tag
157
+ * Editor</a> in the <i>Resource Groups User Guide</i>.</p>
158
+ * </li>
159
+ * </ul>
160
+ * <p>Example: <code>"ResourceTypeFilters": ["AWS::AllSupported"]</code> or
161
+ * <code>"ResourceTypeFilters": ["AWS::EC2::Instance",
162
+ * "AWS::S3::Bucket"]</code>
163
+ * </p>
164
+ * </li>
165
+ * <li>
166
+ * <p>
167
+ * <code>TagFilters</code> – applicable only if <code>Type</code> =
168
+ * <code>TAG_FILTERS_1_0</code>. The <code>Query</code> contains a JSON string
169
+ * that represents a collection of simple tag filters. The JSON string uses a
170
+ * syntax similar to the <code>
180
171
  * <a href="https://docs.aws.amazon.com/resourcegroupstagging/latest/APIReference/API_GetResources.html">GetResources</a>
181
172
  * </code> operation, but uses only the <code>
182
173
  * <a href="https://docs.aws.amazon.com/resourcegroupstagging/latest/APIReference/API_GetResources.html#resourcegrouptagging-GetResources-request-ResourceTypeFilters"> ResourceTypeFilters</a>
@@ -187,52 +178,59 @@ export interface ResourceQuery {
187
178
  * tag key, are returned in your query. If you specify more than one value for a
188
179
  * tag key, a resource matches the filter if it has a tag key value that matches
189
180
  * <i>any</i> of the specified values.</p>
190
- * <p>For example, consider the following sample query for resources that have two
181
+ * <p>For example, consider the following sample query for resources that have two
191
182
  * tags, <code>Stage</code> and <code>Version</code>, with two values each:</p>
192
- * <p>
183
+ * <p>
193
184
  * <code>[{"Stage":["Test","Deploy"]},{"Version":["1","2"]}]</code>
194
185
  * </p>
195
- * <p>The results of this query could include the following.</p>
196
- * <ul>
186
+ * <p>The results of this resource query could include the following.</p>
187
+ * <ul>
197
188
  * <li>
198
- * <p>An EC2 instance that has the following two tags:
189
+ * <p>An Amazon EC2 instance that has the following two tags:
199
190
  * <code>{"Stage":"Deploy"}</code>, and
200
191
  * <code>{"Version":"2"}</code>
201
192
  * </p>
202
- * </li>
193
+ * </li>
203
194
  * <li>
204
- * <p>An S3 bucket that has the following two tags:
195
+ * <p>An S3 bucket that has the following two tags:
205
196
  * <code>{"Stage":"Test"}</code>, and
206
197
  * <code>{"Version":"1"}</code>
207
198
  * </p>
208
- * </li>
199
+ * </li>
209
200
  * </ul>
210
- * <p>The query would not include the following items in the results, however. </p>
211
- * <ul>
201
+ * <p>The resource query results would <i>not</i> include the
202
+ * following items in the results, however. </p>
203
+ * <ul>
212
204
  * <li>
213
- * <p>An EC2 instance that has only the following tag:
205
+ * <p>An Amazon EC2 instance that has only the following tag:
214
206
  * <code>{"Stage":"Deploy"}</code>.</p>
215
- * <p>The instance does not have <b>all</b> of the
207
+ * <p>The instance does not have <b>all</b> of the
216
208
  * tag keys specified in the filter, so it is excluded from the
217
209
  * results.</p>
218
- * </li>
210
+ * </li>
219
211
  * <li>
220
- * <p>An RDS database that has the following two tags:
212
+ * <p>An RDS database that has the following two tags:
221
213
  * <code>{"Stage":"Archived"}</code> and
222
214
  * <code>{"Version":"4"}</code>
223
215
  * </p>
224
- * <p>The database has all of the tag keys, but none of those keys has an
216
+ * <p>The database has all of the tag keys, but none of those keys has an
225
217
  * associated value that matches at least one of the specified values in
226
218
  * the filter.</p>
227
- * </li>
219
+ * </li>
228
220
  * </ul>
221
+ * <p>Example: <code>"TagFilters": [ { "Key": "Stage", "Values": [ "Gamma", "Beta" ]
222
+ * }</code>
223
+ * </p>
224
+ * </li>
225
+ * <li>
226
+ * <p>
227
+ * <code>StackIdentifier</code> – applicable only if <code>Type</code> =
228
+ * <code>CLOUDFORMATION_STACK_1_0</code>. The value of this parameter is the
229
+ * Amazon Resource Name (ARN) of the CloudFormation stack whose resources you want included
230
+ * in the group.</p>
229
231
  * </li>
230
232
  * </ul>
231
233
  */
232
- Type: QueryType | string | undefined;
233
- /**
234
- * <p>The query that defines a group or a search.</p>
235
- */
236
234
  Query: string | undefined;
237
235
  }
238
236
  export interface CreateGroupInput {
@@ -241,7 +239,7 @@ export interface CreateGroupInput {
241
239
  * can't change the name of a resource group after you create it. A resource group name can
242
240
  * consist of letters, numbers, hyphens, periods, and underscores. The name cannot start
243
241
  * with <code>AWS</code> or <code>aws</code>; these are reserved. A resource group name
244
- * must be unique within each AWS Region in your AWS account.</p>
242
+ * must be unique within each Amazon Web Services Region in your Amazon Web Services account.</p>
245
243
  */
246
244
  Name: string | undefined;
247
245
  /**
@@ -250,13 +248,13 @@ export interface CreateGroupInput {
250
248
  */
251
249
  Description?: string;
252
250
  /**
253
- * <p>The resource query that determines which AWS resources are members of this group.
251
+ * <p>The resource query that determines which Amazon Web Services resources are members of this group.
254
252
  * For more information about resource queries, see <a href="https://docs.aws.amazon.com/ARG/latest/userguide/gettingstarted-query.html#gettingstarted-query-cli-tag">Create
255
253
  * a tag-based group in Resource Groups</a>. </p>
256
- * <note>
254
+ * <note>
257
255
  * <p>A resource group can contain either a <code>ResourceQuery</code> or a
258
256
  * <code>Configuration</code>, but not both.</p>
259
- * </note>
257
+ * </note>
260
258
  */
261
259
  ResourceQuery?: ResourceQuery;
262
260
  /**
@@ -264,33 +262,32 @@ export interface CreateGroupInput {
264
262
  */
265
263
  Tags?: Record<string, string>;
266
264
  /**
267
- * <p>A configuration associates the resource group with an AWS service and specifies how
265
+ * <p>A configuration associates the resource group with an Amazon Web Services service and specifies how
268
266
  * the service can interact with the resources in the group. A configuration is an array of
269
267
  * <a>GroupConfigurationItem</a> elements. For details about the syntax of
270
- * service configurations, see <a href="https://docs.aws.amazon.com/ARG/latest/APIReference/about-slg.html">Service configurations for resource
271
- * groups</a>.</p>
272
- * <note>
268
+ * service configurations, see <a href="https://docs.aws.amazon.com/ARG/latest/APIReference/about-slg.html">Service configurations for Resource Groups</a>.</p>
269
+ * <note>
273
270
  * <p>A resource group can contain either a <code>Configuration</code> or a
274
271
  * <code>ResourceQuery</code>, but not both.</p>
275
- * </note>
272
+ * </note>
276
273
  */
277
274
  Configuration?: GroupConfigurationItem[];
278
275
  }
279
276
  /**
280
- * <p>A resource group that contains AWS resources. You can assign resources to the group
277
+ * <p>A resource group that contains Amazon Web Services resources. You can assign resources to the group
281
278
  * by associating either of the following elements with the group:</p>
282
- * <ul>
279
+ * <ul>
283
280
  * <li>
284
- * <p>
281
+ * <p>
285
282
  * <a>ResourceQuery</a> - Use a resource query to specify a set of tag
286
- * keys and values. All resources in the same AWS Region and AWS account that
283
+ * keys and values. All resources in the same Amazon Web Services Region and Amazon Web Services account that
287
284
  * have those keys with the same values are included in the group. You can add a
288
285
  * resource query when you create the group, or later by using the <a>PutGroupConfiguration</a> operation.</p>
289
286
  * </li>
290
287
  * <li>
291
- * <p>
288
+ * <p>
292
289
  * <a>GroupConfiguration</a> - Use a service configuration to
293
- * associate the group with an AWS service. The configuration specifies which
290
+ * associate the group with an Amazon Web Services service. The configuration specifies which
294
291
  * resource types can be included in the group.</p>
295
292
  * </li>
296
293
  * </ul>
@@ -316,7 +313,7 @@ export declare enum GroupConfigurationStatus {
316
313
  }
317
314
  /**
318
315
  * <p>A service configuration associated with a resource group. The configuration options
319
- * are determined by the AWS service that defines the <code>Type</code>, and specifies
316
+ * are determined by the Amazon Web Services service that defines the <code>Type</code>, and specifies
320
317
  * which resources can be included in the group. You can add a service configuration when
321
318
  * you create the group by using <a>CreateGroup</a>, or later by using the <a>PutGroupConfiguration</a> operation. For details about group service
322
319
  * configuration syntax, see <a href="https://docs.aws.amazon.com/ARG/latest/APIReference/about-slg.html">Service configurations for resource
@@ -358,8 +355,7 @@ export interface CreateGroupOutput {
358
355
  Tags?: Record<string, string>;
359
356
  /**
360
357
  * <p>The service configuration associated with the resource group. For details about the
361
- * syntax of a service configuration, see <a href="https://docs.aws.amazon.com/ARG/latest/APIReference/about-slg.html">Service configurations for resource
362
- * groups</a>.</p>
358
+ * syntax of a service configuration, see <a href="https://docs.aws.amazon.com/ARG/latest/APIReference/about-slg.html">Service configurations for Resource Groups</a>.</p>
363
359
  */
364
360
  GroupConfiguration?: GroupConfiguration;
365
361
  }
@@ -442,6 +438,12 @@ export declare class NotFoundException extends __BaseException {
442
438
  */
443
439
  constructor(opts: __ExceptionOptionType<NotFoundException, __BaseException>);
444
440
  }
441
+ export interface GetAccountSettingsOutput {
442
+ /**
443
+ * <p>The current settings for the optional features in Resource Groups.</p>
444
+ */
445
+ AccountSettings?: AccountSettings;
446
+ }
445
447
  export interface GetGroupInput {
446
448
  /**
447
449
  * @deprecated
@@ -456,21 +458,24 @@ export interface GetGroupInput {
456
458
  }
457
459
  export interface GetGroupOutput {
458
460
  /**
459
- * <p>A full description of the resource group.</p>
461
+ * <p>A structure that contains the metadata details for the specified resource group. Use
462
+ * <a>GetGroupQuery</a> and <a>GetGroupConfiguration</a> to get
463
+ * those additional details of the resource group.</p>
460
464
  */
461
465
  Group?: Group;
462
466
  }
463
467
  export interface GetGroupConfigurationInput {
464
468
  /**
465
- * <p>The name or the ARN of the resource group.</p>
469
+ * <p>The name or the ARN of the resource group for which you want to retrive the service
470
+ * configuration.</p>
466
471
  */
467
472
  Group?: string;
468
473
  }
469
474
  export interface GetGroupConfigurationOutput {
470
475
  /**
471
- * <p>The service configuration associated with the specified group. For details about the
472
- * service configuration syntax, see <a href="https://docs.aws.amazon.com/ARG/latest/APIReference/about-slg.html">Service configurations for resource
473
- * groups</a>.</p>
476
+ * <p>A structure that describes the service configuration attached with the specified
477
+ * group. For details about the service configuration syntax, see <a href="https://docs.aws.amazon.com/ARG/latest/APIReference/about-slg.html">Service configurations for
478
+ * Resource Groups</a>.</p>
474
479
  */
475
480
  GroupConfiguration?: GroupConfiguration;
476
481
  }
@@ -487,7 +492,7 @@ export interface GetGroupQueryInput {
487
492
  Group?: string;
488
493
  }
489
494
  /**
490
- * <p>A mapping of a query attached to a resource group that determines the AWS resources
495
+ * <p>A mapping of a query attached to a resource group that determines the Amazon Web Services resources
491
496
  * that are members of the group.</p>
492
497
  */
493
498
  export interface GroupQuery {
@@ -497,7 +502,7 @@ export interface GroupQuery {
497
502
  */
498
503
  GroupName: string | undefined;
499
504
  /**
500
- * <p>The resource query that determines which AWS resources are members of the associated
505
+ * <p>The resource query that determines which Amazon Web Services resources are members of the associated
501
506
  * resource group.</p>
502
507
  */
503
508
  ResourceQuery: ResourceQuery | undefined;
@@ -532,7 +537,7 @@ export interface GroupResourcesInput {
532
537
  */
533
538
  Group: string | undefined;
534
539
  /**
535
- * <p>The list of ARNs for resources to be added to the group. </p>
540
+ * <p>The list of ARNs of the resources to be added to the group. </p>
536
541
  */
537
542
  ResourceArns: string[] | undefined;
538
543
  }
@@ -566,22 +571,22 @@ export interface PendingResource {
566
571
  }
567
572
  export interface GroupResourcesOutput {
568
573
  /**
569
- * <p>A list of ARNs of resources that were successfully added to the group by this
570
- * operation.</p>
574
+ * <p>A list of ARNs of the resources that this operation successfully added to the
575
+ * group.</p>
571
576
  */
572
577
  Succeeded?: string[];
573
578
  /**
574
- * <p>A list of ARNs of any resources that failed to be added to the group by this
575
- * operation.</p>
579
+ * <p>A list of ARNs of any resources that this operation failed to add to the group.</p>
576
580
  */
577
581
  Failed?: FailedResource[];
578
582
  /**
579
- * <p>A list of ARNs of any resources that are still in the process of being added to the
580
- * group by this operation. These pending additions continue asynchronously. You can check
581
- * the status of pending additions by using the <code>
583
+ * <p>A list of ARNs of any resources that this operation is still in the process adding to
584
+ * the group. These pending additions continue asynchronously. You can check the status of
585
+ * pending additions by using the <code>
582
586
  * <a>ListGroupResources</a>
583
- * </code> operation, and checking the <code>Resources</code> array in the response
584
- * and the <code>Status</code> field of each object in that array. </p>
587
+ * </code>
588
+ * operation, and checking the <code>Resources</code> array in the response and the
589
+ * <code>Status</code> field of each object in that array. </p>
585
590
  */
586
591
  Pending?: PendingResource[];
587
592
  }
@@ -614,7 +619,7 @@ export interface ListGroupResourcesInput {
614
619
  * <code>Group</code> request field instead.</b>
615
620
  * </i>
616
621
  * </p>
617
- * </important>
622
+ * </important>
618
623
  */
619
624
  GroupName?: string;
620
625
  /**
@@ -625,32 +630,32 @@ export interface ListGroupResourcesInput {
625
630
  * <p>Filters, formatted as <a>ResourceFilter</a> objects, that you want to apply
626
631
  * to a <code>ListGroupResources</code> operation. Filters the results to include only
627
632
  * those of the specified resource types.</p>
628
- * <ul>
633
+ * <ul>
629
634
  * <li>
630
- * <p>
635
+ * <p>
631
636
  * <code>resource-type</code> - Filter resources by their type. Specify up to
632
637
  * five resource types in the format <code>AWS::ServiceCode::ResourceType</code>.
633
638
  * For example, <code>AWS::EC2::Instance</code>, or <code>AWS::S3::Bucket</code>.
634
639
  * </p>
635
640
  * </li>
636
641
  * </ul>
637
- * <p>When you specify a <code>resource-type</code> filter for
638
- * <code>ListGroupResources</code>, AWS Resource Groups validates your filter resource types
642
+ * <p>When you specify a <code>resource-type</code> filter for
643
+ * <code>ListGroupResources</code>, Resource Groups validates your filter resource types
639
644
  * against the types that are defined in the query associated with the group. For example,
640
645
  * if a group contains only S3 buckets because its query specifies only that resource type,
641
- * but your <code>resource-type</code> filter includes EC2 instances, AWS Resource Groups
642
- * does not filter for EC2 instances. In this case, a <code>ListGroupResources</code>
643
- * request returns a <code>BadRequestException</code> error with a message similar to the
646
+ * but your <code>resource-type</code> filter includes EC2 instances, AWS Resource Groups does not
647
+ * filter for EC2 instances. In this case, a <code>ListGroupResources</code> request
648
+ * returns a <code>BadRequestException</code> error with a message similar to the
644
649
  * following:</p>
645
- * <p>
650
+ * <p>
646
651
  * <code>The resource types specified as filters in the request are not
647
652
  * valid.</code>
648
653
  * </p>
649
- * <p>The error includes a list of resource types that failed the validation because they
654
+ * <p>The error includes a list of resource types that failed the validation because they
650
655
  * are not part of the query associated with the group. This validation doesn't occur when
651
656
  * the group query specifies <code>AWS::AllSupported</code>, because a group based on such
652
657
  * a query can contain any of the allowed resource types for the query type (tag-based or
653
- * AWS CloudFormation stack-based queries).</p>
658
+ * Amazon CloudFront stack-based queries).</p>
654
659
  */
655
660
  Filters?: ResourceFilter[];
656
661
  /**
@@ -674,27 +679,27 @@ export interface ListGroupResourcesInput {
674
679
  }
675
680
  export declare enum QueryErrorCode {
676
681
  CLOUDFORMATION_STACK_INACTIVE = "CLOUDFORMATION_STACK_INACTIVE",
677
- CLOUDFORMATION_STACK_NOT_EXISTING = "CLOUDFORMATION_STACK_NOT_EXISTING"
682
+ CLOUDFORMATION_STACK_NOT_EXISTING = "CLOUDFORMATION_STACK_NOT_EXISTING",
683
+ CLOUDFORMATION_STACK_UNASSUMABLE_ROLE = "CLOUDFORMATION_STACK_UNASSUMABLE_ROLE"
678
684
  }
679
685
  /**
680
686
  * <p>A two-part error structure that can occur in <code>ListGroupResources</code> or
681
- * <code>SearchResources</code> operations on CloudFormation stack-based queries. The error
682
- * occurs if the CloudFormation stack on which the query is based either does not exist, or has a
687
+ * <code>SearchResources</code> operations on CloudFront stack-based queries. The error
688
+ * occurs if the CloudFront stack on which the query is based either does not exist, or has a
683
689
  * status that renders the stack inactive. A <code>QueryError</code> occurrence does not
684
- * necessarily mean that AWS Resource Groups could not complete the operation, but the resulting
690
+ * necessarily mean that Resource Groups could not complete the operation, but the resulting
685
691
  * group might have no member resources.</p>
686
692
  */
687
693
  export interface QueryError {
688
694
  /**
689
- * <p>Possible values are <code>CLOUDFORMATION_STACK_INACTIVE</code> and
690
- * <code>CLOUDFORMATION_STACK_NOT_EXISTING</code>.</p>
695
+ * <p>Specifies the error code that was raised.</p>
691
696
  */
692
697
  ErrorCode?: QueryErrorCode | string;
693
698
  /**
694
699
  * <p>A message that explains the <code>ErrorCode</code> value. Messages might state that
695
- * the specified CloudFormation stack does not exist (or no longer exists). For
700
+ * the specified CloudFront stack does not exist (or no longer exists). For
696
701
  * <code>CLOUDFORMATION_STACK_INACTIVE</code>, the message typically states that the
697
- * CloudFormation stack has a status that is not (or no longer) active, such as
702
+ * CloudFront stack has a status that is not (or no longer) active, such as
698
703
  * <code>CREATE_FAILED</code>.</p>
699
704
  */
700
705
  Message?: string;
@@ -740,10 +745,10 @@ export interface ListGroupResourcesItem {
740
745
  /**
741
746
  * <p>A structure that contains the status of this resource's membership in the
742
747
  * group.</p>
743
- * <note>
748
+ * <note>
744
749
  * <p>This field is present in the response only if the group is of type
745
750
  * <code>AWS::EC2::HostManagement</code>.</p>
746
- * </note>
751
+ * </note>
747
752
  */
748
753
  Status?: ResourceStatus;
749
754
  }
@@ -764,7 +769,7 @@ export interface ListGroupResourcesOutput {
764
769
  * instead.</i>
765
770
  * </b>
766
771
  * </p>
767
- * </important>
772
+ * </important>
768
773
  */
769
774
  ResourceIdentifiers?: ResourceIdentifier[];
770
775
  /**
@@ -818,9 +823,9 @@ export interface ListGroupsInput {
818
823
  /**
819
824
  * <p>Filters, formatted as <a>GroupFilter</a> objects, that you want to apply to
820
825
  * a <code>ListGroups</code> operation.</p>
821
- * <ul>
826
+ * <ul>
822
827
  * <li>
823
- * <p>
828
+ * <p>
824
829
  * <code>resource-type</code> - Filter the results to include only those of the
825
830
  * specified resource types. Specify up to five resource types in the format
826
831
  * <code>AWS::<i>ServiceCode</i>::<i>ResourceType</i>
@@ -829,21 +834,21 @@ export interface ListGroupsInput {
829
834
  * <code>AWS::S3::Bucket</code>.</p>
830
835
  * </li>
831
836
  * <li>
832
- * <p>
837
+ * <p>
833
838
  * <code>configuration-type</code> - Filter the results to include only those
834
839
  * groups that have the specified configuration types attached. The current
835
840
  * supported values are:</p>
836
- * <ul>
841
+ * <ul>
837
842
  * <li>
838
- * <p>
839
- * <code>AWS:EC2::CapacityReservationPool</code>
843
+ * <p>
844
+ * <code>AWS::EC2::CapacityReservationPool</code>
840
845
  * </p>
841
- * </li>
846
+ * </li>
842
847
  * <li>
843
- * <p>
844
- * <code>AWS:EC2::HostManagement</code>
848
+ * <p>
849
+ * <code>AWS::EC2::HostManagement</code>
845
850
  * </p>
846
- * </li>
851
+ * </li>
847
852
  * </ul>
848
853
  * </li>
849
854
  * </ul>
@@ -898,7 +903,7 @@ export interface ListGroupsOutput {
898
903
  * instead.</b>
899
904
  * </i>
900
905
  * </p>
901
- * </important>
906
+ * </important>
902
907
  */
903
908
  Groups?: Group[];
904
909
  /**
@@ -917,14 +922,14 @@ export interface PutGroupConfigurationInput {
917
922
  Group?: string;
918
923
  /**
919
924
  * <p>The new configuration to associate with the specified group. A configuration
920
- * associates the resource group with an AWS service and specifies how the service can
925
+ * associates the resource group with an Amazon Web Services service and specifies how the service can
921
926
  * interact with the resources in the group. A configuration is an array of <a>GroupConfigurationItem</a> elements.</p>
922
- * <p>For information about the syntax of a service configuration, see <a href="https://docs.aws.amazon.com/ARG/latest/APIReference/about-slg.html">Service configurations for
923
- * resource groups</a>.</p>
924
- * <note>
927
+ * <p>For information about the syntax of a service configuration, see <a href="https://docs.aws.amazon.com/ARG/latest/APIReference/about-slg.html">Service configurations for
928
+ * Resource Groups</a>.</p>
929
+ * <note>
925
930
  * <p>A resource group can contain either a <code>Configuration</code> or a
926
931
  * <code>ResourceQuery</code>, but not both.</p>
927
- * </note>
932
+ * </note>
928
933
  */
929
934
  Configuration?: GroupConfigurationItem[];
930
935
  }
@@ -970,9 +975,20 @@ export interface SearchResourcesOutput {
970
975
  NextToken?: string;
971
976
  /**
972
977
  * <p>A list of <code>QueryError</code> objects. Each error is an object that contains
973
- * <code>ErrorCode</code> and <code>Message</code> structures. Possible values for
974
- * <code>ErrorCode</code> are <code>CLOUDFORMATION_STACK_INACTIVE</code> and
975
- * <code>CLOUDFORMATION_STACK_NOT_EXISTING</code>.</p>
978
+ * <code>ErrorCode</code> and <code>Message</code> structures.</p>
979
+ * <p>Possible values for <code>ErrorCode</code>:</p>
980
+ * <ul>
981
+ * <li>
982
+ * <p>
983
+ * <code>CLOUDFORMATION_STACK_INACTIVE</code>
984
+ * </p>
985
+ * </li>
986
+ * <li>
987
+ * <p>
988
+ * <code>CLOUDFORMATION_STACK_NOT_EXISTING</code>
989
+ * </p>
990
+ * </li>
991
+ * </ul>
976
992
  */
977
993
  QueryErrors?: QueryError[];
978
994
  }
@@ -1049,6 +1065,18 @@ export interface UntagOutput {
1049
1065
  */
1050
1066
  Keys?: string[];
1051
1067
  }
1068
+ export interface UpdateAccountSettingsInput {
1069
+ /**
1070
+ * <p>Specifies whether you want to turn <a href="https://docs.aws.amazon.com/ARG/latest/userguide/monitor-groups.html">group lifecycle events</a> on or off.</p>
1071
+ */
1072
+ GroupLifecycleEventsDesiredStatus?: GroupLifecycleEventsDesiredStatus | string;
1073
+ }
1074
+ export interface UpdateAccountSettingsOutput {
1075
+ /**
1076
+ * <p>A structure that displays the status of the optional features in the account.</p>
1077
+ */
1078
+ AccountSettings?: AccountSettings;
1079
+ }
1052
1080
  export interface UpdateGroupInput {
1053
1081
  /**
1054
1082
  * @deprecated
@@ -1084,12 +1112,12 @@ export interface UpdateGroupQueryInput {
1084
1112
  */
1085
1113
  Group?: string;
1086
1114
  /**
1087
- * <p>The resource query to determine which AWS resources are members of this resource
1115
+ * <p>The resource query to determine which Amazon Web Services resources are members of this resource
1088
1116
  * group.</p>
1089
- * <note>
1117
+ * <note>
1090
1118
  * <p>A resource group can contain either a <code>Configuration</code> or a
1091
1119
  * <code>ResourceQuery</code>, but not both.</p>
1092
- * </note>
1120
+ * </note>
1093
1121
  */
1094
1122
  ResourceQuery: ResourceQuery | undefined;
1095
1123
  }
@@ -1099,6 +1127,10 @@ export interface UpdateGroupQueryOutput {
1099
1127
  */
1100
1128
  GroupQuery?: GroupQuery;
1101
1129
  }
1130
+ /**
1131
+ * @internal
1132
+ */
1133
+ export declare const AccountSettingsFilterSensitiveLog: (obj: AccountSettings) => any;
1102
1134
  /**
1103
1135
  * @internal
1104
1136
  */
@@ -1135,6 +1167,10 @@ export declare const DeleteGroupInputFilterSensitiveLog: (obj: DeleteGroupInput)
1135
1167
  * @internal
1136
1168
  */
1137
1169
  export declare const DeleteGroupOutputFilterSensitiveLog: (obj: DeleteGroupOutput) => any;
1170
+ /**
1171
+ * @internal
1172
+ */
1173
+ export declare const GetAccountSettingsOutputFilterSensitiveLog: (obj: GetAccountSettingsOutput) => any;
1138
1174
  /**
1139
1175
  * @internal
1140
1176
  */
@@ -1271,6 +1307,14 @@ export declare const UntagInputFilterSensitiveLog: (obj: UntagInput) => any;
1271
1307
  * @internal
1272
1308
  */
1273
1309
  export declare const UntagOutputFilterSensitiveLog: (obj: UntagOutput) => any;
1310
+ /**
1311
+ * @internal
1312
+ */
1313
+ export declare const UpdateAccountSettingsInputFilterSensitiveLog: (obj: UpdateAccountSettingsInput) => any;
1314
+ /**
1315
+ * @internal
1316
+ */
1317
+ export declare const UpdateAccountSettingsOutputFilterSensitiveLog: (obj: UpdateAccountSettingsOutput) => any;
1274
1318
  /**
1275
1319
  * @internal
1276
1320
  */