Network.AWS.SWF.TerminateWorkflowExecution

Records a WorkflowExecutionTerminated event and forces closure of the workflow execution identified by the given domain, runId, and workflowId. The child policy, registered with the workflow type or specified when starting this execution, is applied to any open child workflow executions of this workflow execution.

Important: If the identified workflow execution was in progress, it is terminated immediately.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

terminateWorkflowExecution

Arguments

:: Text

tweDomain

-> Text

tweWorkflowId

-> TerminateWorkflowExecution

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

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

• tweReason - Optional. A descriptive reason for terminating the workflow execution.
• tweRunId - The runId of the workflow execution to terminate.
• tweChildPolicy - If set, specifies the policy to use for the child workflow executions of the workflow execution being terminated. This policy overrides the child policy specified for the workflow execution at registration time or when starting the execution. The supported child policies are: * TERMINATE: the child executions will be terminated. * REQUEST_CANCEL: a request to cancel will be attempted for each child execution by recording a WorkflowExecutionCancelRequested event in its history. It is up to the decider to take appropriate actions when it receives an execution history with this event. * ABANDON: no action will be taken. The child executions will continue to run.
• tweDetails - Optional. Details for terminating the workflow execution.
• tweDomain - The domain of the workflow execution to terminate.
• tweWorkflowId - The workflowId of the workflow execution to terminate.

data TerminateWorkflowExecution

See: terminateWorkflowExecution smart constructor.

Instances

Eq TerminateWorkflowExecution

Methods

(==) :: TerminateWorkflowExecution -> TerminateWorkflowExecution -> Bool

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

Data TerminateWorkflowExecution

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> TerminateWorkflowExecution -> c TerminateWorkflowExecution

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c TerminateWorkflowExecution

toConstr :: TerminateWorkflowExecution -> Constr

dataTypeOf :: TerminateWorkflowExecution -> DataType

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c TerminateWorkflowExecution)

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c TerminateWorkflowExecution)

gmapT :: (forall b. Data b => b -> b) -> TerminateWorkflowExecution -> TerminateWorkflowExecution

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> TerminateWorkflowExecution -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> TerminateWorkflowExecution -> r

gmapQ :: (forall d. Data d => d -> u) -> TerminateWorkflowExecution -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> TerminateWorkflowExecution -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> TerminateWorkflowExecution -> m TerminateWorkflowExecution

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> TerminateWorkflowExecution -> m TerminateWorkflowExecution

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> TerminateWorkflowExecution -> m TerminateWorkflowExecution

Read TerminateWorkflowExecution

Methods

readsPrec :: Int -> ReadS TerminateWorkflowExecution

readList :: ReadS [TerminateWorkflowExecution]

readPrec :: ReadPrec TerminateWorkflowExecution

readListPrec :: ReadPrec [TerminateWorkflowExecution]

Show TerminateWorkflowExecution

Methods

showsPrec :: Int -> TerminateWorkflowExecution -> ShowS

show :: TerminateWorkflowExecution -> String

showList :: [TerminateWorkflowExecution] -> ShowS

Generic TerminateWorkflowExecution

Associated Types

type Rep TerminateWorkflowExecution :: * -> *

Methods

from :: TerminateWorkflowExecution -> Rep TerminateWorkflowExecution x

to :: Rep TerminateWorkflowExecution x -> TerminateWorkflowExecution

Hashable TerminateWorkflowExecution

Methods

hashWithSalt :: Int -> TerminateWorkflowExecution -> Int

hash :: TerminateWorkflowExecution -> Int

ToJSON TerminateWorkflowExecution

Methods

toJSON :: TerminateWorkflowExecution -> Value

toEncoding :: TerminateWorkflowExecution -> Encoding

toJSONList :: [TerminateWorkflowExecution] -> Value

toEncodingList :: [TerminateWorkflowExecution] -> Encoding

NFData TerminateWorkflowExecution

Methods

rnf :: TerminateWorkflowExecution -> ()

AWSRequest TerminateWorkflowExecution

Associated Types

type Rs TerminateWorkflowExecution :: *

Methods

request :: TerminateWorkflowExecution -> Request TerminateWorkflowExecution

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

ToPath TerminateWorkflowExecution

Methods

toPath :: TerminateWorkflowExecution -> ByteString

ToHeaders TerminateWorkflowExecution

Methods

toHeaders :: TerminateWorkflowExecution -> [Header]

ToQuery TerminateWorkflowExecution

Methods

toQuery :: TerminateWorkflowExecution -> QueryString

type Rep TerminateWorkflowExecution

type Rep TerminateWorkflowExecution = D1 (MetaData "TerminateWorkflowExecution" "Network.AWS.SWF.TerminateWorkflowExecution" "amazonka-swf-1.4.5-JrgP3TYd23IIXxQppO5YqL" False) (C1 (MetaCons "TerminateWorkflowExecution'" PrefixI True) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "_tweReason") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) ((:*:) (S1 (MetaSel (Just Symbol "_tweRunId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) (S1 (MetaSel (Just Symbol "_tweChildPolicy") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe ChildPolicy))))) ((:*:) (S1 (MetaSel (Just Symbol "_tweDetails") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) ((:*:) (S1 (MetaSel (Just Symbol "_tweDomain") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text)) (S1 (MetaSel (Just Symbol "_tweWorkflowId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text))))))

type Rs TerminateWorkflowExecution

type Rs TerminateWorkflowExecution = TerminateWorkflowExecutionResponse

Request Lenses

tweReason :: Lens' TerminateWorkflowExecution (Maybe Text)

Optional. A descriptive reason for terminating the workflow execution.

tweRunId :: Lens' TerminateWorkflowExecution (Maybe Text)

The runId of the workflow execution to terminate.

tweChildPolicy :: Lens' TerminateWorkflowExecution (Maybe ChildPolicy)

If set, specifies the policy to use for the child workflow executions of the workflow execution being terminated. This policy overrides the child policy specified for the workflow execution at registration time or when starting the execution. The supported child policies are: * TERMINATE: the child executions will be terminated. * REQUEST_CANCEL: a request to cancel will be attempted for each child execution by recording a WorkflowExecutionCancelRequested event in its history. It is up to the decider to take appropriate actions when it receives an execution history with this event. * ABANDON: no action will be taken. The child executions will continue to run.

tweDetails :: Lens' TerminateWorkflowExecution (Maybe Text)

Optional. Details for terminating the workflow execution.

tweDomain :: Lens' TerminateWorkflowExecution Text

The domain of the workflow execution to terminate.

tweWorkflowId :: Lens' TerminateWorkflowExecution Text

The workflowId of the workflow execution to terminate.

Destructuring the Response

terminateWorkflowExecutionResponse :: TerminateWorkflowExecutionResponse

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

data TerminateWorkflowExecutionResponse

See: terminateWorkflowExecutionResponse smart constructor.

Instances

Eq TerminateWorkflowExecutionResponse

Methods

(==) :: TerminateWorkflowExecutionResponse -> TerminateWorkflowExecutionResponse -> Bool

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

Data TerminateWorkflowExecutionResponse

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> TerminateWorkflowExecutionResponse -> c TerminateWorkflowExecutionResponse

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c TerminateWorkflowExecutionResponse

toConstr :: TerminateWorkflowExecutionResponse -> Constr

dataTypeOf :: TerminateWorkflowExecutionResponse -> DataType

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c TerminateWorkflowExecutionResponse)

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c TerminateWorkflowExecutionResponse)

gmapT :: (forall b. Data b => b -> b) -> TerminateWorkflowExecutionResponse -> TerminateWorkflowExecutionResponse

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> TerminateWorkflowExecutionResponse -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> TerminateWorkflowExecutionResponse -> r

gmapQ :: (forall d. Data d => d -> u) -> TerminateWorkflowExecutionResponse -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> TerminateWorkflowExecutionResponse -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> TerminateWorkflowExecutionResponse -> m TerminateWorkflowExecutionResponse

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> TerminateWorkflowExecutionResponse -> m TerminateWorkflowExecutionResponse

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> TerminateWorkflowExecutionResponse -> m TerminateWorkflowExecutionResponse

Read TerminateWorkflowExecutionResponse

Methods

readsPrec :: Int -> ReadS TerminateWorkflowExecutionResponse

readList :: ReadS [TerminateWorkflowExecutionResponse]

readPrec :: ReadPrec TerminateWorkflowExecutionResponse

readListPrec :: ReadPrec [TerminateWorkflowExecutionResponse]

Show TerminateWorkflowExecutionResponse

Methods

showsPrec :: Int -> TerminateWorkflowExecutionResponse -> ShowS

show :: TerminateWorkflowExecutionResponse -> String

showList :: [TerminateWorkflowExecutionResponse] -> ShowS

Generic TerminateWorkflowExecutionResponse

Associated Types

type Rep TerminateWorkflowExecutionResponse :: * -> *

Methods

from :: TerminateWorkflowExecutionResponse -> Rep TerminateWorkflowExecutionResponse x

to :: Rep TerminateWorkflowExecutionResponse x -> TerminateWorkflowExecutionResponse

NFData TerminateWorkflowExecutionResponse

Methods

rnf :: TerminateWorkflowExecutionResponse -> ()

type Rep TerminateWorkflowExecutionResponse

type Rep TerminateWorkflowExecutionResponse = D1 (MetaData "TerminateWorkflowExecutionResponse" "Network.AWS.SWF.TerminateWorkflowExecution" "amazonka-swf-1.4.5-JrgP3TYd23IIXxQppO5YqL" False) (C1 (MetaCons "TerminateWorkflowExecutionResponse'" PrefixI False) U1)