@aws-sdk/client-resource-groups 3.245.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.
- package/README.md +8 -10
- package/dist-cjs/ResourceGroups.js +30 -0
- package/dist-cjs/commands/GetAccountSettingsCommand.js +46 -0
- package/dist-cjs/commands/UpdateAccountSettingsCommand.js +46 -0
- package/dist-cjs/commands/index.js +2 -0
- package/dist-cjs/endpoint/ruleset.js +3 -3
- package/dist-cjs/models/models_0.js +31 -2
- package/dist-cjs/protocols/Aws_restJson1.js +142 -1
- package/dist-es/ResourceGroups.js +30 -0
- package/dist-es/commands/GetAccountSettingsCommand.js +42 -0
- package/dist-es/commands/UpdateAccountSettingsCommand.js +42 -0
- package/dist-es/commands/index.js +2 -0
- package/dist-es/endpoint/ruleset.js +3 -3
- package/dist-es/models/models_0.js +25 -0
- package/dist-es/protocols/Aws_restJson1.js +137 -0
- package/dist-types/ResourceGroups.d.ts +120 -84
- package/dist-types/ResourceGroupsClient.d.ts +18 -18
- package/dist-types/commands/CreateGroupCommand.d.ts +7 -7
- package/dist-types/commands/DeleteGroupCommand.d.ts +3 -3
- package/dist-types/commands/GetAccountSettingsCommand.d.ts +37 -0
- package/dist-types/commands/GetGroupCommand.d.ts +3 -3
- package/dist-types/commands/GetGroupConfigurationCommand.d.ts +5 -6
- package/dist-types/commands/GetGroupQueryCommand.d.ts +3 -3
- package/dist-types/commands/GetTagsCommand.d.ts +3 -3
- package/dist-types/commands/GroupResourcesCommand.d.ts +21 -3
- package/dist-types/commands/ListGroupResourcesCommand.d.ts +6 -6
- package/dist-types/commands/ListGroupsCommand.d.ts +4 -4
- package/dist-types/commands/PutGroupConfigurationCommand.d.ts +3 -3
- package/dist-types/commands/SearchResourcesCommand.d.ts +9 -9
- package/dist-types/commands/TagCommand.d.ts +5 -5
- package/dist-types/commands/UngroupResourcesCommand.d.ts +7 -4
- package/dist-types/commands/UntagCommand.d.ts +3 -3
- package/dist-types/commands/UpdateAccountSettingsCommand.d.ts +41 -0
- package/dist-types/commands/UpdateGroupCommand.d.ts +3 -3
- package/dist-types/commands/UpdateGroupQueryCommand.d.ts +3 -3
- package/dist-types/commands/index.d.ts +2 -0
- package/dist-types/endpoint/EndpointParameters.d.ts +1 -1
- package/dist-types/models/models_0.d.ts +251 -207
- package/dist-types/protocols/Aws_restJson1.d.ts +6 -0
- package/dist-types/ts3.4/ResourceGroups.d.ts +34 -0
- package/dist-types/ts3.4/ResourceGroupsClient.d.ts +12 -0
- package/dist-types/ts3.4/commands/GetAccountSettingsCommand.d.ts +34 -0
- package/dist-types/ts3.4/commands/UpdateAccountSettingsCommand.d.ts +41 -0
- package/dist-types/ts3.4/commands/index.d.ts +2 -0
- package/dist-types/ts3.4/endpoint/EndpointParameters.d.ts +1 -1
- package/dist-types/ts3.4/models/models_0.d.ts +41 -0
- package/dist-types/ts3.4/protocols/Aws_restJson1.d.ts +24 -0
- package/package.json +1 -1
|
@@ -1,6 +1,7 @@
|
|
|
1
1
|
import { HttpHandlerOptions as __HttpHandlerOptions } from "@aws-sdk/types";
|
|
2
2
|
import { CreateGroupCommandInput, CreateGroupCommandOutput } from "./commands/CreateGroupCommand";
|
|
3
3
|
import { DeleteGroupCommandInput, DeleteGroupCommandOutput } from "./commands/DeleteGroupCommand";
|
|
4
|
+
import { GetAccountSettingsCommandInput, GetAccountSettingsCommandOutput } from "./commands/GetAccountSettingsCommand";
|
|
4
5
|
import { GetGroupCommandInput, GetGroupCommandOutput } from "./commands/GetGroupCommand";
|
|
5
6
|
import { GetGroupConfigurationCommandInput, GetGroupConfigurationCommandOutput } from "./commands/GetGroupConfigurationCommand";
|
|
6
7
|
import { GetGroupQueryCommandInput, GetGroupQueryCommandOutput } from "./commands/GetGroupQueryCommand";
|
|
@@ -13,61 +14,60 @@ import { SearchResourcesCommandInput, SearchResourcesCommandOutput } from "./com
|
|
|
13
14
|
import { TagCommandInput, TagCommandOutput } from "./commands/TagCommand";
|
|
14
15
|
import { UngroupResourcesCommandInput, UngroupResourcesCommandOutput } from "./commands/UngroupResourcesCommand";
|
|
15
16
|
import { UntagCommandInput, UntagCommandOutput } from "./commands/UntagCommand";
|
|
17
|
+
import { UpdateAccountSettingsCommandInput, UpdateAccountSettingsCommandOutput } from "./commands/UpdateAccountSettingsCommand";
|
|
16
18
|
import { UpdateGroupCommandInput, UpdateGroupCommandOutput } from "./commands/UpdateGroupCommand";
|
|
17
19
|
import { UpdateGroupQueryCommandInput, UpdateGroupQueryCommandOutput } from "./commands/UpdateGroupQueryCommand";
|
|
18
20
|
import { ResourceGroupsClient } from "./ResourceGroupsClient";
|
|
19
21
|
/**
|
|
20
|
-
* <
|
|
21
|
-
*
|
|
22
|
-
* <p>AWS Resource Groups lets you organize AWS resources such as Amazon EC2 instances, Amazon Relational Database Service
|
|
23
|
-
* databases, and Amazon S3 buckets into groups using criteria that you define as tags. A
|
|
22
|
+
* <p>Resource Groups lets you organize Amazon Web Services resources such as Amazon Elastic Compute Cloud instances, Amazon Relational Database Service
|
|
23
|
+
* databases, and Amazon Simple Storage Service buckets into groups using criteria that you define as tags. A
|
|
24
24
|
* resource group is a collection of resources that match the resource types specified in a
|
|
25
25
|
* query, and share one or more tags or portions of tags. You can create a group of
|
|
26
26
|
* resources based on their roles in your cloud infrastructure, lifecycle stages, regions,
|
|
27
27
|
* application layers, or virtually any criteria. Resource Groups enable you to automate management
|
|
28
|
-
* tasks, such as those in
|
|
29
|
-
*
|
|
30
|
-
*
|
|
28
|
+
* tasks, such as those in Amazon Web Services Systems Manager Automation documents, on tag-related resources in
|
|
29
|
+
* Amazon Web Services Systems Manager. Groups of tagged resources also let you quickly view a custom console in
|
|
30
|
+
* Amazon Web Services Systems Manager that shows Config compliance and other monitoring data about member
|
|
31
31
|
* resources.</p>
|
|
32
|
-
*
|
|
32
|
+
* <p>To create a resource group, build a resource query, and specify tags that identify the
|
|
33
33
|
* criteria that members of the group have in common. Tags are key-value pairs.</p>
|
|
34
|
-
*
|
|
35
|
-
*
|
|
34
|
+
* <p>For more information about Resource Groups, see the <a href="https://docs.aws.amazon.com/ARG/latest/userguide/welcome.html">Resource Groups User Guide</a>.</p>
|
|
35
|
+
* <p>Resource Groups uses a REST-compliant API that you can use to perform the following types of
|
|
36
36
|
* operations.</p>
|
|
37
|
-
*
|
|
37
|
+
* <ul>
|
|
38
38
|
* <li>
|
|
39
|
-
*
|
|
39
|
+
* <p>Create, Read, Update, and Delete (CRUD) operations on resource groups and
|
|
40
40
|
* resource query entities</p>
|
|
41
41
|
* </li>
|
|
42
42
|
* <li>
|
|
43
|
-
*
|
|
43
|
+
* <p>Applying, editing, and removing tags from resource groups</p>
|
|
44
44
|
* </li>
|
|
45
45
|
* <li>
|
|
46
|
-
*
|
|
46
|
+
* <p>Resolving resource group member ARNs so they can be returned as search
|
|
47
47
|
* results</p>
|
|
48
48
|
* </li>
|
|
49
49
|
* <li>
|
|
50
|
-
*
|
|
50
|
+
* <p>Getting data about resources that are members of a group</p>
|
|
51
51
|
* </li>
|
|
52
52
|
* <li>
|
|
53
|
-
*
|
|
53
|
+
* <p>Searching Amazon Web Services resources based on a resource query</p>
|
|
54
54
|
* </li>
|
|
55
55
|
* </ul>
|
|
56
56
|
*/
|
|
57
57
|
export declare class ResourceGroups extends ResourceGroupsClient {
|
|
58
58
|
/**
|
|
59
59
|
* <p>Creates a resource group with the specified name and description. You can optionally
|
|
60
|
-
* include a resource query
|
|
61
|
-
* constructing a resource query, see <a href="https://docs.aws.amazon.com/ARG/latest/userguide/
|
|
62
|
-
*
|
|
63
|
-
*
|
|
64
|
-
*
|
|
60
|
+
* include either a resource query or a service configuration. For more information about
|
|
61
|
+
* constructing a resource query, see <a href="https://docs.aws.amazon.com/ARG/latest/userguide/getting_started-query.html">Build queries and groups in
|
|
62
|
+
* Resource Groups</a> in the <i>Resource Groups User Guide</i>. For more information
|
|
63
|
+
* about service-linked groups and service configurations, see <a href="https://docs.aws.amazon.com/ARG/latest/APIReference/about-slg.html">Service configurations for Resource Groups</a>.</p>
|
|
64
|
+
* <p>
|
|
65
65
|
* <b>Minimum permissions</b>
|
|
66
66
|
* </p>
|
|
67
67
|
* <p>To run this command, you must have the following permissions:</p>
|
|
68
|
-
*
|
|
68
|
+
* <ul>
|
|
69
69
|
* <li>
|
|
70
|
-
*
|
|
70
|
+
* <p>
|
|
71
71
|
* <code>resource-groups:CreateGroup</code>
|
|
72
72
|
* </p>
|
|
73
73
|
* </li>
|
|
@@ -79,13 +79,13 @@ export declare class ResourceGroups extends ResourceGroupsClient {
|
|
|
79
79
|
/**
|
|
80
80
|
* <p>Deletes the specified resource group. Deleting a resource group does not delete any
|
|
81
81
|
* resources that are members of the group; it only deletes the group structure.</p>
|
|
82
|
-
*
|
|
82
|
+
* <p>
|
|
83
83
|
* <b>Minimum permissions</b>
|
|
84
84
|
* </p>
|
|
85
85
|
* <p>To run this command, you must have the following permissions:</p>
|
|
86
|
-
*
|
|
86
|
+
* <ul>
|
|
87
87
|
* <li>
|
|
88
|
-
*
|
|
88
|
+
* <p>
|
|
89
89
|
* <code>resource-groups:DeleteGroup</code>
|
|
90
90
|
* </p>
|
|
91
91
|
* </li>
|
|
@@ -94,15 +94,21 @@ export declare class ResourceGroups extends ResourceGroupsClient {
|
|
|
94
94
|
deleteGroup(args: DeleteGroupCommandInput, options?: __HttpHandlerOptions): Promise<DeleteGroupCommandOutput>;
|
|
95
95
|
deleteGroup(args: DeleteGroupCommandInput, cb: (err: any, data?: DeleteGroupCommandOutput) => void): void;
|
|
96
96
|
deleteGroup(args: DeleteGroupCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteGroupCommandOutput) => void): void;
|
|
97
|
+
/**
|
|
98
|
+
* <p>Retrieves the current status of optional features in Resource Groups.</p>
|
|
99
|
+
*/
|
|
100
|
+
getAccountSettings(args: GetAccountSettingsCommandInput, options?: __HttpHandlerOptions): Promise<GetAccountSettingsCommandOutput>;
|
|
101
|
+
getAccountSettings(args: GetAccountSettingsCommandInput, cb: (err: any, data?: GetAccountSettingsCommandOutput) => void): void;
|
|
102
|
+
getAccountSettings(args: GetAccountSettingsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetAccountSettingsCommandOutput) => void): void;
|
|
97
103
|
/**
|
|
98
104
|
* <p>Returns information about a specified resource group.</p>
|
|
99
|
-
*
|
|
105
|
+
* <p>
|
|
100
106
|
* <b>Minimum permissions</b>
|
|
101
107
|
* </p>
|
|
102
108
|
* <p>To run this command, you must have the following permissions:</p>
|
|
103
|
-
*
|
|
109
|
+
* <ul>
|
|
104
110
|
* <li>
|
|
105
|
-
*
|
|
111
|
+
* <p>
|
|
106
112
|
* <code>resource-groups:GetGroup</code>
|
|
107
113
|
* </p>
|
|
108
114
|
* </li>
|
|
@@ -112,16 +118,15 @@ export declare class ResourceGroups extends ResourceGroupsClient {
|
|
|
112
118
|
getGroup(args: GetGroupCommandInput, cb: (err: any, data?: GetGroupCommandOutput) => void): void;
|
|
113
119
|
getGroup(args: GetGroupCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetGroupCommandOutput) => void): void;
|
|
114
120
|
/**
|
|
115
|
-
* <p>
|
|
116
|
-
* details about the service configuration syntax, see <a href="https://docs.aws.amazon.com/ARG/latest/APIReference/about-slg.html">Service configurations for
|
|
117
|
-
*
|
|
118
|
-
* <p>
|
|
121
|
+
* <p>Retrieves the service configuration associated with the specified resource group. For
|
|
122
|
+
* details about the service configuration syntax, see <a href="https://docs.aws.amazon.com/ARG/latest/APIReference/about-slg.html">Service configurations for Resource Groups</a>.</p>
|
|
123
|
+
* <p>
|
|
119
124
|
* <b>Minimum permissions</b>
|
|
120
125
|
* </p>
|
|
121
126
|
* <p>To run this command, you must have the following permissions:</p>
|
|
122
|
-
*
|
|
127
|
+
* <ul>
|
|
123
128
|
* <li>
|
|
124
|
-
*
|
|
129
|
+
* <p>
|
|
125
130
|
* <code>resource-groups:GetGroupConfiguration</code>
|
|
126
131
|
* </p>
|
|
127
132
|
* </li>
|
|
@@ -134,13 +139,13 @@ export declare class ResourceGroups extends ResourceGroupsClient {
|
|
|
134
139
|
* <p>Retrieves the resource query associated with the specified resource group. For more
|
|
135
140
|
* information about resource queries, see <a href="https://docs.aws.amazon.com/ARG/latest/userguide/gettingstarted-query.html#gettingstarted-query-cli-tag">Create
|
|
136
141
|
* a tag-based group in Resource Groups</a>.</p>
|
|
137
|
-
*
|
|
142
|
+
* <p>
|
|
138
143
|
* <b>Minimum permissions</b>
|
|
139
144
|
* </p>
|
|
140
145
|
* <p>To run this command, you must have the following permissions:</p>
|
|
141
|
-
*
|
|
146
|
+
* <ul>
|
|
142
147
|
* <li>
|
|
143
|
-
*
|
|
148
|
+
* <p>
|
|
144
149
|
* <code>resource-groups:GetGroupQuery</code>
|
|
145
150
|
* </p>
|
|
146
151
|
* </li>
|
|
@@ -152,13 +157,13 @@ export declare class ResourceGroups extends ResourceGroupsClient {
|
|
|
152
157
|
/**
|
|
153
158
|
* <p>Returns a list of tags that are associated with a resource group, specified by an
|
|
154
159
|
* ARN.</p>
|
|
155
|
-
*
|
|
160
|
+
* <p>
|
|
156
161
|
* <b>Minimum permissions</b>
|
|
157
162
|
* </p>
|
|
158
163
|
* <p>To run this command, you must have the following permissions:</p>
|
|
159
|
-
*
|
|
164
|
+
* <ul>
|
|
160
165
|
* <li>
|
|
161
|
-
*
|
|
166
|
+
* <p>
|
|
162
167
|
* <code>resource-groups:GetTags</code>
|
|
163
168
|
* </p>
|
|
164
169
|
* </li>
|
|
@@ -169,13 +174,31 @@ export declare class ResourceGroups extends ResourceGroupsClient {
|
|
|
169
174
|
getTags(args: GetTagsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetTagsCommandOutput) => void): void;
|
|
170
175
|
/**
|
|
171
176
|
* <p>Adds the specified resources to the specified group.</p>
|
|
172
|
-
*
|
|
177
|
+
* <important>
|
|
178
|
+
* <p>You can use this operation with only resource groups that are configured with the
|
|
179
|
+
* following types:</p>
|
|
180
|
+
* <ul>
|
|
181
|
+
* <li>
|
|
182
|
+
* <p>
|
|
183
|
+
* <code>AWS::EC2::HostManagement</code>
|
|
184
|
+
* </p>
|
|
185
|
+
* </li>
|
|
186
|
+
* <li>
|
|
187
|
+
* <p>
|
|
188
|
+
* <code>AWS::EC2::CapacityReservationPool</code>
|
|
189
|
+
* </p>
|
|
190
|
+
* </li>
|
|
191
|
+
* </ul>
|
|
192
|
+
* <p>Other resource group type and resource types aren't currently supported by this
|
|
193
|
+
* operation.</p>
|
|
194
|
+
* </important>
|
|
195
|
+
* <p>
|
|
173
196
|
* <b>Minimum permissions</b>
|
|
174
197
|
* </p>
|
|
175
198
|
* <p>To run this command, you must have the following permissions:</p>
|
|
176
|
-
*
|
|
199
|
+
* <ul>
|
|
177
200
|
* <li>
|
|
178
|
-
*
|
|
201
|
+
* <p>
|
|
179
202
|
* <code>resource-groups:GroupResources</code>
|
|
180
203
|
* </p>
|
|
181
204
|
* </li>
|
|
@@ -187,28 +210,28 @@ export declare class ResourceGroups extends ResourceGroupsClient {
|
|
|
187
210
|
/**
|
|
188
211
|
* <p>Returns a list of ARNs of the resources that are members of a specified resource
|
|
189
212
|
* group.</p>
|
|
190
|
-
*
|
|
213
|
+
* <p>
|
|
191
214
|
* <b>Minimum permissions</b>
|
|
192
215
|
* </p>
|
|
193
216
|
* <p>To run this command, you must have the following permissions:</p>
|
|
194
|
-
*
|
|
217
|
+
* <ul>
|
|
195
218
|
* <li>
|
|
196
|
-
*
|
|
219
|
+
* <p>
|
|
197
220
|
* <code>resource-groups:ListGroupResources</code>
|
|
198
221
|
* </p>
|
|
199
222
|
* </li>
|
|
200
223
|
* <li>
|
|
201
|
-
*
|
|
224
|
+
* <p>
|
|
202
225
|
* <code>cloudformation:DescribeStacks</code>
|
|
203
226
|
* </p>
|
|
204
227
|
* </li>
|
|
205
228
|
* <li>
|
|
206
|
-
*
|
|
229
|
+
* <p>
|
|
207
230
|
* <code>cloudformation:ListStackResources</code>
|
|
208
231
|
* </p>
|
|
209
232
|
* </li>
|
|
210
233
|
* <li>
|
|
211
|
-
*
|
|
234
|
+
* <p>
|
|
212
235
|
* <code>tag:GetResources</code>
|
|
213
236
|
* </p>
|
|
214
237
|
* </li>
|
|
@@ -218,14 +241,14 @@ export declare class ResourceGroups extends ResourceGroupsClient {
|
|
|
218
241
|
listGroupResources(args: ListGroupResourcesCommandInput, cb: (err: any, data?: ListGroupResourcesCommandOutput) => void): void;
|
|
219
242
|
listGroupResources(args: ListGroupResourcesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListGroupResourcesCommandOutput) => void): void;
|
|
220
243
|
/**
|
|
221
|
-
* <p>Returns a list of existing
|
|
222
|
-
*
|
|
244
|
+
* <p>Returns a list of existing Resource Groups in your account.</p>
|
|
245
|
+
* <p>
|
|
223
246
|
* <b>Minimum permissions</b>
|
|
224
247
|
* </p>
|
|
225
248
|
* <p>To run this command, you must have the following permissions:</p>
|
|
226
|
-
*
|
|
249
|
+
* <ul>
|
|
227
250
|
* <li>
|
|
228
|
-
*
|
|
251
|
+
* <p>
|
|
229
252
|
* <code>resource-groups:ListGroups</code>
|
|
230
253
|
* </p>
|
|
231
254
|
* </li>
|
|
@@ -238,13 +261,13 @@ export declare class ResourceGroups extends ResourceGroupsClient {
|
|
|
238
261
|
* <p>Attaches a service configuration to the specified group. This occurs asynchronously,
|
|
239
262
|
* and can take time to complete. You can use <a>GetGroupConfiguration</a> to
|
|
240
263
|
* check the status of the update.</p>
|
|
241
|
-
*
|
|
264
|
+
* <p>
|
|
242
265
|
* <b>Minimum permissions</b>
|
|
243
266
|
* </p>
|
|
244
267
|
* <p>To run this command, you must have the following permissions:</p>
|
|
245
|
-
*
|
|
268
|
+
* <ul>
|
|
246
269
|
* <li>
|
|
247
|
-
*
|
|
270
|
+
* <p>
|
|
248
271
|
* <code>resource-groups:PutGroupConfiguration</code>
|
|
249
272
|
* </p>
|
|
250
273
|
* </li>
|
|
@@ -254,31 +277,31 @@ export declare class ResourceGroups extends ResourceGroupsClient {
|
|
|
254
277
|
putGroupConfiguration(args: PutGroupConfigurationCommandInput, cb: (err: any, data?: PutGroupConfigurationCommandOutput) => void): void;
|
|
255
278
|
putGroupConfiguration(args: PutGroupConfigurationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutGroupConfigurationCommandOutput) => void): void;
|
|
256
279
|
/**
|
|
257
|
-
* <p>Returns a list of
|
|
258
|
-
* query uses the same format as a resource query in a CreateGroup or
|
|
259
|
-
*
|
|
260
|
-
*
|
|
280
|
+
* <p>Returns a list of Amazon Web Services resource identifiers that matches the specified query. The
|
|
281
|
+
* query uses the same format as a resource query in a <a>CreateGroup</a> or
|
|
282
|
+
* <a>UpdateGroupQuery</a> operation.</p>
|
|
283
|
+
* <p>
|
|
261
284
|
* <b>Minimum permissions</b>
|
|
262
285
|
* </p>
|
|
263
286
|
* <p>To run this command, you must have the following permissions:</p>
|
|
264
|
-
*
|
|
287
|
+
* <ul>
|
|
265
288
|
* <li>
|
|
266
|
-
*
|
|
289
|
+
* <p>
|
|
267
290
|
* <code>resource-groups:SearchResources</code>
|
|
268
291
|
* </p>
|
|
269
292
|
* </li>
|
|
270
293
|
* <li>
|
|
271
|
-
*
|
|
294
|
+
* <p>
|
|
272
295
|
* <code>cloudformation:DescribeStacks</code>
|
|
273
296
|
* </p>
|
|
274
297
|
* </li>
|
|
275
298
|
* <li>
|
|
276
|
-
*
|
|
299
|
+
* <p>
|
|
277
300
|
* <code>cloudformation:ListStackResources</code>
|
|
278
301
|
* </p>
|
|
279
302
|
* </li>
|
|
280
303
|
* <li>
|
|
281
|
-
*
|
|
304
|
+
* <p>
|
|
282
305
|
* <code>tag:GetResources</code>
|
|
283
306
|
* </p>
|
|
284
307
|
* </li>
|
|
@@ -290,19 +313,19 @@ export declare class ResourceGroups extends ResourceGroupsClient {
|
|
|
290
313
|
/**
|
|
291
314
|
* <p>Adds tags to a resource group with the specified ARN. Existing tags on a resource
|
|
292
315
|
* group are not changed if they are not specified in the request parameters.</p>
|
|
293
|
-
*
|
|
316
|
+
* <important>
|
|
294
317
|
* <p>Do not store personally identifiable information (PII) or other confidential or
|
|
295
318
|
* sensitive information in tags. We use tags to provide you with billing and
|
|
296
319
|
* administration services. Tags are not intended to be used for private or sensitive
|
|
297
320
|
* data.</p>
|
|
298
|
-
*
|
|
299
|
-
*
|
|
321
|
+
* </important>
|
|
322
|
+
* <p>
|
|
300
323
|
* <b>Minimum permissions</b>
|
|
301
324
|
* </p>
|
|
302
325
|
* <p>To run this command, you must have the following permissions:</p>
|
|
303
|
-
*
|
|
326
|
+
* <ul>
|
|
304
327
|
* <li>
|
|
305
|
-
*
|
|
328
|
+
* <p>
|
|
306
329
|
* <code>resource-groups:Tag</code>
|
|
307
330
|
* </p>
|
|
308
331
|
* </li>
|
|
@@ -312,14 +335,17 @@ export declare class ResourceGroups extends ResourceGroupsClient {
|
|
|
312
335
|
tag(args: TagCommandInput, cb: (err: any, data?: TagCommandOutput) => void): void;
|
|
313
336
|
tag(args: TagCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: TagCommandOutput) => void): void;
|
|
314
337
|
/**
|
|
315
|
-
* <p>Removes the specified resources from the specified group
|
|
316
|
-
*
|
|
338
|
+
* <p>Removes the specified resources from the specified group. This operation works only
|
|
339
|
+
* with static groups that you populated using the <a>GroupResources</a>
|
|
340
|
+
* operation. It doesn't work with any resource groups that are automatically populated by
|
|
341
|
+
* tag-based or CloudFormation stack-based queries.</p>
|
|
342
|
+
* <p>
|
|
317
343
|
* <b>Minimum permissions</b>
|
|
318
344
|
* </p>
|
|
319
345
|
* <p>To run this command, you must have the following permissions:</p>
|
|
320
|
-
*
|
|
346
|
+
* <ul>
|
|
321
347
|
* <li>
|
|
322
|
-
*
|
|
348
|
+
* <p>
|
|
323
349
|
* <code>resource-groups:UngroupResources</code>
|
|
324
350
|
* </p>
|
|
325
351
|
* </li>
|
|
@@ -330,13 +356,13 @@ export declare class ResourceGroups extends ResourceGroupsClient {
|
|
|
330
356
|
ungroupResources(args: UngroupResourcesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UngroupResourcesCommandOutput) => void): void;
|
|
331
357
|
/**
|
|
332
358
|
* <p>Deletes tags from a specified resource group.</p>
|
|
333
|
-
*
|
|
359
|
+
* <p>
|
|
334
360
|
* <b>Minimum permissions</b>
|
|
335
361
|
* </p>
|
|
336
362
|
* <p>To run this command, you must have the following permissions:</p>
|
|
337
|
-
*
|
|
363
|
+
* <ul>
|
|
338
364
|
* <li>
|
|
339
|
-
*
|
|
365
|
+
* <p>
|
|
340
366
|
* <code>resource-groups:Untag</code>
|
|
341
367
|
* </p>
|
|
342
368
|
* </li>
|
|
@@ -345,16 +371,26 @@ export declare class ResourceGroups extends ResourceGroupsClient {
|
|
|
345
371
|
untag(args: UntagCommandInput, options?: __HttpHandlerOptions): Promise<UntagCommandOutput>;
|
|
346
372
|
untag(args: UntagCommandInput, cb: (err: any, data?: UntagCommandOutput) => void): void;
|
|
347
373
|
untag(args: UntagCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UntagCommandOutput) => void): void;
|
|
374
|
+
/**
|
|
375
|
+
* <p>Turns on or turns off optional features in Resource Groups.</p>
|
|
376
|
+
* <p>The preceding example shows that the request to turn on group lifecycle events is
|
|
377
|
+
* <code>IN_PROGRESS</code>. You can call the <a>GetAccountSettings</a>
|
|
378
|
+
* operation to check for completion by looking for <code>GroupLifecycleEventsStatus</code>
|
|
379
|
+
* to change to <code>ACTIVE</code>.</p>
|
|
380
|
+
*/
|
|
381
|
+
updateAccountSettings(args: UpdateAccountSettingsCommandInput, options?: __HttpHandlerOptions): Promise<UpdateAccountSettingsCommandOutput>;
|
|
382
|
+
updateAccountSettings(args: UpdateAccountSettingsCommandInput, cb: (err: any, data?: UpdateAccountSettingsCommandOutput) => void): void;
|
|
383
|
+
updateAccountSettings(args: UpdateAccountSettingsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateAccountSettingsCommandOutput) => void): void;
|
|
348
384
|
/**
|
|
349
385
|
* <p>Updates the description for an existing group. You cannot update the name of a
|
|
350
386
|
* resource group.</p>
|
|
351
|
-
*
|
|
387
|
+
* <p>
|
|
352
388
|
* <b>Minimum permissions</b>
|
|
353
389
|
* </p>
|
|
354
390
|
* <p>To run this command, you must have the following permissions:</p>
|
|
355
|
-
*
|
|
391
|
+
* <ul>
|
|
356
392
|
* <li>
|
|
357
|
-
*
|
|
393
|
+
* <p>
|
|
358
394
|
* <code>resource-groups:UpdateGroup</code>
|
|
359
395
|
* </p>
|
|
360
396
|
* </li>
|
|
@@ -366,13 +402,13 @@ export declare class ResourceGroups extends ResourceGroupsClient {
|
|
|
366
402
|
/**
|
|
367
403
|
* <p>Updates the resource query of a group. For more information about resource queries,
|
|
368
404
|
* see <a href="https://docs.aws.amazon.com/ARG/latest/userguide/gettingstarted-query.html#gettingstarted-query-cli-tag">Create a tag-based group in Resource Groups</a>.</p>
|
|
369
|
-
*
|
|
405
|
+
* <p>
|
|
370
406
|
* <b>Minimum permissions</b>
|
|
371
407
|
* </p>
|
|
372
408
|
* <p>To run this command, you must have the following permissions:</p>
|
|
373
|
-
*
|
|
409
|
+
* <ul>
|
|
374
410
|
* <li>
|
|
375
|
-
*
|
|
411
|
+
* <p>
|
|
376
412
|
* <code>resource-groups:UpdateGroupQuery</code>
|
|
377
413
|
* </p>
|
|
378
414
|
* </li>
|
|
@@ -9,6 +9,7 @@ import { Client as __Client, DefaultsMode, SmithyConfiguration as __SmithyConfig
|
|
|
9
9
|
import { BodyLengthCalculator as __BodyLengthCalculator, Credentials as __Credentials, Decoder as __Decoder, Encoder as __Encoder, HashConstructor as __HashConstructor, HttpHandlerOptions as __HttpHandlerOptions, Logger as __Logger, Provider as __Provider, Provider, StreamCollector as __StreamCollector, UrlParser as __UrlParser, UserAgent as __UserAgent } from "@aws-sdk/types";
|
|
10
10
|
import { CreateGroupCommandInput, CreateGroupCommandOutput } from "./commands/CreateGroupCommand";
|
|
11
11
|
import { DeleteGroupCommandInput, DeleteGroupCommandOutput } from "./commands/DeleteGroupCommand";
|
|
12
|
+
import { GetAccountSettingsCommandInput, GetAccountSettingsCommandOutput } from "./commands/GetAccountSettingsCommand";
|
|
12
13
|
import { GetGroupCommandInput, GetGroupCommandOutput } from "./commands/GetGroupCommand";
|
|
13
14
|
import { GetGroupConfigurationCommandInput, GetGroupConfigurationCommandOutput } from "./commands/GetGroupConfigurationCommand";
|
|
14
15
|
import { GetGroupQueryCommandInput, GetGroupQueryCommandOutput } from "./commands/GetGroupQueryCommand";
|
|
@@ -21,11 +22,12 @@ import { SearchResourcesCommandInput, SearchResourcesCommandOutput } from "./com
|
|
|
21
22
|
import { TagCommandInput, TagCommandOutput } from "./commands/TagCommand";
|
|
22
23
|
import { UngroupResourcesCommandInput, UngroupResourcesCommandOutput } from "./commands/UngroupResourcesCommand";
|
|
23
24
|
import { UntagCommandInput, UntagCommandOutput } from "./commands/UntagCommand";
|
|
25
|
+
import { UpdateAccountSettingsCommandInput, UpdateAccountSettingsCommandOutput } from "./commands/UpdateAccountSettingsCommand";
|
|
24
26
|
import { UpdateGroupCommandInput, UpdateGroupCommandOutput } from "./commands/UpdateGroupCommand";
|
|
25
27
|
import { UpdateGroupQueryCommandInput, UpdateGroupQueryCommandOutput } from "./commands/UpdateGroupQueryCommand";
|
|
26
28
|
import { ClientInputEndpointParameters, ClientResolvedEndpointParameters, EndpointParameters } from "./endpoint/EndpointParameters";
|
|
27
|
-
export declare type ServiceInputTypes = CreateGroupCommandInput | DeleteGroupCommandInput | GetGroupCommandInput | GetGroupConfigurationCommandInput | GetGroupQueryCommandInput | GetTagsCommandInput | GroupResourcesCommandInput | ListGroupResourcesCommandInput | ListGroupsCommandInput | PutGroupConfigurationCommandInput | SearchResourcesCommandInput | TagCommandInput | UngroupResourcesCommandInput | UntagCommandInput | UpdateGroupCommandInput | UpdateGroupQueryCommandInput;
|
|
28
|
-
export declare type ServiceOutputTypes = CreateGroupCommandOutput | DeleteGroupCommandOutput | GetGroupCommandOutput | GetGroupConfigurationCommandOutput | GetGroupQueryCommandOutput | GetTagsCommandOutput | GroupResourcesCommandOutput | ListGroupResourcesCommandOutput | ListGroupsCommandOutput | PutGroupConfigurationCommandOutput | SearchResourcesCommandOutput | TagCommandOutput | UngroupResourcesCommandOutput | UntagCommandOutput | UpdateGroupCommandOutput | UpdateGroupQueryCommandOutput;
|
|
29
|
+
export declare type ServiceInputTypes = CreateGroupCommandInput | DeleteGroupCommandInput | GetAccountSettingsCommandInput | GetGroupCommandInput | GetGroupConfigurationCommandInput | GetGroupQueryCommandInput | GetTagsCommandInput | GroupResourcesCommandInput | ListGroupResourcesCommandInput | ListGroupsCommandInput | PutGroupConfigurationCommandInput | SearchResourcesCommandInput | TagCommandInput | UngroupResourcesCommandInput | UntagCommandInput | UpdateAccountSettingsCommandInput | UpdateGroupCommandInput | UpdateGroupQueryCommandInput;
|
|
30
|
+
export declare type ServiceOutputTypes = CreateGroupCommandOutput | DeleteGroupCommandOutput | GetAccountSettingsCommandOutput | GetGroupCommandOutput | GetGroupConfigurationCommandOutput | GetGroupQueryCommandOutput | GetTagsCommandOutput | GroupResourcesCommandOutput | ListGroupResourcesCommandOutput | ListGroupsCommandOutput | PutGroupConfigurationCommandOutput | SearchResourcesCommandOutput | TagCommandOutput | UngroupResourcesCommandOutput | UntagCommandOutput | UpdateAccountSettingsCommandOutput | UpdateGroupCommandOutput | UpdateGroupQueryCommandOutput;
|
|
29
31
|
export interface ClientDefaults extends Partial<__SmithyResolvedConfiguration<__HttpHandlerOptions>> {
|
|
30
32
|
/**
|
|
31
33
|
* The HTTP handler to use. Fetch in browser and Https in Nodejs.
|
|
@@ -139,40 +141,38 @@ declare type ResourceGroupsClientResolvedConfigType = __SmithyResolvedConfigurat
|
|
|
139
141
|
export interface ResourceGroupsClientResolvedConfig extends ResourceGroupsClientResolvedConfigType {
|
|
140
142
|
}
|
|
141
143
|
/**
|
|
142
|
-
* <
|
|
143
|
-
*
|
|
144
|
-
* <p>AWS Resource Groups lets you organize AWS resources such as Amazon EC2 instances, Amazon Relational Database Service
|
|
145
|
-
* databases, and Amazon S3 buckets into groups using criteria that you define as tags. A
|
|
144
|
+
* <p>Resource Groups lets you organize Amazon Web Services resources such as Amazon Elastic Compute Cloud instances, Amazon Relational Database Service
|
|
145
|
+
* databases, and Amazon Simple Storage Service buckets into groups using criteria that you define as tags. A
|
|
146
146
|
* resource group is a collection of resources that match the resource types specified in a
|
|
147
147
|
* query, and share one or more tags or portions of tags. You can create a group of
|
|
148
148
|
* resources based on their roles in your cloud infrastructure, lifecycle stages, regions,
|
|
149
149
|
* application layers, or virtually any criteria. Resource Groups enable you to automate management
|
|
150
|
-
* tasks, such as those in
|
|
151
|
-
*
|
|
152
|
-
*
|
|
150
|
+
* tasks, such as those in Amazon Web Services Systems Manager Automation documents, on tag-related resources in
|
|
151
|
+
* Amazon Web Services Systems Manager. Groups of tagged resources also let you quickly view a custom console in
|
|
152
|
+
* Amazon Web Services Systems Manager that shows Config compliance and other monitoring data about member
|
|
153
153
|
* resources.</p>
|
|
154
|
-
*
|
|
154
|
+
* <p>To create a resource group, build a resource query, and specify tags that identify the
|
|
155
155
|
* criteria that members of the group have in common. Tags are key-value pairs.</p>
|
|
156
|
-
*
|
|
157
|
-
*
|
|
156
|
+
* <p>For more information about Resource Groups, see the <a href="https://docs.aws.amazon.com/ARG/latest/userguide/welcome.html">Resource Groups User Guide</a>.</p>
|
|
157
|
+
* <p>Resource Groups uses a REST-compliant API that you can use to perform the following types of
|
|
158
158
|
* operations.</p>
|
|
159
|
-
*
|
|
159
|
+
* <ul>
|
|
160
160
|
* <li>
|
|
161
|
-
*
|
|
161
|
+
* <p>Create, Read, Update, and Delete (CRUD) operations on resource groups and
|
|
162
162
|
* resource query entities</p>
|
|
163
163
|
* </li>
|
|
164
164
|
* <li>
|
|
165
|
-
*
|
|
165
|
+
* <p>Applying, editing, and removing tags from resource groups</p>
|
|
166
166
|
* </li>
|
|
167
167
|
* <li>
|
|
168
|
-
*
|
|
168
|
+
* <p>Resolving resource group member ARNs so they can be returned as search
|
|
169
169
|
* results</p>
|
|
170
170
|
* </li>
|
|
171
171
|
* <li>
|
|
172
|
-
*
|
|
172
|
+
* <p>Getting data about resources that are members of a group</p>
|
|
173
173
|
* </li>
|
|
174
174
|
* <li>
|
|
175
|
-
*
|
|
175
|
+
* <p>Searching Amazon Web Services resources based on a resource query</p>
|
|
176
176
|
* </li>
|
|
177
177
|
* </ul>
|
|
178
178
|
*/
|
|
@@ -9,17 +9,17 @@ export interface CreateGroupCommandOutput extends CreateGroupOutput, __MetadataB
|
|
|
9
9
|
}
|
|
10
10
|
/**
|
|
11
11
|
* <p>Creates a resource group with the specified name and description. You can optionally
|
|
12
|
-
* include a resource query
|
|
13
|
-
* constructing a resource query, see <a href="https://docs.aws.amazon.com/ARG/latest/userguide/
|
|
14
|
-
*
|
|
15
|
-
*
|
|
16
|
-
*
|
|
12
|
+
* include either a resource query or a service configuration. For more information about
|
|
13
|
+
* constructing a resource query, see <a href="https://docs.aws.amazon.com/ARG/latest/userguide/getting_started-query.html">Build queries and groups in
|
|
14
|
+
* Resource Groups</a> in the <i>Resource Groups User Guide</i>. For more information
|
|
15
|
+
* about service-linked groups and service configurations, see <a href="https://docs.aws.amazon.com/ARG/latest/APIReference/about-slg.html">Service configurations for Resource Groups</a>.</p>
|
|
16
|
+
* <p>
|
|
17
17
|
* <b>Minimum permissions</b>
|
|
18
18
|
* </p>
|
|
19
19
|
* <p>To run this command, you must have the following permissions:</p>
|
|
20
|
-
*
|
|
20
|
+
* <ul>
|
|
21
21
|
* <li>
|
|
22
|
-
*
|
|
22
|
+
* <p>
|
|
23
23
|
* <code>resource-groups:CreateGroup</code>
|
|
24
24
|
* </p>
|
|
25
25
|
* </li>
|
|
@@ -10,13 +10,13 @@ export interface DeleteGroupCommandOutput extends DeleteGroupOutput, __MetadataB
|
|
|
10
10
|
/**
|
|
11
11
|
* <p>Deletes the specified resource group. Deleting a resource group does not delete any
|
|
12
12
|
* resources that are members of the group; it only deletes the group structure.</p>
|
|
13
|
-
*
|
|
13
|
+
* <p>
|
|
14
14
|
* <b>Minimum permissions</b>
|
|
15
15
|
* </p>
|
|
16
16
|
* <p>To run this command, you must have the following permissions:</p>
|
|
17
|
-
*
|
|
17
|
+
* <ul>
|
|
18
18
|
* <li>
|
|
19
|
-
*
|
|
19
|
+
* <p>
|
|
20
20
|
* <code>resource-groups:DeleteGroup</code>
|
|
21
21
|
* </p>
|
|
22
22
|
* </li>
|
|
@@ -0,0 +1,37 @@
|
|
|
1
|
+
import { EndpointParameterInstructions } from "@aws-sdk/middleware-endpoint";
|
|
2
|
+
import { Command as $Command } from "@aws-sdk/smithy-client";
|
|
3
|
+
import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer, MiddlewareStack } from "@aws-sdk/types";
|
|
4
|
+
import { GetAccountSettingsOutput } from "../models/models_0";
|
|
5
|
+
import { ResourceGroupsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ResourceGroupsClient";
|
|
6
|
+
export interface GetAccountSettingsCommandInput {
|
|
7
|
+
}
|
|
8
|
+
export interface GetAccountSettingsCommandOutput extends GetAccountSettingsOutput, __MetadataBearer {
|
|
9
|
+
}
|
|
10
|
+
/**
|
|
11
|
+
* <p>Retrieves the current status of optional features in Resource Groups.</p>
|
|
12
|
+
* @example
|
|
13
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
14
|
+
* ```javascript
|
|
15
|
+
* import { ResourceGroupsClient, GetAccountSettingsCommand } from "@aws-sdk/client-resource-groups"; // ES Modules import
|
|
16
|
+
* // const { ResourceGroupsClient, GetAccountSettingsCommand } = require("@aws-sdk/client-resource-groups"); // CommonJS import
|
|
17
|
+
* const client = new ResourceGroupsClient(config);
|
|
18
|
+
* const command = new GetAccountSettingsCommand(input);
|
|
19
|
+
* const response = await client.send(command);
|
|
20
|
+
* ```
|
|
21
|
+
*
|
|
22
|
+
* @see {@link GetAccountSettingsCommandInput} for command's `input` shape.
|
|
23
|
+
* @see {@link GetAccountSettingsCommandOutput} for command's `response` shape.
|
|
24
|
+
* @see {@link ResourceGroupsClientResolvedConfig | config} for ResourceGroupsClient's `config` shape.
|
|
25
|
+
*
|
|
26
|
+
*/
|
|
27
|
+
export declare class GetAccountSettingsCommand extends $Command<GetAccountSettingsCommandInput, GetAccountSettingsCommandOutput, ResourceGroupsClientResolvedConfig> {
|
|
28
|
+
readonly input: GetAccountSettingsCommandInput;
|
|
29
|
+
static getEndpointParameterInstructions(): EndpointParameterInstructions;
|
|
30
|
+
constructor(input: GetAccountSettingsCommandInput);
|
|
31
|
+
/**
|
|
32
|
+
* @internal
|
|
33
|
+
*/
|
|
34
|
+
resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: ResourceGroupsClientResolvedConfig, options?: __HttpHandlerOptions): Handler<GetAccountSettingsCommandInput, GetAccountSettingsCommandOutput>;
|
|
35
|
+
private serialize;
|
|
36
|
+
private deserialize;
|
|
37
|
+
}
|
|
@@ -9,13 +9,13 @@ export interface GetGroupCommandOutput extends GetGroupOutput, __MetadataBearer
|
|
|
9
9
|
}
|
|
10
10
|
/**
|
|
11
11
|
* <p>Returns information about a specified resource group.</p>
|
|
12
|
-
*
|
|
12
|
+
* <p>
|
|
13
13
|
* <b>Minimum permissions</b>
|
|
14
14
|
* </p>
|
|
15
15
|
* <p>To run this command, you must have the following permissions:</p>
|
|
16
|
-
*
|
|
16
|
+
* <ul>
|
|
17
17
|
* <li>
|
|
18
|
-
*
|
|
18
|
+
* <p>
|
|
19
19
|
* <code>resource-groups:GetGroup</code>
|
|
20
20
|
* </p>
|
|
21
21
|
* </li>
|