aws-sdk-resourcegroups 1.23.0 → 1.28.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 +343 -89
- 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 +2 -0
- data/lib/aws-sdk-resourcegroups/types.rb +629 -146
- metadata +4 -4
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 23f39cc4f5026e0dc2c82b6f0d1f27af639f37d533e3745619f1396346d17767
|
4
|
+
data.tar.gz: 7b8a568cf9111a52645a438f807378624f377b9c82391fa8cfc5fea090eda738
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 7273a02b0539ad28f76adff569b92d01c63c79be20890a2dd00db6a6ee1c786ed96ee0036daa68f8d7e4cb40056ca4d2f3aba295f2c452a56bfcd916720ddeb9
|
7
|
+
data.tar.gz: 91d08d85858c9f2f745e976daa04215c7196d89ad99122db7c1eb2f6f1aca92878a25ace291f573ae62dc0cfef776b31f717d7722de923fcc8d4dbe0de29ed19
|
@@ -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.28.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
|
|
@@ -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 a valid HTTP(S) URI.
|
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.
|
@@ -308,50 +312,73 @@ module Aws::ResourceGroups
|
|
308
312
|
|
309
313
|
# @!group API Operations
|
310
314
|
|
311
|
-
# Creates a group with
|
312
|
-
# query.
|
315
|
+
# Creates a resource group with the specified name and description. You
|
316
|
+
# can optionally include a resource query, or a service configuration.
|
313
317
|
#
|
314
318
|
# @option params [required, String] :name
|
315
319
|
# The name of the group, which is the identifier of the group in other
|
316
|
-
# operations.
|
317
|
-
#
|
318
|
-
#
|
319
|
-
#
|
320
|
-
#
|
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.
|
321
325
|
#
|
322
326
|
# @option params [String] :description
|
323
|
-
# The description of the resource group. Descriptions can
|
324
|
-
#
|
325
|
-
# punctuation, and spaces.
|
327
|
+
# The description of the resource group. Descriptions can consist of
|
328
|
+
# letters, numbers, hyphens, underscores, periods, and spaces.
|
326
329
|
#
|
327
|
-
# @option params [
|
330
|
+
# @option params [Types::ResourceQuery] :resource_query
|
328
331
|
# The resource query that determines which AWS resources are members of
|
329
332
|
# this group.
|
330
333
|
#
|
334
|
+
# <note markdown="1"> You can specify either a `ResourceQuery` or a `Configuration`, but not
|
335
|
+
# both.
|
336
|
+
#
|
337
|
+
# </note>
|
338
|
+
#
|
331
339
|
# @option params [Hash<String,String>] :tags
|
332
|
-
# The tags to add to the group. A tag is
|
333
|
-
#
|
334
|
-
#
|
335
|
-
#
|
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>
|
336
351
|
#
|
337
352
|
# @return [Types::CreateGroupOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
338
353
|
#
|
339
354
|
# * {Types::CreateGroupOutput#group #group} => Types::Group
|
340
355
|
# * {Types::CreateGroupOutput#resource_query #resource_query} => Types::ResourceQuery
|
341
356
|
# * {Types::CreateGroupOutput#tags #tags} => Hash<String,String>
|
357
|
+
# * {Types::CreateGroupOutput#group_configuration #group_configuration} => Types::GroupConfiguration
|
342
358
|
#
|
343
359
|
# @example Request syntax with placeholder values
|
344
360
|
#
|
345
361
|
# resp = client.create_group({
|
346
362
|
# name: "GroupName", # required
|
347
|
-
# description: "
|
348
|
-
# resource_query: {
|
363
|
+
# description: "Description",
|
364
|
+
# resource_query: {
|
349
365
|
# type: "TAG_FILTERS_1_0", # required, accepts TAG_FILTERS_1_0, CLOUDFORMATION_STACK_1_0
|
350
366
|
# query: "Query", # required
|
351
367
|
# },
|
352
368
|
# tags: {
|
353
369
|
# "TagKey" => "TagValue",
|
354
370
|
# },
|
371
|
+
# configuration: [
|
372
|
+
# {
|
373
|
+
# type: "GroupConfigurationType", # required
|
374
|
+
# parameters: [
|
375
|
+
# {
|
376
|
+
# name: "GroupConfigurationParameterName", # required
|
377
|
+
# values: ["GroupConfigurationParameterValue"],
|
378
|
+
# },
|
379
|
+
# ],
|
380
|
+
# },
|
381
|
+
# ],
|
355
382
|
# })
|
356
383
|
#
|
357
384
|
# @example Response structure
|
@@ -363,6 +390,20 @@ module Aws::ResourceGroups
|
|
363
390
|
# resp.resource_query.query #=> String
|
364
391
|
# resp.tags #=> Hash
|
365
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
|
366
407
|
#
|
367
408
|
# @see http://docs.aws.amazon.com/goto/WebAPI/resource-groups-2017-11-27/CreateGroup AWS API Documentation
|
368
409
|
#
|
@@ -373,12 +414,15 @@ module Aws::ResourceGroups
|
|
373
414
|
req.send_request(options)
|
374
415
|
end
|
375
416
|
|
376
|
-
# Deletes
|
377
|
-
# delete resources that are members of the group; it only
|
378
|
-
# 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.
|
379
423
|
#
|
380
|
-
# @option params [
|
381
|
-
# 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.
|
382
426
|
#
|
383
427
|
# @return [Types::DeleteGroupOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
384
428
|
#
|
@@ -387,7 +431,8 @@ module Aws::ResourceGroups
|
|
387
431
|
# @example Request syntax with placeholder values
|
388
432
|
#
|
389
433
|
# resp = client.delete_group({
|
390
|
-
# group_name: "GroupName",
|
434
|
+
# group_name: "GroupName",
|
435
|
+
# group: "GroupString",
|
391
436
|
# })
|
392
437
|
#
|
393
438
|
# @example Response structure
|
@@ -407,8 +452,11 @@ module Aws::ResourceGroups
|
|
407
452
|
|
408
453
|
# Returns information about a specified resource group.
|
409
454
|
#
|
410
|
-
# @option params [
|
411
|
-
#
|
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.
|
412
460
|
#
|
413
461
|
# @return [Types::GetGroupOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
414
462
|
#
|
@@ -417,7 +465,8 @@ module Aws::ResourceGroups
|
|
417
465
|
# @example Request syntax with placeholder values
|
418
466
|
#
|
419
467
|
# resp = client.get_group({
|
420
|
-
# group_name: "GroupName",
|
468
|
+
# group_name: "GroupName",
|
469
|
+
# group: "GroupString",
|
421
470
|
# })
|
422
471
|
#
|
423
472
|
# @example Response structure
|
@@ -435,11 +484,67 @@ module Aws::ResourceGroups
|
|
435
484
|
req.send_request(options)
|
436
485
|
end
|
437
486
|
|
438
|
-
# 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
|
439
541
|
# group.
|
440
542
|
#
|
441
|
-
# @option params [
|
442
|
-
#
|
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.
|
443
548
|
#
|
444
549
|
# @return [Types::GetGroupQueryOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
445
550
|
#
|
@@ -448,7 +553,8 @@ module Aws::ResourceGroups
|
|
448
553
|
# @example Request syntax with placeholder values
|
449
554
|
#
|
450
555
|
# resp = client.get_group_query({
|
451
|
-
# group_name: "GroupName",
|
556
|
+
# group_name: "GroupName",
|
557
|
+
# group: "GroupString",
|
452
558
|
# })
|
453
559
|
#
|
454
560
|
# @example Response structure
|
@@ -470,8 +576,7 @@ module Aws::ResourceGroups
|
|
470
576
|
# specified by an ARN.
|
471
577
|
#
|
472
578
|
# @option params [required, String] :arn
|
473
|
-
# The ARN of the resource group
|
474
|
-
# resource must exist within the account you are using.
|
579
|
+
# The ARN of the resource group whose tags you want to retrieve.
|
475
580
|
#
|
476
581
|
# @return [Types::GetTagsOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
477
582
|
#
|
@@ -499,31 +604,101 @@ module Aws::ResourceGroups
|
|
499
604
|
req.send_request(options)
|
500
605
|
end
|
501
606
|
|
502
|
-
#
|
503
|
-
#
|
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.
|
504
614
|
#
|
505
|
-
# @
|
506
|
-
#
|
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
|
+
|
645
|
+
# Returns a list of ARNs of the resources that are members of a
|
646
|
+
# specified resource group.
|
647
|
+
#
|
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
|
507
653
|
#
|
508
654
|
# @option params [Array<Types::ResourceFilter>] :filters
|
509
655
|
# Filters, formatted as ResourceFilter objects, that you want to apply
|
510
|
-
# to a ListGroupResources operation.
|
656
|
+
# to a `ListGroupResources` operation. Filters the results to include
|
657
|
+
# only those of the specified resource types.
|
511
658
|
#
|
512
659
|
# * `resource-type` - Filter resources by their type. Specify up to five
|
513
|
-
# resource types in the format AWS::ServiceCode::ResourceType
|
514
|
-
# example, AWS::EC2::Instance
|
660
|
+
# resource types in the format `AWS::ServiceCode::ResourceType`. For
|
661
|
+
# example, `AWS::EC2::Instance`, or `AWS::S3::Bucket`.
|
515
662
|
#
|
516
663
|
# ^
|
517
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
|
+
#
|
518
684
|
# @option params [Integer] :max_results
|
519
|
-
# The
|
520
|
-
#
|
521
|
-
#
|
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.
|
522
695
|
#
|
523
696
|
# @option params [String] :next_token
|
524
|
-
# The
|
525
|
-
#
|
526
|
-
#
|
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.
|
527
702
|
#
|
528
703
|
# @return [Types::ListGroupResourcesOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
529
704
|
#
|
@@ -536,7 +711,8 @@ module Aws::ResourceGroups
|
|
536
711
|
# @example Request syntax with placeholder values
|
537
712
|
#
|
538
713
|
# resp = client.list_group_resources({
|
539
|
-
# group_name: "GroupName",
|
714
|
+
# group_name: "GroupName",
|
715
|
+
# group: "GroupString",
|
540
716
|
# filters: [
|
541
717
|
# {
|
542
718
|
# name: "resource-type", # required, accepts resource-type
|
@@ -570,22 +746,39 @@ module Aws::ResourceGroups
|
|
570
746
|
#
|
571
747
|
# @option params [Array<Types::GroupFilter>] :filters
|
572
748
|
# Filters, formatted as GroupFilter objects, that you want to apply to a
|
573
|
-
# ListGroups operation.
|
749
|
+
# `ListGroups` operation.
|
574
750
|
#
|
575
|
-
# * `resource-type` - Filter
|
576
|
-
# resource types
|
577
|
-
#
|
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`.
|
578
755
|
#
|
579
|
-
#
|
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
|
+
# ^
|
580
763
|
#
|
581
764
|
# @option params [Integer] :max_results
|
582
|
-
# The
|
583
|
-
#
|
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.
|
584
775
|
#
|
585
776
|
# @option params [String] :next_token
|
586
|
-
# The
|
587
|
-
#
|
588
|
-
#
|
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.
|
589
782
|
#
|
590
783
|
# @return [Types::ListGroupsOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
591
784
|
#
|
@@ -600,7 +793,7 @@ module Aws::ResourceGroups
|
|
600
793
|
# resp = client.list_groups({
|
601
794
|
# filters: [
|
602
795
|
# {
|
603
|
-
# name: "resource-type", # required, accepts resource-type
|
796
|
+
# name: "resource-type", # required, accepts resource-type, configuration-type
|
604
797
|
# values: ["GroupFilterValue"], # required
|
605
798
|
# },
|
606
799
|
# ],
|
@@ -628,22 +821,32 @@ module Aws::ResourceGroups
|
|
628
821
|
req.send_request(options)
|
629
822
|
end
|
630
823
|
|
631
|
-
# Returns a list of AWS resource identifiers that matches
|
824
|
+
# Returns a list of AWS resource identifiers that matches tne specified
|
632
825
|
# query. The query uses the same format as a resource query in a
|
633
826
|
# CreateGroup or UpdateGroupQuery operation.
|
634
827
|
#
|
635
828
|
# @option params [required, Types::ResourceQuery] :resource_query
|
636
829
|
# The search query, using the same formats that are supported for
|
637
|
-
# resource group definition.
|
830
|
+
# resource group definition. For more information, see CreateGroup.
|
638
831
|
#
|
639
832
|
# @option params [Integer] :max_results
|
640
|
-
# The
|
641
|
-
#
|
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.
|
642
843
|
#
|
643
844
|
# @option params [String] :next_token
|
644
|
-
# The
|
645
|
-
#
|
646
|
-
#
|
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.
|
647
850
|
#
|
648
851
|
# @return [Types::SearchResourcesOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
649
852
|
#
|
@@ -687,14 +890,17 @@ module Aws::ResourceGroups
|
|
687
890
|
# a resource group are not changed if they are not specified in the
|
688
891
|
# request parameters.
|
689
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
|
+
#
|
690
898
|
# @option params [required, String] :arn
|
691
|
-
# The ARN of the resource to which to add tags.
|
899
|
+
# The ARN of the resource group to which to add tags.
|
692
900
|
#
|
693
901
|
# @option params [required, Hash<String,String>] :tags
|
694
|
-
# The tags to add to the specified resource. A tag is a
|
695
|
-
# map of key-value pairs.
|
696
|
-
# of 128 characters, and tag values can have a maximum length of 256
|
697
|
-
# characters.
|
902
|
+
# The tags to add to the specified resource group. A tag is a
|
903
|
+
# string-to-string map of key-value pairs.
|
698
904
|
#
|
699
905
|
# @return [Types::TagOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
700
906
|
#
|
@@ -725,10 +931,51 @@ module Aws::ResourceGroups
|
|
725
931
|
req.send_request(options)
|
726
932
|
end
|
727
933
|
|
728
|
-
#
|
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.
|
729
974
|
#
|
730
975
|
# @option params [required, String] :arn
|
731
|
-
# 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.
|
732
979
|
#
|
733
980
|
# @option params [required, Array<String>] :keys
|
734
981
|
# The keys of the tags to be removed.
|
@@ -760,17 +1007,19 @@ module Aws::ResourceGroups
|
|
760
1007
|
req.send_request(options)
|
761
1008
|
end
|
762
1009
|
|
763
|
-
# Updates an existing group
|
764
|
-
#
|
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.
|
765
1015
|
#
|
766
|
-
# @option params [
|
767
|
-
# The name of the resource group
|
768
|
-
# description.
|
1016
|
+
# @option params [String] :group
|
1017
|
+
# The name or the ARN of the resource group to modify.
|
769
1018
|
#
|
770
1019
|
# @option params [String] :description
|
771
|
-
# The description
|
772
|
-
#
|
773
|
-
#
|
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.
|
774
1023
|
#
|
775
1024
|
# @return [Types::UpdateGroupOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
776
1025
|
#
|
@@ -779,8 +1028,9 @@ module Aws::ResourceGroups
|
|
779
1028
|
# @example Request syntax with placeholder values
|
780
1029
|
#
|
781
1030
|
# resp = client.update_group({
|
782
|
-
# group_name: "GroupName",
|
783
|
-
#
|
1031
|
+
# group_name: "GroupName",
|
1032
|
+
# group: "GroupString",
|
1033
|
+
# description: "Description",
|
784
1034
|
# })
|
785
1035
|
#
|
786
1036
|
# @example Response structure
|
@@ -800,12 +1050,15 @@ module Aws::ResourceGroups
|
|
800
1050
|
|
801
1051
|
# Updates the resource query of a group.
|
802
1052
|
#
|
803
|
-
# @option params [
|
804
|
-
#
|
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.
|
805
1058
|
#
|
806
1059
|
# @option params [required, Types::ResourceQuery] :resource_query
|
807
|
-
# The resource query
|
808
|
-
#
|
1060
|
+
# The resource query to determine which AWS resources are members of
|
1061
|
+
# this resource group.
|
809
1062
|
#
|
810
1063
|
# @return [Types::UpdateGroupQueryOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
811
1064
|
#
|
@@ -814,7 +1067,8 @@ module Aws::ResourceGroups
|
|
814
1067
|
# @example Request syntax with placeholder values
|
815
1068
|
#
|
816
1069
|
# resp = client.update_group_query({
|
817
|
-
# group_name: "GroupName",
|
1070
|
+
# group_name: "GroupName",
|
1071
|
+
# group: "GroupString",
|
818
1072
|
# resource_query: { # required
|
819
1073
|
# type: "TAG_FILTERS_1_0", # required, accepts TAG_FILTERS_1_0, CLOUDFORMATION_STACK_1_0
|
820
1074
|
# query: "Query", # required
|
@@ -849,7 +1103,7 @@ module Aws::ResourceGroups
|
|
849
1103
|
params: params,
|
850
1104
|
config: config)
|
851
1105
|
context[:gem_name] = 'aws-sdk-resourcegroups'
|
852
|
-
context[:gem_version] = '1.
|
1106
|
+
context[:gem_version] = '1.28.0'
|
853
1107
|
Seahorse::Client::Request.new(handlers, context)
|
854
1108
|
end
|
855
1109
|
|