aws-sdk-forecastqueryservice 1.0.0 → 1.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 2431c0ccf52c6c0a7fd2cbf990cefed34d387d51
-  data.tar.gz: 508a2dfb0efd9cf72743d1c2e7a3dcf5db35fec5
+SHA256:
+  metadata.gz: 05c1371f13607cc9d8eea7825e5110ef2e59c158467b32ad2d09e9725b067a8a
+  data.tar.gz: c835f60cc243a5aa469e2ae8ea59c4c992545ec5866de8116ff7ff7da7d67fa5
 SHA512:
-  metadata.gz: 1199a44d5c0b496ff351c12cdfd48d52b0cee8bd22cefd83c8998b43033c8cbfb23fb2dda535902e7f57f48c0ddfaabeed88f1529461207f3b621bc1aef2dbcd
-  data.tar.gz: 4c50768b01664e4a3f2469f70b01ce13be51b163a3c5e80030af88e1018ad1658bf7b36d32b796ad9ed27c05c62bc226be09e4ba7e2f6df8f5effd6de5bafdc9
+  metadata.gz: fd39a993b38e6764f4cb2f0519e0e794afcb84a5dbd09def7d3f720841dbbc439872a60ccc5d369904fd09310ef19d84019ea80285a31dff8d0e795c4ec25bdf
+  data.tar.gz: 41302cd4d964ef65d85aded8ecdca14bd0eea00d79827c3a9314ac20e437f968759a4977c9f026a7aa9ba9a2a17a12f14e6d843a30c81657d44cbc099ac7e241

data/lib/aws-sdk-forecastqueryservice.rb

@@ -24,17 +24,20 @@ require_relative 'aws-sdk-forecastqueryservice/customizations'
 # methods each accept a hash of request parameters and return a response
 # structure.
 #
+#     forecast_query_service = Aws::ForecastQueryService::Client.new
+#     resp = forecast_query_service.query_forecast(params)
+#
 # See {Client} for more information.
 #
 # # Errors
 #
-# Errors returned from Amazon Forecast Query Service all
-# extend {Errors::ServiceError}.
+# Errors returned from Amazon Forecast Query Service are defined in the
+# {Errors} module and all extend {Errors::ServiceError}.
 #
 #     begin
 #       # do stuff
 #     rescue Aws::ForecastQueryService::Errors::ServiceError
-#       # rescues all service API errors
+#       # rescues all Amazon Forecast Query Service API errors
 #     end
 #
 # See {Errors} for more information.
@@ -42,6 +45,6 @@ require_relative 'aws-sdk-forecastqueryservice/customizations'
 # @service
 module Aws::ForecastQueryService
 
-  GEM_VERSION = '1.0.0'
+  GEM_VERSION = '1.5.0'
 
 end

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

@@ -30,6 +30,18 @@ require 'aws-sdk-core/plugins/protocols/json_rpc.rb'
 Aws::Plugins::GlobalConfiguration.add_identifier(:forecastqueryservice)
 
 module Aws::ForecastQueryService
+  # An API client for ForecastQueryService.  To construct a client, you need to configure a `:region` and `:credentials`.
+  #
+  #     client = Aws::ForecastQueryService::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::ForecastQueryService
     #   @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::ForecastQueryService
     #     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::ForecastQueryService
     #     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::ForecastQueryService
     #   @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::ForecastQueryService
     #     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::ForecastQueryService
     #     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::ForecastQueryService
     #     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::ForecastQueryService
     #     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::ForecastQueryService
     #     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`.
@@ -264,56 +318,55 @@ module Aws::ForecastQueryService
 
     # @!group API Operations
 
-    # Retrieves a forecast filtered by the supplied criteria.
+    # Retrieves a forecast for a single item, filtered by the supplied
+    # criteria.
     #
     # The criteria is a key-value pair. The key is either `item_id` (or the
     # equivalent non-timestamp, non-target field) from the
     # `TARGET_TIME_SERIES` dataset, or one of the forecast dimensions
     # specified as part of the `FeaturizationConfig` object.
     #
-    # By default, the complete date range of the filtered forecast is
-    # returned. Optionally, you can request a specific date range within the
-    # forecast.
+    # By default, `QueryForecast` returns the complete date range for the
+    # filtered forecast. You can request a specific date range.
+    #
+    # To get the full forecast, use the [CreateForecastExportJob][1]
+    # operation.
     #
     # <note markdown="1"> The forecasts generated by Amazon Forecast are in the same timezone as
     # the dataset that was used to create the predictor.
     #
     #  </note>
     #
+    #
+    #
+    # [1]: https://docs.aws.amazon.com/en_us/forecast/latest/dg/API_CreateForecastExportJob.html
+    #
     # @option params [required, String] :forecast_arn
     #   The Amazon Resource Name (ARN) of the forecast to query.
     #
     # @option params [String] :start_date
     #   The start date for the forecast. Specify the date using this format:
-    #   yyyy-MM-dd'T'HH:mm:ss'Z' (ISO 8601 format) For example,
-    #   "1970-01-01T00:00:00Z."
+    #   yyyy-MM-dd'T'HH:mm:ss (ISO 8601 format). For example,
+    #   2015-01-01T08:00:00.
     #
     # @option params [String] :end_date
     #   The end date for the forecast. Specify the date using this format:
-    #   yyyy-MM-dd'T'HH:mm:ss'Z' (ISO 8601 format). For example,
-    #   "1970-01-01T00:00:00Z."
+    #   yyyy-MM-dd'T'HH:mm:ss (ISO 8601 format). For example,
+    #   2015-01-01T20:00:00.
     #
     # @option params [required, Hash<String,String>] :filters
     #   The filtering criteria to apply when retrieving the forecast. For
-    #   example:
-    #
-    #   * To get a forecast for a specific item specify the following:
-    #
-    #     `\{"item_id" : "client_1"\}`
-    #   ^
+    #   example, to get the forecast for `client_21` in the electricity usage
+    #   dataset, specify the following:
     #
-    #   * To get a forecast for a specific item sold in a specific location,
-    #     specify the following:
+    #   `\{"item_id" : "client_21"\}`
     #
-    #     `\{"item_id" : "client_1", "location" : "ny"\}`
-    #   ^
+    #   To get the full forecast, use the [CreateForecastExportJob][1]
+    #   operation.
     #
-    #   * To get a forecast for all blue items sold in a specific location,
-    #     specify the following:
     #
-    #     `\{ "location" : "ny", "color":"blue"\}`
     #
-    #   To get the full forecast, use the operation.
+    #   [1]: https://docs.aws.amazon.com/en_us/forecast/latest/dg/API_CreateForecastExportJob.html
     #
     # @option params [String] :next_token
     #   If the result of the previous request was truncated, the response
@@ -365,7 +418,7 @@ module Aws::ForecastQueryService
         params: params,
         config: config)
       context[:gem_name] = 'aws-sdk-forecastqueryservice'
-      context[:gem_version] = '1.0.0'
+      context[:gem_version] = '1.5.0'
       Seahorse::Client::Request.new(handlers, context)
     end
 

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

@@ -6,6 +6,33 @@
 # WARNING ABOUT GENERATED CODE
 
 module Aws::ForecastQueryService
+
+  # When ForecastQueryService returns an error response, the Ruby SDK constructs and raises an error.
+  # These errors all extend Aws::ForecastQueryService::Errors::ServiceError < {Aws::Errors::ServiceError}
+  #
+  # You can rescue all ForecastQueryService errors using ServiceError:
+  #
+  #     begin
+  #       # do stuff
+  #     rescue Aws::ForecastQueryService::Errors::ServiceError
+  #       # rescues all ForecastQueryService 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
+  # * {InvalidInputException}
+  # * {InvalidNextTokenException}
+  # * {LimitExceededException}
+  # * {ResourceInUseException}
+  # * {ResourceNotFoundException}
+  #
+  # 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 +50,6 @@ module Aws::ForecastQueryService
       def message
         @message || @data[:message]
       end
-
     end
 
     class InvalidNextTokenException < ServiceError
@@ -39,7 +65,6 @@ module Aws::ForecastQueryService
       def message
         @message || @data[:message]
       end
-
     end
 
     class LimitExceededException < ServiceError
@@ -55,7 +80,6 @@ module Aws::ForecastQueryService
       def message
         @message || @data[:message]
       end
-
     end
 
     class ResourceInUseException < ServiceError
@@ -71,7 +95,6 @@ module Aws::ForecastQueryService
       def message
         @message || @data[:message]
       end
-
     end
 
     class ResourceNotFoundException < ServiceError
@@ -87,7 +110,6 @@ module Aws::ForecastQueryService
       def message
         @message || @data[:message]
       end
-
     end
 
   end

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

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

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

@@ -32,11 +32,9 @@ module Aws::ForecastQueryService
     # @!attribute [rw] predictions
     #   The forecast.
     #
-    #   The *string* of the string to array map is one of the following
+    #   The *string* of the string-to-array map is one of the following
     #   values:
     #
-    #   * mean
-    #
     #   * p10
     #
     #   * p50
@@ -51,7 +49,7 @@ module Aws::ForecastQueryService
       include Aws::Structure
     end
 
-    # The value that you provided was invalid or too long.
+    # The value is invalid or is too long.
     #
     # @!attribute [rw] message
     #   @return [String]
@@ -106,37 +104,29 @@ module Aws::ForecastQueryService
     #
     # @!attribute [rw] start_date
     #   The start date for the forecast. Specify the date using this format:
-    #   yyyy-MM-dd'T'HH:mm:ss'Z' (ISO 8601 format) For example,
-    #   "1970-01-01T00:00:00Z."
+    #   yyyy-MM-dd'T'HH:mm:ss (ISO 8601 format). For example,
+    #   2015-01-01T08:00:00.
     #   @return [String]
     #
     # @!attribute [rw] end_date
     #   The end date for the forecast. Specify the date using this format:
-    #   yyyy-MM-dd'T'HH:mm:ss'Z' (ISO 8601 format). For example,
-    #   "1970-01-01T00:00:00Z."
+    #   yyyy-MM-dd'T'HH:mm:ss (ISO 8601 format). For example,
+    #   2015-01-01T20:00:00.
     #   @return [String]
     #
     # @!attribute [rw] filters
     #   The filtering criteria to apply when retrieving the forecast. For
-    #   example:
-    #
-    #   * To get a forecast for a specific item specify the following:
-    #
-    #     `\{"item_id" : "client_1"\}`
-    #   ^
+    #   example, to get the forecast for `client_21` in the electricity
+    #   usage dataset, specify the following:
     #
-    #   * To get a forecast for a specific item sold in a specific location,
-    #     specify the following:
+    #   `\{"item_id" : "client_21"\}`
     #
-    #     `\{"item_id" : "client_1", "location" : "ny"\}`
-    #   ^
+    #   To get the full forecast, use the [CreateForecastExportJob][1]
+    #   operation.
     #
-    #   * To get a forecast for all blue items sold in a specific location,
-    #     specify the following:
     #
-    #     `\{ "location" : "ny", "color":"blue"\}`
     #
-    #   To get the full forecast, use the operation.
+    #   [1]: https://docs.aws.amazon.com/en_us/forecast/latest/dg/API_CreateForecastExportJob.html
     #   @return [Hash<String,String>]
     #
     # @!attribute [rw] next_token

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: aws-sdk-forecastqueryservice
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.5.0
 platform: ruby
 authors:
 - Amazon Web Services
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-08-21 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.61.1
+        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.61.1
+        version: 3.71.0
 - !ruby/object:Gem::Dependency
   name: aws-sigv4
   requirement: !ruby/object:Gem::Requirement
@@ -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 - Amazon Forecast Query Service