import type { MetadataBearer as __MetadataBearer } from "@smithy/types"; import type { CreateWhatIfAnalysisRequest, CreateWhatIfAnalysisResponse } from "../models/models_0"; /** * @public */ export type { __MetadataBearer }; /** * @public * * The input for {@link CreateWhatIfAnalysisCommand}. */ export interface CreateWhatIfAnalysisCommandInput extends CreateWhatIfAnalysisRequest { } /** * @public * * The output of {@link CreateWhatIfAnalysisCommand}. */ export interface CreateWhatIfAnalysisCommandOutput extends CreateWhatIfAnalysisResponse, __MetadataBearer { } declare const CreateWhatIfAnalysisCommand_base: { new (input: CreateWhatIfAnalysisCommandInput): import("@smithy/core/client").CommandImpl; new (input: CreateWhatIfAnalysisCommandInput): import("@smithy/core/client").CommandImpl; getEndpointParameterInstructions(): import("@smithy/types").EndpointParameterInstructions; }; /** *

What-if analysis is a scenario modeling technique where you make a hypothetical change to a time series and * compare the forecasts generated by these changes against the baseline, unchanged time series. It is important to * remember that the purpose of a what-if analysis is to understand how a forecast can change given different * modifications to the baseline time series.

*

For example, imagine you are a clothing retailer who is considering an end of season sale * to clear space for new styles. After creating a baseline forecast, you can use a what-if * analysis to investigate how different sales tactics might affect your goals.

*

You could create a scenario where everything is given a 25% markdown, and another where * everything is given a fixed dollar markdown. You could create a scenario where the sale lasts for one week and * another where the sale lasts for one month. * With a what-if analysis, you can compare many different scenarios against each other.

*

Note that a what-if analysis is meant to display what the forecasting model has learned and how it will behave in the scenarios that you are evaluating. Do not blindly use the results of the what-if analysis to make business decisions. For instance, forecasts might not be accurate for novel scenarios where there is no reference available to determine whether a forecast is good.

*

The TimeSeriesSelector object defines the items that you want in the what-if analysis.

* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript * import { ForecastClient, CreateWhatIfAnalysisCommand } from "@aws-sdk/client-forecast"; // ES Modules import * // const { ForecastClient, CreateWhatIfAnalysisCommand } = 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 = { // CreateWhatIfAnalysisRequest * WhatIfAnalysisName: "STRING_VALUE", // required * ForecastArn: "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", * }, * }, * Tags: [ // Tags * { // Tag * Key: "STRING_VALUE", // required * Value: "STRING_VALUE", // required * }, * ], * }; * const command = new CreateWhatIfAnalysisCommand(input); * const response = await client.send(command); * // { // CreateWhatIfAnalysisResponse * // WhatIfAnalysisArn: "STRING_VALUE", * // }; * * ``` * * @param CreateWhatIfAnalysisCommandInput - {@link CreateWhatIfAnalysisCommandInput} * @returns {@link CreateWhatIfAnalysisCommandOutput} * @see {@link CreateWhatIfAnalysisCommandInput} for command's `input` shape. * @see {@link CreateWhatIfAnalysisCommandOutput} 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 CreateWhatIfAnalysisCommand extends CreateWhatIfAnalysisCommand_base { /** @internal type navigation helper, not in runtime. */ protected static __types: { api: { input: CreateWhatIfAnalysisRequest; output: CreateWhatIfAnalysisResponse; }; sdk: { input: CreateWhatIfAnalysisCommandInput; output: CreateWhatIfAnalysisCommandOutput; }; }; }