aws-sdk-resourcegroups 1.72.0 → 1.73.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/CHANGELOG.md +5 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-resourcegroups/client.rb +399 -41
- data/lib/aws-sdk-resourcegroups/client_api.rb +237 -14
- data/lib/aws-sdk-resourcegroups/endpoints.rb +55 -0
- data/lib/aws-sdk-resourcegroups/plugins/endpoints.rb +10 -0
- data/lib/aws-sdk-resourcegroups/types.rb +575 -43
- data/lib/aws-sdk-resourcegroups.rb +2 -2
- data/sig/client.rbs +89 -3
- data/sig/types.rbs +119 -1
- metadata +2 -2
@@ -49,6 +49,18 @@ module Aws::ResourceGroups
|
|
49
49
|
include Aws::Structure
|
50
50
|
end
|
51
51
|
|
52
|
+
# @!attribute [rw] task_arn
|
53
|
+
# The Amazon resource name (ARN) of the tag-sync task.
|
54
|
+
# @return [String]
|
55
|
+
#
|
56
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/resource-groups-2017-11-27/CancelTagSyncTaskInput AWS API Documentation
|
57
|
+
#
|
58
|
+
class CancelTagSyncTaskInput < Struct.new(
|
59
|
+
:task_arn)
|
60
|
+
SENSITIVE = []
|
61
|
+
include Aws::Structure
|
62
|
+
end
|
63
|
+
|
52
64
|
# @!attribute [rw] name
|
53
65
|
# The name of the group, which is the identifier of the group in other
|
54
66
|
# operations. You can't change the name of a resource group after you
|
@@ -102,6 +114,22 @@ module Aws::ResourceGroups
|
|
102
114
|
# [1]: https://docs.aws.amazon.com/ARG/latest/APIReference/about-slg.html
|
103
115
|
# @return [Array<Types::GroupConfigurationItem>]
|
104
116
|
#
|
117
|
+
# @!attribute [rw] criticality
|
118
|
+
# The critical rank of the application group on a scale of 1 to 10,
|
119
|
+
# with a rank of 1 being the most critical, and a rank of 10 being
|
120
|
+
# least critical.
|
121
|
+
# @return [Integer]
|
122
|
+
#
|
123
|
+
# @!attribute [rw] owner
|
124
|
+
# A name, email address or other identifier for the person or group
|
125
|
+
# who is considered as the owner of this application group within your
|
126
|
+
# organization.
|
127
|
+
# @return [String]
|
128
|
+
#
|
129
|
+
# @!attribute [rw] display_name
|
130
|
+
# The name of the application group, which you can change at any time.
|
131
|
+
# @return [String]
|
132
|
+
#
|
105
133
|
# @see http://docs.aws.amazon.com/goto/WebAPI/resource-groups-2017-11-27/CreateGroupInput AWS API Documentation
|
106
134
|
#
|
107
135
|
class CreateGroupInput < Struct.new(
|
@@ -109,7 +137,10 @@ module Aws::ResourceGroups
|
|
109
137
|
:description,
|
110
138
|
:resource_query,
|
111
139
|
:tags,
|
112
|
-
:configuration
|
140
|
+
:configuration,
|
141
|
+
:criticality,
|
142
|
+
:owner,
|
143
|
+
:display_name)
|
113
144
|
SENSITIVE = []
|
114
145
|
include Aws::Structure
|
115
146
|
end
|
@@ -158,7 +189,8 @@ module Aws::ResourceGroups
|
|
158
189
|
# @return [String]
|
159
190
|
#
|
160
191
|
# @!attribute [rw] group
|
161
|
-
# The name or the ARN of the resource group to
|
192
|
+
# The name or the Amazon resource name (ARN) of the resource group to
|
193
|
+
# delete.
|
162
194
|
# @return [String]
|
163
195
|
#
|
164
196
|
# @see http://docs.aws.amazon.com/goto/WebAPI/resource-groups-2017-11-27/DeleteGroupInput AWS API Documentation
|
@@ -185,7 +217,8 @@ module Aws::ResourceGroups
|
|
185
217
|
# A resource that failed to be added to or removed from a group.
|
186
218
|
#
|
187
219
|
# @!attribute [rw] resource_arn
|
188
|
-
# The ARN of the resource that failed to be
|
220
|
+
# The Amazon resource name (ARN) of the resource that failed to be
|
221
|
+
# added or removed.
|
189
222
|
# @return [String]
|
190
223
|
#
|
191
224
|
# @!attribute [rw] error_message
|
@@ -232,8 +265,8 @@ module Aws::ResourceGroups
|
|
232
265
|
end
|
233
266
|
|
234
267
|
# @!attribute [rw] group
|
235
|
-
# The name or the ARN of the resource group for
|
236
|
-
# retrive the service configuration.
|
268
|
+
# The name or the Amazon resource name (ARN) of the resource group for
|
269
|
+
# which you want to retrive the service configuration.
|
237
270
|
# @return [String]
|
238
271
|
#
|
239
272
|
# @see http://docs.aws.amazon.com/goto/WebAPI/resource-groups-2017-11-27/GetGroupConfigurationInput AWS API Documentation
|
@@ -267,7 +300,8 @@ module Aws::ResourceGroups
|
|
267
300
|
# @return [String]
|
268
301
|
#
|
269
302
|
# @!attribute [rw] group
|
270
|
-
# The name or the ARN of the resource group to
|
303
|
+
# The name or the Amazon resource name (ARN) of the resource group to
|
304
|
+
# retrieve.
|
271
305
|
# @return [String]
|
272
306
|
#
|
273
307
|
# @see http://docs.aws.amazon.com/goto/WebAPI/resource-groups-2017-11-27/GetGroupInput AWS API Documentation
|
@@ -298,7 +332,8 @@ module Aws::ResourceGroups
|
|
298
332
|
# @return [String]
|
299
333
|
#
|
300
334
|
# @!attribute [rw] group
|
301
|
-
# The name or the ARN of the resource group to
|
335
|
+
# The name or the Amazon resource name (ARN) of the resource group to
|
336
|
+
# query.
|
302
337
|
# @return [String]
|
303
338
|
#
|
304
339
|
# @see http://docs.aws.amazon.com/goto/WebAPI/resource-groups-2017-11-27/GetGroupQueryInput AWS API Documentation
|
@@ -328,8 +363,93 @@ module Aws::ResourceGroups
|
|
328
363
|
include Aws::Structure
|
329
364
|
end
|
330
365
|
|
366
|
+
# @!attribute [rw] task_arn
|
367
|
+
# The Amazon resource name (ARN) of the tag-sync task.
|
368
|
+
# @return [String]
|
369
|
+
#
|
370
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/resource-groups-2017-11-27/GetTagSyncTaskInput AWS API Documentation
|
371
|
+
#
|
372
|
+
class GetTagSyncTaskInput < Struct.new(
|
373
|
+
:task_arn)
|
374
|
+
SENSITIVE = []
|
375
|
+
include Aws::Structure
|
376
|
+
end
|
377
|
+
|
378
|
+
# @!attribute [rw] group_arn
|
379
|
+
# The Amazon resource name (ARN) of the application group.
|
380
|
+
# @return [String]
|
381
|
+
#
|
382
|
+
# @!attribute [rw] group_name
|
383
|
+
# The name of the application group.
|
384
|
+
# @return [String]
|
385
|
+
#
|
386
|
+
# @!attribute [rw] task_arn
|
387
|
+
# The Amazon resource name (ARN) of the tag-sync task.
|
388
|
+
# @return [String]
|
389
|
+
#
|
390
|
+
# @!attribute [rw] tag_key
|
391
|
+
# The tag key.
|
392
|
+
# @return [String]
|
393
|
+
#
|
394
|
+
# @!attribute [rw] tag_value
|
395
|
+
# The tag value.
|
396
|
+
# @return [String]
|
397
|
+
#
|
398
|
+
# @!attribute [rw] role_arn
|
399
|
+
# The Amazon resource name (ARN) of the role assumed by Resource
|
400
|
+
# Groups to tag and untag resources on your behalf.
|
401
|
+
#
|
402
|
+
# For more information about this role, review [Tag-sync required
|
403
|
+
# permissions][1].
|
404
|
+
#
|
405
|
+
#
|
406
|
+
#
|
407
|
+
# [1]: https://docs.aws.amazon.com/servicecatalog/latest/arguide/app-tag-sync.html#tag-sync-role
|
408
|
+
# @return [String]
|
409
|
+
#
|
410
|
+
# @!attribute [rw] status
|
411
|
+
# The status of the tag-sync task.
|
412
|
+
#
|
413
|
+
# Valid values include:
|
414
|
+
#
|
415
|
+
# * `ACTIVE` - The tag-sync task is actively managing resources in the
|
416
|
+
# application by adding or removing the `awsApplication` tag from
|
417
|
+
# resources when they are tagged or untagged with the specified tag
|
418
|
+
# key-value pair.
|
419
|
+
#
|
420
|
+
# * `ERROR` - The tag-sync task is not actively managing resources in
|
421
|
+
# the application. Review the `ErrorMessage` for more information
|
422
|
+
# about resolving the error.
|
423
|
+
# @return [String]
|
424
|
+
#
|
425
|
+
# @!attribute [rw] error_message
|
426
|
+
# The specific error message in cases where the tag-sync task status
|
427
|
+
# is `ERROR`.
|
428
|
+
# @return [String]
|
429
|
+
#
|
430
|
+
# @!attribute [rw] created_at
|
431
|
+
# The timestamp of when the tag-sync task was created.
|
432
|
+
# @return [Time]
|
433
|
+
#
|
434
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/resource-groups-2017-11-27/GetTagSyncTaskOutput AWS API Documentation
|
435
|
+
#
|
436
|
+
class GetTagSyncTaskOutput < Struct.new(
|
437
|
+
:group_arn,
|
438
|
+
:group_name,
|
439
|
+
:task_arn,
|
440
|
+
:tag_key,
|
441
|
+
:tag_value,
|
442
|
+
:role_arn,
|
443
|
+
:status,
|
444
|
+
:error_message,
|
445
|
+
:created_at)
|
446
|
+
SENSITIVE = []
|
447
|
+
include Aws::Structure
|
448
|
+
end
|
449
|
+
|
331
450
|
# @!attribute [rw] arn
|
332
|
-
# The ARN of the resource group whose tags you
|
451
|
+
# The Amazon resource name (ARN) of the resource group whose tags you
|
452
|
+
# want to retrieve.
|
333
453
|
# @return [String]
|
334
454
|
#
|
335
455
|
# @see http://docs.aws.amazon.com/goto/WebAPI/resource-groups-2017-11-27/GetTagsInput AWS API Documentation
|
@@ -341,7 +461,7 @@ module Aws::ResourceGroups
|
|
341
461
|
end
|
342
462
|
|
343
463
|
# @!attribute [rw] arn
|
344
|
-
#
|
464
|
+
# TheAmazon resource name (ARN) of the tagged resource group.
|
345
465
|
# @return [String]
|
346
466
|
#
|
347
467
|
# @!attribute [rw] tags
|
@@ -373,7 +493,7 @@ module Aws::ResourceGroups
|
|
373
493
|
# specifies which resource types can be included in the group.
|
374
494
|
#
|
375
495
|
# @!attribute [rw] group_arn
|
376
|
-
# The ARN of the resource group.
|
496
|
+
# The Amazon resource name (ARN) of the resource group.
|
377
497
|
# @return [String]
|
378
498
|
#
|
379
499
|
# @!attribute [rw] name
|
@@ -384,12 +504,37 @@ module Aws::ResourceGroups
|
|
384
504
|
# The description of the resource group.
|
385
505
|
# @return [String]
|
386
506
|
#
|
507
|
+
# @!attribute [rw] criticality
|
508
|
+
# The critical rank of the application group on a scale of 1 to 10,
|
509
|
+
# with a rank of 1 being the most critical, and a rank of 10 being
|
510
|
+
# least critical.
|
511
|
+
# @return [Integer]
|
512
|
+
#
|
513
|
+
# @!attribute [rw] owner
|
514
|
+
# A name, email address or other identifier for the person or group
|
515
|
+
# who is considered as the owner of this application group within your
|
516
|
+
# organization.
|
517
|
+
# @return [String]
|
518
|
+
#
|
519
|
+
# @!attribute [rw] display_name
|
520
|
+
# The name of the application group, which you can change at any time.
|
521
|
+
# @return [String]
|
522
|
+
#
|
523
|
+
# @!attribute [rw] application_tag
|
524
|
+
# A tag that defines the application group membership. This tag is
|
525
|
+
# only supported for application groups.
|
526
|
+
# @return [Hash<String,String>]
|
527
|
+
#
|
387
528
|
# @see http://docs.aws.amazon.com/goto/WebAPI/resource-groups-2017-11-27/Group AWS API Documentation
|
388
529
|
#
|
389
530
|
class Group < Struct.new(
|
390
531
|
:group_arn,
|
391
532
|
:name,
|
392
|
-
:description
|
533
|
+
:description,
|
534
|
+
:criticality,
|
535
|
+
:owner,
|
536
|
+
:display_name,
|
537
|
+
:application_tag)
|
393
538
|
SENSITIVE = []
|
394
539
|
include Aws::Structure
|
395
540
|
end
|
@@ -539,14 +684,38 @@ module Aws::ResourceGroups
|
|
539
684
|
# @return [String]
|
540
685
|
#
|
541
686
|
# @!attribute [rw] group_arn
|
542
|
-
# The ARN of the resource group.
|
687
|
+
# The Amazon resource name (ARN) of the resource group.
|
688
|
+
# @return [String]
|
689
|
+
#
|
690
|
+
# @!attribute [rw] description
|
691
|
+
# The description of the application group.
|
692
|
+
# @return [String]
|
693
|
+
#
|
694
|
+
# @!attribute [rw] criticality
|
695
|
+
# The critical rank of the application group on a scale of 1 to 10,
|
696
|
+
# with a rank of 1 being the most critical, and a rank of 10 being
|
697
|
+
# least critical.
|
698
|
+
# @return [Integer]
|
699
|
+
#
|
700
|
+
# @!attribute [rw] owner
|
701
|
+
# A name, email address or other identifier for the person or group
|
702
|
+
# who is considered as the owner of this group within your
|
703
|
+
# organization.
|
704
|
+
# @return [String]
|
705
|
+
#
|
706
|
+
# @!attribute [rw] display_name
|
707
|
+
# The name of the application group, which you can change at any time.
|
543
708
|
# @return [String]
|
544
709
|
#
|
545
710
|
# @see http://docs.aws.amazon.com/goto/WebAPI/resource-groups-2017-11-27/GroupIdentifier AWS API Documentation
|
546
711
|
#
|
547
712
|
class GroupIdentifier < Struct.new(
|
548
713
|
:group_name,
|
549
|
-
:group_arn
|
714
|
+
:group_arn,
|
715
|
+
:description,
|
716
|
+
:criticality,
|
717
|
+
:owner,
|
718
|
+
:display_name)
|
550
719
|
SENSITIVE = []
|
551
720
|
include Aws::Structure
|
552
721
|
end
|
@@ -574,11 +743,13 @@ module Aws::ResourceGroups
|
|
574
743
|
end
|
575
744
|
|
576
745
|
# @!attribute [rw] group
|
577
|
-
# The name or the ARN of the resource group to
|
746
|
+
# The name or the Amazon resource name (ARN) of the resource group to
|
747
|
+
# add resources to.
|
578
748
|
# @return [String]
|
579
749
|
#
|
580
750
|
# @!attribute [rw] resource_arns
|
581
|
-
# The list of ARNs of the resources to be
|
751
|
+
# The list of Amazon resource names (ARNs) of the resources to be
|
752
|
+
# added to the group.
|
582
753
|
# @return [Array<String>]
|
583
754
|
#
|
584
755
|
# @see http://docs.aws.amazon.com/goto/WebAPI/resource-groups-2017-11-27/GroupResourcesInput AWS API Documentation
|
@@ -591,22 +762,22 @@ module Aws::ResourceGroups
|
|
591
762
|
end
|
592
763
|
|
593
764
|
# @!attribute [rw] succeeded
|
594
|
-
# A list of ARNs of the resources that this
|
595
|
-
# added to the group.
|
765
|
+
# A list of Amazon resource names (ARNs) of the resources that this
|
766
|
+
# operation successfully added to the group.
|
596
767
|
# @return [Array<String>]
|
597
768
|
#
|
598
769
|
# @!attribute [rw] failed
|
599
|
-
# A list of ARNs of any resources that this
|
600
|
-
# the group.
|
770
|
+
# A list of Amazon resource names (ARNs) of any resources that this
|
771
|
+
# operation failed to add to the group.
|
601
772
|
# @return [Array<Types::FailedResource>]
|
602
773
|
#
|
603
774
|
# @!attribute [rw] pending
|
604
|
-
# A list of ARNs of any resources that this
|
605
|
-
# process adding to the group. These pending
|
606
|
-
# asynchronously. You can check the status of
|
607
|
-
# using the ` ListGroupResources ` operation, and
|
608
|
-
# `Resources` array in the response and the `Status`
|
609
|
-
# object in that array.
|
775
|
+
# A list of Amazon resource names (ARNs) of any resources that this
|
776
|
+
# operation is still in the process adding to the group. These pending
|
777
|
+
# additions continue asynchronously. You can check the status of
|
778
|
+
# pending additions by using the ` ListGroupResources ` operation, and
|
779
|
+
# checking the `Resources` array in the response and the `Status`
|
780
|
+
# field of each object in that array.
|
610
781
|
# @return [Array<Types::PendingResource>]
|
611
782
|
#
|
612
783
|
# @see http://docs.aws.amazon.com/goto/WebAPI/resource-groups-2017-11-27/GroupResourcesOutput AWS API Documentation
|
@@ -619,6 +790,47 @@ module Aws::ResourceGroups
|
|
619
790
|
include Aws::Structure
|
620
791
|
end
|
621
792
|
|
793
|
+
# The information about a grouping or ungrouping resource action.
|
794
|
+
#
|
795
|
+
# @!attribute [rw] resource_arn
|
796
|
+
# The Amazon resource name (ARN) of a resource.
|
797
|
+
# @return [String]
|
798
|
+
#
|
799
|
+
# @!attribute [rw] action
|
800
|
+
# Describes the resource grouping action with values of `GROUP` or
|
801
|
+
# `UNGROUP`.
|
802
|
+
# @return [String]
|
803
|
+
#
|
804
|
+
# @!attribute [rw] status
|
805
|
+
# Describes the resource grouping status with values of `SUCCESS`,
|
806
|
+
# `FAILED`, `IN_PROGRESS`, or `SKIPPED`.
|
807
|
+
# @return [String]
|
808
|
+
#
|
809
|
+
# @!attribute [rw] error_message
|
810
|
+
# A message that explains the `ErrorCode`.
|
811
|
+
# @return [String]
|
812
|
+
#
|
813
|
+
# @!attribute [rw] error_code
|
814
|
+
# Specifies the error code that was raised.
|
815
|
+
# @return [String]
|
816
|
+
#
|
817
|
+
# @!attribute [rw] updated_at
|
818
|
+
# A timestamp of when the status was last updated.
|
819
|
+
# @return [Time]
|
820
|
+
#
|
821
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/resource-groups-2017-11-27/GroupingStatusesItem AWS API Documentation
|
822
|
+
#
|
823
|
+
class GroupingStatusesItem < Struct.new(
|
824
|
+
:resource_arn,
|
825
|
+
:action,
|
826
|
+
:status,
|
827
|
+
:error_message,
|
828
|
+
:error_code,
|
829
|
+
:updated_at)
|
830
|
+
SENSITIVE = []
|
831
|
+
include Aws::Structure
|
832
|
+
end
|
833
|
+
|
622
834
|
# An internal error occurred while processing the request. Try again
|
623
835
|
# later.
|
624
836
|
#
|
@@ -639,7 +851,7 @@ module Aws::ResourceGroups
|
|
639
851
|
# @return [String]
|
640
852
|
#
|
641
853
|
# @!attribute [rw] group
|
642
|
-
# The name or the ARN of the resource group
|
854
|
+
# The name or the Amazon resource name (ARN) of the resource group.
|
643
855
|
# @return [String]
|
644
856
|
#
|
645
857
|
# @!attribute [rw] filters
|
@@ -773,6 +985,89 @@ module Aws::ResourceGroups
|
|
773
985
|
include Aws::Structure
|
774
986
|
end
|
775
987
|
|
988
|
+
# A filter name and value pair that is used to obtain more specific
|
989
|
+
# results from the list of grouping statuses.
|
990
|
+
#
|
991
|
+
# @!attribute [rw] name
|
992
|
+
# The name of the filter. Filter names are case-sensitive.
|
993
|
+
# @return [String]
|
994
|
+
#
|
995
|
+
# @!attribute [rw] values
|
996
|
+
# One or more filter values. Allowed filter values vary by resource
|
997
|
+
# filter name, and are case-sensitive.
|
998
|
+
# @return [Array<String>]
|
999
|
+
#
|
1000
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/resource-groups-2017-11-27/ListGroupingStatusesFilter AWS API Documentation
|
1001
|
+
#
|
1002
|
+
class ListGroupingStatusesFilter < Struct.new(
|
1003
|
+
:name,
|
1004
|
+
:values)
|
1005
|
+
SENSITIVE = []
|
1006
|
+
include Aws::Structure
|
1007
|
+
end
|
1008
|
+
|
1009
|
+
# @!attribute [rw] group
|
1010
|
+
# The application group identifier, expressed as an Amazon resource
|
1011
|
+
# name (ARN) or the application group name.
|
1012
|
+
# @return [String]
|
1013
|
+
#
|
1014
|
+
# @!attribute [rw] max_results
|
1015
|
+
# The maximum number of resources and their statuses returned in the
|
1016
|
+
# response.
|
1017
|
+
# @return [Integer]
|
1018
|
+
#
|
1019
|
+
# @!attribute [rw] filters
|
1020
|
+
# The filter name and value pair that is used to return more specific
|
1021
|
+
# results from a list of resources.
|
1022
|
+
# @return [Array<Types::ListGroupingStatusesFilter>]
|
1023
|
+
#
|
1024
|
+
# @!attribute [rw] next_token
|
1025
|
+
# The parameter for receiving additional results if you receive a
|
1026
|
+
# `NextToken` response in a previous request. A `NextToken` response
|
1027
|
+
# indicates that more output is available. Set this parameter to the
|
1028
|
+
# value provided by a previous call's `NextToken` response to
|
1029
|
+
# indicate where the output should continue from.
|
1030
|
+
# @return [String]
|
1031
|
+
#
|
1032
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/resource-groups-2017-11-27/ListGroupingStatusesInput AWS API Documentation
|
1033
|
+
#
|
1034
|
+
class ListGroupingStatusesInput < Struct.new(
|
1035
|
+
:group,
|
1036
|
+
:max_results,
|
1037
|
+
:filters,
|
1038
|
+
:next_token)
|
1039
|
+
SENSITIVE = []
|
1040
|
+
include Aws::Structure
|
1041
|
+
end
|
1042
|
+
|
1043
|
+
# @!attribute [rw] group
|
1044
|
+
# The application group identifier, expressed as an Amazon resource
|
1045
|
+
# name (ARN) or the application group name.
|
1046
|
+
# @return [String]
|
1047
|
+
#
|
1048
|
+
# @!attribute [rw] grouping_statuses
|
1049
|
+
# Returns details about the grouping or ungrouping status of the
|
1050
|
+
# resources in the specified application group.
|
1051
|
+
# @return [Array<Types::GroupingStatusesItem>]
|
1052
|
+
#
|
1053
|
+
# @!attribute [rw] next_token
|
1054
|
+
# If present, indicates that more output is available than is included
|
1055
|
+
# in the current response. Use this value in the `NextToken` request
|
1056
|
+
# parameter in a subsequent call to the operation to get the next part
|
1057
|
+
# of the output. You should repeat this until the `NextToken` response
|
1058
|
+
# element comes back as `null`.
|
1059
|
+
# @return [String]
|
1060
|
+
#
|
1061
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/resource-groups-2017-11-27/ListGroupingStatusesOutput AWS API Documentation
|
1062
|
+
#
|
1063
|
+
class ListGroupingStatusesOutput < Struct.new(
|
1064
|
+
:group,
|
1065
|
+
:grouping_statuses,
|
1066
|
+
:next_token)
|
1067
|
+
SENSITIVE = []
|
1068
|
+
include Aws::Structure
|
1069
|
+
end
|
1070
|
+
|
776
1071
|
# @!attribute [rw] filters
|
777
1072
|
# Filters, formatted as GroupFilter objects, that you want to apply to
|
778
1073
|
# a `ListGroups` operation.
|
@@ -787,6 +1082,8 @@ module Aws::ResourceGroups
|
|
787
1082
|
# groups that have the specified configuration types attached. The
|
788
1083
|
# current supported values are:
|
789
1084
|
#
|
1085
|
+
# * `AWS::ResourceGroups::ApplicationGroup`
|
1086
|
+
#
|
790
1087
|
# * `AWS::AppRegistry::Application`
|
791
1088
|
#
|
792
1089
|
# * `AWS::AppRegistry::ApplicationResourceGroups`
|
@@ -859,6 +1156,74 @@ module Aws::ResourceGroups
|
|
859
1156
|
include Aws::Structure
|
860
1157
|
end
|
861
1158
|
|
1159
|
+
# Returns tag-sync tasks filtered by the Amazon resource name (ARN) or
|
1160
|
+
# name of a specified application group.
|
1161
|
+
#
|
1162
|
+
# @!attribute [rw] group_arn
|
1163
|
+
# The Amazon resource name (ARN) of the application group.
|
1164
|
+
# @return [String]
|
1165
|
+
#
|
1166
|
+
# @!attribute [rw] group_name
|
1167
|
+
# The name of the application group.
|
1168
|
+
# @return [String]
|
1169
|
+
#
|
1170
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/resource-groups-2017-11-27/ListTagSyncTasksFilter AWS API Documentation
|
1171
|
+
#
|
1172
|
+
class ListTagSyncTasksFilter < Struct.new(
|
1173
|
+
:group_arn,
|
1174
|
+
:group_name)
|
1175
|
+
SENSITIVE = []
|
1176
|
+
include Aws::Structure
|
1177
|
+
end
|
1178
|
+
|
1179
|
+
# @!attribute [rw] filters
|
1180
|
+
# The Amazon resource name (ARN) or name of the application group for
|
1181
|
+
# which you want to return a list of tag-sync tasks.
|
1182
|
+
# @return [Array<Types::ListTagSyncTasksFilter>]
|
1183
|
+
#
|
1184
|
+
# @!attribute [rw] max_results
|
1185
|
+
# The maximum number of results to be included in the response.
|
1186
|
+
# @return [Integer]
|
1187
|
+
#
|
1188
|
+
# @!attribute [rw] next_token
|
1189
|
+
# The parameter for receiving additional results if you receive a
|
1190
|
+
# `NextToken` response in a previous request. A `NextToken` response
|
1191
|
+
# indicates that more output is available. Set this parameter to the
|
1192
|
+
# value provided by a previous call's `NextToken` response to
|
1193
|
+
# indicate where the output should continue from.
|
1194
|
+
# @return [String]
|
1195
|
+
#
|
1196
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/resource-groups-2017-11-27/ListTagSyncTasksInput AWS API Documentation
|
1197
|
+
#
|
1198
|
+
class ListTagSyncTasksInput < Struct.new(
|
1199
|
+
:filters,
|
1200
|
+
:max_results,
|
1201
|
+
:next_token)
|
1202
|
+
SENSITIVE = []
|
1203
|
+
include Aws::Structure
|
1204
|
+
end
|
1205
|
+
|
1206
|
+
# @!attribute [rw] tag_sync_tasks
|
1207
|
+
# A list of tag-sync tasks and information about each task.
|
1208
|
+
# @return [Array<Types::TagSyncTaskItem>]
|
1209
|
+
#
|
1210
|
+
# @!attribute [rw] next_token
|
1211
|
+
# If present, indicates that more output is available than is included
|
1212
|
+
# in the current response. Use this value in the `NextToken` request
|
1213
|
+
# parameter in a subsequent call to the operation to get the next part
|
1214
|
+
# of the output. You should repeat this until the `NextToken` response
|
1215
|
+
# element comes back as `null`.
|
1216
|
+
# @return [String]
|
1217
|
+
#
|
1218
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/resource-groups-2017-11-27/ListTagSyncTasksOutput AWS API Documentation
|
1219
|
+
#
|
1220
|
+
class ListTagSyncTasksOutput < Struct.new(
|
1221
|
+
:tag_sync_tasks,
|
1222
|
+
:next_token)
|
1223
|
+
SENSITIVE = []
|
1224
|
+
include Aws::Structure
|
1225
|
+
end
|
1226
|
+
|
862
1227
|
# The request uses an HTTP method that isn't allowed for the specified
|
863
1228
|
# resource.
|
864
1229
|
#
|
@@ -905,8 +1270,8 @@ module Aws::ResourceGroups
|
|
905
1270
|
end
|
906
1271
|
|
907
1272
|
# @!attribute [rw] group
|
908
|
-
# The name or ARN of the resource group with
|
909
|
-
# you want to update.
|
1273
|
+
# The name or Amazon resource name (ARN) of the resource group with
|
1274
|
+
# the configuration that you want to update.
|
910
1275
|
# @return [String]
|
911
1276
|
#
|
912
1277
|
# @!attribute [rw] configuration
|
@@ -986,7 +1351,7 @@ module Aws::ResourceGroups
|
|
986
1351
|
# A structure that contains the ARN of a resource and its resource type.
|
987
1352
|
#
|
988
1353
|
# @!attribute [rw] resource_arn
|
989
|
-
# The ARN of a resource.
|
1354
|
+
# The Amazon resource name (ARN) of a resource.
|
990
1355
|
# @return [String]
|
991
1356
|
#
|
992
1357
|
# @!attribute [rw] resource_type
|
@@ -1041,8 +1406,8 @@ module Aws::ResourceGroups
|
|
1041
1406
|
#
|
1042
1407
|
# * <i> <code>CLOUDFORMATION_STACK_1_0:</code> </i> Specifies that you
|
1043
1408
|
# want the group to contain the members of an CloudFormation stack.
|
1044
|
-
# The `Query` contains a `StackIdentifier` element with an
|
1045
|
-
# CloudFormation stack.
|
1409
|
+
# The `Query` contains a `StackIdentifier` element with an Amazon
|
1410
|
+
# resource name (ARN) for a CloudFormation stack.
|
1046
1411
|
#
|
1047
1412
|
# * <i> <code>TAG_FILTERS_1_0:</code> </i> Specifies that you want the
|
1048
1413
|
# group to include resource that have tags that match the query.
|
@@ -1220,8 +1585,83 @@ module Aws::ResourceGroups
|
|
1220
1585
|
include Aws::Structure
|
1221
1586
|
end
|
1222
1587
|
|
1588
|
+
# @!attribute [rw] group
|
1589
|
+
# The Amazon resource name (ARN) or name of the application group for
|
1590
|
+
# which you want to create a tag-sync task.
|
1591
|
+
# @return [String]
|
1592
|
+
#
|
1593
|
+
# @!attribute [rw] tag_key
|
1594
|
+
# The tag key. Resources tagged with this tag key-value pair will be
|
1595
|
+
# added to the application. If a resource with this tag is later
|
1596
|
+
# untagged, the tag-sync task removes the resource from the
|
1597
|
+
# application.
|
1598
|
+
# @return [String]
|
1599
|
+
#
|
1600
|
+
# @!attribute [rw] tag_value
|
1601
|
+
# The tag value. Resources tagged with this tag key-value pair will be
|
1602
|
+
# added to the application. If a resource with this tag is later
|
1603
|
+
# untagged, the tag-sync task removes the resource from the
|
1604
|
+
# application.
|
1605
|
+
# @return [String]
|
1606
|
+
#
|
1607
|
+
# @!attribute [rw] role_arn
|
1608
|
+
# The Amazon resource name (ARN) of the role assumed by the service to
|
1609
|
+
# tag and untag resources on your behalf.
|
1610
|
+
# @return [String]
|
1611
|
+
#
|
1612
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/resource-groups-2017-11-27/StartTagSyncTaskInput AWS API Documentation
|
1613
|
+
#
|
1614
|
+
class StartTagSyncTaskInput < Struct.new(
|
1615
|
+
:group,
|
1616
|
+
:tag_key,
|
1617
|
+
:tag_value,
|
1618
|
+
:role_arn)
|
1619
|
+
SENSITIVE = []
|
1620
|
+
include Aws::Structure
|
1621
|
+
end
|
1622
|
+
|
1623
|
+
# @!attribute [rw] group_arn
|
1624
|
+
# The Amazon resource name (ARN) of the application group for which
|
1625
|
+
# you want to add or remove resources.
|
1626
|
+
# @return [String]
|
1627
|
+
#
|
1628
|
+
# @!attribute [rw] group_name
|
1629
|
+
# The name of the application group to onboard and sync resources.
|
1630
|
+
# @return [String]
|
1631
|
+
#
|
1632
|
+
# @!attribute [rw] task_arn
|
1633
|
+
# The Amazon resource name (ARN) of the new tag-sync task.
|
1634
|
+
# @return [String]
|
1635
|
+
#
|
1636
|
+
# @!attribute [rw] tag_key
|
1637
|
+
# The tag key of the tag-sync task.
|
1638
|
+
# @return [String]
|
1639
|
+
#
|
1640
|
+
# @!attribute [rw] tag_value
|
1641
|
+
# The tag value of the tag-sync task.
|
1642
|
+
# @return [String]
|
1643
|
+
#
|
1644
|
+
# @!attribute [rw] role_arn
|
1645
|
+
# The Amazon resource name (ARN) of the role assumed by the service to
|
1646
|
+
# tag and untag resources on your behalf.
|
1647
|
+
# @return [String]
|
1648
|
+
#
|
1649
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/resource-groups-2017-11-27/StartTagSyncTaskOutput AWS API Documentation
|
1650
|
+
#
|
1651
|
+
class StartTagSyncTaskOutput < Struct.new(
|
1652
|
+
:group_arn,
|
1653
|
+
:group_name,
|
1654
|
+
:task_arn,
|
1655
|
+
:tag_key,
|
1656
|
+
:tag_value,
|
1657
|
+
:role_arn)
|
1658
|
+
SENSITIVE = []
|
1659
|
+
include Aws::Structure
|
1660
|
+
end
|
1661
|
+
|
1223
1662
|
# @!attribute [rw] arn
|
1224
|
-
# The ARN of the resource group to which to add
|
1663
|
+
# The Amazon resource name (ARN) of the resource group to which to add
|
1664
|
+
# tags.
|
1225
1665
|
# @return [String]
|
1226
1666
|
#
|
1227
1667
|
# @!attribute [rw] tags
|
@@ -1239,7 +1679,7 @@ module Aws::ResourceGroups
|
|
1239
1679
|
end
|
1240
1680
|
|
1241
1681
|
# @!attribute [rw] arn
|
1242
|
-
# The ARN of the tagged resource.
|
1682
|
+
# The Amazon resource name (ARN) of the tagged resource.
|
1243
1683
|
# @return [String]
|
1244
1684
|
#
|
1245
1685
|
# @!attribute [rw] tags
|
@@ -1255,6 +1695,73 @@ module Aws::ResourceGroups
|
|
1255
1695
|
include Aws::Structure
|
1256
1696
|
end
|
1257
1697
|
|
1698
|
+
# The Amazon resource name (ARN) of the tag-sync task.
|
1699
|
+
#
|
1700
|
+
# @!attribute [rw] group_arn
|
1701
|
+
# The Amazon resource name (ARN) of the application group.
|
1702
|
+
# @return [String]
|
1703
|
+
#
|
1704
|
+
# @!attribute [rw] group_name
|
1705
|
+
# The name of the application group.
|
1706
|
+
# @return [String]
|
1707
|
+
#
|
1708
|
+
# @!attribute [rw] task_arn
|
1709
|
+
# The Amazon resource name (ARN) of the tag-sync task.
|
1710
|
+
# @return [String]
|
1711
|
+
#
|
1712
|
+
# @!attribute [rw] tag_key
|
1713
|
+
# The tag key.
|
1714
|
+
# @return [String]
|
1715
|
+
#
|
1716
|
+
# @!attribute [rw] tag_value
|
1717
|
+
# The tag value.
|
1718
|
+
# @return [String]
|
1719
|
+
#
|
1720
|
+
# @!attribute [rw] role_arn
|
1721
|
+
# The Amazon resource name (ARN) of the role assumed by the service to
|
1722
|
+
# tag and untag resources on your behalf.
|
1723
|
+
# @return [String]
|
1724
|
+
#
|
1725
|
+
# @!attribute [rw] status
|
1726
|
+
# The status of the tag-sync task.
|
1727
|
+
#
|
1728
|
+
# Valid values include:
|
1729
|
+
#
|
1730
|
+
# * `ACTIVE` - The tag-sync task is actively managing resources in the
|
1731
|
+
# application by adding or removing the `awsApplication` tag from
|
1732
|
+
# resources when they are tagged or untagged with the specified tag
|
1733
|
+
# key-value pair.
|
1734
|
+
#
|
1735
|
+
# * `ERROR` - The tag-sync task is not actively managing resources in
|
1736
|
+
# the application. Review the `ErrorMessage` for more information
|
1737
|
+
# about resolving the error.
|
1738
|
+
# @return [String]
|
1739
|
+
#
|
1740
|
+
# @!attribute [rw] error_message
|
1741
|
+
# The specific error message in cases where the tag-sync task status
|
1742
|
+
# is `Error`.
|
1743
|
+
# @return [String]
|
1744
|
+
#
|
1745
|
+
# @!attribute [rw] created_at
|
1746
|
+
# The timestamp of when the tag-sync task was created.
|
1747
|
+
# @return [Time]
|
1748
|
+
#
|
1749
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/resource-groups-2017-11-27/TagSyncTaskItem AWS API Documentation
|
1750
|
+
#
|
1751
|
+
class TagSyncTaskItem < Struct.new(
|
1752
|
+
:group_arn,
|
1753
|
+
:group_name,
|
1754
|
+
:task_arn,
|
1755
|
+
:tag_key,
|
1756
|
+
:tag_value,
|
1757
|
+
:role_arn,
|
1758
|
+
:status,
|
1759
|
+
:error_message,
|
1760
|
+
:created_at)
|
1761
|
+
SENSITIVE = []
|
1762
|
+
include Aws::Structure
|
1763
|
+
end
|
1764
|
+
|
1258
1765
|
# You've exceeded throttling limits by making too many requests in a
|
1259
1766
|
# period of time.
|
1260
1767
|
#
|
@@ -1284,12 +1791,13 @@ module Aws::ResourceGroups
|
|
1284
1791
|
end
|
1285
1792
|
|
1286
1793
|
# @!attribute [rw] group
|
1287
|
-
# The name or the ARN of the resource group
|
1288
|
-
# resources.
|
1794
|
+
# The name or the Amazon resource name (ARN) of the resource group
|
1795
|
+
# from which to remove the resources.
|
1289
1796
|
# @return [String]
|
1290
1797
|
#
|
1291
1798
|
# @!attribute [rw] resource_arns
|
1292
|
-
# The ARNs of the resources to be removed from
|
1799
|
+
# The Amazon resource names (ARNs) of the resources to be removed from
|
1800
|
+
# the group.
|
1293
1801
|
# @return [Array<String>]
|
1294
1802
|
#
|
1295
1803
|
# @see http://docs.aws.amazon.com/goto/WebAPI/resource-groups-2017-11-27/UngroupResourcesInput AWS API Documentation
|
@@ -1331,9 +1839,9 @@ module Aws::ResourceGroups
|
|
1331
1839
|
end
|
1332
1840
|
|
1333
1841
|
# @!attribute [rw] arn
|
1334
|
-
# The ARN of the resource group from which to
|
1335
|
-
# removed both the specified keys and any
|
1336
|
-
# keys.
|
1842
|
+
# The Amazon resource name (ARN) of the resource group from which to
|
1843
|
+
# remove tags. The command removed both the specified keys and any
|
1844
|
+
# values associated with those keys.
|
1337
1845
|
# @return [String]
|
1338
1846
|
#
|
1339
1847
|
# @!attribute [rw] keys
|
@@ -1350,7 +1858,8 @@ module Aws::ResourceGroups
|
|
1350
1858
|
end
|
1351
1859
|
|
1352
1860
|
# @!attribute [rw] arn
|
1353
|
-
# The ARN of the resource group from which tags
|
1861
|
+
# The Amazon resource name (ARN) of the resource group from which tags
|
1862
|
+
# have been removed.
|
1354
1863
|
# @return [String]
|
1355
1864
|
#
|
1356
1865
|
# @!attribute [rw] keys
|
@@ -1370,6 +1879,9 @@ module Aws::ResourceGroups
|
|
1370
1879
|
# Specifies whether you want to turn [group lifecycle events][1] on or
|
1371
1880
|
# off.
|
1372
1881
|
#
|
1882
|
+
# You can't turn on group lifecycle events if your resource groups
|
1883
|
+
# quota is greater than 2,000.
|
1884
|
+
#
|
1373
1885
|
#
|
1374
1886
|
#
|
1375
1887
|
# [1]: https://docs.aws.amazon.com/ARG/latest/userguide/monitor-groups.html
|
@@ -1401,7 +1913,7 @@ module Aws::ResourceGroups
|
|
1401
1913
|
# @return [String]
|
1402
1914
|
#
|
1403
1915
|
# @!attribute [rw] group
|
1404
|
-
# The name or the ARN of the resource group to
|
1916
|
+
# The name or the ARN of the resource group to update.
|
1405
1917
|
# @return [String]
|
1406
1918
|
#
|
1407
1919
|
# @!attribute [rw] description
|
@@ -1410,12 +1922,31 @@ module Aws::ResourceGroups
|
|
1410
1922
|
# periods, and spaces.
|
1411
1923
|
# @return [String]
|
1412
1924
|
#
|
1925
|
+
# @!attribute [rw] criticality
|
1926
|
+
# The critical rank of the application group on a scale of 1 to 10,
|
1927
|
+
# with a rank of 1 being the most critical, and a rank of 10 being
|
1928
|
+
# least critical.
|
1929
|
+
# @return [Integer]
|
1930
|
+
#
|
1931
|
+
# @!attribute [rw] owner
|
1932
|
+
# A name, email address or other identifier for the person or group
|
1933
|
+
# who is considered as the owner of this application group within your
|
1934
|
+
# organization.
|
1935
|
+
# @return [String]
|
1936
|
+
#
|
1937
|
+
# @!attribute [rw] display_name
|
1938
|
+
# The name of the application group, which you can change at any time.
|
1939
|
+
# @return [String]
|
1940
|
+
#
|
1413
1941
|
# @see http://docs.aws.amazon.com/goto/WebAPI/resource-groups-2017-11-27/UpdateGroupInput AWS API Documentation
|
1414
1942
|
#
|
1415
1943
|
class UpdateGroupInput < Struct.new(
|
1416
1944
|
:group_name,
|
1417
1945
|
:group,
|
1418
|
-
:description
|
1946
|
+
:description,
|
1947
|
+
:criticality,
|
1948
|
+
:owner,
|
1949
|
+
:display_name)
|
1419
1950
|
SENSITIVE = []
|
1420
1951
|
include Aws::Structure
|
1421
1952
|
end
|
@@ -1437,7 +1968,8 @@ module Aws::ResourceGroups
|
|
1437
1968
|
# @return [String]
|
1438
1969
|
#
|
1439
1970
|
# @!attribute [rw] group
|
1440
|
-
# The name or the ARN of the resource group to
|
1971
|
+
# The name or the Amazon resource name (ARN) of the resource group to
|
1972
|
+
# query.
|
1441
1973
|
# @return [String]
|
1442
1974
|
#
|
1443
1975
|
# @!attribute [rw] resource_query
|