ForecastService / Client / delete_what_if_forecast

delete_what_if_forecast#

ForecastService.Client.delete_what_if_forecast(**kwargs)#

Deletes a what-if forecast created using the CreateWhatIfForecast operation. You can delete only what-if forecasts that have a status of ACTIVE or CREATE_FAILED. To get the status, use the DescribeWhatIfForecast operation.

You can’t delete a what-if forecast while it is being exported. After a what-if forecast is deleted, you can no longer query the what-if analysis.

See also: AWS API Documentation

Request Syntax

response = client.delete_what_if_forecast(
    WhatIfForecastArn='string'
)
Parameters:

WhatIfForecastArn (string) –

[REQUIRED]

The Amazon Resource Name (ARN) of the what-if forecast that you want to delete.

Returns:

None

Exceptions

  • ForecastService.Client.exceptions.InvalidInputException

  • ForecastService.Client.exceptions.ResourceNotFoundException

  • ForecastService.Client.exceptions.ResourceInUseException