Class: Aws::ForecastQueryService::Client
- Inherits:
-
Seahorse::Client::Base
- Object
- Seahorse::Client::Base
- Aws::ForecastQueryService::Client
- Includes:
- ClientStubs
- Defined in:
- gems/aws-sdk-forecastqueryservice/lib/aws-sdk-forecastqueryservice/client.rb
Overview
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.
See #initialize for a full list of supported configuration options.
Instance Attribute Summary
Attributes inherited from Seahorse::Client::Base
API Operations collapse
-
#query_forecast(params = {}) ⇒ Types::QueryForecastResponse
Retrieves a forecast for a single item, filtered by the supplied criteria.
Instance Method Summary collapse
-
#initialize(options) ⇒ Client
constructor
A new instance of Client.
Methods included from ClientStubs
#api_requests, #stub_data, #stub_responses
Methods inherited from Seahorse::Client::Base
add_plugin, api, clear_plugins, define, new, #operation_names, plugins, remove_plugin, set_api, set_plugins
Methods included from Seahorse::Client::HandlerBuilder
#handle, #handle_request, #handle_response
Constructor Details
#initialize(options) ⇒ Client
Returns a new instance of Client.
334 335 336 |
# File 'gems/aws-sdk-forecastqueryservice/lib/aws-sdk-forecastqueryservice/client.rb', line 334 def initialize(*args) super end |
Instance Method Details
#query_forecast(params = {}) ⇒ Types::QueryForecastResponse
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, 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 operation.
422 423 424 425 |
# File 'gems/aws-sdk-forecastqueryservice/lib/aws-sdk-forecastqueryservice/client.rb', line 422 def query_forecast(params = {}, = {}) req = build_request(:query_forecast, params) req.send_request() end |