aws-sdk-resourcegroups 1.28.0 → 1.33.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 23f39cc4f5026e0dc2c82b6f0d1f27af639f37d533e3745619f1396346d17767
-  data.tar.gz: 7b8a568cf9111a52645a438f807378624f377b9c82391fa8cfc5fea090eda738
+  metadata.gz: 0cd9b853dae692f26ea582fd09d1b7ee05c9e6c415daf225561e9f51de1ba373
+  data.tar.gz: 2774d44203d0f390edbd27d81df9880d8df7068c15ceff03c16a5d732c7ea206
 SHA512:
-  metadata.gz: 7273a02b0539ad28f76adff569b92d01c63c79be20890a2dd00db6a6ee1c786ed96ee0036daa68f8d7e4cb40056ca4d2f3aba295f2c452a56bfcd916720ddeb9
-  data.tar.gz: 91d08d85858c9f2f745e976daa04215c7196d89ad99122db7c1eb2f6f1aca92878a25ace291f573ae62dc0cfef776b31f717d7722de923fcc8d4dbe0de29ed19
+  metadata.gz: cc8d1ab14a885c2bd8aad249c766cb80d9edce7a939d87a6b40cc70924d82cab7fae5e98f779064dd8ef1871c0da4cdfc1dac4c3a79dc15f360b11156c434fcc
+  data.tar.gz: ec90a308aa4956e52173a5dd876dac639f892d6240da062ecec2c2b74fc4739da759f9553821adacffa9c6ff57480d129f6db0ab3e8b02c776631d342d6c2ae8

data/lib/aws-sdk-resourcegroups.rb

@@ -7,6 +7,7 @@
 #
 # WARNING ABOUT GENERATED CODE
 
+
 require 'aws-sdk-core'
 require 'aws-sigv4'
 
@@ -44,9 +45,9 @@ require_relative 'aws-sdk-resourcegroups/customizations'
 #
 # See {Errors} for more information.
 #
-# @service
+# @!group service
 module Aws::ResourceGroups
 
-  GEM_VERSION = '1.28.0'
+  GEM_VERSION = '1.33.0'
 
 end

data/lib/aws-sdk-resourcegroups/client.rb

@@ -85,13 +85,28 @@ module Aws::ResourceGroups
     #     * `Aws::Credentials` - Used for configuring static, non-refreshing
     #       credentials.
     #
+    #     * `Aws::SharedCredentials` - Used for loading static credentials from a
+    #       shared file, such as `~/.aws/config`.
+    #
+    #     * `Aws::AssumeRoleCredentials` - Used when you need to assume a role.
+    #
+    #     * `Aws::AssumeRoleWebIdentityCredentials` - Used when you need to
+    #       assume a role after providing credentials via the web.
+    #
+    #     * `Aws::SSOCredentials` - Used for loading credentials from AWS SSO using an
+    #       access token generated from `aws login`.
+    #
+    #     * `Aws::ProcessCredentials` - Used for loading credentials from a
+    #       process that outputs to stdout.
+    #
     #     * `Aws::InstanceProfileCredentials` - Used for loading credentials
     #       from an EC2 IMDS on an EC2 instance.
     #
-    #     * `Aws::SharedCredentials` - Used for loading credentials from a
-    #       shared file, such as `~/.aws/config`.
+    #     * `Aws::ECSCredentials` - Used for loading credentials from
+    #       instances running in ECS.
     #
-    #     * `Aws::AssumeRoleCredentials` - Used when you need to assume a role.
+    #     * `Aws::CognitoIdentityCredentials` - Used for loading credentials
+    #       from the Cognito Identity service.
     #
     #     When `:credentials` are not configured directly, the following
     #     locations will be searched for credentials:
@@ -101,10 +116,10 @@ module Aws::ResourceGroups
     #     * ENV['AWS_ACCESS_KEY_ID'], ENV['AWS_SECRET_ACCESS_KEY']
     #     * `~/.aws/credentials`
     #     * `~/.aws/config`
-    #     * EC2 IMDS instance profile - When used by default, the timeouts are
-    #       very aggressive. Construct and pass an instance of
-    #       `Aws::InstanceProfileCredentails` to enable retries and extended
-    #       timeouts.
+    #     * EC2/ECS IMDS instance profile - When used by default, the timeouts
+    #       are very aggressive. Construct and pass an instance of
+    #       `Aws::InstanceProfileCredentails` or `Aws::ECSCredentials` to
+    #       enable retries and extended timeouts.
     #
     #   @option options [required, String] :region
     #     The AWS region to connect to.  The configured `:region` is
@@ -314,6 +329,23 @@ module Aws::ResourceGroups
 
     # Creates a resource group with the specified name and description. You
     # can optionally include a resource query, or a service configuration.
+    # For more information about constructing a resource query, see [Create
+    # a tag-based group in Resource Groups][1]. For more information about
+    # service configurations, see [Service configurations for resource
+    # groups][2].
+    #
+    # **Minimum permissions**
+    #
+    # To run this command, you must have the following permissions:
+    #
+    # * `resource-groups:CreateGroup`
+    #
+    # ^
+    #
+    #
+    #
+    # [1]: https://docs.aws.amazon.com/ARG/latest/userguide/gettingstarted-query.html#gettingstarted-query-cli-tag
+    # [2]: https://docs.aws.amazon.com/ARG/latest/APIReference/about-slg.html
     #
     # @option params [required, String] :name
     #   The name of the group, which is the identifier of the group in other
@@ -329,13 +361,18 @@ module Aws::ResourceGroups
     #
     # @option params [Types::ResourceQuery] :resource_query
     #   The resource query that determines which AWS resources are members of
-    #   this group.
+    #   this group. For more information about resource queries, see [Create a
+    #   tag-based group in Resource Groups][1].
     #
-    #   <note markdown="1"> You can specify either a `ResourceQuery` or a `Configuration`, but not
-    #   both.
+    #   <note markdown="1"> A resource group can contain either a `ResourceQuery` or a
+    #   `Configuration`, but not both.
     #
     #    </note>
     #
+    #
+    #
+    #   [1]: https://docs.aws.amazon.com/ARG/latest/userguide/gettingstarted-query.html#gettingstarted-query-cli-tag
+    #
     # @option params [Hash<String,String>] :tags
     #   The tags to add to the group. A tag is key-value pair string.
     #
@@ -343,12 +380,18 @@ module Aws::ResourceGroups
     #   A configuration associates the resource group with an AWS service and
     #   specifies how the service can interact with the resources in the
     #   group. A configuration is an array of GroupConfigurationItem elements.
+    #   For details about the syntax of service configurations, see [Service
+    #   configurations for resource groups][1].
     #
-    #   <note markdown="1"> You can specify either a `Configuration` or a `ResourceQuery` in a
-    #   group, but not both.
+    #   <note markdown="1"> A resource group can contain either a `Configuration` or a
+    #   `ResourceQuery`, but not both.
     #
     #    </note>
     #
+    #
+    #
+    #   [1]: https://docs.aws.amazon.com/ARG/latest/APIReference/about-slg.html
+    #
     # @return [Types::CreateGroupOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
     #
     #   * {Types::CreateGroupOutput#group #group} => Types::Group
@@ -418,8 +461,16 @@ module Aws::ResourceGroups
     # not delete any resources that are members of the group; it only
     # deletes the group structure.
     #
+    # **Minimum permissions**
+    #
+    # To run this command, you must have the following permissions:
+    #
+    # * `resource-groups:DeleteGroup`
+    #
+    # ^
+    #
     # @option params [String] :group_name
-    #   Don't use this parameter. Use `Group` instead.
+    #   Deprecated - don't use this parameter. Use `Group` instead.
     #
     # @option params [String] :group
     #   The name or the ARN of the resource group to delete.
@@ -452,8 +503,16 @@ module Aws::ResourceGroups
 
     # Returns information about a specified resource group.
     #
+    # **Minimum permissions**
+    #
+    # To run this command, you must have the following permissions:
+    #
+    # * `resource-groups:GetGroup`
+    #
+    # ^
+    #
     # @option params [String] :group_name
-    #   Don't use this parameter. Use `Group` instead.
+    #   Deprecated - don't use this parameter. Use `Group` instead.
     #
     # @option params [String] :group
     #   The name or the ARN of the resource group to retrieve.
@@ -485,18 +544,20 @@ module Aws::ResourceGroups
     end
 
     # Returns the service configuration associated with the specified
-    # resource group. AWS Resource Groups supports configurations for the
-    # following resource group types:
+    # resource group. For details about the service configuration syntax,
+    # see [Service configurations for resource groups][1].
+    #
+    # **Minimum permissions**
     #
-    # * `AWS::EC2::CapacityReservationPool` - Amazon EC2 capacity
-    #   reservation pools. For more information, see [Working with capacity
-    #   reservation groups][1] in the *EC2 Users Guide*.
+    # To run this command, you must have the following permissions:
+    #
+    # * `resource-groups:GetGroupConfiguration`
     #
     # ^
     #
     #
     #
-    # [1]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/capacity-reservations-using.html#create-cr-group
+    # [1]: https://docs.aws.amazon.com/ARG/latest/APIReference/about-slg.html
     #
     # @option params [String] :group
     #   The name or the ARN of the resource group.
@@ -538,7 +599,20 @@ module Aws::ResourceGroups
     end
 
     # Retrieves the resource query associated with the specified resource
-    # group.
+    # group. For more information about resource queries, see [Create a
+    # tag-based group in Resource Groups][1].
+    #
+    # **Minimum permissions**
+    #
+    # To run this command, you must have the following permissions:
+    #
+    # * `resource-groups:GetGroupQuery`
+    #
+    # ^
+    #
+    #
+    #
+    # [1]: https://docs.aws.amazon.com/ARG/latest/userguide/gettingstarted-query.html#gettingstarted-query-cli-tag
     #
     # @option params [String] :group_name
     #   Don't use this parameter. Use `Group` instead.
@@ -575,6 +649,14 @@ module Aws::ResourceGroups
     # Returns a list of tags that are associated with a resource group,
     # specified by an ARN.
     #
+    # **Minimum permissions**
+    #
+    # To run this command, you must have the following permissions:
+    #
+    # * `resource-groups:GetTags`
+    #
+    # ^
+    #
     # @option params [required, String] :arn
     #   The ARN of the resource group whose tags you want to retrieve.
     #
@@ -606,6 +688,14 @@ module Aws::ResourceGroups
 
     # Adds the specified resources to the specified group.
     #
+    # **Minimum permissions**
+    #
+    # To run this command, you must have the following permissions:
+    #
+    # * `resource-groups:GroupResources`
+    #
+    # ^
+    #
     # @option params [required, String] :group
     #   The name or the ARN of the resource group to add resources to.
     #
@@ -616,6 +706,7 @@ module Aws::ResourceGroups
     #
     #   * {Types::GroupResourcesOutput#succeeded #succeeded} => Array&lt;String&gt;
     #   * {Types::GroupResourcesOutput#failed #failed} => Array&lt;Types::FailedResource&gt;
+    #   * {Types::GroupResourcesOutput#pending #pending} => Array&lt;Types::PendingResource&gt;
     #
     # @example Request syntax with placeholder values
     #
@@ -632,6 +723,8 @@ module Aws::ResourceGroups
     #   resp.failed[0].resource_arn #=> String
     #   resp.failed[0].error_message #=> String
     #   resp.failed[0].error_code #=> String
+    #   resp.pending #=> Array
+    #   resp.pending[0].resource_arn #=> String
     #
     # @see http://docs.aws.amazon.com/goto/WebAPI/resource-groups-2017-11-27/GroupResources AWS API Documentation
     #
@@ -645,8 +738,17 @@ module Aws::ResourceGroups
     # Returns a list of ARNs of the resources that are members of a
     # specified resource group.
     #
+    # **Minimum permissions**
+    #
+    # To run this command, you must have the following permissions:
+    #
+    # * `resource-groups:ListGroupResources`
+    #
+    # ^
+    #
     # @option params [String] :group_name
-    #   Don't use this parameter. Use `Group` instead.
+    #   <i> <b>Deprecated - don't use this parameter. Use the
+    #   <code>Group</code> request field instead.</b> </i>
     #
     # @option params [String] :group
     #   The name or the ARN of the resource group
@@ -702,6 +804,7 @@ module Aws::ResourceGroups
     #
     # @return [Types::ListGroupResourcesOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
     #
+    #   * {Types::ListGroupResourcesOutput#resources #resources} => Array&lt;Types::ListGroupResourcesItem&gt;
     #   * {Types::ListGroupResourcesOutput#resource_identifiers #resource_identifiers} => Array&lt;Types::ResourceIdentifier&gt;
     #   * {Types::ListGroupResourcesOutput#next_token #next_token} => String
     #   * {Types::ListGroupResourcesOutput#query_errors #query_errors} => Array&lt;Types::QueryError&gt;
@@ -725,6 +828,10 @@ module Aws::ResourceGroups
     #
     # @example Response structure
     #
+    #   resp.resources #=> Array
+    #   resp.resources[0].identifier.resource_arn #=> String
+    #   resp.resources[0].identifier.resource_type #=> String
+    #   resp.resources[0].status.name #=> String, one of "PENDING"
     #   resp.resource_identifiers #=> Array
     #   resp.resource_identifiers[0].resource_arn #=> String
     #   resp.resource_identifiers[0].resource_type #=> String
@@ -744,6 +851,14 @@ module Aws::ResourceGroups
 
     # Returns a list of existing resource groups in your account.
     #
+    # **Minimum permissions**
+    #
+    # To run this command, you must have the following permissions:
+    #
+    # * `resource-groups:ListGroups`
+    #
+    # ^
+    #
     # @option params [Array<Types::GroupFilter>] :filters
     #   Filters, formatted as GroupFilter objects, that you want to apply to a
     #   `ListGroups` operation.
@@ -757,9 +872,9 @@ module Aws::ResourceGroups
     #     groups that have the specified configuration types attached. The
     #     current supported values are:
     #
-    #     * AWS:EC2::CapacityReservationPool
+    #     * `AWS:EC2::CapacityReservationPool`
     #
-    #     ^
+    #     * `AWS:EC2::HostManagement`
     #
     # @option params [Integer] :max_results
     #   The total number of results that you want included on each page of the
@@ -821,10 +936,80 @@ module Aws::ResourceGroups
       req.send_request(options)
     end
 
-    # Returns a list of AWS resource identifiers that matches tne specified
+    # Attaches a service configuration to the specified group. This occurs
+    # asynchronously, and can take time to complete. You can use
+    # GetGroupConfiguration to check the status of the update.
+    #
+    # **Minimum permissions**
+    #
+    # To run this command, you must have the following permissions:
+    #
+    # * `resource-groups:PutGroupConfiguration`
+    #
+    # ^
+    #
+    # @option params [String] :group
+    #   The name or ARN of the resource group with the configuration that you
+    #   want to update.
+    #
+    # @option params [Array<Types::GroupConfigurationItem>] :configuration
+    #   The new configuration to associate with the specified group. A
+    #   configuration associates the resource group with an AWS service and
+    #   specifies how the service can interact with the resources in the
+    #   group. A configuration is an array of GroupConfigurationItem elements.
+    #
+    #   For information about the syntax of a service configuration, see
+    #   [Service configurations for resource groups][1].
+    #
+    #   <note markdown="1"> A resource group can contain either a `Configuration` or a
+    #   `ResourceQuery`, but not both.
+    #
+    #    </note>
+    #
+    #
+    #
+    #   [1]: https://docs.aws.amazon.com/ARG/latest/APIReference/about-slg.html
+    #
+    # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
+    #
+    # @example Request syntax with placeholder values
+    #
+    #   resp = client.put_group_configuration({
+    #     group: "GroupString",
+    #     configuration: [
+    #       {
+    #         type: "GroupConfigurationType", # required
+    #         parameters: [
+    #           {
+    #             name: "GroupConfigurationParameterName", # required
+    #             values: ["GroupConfigurationParameterValue"],
+    #           },
+    #         ],
+    #       },
+    #     ],
+    #   })
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/resource-groups-2017-11-27/PutGroupConfiguration AWS API Documentation
+    #
+    # @overload put_group_configuration(params = {})
+    # @param [Hash] params ({})
+    def put_group_configuration(params = {}, options = {})
+      req = build_request(:put_group_configuration, params)
+      req.send_request(options)
+    end
+
+    # Returns a list of AWS resource identifiers that matches the specified
     # query. The query uses the same format as a resource query in a
     # CreateGroup or UpdateGroupQuery operation.
     #
+    # **Minimum permissions**
+    #
+    # To run this command, you must have the following permissions:
+    #
+    # * `resource-groups:SearchResources`
+    #
+    # ^
+    #
     # @option params [required, Types::ResourceQuery] :resource_query
     #   The search query, using the same formats that are supported for
     #   resource group definition. For more information, see CreateGroup.
@@ -895,6 +1080,14 @@ module Aws::ResourceGroups
     # you with billing and administration services. Tags are not intended to
     # be used for private or sensitive data.
     #
+    # **Minimum permissions**
+    #
+    # To run this command, you must have the following permissions:
+    #
+    # * `resource-groups:Tag`
+    #
+    # ^
+    #
     # @option params [required, String] :arn
     #   The ARN of the resource group to which to add tags.
     #
@@ -933,6 +1126,14 @@ module Aws::ResourceGroups
 
     # Removes the specified resources from the specified group.
     #
+    # **Minimum permissions**
+    #
+    # To run this command, you must have the following permissions:
+    #
+    # * `resource-groups:UngroupResources`
+    #
+    # ^
+    #
     # @option params [required, String] :group
     #   The name or the ARN of the resource group from which to remove the
     #   resources.
@@ -944,6 +1145,7 @@ module Aws::ResourceGroups
     #
     #   * {Types::UngroupResourcesOutput#succeeded #succeeded} => Array&lt;String&gt;
     #   * {Types::UngroupResourcesOutput#failed #failed} => Array&lt;Types::FailedResource&gt;
+    #   * {Types::UngroupResourcesOutput#pending #pending} => Array&lt;Types::PendingResource&gt;
     #
     # @example Request syntax with placeholder values
     #
@@ -960,6 +1162,8 @@ module Aws::ResourceGroups
     #   resp.failed[0].resource_arn #=> String
     #   resp.failed[0].error_message #=> String
     #   resp.failed[0].error_code #=> String
+    #   resp.pending #=> Array
+    #   resp.pending[0].resource_arn #=> String
     #
     # @see http://docs.aws.amazon.com/goto/WebAPI/resource-groups-2017-11-27/UngroupResources AWS API Documentation
     #
@@ -972,6 +1176,14 @@ module Aws::ResourceGroups
 
     # Deletes tags from a specified resource group.
     #
+    # **Minimum permissions**
+    #
+    # To run this command, you must have the following permissions:
+    #
+    # * `resource-groups:Untag`
+    #
+    # ^
+    #
     # @option params [required, String] :arn
     #   The ARN of the resource group from which to remove tags. The command
     #   removed both the specified keys and any values associated with those
@@ -1010,6 +1222,14 @@ module Aws::ResourceGroups
     # Updates the description for an existing group. You cannot update the
     # name of a resource group.
     #
+    # **Minimum permissions**
+    #
+    # To run this command, you must have the following permissions:
+    #
+    # * `resource-groups:UpdateGroup`
+    #
+    # ^
+    #
     # @option params [String] :group_name
     #   Don't use this parameter. Use `Group` instead.
     #
@@ -1048,7 +1268,21 @@ module Aws::ResourceGroups
       req.send_request(options)
     end
 
-    # Updates the resource query of a group.
+    # Updates the resource query of a group. For more information about
+    # resource queries, see [Create a tag-based group in Resource
+    # Groups][1].
+    #
+    # **Minimum permissions**
+    #
+    # To run this command, you must have the following permissions:
+    #
+    # * `resource-groups:UpdateGroupQuery`
+    #
+    # ^
+    #
+    #
+    #
+    # [1]: https://docs.aws.amazon.com/ARG/latest/userguide/gettingstarted-query.html#gettingstarted-query-cli-tag
     #
     # @option params [String] :group_name
     #   Don't use this parameter. Use `Group` instead.
@@ -1060,6 +1294,11 @@ module Aws::ResourceGroups
     #   The resource query to determine which AWS resources are members of
     #   this resource group.
     #
+    #   <note markdown="1"> A resource group can contain either a `Configuration` or a
+    #   `ResourceQuery`, but not both.
+    #
+    #    </note>
+    #
     # @return [Types::UpdateGroupQueryOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
     #
     #   * {Types::UpdateGroupQueryOutput#group_query #group_query} => Types::GroupQuery
@@ -1103,7 +1342,7 @@ module Aws::ResourceGroups
         params: params,
         config: config)
       context[:gem_name] = 'aws-sdk-resourcegroups'
-      context[:gem_version] = '1.28.0'
+      context[:gem_version] = '1.33.0'
       Seahorse::Client::Request.new(handlers, context)
     end