- Navigation GuideYou are on a Command (operation) page with structural examples. Use the navigation breadcrumb if you would like to return to the Client landing page.
DeleteForecastCommand
Deletes a forecast created using the CreateForecast operation. You can delete only forecasts that have a status of ACTIVE or CREATE_FAILED. To get the status, use the DescribeForecast operation.
You can't delete a forecast while it is being exported. After a forecast is deleted, you can no longer query the forecast.
Example Syntax
Use a bare-bones client and the command you need to make an API call.
import { ForecastClient, DeleteForecastCommand } from "@aws-sdk/client-forecast"; // ES Modules import
// const { ForecastClient, DeleteForecastCommand } = require("@aws-sdk/client-forecast"); // CommonJS import
const client = new ForecastClient(config);
const input = { // DeleteForecastRequest
ForecastArn: "STRING_VALUE", // required
};
const command = new DeleteForecastCommand(input);
const response = await client.send(command);
// {};
DeleteForecastCommand Input
See DeleteForecastCommandInput for more details
Parameter | Type | Description |
|---|
Parameter | Type | Description |
|---|---|---|
ForecastArnRequired | string | undefined | The Amazon Resource Name (ARN) of the forecast to delete. |
DeleteForecastCommand Output
See DeleteForecastCommandOutput for details
Parameter | Type | Description |
|---|
Parameter | Type | Description |
|---|---|---|
$metadataRequired | ResponseMetadata | Metadata pertaining to this request. |
Throws
Name | Fault | Details |
|---|
Name | Fault | Details |
|---|---|---|
| InvalidInputException | client | We can't process the request because it includes an invalid value or a value that exceeds the valid range. |
| ResourceInUseException | client | The specified resource is in use. |
| ResourceNotFoundException | client | We can't find a resource with that Amazon Resource Name (ARN). Check the ARN and try again. |
| ForecastServiceException | Base exception class for all service exceptions from Forecast service. |