Network.AWS.SWF.RequestCancelWorkflowExecution

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.

If the runId is not specified, the WorkflowExecutionCancelRequested event is recorded in the history of the current open workflow execution with the specified workflowId in the domain.

Because this action allows the workflow to properly clean up and gracefully close, it should be used instead of TerminateWorkflowExecution when possible.

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 does not 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 will be set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows.

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
• rcweDomain
• rcweWorkflowId

data RequestCancelWorkflowExecution

See: requestCancelWorkflowExecution smart constructor.

Instances

Eq RequestCancelWorkflowExecution

Methods

(==) :: RequestCancelWorkflowExecution -> RequestCancelWorkflowExecution -> Bool

(/=) :: RequestCancelWorkflowExecution -> RequestCancelWorkflowExecution -> Bool

Data 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

Methods

readsPrec :: Int -> ReadS RequestCancelWorkflowExecution

readList :: ReadS [RequestCancelWorkflowExecution]

readPrec :: ReadPrec RequestCancelWorkflowExecution

readListPrec :: ReadPrec [RequestCancelWorkflowExecution]

Show RequestCancelWorkflowExecution

Methods

showsPrec :: Int -> RequestCancelWorkflowExecution -> ShowS

show :: RequestCancelWorkflowExecution -> String

showList :: [RequestCancelWorkflowExecution] -> ShowS

Generic RequestCancelWorkflowExecution

Associated Types

type Rep RequestCancelWorkflowExecution :: * -> *

Methods

from :: RequestCancelWorkflowExecution -> Rep RequestCancelWorkflowExecution x

to :: Rep RequestCancelWorkflowExecution x -> RequestCancelWorkflowExecution

Hashable RequestCancelWorkflowExecution

Methods

hashWithSalt :: Int -> RequestCancelWorkflowExecution -> Int

hash :: RequestCancelWorkflowExecution -> Int

ToJSON RequestCancelWorkflowExecution

Methods

toJSON :: RequestCancelWorkflowExecution -> Value

toEncoding :: RequestCancelWorkflowExecution -> Encoding

toJSONList :: [RequestCancelWorkflowExecution] -> Value

toEncodingList :: [RequestCancelWorkflowExecution] -> Encoding

NFData RequestCancelWorkflowExecution

Methods

rnf :: RequestCancelWorkflowExecution -> ()

AWSRequest RequestCancelWorkflowExecution

Associated Types

type Rs RequestCancelWorkflowExecution :: *

Methods

request :: RequestCancelWorkflowExecution -> Request RequestCancelWorkflowExecution

response :: MonadResource m => Logger -> Service -> Proxy * RequestCancelWorkflowExecution -> ClientResponse -> m (Response RequestCancelWorkflowExecution)

ToQuery RequestCancelWorkflowExecution

Methods

toQuery :: RequestCancelWorkflowExecution -> QueryString

ToPath RequestCancelWorkflowExecution

Methods

toPath :: RequestCancelWorkflowExecution -> ByteString

ToHeaders RequestCancelWorkflowExecution

Methods

toHeaders :: RequestCancelWorkflowExecution -> [Header]

type Rep RequestCancelWorkflowExecution

type Rep RequestCancelWorkflowExecution = D1 (MetaData "RequestCancelWorkflowExecution" "Network.AWS.SWF.RequestCancelWorkflowExecution" "amazonka-swf-1.4.3-CUgUcKlV8EhcLLfbuVW5c" False) (C1 (MetaCons "RequestCancelWorkflowExecution'" PrefixI True) ((:*:) (S1 (MetaSel (Just Symbol "_rcweRunId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) ((:*:) (S1 (MetaSel (Just Symbol "_rcweDomain") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text)) (S1 (MetaSel (Just Symbol "_rcweWorkflowId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text)))))

type Rs 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

Methods

(==) :: RequestCancelWorkflowExecutionResponse -> RequestCancelWorkflowExecutionResponse -> Bool

(/=) :: RequestCancelWorkflowExecutionResponse -> RequestCancelWorkflowExecutionResponse -> Bool

Data RequestCancelWorkflowExecutionResponse

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

Methods

readsPrec :: Int -> ReadS RequestCancelWorkflowExecutionResponse

readList :: ReadS [RequestCancelWorkflowExecutionResponse]

readPrec :: ReadPrec RequestCancelWorkflowExecutionResponse

readListPrec :: ReadPrec [RequestCancelWorkflowExecutionResponse]

Show RequestCancelWorkflowExecutionResponse

Methods

showsPrec :: Int -> RequestCancelWorkflowExecutionResponse -> ShowS

show :: RequestCancelWorkflowExecutionResponse -> String

showList :: [RequestCancelWorkflowExecutionResponse] -> ShowS

Generic RequestCancelWorkflowExecutionResponse

Associated Types

type Rep RequestCancelWorkflowExecutionResponse :: * -> *

Methods

from :: RequestCancelWorkflowExecutionResponse -> Rep RequestCancelWorkflowExecutionResponse x

to :: Rep RequestCancelWorkflowExecutionResponse x -> RequestCancelWorkflowExecutionResponse

NFData RequestCancelWorkflowExecutionResponse

Methods

rnf :: RequestCancelWorkflowExecutionResponse -> ()

type Rep RequestCancelWorkflowExecutionResponse

type Rep RequestCancelWorkflowExecutionResponse = D1 (MetaData "RequestCancelWorkflowExecutionResponse" "Network.AWS.SWF.RequestCancelWorkflowExecution" "amazonka-swf-1.4.3-CUgUcKlV8EhcLLfbuVW5c" False) (C1 (MetaCons "RequestCancelWorkflowExecutionResponse'" PrefixI False) U1)