ForecastService / Client / delete_what_if_analysis

delete_what_if_analysis#

ForecastService.Client.delete_what_if_analysis(**kwargs)#

Deletes a what-if analysis created using the CreateWhatIfAnalysis operation. You can delete only what-if analyses that have a status of ACTIVE or CREATE_FAILED. To get the status, use the DescribeWhatIfAnalysis operation.

You can’t delete a what-if analysis while any of its forecasts are being exported.

See also: AWS API Documentation

Request Syntax

response = client.delete_what_if_analysis(
    WhatIfAnalysisArn='string'
)
Parameters:

WhatIfAnalysisArn (string) –

[REQUIRED]

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

Returns:

None

Exceptions

  • ForecastService.Client.exceptions.InvalidInputException

  • ForecastService.Client.exceptions.ResourceNotFoundException

  • ForecastService.Client.exceptions.ResourceInUseException