import type { MetadataBearer as __MetadataBearer } from "@smithy/types"; import type { CreateForecastRequest, CreateForecastResponse } from "../models/models_0"; /** * @public */ export type { __MetadataBearer }; /** * @public * * The input for {@link CreateForecastCommand}. */ export interface CreateForecastCommandInput extends CreateForecastRequest { } /** * @public * * The output of {@link CreateForecastCommand}. */ export interface CreateForecastCommandOutput extends CreateForecastResponse, __MetadataBearer { } declare const CreateForecastCommand_base: { new (input: CreateForecastCommandInput): import("@smithy/core/client").CommandImpl; new (input: CreateForecastCommandInput): import("@smithy/core/client").CommandImpl; getEndpointParameterInstructions(): import("@smithy/types").EndpointParameterInstructions; }; /** *

Creates a forecast for each item in the TARGET_TIME_SERIES dataset that was * used to train the predictor. This is known as inference. To retrieve the forecast for a single * item at low latency, use the operation. To * export the complete forecast into your Amazon Simple Storage Service (Amazon S3) bucket, use the CreateForecastExportJob operation.

*

The range of the forecast is determined by the ForecastHorizon value, which * you specify in the CreatePredictor request. When you query a forecast, you * can request a specific date range within the forecast.

*

To get a list of all your forecasts, use the ListForecasts * operation.

* *

The forecasts generated by Amazon Forecast are in the same time zone as the dataset that was * used to create the predictor.

*
*

For more information, see howitworks-forecast.

* *

The Status of the forecast must be ACTIVE before you can query * or export the forecast. Use the DescribeForecast operation to get the * status.

*
*

By default, a forecast includes predictions for every item (item_id) in the dataset group that was used to train the predictor. * However, you can use the TimeSeriesSelector object to generate a forecast on a subset of time series. Forecast creation is skipped for any time series that you specify that are not in the input dataset. The forecast export file will not contain these time series or their forecasted values.

* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript * import { ForecastClient, CreateForecastCommand } from "@aws-sdk/client-forecast"; // ES Modules import * // const { ForecastClient, CreateForecastCommand } = require("@aws-sdk/client-forecast"); // CommonJS import * // import type { ForecastClientConfig } from "@aws-sdk/client-forecast"; * const config = {}; // type is ForecastClientConfig * const client = new ForecastClient(config); * const input = { // CreateForecastRequest * ForecastName: "STRING_VALUE", // required * PredictorArn: "STRING_VALUE", // required * ForecastTypes: [ // ForecastTypes * "STRING_VALUE", * ], * Tags: [ // Tags * { // Tag * Key: "STRING_VALUE", // required * Value: "STRING_VALUE", // required * }, * ], * TimeSeriesSelector: { // TimeSeriesSelector * TimeSeriesIdentifiers: { // TimeSeriesIdentifiers * DataSource: { // DataSource * S3Config: { // S3Config * Path: "STRING_VALUE", // required * RoleArn: "STRING_VALUE", // required * KMSKeyArn: "STRING_VALUE", * }, * }, * Schema: { // Schema * Attributes: [ // SchemaAttributes * { // SchemaAttribute * AttributeName: "STRING_VALUE", * AttributeType: "string" || "integer" || "float" || "timestamp" || "geolocation", * }, * ], * }, * Format: "STRING_VALUE", * }, * }, * }; * const command = new CreateForecastCommand(input); * const response = await client.send(command); * // { // CreateForecastResponse * // ForecastArn: "STRING_VALUE", * // }; * * ``` * * @param CreateForecastCommandInput - {@link CreateForecastCommandInput} * @returns {@link CreateForecastCommandOutput} * @see {@link CreateForecastCommandInput} for command's `input` shape. * @see {@link CreateForecastCommandOutput} for command's `response` shape. * @see {@link ForecastClientResolvedConfig | config} for ForecastClient's `config` shape. * * @throws {@link InvalidInputException} (client fault) *

We can't process the request because it includes an invalid value or a value that exceeds * the valid range.

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

The limit on the number of resources per account has been exceeded.

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

There is already a resource with this name. Try again with a different name.

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

The specified resource is in use.

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

We can't find a resource with that Amazon Resource Name (ARN). Check the ARN and try * again.

* * @throws {@link ForecastServiceException} *

Base exception class for all service exceptions from Forecast service.

* * * @public */ export declare class CreateForecastCommand extends CreateForecastCommand_base { /** @internal type navigation helper, not in runtime. */ protected static __types: { api: { input: CreateForecastRequest; output: CreateForecastResponse; }; sdk: { input: CreateForecastCommandInput; output: CreateForecastCommandOutput; }; }; }