@aws-sdk/client-resource-groups 3.533.0 → 3.540.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/dist-cjs/endpoint/endpointResolver.js +4 -2
- package/dist-cjs/index.js +0 -3
- package/dist-es/endpoint/endpointResolver.js +3 -1
- package/dist-es/index.js +0 -1
- package/dist-types/ResourceGroups.d.ts +11 -1
- package/dist-types/ResourceGroupsClient.d.ts +1 -1
- package/dist-types/commands/CreateGroupCommand.d.ts +2 -1
- package/dist-types/commands/DeleteGroupCommand.d.ts +2 -1
- package/dist-types/commands/GetAccountSettingsCommand.d.ts +2 -1
- package/dist-types/commands/GetGroupCommand.d.ts +2 -1
- package/dist-types/commands/GetGroupConfigurationCommand.d.ts +2 -1
- package/dist-types/commands/GetGroupQueryCommand.d.ts +2 -1
- package/dist-types/commands/GetTagsCommand.d.ts +2 -1
- package/dist-types/commands/GroupResourcesCommand.d.ts +2 -1
- package/dist-types/commands/ListGroupResourcesCommand.d.ts +2 -1
- package/dist-types/commands/ListGroupsCommand.d.ts +2 -1
- package/dist-types/commands/PutGroupConfigurationCommand.d.ts +2 -1
- package/dist-types/commands/SearchResourcesCommand.d.ts +2 -1
- package/dist-types/commands/TagCommand.d.ts +2 -1
- package/dist-types/commands/UngroupResourcesCommand.d.ts +2 -1
- package/dist-types/commands/UntagCommand.d.ts +2 -1
- package/dist-types/commands/UpdateAccountSettingsCommand.d.ts +2 -1
- package/dist-types/commands/UpdateGroupCommand.d.ts +2 -1
- package/dist-types/commands/UpdateGroupQueryCommand.d.ts +2 -1
- package/dist-types/index.d.ts +0 -1
- package/dist-types/models/models_0.d.ts +133 -133
- package/dist-types/ts3.4/ResourceGroups.d.ts +10 -0
- package/dist-types/ts3.4/commands/CreateGroupCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/DeleteGroupCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/GetAccountSettingsCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/GetGroupCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/GetGroupConfigurationCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/GetGroupQueryCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/GetTagsCommand.d.ts +7 -0
- package/dist-types/ts3.4/commands/GroupResourcesCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/ListGroupResourcesCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/ListGroupsCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/PutGroupConfigurationCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/SearchResourcesCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/TagCommand.d.ts +7 -0
- package/dist-types/ts3.4/commands/UngroupResourcesCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/UntagCommand.d.ts +7 -0
- package/dist-types/ts3.4/commands/UpdateAccountSettingsCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/UpdateGroupCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/UpdateGroupQueryCommand.d.ts +9 -0
- package/dist-types/ts3.4/index.d.ts +0 -1
- package/package.json +40 -40
|
@@ -27,29 +27,29 @@ export declare const GroupLifecycleEventsStatus: {
|
|
|
27
27
|
*/
|
|
28
28
|
export type GroupLifecycleEventsStatus = (typeof GroupLifecycleEventsStatus)[keyof typeof GroupLifecycleEventsStatus];
|
|
29
29
|
/**
|
|
30
|
-
* @public
|
|
31
30
|
* <p>The Resource Groups settings for this Amazon Web Services account.</p>
|
|
31
|
+
* @public
|
|
32
32
|
*/
|
|
33
33
|
export interface AccountSettings {
|
|
34
34
|
/**
|
|
35
|
-
* @public
|
|
36
35
|
* <p>The desired target status of the group lifecycle events feature. If</p>
|
|
36
|
+
* @public
|
|
37
37
|
*/
|
|
38
38
|
GroupLifecycleEventsDesiredStatus?: GroupLifecycleEventsDesiredStatus;
|
|
39
39
|
/**
|
|
40
|
-
* @public
|
|
41
40
|
* <p>The current status of the group lifecycle events feature.</p>
|
|
41
|
+
* @public
|
|
42
42
|
*/
|
|
43
43
|
GroupLifecycleEventsStatus?: GroupLifecycleEventsStatus;
|
|
44
44
|
/**
|
|
45
|
-
* @public
|
|
46
45
|
* <p>The text of any error message occurs during an attempt to turn group lifecycle events on or off.</p>
|
|
46
|
+
* @public
|
|
47
47
|
*/
|
|
48
48
|
GroupLifecycleEventsStatusMessage?: string;
|
|
49
49
|
}
|
|
50
50
|
/**
|
|
51
|
-
* @public
|
|
52
51
|
* <p>The request includes one or more parameters that violate validation rules.</p>
|
|
52
|
+
* @public
|
|
53
53
|
*/
|
|
54
54
|
export declare class BadRequestException extends __BaseException {
|
|
55
55
|
readonly name: "BadRequestException";
|
|
@@ -61,47 +61,47 @@ export declare class BadRequestException extends __BaseException {
|
|
|
61
61
|
constructor(opts: __ExceptionOptionType<BadRequestException, __BaseException>);
|
|
62
62
|
}
|
|
63
63
|
/**
|
|
64
|
-
* @public
|
|
65
64
|
* <p>A parameter for a group configuration item. For details about group service
|
|
66
65
|
* configuration syntax, see <a href="https://docs.aws.amazon.com/ARG/latest/APIReference/about-slg.html">Service configurations for resource
|
|
67
66
|
* groups</a>.</p>
|
|
67
|
+
* @public
|
|
68
68
|
*/
|
|
69
69
|
export interface GroupConfigurationParameter {
|
|
70
70
|
/**
|
|
71
|
-
* @public
|
|
72
71
|
* <p>The name of the group configuration parameter. For the list of parameters that you can
|
|
73
72
|
* use with each configuration item type, see <a href="https://docs.aws.amazon.com/ARG/latest/APIReference/about-slg.html#about-slg-types">Supported resource types and
|
|
74
73
|
* parameters</a>.</p>
|
|
74
|
+
* @public
|
|
75
75
|
*/
|
|
76
76
|
Name: string | undefined;
|
|
77
77
|
/**
|
|
78
|
-
* @public
|
|
79
78
|
* <p>The value or values to be used for the specified parameter. For the list of values you
|
|
80
79
|
* can use with each parameter, see <a href="https://docs.aws.amazon.com/ARG/latest/APIReference/about-slg.html#about-slg-types">Supported resource types and
|
|
81
80
|
* parameters</a>.</p>
|
|
81
|
+
* @public
|
|
82
82
|
*/
|
|
83
83
|
Values?: string[];
|
|
84
84
|
}
|
|
85
85
|
/**
|
|
86
|
-
* @public
|
|
87
86
|
* <p>An item in a group configuration. A group service configuration can have one or more
|
|
88
87
|
* items. For details about group service configuration syntax, see <a href="https://docs.aws.amazon.com/ARG/latest/APIReference/about-slg.html">Service configurations for
|
|
89
88
|
* resource groups</a>.</p>
|
|
89
|
+
* @public
|
|
90
90
|
*/
|
|
91
91
|
export interface GroupConfigurationItem {
|
|
92
92
|
/**
|
|
93
|
-
* @public
|
|
94
93
|
* <p>Specifies the type of group configuration item. Each item must have a unique value for
|
|
95
94
|
* <code>type</code>. For the list of types that you can specify for a configuration
|
|
96
95
|
* item, see <a href="https://docs.aws.amazon.com/ARG/latest/APIReference/about-slg.html#about-slg-types">Supported resource types and
|
|
97
96
|
* parameters</a>.</p>
|
|
97
|
+
* @public
|
|
98
98
|
*/
|
|
99
99
|
Type: string | undefined;
|
|
100
100
|
/**
|
|
101
|
-
* @public
|
|
102
101
|
* <p>A collection of parameters for this group configuration item. For the list of
|
|
103
102
|
* parameters that you can use with each configuration item type, see <a href="https://docs.aws.amazon.com/ARG/latest/APIReference/about-slg.html#about-slg-types">Supported
|
|
104
103
|
* resource types and parameters</a>.</p>
|
|
104
|
+
* @public
|
|
105
105
|
*/
|
|
106
106
|
Parameters?: GroupConfigurationParameter[];
|
|
107
107
|
}
|
|
@@ -118,7 +118,6 @@ export declare const QueryType: {
|
|
|
118
118
|
*/
|
|
119
119
|
export type QueryType = (typeof QueryType)[keyof typeof QueryType];
|
|
120
120
|
/**
|
|
121
|
-
* @public
|
|
122
121
|
* <p>The query you can use to define a resource group or a search for resources. A
|
|
123
122
|
* <code>ResourceQuery</code> specifies both a query <code>Type</code> and a
|
|
124
123
|
* <code>Query</code> string as JSON string objects. See the examples section for
|
|
@@ -146,10 +145,10 @@ export type QueryType = (typeof QueryType)[keyof typeof QueryType];
|
|
|
146
145
|
* <p>
|
|
147
146
|
* <code>"ResourceTypeFilters":["AWS::S3::Bucket", "AWS::EC2::Instance"]</code>
|
|
148
147
|
* </p>
|
|
148
|
+
* @public
|
|
149
149
|
*/
|
|
150
150
|
export interface ResourceQuery {
|
|
151
151
|
/**
|
|
152
|
-
* @public
|
|
153
152
|
* <p>The type of the query to perform. This can have one of two values:</p>
|
|
154
153
|
* <ul>
|
|
155
154
|
* <li>
|
|
@@ -169,10 +168,10 @@ export interface ResourceQuery {
|
|
|
169
168
|
* group to include resource that have tags that match the query. </p>
|
|
170
169
|
* </li>
|
|
171
170
|
* </ul>
|
|
171
|
+
* @public
|
|
172
172
|
*/
|
|
173
173
|
Type: QueryType | undefined;
|
|
174
174
|
/**
|
|
175
|
-
* @public
|
|
176
175
|
* <p>The query that defines a group or a search. The contents depends on the value of the
|
|
177
176
|
* <code>Type</code> element.</p>
|
|
178
177
|
* <ul>
|
|
@@ -268,6 +267,7 @@ export interface ResourceQuery {
|
|
|
268
267
|
* in the group.</p>
|
|
269
268
|
* </li>
|
|
270
269
|
* </ul>
|
|
270
|
+
* @public
|
|
271
271
|
*/
|
|
272
272
|
Query: string | undefined;
|
|
273
273
|
}
|
|
@@ -276,22 +276,21 @@ export interface ResourceQuery {
|
|
|
276
276
|
*/
|
|
277
277
|
export interface CreateGroupInput {
|
|
278
278
|
/**
|
|
279
|
-
* @public
|
|
280
279
|
* <p>The name of the group, which is the identifier of the group in other operations. You
|
|
281
280
|
* can't change the name of a resource group after you create it. A resource group name can
|
|
282
281
|
* consist of letters, numbers, hyphens, periods, and underscores. The name cannot start
|
|
283
282
|
* with <code>AWS</code> or <code>aws</code>; these are reserved. A resource group name
|
|
284
283
|
* must be unique within each Amazon Web Services Region in your Amazon Web Services account.</p>
|
|
284
|
+
* @public
|
|
285
285
|
*/
|
|
286
286
|
Name: string | undefined;
|
|
287
287
|
/**
|
|
288
|
-
* @public
|
|
289
288
|
* <p>The description of the resource group. Descriptions can consist of letters, numbers,
|
|
290
289
|
* hyphens, underscores, periods, and spaces.</p>
|
|
290
|
+
* @public
|
|
291
291
|
*/
|
|
292
292
|
Description?: string;
|
|
293
293
|
/**
|
|
294
|
-
* @public
|
|
295
294
|
* <p>The resource query that determines which Amazon Web Services resources are members of this group.
|
|
296
295
|
* 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
|
|
297
296
|
* a tag-based group in Resource Groups</a>. </p>
|
|
@@ -299,15 +298,15 @@ export interface CreateGroupInput {
|
|
|
299
298
|
* <p>A resource group can contain either a <code>ResourceQuery</code> or a
|
|
300
299
|
* <code>Configuration</code>, but not both.</p>
|
|
301
300
|
* </note>
|
|
301
|
+
* @public
|
|
302
302
|
*/
|
|
303
303
|
ResourceQuery?: ResourceQuery;
|
|
304
304
|
/**
|
|
305
|
-
* @public
|
|
306
305
|
* <p>The tags to add to the group. A tag is key-value pair string.</p>
|
|
306
|
+
* @public
|
|
307
307
|
*/
|
|
308
308
|
Tags?: Record<string, string>;
|
|
309
309
|
/**
|
|
310
|
-
* @public
|
|
311
310
|
* <p>A configuration associates the resource group with an Amazon Web Services service and specifies how
|
|
312
311
|
* the service can interact with the resources in the group. A configuration is an array of
|
|
313
312
|
* <a>GroupConfigurationItem</a> elements. For details about the syntax of
|
|
@@ -316,11 +315,11 @@ export interface CreateGroupInput {
|
|
|
316
315
|
* <p>A resource group can contain either a <code>Configuration</code> or a
|
|
317
316
|
* <code>ResourceQuery</code>, but not both.</p>
|
|
318
317
|
* </note>
|
|
318
|
+
* @public
|
|
319
319
|
*/
|
|
320
320
|
Configuration?: GroupConfigurationItem[];
|
|
321
321
|
}
|
|
322
322
|
/**
|
|
323
|
-
* @public
|
|
324
323
|
* <p>A resource group that contains Amazon Web Services resources. You can assign resources to the group
|
|
325
324
|
* by associating either of the following elements with the group:</p>
|
|
326
325
|
* <ul>
|
|
@@ -338,21 +337,22 @@ export interface CreateGroupInput {
|
|
|
338
337
|
* resource types can be included in the group.</p>
|
|
339
338
|
* </li>
|
|
340
339
|
* </ul>
|
|
340
|
+
* @public
|
|
341
341
|
*/
|
|
342
342
|
export interface Group {
|
|
343
343
|
/**
|
|
344
|
-
* @public
|
|
345
344
|
* <p>The ARN of the resource group.</p>
|
|
345
|
+
* @public
|
|
346
346
|
*/
|
|
347
347
|
GroupArn: string | undefined;
|
|
348
348
|
/**
|
|
349
|
-
* @public
|
|
350
349
|
* <p>The name of the resource group.</p>
|
|
350
|
+
* @public
|
|
351
351
|
*/
|
|
352
352
|
Name: string | undefined;
|
|
353
353
|
/**
|
|
354
|
-
* @public
|
|
355
354
|
* <p>The description of the resource group.</p>
|
|
355
|
+
* @public
|
|
356
356
|
*/
|
|
357
357
|
Description?: string;
|
|
358
358
|
}
|
|
@@ -370,34 +370,34 @@ export declare const GroupConfigurationStatus: {
|
|
|
370
370
|
*/
|
|
371
371
|
export type GroupConfigurationStatus = (typeof GroupConfigurationStatus)[keyof typeof GroupConfigurationStatus];
|
|
372
372
|
/**
|
|
373
|
-
* @public
|
|
374
373
|
* <p>A service configuration associated with a resource group. The configuration options
|
|
375
374
|
* are determined by the Amazon Web Services service that defines the <code>Type</code>, and specifies
|
|
376
375
|
* which resources can be included in the group. You can add a service configuration when
|
|
377
376
|
* you create the group by using <a>CreateGroup</a>, or later by using the <a>PutGroupConfiguration</a> operation. For details about group service
|
|
378
377
|
* configuration syntax, see <a href="https://docs.aws.amazon.com/ARG/latest/APIReference/about-slg.html">Service configurations for resource
|
|
379
378
|
* groups</a>.</p>
|
|
379
|
+
* @public
|
|
380
380
|
*/
|
|
381
381
|
export interface GroupConfiguration {
|
|
382
382
|
/**
|
|
383
|
-
* @public
|
|
384
383
|
* <p>The configuration currently associated with the group and in effect.</p>
|
|
384
|
+
* @public
|
|
385
385
|
*/
|
|
386
386
|
Configuration?: GroupConfigurationItem[];
|
|
387
387
|
/**
|
|
388
|
-
* @public
|
|
389
388
|
* <p>If present, the new configuration that is in the process of being applied to the
|
|
390
389
|
* group.</p>
|
|
390
|
+
* @public
|
|
391
391
|
*/
|
|
392
392
|
ProposedConfiguration?: GroupConfigurationItem[];
|
|
393
393
|
/**
|
|
394
|
-
* @public
|
|
395
394
|
* <p>The current status of an attempt to update the group configuration.</p>
|
|
395
|
+
* @public
|
|
396
396
|
*/
|
|
397
397
|
Status?: GroupConfigurationStatus;
|
|
398
398
|
/**
|
|
399
|
-
* @public
|
|
400
399
|
* <p>If present, the reason why a request to update the group configuration failed.</p>
|
|
400
|
+
* @public
|
|
401
401
|
*/
|
|
402
402
|
FailureReason?: string;
|
|
403
403
|
}
|
|
@@ -406,32 +406,32 @@ export interface GroupConfiguration {
|
|
|
406
406
|
*/
|
|
407
407
|
export interface CreateGroupOutput {
|
|
408
408
|
/**
|
|
409
|
-
* @public
|
|
410
409
|
* <p>The description of the resource group.</p>
|
|
410
|
+
* @public
|
|
411
411
|
*/
|
|
412
412
|
Group?: Group;
|
|
413
413
|
/**
|
|
414
|
-
* @public
|
|
415
414
|
* <p>The resource query associated with the group. For more information about resource
|
|
416
415
|
* queries, see <a href="https://docs.aws.amazon.com/ARG/latest/userguide/gettingstarted-query.html#gettingstarted-query-cli-tag">Create
|
|
417
416
|
* a tag-based group in Resource Groups</a>. </p>
|
|
417
|
+
* @public
|
|
418
418
|
*/
|
|
419
419
|
ResourceQuery?: ResourceQuery;
|
|
420
420
|
/**
|
|
421
|
-
* @public
|
|
422
421
|
* <p>The tags associated with the group.</p>
|
|
422
|
+
* @public
|
|
423
423
|
*/
|
|
424
424
|
Tags?: Record<string, string>;
|
|
425
425
|
/**
|
|
426
|
-
* @public
|
|
427
426
|
* <p>The service configuration associated with the resource group. For details about the
|
|
428
427
|
* 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>
|
|
428
|
+
* @public
|
|
429
429
|
*/
|
|
430
430
|
GroupConfiguration?: GroupConfiguration;
|
|
431
431
|
}
|
|
432
432
|
/**
|
|
433
|
-
* @public
|
|
434
433
|
* <p>The caller isn't authorized to make the request. Check permissions.</p>
|
|
434
|
+
* @public
|
|
435
435
|
*/
|
|
436
436
|
export declare class ForbiddenException extends __BaseException {
|
|
437
437
|
readonly name: "ForbiddenException";
|
|
@@ -443,8 +443,8 @@ export declare class ForbiddenException extends __BaseException {
|
|
|
443
443
|
constructor(opts: __ExceptionOptionType<ForbiddenException, __BaseException>);
|
|
444
444
|
}
|
|
445
445
|
/**
|
|
446
|
-
* @public
|
|
447
446
|
* <p>An internal error occurred while processing the request. Try again later.</p>
|
|
447
|
+
* @public
|
|
448
448
|
*/
|
|
449
449
|
export declare class InternalServerErrorException extends __BaseException {
|
|
450
450
|
readonly name: "InternalServerErrorException";
|
|
@@ -456,8 +456,8 @@ export declare class InternalServerErrorException extends __BaseException {
|
|
|
456
456
|
constructor(opts: __ExceptionOptionType<InternalServerErrorException, __BaseException>);
|
|
457
457
|
}
|
|
458
458
|
/**
|
|
459
|
-
* @public
|
|
460
459
|
* <p>The request uses an HTTP method that isn't allowed for the specified resource.</p>
|
|
460
|
+
* @public
|
|
461
461
|
*/
|
|
462
462
|
export declare class MethodNotAllowedException extends __BaseException {
|
|
463
463
|
readonly name: "MethodNotAllowedException";
|
|
@@ -469,9 +469,9 @@ export declare class MethodNotAllowedException extends __BaseException {
|
|
|
469
469
|
constructor(opts: __ExceptionOptionType<MethodNotAllowedException, __BaseException>);
|
|
470
470
|
}
|
|
471
471
|
/**
|
|
472
|
-
* @public
|
|
473
472
|
* <p>You've exceeded throttling limits by making too many requests in a period of
|
|
474
473
|
* time.</p>
|
|
474
|
+
* @public
|
|
475
475
|
*/
|
|
476
476
|
export declare class TooManyRequestsException extends __BaseException {
|
|
477
477
|
readonly name: "TooManyRequestsException";
|
|
@@ -487,15 +487,15 @@ export declare class TooManyRequestsException extends __BaseException {
|
|
|
487
487
|
*/
|
|
488
488
|
export interface DeleteGroupInput {
|
|
489
489
|
/**
|
|
490
|
-
* @public
|
|
491
490
|
* @deprecated
|
|
492
491
|
*
|
|
493
492
|
* <p>Deprecated - don't use this parameter. Use <code>Group</code> instead.</p>
|
|
493
|
+
* @public
|
|
494
494
|
*/
|
|
495
495
|
GroupName?: string;
|
|
496
496
|
/**
|
|
497
|
-
* @public
|
|
498
497
|
* <p>The name or the ARN of the resource group to delete.</p>
|
|
498
|
+
* @public
|
|
499
499
|
*/
|
|
500
500
|
Group?: string;
|
|
501
501
|
}
|
|
@@ -504,14 +504,14 @@ export interface DeleteGroupInput {
|
|
|
504
504
|
*/
|
|
505
505
|
export interface DeleteGroupOutput {
|
|
506
506
|
/**
|
|
507
|
-
* @public
|
|
508
507
|
* <p>A full description of the deleted resource group.</p>
|
|
508
|
+
* @public
|
|
509
509
|
*/
|
|
510
510
|
Group?: Group;
|
|
511
511
|
}
|
|
512
512
|
/**
|
|
513
|
-
* @public
|
|
514
513
|
* <p>One or more of the specified resources don't exist.</p>
|
|
514
|
+
* @public
|
|
515
515
|
*/
|
|
516
516
|
export declare class NotFoundException extends __BaseException {
|
|
517
517
|
readonly name: "NotFoundException";
|
|
@@ -527,8 +527,8 @@ export declare class NotFoundException extends __BaseException {
|
|
|
527
527
|
*/
|
|
528
528
|
export interface GetAccountSettingsOutput {
|
|
529
529
|
/**
|
|
530
|
-
* @public
|
|
531
530
|
* <p>The current settings for the optional features in Resource Groups.</p>
|
|
531
|
+
* @public
|
|
532
532
|
*/
|
|
533
533
|
AccountSettings?: AccountSettings;
|
|
534
534
|
}
|
|
@@ -537,15 +537,15 @@ export interface GetAccountSettingsOutput {
|
|
|
537
537
|
*/
|
|
538
538
|
export interface GetGroupInput {
|
|
539
539
|
/**
|
|
540
|
-
* @public
|
|
541
540
|
* @deprecated
|
|
542
541
|
*
|
|
543
542
|
* <p>Deprecated - don't use this parameter. Use <code>Group</code> instead.</p>
|
|
543
|
+
* @public
|
|
544
544
|
*/
|
|
545
545
|
GroupName?: string;
|
|
546
546
|
/**
|
|
547
|
-
* @public
|
|
548
547
|
* <p>The name or the ARN of the resource group to retrieve.</p>
|
|
548
|
+
* @public
|
|
549
549
|
*/
|
|
550
550
|
Group?: string;
|
|
551
551
|
}
|
|
@@ -554,10 +554,10 @@ export interface GetGroupInput {
|
|
|
554
554
|
*/
|
|
555
555
|
export interface GetGroupOutput {
|
|
556
556
|
/**
|
|
557
|
-
* @public
|
|
558
557
|
* <p>A structure that contains the metadata details for the specified resource group. Use
|
|
559
558
|
* <a>GetGroupQuery</a> and <a>GetGroupConfiguration</a> to get
|
|
560
559
|
* those additional details of the resource group.</p>
|
|
560
|
+
* @public
|
|
561
561
|
*/
|
|
562
562
|
Group?: Group;
|
|
563
563
|
}
|
|
@@ -566,9 +566,9 @@ export interface GetGroupOutput {
|
|
|
566
566
|
*/
|
|
567
567
|
export interface GetGroupConfigurationInput {
|
|
568
568
|
/**
|
|
569
|
-
* @public
|
|
570
569
|
* <p>The name or the ARN of the resource group for which you want to retrive the service
|
|
571
570
|
* configuration.</p>
|
|
571
|
+
* @public
|
|
572
572
|
*/
|
|
573
573
|
Group?: string;
|
|
574
574
|
}
|
|
@@ -577,10 +577,10 @@ export interface GetGroupConfigurationInput {
|
|
|
577
577
|
*/
|
|
578
578
|
export interface GetGroupConfigurationOutput {
|
|
579
579
|
/**
|
|
580
|
-
* @public
|
|
581
580
|
* <p>A structure that describes the service configuration attached with the specified
|
|
582
581
|
* 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
|
|
583
582
|
* Resource Groups</a>.</p>
|
|
583
|
+
* @public
|
|
584
584
|
*/
|
|
585
585
|
GroupConfiguration?: GroupConfiguration;
|
|
586
586
|
}
|
|
@@ -589,34 +589,34 @@ export interface GetGroupConfigurationOutput {
|
|
|
589
589
|
*/
|
|
590
590
|
export interface GetGroupQueryInput {
|
|
591
591
|
/**
|
|
592
|
-
* @public
|
|
593
592
|
* @deprecated
|
|
594
593
|
*
|
|
595
594
|
* <p>Don't use this parameter. Use <code>Group</code> instead.</p>
|
|
595
|
+
* @public
|
|
596
596
|
*/
|
|
597
597
|
GroupName?: string;
|
|
598
598
|
/**
|
|
599
|
-
* @public
|
|
600
599
|
* <p>The name or the ARN of the resource group to query.</p>
|
|
600
|
+
* @public
|
|
601
601
|
*/
|
|
602
602
|
Group?: string;
|
|
603
603
|
}
|
|
604
604
|
/**
|
|
605
|
-
* @public
|
|
606
605
|
* <p>A mapping of a query attached to a resource group that determines the Amazon Web Services resources
|
|
607
606
|
* that are members of the group.</p>
|
|
607
|
+
* @public
|
|
608
608
|
*/
|
|
609
609
|
export interface GroupQuery {
|
|
610
610
|
/**
|
|
611
|
-
* @public
|
|
612
611
|
* <p>The name of the resource group that is associated with the specified resource
|
|
613
612
|
* query.</p>
|
|
613
|
+
* @public
|
|
614
614
|
*/
|
|
615
615
|
GroupName: string | undefined;
|
|
616
616
|
/**
|
|
617
|
-
* @public
|
|
618
617
|
* <p>The resource query that determines which Amazon Web Services resources are members of the associated
|
|
619
618
|
* resource group.</p>
|
|
619
|
+
* @public
|
|
620
620
|
*/
|
|
621
621
|
ResourceQuery: ResourceQuery | undefined;
|
|
622
622
|
}
|
|
@@ -625,10 +625,10 @@ export interface GroupQuery {
|
|
|
625
625
|
*/
|
|
626
626
|
export interface GetGroupQueryOutput {
|
|
627
627
|
/**
|
|
628
|
-
* @public
|
|
629
628
|
* <p>The resource query associated with the specified group. For more information about
|
|
630
629
|
* resource queries, see <a href="https://docs.aws.amazon.com/ARG/latest/userguide/gettingstarted-query.html#gettingstarted-query-cli-tag">Create
|
|
631
630
|
* a tag-based group in Resource Groups</a>.</p>
|
|
631
|
+
* @public
|
|
632
632
|
*/
|
|
633
633
|
GroupQuery?: GroupQuery;
|
|
634
634
|
}
|
|
@@ -637,8 +637,8 @@ export interface GetGroupQueryOutput {
|
|
|
637
637
|
*/
|
|
638
638
|
export interface GetTagsInput {
|
|
639
639
|
/**
|
|
640
|
-
* @public
|
|
641
640
|
* <p>The ARN of the resource group whose tags you want to retrieve.</p>
|
|
641
|
+
* @public
|
|
642
642
|
*/
|
|
643
643
|
Arn: string | undefined;
|
|
644
644
|
}
|
|
@@ -647,13 +647,13 @@ export interface GetTagsInput {
|
|
|
647
647
|
*/
|
|
648
648
|
export interface GetTagsOutput {
|
|
649
649
|
/**
|
|
650
|
-
* @public
|
|
651
650
|
* <p>The ARN of the tagged resource group.</p>
|
|
651
|
+
* @public
|
|
652
652
|
*/
|
|
653
653
|
Arn?: string;
|
|
654
654
|
/**
|
|
655
|
-
* @public
|
|
656
655
|
* <p>The tags associated with the specified resource group.</p>
|
|
656
|
+
* @public
|
|
657
657
|
*/
|
|
658
658
|
Tags?: Record<string, string>;
|
|
659
659
|
}
|
|
@@ -662,47 +662,47 @@ export interface GetTagsOutput {
|
|
|
662
662
|
*/
|
|
663
663
|
export interface GroupResourcesInput {
|
|
664
664
|
/**
|
|
665
|
-
* @public
|
|
666
665
|
* <p>The name or the ARN of the resource group to add resources to.</p>
|
|
666
|
+
* @public
|
|
667
667
|
*/
|
|
668
668
|
Group: string | undefined;
|
|
669
669
|
/**
|
|
670
|
-
* @public
|
|
671
670
|
* <p>The list of ARNs of the resources to be added to the group. </p>
|
|
671
|
+
* @public
|
|
672
672
|
*/
|
|
673
673
|
ResourceArns: string[] | undefined;
|
|
674
674
|
}
|
|
675
675
|
/**
|
|
676
|
-
* @public
|
|
677
676
|
* <p>A resource that failed to be added to or removed from a group.</p>
|
|
677
|
+
* @public
|
|
678
678
|
*/
|
|
679
679
|
export interface FailedResource {
|
|
680
680
|
/**
|
|
681
|
-
* @public
|
|
682
681
|
* <p>The ARN of the resource that failed to be added or removed.</p>
|
|
682
|
+
* @public
|
|
683
683
|
*/
|
|
684
684
|
ResourceArn?: string;
|
|
685
685
|
/**
|
|
686
|
-
* @public
|
|
687
686
|
* <p>The error message text associated with the failure.</p>
|
|
687
|
+
* @public
|
|
688
688
|
*/
|
|
689
689
|
ErrorMessage?: string;
|
|
690
690
|
/**
|
|
691
|
-
* @public
|
|
692
691
|
* <p>The error code associated with the failure.</p>
|
|
692
|
+
* @public
|
|
693
693
|
*/
|
|
694
694
|
ErrorCode?: string;
|
|
695
695
|
}
|
|
696
696
|
/**
|
|
697
|
-
* @public
|
|
698
697
|
* <p>A structure that identifies a resource that is currently pending addition to the group
|
|
699
698
|
* as a member. Adding a resource to a resource group happens asynchronously as a
|
|
700
699
|
* background task and this one isn't completed yet.</p>
|
|
700
|
+
* @public
|
|
701
701
|
*/
|
|
702
702
|
export interface PendingResource {
|
|
703
703
|
/**
|
|
704
|
-
* @public
|
|
705
704
|
* <p>The Amazon resource name (ARN) of the resource that's in a pending state.</p>
|
|
705
|
+
* @public
|
|
706
706
|
*/
|
|
707
707
|
ResourceArn?: string;
|
|
708
708
|
}
|
|
@@ -711,18 +711,17 @@ export interface PendingResource {
|
|
|
711
711
|
*/
|
|
712
712
|
export interface GroupResourcesOutput {
|
|
713
713
|
/**
|
|
714
|
-
* @public
|
|
715
714
|
* <p>A list of ARNs of the resources that this operation successfully added to the
|
|
716
715
|
* group.</p>
|
|
716
|
+
* @public
|
|
717
717
|
*/
|
|
718
718
|
Succeeded?: string[];
|
|
719
719
|
/**
|
|
720
|
-
* @public
|
|
721
720
|
* <p>A list of ARNs of any resources that this operation failed to add to the group.</p>
|
|
721
|
+
* @public
|
|
722
722
|
*/
|
|
723
723
|
Failed?: FailedResource[];
|
|
724
724
|
/**
|
|
725
|
-
* @public
|
|
726
725
|
* <p>A list of ARNs of any resources that this operation is still in the process adding to
|
|
727
726
|
* the group. These pending additions continue asynchronously. You can check the status of
|
|
728
727
|
* pending additions by using the <code>
|
|
@@ -730,6 +729,7 @@ export interface GroupResourcesOutput {
|
|
|
730
729
|
* </code>
|
|
731
730
|
* operation, and checking the <code>Resources</code> array in the response and the
|
|
732
731
|
* <code>Status</code> field of each object in that array. </p>
|
|
732
|
+
* @public
|
|
733
733
|
*/
|
|
734
734
|
Pending?: PendingResource[];
|
|
735
735
|
}
|
|
@@ -745,20 +745,20 @@ export declare const ResourceFilterName: {
|
|
|
745
745
|
*/
|
|
746
746
|
export type ResourceFilterName = (typeof ResourceFilterName)[keyof typeof ResourceFilterName];
|
|
747
747
|
/**
|
|
748
|
-
* @public
|
|
749
748
|
* <p>A filter name and value pair that is used to obtain more specific results from a list
|
|
750
749
|
* of resources.</p>
|
|
750
|
+
* @public
|
|
751
751
|
*/
|
|
752
752
|
export interface ResourceFilter {
|
|
753
753
|
/**
|
|
754
|
-
* @public
|
|
755
754
|
* <p>The name of the filter. Filter names are case-sensitive.</p>
|
|
755
|
+
* @public
|
|
756
756
|
*/
|
|
757
757
|
Name: ResourceFilterName | undefined;
|
|
758
758
|
/**
|
|
759
|
-
* @public
|
|
760
759
|
* <p>One or more filter values. Allowed filter values vary by resource filter name, and are
|
|
761
760
|
* case-sensitive.</p>
|
|
761
|
+
* @public
|
|
762
762
|
*/
|
|
763
763
|
Values: string[] | undefined;
|
|
764
764
|
}
|
|
@@ -767,7 +767,6 @@ export interface ResourceFilter {
|
|
|
767
767
|
*/
|
|
768
768
|
export interface ListGroupResourcesInput {
|
|
769
769
|
/**
|
|
770
|
-
* @public
|
|
771
770
|
* @deprecated
|
|
772
771
|
*
|
|
773
772
|
* <important>
|
|
@@ -778,15 +777,15 @@ export interface ListGroupResourcesInput {
|
|
|
778
777
|
* </i>
|
|
779
778
|
* </p>
|
|
780
779
|
* </important>
|
|
780
|
+
* @public
|
|
781
781
|
*/
|
|
782
782
|
GroupName?: string;
|
|
783
783
|
/**
|
|
784
|
-
* @public
|
|
785
784
|
* <p>The name or the ARN of the resource group</p>
|
|
785
|
+
* @public
|
|
786
786
|
*/
|
|
787
787
|
Group?: string;
|
|
788
788
|
/**
|
|
789
|
-
* @public
|
|
790
789
|
* <p>Filters, formatted as <a>ResourceFilter</a> objects, that you want to apply
|
|
791
790
|
* to a <code>ListGroupResources</code> operation. Filters the results to include only
|
|
792
791
|
* those of the specified resource types.</p>
|
|
@@ -816,10 +815,10 @@ export interface ListGroupResourcesInput {
|
|
|
816
815
|
* the group query specifies <code>AWS::AllSupported</code>, because a group based on such
|
|
817
816
|
* a query can contain any of the allowed resource types for the query type (tag-based or
|
|
818
817
|
* Amazon CloudFront stack-based queries).</p>
|
|
818
|
+
* @public
|
|
819
819
|
*/
|
|
820
820
|
Filters?: ResourceFilter[];
|
|
821
821
|
/**
|
|
822
|
-
* @public
|
|
823
822
|
* <p>The total number of results that you want included on each page of the
|
|
824
823
|
* response. If you do not include this parameter, it defaults to a value that is specific to the
|
|
825
824
|
* operation. If additional items exist beyond the maximum you specify, the <code>NextToken</code>
|
|
@@ -828,14 +827,15 @@ export interface ListGroupResourcesInput {
|
|
|
828
827
|
* of the results. Note that the service might return fewer results than the maximum even when there
|
|
829
828
|
* are more results available. You should check <code>NextToken</code> after every operation to
|
|
830
829
|
* ensure that you receive all of the results.</p>
|
|
830
|
+
* @public
|
|
831
831
|
*/
|
|
832
832
|
MaxResults?: number;
|
|
833
833
|
/**
|
|
834
|
-
* @public
|
|
835
834
|
* <p>The parameter for receiving additional results if you receive a
|
|
836
835
|
* <code>NextToken</code> response in a previous request. A <code>NextToken</code> response
|
|
837
836
|
* indicates that more output is available. Set this parameter to the value provided by a previous
|
|
838
837
|
* call's <code>NextToken</code> response to indicate where the output should continue from.</p>
|
|
838
|
+
* @public
|
|
839
839
|
*/
|
|
840
840
|
NextToken?: string;
|
|
841
841
|
}
|
|
@@ -853,43 +853,43 @@ export declare const QueryErrorCode: {
|
|
|
853
853
|
*/
|
|
854
854
|
export type QueryErrorCode = (typeof QueryErrorCode)[keyof typeof QueryErrorCode];
|
|
855
855
|
/**
|
|
856
|
-
* @public
|
|
857
856
|
* <p>A two-part error structure that can occur in <code>ListGroupResources</code> or
|
|
858
857
|
* <code>SearchResources</code> operations on CloudFront stack-based queries. The error
|
|
859
858
|
* occurs if the CloudFront stack on which the query is based either does not exist, or has a
|
|
860
859
|
* status that renders the stack inactive. A <code>QueryError</code> occurrence does not
|
|
861
860
|
* necessarily mean that Resource Groups could not complete the operation, but the resulting
|
|
862
861
|
* group might have no member resources.</p>
|
|
862
|
+
* @public
|
|
863
863
|
*/
|
|
864
864
|
export interface QueryError {
|
|
865
865
|
/**
|
|
866
|
-
* @public
|
|
867
866
|
* <p>Specifies the error code that was raised.</p>
|
|
867
|
+
* @public
|
|
868
868
|
*/
|
|
869
869
|
ErrorCode?: QueryErrorCode;
|
|
870
870
|
/**
|
|
871
|
-
* @public
|
|
872
871
|
* <p>A message that explains the <code>ErrorCode</code> value. Messages might state that
|
|
873
872
|
* the specified CloudFront stack does not exist (or no longer exists). For
|
|
874
873
|
* <code>CLOUDFORMATION_STACK_INACTIVE</code>, the message typically states that the
|
|
875
874
|
* CloudFront stack has a status that is not (or no longer) active, such as
|
|
876
875
|
* <code>CREATE_FAILED</code>.</p>
|
|
876
|
+
* @public
|
|
877
877
|
*/
|
|
878
878
|
Message?: string;
|
|
879
879
|
}
|
|
880
880
|
/**
|
|
881
|
-
* @public
|
|
882
881
|
* <p>A structure that contains the ARN of a resource and its resource type.</p>
|
|
882
|
+
* @public
|
|
883
883
|
*/
|
|
884
884
|
export interface ResourceIdentifier {
|
|
885
885
|
/**
|
|
886
|
-
* @public
|
|
887
886
|
* <p>The ARN of a resource.</p>
|
|
887
|
+
* @public
|
|
888
888
|
*/
|
|
889
889
|
ResourceArn?: string;
|
|
890
890
|
/**
|
|
891
|
-
* @public
|
|
892
891
|
* <p>The resource type of a resource, such as <code>AWS::EC2::Instance</code>.</p>
|
|
892
|
+
* @public
|
|
893
893
|
*/
|
|
894
894
|
ResourceType?: string;
|
|
895
895
|
}
|
|
@@ -905,39 +905,39 @@ export declare const ResourceStatusValue: {
|
|
|
905
905
|
*/
|
|
906
906
|
export type ResourceStatusValue = (typeof ResourceStatusValue)[keyof typeof ResourceStatusValue];
|
|
907
907
|
/**
|
|
908
|
-
* @public
|
|
909
908
|
* <p>A structure that identifies the current group membership status for a resource. Adding
|
|
910
909
|
* a resource to a resource group is performed asynchronously as a background task. A
|
|
911
910
|
* <code>PENDING</code> status indicates, for this resource, that the process isn't
|
|
912
911
|
* completed yet.</p>
|
|
912
|
+
* @public
|
|
913
913
|
*/
|
|
914
914
|
export interface ResourceStatus {
|
|
915
915
|
/**
|
|
916
|
-
* @public
|
|
917
916
|
* <p>The current status.</p>
|
|
917
|
+
* @public
|
|
918
918
|
*/
|
|
919
919
|
Name?: ResourceStatusValue;
|
|
920
920
|
}
|
|
921
921
|
/**
|
|
922
|
-
* @public
|
|
923
922
|
* <p>A structure returned by the <a>ListGroupResources</a> operation that
|
|
924
923
|
* contains identity and group membership status information for one of the resources in
|
|
925
924
|
* the group.</p>
|
|
925
|
+
* @public
|
|
926
926
|
*/
|
|
927
927
|
export interface ListGroupResourcesItem {
|
|
928
928
|
/**
|
|
929
|
-
* @public
|
|
930
929
|
* <p>A structure that contains the ARN of a resource and its resource type.</p>
|
|
930
|
+
* @public
|
|
931
931
|
*/
|
|
932
932
|
Identifier?: ResourceIdentifier;
|
|
933
933
|
/**
|
|
934
|
-
* @public
|
|
935
934
|
* <p>A structure that contains the status of this resource's membership in the
|
|
936
935
|
* group.</p>
|
|
937
936
|
* <note>
|
|
938
937
|
* <p>This field is present in the response only if the group is of type
|
|
939
938
|
* <code>AWS::EC2::HostManagement</code>.</p>
|
|
940
939
|
* </note>
|
|
940
|
+
* @public
|
|
941
941
|
*/
|
|
942
942
|
Status?: ResourceStatus;
|
|
943
943
|
}
|
|
@@ -946,13 +946,12 @@ export interface ListGroupResourcesItem {
|
|
|
946
946
|
*/
|
|
947
947
|
export interface ListGroupResourcesOutput {
|
|
948
948
|
/**
|
|
949
|
-
* @public
|
|
950
949
|
* <p>An array of resources from which you can determine each resource's identity, type, and
|
|
951
950
|
* group membership status.</p>
|
|
951
|
+
* @public
|
|
952
952
|
*/
|
|
953
953
|
Resources?: ListGroupResourcesItem[];
|
|
954
954
|
/**
|
|
955
|
-
* @public
|
|
956
955
|
* @deprecated
|
|
957
956
|
*
|
|
958
957
|
* <important>
|
|
@@ -964,29 +963,30 @@ export interface ListGroupResourcesOutput {
|
|
|
964
963
|
* </b>
|
|
965
964
|
* </p>
|
|
966
965
|
* </important>
|
|
966
|
+
* @public
|
|
967
967
|
*/
|
|
968
968
|
ResourceIdentifiers?: ResourceIdentifier[];
|
|
969
969
|
/**
|
|
970
|
-
* @public
|
|
971
970
|
* <p>If present, indicates that more output is available than is
|
|
972
971
|
* included in the current response. Use this value in the <code>NextToken</code> request parameter
|
|
973
972
|
* in a subsequent call to the operation to get the next part of the output. You should repeat this
|
|
974
973
|
* until the <code>NextToken</code> response element comes back as <code>null</code>.</p>
|
|
974
|
+
* @public
|
|
975
975
|
*/
|
|
976
976
|
NextToken?: string;
|
|
977
977
|
/**
|
|
978
|
-
* @public
|
|
979
978
|
* <p>A list of <code>QueryError</code> objects. Each error is an object that contains
|
|
980
979
|
* <code>ErrorCode</code> and <code>Message</code> structures. Possible values for
|
|
981
980
|
* <code>ErrorCode</code> are <code>CLOUDFORMATION_STACK_INACTIVE</code> and
|
|
982
981
|
* <code>CLOUDFORMATION_STACK_NOT_EXISTING</code>.</p>
|
|
982
|
+
* @public
|
|
983
983
|
*/
|
|
984
984
|
QueryErrors?: QueryError[];
|
|
985
985
|
}
|
|
986
986
|
/**
|
|
987
|
-
* @public
|
|
988
987
|
* <p>The request was rejected because it doesn't have valid credentials for the target
|
|
989
988
|
* resource.</p>
|
|
989
|
+
* @public
|
|
990
990
|
*/
|
|
991
991
|
export declare class UnauthorizedException extends __BaseException {
|
|
992
992
|
readonly name: "UnauthorizedException";
|
|
@@ -1010,20 +1010,20 @@ export declare const GroupFilterName: {
|
|
|
1010
1010
|
*/
|
|
1011
1011
|
export type GroupFilterName = (typeof GroupFilterName)[keyof typeof GroupFilterName];
|
|
1012
1012
|
/**
|
|
1013
|
-
* @public
|
|
1014
1013
|
* <p>A filter collection that you can use to restrict the results from a <code>List</code>
|
|
1015
1014
|
* operation to only those you want to include.</p>
|
|
1015
|
+
* @public
|
|
1016
1016
|
*/
|
|
1017
1017
|
export interface GroupFilter {
|
|
1018
1018
|
/**
|
|
1019
|
-
* @public
|
|
1020
1019
|
* <p>The name of the filter. Filter names are case-sensitive.</p>
|
|
1020
|
+
* @public
|
|
1021
1021
|
*/
|
|
1022
1022
|
Name: GroupFilterName | undefined;
|
|
1023
1023
|
/**
|
|
1024
|
-
* @public
|
|
1025
1024
|
* <p>One or more filter values. Allowed filter values vary by group filter name, and are
|
|
1026
1025
|
* case-sensitive.</p>
|
|
1026
|
+
* @public
|
|
1027
1027
|
*/
|
|
1028
1028
|
Values: string[] | undefined;
|
|
1029
1029
|
}
|
|
@@ -1032,7 +1032,6 @@ export interface GroupFilter {
|
|
|
1032
1032
|
*/
|
|
1033
1033
|
export interface ListGroupsInput {
|
|
1034
1034
|
/**
|
|
1035
|
-
* @public
|
|
1036
1035
|
* <p>Filters, formatted as <a>GroupFilter</a> objects, that you want to apply to
|
|
1037
1036
|
* a <code>ListGroups</code> operation.</p>
|
|
1038
1037
|
* <ul>
|
|
@@ -1064,10 +1063,10 @@ export interface ListGroupsInput {
|
|
|
1064
1063
|
* </ul>
|
|
1065
1064
|
* </li>
|
|
1066
1065
|
* </ul>
|
|
1066
|
+
* @public
|
|
1067
1067
|
*/
|
|
1068
1068
|
Filters?: GroupFilter[];
|
|
1069
1069
|
/**
|
|
1070
|
-
* @public
|
|
1071
1070
|
* <p>The total number of results that you want included on each page of the
|
|
1072
1071
|
* response. If you do not include this parameter, it defaults to a value that is specific to the
|
|
1073
1072
|
* operation. If additional items exist beyond the maximum you specify, the <code>NextToken</code>
|
|
@@ -1076,30 +1075,31 @@ export interface ListGroupsInput {
|
|
|
1076
1075
|
* of the results. Note that the service might return fewer results than the maximum even when there
|
|
1077
1076
|
* are more results available. You should check <code>NextToken</code> after every operation to
|
|
1078
1077
|
* ensure that you receive all of the results.</p>
|
|
1078
|
+
* @public
|
|
1079
1079
|
*/
|
|
1080
1080
|
MaxResults?: number;
|
|
1081
1081
|
/**
|
|
1082
|
-
* @public
|
|
1083
1082
|
* <p>The parameter for receiving additional results if you receive a
|
|
1084
1083
|
* <code>NextToken</code> response in a previous request. A <code>NextToken</code> response
|
|
1085
1084
|
* indicates that more output is available. Set this parameter to the value provided by a previous
|
|
1086
1085
|
* call's <code>NextToken</code> response to indicate where the output should continue from.</p>
|
|
1086
|
+
* @public
|
|
1087
1087
|
*/
|
|
1088
1088
|
NextToken?: string;
|
|
1089
1089
|
}
|
|
1090
1090
|
/**
|
|
1091
|
-
* @public
|
|
1092
1091
|
* <p>The unique identifiers for a resource group.</p>
|
|
1092
|
+
* @public
|
|
1093
1093
|
*/
|
|
1094
1094
|
export interface GroupIdentifier {
|
|
1095
1095
|
/**
|
|
1096
|
-
* @public
|
|
1097
1096
|
* <p>The name of the resource group.</p>
|
|
1097
|
+
* @public
|
|
1098
1098
|
*/
|
|
1099
1099
|
GroupName?: string;
|
|
1100
1100
|
/**
|
|
1101
|
-
* @public
|
|
1102
1101
|
* <p>The ARN of the resource group.</p>
|
|
1102
|
+
* @public
|
|
1103
1103
|
*/
|
|
1104
1104
|
GroupArn?: string;
|
|
1105
1105
|
}
|
|
@@ -1108,13 +1108,12 @@ export interface GroupIdentifier {
|
|
|
1108
1108
|
*/
|
|
1109
1109
|
export interface ListGroupsOutput {
|
|
1110
1110
|
/**
|
|
1111
|
-
* @public
|
|
1112
1111
|
* <p>A list of <a>GroupIdentifier</a> objects. Each identifier is an object that
|
|
1113
1112
|
* contains both the <code>Name</code> and the <code>GroupArn</code>.</p>
|
|
1113
|
+
* @public
|
|
1114
1114
|
*/
|
|
1115
1115
|
GroupIdentifiers?: GroupIdentifier[];
|
|
1116
1116
|
/**
|
|
1117
|
-
* @public
|
|
1118
1117
|
* @deprecated
|
|
1119
1118
|
*
|
|
1120
1119
|
* <important>
|
|
@@ -1126,14 +1125,15 @@ export interface ListGroupsOutput {
|
|
|
1126
1125
|
* </i>
|
|
1127
1126
|
* </p>
|
|
1128
1127
|
* </important>
|
|
1128
|
+
* @public
|
|
1129
1129
|
*/
|
|
1130
1130
|
Groups?: Group[];
|
|
1131
1131
|
/**
|
|
1132
|
-
* @public
|
|
1133
1132
|
* <p>If present, indicates that more output is available than is
|
|
1134
1133
|
* included in the current response. Use this value in the <code>NextToken</code> request parameter
|
|
1135
1134
|
* in a subsequent call to the operation to get the next part of the output. You should repeat this
|
|
1136
1135
|
* until the <code>NextToken</code> response element comes back as <code>null</code>.</p>
|
|
1136
|
+
* @public
|
|
1137
1137
|
*/
|
|
1138
1138
|
NextToken?: string;
|
|
1139
1139
|
}
|
|
@@ -1142,13 +1142,12 @@ export interface ListGroupsOutput {
|
|
|
1142
1142
|
*/
|
|
1143
1143
|
export interface PutGroupConfigurationInput {
|
|
1144
1144
|
/**
|
|
1145
|
-
* @public
|
|
1146
1145
|
* <p>The name or ARN of the resource group with the configuration that you want to
|
|
1147
1146
|
* update.</p>
|
|
1147
|
+
* @public
|
|
1148
1148
|
*/
|
|
1149
1149
|
Group?: string;
|
|
1150
1150
|
/**
|
|
1151
|
-
* @public
|
|
1152
1151
|
* <p>The new configuration to associate with the specified group. A configuration
|
|
1153
1152
|
* associates the resource group with an Amazon Web Services service and specifies how the service can
|
|
1154
1153
|
* interact with the resources in the group. A configuration is an array of <a>GroupConfigurationItem</a> elements.</p>
|
|
@@ -1158,6 +1157,7 @@ export interface PutGroupConfigurationInput {
|
|
|
1158
1157
|
* <p>A resource group can contain either a <code>Configuration</code> or a
|
|
1159
1158
|
* <code>ResourceQuery</code>, but not both.</p>
|
|
1160
1159
|
* </note>
|
|
1160
|
+
* @public
|
|
1161
1161
|
*/
|
|
1162
1162
|
Configuration?: GroupConfigurationItem[];
|
|
1163
1163
|
}
|
|
@@ -1171,13 +1171,12 @@ export interface PutGroupConfigurationOutput {
|
|
|
1171
1171
|
*/
|
|
1172
1172
|
export interface SearchResourcesInput {
|
|
1173
1173
|
/**
|
|
1174
|
-
* @public
|
|
1175
1174
|
* <p>The search query, using the same formats that are supported for resource group
|
|
1176
1175
|
* definition. For more information, see <a>CreateGroup</a>.</p>
|
|
1176
|
+
* @public
|
|
1177
1177
|
*/
|
|
1178
1178
|
ResourceQuery: ResourceQuery | undefined;
|
|
1179
1179
|
/**
|
|
1180
|
-
* @public
|
|
1181
1180
|
* <p>The total number of results that you want included on each page of the
|
|
1182
1181
|
* response. If you do not include this parameter, it defaults to a value that is specific to the
|
|
1183
1182
|
* operation. If additional items exist beyond the maximum you specify, the <code>NextToken</code>
|
|
@@ -1186,14 +1185,15 @@ export interface SearchResourcesInput {
|
|
|
1186
1185
|
* of the results. Note that the service might return fewer results than the maximum even when there
|
|
1187
1186
|
* are more results available. You should check <code>NextToken</code> after every operation to
|
|
1188
1187
|
* ensure that you receive all of the results.</p>
|
|
1188
|
+
* @public
|
|
1189
1189
|
*/
|
|
1190
1190
|
MaxResults?: number;
|
|
1191
1191
|
/**
|
|
1192
|
-
* @public
|
|
1193
1192
|
* <p>The parameter for receiving additional results if you receive a
|
|
1194
1193
|
* <code>NextToken</code> response in a previous request. A <code>NextToken</code> response
|
|
1195
1194
|
* indicates that more output is available. Set this parameter to the value provided by a previous
|
|
1196
1195
|
* call's <code>NextToken</code> response to indicate where the output should continue from.</p>
|
|
1196
|
+
* @public
|
|
1197
1197
|
*/
|
|
1198
1198
|
NextToken?: string;
|
|
1199
1199
|
}
|
|
@@ -1202,21 +1202,20 @@ export interface SearchResourcesInput {
|
|
|
1202
1202
|
*/
|
|
1203
1203
|
export interface SearchResourcesOutput {
|
|
1204
1204
|
/**
|
|
1205
|
-
* @public
|
|
1206
1205
|
* <p>The ARNs and resource types of resources that are members of the group that you
|
|
1207
1206
|
* specified.</p>
|
|
1207
|
+
* @public
|
|
1208
1208
|
*/
|
|
1209
1209
|
ResourceIdentifiers?: ResourceIdentifier[];
|
|
1210
1210
|
/**
|
|
1211
|
-
* @public
|
|
1212
1211
|
* <p>If present, indicates that more output is available than is
|
|
1213
1212
|
* included in the current response. Use this value in the <code>NextToken</code> request parameter
|
|
1214
1213
|
* in a subsequent call to the operation to get the next part of the output. You should repeat this
|
|
1215
1214
|
* until the <code>NextToken</code> response element comes back as <code>null</code>.</p>
|
|
1215
|
+
* @public
|
|
1216
1216
|
*/
|
|
1217
1217
|
NextToken?: string;
|
|
1218
1218
|
/**
|
|
1219
|
-
* @public
|
|
1220
1219
|
* <p>A list of <code>QueryError</code> objects. Each error is an object that contains
|
|
1221
1220
|
* <code>ErrorCode</code> and <code>Message</code> structures.</p>
|
|
1222
1221
|
* <p>Possible values for <code>ErrorCode</code>:</p>
|
|
@@ -1232,6 +1231,7 @@ export interface SearchResourcesOutput {
|
|
|
1232
1231
|
* </p>
|
|
1233
1232
|
* </li>
|
|
1234
1233
|
* </ul>
|
|
1234
|
+
* @public
|
|
1235
1235
|
*/
|
|
1236
1236
|
QueryErrors?: QueryError[];
|
|
1237
1237
|
}
|
|
@@ -1240,14 +1240,14 @@ export interface SearchResourcesOutput {
|
|
|
1240
1240
|
*/
|
|
1241
1241
|
export interface TagInput {
|
|
1242
1242
|
/**
|
|
1243
|
-
* @public
|
|
1244
1243
|
* <p>The ARN of the resource group to which to add tags.</p>
|
|
1244
|
+
* @public
|
|
1245
1245
|
*/
|
|
1246
1246
|
Arn: string | undefined;
|
|
1247
1247
|
/**
|
|
1248
|
-
* @public
|
|
1249
1248
|
* <p>The tags to add to the specified resource group. A tag is a string-to-string map of
|
|
1250
1249
|
* key-value pairs.</p>
|
|
1250
|
+
* @public
|
|
1251
1251
|
*/
|
|
1252
1252
|
Tags: Record<string, string> | undefined;
|
|
1253
1253
|
}
|
|
@@ -1256,13 +1256,13 @@ export interface TagInput {
|
|
|
1256
1256
|
*/
|
|
1257
1257
|
export interface TagOutput {
|
|
1258
1258
|
/**
|
|
1259
|
-
* @public
|
|
1260
1259
|
* <p>The ARN of the tagged resource.</p>
|
|
1260
|
+
* @public
|
|
1261
1261
|
*/
|
|
1262
1262
|
Arn?: string;
|
|
1263
1263
|
/**
|
|
1264
|
-
* @public
|
|
1265
1264
|
* <p>The tags that have been added to the specified resource group.</p>
|
|
1265
|
+
* @public
|
|
1266
1266
|
*/
|
|
1267
1267
|
Tags?: Record<string, string>;
|
|
1268
1268
|
}
|
|
@@ -1271,13 +1271,13 @@ export interface TagOutput {
|
|
|
1271
1271
|
*/
|
|
1272
1272
|
export interface UngroupResourcesInput {
|
|
1273
1273
|
/**
|
|
1274
|
-
* @public
|
|
1275
1274
|
* <p>The name or the ARN of the resource group from which to remove the resources.</p>
|
|
1275
|
+
* @public
|
|
1276
1276
|
*/
|
|
1277
1277
|
Group: string | undefined;
|
|
1278
1278
|
/**
|
|
1279
|
-
* @public
|
|
1280
1279
|
* <p>The ARNs of the resources to be removed from the group.</p>
|
|
1280
|
+
* @public
|
|
1281
1281
|
*/
|
|
1282
1282
|
ResourceArns: string[] | undefined;
|
|
1283
1283
|
}
|
|
@@ -1286,25 +1286,25 @@ export interface UngroupResourcesInput {
|
|
|
1286
1286
|
*/
|
|
1287
1287
|
export interface UngroupResourcesOutput {
|
|
1288
1288
|
/**
|
|
1289
|
-
* @public
|
|
1290
1289
|
* <p>A list of resources that were successfully removed from the group by this
|
|
1291
1290
|
* operation.</p>
|
|
1291
|
+
* @public
|
|
1292
1292
|
*/
|
|
1293
1293
|
Succeeded?: string[];
|
|
1294
1294
|
/**
|
|
1295
|
-
* @public
|
|
1296
1295
|
* <p>A list of any resources that failed to be removed from the group by this
|
|
1297
1296
|
* operation.</p>
|
|
1297
|
+
* @public
|
|
1298
1298
|
*/
|
|
1299
1299
|
Failed?: FailedResource[];
|
|
1300
1300
|
/**
|
|
1301
|
-
* @public
|
|
1302
1301
|
* <p>A list of any resources that are still in the process of being removed from the group
|
|
1303
1302
|
* by this operation. These pending removals continue asynchronously. You can check the
|
|
1304
1303
|
* status of pending removals by using the <code>
|
|
1305
1304
|
* <a>ListGroupResources</a>
|
|
1306
1305
|
* </code> operation. After the resource is successfully removed, it no longer
|
|
1307
1306
|
* appears in the response.</p>
|
|
1307
|
+
* @public
|
|
1308
1308
|
*/
|
|
1309
1309
|
Pending?: PendingResource[];
|
|
1310
1310
|
}
|
|
@@ -1313,14 +1313,14 @@ export interface UngroupResourcesOutput {
|
|
|
1313
1313
|
*/
|
|
1314
1314
|
export interface UntagInput {
|
|
1315
1315
|
/**
|
|
1316
|
-
* @public
|
|
1317
1316
|
* <p>The ARN of the resource group from which to remove tags. The command removed both the
|
|
1318
1317
|
* specified keys and any values associated with those keys.</p>
|
|
1318
|
+
* @public
|
|
1319
1319
|
*/
|
|
1320
1320
|
Arn: string | undefined;
|
|
1321
1321
|
/**
|
|
1322
|
-
* @public
|
|
1323
1322
|
* <p>The keys of the tags to be removed.</p>
|
|
1323
|
+
* @public
|
|
1324
1324
|
*/
|
|
1325
1325
|
Keys: string[] | undefined;
|
|
1326
1326
|
}
|
|
@@ -1329,13 +1329,13 @@ export interface UntagInput {
|
|
|
1329
1329
|
*/
|
|
1330
1330
|
export interface UntagOutput {
|
|
1331
1331
|
/**
|
|
1332
|
-
* @public
|
|
1333
1332
|
* <p>The ARN of the resource group from which tags have been removed.</p>
|
|
1333
|
+
* @public
|
|
1334
1334
|
*/
|
|
1335
1335
|
Arn?: string;
|
|
1336
1336
|
/**
|
|
1337
|
-
* @public
|
|
1338
1337
|
* <p>The keys of the tags that were removed.</p>
|
|
1338
|
+
* @public
|
|
1339
1339
|
*/
|
|
1340
1340
|
Keys?: string[];
|
|
1341
1341
|
}
|
|
@@ -1344,8 +1344,8 @@ export interface UntagOutput {
|
|
|
1344
1344
|
*/
|
|
1345
1345
|
export interface UpdateAccountSettingsInput {
|
|
1346
1346
|
/**
|
|
1347
|
-
* @public
|
|
1348
1347
|
* <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>
|
|
1348
|
+
* @public
|
|
1349
1349
|
*/
|
|
1350
1350
|
GroupLifecycleEventsDesiredStatus?: GroupLifecycleEventsDesiredStatus;
|
|
1351
1351
|
}
|
|
@@ -1354,8 +1354,8 @@ export interface UpdateAccountSettingsInput {
|
|
|
1354
1354
|
*/
|
|
1355
1355
|
export interface UpdateAccountSettingsOutput {
|
|
1356
1356
|
/**
|
|
1357
|
-
* @public
|
|
1358
1357
|
* <p>A structure that displays the status of the optional features in the account.</p>
|
|
1358
|
+
* @public
|
|
1359
1359
|
*/
|
|
1360
1360
|
AccountSettings?: AccountSettings;
|
|
1361
1361
|
}
|
|
@@ -1364,21 +1364,21 @@ export interface UpdateAccountSettingsOutput {
|
|
|
1364
1364
|
*/
|
|
1365
1365
|
export interface UpdateGroupInput {
|
|
1366
1366
|
/**
|
|
1367
|
-
* @public
|
|
1368
1367
|
* @deprecated
|
|
1369
1368
|
*
|
|
1370
1369
|
* <p>Don't use this parameter. Use <code>Group</code> instead.</p>
|
|
1370
|
+
* @public
|
|
1371
1371
|
*/
|
|
1372
1372
|
GroupName?: string;
|
|
1373
1373
|
/**
|
|
1374
|
-
* @public
|
|
1375
1374
|
* <p>The name or the ARN of the resource group to modify.</p>
|
|
1375
|
+
* @public
|
|
1376
1376
|
*/
|
|
1377
1377
|
Group?: string;
|
|
1378
1378
|
/**
|
|
1379
|
-
* @public
|
|
1380
1379
|
* <p>The new description that you want to update the resource group with. Descriptions can
|
|
1381
1380
|
* contain letters, numbers, hyphens, underscores, periods, and spaces.</p>
|
|
1381
|
+
* @public
|
|
1382
1382
|
*/
|
|
1383
1383
|
Description?: string;
|
|
1384
1384
|
}
|
|
@@ -1387,8 +1387,8 @@ export interface UpdateGroupInput {
|
|
|
1387
1387
|
*/
|
|
1388
1388
|
export interface UpdateGroupOutput {
|
|
1389
1389
|
/**
|
|
1390
|
-
* @public
|
|
1391
1390
|
* <p>The update description of the resource group.</p>
|
|
1391
|
+
* @public
|
|
1392
1392
|
*/
|
|
1393
1393
|
Group?: Group;
|
|
1394
1394
|
}
|
|
@@ -1397,25 +1397,25 @@ export interface UpdateGroupOutput {
|
|
|
1397
1397
|
*/
|
|
1398
1398
|
export interface UpdateGroupQueryInput {
|
|
1399
1399
|
/**
|
|
1400
|
-
* @public
|
|
1401
1400
|
* @deprecated
|
|
1402
1401
|
*
|
|
1403
1402
|
* <p>Don't use this parameter. Use <code>Group</code> instead.</p>
|
|
1403
|
+
* @public
|
|
1404
1404
|
*/
|
|
1405
1405
|
GroupName?: string;
|
|
1406
1406
|
/**
|
|
1407
|
-
* @public
|
|
1408
1407
|
* <p>The name or the ARN of the resource group to query.</p>
|
|
1408
|
+
* @public
|
|
1409
1409
|
*/
|
|
1410
1410
|
Group?: string;
|
|
1411
1411
|
/**
|
|
1412
|
-
* @public
|
|
1413
1412
|
* <p>The resource query to determine which Amazon Web Services resources are members of this resource
|
|
1414
1413
|
* group.</p>
|
|
1415
1414
|
* <note>
|
|
1416
1415
|
* <p>A resource group can contain either a <code>Configuration</code> or a
|
|
1417
1416
|
* <code>ResourceQuery</code>, but not both.</p>
|
|
1418
1417
|
* </note>
|
|
1418
|
+
* @public
|
|
1419
1419
|
*/
|
|
1420
1420
|
ResourceQuery: ResourceQuery | undefined;
|
|
1421
1421
|
}
|
|
@@ -1424,8 +1424,8 @@ export interface UpdateGroupQueryInput {
|
|
|
1424
1424
|
*/
|
|
1425
1425
|
export interface UpdateGroupQueryOutput {
|
|
1426
1426
|
/**
|
|
1427
|
-
* @public
|
|
1428
1427
|
* <p>The updated resource query associated with the resource group after the update.</p>
|
|
1428
|
+
* @public
|
|
1429
1429
|
*/
|
|
1430
1430
|
GroupQuery?: GroupQuery;
|
|
1431
1431
|
}
|