Query What If Forecast

forecastqueryservice_query_what_if_forecast

R Documentation

Retrieves a what-if forecast¶

Description¶

Retrieves a what-if forecast.

Usage¶

forecastqueryservice_query_what_if_forecast(WhatIfForecastArn,
  StartDate, EndDate, Filters, NextToken)

Arguments¶

WhatIfForecastArn

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

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.

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.

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 what-if 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_what_if_forecast(
  WhatIfForecastArn = "string",
  StartDate = "string",
  EndDate = "string",
  Filters = list(
    "string"
  ),
  NextToken = "string"
)