aws-sdk-forecastqueryservice 1.1.0 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 36c07c8a4cb1a9524a54c6ef2c2e5b6695c2eac7
-  data.tar.gz: f9de384c63aa4d721c360c29bfdc9104748d16a4
+  metadata.gz: 81ae676e9341e9f4e10999c56fe817f3100cf9dc
+  data.tar.gz: b0209d5efbd1d43fadeea0a769454f02f36e5bab
 SHA512:
-  metadata.gz: 66a6aeba39e0d382bec909f2b6a372ef58aae68bc20c81b12517c2c7b54725fba7caa6704725b7f13695bb73664ea67fcd32ba71baa0be4f7191f7a5645c4dcc
-  data.tar.gz: c009f229636a95875ea2952017deb774bac62db8df20f31b896c2153d27345cf93510fc6d5b9ab7217f857f9be62c4dbfec216d0faae60454482a22e6e3008f1
+  metadata.gz: bcd18cadc393b5b6fa01e7f7257980386bed9e1cf134bd7918d630baccca6496479fdf817b5991e75e5e16e920d448a57d812a4b6679e83a57c9df98296e4019
+  data.tar.gz: cccdc4847b804ddd0513a32fabdc0097d41bad9b7f9f8d55077c291429cee829705f98d2f233590e92375256c4cdb175bdd1a984f523222ec4addcb9bfb9d9cd

data/lib/aws-sdk-forecastqueryservice.rb

@@ -42,6 +42,6 @@ require_relative 'aws-sdk-forecastqueryservice/customizations'
 # @service
 module Aws::ForecastQueryService
 
-  GEM_VERSION = '1.1.0'
+  GEM_VERSION = '1.2.0'
 
 end

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

@@ -264,56 +264,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 +364,7 @@ module Aws::ForecastQueryService
         params: params,
         config: config)
       context[:gem_name] = 'aws-sdk-forecastqueryservice'
-      context[:gem_version] = '1.1.0'
+      context[:gem_version] = '1.2.0'
       Seahorse::Client::Request.new(handlers, context)
     end
 

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.1.0
+  version: 1.2.0
 platform: ruby
 authors:
 - Amazon Web Services
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-10-23 00:00:00.000000000 Z
+date: 2020-02-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aws-sdk-core