Forecastquery

query_forecast(filters, forecast_arn)
query_forecast(filters, forecast_arn, params::Dict{String,<:Any})

Retrieves a forecast for a single item, filtered by the supplied criteria. The criteria is a key-value pair. The key is either itemid (or the equivalent non-timestamp, non-target field) from the TARGETTIME_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.

Arguments

• filters: The filtering criteria to apply when retrieving the forecast. For example, to get the forecast for client21 in the electricity usage dataset, specify the following: {"itemid" : "client_21"} To get the full forecast, use the CreateForecastExportJob operation.
• forecast_arn: The Amazon Resource Name (ARN) of the forecast to query.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "EndDate": The end date for the forecast. Specify the date using this format: yyyy-MM-dd'T'HH:mm:ss (ISO 8601 format). For example, 2015-01-01T20:00:00.
• "NextToken": 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.
• "StartDate": The start date for the forecast. Specify the date using this format: yyyy-MM-dd'T'HH:mm:ss (ISO 8601 format). For example, 2015-01-01T08:00:00.

query_what_if_forecast(filters, what_if_forecast_arn)
query_what_if_forecast(filters, what_if_forecast_arn, params::Dict{String,<:Any})

Retrieves a what-if forecast.

Arguments

• filters: The filtering criteria to apply when retrieving the forecast. For example, to get the forecast for client21 in the electricity usage dataset, specify the following: {"itemid" : "client_21"} To get the full what-if forecast, use the CreateForecastExportJob operation.
• what_if_forecast_arn: The Amazon Resource Name (ARN) of the what-if forecast to query.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "EndDate": 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.
• "NextToken": 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.
• "StartDate": 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.