Copyright	(c) 2013-2018 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay+amazonka@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None
Language	Haskell2010

Network.AWS.SWF.RequestCancelWorkflowExecution

Contents

Creating a Request
Request Lenses
Destructuring the Response

Description

Records a WorkflowExecutionCancelRequested event in the currently running workflow execution identified by the given domain, workflowId, and runId. This logically requests the cancellation of the workflow execution as a whole. It is up to the decider to take appropriate actions when it receives an execution history with this event.

Access Control

You can use IAM policies to control this action's access to Amazon SWF resources as follows:

Use a Resource element with the domain name to limit the action to only specified domains.
Use an Action element to allow or deny permission to call this action.
You cannot use an IAM policy to constrain this action's parameters.

If the caller doesn't have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter is set to OPERATION_NOT_PERMITTED . For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows in the Amazon SWF Developer Guide .

Creating a Request

requestCancelWorkflowExecution #

Arguments

:: Text	`rcweDomain`
-> Text	`rcweWorkflowId`
-> RequestCancelWorkflowExecution

Creates a value of RequestCancelWorkflowExecution with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

rcweRunId - The runId of the workflow execution to cancel.
rcweDomain - The name of the domain containing the workflow execution to cancel.
rcweWorkflowId - The workflowId of the workflow execution to cancel.

data RequestCancelWorkflowExecution #

See: requestCancelWorkflowExecution smart constructor.

Instances

Eq RequestCancelWorkflowExecution #
Instance details Defined in Network.AWS.SWF.RequestCancelWorkflowExecution Methods (==) :: RequestCancelWorkflowExecution -> RequestCancelWorkflowExecution -> Bool # (/=) :: RequestCancelWorkflowExecution -> RequestCancelWorkflowExecution -> Bool #
Data RequestCancelWorkflowExecution #
Instance details Defined in Network.AWS.SWF.RequestCancelWorkflowExecution Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> RequestCancelWorkflowExecution -> c RequestCancelWorkflowExecution # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c RequestCancelWorkflowExecution # toConstr :: RequestCancelWorkflowExecution -> Constr # dataTypeOf :: RequestCancelWorkflowExecution -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c RequestCancelWorkflowExecution) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c RequestCancelWorkflowExecution) # gmapT :: (forall b. Data b => b -> b) -> RequestCancelWorkflowExecution -> RequestCancelWorkflowExecution # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> RequestCancelWorkflowExecution -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> RequestCancelWorkflowExecution -> r # gmapQ :: (forall d. Data d => d -> u) -> RequestCancelWorkflowExecution -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> RequestCancelWorkflowExecution -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> RequestCancelWorkflowExecution -> m RequestCancelWorkflowExecution # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> RequestCancelWorkflowExecution -> m RequestCancelWorkflowExecution # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> RequestCancelWorkflowExecution -> m RequestCancelWorkflowExecution #
Read RequestCancelWorkflowExecution #
Instance details Defined in Network.AWS.SWF.RequestCancelWorkflowExecution Methods readsPrec :: Int -> ReadS RequestCancelWorkflowExecution # readList :: ReadS [RequestCancelWorkflowExecution] # readPrec :: ReadPrec RequestCancelWorkflowExecution # readListPrec :: ReadPrec [RequestCancelWorkflowExecution] #
Show RequestCancelWorkflowExecution #
Instance details Defined in Network.AWS.SWF.RequestCancelWorkflowExecution Methods showsPrec :: Int -> RequestCancelWorkflowExecution -> ShowS # show :: RequestCancelWorkflowExecution -> String # showList :: [RequestCancelWorkflowExecution] -> ShowS #
Generic RequestCancelWorkflowExecution #
Instance details Defined in Network.AWS.SWF.RequestCancelWorkflowExecution Associated Types type Rep RequestCancelWorkflowExecution :: * -> * # Methods from :: RequestCancelWorkflowExecution -> Rep RequestCancelWorkflowExecution x # to :: Rep RequestCancelWorkflowExecution x -> RequestCancelWorkflowExecution #
Hashable RequestCancelWorkflowExecution #
Instance details Defined in Network.AWS.SWF.RequestCancelWorkflowExecution Methods hashWithSalt :: Int -> RequestCancelWorkflowExecution -> Int # hash :: RequestCancelWorkflowExecution -> Int #
ToJSON RequestCancelWorkflowExecution #
Instance details Defined in Network.AWS.SWF.RequestCancelWorkflowExecution Methods toJSON :: RequestCancelWorkflowExecution -> Value # toEncoding :: RequestCancelWorkflowExecution -> Encoding # toJSONList :: [RequestCancelWorkflowExecution] -> Value # toEncodingList :: [RequestCancelWorkflowExecution] -> Encoding #
AWSRequest RequestCancelWorkflowExecution #
Instance details Defined in Network.AWS.SWF.RequestCancelWorkflowExecution Associated Types type Rs RequestCancelWorkflowExecution :: * # Methods request :: RequestCancelWorkflowExecution -> Request RequestCancelWorkflowExecution # response :: (MonadResource m, MonadThrow m) => Logger -> Service -> Proxy RequestCancelWorkflowExecution -> ClientResponse -> m (Response RequestCancelWorkflowExecution) #
ToHeaders RequestCancelWorkflowExecution #
Instance details Defined in Network.AWS.SWF.RequestCancelWorkflowExecution Methods toHeaders :: RequestCancelWorkflowExecution -> [Header] #
ToPath RequestCancelWorkflowExecution #
Instance details Defined in Network.AWS.SWF.RequestCancelWorkflowExecution Methods toPath :: RequestCancelWorkflowExecution -> ByteString #
ToQuery RequestCancelWorkflowExecution #
Instance details Defined in Network.AWS.SWF.RequestCancelWorkflowExecution Methods toQuery :: RequestCancelWorkflowExecution -> QueryString #
NFData RequestCancelWorkflowExecution #
Instance details Defined in Network.AWS.SWF.RequestCancelWorkflowExecution Methods rnf :: RequestCancelWorkflowExecution -> () #
type Rep RequestCancelWorkflowExecution #
Instance details Defined in Network.AWS.SWF.RequestCancelWorkflowExecution type Rep RequestCancelWorkflowExecution = D1 (MetaData "RequestCancelWorkflowExecution" "Network.AWS.SWF.RequestCancelWorkflowExecution" "amazonka-swf-1.6.0-1h41zhaEbfa3Fk0SeWaXFv" False) (C1 (MetaCons "RequestCancelWorkflowExecution'" PrefixI True) (S1 (MetaSel (Just "_rcweRunId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :: (S1 (MetaSel (Just "_rcweDomain") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text) :: S1 (MetaSel (Just "_rcweWorkflowId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text))))
type Rs RequestCancelWorkflowExecution #
Instance details Defined in Network.AWS.SWF.RequestCancelWorkflowExecution type Rs RequestCancelWorkflowExecution = RequestCancelWorkflowExecutionResponse

Request Lenses

rcweRunId :: Lens' RequestCancelWorkflowExecution (Maybe Text) #

The runId of the workflow execution to cancel.

rcweDomain :: Lens' RequestCancelWorkflowExecution Text #

The name of the domain containing the workflow execution to cancel.

rcweWorkflowId :: Lens' RequestCancelWorkflowExecution Text #

The workflowId of the workflow execution to cancel.

Destructuring the Response

requestCancelWorkflowExecutionResponse :: RequestCancelWorkflowExecutionResponse #

Creates a value of RequestCancelWorkflowExecutionResponse with the minimum fields required to make a request.

data RequestCancelWorkflowExecutionResponse #

See: requestCancelWorkflowExecutionResponse smart constructor.

Instances

Eq RequestCancelWorkflowExecutionResponse #
Instance details Defined in Network.AWS.SWF.RequestCancelWorkflowExecution Methods (==) :: RequestCancelWorkflowExecutionResponse -> RequestCancelWorkflowExecutionResponse -> Bool # (/=) :: RequestCancelWorkflowExecutionResponse -> RequestCancelWorkflowExecutionResponse -> Bool #
Data RequestCancelWorkflowExecutionResponse #
Instance details Defined in Network.AWS.SWF.RequestCancelWorkflowExecution Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> RequestCancelWorkflowExecutionResponse -> c RequestCancelWorkflowExecutionResponse # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c RequestCancelWorkflowExecutionResponse # toConstr :: RequestCancelWorkflowExecutionResponse -> Constr # dataTypeOf :: RequestCancelWorkflowExecutionResponse -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c RequestCancelWorkflowExecutionResponse) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c RequestCancelWorkflowExecutionResponse) # gmapT :: (forall b. Data b => b -> b) -> RequestCancelWorkflowExecutionResponse -> RequestCancelWorkflowExecutionResponse # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> RequestCancelWorkflowExecutionResponse -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> RequestCancelWorkflowExecutionResponse -> r # gmapQ :: (forall d. Data d => d -> u) -> RequestCancelWorkflowExecutionResponse -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> RequestCancelWorkflowExecutionResponse -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> RequestCancelWorkflowExecutionResponse -> m RequestCancelWorkflowExecutionResponse # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> RequestCancelWorkflowExecutionResponse -> m RequestCancelWorkflowExecutionResponse # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> RequestCancelWorkflowExecutionResponse -> m RequestCancelWorkflowExecutionResponse #
Read RequestCancelWorkflowExecutionResponse #
Instance details Defined in Network.AWS.SWF.RequestCancelWorkflowExecution Methods readsPrec :: Int -> ReadS RequestCancelWorkflowExecutionResponse # readList :: ReadS [RequestCancelWorkflowExecutionResponse] # readPrec :: ReadPrec RequestCancelWorkflowExecutionResponse # readListPrec :: ReadPrec [RequestCancelWorkflowExecutionResponse] #
Show RequestCancelWorkflowExecutionResponse #
Instance details Defined in Network.AWS.SWF.RequestCancelWorkflowExecution Methods showsPrec :: Int -> RequestCancelWorkflowExecutionResponse -> ShowS # show :: RequestCancelWorkflowExecutionResponse -> String # showList :: [RequestCancelWorkflowExecutionResponse] -> ShowS #
Generic RequestCancelWorkflowExecutionResponse #
Instance details Defined in Network.AWS.SWF.RequestCancelWorkflowExecution Associated Types type Rep RequestCancelWorkflowExecutionResponse :: * -> * # Methods from :: RequestCancelWorkflowExecutionResponse -> Rep RequestCancelWorkflowExecutionResponse x # to :: Rep RequestCancelWorkflowExecutionResponse x -> RequestCancelWorkflowExecutionResponse #
NFData RequestCancelWorkflowExecutionResponse #
Instance details Defined in Network.AWS.SWF.RequestCancelWorkflowExecution Methods rnf :: RequestCancelWorkflowExecutionResponse -> () #
type Rep RequestCancelWorkflowExecutionResponse #
Instance details Defined in Network.AWS.SWF.RequestCancelWorkflowExecution type Rep RequestCancelWorkflowExecutionResponse = D1 (MetaData "RequestCancelWorkflowExecutionResponse" "Network.AWS.SWF.RequestCancelWorkflowExecution" "amazonka-swf-1.6.0-1h41zhaEbfa3Fk0SeWaXFv" False) (C1 (MetaCons "RequestCancelWorkflowExecutionResponse'" PrefixI False) (U1 :: * -> *))