aws-sdk-resourcegroups 1.26.0 → 1.31.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/lib/aws-sdk-resourcegroups.rb +3 -2
- data/lib/aws-sdk-resourcegroups/client.rb +359 -94
- data/lib/aws-sdk-resourcegroups/client_api.rb +147 -24
- data/lib/aws-sdk-resourcegroups/types.rb +648 -147
- metadata +2 -2
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 3b6e28ce269da1a2204f43b306a04a1226552656d71bf08717fe6572ed7004ea
|
4
|
+
data.tar.gz: 952325578f4c31a9175d30270f6ad9607e587e92c0e3915bbcc500e79a6ec4b1
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: da4aaddc000e9ca8402922276c22b83b206971d5a423732d6fb07024e4098655a293b05dd9db7cd58339f4bf85bb3863d536a498cb010bd57c0b60fb0c365679
|
7
|
+
data.tar.gz: 4b9bb0534939d0d1fc3f3045cbb7972c0422eacbde03c5a42734c70218fe33f36fdd84fb506cc128e22a7a5fe2eddfc78bb7e938d39148e96ae4a60ce223ca07
|
@@ -7,6 +7,7 @@
|
|
7
7
|
#
|
8
8
|
# WARNING ABOUT GENERATED CODE
|
9
9
|
|
10
|
+
|
10
11
|
require 'aws-sdk-core'
|
11
12
|
require 'aws-sigv4'
|
12
13
|
|
@@ -44,9 +45,9 @@ require_relative 'aws-sdk-resourcegroups/customizations'
|
|
44
45
|
#
|
45
46
|
# See {Errors} for more information.
|
46
47
|
#
|
47
|
-
#
|
48
|
+
# @!group service
|
48
49
|
module Aws::ResourceGroups
|
49
50
|
|
50
|
-
GEM_VERSION = '1.
|
51
|
+
GEM_VERSION = '1.31.0'
|
51
52
|
|
52
53
|
end
|
@@ -85,13 +85,28 @@ module Aws::ResourceGroups
|
|
85
85
|
# * `Aws::Credentials` - Used for configuring static, non-refreshing
|
86
86
|
# credentials.
|
87
87
|
#
|
88
|
+
# * `Aws::SharedCredentials` - Used for loading static credentials from a
|
89
|
+
# shared file, such as `~/.aws/config`.
|
90
|
+
#
|
91
|
+
# * `Aws::AssumeRoleCredentials` - Used when you need to assume a role.
|
92
|
+
#
|
93
|
+
# * `Aws::AssumeRoleWebIdentityCredentials` - Used when you need to
|
94
|
+
# assume a role after providing credentials via the web.
|
95
|
+
#
|
96
|
+
# * `Aws::SSOCredentials` - Used for loading credentials from AWS SSO using an
|
97
|
+
# access token generated from `aws login`.
|
98
|
+
#
|
99
|
+
# * `Aws::ProcessCredentials` - Used for loading credentials from a
|
100
|
+
# process that outputs to stdout.
|
101
|
+
#
|
88
102
|
# * `Aws::InstanceProfileCredentials` - Used for loading credentials
|
89
103
|
# from an EC2 IMDS on an EC2 instance.
|
90
104
|
#
|
91
|
-
# * `Aws::
|
92
|
-
#
|
105
|
+
# * `Aws::ECSCredentials` - Used for loading credentials from
|
106
|
+
# instances running in ECS.
|
93
107
|
#
|
94
|
-
# * `Aws::
|
108
|
+
# * `Aws::CognitoIdentityCredentials` - Used for loading credentials
|
109
|
+
# from the Cognito Identity service.
|
95
110
|
#
|
96
111
|
# When `:credentials` are not configured directly, the following
|
97
112
|
# locations will be searched for credentials:
|
@@ -101,10 +116,10 @@ module Aws::ResourceGroups
|
|
101
116
|
# * ENV['AWS_ACCESS_KEY_ID'], ENV['AWS_SECRET_ACCESS_KEY']
|
102
117
|
# * `~/.aws/credentials`
|
103
118
|
# * `~/.aws/config`
|
104
|
-
# * EC2 IMDS instance profile - When used by default, the timeouts
|
105
|
-
# very aggressive. Construct and pass an instance of
|
106
|
-
# `Aws::InstanceProfileCredentails`
|
107
|
-
# timeouts.
|
119
|
+
# * EC2/ECS IMDS instance profile - When used by default, the timeouts
|
120
|
+
# are very aggressive. Construct and pass an instance of
|
121
|
+
# `Aws::InstanceProfileCredentails` or `Aws::ECSCredentials` to
|
122
|
+
# enable retries and extended timeouts.
|
108
123
|
#
|
109
124
|
# @option options [required, String] :region
|
110
125
|
# The AWS region to connect to. The configured `:region` is
|
@@ -312,50 +327,73 @@ module Aws::ResourceGroups
|
|
312
327
|
|
313
328
|
# @!group API Operations
|
314
329
|
|
315
|
-
# Creates a group with
|
316
|
-
# query.
|
330
|
+
# Creates a resource group with the specified name and description. You
|
331
|
+
# can optionally include a resource query, or a service configuration.
|
317
332
|
#
|
318
333
|
# @option params [required, String] :name
|
319
334
|
# The name of the group, which is the identifier of the group in other
|
320
|
-
# operations.
|
321
|
-
#
|
322
|
-
#
|
323
|
-
#
|
324
|
-
#
|
335
|
+
# operations. You can't change the name of a resource group after you
|
336
|
+
# create it. A resource group name can consist of letters, numbers,
|
337
|
+
# hyphens, periods, and underscores. The name cannot start with `AWS` or
|
338
|
+
# `aws`; these are reserved. A resource group name must be unique within
|
339
|
+
# each AWS Region in your AWS account.
|
325
340
|
#
|
326
341
|
# @option params [String] :description
|
327
|
-
# The description of the resource group. Descriptions can
|
328
|
-
#
|
329
|
-
# punctuation, and spaces.
|
342
|
+
# The description of the resource group. Descriptions can consist of
|
343
|
+
# letters, numbers, hyphens, underscores, periods, and spaces.
|
330
344
|
#
|
331
|
-
# @option params [
|
345
|
+
# @option params [Types::ResourceQuery] :resource_query
|
332
346
|
# The resource query that determines which AWS resources are members of
|
333
347
|
# this group.
|
334
348
|
#
|
349
|
+
# <note markdown="1"> You can specify either a `ResourceQuery` or a `Configuration`, but not
|
350
|
+
# both.
|
351
|
+
#
|
352
|
+
# </note>
|
353
|
+
#
|
335
354
|
# @option params [Hash<String,String>] :tags
|
336
|
-
# The tags to add to the group. A tag is
|
337
|
-
#
|
338
|
-
#
|
339
|
-
#
|
355
|
+
# The tags to add to the group. A tag is key-value pair string.
|
356
|
+
#
|
357
|
+
# @option params [Array<Types::GroupConfigurationItem>] :configuration
|
358
|
+
# A configuration associates the resource group with an AWS service and
|
359
|
+
# specifies how the service can interact with the resources in the
|
360
|
+
# group. A configuration is an array of GroupConfigurationItem elements.
|
361
|
+
#
|
362
|
+
# <note markdown="1"> You can specify either a `Configuration` or a `ResourceQuery` in a
|
363
|
+
# group, but not both.
|
364
|
+
#
|
365
|
+
# </note>
|
340
366
|
#
|
341
367
|
# @return [Types::CreateGroupOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
342
368
|
#
|
343
369
|
# * {Types::CreateGroupOutput#group #group} => Types::Group
|
344
370
|
# * {Types::CreateGroupOutput#resource_query #resource_query} => Types::ResourceQuery
|
345
371
|
# * {Types::CreateGroupOutput#tags #tags} => Hash<String,String>
|
372
|
+
# * {Types::CreateGroupOutput#group_configuration #group_configuration} => Types::GroupConfiguration
|
346
373
|
#
|
347
374
|
# @example Request syntax with placeholder values
|
348
375
|
#
|
349
376
|
# resp = client.create_group({
|
350
377
|
# name: "GroupName", # required
|
351
|
-
# description: "
|
352
|
-
# resource_query: {
|
378
|
+
# description: "Description",
|
379
|
+
# resource_query: {
|
353
380
|
# type: "TAG_FILTERS_1_0", # required, accepts TAG_FILTERS_1_0, CLOUDFORMATION_STACK_1_0
|
354
381
|
# query: "Query", # required
|
355
382
|
# },
|
356
383
|
# tags: {
|
357
384
|
# "TagKey" => "TagValue",
|
358
385
|
# },
|
386
|
+
# configuration: [
|
387
|
+
# {
|
388
|
+
# type: "GroupConfigurationType", # required
|
389
|
+
# parameters: [
|
390
|
+
# {
|
391
|
+
# name: "GroupConfigurationParameterName", # required
|
392
|
+
# values: ["GroupConfigurationParameterValue"],
|
393
|
+
# },
|
394
|
+
# ],
|
395
|
+
# },
|
396
|
+
# ],
|
359
397
|
# })
|
360
398
|
#
|
361
399
|
# @example Response structure
|
@@ -367,6 +405,20 @@ module Aws::ResourceGroups
|
|
367
405
|
# resp.resource_query.query #=> String
|
368
406
|
# resp.tags #=> Hash
|
369
407
|
# resp.tags["TagKey"] #=> String
|
408
|
+
# resp.group_configuration.configuration #=> Array
|
409
|
+
# resp.group_configuration.configuration[0].type #=> String
|
410
|
+
# resp.group_configuration.configuration[0].parameters #=> Array
|
411
|
+
# resp.group_configuration.configuration[0].parameters[0].name #=> String
|
412
|
+
# resp.group_configuration.configuration[0].parameters[0].values #=> Array
|
413
|
+
# resp.group_configuration.configuration[0].parameters[0].values[0] #=> String
|
414
|
+
# resp.group_configuration.proposed_configuration #=> Array
|
415
|
+
# resp.group_configuration.proposed_configuration[0].type #=> String
|
416
|
+
# resp.group_configuration.proposed_configuration[0].parameters #=> Array
|
417
|
+
# resp.group_configuration.proposed_configuration[0].parameters[0].name #=> String
|
418
|
+
# resp.group_configuration.proposed_configuration[0].parameters[0].values #=> Array
|
419
|
+
# resp.group_configuration.proposed_configuration[0].parameters[0].values[0] #=> String
|
420
|
+
# resp.group_configuration.status #=> String, one of "UPDATING", "UPDATE_COMPLETE", "UPDATE_FAILED"
|
421
|
+
# resp.group_configuration.failure_reason #=> String
|
370
422
|
#
|
371
423
|
# @see http://docs.aws.amazon.com/goto/WebAPI/resource-groups-2017-11-27/CreateGroup AWS API Documentation
|
372
424
|
#
|
@@ -377,12 +429,15 @@ module Aws::ResourceGroups
|
|
377
429
|
req.send_request(options)
|
378
430
|
end
|
379
431
|
|
380
|
-
# Deletes
|
381
|
-
# delete resources that are members of the group; it only
|
382
|
-
# group structure.
|
432
|
+
# Deletes the specified resource group. Deleting a resource group does
|
433
|
+
# not delete any resources that are members of the group; it only
|
434
|
+
# deletes the group structure.
|
435
|
+
#
|
436
|
+
# @option params [String] :group_name
|
437
|
+
# Don't use this parameter. Use `Group` instead.
|
383
438
|
#
|
384
|
-
# @option params [
|
385
|
-
# The name of the resource group to delete.
|
439
|
+
# @option params [String] :group
|
440
|
+
# The name or the ARN of the resource group to delete.
|
386
441
|
#
|
387
442
|
# @return [Types::DeleteGroupOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
388
443
|
#
|
@@ -391,7 +446,8 @@ module Aws::ResourceGroups
|
|
391
446
|
# @example Request syntax with placeholder values
|
392
447
|
#
|
393
448
|
# resp = client.delete_group({
|
394
|
-
# group_name: "GroupName",
|
449
|
+
# group_name: "GroupName",
|
450
|
+
# group: "GroupString",
|
395
451
|
# })
|
396
452
|
#
|
397
453
|
# @example Response structure
|
@@ -411,8 +467,11 @@ module Aws::ResourceGroups
|
|
411
467
|
|
412
468
|
# Returns information about a specified resource group.
|
413
469
|
#
|
414
|
-
# @option params [
|
415
|
-
#
|
470
|
+
# @option params [String] :group_name
|
471
|
+
# Don't use this parameter. Use `Group` instead.
|
472
|
+
#
|
473
|
+
# @option params [String] :group
|
474
|
+
# The name or the ARN of the resource group to retrieve.
|
416
475
|
#
|
417
476
|
# @return [Types::GetGroupOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
418
477
|
#
|
@@ -421,7 +480,8 @@ module Aws::ResourceGroups
|
|
421
480
|
# @example Request syntax with placeholder values
|
422
481
|
#
|
423
482
|
# resp = client.get_group({
|
424
|
-
# group_name: "GroupName",
|
483
|
+
# group_name: "GroupName",
|
484
|
+
# group: "GroupString",
|
425
485
|
# })
|
426
486
|
#
|
427
487
|
# @example Response structure
|
@@ -439,11 +499,67 @@ module Aws::ResourceGroups
|
|
439
499
|
req.send_request(options)
|
440
500
|
end
|
441
501
|
|
442
|
-
# Returns the
|
502
|
+
# Returns the service configuration associated with the specified
|
503
|
+
# resource group. AWS Resource Groups supports configurations for the
|
504
|
+
# following resource group types:
|
505
|
+
#
|
506
|
+
# * `AWS::EC2::CapacityReservationPool` - Amazon EC2 capacity
|
507
|
+
# reservation pools. For more information, see [Working with capacity
|
508
|
+
# reservation groups][1] in the *EC2 Users Guide*.
|
509
|
+
#
|
510
|
+
# ^
|
511
|
+
#
|
512
|
+
#
|
513
|
+
#
|
514
|
+
# [1]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/capacity-reservations-using.html#create-cr-group
|
515
|
+
#
|
516
|
+
# @option params [String] :group
|
517
|
+
# The name or the ARN of the resource group.
|
518
|
+
#
|
519
|
+
# @return [Types::GetGroupConfigurationOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
520
|
+
#
|
521
|
+
# * {Types::GetGroupConfigurationOutput#group_configuration #group_configuration} => Types::GroupConfiguration
|
522
|
+
#
|
523
|
+
# @example Request syntax with placeholder values
|
524
|
+
#
|
525
|
+
# resp = client.get_group_configuration({
|
526
|
+
# group: "GroupString",
|
527
|
+
# })
|
528
|
+
#
|
529
|
+
# @example Response structure
|
530
|
+
#
|
531
|
+
# resp.group_configuration.configuration #=> Array
|
532
|
+
# resp.group_configuration.configuration[0].type #=> String
|
533
|
+
# resp.group_configuration.configuration[0].parameters #=> Array
|
534
|
+
# resp.group_configuration.configuration[0].parameters[0].name #=> String
|
535
|
+
# resp.group_configuration.configuration[0].parameters[0].values #=> Array
|
536
|
+
# resp.group_configuration.configuration[0].parameters[0].values[0] #=> String
|
537
|
+
# resp.group_configuration.proposed_configuration #=> Array
|
538
|
+
# resp.group_configuration.proposed_configuration[0].type #=> String
|
539
|
+
# resp.group_configuration.proposed_configuration[0].parameters #=> Array
|
540
|
+
# resp.group_configuration.proposed_configuration[0].parameters[0].name #=> String
|
541
|
+
# resp.group_configuration.proposed_configuration[0].parameters[0].values #=> Array
|
542
|
+
# resp.group_configuration.proposed_configuration[0].parameters[0].values[0] #=> String
|
543
|
+
# resp.group_configuration.status #=> String, one of "UPDATING", "UPDATE_COMPLETE", "UPDATE_FAILED"
|
544
|
+
# resp.group_configuration.failure_reason #=> String
|
545
|
+
#
|
546
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/resource-groups-2017-11-27/GetGroupConfiguration AWS API Documentation
|
547
|
+
#
|
548
|
+
# @overload get_group_configuration(params = {})
|
549
|
+
# @param [Hash] params ({})
|
550
|
+
def get_group_configuration(params = {}, options = {})
|
551
|
+
req = build_request(:get_group_configuration, params)
|
552
|
+
req.send_request(options)
|
553
|
+
end
|
554
|
+
|
555
|
+
# Retrieves the resource query associated with the specified resource
|
443
556
|
# group.
|
444
557
|
#
|
445
|
-
# @option params [
|
446
|
-
#
|
558
|
+
# @option params [String] :group_name
|
559
|
+
# Don't use this parameter. Use `Group` instead.
|
560
|
+
#
|
561
|
+
# @option params [String] :group
|
562
|
+
# The name or the ARN of the resource group to query.
|
447
563
|
#
|
448
564
|
# @return [Types::GetGroupQueryOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
449
565
|
#
|
@@ -452,7 +568,8 @@ module Aws::ResourceGroups
|
|
452
568
|
# @example Request syntax with placeholder values
|
453
569
|
#
|
454
570
|
# resp = client.get_group_query({
|
455
|
-
# group_name: "GroupName",
|
571
|
+
# group_name: "GroupName",
|
572
|
+
# group: "GroupString",
|
456
573
|
# })
|
457
574
|
#
|
458
575
|
# @example Response structure
|
@@ -474,8 +591,7 @@ module Aws::ResourceGroups
|
|
474
591
|
# specified by an ARN.
|
475
592
|
#
|
476
593
|
# @option params [required, String] :arn
|
477
|
-
# The ARN of the resource group
|
478
|
-
# resource must exist within the account you are using.
|
594
|
+
# The ARN of the resource group whose tags you want to retrieve.
|
479
595
|
#
|
480
596
|
# @return [Types::GetTagsOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
481
597
|
#
|
@@ -503,31 +619,101 @@ module Aws::ResourceGroups
|
|
503
619
|
req.send_request(options)
|
504
620
|
end
|
505
621
|
|
506
|
-
#
|
507
|
-
#
|
622
|
+
# Adds the specified resources to the specified group.
|
623
|
+
#
|
624
|
+
# @option params [required, String] :group
|
625
|
+
# The name or the ARN of the resource group to add resources to.
|
626
|
+
#
|
627
|
+
# @option params [required, Array<String>] :resource_arns
|
628
|
+
# The list of ARNs for resources to be added to the group.
|
508
629
|
#
|
509
|
-
# @
|
510
|
-
#
|
630
|
+
# @return [Types::GroupResourcesOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
631
|
+
#
|
632
|
+
# * {Types::GroupResourcesOutput#succeeded #succeeded} => Array<String>
|
633
|
+
# * {Types::GroupResourcesOutput#failed #failed} => Array<Types::FailedResource>
|
634
|
+
#
|
635
|
+
# @example Request syntax with placeholder values
|
636
|
+
#
|
637
|
+
# resp = client.group_resources({
|
638
|
+
# group: "GroupString", # required
|
639
|
+
# resource_arns: ["ResourceArn"], # required
|
640
|
+
# })
|
641
|
+
#
|
642
|
+
# @example Response structure
|
643
|
+
#
|
644
|
+
# resp.succeeded #=> Array
|
645
|
+
# resp.succeeded[0] #=> String
|
646
|
+
# resp.failed #=> Array
|
647
|
+
# resp.failed[0].resource_arn #=> String
|
648
|
+
# resp.failed[0].error_message #=> String
|
649
|
+
# resp.failed[0].error_code #=> String
|
650
|
+
#
|
651
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/resource-groups-2017-11-27/GroupResources AWS API Documentation
|
652
|
+
#
|
653
|
+
# @overload group_resources(params = {})
|
654
|
+
# @param [Hash] params ({})
|
655
|
+
def group_resources(params = {}, options = {})
|
656
|
+
req = build_request(:group_resources, params)
|
657
|
+
req.send_request(options)
|
658
|
+
end
|
659
|
+
|
660
|
+
# Returns a list of ARNs of the resources that are members of a
|
661
|
+
# specified resource group.
|
662
|
+
#
|
663
|
+
# @option params [String] :group_name
|
664
|
+
# Don't use this parameter. Use `Group` instead.
|
665
|
+
#
|
666
|
+
# @option params [String] :group
|
667
|
+
# The name or the ARN of the resource group
|
511
668
|
#
|
512
669
|
# @option params [Array<Types::ResourceFilter>] :filters
|
513
670
|
# Filters, formatted as ResourceFilter objects, that you want to apply
|
514
|
-
# to a ListGroupResources operation.
|
671
|
+
# to a `ListGroupResources` operation. Filters the results to include
|
672
|
+
# only those of the specified resource types.
|
515
673
|
#
|
516
674
|
# * `resource-type` - Filter resources by their type. Specify up to five
|
517
|
-
# resource types in the format AWS::ServiceCode::ResourceType
|
518
|
-
# example, AWS::EC2::Instance
|
675
|
+
# resource types in the format `AWS::ServiceCode::ResourceType`. For
|
676
|
+
# example, `AWS::EC2::Instance`, or `AWS::S3::Bucket`.
|
519
677
|
#
|
520
678
|
# ^
|
521
679
|
#
|
680
|
+
# When you specify a `resource-type` filter for `ListGroupResources`,
|
681
|
+
# AWS Resource Groups validates your filter resource types against the
|
682
|
+
# types that are defined in the query associated with the group. For
|
683
|
+
# example, if a group contains only S3 buckets because its query
|
684
|
+
# specifies only that resource type, but your `resource-type` filter
|
685
|
+
# includes EC2 instances, AWS Resource Groups does not filter for EC2
|
686
|
+
# instances. In this case, a `ListGroupResources` request returns a
|
687
|
+
# `BadRequestException` error with a message similar to the following:
|
688
|
+
#
|
689
|
+
# `The resource types specified as filters in the request are not
|
690
|
+
# valid.`
|
691
|
+
#
|
692
|
+
# The error includes a list of resource types that failed the validation
|
693
|
+
# because they are not part of the query associated with the group. This
|
694
|
+
# validation doesn't occur when the group query specifies
|
695
|
+
# `AWS::AllSupported`, because a group based on such a query can contain
|
696
|
+
# any of the allowed resource types for the query type (tag-based or AWS
|
697
|
+
# CloudFormation stack-based queries).
|
698
|
+
#
|
522
699
|
# @option params [Integer] :max_results
|
523
|
-
# The
|
524
|
-
#
|
525
|
-
#
|
700
|
+
# The total number of results that you want included on each page of the
|
701
|
+
# response. If you do not include this parameter, it defaults to a value
|
702
|
+
# that is specific to the operation. If additional items exist beyond
|
703
|
+
# the maximum you specify, the `NextToken` response element is present
|
704
|
+
# and has a value (is not null). Include that value as the `NextToken`
|
705
|
+
# request parameter in the next call to the operation to get the next
|
706
|
+
# part of the results. Note that the service might return fewer results
|
707
|
+
# than the maximum even when there are more results available. You
|
708
|
+
# should check `NextToken` after every operation to ensure that you
|
709
|
+
# receive all of the results.
|
526
710
|
#
|
527
711
|
# @option params [String] :next_token
|
528
|
-
# The
|
529
|
-
#
|
530
|
-
#
|
712
|
+
# The parameter for receiving additional results if you receive a
|
713
|
+
# `NextToken` response in a previous request. A `NextToken` response
|
714
|
+
# indicates that more output is available. Set this parameter to the
|
715
|
+
# value provided by a previous call's `NextToken` response to indicate
|
716
|
+
# where the output should continue from.
|
531
717
|
#
|
532
718
|
# @return [Types::ListGroupResourcesOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
533
719
|
#
|
@@ -540,7 +726,8 @@ module Aws::ResourceGroups
|
|
540
726
|
# @example Request syntax with placeholder values
|
541
727
|
#
|
542
728
|
# resp = client.list_group_resources({
|
543
|
-
# group_name: "GroupName",
|
729
|
+
# group_name: "GroupName",
|
730
|
+
# group: "GroupString",
|
544
731
|
# filters: [
|
545
732
|
# {
|
546
733
|
# name: "resource-type", # required, accepts resource-type
|
@@ -574,22 +761,39 @@ module Aws::ResourceGroups
|
|
574
761
|
#
|
575
762
|
# @option params [Array<Types::GroupFilter>] :filters
|
576
763
|
# Filters, formatted as GroupFilter objects, that you want to apply to a
|
577
|
-
# ListGroups operation.
|
764
|
+
# `ListGroups` operation.
|
578
765
|
#
|
579
|
-
# * `resource-type` - Filter
|
580
|
-
# resource types
|
581
|
-
#
|
766
|
+
# * `resource-type` - Filter the results to include only those of the
|
767
|
+
# specified resource types. Specify up to five resource types in the
|
768
|
+
# format `AWS::ServiceCode::ResourceType `. For example,
|
769
|
+
# `AWS::EC2::Instance`, or `AWS::S3::Bucket`.
|
582
770
|
#
|
583
|
-
#
|
771
|
+
# * `configuration-type` - Filter the results to include only those
|
772
|
+
# groups that have the specified configuration types attached. The
|
773
|
+
# current supported values are:
|
774
|
+
#
|
775
|
+
# * AWS:EC2::CapacityReservationPool
|
776
|
+
#
|
777
|
+
# ^
|
584
778
|
#
|
585
779
|
# @option params [Integer] :max_results
|
586
|
-
# The
|
587
|
-
#
|
780
|
+
# The total number of results that you want included on each page of the
|
781
|
+
# response. If you do not include this parameter, it defaults to a value
|
782
|
+
# that is specific to the operation. If additional items exist beyond
|
783
|
+
# the maximum you specify, the `NextToken` response element is present
|
784
|
+
# and has a value (is not null). Include that value as the `NextToken`
|
785
|
+
# request parameter in the next call to the operation to get the next
|
786
|
+
# part of the results. Note that the service might return fewer results
|
787
|
+
# than the maximum even when there are more results available. You
|
788
|
+
# should check `NextToken` after every operation to ensure that you
|
789
|
+
# receive all of the results.
|
588
790
|
#
|
589
791
|
# @option params [String] :next_token
|
590
|
-
# The
|
591
|
-
#
|
592
|
-
#
|
792
|
+
# The parameter for receiving additional results if you receive a
|
793
|
+
# `NextToken` response in a previous request. A `NextToken` response
|
794
|
+
# indicates that more output is available. Set this parameter to the
|
795
|
+
# value provided by a previous call's `NextToken` response to indicate
|
796
|
+
# where the output should continue from.
|
593
797
|
#
|
594
798
|
# @return [Types::ListGroupsOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
595
799
|
#
|
@@ -604,7 +808,7 @@ module Aws::ResourceGroups
|
|
604
808
|
# resp = client.list_groups({
|
605
809
|
# filters: [
|
606
810
|
# {
|
607
|
-
# name: "resource-type", # required, accepts resource-type
|
811
|
+
# name: "resource-type", # required, accepts resource-type, configuration-type
|
608
812
|
# values: ["GroupFilterValue"], # required
|
609
813
|
# },
|
610
814
|
# ],
|
@@ -632,22 +836,32 @@ module Aws::ResourceGroups
|
|
632
836
|
req.send_request(options)
|
633
837
|
end
|
634
838
|
|
635
|
-
# Returns a list of AWS resource identifiers that matches
|
839
|
+
# Returns a list of AWS resource identifiers that matches the specified
|
636
840
|
# query. The query uses the same format as a resource query in a
|
637
841
|
# CreateGroup or UpdateGroupQuery operation.
|
638
842
|
#
|
639
843
|
# @option params [required, Types::ResourceQuery] :resource_query
|
640
844
|
# The search query, using the same formats that are supported for
|
641
|
-
# resource group definition.
|
845
|
+
# resource group definition. For more information, see CreateGroup.
|
642
846
|
#
|
643
847
|
# @option params [Integer] :max_results
|
644
|
-
# The
|
645
|
-
#
|
848
|
+
# The total number of results that you want included on each page of the
|
849
|
+
# response. If you do not include this parameter, it defaults to a value
|
850
|
+
# that is specific to the operation. If additional items exist beyond
|
851
|
+
# the maximum you specify, the `NextToken` response element is present
|
852
|
+
# and has a value (is not null). Include that value as the `NextToken`
|
853
|
+
# request parameter in the next call to the operation to get the next
|
854
|
+
# part of the results. Note that the service might return fewer results
|
855
|
+
# than the maximum even when there are more results available. You
|
856
|
+
# should check `NextToken` after every operation to ensure that you
|
857
|
+
# receive all of the results.
|
646
858
|
#
|
647
859
|
# @option params [String] :next_token
|
648
|
-
# The
|
649
|
-
#
|
650
|
-
#
|
860
|
+
# The parameter for receiving additional results if you receive a
|
861
|
+
# `NextToken` response in a previous request. A `NextToken` response
|
862
|
+
# indicates that more output is available. Set this parameter to the
|
863
|
+
# value provided by a previous call's `NextToken` response to indicate
|
864
|
+
# where the output should continue from.
|
651
865
|
#
|
652
866
|
# @return [Types::SearchResourcesOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
653
867
|
#
|
@@ -691,14 +905,17 @@ module Aws::ResourceGroups
|
|
691
905
|
# a resource group are not changed if they are not specified in the
|
692
906
|
# request parameters.
|
693
907
|
#
|
908
|
+
# Do not store personally identifiable information (PII) or other
|
909
|
+
# confidential or sensitive information in tags. We use tags to provide
|
910
|
+
# you with billing and administration services. Tags are not intended to
|
911
|
+
# be used for private or sensitive data.
|
912
|
+
#
|
694
913
|
# @option params [required, String] :arn
|
695
|
-
# The ARN of the resource to which to add tags.
|
914
|
+
# The ARN of the resource group to which to add tags.
|
696
915
|
#
|
697
916
|
# @option params [required, Hash<String,String>] :tags
|
698
|
-
# The tags to add to the specified resource. A tag is a
|
699
|
-
# map of key-value pairs.
|
700
|
-
# of 128 characters, and tag values can have a maximum length of 256
|
701
|
-
# characters.
|
917
|
+
# The tags to add to the specified resource group. A tag is a
|
918
|
+
# string-to-string map of key-value pairs.
|
702
919
|
#
|
703
920
|
# @return [Types::TagOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
704
921
|
#
|
@@ -729,10 +946,51 @@ module Aws::ResourceGroups
|
|
729
946
|
req.send_request(options)
|
730
947
|
end
|
731
948
|
|
732
|
-
#
|
949
|
+
# Removes the specified resources from the specified group.
|
950
|
+
#
|
951
|
+
# @option params [required, String] :group
|
952
|
+
# The name or the ARN of the resource group from which to remove the
|
953
|
+
# resources.
|
954
|
+
#
|
955
|
+
# @option params [required, Array<String>] :resource_arns
|
956
|
+
# The ARNs of the resources to be removed from the group.
|
957
|
+
#
|
958
|
+
# @return [Types::UngroupResourcesOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
959
|
+
#
|
960
|
+
# * {Types::UngroupResourcesOutput#succeeded #succeeded} => Array<String>
|
961
|
+
# * {Types::UngroupResourcesOutput#failed #failed} => Array<Types::FailedResource>
|
962
|
+
#
|
963
|
+
# @example Request syntax with placeholder values
|
964
|
+
#
|
965
|
+
# resp = client.ungroup_resources({
|
966
|
+
# group: "GroupString", # required
|
967
|
+
# resource_arns: ["ResourceArn"], # required
|
968
|
+
# })
|
969
|
+
#
|
970
|
+
# @example Response structure
|
971
|
+
#
|
972
|
+
# resp.succeeded #=> Array
|
973
|
+
# resp.succeeded[0] #=> String
|
974
|
+
# resp.failed #=> Array
|
975
|
+
# resp.failed[0].resource_arn #=> String
|
976
|
+
# resp.failed[0].error_message #=> String
|
977
|
+
# resp.failed[0].error_code #=> String
|
978
|
+
#
|
979
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/resource-groups-2017-11-27/UngroupResources AWS API Documentation
|
980
|
+
#
|
981
|
+
# @overload ungroup_resources(params = {})
|
982
|
+
# @param [Hash] params ({})
|
983
|
+
def ungroup_resources(params = {}, options = {})
|
984
|
+
req = build_request(:ungroup_resources, params)
|
985
|
+
req.send_request(options)
|
986
|
+
end
|
987
|
+
|
988
|
+
# Deletes tags from a specified resource group.
|
733
989
|
#
|
734
990
|
# @option params [required, String] :arn
|
735
|
-
# The ARN of the resource from which to remove tags.
|
991
|
+
# The ARN of the resource group from which to remove tags. The command
|
992
|
+
# removed both the specified keys and any values associated with those
|
993
|
+
# keys.
|
736
994
|
#
|
737
995
|
# @option params [required, Array<String>] :keys
|
738
996
|
# The keys of the tags to be removed.
|
@@ -764,17 +1022,19 @@ module Aws::ResourceGroups
|
|
764
1022
|
req.send_request(options)
|
765
1023
|
end
|
766
1024
|
|
767
|
-
# Updates an existing group
|
768
|
-
#
|
1025
|
+
# Updates the description for an existing group. You cannot update the
|
1026
|
+
# name of a resource group.
|
1027
|
+
#
|
1028
|
+
# @option params [String] :group_name
|
1029
|
+
# Don't use this parameter. Use `Group` instead.
|
769
1030
|
#
|
770
|
-
# @option params [
|
771
|
-
# The name of the resource group
|
772
|
-
# description.
|
1031
|
+
# @option params [String] :group
|
1032
|
+
# The name or the ARN of the resource group to modify.
|
773
1033
|
#
|
774
1034
|
# @option params [String] :description
|
775
|
-
# The description
|
776
|
-
#
|
777
|
-
#
|
1035
|
+
# The new description that you want to update the resource group with.
|
1036
|
+
# Descriptions can contain letters, numbers, hyphens, underscores,
|
1037
|
+
# periods, and spaces.
|
778
1038
|
#
|
779
1039
|
# @return [Types::UpdateGroupOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
780
1040
|
#
|
@@ -783,8 +1043,9 @@ module Aws::ResourceGroups
|
|
783
1043
|
# @example Request syntax with placeholder values
|
784
1044
|
#
|
785
1045
|
# resp = client.update_group({
|
786
|
-
# group_name: "GroupName",
|
787
|
-
#
|
1046
|
+
# group_name: "GroupName",
|
1047
|
+
# group: "GroupString",
|
1048
|
+
# description: "Description",
|
788
1049
|
# })
|
789
1050
|
#
|
790
1051
|
# @example Response structure
|
@@ -804,12 +1065,15 @@ module Aws::ResourceGroups
|
|
804
1065
|
|
805
1066
|
# Updates the resource query of a group.
|
806
1067
|
#
|
807
|
-
# @option params [
|
808
|
-
#
|
1068
|
+
# @option params [String] :group_name
|
1069
|
+
# Don't use this parameter. Use `Group` instead.
|
1070
|
+
#
|
1071
|
+
# @option params [String] :group
|
1072
|
+
# The name or the ARN of the resource group to query.
|
809
1073
|
#
|
810
1074
|
# @option params [required, Types::ResourceQuery] :resource_query
|
811
|
-
# The resource query
|
812
|
-
#
|
1075
|
+
# The resource query to determine which AWS resources are members of
|
1076
|
+
# this resource group.
|
813
1077
|
#
|
814
1078
|
# @return [Types::UpdateGroupQueryOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
815
1079
|
#
|
@@ -818,7 +1082,8 @@ module Aws::ResourceGroups
|
|
818
1082
|
# @example Request syntax with placeholder values
|
819
1083
|
#
|
820
1084
|
# resp = client.update_group_query({
|
821
|
-
# group_name: "GroupName",
|
1085
|
+
# group_name: "GroupName",
|
1086
|
+
# group: "GroupString",
|
822
1087
|
# resource_query: { # required
|
823
1088
|
# type: "TAG_FILTERS_1_0", # required, accepts TAG_FILTERS_1_0, CLOUDFORMATION_STACK_1_0
|
824
1089
|
# query: "Query", # required
|
@@ -853,7 +1118,7 @@ module Aws::ResourceGroups
|
|
853
1118
|
params: params,
|
854
1119
|
config: config)
|
855
1120
|
context[:gem_name] = 'aws-sdk-resourcegroups'
|
856
|
-
context[:gem_version] = '1.
|
1121
|
+
context[:gem_version] = '1.31.0'
|
857
1122
|
Seahorse::Client::Request.new(handlers, context)
|
858
1123
|
end
|
859
1124
|
|