ForecastService / Client / stop_resource

stop_resource#

ForecastService.Client.stop_resource(**kwargs)#

Stops a resource.

The resource undergoes the following states: CREATE_STOPPING and CREATE_STOPPED. You cannot resume a resource once it has been stopped.

This operation can be applied to the following resources (and their corresponding child resources):

  • Dataset Import Job

  • Predictor Job

  • Forecast Job

  • Forecast Export Job

  • Predictor Backtest Export Job

  • Explainability Job

  • Explainability Export Job

See also: AWS API Documentation

Request Syntax

response = client.stop_resource(
    ResourceArn='string'
)
Parameters:

ResourceArn (string) –

[REQUIRED]

The Amazon Resource Name (ARN) that identifies the resource to stop. The supported ARNs are DatasetImportJobArn, PredictorArn, PredictorBacktestExportJobArn, ForecastArn, ForecastExportJobArn, ExplainabilityArn, and ExplainabilityExportArn.

Returns:

None

Exceptions

  • ForecastService.Client.exceptions.InvalidInputException

  • ForecastService.Client.exceptions.LimitExceededException

  • ForecastService.Client.exceptions.ResourceNotFoundException