Options
All
  • Public
  • Public/Protected
  • All
Menu

Class QueryForecastCommand

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.

example

Use a bare-bones client and the command you need to make an API call.

import { ForecastqueryClient, QueryForecastCommand } from "@aws-sdk/client-forecastquery"; // ES Modules import
// const { ForecastqueryClient, QueryForecastCommand } = require("@aws-sdk/client-forecastquery"); // CommonJS import
const client = new ForecastqueryClient(config);
const command = new QueryForecastCommand(input);
const response = await client.send(command);
see

QueryForecastCommandInput for command's input shape.

see

QueryForecastCommandOutput for command's response shape.

see

config for ForecastqueryClient's config shape.

Hierarchy

Implements

Index

Constructors

constructor

Properties

Readonly input

input: QueryForecastCommandInput

Readonly middlewareStack

middlewareStack: IMiddlewareStack<QueryForecastCommandInput, QueryForecastCommandOutput>

Methods

Static getEndpointParameterInstructions