import type { MetadataBearer as __MetadataBearer } from "@smithy/types"; import type { QueryForecastRequest, QueryForecastResponse } from "../models/models_0"; /** * @public */ export type { __MetadataBearer }; /** * @public * * The input for {@link QueryForecastCommand}. */ export interface QueryForecastCommandInput extends QueryForecastRequest { } /** * @public * * The output of {@link QueryForecastCommand}. */ export interface QueryForecastCommandOutput extends QueryForecastResponse, __MetadataBearer { } declare const QueryForecastCommand_base: { new (input: QueryForecastCommandInput): import("@smithy/core/client").CommandImpl; new (input: QueryForecastCommandInput): import("@smithy/core/client").CommandImpl; getEndpointParameterInstructions(): import("@smithy/types").EndpointParameterInstructions; }; /** *

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. * ```javascript * import { ForecastqueryClient, QueryForecastCommand } from "@aws-sdk/client-forecastquery"; // ES Modules import * // const { ForecastqueryClient, QueryForecastCommand } = require("@aws-sdk/client-forecastquery"); // CommonJS import * // import type { ForecastqueryClientConfig } from "@aws-sdk/client-forecastquery"; * const config = {}; // type is ForecastqueryClientConfig * const client = new ForecastqueryClient(config); * const input = { // QueryForecastRequest * ForecastArn: "STRING_VALUE", // required * StartDate: "STRING_VALUE", * EndDate: "STRING_VALUE", * Filters: { // Filters // required * "": "STRING_VALUE", * }, * NextToken: "STRING_VALUE", * }; * const command = new QueryForecastCommand(input); * const response = await client.send(command); * // { // QueryForecastResponse * // Forecast: { // Forecast * // Predictions: { // Predictions * // "": [ // TimeSeries * // { // DataPoint * // Timestamp: "STRING_VALUE", * // Value: Number("double"), * // }, * // ], * // }, * // }, * // }; * * ``` * * @param QueryForecastCommandInput - {@link QueryForecastCommandInput} * @returns {@link QueryForecastCommandOutput} * @see {@link QueryForecastCommandInput} for command's `input` shape. * @see {@link QueryForecastCommandOutput} for command's `response` shape. * @see {@link ForecastqueryClientResolvedConfig | config} for ForecastqueryClient's `config` shape. * * @throws {@link InvalidInputException} (client fault) *

The value is invalid or is too long.

* * @throws {@link InvalidNextTokenException} (client fault) *

The token is not valid. Tokens expire after 24 hours.

* * @throws {@link LimitExceededException} (client fault) *

The limit on the number of requests per second has been exceeded.

* * @throws {@link ResourceInUseException} (client fault) *

The specified resource is in use.

* * @throws {@link ResourceNotFoundException} (client fault) *

We can't find that resource. Check the information that you've provided and try * again.

* * @throws {@link ForecastqueryServiceException} *

Base exception class for all service exceptions from Forecastquery service.

* * * @public */ export declare class QueryForecastCommand extends QueryForecastCommand_base { /** @internal type navigation helper, not in runtime. */ protected static __types: { api: { input: QueryForecastRequest; output: QueryForecastResponse; }; sdk: { input: QueryForecastCommandInput; output: QueryForecastCommandOutput; }; }; }