@aws-sdk/client-forecast 3.154.0 → 3.155.0

package/dist-types/commands/DescribeWhatIfForecastCommand.d.ts

@@ -0,0 +1,57 @@
+import { Command as $Command } from "@aws-sdk/smithy-client";
+import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer, MiddlewareStack } from "@aws-sdk/types";
+import { ForecastClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ForecastClient";
+import { DescribeWhatIfForecastRequest, DescribeWhatIfForecastResponse } from "../models/models_0";
+export interface DescribeWhatIfForecastCommandInput extends DescribeWhatIfForecastRequest {
+}
+export interface DescribeWhatIfForecastCommandOutput extends DescribeWhatIfForecastResponse, __MetadataBearer {
+}
+/**
+ * <p>Describes the what-if forecast created using the <a>CreateWhatIfForecast</a> operation.</p>
+ *          <p>In addition to listing the properties provided in the <code>CreateWhatIfForecast</code> request, this operation lists the following properties:</p>
+ *          <ul>
+ *             <li>
+ *                <p>
+ *                   <code>CreationTime</code>
+ *                </p>
+ *             </li>
+ *             <li>
+ *                <p>
+ *                   <code>LastModificationTime</code>
+ *                </p>
+ *             </li>
+ *             <li>
+ *                <p>
+ *                   <code>Message</code> - If an error occurred, information about the error.</p>
+ *             </li>
+ *             <li>
+ *                <p>
+ *                   <code>Status</code>
+ *                </p>
+ *             </li>
+ *          </ul>
+ * @example
+ * Use a bare-bones client and the command you need to make an API call.
+ * ```javascript
+ * import { ForecastClient, DescribeWhatIfForecastCommand } from "@aws-sdk/client-forecast"; // ES Modules import
+ * // const { ForecastClient, DescribeWhatIfForecastCommand } = require("@aws-sdk/client-forecast"); // CommonJS import
+ * const client = new ForecastClient(config);
+ * const command = new DescribeWhatIfForecastCommand(input);
+ * const response = await client.send(command);
+ * ```
+ *
+ * @see {@link DescribeWhatIfForecastCommandInput} for command's `input` shape.
+ * @see {@link DescribeWhatIfForecastCommandOutput} for command's `response` shape.
+ * @see {@link ForecastClientResolvedConfig | config} for ForecastClient's `config` shape.
+ *
+ */
+export declare class DescribeWhatIfForecastCommand extends $Command<DescribeWhatIfForecastCommandInput, DescribeWhatIfForecastCommandOutput, ForecastClientResolvedConfig> {
+    readonly input: DescribeWhatIfForecastCommandInput;
+    constructor(input: DescribeWhatIfForecastCommandInput);
+    /**
+     * @internal
+     */
+    resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: ForecastClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DescribeWhatIfForecastCommandInput, DescribeWhatIfForecastCommandOutput>;
+    private serialize;
+    private deserialize;
+}

package/dist-types/commands/DescribeWhatIfForecastExportCommand.d.ts

@@ -0,0 +1,57 @@
+import { Command as $Command } from "@aws-sdk/smithy-client";
+import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer, MiddlewareStack } from "@aws-sdk/types";
+import { ForecastClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ForecastClient";
+import { DescribeWhatIfForecastExportRequest, DescribeWhatIfForecastExportResponse } from "../models/models_0";
+export interface DescribeWhatIfForecastExportCommandInput extends DescribeWhatIfForecastExportRequest {
+}
+export interface DescribeWhatIfForecastExportCommandOutput extends DescribeWhatIfForecastExportResponse, __MetadataBearer {
+}
+/**
+ * <p>Describes the what-if forecast export created using the <a>CreateWhatIfForecastExport</a> operation.</p>
+ *          <p>In addition to listing the properties provided in the <code>CreateWhatIfForecastExport</code> request, this operation lists the following properties:</p>
+ *          <ul>
+ *             <li>
+ *                <p>
+ *                   <code>CreationTime</code>
+ *                </p>
+ *             </li>
+ *             <li>
+ *                <p>
+ *                   <code>LastModificationTime</code>
+ *                </p>
+ *             </li>
+ *             <li>
+ *                <p>
+ *                   <code>Message</code> - If an error occurred, information about the error.</p>
+ *             </li>
+ *             <li>
+ *                <p>
+ *                   <code>Status</code>
+ *                </p>
+ *             </li>
+ *          </ul>
+ * @example
+ * Use a bare-bones client and the command you need to make an API call.
+ * ```javascript
+ * import { ForecastClient, DescribeWhatIfForecastExportCommand } from "@aws-sdk/client-forecast"; // ES Modules import
+ * // const { ForecastClient, DescribeWhatIfForecastExportCommand } = require("@aws-sdk/client-forecast"); // CommonJS import
+ * const client = new ForecastClient(config);
+ * const command = new DescribeWhatIfForecastExportCommand(input);
+ * const response = await client.send(command);
+ * ```
+ *
+ * @see {@link DescribeWhatIfForecastExportCommandInput} for command's `input` shape.
+ * @see {@link DescribeWhatIfForecastExportCommandOutput} for command's `response` shape.
+ * @see {@link ForecastClientResolvedConfig | config} for ForecastClient's `config` shape.
+ *
+ */
+export declare class DescribeWhatIfForecastExportCommand extends $Command<DescribeWhatIfForecastExportCommandInput, DescribeWhatIfForecastExportCommandOutput, ForecastClientResolvedConfig> {
+    readonly input: DescribeWhatIfForecastExportCommandInput;
+    constructor(input: DescribeWhatIfForecastExportCommandInput);
+    /**
+     * @internal
+     */
+    resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: ForecastClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DescribeWhatIfForecastExportCommandInput, DescribeWhatIfForecastExportCommandOutput>;
+    private serialize;
+    private deserialize;
+}

package/dist-types/commands/ListWhatIfAnalysesCommand.d.ts

@@ -0,0 +1,35 @@
+import { Command as $Command } from "@aws-sdk/smithy-client";
+import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer, MiddlewareStack } from "@aws-sdk/types";
+import { ForecastClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ForecastClient";
+import { ListWhatIfAnalysesRequest, ListWhatIfAnalysesResponse } from "../models/models_0";
+export interface ListWhatIfAnalysesCommandInput extends ListWhatIfAnalysesRequest {
+}
+export interface ListWhatIfAnalysesCommandOutput extends ListWhatIfAnalysesResponse, __MetadataBearer {
+}
+/**
+ * <p>Returns a list of what-if analyses created using the <a>CreateWhatIfAnalysis</a> operation. For each what-if analysis, this operation returns a summary of its properties, including its Amazon Resource Name (ARN). You can retrieve the complete set of properties by using the what-if analysis ARN with the <a>DescribeWhatIfAnalysis</a> operation.</p>
+ * @example
+ * Use a bare-bones client and the command you need to make an API call.
+ * ```javascript
+ * import { ForecastClient, ListWhatIfAnalysesCommand } from "@aws-sdk/client-forecast"; // ES Modules import
+ * // const { ForecastClient, ListWhatIfAnalysesCommand } = require("@aws-sdk/client-forecast"); // CommonJS import
+ * const client = new ForecastClient(config);
+ * const command = new ListWhatIfAnalysesCommand(input);
+ * const response = await client.send(command);
+ * ```
+ *
+ * @see {@link ListWhatIfAnalysesCommandInput} for command's `input` shape.
+ * @see {@link ListWhatIfAnalysesCommandOutput} for command's `response` shape.
+ * @see {@link ForecastClientResolvedConfig | config} for ForecastClient's `config` shape.
+ *
+ */
+export declare class ListWhatIfAnalysesCommand extends $Command<ListWhatIfAnalysesCommandInput, ListWhatIfAnalysesCommandOutput, ForecastClientResolvedConfig> {
+    readonly input: ListWhatIfAnalysesCommandInput;
+    constructor(input: ListWhatIfAnalysesCommandInput);
+    /**
+     * @internal
+     */
+    resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: ForecastClientResolvedConfig, options?: __HttpHandlerOptions): Handler<ListWhatIfAnalysesCommandInput, ListWhatIfAnalysesCommandOutput>;
+    private serialize;
+    private deserialize;
+}

package/dist-types/commands/ListWhatIfForecastExportsCommand.d.ts

@@ -0,0 +1,35 @@
+import { Command as $Command } from "@aws-sdk/smithy-client";
+import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer, MiddlewareStack } from "@aws-sdk/types";
+import { ForecastClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ForecastClient";
+import { ListWhatIfForecastExportsRequest, ListWhatIfForecastExportsResponse } from "../models/models_0";
+export interface ListWhatIfForecastExportsCommandInput extends ListWhatIfForecastExportsRequest {
+}
+export interface ListWhatIfForecastExportsCommandOutput extends ListWhatIfForecastExportsResponse, __MetadataBearer {
+}
+/**
+ * <p>Returns a list of what-if forecast exports created using the <a>CreateWhatIfForecastExport</a> operation. For each what-if forecast export, this operation returns a summary of its properties, including its Amazon Resource Name (ARN). You can retrieve the complete set of properties by using the what-if forecast export ARN with the <a>DescribeWhatIfForecastExport</a> operation.</p>
+ * @example
+ * Use a bare-bones client and the command you need to make an API call.
+ * ```javascript
+ * import { ForecastClient, ListWhatIfForecastExportsCommand } from "@aws-sdk/client-forecast"; // ES Modules import
+ * // const { ForecastClient, ListWhatIfForecastExportsCommand } = require("@aws-sdk/client-forecast"); // CommonJS import
+ * const client = new ForecastClient(config);
+ * const command = new ListWhatIfForecastExportsCommand(input);
+ * const response = await client.send(command);
+ * ```
+ *
+ * @see {@link ListWhatIfForecastExportsCommandInput} for command's `input` shape.
+ * @see {@link ListWhatIfForecastExportsCommandOutput} for command's `response` shape.
+ * @see {@link ForecastClientResolvedConfig | config} for ForecastClient's `config` shape.
+ *
+ */
+export declare class ListWhatIfForecastExportsCommand extends $Command<ListWhatIfForecastExportsCommandInput, ListWhatIfForecastExportsCommandOutput, ForecastClientResolvedConfig> {
+    readonly input: ListWhatIfForecastExportsCommandInput;
+    constructor(input: ListWhatIfForecastExportsCommandInput);
+    /**
+     * @internal
+     */
+    resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: ForecastClientResolvedConfig, options?: __HttpHandlerOptions): Handler<ListWhatIfForecastExportsCommandInput, ListWhatIfForecastExportsCommandOutput>;
+    private serialize;
+    private deserialize;
+}

package/dist-types/commands/ListWhatIfForecastsCommand.d.ts

@@ -0,0 +1,35 @@
+import { Command as $Command } from "@aws-sdk/smithy-client";
+import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer, MiddlewareStack } from "@aws-sdk/types";
+import { ForecastClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ForecastClient";
+import { ListWhatIfForecastsRequest, ListWhatIfForecastsResponse } from "../models/models_0";
+export interface ListWhatIfForecastsCommandInput extends ListWhatIfForecastsRequest {
+}
+export interface ListWhatIfForecastsCommandOutput extends ListWhatIfForecastsResponse, __MetadataBearer {
+}
+/**
+ * <p>Returns a list of what-if forecasts created using the <a>CreateWhatIfForecast</a> operation. For each what-if forecast, this operation returns a summary of its properties, including its Amazon Resource Name (ARN). You can retrieve the complete set of properties by using the what-if forecast ARN with the <a>DescribeWhatIfForecast</a> operation.</p>
+ * @example
+ * Use a bare-bones client and the command you need to make an API call.
+ * ```javascript
+ * import { ForecastClient, ListWhatIfForecastsCommand } from "@aws-sdk/client-forecast"; // ES Modules import
+ * // const { ForecastClient, ListWhatIfForecastsCommand } = require("@aws-sdk/client-forecast"); // CommonJS import
+ * const client = new ForecastClient(config);
+ * const command = new ListWhatIfForecastsCommand(input);
+ * const response = await client.send(command);
+ * ```
+ *
+ * @see {@link ListWhatIfForecastsCommandInput} for command's `input` shape.
+ * @see {@link ListWhatIfForecastsCommandOutput} for command's `response` shape.
+ * @see {@link ForecastClientResolvedConfig | config} for ForecastClient's `config` shape.
+ *
+ */
+export declare class ListWhatIfForecastsCommand extends $Command<ListWhatIfForecastsCommandInput, ListWhatIfForecastsCommandOutput, ForecastClientResolvedConfig> {
+    readonly input: ListWhatIfForecastsCommandInput;
+    constructor(input: ListWhatIfForecastsCommandInput);
+    /**
+     * @internal
+     */
+    resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: ForecastClientResolvedConfig, options?: __HttpHandlerOptions): Handler<ListWhatIfForecastsCommandInput, ListWhatIfForecastsCommandOutput>;
+    private serialize;
+    private deserialize;
+}

package/dist-types/commands/index.d.ts

@@ -9,6 +9,9 @@ export * from "./CreateForecastExportJobCommand";
 export * from "./CreateMonitorCommand";
 export * from "./CreatePredictorBacktestExportJobCommand";
 export * from "./CreatePredictorCommand";
+export * from "./CreateWhatIfAnalysisCommand";
+export * from "./CreateWhatIfForecastCommand";
+export * from "./CreateWhatIfForecastExportCommand";
 export * from "./DeleteDatasetCommand";
 export * from "./DeleteDatasetGroupCommand";
 export * from "./DeleteDatasetImportJobCommand";
@@ -20,6 +23,9 @@ export * from "./DeleteMonitorCommand";
 export * from "./DeletePredictorBacktestExportJobCommand";
 export * from "./DeletePredictorCommand";
 export * from "./DeleteResourceTreeCommand";
+export * from "./DeleteWhatIfAnalysisCommand";
+export * from "./DeleteWhatIfForecastCommand";
+export * from "./DeleteWhatIfForecastExportCommand";
 export * from "./DescribeAutoPredictorCommand";
 export * from "./DescribeDatasetCommand";
 export * from "./DescribeDatasetGroupCommand";
@@ -31,6 +37,9 @@ export * from "./DescribeForecastExportJobCommand";
 export * from "./DescribeMonitorCommand";
 export * from "./DescribePredictorBacktestExportJobCommand";
 export * from "./DescribePredictorCommand";
+export * from "./DescribeWhatIfAnalysisCommand";
+export * from "./DescribeWhatIfForecastCommand";
+export * from "./DescribeWhatIfForecastExportCommand";
 export * from "./GetAccuracyMetricsCommand";
 export * from "./ListDatasetGroupsCommand";
 export * from "./ListDatasetImportJobsCommand";
@@ -44,6 +53,9 @@ export * from "./ListMonitorsCommand";
 export * from "./ListPredictorBacktestExportJobsCommand";
 export * from "./ListPredictorsCommand";
 export * from "./ListTagsForResourceCommand";
+export * from "./ListWhatIfAnalysesCommand";
+export * from "./ListWhatIfForecastExportsCommand";
+export * from "./ListWhatIfForecastsCommand";
 export * from "./ResumeResourceCommand";
 export * from "./StopResourceCommand";
 export * from "./TagResourceCommand";