aws-sdk-resourcegroupstaggingapi 1.21.0 → 1.26.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: f76551ae431f1ab74f8a180546351437e41ef63f
-  data.tar.gz: '0199fe5a0ee304a6ab904b0a571ff1f6adc5fd6c'
+SHA256:
+  metadata.gz: fecc9acb60feca47145ce9f9b2ef93e684fe9d0e83576ea9249d4e168a43b8ce
+  data.tar.gz: 13560a0fefd633f085ea7e2d7a645796b8ba7c6c5d1a82dffe93029bac95b76b
 SHA512:
-  metadata.gz: 3ec1a16d9c9b8dc60e2d2b09799f3c4949ce1a9cf450d2cf2c3aa3465020c81ad84832ff4d96cf4b1f571d5bfd0a6991188accc7b5b6296dbea005c6a5a6b849
-  data.tar.gz: a8633ef68e7b5f623125956d81c70b58e2c0eecbc1ae5ef1c377045af81f6b65c3d771eec675983c32972f0a0e9ae0655d3dab761cbd744471dd1fb79aba85c8
+  metadata.gz: f3a054df455a0aa00649ea00cb388b839b876184ba19763a67ec8685383c824cd1e0a2f70265253f5f000cac148070155b7047dc4b9a33cfb6e3a042dd0a545f
+  data.tar.gz: fcf85fb96f393547a01742505229fe3fbf947cab61307bb9121f5746ceb429936214f4eafe376c8bcbb12cfb4e4d9b2d94e264fd9706dac7716fae2ce63cfb30

data/lib/aws-sdk-resourcegroupstaggingapi.rb

@@ -24,17 +24,20 @@ require_relative 'aws-sdk-resourcegroupstaggingapi/customizations'
 # methods each accept a hash of request parameters and return a response
 # structure.
 #
+#     resource_groups_tagging_api = Aws::ResourceGroupsTaggingAPI::Client.new
+#     resp = resource_groups_tagging_api.describe_report_creation(params)
+#
 # See {Client} for more information.
 #
 # # Errors
 #
-# Errors returned from AWS Resource Groups Tagging API all
-# extend {Errors::ServiceError}.
+# Errors returned from AWS Resource Groups Tagging API are defined in the
+# {Errors} module and all extend {Errors::ServiceError}.
 #
 #     begin
 #       # do stuff
 #     rescue Aws::ResourceGroupsTaggingAPI::Errors::ServiceError
-#       # rescues all service API errors
+#       # rescues all AWS Resource Groups Tagging API API errors
 #     end
 #
 # See {Errors} for more information.
@@ -42,6 +45,6 @@ require_relative 'aws-sdk-resourcegroupstaggingapi/customizations'
 # @service
 module Aws::ResourceGroupsTaggingAPI
 
-  GEM_VERSION = '1.21.0'
+  GEM_VERSION = '1.26.0'
 
 end

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

@@ -30,6 +30,18 @@ require 'aws-sdk-core/plugins/protocols/json_rpc.rb'
 Aws::Plugins::GlobalConfiguration.add_identifier(:resourcegroupstaggingapi)
 
 module Aws::ResourceGroupsTaggingAPI
+  # An API client for ResourceGroupsTaggingAPI.  To construct a client, you need to configure a `:region` and `:credentials`.
+  #
+  #     client = Aws::ResourceGroupsTaggingAPI::Client.new(
+  #       region: region_name,
+  #       credentials: credentials,
+  #       # ...
+  #     )
+  #
+  # For details on configuring region and credentials see
+  # the [developer guide](/sdk-for-ruby/v3/developer-guide/setup-config.html).
+  #
+  # See {#initialize} for a full list of supported configuration options.
   class Client < Seahorse::Client::Base
 
     include Aws::ClientStubs
@@ -93,7 +105,7 @@ module Aws::ResourceGroupsTaggingAPI
     #   @option options [required, String] :region
     #     The AWS region to connect to.  The configured `:region` is
     #     used to determine the service `:endpoint`. When not passed,
-    #     a default `:region` is search for in the following locations:
+    #     a default `:region` is searched for in the following locations:
     #
     #     * `Aws.config[:region]`
     #     * `ENV['AWS_REGION']`
@@ -108,6 +120,12 @@ module Aws::ResourceGroupsTaggingAPI
     #     When set to `true`, a thread polling for endpoints will be running in
     #     the background every 60 secs (default). Defaults to `false`.
     #
+    #   @option options [Boolean] :adaptive_retry_wait_to_fill (true)
+    #     Used only in `adaptive` retry mode.  When true, the request will sleep
+    #     until there is sufficent client side capacity to retry the request.
+    #     When false, the request will raise a `RetryCapacityNotAvailableError` and will
+    #     not retry instead of sleeping.
+    #
     #   @option options [Boolean] :client_side_monitoring (false)
     #     When `true`, client-side metrics will be collected for all API requests from
     #     this client.
@@ -132,6 +150,10 @@ module Aws::ResourceGroupsTaggingAPI
     #     When `true`, an attempt is made to coerce request parameters into
     #     the required types.
     #
+    #   @option options [Boolean] :correct_clock_skew (true)
+    #     Used only in `standard` and adaptive retry modes. Specifies whether to apply
+    #     a clock skew correction and retry requests with skewed client clocks.
+    #
     #   @option options [Boolean] :disable_host_prefix_injection (false)
     #     Set to true to disable SDK automatically adding host prefix
     #     to default service endpoint when available.
@@ -139,7 +161,7 @@ module Aws::ResourceGroupsTaggingAPI
     #   @option options [String] :endpoint
     #     The client endpoint is normally constructed from the `:region`
     #     option. You should only configure an `:endpoint` when connecting
-    #     to test endpoints. This should be avalid HTTP(S) URI.
+    #     to test endpoints. This should be a valid HTTP(S) URI.
     #
     #   @option options [Integer] :endpoint_cache_max_entries (1000)
     #     Used for the maximum size limit of the LRU cache storing endpoints data
@@ -154,7 +176,7 @@ module Aws::ResourceGroupsTaggingAPI
     #     requests fetching endpoints information. Defaults to 60 sec.
     #
     #   @option options [Boolean] :endpoint_discovery (false)
-    #     When set to `true`, endpoint discovery will be enabled for operations when available. Defaults to `false`.
+    #     When set to `true`, endpoint discovery will be enabled for operations when available.
     #
     #   @option options [Aws::Log::Formatter] :log_formatter (Aws::Log::Formatter.default)
     #     The log formatter.
@@ -166,15 +188,29 @@ module Aws::ResourceGroupsTaggingAPI
     #     The Logger instance to send log messages to.  If this option
     #     is not set, logging will be disabled.
     #
+    #   @option options [Integer] :max_attempts (3)
+    #     An integer representing the maximum number attempts that will be made for
+    #     a single request, including the initial attempt.  For example,
+    #     setting this value to 5 will result in a request being retried up to
+    #     4 times. Used in `standard` and `adaptive` retry modes.
+    #
     #   @option options [String] :profile ("default")
     #     Used when loading credentials from the shared credentials file
     #     at HOME/.aws/credentials.  When not specified, 'default' is used.
     #
+    #   @option options [Proc] :retry_backoff
+    #     A proc or lambda used for backoff. Defaults to 2**retries * retry_base_delay.
+    #     This option is only used in the `legacy` retry mode.
+    #
     #   @option options [Float] :retry_base_delay (0.3)
-    #     The base delay in seconds used by the default backoff function.
+    #     The base delay in seconds used by the default backoff function. This option
+    #     is only used in the `legacy` retry mode.
     #
     #   @option options [Symbol] :retry_jitter (:none)
-    #     A delay randomiser function used by the default backoff function. Some predefined functions can be referenced by name - :none, :equal, :full, otherwise a Proc that takes and returns a number.
+    #     A delay randomiser function used by the default backoff function.
+    #     Some predefined functions can be referenced by name - :none, :equal, :full,
+    #     otherwise a Proc that takes and returns a number. This option is only used
+    #     in the `legacy` retry mode.
     #
     #     @see https://www.awsarchitectureblog.com/2015/03/backoff.html
     #
@@ -182,11 +218,30 @@ module Aws::ResourceGroupsTaggingAPI
     #     The maximum number of times to retry failed requests.  Only
     #     ~ 500 level server errors and certain ~ 400 level client errors
     #     are retried.  Generally, these are throttling errors, data
-    #     checksum errors, networking errors, timeout errors and auth
-    #     errors from expired credentials.
+    #     checksum errors, networking errors, timeout errors, auth errors,
+    #     endpoint discovery, and errors from expired credentials.
+    #     This option is only used in the `legacy` retry mode.
     #
     #   @option options [Integer] :retry_max_delay (0)
-    #     The maximum number of seconds to delay between retries (0 for no limit) used by the default backoff function.
+    #     The maximum number of seconds to delay between retries (0 for no limit)
+    #     used by the default backoff function. This option is only used in the
+    #     `legacy` retry mode.
+    #
+    #   @option options [String] :retry_mode ("legacy")
+    #     Specifies which retry algorithm to use. Values are:
+    #
+    #     * `legacy` - The pre-existing retry behavior.  This is default value if
+    #       no retry mode is provided.
+    #
+    #     * `standard` - A standardized set of retry rules across the AWS SDKs.
+    #       This includes support for retry quotas, which limit the number of
+    #       unsuccessful retries a client can make.
+    #
+    #     * `adaptive` - An experimental retry mode that includes all the
+    #       functionality of `standard` mode along with automatic client side
+    #       throttling.  This is a provisional mode that may change behavior
+    #       in the future.
+    #
     #
     #   @option options [String] :secret_access_key
     #
@@ -219,16 +274,15 @@ module Aws::ResourceGroupsTaggingAPI
     #     requests through.  Formatted like 'http://proxy.com:123'.
     #
     #   @option options [Float] :http_open_timeout (15) The number of
-    #     seconds to wait when opening a HTTP session before rasing a
+    #     seconds to wait when opening a HTTP session before raising a
     #     `Timeout::Error`.
     #
     #   @option options [Integer] :http_read_timeout (60) The default
     #     number of seconds to wait for response data.  This value can
-    #     safely be set
-    #     per-request on the session yeidled by {#session_for}.
+    #     safely be set per-request on the session.
     #
     #   @option options [Float] :http_idle_timeout (5) The number of
-    #     seconds a connection is allowed to sit idble before it is
+    #     seconds a connection is allowed to sit idle before it is
     #     considered stale.  Stale connections are closed and removed
     #     from the pool before making a request.
     #
@@ -237,7 +291,7 @@ module Aws::ResourceGroupsTaggingAPI
     #     request body.  This option has no effect unless the request has
     #     "Expect" header set to "100-continue".  Defaults to `nil` which
     #     disables this behaviour.  This value can safely be set per
-    #     request on the session yeidled by {#session_for}.
+    #     request on the session.
     #
     #   @option options [Boolean] :http_wire_trace (false) When `true`,
     #     HTTP debug output will be sent to the `:logger`.
@@ -366,6 +420,8 @@ module Aws::ResourceGroupsTaggingAPI
     #   * {Types::GetComplianceSummaryOutput#summary_list #summary_list} => Array&lt;Types::Summary&gt;
     #   * {Types::GetComplianceSummaryOutput#pagination_token #pagination_token} => String
     #
+    # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
+    #
     # @example Request syntax with placeholder values
     #
     #   resp = client.get_compliance_summary({
@@ -544,6 +600,8 @@ module Aws::ResourceGroupsTaggingAPI
     #   * {Types::GetResourcesOutput#pagination_token #pagination_token} => String
     #   * {Types::GetResourcesOutput#resource_tag_mapping_list #resource_tag_mapping_list} => Array&lt;Types::ResourceTagMapping&gt;
     #
+    # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
+    #
     # @example Request syntax with placeholder values
     #
     #   resp = client.get_resources({
@@ -597,6 +655,8 @@ module Aws::ResourceGroupsTaggingAPI
     #   * {Types::GetTagKeysOutput#pagination_token #pagination_token} => String
     #   * {Types::GetTagKeysOutput#tag_keys #tag_keys} => Array&lt;String&gt;
     #
+    # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
+    #
     # @example Request syntax with placeholder values
     #
     #   resp = client.get_tag_keys({
@@ -636,6 +696,8 @@ module Aws::ResourceGroupsTaggingAPI
     #   * {Types::GetTagValuesOutput#pagination_token #pagination_token} => String
     #   * {Types::GetTagValuesOutput#tag_values #tag_values} => Array&lt;String&gt;
     #
+    # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
+    #
     # @example Request syntax with placeholder values
     #
     #   resp = client.get_tag_values({
@@ -718,10 +780,8 @@ module Aws::ResourceGroupsTaggingAPI
     #
     # @option params [required, Array<String>] :resource_arn_list
     #   A list of ARNs. An ARN (Amazon Resource Name) uniquely identifies a
-    #   resource. You can specify a minimum of 1 and a maximum of 20 ARNs
-    #   (resources) to tag. An ARN can be set to a maximum of 1600 characters.
-    #   For more information, see [Amazon Resource Names (ARNs) and AWS
-    #   Service Namespaces][1] in the *AWS General Reference*.
+    #   resource. For more information, see [Amazon Resource Names (ARNs) and
+    #   AWS Service Namespaces][1] in the *AWS General Reference*.
     #
     #
     #
@@ -778,10 +838,8 @@ module Aws::ResourceGroupsTaggingAPI
     #
     # @option params [required, Array<String>] :resource_arn_list
     #   A list of ARNs. An ARN (Amazon Resource Name) uniquely identifies a
-    #   resource. You can specify a minimum of 1 and a maximum of 20 ARNs
-    #   (resources) to untag. An ARN can be set to a maximum of 1600
-    #   characters. For more information, see [Amazon Resource Names (ARNs)
-    #   and AWS Service Namespaces][1] in the *AWS General Reference*.
+    #   resource. For more information, see [Amazon Resource Names (ARNs) and
+    #   AWS Service Namespaces][1] in the *AWS General Reference*.
     #
     #
     #
@@ -831,7 +889,7 @@ module Aws::ResourceGroupsTaggingAPI
         params: params,
         config: config)
       context[:gem_name] = 'aws-sdk-resourcegroupstaggingapi'
-      context[:gem_version] = '1.21.0'
+      context[:gem_version] = '1.26.0'
       Seahorse::Client::Request.new(handlers, context)
     end
 

data/lib/aws-sdk-resourcegroupstaggingapi/errors.rb

@@ -6,6 +6,34 @@
 # WARNING ABOUT GENERATED CODE
 
 module Aws::ResourceGroupsTaggingAPI
+
+  # When ResourceGroupsTaggingAPI returns an error response, the Ruby SDK constructs and raises an error.
+  # These errors all extend Aws::ResourceGroupsTaggingAPI::Errors::ServiceError < {Aws::Errors::ServiceError}
+  #
+  # You can rescue all ResourceGroupsTaggingAPI errors using ServiceError:
+  #
+  #     begin
+  #       # do stuff
+  #     rescue Aws::ResourceGroupsTaggingAPI::Errors::ServiceError
+  #       # rescues all ResourceGroupsTaggingAPI API errors
+  #     end
+  #
+  #
+  # ## Request Context
+  # ServiceError objects have a {Aws::Errors::ServiceError#context #context} method that returns
+  # information about the request that generated the error.
+  # See {Seahorse::Client::RequestContext} for more information.
+  #
+  # ## Error Classes
+  # * {ConcurrentModificationException}
+  # * {ConstraintViolationException}
+  # * {InternalServiceException}
+  # * {InvalidParameterException}
+  # * {PaginationTokenExpiredException}
+  # * {ThrottledException}
+  #
+  # Additionally, error classes are dynamically generated for service errors based on the error code
+  # if they are not defined above.
   module Errors
 
     extend Aws::Errors::DynamicErrors
@@ -23,7 +51,6 @@ module Aws::ResourceGroupsTaggingAPI
       def message
         @message || @data[:message]
       end
-
     end
 
     class ConstraintViolationException < ServiceError
@@ -39,7 +66,6 @@ module Aws::ResourceGroupsTaggingAPI
       def message
         @message || @data[:message]
       end
-
     end
 
     class InternalServiceException < ServiceError
@@ -55,7 +81,6 @@ module Aws::ResourceGroupsTaggingAPI
       def message
         @message || @data[:message]
       end
-
     end
 
     class InvalidParameterException < ServiceError
@@ -71,7 +96,6 @@ module Aws::ResourceGroupsTaggingAPI
       def message
         @message || @data[:message]
       end
-
     end
 
     class PaginationTokenExpiredException < ServiceError
@@ -87,7 +111,6 @@ module Aws::ResourceGroupsTaggingAPI
       def message
         @message || @data[:message]
       end
-
     end
 
     class ThrottledException < ServiceError
@@ -103,7 +126,6 @@ module Aws::ResourceGroupsTaggingAPI
       def message
         @message || @data[:message]
       end
-
     end
 
   end

data/lib/aws-sdk-resourcegroupstaggingapi/resource.rb

@@ -6,6 +6,7 @@
 # WARNING ABOUT GENERATED CODE
 
 module Aws::ResourceGroupsTaggingAPI
+
   class Resource
 
     # @param options ({})

data/lib/aws-sdk-resourcegroupstaggingapi/types.rb

@@ -121,7 +121,37 @@ module Aws::ResourceGroupsTaggingAPI
       include Aws::Structure
     end
 
-    # Details of the common errors that all actions return.
+    # Information about the errors that are returned for each failed
+    # resource. This information can include `InternalServiceException` and
+    # `InvalidParameterException` errors. It can also include any valid
+    # error code returned by the AWS service that hosts the resource that
+    # the ARN key represents.
+    #
+    # The following are common error codes that you might receive from other
+    # AWS services:
+    #
+    # * **InternalServiceException** – This can mean that the Resource
+    #   Groups Tagging API didn't receive a response from another AWS
+    #   service. It can also mean the the resource type in the request is
+    #   not supported by the Resource Groups Tagging API. In these cases,
+    #   it's safe to retry the request and then call [GetResources][1] to
+    #   verify the changes.
+    #
+    # * **AccessDeniedException** – This can mean that you need permission
+    #   to calling tagging operations in the AWS service that contains the
+    #   resource. For example, to use the Resource Groups Tagging API to tag
+    #   a CloudWatch alarm resource, you need permission to call [
+    #   `TagResources` ][2] *and* [ `TagResource` ][3] in the CloudWatch
+    #   API.
+    #
+    # For more information on errors that are generated from other AWS
+    # services, see the documentation for that service.
+    #
+    #
+    #
+    # [1]: http://docs.aws.amazon.com/resourcegroupstagging/latest/APIReference/API_GetResources.html
+    # [2]: http://docs.aws.amazon.com/resourcegroupstagging/latest/APIReference/API_TagResources.html
+    # [3]: http://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_TagResource.html
     #
     # @!attribute [rw] status_code
     #   The HTTP status code of the common error.
@@ -675,9 +705,9 @@ module Aws::ResourceGroupsTaggingAPI
     end
 
     # The metadata that you apply to AWS resources to help you categorize
-    # and organize them. Each tag consists of a key and an optional value,
-    # both of which you define. For more information, see [Tagging AWS
-    # Resources][1] in the *AWS General Reference*.
+    # and organize them. Each tag consists of a key and a value, both of
+    # which you define. For more information, see [Tagging AWS Resources][1]
+    # in the *AWS General Reference*.
     #
     #
     #
@@ -689,8 +719,9 @@ module Aws::ResourceGroupsTaggingAPI
     #   @return [String]
     #
     # @!attribute [rw] value
-    #   The optional part of a key-value pair that make up a tag. A value
-    #   acts as a descriptor within a tag category (key).
+    #   One part of a key-value pair that make up a tag. A value acts as a
+    #   descriptor within a tag category (key). The value can be empty or
+    #   null.
     #   @return [String]
     #
     # @see http://docs.aws.amazon.com/goto/WebAPI/resourcegroupstaggingapi-2017-01-26/Tag AWS API Documentation
@@ -718,8 +749,9 @@ module Aws::ResourceGroupsTaggingAPI
     #   @return [String]
     #
     # @!attribute [rw] values
-    #   The optional part of a key-value pair that make up a tag. A value
-    #   acts as a descriptor within a tag category (key).
+    #   One part of a key-value pair that make up a tag. A value acts as a
+    #   descriptor within a tag category (key). The value can be empty or
+    #   null.
     #   @return [Array<String>]
     #
     # @see http://docs.aws.amazon.com/goto/WebAPI/resourcegroupstaggingapi-2017-01-26/TagFilter AWS API Documentation
@@ -742,9 +774,7 @@ module Aws::ResourceGroupsTaggingAPI
     #
     # @!attribute [rw] resource_arn_list
     #   A list of ARNs. An ARN (Amazon Resource Name) uniquely identifies a
-    #   resource. You can specify a minimum of 1 and a maximum of 20 ARNs
-    #   (resources) to tag. An ARN can be set to a maximum of 1600
-    #   characters. For more information, see [Amazon Resource Names (ARNs)
+    #   resource. For more information, see [Amazon Resource Names (ARNs)
     #   and AWS Service Namespaces][1] in the *AWS General Reference*.
     #
     #
@@ -766,8 +796,11 @@ module Aws::ResourceGroupsTaggingAPI
     end
 
     # @!attribute [rw] failed_resources_map
-    #   Details of resources that could not be tagged. An error code, status
-    #   code, and error message are returned for each failed item.
+    #   A map containing a key-value pair for each failed item that
+    #   couldn't be tagged. The key is the ARN of the failed resource. The
+    #   value is a `FailureInfo` object that contains an error code, a
+    #   status code, and an error message. If there are no errors, the
+    #   `FailedResourcesMap` is empty.
     #   @return [Hash<String,Types::FailureInfo>]
     #
     # @see http://docs.aws.amazon.com/goto/WebAPI/resourcegroupstaggingapi-2017-01-26/TagResourcesOutput AWS API Documentation
@@ -799,9 +832,7 @@ module Aws::ResourceGroupsTaggingAPI
     #
     # @!attribute [rw] resource_arn_list
     #   A list of ARNs. An ARN (Amazon Resource Name) uniquely identifies a
-    #   resource. You can specify a minimum of 1 and a maximum of 20 ARNs
-    #   (resources) to untag. An ARN can be set to a maximum of 1600
-    #   characters. For more information, see [Amazon Resource Names (ARNs)
+    #   resource. For more information, see [Amazon Resource Names (ARNs)
     #   and AWS Service Namespaces][1] in the *AWS General Reference*.
     #
     #

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: aws-sdk-resourcegroupstaggingapi
 version: !ruby/object:Gem::Version
-  version: 1.21.0
+  version: 1.26.0
 platform: ruby
 authors:
 - Amazon Web Services
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-12-18 00:00:00.000000000 Z
+date: 2020-05-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aws-sdk-core
@@ -81,7 +81,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.2.3
+rubygems_version: 2.7.6.2
 signing_key: 
 specification_version: 4
 summary: AWS SDK for Ruby - AWS Resource Groups Tagging API