Query Forecast

forecastqueryservice_query_forecast

R Documentation

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

Description

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, query_forecast 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.

Usage

forecastqueryservice_query_forecast(ForecastArn, StartDate, EndDate,
  Filters, NextToken)

Arguments

ForecastArn

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

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.

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.

Filters

[required] 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.

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.

Value

A list with the following syntax:

list(
  Forecast = list(
    Predictions = list(
      list(
        list(
          Timestamp = "string",
          Value = 123.0
        )
      )
    )
  )
)

Request syntax

svc$query_forecast(
  ForecastArn = "string",
  StartDate = "string",
  EndDate = "string",
  Filters = list(
    "string"
  ),
  NextToken = "string"
)