StopCalculationExecution
Requests the cancellation of a calculation. A StopCalculationExecution
call on a calculation that is already in a terminal state (for example,
STOPPED, FAILED, or COMPLETED) succeeds but
has no effect.
Note
Cancelling a calculation is done on a best effort basis. If a calculation cannot be cancelled, you can be charged for its completion. If you are concerned about being charged for a calculation that cannot be cancelled, consider terminating the session in which the calculation is running.
Request Syntax
{
"CalculationExecutionId": "string"
}Request Parameters
For information about the parameters that are common to all actions, see Common Parameters.
The request accepts the following data in JSON format.
- CalculationExecutionId
-
The calculation execution UUID.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 36.
Required: Yes
Response Syntax
{
"State": "string"
}Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
- State
-
CREATING- The calculation is in the process of being created.CREATED- The calculation has been created and is ready to run.QUEUED- The calculation has been queued for processing.RUNNING- The calculation is running.CANCELING- A request to cancel the calculation has been received and the system is working to stop it.CANCELED- The calculation is no longer running as the result of a cancel request.COMPLETED- The calculation has completed without error.FAILED- The calculation failed and is no longer running.Type: String
Valid Values:
CREATING | CREATED | QUEUED | RUNNING | CANCELING | CANCELED | COMPLETED | FAILED
Errors
For information about the errors that are common to all actions, see Common Errors.
- InternalServerException
-
Indicates a platform issue, which may be due to a transient condition or outage.
HTTP Status Code: 500
- InvalidRequestException
-
Indicates that something is wrong with the input to the request. For example, a required parameter may be missing or out of range.
HTTP Status Code: 400
- ResourceNotFoundException
-
A resource, such as a workgroup, was not found.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
