aws-sdk-machinelearning 1.15.0 → 1.20.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 4e921b70501a90ce0215f7f958cdf1d184670317
-  data.tar.gz: 41232970ba39fbf9c24ee92975a21dfe2f65f0bc
+SHA256:
+  metadata.gz: 4ed3ca8eeb18521706c6bce4d1050f42509ffc8dccbcb8e6f2ab6e8a2b211772
+  data.tar.gz: 5631340664339e52a0864943408dadd7ce8defeaa14c69b4cee3622799e9d70f
 SHA512:
-  metadata.gz: f811d25d2c7ede39636f4f701494a712ff1505715bdfc891765717b68b1ae0c072472150be925b71889a146e13db29e981906aaca859d438c87c823b8caf581d
-  data.tar.gz: 1ba4d71a571d02cb076e35abefb9de6f090e1b1182aebdb07d918ff7ac9507c1920ecb22c744e2806d14cf2c0c7d80cd6458be11b0b0ea5f806a2c57151ce0bf
+  metadata.gz: adc1bc95c769129d3187f87f3804febc6e6daa825a2aa3eb6be62532bc3882accbab89e9e0fd88a34ce1d89c03daa08f59ff20762e00daaeb625b02551f12798
+  data.tar.gz: b5bfe764344a8c3353bb063551dffbc4103f8c7f77b69930dcf28c131b77c236e0fc2cb15f54884e7f743ff60e076ecc454730e4bb04f3407ce1a0678a988c60

data/lib/aws-sdk-machinelearning.rb

@@ -25,17 +25,20 @@ require_relative 'aws-sdk-machinelearning/customizations'
 # methods each accept a hash of request parameters and return a response
 # structure.
 #
+#     machine_learning = Aws::MachineLearning::Client.new
+#     resp = machine_learning.add_tags(params)
+#
 # See {Client} for more information.
 #
 # # Errors
 #
-# Errors returned from Amazon Machine Learning all
-# extend {Errors::ServiceError}.
+# Errors returned from Amazon Machine Learning are defined in the
+# {Errors} module and all extend {Errors::ServiceError}.
 #
 #     begin
 #       # do stuff
 #     rescue Aws::MachineLearning::Errors::ServiceError
-#       # rescues all service API errors
+#       # rescues all Amazon Machine Learning API errors
 #     end
 #
 # See {Errors} for more information.
@@ -43,6 +46,6 @@ require_relative 'aws-sdk-machinelearning/customizations'
 # @service
 module Aws::MachineLearning
 
-  GEM_VERSION = '1.15.0'
+  GEM_VERSION = '1.20.0'
 
 end

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

@@ -31,6 +31,18 @@ require 'aws-sdk-machinelearning/plugins/predict_endpoint.rb'
 Aws::Plugins::GlobalConfiguration.add_identifier(:machinelearning)
 
 module Aws::MachineLearning
+  # An API client for MachineLearning.  To construct a client, you need to configure a `:region` and `:credentials`.
+  #
+  #     client = Aws::MachineLearning::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
@@ -95,7 +107,7 @@ module Aws::MachineLearning
     #   @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']`
@@ -110,6 +122,12 @@ module Aws::MachineLearning
     #     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.
@@ -134,6 +152,10 @@ module Aws::MachineLearning
     #     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.
@@ -141,7 +163,7 @@ module Aws::MachineLearning
     #   @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
@@ -156,7 +178,7 @@ module Aws::MachineLearning
     #     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.
@@ -168,15 +190,29 @@ module Aws::MachineLearning
     #     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
     #
@@ -184,11 +220,30 @@ module Aws::MachineLearning
     #     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
     #
@@ -221,16 +276,15 @@ module Aws::MachineLearning
     #     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.
     #
@@ -239,7 +293,7 @@ module Aws::MachineLearning
     #     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`.
@@ -1261,6 +1315,8 @@ module Aws::MachineLearning
     #   * {Types::DescribeBatchPredictionsOutput#results #results} => Array&lt;Types::BatchPrediction&gt;
     #   * {Types::DescribeBatchPredictionsOutput#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.describe_batch_predictions({
@@ -1298,6 +1354,11 @@ module Aws::MachineLearning
     #   resp.results[0].invalid_record_count #=> Integer
     #   resp.next_token #=> String
     #
+    #
+    # The following waiters are defined for this operation (see {Client#wait_until} for detailed usage):
+    #
+    #   * batch_prediction_available
+    #
     # @overload describe_batch_predictions(params = {})
     # @param [Hash] params ({})
     def describe_batch_predictions(params = {}, options = {})
@@ -1386,6 +1447,8 @@ module Aws::MachineLearning
     #   * {Types::DescribeDataSourcesOutput#results #results} => Array&lt;Types::DataSource&gt;
     #   * {Types::DescribeDataSourcesOutput#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.describe_data_sources({
@@ -1434,6 +1497,11 @@ module Aws::MachineLearning
     #   resp.results[0].started_at #=> Time
     #   resp.next_token #=> String
     #
+    #
+    # The following waiters are defined for this operation (see {Client#wait_until} for detailed usage):
+    #
+    #   * data_source_available
+    #
     # @overload describe_data_sources(params = {})
     # @param [Hash] params ({})
     def describe_data_sources(params = {}, options = {})
@@ -1527,6 +1595,8 @@ module Aws::MachineLearning
     #   * {Types::DescribeEvaluationsOutput#results #results} => Array&lt;Types::Evaluation&gt;
     #   * {Types::DescribeEvaluationsOutput#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.describe_evaluations({
@@ -1563,6 +1633,11 @@ module Aws::MachineLearning
     #   resp.results[0].started_at #=> Time
     #   resp.next_token #=> String
     #
+    #
+    # The following waiters are defined for this operation (see {Client#wait_until} for detailed usage):
+    #
+    #   * evaluation_available
+    #
     # @overload describe_evaluations(params = {})
     # @param [Hash] params ({})
     def describe_evaluations(params = {}, options = {})
@@ -1659,6 +1734,8 @@ module Aws::MachineLearning
     #   * {Types::DescribeMLModelsOutput#results #results} => Array&lt;Types::MLModel&gt;
     #   * {Types::DescribeMLModelsOutput#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.describe_ml_models({
@@ -1703,6 +1780,11 @@ module Aws::MachineLearning
     #   resp.results[0].started_at #=> Time
     #   resp.next_token #=> String
     #
+    #
+    # The following waiters are defined for this operation (see {Client#wait_until} for detailed usage):
+    #
+    #   * ml_model_available
+    #
     # @overload describe_ml_models(params = {})
     # @param [Hash] params ({})
     def describe_ml_models(params = {}, options = {})
@@ -2235,7 +2317,7 @@ module Aws::MachineLearning
         params: params,
         config: config)
       context[:gem_name] = 'aws-sdk-machinelearning'
-      context[:gem_version] = '1.15.0'
+      context[:gem_version] = '1.20.0'
       Seahorse::Client::Request.new(handlers, context)
     end
 
@@ -2301,12 +2383,12 @@ module Aws::MachineLearning
     # The following table lists the valid waiter names, the operations they call,
     # and the default `:delay` and `:max_attempts` values.
     #
-    # | waiter_name                | params                        | :delay   | :max_attempts |
-    # | -------------------------- | ----------------------------- | -------- | ------------- |
-    # | batch_prediction_available | {#describe_batch_predictions} | 30       | 60            |
-    # | data_source_available      | {#describe_data_sources}      | 30       | 60            |
-    # | evaluation_available       | {#describe_evaluations}       | 30       | 60            |
-    # | ml_model_available         | {#describe_ml_models}         | 30       | 60            |
+    # | waiter_name                | params                              | :delay   | :max_attempts |
+    # | -------------------------- | ----------------------------------- | -------- | ------------- |
+    # | batch_prediction_available | {Client#describe_batch_predictions} | 30       | 60            |
+    # | data_source_available      | {Client#describe_data_sources}      | 30       | 60            |
+    # | evaluation_available       | {Client#describe_evaluations}       | 30       | 60            |
+    # | ml_model_available         | {Client#describe_ml_models}         | 30       | 60            |
     #
     # @raise [Errors::FailureStateError] Raised when the waiter terminates
     #   because the waiter has entered a state that it will not transition

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

@@ -6,6 +6,36 @@
 # WARNING ABOUT GENERATED CODE
 
 module Aws::MachineLearning
+
+  # When MachineLearning returns an error response, the Ruby SDK constructs and raises an error.
+  # These errors all extend Aws::MachineLearning::Errors::ServiceError < {Aws::Errors::ServiceError}
+  #
+  # You can rescue all MachineLearning errors using ServiceError:
+  #
+  #     begin
+  #       # do stuff
+  #     rescue Aws::MachineLearning::Errors::ServiceError
+  #       # rescues all MachineLearning 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
+  # * {IdempotentParameterMismatchException}
+  # * {InternalServerException}
+  # * {InvalidInputException}
+  # * {InvalidTagException}
+  # * {LimitExceededException}
+  # * {PredictorNotMountedException}
+  # * {ResourceNotFoundException}
+  # * {TagLimitExceededException}
+  #
+  # 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
@@ -28,7 +58,6 @@ module Aws::MachineLearning
       def code
         @code || @data[:code]
       end
-
     end
 
     class InternalServerException < ServiceError
@@ -49,7 +78,6 @@ module Aws::MachineLearning
       def code
         @code || @data[:code]
       end
-
     end
 
     class InvalidInputException < ServiceError
@@ -70,7 +98,6 @@ module Aws::MachineLearning
       def code
         @code || @data[:code]
       end
-
     end
 
     class InvalidTagException < ServiceError
@@ -86,7 +113,6 @@ module Aws::MachineLearning
       def message
         @message || @data[:message]
       end
-
     end
 
     class LimitExceededException < ServiceError
@@ -107,7 +133,6 @@ module Aws::MachineLearning
       def code
         @code || @data[:code]
       end
-
     end
 
     class PredictorNotMountedException < ServiceError
@@ -123,7 +148,6 @@ module Aws::MachineLearning
       def message
         @message || @data[:message]
       end
-
     end
 
     class ResourceNotFoundException < ServiceError
@@ -144,7 +168,6 @@ module Aws::MachineLearning
       def code
         @code || @data[:code]
       end
-
     end
 
     class TagLimitExceededException < ServiceError
@@ -160,7 +183,6 @@ module Aws::MachineLearning
       def message
         @message || @data[:message]
       end
-
     end
 
   end

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

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

data/lib/aws-sdk-machinelearning/waiters.rb

@@ -8,6 +8,70 @@
 require 'aws-sdk-core/waiters'
 
 module Aws::MachineLearning
+  # Waiters are utility methods that poll for a particular state to occur
+  # on a client. Waiters can fail after a number of attempts at a polling
+  # interval defined for the service client.
+  #
+  # For a list of operations that can be waited for and the
+  # client methods called for each operation, see the table below or the
+  # {Client#wait_until} field documentation for the {Client}.
+  #
+  # # Invoking a Waiter
+  # To invoke a waiter, call #wait_until on a {Client}. The first parameter
+  # is the waiter name, which is specific to the service client and indicates
+  # which operation is being waited for. The second parameter is a hash of
+  # parameters that are passed to the client method called by the waiter,
+  # which varies according to the waiter name.
+  #
+  # # Wait Failures
+  # To catch errors in a waiter, use WaiterFailed,
+  # as shown in the following example.
+  #
+  #     rescue rescue Aws::Waiters::Errors::WaiterFailed => error
+  #       puts "failed waiting for instance running: #{error.message}
+  #     end
+  #
+  # # Configuring a Waiter
+  # Each waiter has a default polling interval and a maximum number of
+  # attempts it will make before returning control to your program.
+  # To set these values, use the `max_attempts` and `delay` parameters
+  # in your `#wait_until` call.
+  # The following example waits for up to 25 seconds, polling every five seconds.
+  #
+  #     client.wait_until(...) do |w|
+  #       w.max_attempts = 5
+  #       w.delay = 5
+  #     end
+  #
+  # To disable wait failures, set the value of either of these parameters
+  # to `nil`.
+  #
+  # # Extending a Waiter
+  # To modify the behavior of waiters, you can register callbacks that are
+  # triggered before each polling attempt and before waiting.
+  #
+  # The following example implements an exponential backoff in a waiter
+  # by doubling the amount of time to wait on every attempt.
+  #
+  #     client.wait_until(...) do |w|
+  #       w.interval = 0 # disable normal sleep
+  #       w.before_wait do |n, resp|
+  #         sleep(n ** 2)
+  #       end
+  #     end
+  #
+  # # Available Waiters
+  #
+  # The following table lists the valid waiter names, the operations they call,
+  # and the default `:delay` and `:max_attempts` values.
+  #
+  # | waiter_name                | params                              | :delay   | :max_attempts |
+  # | -------------------------- | ----------------------------------- | -------- | ------------- |
+  # | batch_prediction_available | {Client#describe_batch_predictions} | 30       | 60            |
+  # | data_source_available      | {Client#describe_data_sources}      | 30       | 60            |
+  # | evaluation_available       | {Client#describe_evaluations}       | 30       | 60            |
+  # | ml_model_available         | {Client#describe_ml_models}         | 30       | 60            |
+  #
   module Waiters
 
     class BatchPredictionAvailable

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: aws-sdk-machinelearning
 version: !ruby/object:Gem::Version
-  version: 1.15.0
+  version: 1.20.0
 platform: ruby
 authors:
 - Amazon Web Services
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-07-01 00:00:00.000000000 Z
+date: 2020-05-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aws-sdk-core
@@ -19,7 +19,7 @@ dependencies:
         version: '3'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 3.58.0
+        version: 3.71.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -29,7 +29,7 @@ dependencies:
         version: '3'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 3.58.0
+        version: 3.71.0
 - !ruby/object:Gem::Dependency
   name: aws-sigv4
   requirement: !ruby/object:Gem::Requirement
@@ -83,7 +83,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 - Amazon Machine Learning