resourcegroups.d.ts
34 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
import {Request} from '../lib/request';
import {Response} from '../lib/response';
import {AWSError} from '../lib/error';
import {Service} from '../lib/service';
import {ServiceConfigurationOptions} from '../lib/service';
import {ConfigBase as Config} from '../lib/config-base';
interface Blob {}
declare class ResourceGroups extends Service {
/**
* Constructs a service object. This object has one method for each API operation.
*/
constructor(options?: ResourceGroups.Types.ClientConfiguration)
config: Config & ResourceGroups.Types.ClientConfiguration;
/**
* Creates a resource group with the specified name and description. You can optionally include a resource query, or a service configuration.
*/
createGroup(params: ResourceGroups.Types.CreateGroupInput, callback?: (err: AWSError, data: ResourceGroups.Types.CreateGroupOutput) => void): Request<ResourceGroups.Types.CreateGroupOutput, AWSError>;
/**
* Creates a resource group with the specified name and description. You can optionally include a resource query, or a service configuration.
*/
createGroup(callback?: (err: AWSError, data: ResourceGroups.Types.CreateGroupOutput) => void): Request<ResourceGroups.Types.CreateGroupOutput, AWSError>;
/**
* Deletes the specified resource group. Deleting a resource group does not delete any resources that are members of the group; it only deletes the group structure.
*/
deleteGroup(params: ResourceGroups.Types.DeleteGroupInput, callback?: (err: AWSError, data: ResourceGroups.Types.DeleteGroupOutput) => void): Request<ResourceGroups.Types.DeleteGroupOutput, AWSError>;
/**
* Deletes the specified resource group. Deleting a resource group does not delete any resources that are members of the group; it only deletes the group structure.
*/
deleteGroup(callback?: (err: AWSError, data: ResourceGroups.Types.DeleteGroupOutput) => void): Request<ResourceGroups.Types.DeleteGroupOutput, AWSError>;
/**
* Returns information about a specified resource group.
*/
getGroup(params: ResourceGroups.Types.GetGroupInput, callback?: (err: AWSError, data: ResourceGroups.Types.GetGroupOutput) => void): Request<ResourceGroups.Types.GetGroupOutput, AWSError>;
/**
* Returns information about a specified resource group.
*/
getGroup(callback?: (err: AWSError, data: ResourceGroups.Types.GetGroupOutput) => void): Request<ResourceGroups.Types.GetGroupOutput, AWSError>;
/**
* Returns the service configuration associated with the specified resource group. AWS Resource Groups supports configurations for the following resource group types: AWS::EC2::CapacityReservationPool - Amazon EC2 capacity reservation pools. For more information, see Working with capacity reservation groups in the EC2 Users Guide.
*/
getGroupConfiguration(params: ResourceGroups.Types.GetGroupConfigurationInput, callback?: (err: AWSError, data: ResourceGroups.Types.GetGroupConfigurationOutput) => void): Request<ResourceGroups.Types.GetGroupConfigurationOutput, AWSError>;
/**
* Returns the service configuration associated with the specified resource group. AWS Resource Groups supports configurations for the following resource group types: AWS::EC2::CapacityReservationPool - Amazon EC2 capacity reservation pools. For more information, see Working with capacity reservation groups in the EC2 Users Guide.
*/
getGroupConfiguration(callback?: (err: AWSError, data: ResourceGroups.Types.GetGroupConfigurationOutput) => void): Request<ResourceGroups.Types.GetGroupConfigurationOutput, AWSError>;
/**
* Retrieves the resource query associated with the specified resource group.
*/
getGroupQuery(params: ResourceGroups.Types.GetGroupQueryInput, callback?: (err: AWSError, data: ResourceGroups.Types.GetGroupQueryOutput) => void): Request<ResourceGroups.Types.GetGroupQueryOutput, AWSError>;
/**
* Retrieves the resource query associated with the specified resource group.
*/
getGroupQuery(callback?: (err: AWSError, data: ResourceGroups.Types.GetGroupQueryOutput) => void): Request<ResourceGroups.Types.GetGroupQueryOutput, AWSError>;
/**
* Returns a list of tags that are associated with a resource group, specified by an ARN.
*/
getTags(params: ResourceGroups.Types.GetTagsInput, callback?: (err: AWSError, data: ResourceGroups.Types.GetTagsOutput) => void): Request<ResourceGroups.Types.GetTagsOutput, AWSError>;
/**
* Returns a list of tags that are associated with a resource group, specified by an ARN.
*/
getTags(callback?: (err: AWSError, data: ResourceGroups.Types.GetTagsOutput) => void): Request<ResourceGroups.Types.GetTagsOutput, AWSError>;
/**
* Adds the specified resources to the specified group.
*/
groupResources(params: ResourceGroups.Types.GroupResourcesInput, callback?: (err: AWSError, data: ResourceGroups.Types.GroupResourcesOutput) => void): Request<ResourceGroups.Types.GroupResourcesOutput, AWSError>;
/**
* Adds the specified resources to the specified group.
*/
groupResources(callback?: (err: AWSError, data: ResourceGroups.Types.GroupResourcesOutput) => void): Request<ResourceGroups.Types.GroupResourcesOutput, AWSError>;
/**
* Returns a list of ARNs of the resources that are members of a specified resource group.
*/
listGroupResources(params: ResourceGroups.Types.ListGroupResourcesInput, callback?: (err: AWSError, data: ResourceGroups.Types.ListGroupResourcesOutput) => void): Request<ResourceGroups.Types.ListGroupResourcesOutput, AWSError>;
/**
* Returns a list of ARNs of the resources that are members of a specified resource group.
*/
listGroupResources(callback?: (err: AWSError, data: ResourceGroups.Types.ListGroupResourcesOutput) => void): Request<ResourceGroups.Types.ListGroupResourcesOutput, AWSError>;
/**
* Returns a list of existing resource groups in your account.
*/
listGroups(params: ResourceGroups.Types.ListGroupsInput, callback?: (err: AWSError, data: ResourceGroups.Types.ListGroupsOutput) => void): Request<ResourceGroups.Types.ListGroupsOutput, AWSError>;
/**
* Returns a list of existing resource groups in your account.
*/
listGroups(callback?: (err: AWSError, data: ResourceGroups.Types.ListGroupsOutput) => void): Request<ResourceGroups.Types.ListGroupsOutput, AWSError>;
/**
* Returns a list of AWS resource identifiers that matches the specified query. The query uses the same format as a resource query in a CreateGroup or UpdateGroupQuery operation.
*/
searchResources(params: ResourceGroups.Types.SearchResourcesInput, callback?: (err: AWSError, data: ResourceGroups.Types.SearchResourcesOutput) => void): Request<ResourceGroups.Types.SearchResourcesOutput, AWSError>;
/**
* Returns a list of AWS resource identifiers that matches the specified query. The query uses the same format as a resource query in a CreateGroup or UpdateGroupQuery operation.
*/
searchResources(callback?: (err: AWSError, data: ResourceGroups.Types.SearchResourcesOutput) => void): Request<ResourceGroups.Types.SearchResourcesOutput, AWSError>;
/**
* 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. Do not store personally identifiable information (PII) or other confidential or sensitive information in tags. We use tags to provide you with billing and administration services. Tags are not intended to be used for private or sensitive data.
*/
tag(params: ResourceGroups.Types.TagInput, callback?: (err: AWSError, data: ResourceGroups.Types.TagOutput) => void): Request<ResourceGroups.Types.TagOutput, AWSError>;
/**
* 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. Do not store personally identifiable information (PII) or other confidential or sensitive information in tags. We use tags to provide you with billing and administration services. Tags are not intended to be used for private or sensitive data.
*/
tag(callback?: (err: AWSError, data: ResourceGroups.Types.TagOutput) => void): Request<ResourceGroups.Types.TagOutput, AWSError>;
/**
* Removes the specified resources from the specified group.
*/
ungroupResources(params: ResourceGroups.Types.UngroupResourcesInput, callback?: (err: AWSError, data: ResourceGroups.Types.UngroupResourcesOutput) => void): Request<ResourceGroups.Types.UngroupResourcesOutput, AWSError>;
/**
* Removes the specified resources from the specified group.
*/
ungroupResources(callback?: (err: AWSError, data: ResourceGroups.Types.UngroupResourcesOutput) => void): Request<ResourceGroups.Types.UngroupResourcesOutput, AWSError>;
/**
* Deletes tags from a specified resource group.
*/
untag(params: ResourceGroups.Types.UntagInput, callback?: (err: AWSError, data: ResourceGroups.Types.UntagOutput) => void): Request<ResourceGroups.Types.UntagOutput, AWSError>;
/**
* Deletes tags from a specified resource group.
*/
untag(callback?: (err: AWSError, data: ResourceGroups.Types.UntagOutput) => void): Request<ResourceGroups.Types.UntagOutput, AWSError>;
/**
* Updates the description for an existing group. You cannot update the name of a resource group.
*/
updateGroup(params: ResourceGroups.Types.UpdateGroupInput, callback?: (err: AWSError, data: ResourceGroups.Types.UpdateGroupOutput) => void): Request<ResourceGroups.Types.UpdateGroupOutput, AWSError>;
/**
* Updates the description for an existing group. You cannot update the name of a resource group.
*/
updateGroup(callback?: (err: AWSError, data: ResourceGroups.Types.UpdateGroupOutput) => void): Request<ResourceGroups.Types.UpdateGroupOutput, AWSError>;
/**
* Updates the resource query of a group.
*/
updateGroupQuery(params: ResourceGroups.Types.UpdateGroupQueryInput, callback?: (err: AWSError, data: ResourceGroups.Types.UpdateGroupQueryOutput) => void): Request<ResourceGroups.Types.UpdateGroupQueryOutput, AWSError>;
/**
* Updates the resource query of a group.
*/
updateGroupQuery(callback?: (err: AWSError, data: ResourceGroups.Types.UpdateGroupQueryOutput) => void): Request<ResourceGroups.Types.UpdateGroupQueryOutput, AWSError>;
}
declare namespace ResourceGroups {
export interface CreateGroupInput {
/**
* The name of the group, which is the identifier of the group in other operations. You can't change the name of a resource group after you create it. A resource group name can consist of letters, numbers, hyphens, periods, and underscores. The name cannot start with AWS or aws; these are reserved. A resource group name must be unique within each AWS Region in your AWS account.
*/
Name: GroupName;
/**
* The description of the resource group. Descriptions can consist of letters, numbers, hyphens, underscores, periods, and spaces.
*/
Description?: Description;
/**
* The resource query that determines which AWS resources are members of this group. You can specify either a ResourceQuery or a Configuration, but not both.
*/
ResourceQuery?: ResourceQuery;
/**
* The tags to add to the group. A tag is key-value pair string.
*/
Tags?: Tags;
/**
* A configuration associates the resource group with an AWS service and specifies how the service can interact with the resources in the group. A configuration is an array of GroupConfigurationItem elements. You can specify either a Configuration or a ResourceQuery in a group, but not both.
*/
Configuration?: GroupConfigurationList;
}
export interface CreateGroupOutput {
/**
* The description of the resource group.
*/
Group?: Group;
/**
* The resource query associated with the group.
*/
ResourceQuery?: ResourceQuery;
/**
* The tags associated with the group.
*/
Tags?: Tags;
/**
* The service configuration associated with the resource group. AWS Resource Groups supports adding service configurations for the following resource group types: AWS::EC2::CapacityReservationPool - Amazon EC2 capacity reservation pools. For more information, see Working with capacity reservation groups in the EC2 Users Guide.
*/
GroupConfiguration?: GroupConfiguration;
}
export interface DeleteGroupInput {
/**
* Don't use this parameter. Use Group instead.
*/
GroupName?: GroupName;
/**
* The name or the ARN of the resource group to delete.
*/
Group?: GroupString;
}
export interface DeleteGroupOutput {
/**
* A full description of the deleted resource group.
*/
Group?: Group;
}
export type Description = string;
export type ErrorCode = string;
export type ErrorMessage = string;
export interface FailedResource {
/**
* The ARN of the resource that failed to be added or removed.
*/
ResourceArn?: ResourceArn;
/**
* The error message text associated with the failure.
*/
ErrorMessage?: ErrorMessage;
/**
* The error code associated with the failure.
*/
ErrorCode?: ErrorCode;
}
export type FailedResourceList = FailedResource[];
export interface GetGroupConfigurationInput {
/**
* The name or the ARN of the resource group.
*/
Group?: GroupString;
}
export interface GetGroupConfigurationOutput {
/**
* The configuration associated with the specified group.
*/
GroupConfiguration?: GroupConfiguration;
}
export interface GetGroupInput {
/**
* Don't use this parameter. Use Group instead.
*/
GroupName?: GroupName;
/**
* The name or the ARN of the resource group to retrieve.
*/
Group?: GroupString;
}
export interface GetGroupOutput {
/**
* A full description of the resource group.
*/
Group?: Group;
}
export interface GetGroupQueryInput {
/**
* Don't use this parameter. Use Group instead.
*/
GroupName?: GroupName;
/**
* The name or the ARN of the resource group to query.
*/
Group?: GroupString;
}
export interface GetGroupQueryOutput {
/**
* The resource query associated with the specified group.
*/
GroupQuery?: GroupQuery;
}
export interface GetTagsInput {
/**
* The ARN of the resource group whose tags you want to retrieve.
*/
Arn: GroupArn;
}
export interface GetTagsOutput {
/**
* The ARN of the tagged resource group.
*/
Arn?: GroupArn;
/**
* The tags associated with the specified resource group.
*/
Tags?: Tags;
}
export interface Group {
/**
* The ARN of the resource group.
*/
GroupArn: GroupArn;
/**
* The name of the resource group.
*/
Name: GroupName;
/**
* The description of the resource group.
*/
Description?: Description;
}
export type GroupArn = string;
export interface GroupConfiguration {
/**
* The configuration currently associated with the group and in effect.
*/
Configuration?: GroupConfigurationList;
/**
* If present, the new configuration that is in the process of being applied to the group.
*/
ProposedConfiguration?: GroupConfigurationList;
/**
* The current status of an attempt to update the group configuration.
*/
Status?: GroupConfigurationStatus;
/**
* If present, the reason why a request to update the group configuration failed.
*/
FailureReason?: GroupConfigurationFailureReason;
}
export type GroupConfigurationFailureReason = string;
export interface GroupConfigurationItem {
/**
* Specifies the type of group configuration item. Each item must have a unique value for type. You can specify the following string values: AWS::EC2::CapacityReservationPool For more information about EC2 capacity reservation groups, see Working with capacity reservation groups in the EC2 Users Guide. AWS::ResourceGroups::Generic - Supports parameters that configure the behavior of resource groups of any type.
*/
Type: GroupConfigurationType;
/**
* A collection of parameters for this group configuration item.
*/
Parameters?: GroupParameterList;
}
export type GroupConfigurationList = GroupConfigurationItem[];
export interface GroupConfigurationParameter {
/**
* The name of the group configuration parameter. You can specify the following string values: For configuration item type AWS::ResourceGroups::Generic: allowed-resource-types Specifies the types of resources that you can add to this group by using the GroupResources operation. For configuration item type AWS::EC2::CapacityReservationPool: None - This configuration item type doesn't support any parameters. For more information about EC2 capacity reservation groups, see Working with capacity reservation groups in the EC2 Users Guide.
*/
Name: GroupConfigurationParameterName;
/**
* The values of for this parameter. You can specify the following string value: For item type allowed-resource-types: the only supported parameter value is AWS::EC2::CapacityReservation.
*/
Values?: GroupConfigurationParameterValueList;
}
export type GroupConfigurationParameterName = string;
export type GroupConfigurationParameterValue = string;
export type GroupConfigurationParameterValueList = GroupConfigurationParameterValue[];
export type GroupConfigurationStatus = "UPDATING"|"UPDATE_COMPLETE"|"UPDATE_FAILED"|string;
export type GroupConfigurationType = string;
export interface GroupFilter {
/**
* The name of the filter. Filter names are case-sensitive.
*/
Name: GroupFilterName;
/**
* One or more filter values. Allowed filter values vary by group filter name, and are case-sensitive.
*/
Values: GroupFilterValues;
}
export type GroupFilterList = GroupFilter[];
export type GroupFilterName = "resource-type"|"configuration-type"|string;
export type GroupFilterValue = string;
export type GroupFilterValues = GroupFilterValue[];
export interface GroupIdentifier {
/**
* The name of the resource group.
*/
GroupName?: GroupName;
/**
* The ARN of the resource group.
*/
GroupArn?: GroupArn;
}
export type GroupIdentifierList = GroupIdentifier[];
export type GroupList = Group[];
export type GroupName = string;
export type GroupParameterList = GroupConfigurationParameter[];
export interface GroupQuery {
/**
* The name of the resource group that is associated with the specified resource query.
*/
GroupName: GroupName;
/**
* The resource query that determines which AWS resources are members of the associated resource group.
*/
ResourceQuery: ResourceQuery;
}
export interface GroupResourcesInput {
/**
* The name or the ARN of the resource group to add resources to.
*/
Group: GroupString;
/**
* The list of ARNs for resources to be added to the group.
*/
ResourceArns: ResourceArnList;
}
export interface GroupResourcesOutput {
/**
* The ARNs of the resources that were successfully added to the group by this operation.
*/
Succeeded?: ResourceArnList;
/**
* The ARNs of the resources that failed to be added to the group by this operation.
*/
Failed?: FailedResourceList;
}
export type GroupString = string;
export interface ListGroupResourcesInput {
/**
* Don't use this parameter. Use Group instead.
*/
GroupName?: GroupName;
/**
* The name or the ARN of the resource group
*/
Group?: GroupString;
/**
* Filters, formatted as ResourceFilter objects, that you want to apply to a ListGroupResources operation. Filters the results to include only those of the specified resource types. resource-type - Filter resources by their type. Specify up to five resource types in the format AWS::ServiceCode::ResourceType. For example, AWS::EC2::Instance, or AWS::S3::Bucket. When you specify a resource-type filter for ListGroupResources, AWS Resource Groups validates your filter resource types against the types that are defined in the query associated with the group. For example, if a group contains only S3 buckets because its query specifies only that resource type, but your resource-type filter includes EC2 instances, AWS Resource Groups does not filter for EC2 instances. In this case, a ListGroupResources request returns a BadRequestException error with a message similar to the following: The resource types specified as filters in the request are not valid. The error includes a list of resource types that failed the validation because they are not part of the query associated with the group. This validation doesn't occur when the group query specifies AWS::AllSupported, because a group based on such a query can contain any of the allowed resource types for the query type (tag-based or AWS CloudFormation stack-based queries).
*/
Filters?: ResourceFilterList;
/**
* The total number of results that you want included on each page of the response. If you do not include this parameter, it defaults to a value that is specific to the operation. If additional items exist beyond the maximum you specify, the NextToken response element is present and has a value (is not null). Include that value as the NextToken request parameter in the next call to the operation to get the next part of the results. Note that the service might return fewer results than the maximum even when there are more results available. You should check NextToken after every operation to ensure that you receive all of the results.
*/
MaxResults?: MaxResults;
/**
* The parameter for receiving additional results if you receive a NextToken response in a previous request. A NextToken response indicates that more output is available. Set this parameter to the value provided by a previous call's NextToken response to indicate where the output should continue from.
*/
NextToken?: NextToken;
}
export interface ListGroupResourcesOutput {
/**
* The ARNs and resource types of resources that are members of the group that you specified.
*/
ResourceIdentifiers?: ResourceIdentifierList;
/**
* If present, indicates that more output is available than is included in the current response. Use this value in the NextToken request parameter in a subsequent call to the operation to get the next part of the output. You should repeat this until the NextToken response element comes back as null.
*/
NextToken?: NextToken;
/**
* A list of QueryError objects. Each error is an object that contains ErrorCode and Message structures. Possible values for ErrorCode are CLOUDFORMATION_STACK_INACTIVE and CLOUDFORMATION_STACK_NOT_EXISTING.
*/
QueryErrors?: QueryErrorList;
}
export interface ListGroupsInput {
/**
* Filters, formatted as GroupFilter objects, that you want to apply to a ListGroups operation. resource-type - Filter the results to include only those of the specified resource types. Specify up to five resource types in the format AWS::ServiceCode::ResourceType . For example, AWS::EC2::Instance, or AWS::S3::Bucket. configuration-type - Filter the results to include only those groups that have the specified configuration types attached. The current supported values are: AWS:EC2::CapacityReservationPool
*/
Filters?: GroupFilterList;
/**
* The total number of results that you want included on each page of the response. If you do not include this parameter, it defaults to a value that is specific to the operation. If additional items exist beyond the maximum you specify, the NextToken response element is present and has a value (is not null). Include that value as the NextToken request parameter in the next call to the operation to get the next part of the results. Note that the service might return fewer results than the maximum even when there are more results available. You should check NextToken after every operation to ensure that you receive all of the results.
*/
MaxResults?: MaxResults;
/**
* The parameter for receiving additional results if you receive a NextToken response in a previous request. A NextToken response indicates that more output is available. Set this parameter to the value provided by a previous call's NextToken response to indicate where the output should continue from.
*/
NextToken?: NextToken;
}
export interface ListGroupsOutput {
/**
* A list of GroupIdentifier objects. Each identifier is an object that contains both the Name and the GroupArn.
*/
GroupIdentifiers?: GroupIdentifierList;
/**
* This output element is deprecated and shouldn't be used. Refer to GroupIdentifiers instead.
*/
Groups?: GroupList;
/**
* If present, indicates that more output is available than is included in the current response. Use this value in the NextToken request parameter in a subsequent call to the operation to get the next part of the output. You should repeat this until the NextToken response element comes back as null.
*/
NextToken?: NextToken;
}
export type MaxResults = number;
export type NextToken = string;
export type Query = string;
export interface QueryError {
/**
* Possible values are CLOUDFORMATION_STACK_INACTIVE and CLOUDFORMATION_STACK_NOT_EXISTING.
*/
ErrorCode?: QueryErrorCode;
/**
* A message that explains the ErrorCode value. Messages might state that the specified CloudFormation stack does not exist (or no longer exists). For CLOUDFORMATION_STACK_INACTIVE, the message typically states that the CloudFormation stack has a status that is not (or no longer) active, such as CREATE_FAILED.
*/
Message?: QueryErrorMessage;
}
export type QueryErrorCode = "CLOUDFORMATION_STACK_INACTIVE"|"CLOUDFORMATION_STACK_NOT_EXISTING"|string;
export type QueryErrorList = QueryError[];
export type QueryErrorMessage = string;
export type QueryType = "TAG_FILTERS_1_0"|"CLOUDFORMATION_STACK_1_0"|string;
export type ResourceArn = string;
export type ResourceArnList = ResourceArn[];
export interface ResourceFilter {
/**
* The name of the filter. Filter names are case-sensitive.
*/
Name: ResourceFilterName;
/**
* One or more filter values. Allowed filter values vary by resource filter name, and are case-sensitive.
*/
Values: ResourceFilterValues;
}
export type ResourceFilterList = ResourceFilter[];
export type ResourceFilterName = "resource-type"|string;
export type ResourceFilterValue = string;
export type ResourceFilterValues = ResourceFilterValue[];
export interface ResourceIdentifier {
/**
* The ARN of a resource.
*/
ResourceArn?: ResourceArn;
/**
* The resource type of a resource, such as AWS::EC2::Instance.
*/
ResourceType?: ResourceType;
}
export type ResourceIdentifierList = ResourceIdentifier[];
export interface ResourceQuery {
/**
* The type of the query. You can use the following values: CLOUDFORMATION_STACK_1_0: Specifies that the Query contains an ARN for a CloudFormation stack. TAG_FILTERS_1_0: Specifies that the Query parameter contains a JSON string that represents a collection of simple tag filters for resource types and tags. The JSON string uses a syntax similar to the GetResources operation, but uses only the ResourceTypeFilters and TagFilters fields. If you specify more than one tag key, only resources that match all tag keys, and at least one value of each specified tag key, are returned in your query. If you specify more than one value for a tag key, a resource matches the filter if it has a tag key value that matches any of the specified values. For example, consider the following sample query for resources that have two tags, Stage and Version, with two values each: [{"Stage":["Test","Deploy"]},{"Version":["1","2"]}] The results of this query could include the following. An EC2 instance that has the following two tags: {"Stage":"Deploy"}, and {"Version":"2"} An S3 bucket that has the following two tags: {"Stage":"Test"}, and {"Version":"1"} The query would not include the following items in the results, however. An EC2 instance that has only the following tag: {"Stage":"Deploy"}. The instance does not have all of the tag keys specified in the filter, so it is excluded from the results. An RDS database that has the following two tags: {"Stage":"Archived"} and {"Version":"4"} The database has all of the tag keys, but none of those keys has an associated value that matches at least one of the specified values in the filter.
*/
Type: QueryType;
/**
* The query that defines a group or a search.
*/
Query: Query;
}
export type ResourceType = string;
export interface SearchResourcesInput {
/**
* The search query, using the same formats that are supported for resource group definition. For more information, see CreateGroup.
*/
ResourceQuery: ResourceQuery;
/**
* The total number of results that you want included on each page of the response. If you do not include this parameter, it defaults to a value that is specific to the operation. If additional items exist beyond the maximum you specify, the NextToken response element is present and has a value (is not null). Include that value as the NextToken request parameter in the next call to the operation to get the next part of the results. Note that the service might return fewer results than the maximum even when there are more results available. You should check NextToken after every operation to ensure that you receive all of the results.
*/
MaxResults?: MaxResults;
/**
* The parameter for receiving additional results if you receive a NextToken response in a previous request. A NextToken response indicates that more output is available. Set this parameter to the value provided by a previous call's NextToken response to indicate where the output should continue from.
*/
NextToken?: NextToken;
}
export interface SearchResourcesOutput {
/**
* The ARNs and resource types of resources that are members of the group that you specified.
*/
ResourceIdentifiers?: ResourceIdentifierList;
/**
* If present, indicates that more output is available than is included in the current response. Use this value in the NextToken request parameter in a subsequent call to the operation to get the next part of the output. You should repeat this until the NextToken response element comes back as null.
*/
NextToken?: NextToken;
/**
* A list of QueryError objects. Each error is an object that contains ErrorCode and Message structures. Possible values for ErrorCode are CLOUDFORMATION_STACK_INACTIVE and CLOUDFORMATION_STACK_NOT_EXISTING.
*/
QueryErrors?: QueryErrorList;
}
export interface TagInput {
/**
* The ARN of the resource group to which to add tags.
*/
Arn: GroupArn;
/**
* The tags to add to the specified resource group. A tag is a string-to-string map of key-value pairs.
*/
Tags: Tags;
}
export type TagKey = string;
export type TagKeyList = TagKey[];
export interface TagOutput {
/**
* The ARN of the tagged resource.
*/
Arn?: GroupArn;
/**
* The tags that have been added to the specified resource group.
*/
Tags?: Tags;
}
export type TagValue = string;
export type Tags = {[key: string]: TagValue};
export interface UngroupResourcesInput {
/**
* The name or the ARN of the resource group from which to remove the resources.
*/
Group: GroupString;
/**
* The ARNs of the resources to be removed from the group.
*/
ResourceArns: ResourceArnList;
}
export interface UngroupResourcesOutput {
/**
* The ARNs of the resources that were successfully removed from the group.
*/
Succeeded?: ResourceArnList;
/**
* The resources that failed to be removed from the group.
*/
Failed?: FailedResourceList;
}
export interface UntagInput {
/**
* The ARN of the resource group from which to remove tags. The command removed both the specified keys and any values associated with those keys.
*/
Arn: GroupArn;
/**
* The keys of the tags to be removed.
*/
Keys: TagKeyList;
}
export interface UntagOutput {
/**
* The ARN of the resource group from which tags have been removed.
*/
Arn?: GroupArn;
/**
* The keys of the tags that were removed.
*/
Keys?: TagKeyList;
}
export interface UpdateGroupInput {
/**
* Don't use this parameter. Use Group instead.
*/
GroupName?: GroupName;
/**
* The name or the ARN of the resource group to modify.
*/
Group?: GroupString;
/**
* The new description that you want to update the resource group with. Descriptions can contain letters, numbers, hyphens, underscores, periods, and spaces.
*/
Description?: Description;
}
export interface UpdateGroupOutput {
/**
* The update description of the resource group.
*/
Group?: Group;
}
export interface UpdateGroupQueryInput {
/**
* Don't use this parameter. Use Group instead.
*/
GroupName?: GroupName;
/**
* The name or the ARN of the resource group to query.
*/
Group?: GroupString;
/**
* The resource query to determine which AWS resources are members of this resource group.
*/
ResourceQuery: ResourceQuery;
}
export interface UpdateGroupQueryOutput {
/**
* The updated resource query associated with the resource group after the update.
*/
GroupQuery?: GroupQuery;
}
/**
* A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version.
*/
export type apiVersion = "2017-11-27"|"latest"|string;
export interface ClientApiVersions {
/**
* A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version.
*/
apiVersion?: apiVersion;
}
export type ClientConfiguration = ServiceConfigurationOptions & ClientApiVersions;
/**
* Contains interfaces for use with the ResourceGroups client.
*/
export import Types = ResourceGroups;
}
export = ResourceGroups;