aws-sdk-resourcegroups 1.28.0 → 1.33.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 +266 -27
- data/lib/aws-sdk-resourcegroups/client_api.rb +46 -1
- data/lib/aws-sdk-resourcegroups/types.rb +334 -104
- metadata +4 -4
@@ -60,6 +60,8 @@ module Aws::ResourceGroups
|
|
60
60
|
GroupString = Shapes::StringShape.new(name: 'GroupString')
|
61
61
|
InternalServerErrorException = Shapes::StructureShape.new(name: 'InternalServerErrorException')
|
62
62
|
ListGroupResourcesInput = Shapes::StructureShape.new(name: 'ListGroupResourcesInput')
|
63
|
+
ListGroupResourcesItem = Shapes::StructureShape.new(name: 'ListGroupResourcesItem')
|
64
|
+
ListGroupResourcesItemList = Shapes::ListShape.new(name: 'ListGroupResourcesItemList')
|
63
65
|
ListGroupResourcesOutput = Shapes::StructureShape.new(name: 'ListGroupResourcesOutput')
|
64
66
|
ListGroupsInput = Shapes::StructureShape.new(name: 'ListGroupsInput')
|
65
67
|
ListGroupsOutput = Shapes::StructureShape.new(name: 'ListGroupsOutput')
|
@@ -67,6 +69,10 @@ module Aws::ResourceGroups
|
|
67
69
|
MethodNotAllowedException = Shapes::StructureShape.new(name: 'MethodNotAllowedException')
|
68
70
|
NextToken = Shapes::StringShape.new(name: 'NextToken')
|
69
71
|
NotFoundException = Shapes::StructureShape.new(name: 'NotFoundException')
|
72
|
+
PendingResource = Shapes::StructureShape.new(name: 'PendingResource')
|
73
|
+
PendingResourceList = Shapes::ListShape.new(name: 'PendingResourceList')
|
74
|
+
PutGroupConfigurationInput = Shapes::StructureShape.new(name: 'PutGroupConfigurationInput')
|
75
|
+
PutGroupConfigurationOutput = Shapes::StructureShape.new(name: 'PutGroupConfigurationOutput')
|
70
76
|
Query = Shapes::StringShape.new(name: 'Query')
|
71
77
|
QueryError = Shapes::StructureShape.new(name: 'QueryError')
|
72
78
|
QueryErrorCode = Shapes::StringShape.new(name: 'QueryErrorCode')
|
@@ -83,6 +89,8 @@ module Aws::ResourceGroups
|
|
83
89
|
ResourceIdentifier = Shapes::StructureShape.new(name: 'ResourceIdentifier')
|
84
90
|
ResourceIdentifierList = Shapes::ListShape.new(name: 'ResourceIdentifierList')
|
85
91
|
ResourceQuery = Shapes::StructureShape.new(name: 'ResourceQuery')
|
92
|
+
ResourceStatus = Shapes::StructureShape.new(name: 'ResourceStatus')
|
93
|
+
ResourceStatusValue = Shapes::StringShape.new(name: 'ResourceStatusValue')
|
86
94
|
ResourceType = Shapes::StringShape.new(name: 'ResourceType')
|
87
95
|
SearchResourcesInput = Shapes::StructureShape.new(name: 'SearchResourcesInput')
|
88
96
|
SearchResourcesOutput = Shapes::StructureShape.new(name: 'SearchResourcesOutput')
|
@@ -214,6 +222,7 @@ module Aws::ResourceGroups
|
|
214
222
|
|
215
223
|
GroupResourcesOutput.add_member(:succeeded, Shapes::ShapeRef.new(shape: ResourceArnList, location_name: "Succeeded"))
|
216
224
|
GroupResourcesOutput.add_member(:failed, Shapes::ShapeRef.new(shape: FailedResourceList, location_name: "Failed"))
|
225
|
+
GroupResourcesOutput.add_member(:pending, Shapes::ShapeRef.new(shape: PendingResourceList, location_name: "Pending"))
|
217
226
|
GroupResourcesOutput.struct_class = Types::GroupResourcesOutput
|
218
227
|
|
219
228
|
InternalServerErrorException.add_member(:message, Shapes::ShapeRef.new(shape: ErrorMessage, location_name: "Message"))
|
@@ -226,7 +235,14 @@ module Aws::ResourceGroups
|
|
226
235
|
ListGroupResourcesInput.add_member(:next_token, Shapes::ShapeRef.new(shape: NextToken, location_name: "NextToken"))
|
227
236
|
ListGroupResourcesInput.struct_class = Types::ListGroupResourcesInput
|
228
237
|
|
229
|
-
|
238
|
+
ListGroupResourcesItem.add_member(:identifier, Shapes::ShapeRef.new(shape: ResourceIdentifier, location_name: "Identifier"))
|
239
|
+
ListGroupResourcesItem.add_member(:status, Shapes::ShapeRef.new(shape: ResourceStatus, location_name: "Status"))
|
240
|
+
ListGroupResourcesItem.struct_class = Types::ListGroupResourcesItem
|
241
|
+
|
242
|
+
ListGroupResourcesItemList.member = Shapes::ShapeRef.new(shape: ListGroupResourcesItem)
|
243
|
+
|
244
|
+
ListGroupResourcesOutput.add_member(:resources, Shapes::ShapeRef.new(shape: ListGroupResourcesItemList, location_name: "Resources"))
|
245
|
+
ListGroupResourcesOutput.add_member(:resource_identifiers, Shapes::ShapeRef.new(shape: ResourceIdentifierList, deprecated: true, location_name: "ResourceIdentifiers", metadata: {"deprecatedMessage"=>"This field is deprecated, use Resources instead."}))
|
230
246
|
ListGroupResourcesOutput.add_member(:next_token, Shapes::ShapeRef.new(shape: NextToken, location_name: "NextToken"))
|
231
247
|
ListGroupResourcesOutput.add_member(:query_errors, Shapes::ShapeRef.new(shape: QueryErrorList, location_name: "QueryErrors"))
|
232
248
|
ListGroupResourcesOutput.struct_class = Types::ListGroupResourcesOutput
|
@@ -247,6 +263,17 @@ module Aws::ResourceGroups
|
|
247
263
|
NotFoundException.add_member(:message, Shapes::ShapeRef.new(shape: ErrorMessage, location_name: "Message"))
|
248
264
|
NotFoundException.struct_class = Types::NotFoundException
|
249
265
|
|
266
|
+
PendingResource.add_member(:resource_arn, Shapes::ShapeRef.new(shape: ResourceArn, location_name: "ResourceArn"))
|
267
|
+
PendingResource.struct_class = Types::PendingResource
|
268
|
+
|
269
|
+
PendingResourceList.member = Shapes::ShapeRef.new(shape: PendingResource)
|
270
|
+
|
271
|
+
PutGroupConfigurationInput.add_member(:group, Shapes::ShapeRef.new(shape: GroupString, location_name: "Group"))
|
272
|
+
PutGroupConfigurationInput.add_member(:configuration, Shapes::ShapeRef.new(shape: GroupConfigurationList, location_name: "Configuration"))
|
273
|
+
PutGroupConfigurationInput.struct_class = Types::PutGroupConfigurationInput
|
274
|
+
|
275
|
+
PutGroupConfigurationOutput.struct_class = Types::PutGroupConfigurationOutput
|
276
|
+
|
250
277
|
QueryError.add_member(:error_code, Shapes::ShapeRef.new(shape: QueryErrorCode, location_name: "ErrorCode"))
|
251
278
|
QueryError.add_member(:message, Shapes::ShapeRef.new(shape: QueryErrorMessage, location_name: "Message"))
|
252
279
|
QueryError.struct_class = Types::QueryError
|
@@ -273,6 +300,9 @@ module Aws::ResourceGroups
|
|
273
300
|
ResourceQuery.add_member(:query, Shapes::ShapeRef.new(shape: Query, required: true, location_name: "Query"))
|
274
301
|
ResourceQuery.struct_class = Types::ResourceQuery
|
275
302
|
|
303
|
+
ResourceStatus.add_member(:name, Shapes::ShapeRef.new(shape: ResourceStatusValue, location_name: "Name"))
|
304
|
+
ResourceStatus.struct_class = Types::ResourceStatus
|
305
|
+
|
276
306
|
SearchResourcesInput.add_member(:resource_query, Shapes::ShapeRef.new(shape: ResourceQuery, required: true, location_name: "ResourceQuery"))
|
277
307
|
SearchResourcesInput.add_member(:max_results, Shapes::ShapeRef.new(shape: MaxResults, location_name: "MaxResults"))
|
278
308
|
SearchResourcesInput.add_member(:next_token, Shapes::ShapeRef.new(shape: NextToken, location_name: "NextToken"))
|
@@ -308,6 +338,7 @@ module Aws::ResourceGroups
|
|
308
338
|
|
309
339
|
UngroupResourcesOutput.add_member(:succeeded, Shapes::ShapeRef.new(shape: ResourceArnList, location_name: "Succeeded"))
|
310
340
|
UngroupResourcesOutput.add_member(:failed, Shapes::ShapeRef.new(shape: FailedResourceList, location_name: "Failed"))
|
341
|
+
UngroupResourcesOutput.add_member(:pending, Shapes::ShapeRef.new(shape: PendingResourceList, location_name: "Pending"))
|
311
342
|
UngroupResourcesOutput.struct_class = Types::UngroupResourcesOutput
|
312
343
|
|
313
344
|
UntagInput.add_member(:arn, Shapes::ShapeRef.new(shape: GroupArn, required: true, location: "uri", location_name: "Arn"))
|
@@ -489,6 +520,20 @@ module Aws::ResourceGroups
|
|
489
520
|
)
|
490
521
|
end)
|
491
522
|
|
523
|
+
api.add_operation(:put_group_configuration, Seahorse::Model::Operation.new.tap do |o|
|
524
|
+
o.name = "PutGroupConfiguration"
|
525
|
+
o.http_method = "POST"
|
526
|
+
o.http_request_uri = "/put-group-configuration"
|
527
|
+
o.input = Shapes::ShapeRef.new(shape: PutGroupConfigurationInput)
|
528
|
+
o.output = Shapes::ShapeRef.new(shape: PutGroupConfigurationOutput)
|
529
|
+
o.errors << Shapes::ShapeRef.new(shape: BadRequestException)
|
530
|
+
o.errors << Shapes::ShapeRef.new(shape: ForbiddenException)
|
531
|
+
o.errors << Shapes::ShapeRef.new(shape: NotFoundException)
|
532
|
+
o.errors << Shapes::ShapeRef.new(shape: MethodNotAllowedException)
|
533
|
+
o.errors << Shapes::ShapeRef.new(shape: TooManyRequestsException)
|
534
|
+
o.errors << Shapes::ShapeRef.new(shape: InternalServerErrorException)
|
535
|
+
end)
|
536
|
+
|
492
537
|
api.add_operation(:search_resources, Seahorse::Model::Operation.new.tap do |o|
|
493
538
|
o.name = "SearchResources"
|
494
539
|
o.http_method = "POST"
|
@@ -66,12 +66,17 @@ module Aws::ResourceGroups
|
|
66
66
|
#
|
67
67
|
# @!attribute [rw] resource_query
|
68
68
|
# The resource query that determines which AWS resources are members
|
69
|
-
# of this group.
|
69
|
+
# of this group. For more information about resource queries, see
|
70
|
+
# [Create a tag-based group in Resource Groups][1].
|
70
71
|
#
|
71
|
-
# <note markdown="1">
|
72
|
-
# not both.
|
72
|
+
# <note markdown="1"> A resource group can contain either a `ResourceQuery` or a
|
73
|
+
# `Configuration`, but not both.
|
73
74
|
#
|
74
75
|
# </note>
|
76
|
+
#
|
77
|
+
#
|
78
|
+
#
|
79
|
+
# [1]: https://docs.aws.amazon.com/ARG/latest/userguide/gettingstarted-query.html#gettingstarted-query-cli-tag
|
75
80
|
# @return [Types::ResourceQuery]
|
76
81
|
#
|
77
82
|
# @!attribute [rw] tags
|
@@ -82,12 +87,17 @@ module Aws::ResourceGroups
|
|
82
87
|
# A configuration associates the resource group with an AWS service
|
83
88
|
# and specifies how the service can interact with the resources in the
|
84
89
|
# group. A configuration is an array of GroupConfigurationItem
|
85
|
-
# elements.
|
90
|
+
# elements. For details about the syntax of service configurations,
|
91
|
+
# see [Service configurations for resource groups][1].
|
86
92
|
#
|
87
|
-
# <note markdown="1">
|
88
|
-
#
|
93
|
+
# <note markdown="1"> A resource group can contain either a `Configuration` or a
|
94
|
+
# `ResourceQuery`, but not both.
|
89
95
|
#
|
90
96
|
# </note>
|
97
|
+
#
|
98
|
+
#
|
99
|
+
#
|
100
|
+
# [1]: https://docs.aws.amazon.com/ARG/latest/APIReference/about-slg.html
|
91
101
|
# @return [Array<Types::GroupConfigurationItem>]
|
92
102
|
#
|
93
103
|
# @see http://docs.aws.amazon.com/goto/WebAPI/resource-groups-2017-11-27/CreateGroupInput AWS API Documentation
|
@@ -107,7 +117,13 @@ module Aws::ResourceGroups
|
|
107
117
|
# @return [Types::Group]
|
108
118
|
#
|
109
119
|
# @!attribute [rw] resource_query
|
110
|
-
# The resource query associated with the group.
|
120
|
+
# The resource query associated with the group. For more information
|
121
|
+
# about resource queries, see [Create a tag-based group in Resource
|
122
|
+
# Groups][1].
|
123
|
+
#
|
124
|
+
#
|
125
|
+
#
|
126
|
+
# [1]: https://docs.aws.amazon.com/ARG/latest/userguide/gettingstarted-query.html#gettingstarted-query-cli-tag
|
111
127
|
# @return [Types::ResourceQuery]
|
112
128
|
#
|
113
129
|
# @!attribute [rw] tags
|
@@ -115,19 +131,13 @@ module Aws::ResourceGroups
|
|
115
131
|
# @return [Hash<String,String>]
|
116
132
|
#
|
117
133
|
# @!attribute [rw] group_configuration
|
118
|
-
# The service configuration associated with the resource group.
|
119
|
-
#
|
120
|
-
#
|
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
|
-
# ^
|
134
|
+
# The service configuration associated with the resource group. For
|
135
|
+
# details about the syntax of a service configuration, see [Service
|
136
|
+
# configurations for resource groups][1].
|
127
137
|
#
|
128
138
|
#
|
129
139
|
#
|
130
|
-
# [1]: https://docs.aws.amazon.com/
|
140
|
+
# [1]: https://docs.aws.amazon.com/ARG/latest/APIReference/about-slg.html
|
131
141
|
# @return [Types::GroupConfiguration]
|
132
142
|
#
|
133
143
|
# @see http://docs.aws.amazon.com/goto/WebAPI/resource-groups-2017-11-27/CreateGroupOutput AWS API Documentation
|
@@ -150,7 +160,7 @@ module Aws::ResourceGroups
|
|
150
160
|
# }
|
151
161
|
#
|
152
162
|
# @!attribute [rw] group_name
|
153
|
-
#
|
163
|
+
# Deprecated - don't use this parameter. Use `Group` instead.
|
154
164
|
# @return [String]
|
155
165
|
#
|
156
166
|
# @!attribute [rw] group
|
@@ -235,7 +245,13 @@ module Aws::ResourceGroups
|
|
235
245
|
end
|
236
246
|
|
237
247
|
# @!attribute [rw] group_configuration
|
238
|
-
# The configuration associated with the specified group.
|
248
|
+
# The service configuration associated with the specified group. For
|
249
|
+
# details about the service configuration syntax, see [Service
|
250
|
+
# configurations for resource groups][1].
|
251
|
+
#
|
252
|
+
#
|
253
|
+
#
|
254
|
+
# [1]: https://docs.aws.amazon.com/ARG/latest/APIReference/about-slg.html
|
239
255
|
# @return [Types::GroupConfiguration]
|
240
256
|
#
|
241
257
|
# @see http://docs.aws.amazon.com/goto/WebAPI/resource-groups-2017-11-27/GetGroupConfigurationOutput AWS API Documentation
|
@@ -255,7 +271,7 @@ module Aws::ResourceGroups
|
|
255
271
|
# }
|
256
272
|
#
|
257
273
|
# @!attribute [rw] group_name
|
258
|
-
#
|
274
|
+
# Deprecated - don't use this parameter. Use `Group` instead.
|
259
275
|
# @return [String]
|
260
276
|
#
|
261
277
|
# @!attribute [rw] group
|
@@ -309,7 +325,13 @@ module Aws::ResourceGroups
|
|
309
325
|
end
|
310
326
|
|
311
327
|
# @!attribute [rw] group_query
|
312
|
-
# The resource query associated with the specified group.
|
328
|
+
# The resource query associated with the specified group. For more
|
329
|
+
# information about resource queries, see [Create a tag-based group in
|
330
|
+
# Resource Groups][1].
|
331
|
+
#
|
332
|
+
#
|
333
|
+
#
|
334
|
+
# [1]: https://docs.aws.amazon.com/ARG/latest/userguide/gettingstarted-query.html#gettingstarted-query-cli-tag
|
313
335
|
# @return [Types::GroupQuery]
|
314
336
|
#
|
315
337
|
# @see http://docs.aws.amazon.com/goto/WebAPI/resource-groups-2017-11-27/GetGroupQueryOutput AWS API Documentation
|
@@ -363,7 +385,8 @@ module Aws::ResourceGroups
|
|
363
385
|
# * ResourceQuery - Use a resource query to specify a set of tag keys
|
364
386
|
# and values. All resources in the same AWS Region and AWS account
|
365
387
|
# 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
|
388
|
+
# You can add a resource query when you create the group, or later by
|
389
|
+
# using the PutGroupConfiguration operation.
|
367
390
|
#
|
368
391
|
# * GroupConfiguration - Use a service configuration to associate the
|
369
392
|
# group with an AWS service. The configuration specifies which
|
@@ -394,7 +417,14 @@ module Aws::ResourceGroups
|
|
394
417
|
# A service configuration associated with a resource group. The
|
395
418
|
# configuration options are determined by the AWS service that defines
|
396
419
|
# the `Type`, and specifies which resources can be included in the
|
397
|
-
# group. You can add a service configuration when you create the group
|
420
|
+
# group. You can add a service configuration when you create the group
|
421
|
+
# by using CreateGroup, or later by using the PutGroupConfiguration
|
422
|
+
# operation. For details about group service configuration syntax, see
|
423
|
+
# [Service configurations for resource groups][1].
|
424
|
+
#
|
425
|
+
#
|
426
|
+
#
|
427
|
+
# [1]: https://docs.aws.amazon.com/ARG/latest/APIReference/about-slg.html
|
398
428
|
#
|
399
429
|
# @!attribute [rw] configuration
|
400
430
|
# The configuration currently associated with the group and in effect.
|
@@ -425,8 +455,13 @@ module Aws::ResourceGroups
|
|
425
455
|
include Aws::Structure
|
426
456
|
end
|
427
457
|
|
428
|
-
# An item in a group configuration. A group configuration can
|
429
|
-
# or more items.
|
458
|
+
# An item in a group configuration. A group service configuration can
|
459
|
+
# have one or more items. For details about group service configuration
|
460
|
+
# syntax, see [Service configurations for resource groups][1].
|
461
|
+
#
|
462
|
+
#
|
463
|
+
#
|
464
|
+
# [1]: https://docs.aws.amazon.com/ARG/latest/APIReference/about-slg.html
|
430
465
|
#
|
431
466
|
# @note When making an API call, you may pass GroupConfigurationItem
|
432
467
|
# data as a hash:
|
@@ -443,26 +478,23 @@ module Aws::ResourceGroups
|
|
443
478
|
#
|
444
479
|
# @!attribute [rw] type
|
445
480
|
# Specifies the type of group configuration item. Each item must have
|
446
|
-
# a unique value for `type`.
|
481
|
+
# a unique value for `type`. For the list of types that you can
|
482
|
+
# specify for a configuration item, see [Supported resource types and
|
483
|
+
# parameters][1].
|
447
484
|
#
|
448
|
-
# You can specify the following string values:
|
449
485
|
#
|
450
|
-
# * `AWS::EC2::CapacityReservationPool`
|
451
486
|
#
|
452
|
-
#
|
453
|
-
#
|
454
|
-
# Guide*.
|
487
|
+
# [1]: https://docs.aws.amazon.com/ARG/latest/APIReference/about-slg.html#about-slg-types
|
488
|
+
# @return [String]
|
455
489
|
#
|
456
|
-
#
|
457
|
-
#
|
490
|
+
# @!attribute [rw] parameters
|
491
|
+
# A collection of parameters for this group configuration item. For
|
492
|
+
# the list of parameters that you can use with each configuration item
|
493
|
+
# type, see [Supported resource types and parameters][1].
|
458
494
|
#
|
459
495
|
#
|
460
496
|
#
|
461
|
-
# [1]: https://docs.aws.amazon.com/
|
462
|
-
# @return [String]
|
463
|
-
#
|
464
|
-
# @!attribute [rw] parameters
|
465
|
-
# A collection of parameters for this group configuration item.
|
497
|
+
# [1]: https://docs.aws.amazon.com/ARG/latest/APIReference/about-slg.html#about-slg-types
|
466
498
|
# @return [Array<Types::GroupConfigurationParameter>]
|
467
499
|
#
|
468
500
|
# @see http://docs.aws.amazon.com/goto/WebAPI/resource-groups-2017-11-27/GroupConfigurationItem AWS API Documentation
|
@@ -474,7 +506,13 @@ module Aws::ResourceGroups
|
|
474
506
|
include Aws::Structure
|
475
507
|
end
|
476
508
|
|
477
|
-
# A parameter for a group configuration item.
|
509
|
+
# A parameter for a group configuration item. For details about group
|
510
|
+
# service configuration syntax, see [Service configurations for resource
|
511
|
+
# groups][1].
|
512
|
+
#
|
513
|
+
#
|
514
|
+
#
|
515
|
+
# [1]: https://docs.aws.amazon.com/ARG/latest/APIReference/about-slg.html
|
478
516
|
#
|
479
517
|
# @note When making an API call, you may pass GroupConfigurationParameter
|
480
518
|
# data as a hash:
|
@@ -485,42 +523,23 @@ module Aws::ResourceGroups
|
|
485
523
|
# }
|
486
524
|
#
|
487
525
|
# @!attribute [rw] name
|
488
|
-
# The name of the group configuration parameter.
|
489
|
-
#
|
490
|
-
#
|
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.
|
526
|
+
# The name of the group configuration parameter. For the list of
|
527
|
+
# parameters that you can use with each configuration item type, see
|
528
|
+
# [Supported resource types and parameters][1].
|
498
529
|
#
|
499
|
-
# * For configuration item type `AWS::EC2::CapacityReservationPool`\:
|
500
530
|
#
|
501
|
-
# * None - This configuration item type doesn't support any
|
502
|
-
# parameters.
|
503
531
|
#
|
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
|
532
|
+
# [1]: https://docs.aws.amazon.com/ARG/latest/APIReference/about-slg.html#about-slg-types
|
513
533
|
# @return [String]
|
514
534
|
#
|
515
535
|
# @!attribute [rw] values
|
516
|
-
# The values
|
536
|
+
# The value or values to be used for the specified parameter. For the
|
537
|
+
# list of values you can use with each parameter, see [Supported
|
538
|
+
# resource types and parameters][1].
|
517
539
|
#
|
518
|
-
# You can specify the following string value:
|
519
540
|
#
|
520
|
-
# * For item type `allowed-resource-types`\: the only supported
|
521
|
-
# parameter value is `AWS::EC2::CapacityReservation`.
|
522
541
|
#
|
523
|
-
#
|
542
|
+
# [1]: https://docs.aws.amazon.com/ARG/latest/APIReference/about-slg.html#about-slg-types
|
524
543
|
# @return [Array<String>]
|
525
544
|
#
|
526
545
|
# @see http://docs.aws.amazon.com/goto/WebAPI/resource-groups-2017-11-27/GroupConfigurationParameter AWS API Documentation
|
@@ -628,20 +647,30 @@ module Aws::ResourceGroups
|
|
628
647
|
end
|
629
648
|
|
630
649
|
# @!attribute [rw] succeeded
|
631
|
-
#
|
632
|
-
# by this operation.
|
650
|
+
# A list of ARNs of resources that were successfully added to the
|
651
|
+
# group by this operation.
|
633
652
|
# @return [Array<String>]
|
634
653
|
#
|
635
654
|
# @!attribute [rw] failed
|
636
|
-
#
|
637
|
-
# this operation.
|
655
|
+
# A list of ARNs of any resources that failed to be added to the group
|
656
|
+
# by this operation.
|
638
657
|
# @return [Array<Types::FailedResource>]
|
639
658
|
#
|
659
|
+
# @!attribute [rw] pending
|
660
|
+
# A list of ARNs of any resources that are still in the process of
|
661
|
+
# being added to the group by this operation. These pending additions
|
662
|
+
# continue asynchronously. You can check the status of pending
|
663
|
+
# additions by using the ` ListGroupResources ` operation, and
|
664
|
+
# checking the `Resources` array in the response and the `Status`
|
665
|
+
# field of each object in that array.
|
666
|
+
# @return [Array<Types::PendingResource>]
|
667
|
+
#
|
640
668
|
# @see http://docs.aws.amazon.com/goto/WebAPI/resource-groups-2017-11-27/GroupResourcesOutput AWS API Documentation
|
641
669
|
#
|
642
670
|
class GroupResourcesOutput < Struct.new(
|
643
671
|
:succeeded,
|
644
|
-
:failed
|
672
|
+
:failed,
|
673
|
+
:pending)
|
645
674
|
SENSITIVE = []
|
646
675
|
include Aws::Structure
|
647
676
|
end
|
@@ -677,7 +706,8 @@ module Aws::ResourceGroups
|
|
677
706
|
# }
|
678
707
|
#
|
679
708
|
# @!attribute [rw] group_name
|
680
|
-
#
|
709
|
+
# <i> <b>Deprecated - don't use this parameter. Use the
|
710
|
+
# <code>Group</code> request field instead.</b> </i>
|
681
711
|
# @return [String]
|
682
712
|
#
|
683
713
|
# @!attribute [rw] group
|
@@ -749,9 +779,42 @@ module Aws::ResourceGroups
|
|
749
779
|
include Aws::Structure
|
750
780
|
end
|
751
781
|
|
782
|
+
# A structure returned by the ListGroupResources operation that contains
|
783
|
+
# identity and group membership status information for one of the
|
784
|
+
# resources in the group.
|
785
|
+
#
|
786
|
+
# @!attribute [rw] identifier
|
787
|
+
# A structure that contains the ARN of a resource and its resource
|
788
|
+
# type.
|
789
|
+
# @return [Types::ResourceIdentifier]
|
790
|
+
#
|
791
|
+
# @!attribute [rw] status
|
792
|
+
# A structure that contains the status of this resource's membership
|
793
|
+
# in the group.
|
794
|
+
#
|
795
|
+
# <note markdown="1"> This field is present in the response only if the group is of type
|
796
|
+
# `AWS::EC2::HostManagement`.
|
797
|
+
#
|
798
|
+
# </note>
|
799
|
+
# @return [Types::ResourceStatus]
|
800
|
+
#
|
801
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/resource-groups-2017-11-27/ListGroupResourcesItem AWS API Documentation
|
802
|
+
#
|
803
|
+
class ListGroupResourcesItem < Struct.new(
|
804
|
+
:identifier,
|
805
|
+
:status)
|
806
|
+
SENSITIVE = []
|
807
|
+
include Aws::Structure
|
808
|
+
end
|
809
|
+
|
810
|
+
# @!attribute [rw] resources
|
811
|
+
# An array of resources from which you can determine each resource's
|
812
|
+
# identity, type, and group membership status.
|
813
|
+
# @return [Array<Types::ListGroupResourcesItem>]
|
814
|
+
#
|
752
815
|
# @!attribute [rw] resource_identifiers
|
753
|
-
#
|
754
|
-
#
|
816
|
+
# <b> <i>Deprecated - don't use this parameter. Use the
|
817
|
+
# <code>Resources</code> response field instead.</i> </b>
|
755
818
|
# @return [Array<Types::ResourceIdentifier>]
|
756
819
|
#
|
757
820
|
# @!attribute [rw] next_token
|
@@ -772,6 +835,7 @@ module Aws::ResourceGroups
|
|
772
835
|
# @see http://docs.aws.amazon.com/goto/WebAPI/resource-groups-2017-11-27/ListGroupResourcesOutput AWS API Documentation
|
773
836
|
#
|
774
837
|
class ListGroupResourcesOutput < Struct.new(
|
838
|
+
:resources,
|
775
839
|
:resource_identifiers,
|
776
840
|
:next_token,
|
777
841
|
:query_errors)
|
@@ -806,9 +870,9 @@ module Aws::ResourceGroups
|
|
806
870
|
# groups that have the specified configuration types attached. The
|
807
871
|
# current supported values are:
|
808
872
|
#
|
809
|
-
# * AWS:EC2::CapacityReservationPool
|
873
|
+
# * `AWS:EC2::CapacityReservationPool`
|
810
874
|
#
|
811
|
-
#
|
875
|
+
# * `AWS:EC2::HostManagement`
|
812
876
|
# @return [Array<Types::GroupFilter>]
|
813
877
|
#
|
814
878
|
# @!attribute [rw] max_results
|
@@ -848,8 +912,8 @@ module Aws::ResourceGroups
|
|
848
912
|
# @return [Array<Types::GroupIdentifier>]
|
849
913
|
#
|
850
914
|
# @!attribute [rw] groups
|
851
|
-
#
|
852
|
-
#
|
915
|
+
# <i> <b>Deprecated - don't use this field. Use the
|
916
|
+
# <code>GroupIdentifiers</code> response field instead.</b> </i>
|
853
917
|
# @return [Array<Types::Group>]
|
854
918
|
#
|
855
919
|
# @!attribute [rw] next_token
|
@@ -897,6 +961,80 @@ module Aws::ResourceGroups
|
|
897
961
|
include Aws::Structure
|
898
962
|
end
|
899
963
|
|
964
|
+
# A structure that identifies a resource that is currently pending
|
965
|
+
# addition to the group as a member. Adding a resource to a resource
|
966
|
+
# group happens asynchronously as a background task and this one isn't
|
967
|
+
# completed yet.
|
968
|
+
#
|
969
|
+
# @!attribute [rw] resource_arn
|
970
|
+
# The Amazon resource name (ARN) of the resource that's in a pending
|
971
|
+
# state.
|
972
|
+
# @return [String]
|
973
|
+
#
|
974
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/resource-groups-2017-11-27/PendingResource AWS API Documentation
|
975
|
+
#
|
976
|
+
class PendingResource < Struct.new(
|
977
|
+
:resource_arn)
|
978
|
+
SENSITIVE = []
|
979
|
+
include Aws::Structure
|
980
|
+
end
|
981
|
+
|
982
|
+
# @note When making an API call, you may pass PutGroupConfigurationInput
|
983
|
+
# data as a hash:
|
984
|
+
#
|
985
|
+
# {
|
986
|
+
# group: "GroupString",
|
987
|
+
# configuration: [
|
988
|
+
# {
|
989
|
+
# type: "GroupConfigurationType", # required
|
990
|
+
# parameters: [
|
991
|
+
# {
|
992
|
+
# name: "GroupConfigurationParameterName", # required
|
993
|
+
# values: ["GroupConfigurationParameterValue"],
|
994
|
+
# },
|
995
|
+
# ],
|
996
|
+
# },
|
997
|
+
# ],
|
998
|
+
# }
|
999
|
+
#
|
1000
|
+
# @!attribute [rw] group
|
1001
|
+
# The name or ARN of the resource group with the configuration that
|
1002
|
+
# you want to update.
|
1003
|
+
# @return [String]
|
1004
|
+
#
|
1005
|
+
# @!attribute [rw] configuration
|
1006
|
+
# The new configuration to associate with the specified group. A
|
1007
|
+
# configuration associates the resource group with an AWS service and
|
1008
|
+
# specifies how the service can interact with the resources in the
|
1009
|
+
# group. A configuration is an array of GroupConfigurationItem
|
1010
|
+
# elements.
|
1011
|
+
#
|
1012
|
+
# For information about the syntax of a service configuration, see
|
1013
|
+
# [Service configurations for resource groups][1].
|
1014
|
+
#
|
1015
|
+
# <note markdown="1"> A resource group can contain either a `Configuration` or a
|
1016
|
+
# `ResourceQuery`, but not both.
|
1017
|
+
#
|
1018
|
+
# </note>
|
1019
|
+
#
|
1020
|
+
#
|
1021
|
+
#
|
1022
|
+
# [1]: https://docs.aws.amazon.com/ARG/latest/APIReference/about-slg.html
|
1023
|
+
# @return [Array<Types::GroupConfigurationItem>]
|
1024
|
+
#
|
1025
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/resource-groups-2017-11-27/PutGroupConfigurationInput AWS API Documentation
|
1026
|
+
#
|
1027
|
+
class PutGroupConfigurationInput < Struct.new(
|
1028
|
+
:group,
|
1029
|
+
:configuration)
|
1030
|
+
SENSITIVE = []
|
1031
|
+
include Aws::Structure
|
1032
|
+
end
|
1033
|
+
|
1034
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/resource-groups-2017-11-27/PutGroupConfigurationOutput AWS API Documentation
|
1035
|
+
#
|
1036
|
+
class PutGroupConfigurationOutput < Aws::EmptyStructure; end
|
1037
|
+
|
900
1038
|
# A two-part error structure that can occur in `ListGroupResources` or
|
901
1039
|
# `SearchResources` operations on CloudFormation stack-based queries.
|
902
1040
|
# The error occurs if the CloudFormation stack on which the query is
|
@@ -956,7 +1094,7 @@ module Aws::ResourceGroups
|
|
956
1094
|
include Aws::Structure
|
957
1095
|
end
|
958
1096
|
|
959
|
-
#
|
1097
|
+
# A structure that contains the ARN of a resource and its resource type.
|
960
1098
|
#
|
961
1099
|
# @!attribute [rw] resource_arn
|
962
1100
|
# The ARN of a resource.
|
@@ -976,7 +1114,72 @@ module Aws::ResourceGroups
|
|
976
1114
|
end
|
977
1115
|
|
978
1116
|
# The query that is used to define a resource group or a search for
|
979
|
-
# resources.
|
1117
|
+
# resources. A query specifies both a query type and a query string as a
|
1118
|
+
# JSON object. See the examples section for example JSON strings.
|
1119
|
+
#
|
1120
|
+
# The examples that follow are shown as standard JSON strings. If you
|
1121
|
+
# include such a string as a parameter to the AWS CLI or an SDK API, you
|
1122
|
+
# might need to 'escape' the string into a single line. For example,
|
1123
|
+
# see the [Quoting strings][1] in the *AWS CLI User Guide*.
|
1124
|
+
#
|
1125
|
+
# **Example 1**
|
1126
|
+
#
|
1127
|
+
# The following generic example shows a resource query JSON string that
|
1128
|
+
# includes only resources that meet the following criteria:
|
1129
|
+
#
|
1130
|
+
# * The resource type must be either `resource_type1` or
|
1131
|
+
# `resource_type2`.
|
1132
|
+
#
|
1133
|
+
# * The resource must have a tag `Key1` with a value of either `ValueA`
|
1134
|
+
# or `ValueB`.
|
1135
|
+
#
|
1136
|
+
# * The resource must have a tag `Key2` with a value of either `ValueC`
|
1137
|
+
# or `ValueD`.
|
1138
|
+
#
|
1139
|
+
# `\{ "Type": "TAG_FILTERS_1_0", "Query": \{ "ResourceTypeFilters": [
|
1140
|
+
# "resource_type1", "resource_type2"], "TagFilters": [ \{ "Key": "Key1",
|
1141
|
+
# "Values": ["ValueA","ValueB"] \}, \{ "Key":"Key2",
|
1142
|
+
# "Values":["ValueC","ValueD"] \} ] \} \}`
|
1143
|
+
#
|
1144
|
+
# This has the equivalent "shortcut" syntax of the following:
|
1145
|
+
#
|
1146
|
+
# `\{ "Type": "TAG_FILTERS_1_0", "Query": \{ "ResourceTypeFilters": [
|
1147
|
+
# "resource_type1", "resource_type2"], "TagFilters": [ \{ "Key1":
|
1148
|
+
# ["ValueA","ValueB"] \}, \{ "Key2": ["ValueC","ValueD"] \} ] \} \}`
|
1149
|
+
#
|
1150
|
+
# **Example 2**
|
1151
|
+
#
|
1152
|
+
# The following example shows a resource query JSON string that includes
|
1153
|
+
# only Amazon EC2 instances that are tagged `Stage` with a value of
|
1154
|
+
# `Test`.
|
1155
|
+
#
|
1156
|
+
# `\{ "Type": "TAG_FILTERS_1_0", "Query": "\{ "ResourceTypeFilters":
|
1157
|
+
# "AWS::EC2::Instance", "TagFilters": \{ "Stage": "Test" \} \} \}`
|
1158
|
+
#
|
1159
|
+
# **Example 3**
|
1160
|
+
#
|
1161
|
+
# The following example shows a resource query JSON string that includes
|
1162
|
+
# resource of any supported type as long as it is tagged `Stage` with a
|
1163
|
+
# value of `Prod`.
|
1164
|
+
#
|
1165
|
+
# `\{ "Type": "TAG_FILTERS_1_0", "Query": \{ "ResourceTypeFilters":
|
1166
|
+
# "AWS::AllSupported", "TagFilters": \{ "Stage": "Prod" \} \} \}`
|
1167
|
+
#
|
1168
|
+
# **Example 4**
|
1169
|
+
#
|
1170
|
+
# The following example shows a resource query JSON string that includes
|
1171
|
+
# only Amazon EC2 instances and Amazon S3 buckets that are part of the
|
1172
|
+
# specified AWS CloudFormation stack.
|
1173
|
+
#
|
1174
|
+
# `\{ "Type": "CLOUDFORMATION_STACK_1_0", "Query": \{
|
1175
|
+
# "ResourceTypeFilters": [ "AWS::EC2::Instance", "AWS::S3::Bucket" ],
|
1176
|
+
# "StackIdentifier":
|
1177
|
+
# "arn:aws:cloudformation:us-west-2:123456789012:stack/AWStestuseraccount/fb0d5000-aba8-00e8-aa9e-50d5cEXAMPLE"
|
1178
|
+
# \} \}`
|
1179
|
+
#
|
1180
|
+
#
|
1181
|
+
#
|
1182
|
+
# [1]: https://docs.aws.amazon.com/cli/latest/userguide/cli-usage-parameters-quoting-strings.html
|
980
1183
|
#
|
981
1184
|
# @note When making an API call, you may pass ResourceQuery
|
982
1185
|
# data as a hash:
|
@@ -989,15 +1192,16 @@ module Aws::ResourceGroups
|
|
989
1192
|
# @!attribute [rw] type
|
990
1193
|
# The type of the query. You can use the following values:
|
991
1194
|
#
|
992
|
-
# * <i> <code>CLOUDFORMATION_STACK_1_0:</code> </i>
|
993
|
-
#
|
1195
|
+
# * <i> <code>CLOUDFORMATION_STACK_1_0:</code> </i>Specifies that the
|
1196
|
+
# `Query` contains an ARN for a CloudFormation stack.
|
994
1197
|
#
|
995
|
-
# * <i> <code>TAG_FILTERS_1_0:</code> </i>
|
996
|
-
#
|
997
|
-
#
|
998
|
-
#
|
999
|
-
#
|
1000
|
-
#
|
1198
|
+
# * <i> <code>TAG_FILTERS_1_0:</code> </i>Specifies that the `Query`
|
1199
|
+
# parameter contains a JSON string that represents a collection of
|
1200
|
+
# simple tag filters for resource types and tags. The JSON string
|
1201
|
+
# uses a syntax similar to the ` GetResources ` operation, but uses
|
1202
|
+
# only the ` ResourceTypeFilters ` and ` TagFilters ` fields. If
|
1203
|
+
# you specify more than one tag key, only resources that match all
|
1204
|
+
# tag keys, and at least one value of each specified tag key, are
|
1001
1205
|
# returned in your query. If you specify more than one value for a
|
1002
1206
|
# tag key, a resource matches the filter if it has a tag key value
|
1003
1207
|
# that matches *any* of the specified values.
|
@@ -1005,38 +1209,31 @@ module Aws::ResourceGroups
|
|
1005
1209
|
# For example, consider the following sample query for resources
|
1006
1210
|
# that have two tags, `Stage` and `Version`, with two values each:
|
1007
1211
|
#
|
1008
|
-
# `[\{"
|
1212
|
+
# `[\{"Stage":["Test","Deploy"]\},\{"Version":["1","2"]\}]`
|
1009
1213
|
#
|
1010
1214
|
# The results of this query could include the following.
|
1011
1215
|
#
|
1012
1216
|
# * An EC2 instance that has the following two tags:
|
1013
|
-
# `\{"
|
1014
|
-
# `\{"Key":"Version","Value":"2"\}`
|
1217
|
+
# `\{"Stage":"Deploy"\}`, and `\{"Version":"2"\}`
|
1015
1218
|
#
|
1016
1219
|
# * An S3 bucket that has the following two tags:
|
1017
|
-
# `\{"
|
1018
|
-
# `\{"Key":"Version","Value":"1"\}`
|
1220
|
+
# `\{"Stage":"Test"\}`, and `\{"Version":"1"\}`
|
1019
1221
|
#
|
1020
1222
|
# The query would not include the following items in the results,
|
1021
1223
|
# however.
|
1022
1224
|
#
|
1023
1225
|
# * An EC2 instance that has only the following tag:
|
1024
|
-
# `\{"
|
1226
|
+
# `\{"Stage":"Deploy"\}`.
|
1025
1227
|
#
|
1026
1228
|
# The instance does not have **all** of the tag keys specified in
|
1027
1229
|
# the filter, so it is excluded from the results.
|
1028
1230
|
#
|
1029
1231
|
# * An RDS database that has the following two tags:
|
1030
|
-
# `\{"
|
1031
|
-
# `\{"Key":"Version","Value":"4"\}`
|
1232
|
+
# `\{"Stage":"Archived"\}` and `\{"Version":"4"\}`
|
1032
1233
|
#
|
1033
1234
|
# The database has all of the tag keys, but none of those keys has
|
1034
1235
|
# an associated value that matches at least one of the specified
|
1035
1236
|
# values in the filter.
|
1036
|
-
#
|
1037
|
-
#
|
1038
|
-
#
|
1039
|
-
# [1]: https://docs.aws.amazon.com/resourcegroupstagging/latest/APIReference/API_GetResources.html#resourcegrouptagging-GetResources-request-ResourceTypeFilters
|
1040
1237
|
# @return [String]
|
1041
1238
|
#
|
1042
1239
|
# @!attribute [rw] query
|
@@ -1052,6 +1249,23 @@ module Aws::ResourceGroups
|
|
1052
1249
|
include Aws::Structure
|
1053
1250
|
end
|
1054
1251
|
|
1252
|
+
# A structure that identifies the current group membership status for a
|
1253
|
+
# resource. Adding a resource to a resource group is performed
|
1254
|
+
# asynchronously as a background task. A `PENDING` status indicates, for
|
1255
|
+
# this resource, that the process isn't completed yet.
|
1256
|
+
#
|
1257
|
+
# @!attribute [rw] name
|
1258
|
+
# The current status.
|
1259
|
+
# @return [String]
|
1260
|
+
#
|
1261
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/resource-groups-2017-11-27/ResourceStatus AWS API Documentation
|
1262
|
+
#
|
1263
|
+
class ResourceStatus < Struct.new(
|
1264
|
+
:name)
|
1265
|
+
SENSITIVE = []
|
1266
|
+
include Aws::Structure
|
1267
|
+
end
|
1268
|
+
|
1055
1269
|
# @note When making an API call, you may pass SearchResourcesInput
|
1056
1270
|
# data as a hash:
|
1057
1271
|
#
|
@@ -1230,19 +1444,30 @@ module Aws::ResourceGroups
|
|
1230
1444
|
end
|
1231
1445
|
|
1232
1446
|
# @!attribute [rw] succeeded
|
1233
|
-
#
|
1234
|
-
#
|
1447
|
+
# A list of resources that were successfully removed from the group by
|
1448
|
+
# this operation.
|
1235
1449
|
# @return [Array<String>]
|
1236
1450
|
#
|
1237
1451
|
# @!attribute [rw] failed
|
1238
|
-
#
|
1452
|
+
# A list of any resources that failed to be removed from the group by
|
1453
|
+
# this operation.
|
1239
1454
|
# @return [Array<Types::FailedResource>]
|
1240
1455
|
#
|
1456
|
+
# @!attribute [rw] pending
|
1457
|
+
# A list of any resources that are still in the process of being
|
1458
|
+
# removed from the group by this operation. These pending removals
|
1459
|
+
# continue asynchronously. You can check the status of pending
|
1460
|
+
# removals by using the ` ListGroupResources ` operation. After the
|
1461
|
+
# resource is successfully removed, it no longer appears in the
|
1462
|
+
# response.
|
1463
|
+
# @return [Array<Types::PendingResource>]
|
1464
|
+
#
|
1241
1465
|
# @see http://docs.aws.amazon.com/goto/WebAPI/resource-groups-2017-11-27/UngroupResourcesOutput AWS API Documentation
|
1242
1466
|
#
|
1243
1467
|
class UngroupResourcesOutput < Struct.new(
|
1244
1468
|
:succeeded,
|
1245
|
-
:failed
|
1469
|
+
:failed,
|
1470
|
+
:pending)
|
1246
1471
|
SENSITIVE = []
|
1247
1472
|
include Aws::Structure
|
1248
1473
|
end
|
@@ -1359,6 +1584,11 @@ module Aws::ResourceGroups
|
|
1359
1584
|
# @!attribute [rw] resource_query
|
1360
1585
|
# The resource query to determine which AWS resources are members of
|
1361
1586
|
# this resource group.
|
1587
|
+
#
|
1588
|
+
# <note markdown="1"> A resource group can contain either a `Configuration` or a
|
1589
|
+
# `ResourceQuery`, but not both.
|
1590
|
+
#
|
1591
|
+
# </note>
|
1362
1592
|
# @return [Types::ResourceQuery]
|
1363
1593
|
#
|
1364
1594
|
# @see http://docs.aws.amazon.com/goto/WebAPI/resource-groups-2017-11-27/UpdateGroupQueryInput AWS API Documentation
|