aws-sdk-resourcegroups 1.26.0 → 1.31.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/lib/aws-sdk-resourcegroups.rb +3 -2
- data/lib/aws-sdk-resourcegroups/client.rb +359 -94
- data/lib/aws-sdk-resourcegroups/client_api.rb +147 -24
- data/lib/aws-sdk-resourcegroups/types.rb +648 -147
- metadata +2 -2
@@ -18,8 +18,14 @@ module Aws::ResourceGroups
|
|
18
18
|
CreateGroupOutput = Shapes::StructureShape.new(name: 'CreateGroupOutput')
|
19
19
|
DeleteGroupInput = Shapes::StructureShape.new(name: 'DeleteGroupInput')
|
20
20
|
DeleteGroupOutput = Shapes::StructureShape.new(name: 'DeleteGroupOutput')
|
21
|
+
Description = Shapes::StringShape.new(name: 'Description')
|
22
|
+
ErrorCode = Shapes::StringShape.new(name: 'ErrorCode')
|
21
23
|
ErrorMessage = Shapes::StringShape.new(name: 'ErrorMessage')
|
24
|
+
FailedResource = Shapes::StructureShape.new(name: 'FailedResource')
|
25
|
+
FailedResourceList = Shapes::ListShape.new(name: 'FailedResourceList')
|
22
26
|
ForbiddenException = Shapes::StructureShape.new(name: 'ForbiddenException')
|
27
|
+
GetGroupConfigurationInput = Shapes::StructureShape.new(name: 'GetGroupConfigurationInput')
|
28
|
+
GetGroupConfigurationOutput = Shapes::StructureShape.new(name: 'GetGroupConfigurationOutput')
|
23
29
|
GetGroupInput = Shapes::StructureShape.new(name: 'GetGroupInput')
|
24
30
|
GetGroupOutput = Shapes::StructureShape.new(name: 'GetGroupOutput')
|
25
31
|
GetGroupQueryInput = Shapes::StructureShape.new(name: 'GetGroupQueryInput')
|
@@ -28,7 +34,16 @@ module Aws::ResourceGroups
|
|
28
34
|
GetTagsOutput = Shapes::StructureShape.new(name: 'GetTagsOutput')
|
29
35
|
Group = Shapes::StructureShape.new(name: 'Group')
|
30
36
|
GroupArn = Shapes::StringShape.new(name: 'GroupArn')
|
31
|
-
|
37
|
+
GroupConfiguration = Shapes::StructureShape.new(name: 'GroupConfiguration')
|
38
|
+
GroupConfigurationFailureReason = Shapes::StringShape.new(name: 'GroupConfigurationFailureReason')
|
39
|
+
GroupConfigurationItem = Shapes::StructureShape.new(name: 'GroupConfigurationItem')
|
40
|
+
GroupConfigurationList = Shapes::ListShape.new(name: 'GroupConfigurationList')
|
41
|
+
GroupConfigurationParameter = Shapes::StructureShape.new(name: 'GroupConfigurationParameter')
|
42
|
+
GroupConfigurationParameterName = Shapes::StringShape.new(name: 'GroupConfigurationParameterName')
|
43
|
+
GroupConfigurationParameterValue = Shapes::StringShape.new(name: 'GroupConfigurationParameterValue')
|
44
|
+
GroupConfigurationParameterValueList = Shapes::ListShape.new(name: 'GroupConfigurationParameterValueList')
|
45
|
+
GroupConfigurationStatus = Shapes::StringShape.new(name: 'GroupConfigurationStatus')
|
46
|
+
GroupConfigurationType = Shapes::StringShape.new(name: 'GroupConfigurationType')
|
32
47
|
GroupFilter = Shapes::StructureShape.new(name: 'GroupFilter')
|
33
48
|
GroupFilterList = Shapes::ListShape.new(name: 'GroupFilterList')
|
34
49
|
GroupFilterName = Shapes::StringShape.new(name: 'GroupFilterName')
|
@@ -38,7 +53,11 @@ module Aws::ResourceGroups
|
|
38
53
|
GroupIdentifierList = Shapes::ListShape.new(name: 'GroupIdentifierList')
|
39
54
|
GroupList = Shapes::ListShape.new(name: 'GroupList')
|
40
55
|
GroupName = Shapes::StringShape.new(name: 'GroupName')
|
56
|
+
GroupParameterList = Shapes::ListShape.new(name: 'GroupParameterList')
|
41
57
|
GroupQuery = Shapes::StructureShape.new(name: 'GroupQuery')
|
58
|
+
GroupResourcesInput = Shapes::StructureShape.new(name: 'GroupResourcesInput')
|
59
|
+
GroupResourcesOutput = Shapes::StructureShape.new(name: 'GroupResourcesOutput')
|
60
|
+
GroupString = Shapes::StringShape.new(name: 'GroupString')
|
42
61
|
InternalServerErrorException = Shapes::StructureShape.new(name: 'InternalServerErrorException')
|
43
62
|
ListGroupResourcesInput = Shapes::StructureShape.new(name: 'ListGroupResourcesInput')
|
44
63
|
ListGroupResourcesOutput = Shapes::StructureShape.new(name: 'ListGroupResourcesOutput')
|
@@ -55,6 +74,7 @@ module Aws::ResourceGroups
|
|
55
74
|
QueryErrorMessage = Shapes::StringShape.new(name: 'QueryErrorMessage')
|
56
75
|
QueryType = Shapes::StringShape.new(name: 'QueryType')
|
57
76
|
ResourceArn = Shapes::StringShape.new(name: 'ResourceArn')
|
77
|
+
ResourceArnList = Shapes::ListShape.new(name: 'ResourceArnList')
|
58
78
|
ResourceFilter = Shapes::StructureShape.new(name: 'ResourceFilter')
|
59
79
|
ResourceFilterList = Shapes::ListShape.new(name: 'ResourceFilterList')
|
60
80
|
ResourceFilterName = Shapes::StringShape.new(name: 'ResourceFilterName')
|
@@ -74,6 +94,8 @@ module Aws::ResourceGroups
|
|
74
94
|
Tags = Shapes::MapShape.new(name: 'Tags')
|
75
95
|
TooManyRequestsException = Shapes::StructureShape.new(name: 'TooManyRequestsException')
|
76
96
|
UnauthorizedException = Shapes::StructureShape.new(name: 'UnauthorizedException')
|
97
|
+
UngroupResourcesInput = Shapes::StructureShape.new(name: 'UngroupResourcesInput')
|
98
|
+
UngroupResourcesOutput = Shapes::StructureShape.new(name: 'UngroupResourcesOutput')
|
77
99
|
UntagInput = Shapes::StructureShape.new(name: 'UntagInput')
|
78
100
|
UntagOutput = Shapes::StructureShape.new(name: 'UntagOutput')
|
79
101
|
UpdateGroupInput = Shapes::StructureShape.new(name: 'UpdateGroupInput')
|
@@ -85,32 +107,50 @@ module Aws::ResourceGroups
|
|
85
107
|
BadRequestException.struct_class = Types::BadRequestException
|
86
108
|
|
87
109
|
CreateGroupInput.add_member(:name, Shapes::ShapeRef.new(shape: GroupName, required: true, location_name: "Name"))
|
88
|
-
CreateGroupInput.add_member(:description, Shapes::ShapeRef.new(shape:
|
89
|
-
CreateGroupInput.add_member(:resource_query, Shapes::ShapeRef.new(shape: ResourceQuery,
|
110
|
+
CreateGroupInput.add_member(:description, Shapes::ShapeRef.new(shape: Description, location_name: "Description"))
|
111
|
+
CreateGroupInput.add_member(:resource_query, Shapes::ShapeRef.new(shape: ResourceQuery, location_name: "ResourceQuery"))
|
90
112
|
CreateGroupInput.add_member(:tags, Shapes::ShapeRef.new(shape: Tags, location_name: "Tags"))
|
113
|
+
CreateGroupInput.add_member(:configuration, Shapes::ShapeRef.new(shape: GroupConfigurationList, location_name: "Configuration"))
|
91
114
|
CreateGroupInput.struct_class = Types::CreateGroupInput
|
92
115
|
|
93
116
|
CreateGroupOutput.add_member(:group, Shapes::ShapeRef.new(shape: Group, location_name: "Group"))
|
94
117
|
CreateGroupOutput.add_member(:resource_query, Shapes::ShapeRef.new(shape: ResourceQuery, location_name: "ResourceQuery"))
|
95
118
|
CreateGroupOutput.add_member(:tags, Shapes::ShapeRef.new(shape: Tags, location_name: "Tags"))
|
119
|
+
CreateGroupOutput.add_member(:group_configuration, Shapes::ShapeRef.new(shape: GroupConfiguration, location_name: "GroupConfiguration"))
|
96
120
|
CreateGroupOutput.struct_class = Types::CreateGroupOutput
|
97
121
|
|
98
|
-
DeleteGroupInput.add_member(:group_name, Shapes::ShapeRef.new(shape: GroupName,
|
122
|
+
DeleteGroupInput.add_member(:group_name, Shapes::ShapeRef.new(shape: GroupName, deprecated: true, location_name: "GroupName", metadata: {"deprecatedMessage"=>"This field is deprecated, use Group instead."}))
|
123
|
+
DeleteGroupInput.add_member(:group, Shapes::ShapeRef.new(shape: GroupString, location_name: "Group"))
|
99
124
|
DeleteGroupInput.struct_class = Types::DeleteGroupInput
|
100
125
|
|
101
126
|
DeleteGroupOutput.add_member(:group, Shapes::ShapeRef.new(shape: Group, location_name: "Group"))
|
102
127
|
DeleteGroupOutput.struct_class = Types::DeleteGroupOutput
|
103
128
|
|
129
|
+
FailedResource.add_member(:resource_arn, Shapes::ShapeRef.new(shape: ResourceArn, location_name: "ResourceArn"))
|
130
|
+
FailedResource.add_member(:error_message, Shapes::ShapeRef.new(shape: ErrorMessage, location_name: "ErrorMessage"))
|
131
|
+
FailedResource.add_member(:error_code, Shapes::ShapeRef.new(shape: ErrorCode, location_name: "ErrorCode"))
|
132
|
+
FailedResource.struct_class = Types::FailedResource
|
133
|
+
|
134
|
+
FailedResourceList.member = Shapes::ShapeRef.new(shape: FailedResource)
|
135
|
+
|
104
136
|
ForbiddenException.add_member(:message, Shapes::ShapeRef.new(shape: ErrorMessage, location_name: "Message"))
|
105
137
|
ForbiddenException.struct_class = Types::ForbiddenException
|
106
138
|
|
107
|
-
|
139
|
+
GetGroupConfigurationInput.add_member(:group, Shapes::ShapeRef.new(shape: GroupString, location_name: "Group"))
|
140
|
+
GetGroupConfigurationInput.struct_class = Types::GetGroupConfigurationInput
|
141
|
+
|
142
|
+
GetGroupConfigurationOutput.add_member(:group_configuration, Shapes::ShapeRef.new(shape: GroupConfiguration, location_name: "GroupConfiguration"))
|
143
|
+
GetGroupConfigurationOutput.struct_class = Types::GetGroupConfigurationOutput
|
144
|
+
|
145
|
+
GetGroupInput.add_member(:group_name, Shapes::ShapeRef.new(shape: GroupName, deprecated: true, location_name: "GroupName", metadata: {"deprecatedMessage"=>"This field is deprecated, use Group instead."}))
|
146
|
+
GetGroupInput.add_member(:group, Shapes::ShapeRef.new(shape: GroupString, location_name: "Group"))
|
108
147
|
GetGroupInput.struct_class = Types::GetGroupInput
|
109
148
|
|
110
149
|
GetGroupOutput.add_member(:group, Shapes::ShapeRef.new(shape: Group, location_name: "Group"))
|
111
150
|
GetGroupOutput.struct_class = Types::GetGroupOutput
|
112
151
|
|
113
|
-
GetGroupQueryInput.add_member(:group_name, Shapes::ShapeRef.new(shape: GroupName,
|
152
|
+
GetGroupQueryInput.add_member(:group_name, Shapes::ShapeRef.new(shape: GroupName, deprecated: true, location_name: "GroupName", metadata: {"deprecatedMessage"=>"This field is deprecated, use Group instead."}))
|
153
|
+
GetGroupQueryInput.add_member(:group, Shapes::ShapeRef.new(shape: GroupString, location_name: "Group"))
|
114
154
|
GetGroupQueryInput.struct_class = Types::GetGroupQueryInput
|
115
155
|
|
116
156
|
GetGroupQueryOutput.add_member(:group_query, Shapes::ShapeRef.new(shape: GroupQuery, location_name: "GroupQuery"))
|
@@ -125,9 +165,27 @@ module Aws::ResourceGroups
|
|
125
165
|
|
126
166
|
Group.add_member(:group_arn, Shapes::ShapeRef.new(shape: GroupArn, required: true, location_name: "GroupArn"))
|
127
167
|
Group.add_member(:name, Shapes::ShapeRef.new(shape: GroupName, required: true, location_name: "Name"))
|
128
|
-
Group.add_member(:description, Shapes::ShapeRef.new(shape:
|
168
|
+
Group.add_member(:description, Shapes::ShapeRef.new(shape: Description, location_name: "Description"))
|
129
169
|
Group.struct_class = Types::Group
|
130
170
|
|
171
|
+
GroupConfiguration.add_member(:configuration, Shapes::ShapeRef.new(shape: GroupConfigurationList, location_name: "Configuration"))
|
172
|
+
GroupConfiguration.add_member(:proposed_configuration, Shapes::ShapeRef.new(shape: GroupConfigurationList, location_name: "ProposedConfiguration"))
|
173
|
+
GroupConfiguration.add_member(:status, Shapes::ShapeRef.new(shape: GroupConfigurationStatus, location_name: "Status"))
|
174
|
+
GroupConfiguration.add_member(:failure_reason, Shapes::ShapeRef.new(shape: GroupConfigurationFailureReason, location_name: "FailureReason"))
|
175
|
+
GroupConfiguration.struct_class = Types::GroupConfiguration
|
176
|
+
|
177
|
+
GroupConfigurationItem.add_member(:type, Shapes::ShapeRef.new(shape: GroupConfigurationType, required: true, location_name: "Type"))
|
178
|
+
GroupConfigurationItem.add_member(:parameters, Shapes::ShapeRef.new(shape: GroupParameterList, location_name: "Parameters"))
|
179
|
+
GroupConfigurationItem.struct_class = Types::GroupConfigurationItem
|
180
|
+
|
181
|
+
GroupConfigurationList.member = Shapes::ShapeRef.new(shape: GroupConfigurationItem)
|
182
|
+
|
183
|
+
GroupConfigurationParameter.add_member(:name, Shapes::ShapeRef.new(shape: GroupConfigurationParameterName, required: true, location_name: "Name"))
|
184
|
+
GroupConfigurationParameter.add_member(:values, Shapes::ShapeRef.new(shape: GroupConfigurationParameterValueList, location_name: "Values"))
|
185
|
+
GroupConfigurationParameter.struct_class = Types::GroupConfigurationParameter
|
186
|
+
|
187
|
+
GroupConfigurationParameterValueList.member = Shapes::ShapeRef.new(shape: GroupConfigurationParameterValue)
|
188
|
+
|
131
189
|
GroupFilter.add_member(:name, Shapes::ShapeRef.new(shape: GroupFilterName, required: true, location_name: "Name"))
|
132
190
|
GroupFilter.add_member(:values, Shapes::ShapeRef.new(shape: GroupFilterValues, required: true, location_name: "Values"))
|
133
191
|
GroupFilter.struct_class = Types::GroupFilter
|
@@ -144,17 +202,28 @@ module Aws::ResourceGroups
|
|
144
202
|
|
145
203
|
GroupList.member = Shapes::ShapeRef.new(shape: Group)
|
146
204
|
|
205
|
+
GroupParameterList.member = Shapes::ShapeRef.new(shape: GroupConfigurationParameter)
|
206
|
+
|
147
207
|
GroupQuery.add_member(:group_name, Shapes::ShapeRef.new(shape: GroupName, required: true, location_name: "GroupName"))
|
148
208
|
GroupQuery.add_member(:resource_query, Shapes::ShapeRef.new(shape: ResourceQuery, required: true, location_name: "ResourceQuery"))
|
149
209
|
GroupQuery.struct_class = Types::GroupQuery
|
150
210
|
|
211
|
+
GroupResourcesInput.add_member(:group, Shapes::ShapeRef.new(shape: GroupString, required: true, location_name: "Group"))
|
212
|
+
GroupResourcesInput.add_member(:resource_arns, Shapes::ShapeRef.new(shape: ResourceArnList, required: true, location_name: "ResourceArns"))
|
213
|
+
GroupResourcesInput.struct_class = Types::GroupResourcesInput
|
214
|
+
|
215
|
+
GroupResourcesOutput.add_member(:succeeded, Shapes::ShapeRef.new(shape: ResourceArnList, location_name: "Succeeded"))
|
216
|
+
GroupResourcesOutput.add_member(:failed, Shapes::ShapeRef.new(shape: FailedResourceList, location_name: "Failed"))
|
217
|
+
GroupResourcesOutput.struct_class = Types::GroupResourcesOutput
|
218
|
+
|
151
219
|
InternalServerErrorException.add_member(:message, Shapes::ShapeRef.new(shape: ErrorMessage, location_name: "Message"))
|
152
220
|
InternalServerErrorException.struct_class = Types::InternalServerErrorException
|
153
221
|
|
154
|
-
ListGroupResourcesInput.add_member(:group_name, Shapes::ShapeRef.new(shape: GroupName,
|
222
|
+
ListGroupResourcesInput.add_member(:group_name, Shapes::ShapeRef.new(shape: GroupName, deprecated: true, location_name: "GroupName", metadata: {"deprecatedMessage"=>"This field is deprecated, use Group instead."}))
|
223
|
+
ListGroupResourcesInput.add_member(:group, Shapes::ShapeRef.new(shape: GroupString, location_name: "Group"))
|
155
224
|
ListGroupResourcesInput.add_member(:filters, Shapes::ShapeRef.new(shape: ResourceFilterList, location_name: "Filters"))
|
156
|
-
ListGroupResourcesInput.add_member(:max_results, Shapes::ShapeRef.new(shape: MaxResults,
|
157
|
-
ListGroupResourcesInput.add_member(:next_token, Shapes::ShapeRef.new(shape: NextToken,
|
225
|
+
ListGroupResourcesInput.add_member(:max_results, Shapes::ShapeRef.new(shape: MaxResults, location_name: "MaxResults"))
|
226
|
+
ListGroupResourcesInput.add_member(:next_token, Shapes::ShapeRef.new(shape: NextToken, location_name: "NextToken"))
|
158
227
|
ListGroupResourcesInput.struct_class = Types::ListGroupResourcesInput
|
159
228
|
|
160
229
|
ListGroupResourcesOutput.add_member(:resource_identifiers, Shapes::ShapeRef.new(shape: ResourceIdentifierList, location_name: "ResourceIdentifiers"))
|
@@ -184,6 +253,8 @@ module Aws::ResourceGroups
|
|
184
253
|
|
185
254
|
QueryErrorList.member = Shapes::ShapeRef.new(shape: QueryError)
|
186
255
|
|
256
|
+
ResourceArnList.member = Shapes::ShapeRef.new(shape: ResourceArn)
|
257
|
+
|
187
258
|
ResourceFilter.add_member(:name, Shapes::ShapeRef.new(shape: ResourceFilterName, required: true, location_name: "Name"))
|
188
259
|
ResourceFilter.add_member(:values, Shapes::ShapeRef.new(shape: ResourceFilterValues, required: true, location_name: "Values"))
|
189
260
|
ResourceFilter.struct_class = Types::ResourceFilter
|
@@ -231,6 +302,14 @@ module Aws::ResourceGroups
|
|
231
302
|
UnauthorizedException.add_member(:message, Shapes::ShapeRef.new(shape: ErrorMessage, location_name: "Message"))
|
232
303
|
UnauthorizedException.struct_class = Types::UnauthorizedException
|
233
304
|
|
305
|
+
UngroupResourcesInput.add_member(:group, Shapes::ShapeRef.new(shape: GroupString, required: true, location_name: "Group"))
|
306
|
+
UngroupResourcesInput.add_member(:resource_arns, Shapes::ShapeRef.new(shape: ResourceArnList, required: true, location_name: "ResourceArns"))
|
307
|
+
UngroupResourcesInput.struct_class = Types::UngroupResourcesInput
|
308
|
+
|
309
|
+
UngroupResourcesOutput.add_member(:succeeded, Shapes::ShapeRef.new(shape: ResourceArnList, location_name: "Succeeded"))
|
310
|
+
UngroupResourcesOutput.add_member(:failed, Shapes::ShapeRef.new(shape: FailedResourceList, location_name: "Failed"))
|
311
|
+
UngroupResourcesOutput.struct_class = Types::UngroupResourcesOutput
|
312
|
+
|
234
313
|
UntagInput.add_member(:arn, Shapes::ShapeRef.new(shape: GroupArn, required: true, location: "uri", location_name: "Arn"))
|
235
314
|
UntagInput.add_member(:keys, Shapes::ShapeRef.new(shape: TagKeyList, required: true, location_name: "Keys"))
|
236
315
|
UntagInput.struct_class = Types::UntagInput
|
@@ -239,14 +318,16 @@ module Aws::ResourceGroups
|
|
239
318
|
UntagOutput.add_member(:keys, Shapes::ShapeRef.new(shape: TagKeyList, location_name: "Keys"))
|
240
319
|
UntagOutput.struct_class = Types::UntagOutput
|
241
320
|
|
242
|
-
UpdateGroupInput.add_member(:group_name, Shapes::ShapeRef.new(shape: GroupName,
|
243
|
-
UpdateGroupInput.add_member(:
|
321
|
+
UpdateGroupInput.add_member(:group_name, Shapes::ShapeRef.new(shape: GroupName, deprecated: true, location_name: "GroupName", metadata: {"deprecatedMessage"=>"This field is deprecated, use Group instead."}))
|
322
|
+
UpdateGroupInput.add_member(:group, Shapes::ShapeRef.new(shape: GroupString, location_name: "Group"))
|
323
|
+
UpdateGroupInput.add_member(:description, Shapes::ShapeRef.new(shape: Description, location_name: "Description"))
|
244
324
|
UpdateGroupInput.struct_class = Types::UpdateGroupInput
|
245
325
|
|
246
326
|
UpdateGroupOutput.add_member(:group, Shapes::ShapeRef.new(shape: Group, location_name: "Group"))
|
247
327
|
UpdateGroupOutput.struct_class = Types::UpdateGroupOutput
|
248
328
|
|
249
|
-
UpdateGroupQueryInput.add_member(:group_name, Shapes::ShapeRef.new(shape: GroupName,
|
329
|
+
UpdateGroupQueryInput.add_member(:group_name, Shapes::ShapeRef.new(shape: GroupName, deprecated: true, location_name: "GroupName", metadata: {"deprecatedMessage"=>"This field is deprecated, use Group instead."}))
|
330
|
+
UpdateGroupQueryInput.add_member(:group, Shapes::ShapeRef.new(shape: GroupString, location_name: "Group"))
|
250
331
|
UpdateGroupQueryInput.add_member(:resource_query, Shapes::ShapeRef.new(shape: ResourceQuery, required: true, location_name: "ResourceQuery"))
|
251
332
|
UpdateGroupQueryInput.struct_class = Types::UpdateGroupQueryInput
|
252
333
|
|
@@ -286,8 +367,8 @@ module Aws::ResourceGroups
|
|
286
367
|
|
287
368
|
api.add_operation(:delete_group, Seahorse::Model::Operation.new.tap do |o|
|
288
369
|
o.name = "DeleteGroup"
|
289
|
-
o.http_method = "
|
290
|
-
o.http_request_uri = "/
|
370
|
+
o.http_method = "POST"
|
371
|
+
o.http_request_uri = "/delete-group"
|
291
372
|
o.input = Shapes::ShapeRef.new(shape: DeleteGroupInput)
|
292
373
|
o.output = Shapes::ShapeRef.new(shape: DeleteGroupOutput)
|
293
374
|
o.errors << Shapes::ShapeRef.new(shape: BadRequestException)
|
@@ -300,8 +381,8 @@ module Aws::ResourceGroups
|
|
300
381
|
|
301
382
|
api.add_operation(:get_group, Seahorse::Model::Operation.new.tap do |o|
|
302
383
|
o.name = "GetGroup"
|
303
|
-
o.http_method = "
|
304
|
-
o.http_request_uri = "/
|
384
|
+
o.http_method = "POST"
|
385
|
+
o.http_request_uri = "/get-group"
|
305
386
|
o.input = Shapes::ShapeRef.new(shape: GetGroupInput)
|
306
387
|
o.output = Shapes::ShapeRef.new(shape: GetGroupOutput)
|
307
388
|
o.errors << Shapes::ShapeRef.new(shape: BadRequestException)
|
@@ -312,10 +393,24 @@ module Aws::ResourceGroups
|
|
312
393
|
o.errors << Shapes::ShapeRef.new(shape: InternalServerErrorException)
|
313
394
|
end)
|
314
395
|
|
396
|
+
api.add_operation(:get_group_configuration, Seahorse::Model::Operation.new.tap do |o|
|
397
|
+
o.name = "GetGroupConfiguration"
|
398
|
+
o.http_method = "POST"
|
399
|
+
o.http_request_uri = "/get-group-configuration"
|
400
|
+
o.input = Shapes::ShapeRef.new(shape: GetGroupConfigurationInput)
|
401
|
+
o.output = Shapes::ShapeRef.new(shape: GetGroupConfigurationOutput)
|
402
|
+
o.errors << Shapes::ShapeRef.new(shape: BadRequestException)
|
403
|
+
o.errors << Shapes::ShapeRef.new(shape: ForbiddenException)
|
404
|
+
o.errors << Shapes::ShapeRef.new(shape: NotFoundException)
|
405
|
+
o.errors << Shapes::ShapeRef.new(shape: MethodNotAllowedException)
|
406
|
+
o.errors << Shapes::ShapeRef.new(shape: TooManyRequestsException)
|
407
|
+
o.errors << Shapes::ShapeRef.new(shape: InternalServerErrorException)
|
408
|
+
end)
|
409
|
+
|
315
410
|
api.add_operation(:get_group_query, Seahorse::Model::Operation.new.tap do |o|
|
316
411
|
o.name = "GetGroupQuery"
|
317
|
-
o.http_method = "
|
318
|
-
o.http_request_uri = "/
|
412
|
+
o.http_method = "POST"
|
413
|
+
o.http_request_uri = "/get-group-query"
|
319
414
|
o.input = Shapes::ShapeRef.new(shape: GetGroupQueryInput)
|
320
415
|
o.output = Shapes::ShapeRef.new(shape: GetGroupQueryOutput)
|
321
416
|
o.errors << Shapes::ShapeRef.new(shape: BadRequestException)
|
@@ -340,10 +435,24 @@ module Aws::ResourceGroups
|
|
340
435
|
o.errors << Shapes::ShapeRef.new(shape: InternalServerErrorException)
|
341
436
|
end)
|
342
437
|
|
438
|
+
api.add_operation(:group_resources, Seahorse::Model::Operation.new.tap do |o|
|
439
|
+
o.name = "GroupResources"
|
440
|
+
o.http_method = "POST"
|
441
|
+
o.http_request_uri = "/group-resources"
|
442
|
+
o.input = Shapes::ShapeRef.new(shape: GroupResourcesInput)
|
443
|
+
o.output = Shapes::ShapeRef.new(shape: GroupResourcesOutput)
|
444
|
+
o.errors << Shapes::ShapeRef.new(shape: BadRequestException)
|
445
|
+
o.errors << Shapes::ShapeRef.new(shape: ForbiddenException)
|
446
|
+
o.errors << Shapes::ShapeRef.new(shape: NotFoundException)
|
447
|
+
o.errors << Shapes::ShapeRef.new(shape: MethodNotAllowedException)
|
448
|
+
o.errors << Shapes::ShapeRef.new(shape: TooManyRequestsException)
|
449
|
+
o.errors << Shapes::ShapeRef.new(shape: InternalServerErrorException)
|
450
|
+
end)
|
451
|
+
|
343
452
|
api.add_operation(:list_group_resources, Seahorse::Model::Operation.new.tap do |o|
|
344
453
|
o.name = "ListGroupResources"
|
345
454
|
o.http_method = "POST"
|
346
|
-
o.http_request_uri = "/
|
455
|
+
o.http_request_uri = "/list-group-resources"
|
347
456
|
o.input = Shapes::ShapeRef.new(shape: ListGroupResourcesInput)
|
348
457
|
o.output = Shapes::ShapeRef.new(shape: ListGroupResourcesOutput)
|
349
458
|
o.errors << Shapes::ShapeRef.new(shape: UnauthorizedException)
|
@@ -414,6 +523,20 @@ module Aws::ResourceGroups
|
|
414
523
|
o.errors << Shapes::ShapeRef.new(shape: InternalServerErrorException)
|
415
524
|
end)
|
416
525
|
|
526
|
+
api.add_operation(:ungroup_resources, Seahorse::Model::Operation.new.tap do |o|
|
527
|
+
o.name = "UngroupResources"
|
528
|
+
o.http_method = "POST"
|
529
|
+
o.http_request_uri = "/ungroup-resources"
|
530
|
+
o.input = Shapes::ShapeRef.new(shape: UngroupResourcesInput)
|
531
|
+
o.output = Shapes::ShapeRef.new(shape: UngroupResourcesOutput)
|
532
|
+
o.errors << Shapes::ShapeRef.new(shape: BadRequestException)
|
533
|
+
o.errors << Shapes::ShapeRef.new(shape: ForbiddenException)
|
534
|
+
o.errors << Shapes::ShapeRef.new(shape: NotFoundException)
|
535
|
+
o.errors << Shapes::ShapeRef.new(shape: MethodNotAllowedException)
|
536
|
+
o.errors << Shapes::ShapeRef.new(shape: TooManyRequestsException)
|
537
|
+
o.errors << Shapes::ShapeRef.new(shape: InternalServerErrorException)
|
538
|
+
end)
|
539
|
+
|
417
540
|
api.add_operation(:untag, Seahorse::Model::Operation.new.tap do |o|
|
418
541
|
o.name = "Untag"
|
419
542
|
o.http_method = "PATCH"
|
@@ -430,8 +553,8 @@ module Aws::ResourceGroups
|
|
430
553
|
|
431
554
|
api.add_operation(:update_group, Seahorse::Model::Operation.new.tap do |o|
|
432
555
|
o.name = "UpdateGroup"
|
433
|
-
o.http_method = "
|
434
|
-
o.http_request_uri = "/
|
556
|
+
o.http_method = "POST"
|
557
|
+
o.http_request_uri = "/update-group"
|
435
558
|
o.input = Shapes::ShapeRef.new(shape: UpdateGroupInput)
|
436
559
|
o.output = Shapes::ShapeRef.new(shape: UpdateGroupOutput)
|
437
560
|
o.errors << Shapes::ShapeRef.new(shape: BadRequestException)
|
@@ -444,8 +567,8 @@ module Aws::ResourceGroups
|
|
444
567
|
|
445
568
|
api.add_operation(:update_group_query, Seahorse::Model::Operation.new.tap do |o|
|
446
569
|
o.name = "UpdateGroupQuery"
|
447
|
-
o.http_method = "
|
448
|
-
o.http_request_uri = "/
|
570
|
+
o.http_method = "POST"
|
571
|
+
o.http_request_uri = "/update-group-query"
|
449
572
|
o.input = Shapes::ShapeRef.new(shape: UpdateGroupQueryInput)
|
450
573
|
o.output = Shapes::ShapeRef.new(shape: UpdateGroupQueryOutput)
|
451
574
|
o.errors << Shapes::ShapeRef.new(shape: BadRequestException)
|
@@ -10,8 +10,8 @@
|
|
10
10
|
module Aws::ResourceGroups
|
11
11
|
module Types
|
12
12
|
|
13
|
-
# The request
|
14
|
-
#
|
13
|
+
# The request includes one or more parameters that violate validation
|
14
|
+
# rules.
|
15
15
|
#
|
16
16
|
# @!attribute [rw] message
|
17
17
|
# @return [String]
|
@@ -29,56 +29,81 @@ module Aws::ResourceGroups
|
|
29
29
|
#
|
30
30
|
# {
|
31
31
|
# name: "GroupName", # required
|
32
|
-
# description: "
|
33
|
-
# resource_query: {
|
32
|
+
# description: "Description",
|
33
|
+
# resource_query: {
|
34
34
|
# type: "TAG_FILTERS_1_0", # required, accepts TAG_FILTERS_1_0, CLOUDFORMATION_STACK_1_0
|
35
35
|
# query: "Query", # required
|
36
36
|
# },
|
37
37
|
# tags: {
|
38
38
|
# "TagKey" => "TagValue",
|
39
39
|
# },
|
40
|
+
# configuration: [
|
41
|
+
# {
|
42
|
+
# type: "GroupConfigurationType", # required
|
43
|
+
# parameters: [
|
44
|
+
# {
|
45
|
+
# name: "GroupConfigurationParameterName", # required
|
46
|
+
# values: ["GroupConfigurationParameterValue"],
|
47
|
+
# },
|
48
|
+
# ],
|
49
|
+
# },
|
50
|
+
# ],
|
40
51
|
# }
|
41
52
|
#
|
42
53
|
# @!attribute [rw] name
|
43
54
|
# The name of the group, which is the identifier of the group in other
|
44
|
-
# operations.
|
45
|
-
#
|
46
|
-
#
|
47
|
-
#
|
48
|
-
#
|
55
|
+
# operations. You can't change the name of a resource group after you
|
56
|
+
# create it. A resource group name can consist of letters, numbers,
|
57
|
+
# hyphens, periods, and underscores. The name cannot start with `AWS`
|
58
|
+
# or `aws`; these are reserved. A resource group name must be unique
|
59
|
+
# within each AWS Region in your AWS account.
|
49
60
|
# @return [String]
|
50
61
|
#
|
51
62
|
# @!attribute [rw] description
|
52
|
-
# The description of the resource group. Descriptions can
|
53
|
-
#
|
54
|
-
# underscores, punctuation, and spaces.
|
63
|
+
# The description of the resource group. Descriptions can consist of
|
64
|
+
# letters, numbers, hyphens, underscores, periods, and spaces.
|
55
65
|
# @return [String]
|
56
66
|
#
|
57
67
|
# @!attribute [rw] resource_query
|
58
68
|
# The resource query that determines which AWS resources are members
|
59
69
|
# of this group.
|
70
|
+
#
|
71
|
+
# <note markdown="1"> You can specify either a `ResourceQuery` or a `Configuration`, but
|
72
|
+
# not both.
|
73
|
+
#
|
74
|
+
# </note>
|
60
75
|
# @return [Types::ResourceQuery]
|
61
76
|
#
|
62
77
|
# @!attribute [rw] tags
|
63
|
-
# The tags to add to the group. A tag is
|
64
|
-
# key-value pairs. Tag keys can have a maximum character length of 128
|
65
|
-
# characters, and tag values can have a maximum length of 256
|
66
|
-
# characters.
|
78
|
+
# The tags to add to the group. A tag is key-value pair string.
|
67
79
|
# @return [Hash<String,String>]
|
68
80
|
#
|
81
|
+
# @!attribute [rw] configuration
|
82
|
+
# A configuration associates the resource group with an AWS service
|
83
|
+
# and specifies how the service can interact with the resources in the
|
84
|
+
# group. A configuration is an array of GroupConfigurationItem
|
85
|
+
# elements.
|
86
|
+
#
|
87
|
+
# <note markdown="1"> You can specify either a `Configuration` or a `ResourceQuery` in a
|
88
|
+
# group, but not both.
|
89
|
+
#
|
90
|
+
# </note>
|
91
|
+
# @return [Array<Types::GroupConfigurationItem>]
|
92
|
+
#
|
69
93
|
# @see http://docs.aws.amazon.com/goto/WebAPI/resource-groups-2017-11-27/CreateGroupInput AWS API Documentation
|
70
94
|
#
|
71
95
|
class CreateGroupInput < Struct.new(
|
72
96
|
:name,
|
73
97
|
:description,
|
74
98
|
:resource_query,
|
75
|
-
:tags
|
99
|
+
:tags,
|
100
|
+
:configuration)
|
76
101
|
SENSITIVE = []
|
77
102
|
include Aws::Structure
|
78
103
|
end
|
79
104
|
|
80
105
|
# @!attribute [rw] group
|
81
|
-
#
|
106
|
+
# The description of the resource group.
|
82
107
|
# @return [Types::Group]
|
83
108
|
#
|
84
109
|
# @!attribute [rw] resource_query
|
@@ -89,12 +114,29 @@ module Aws::ResourceGroups
|
|
89
114
|
# The tags associated with the group.
|
90
115
|
# @return [Hash<String,String>]
|
91
116
|
#
|
117
|
+
# @!attribute [rw] group_configuration
|
118
|
+
# The service configuration associated with the resource group. AWS
|
119
|
+
# Resource Groups supports adding service configurations for the
|
120
|
+
# following resource group types:
|
121
|
+
#
|
122
|
+
# * `AWS::EC2::CapacityReservationPool` - Amazon EC2 capacity
|
123
|
+
# reservation pools. For more information, see [Working with
|
124
|
+
# capacity reservation groups][1] in the *EC2 Users Guide*.
|
125
|
+
#
|
126
|
+
# ^
|
127
|
+
#
|
128
|
+
#
|
129
|
+
#
|
130
|
+
# [1]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/capacity-reservations-using.html#create-cr-group
|
131
|
+
# @return [Types::GroupConfiguration]
|
132
|
+
#
|
92
133
|
# @see http://docs.aws.amazon.com/goto/WebAPI/resource-groups-2017-11-27/CreateGroupOutput AWS API Documentation
|
93
134
|
#
|
94
135
|
class CreateGroupOutput < Struct.new(
|
95
136
|
:group,
|
96
137
|
:resource_query,
|
97
|
-
:tags
|
138
|
+
:tags,
|
139
|
+
:group_configuration)
|
98
140
|
SENSITIVE = []
|
99
141
|
include Aws::Structure
|
100
142
|
end
|
@@ -103,17 +145,23 @@ module Aws::ResourceGroups
|
|
103
145
|
# data as a hash:
|
104
146
|
#
|
105
147
|
# {
|
106
|
-
# group_name: "GroupName",
|
148
|
+
# group_name: "GroupName",
|
149
|
+
# group: "GroupString",
|
107
150
|
# }
|
108
151
|
#
|
109
152
|
# @!attribute [rw] group_name
|
110
|
-
#
|
153
|
+
# Don't use this parameter. Use `Group` instead.
|
154
|
+
# @return [String]
|
155
|
+
#
|
156
|
+
# @!attribute [rw] group
|
157
|
+
# The name or the ARN of the resource group to delete.
|
111
158
|
# @return [String]
|
112
159
|
#
|
113
160
|
# @see http://docs.aws.amazon.com/goto/WebAPI/resource-groups-2017-11-27/DeleteGroupInput AWS API Documentation
|
114
161
|
#
|
115
162
|
class DeleteGroupInput < Struct.new(
|
116
|
-
:group_name
|
163
|
+
:group_name,
|
164
|
+
:group)
|
117
165
|
SENSITIVE = []
|
118
166
|
include Aws::Structure
|
119
167
|
end
|
@@ -130,7 +178,31 @@ module Aws::ResourceGroups
|
|
130
178
|
include Aws::Structure
|
131
179
|
end
|
132
180
|
|
133
|
-
#
|
181
|
+
# A resource that failed to be added to or removed from a group.
|
182
|
+
#
|
183
|
+
# @!attribute [rw] resource_arn
|
184
|
+
# The ARN of the resource that failed to be added or removed.
|
185
|
+
# @return [String]
|
186
|
+
#
|
187
|
+
# @!attribute [rw] error_message
|
188
|
+
# The error message text associated with the failure.
|
189
|
+
# @return [String]
|
190
|
+
#
|
191
|
+
# @!attribute [rw] error_code
|
192
|
+
# The error code associated with the failure.
|
193
|
+
# @return [String]
|
194
|
+
#
|
195
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/resource-groups-2017-11-27/FailedResource AWS API Documentation
|
196
|
+
#
|
197
|
+
class FailedResource < Struct.new(
|
198
|
+
:resource_arn,
|
199
|
+
:error_message,
|
200
|
+
:error_code)
|
201
|
+
SENSITIVE = []
|
202
|
+
include Aws::Structure
|
203
|
+
end
|
204
|
+
|
205
|
+
# The caller isn't authorized to make the request. Check permissions.
|
134
206
|
#
|
135
207
|
# @!attribute [rw] message
|
136
208
|
# @return [String]
|
@@ -143,21 +215,58 @@ module Aws::ResourceGroups
|
|
143
215
|
include Aws::Structure
|
144
216
|
end
|
145
217
|
|
218
|
+
# @note When making an API call, you may pass GetGroupConfigurationInput
|
219
|
+
# data as a hash:
|
220
|
+
#
|
221
|
+
# {
|
222
|
+
# group: "GroupString",
|
223
|
+
# }
|
224
|
+
#
|
225
|
+
# @!attribute [rw] group
|
226
|
+
# The name or the ARN of the resource group.
|
227
|
+
# @return [String]
|
228
|
+
#
|
229
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/resource-groups-2017-11-27/GetGroupConfigurationInput AWS API Documentation
|
230
|
+
#
|
231
|
+
class GetGroupConfigurationInput < Struct.new(
|
232
|
+
:group)
|
233
|
+
SENSITIVE = []
|
234
|
+
include Aws::Structure
|
235
|
+
end
|
236
|
+
|
237
|
+
# @!attribute [rw] group_configuration
|
238
|
+
# The configuration associated with the specified group.
|
239
|
+
# @return [Types::GroupConfiguration]
|
240
|
+
#
|
241
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/resource-groups-2017-11-27/GetGroupConfigurationOutput AWS API Documentation
|
242
|
+
#
|
243
|
+
class GetGroupConfigurationOutput < Struct.new(
|
244
|
+
:group_configuration)
|
245
|
+
SENSITIVE = []
|
246
|
+
include Aws::Structure
|
247
|
+
end
|
248
|
+
|
146
249
|
# @note When making an API call, you may pass GetGroupInput
|
147
250
|
# data as a hash:
|
148
251
|
#
|
149
252
|
# {
|
150
|
-
# group_name: "GroupName",
|
253
|
+
# group_name: "GroupName",
|
254
|
+
# group: "GroupString",
|
151
255
|
# }
|
152
256
|
#
|
153
257
|
# @!attribute [rw] group_name
|
154
|
-
#
|
258
|
+
# Don't use this parameter. Use `Group` instead.
|
259
|
+
# @return [String]
|
260
|
+
#
|
261
|
+
# @!attribute [rw] group
|
262
|
+
# The name or the ARN of the resource group to retrieve.
|
155
263
|
# @return [String]
|
156
264
|
#
|
157
265
|
# @see http://docs.aws.amazon.com/goto/WebAPI/resource-groups-2017-11-27/GetGroupInput AWS API Documentation
|
158
266
|
#
|
159
267
|
class GetGroupInput < Struct.new(
|
160
|
-
:group_name
|
268
|
+
:group_name,
|
269
|
+
:group)
|
161
270
|
SENSITIVE = []
|
162
271
|
include Aws::Structure
|
163
272
|
end
|
@@ -178,17 +287,23 @@ module Aws::ResourceGroups
|
|
178
287
|
# data as a hash:
|
179
288
|
#
|
180
289
|
# {
|
181
|
-
# group_name: "GroupName",
|
290
|
+
# group_name: "GroupName",
|
291
|
+
# group: "GroupString",
|
182
292
|
# }
|
183
293
|
#
|
184
294
|
# @!attribute [rw] group_name
|
185
|
-
#
|
295
|
+
# Don't use this parameter. Use `Group` instead.
|
296
|
+
# @return [String]
|
297
|
+
#
|
298
|
+
# @!attribute [rw] group
|
299
|
+
# The name or the ARN of the resource group to query.
|
186
300
|
# @return [String]
|
187
301
|
#
|
188
302
|
# @see http://docs.aws.amazon.com/goto/WebAPI/resource-groups-2017-11-27/GetGroupQueryInput AWS API Documentation
|
189
303
|
#
|
190
304
|
class GetGroupQueryInput < Struct.new(
|
191
|
-
:group_name
|
305
|
+
:group_name,
|
306
|
+
:group)
|
192
307
|
SENSITIVE = []
|
193
308
|
include Aws::Structure
|
194
309
|
end
|
@@ -213,8 +328,7 @@ module Aws::ResourceGroups
|
|
213
328
|
# }
|
214
329
|
#
|
215
330
|
# @!attribute [rw] arn
|
216
|
-
# The ARN of the resource group
|
217
|
-
# resource must exist within the account you are using.
|
331
|
+
# The ARN of the resource group whose tags you want to retrieve.
|
218
332
|
# @return [String]
|
219
333
|
#
|
220
334
|
# @see http://docs.aws.amazon.com/goto/WebAPI/resource-groups-2017-11-27/GetTagsInput AWS API Documentation
|
@@ -242,14 +356,25 @@ module Aws::ResourceGroups
|
|
242
356
|
include Aws::Structure
|
243
357
|
end
|
244
358
|
|
245
|
-
# A resource group.
|
359
|
+
# A resource group that contains AWS resources. You can assign resources
|
360
|
+
# to the group by associating either of the following elements with the
|
361
|
+
# group:
|
362
|
+
#
|
363
|
+
# * ResourceQuery - Use a resource query to specify a set of tag keys
|
364
|
+
# and values. All resources in the same AWS Region and AWS account
|
365
|
+
# that have those keys with the same values are included in the group.
|
366
|
+
# You can add a resource query when you create the group.
|
367
|
+
#
|
368
|
+
# * GroupConfiguration - Use a service configuration to associate the
|
369
|
+
# group with an AWS service. The configuration specifies which
|
370
|
+
# resource types can be included in the group.
|
246
371
|
#
|
247
372
|
# @!attribute [rw] group_arn
|
248
|
-
# The ARN of
|
373
|
+
# The ARN of the resource group.
|
249
374
|
# @return [String]
|
250
375
|
#
|
251
376
|
# @!attribute [rw] name
|
252
|
-
# The name of
|
377
|
+
# The name of the resource group.
|
253
378
|
# @return [String]
|
254
379
|
#
|
255
380
|
# @!attribute [rw] description
|
@@ -266,14 +391,155 @@ module Aws::ResourceGroups
|
|
266
391
|
include Aws::Structure
|
267
392
|
end
|
268
393
|
|
269
|
-
# A
|
270
|
-
#
|
394
|
+
# A service configuration associated with a resource group. The
|
395
|
+
# configuration options are determined by the AWS service that defines
|
396
|
+
# the `Type`, and specifies which resources can be included in the
|
397
|
+
# group. You can add a service configuration when you create the group.
|
398
|
+
#
|
399
|
+
# @!attribute [rw] configuration
|
400
|
+
# The configuration currently associated with the group and in effect.
|
401
|
+
# @return [Array<Types::GroupConfigurationItem>]
|
402
|
+
#
|
403
|
+
# @!attribute [rw] proposed_configuration
|
404
|
+
# If present, the new configuration that is in the process of being
|
405
|
+
# applied to the group.
|
406
|
+
# @return [Array<Types::GroupConfigurationItem>]
|
407
|
+
#
|
408
|
+
# @!attribute [rw] status
|
409
|
+
# The current status of an attempt to update the group configuration.
|
410
|
+
# @return [String]
|
411
|
+
#
|
412
|
+
# @!attribute [rw] failure_reason
|
413
|
+
# If present, the reason why a request to update the group
|
414
|
+
# configuration failed.
|
415
|
+
# @return [String]
|
416
|
+
#
|
417
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/resource-groups-2017-11-27/GroupConfiguration AWS API Documentation
|
418
|
+
#
|
419
|
+
class GroupConfiguration < Struct.new(
|
420
|
+
:configuration,
|
421
|
+
:proposed_configuration,
|
422
|
+
:status,
|
423
|
+
:failure_reason)
|
424
|
+
SENSITIVE = []
|
425
|
+
include Aws::Structure
|
426
|
+
end
|
427
|
+
|
428
|
+
# An item in a group configuration. A group configuration can have one
|
429
|
+
# or more items.
|
430
|
+
#
|
431
|
+
# @note When making an API call, you may pass GroupConfigurationItem
|
432
|
+
# data as a hash:
|
433
|
+
#
|
434
|
+
# {
|
435
|
+
# type: "GroupConfigurationType", # required
|
436
|
+
# parameters: [
|
437
|
+
# {
|
438
|
+
# name: "GroupConfigurationParameterName", # required
|
439
|
+
# values: ["GroupConfigurationParameterValue"],
|
440
|
+
# },
|
441
|
+
# ],
|
442
|
+
# }
|
443
|
+
#
|
444
|
+
# @!attribute [rw] type
|
445
|
+
# Specifies the type of group configuration item. Each item must have
|
446
|
+
# a unique value for `type`.
|
447
|
+
#
|
448
|
+
# You can specify the following string values:
|
449
|
+
#
|
450
|
+
# * `AWS::EC2::CapacityReservationPool`
|
451
|
+
#
|
452
|
+
# For more information about EC2 capacity reservation groups, see
|
453
|
+
# [Working with capacity reservation groups][1] in the *EC2 Users
|
454
|
+
# Guide*.
|
455
|
+
#
|
456
|
+
# * `AWS::ResourceGroups::Generic` - Supports parameters that
|
457
|
+
# configure the behavior of resource groups of any type.
|
458
|
+
#
|
459
|
+
#
|
460
|
+
#
|
461
|
+
# [1]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/capacity-reservations-using.html#create-cr-group
|
462
|
+
# @return [String]
|
463
|
+
#
|
464
|
+
# @!attribute [rw] parameters
|
465
|
+
# A collection of parameters for this group configuration item.
|
466
|
+
# @return [Array<Types::GroupConfigurationParameter>]
|
467
|
+
#
|
468
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/resource-groups-2017-11-27/GroupConfigurationItem AWS API Documentation
|
469
|
+
#
|
470
|
+
class GroupConfigurationItem < Struct.new(
|
471
|
+
:type,
|
472
|
+
:parameters)
|
473
|
+
SENSITIVE = []
|
474
|
+
include Aws::Structure
|
475
|
+
end
|
476
|
+
|
477
|
+
# A parameter for a group configuration item.
|
478
|
+
#
|
479
|
+
# @note When making an API call, you may pass GroupConfigurationParameter
|
480
|
+
# data as a hash:
|
481
|
+
#
|
482
|
+
# {
|
483
|
+
# name: "GroupConfigurationParameterName", # required
|
484
|
+
# values: ["GroupConfigurationParameterValue"],
|
485
|
+
# }
|
486
|
+
#
|
487
|
+
# @!attribute [rw] name
|
488
|
+
# The name of the group configuration parameter.
|
489
|
+
#
|
490
|
+
# You can specify the following string values:
|
491
|
+
#
|
492
|
+
# * For configuration item type `AWS::ResourceGroups::Generic`\:
|
493
|
+
#
|
494
|
+
# * `allowed-resource-types`
|
495
|
+
#
|
496
|
+
# Specifies the types of resources that you can add to this group
|
497
|
+
# by using the GroupResources operation.
|
498
|
+
#
|
499
|
+
# * For configuration item type `AWS::EC2::CapacityReservationPool`\:
|
500
|
+
#
|
501
|
+
# * None - This configuration item type doesn't support any
|
502
|
+
# parameters.
|
503
|
+
#
|
504
|
+
# ^
|
505
|
+
#
|
506
|
+
# For more information about EC2 capacity reservation groups, see
|
507
|
+
# [Working with capacity reservation groups][1] in the *EC2 Users
|
508
|
+
# Guide*.
|
509
|
+
#
|
510
|
+
#
|
511
|
+
#
|
512
|
+
# [1]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/capacity-reservations-using.html#create-cr-group
|
513
|
+
# @return [String]
|
514
|
+
#
|
515
|
+
# @!attribute [rw] values
|
516
|
+
# The values of for this parameter.
|
517
|
+
#
|
518
|
+
# You can specify the following string value:
|
519
|
+
#
|
520
|
+
# * For item type `allowed-resource-types`\: the only supported
|
521
|
+
# parameter value is `AWS::EC2::CapacityReservation`.
|
522
|
+
#
|
523
|
+
# ^
|
524
|
+
# @return [Array<String>]
|
525
|
+
#
|
526
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/resource-groups-2017-11-27/GroupConfigurationParameter AWS API Documentation
|
527
|
+
#
|
528
|
+
class GroupConfigurationParameter < Struct.new(
|
529
|
+
:name,
|
530
|
+
:values)
|
531
|
+
SENSITIVE = []
|
532
|
+
include Aws::Structure
|
533
|
+
end
|
534
|
+
|
535
|
+
# A filter collection that you can use to restrict the results from a
|
536
|
+
# `List` operation to only those you want to include.
|
271
537
|
#
|
272
538
|
# @note When making an API call, you may pass GroupFilter
|
273
539
|
# data as a hash:
|
274
540
|
#
|
275
541
|
# {
|
276
|
-
# name: "resource-type", # required, accepts resource-type
|
542
|
+
# name: "resource-type", # required, accepts resource-type, configuration-type
|
277
543
|
# values: ["GroupFilterValue"], # required
|
278
544
|
# }
|
279
545
|
#
|
@@ -295,14 +561,14 @@ module Aws::ResourceGroups
|
|
295
561
|
include Aws::Structure
|
296
562
|
end
|
297
563
|
|
298
|
-
# The
|
564
|
+
# The unique identifiers for a resource group.
|
299
565
|
#
|
300
566
|
# @!attribute [rw] group_name
|
301
|
-
# The name of
|
567
|
+
# The name of the resource group.
|
302
568
|
# @return [String]
|
303
569
|
#
|
304
570
|
# @!attribute [rw] group_arn
|
305
|
-
# The ARN of
|
571
|
+
# The ARN of the resource group.
|
306
572
|
# @return [String]
|
307
573
|
#
|
308
574
|
# @see http://docs.aws.amazon.com/goto/WebAPI/resource-groups-2017-11-27/GroupIdentifier AWS API Documentation
|
@@ -314,16 +580,16 @@ module Aws::ResourceGroups
|
|
314
580
|
include Aws::Structure
|
315
581
|
end
|
316
582
|
|
317
|
-
#
|
318
|
-
#
|
583
|
+
# A mapping of a query attached to a resource group that determines the
|
584
|
+
# AWS resources that are members of the group.
|
319
585
|
#
|
320
586
|
# @!attribute [rw] group_name
|
321
|
-
# The name of
|
587
|
+
# The name of the resource group that is associated with the specified
|
322
588
|
# resource query.
|
323
589
|
# @return [String]
|
324
590
|
#
|
325
591
|
# @!attribute [rw] resource_query
|
326
|
-
# The resource query
|
592
|
+
# The resource query that determines which AWS resources are members
|
327
593
|
# of the associated resource group.
|
328
594
|
# @return [Types::ResourceQuery]
|
329
595
|
#
|
@@ -336,7 +602,52 @@ module Aws::ResourceGroups
|
|
336
602
|
include Aws::Structure
|
337
603
|
end
|
338
604
|
|
339
|
-
#
|
605
|
+
# @note When making an API call, you may pass GroupResourcesInput
|
606
|
+
# data as a hash:
|
607
|
+
#
|
608
|
+
# {
|
609
|
+
# group: "GroupString", # required
|
610
|
+
# resource_arns: ["ResourceArn"], # required
|
611
|
+
# }
|
612
|
+
#
|
613
|
+
# @!attribute [rw] group
|
614
|
+
# The name or the ARN of the resource group to add resources to.
|
615
|
+
# @return [String]
|
616
|
+
#
|
617
|
+
# @!attribute [rw] resource_arns
|
618
|
+
# The list of ARNs for resources to be added to the group.
|
619
|
+
# @return [Array<String>]
|
620
|
+
#
|
621
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/resource-groups-2017-11-27/GroupResourcesInput AWS API Documentation
|
622
|
+
#
|
623
|
+
class GroupResourcesInput < Struct.new(
|
624
|
+
:group,
|
625
|
+
:resource_arns)
|
626
|
+
SENSITIVE = []
|
627
|
+
include Aws::Structure
|
628
|
+
end
|
629
|
+
|
630
|
+
# @!attribute [rw] succeeded
|
631
|
+
# The ARNs of the resources that were successfully added to the group
|
632
|
+
# by this operation.
|
633
|
+
# @return [Array<String>]
|
634
|
+
#
|
635
|
+
# @!attribute [rw] failed
|
636
|
+
# The ARNs of the resources that failed to be added to the group by
|
637
|
+
# this operation.
|
638
|
+
# @return [Array<Types::FailedResource>]
|
639
|
+
#
|
640
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/resource-groups-2017-11-27/GroupResourcesOutput AWS API Documentation
|
641
|
+
#
|
642
|
+
class GroupResourcesOutput < Struct.new(
|
643
|
+
:succeeded,
|
644
|
+
:failed)
|
645
|
+
SENSITIVE = []
|
646
|
+
include Aws::Structure
|
647
|
+
end
|
648
|
+
|
649
|
+
# An internal error occurred while processing the request. Try again
|
650
|
+
# later.
|
340
651
|
#
|
341
652
|
# @!attribute [rw] message
|
342
653
|
# @return [String]
|
@@ -353,7 +664,8 @@ module Aws::ResourceGroups
|
|
353
664
|
# data as a hash:
|
354
665
|
#
|
355
666
|
# {
|
356
|
-
# group_name: "GroupName",
|
667
|
+
# group_name: "GroupName",
|
668
|
+
# group: "GroupString",
|
357
669
|
# filters: [
|
358
670
|
# {
|
359
671
|
# name: "resource-type", # required, accepts resource-type
|
@@ -365,37 +677,71 @@ module Aws::ResourceGroups
|
|
365
677
|
# }
|
366
678
|
#
|
367
679
|
# @!attribute [rw] group_name
|
368
|
-
#
|
680
|
+
# Don't use this parameter. Use `Group` instead.
|
681
|
+
# @return [String]
|
682
|
+
#
|
683
|
+
# @!attribute [rw] group
|
684
|
+
# The name or the ARN of the resource group
|
369
685
|
# @return [String]
|
370
686
|
#
|
371
687
|
# @!attribute [rw] filters
|
372
688
|
# Filters, formatted as ResourceFilter objects, that you want to apply
|
373
|
-
# to a ListGroupResources operation.
|
689
|
+
# to a `ListGroupResources` operation. Filters the results to include
|
690
|
+
# only those of the specified resource types.
|
374
691
|
#
|
375
692
|
# * `resource-type` - Filter resources by their type. Specify up to
|
376
|
-
# five resource types in the format
|
377
|
-
#
|
693
|
+
# five resource types in the format
|
694
|
+
# `AWS::ServiceCode::ResourceType`. For example,
|
695
|
+
# `AWS::EC2::Instance`, or `AWS::S3::Bucket`.
|
378
696
|
#
|
379
697
|
# ^
|
698
|
+
#
|
699
|
+
# When you specify a `resource-type` filter for `ListGroupResources`,
|
700
|
+
# AWS Resource Groups validates your filter resource types against the
|
701
|
+
# types that are defined in the query associated with the group. For
|
702
|
+
# example, if a group contains only S3 buckets because its query
|
703
|
+
# specifies only that resource type, but your `resource-type` filter
|
704
|
+
# includes EC2 instances, AWS Resource Groups does not filter for EC2
|
705
|
+
# instances. In this case, a `ListGroupResources` request returns a
|
706
|
+
# `BadRequestException` error with a message similar to the following:
|
707
|
+
#
|
708
|
+
# `The resource types specified as filters in the request are not
|
709
|
+
# valid.`
|
710
|
+
#
|
711
|
+
# The error includes a list of resource types that failed the
|
712
|
+
# validation because they are not part of the query associated with
|
713
|
+
# the group. This validation doesn't occur when the group query
|
714
|
+
# specifies `AWS::AllSupported`, because a group based on such a query
|
715
|
+
# can contain any of the allowed resource types for the query type
|
716
|
+
# (tag-based or AWS CloudFormation stack-based queries).
|
380
717
|
# @return [Array<Types::ResourceFilter>]
|
381
718
|
#
|
382
719
|
# @!attribute [rw] max_results
|
383
|
-
# The
|
384
|
-
#
|
385
|
-
#
|
720
|
+
# The total number of results that you want included on each page of
|
721
|
+
# the response. If you do not include this parameter, it defaults to a
|
722
|
+
# value that is specific to the operation. If additional items exist
|
723
|
+
# beyond the maximum you specify, the `NextToken` response element is
|
724
|
+
# present and has a value (is not null). Include that value as the
|
725
|
+
# `NextToken` request parameter in the next call to the operation to
|
726
|
+
# get the next part of the results. Note that the service might return
|
727
|
+
# fewer results than the maximum even when there are more results
|
728
|
+
# available. You should check `NextToken` after every operation to
|
729
|
+
# ensure that you receive all of the results.
|
386
730
|
# @return [Integer]
|
387
731
|
#
|
388
732
|
# @!attribute [rw] next_token
|
389
|
-
# The
|
390
|
-
#
|
391
|
-
#
|
392
|
-
# value
|
733
|
+
# The parameter for receiving additional results if you receive a
|
734
|
+
# `NextToken` response in a previous request. A `NextToken` response
|
735
|
+
# indicates that more output is available. Set this parameter to the
|
736
|
+
# value provided by a previous call's `NextToken` response to
|
737
|
+
# indicate where the output should continue from.
|
393
738
|
# @return [String]
|
394
739
|
#
|
395
740
|
# @see http://docs.aws.amazon.com/goto/WebAPI/resource-groups-2017-11-27/ListGroupResourcesInput AWS API Documentation
|
396
741
|
#
|
397
742
|
class ListGroupResourcesInput < Struct.new(
|
398
743
|
:group_name,
|
744
|
+
:group,
|
399
745
|
:filters,
|
400
746
|
:max_results,
|
401
747
|
:next_token)
|
@@ -409,8 +755,11 @@ module Aws::ResourceGroups
|
|
409
755
|
# @return [Array<Types::ResourceIdentifier>]
|
410
756
|
#
|
411
757
|
# @!attribute [rw] next_token
|
412
|
-
#
|
413
|
-
#
|
758
|
+
# If present, indicates that more output is available than is included
|
759
|
+
# in the current response. Use this value in the `NextToken` request
|
760
|
+
# parameter in a subsequent call to the operation to get the next part
|
761
|
+
# of the output. You should repeat this until the `NextToken` response
|
762
|
+
# element comes back as `null`.
|
414
763
|
# @return [String]
|
415
764
|
#
|
416
765
|
# @!attribute [rw] query_errors
|
@@ -436,7 +785,7 @@ module Aws::ResourceGroups
|
|
436
785
|
# {
|
437
786
|
# filters: [
|
438
787
|
# {
|
439
|
-
# name: "resource-type", # required, accepts resource-type
|
788
|
+
# name: "resource-type", # required, accepts resource-type, configuration-type
|
440
789
|
# values: ["GroupFilterValue"], # required
|
441
790
|
# },
|
442
791
|
# ],
|
@@ -446,24 +795,41 @@ module Aws::ResourceGroups
|
|
446
795
|
#
|
447
796
|
# @!attribute [rw] filters
|
448
797
|
# Filters, formatted as GroupFilter objects, that you want to apply to
|
449
|
-
# a ListGroups operation.
|
798
|
+
# a `ListGroups` operation.
|
450
799
|
#
|
451
|
-
# * `resource-type` - Filter
|
452
|
-
# five resource types in the
|
453
|
-
#
|
800
|
+
# * `resource-type` - Filter the results to include only those of the
|
801
|
+
# specified resource types. Specify up to five resource types in the
|
802
|
+
# format `AWS::ServiceCode::ResourceType `. For example,
|
803
|
+
# `AWS::EC2::Instance`, or `AWS::S3::Bucket`.
|
454
804
|
#
|
455
|
-
#
|
805
|
+
# * `configuration-type` - Filter the results to include only those
|
806
|
+
# groups that have the specified configuration types attached. The
|
807
|
+
# current supported values are:
|
808
|
+
#
|
809
|
+
# * AWS:EC2::CapacityReservationPool
|
810
|
+
#
|
811
|
+
# ^
|
456
812
|
# @return [Array<Types::GroupFilter>]
|
457
813
|
#
|
458
814
|
# @!attribute [rw] max_results
|
459
|
-
# The
|
460
|
-
#
|
815
|
+
# The total number of results that you want included on each page of
|
816
|
+
# the response. If you do not include this parameter, it defaults to a
|
817
|
+
# value that is specific to the operation. If additional items exist
|
818
|
+
# beyond the maximum you specify, the `NextToken` response element is
|
819
|
+
# present and has a value (is not null). Include that value as the
|
820
|
+
# `NextToken` request parameter in the next call to the operation to
|
821
|
+
# get the next part of the results. Note that the service might return
|
822
|
+
# fewer results than the maximum even when there are more results
|
823
|
+
# available. You should check `NextToken` after every operation to
|
824
|
+
# ensure that you receive all of the results.
|
461
825
|
# @return [Integer]
|
462
826
|
#
|
463
827
|
# @!attribute [rw] next_token
|
464
|
-
# The
|
465
|
-
#
|
466
|
-
#
|
828
|
+
# The parameter for receiving additional results if you receive a
|
829
|
+
# `NextToken` response in a previous request. A `NextToken` response
|
830
|
+
# indicates that more output is available. Set this parameter to the
|
831
|
+
# value provided by a previous call's `NextToken` response to
|
832
|
+
# indicate where the output should continue from.
|
467
833
|
# @return [String]
|
468
834
|
#
|
469
835
|
# @see http://docs.aws.amazon.com/goto/WebAPI/resource-groups-2017-11-27/ListGroupsInput AWS API Documentation
|
@@ -478,16 +844,20 @@ module Aws::ResourceGroups
|
|
478
844
|
|
479
845
|
# @!attribute [rw] group_identifiers
|
480
846
|
# A list of GroupIdentifier objects. Each identifier is an object that
|
481
|
-
# contains both the
|
847
|
+
# contains both the `Name` and the `GroupArn`.
|
482
848
|
# @return [Array<Types::GroupIdentifier>]
|
483
849
|
#
|
484
850
|
# @!attribute [rw] groups
|
485
|
-
#
|
851
|
+
# This output element is deprecated and shouldn't be used. Refer to
|
852
|
+
# `GroupIdentifiers` instead.
|
486
853
|
# @return [Array<Types::Group>]
|
487
854
|
#
|
488
855
|
# @!attribute [rw] next_token
|
489
|
-
#
|
490
|
-
#
|
856
|
+
# If present, indicates that more output is available than is included
|
857
|
+
# in the current response. Use this value in the `NextToken` request
|
858
|
+
# parameter in a subsequent call to the operation to get the next part
|
859
|
+
# of the output. You should repeat this until the `NextToken` response
|
860
|
+
# element comes back as `null`.
|
491
861
|
# @return [String]
|
492
862
|
#
|
493
863
|
# @see http://docs.aws.amazon.com/goto/WebAPI/resource-groups-2017-11-27/ListGroupsOutput AWS API Documentation
|
@@ -500,7 +870,7 @@ module Aws::ResourceGroups
|
|
500
870
|
include Aws::Structure
|
501
871
|
end
|
502
872
|
|
503
|
-
# The request uses an HTTP method
|
873
|
+
# The request uses an HTTP method that isn't allowed for the specified
|
504
874
|
# resource.
|
505
875
|
#
|
506
876
|
# @!attribute [rw] message
|
@@ -514,7 +884,7 @@ module Aws::ResourceGroups
|
|
514
884
|
include Aws::Structure
|
515
885
|
end
|
516
886
|
|
517
|
-
# One or more
|
887
|
+
# One or more of the specified resources don't exist.
|
518
888
|
#
|
519
889
|
# @!attribute [rw] message
|
520
890
|
# @return [String]
|
@@ -606,7 +976,72 @@ module Aws::ResourceGroups
|
|
606
976
|
end
|
607
977
|
|
608
978
|
# The query that is used to define a resource group or a search for
|
609
|
-
# resources.
|
979
|
+
# resources. A query specifies both a query type and a query string as a
|
980
|
+
# JSON object. See the examples section for example JSON strings.
|
981
|
+
#
|
982
|
+
# The examples that follow are shown as standard JSON strings. If you
|
983
|
+
# include such a string as a parameter to the AWS CLI or an SDK API, you
|
984
|
+
# might need to 'escape' the string into a single line. For example,
|
985
|
+
# see the [Quoting strings][1] in the *AWS CLI User Guide*.
|
986
|
+
#
|
987
|
+
# **Example 1**
|
988
|
+
#
|
989
|
+
# The following generic example shows a resource query JSON string that
|
990
|
+
# includes only resources that meet the following criteria:
|
991
|
+
#
|
992
|
+
# * The resource type must be either `resource_type1` or
|
993
|
+
# `resource_type2`.
|
994
|
+
#
|
995
|
+
# * The resource must have a tag `Key1` with a value of either `ValueA`
|
996
|
+
# or `ValueB`.
|
997
|
+
#
|
998
|
+
# * The resource must have a tag `Key2` with a value of either `ValueC`
|
999
|
+
# or `ValueD`.
|
1000
|
+
#
|
1001
|
+
# `\{ "Type": "TAG_FILTERS_1_0", "Query": \{ "ResourceTypeFilters": [
|
1002
|
+
# "resource_type1", "resource_type2"], "TagFilters": [ \{ "Key": "Key1",
|
1003
|
+
# "Values": ["ValueA","ValueB"] \}, \{ "Key":"Key2",
|
1004
|
+
# "Values":["ValueC","ValueD"] \} ] \} \}`
|
1005
|
+
#
|
1006
|
+
# This has the equivalent "shortcut" syntax of the following:
|
1007
|
+
#
|
1008
|
+
# `\{ "Type": "TAG_FILTERS_1_0", "Query": \{ "ResourceTypeFilters": [
|
1009
|
+
# "resource_type1", "resource_type2"], "TagFilters": [ \{ "Key1":
|
1010
|
+
# ["ValueA","ValueB"] \}, \{ "Key2": ["ValueC","ValueD"] \} ] \} \}`
|
1011
|
+
#
|
1012
|
+
# **Example 2**
|
1013
|
+
#
|
1014
|
+
# The following example shows a resource query JSON string that includes
|
1015
|
+
# only Amazon EC2 instances that are tagged `Stage` with a value of
|
1016
|
+
# `Test`.
|
1017
|
+
#
|
1018
|
+
# `\{ "Type": "TAG_FILTERS_1_0", "Query": "\{ "ResourceTypeFilters":
|
1019
|
+
# "AWS::EC2::Instance", "TagFilters": \{ "Stage": "Test" \} \} \}`
|
1020
|
+
#
|
1021
|
+
# **Example 3**
|
1022
|
+
#
|
1023
|
+
# The following example shows a resource query JSON string that includes
|
1024
|
+
# resource of any supported type as long as it is tagged `Stage` with a
|
1025
|
+
# value of `Prod`.
|
1026
|
+
#
|
1027
|
+
# `\{ "Type": "TAG_FILTERS_1_0", "Query": \{ "ResourceTypeFilters":
|
1028
|
+
# "AWS::AllSupported", "TagFilters": \{ "Stage": "Prod" \} \} \}`
|
1029
|
+
#
|
1030
|
+
# **Example 4**
|
1031
|
+
#
|
1032
|
+
# The following example shows a resource query JSON string that includes
|
1033
|
+
# only Amazon EC2 instances and Amazon S3 buckets that are part of the
|
1034
|
+
# specified AWS CloudFormation stack.
|
1035
|
+
#
|
1036
|
+
# `\{ "Type": "CLOUDFORMATION_STACK_1_0", "Query": \{
|
1037
|
+
# "ResourceTypeFilters": [ "AWS::EC2::Instance", "AWS::S3::Bucket" ],
|
1038
|
+
# "StackIdentifier":
|
1039
|
+
# "arn:aws:cloudformation:us-west-2:123456789012:stack/AWStestuseraccount/fb0d5000-aba8-00e8-aa9e-50d5cEXAMPLE"
|
1040
|
+
# \} \}`
|
1041
|
+
#
|
1042
|
+
#
|
1043
|
+
#
|
1044
|
+
# [1]: https://docs.aws.amazon.com/cli/latest/userguide/cli-usage-parameters-quoting-strings.html
|
610
1045
|
#
|
611
1046
|
# @note When making an API call, you may pass ResourceQuery
|
612
1047
|
# data as a hash:
|
@@ -617,50 +1052,50 @@ module Aws::ResourceGroups
|
|
617
1052
|
# }
|
618
1053
|
#
|
619
1054
|
# @!attribute [rw] type
|
620
|
-
# The type of the query.
|
621
|
-
# `TAG_FILTERS_1_0` and `CLOUDFORMATION_STACK_1_0`.
|
1055
|
+
# The type of the query. You can use the following values:
|
622
1056
|
#
|
623
|
-
# <i> <code>
|
624
|
-
#
|
625
|
-
# tags, as supported by the AWS Tagging API [GetResources][1]
|
626
|
-
# operation. If you specify more than one tag key, only resources that
|
627
|
-
# match all tag keys, and at least one value of each specified tag
|
628
|
-
# key, are returned in your query. If you specify more than one value
|
629
|
-
# for a tag key, a resource matches the filter if it has a tag key
|
630
|
-
# value that matches *any* of the specified values.
|
1057
|
+
# * <i> <code>CLOUDFORMATION_STACK_1_0:</code> </i>Specifies that the
|
1058
|
+
# `Query` contains an ARN for a CloudFormation stack.
|
631
1059
|
#
|
632
|
-
#
|
633
|
-
#
|
634
|
-
#
|
635
|
-
#
|
1060
|
+
# * <i> <code>TAG_FILTERS_1_0:</code> </i>Specifies that the `Query`
|
1061
|
+
# parameter contains a JSON string that represents a collection of
|
1062
|
+
# simple tag filters for resource types and tags. The JSON string
|
1063
|
+
# uses a syntax similar to the ` GetResources ` operation, but uses
|
1064
|
+
# only the ` ResourceTypeFilters ` and ` TagFilters ` fields. If
|
1065
|
+
# you specify more than one tag key, only resources that match all
|
1066
|
+
# tag keys, and at least one value of each specified tag key, are
|
1067
|
+
# returned in your query. If you specify more than one value for a
|
1068
|
+
# tag key, a resource matches the filter if it has a tag key value
|
1069
|
+
# that matches *any* of the specified values.
|
636
1070
|
#
|
637
|
-
#
|
638
|
-
#
|
639
|
-
# `\{"Key":"Version","Value":"2"\}`
|
1071
|
+
# For example, consider the following sample query for resources
|
1072
|
+
# that have two tags, `Stage` and `Version`, with two values each:
|
640
1073
|
#
|
641
|
-
#
|
642
|
-
# \\\{"Key":"Stage","Value":"Test"\\}, and
|
643
|
-
# \\\{"Key":"Version","Value":"1"\\}
|
1074
|
+
# `[\{"Stage":["Test","Deploy"]\},\{"Version":["1","2"]\}]`
|
644
1075
|
#
|
645
|
-
#
|
646
|
-
# following EC2 instance does not have all tag keys specified in the
|
647
|
-
# filter, so it is rejected. The RDS database has all of the tag keys,
|
648
|
-
# but no values that match at least one of the specified tag key
|
649
|
-
# values in the filter.
|
1076
|
+
# The results of this query could include the following.
|
650
1077
|
#
|
651
|
-
#
|
652
|
-
#
|
1078
|
+
# * An EC2 instance that has the following two tags:
|
1079
|
+
# `\{"Stage":"Deploy"\}`, and `\{"Version":"2"\}`
|
653
1080
|
#
|
654
|
-
#
|
655
|
-
#
|
656
|
-
# `\{"Key":"Version","Value":"4"\}`
|
1081
|
+
# * An S3 bucket that has the following two tags:
|
1082
|
+
# `\{"Stage":"Test"\}`, and `\{"Version":"1"\}`
|
657
1083
|
#
|
658
|
-
#
|
659
|
-
#
|
1084
|
+
# The query would not include the following items in the results,
|
1085
|
+
# however.
|
660
1086
|
#
|
1087
|
+
# * An EC2 instance that has only the following tag:
|
1088
|
+
# `\{"Stage":"Deploy"\}`.
|
661
1089
|
#
|
1090
|
+
# The instance does not have **all** of the tag keys specified in
|
1091
|
+
# the filter, so it is excluded from the results.
|
662
1092
|
#
|
663
|
-
#
|
1093
|
+
# * An RDS database that has the following two tags:
|
1094
|
+
# `\{"Stage":"Archived"\}` and `\{"Version":"4"\}`
|
1095
|
+
#
|
1096
|
+
# The database has all of the tag keys, but none of those keys has
|
1097
|
+
# an associated value that matches at least one of the specified
|
1098
|
+
# values in the filter.
|
664
1099
|
# @return [String]
|
665
1100
|
#
|
666
1101
|
# @!attribute [rw] query
|
@@ -690,20 +1125,28 @@ module Aws::ResourceGroups
|
|
690
1125
|
#
|
691
1126
|
# @!attribute [rw] resource_query
|
692
1127
|
# The search query, using the same formats that are supported for
|
693
|
-
# resource group definition.
|
1128
|
+
# resource group definition. For more information, see CreateGroup.
|
694
1129
|
# @return [Types::ResourceQuery]
|
695
1130
|
#
|
696
1131
|
# @!attribute [rw] max_results
|
697
|
-
# The
|
698
|
-
#
|
699
|
-
#
|
1132
|
+
# The total number of results that you want included on each page of
|
1133
|
+
# the response. If you do not include this parameter, it defaults to a
|
1134
|
+
# value that is specific to the operation. If additional items exist
|
1135
|
+
# beyond the maximum you specify, the `NextToken` response element is
|
1136
|
+
# present and has a value (is not null). Include that value as the
|
1137
|
+
# `NextToken` request parameter in the next call to the operation to
|
1138
|
+
# get the next part of the results. Note that the service might return
|
1139
|
+
# fewer results than the maximum even when there are more results
|
1140
|
+
# available. You should check `NextToken` after every operation to
|
1141
|
+
# ensure that you receive all of the results.
|
700
1142
|
# @return [Integer]
|
701
1143
|
#
|
702
1144
|
# @!attribute [rw] next_token
|
703
|
-
# The
|
704
|
-
# `
|
705
|
-
#
|
706
|
-
# value
|
1145
|
+
# The parameter for receiving additional results if you receive a
|
1146
|
+
# `NextToken` response in a previous request. A `NextToken` response
|
1147
|
+
# indicates that more output is available. Set this parameter to the
|
1148
|
+
# value provided by a previous call's `NextToken` response to
|
1149
|
+
# indicate where the output should continue from.
|
707
1150
|
# @return [String]
|
708
1151
|
#
|
709
1152
|
# @see http://docs.aws.amazon.com/goto/WebAPI/resource-groups-2017-11-27/SearchResourcesInput AWS API Documentation
|
@@ -722,8 +1165,11 @@ module Aws::ResourceGroups
|
|
722
1165
|
# @return [Array<Types::ResourceIdentifier>]
|
723
1166
|
#
|
724
1167
|
# @!attribute [rw] next_token
|
725
|
-
#
|
726
|
-
#
|
1168
|
+
# If present, indicates that more output is available than is included
|
1169
|
+
# in the current response. Use this value in the `NextToken` request
|
1170
|
+
# parameter in a subsequent call to the operation to get the next part
|
1171
|
+
# of the output. You should repeat this until the `NextToken` response
|
1172
|
+
# element comes back as `null`.
|
727
1173
|
# @return [String]
|
728
1174
|
#
|
729
1175
|
# @!attribute [rw] query_errors
|
@@ -754,14 +1200,12 @@ module Aws::ResourceGroups
|
|
754
1200
|
# }
|
755
1201
|
#
|
756
1202
|
# @!attribute [rw] arn
|
757
|
-
# The ARN of the resource to which to add tags.
|
1203
|
+
# The ARN of the resource group to which to add tags.
|
758
1204
|
# @return [String]
|
759
1205
|
#
|
760
1206
|
# @!attribute [rw] tags
|
761
|
-
# The tags to add to the specified resource. A tag is a
|
762
|
-
# string-to-string map of key-value pairs.
|
763
|
-
# character length of 128 characters, and tag values can have a
|
764
|
-
# maximum length of 256 characters.
|
1207
|
+
# The tags to add to the specified resource group. A tag is a
|
1208
|
+
# string-to-string map of key-value pairs.
|
765
1209
|
# @return [Hash<String,String>]
|
766
1210
|
#
|
767
1211
|
# @see http://docs.aws.amazon.com/goto/WebAPI/resource-groups-2017-11-27/TagInput AWS API Documentation
|
@@ -778,7 +1222,7 @@ module Aws::ResourceGroups
|
|
778
1222
|
# @return [String]
|
779
1223
|
#
|
780
1224
|
# @!attribute [rw] tags
|
781
|
-
# The tags that have been added to the specified resource.
|
1225
|
+
# The tags that have been added to the specified resource group.
|
782
1226
|
# @return [Hash<String,String>]
|
783
1227
|
#
|
784
1228
|
# @see http://docs.aws.amazon.com/goto/WebAPI/resource-groups-2017-11-27/TagOutput AWS API Documentation
|
@@ -790,7 +1234,8 @@ module Aws::ResourceGroups
|
|
790
1234
|
include Aws::Structure
|
791
1235
|
end
|
792
1236
|
|
793
|
-
#
|
1237
|
+
# You've exceeded throttling limits by making too many requests in a
|
1238
|
+
# period of time.
|
794
1239
|
#
|
795
1240
|
# @!attribute [rw] message
|
796
1241
|
# @return [String]
|
@@ -803,8 +1248,8 @@ module Aws::ResourceGroups
|
|
803
1248
|
include Aws::Structure
|
804
1249
|
end
|
805
1250
|
|
806
|
-
# The request
|
807
|
-
#
|
1251
|
+
# The request was rejected because it doesn't have valid credentials
|
1252
|
+
# for the target resource.
|
808
1253
|
#
|
809
1254
|
# @!attribute [rw] message
|
810
1255
|
# @return [String]
|
@@ -817,6 +1262,50 @@ module Aws::ResourceGroups
|
|
817
1262
|
include Aws::Structure
|
818
1263
|
end
|
819
1264
|
|
1265
|
+
# @note When making an API call, you may pass UngroupResourcesInput
|
1266
|
+
# data as a hash:
|
1267
|
+
#
|
1268
|
+
# {
|
1269
|
+
# group: "GroupString", # required
|
1270
|
+
# resource_arns: ["ResourceArn"], # required
|
1271
|
+
# }
|
1272
|
+
#
|
1273
|
+
# @!attribute [rw] group
|
1274
|
+
# The name or the ARN of the resource group from which to remove the
|
1275
|
+
# resources.
|
1276
|
+
# @return [String]
|
1277
|
+
#
|
1278
|
+
# @!attribute [rw] resource_arns
|
1279
|
+
# The ARNs of the resources to be removed from the group.
|
1280
|
+
# @return [Array<String>]
|
1281
|
+
#
|
1282
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/resource-groups-2017-11-27/UngroupResourcesInput AWS API Documentation
|
1283
|
+
#
|
1284
|
+
class UngroupResourcesInput < Struct.new(
|
1285
|
+
:group,
|
1286
|
+
:resource_arns)
|
1287
|
+
SENSITIVE = []
|
1288
|
+
include Aws::Structure
|
1289
|
+
end
|
1290
|
+
|
1291
|
+
# @!attribute [rw] succeeded
|
1292
|
+
# The ARNs of the resources that were successfully removed from the
|
1293
|
+
# group.
|
1294
|
+
# @return [Array<String>]
|
1295
|
+
#
|
1296
|
+
# @!attribute [rw] failed
|
1297
|
+
# The resources that failed to be removed from the group.
|
1298
|
+
# @return [Array<Types::FailedResource>]
|
1299
|
+
#
|
1300
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/resource-groups-2017-11-27/UngroupResourcesOutput AWS API Documentation
|
1301
|
+
#
|
1302
|
+
class UngroupResourcesOutput < Struct.new(
|
1303
|
+
:succeeded,
|
1304
|
+
:failed)
|
1305
|
+
SENSITIVE = []
|
1306
|
+
include Aws::Structure
|
1307
|
+
end
|
1308
|
+
|
820
1309
|
# @note When making an API call, you may pass UntagInput
|
821
1310
|
# data as a hash:
|
822
1311
|
#
|
@@ -826,7 +1315,9 @@ module Aws::ResourceGroups
|
|
826
1315
|
# }
|
827
1316
|
#
|
828
1317
|
# @!attribute [rw] arn
|
829
|
-
# The ARN of the resource from which to remove tags.
|
1318
|
+
# The ARN of the resource group from which to remove tags. The command
|
1319
|
+
# removed both the specified keys and any values associated with those
|
1320
|
+
# keys.
|
830
1321
|
# @return [String]
|
831
1322
|
#
|
832
1323
|
# @!attribute [rw] keys
|
@@ -843,11 +1334,11 @@ module Aws::ResourceGroups
|
|
843
1334
|
end
|
844
1335
|
|
845
1336
|
# @!attribute [rw] arn
|
846
|
-
# The ARN of the resource from which tags have been removed.
|
1337
|
+
# The ARN of the resource group from which tags have been removed.
|
847
1338
|
# @return [String]
|
848
1339
|
#
|
849
1340
|
# @!attribute [rw] keys
|
850
|
-
# The keys of tags that
|
1341
|
+
# The keys of the tags that were removed.
|
851
1342
|
# @return [Array<String>]
|
852
1343
|
#
|
853
1344
|
# @see http://docs.aws.amazon.com/goto/WebAPI/resource-groups-2017-11-27/UntagOutput AWS API Documentation
|
@@ -863,33 +1354,37 @@ module Aws::ResourceGroups
|
|
863
1354
|
# data as a hash:
|
864
1355
|
#
|
865
1356
|
# {
|
866
|
-
# group_name: "GroupName",
|
867
|
-
#
|
1357
|
+
# group_name: "GroupName",
|
1358
|
+
# group: "GroupString",
|
1359
|
+
# description: "Description",
|
868
1360
|
# }
|
869
1361
|
#
|
870
1362
|
# @!attribute [rw] group_name
|
871
|
-
#
|
872
|
-
#
|
1363
|
+
# Don't use this parameter. Use `Group` instead.
|
1364
|
+
# @return [String]
|
1365
|
+
#
|
1366
|
+
# @!attribute [rw] group
|
1367
|
+
# The name or the ARN of the resource group to modify.
|
873
1368
|
# @return [String]
|
874
1369
|
#
|
875
1370
|
# @!attribute [rw] description
|
876
|
-
# The description
|
877
|
-
#
|
878
|
-
#
|
1371
|
+
# The new description that you want to update the resource group with.
|
1372
|
+
# Descriptions can contain letters, numbers, hyphens, underscores,
|
1373
|
+
# periods, and spaces.
|
879
1374
|
# @return [String]
|
880
1375
|
#
|
881
1376
|
# @see http://docs.aws.amazon.com/goto/WebAPI/resource-groups-2017-11-27/UpdateGroupInput AWS API Documentation
|
882
1377
|
#
|
883
1378
|
class UpdateGroupInput < Struct.new(
|
884
1379
|
:group_name,
|
1380
|
+
:group,
|
885
1381
|
:description)
|
886
1382
|
SENSITIVE = []
|
887
1383
|
include Aws::Structure
|
888
1384
|
end
|
889
1385
|
|
890
1386
|
# @!attribute [rw] group
|
891
|
-
# The
|
892
|
-
# updated.
|
1387
|
+
# The update description of the resource group.
|
893
1388
|
# @return [Types::Group]
|
894
1389
|
#
|
895
1390
|
# @see http://docs.aws.amazon.com/goto/WebAPI/resource-groups-2017-11-27/UpdateGroupOutput AWS API Documentation
|
@@ -904,7 +1399,8 @@ module Aws::ResourceGroups
|
|
904
1399
|
# data as a hash:
|
905
1400
|
#
|
906
1401
|
# {
|
907
|
-
# group_name: "GroupName",
|
1402
|
+
# group_name: "GroupName",
|
1403
|
+
# group: "GroupString",
|
908
1404
|
# resource_query: { # required
|
909
1405
|
# type: "TAG_FILTERS_1_0", # required, accepts TAG_FILTERS_1_0, CLOUDFORMATION_STACK_1_0
|
910
1406
|
# query: "Query", # required
|
@@ -912,26 +1408,31 @@ module Aws::ResourceGroups
|
|
912
1408
|
# }
|
913
1409
|
#
|
914
1410
|
# @!attribute [rw] group_name
|
915
|
-
#
|
1411
|
+
# Don't use this parameter. Use `Group` instead.
|
1412
|
+
# @return [String]
|
1413
|
+
#
|
1414
|
+
# @!attribute [rw] group
|
1415
|
+
# The name or the ARN of the resource group to query.
|
916
1416
|
# @return [String]
|
917
1417
|
#
|
918
1418
|
# @!attribute [rw] resource_query
|
919
|
-
# The resource query
|
920
|
-
#
|
1419
|
+
# The resource query to determine which AWS resources are members of
|
1420
|
+
# this resource group.
|
921
1421
|
# @return [Types::ResourceQuery]
|
922
1422
|
#
|
923
1423
|
# @see http://docs.aws.amazon.com/goto/WebAPI/resource-groups-2017-11-27/UpdateGroupQueryInput AWS API Documentation
|
924
1424
|
#
|
925
1425
|
class UpdateGroupQueryInput < Struct.new(
|
926
1426
|
:group_name,
|
1427
|
+
:group,
|
927
1428
|
:resource_query)
|
928
1429
|
SENSITIVE = []
|
929
1430
|
include Aws::Structure
|
930
1431
|
end
|
931
1432
|
|
932
1433
|
# @!attribute [rw] group_query
|
933
|
-
# The resource query associated with the resource group after
|
934
|
-
# update.
|
1434
|
+
# The updated resource query associated with the resource group after
|
1435
|
+
# the update.
|
935
1436
|
# @return [Types::GroupQuery]
|
936
1437
|
#
|
937
1438
|
# @see http://docs.aws.amazon.com/goto/WebAPI/resource-groups-2017-11-27/UpdateGroupQueryOutput AWS API Documentation
|