1 | import {Request} from '../lib/request';
|
2 | import {Response} from '../lib/response';
|
3 | import {AWSError} from '../lib/error';
|
4 | import {Service} from '../lib/service';
|
5 | import {ServiceConfigurationOptions} from '../lib/service';
|
6 | import {ConfigBase as Config} from '../lib/config';
|
7 | interface Blob {}
|
8 | declare class ResourceGroups extends Service {
|
9 | |
10 |
|
11 |
|
12 | constructor(options?: ResourceGroups.Types.ClientConfiguration)
|
13 | config: Config & ResourceGroups.Types.ClientConfiguration;
|
14 | /**
|
15 | * Creates a group with a specified name, description, and resource query.
|
16 | */
|
17 | createGroup(params: ResourceGroups.Types.CreateGroupInput, callback?: (err: AWSError, data: ResourceGroups.Types.CreateGroupOutput) => void): Request<ResourceGroups.Types.CreateGroupOutput, AWSError>;
|
18 | /**
|
19 | * Creates a group with a specified name, description, and resource query.
|
20 | */
|
21 | createGroup(callback?: (err: AWSError, data: ResourceGroups.Types.CreateGroupOutput) => void): Request<ResourceGroups.Types.CreateGroupOutput, AWSError>;
|
22 | /**
|
23 | * Deletes a specified resource group. Deleting a resource group does not delete resources that are members of the group; it only deletes the group structure.
|
24 | */
|
25 | deleteGroup(params: ResourceGroups.Types.DeleteGroupInput, callback?: (err: AWSError, data: ResourceGroups.Types.DeleteGroupOutput) => void): Request<ResourceGroups.Types.DeleteGroupOutput, AWSError>;
|
26 | /**
|
27 | * Deletes a specified resource group. Deleting a resource group does not delete resources that are members of the group; it only deletes the group structure.
|
28 | */
|
29 | deleteGroup(callback?: (err: AWSError, data: ResourceGroups.Types.DeleteGroupOutput) => void): Request<ResourceGroups.Types.DeleteGroupOutput, AWSError>;
|
30 | /**
|
31 | * Returns information about a specified resource group.
|
32 | */
|
33 | getGroup(params: ResourceGroups.Types.GetGroupInput, callback?: (err: AWSError, data: ResourceGroups.Types.GetGroupOutput) => void): Request<ResourceGroups.Types.GetGroupOutput, AWSError>;
|
34 | /**
|
35 | * Returns information about a specified resource group.
|
36 | */
|
37 | getGroup(callback?: (err: AWSError, data: ResourceGroups.Types.GetGroupOutput) => void): Request<ResourceGroups.Types.GetGroupOutput, AWSError>;
|
38 | /**
|
39 | * Returns the resource query associated with the specified resource group.
|
40 | */
|
41 | getGroupQuery(params: ResourceGroups.Types.GetGroupQueryInput, callback?: (err: AWSError, data: ResourceGroups.Types.GetGroupQueryOutput) => void): Request<ResourceGroups.Types.GetGroupQueryOutput, AWSError>;
|
42 | /**
|
43 | * Returns the resource query associated with the specified resource group.
|
44 | */
|
45 | getGroupQuery(callback?: (err: AWSError, data: ResourceGroups.Types.GetGroupQueryOutput) => void): Request<ResourceGroups.Types.GetGroupQueryOutput, AWSError>;
|
46 | /**
|
47 | * Returns a list of tags that are associated with a resource group, specified by an ARN.
|
48 | */
|
49 | getTags(params: ResourceGroups.Types.GetTagsInput, callback?: (err: AWSError, data: ResourceGroups.Types.GetTagsOutput) => void): Request<ResourceGroups.Types.GetTagsOutput, AWSError>;
|
50 | /**
|
51 | * Returns a list of tags that are associated with a resource group, specified by an ARN.
|
52 | */
|
53 | getTags(callback?: (err: AWSError, data: ResourceGroups.Types.GetTagsOutput) => void): Request<ResourceGroups.Types.GetTagsOutput, AWSError>;
|
54 | /**
|
55 | * Returns a list of ARNs of resources that are members of a specified resource group.
|
56 | */
|
57 | listGroupResources(params: ResourceGroups.Types.ListGroupResourcesInput, callback?: (err: AWSError, data: ResourceGroups.Types.ListGroupResourcesOutput) => void): Request<ResourceGroups.Types.ListGroupResourcesOutput, AWSError>;
|
58 | /**
|
59 | * Returns a list of ARNs of resources that are members of a specified resource group.
|
60 | */
|
61 | listGroupResources(callback?: (err: AWSError, data: ResourceGroups.Types.ListGroupResourcesOutput) => void): Request<ResourceGroups.Types.ListGroupResourcesOutput, AWSError>;
|
62 | /**
|
63 | * Returns a list of existing resource groups in your account.
|
64 | */
|
65 | listGroups(params: ResourceGroups.Types.ListGroupsInput, callback?: (err: AWSError, data: ResourceGroups.Types.ListGroupsOutput) => void): Request<ResourceGroups.Types.ListGroupsOutput, AWSError>;
|
66 | /**
|
67 | * Returns a list of existing resource groups in your account.
|
68 | */
|
69 | listGroups(callback?: (err: AWSError, data: ResourceGroups.Types.ListGroupsOutput) => void): Request<ResourceGroups.Types.ListGroupsOutput, AWSError>;
|
70 | /**
|
71 | * Returns a list of AWS resource identifiers that matches a specified query. The query uses the same format as a resource query in a CreateGroup or UpdateGroupQuery operation.
|
72 | */
|
73 | searchResources(params: ResourceGroups.Types.SearchResourcesInput, callback?: (err: AWSError, data: ResourceGroups.Types.SearchResourcesOutput) => void): Request<ResourceGroups.Types.SearchResourcesOutput, AWSError>;
|
74 | /**
|
75 | * Returns a list of AWS resource identifiers that matches a specified query. The query uses the same format as a resource query in a CreateGroup or UpdateGroupQuery operation.
|
76 | */
|
77 | searchResources(callback?: (err: AWSError, data: ResourceGroups.Types.SearchResourcesOutput) => void): Request<ResourceGroups.Types.SearchResourcesOutput, AWSError>;
|
78 | /**
|
79 | * Adds tags to a resource group with the specified ARN. Existing tags on a resource group are not changed if they are not specified in the request parameters.
|
80 | */
|
81 | tag(params: ResourceGroups.Types.TagInput, callback?: (err: AWSError, data: ResourceGroups.Types.TagOutput) => void): Request<ResourceGroups.Types.TagOutput, AWSError>;
|
82 | /**
|
83 | * Adds tags to a resource group with the specified ARN. Existing tags on a resource group are not changed if they are not specified in the request parameters.
|
84 | */
|
85 | tag(callback?: (err: AWSError, data: ResourceGroups.Types.TagOutput) => void): Request<ResourceGroups.Types.TagOutput, AWSError>;
|
86 | /**
|
87 | * Deletes specified tags from a specified resource.
|
88 | */
|
89 | untag(params: ResourceGroups.Types.UntagInput, callback?: (err: AWSError, data: ResourceGroups.Types.UntagOutput) => void): Request<ResourceGroups.Types.UntagOutput, AWSError>;
|
90 | /**
|
91 | * Deletes specified tags from a specified resource.
|
92 | */
|
93 | untag(callback?: (err: AWSError, data: ResourceGroups.Types.UntagOutput) => void): Request<ResourceGroups.Types.UntagOutput, AWSError>;
|
94 | /**
|
95 | * Updates an existing group with a new or changed description. You cannot update the name of a resource group.
|
96 | */
|
97 | updateGroup(params: ResourceGroups.Types.UpdateGroupInput, callback?: (err: AWSError, data: ResourceGroups.Types.UpdateGroupOutput) => void): Request<ResourceGroups.Types.UpdateGroupOutput, AWSError>;
|
98 | /**
|
99 | * Updates an existing group with a new or changed description. You cannot update the name of a resource group.
|
100 | */
|
101 | updateGroup(callback?: (err: AWSError, data: ResourceGroups.Types.UpdateGroupOutput) => void): Request<ResourceGroups.Types.UpdateGroupOutput, AWSError>;
|
102 | /**
|
103 | * Updates the resource query of a group.
|
104 | */
|
105 | updateGroupQuery(params: ResourceGroups.Types.UpdateGroupQueryInput, callback?: (err: AWSError, data: ResourceGroups.Types.UpdateGroupQueryOutput) => void): Request<ResourceGroups.Types.UpdateGroupQueryOutput, AWSError>;
|
106 | /**
|
107 | * Updates the resource query of a group.
|
108 | */
|
109 | updateGroupQuery(callback?: (err: AWSError, data: ResourceGroups.Types.UpdateGroupQueryOutput) => void): Request<ResourceGroups.Types.UpdateGroupQueryOutput, AWSError>;
|
110 | }
|
111 | declare namespace ResourceGroups {
|
112 | export interface CreateGroupInput {
|
113 | |
114 |
|
115 |
|
116 | Name: GroupName;
|
117 | |
118 |
|
119 |
|
120 | Description?: GroupDescription;
|
121 | |
122 |
|
123 |
|
124 | ResourceQuery: ResourceQuery;
|
125 | |
126 |
|
127 |
|
128 | Tags?: Tags;
|
129 | }
|
130 | export interface CreateGroupOutput {
|
131 | |
132 |
|
133 |
|
134 | Group?: Group;
|
135 | |
136 |
|
137 |
|
138 | ResourceQuery?: ResourceQuery;
|
139 | |
140 |
|
141 |
|
142 | Tags?: Tags;
|
143 | }
|
144 | export interface DeleteGroupInput {
|
145 | |
146 |
|
147 |
|
148 | GroupName: GroupName;
|
149 | }
|
150 | export interface DeleteGroupOutput {
|
151 | |
152 |
|
153 |
|
154 | Group?: Group;
|
155 | }
|
156 | export interface GetGroupInput {
|
157 | |
158 |
|
159 |
|
160 | GroupName: GroupName;
|
161 | }
|
162 | export interface GetGroupOutput {
|
163 | |
164 |
|
165 |
|
166 | Group?: Group;
|
167 | }
|
168 | export interface GetGroupQueryInput {
|
169 | |
170 |
|
171 |
|
172 | GroupName: GroupName;
|
173 | }
|
174 | export interface GetGroupQueryOutput {
|
175 | |
176 |
|
177 |
|
178 | GroupQuery?: GroupQuery;
|
179 | }
|
180 | export interface GetTagsInput {
|
181 | |
182 |
|
183 |
|
184 | Arn: GroupArn;
|
185 | }
|
186 | export interface GetTagsOutput {
|
187 | |
188 |
|
189 |
|
190 | Arn?: GroupArn;
|
191 | |
192 |
|
193 |
|
194 | Tags?: Tags;
|
195 | }
|
196 | export interface Group {
|
197 | |
198 |
|
199 |
|
200 | GroupArn: GroupArn;
|
201 | |
202 |
|
203 |
|
204 | Name: GroupName;
|
205 | |
206 |
|
207 |
|
208 | Description?: GroupDescription;
|
209 | }
|
210 | export type GroupArn = string;
|
211 | export type GroupDescription = string;
|
212 | export interface GroupFilter {
|
213 | |
214 |
|
215 |
|
216 | Name: GroupFilterName;
|
217 | |
218 |
|
219 |
|
220 | Values: GroupFilterValues;
|
221 | }
|
222 | export type GroupFilterList = GroupFilter[];
|
223 | export type GroupFilterName = "resource-type"|string;
|
224 | export type GroupFilterValue = string;
|
225 | export type GroupFilterValues = GroupFilterValue[];
|
226 | export interface GroupIdentifier {
|
227 | |
228 |
|
229 |
|
230 | GroupName?: GroupName;
|
231 | |
232 |
|
233 |
|
234 | GroupArn?: GroupArn;
|
235 | }
|
236 | export type GroupIdentifierList = GroupIdentifier[];
|
237 | export type GroupList = Group[];
|
238 | export type GroupName = string;
|
239 | export interface GroupQuery {
|
240 | |
241 |
|
242 |
|
243 | GroupName: GroupName;
|
244 | |
245 |
|
246 |
|
247 | ResourceQuery: ResourceQuery;
|
248 | }
|
249 | export interface ListGroupResourcesInput {
|
250 | |
251 |
|
252 |
|
253 | GroupName: GroupName;
|
254 | |
255 |
|
256 |
|
257 | Filters?: ResourceFilterList;
|
258 | |
259 |
|
260 |
|
261 | MaxResults?: MaxResults;
|
262 | |
263 |
|
264 |
|
265 | NextToken?: NextToken;
|
266 | }
|
267 | export interface ListGroupResourcesOutput {
|
268 | |
269 |
|
270 |
|
271 | ResourceIdentifiers?: ResourceIdentifierList;
|
272 | |
273 |
|
274 |
|
275 | NextToken?: NextToken;
|
276 | |
277 |
|
278 |
|
279 | QueryErrors?: QueryErrorList;
|
280 | }
|
281 | export interface ListGroupsInput {
|
282 | |
283 |
|
284 |
|
285 | Filters?: GroupFilterList;
|
286 | |
287 |
|
288 |
|
289 | MaxResults?: MaxResults;
|
290 | |
291 |
|
292 |
|
293 | NextToken?: NextToken;
|
294 | }
|
295 | export interface ListGroupsOutput {
|
296 | |
297 |
|
298 |
|
299 | GroupIdentifiers?: GroupIdentifierList;
|
300 | |
301 |
|
302 |
|
303 | Groups?: GroupList;
|
304 | |
305 |
|
306 |
|
307 | NextToken?: NextToken;
|
308 | }
|
309 | export type MaxResults = number;
|
310 | export type NextToken = string;
|
311 | export type Query = string;
|
312 | export interface QueryError {
|
313 | |
314 |
|
315 |
|
316 | ErrorCode?: QueryErrorCode;
|
317 | |
318 |
|
319 |
|
320 | Message?: QueryErrorMessage;
|
321 | }
|
322 | export type QueryErrorCode = "CLOUDFORMATION_STACK_INACTIVE"|"CLOUDFORMATION_STACK_NOT_EXISTING"|string;
|
323 | export type QueryErrorList = QueryError[];
|
324 | export type QueryErrorMessage = string;
|
325 | export type QueryType = "TAG_FILTERS_1_0"|"CLOUDFORMATION_STACK_1_0"|string;
|
326 | export type ResourceArn = string;
|
327 | export interface ResourceFilter {
|
328 | |
329 |
|
330 |
|
331 | Name: ResourceFilterName;
|
332 | |
333 |
|
334 |
|
335 | Values: ResourceFilterValues;
|
336 | }
|
337 | export type ResourceFilterList = ResourceFilter[];
|
338 | export type ResourceFilterName = "resource-type"|string;
|
339 | export type ResourceFilterValue = string;
|
340 | export type ResourceFilterValues = ResourceFilterValue[];
|
341 | export interface ResourceIdentifier {
|
342 | |
343 |
|
344 |
|
345 | ResourceArn?: ResourceArn;
|
346 | |
347 |
|
348 |
|
349 | ResourceType?: ResourceType;
|
350 | }
|
351 | export type ResourceIdentifierList = ResourceIdentifier[];
|
352 | export interface ResourceQuery {
|
353 | |
354 |
|
355 |
|
356 | Type: QueryType;
|
357 | |
358 |
|
359 |
|
360 | Query: Query;
|
361 | }
|
362 | export type ResourceType = string;
|
363 | export interface SearchResourcesInput {
|
364 | |
365 |
|
366 |
|
367 | ResourceQuery: ResourceQuery;
|
368 | |
369 |
|
370 |
|
371 | MaxResults?: MaxResults;
|
372 | |
373 |
|
374 |
|
375 | NextToken?: NextToken;
|
376 | }
|
377 | export interface SearchResourcesOutput {
|
378 | |
379 |
|
380 |
|
381 | ResourceIdentifiers?: ResourceIdentifierList;
|
382 | |
383 |
|
384 |
|
385 | NextToken?: NextToken;
|
386 | |
387 |
|
388 |
|
389 | QueryErrors?: QueryErrorList;
|
390 | }
|
391 | export interface TagInput {
|
392 | |
393 |
|
394 |
|
395 | Arn: GroupArn;
|
396 | |
397 |
|
398 |
|
399 | Tags: Tags;
|
400 | }
|
401 | export type TagKey = string;
|
402 | export type TagKeyList = TagKey[];
|
403 | export interface TagOutput {
|
404 | |
405 |
|
406 |
|
407 | Arn?: GroupArn;
|
408 | |
409 |
|
410 |
|
411 | Tags?: Tags;
|
412 | }
|
413 | export type TagValue = string;
|
414 | export type Tags = {[key: string]: TagValue};
|
415 | export interface UntagInput {
|
416 | |
417 |
|
418 |
|
419 | Arn: GroupArn;
|
420 | |
421 |
|
422 |
|
423 | Keys: TagKeyList;
|
424 | }
|
425 | export interface UntagOutput {
|
426 | |
427 |
|
428 |
|
429 | Arn?: GroupArn;
|
430 | |
431 |
|
432 |
|
433 | Keys?: TagKeyList;
|
434 | }
|
435 | export interface UpdateGroupInput {
|
436 | |
437 |
|
438 |
|
439 | GroupName: GroupName;
|
440 | |
441 |
|
442 |
|
443 | Description?: GroupDescription;
|
444 | }
|
445 | export interface UpdateGroupOutput {
|
446 | |
447 |
|
448 |
|
449 | Group?: Group;
|
450 | }
|
451 | export interface UpdateGroupQueryInput {
|
452 | |
453 |
|
454 |
|
455 | GroupName: GroupName;
|
456 | |
457 |
|
458 |
|
459 | ResourceQuery: ResourceQuery;
|
460 | }
|
461 | export interface UpdateGroupQueryOutput {
|
462 | |
463 |
|
464 |
|
465 | GroupQuery?: GroupQuery;
|
466 | }
|
467 | |
468 |
|
469 |
|
470 | export type apiVersion = "2017-11-27"|"latest"|string;
|
471 | export interface ClientApiVersions {
|
472 | |
473 |
|
474 |
|
475 | apiVersion?: apiVersion;
|
476 | }
|
477 | export type ClientConfiguration = ServiceConfigurationOptions & ClientApiVersions;
|
478 | |
479 |
|
480 |
|
481 | export import Types = ResourceGroups;
|
482 | }
|
483 | export = ResourceGroups;
|