Skip to contents

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

Source: R/forecastqueryservice_operations.R
forecastqueryservice_query_forecast.Rd

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

See https://www.paws-r-sdk.com/docs/forecastqueryservice_query_forecast/ for full documentation.

Usage

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

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.