aws-sdk-resourcegroups 1.22.0 → 1.27.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/lib/aws-sdk-resourcegroups.rb +3 -1
- data/lib/aws-sdk-resourcegroups/client.rb +349 -90
- data/lib/aws-sdk-resourcegroups/client_api.rb +149 -24
- data/lib/aws-sdk-resourcegroups/errors.rb +2 -0
- data/lib/aws-sdk-resourcegroups/resource.rb +3 -7
- data/lib/aws-sdk-resourcegroups/types.rb +622 -145
- metadata +6 -5
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: d11deac8aab073e36e5c1f6ed18e872b6e532cddbede52d9a6eea6e6e39d24f1
|
|
4
|
+
data.tar.gz: c846995796d93f43edf31e8a61b0b152f6a6fa2b44fb785b576151586fa7fb02
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: 57b6f38164521ee6695549f76e12e8880ec4dedf4c8fc4564f8cd4ff291cca6b9129858a527dc8ab2432508c971ba209ac665b8cc6f8ace3c4e57ea4716f80ab
|
|
7
|
+
data.tar.gz: bf6d5bc545861c81229f61123123bc7b74f242c72d4ada99248c02153e5a26963283ac5e924818a6d3523cdb56ec0e6eeb4fc40c90eda783015f16ecf7d784cd
|
|
@@ -1,3 +1,5 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
1
3
|
# WARNING ABOUT GENERATED CODE
|
|
2
4
|
#
|
|
3
5
|
# This file is generated. See the contributing guide for more information:
|
|
@@ -45,6 +47,6 @@ require_relative 'aws-sdk-resourcegroups/customizations'
|
|
|
45
47
|
# @service
|
|
46
48
|
module Aws::ResourceGroups
|
|
47
49
|
|
|
48
|
-
GEM_VERSION = '1.
|
|
50
|
+
GEM_VERSION = '1.27.0'
|
|
49
51
|
|
|
50
52
|
end
|
|
@@ -1,3 +1,5 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
1
3
|
# WARNING ABOUT GENERATED CODE
|
|
2
4
|
#
|
|
3
5
|
# This file is generated. See the contributing guide for more information:
|
|
@@ -24,6 +26,7 @@ require 'aws-sdk-core/plugins/jsonvalue_converter.rb'
|
|
|
24
26
|
require 'aws-sdk-core/plugins/client_metrics_plugin.rb'
|
|
25
27
|
require 'aws-sdk-core/plugins/client_metrics_send_plugin.rb'
|
|
26
28
|
require 'aws-sdk-core/plugins/transfer_encoding.rb'
|
|
29
|
+
require 'aws-sdk-core/plugins/http_checksum.rb'
|
|
27
30
|
require 'aws-sdk-core/plugins/signature_v4.rb'
|
|
28
31
|
require 'aws-sdk-core/plugins/protocols/rest_json.rb'
|
|
29
32
|
|
|
@@ -69,6 +72,7 @@ module Aws::ResourceGroups
|
|
|
69
72
|
add_plugin(Aws::Plugins::ClientMetricsPlugin)
|
|
70
73
|
add_plugin(Aws::Plugins::ClientMetricsSendPlugin)
|
|
71
74
|
add_plugin(Aws::Plugins::TransferEncoding)
|
|
75
|
+
add_plugin(Aws::Plugins::HttpChecksum)
|
|
72
76
|
add_plugin(Aws::Plugins::SignatureV4)
|
|
73
77
|
add_plugin(Aws::Plugins::Protocols::RestJson)
|
|
74
78
|
|
|
@@ -105,7 +109,7 @@ module Aws::ResourceGroups
|
|
|
105
109
|
# @option options [required, String] :region
|
|
106
110
|
# The AWS region to connect to. The configured `:region` is
|
|
107
111
|
# used to determine the service `:endpoint`. When not passed,
|
|
108
|
-
# a default `:region` is
|
|
112
|
+
# a default `:region` is searched for in the following locations:
|
|
109
113
|
#
|
|
110
114
|
# * `Aws.config[:region]`
|
|
111
115
|
# * `ENV['AWS_REGION']`
|
|
@@ -161,7 +165,7 @@ module Aws::ResourceGroups
|
|
|
161
165
|
# @option options [String] :endpoint
|
|
162
166
|
# The client endpoint is normally constructed from the `:region`
|
|
163
167
|
# option. You should only configure an `:endpoint` when connecting
|
|
164
|
-
# to test endpoints. This should be
|
|
168
|
+
# to test or custom endpoints. This should be a valid HTTP(S) URI.
|
|
165
169
|
#
|
|
166
170
|
# @option options [Integer] :endpoint_cache_max_entries (1000)
|
|
167
171
|
# Used for the maximum size limit of the LRU cache storing endpoints data
|
|
@@ -176,7 +180,7 @@ module Aws::ResourceGroups
|
|
|
176
180
|
# requests fetching endpoints information. Defaults to 60 sec.
|
|
177
181
|
#
|
|
178
182
|
# @option options [Boolean] :endpoint_discovery (false)
|
|
179
|
-
# When set to `true`, endpoint discovery will be enabled for operations when available.
|
|
183
|
+
# When set to `true`, endpoint discovery will be enabled for operations when available.
|
|
180
184
|
#
|
|
181
185
|
# @option options [Aws::Log::Formatter] :log_formatter (Aws::Log::Formatter.default)
|
|
182
186
|
# The log formatter.
|
|
@@ -269,8 +273,7 @@ module Aws::ResourceGroups
|
|
|
269
273
|
#
|
|
270
274
|
# @option options [Integer] :http_read_timeout (60) The default
|
|
271
275
|
# number of seconds to wait for response data. This value can
|
|
272
|
-
# safely be set
|
|
273
|
-
# per-request on the session yielded by {#session_for}.
|
|
276
|
+
# safely be set per-request on the session.
|
|
274
277
|
#
|
|
275
278
|
# @option options [Float] :http_idle_timeout (5) The number of
|
|
276
279
|
# seconds a connection is allowed to sit idle before it is
|
|
@@ -282,7 +285,7 @@ module Aws::ResourceGroups
|
|
|
282
285
|
# request body. This option has no effect unless the request has
|
|
283
286
|
# "Expect" header set to "100-continue". Defaults to `nil` which
|
|
284
287
|
# disables this behaviour. This value can safely be set per
|
|
285
|
-
# request on the session
|
|
288
|
+
# request on the session.
|
|
286
289
|
#
|
|
287
290
|
# @option options [Boolean] :http_wire_trace (false) When `true`,
|
|
288
291
|
# HTTP debug output will be sent to the `:logger`.
|
|
@@ -309,50 +312,73 @@ module Aws::ResourceGroups
|
|
|
309
312
|
|
|
310
313
|
# @!group API Operations
|
|
311
314
|
|
|
312
|
-
# Creates a group with
|
|
313
|
-
# query.
|
|
315
|
+
# Creates a resource group with the specified name and description. You
|
|
316
|
+
# can optionally include a resource query, or a service configuration.
|
|
314
317
|
#
|
|
315
318
|
# @option params [required, String] :name
|
|
316
319
|
# The name of the group, which is the identifier of the group in other
|
|
317
|
-
# operations.
|
|
318
|
-
#
|
|
319
|
-
#
|
|
320
|
-
#
|
|
321
|
-
#
|
|
320
|
+
# operations. You can't change the name of a resource group after you
|
|
321
|
+
# create it. A resource group name can consist of letters, numbers,
|
|
322
|
+
# hyphens, periods, and underscores. The name cannot start with `AWS` or
|
|
323
|
+
# `aws`; these are reserved. A resource group name must be unique within
|
|
324
|
+
# each AWS Region in your AWS account.
|
|
322
325
|
#
|
|
323
326
|
# @option params [String] :description
|
|
324
|
-
# The description of the resource group. Descriptions can
|
|
325
|
-
#
|
|
326
|
-
# punctuation, and spaces.
|
|
327
|
+
# The description of the resource group. Descriptions can consist of
|
|
328
|
+
# letters, numbers, hyphens, underscores, periods, and spaces.
|
|
327
329
|
#
|
|
328
|
-
# @option params [
|
|
330
|
+
# @option params [Types::ResourceQuery] :resource_query
|
|
329
331
|
# The resource query that determines which AWS resources are members of
|
|
330
332
|
# this group.
|
|
331
333
|
#
|
|
334
|
+
# <note markdown="1"> You can specify either a `ResourceQuery` or a `Configuration`, but not
|
|
335
|
+
# both.
|
|
336
|
+
#
|
|
337
|
+
# </note>
|
|
338
|
+
#
|
|
332
339
|
# @option params [Hash<String,String>] :tags
|
|
333
|
-
# The tags to add to the group. A tag is
|
|
334
|
-
#
|
|
335
|
-
#
|
|
336
|
-
#
|
|
340
|
+
# The tags to add to the group. A tag is key-value pair string.
|
|
341
|
+
#
|
|
342
|
+
# @option params [Array<Types::GroupConfigurationItem>] :configuration
|
|
343
|
+
# A configuration associates the resource group with an AWS service and
|
|
344
|
+
# specifies how the service can interact with the resources in the
|
|
345
|
+
# group. A configuration is an array of GroupConfigurationItem elements.
|
|
346
|
+
#
|
|
347
|
+
# <note markdown="1"> You can specify either a `Configuration` or a `ResourceQuery` in a
|
|
348
|
+
# group, but not both.
|
|
349
|
+
#
|
|
350
|
+
# </note>
|
|
337
351
|
#
|
|
338
352
|
# @return [Types::CreateGroupOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
339
353
|
#
|
|
340
354
|
# * {Types::CreateGroupOutput#group #group} => Types::Group
|
|
341
355
|
# * {Types::CreateGroupOutput#resource_query #resource_query} => Types::ResourceQuery
|
|
342
356
|
# * {Types::CreateGroupOutput#tags #tags} => Hash<String,String>
|
|
357
|
+
# * {Types::CreateGroupOutput#group_configuration #group_configuration} => Types::GroupConfiguration
|
|
343
358
|
#
|
|
344
359
|
# @example Request syntax with placeholder values
|
|
345
360
|
#
|
|
346
361
|
# resp = client.create_group({
|
|
347
362
|
# name: "GroupName", # required
|
|
348
|
-
# description: "
|
|
349
|
-
# resource_query: {
|
|
363
|
+
# description: "Description",
|
|
364
|
+
# resource_query: {
|
|
350
365
|
# type: "TAG_FILTERS_1_0", # required, accepts TAG_FILTERS_1_0, CLOUDFORMATION_STACK_1_0
|
|
351
366
|
# query: "Query", # required
|
|
352
367
|
# },
|
|
353
368
|
# tags: {
|
|
354
369
|
# "TagKey" => "TagValue",
|
|
355
370
|
# },
|
|
371
|
+
# configuration: [
|
|
372
|
+
# {
|
|
373
|
+
# type: "GroupConfigurationType", # required
|
|
374
|
+
# parameters: [
|
|
375
|
+
# {
|
|
376
|
+
# name: "GroupConfigurationParameterName", # required
|
|
377
|
+
# values: ["GroupConfigurationParameterValue"],
|
|
378
|
+
# },
|
|
379
|
+
# ],
|
|
380
|
+
# },
|
|
381
|
+
# ],
|
|
356
382
|
# })
|
|
357
383
|
#
|
|
358
384
|
# @example Response structure
|
|
@@ -364,6 +390,20 @@ module Aws::ResourceGroups
|
|
|
364
390
|
# resp.resource_query.query #=> String
|
|
365
391
|
# resp.tags #=> Hash
|
|
366
392
|
# resp.tags["TagKey"] #=> String
|
|
393
|
+
# resp.group_configuration.configuration #=> Array
|
|
394
|
+
# resp.group_configuration.configuration[0].type #=> String
|
|
395
|
+
# resp.group_configuration.configuration[0].parameters #=> Array
|
|
396
|
+
# resp.group_configuration.configuration[0].parameters[0].name #=> String
|
|
397
|
+
# resp.group_configuration.configuration[0].parameters[0].values #=> Array
|
|
398
|
+
# resp.group_configuration.configuration[0].parameters[0].values[0] #=> String
|
|
399
|
+
# resp.group_configuration.proposed_configuration #=> Array
|
|
400
|
+
# resp.group_configuration.proposed_configuration[0].type #=> String
|
|
401
|
+
# resp.group_configuration.proposed_configuration[0].parameters #=> Array
|
|
402
|
+
# resp.group_configuration.proposed_configuration[0].parameters[0].name #=> String
|
|
403
|
+
# resp.group_configuration.proposed_configuration[0].parameters[0].values #=> Array
|
|
404
|
+
# resp.group_configuration.proposed_configuration[0].parameters[0].values[0] #=> String
|
|
405
|
+
# resp.group_configuration.status #=> String, one of "UPDATING", "UPDATE_COMPLETE", "UPDATE_FAILED"
|
|
406
|
+
# resp.group_configuration.failure_reason #=> String
|
|
367
407
|
#
|
|
368
408
|
# @see http://docs.aws.amazon.com/goto/WebAPI/resource-groups-2017-11-27/CreateGroup AWS API Documentation
|
|
369
409
|
#
|
|
@@ -374,12 +414,15 @@ module Aws::ResourceGroups
|
|
|
374
414
|
req.send_request(options)
|
|
375
415
|
end
|
|
376
416
|
|
|
377
|
-
# Deletes
|
|
378
|
-
# delete resources that are members of the group; it only
|
|
379
|
-
# group structure.
|
|
417
|
+
# Deletes the specified resource group. Deleting a resource group does
|
|
418
|
+
# not delete any resources that are members of the group; it only
|
|
419
|
+
# deletes the group structure.
|
|
420
|
+
#
|
|
421
|
+
# @option params [String] :group_name
|
|
422
|
+
# Don't use this parameter. Use `Group` instead.
|
|
380
423
|
#
|
|
381
|
-
# @option params [
|
|
382
|
-
# The name of the resource group to delete.
|
|
424
|
+
# @option params [String] :group
|
|
425
|
+
# The name or the ARN of the resource group to delete.
|
|
383
426
|
#
|
|
384
427
|
# @return [Types::DeleteGroupOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
385
428
|
#
|
|
@@ -388,7 +431,8 @@ module Aws::ResourceGroups
|
|
|
388
431
|
# @example Request syntax with placeholder values
|
|
389
432
|
#
|
|
390
433
|
# resp = client.delete_group({
|
|
391
|
-
# group_name: "GroupName",
|
|
434
|
+
# group_name: "GroupName",
|
|
435
|
+
# group: "GroupString",
|
|
392
436
|
# })
|
|
393
437
|
#
|
|
394
438
|
# @example Response structure
|
|
@@ -408,8 +452,11 @@ module Aws::ResourceGroups
|
|
|
408
452
|
|
|
409
453
|
# Returns information about a specified resource group.
|
|
410
454
|
#
|
|
411
|
-
# @option params [
|
|
412
|
-
#
|
|
455
|
+
# @option params [String] :group_name
|
|
456
|
+
# Don't use this parameter. Use `Group` instead.
|
|
457
|
+
#
|
|
458
|
+
# @option params [String] :group
|
|
459
|
+
# The name or the ARN of the resource group to retrieve.
|
|
413
460
|
#
|
|
414
461
|
# @return [Types::GetGroupOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
415
462
|
#
|
|
@@ -418,7 +465,8 @@ module Aws::ResourceGroups
|
|
|
418
465
|
# @example Request syntax with placeholder values
|
|
419
466
|
#
|
|
420
467
|
# resp = client.get_group({
|
|
421
|
-
# group_name: "GroupName",
|
|
468
|
+
# group_name: "GroupName",
|
|
469
|
+
# group: "GroupString",
|
|
422
470
|
# })
|
|
423
471
|
#
|
|
424
472
|
# @example Response structure
|
|
@@ -436,11 +484,67 @@ module Aws::ResourceGroups
|
|
|
436
484
|
req.send_request(options)
|
|
437
485
|
end
|
|
438
486
|
|
|
439
|
-
# Returns the
|
|
487
|
+
# Returns the service configuration associated with the specified
|
|
488
|
+
# resource group. AWS Resource Groups supports configurations for the
|
|
489
|
+
# following resource group types:
|
|
490
|
+
#
|
|
491
|
+
# * `AWS::EC2::CapacityReservationPool` - Amazon EC2 capacity
|
|
492
|
+
# reservation pools. For more information, see [Working with capacity
|
|
493
|
+
# reservation groups][1] in the *EC2 Users Guide*.
|
|
494
|
+
#
|
|
495
|
+
# ^
|
|
496
|
+
#
|
|
497
|
+
#
|
|
498
|
+
#
|
|
499
|
+
# [1]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/capacity-reservations-using.html#create-cr-group
|
|
500
|
+
#
|
|
501
|
+
# @option params [String] :group
|
|
502
|
+
# The name or the ARN of the resource group.
|
|
503
|
+
#
|
|
504
|
+
# @return [Types::GetGroupConfigurationOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
505
|
+
#
|
|
506
|
+
# * {Types::GetGroupConfigurationOutput#group_configuration #group_configuration} => Types::GroupConfiguration
|
|
507
|
+
#
|
|
508
|
+
# @example Request syntax with placeholder values
|
|
509
|
+
#
|
|
510
|
+
# resp = client.get_group_configuration({
|
|
511
|
+
# group: "GroupString",
|
|
512
|
+
# })
|
|
513
|
+
#
|
|
514
|
+
# @example Response structure
|
|
515
|
+
#
|
|
516
|
+
# resp.group_configuration.configuration #=> Array
|
|
517
|
+
# resp.group_configuration.configuration[0].type #=> String
|
|
518
|
+
# resp.group_configuration.configuration[0].parameters #=> Array
|
|
519
|
+
# resp.group_configuration.configuration[0].parameters[0].name #=> String
|
|
520
|
+
# resp.group_configuration.configuration[0].parameters[0].values #=> Array
|
|
521
|
+
# resp.group_configuration.configuration[0].parameters[0].values[0] #=> String
|
|
522
|
+
# resp.group_configuration.proposed_configuration #=> Array
|
|
523
|
+
# resp.group_configuration.proposed_configuration[0].type #=> String
|
|
524
|
+
# resp.group_configuration.proposed_configuration[0].parameters #=> Array
|
|
525
|
+
# resp.group_configuration.proposed_configuration[0].parameters[0].name #=> String
|
|
526
|
+
# resp.group_configuration.proposed_configuration[0].parameters[0].values #=> Array
|
|
527
|
+
# resp.group_configuration.proposed_configuration[0].parameters[0].values[0] #=> String
|
|
528
|
+
# resp.group_configuration.status #=> String, one of "UPDATING", "UPDATE_COMPLETE", "UPDATE_FAILED"
|
|
529
|
+
# resp.group_configuration.failure_reason #=> String
|
|
530
|
+
#
|
|
531
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/resource-groups-2017-11-27/GetGroupConfiguration AWS API Documentation
|
|
532
|
+
#
|
|
533
|
+
# @overload get_group_configuration(params = {})
|
|
534
|
+
# @param [Hash] params ({})
|
|
535
|
+
def get_group_configuration(params = {}, options = {})
|
|
536
|
+
req = build_request(:get_group_configuration, params)
|
|
537
|
+
req.send_request(options)
|
|
538
|
+
end
|
|
539
|
+
|
|
540
|
+
# Retrieves the resource query associated with the specified resource
|
|
440
541
|
# group.
|
|
441
542
|
#
|
|
442
|
-
# @option params [
|
|
443
|
-
#
|
|
543
|
+
# @option params [String] :group_name
|
|
544
|
+
# Don't use this parameter. Use `Group` instead.
|
|
545
|
+
#
|
|
546
|
+
# @option params [String] :group
|
|
547
|
+
# The name or the ARN of the resource group to query.
|
|
444
548
|
#
|
|
445
549
|
# @return [Types::GetGroupQueryOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
446
550
|
#
|
|
@@ -449,7 +553,8 @@ module Aws::ResourceGroups
|
|
|
449
553
|
# @example Request syntax with placeholder values
|
|
450
554
|
#
|
|
451
555
|
# resp = client.get_group_query({
|
|
452
|
-
# group_name: "GroupName",
|
|
556
|
+
# group_name: "GroupName",
|
|
557
|
+
# group: "GroupString",
|
|
453
558
|
# })
|
|
454
559
|
#
|
|
455
560
|
# @example Response structure
|
|
@@ -471,8 +576,7 @@ module Aws::ResourceGroups
|
|
|
471
576
|
# specified by an ARN.
|
|
472
577
|
#
|
|
473
578
|
# @option params [required, String] :arn
|
|
474
|
-
# The ARN of the resource group
|
|
475
|
-
# resource must exist within the account you are using.
|
|
579
|
+
# The ARN of the resource group whose tags you want to retrieve.
|
|
476
580
|
#
|
|
477
581
|
# @return [Types::GetTagsOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
478
582
|
#
|
|
@@ -500,31 +604,101 @@ module Aws::ResourceGroups
|
|
|
500
604
|
req.send_request(options)
|
|
501
605
|
end
|
|
502
606
|
|
|
607
|
+
# Adds the specified resources to the specified group.
|
|
608
|
+
#
|
|
609
|
+
# @option params [required, String] :group
|
|
610
|
+
# The name or the ARN of the resource group to add resources to.
|
|
611
|
+
#
|
|
612
|
+
# @option params [required, Array<String>] :resource_arns
|
|
613
|
+
# The list of ARNs for resources to be added to the group.
|
|
614
|
+
#
|
|
615
|
+
# @return [Types::GroupResourcesOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
616
|
+
#
|
|
617
|
+
# * {Types::GroupResourcesOutput#succeeded #succeeded} => Array<String>
|
|
618
|
+
# * {Types::GroupResourcesOutput#failed #failed} => Array<Types::FailedResource>
|
|
619
|
+
#
|
|
620
|
+
# @example Request syntax with placeholder values
|
|
621
|
+
#
|
|
622
|
+
# resp = client.group_resources({
|
|
623
|
+
# group: "GroupString", # required
|
|
624
|
+
# resource_arns: ["ResourceArn"], # required
|
|
625
|
+
# })
|
|
626
|
+
#
|
|
627
|
+
# @example Response structure
|
|
628
|
+
#
|
|
629
|
+
# resp.succeeded #=> Array
|
|
630
|
+
# resp.succeeded[0] #=> String
|
|
631
|
+
# resp.failed #=> Array
|
|
632
|
+
# resp.failed[0].resource_arn #=> String
|
|
633
|
+
# resp.failed[0].error_message #=> String
|
|
634
|
+
# resp.failed[0].error_code #=> String
|
|
635
|
+
#
|
|
636
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/resource-groups-2017-11-27/GroupResources AWS API Documentation
|
|
637
|
+
#
|
|
638
|
+
# @overload group_resources(params = {})
|
|
639
|
+
# @param [Hash] params ({})
|
|
640
|
+
def group_resources(params = {}, options = {})
|
|
641
|
+
req = build_request(:group_resources, params)
|
|
642
|
+
req.send_request(options)
|
|
643
|
+
end
|
|
644
|
+
|
|
503
645
|
# Returns a list of ARNs of resources that are members of a specified
|
|
504
646
|
# resource group.
|
|
505
647
|
#
|
|
506
|
-
# @option params [
|
|
507
|
-
#
|
|
648
|
+
# @option params [String] :group_name
|
|
649
|
+
# Don't use this parameter. Use `Group` instead.
|
|
650
|
+
#
|
|
651
|
+
# @option params [String] :group
|
|
652
|
+
# The name or the ARN of the resource group
|
|
508
653
|
#
|
|
509
654
|
# @option params [Array<Types::ResourceFilter>] :filters
|
|
510
655
|
# Filters, formatted as ResourceFilter objects, that you want to apply
|
|
511
|
-
# to a ListGroupResources operation.
|
|
656
|
+
# to a `ListGroupResources` operation. Filters the results to include
|
|
657
|
+
# only those of the specified resource types.
|
|
512
658
|
#
|
|
513
659
|
# * `resource-type` - Filter resources by their type. Specify up to five
|
|
514
|
-
# resource types in the format AWS::ServiceCode::ResourceType
|
|
515
|
-
# example, AWS::EC2::Instance
|
|
660
|
+
# resource types in the format `AWS::ServiceCode::ResourceType`. For
|
|
661
|
+
# example, `AWS::EC2::Instance`, or `AWS::S3::Bucket`.
|
|
516
662
|
#
|
|
517
663
|
# ^
|
|
518
664
|
#
|
|
665
|
+
# When you specify a `resource-type` filter for `ListGroupResources`,
|
|
666
|
+
# AWS Resource Groups validates your filter resource types against the
|
|
667
|
+
# types that are defined in the query associated with the group. For
|
|
668
|
+
# example, if a group contains only S3 buckets because its query
|
|
669
|
+
# specifies only that resource type, but your `resource-type` filter
|
|
670
|
+
# includes EC2 instances, AWS Resource Groups does not filter for EC2
|
|
671
|
+
# instances. In this case, a `ListGroupResources` request returns a
|
|
672
|
+
# `BadRequestException` error with a message similar to the following:
|
|
673
|
+
#
|
|
674
|
+
# `The resource types specified as filters in the request are not
|
|
675
|
+
# valid.`
|
|
676
|
+
#
|
|
677
|
+
# The error includes a list of resource types that failed the validation
|
|
678
|
+
# because they are not part of the query associated with the group. This
|
|
679
|
+
# validation doesn't occur when the group query specifies
|
|
680
|
+
# `AWS::AllSupported`, because a group based on such a query can contain
|
|
681
|
+
# any of the allowed resource types for the query type (tag-based or AWS
|
|
682
|
+
# CloudFormation stack-based queries).
|
|
683
|
+
#
|
|
519
684
|
# @option params [Integer] :max_results
|
|
520
|
-
# The
|
|
521
|
-
#
|
|
522
|
-
#
|
|
685
|
+
# The total number of results that you want included on each page of the
|
|
686
|
+
# response. If you do not include this parameter, it defaults to a value
|
|
687
|
+
# that is specific to the operation. If additional items exist beyond
|
|
688
|
+
# the maximum you specify, the `NextToken` response element is present
|
|
689
|
+
# and has a value (is not null). Include that value as the `NextToken`
|
|
690
|
+
# request parameter in the next call to the operation to get the next
|
|
691
|
+
# part of the results. Note that the service might return fewer results
|
|
692
|
+
# than the maximum even when there are more results available. You
|
|
693
|
+
# should check `NextToken` after every operation to ensure that you
|
|
694
|
+
# receive all of the results.
|
|
523
695
|
#
|
|
524
696
|
# @option params [String] :next_token
|
|
525
|
-
# The
|
|
526
|
-
#
|
|
527
|
-
#
|
|
697
|
+
# The parameter for receiving additional results if you receive a
|
|
698
|
+
# `NextToken` response in a previous request. A `NextToken` response
|
|
699
|
+
# indicates that more output is available. Set this parameter to the
|
|
700
|
+
# value provided by a previous call's `NextToken` response to indicate
|
|
701
|
+
# where the output should continue from.
|
|
528
702
|
#
|
|
529
703
|
# @return [Types::ListGroupResourcesOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
530
704
|
#
|
|
@@ -532,10 +706,13 @@ module Aws::ResourceGroups
|
|
|
532
706
|
# * {Types::ListGroupResourcesOutput#next_token #next_token} => String
|
|
533
707
|
# * {Types::ListGroupResourcesOutput#query_errors #query_errors} => Array<Types::QueryError>
|
|
534
708
|
#
|
|
709
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
|
710
|
+
#
|
|
535
711
|
# @example Request syntax with placeholder values
|
|
536
712
|
#
|
|
537
713
|
# resp = client.list_group_resources({
|
|
538
|
-
# group_name: "GroupName",
|
|
714
|
+
# group_name: "GroupName",
|
|
715
|
+
# group: "GroupString",
|
|
539
716
|
# filters: [
|
|
540
717
|
# {
|
|
541
718
|
# name: "resource-type", # required, accepts resource-type
|
|
@@ -569,22 +746,39 @@ module Aws::ResourceGroups
|
|
|
569
746
|
#
|
|
570
747
|
# @option params [Array<Types::GroupFilter>] :filters
|
|
571
748
|
# Filters, formatted as GroupFilter objects, that you want to apply to a
|
|
572
|
-
# ListGroups operation.
|
|
749
|
+
# `ListGroups` operation.
|
|
573
750
|
#
|
|
574
|
-
# * `resource-type` - Filter
|
|
575
|
-
# resource types
|
|
576
|
-
#
|
|
751
|
+
# * `resource-type` - Filter the results to include only those of the
|
|
752
|
+
# specified resource types. Specify up to five resource types in the
|
|
753
|
+
# format `AWS::ServiceCode::ResourceType `. For example,
|
|
754
|
+
# `AWS::EC2::Instance`, or `AWS::S3::Bucket`.
|
|
577
755
|
#
|
|
578
|
-
#
|
|
756
|
+
# * `configuration-type` - Filter the results to include only those
|
|
757
|
+
# groups that have the specified configuration types attached. The
|
|
758
|
+
# current supported values are:
|
|
759
|
+
#
|
|
760
|
+
# * AWS:EC2::CapacityReservationPool
|
|
761
|
+
#
|
|
762
|
+
# ^
|
|
579
763
|
#
|
|
580
764
|
# @option params [Integer] :max_results
|
|
581
|
-
# The
|
|
582
|
-
#
|
|
765
|
+
# The total number of results that you want included on each page of the
|
|
766
|
+
# response. If you do not include this parameter, it defaults to a value
|
|
767
|
+
# that is specific to the operation. If additional items exist beyond
|
|
768
|
+
# the maximum you specify, the `NextToken` response element is present
|
|
769
|
+
# and has a value (is not null). Include that value as the `NextToken`
|
|
770
|
+
# request parameter in the next call to the operation to get the next
|
|
771
|
+
# part of the results. Note that the service might return fewer results
|
|
772
|
+
# than the maximum even when there are more results available. You
|
|
773
|
+
# should check `NextToken` after every operation to ensure that you
|
|
774
|
+
# receive all of the results.
|
|
583
775
|
#
|
|
584
776
|
# @option params [String] :next_token
|
|
585
|
-
# The
|
|
586
|
-
#
|
|
587
|
-
#
|
|
777
|
+
# The parameter for receiving additional results if you receive a
|
|
778
|
+
# `NextToken` response in a previous request. A `NextToken` response
|
|
779
|
+
# indicates that more output is available. Set this parameter to the
|
|
780
|
+
# value provided by a previous call's `NextToken` response to indicate
|
|
781
|
+
# where the output should continue from.
|
|
588
782
|
#
|
|
589
783
|
# @return [Types::ListGroupsOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
590
784
|
#
|
|
@@ -592,12 +786,14 @@ module Aws::ResourceGroups
|
|
|
592
786
|
# * {Types::ListGroupsOutput#groups #groups} => Array<Types::Group>
|
|
593
787
|
# * {Types::ListGroupsOutput#next_token #next_token} => String
|
|
594
788
|
#
|
|
789
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
|
790
|
+
#
|
|
595
791
|
# @example Request syntax with placeholder values
|
|
596
792
|
#
|
|
597
793
|
# resp = client.list_groups({
|
|
598
794
|
# filters: [
|
|
599
795
|
# {
|
|
600
|
-
# name: "resource-type", # required, accepts resource-type
|
|
796
|
+
# name: "resource-type", # required, accepts resource-type, configuration-type
|
|
601
797
|
# values: ["GroupFilterValue"], # required
|
|
602
798
|
# },
|
|
603
799
|
# ],
|
|
@@ -631,16 +827,26 @@ module Aws::ResourceGroups
|
|
|
631
827
|
#
|
|
632
828
|
# @option params [required, Types::ResourceQuery] :resource_query
|
|
633
829
|
# The search query, using the same formats that are supported for
|
|
634
|
-
# resource group definition.
|
|
830
|
+
# resource group definition. For more information, see CreateGroup.
|
|
635
831
|
#
|
|
636
832
|
# @option params [Integer] :max_results
|
|
637
|
-
# The
|
|
638
|
-
#
|
|
833
|
+
# The total number of results that you want included on each page of the
|
|
834
|
+
# response. If you do not include this parameter, it defaults to a value
|
|
835
|
+
# that is specific to the operation. If additional items exist beyond
|
|
836
|
+
# the maximum you specify, the `NextToken` response element is present
|
|
837
|
+
# and has a value (is not null). Include that value as the `NextToken`
|
|
838
|
+
# request parameter in the next call to the operation to get the next
|
|
839
|
+
# part of the results. Note that the service might return fewer results
|
|
840
|
+
# than the maximum even when there are more results available. You
|
|
841
|
+
# should check `NextToken` after every operation to ensure that you
|
|
842
|
+
# receive all of the results.
|
|
639
843
|
#
|
|
640
844
|
# @option params [String] :next_token
|
|
641
|
-
# The
|
|
642
|
-
#
|
|
643
|
-
#
|
|
845
|
+
# The parameter for receiving additional results if you receive a
|
|
846
|
+
# `NextToken` response in a previous request. A `NextToken` response
|
|
847
|
+
# indicates that more output is available. Set this parameter to the
|
|
848
|
+
# value provided by a previous call's `NextToken` response to indicate
|
|
849
|
+
# where the output should continue from.
|
|
644
850
|
#
|
|
645
851
|
# @return [Types::SearchResourcesOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
646
852
|
#
|
|
@@ -648,6 +854,8 @@ module Aws::ResourceGroups
|
|
|
648
854
|
# * {Types::SearchResourcesOutput#next_token #next_token} => String
|
|
649
855
|
# * {Types::SearchResourcesOutput#query_errors #query_errors} => Array<Types::QueryError>
|
|
650
856
|
#
|
|
857
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
|
858
|
+
#
|
|
651
859
|
# @example Request syntax with placeholder values
|
|
652
860
|
#
|
|
653
861
|
# resp = client.search_resources({
|
|
@@ -682,14 +890,17 @@ module Aws::ResourceGroups
|
|
|
682
890
|
# a resource group are not changed if they are not specified in the
|
|
683
891
|
# request parameters.
|
|
684
892
|
#
|
|
893
|
+
# Do not store personally identifiable information (PII) or other
|
|
894
|
+
# confidential or sensitive information in tags. We use tags to provide
|
|
895
|
+
# you with billing and administration services. Tags are not intended to
|
|
896
|
+
# be used for private or sensitive data.
|
|
897
|
+
#
|
|
685
898
|
# @option params [required, String] :arn
|
|
686
|
-
# The ARN of the resource to which to add tags.
|
|
899
|
+
# The ARN of the resource group to which to add tags.
|
|
687
900
|
#
|
|
688
901
|
# @option params [required, Hash<String,String>] :tags
|
|
689
|
-
# The tags to add to the specified resource. A tag is a
|
|
690
|
-
# map of key-value pairs.
|
|
691
|
-
# of 128 characters, and tag values can have a maximum length of 256
|
|
692
|
-
# characters.
|
|
902
|
+
# The tags to add to the specified resource group. A tag is a
|
|
903
|
+
# string-to-string map of key-value pairs.
|
|
693
904
|
#
|
|
694
905
|
# @return [Types::TagOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
695
906
|
#
|
|
@@ -720,10 +931,51 @@ module Aws::ResourceGroups
|
|
|
720
931
|
req.send_request(options)
|
|
721
932
|
end
|
|
722
933
|
|
|
723
|
-
#
|
|
934
|
+
# Removes the specified resources from the specified group.
|
|
935
|
+
#
|
|
936
|
+
# @option params [required, String] :group
|
|
937
|
+
# The name or the ARN of the resource group from which to remove the
|
|
938
|
+
# resources.
|
|
939
|
+
#
|
|
940
|
+
# @option params [required, Array<String>] :resource_arns
|
|
941
|
+
# The ARNs of the resources to be removed from the group.
|
|
942
|
+
#
|
|
943
|
+
# @return [Types::UngroupResourcesOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
944
|
+
#
|
|
945
|
+
# * {Types::UngroupResourcesOutput#succeeded #succeeded} => Array<String>
|
|
946
|
+
# * {Types::UngroupResourcesOutput#failed #failed} => Array<Types::FailedResource>
|
|
947
|
+
#
|
|
948
|
+
# @example Request syntax with placeholder values
|
|
949
|
+
#
|
|
950
|
+
# resp = client.ungroup_resources({
|
|
951
|
+
# group: "GroupString", # required
|
|
952
|
+
# resource_arns: ["ResourceArn"], # required
|
|
953
|
+
# })
|
|
954
|
+
#
|
|
955
|
+
# @example Response structure
|
|
956
|
+
#
|
|
957
|
+
# resp.succeeded #=> Array
|
|
958
|
+
# resp.succeeded[0] #=> String
|
|
959
|
+
# resp.failed #=> Array
|
|
960
|
+
# resp.failed[0].resource_arn #=> String
|
|
961
|
+
# resp.failed[0].error_message #=> String
|
|
962
|
+
# resp.failed[0].error_code #=> String
|
|
963
|
+
#
|
|
964
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/resource-groups-2017-11-27/UngroupResources AWS API Documentation
|
|
965
|
+
#
|
|
966
|
+
# @overload ungroup_resources(params = {})
|
|
967
|
+
# @param [Hash] params ({})
|
|
968
|
+
def ungroup_resources(params = {}, options = {})
|
|
969
|
+
req = build_request(:ungroup_resources, params)
|
|
970
|
+
req.send_request(options)
|
|
971
|
+
end
|
|
972
|
+
|
|
973
|
+
# Deletes tags from a specified resource group.
|
|
724
974
|
#
|
|
725
975
|
# @option params [required, String] :arn
|
|
726
|
-
# The ARN of the resource from which to remove tags.
|
|
976
|
+
# The ARN of the resource group from which to remove tags. The command
|
|
977
|
+
# removed both the specified keys and any values associated with those
|
|
978
|
+
# keys.
|
|
727
979
|
#
|
|
728
980
|
# @option params [required, Array<String>] :keys
|
|
729
981
|
# The keys of the tags to be removed.
|
|
@@ -755,17 +1007,19 @@ module Aws::ResourceGroups
|
|
|
755
1007
|
req.send_request(options)
|
|
756
1008
|
end
|
|
757
1009
|
|
|
758
|
-
# Updates an existing group
|
|
759
|
-
#
|
|
1010
|
+
# Updates the description for an existing group. You cannot update the
|
|
1011
|
+
# name of a resource group.
|
|
1012
|
+
#
|
|
1013
|
+
# @option params [String] :group_name
|
|
1014
|
+
# Don't use this parameter. Use `Group` instead.
|
|
760
1015
|
#
|
|
761
|
-
# @option params [
|
|
762
|
-
# The name of the resource group
|
|
763
|
-
# description.
|
|
1016
|
+
# @option params [String] :group
|
|
1017
|
+
# The name or the ARN of the resource group to modify.
|
|
764
1018
|
#
|
|
765
1019
|
# @option params [String] :description
|
|
766
|
-
# The description
|
|
767
|
-
#
|
|
768
|
-
#
|
|
1020
|
+
# The new description that you want to update the resource group with.
|
|
1021
|
+
# Descriptions can contain letters, numbers, hyphens, underscores,
|
|
1022
|
+
# periods, and spaces.
|
|
769
1023
|
#
|
|
770
1024
|
# @return [Types::UpdateGroupOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
771
1025
|
#
|
|
@@ -774,8 +1028,9 @@ module Aws::ResourceGroups
|
|
|
774
1028
|
# @example Request syntax with placeholder values
|
|
775
1029
|
#
|
|
776
1030
|
# resp = client.update_group({
|
|
777
|
-
# group_name: "GroupName",
|
|
778
|
-
#
|
|
1031
|
+
# group_name: "GroupName",
|
|
1032
|
+
# group: "GroupString",
|
|
1033
|
+
# description: "Description",
|
|
779
1034
|
# })
|
|
780
1035
|
#
|
|
781
1036
|
# @example Response structure
|
|
@@ -795,12 +1050,15 @@ module Aws::ResourceGroups
|
|
|
795
1050
|
|
|
796
1051
|
# Updates the resource query of a group.
|
|
797
1052
|
#
|
|
798
|
-
# @option params [
|
|
799
|
-
#
|
|
1053
|
+
# @option params [String] :group_name
|
|
1054
|
+
# Don't use this parameter. Use `Group` instead.
|
|
1055
|
+
#
|
|
1056
|
+
# @option params [String] :group
|
|
1057
|
+
# The name or the ARN of the resource group to query.
|
|
800
1058
|
#
|
|
801
1059
|
# @option params [required, Types::ResourceQuery] :resource_query
|
|
802
|
-
# The resource query
|
|
803
|
-
#
|
|
1060
|
+
# The resource query to determine which AWS resources are members of
|
|
1061
|
+
# this resource group.
|
|
804
1062
|
#
|
|
805
1063
|
# @return [Types::UpdateGroupQueryOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
806
1064
|
#
|
|
@@ -809,7 +1067,8 @@ module Aws::ResourceGroups
|
|
|
809
1067
|
# @example Request syntax with placeholder values
|
|
810
1068
|
#
|
|
811
1069
|
# resp = client.update_group_query({
|
|
812
|
-
# group_name: "GroupName",
|
|
1070
|
+
# group_name: "GroupName",
|
|
1071
|
+
# group: "GroupString",
|
|
813
1072
|
# resource_query: { # required
|
|
814
1073
|
# type: "TAG_FILTERS_1_0", # required, accepts TAG_FILTERS_1_0, CLOUDFORMATION_STACK_1_0
|
|
815
1074
|
# query: "Query", # required
|
|
@@ -844,7 +1103,7 @@ module Aws::ResourceGroups
|
|
|
844
1103
|
params: params,
|
|
845
1104
|
config: config)
|
|
846
1105
|
context[:gem_name] = 'aws-sdk-resourcegroups'
|
|
847
|
-
context[:gem_version] = '1.
|
|
1106
|
+
context[:gem_version] = '1.27.0'
|
|
848
1107
|
Seahorse::Client::Request.new(handlers, context)
|
|
849
1108
|
end
|
|
850
1109
|
|