/AWS1/CL_FCQ=>QUERYFORECAST()

About QueryForecast

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.

Method Signature

IMPORTING

Required arguments:

IV_FORECASTARN TYPE /AWS1/FCQARN /AWS1/FCQARN

The Amazon Resource Name (ARN) of the forecast to query.

IT_FILTERS TYPE /AWS1/CL_FCQFILTERS_W=>TT_FILTERS TT_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 forecast, use the CreateForecastExportJob operation.

Optional arguments:

IV_STARTDATE TYPE /AWS1/FCQDATETIME /AWS1/FCQDATETIME

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.

IV_ENDDATE TYPE /AWS1/FCQDATETIME /AWS1/FCQDATETIME

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.

IV_NEXTTOKEN TYPE /AWS1/FCQNEXTTOKEN /AWS1/FCQNEXTTOKEN

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.

RETURNING

OO_OUTPUT TYPE REF TO /AWS1/CL_FCQQUERYFCRESPONSE /AWS1/CL_FCQQUERYFCRESPONSE