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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

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.

Creating a Request

data StopCalculationExecution Source #

See: newStopCalculationExecution smart constructor.

Constructors

StopCalculationExecution'
Fields calculationExecutionId :: Text The calculation execution UUID.

Instances

Instances details

ToJSON StopCalculationExecution Source #
Instance details Defined in Amazonka.Athena.StopCalculationExecution Methods toJSON :: StopCalculationExecution -> Value # toEncoding :: StopCalculationExecution -> Encoding # toJSONList :: [StopCalculationExecution] -> Value # toEncodingList :: [StopCalculationExecution] -> Encoding #
ToHeaders StopCalculationExecution Source #
Instance details Defined in Amazonka.Athena.StopCalculationExecution Methods toHeaders :: StopCalculationExecution -> [Header] #
ToPath StopCalculationExecution Source #
Instance details Defined in Amazonka.Athena.StopCalculationExecution Methods toPath :: StopCalculationExecution -> ByteString #
ToQuery StopCalculationExecution Source #
Instance details Defined in Amazonka.Athena.StopCalculationExecution Methods toQuery :: StopCalculationExecution -> QueryString #
AWSRequest StopCalculationExecution Source #
Instance details Defined in Amazonka.Athena.StopCalculationExecution Associated Types type AWSResponse StopCalculationExecution # Methods request :: (Service -> Service) -> StopCalculationExecution -> Request StopCalculationExecution # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy StopCalculationExecution -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse StopCalculationExecution))) #
Generic StopCalculationExecution Source #
Instance details Defined in Amazonka.Athena.StopCalculationExecution Associated Types type Rep StopCalculationExecution :: Type -> Type # Methods from :: StopCalculationExecution -> Rep StopCalculationExecution x # to :: Rep StopCalculationExecution x -> StopCalculationExecution #
Read StopCalculationExecution Source #
Instance details Defined in Amazonka.Athena.StopCalculationExecution Methods readsPrec :: Int -> ReadS StopCalculationExecution # readList :: ReadS [StopCalculationExecution] # readPrec :: ReadPrec StopCalculationExecution # readListPrec :: ReadPrec [StopCalculationExecution] #
Show StopCalculationExecution Source #
Instance details Defined in Amazonka.Athena.StopCalculationExecution Methods showsPrec :: Int -> StopCalculationExecution -> ShowS # show :: StopCalculationExecution -> String # showList :: [StopCalculationExecution] -> ShowS #
NFData StopCalculationExecution Source #
Instance details Defined in Amazonka.Athena.StopCalculationExecution Methods rnf :: StopCalculationExecution -> () #
Eq StopCalculationExecution Source #
Instance details Defined in Amazonka.Athena.StopCalculationExecution Methods (==) :: StopCalculationExecution -> StopCalculationExecution -> Bool # (/=) :: StopCalculationExecution -> StopCalculationExecution -> Bool #
Hashable StopCalculationExecution Source #
Instance details Defined in Amazonka.Athena.StopCalculationExecution Methods hashWithSalt :: Int -> StopCalculationExecution -> Int # hash :: StopCalculationExecution -> Int #
type AWSResponse StopCalculationExecution Source #
Instance details Defined in Amazonka.Athena.StopCalculationExecution type AWSResponse StopCalculationExecution = StopCalculationExecutionResponse
type Rep StopCalculationExecution Source #
Instance details Defined in Amazonka.Athena.StopCalculationExecution type Rep StopCalculationExecution = D1 ('MetaData "StopCalculationExecution" "Amazonka.Athena.StopCalculationExecution" "amazonka-athena-2.0-1BJA3HTvHJNEzwQRaEw59w" 'False) (C1 ('MetaCons "StopCalculationExecution'" 'PrefixI 'True) (S1 ('MetaSel ('Just "calculationExecutionId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

newStopCalculationExecution Source #

Arguments

:: Text	`StopCalculationExecution`
-> 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

state :: Maybe CalculationExecutionState
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.
httpStatus :: Int
The response's http status code.

Instances

Instances details

Generic StopCalculationExecutionResponse Source #
Instance details Defined in Amazonka.Athena.StopCalculationExecution Associated Types type Rep StopCalculationExecutionResponse :: Type -> Type # Methods from :: StopCalculationExecutionResponse -> Rep StopCalculationExecutionResponse x # to :: Rep StopCalculationExecutionResponse x -> StopCalculationExecutionResponse #
Read StopCalculationExecutionResponse Source #
Instance details Defined in Amazonka.Athena.StopCalculationExecution Methods readsPrec :: Int -> ReadS StopCalculationExecutionResponse # readList :: ReadS [StopCalculationExecutionResponse] # readPrec :: ReadPrec StopCalculationExecutionResponse # readListPrec :: ReadPrec [StopCalculationExecutionResponse] #
Show StopCalculationExecutionResponse Source #
Instance details Defined in Amazonka.Athena.StopCalculationExecution Methods showsPrec :: Int -> StopCalculationExecutionResponse -> ShowS # show :: StopCalculationExecutionResponse -> String # showList :: [StopCalculationExecutionResponse] -> ShowS #
NFData StopCalculationExecutionResponse Source #
Instance details Defined in Amazonka.Athena.StopCalculationExecution Methods rnf :: StopCalculationExecutionResponse -> () #
Eq StopCalculationExecutionResponse Source #
Instance details Defined in Amazonka.Athena.StopCalculationExecution Methods (==) :: StopCalculationExecutionResponse -> StopCalculationExecutionResponse -> Bool # (/=) :: StopCalculationExecutionResponse -> StopCalculationExecutionResponse -> Bool #
type Rep StopCalculationExecutionResponse Source #
Instance details Defined in Amazonka.Athena.StopCalculationExecution type Rep StopCalculationExecutionResponse = D1 ('MetaData "StopCalculationExecutionResponse" "Amazonka.Athena.StopCalculationExecution" "amazonka-athena-2.0-1BJA3HTvHJNEzwQRaEw59w" 'False) (C1 ('MetaCons "StopCalculationExecutionResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "state") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe CalculationExecutionState)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newStopCalculationExecutionResponse Source #

Arguments

:: Int	`$sel:httpStatus:StopCalculationExecutionResponse'`
-> StopCalculationExecutionResponse

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.