@aws-sdk/client-resource-groups 3.379.1 → 3.382.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-types/models/models_0.d.ts +110 -0
- package/package.json +5 -5
|
@@ -32,14 +32,17 @@ export type GroupLifecycleEventsStatus = (typeof GroupLifecycleEventsStatus)[key
|
|
|
32
32
|
*/
|
|
33
33
|
export interface AccountSettings {
|
|
34
34
|
/**
|
|
35
|
+
* @public
|
|
35
36
|
* <p>The desired target status of the group lifecycle events feature. If</p>
|
|
36
37
|
*/
|
|
37
38
|
GroupLifecycleEventsDesiredStatus?: GroupLifecycleEventsDesiredStatus | string;
|
|
38
39
|
/**
|
|
40
|
+
* @public
|
|
39
41
|
* <p>The current status of the group lifecycle events feature.</p>
|
|
40
42
|
*/
|
|
41
43
|
GroupLifecycleEventsStatus?: GroupLifecycleEventsStatus | string;
|
|
42
44
|
/**
|
|
45
|
+
* @public
|
|
43
46
|
* <p>The text of any error message occurs during an attempt to turn group lifecycle events on or off.</p>
|
|
44
47
|
*/
|
|
45
48
|
GroupLifecycleEventsStatusMessage?: string;
|
|
@@ -65,12 +68,14 @@ export declare class BadRequestException extends __BaseException {
|
|
|
65
68
|
*/
|
|
66
69
|
export interface GroupConfigurationParameter {
|
|
67
70
|
/**
|
|
71
|
+
* @public
|
|
68
72
|
* <p>The name of the group configuration parameter. For the list of parameters that you can
|
|
69
73
|
* 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
|
|
70
74
|
* parameters</a>.</p>
|
|
71
75
|
*/
|
|
72
76
|
Name: string | undefined;
|
|
73
77
|
/**
|
|
78
|
+
* @public
|
|
74
79
|
* <p>The value or values to be used for the specified parameter. For the list of values you
|
|
75
80
|
* 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
|
|
76
81
|
* parameters</a>.</p>
|
|
@@ -85,6 +90,7 @@ export interface GroupConfigurationParameter {
|
|
|
85
90
|
*/
|
|
86
91
|
export interface GroupConfigurationItem {
|
|
87
92
|
/**
|
|
93
|
+
* @public
|
|
88
94
|
* <p>Specifies the type of group configuration item. Each item must have a unique value for
|
|
89
95
|
* <code>type</code>. For the list of types that you can specify for a configuration
|
|
90
96
|
* item, see <a href="https://docs.aws.amazon.com/ARG/latest/APIReference/about-slg.html#about-slg-types">Supported resource types and
|
|
@@ -92,6 +98,7 @@ export interface GroupConfigurationItem {
|
|
|
92
98
|
*/
|
|
93
99
|
Type: string | undefined;
|
|
94
100
|
/**
|
|
101
|
+
* @public
|
|
95
102
|
* <p>A collection of parameters for this group configuration item. For the list of
|
|
96
103
|
* 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
|
|
97
104
|
* resource types and parameters</a>.</p>
|
|
@@ -142,6 +149,7 @@ export type QueryType = (typeof QueryType)[keyof typeof QueryType];
|
|
|
142
149
|
*/
|
|
143
150
|
export interface ResourceQuery {
|
|
144
151
|
/**
|
|
152
|
+
* @public
|
|
145
153
|
* <p>The type of the query to perform. This can have one of two values:</p>
|
|
146
154
|
* <ul>
|
|
147
155
|
* <li>
|
|
@@ -164,6 +172,7 @@ export interface ResourceQuery {
|
|
|
164
172
|
*/
|
|
165
173
|
Type: QueryType | string | undefined;
|
|
166
174
|
/**
|
|
175
|
+
* @public
|
|
167
176
|
* <p>The query that defines a group or a search. The contents depends on the value of the
|
|
168
177
|
* <code>Type</code> element.</p>
|
|
169
178
|
* <ul>
|
|
@@ -267,6 +276,7 @@ export interface ResourceQuery {
|
|
|
267
276
|
*/
|
|
268
277
|
export interface CreateGroupInput {
|
|
269
278
|
/**
|
|
279
|
+
* @public
|
|
270
280
|
* <p>The name of the group, which is the identifier of the group in other operations. You
|
|
271
281
|
* can't change the name of a resource group after you create it. A resource group name can
|
|
272
282
|
* consist of letters, numbers, hyphens, periods, and underscores. The name cannot start
|
|
@@ -275,11 +285,13 @@ export interface CreateGroupInput {
|
|
|
275
285
|
*/
|
|
276
286
|
Name: string | undefined;
|
|
277
287
|
/**
|
|
288
|
+
* @public
|
|
278
289
|
* <p>The description of the resource group. Descriptions can consist of letters, numbers,
|
|
279
290
|
* hyphens, underscores, periods, and spaces.</p>
|
|
280
291
|
*/
|
|
281
292
|
Description?: string;
|
|
282
293
|
/**
|
|
294
|
+
* @public
|
|
283
295
|
* <p>The resource query that determines which Amazon Web Services resources are members of this group.
|
|
284
296
|
* 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
|
|
285
297
|
* a tag-based group in Resource Groups</a>. </p>
|
|
@@ -290,10 +302,12 @@ export interface CreateGroupInput {
|
|
|
290
302
|
*/
|
|
291
303
|
ResourceQuery?: ResourceQuery;
|
|
292
304
|
/**
|
|
305
|
+
* @public
|
|
293
306
|
* <p>The tags to add to the group. A tag is key-value pair string.</p>
|
|
294
307
|
*/
|
|
295
308
|
Tags?: Record<string, string>;
|
|
296
309
|
/**
|
|
310
|
+
* @public
|
|
297
311
|
* <p>A configuration associates the resource group with an Amazon Web Services service and specifies how
|
|
298
312
|
* the service can interact with the resources in the group. A configuration is an array of
|
|
299
313
|
* <a>GroupConfigurationItem</a> elements. For details about the syntax of
|
|
@@ -327,14 +341,17 @@ export interface CreateGroupInput {
|
|
|
327
341
|
*/
|
|
328
342
|
export interface Group {
|
|
329
343
|
/**
|
|
344
|
+
* @public
|
|
330
345
|
* <p>The ARN of the resource group.</p>
|
|
331
346
|
*/
|
|
332
347
|
GroupArn: string | undefined;
|
|
333
348
|
/**
|
|
349
|
+
* @public
|
|
334
350
|
* <p>The name of the resource group.</p>
|
|
335
351
|
*/
|
|
336
352
|
Name: string | undefined;
|
|
337
353
|
/**
|
|
354
|
+
* @public
|
|
338
355
|
* <p>The description of the resource group.</p>
|
|
339
356
|
*/
|
|
340
357
|
Description?: string;
|
|
@@ -363,19 +380,23 @@ export type GroupConfigurationStatus = (typeof GroupConfigurationStatus)[keyof t
|
|
|
363
380
|
*/
|
|
364
381
|
export interface GroupConfiguration {
|
|
365
382
|
/**
|
|
383
|
+
* @public
|
|
366
384
|
* <p>The configuration currently associated with the group and in effect.</p>
|
|
367
385
|
*/
|
|
368
386
|
Configuration?: GroupConfigurationItem[];
|
|
369
387
|
/**
|
|
388
|
+
* @public
|
|
370
389
|
* <p>If present, the new configuration that is in the process of being applied to the
|
|
371
390
|
* group.</p>
|
|
372
391
|
*/
|
|
373
392
|
ProposedConfiguration?: GroupConfigurationItem[];
|
|
374
393
|
/**
|
|
394
|
+
* @public
|
|
375
395
|
* <p>The current status of an attempt to update the group configuration.</p>
|
|
376
396
|
*/
|
|
377
397
|
Status?: GroupConfigurationStatus | string;
|
|
378
398
|
/**
|
|
399
|
+
* @public
|
|
379
400
|
* <p>If present, the reason why a request to update the group configuration failed.</p>
|
|
380
401
|
*/
|
|
381
402
|
FailureReason?: string;
|
|
@@ -385,20 +406,24 @@ export interface GroupConfiguration {
|
|
|
385
406
|
*/
|
|
386
407
|
export interface CreateGroupOutput {
|
|
387
408
|
/**
|
|
409
|
+
* @public
|
|
388
410
|
* <p>The description of the resource group.</p>
|
|
389
411
|
*/
|
|
390
412
|
Group?: Group;
|
|
391
413
|
/**
|
|
414
|
+
* @public
|
|
392
415
|
* <p>The resource query associated with the group. For more information about resource
|
|
393
416
|
* queries, see <a href="https://docs.aws.amazon.com/ARG/latest/userguide/gettingstarted-query.html#gettingstarted-query-cli-tag">Create
|
|
394
417
|
* a tag-based group in Resource Groups</a>. </p>
|
|
395
418
|
*/
|
|
396
419
|
ResourceQuery?: ResourceQuery;
|
|
397
420
|
/**
|
|
421
|
+
* @public
|
|
398
422
|
* <p>The tags associated with the group.</p>
|
|
399
423
|
*/
|
|
400
424
|
Tags?: Record<string, string>;
|
|
401
425
|
/**
|
|
426
|
+
* @public
|
|
402
427
|
* <p>The service configuration associated with the resource group. For details about the
|
|
403
428
|
* 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>
|
|
404
429
|
*/
|
|
@@ -462,12 +487,14 @@ export declare class TooManyRequestsException extends __BaseException {
|
|
|
462
487
|
*/
|
|
463
488
|
export interface DeleteGroupInput {
|
|
464
489
|
/**
|
|
490
|
+
* @public
|
|
465
491
|
* @deprecated
|
|
466
492
|
*
|
|
467
493
|
* <p>Deprecated - don't use this parameter. Use <code>Group</code> instead.</p>
|
|
468
494
|
*/
|
|
469
495
|
GroupName?: string;
|
|
470
496
|
/**
|
|
497
|
+
* @public
|
|
471
498
|
* <p>The name or the ARN of the resource group to delete.</p>
|
|
472
499
|
*/
|
|
473
500
|
Group?: string;
|
|
@@ -477,6 +504,7 @@ export interface DeleteGroupInput {
|
|
|
477
504
|
*/
|
|
478
505
|
export interface DeleteGroupOutput {
|
|
479
506
|
/**
|
|
507
|
+
* @public
|
|
480
508
|
* <p>A full description of the deleted resource group.</p>
|
|
481
509
|
*/
|
|
482
510
|
Group?: Group;
|
|
@@ -499,6 +527,7 @@ export declare class NotFoundException extends __BaseException {
|
|
|
499
527
|
*/
|
|
500
528
|
export interface GetAccountSettingsOutput {
|
|
501
529
|
/**
|
|
530
|
+
* @public
|
|
502
531
|
* <p>The current settings for the optional features in Resource Groups.</p>
|
|
503
532
|
*/
|
|
504
533
|
AccountSettings?: AccountSettings;
|
|
@@ -508,12 +537,14 @@ export interface GetAccountSettingsOutput {
|
|
|
508
537
|
*/
|
|
509
538
|
export interface GetGroupInput {
|
|
510
539
|
/**
|
|
540
|
+
* @public
|
|
511
541
|
* @deprecated
|
|
512
542
|
*
|
|
513
543
|
* <p>Deprecated - don't use this parameter. Use <code>Group</code> instead.</p>
|
|
514
544
|
*/
|
|
515
545
|
GroupName?: string;
|
|
516
546
|
/**
|
|
547
|
+
* @public
|
|
517
548
|
* <p>The name or the ARN of the resource group to retrieve.</p>
|
|
518
549
|
*/
|
|
519
550
|
Group?: string;
|
|
@@ -523,6 +554,7 @@ export interface GetGroupInput {
|
|
|
523
554
|
*/
|
|
524
555
|
export interface GetGroupOutput {
|
|
525
556
|
/**
|
|
557
|
+
* @public
|
|
526
558
|
* <p>A structure that contains the metadata details for the specified resource group. Use
|
|
527
559
|
* <a>GetGroupQuery</a> and <a>GetGroupConfiguration</a> to get
|
|
528
560
|
* those additional details of the resource group.</p>
|
|
@@ -534,6 +566,7 @@ export interface GetGroupOutput {
|
|
|
534
566
|
*/
|
|
535
567
|
export interface GetGroupConfigurationInput {
|
|
536
568
|
/**
|
|
569
|
+
* @public
|
|
537
570
|
* <p>The name or the ARN of the resource group for which you want to retrive the service
|
|
538
571
|
* configuration.</p>
|
|
539
572
|
*/
|
|
@@ -544,6 +577,7 @@ export interface GetGroupConfigurationInput {
|
|
|
544
577
|
*/
|
|
545
578
|
export interface GetGroupConfigurationOutput {
|
|
546
579
|
/**
|
|
580
|
+
* @public
|
|
547
581
|
* <p>A structure that describes the service configuration attached with the specified
|
|
548
582
|
* 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
|
|
549
583
|
* Resource Groups</a>.</p>
|
|
@@ -555,12 +589,14 @@ export interface GetGroupConfigurationOutput {
|
|
|
555
589
|
*/
|
|
556
590
|
export interface GetGroupQueryInput {
|
|
557
591
|
/**
|
|
592
|
+
* @public
|
|
558
593
|
* @deprecated
|
|
559
594
|
*
|
|
560
595
|
* <p>Don't use this parameter. Use <code>Group</code> instead.</p>
|
|
561
596
|
*/
|
|
562
597
|
GroupName?: string;
|
|
563
598
|
/**
|
|
599
|
+
* @public
|
|
564
600
|
* <p>The name or the ARN of the resource group to query.</p>
|
|
565
601
|
*/
|
|
566
602
|
Group?: string;
|
|
@@ -572,11 +608,13 @@ export interface GetGroupQueryInput {
|
|
|
572
608
|
*/
|
|
573
609
|
export interface GroupQuery {
|
|
574
610
|
/**
|
|
611
|
+
* @public
|
|
575
612
|
* <p>The name of the resource group that is associated with the specified resource
|
|
576
613
|
* query.</p>
|
|
577
614
|
*/
|
|
578
615
|
GroupName: string | undefined;
|
|
579
616
|
/**
|
|
617
|
+
* @public
|
|
580
618
|
* <p>The resource query that determines which Amazon Web Services resources are members of the associated
|
|
581
619
|
* resource group.</p>
|
|
582
620
|
*/
|
|
@@ -587,6 +625,7 @@ export interface GroupQuery {
|
|
|
587
625
|
*/
|
|
588
626
|
export interface GetGroupQueryOutput {
|
|
589
627
|
/**
|
|
628
|
+
* @public
|
|
590
629
|
* <p>The resource query associated with the specified group. For more information about
|
|
591
630
|
* resource queries, see <a href="https://docs.aws.amazon.com/ARG/latest/userguide/gettingstarted-query.html#gettingstarted-query-cli-tag">Create
|
|
592
631
|
* a tag-based group in Resource Groups</a>.</p>
|
|
@@ -598,6 +637,7 @@ export interface GetGroupQueryOutput {
|
|
|
598
637
|
*/
|
|
599
638
|
export interface GetTagsInput {
|
|
600
639
|
/**
|
|
640
|
+
* @public
|
|
601
641
|
* <p>The ARN of the resource group whose tags you want to retrieve.</p>
|
|
602
642
|
*/
|
|
603
643
|
Arn: string | undefined;
|
|
@@ -607,10 +647,12 @@ export interface GetTagsInput {
|
|
|
607
647
|
*/
|
|
608
648
|
export interface GetTagsOutput {
|
|
609
649
|
/**
|
|
650
|
+
* @public
|
|
610
651
|
* <p>The ARN of the tagged resource group.</p>
|
|
611
652
|
*/
|
|
612
653
|
Arn?: string;
|
|
613
654
|
/**
|
|
655
|
+
* @public
|
|
614
656
|
* <p>The tags associated with the specified resource group.</p>
|
|
615
657
|
*/
|
|
616
658
|
Tags?: Record<string, string>;
|
|
@@ -620,10 +662,12 @@ export interface GetTagsOutput {
|
|
|
620
662
|
*/
|
|
621
663
|
export interface GroupResourcesInput {
|
|
622
664
|
/**
|
|
665
|
+
* @public
|
|
623
666
|
* <p>The name or the ARN of the resource group to add resources to.</p>
|
|
624
667
|
*/
|
|
625
668
|
Group: string | undefined;
|
|
626
669
|
/**
|
|
670
|
+
* @public
|
|
627
671
|
* <p>The list of ARNs of the resources to be added to the group. </p>
|
|
628
672
|
*/
|
|
629
673
|
ResourceArns: string[] | undefined;
|
|
@@ -634,14 +678,17 @@ export interface GroupResourcesInput {
|
|
|
634
678
|
*/
|
|
635
679
|
export interface FailedResource {
|
|
636
680
|
/**
|
|
681
|
+
* @public
|
|
637
682
|
* <p>The ARN of the resource that failed to be added or removed.</p>
|
|
638
683
|
*/
|
|
639
684
|
ResourceArn?: string;
|
|
640
685
|
/**
|
|
686
|
+
* @public
|
|
641
687
|
* <p>The error message text associated with the failure.</p>
|
|
642
688
|
*/
|
|
643
689
|
ErrorMessage?: string;
|
|
644
690
|
/**
|
|
691
|
+
* @public
|
|
645
692
|
* <p>The error code associated with the failure.</p>
|
|
646
693
|
*/
|
|
647
694
|
ErrorCode?: string;
|
|
@@ -654,6 +701,7 @@ export interface FailedResource {
|
|
|
654
701
|
*/
|
|
655
702
|
export interface PendingResource {
|
|
656
703
|
/**
|
|
704
|
+
* @public
|
|
657
705
|
* <p>The Amazon resource name (ARN) of the resource that's in a pending state.</p>
|
|
658
706
|
*/
|
|
659
707
|
ResourceArn?: string;
|
|
@@ -663,15 +711,18 @@ export interface PendingResource {
|
|
|
663
711
|
*/
|
|
664
712
|
export interface GroupResourcesOutput {
|
|
665
713
|
/**
|
|
714
|
+
* @public
|
|
666
715
|
* <p>A list of ARNs of the resources that this operation successfully added to the
|
|
667
716
|
* group.</p>
|
|
668
717
|
*/
|
|
669
718
|
Succeeded?: string[];
|
|
670
719
|
/**
|
|
720
|
+
* @public
|
|
671
721
|
* <p>A list of ARNs of any resources that this operation failed to add to the group.</p>
|
|
672
722
|
*/
|
|
673
723
|
Failed?: FailedResource[];
|
|
674
724
|
/**
|
|
725
|
+
* @public
|
|
675
726
|
* <p>A list of ARNs of any resources that this operation is still in the process adding to
|
|
676
727
|
* the group. These pending additions continue asynchronously. You can check the status of
|
|
677
728
|
* pending additions by using the <code>
|
|
@@ -700,10 +751,12 @@ export type ResourceFilterName = (typeof ResourceFilterName)[keyof typeof Resour
|
|
|
700
751
|
*/
|
|
701
752
|
export interface ResourceFilter {
|
|
702
753
|
/**
|
|
754
|
+
* @public
|
|
703
755
|
* <p>The name of the filter. Filter names are case-sensitive.</p>
|
|
704
756
|
*/
|
|
705
757
|
Name: ResourceFilterName | string | undefined;
|
|
706
758
|
/**
|
|
759
|
+
* @public
|
|
707
760
|
* <p>One or more filter values. Allowed filter values vary by resource filter name, and are
|
|
708
761
|
* case-sensitive.</p>
|
|
709
762
|
*/
|
|
@@ -714,6 +767,7 @@ export interface ResourceFilter {
|
|
|
714
767
|
*/
|
|
715
768
|
export interface ListGroupResourcesInput {
|
|
716
769
|
/**
|
|
770
|
+
* @public
|
|
717
771
|
* @deprecated
|
|
718
772
|
*
|
|
719
773
|
* <important>
|
|
@@ -727,10 +781,12 @@ export interface ListGroupResourcesInput {
|
|
|
727
781
|
*/
|
|
728
782
|
GroupName?: string;
|
|
729
783
|
/**
|
|
784
|
+
* @public
|
|
730
785
|
* <p>The name or the ARN of the resource group</p>
|
|
731
786
|
*/
|
|
732
787
|
Group?: string;
|
|
733
788
|
/**
|
|
789
|
+
* @public
|
|
734
790
|
* <p>Filters, formatted as <a>ResourceFilter</a> objects, that you want to apply
|
|
735
791
|
* to a <code>ListGroupResources</code> operation. Filters the results to include only
|
|
736
792
|
* those of the specified resource types.</p>
|
|
@@ -763,6 +819,7 @@ export interface ListGroupResourcesInput {
|
|
|
763
819
|
*/
|
|
764
820
|
Filters?: ResourceFilter[];
|
|
765
821
|
/**
|
|
822
|
+
* @public
|
|
766
823
|
* <p>The total number of results that you want included on each page of the
|
|
767
824
|
* response. If you do not include this parameter, it defaults to a value that is specific to the
|
|
768
825
|
* operation. If additional items exist beyond the maximum you specify, the <code>NextToken</code>
|
|
@@ -774,6 +831,7 @@ export interface ListGroupResourcesInput {
|
|
|
774
831
|
*/
|
|
775
832
|
MaxResults?: number;
|
|
776
833
|
/**
|
|
834
|
+
* @public
|
|
777
835
|
* <p>The parameter for receiving additional results if you receive a
|
|
778
836
|
* <code>NextToken</code> response in a previous request. A <code>NextToken</code> response
|
|
779
837
|
* indicates that more output is available. Set this parameter to the value provided by a previous
|
|
@@ -805,10 +863,12 @@ export type QueryErrorCode = (typeof QueryErrorCode)[keyof typeof QueryErrorCode
|
|
|
805
863
|
*/
|
|
806
864
|
export interface QueryError {
|
|
807
865
|
/**
|
|
866
|
+
* @public
|
|
808
867
|
* <p>Specifies the error code that was raised.</p>
|
|
809
868
|
*/
|
|
810
869
|
ErrorCode?: QueryErrorCode | string;
|
|
811
870
|
/**
|
|
871
|
+
* @public
|
|
812
872
|
* <p>A message that explains the <code>ErrorCode</code> value. Messages might state that
|
|
813
873
|
* the specified CloudFront stack does not exist (or no longer exists). For
|
|
814
874
|
* <code>CLOUDFORMATION_STACK_INACTIVE</code>, the message typically states that the
|
|
@@ -823,10 +883,12 @@ export interface QueryError {
|
|
|
823
883
|
*/
|
|
824
884
|
export interface ResourceIdentifier {
|
|
825
885
|
/**
|
|
886
|
+
* @public
|
|
826
887
|
* <p>The ARN of a resource.</p>
|
|
827
888
|
*/
|
|
828
889
|
ResourceArn?: string;
|
|
829
890
|
/**
|
|
891
|
+
* @public
|
|
830
892
|
* <p>The resource type of a resource, such as <code>AWS::EC2::Instance</code>.</p>
|
|
831
893
|
*/
|
|
832
894
|
ResourceType?: string;
|
|
@@ -851,6 +913,7 @@ export type ResourceStatusValue = (typeof ResourceStatusValue)[keyof typeof Reso
|
|
|
851
913
|
*/
|
|
852
914
|
export interface ResourceStatus {
|
|
853
915
|
/**
|
|
916
|
+
* @public
|
|
854
917
|
* <p>The current status.</p>
|
|
855
918
|
*/
|
|
856
919
|
Name?: ResourceStatusValue | string;
|
|
@@ -863,10 +926,12 @@ export interface ResourceStatus {
|
|
|
863
926
|
*/
|
|
864
927
|
export interface ListGroupResourcesItem {
|
|
865
928
|
/**
|
|
929
|
+
* @public
|
|
866
930
|
* <p>A structure that contains the ARN of a resource and its resource type.</p>
|
|
867
931
|
*/
|
|
868
932
|
Identifier?: ResourceIdentifier;
|
|
869
933
|
/**
|
|
934
|
+
* @public
|
|
870
935
|
* <p>A structure that contains the status of this resource's membership in the
|
|
871
936
|
* group.</p>
|
|
872
937
|
* <note>
|
|
@@ -881,11 +946,13 @@ export interface ListGroupResourcesItem {
|
|
|
881
946
|
*/
|
|
882
947
|
export interface ListGroupResourcesOutput {
|
|
883
948
|
/**
|
|
949
|
+
* @public
|
|
884
950
|
* <p>An array of resources from which you can determine each resource's identity, type, and
|
|
885
951
|
* group membership status.</p>
|
|
886
952
|
*/
|
|
887
953
|
Resources?: ListGroupResourcesItem[];
|
|
888
954
|
/**
|
|
955
|
+
* @public
|
|
889
956
|
* @deprecated
|
|
890
957
|
*
|
|
891
958
|
* <important>
|
|
@@ -900,6 +967,7 @@ export interface ListGroupResourcesOutput {
|
|
|
900
967
|
*/
|
|
901
968
|
ResourceIdentifiers?: ResourceIdentifier[];
|
|
902
969
|
/**
|
|
970
|
+
* @public
|
|
903
971
|
* <p>If present, indicates that more output is available than is
|
|
904
972
|
* included in the current response. Use this value in the <code>NextToken</code> request parameter
|
|
905
973
|
* in a subsequent call to the operation to get the next part of the output. You should repeat this
|
|
@@ -907,6 +975,7 @@ export interface ListGroupResourcesOutput {
|
|
|
907
975
|
*/
|
|
908
976
|
NextToken?: string;
|
|
909
977
|
/**
|
|
978
|
+
* @public
|
|
910
979
|
* <p>A list of <code>QueryError</code> objects. Each error is an object that contains
|
|
911
980
|
* <code>ErrorCode</code> and <code>Message</code> structures. Possible values for
|
|
912
981
|
* <code>ErrorCode</code> are <code>CLOUDFORMATION_STACK_INACTIVE</code> and
|
|
@@ -947,10 +1016,12 @@ export type GroupFilterName = (typeof GroupFilterName)[keyof typeof GroupFilterN
|
|
|
947
1016
|
*/
|
|
948
1017
|
export interface GroupFilter {
|
|
949
1018
|
/**
|
|
1019
|
+
* @public
|
|
950
1020
|
* <p>The name of the filter. Filter names are case-sensitive.</p>
|
|
951
1021
|
*/
|
|
952
1022
|
Name: GroupFilterName | string | undefined;
|
|
953
1023
|
/**
|
|
1024
|
+
* @public
|
|
954
1025
|
* <p>One or more filter values. Allowed filter values vary by group filter name, and are
|
|
955
1026
|
* case-sensitive.</p>
|
|
956
1027
|
*/
|
|
@@ -961,6 +1032,7 @@ export interface GroupFilter {
|
|
|
961
1032
|
*/
|
|
962
1033
|
export interface ListGroupsInput {
|
|
963
1034
|
/**
|
|
1035
|
+
* @public
|
|
964
1036
|
* <p>Filters, formatted as <a>GroupFilter</a> objects, that you want to apply to
|
|
965
1037
|
* a <code>ListGroups</code> operation.</p>
|
|
966
1038
|
* <ul>
|
|
@@ -995,6 +1067,7 @@ export interface ListGroupsInput {
|
|
|
995
1067
|
*/
|
|
996
1068
|
Filters?: GroupFilter[];
|
|
997
1069
|
/**
|
|
1070
|
+
* @public
|
|
998
1071
|
* <p>The total number of results that you want included on each page of the
|
|
999
1072
|
* response. If you do not include this parameter, it defaults to a value that is specific to the
|
|
1000
1073
|
* operation. If additional items exist beyond the maximum you specify, the <code>NextToken</code>
|
|
@@ -1006,6 +1079,7 @@ export interface ListGroupsInput {
|
|
|
1006
1079
|
*/
|
|
1007
1080
|
MaxResults?: number;
|
|
1008
1081
|
/**
|
|
1082
|
+
* @public
|
|
1009
1083
|
* <p>The parameter for receiving additional results if you receive a
|
|
1010
1084
|
* <code>NextToken</code> response in a previous request. A <code>NextToken</code> response
|
|
1011
1085
|
* indicates that more output is available. Set this parameter to the value provided by a previous
|
|
@@ -1019,10 +1093,12 @@ export interface ListGroupsInput {
|
|
|
1019
1093
|
*/
|
|
1020
1094
|
export interface GroupIdentifier {
|
|
1021
1095
|
/**
|
|
1096
|
+
* @public
|
|
1022
1097
|
* <p>The name of the resource group.</p>
|
|
1023
1098
|
*/
|
|
1024
1099
|
GroupName?: string;
|
|
1025
1100
|
/**
|
|
1101
|
+
* @public
|
|
1026
1102
|
* <p>The ARN of the resource group.</p>
|
|
1027
1103
|
*/
|
|
1028
1104
|
GroupArn?: string;
|
|
@@ -1032,11 +1108,13 @@ export interface GroupIdentifier {
|
|
|
1032
1108
|
*/
|
|
1033
1109
|
export interface ListGroupsOutput {
|
|
1034
1110
|
/**
|
|
1111
|
+
* @public
|
|
1035
1112
|
* <p>A list of <a>GroupIdentifier</a> objects. Each identifier is an object that
|
|
1036
1113
|
* contains both the <code>Name</code> and the <code>GroupArn</code>.</p>
|
|
1037
1114
|
*/
|
|
1038
1115
|
GroupIdentifiers?: GroupIdentifier[];
|
|
1039
1116
|
/**
|
|
1117
|
+
* @public
|
|
1040
1118
|
* @deprecated
|
|
1041
1119
|
*
|
|
1042
1120
|
* <important>
|
|
@@ -1051,6 +1129,7 @@ export interface ListGroupsOutput {
|
|
|
1051
1129
|
*/
|
|
1052
1130
|
Groups?: Group[];
|
|
1053
1131
|
/**
|
|
1132
|
+
* @public
|
|
1054
1133
|
* <p>If present, indicates that more output is available than is
|
|
1055
1134
|
* included in the current response. Use this value in the <code>NextToken</code> request parameter
|
|
1056
1135
|
* in a subsequent call to the operation to get the next part of the output. You should repeat this
|
|
@@ -1063,11 +1142,13 @@ export interface ListGroupsOutput {
|
|
|
1063
1142
|
*/
|
|
1064
1143
|
export interface PutGroupConfigurationInput {
|
|
1065
1144
|
/**
|
|
1145
|
+
* @public
|
|
1066
1146
|
* <p>The name or ARN of the resource group with the configuration that you want to
|
|
1067
1147
|
* update.</p>
|
|
1068
1148
|
*/
|
|
1069
1149
|
Group?: string;
|
|
1070
1150
|
/**
|
|
1151
|
+
* @public
|
|
1071
1152
|
* <p>The new configuration to associate with the specified group. A configuration
|
|
1072
1153
|
* associates the resource group with an Amazon Web Services service and specifies how the service can
|
|
1073
1154
|
* interact with the resources in the group. A configuration is an array of <a>GroupConfigurationItem</a> elements.</p>
|
|
@@ -1090,11 +1171,13 @@ export interface PutGroupConfigurationOutput {
|
|
|
1090
1171
|
*/
|
|
1091
1172
|
export interface SearchResourcesInput {
|
|
1092
1173
|
/**
|
|
1174
|
+
* @public
|
|
1093
1175
|
* <p>The search query, using the same formats that are supported for resource group
|
|
1094
1176
|
* definition. For more information, see <a>CreateGroup</a>.</p>
|
|
1095
1177
|
*/
|
|
1096
1178
|
ResourceQuery: ResourceQuery | undefined;
|
|
1097
1179
|
/**
|
|
1180
|
+
* @public
|
|
1098
1181
|
* <p>The total number of results that you want included on each page of the
|
|
1099
1182
|
* response. If you do not include this parameter, it defaults to a value that is specific to the
|
|
1100
1183
|
* operation. If additional items exist beyond the maximum you specify, the <code>NextToken</code>
|
|
@@ -1106,6 +1189,7 @@ export interface SearchResourcesInput {
|
|
|
1106
1189
|
*/
|
|
1107
1190
|
MaxResults?: number;
|
|
1108
1191
|
/**
|
|
1192
|
+
* @public
|
|
1109
1193
|
* <p>The parameter for receiving additional results if you receive a
|
|
1110
1194
|
* <code>NextToken</code> response in a previous request. A <code>NextToken</code> response
|
|
1111
1195
|
* indicates that more output is available. Set this parameter to the value provided by a previous
|
|
@@ -1118,11 +1202,13 @@ export interface SearchResourcesInput {
|
|
|
1118
1202
|
*/
|
|
1119
1203
|
export interface SearchResourcesOutput {
|
|
1120
1204
|
/**
|
|
1205
|
+
* @public
|
|
1121
1206
|
* <p>The ARNs and resource types of resources that are members of the group that you
|
|
1122
1207
|
* specified.</p>
|
|
1123
1208
|
*/
|
|
1124
1209
|
ResourceIdentifiers?: ResourceIdentifier[];
|
|
1125
1210
|
/**
|
|
1211
|
+
* @public
|
|
1126
1212
|
* <p>If present, indicates that more output is available than is
|
|
1127
1213
|
* included in the current response. Use this value in the <code>NextToken</code> request parameter
|
|
1128
1214
|
* in a subsequent call to the operation to get the next part of the output. You should repeat this
|
|
@@ -1130,6 +1216,7 @@ export interface SearchResourcesOutput {
|
|
|
1130
1216
|
*/
|
|
1131
1217
|
NextToken?: string;
|
|
1132
1218
|
/**
|
|
1219
|
+
* @public
|
|
1133
1220
|
* <p>A list of <code>QueryError</code> objects. Each error is an object that contains
|
|
1134
1221
|
* <code>ErrorCode</code> and <code>Message</code> structures.</p>
|
|
1135
1222
|
* <p>Possible values for <code>ErrorCode</code>:</p>
|
|
@@ -1153,10 +1240,12 @@ export interface SearchResourcesOutput {
|
|
|
1153
1240
|
*/
|
|
1154
1241
|
export interface TagInput {
|
|
1155
1242
|
/**
|
|
1243
|
+
* @public
|
|
1156
1244
|
* <p>The ARN of the resource group to which to add tags.</p>
|
|
1157
1245
|
*/
|
|
1158
1246
|
Arn: string | undefined;
|
|
1159
1247
|
/**
|
|
1248
|
+
* @public
|
|
1160
1249
|
* <p>The tags to add to the specified resource group. A tag is a string-to-string map of
|
|
1161
1250
|
* key-value pairs.</p>
|
|
1162
1251
|
*/
|
|
@@ -1167,10 +1256,12 @@ export interface TagInput {
|
|
|
1167
1256
|
*/
|
|
1168
1257
|
export interface TagOutput {
|
|
1169
1258
|
/**
|
|
1259
|
+
* @public
|
|
1170
1260
|
* <p>The ARN of the tagged resource.</p>
|
|
1171
1261
|
*/
|
|
1172
1262
|
Arn?: string;
|
|
1173
1263
|
/**
|
|
1264
|
+
* @public
|
|
1174
1265
|
* <p>The tags that have been added to the specified resource group.</p>
|
|
1175
1266
|
*/
|
|
1176
1267
|
Tags?: Record<string, string>;
|
|
@@ -1180,10 +1271,12 @@ export interface TagOutput {
|
|
|
1180
1271
|
*/
|
|
1181
1272
|
export interface UngroupResourcesInput {
|
|
1182
1273
|
/**
|
|
1274
|
+
* @public
|
|
1183
1275
|
* <p>The name or the ARN of the resource group from which to remove the resources.</p>
|
|
1184
1276
|
*/
|
|
1185
1277
|
Group: string | undefined;
|
|
1186
1278
|
/**
|
|
1279
|
+
* @public
|
|
1187
1280
|
* <p>The ARNs of the resources to be removed from the group.</p>
|
|
1188
1281
|
*/
|
|
1189
1282
|
ResourceArns: string[] | undefined;
|
|
@@ -1193,16 +1286,19 @@ export interface UngroupResourcesInput {
|
|
|
1193
1286
|
*/
|
|
1194
1287
|
export interface UngroupResourcesOutput {
|
|
1195
1288
|
/**
|
|
1289
|
+
* @public
|
|
1196
1290
|
* <p>A list of resources that were successfully removed from the group by this
|
|
1197
1291
|
* operation.</p>
|
|
1198
1292
|
*/
|
|
1199
1293
|
Succeeded?: string[];
|
|
1200
1294
|
/**
|
|
1295
|
+
* @public
|
|
1201
1296
|
* <p>A list of any resources that failed to be removed from the group by this
|
|
1202
1297
|
* operation.</p>
|
|
1203
1298
|
*/
|
|
1204
1299
|
Failed?: FailedResource[];
|
|
1205
1300
|
/**
|
|
1301
|
+
* @public
|
|
1206
1302
|
* <p>A list of any resources that are still in the process of being removed from the group
|
|
1207
1303
|
* by this operation. These pending removals continue asynchronously. You can check the
|
|
1208
1304
|
* status of pending removals by using the <code>
|
|
@@ -1217,11 +1313,13 @@ export interface UngroupResourcesOutput {
|
|
|
1217
1313
|
*/
|
|
1218
1314
|
export interface UntagInput {
|
|
1219
1315
|
/**
|
|
1316
|
+
* @public
|
|
1220
1317
|
* <p>The ARN of the resource group from which to remove tags. The command removed both the
|
|
1221
1318
|
* specified keys and any values associated with those keys.</p>
|
|
1222
1319
|
*/
|
|
1223
1320
|
Arn: string | undefined;
|
|
1224
1321
|
/**
|
|
1322
|
+
* @public
|
|
1225
1323
|
* <p>The keys of the tags to be removed.</p>
|
|
1226
1324
|
*/
|
|
1227
1325
|
Keys: string[] | undefined;
|
|
@@ -1231,10 +1329,12 @@ export interface UntagInput {
|
|
|
1231
1329
|
*/
|
|
1232
1330
|
export interface UntagOutput {
|
|
1233
1331
|
/**
|
|
1332
|
+
* @public
|
|
1234
1333
|
* <p>The ARN of the resource group from which tags have been removed.</p>
|
|
1235
1334
|
*/
|
|
1236
1335
|
Arn?: string;
|
|
1237
1336
|
/**
|
|
1337
|
+
* @public
|
|
1238
1338
|
* <p>The keys of the tags that were removed.</p>
|
|
1239
1339
|
*/
|
|
1240
1340
|
Keys?: string[];
|
|
@@ -1244,6 +1344,7 @@ export interface UntagOutput {
|
|
|
1244
1344
|
*/
|
|
1245
1345
|
export interface UpdateAccountSettingsInput {
|
|
1246
1346
|
/**
|
|
1347
|
+
* @public
|
|
1247
1348
|
* <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>
|
|
1248
1349
|
*/
|
|
1249
1350
|
GroupLifecycleEventsDesiredStatus?: GroupLifecycleEventsDesiredStatus | string;
|
|
@@ -1253,6 +1354,7 @@ export interface UpdateAccountSettingsInput {
|
|
|
1253
1354
|
*/
|
|
1254
1355
|
export interface UpdateAccountSettingsOutput {
|
|
1255
1356
|
/**
|
|
1357
|
+
* @public
|
|
1256
1358
|
* <p>A structure that displays the status of the optional features in the account.</p>
|
|
1257
1359
|
*/
|
|
1258
1360
|
AccountSettings?: AccountSettings;
|
|
@@ -1262,16 +1364,19 @@ export interface UpdateAccountSettingsOutput {
|
|
|
1262
1364
|
*/
|
|
1263
1365
|
export interface UpdateGroupInput {
|
|
1264
1366
|
/**
|
|
1367
|
+
* @public
|
|
1265
1368
|
* @deprecated
|
|
1266
1369
|
*
|
|
1267
1370
|
* <p>Don't use this parameter. Use <code>Group</code> instead.</p>
|
|
1268
1371
|
*/
|
|
1269
1372
|
GroupName?: string;
|
|
1270
1373
|
/**
|
|
1374
|
+
* @public
|
|
1271
1375
|
* <p>The name or the ARN of the resource group to modify.</p>
|
|
1272
1376
|
*/
|
|
1273
1377
|
Group?: string;
|
|
1274
1378
|
/**
|
|
1379
|
+
* @public
|
|
1275
1380
|
* <p>The new description that you want to update the resource group with. Descriptions can
|
|
1276
1381
|
* contain letters, numbers, hyphens, underscores, periods, and spaces.</p>
|
|
1277
1382
|
*/
|
|
@@ -1282,6 +1387,7 @@ export interface UpdateGroupInput {
|
|
|
1282
1387
|
*/
|
|
1283
1388
|
export interface UpdateGroupOutput {
|
|
1284
1389
|
/**
|
|
1390
|
+
* @public
|
|
1285
1391
|
* <p>The update description of the resource group.</p>
|
|
1286
1392
|
*/
|
|
1287
1393
|
Group?: Group;
|
|
@@ -1291,16 +1397,19 @@ export interface UpdateGroupOutput {
|
|
|
1291
1397
|
*/
|
|
1292
1398
|
export interface UpdateGroupQueryInput {
|
|
1293
1399
|
/**
|
|
1400
|
+
* @public
|
|
1294
1401
|
* @deprecated
|
|
1295
1402
|
*
|
|
1296
1403
|
* <p>Don't use this parameter. Use <code>Group</code> instead.</p>
|
|
1297
1404
|
*/
|
|
1298
1405
|
GroupName?: string;
|
|
1299
1406
|
/**
|
|
1407
|
+
* @public
|
|
1300
1408
|
* <p>The name or the ARN of the resource group to query.</p>
|
|
1301
1409
|
*/
|
|
1302
1410
|
Group?: string;
|
|
1303
1411
|
/**
|
|
1412
|
+
* @public
|
|
1304
1413
|
* <p>The resource query to determine which Amazon Web Services resources are members of this resource
|
|
1305
1414
|
* group.</p>
|
|
1306
1415
|
* <note>
|
|
@@ -1315,6 +1424,7 @@ export interface UpdateGroupQueryInput {
|
|
|
1315
1424
|
*/
|
|
1316
1425
|
export interface UpdateGroupQueryOutput {
|
|
1317
1426
|
/**
|
|
1427
|
+
* @public
|
|
1318
1428
|
* <p>The updated resource query associated with the resource group after the update.</p>
|
|
1319
1429
|
*/
|
|
1320
1430
|
GroupQuery?: GroupQuery;
|
package/package.json
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@aws-sdk/client-resource-groups",
|
|
3
3
|
"description": "AWS SDK for JavaScript Resource Groups Client for Node.js, Browser and React Native",
|
|
4
|
-
"version": "3.
|
|
4
|
+
"version": "3.382.0",
|
|
5
5
|
"scripts": {
|
|
6
6
|
"build": "concurrently 'yarn:build:cjs' 'yarn:build:es' 'yarn:build:types'",
|
|
7
7
|
"build:cjs": "tsc -p tsconfig.cjs.json",
|
|
@@ -21,15 +21,15 @@
|
|
|
21
21
|
"dependencies": {
|
|
22
22
|
"@aws-crypto/sha256-browser": "3.0.0",
|
|
23
23
|
"@aws-crypto/sha256-js": "3.0.0",
|
|
24
|
-
"@aws-sdk/client-sts": "3.
|
|
25
|
-
"@aws-sdk/credential-provider-node": "3.
|
|
24
|
+
"@aws-sdk/client-sts": "3.382.0",
|
|
25
|
+
"@aws-sdk/credential-provider-node": "3.382.0",
|
|
26
26
|
"@aws-sdk/middleware-host-header": "3.379.1",
|
|
27
27
|
"@aws-sdk/middleware-logger": "3.378.0",
|
|
28
28
|
"@aws-sdk/middleware-recursion-detection": "3.378.0",
|
|
29
29
|
"@aws-sdk/middleware-signing": "3.379.1",
|
|
30
|
-
"@aws-sdk/middleware-user-agent": "3.
|
|
30
|
+
"@aws-sdk/middleware-user-agent": "3.382.0",
|
|
31
31
|
"@aws-sdk/types": "3.378.0",
|
|
32
|
-
"@aws-sdk/util-endpoints": "3.
|
|
32
|
+
"@aws-sdk/util-endpoints": "3.382.0",
|
|
33
33
|
"@aws-sdk/util-user-agent-browser": "3.378.0",
|
|
34
34
|
"@aws-sdk/util-user-agent-node": "3.378.0",
|
|
35
35
|
"@smithy/config-resolver": "^2.0.1",
|