aws-sdk-resourcegroups 1.72.0 → 1.73.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.
- 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
@@ -447,6 +447,36 @@ module Aws::ResourceGroups
|
|
447
447
|
|
448
448
|
# @!group API Operations
|
449
449
|
|
450
|
+
# Cancels the specified tag-sync task.
|
451
|
+
#
|
452
|
+
# **Minimum permissions**
|
453
|
+
#
|
454
|
+
# To run this command, you must have the following permissions:
|
455
|
+
#
|
456
|
+
# * `resource-groups:CancelTagSyncTask` on the application group
|
457
|
+
#
|
458
|
+
# * `resource-groups:DeleteGroup`
|
459
|
+
#
|
460
|
+
# @option params [required, String] :task_arn
|
461
|
+
# The Amazon resource name (ARN) of the tag-sync task.
|
462
|
+
#
|
463
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
464
|
+
#
|
465
|
+
# @example Request syntax with placeholder values
|
466
|
+
#
|
467
|
+
# resp = client.cancel_tag_sync_task({
|
468
|
+
# task_arn: "TagSyncTaskArn", # required
|
469
|
+
# })
|
470
|
+
#
|
471
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/resource-groups-2017-11-27/CancelTagSyncTask AWS API Documentation
|
472
|
+
#
|
473
|
+
# @overload cancel_tag_sync_task(params = {})
|
474
|
+
# @param [Hash] params ({})
|
475
|
+
def cancel_tag_sync_task(params = {}, options = {})
|
476
|
+
req = build_request(:cancel_tag_sync_task, params)
|
477
|
+
req.send_request(options)
|
478
|
+
end
|
479
|
+
|
450
480
|
# Creates a resource group with the specified name and description. You
|
451
481
|
# can optionally include either a resource query or a service
|
452
482
|
# configuration. For more information about constructing a resource
|
@@ -515,6 +545,19 @@ module Aws::ResourceGroups
|
|
515
545
|
#
|
516
546
|
# [1]: https://docs.aws.amazon.com/ARG/latest/APIReference/about-slg.html
|
517
547
|
#
|
548
|
+
# @option params [Integer] :criticality
|
549
|
+
# The critical rank of the application group on a scale of 1 to 10, with
|
550
|
+
# a rank of 1 being the most critical, and a rank of 10 being least
|
551
|
+
# critical.
|
552
|
+
#
|
553
|
+
# @option params [String] :owner
|
554
|
+
# A name, email address or other identifier for the person or group who
|
555
|
+
# is considered as the owner of this application group within your
|
556
|
+
# organization.
|
557
|
+
#
|
558
|
+
# @option params [String] :display_name
|
559
|
+
# The name of the application group, which you can change at any time.
|
560
|
+
#
|
518
561
|
# @return [Types::CreateGroupOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
519
562
|
#
|
520
563
|
# * {Types::CreateGroupOutput#group #group} => Types::Group
|
@@ -525,7 +568,7 @@ module Aws::ResourceGroups
|
|
525
568
|
# @example Request syntax with placeholder values
|
526
569
|
#
|
527
570
|
# resp = client.create_group({
|
528
|
-
# name: "
|
571
|
+
# name: "CreateGroupName", # required
|
529
572
|
# description: "Description",
|
530
573
|
# resource_query: {
|
531
574
|
# type: "TAG_FILTERS_1_0", # required, accepts TAG_FILTERS_1_0, CLOUDFORMATION_STACK_1_0
|
@@ -545,6 +588,9 @@ module Aws::ResourceGroups
|
|
545
588
|
# ],
|
546
589
|
# },
|
547
590
|
# ],
|
591
|
+
# criticality: 1,
|
592
|
+
# owner: "Owner",
|
593
|
+
# display_name: "DisplayName",
|
548
594
|
# })
|
549
595
|
#
|
550
596
|
# @example Response structure
|
@@ -552,6 +598,11 @@ module Aws::ResourceGroups
|
|
552
598
|
# resp.group.group_arn #=> String
|
553
599
|
# resp.group.name #=> String
|
554
600
|
# resp.group.description #=> String
|
601
|
+
# resp.group.criticality #=> Integer
|
602
|
+
# resp.group.owner #=> String
|
603
|
+
# resp.group.display_name #=> String
|
604
|
+
# resp.group.application_tag #=> Hash
|
605
|
+
# resp.group.application_tag["ApplicationTagKey"] #=> String
|
555
606
|
# resp.resource_query.type #=> String, one of "TAG_FILTERS_1_0", "CLOUDFORMATION_STACK_1_0"
|
556
607
|
# resp.resource_query.query #=> String
|
557
608
|
# resp.tags #=> Hash
|
@@ -596,7 +647,8 @@ module Aws::ResourceGroups
|
|
596
647
|
# Deprecated - don't use this parameter. Use `Group` instead.
|
597
648
|
#
|
598
649
|
# @option params [String] :group
|
599
|
-
# The name or the ARN of the resource group to
|
650
|
+
# The name or the Amazon resource name (ARN) of the resource group to
|
651
|
+
# delete.
|
600
652
|
#
|
601
653
|
# @return [Types::DeleteGroupOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
602
654
|
#
|
@@ -606,7 +658,7 @@ module Aws::ResourceGroups
|
|
606
658
|
#
|
607
659
|
# resp = client.delete_group({
|
608
660
|
# group_name: "GroupName",
|
609
|
-
# group: "
|
661
|
+
# group: "GroupStringV2",
|
610
662
|
# })
|
611
663
|
#
|
612
664
|
# @example Response structure
|
@@ -614,6 +666,11 @@ module Aws::ResourceGroups
|
|
614
666
|
# resp.group.group_arn #=> String
|
615
667
|
# resp.group.name #=> String
|
616
668
|
# resp.group.description #=> String
|
669
|
+
# resp.group.criticality #=> Integer
|
670
|
+
# resp.group.owner #=> String
|
671
|
+
# resp.group.display_name #=> String
|
672
|
+
# resp.group.application_tag #=> Hash
|
673
|
+
# resp.group.application_tag["ApplicationTagKey"] #=> String
|
617
674
|
#
|
618
675
|
# @see http://docs.aws.amazon.com/goto/WebAPI/resource-groups-2017-11-27/DeleteGroup AWS API Documentation
|
619
676
|
#
|
@@ -659,7 +716,8 @@ module Aws::ResourceGroups
|
|
659
716
|
# Deprecated - don't use this parameter. Use `Group` instead.
|
660
717
|
#
|
661
718
|
# @option params [String] :group
|
662
|
-
# The name or the ARN of the resource group to
|
719
|
+
# The name or the Amazon resource name (ARN) of the resource group to
|
720
|
+
# retrieve.
|
663
721
|
#
|
664
722
|
# @return [Types::GetGroupOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
665
723
|
#
|
@@ -669,7 +727,7 @@ module Aws::ResourceGroups
|
|
669
727
|
#
|
670
728
|
# resp = client.get_group({
|
671
729
|
# group_name: "GroupName",
|
672
|
-
# group: "
|
730
|
+
# group: "GroupStringV2",
|
673
731
|
# })
|
674
732
|
#
|
675
733
|
# @example Response structure
|
@@ -677,6 +735,11 @@ module Aws::ResourceGroups
|
|
677
735
|
# resp.group.group_arn #=> String
|
678
736
|
# resp.group.name #=> String
|
679
737
|
# resp.group.description #=> String
|
738
|
+
# resp.group.criticality #=> Integer
|
739
|
+
# resp.group.owner #=> String
|
740
|
+
# resp.group.display_name #=> String
|
741
|
+
# resp.group.application_tag #=> Hash
|
742
|
+
# resp.group.application_tag["ApplicationTagKey"] #=> String
|
680
743
|
#
|
681
744
|
# @see http://docs.aws.amazon.com/goto/WebAPI/resource-groups-2017-11-27/GetGroup AWS API Documentation
|
682
745
|
#
|
@@ -704,8 +767,8 @@ module Aws::ResourceGroups
|
|
704
767
|
# [1]: https://docs.aws.amazon.com/ARG/latest/APIReference/about-slg.html
|
705
768
|
#
|
706
769
|
# @option params [String] :group
|
707
|
-
# The name or the ARN of the resource group for
|
708
|
-
# retrive the service configuration.
|
770
|
+
# The name or the Amazon resource name (ARN) of the resource group for
|
771
|
+
# which you want to retrive the service configuration.
|
709
772
|
#
|
710
773
|
# @return [Types::GetGroupConfigurationOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
711
774
|
#
|
@@ -763,7 +826,8 @@ module Aws::ResourceGroups
|
|
763
826
|
# Don't use this parameter. Use `Group` instead.
|
764
827
|
#
|
765
828
|
# @option params [String] :group
|
766
|
-
# The name or the ARN of the resource group to
|
829
|
+
# The name or the Amazon resource name (ARN) of the resource group to
|
830
|
+
# query.
|
767
831
|
#
|
768
832
|
# @return [Types::GetGroupQueryOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
769
833
|
#
|
@@ -791,8 +855,60 @@ module Aws::ResourceGroups
|
|
791
855
|
req.send_request(options)
|
792
856
|
end
|
793
857
|
|
858
|
+
# Returns information about a specified tag-sync task.
|
859
|
+
#
|
860
|
+
# **Minimum permissions**
|
861
|
+
#
|
862
|
+
# To run this command, you must have the following permissions:
|
863
|
+
#
|
864
|
+
# * `resource-groups:GetTagSyncTask` on the application group
|
865
|
+
#
|
866
|
+
# ^
|
867
|
+
#
|
868
|
+
# @option params [required, String] :task_arn
|
869
|
+
# The Amazon resource name (ARN) of the tag-sync task.
|
870
|
+
#
|
871
|
+
# @return [Types::GetTagSyncTaskOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
872
|
+
#
|
873
|
+
# * {Types::GetTagSyncTaskOutput#group_arn #group_arn} => String
|
874
|
+
# * {Types::GetTagSyncTaskOutput#group_name #group_name} => String
|
875
|
+
# * {Types::GetTagSyncTaskOutput#task_arn #task_arn} => String
|
876
|
+
# * {Types::GetTagSyncTaskOutput#tag_key #tag_key} => String
|
877
|
+
# * {Types::GetTagSyncTaskOutput#tag_value #tag_value} => String
|
878
|
+
# * {Types::GetTagSyncTaskOutput#role_arn #role_arn} => String
|
879
|
+
# * {Types::GetTagSyncTaskOutput#status #status} => String
|
880
|
+
# * {Types::GetTagSyncTaskOutput#error_message #error_message} => String
|
881
|
+
# * {Types::GetTagSyncTaskOutput#created_at #created_at} => Time
|
882
|
+
#
|
883
|
+
# @example Request syntax with placeholder values
|
884
|
+
#
|
885
|
+
# resp = client.get_tag_sync_task({
|
886
|
+
# task_arn: "TagSyncTaskArn", # required
|
887
|
+
# })
|
888
|
+
#
|
889
|
+
# @example Response structure
|
890
|
+
#
|
891
|
+
# resp.group_arn #=> String
|
892
|
+
# resp.group_name #=> String
|
893
|
+
# resp.task_arn #=> String
|
894
|
+
# resp.tag_key #=> String
|
895
|
+
# resp.tag_value #=> String
|
896
|
+
# resp.role_arn #=> String
|
897
|
+
# resp.status #=> String, one of "ACTIVE", "ERROR"
|
898
|
+
# resp.error_message #=> String
|
899
|
+
# resp.created_at #=> Time
|
900
|
+
#
|
901
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/resource-groups-2017-11-27/GetTagSyncTask AWS API Documentation
|
902
|
+
#
|
903
|
+
# @overload get_tag_sync_task(params = {})
|
904
|
+
# @param [Hash] params ({})
|
905
|
+
def get_tag_sync_task(params = {}, options = {})
|
906
|
+
req = build_request(:get_tag_sync_task, params)
|
907
|
+
req.send_request(options)
|
908
|
+
end
|
909
|
+
|
794
910
|
# Returns a list of tags that are associated with a resource group,
|
795
|
-
# specified by an ARN.
|
911
|
+
# specified by an Amazon resource name (ARN).
|
796
912
|
#
|
797
913
|
# **Minimum permissions**
|
798
914
|
#
|
@@ -803,7 +919,8 @@ module Aws::ResourceGroups
|
|
803
919
|
# ^
|
804
920
|
#
|
805
921
|
# @option params [required, String] :arn
|
806
|
-
# The ARN of the resource group whose tags you
|
922
|
+
# The Amazon resource name (ARN) of the resource group whose tags you
|
923
|
+
# want to retrieve.
|
807
924
|
#
|
808
925
|
# @return [Types::GetTagsOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
809
926
|
#
|
@@ -813,7 +930,7 @@ module Aws::ResourceGroups
|
|
813
930
|
# @example Request syntax with placeholder values
|
814
931
|
#
|
815
932
|
# resp = client.get_tags({
|
816
|
-
# arn: "
|
933
|
+
# arn: "GroupArnV2", # required
|
817
934
|
# })
|
818
935
|
#
|
819
936
|
# @example Response structure
|
@@ -833,14 +950,15 @@ module Aws::ResourceGroups
|
|
833
950
|
|
834
951
|
# Adds the specified resources to the specified group.
|
835
952
|
#
|
836
|
-
# You can use this operation with
|
837
|
-
# configured with the following types:
|
953
|
+
# You can only use this operation with the following groups:
|
838
954
|
#
|
839
955
|
# * `AWS::EC2::HostManagement`
|
840
956
|
#
|
841
957
|
# * `AWS::EC2::CapacityReservationPool`
|
842
958
|
#
|
843
|
-
#
|
959
|
+
# * `AWS::ResourceGroups::ApplicationGroup`
|
960
|
+
#
|
961
|
+
# Other resource group types and resource types are not currently
|
844
962
|
# supported by this operation.
|
845
963
|
#
|
846
964
|
# **Minimum permissions**
|
@@ -852,10 +970,12 @@ module Aws::ResourceGroups
|
|
852
970
|
# ^
|
853
971
|
#
|
854
972
|
# @option params [required, String] :group
|
855
|
-
# The name or the ARN of the resource group to
|
973
|
+
# The name or the Amazon resource name (ARN) of the resource group to
|
974
|
+
# add resources to.
|
856
975
|
#
|
857
976
|
# @option params [required, Array<String>] :resource_arns
|
858
|
-
# The list of ARNs of the resources to be added
|
977
|
+
# The list of Amazon resource names (ARNs) of the resources to be added
|
978
|
+
# to the group.
|
859
979
|
#
|
860
980
|
# @return [Types::GroupResourcesOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
861
981
|
#
|
@@ -866,7 +986,7 @@ module Aws::ResourceGroups
|
|
866
986
|
# @example Request syntax with placeholder values
|
867
987
|
#
|
868
988
|
# resp = client.group_resources({
|
869
|
-
# group: "
|
989
|
+
# group: "GroupStringV2", # required
|
870
990
|
# resource_arns: ["ResourceArn"], # required
|
871
991
|
# })
|
872
992
|
#
|
@@ -890,8 +1010,8 @@ module Aws::ResourceGroups
|
|
890
1010
|
req.send_request(options)
|
891
1011
|
end
|
892
1012
|
|
893
|
-
# Returns a list of ARNs of the resources that
|
894
|
-
# specified resource group.
|
1013
|
+
# Returns a list of Amazon resource names (ARNs) of the resources that
|
1014
|
+
# are members of a specified resource group.
|
895
1015
|
#
|
896
1016
|
# **Minimum permissions**
|
897
1017
|
#
|
@@ -910,7 +1030,7 @@ module Aws::ResourceGroups
|
|
910
1030
|
# <code>Group</code> request field instead.</b> </i>
|
911
1031
|
#
|
912
1032
|
# @option params [String] :group
|
913
|
-
# The name or the ARN of the resource group
|
1033
|
+
# The name or the Amazon resource name (ARN) of the resource group.
|
914
1034
|
#
|
915
1035
|
# @option params [Array<Types::ResourceFilter>] :filters
|
916
1036
|
# Filters, formatted as ResourceFilter objects, that you want to apply
|
@@ -974,7 +1094,7 @@ module Aws::ResourceGroups
|
|
974
1094
|
#
|
975
1095
|
# resp = client.list_group_resources({
|
976
1096
|
# group_name: "GroupName",
|
977
|
-
# group: "
|
1097
|
+
# group: "GroupStringV2",
|
978
1098
|
# filters: [
|
979
1099
|
# {
|
980
1100
|
# name: "resource-type", # required, accepts resource-type
|
@@ -1008,6 +1128,71 @@ module Aws::ResourceGroups
|
|
1008
1128
|
req.send_request(options)
|
1009
1129
|
end
|
1010
1130
|
|
1131
|
+
# Returns the status of the last grouping or ungrouping action for each
|
1132
|
+
# resource in the specified application group.
|
1133
|
+
#
|
1134
|
+
# @option params [required, String] :group
|
1135
|
+
# The application group identifier, expressed as an Amazon resource name
|
1136
|
+
# (ARN) or the application group name.
|
1137
|
+
#
|
1138
|
+
# @option params [Integer] :max_results
|
1139
|
+
# The maximum number of resources and their statuses returned in the
|
1140
|
+
# response.
|
1141
|
+
#
|
1142
|
+
# @option params [Array<Types::ListGroupingStatusesFilter>] :filters
|
1143
|
+
# The filter name and value pair that is used to return more specific
|
1144
|
+
# results from a list of resources.
|
1145
|
+
#
|
1146
|
+
# @option params [String] :next_token
|
1147
|
+
# The parameter for receiving additional results if you receive a
|
1148
|
+
# `NextToken` response in a previous request. A `NextToken` response
|
1149
|
+
# indicates that more output is available. Set this parameter to the
|
1150
|
+
# value provided by a previous call's `NextToken` response to indicate
|
1151
|
+
# where the output should continue from.
|
1152
|
+
#
|
1153
|
+
# @return [Types::ListGroupingStatusesOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1154
|
+
#
|
1155
|
+
# * {Types::ListGroupingStatusesOutput#group #group} => String
|
1156
|
+
# * {Types::ListGroupingStatusesOutput#grouping_statuses #grouping_statuses} => Array<Types::GroupingStatusesItem>
|
1157
|
+
# * {Types::ListGroupingStatusesOutput#next_token #next_token} => String
|
1158
|
+
#
|
1159
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
1160
|
+
#
|
1161
|
+
# @example Request syntax with placeholder values
|
1162
|
+
#
|
1163
|
+
# resp = client.list_grouping_statuses({
|
1164
|
+
# group: "GroupStringV2", # required
|
1165
|
+
# max_results: 1,
|
1166
|
+
# filters: [
|
1167
|
+
# {
|
1168
|
+
# name: "status", # required, accepts status, resource-arn
|
1169
|
+
# values: ["ListGroupingStatusesFilterValue"], # required
|
1170
|
+
# },
|
1171
|
+
# ],
|
1172
|
+
# next_token: "NextToken",
|
1173
|
+
# })
|
1174
|
+
#
|
1175
|
+
# @example Response structure
|
1176
|
+
#
|
1177
|
+
# resp.group #=> String
|
1178
|
+
# resp.grouping_statuses #=> Array
|
1179
|
+
# resp.grouping_statuses[0].resource_arn #=> String
|
1180
|
+
# resp.grouping_statuses[0].action #=> String, one of "GROUP", "UNGROUP"
|
1181
|
+
# resp.grouping_statuses[0].status #=> String, one of "SUCCESS", "FAILED", "IN_PROGRESS", "SKIPPED"
|
1182
|
+
# resp.grouping_statuses[0].error_message #=> String
|
1183
|
+
# resp.grouping_statuses[0].error_code #=> String
|
1184
|
+
# resp.grouping_statuses[0].updated_at #=> Time
|
1185
|
+
# resp.next_token #=> String
|
1186
|
+
#
|
1187
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/resource-groups-2017-11-27/ListGroupingStatuses AWS API Documentation
|
1188
|
+
#
|
1189
|
+
# @overload list_grouping_statuses(params = {})
|
1190
|
+
# @param [Hash] params ({})
|
1191
|
+
def list_grouping_statuses(params = {}, options = {})
|
1192
|
+
req = build_request(:list_grouping_statuses, params)
|
1193
|
+
req.send_request(options)
|
1194
|
+
end
|
1195
|
+
|
1011
1196
|
# Returns a list of existing Resource Groups in your account.
|
1012
1197
|
#
|
1013
1198
|
# **Minimum permissions**
|
@@ -1032,6 +1217,8 @@ module Aws::ResourceGroups
|
|
1032
1217
|
# groups that have the specified configuration types attached. The
|
1033
1218
|
# current supported values are:
|
1034
1219
|
#
|
1220
|
+
# * `AWS::ResourceGroups::ApplicationGroup`
|
1221
|
+
#
|
1035
1222
|
# * `AWS::AppRegistry::Application`
|
1036
1223
|
#
|
1037
1224
|
# * `AWS::AppRegistry::ApplicationResourceGroups`
|
@@ -1076,7 +1263,7 @@ module Aws::ResourceGroups
|
|
1076
1263
|
# resp = client.list_groups({
|
1077
1264
|
# filters: [
|
1078
1265
|
# {
|
1079
|
-
# name: "resource-type", # required, accepts resource-type, configuration-type
|
1266
|
+
# name: "resource-type", # required, accepts resource-type, configuration-type, owner, display-name, criticality
|
1080
1267
|
# values: ["GroupFilterValue"], # required
|
1081
1268
|
# },
|
1082
1269
|
# ],
|
@@ -1089,10 +1276,19 @@ module Aws::ResourceGroups
|
|
1089
1276
|
# resp.group_identifiers #=> Array
|
1090
1277
|
# resp.group_identifiers[0].group_name #=> String
|
1091
1278
|
# resp.group_identifiers[0].group_arn #=> String
|
1279
|
+
# resp.group_identifiers[0].description #=> String
|
1280
|
+
# resp.group_identifiers[0].criticality #=> Integer
|
1281
|
+
# resp.group_identifiers[0].owner #=> String
|
1282
|
+
# resp.group_identifiers[0].display_name #=> String
|
1092
1283
|
# resp.groups #=> Array
|
1093
1284
|
# resp.groups[0].group_arn #=> String
|
1094
1285
|
# resp.groups[0].name #=> String
|
1095
1286
|
# resp.groups[0].description #=> String
|
1287
|
+
# resp.groups[0].criticality #=> Integer
|
1288
|
+
# resp.groups[0].owner #=> String
|
1289
|
+
# resp.groups[0].display_name #=> String
|
1290
|
+
# resp.groups[0].application_tag #=> Hash
|
1291
|
+
# resp.groups[0].application_tag["ApplicationTagKey"] #=> String
|
1096
1292
|
# resp.next_token #=> String
|
1097
1293
|
#
|
1098
1294
|
# @see http://docs.aws.amazon.com/goto/WebAPI/resource-groups-2017-11-27/ListGroups AWS API Documentation
|
@@ -1104,6 +1300,74 @@ module Aws::ResourceGroups
|
|
1104
1300
|
req.send_request(options)
|
1105
1301
|
end
|
1106
1302
|
|
1303
|
+
# Returns a list of tag-sync tasks.
|
1304
|
+
#
|
1305
|
+
# **Minimum permissions**
|
1306
|
+
#
|
1307
|
+
# To run this command, you must have the following permissions:
|
1308
|
+
#
|
1309
|
+
# * `resource-groups:ListTagSyncTasks` with the group passed in the
|
1310
|
+
# filters as the resource or * if using no filters
|
1311
|
+
#
|
1312
|
+
# ^
|
1313
|
+
#
|
1314
|
+
# @option params [Array<Types::ListTagSyncTasksFilter>] :filters
|
1315
|
+
# The Amazon resource name (ARN) or name of the application group for
|
1316
|
+
# which you want to return a list of tag-sync tasks.
|
1317
|
+
#
|
1318
|
+
# @option params [Integer] :max_results
|
1319
|
+
# The maximum number of results to be included in the response.
|
1320
|
+
#
|
1321
|
+
# @option params [String] :next_token
|
1322
|
+
# The parameter for receiving additional results if you receive a
|
1323
|
+
# `NextToken` response in a previous request. A `NextToken` response
|
1324
|
+
# indicates that more output is available. Set this parameter to the
|
1325
|
+
# value provided by a previous call's `NextToken` response to indicate
|
1326
|
+
# where the output should continue from.
|
1327
|
+
#
|
1328
|
+
# @return [Types::ListTagSyncTasksOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1329
|
+
#
|
1330
|
+
# * {Types::ListTagSyncTasksOutput#tag_sync_tasks #tag_sync_tasks} => Array<Types::TagSyncTaskItem>
|
1331
|
+
# * {Types::ListTagSyncTasksOutput#next_token #next_token} => String
|
1332
|
+
#
|
1333
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
1334
|
+
#
|
1335
|
+
# @example Request syntax with placeholder values
|
1336
|
+
#
|
1337
|
+
# resp = client.list_tag_sync_tasks({
|
1338
|
+
# filters: [
|
1339
|
+
# {
|
1340
|
+
# group_arn: "GroupArnV2",
|
1341
|
+
# group_name: "GroupName",
|
1342
|
+
# },
|
1343
|
+
# ],
|
1344
|
+
# max_results: 1,
|
1345
|
+
# next_token: "NextToken",
|
1346
|
+
# })
|
1347
|
+
#
|
1348
|
+
# @example Response structure
|
1349
|
+
#
|
1350
|
+
# resp.tag_sync_tasks #=> Array
|
1351
|
+
# resp.tag_sync_tasks[0].group_arn #=> String
|
1352
|
+
# resp.tag_sync_tasks[0].group_name #=> String
|
1353
|
+
# resp.tag_sync_tasks[0].task_arn #=> String
|
1354
|
+
# resp.tag_sync_tasks[0].tag_key #=> String
|
1355
|
+
# resp.tag_sync_tasks[0].tag_value #=> String
|
1356
|
+
# resp.tag_sync_tasks[0].role_arn #=> String
|
1357
|
+
# resp.tag_sync_tasks[0].status #=> String, one of "ACTIVE", "ERROR"
|
1358
|
+
# resp.tag_sync_tasks[0].error_message #=> String
|
1359
|
+
# resp.tag_sync_tasks[0].created_at #=> Time
|
1360
|
+
# resp.next_token #=> String
|
1361
|
+
#
|
1362
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/resource-groups-2017-11-27/ListTagSyncTasks AWS API Documentation
|
1363
|
+
#
|
1364
|
+
# @overload list_tag_sync_tasks(params = {})
|
1365
|
+
# @param [Hash] params ({})
|
1366
|
+
def list_tag_sync_tasks(params = {}, options = {})
|
1367
|
+
req = build_request(:list_tag_sync_tasks, params)
|
1368
|
+
req.send_request(options)
|
1369
|
+
end
|
1370
|
+
|
1107
1371
|
# Attaches a service configuration to the specified group. This occurs
|
1108
1372
|
# asynchronously, and can take time to complete. You can use
|
1109
1373
|
# GetGroupConfiguration to check the status of the update.
|
@@ -1117,8 +1381,8 @@ module Aws::ResourceGroups
|
|
1117
1381
|
# ^
|
1118
1382
|
#
|
1119
1383
|
# @option params [String] :group
|
1120
|
-
# The name or ARN of the resource group with the
|
1121
|
-
# want to update.
|
1384
|
+
# The name or Amazon resource name (ARN) of the resource group with the
|
1385
|
+
# configuration that you want to update.
|
1122
1386
|
#
|
1123
1387
|
# @option params [Array<Types::GroupConfigurationItem>] :configuration
|
1124
1388
|
# The new configuration to associate with the specified group. A
|
@@ -1244,9 +1508,76 @@ module Aws::ResourceGroups
|
|
1244
1508
|
req.send_request(options)
|
1245
1509
|
end
|
1246
1510
|
|
1247
|
-
#
|
1248
|
-
# a
|
1249
|
-
#
|
1511
|
+
# Creates a new tag-sync task to onboard and sync resources tagged with
|
1512
|
+
# a specific tag key-value pair to an application.
|
1513
|
+
#
|
1514
|
+
# **Minimum permissions**
|
1515
|
+
#
|
1516
|
+
# To run this command, you must have the following permissions:
|
1517
|
+
#
|
1518
|
+
# * `resource-groups:StartTagSyncTask` on the application group
|
1519
|
+
#
|
1520
|
+
# * `resource-groups:CreateGroup`
|
1521
|
+
#
|
1522
|
+
# * `iam:PassRole` on the role provided in the request
|
1523
|
+
#
|
1524
|
+
# @option params [required, String] :group
|
1525
|
+
# The Amazon resource name (ARN) or name of the application group for
|
1526
|
+
# which you want to create a tag-sync task.
|
1527
|
+
#
|
1528
|
+
# @option params [required, String] :tag_key
|
1529
|
+
# The tag key. Resources tagged with this tag key-value pair will be
|
1530
|
+
# added to the application. If a resource with this tag is later
|
1531
|
+
# untagged, the tag-sync task removes the resource from the application.
|
1532
|
+
#
|
1533
|
+
# @option params [required, String] :tag_value
|
1534
|
+
# The tag value. Resources tagged with this tag key-value pair will be
|
1535
|
+
# added to the application. If a resource with this tag is later
|
1536
|
+
# untagged, the tag-sync task removes the resource from the application.
|
1537
|
+
#
|
1538
|
+
# @option params [required, String] :role_arn
|
1539
|
+
# The Amazon resource name (ARN) of the role assumed by the service to
|
1540
|
+
# tag and untag resources on your behalf.
|
1541
|
+
#
|
1542
|
+
# @return [Types::StartTagSyncTaskOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1543
|
+
#
|
1544
|
+
# * {Types::StartTagSyncTaskOutput#group_arn #group_arn} => String
|
1545
|
+
# * {Types::StartTagSyncTaskOutput#group_name #group_name} => String
|
1546
|
+
# * {Types::StartTagSyncTaskOutput#task_arn #task_arn} => String
|
1547
|
+
# * {Types::StartTagSyncTaskOutput#tag_key #tag_key} => String
|
1548
|
+
# * {Types::StartTagSyncTaskOutput#tag_value #tag_value} => String
|
1549
|
+
# * {Types::StartTagSyncTaskOutput#role_arn #role_arn} => String
|
1550
|
+
#
|
1551
|
+
# @example Request syntax with placeholder values
|
1552
|
+
#
|
1553
|
+
# resp = client.start_tag_sync_task({
|
1554
|
+
# group: "GroupStringV2", # required
|
1555
|
+
# tag_key: "TagKey", # required
|
1556
|
+
# tag_value: "TagValue", # required
|
1557
|
+
# role_arn: "RoleArn", # required
|
1558
|
+
# })
|
1559
|
+
#
|
1560
|
+
# @example Response structure
|
1561
|
+
#
|
1562
|
+
# resp.group_arn #=> String
|
1563
|
+
# resp.group_name #=> String
|
1564
|
+
# resp.task_arn #=> String
|
1565
|
+
# resp.tag_key #=> String
|
1566
|
+
# resp.tag_value #=> String
|
1567
|
+
# resp.role_arn #=> String
|
1568
|
+
#
|
1569
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/resource-groups-2017-11-27/StartTagSyncTask AWS API Documentation
|
1570
|
+
#
|
1571
|
+
# @overload start_tag_sync_task(params = {})
|
1572
|
+
# @param [Hash] params ({})
|
1573
|
+
def start_tag_sync_task(params = {}, options = {})
|
1574
|
+
req = build_request(:start_tag_sync_task, params)
|
1575
|
+
req.send_request(options)
|
1576
|
+
end
|
1577
|
+
|
1578
|
+
# Adds tags to a resource group with the specified Amazon resource name
|
1579
|
+
# (ARN). Existing tags on a resource group are not changed if they are
|
1580
|
+
# not specified in the request parameters.
|
1250
1581
|
#
|
1251
1582
|
# Do not store personally identifiable information (PII) or other
|
1252
1583
|
# confidential or sensitive information in tags. We use tags to provide
|
@@ -1262,7 +1593,8 @@ module Aws::ResourceGroups
|
|
1262
1593
|
# ^
|
1263
1594
|
#
|
1264
1595
|
# @option params [required, String] :arn
|
1265
|
-
# The ARN of the resource group to which to add
|
1596
|
+
# The Amazon resource name (ARN) of the resource group to which to add
|
1597
|
+
# tags.
|
1266
1598
|
#
|
1267
1599
|
# @option params [required, Hash<String,String>] :tags
|
1268
1600
|
# The tags to add to the specified resource group. A tag is a
|
@@ -1276,7 +1608,7 @@ module Aws::ResourceGroups
|
|
1276
1608
|
# @example Request syntax with placeholder values
|
1277
1609
|
#
|
1278
1610
|
# resp = client.tag({
|
1279
|
-
# arn: "
|
1611
|
+
# arn: "GroupArnV2", # required
|
1280
1612
|
# tags: { # required
|
1281
1613
|
# "TagKey" => "TagValue",
|
1282
1614
|
# },
|
@@ -1312,11 +1644,12 @@ module Aws::ResourceGroups
|
|
1312
1644
|
# ^
|
1313
1645
|
#
|
1314
1646
|
# @option params [required, String] :group
|
1315
|
-
# The name or the ARN of the resource group from
|
1316
|
-
# resources.
|
1647
|
+
# The name or the Amazon resource name (ARN) of the resource group from
|
1648
|
+
# which to remove the resources.
|
1317
1649
|
#
|
1318
1650
|
# @option params [required, Array<String>] :resource_arns
|
1319
|
-
# The ARNs of the resources to be removed from
|
1651
|
+
# The Amazon resource names (ARNs) of the resources to be removed from
|
1652
|
+
# the group.
|
1320
1653
|
#
|
1321
1654
|
# @return [Types::UngroupResourcesOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1322
1655
|
#
|
@@ -1327,7 +1660,7 @@ module Aws::ResourceGroups
|
|
1327
1660
|
# @example Request syntax with placeholder values
|
1328
1661
|
#
|
1329
1662
|
# resp = client.ungroup_resources({
|
1330
|
-
# group: "
|
1663
|
+
# group: "GroupStringV2", # required
|
1331
1664
|
# resource_arns: ["ResourceArn"], # required
|
1332
1665
|
# })
|
1333
1666
|
#
|
@@ -1362,9 +1695,9 @@ module Aws::ResourceGroups
|
|
1362
1695
|
# ^
|
1363
1696
|
#
|
1364
1697
|
# @option params [required, String] :arn
|
1365
|
-
# The ARN of the resource group from which to
|
1366
|
-
# removed both the specified keys and any
|
1367
|
-
# keys.
|
1698
|
+
# The Amazon resource name (ARN) of the resource group from which to
|
1699
|
+
# remove tags. The command removed both the specified keys and any
|
1700
|
+
# values associated with those keys.
|
1368
1701
|
#
|
1369
1702
|
# @option params [required, Array<String>] :keys
|
1370
1703
|
# The keys of the tags to be removed.
|
@@ -1377,7 +1710,7 @@ module Aws::ResourceGroups
|
|
1377
1710
|
# @example Request syntax with placeholder values
|
1378
1711
|
#
|
1379
1712
|
# resp = client.untag({
|
1380
|
-
# arn: "
|
1713
|
+
# arn: "GroupArnV2", # required
|
1381
1714
|
# keys: ["TagKey"], # required
|
1382
1715
|
# })
|
1383
1716
|
#
|
@@ -1407,6 +1740,9 @@ module Aws::ResourceGroups
|
|
1407
1740
|
# Specifies whether you want to turn [group lifecycle events][1] on or
|
1408
1741
|
# off.
|
1409
1742
|
#
|
1743
|
+
# You can't turn on group lifecycle events if your resource groups
|
1744
|
+
# quota is greater than 2,000.
|
1745
|
+
#
|
1410
1746
|
#
|
1411
1747
|
#
|
1412
1748
|
# [1]: https://docs.aws.amazon.com/ARG/latest/userguide/monitor-groups.html
|
@@ -1451,13 +1787,26 @@ module Aws::ResourceGroups
|
|
1451
1787
|
# Don't use this parameter. Use `Group` instead.
|
1452
1788
|
#
|
1453
1789
|
# @option params [String] :group
|
1454
|
-
# The name or the ARN of the resource group to
|
1790
|
+
# The name or the ARN of the resource group to update.
|
1455
1791
|
#
|
1456
1792
|
# @option params [String] :description
|
1457
1793
|
# The new description that you want to update the resource group with.
|
1458
1794
|
# Descriptions can contain letters, numbers, hyphens, underscores,
|
1459
1795
|
# periods, and spaces.
|
1460
1796
|
#
|
1797
|
+
# @option params [Integer] :criticality
|
1798
|
+
# The critical rank of the application group on a scale of 1 to 10, with
|
1799
|
+
# a rank of 1 being the most critical, and a rank of 10 being least
|
1800
|
+
# critical.
|
1801
|
+
#
|
1802
|
+
# @option params [String] :owner
|
1803
|
+
# A name, email address or other identifier for the person or group who
|
1804
|
+
# is considered as the owner of this application group within your
|
1805
|
+
# organization.
|
1806
|
+
#
|
1807
|
+
# @option params [String] :display_name
|
1808
|
+
# The name of the application group, which you can change at any time.
|
1809
|
+
#
|
1461
1810
|
# @return [Types::UpdateGroupOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1462
1811
|
#
|
1463
1812
|
# * {Types::UpdateGroupOutput#group #group} => Types::Group
|
@@ -1466,8 +1815,11 @@ module Aws::ResourceGroups
|
|
1466
1815
|
#
|
1467
1816
|
# resp = client.update_group({
|
1468
1817
|
# group_name: "GroupName",
|
1469
|
-
# group: "
|
1818
|
+
# group: "GroupStringV2",
|
1470
1819
|
# description: "Description",
|
1820
|
+
# criticality: 1,
|
1821
|
+
# owner: "Owner",
|
1822
|
+
# display_name: "DisplayName",
|
1471
1823
|
# })
|
1472
1824
|
#
|
1473
1825
|
# @example Response structure
|
@@ -1475,6 +1827,11 @@ module Aws::ResourceGroups
|
|
1475
1827
|
# resp.group.group_arn #=> String
|
1476
1828
|
# resp.group.name #=> String
|
1477
1829
|
# resp.group.description #=> String
|
1830
|
+
# resp.group.criticality #=> Integer
|
1831
|
+
# resp.group.owner #=> String
|
1832
|
+
# resp.group.display_name #=> String
|
1833
|
+
# resp.group.application_tag #=> Hash
|
1834
|
+
# resp.group.application_tag["ApplicationTagKey"] #=> String
|
1478
1835
|
#
|
1479
1836
|
# @see http://docs.aws.amazon.com/goto/WebAPI/resource-groups-2017-11-27/UpdateGroup AWS API Documentation
|
1480
1837
|
#
|
@@ -1505,7 +1862,8 @@ module Aws::ResourceGroups
|
|
1505
1862
|
# Don't use this parameter. Use `Group` instead.
|
1506
1863
|
#
|
1507
1864
|
# @option params [String] :group
|
1508
|
-
# The name or the ARN of the resource group to
|
1865
|
+
# The name or the Amazon resource name (ARN) of the resource group to
|
1866
|
+
# query.
|
1509
1867
|
#
|
1510
1868
|
# @option params [required, Types::ResourceQuery] :resource_query
|
1511
1869
|
# The resource query to determine which Amazon Web Services resources
|
@@ -1564,7 +1922,7 @@ module Aws::ResourceGroups
|
|
1564
1922
|
tracer: tracer
|
1565
1923
|
)
|
1566
1924
|
context[:gem_name] = 'aws-sdk-resourcegroups'
|
1567
|
-
context[:gem_version] = '1.
|
1925
|
+
context[:gem_version] = '1.73.0'
|
1568
1926
|
Seahorse::Client::Request.new(handlers, context)
|
1569
1927
|
end
|
1570
1928
|
|