Copyright | (c) 2013-2023 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | Safe-Inferred |
Language | Haskell2010 |
Amazonka.Athena.StopCalculationExecution
Description
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.
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.
Synopsis
- data StopCalculationExecution = StopCalculationExecution' {}
- newStopCalculationExecution :: Text -> StopCalculationExecution
- stopCalculationExecution_calculationExecutionId :: Lens' StopCalculationExecution Text
- data StopCalculationExecutionResponse = StopCalculationExecutionResponse' {}
- newStopCalculationExecutionResponse :: Int -> StopCalculationExecutionResponse
- stopCalculationExecutionResponse_state :: Lens' StopCalculationExecutionResponse (Maybe CalculationExecutionState)
- stopCalculationExecutionResponse_httpStatus :: Lens' StopCalculationExecutionResponse Int
Creating a Request
data StopCalculationExecution Source #
See: newStopCalculationExecution
smart constructor.
Constructors
StopCalculationExecution' | |
Fields
|
Instances
newStopCalculationExecution Source #
Arguments
:: Text | |
-> StopCalculationExecution |
Create a value of StopCalculationExecution
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
StopCalculationExecution
, stopCalculationExecution_calculationExecutionId
- The calculation execution UUID.
Request Lenses
stopCalculationExecution_calculationExecutionId :: Lens' StopCalculationExecution Text Source #
The calculation execution UUID.
Destructuring the Response
data StopCalculationExecutionResponse Source #
See: newStopCalculationExecutionResponse
smart constructor.
Constructors
StopCalculationExecutionResponse' | |
Fields
|
Instances
newStopCalculationExecutionResponse Source #
Create a value of StopCalculationExecutionResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
StopCalculationExecutionResponse
, stopCalculationExecutionResponse_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.
$sel:httpStatus:StopCalculationExecutionResponse'
, stopCalculationExecutionResponse_httpStatus
- The response's http status code.
Response Lenses
stopCalculationExecutionResponse_state :: Lens' StopCalculationExecutionResponse (Maybe CalculationExecutionState) Source #
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.
stopCalculationExecutionResponse_httpStatus :: Lens' StopCalculationExecutionResponse Int Source #
The response's http status code.