aws-elixir

View Source AWS.Forecastquery (aws-elixir v1.0.4)

Provides APIs for creating and managing Amazon Forecast resources.

Link to this section Summary

Functions

metadata()
query_forecast(client, input, options \\ [])

Retrieves a forecast for a single item, filtered by the supplied criteria.

query_what_if_forecast(client, input, options \\ [])

Retrieves a what-if forecast.

Link to this section Functions

Link to this function

metadata()

View Source
Link to this function

query_forecast(client, input, options \\ [])

View Source

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.

The forecasts generated by Amazon Forecast are in the same timezone as the dataset that was used to create the predictor.

Link to this function

query_what_if_forecast(client, input, options \\ [])

View Source

Retrieves a what-if forecast.