aws-sdk-forecastqueryservice 1.21.0 → 1.22.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 52da4c17c37a24114eb4b1ebbd0abc1fb6270c98ad79143155fcf8fea5081bba
-  data.tar.gz: a8f0aff5ebca3095f345d5bbbc04c36df7e2f7c1f00d1035f51504816832693c
+  metadata.gz: bfe49d460655e3ba0b86571e4f8a63ab852640e8d3022a4440894439b2b569ac
+  data.tar.gz: 200d73896a9baef7db8e768aa38eaab867b0c3696e5d7432cf39ff20540424cc
 SHA512:
-  metadata.gz: e477a21a7df3e00e47be9eb4dffd20d4a12ab381869b5baffee089765b003f3ef71d4da281360e9f8a02a50932755295b8ef13205d98b26bab179a8a1d931586
-  data.tar.gz: 9fa4b33c35de9ca902c22f40f6000da48fd50b7c5fc6acc83121dd8ad72149ad15e4b02f070c90814f6a48ed4b0cc9e31952ea111cebe2b4d240a83a3538de43
+  metadata.gz: c586ff15845a279c928e8debeea03f58b8572108aec08f0e6f7de294ee03761faa85d5a446d918a5ff95202cb664b364f6e784831f364999d96741cca720fe7e
+  data.tar.gz: 2209e98cee587f64cb7b726261c0215626c95f26ba0772dd9d8dab551aab1d3b2f4eed24c1ec52fd9d6c8a4730212d4d58f6a0da8832b5092f8b33ca42149c81

data/CHANGELOG.md

@@ -1,6 +1,11 @@
 Unreleased Changes
 ------------------
 
+1.22.0 (2022-08-22)
+------------------
+
+* Feature - releasing What-If Analysis APIs
+
 1.21.0 (2022-02-24)
 ------------------
 

data/VERSION

@@ -1 +1 @@
-1.21.0
+1.22.0

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

@@ -448,6 +448,72 @@ module Aws::ForecastQueryService
       req.send_request(options)
     end
 
+    # Retrieves a what-if forecast.
+    #
+    # @option params [required, String] :what_if_forecast_arn
+    #   The Amazon Resource Name (ARN) of the what-if forecast to query.
+    #
+    # @option params [String] :start_date
+    #   The start date for the what-if forecast. Specify the date using this
+    #   format: 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 what-if forecast. Specify the date using this
+    #   format: 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 the forecast for `client_21` in the electricity usage
+    #   dataset, specify the following:
+    #
+    #   `\{"item_id" : "client_21"\}`
+    #
+    #   To get the full what-if forecast, use the [CreateForecastExportJob][1]
+    #   operation.
+    #
+    #
+    #
+    #   [1]: https://docs.aws.amazon.com/en_us/forecast/latest/dg/API_CreateWhatIfForecastExport.html
+    #
+    # @option params [String] :next_token
+    #   If the result of the previous request was truncated, the response
+    #   includes a `NextToken`. To retrieve the next set of results, use the
+    #   token in the next request. Tokens expire after 24 hours.
+    #
+    # @return [Types::QueryWhatIfForecastResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
+    #
+    #   * {Types::QueryWhatIfForecastResponse#forecast #forecast} => Types::Forecast
+    #
+    # @example Request syntax with placeholder values
+    #
+    #   resp = client.query_what_if_forecast({
+    #     what_if_forecast_arn: "LongArn", # required
+    #     start_date: "DateTime",
+    #     end_date: "DateTime",
+    #     filters: { # required
+    #       "AttributeName" => "AttributeValue",
+    #     },
+    #     next_token: "NextToken",
+    #   })
+    #
+    # @example Response structure
+    #
+    #   resp.forecast.predictions #=> Hash
+    #   resp.forecast.predictions["Statistic"] #=> Array
+    #   resp.forecast.predictions["Statistic"][0].timestamp #=> String
+    #   resp.forecast.predictions["Statistic"][0].value #=> Float
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/forecastquery-2018-06-26/QueryWhatIfForecast AWS API Documentation
+    #
+    # @overload query_what_if_forecast(params = {})
+    # @param [Hash] params ({})
+    def query_what_if_forecast(params = {}, options = {})
+      req = build_request(:query_what_if_forecast, params)
+      req.send_request(options)
+    end
+
     # @!endgroup
 
     # @param params ({})
@@ -461,7 +527,7 @@ module Aws::ForecastQueryService
         params: params,
         config: config)
       context[:gem_name] = 'aws-sdk-forecastqueryservice'
-      context[:gem_version] = '1.21.0'
+      context[:gem_version] = '1.22.0'
       Seahorse::Client::Request.new(handlers, context)
     end
 

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

@@ -25,10 +25,13 @@ module Aws::ForecastQueryService
     InvalidInputException = Shapes::StructureShape.new(name: 'InvalidInputException')
     InvalidNextTokenException = Shapes::StructureShape.new(name: 'InvalidNextTokenException')
     LimitExceededException = Shapes::StructureShape.new(name: 'LimitExceededException')
+    LongArn = Shapes::StringShape.new(name: 'LongArn')
     NextToken = Shapes::StringShape.new(name: 'NextToken')
     Predictions = Shapes::MapShape.new(name: 'Predictions')
     QueryForecastRequest = Shapes::StructureShape.new(name: 'QueryForecastRequest')
     QueryForecastResponse = Shapes::StructureShape.new(name: 'QueryForecastResponse')
+    QueryWhatIfForecastRequest = Shapes::StructureShape.new(name: 'QueryWhatIfForecastRequest')
+    QueryWhatIfForecastResponse = Shapes::StructureShape.new(name: 'QueryWhatIfForecastResponse')
     ResourceInUseException = Shapes::StructureShape.new(name: 'ResourceInUseException')
     ResourceNotFoundException = Shapes::StructureShape.new(name: 'ResourceNotFoundException')
     Statistic = Shapes::StringShape.new(name: 'Statistic')
@@ -67,6 +70,16 @@ module Aws::ForecastQueryService
     QueryForecastResponse.add_member(:forecast, Shapes::ShapeRef.new(shape: Forecast, location_name: "Forecast"))
     QueryForecastResponse.struct_class = Types::QueryForecastResponse
 
+    QueryWhatIfForecastRequest.add_member(:what_if_forecast_arn, Shapes::ShapeRef.new(shape: LongArn, required: true, location_name: "WhatIfForecastArn"))
+    QueryWhatIfForecastRequest.add_member(:start_date, Shapes::ShapeRef.new(shape: DateTime, location_name: "StartDate"))
+    QueryWhatIfForecastRequest.add_member(:end_date, Shapes::ShapeRef.new(shape: DateTime, location_name: "EndDate"))
+    QueryWhatIfForecastRequest.add_member(:filters, Shapes::ShapeRef.new(shape: Filters, required: true, location_name: "Filters"))
+    QueryWhatIfForecastRequest.add_member(:next_token, Shapes::ShapeRef.new(shape: NextToken, location_name: "NextToken"))
+    QueryWhatIfForecastRequest.struct_class = Types::QueryWhatIfForecastRequest
+
+    QueryWhatIfForecastResponse.add_member(:forecast, Shapes::ShapeRef.new(shape: Forecast, location_name: "Forecast"))
+    QueryWhatIfForecastResponse.struct_class = Types::QueryWhatIfForecastResponse
+
     ResourceInUseException.add_member(:message, Shapes::ShapeRef.new(shape: ErrorMessage, location_name: "Message"))
     ResourceInUseException.struct_class = Types::ResourceInUseException
 
@@ -106,6 +119,19 @@ module Aws::ForecastQueryService
         o.errors << Shapes::ShapeRef.new(shape: LimitExceededException)
         o.errors << Shapes::ShapeRef.new(shape: InvalidNextTokenException)
       end)
+
+      api.add_operation(:query_what_if_forecast, Seahorse::Model::Operation.new.tap do |o|
+        o.name = "QueryWhatIfForecast"
+        o.http_method = "POST"
+        o.http_request_uri = "/"
+        o.input = Shapes::ShapeRef.new(shape: QueryWhatIfForecastRequest)
+        o.output = Shapes::ShapeRef.new(shape: QueryWhatIfForecastResponse)
+        o.errors << Shapes::ShapeRef.new(shape: ResourceNotFoundException)
+        o.errors << Shapes::ShapeRef.new(shape: ResourceInUseException)
+        o.errors << Shapes::ShapeRef.new(shape: InvalidInputException)
+        o.errors << Shapes::ShapeRef.new(shape: LimitExceededException)
+        o.errors << Shapes::ShapeRef.new(shape: InvalidNextTokenException)
+      end)
     end
 
   end

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

@@ -43,6 +43,15 @@ module Aws::ForecastQueryService
     #   * p50
     #
     #   * p90
+    #
+    #   The default setting is `["0.1", "0.5", "0.9"]`. Use the optional
+    #   `ForecastTypes` parameter of the [CreateForecast][1] operation to
+    #   change the values. The values will vary depending on how this is
+    #   set, with a minimum of `1` and a maximum of `5.`
+    #
+    #
+    #
+    #   [1]: https://docs.aws.amazon.com/forecast/latest/dg/API_CreateForecast.html
     #   @return [Hash<String,Array<Types::DataPoint>>]
     #
     # @see http://docs.aws.amazon.com/goto/WebAPI/forecastquery-2018-06-26/Forecast AWS API Documentation
@@ -166,6 +175,81 @@ module Aws::ForecastQueryService
       include Aws::Structure
     end
 
+    # @note When making an API call, you may pass QueryWhatIfForecastRequest
+    #   data as a hash:
+    #
+    #       {
+    #         what_if_forecast_arn: "LongArn", # required
+    #         start_date: "DateTime",
+    #         end_date: "DateTime",
+    #         filters: { # required
+    #           "AttributeName" => "AttributeValue",
+    #         },
+    #         next_token: "NextToken",
+    #       }
+    #
+    # @!attribute [rw] what_if_forecast_arn
+    #   The Amazon Resource Name (ARN) of the what-if forecast to query.
+    #   @return [String]
+    #
+    # @!attribute [rw] start_date
+    #   The start date for the what-if forecast. Specify the date using this
+    #   format: 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 what-if forecast. Specify the date using this
+    #   format: 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 the forecast for `client_21` in the electricity
+    #   usage dataset, specify the following:
+    #
+    #   `\{"item_id" : "client_21"\}`
+    #
+    #   To get the full what-if forecast, use the
+    #   [CreateForecastExportJob][1] operation.
+    #
+    #
+    #
+    #   [1]: https://docs.aws.amazon.com/en_us/forecast/latest/dg/API_CreateWhatIfForecastExport.html
+    #   @return [Hash<String,String>]
+    #
+    # @!attribute [rw] next_token
+    #   If the result of the previous request was truncated, the response
+    #   includes a `NextToken`. To retrieve the next set of results, use the
+    #   token in the next request. Tokens expire after 24 hours.
+    #   @return [String]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/forecastquery-2018-06-26/QueryWhatIfForecastRequest AWS API Documentation
+    #
+    class QueryWhatIfForecastRequest < Struct.new(
+      :what_if_forecast_arn,
+      :start_date,
+      :end_date,
+      :filters,
+      :next_token)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
+    # @!attribute [rw] forecast
+    #   Provides information about a forecast. Returned as part of the
+    #   QueryForecast response.
+    #   @return [Types::Forecast]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/forecastquery-2018-06-26/QueryWhatIfForecastResponse AWS API Documentation
+    #
+    class QueryWhatIfForecastResponse < Struct.new(
+      :forecast)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
     # The specified resource is in use.
     #
     # @!attribute [rw] message

data/lib/aws-sdk-forecastqueryservice.rb

@@ -48,6 +48,6 @@ require_relative 'aws-sdk-forecastqueryservice/customizations'
 # @!group service
 module Aws::ForecastQueryService
 
-  GEM_VERSION = '1.21.0'
+  GEM_VERSION = '1.22.0'
 
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: aws-sdk-forecastqueryservice
 version: !ruby/object:Gem::Version
-  version: 1.21.0
+  version: 1.22.0
 platform: ruby
 authors:
 - Amazon Web Services
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-02-24 00:00:00.000000000 Z
+date: 2022-08-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aws-sdk-core