Packages
aws
0.10.0
1.0.14
1.0.13
1.0.12
1.0.11
1.0.10
1.0.9
1.0.8
1.0.7
1.0.6
1.0.5
1.0.4
1.0.3
1.0.2
1.0.1
1.0.0
0.14.1
0.14.0
0.13.3
0.13.2
0.13.1
0.13.0
0.12.0
0.11.0
0.10.1
0.10.0
0.9.2
0.9.1
0.9.0
0.8.0
0.7.0
0.6.0
0.5.0
0.4.0
0.3.0
0.2.0
0.1.0
0.0.12
0.0.11
0.0.10
0.0.9
0.0.8
0.0.7
0.0.6
0.0.5
0.0.4
0.0.3
0.0.2
0.0.1
AWS clients for Elixir
Current section
Files
Jump to
Current section
Files
lib/aws/generated/forecastquery.ex
# WARNING: DO NOT EDIT, AUTO-GENERATED CODE!
# See https://github.com/aws-beam/aws-codegen for more details.
defmodule AWS.Forecastquery do
@moduledoc """
Provides APIs for creating and managing Amazon Forecast resources.
"""
alias AWS.Client
alias AWS.Request
def metadata do
%AWS.ServiceMetadata{
abbreviation: nil,
api_version: "2018-06-26",
content_type: "application/x-amz-json-1.1",
credential_scope: nil,
endpoint_prefix: "forecastquery",
global?: false,
protocol: "json",
service_id: "forecastquery",
signature_version: "v4",
signing_name: "forecast",
target_prefix: "AmazonForecastRuntime"
}
end
@doc """
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](https://docs.aws.amazon.com/en_us/forecast/latest/dg/API_CreateForecastExportJob.html)
operation.
The forecasts generated by Amazon Forecast are in the same timezone as the
dataset that was used to create the predictor.
"""
def query_forecast(%Client{} = client, input, options \\ []) do
Request.request_post(client, metadata(), "QueryForecast", input, options)
end
end