aws-sdk-comprehend 1.29.0 → 1.34.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 4afe5433ec3a1d2473588dd9f167df7718049623
-  data.tar.gz: ee542fc30381c67dfc6ab6b8522afd99d9163fb7
+SHA256:
+  metadata.gz: 11748948d475c0bf4d3a5411da47e7a422c3ef4cfc54d1fa1818bf8e1f6fa286
+  data.tar.gz: f050489b0d80a847633811f2c1de56861364c545caabb2bdd58b8d011360deea
 SHA512:
-  metadata.gz: 1aab4ead901fdba21f144907e7fd7b645ad6c5b927ae2a8bc3c5a82c39146529a22c91485d5d35534ec7fa059c5c7775c8ca579a7dd1aa29943aa1f5d801bfaf
-  data.tar.gz: 99ad0f388ce5a540962d14387ffac775d011b493c81bcf4cd6e45ed6702b30383492120bb3d2462196aa2ab10fd8acb42e52013a8d0383a6968c515281c0571f
+  metadata.gz: 0af4bdffd5ce15ed08cef833efcb3e92db0533c36b3350676a82223b20fe284cbf3a6eb42fb8450384b45692b0d3d1784ad86779d2e986e4bf6edc7b19b04d89
+  data.tar.gz: a4ea81392c59ae740f7ed0ff858ebb4d18d4f466799755dd5e3af6c16a413089bbe124c53aabe7ff8d889ba033c5044101c0db157092d8669d4383f2f8d6cfcf

data/lib/aws-sdk-comprehend.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # WARNING ABOUT GENERATED CODE
 #
 # This file is generated. See the contributing guide for more information:
@@ -24,17 +26,20 @@ require_relative 'aws-sdk-comprehend/customizations'
 # methods each accept a hash of request parameters and return a response
 # structure.
 #
+#     comprehend = Aws::Comprehend::Client.new
+#     resp = comprehend.batch_detect_dominant_language(params)
+#
 # See {Client} for more information.
 #
 # # Errors
 #
-# Errors returned from Amazon Comprehend all
-# extend {Errors::ServiceError}.
+# Errors returned from Amazon Comprehend are defined in the
+# {Errors} module and all extend {Errors::ServiceError}.
 #
 #     begin
 #       # do stuff
 #     rescue Aws::Comprehend::Errors::ServiceError
-#       # rescues all service API errors
+#       # rescues all Amazon Comprehend API errors
 #     end
 #
 # See {Errors} for more information.
@@ -42,6 +47,6 @@ require_relative 'aws-sdk-comprehend/customizations'
 # @service
 module Aws::Comprehend
 
-  GEM_VERSION = '1.29.0'
+  GEM_VERSION = '1.34.0'
 
 end

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # WARNING ABOUT GENERATED CODE
 #
 # This file is generated. See the contributing guide for more information:
@@ -24,12 +26,25 @@ require 'aws-sdk-core/plugins/jsonvalue_converter.rb'
 require 'aws-sdk-core/plugins/client_metrics_plugin.rb'
 require 'aws-sdk-core/plugins/client_metrics_send_plugin.rb'
 require 'aws-sdk-core/plugins/transfer_encoding.rb'
+require 'aws-sdk-core/plugins/http_checksum.rb'
 require 'aws-sdk-core/plugins/signature_v4.rb'
 require 'aws-sdk-core/plugins/protocols/json_rpc.rb'
 
 Aws::Plugins::GlobalConfiguration.add_identifier(:comprehend)
 
 module Aws::Comprehend
+  # An API client for Comprehend.  To construct a client, you need to configure a `:region` and `:credentials`.
+  #
+  #     client = Aws::Comprehend::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
@@ -57,6 +72,7 @@ module Aws::Comprehend
     add_plugin(Aws::Plugins::ClientMetricsPlugin)
     add_plugin(Aws::Plugins::ClientMetricsSendPlugin)
     add_plugin(Aws::Plugins::TransferEncoding)
+    add_plugin(Aws::Plugins::HttpChecksum)
     add_plugin(Aws::Plugins::SignatureV4)
     add_plugin(Aws::Plugins::Protocols::JsonRpc)
 
@@ -93,7 +109,7 @@ module Aws::Comprehend
     #   @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 +124,12 @@ module Aws::Comprehend
     #     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 +154,10 @@ module Aws::Comprehend
     #     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 +165,7 @@ module Aws::Comprehend
     #   @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 or custom 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 +180,7 @@ module Aws::Comprehend
     #     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 +192,29 @@ module Aws::Comprehend
     #     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 +222,30 @@ module Aws::Comprehend
     #     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 +278,15 @@ module Aws::Comprehend
     #     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 +295,7 @@ module Aws::Comprehend
     #     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`.
@@ -1571,6 +1629,8 @@ module Aws::Comprehend
     #   * {Types::ListDocumentClassificationJobsResponse#document_classification_job_properties_list #document_classification_job_properties_list} => Array&lt;Types::DocumentClassificationJobProperties&gt;
     #   * {Types::ListDocumentClassificationJobsResponse#next_token #next_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.list_document_classification_jobs({
@@ -1634,6 +1694,8 @@ module Aws::Comprehend
     #   * {Types::ListDocumentClassifiersResponse#document_classifier_properties_list #document_classifier_properties_list} => Array&lt;Types::DocumentClassifierProperties&gt;
     #   * {Types::ListDocumentClassifiersResponse#next_token #next_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.list_document_classifiers({
@@ -1710,6 +1772,8 @@ module Aws::Comprehend
     #   * {Types::ListDominantLanguageDetectionJobsResponse#dominant_language_detection_job_properties_list #dominant_language_detection_job_properties_list} => Array&lt;Types::DominantLanguageDetectionJobProperties&gt;
     #   * {Types::ListDominantLanguageDetectionJobsResponse#next_token #next_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.list_dominant_language_detection_jobs({
@@ -1826,6 +1890,8 @@ module Aws::Comprehend
     #   * {Types::ListEntitiesDetectionJobsResponse#entities_detection_job_properties_list #entities_detection_job_properties_list} => Array&lt;Types::EntitiesDetectionJobProperties&gt;
     #   * {Types::ListEntitiesDetectionJobsResponse#next_token #next_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.list_entities_detection_jobs({
@@ -1897,6 +1963,8 @@ module Aws::Comprehend
     #   * {Types::ListEntityRecognizersResponse#entity_recognizer_properties_list #entity_recognizer_properties_list} => Array&lt;Types::EntityRecognizerProperties&gt;
     #   * {Types::ListEntityRecognizersResponse#next_token #next_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.list_entity_recognizers({
@@ -1972,6 +2040,8 @@ module Aws::Comprehend
     #   * {Types::ListKeyPhrasesDetectionJobsResponse#key_phrases_detection_job_properties_list #key_phrases_detection_job_properties_list} => Array&lt;Types::KeyPhrasesDetectionJobProperties&gt;
     #   * {Types::ListKeyPhrasesDetectionJobsResponse#next_token #next_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.list_key_phrases_detection_jobs({
@@ -2035,6 +2105,8 @@ module Aws::Comprehend
     #   * {Types::ListSentimentDetectionJobsResponse#sentiment_detection_job_properties_list #sentiment_detection_job_properties_list} => Array&lt;Types::SentimentDetectionJobProperties&gt;
     #   * {Types::ListSentimentDetectionJobsResponse#next_token #next_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.list_sentiment_detection_jobs({
@@ -2131,6 +2203,8 @@ module Aws::Comprehend
     #   * {Types::ListTopicsDetectionJobsResponse#topics_detection_job_properties_list #topics_detection_job_properties_list} => Array&lt;Types::TopicsDetectionJobProperties&gt;
     #   * {Types::ListTopicsDetectionJobsResponse#next_token #next_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.list_topics_detection_jobs({
@@ -3084,7 +3158,7 @@ module Aws::Comprehend
         params: params,
         config: config)
       context[:gem_name] = 'aws-sdk-comprehend'
-      context[:gem_version] = '1.29.0'
+      context[:gem_version] = '1.34.0'
       Seahorse::Client::Request.new(handlers, context)
     end
 

data/lib/aws-sdk-comprehend/client_api.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # WARNING ABOUT GENERATED CODE
 #
 # This file is generated. See the contributing guide for more information:

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # WARNING ABOUT GENERATED CODE
 #
 # This file is generated. See the contributing guide for more information:
@@ -6,6 +8,44 @@
 # WARNING ABOUT GENERATED CODE
 
 module Aws::Comprehend
+
+  # When Comprehend returns an error response, the Ruby SDK constructs and raises an error.
+  # These errors all extend Aws::Comprehend::Errors::ServiceError < {Aws::Errors::ServiceError}
+  #
+  # You can rescue all Comprehend errors using ServiceError:
+  #
+  #     begin
+  #       # do stuff
+  #     rescue Aws::Comprehend::Errors::ServiceError
+  #       # rescues all Comprehend 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
+  # * {BatchSizeLimitExceededException}
+  # * {ConcurrentModificationException}
+  # * {InternalServerException}
+  # * {InvalidFilterException}
+  # * {InvalidRequestException}
+  # * {JobNotFoundException}
+  # * {KmsKeyValidationException}
+  # * {ResourceInUseException}
+  # * {ResourceLimitExceededException}
+  # * {ResourceNotFoundException}
+  # * {ResourceUnavailableException}
+  # * {TextSizeLimitExceededException}
+  # * {TooManyRequestsException}
+  # * {TooManyTagKeysException}
+  # * {TooManyTagsException}
+  # * {UnsupportedLanguageException}
+  #
+  # 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 +63,6 @@ module Aws::Comprehend
       def message
         @message || @data[:message]
       end
-
     end
 
     class ConcurrentModificationException < ServiceError
@@ -39,7 +78,6 @@ module Aws::Comprehend
       def message
         @message || @data[:message]
       end
-
     end
 
     class InternalServerException < ServiceError
@@ -55,7 +93,6 @@ module Aws::Comprehend
       def message
         @message || @data[:message]
       end
-
     end
 
     class InvalidFilterException < ServiceError
@@ -71,7 +108,6 @@ module Aws::Comprehend
       def message
         @message || @data[:message]
       end
-
     end
 
     class InvalidRequestException < ServiceError
@@ -87,7 +123,6 @@ module Aws::Comprehend
       def message
         @message || @data[:message]
       end
-
     end
 
     class JobNotFoundException < ServiceError
@@ -103,7 +138,6 @@ module Aws::Comprehend
       def message
         @message || @data[:message]
       end
-
     end
 
     class KmsKeyValidationException < ServiceError
@@ -119,7 +153,6 @@ module Aws::Comprehend
       def message
         @message || @data[:message]
       end
-
     end
 
     class ResourceInUseException < ServiceError
@@ -135,7 +168,6 @@ module Aws::Comprehend
       def message
         @message || @data[:message]
       end
-
     end
 
     class ResourceLimitExceededException < ServiceError
@@ -151,7 +183,6 @@ module Aws::Comprehend
       def message
         @message || @data[:message]
       end
-
     end
 
     class ResourceNotFoundException < ServiceError
@@ -167,7 +198,6 @@ module Aws::Comprehend
       def message
         @message || @data[:message]
       end
-
     end
 
     class ResourceUnavailableException < ServiceError
@@ -183,7 +213,6 @@ module Aws::Comprehend
       def message
         @message || @data[:message]
       end
-
     end
 
     class TextSizeLimitExceededException < ServiceError
@@ -199,7 +228,6 @@ module Aws::Comprehend
       def message
         @message || @data[:message]
       end
-
     end
 
     class TooManyRequestsException < ServiceError
@@ -215,7 +243,6 @@ module Aws::Comprehend
       def message
         @message || @data[:message]
       end
-
     end
 
     class TooManyTagKeysException < ServiceError
@@ -231,7 +258,6 @@ module Aws::Comprehend
       def message
         @message || @data[:message]
       end
-
     end
 
     class TooManyTagsException < ServiceError
@@ -247,7 +273,6 @@ module Aws::Comprehend
       def message
         @message || @data[:message]
       end
-
     end
 
     class UnsupportedLanguageException < ServiceError
@@ -263,7 +288,6 @@ module Aws::Comprehend
       def message
         @message || @data[:message]
       end
-
     end
 
   end