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.
Parameters:
-
forecast_arn
(Arn)
–
The Amazon Resource Name (ARN) of the forecast to delete.
Raises:
Source code in docs_src/capo_forecast/_services/forecast.py
| def delete_forecast(
self,
forecast_arn: "capo_forecast.types.arn.Arn",
*,
config_overrides: Optional[forecastClientConfig] = None,
) -> None:
"""<p>Deletes a forecast created using the <a>CreateForecast</a> operation. You can delete only forecasts that have a status of <code>ACTIVE</code> or <code>CREATE_FAILED</code>. To get the status, use the <a>DescribeForecast</a> operation.</p> <p>You can't delete a forecast while it is being exported. After a forecast is deleted, you can no longer query the forecast.</p>
Args:
forecast_arn: <p>The Amazon Resource Name (ARN) of the forecast to delete.</p>
Raises:
capo_forecast.errors.invalid_input_exception.InvalidInputException: <p>We can't process the request because it includes an invalid value or a value that exceeds the valid range.</p>
capo_forecast.errors.resource_in_use_exception.ResourceInUseException: <p>The specified resource is in use.</p>
capo_forecast.errors.resource_not_found_exception.ResourceNotFoundException: <p>We can't find a resource with that Amazon Resource Name (ARN). Check the ARN and try again.</p>
capo_forecast.errors.UnknownServiceError: The service returned an error code this client does not model.
"""
def _handler(
req: "OperationRequest[capo_forecast.types.delete_forecast_request.DeleteForecastRequest]",
) -> OperationResponse[None]:
import capo_forecast._operations.amazon_forecast.delete_forecast
output, http_response = (
capo_forecast._operations.amazon_forecast.delete_forecast.delete_forecast(
req.options, req.input
)
)
return OperationResponse(output=output, response=http_response)
interceptors_, options_ = self.operation_options(
config_overrides, OperationLogging("DeleteForecast")
)
input_: capo_forecast.types.delete_forecast_request.DeleteForecastRequest = {
"forecast_arn": forecast_arn
}
response = execute_pipeline(
OperationRequest(input=input_, options=options_),
handler=_handler,
interceptors=list(interceptors_),
)
response.response.close()
return response.output
|