Copyright	(c) 2013-2021 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

Amazonka.SWF.TerminateWorkflowExecution

Contents

Creating a Request
Request Lenses
Destructuring the Response

Description

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.

If the identified workflow execution was in progress, it is terminated immediately.

If a runId isn't specified, then the WorkflowExecutionTerminated event is recorded in the history of the current open workflow with the matching workflowId in the domain.

You should consider using RequestCancelWorkflowExecution action instead because it allows the workflow to gracefully close while TerminateWorkflowExecution doesn't.

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.

Synopsis

Creating a Request

data TerminateWorkflowExecution Source #

See: newTerminateWorkflowExecution smart constructor.

Constructors

TerminateWorkflowExecution'

Fields

reason :: Maybe Text
A descriptive reason for terminating the workflow execution.
runId :: Maybe Text
The runId of the workflow execution to terminate.
childPolicy :: 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 are terminated.
- REQUEST_CANCEL – A request to cancel is 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 is taken. The child executions continue to run.
A child policy for this workflow execution must be specified either as a default for the workflow type or through this parameter. If neither this parameter is set nor a default child policy was specified at registration time then a fault is returned.
details :: Maybe Text
Details for terminating the workflow execution.
domain :: Text
The domain of the workflow execution to terminate.
workflowId :: Text
The workflowId of the workflow execution to terminate.

Instances

Instances details

Eq TerminateWorkflowExecution Source #
Instance details Defined in Amazonka.SWF.TerminateWorkflowExecution Methods (==) :: TerminateWorkflowExecution -> TerminateWorkflowExecution -> Bool # (/=) :: TerminateWorkflowExecution -> TerminateWorkflowExecution -> Bool #
Read TerminateWorkflowExecution Source #
Instance details Defined in Amazonka.SWF.TerminateWorkflowExecution Methods readsPrec :: Int -> ReadS TerminateWorkflowExecution # readList :: ReadS [TerminateWorkflowExecution] # readPrec :: ReadPrec TerminateWorkflowExecution # readListPrec :: ReadPrec [TerminateWorkflowExecution] #
Show TerminateWorkflowExecution Source #
Instance details Defined in Amazonka.SWF.TerminateWorkflowExecution Methods showsPrec :: Int -> TerminateWorkflowExecution -> ShowS # show :: TerminateWorkflowExecution -> String # showList :: [TerminateWorkflowExecution] -> ShowS #
Generic TerminateWorkflowExecution Source #
Instance details Defined in Amazonka.SWF.TerminateWorkflowExecution Associated Types type Rep TerminateWorkflowExecution :: Type -> Type # Methods from :: TerminateWorkflowExecution -> Rep TerminateWorkflowExecution x # to :: Rep TerminateWorkflowExecution x -> TerminateWorkflowExecution #
NFData TerminateWorkflowExecution Source #
Instance details Defined in Amazonka.SWF.TerminateWorkflowExecution Methods rnf :: TerminateWorkflowExecution -> () #
Hashable TerminateWorkflowExecution Source #
Instance details Defined in Amazonka.SWF.TerminateWorkflowExecution Methods hashWithSalt :: Int -> TerminateWorkflowExecution -> Int # hash :: TerminateWorkflowExecution -> Int #
ToJSON TerminateWorkflowExecution Source #
Instance details Defined in Amazonka.SWF.TerminateWorkflowExecution Methods toJSON :: TerminateWorkflowExecution -> Value # toEncoding :: TerminateWorkflowExecution -> Encoding # toJSONList :: [TerminateWorkflowExecution] -> Value # toEncodingList :: [TerminateWorkflowExecution] -> Encoding #
AWSRequest TerminateWorkflowExecution Source #
Instance details Defined in Amazonka.SWF.TerminateWorkflowExecution Associated Types type AWSResponse TerminateWorkflowExecution # Methods request :: TerminateWorkflowExecution -> Request TerminateWorkflowExecution # response :: MonadResource m => Logger -> Service -> Proxy TerminateWorkflowExecution -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse TerminateWorkflowExecution))) #
ToHeaders TerminateWorkflowExecution Source #
Instance details Defined in Amazonka.SWF.TerminateWorkflowExecution Methods toHeaders :: TerminateWorkflowExecution -> [Header] #
ToPath TerminateWorkflowExecution Source #
Instance details Defined in Amazonka.SWF.TerminateWorkflowExecution Methods toPath :: TerminateWorkflowExecution -> ByteString #
ToQuery TerminateWorkflowExecution Source #
Instance details Defined in Amazonka.SWF.TerminateWorkflowExecution Methods toQuery :: TerminateWorkflowExecution -> QueryString #
type Rep TerminateWorkflowExecution Source #
Instance details Defined in Amazonka.SWF.TerminateWorkflowExecution type Rep TerminateWorkflowExecution = D1 ('MetaData "TerminateWorkflowExecution" "Amazonka.SWF.TerminateWorkflowExecution" "libZSservicesZSamazonka-swfZSamazonka-swf" 'False) (C1 ('MetaCons "TerminateWorkflowExecution'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "reason") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "runId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "childPolicy") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ChildPolicy)))) :: (S1 ('MetaSel ('Just "details") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "domain") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "workflowId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))))
type AWSResponse TerminateWorkflowExecution Source #
Instance details Defined in Amazonka.SWF.TerminateWorkflowExecution type AWSResponse TerminateWorkflowExecution = TerminateWorkflowExecutionResponse

newTerminateWorkflowExecution Source #

Arguments

:: Text	`$sel:domain:TerminateWorkflowExecution'`
-> Text	`$sel:workflowId:TerminateWorkflowExecution'`
-> TerminateWorkflowExecution

Create a value of TerminateWorkflowExecution 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:

$sel:reason:TerminateWorkflowExecution', terminateWorkflowExecution_reason - A descriptive reason for terminating the workflow execution.

$sel:runId:TerminateWorkflowExecution', terminateWorkflowExecution_runId - The runId of the workflow execution to terminate.

$sel:childPolicy:TerminateWorkflowExecution', terminateWorkflowExecution_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 are terminated.
REQUEST_CANCEL – A request to cancel is 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 is taken. The child executions continue to run.

A child policy for this workflow execution must be specified either as a default for the workflow type or through this parameter. If neither this parameter is set nor a default child policy was specified at registration time then a fault is returned.

$sel:details:TerminateWorkflowExecution', terminateWorkflowExecution_details - Details for terminating the workflow execution.

$sel:domain:TerminateWorkflowExecution', terminateWorkflowExecution_domain - The domain of the workflow execution to terminate.

$sel:workflowId:TerminateWorkflowExecution', terminateWorkflowExecution_workflowId - The workflowId of the workflow execution to terminate.

Request Lenses

terminateWorkflowExecution_reason :: Lens' TerminateWorkflowExecution (Maybe Text) Source #

A descriptive reason for terminating the workflow execution.

terminateWorkflowExecution_runId :: Lens' TerminateWorkflowExecution (Maybe Text) Source #

The runId of the workflow execution to terminate.

terminateWorkflowExecution_childPolicy :: Lens' TerminateWorkflowExecution (Maybe ChildPolicy) Source #

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 are terminated.
REQUEST_CANCEL – A request to cancel is 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 is taken. The child executions continue to run.

A child policy for this workflow execution must be specified either as a default for the workflow type or through this parameter. If neither this parameter is set nor a default child policy was specified at registration time then a fault is returned.

terminateWorkflowExecution_details :: Lens' TerminateWorkflowExecution (Maybe Text) Source #

Details for terminating the workflow execution.

terminateWorkflowExecution_domain :: Lens' TerminateWorkflowExecution Text Source #

The domain of the workflow execution to terminate.

terminateWorkflowExecution_workflowId :: Lens' TerminateWorkflowExecution Text Source #

The workflowId of the workflow execution to terminate.

Destructuring the Response

data TerminateWorkflowExecutionResponse Source #

See: newTerminateWorkflowExecutionResponse smart constructor.

Constructors

TerminateWorkflowExecutionResponse'

Instances

Instances details

Eq TerminateWorkflowExecutionResponse Source #
Instance details Defined in Amazonka.SWF.TerminateWorkflowExecution Methods (==) :: TerminateWorkflowExecutionResponse -> TerminateWorkflowExecutionResponse -> Bool # (/=) :: TerminateWorkflowExecutionResponse -> TerminateWorkflowExecutionResponse -> Bool #
Read TerminateWorkflowExecutionResponse Source #
Instance details Defined in Amazonka.SWF.TerminateWorkflowExecution Methods readsPrec :: Int -> ReadS TerminateWorkflowExecutionResponse # readList :: ReadS [TerminateWorkflowExecutionResponse] # readPrec :: ReadPrec TerminateWorkflowExecutionResponse # readListPrec :: ReadPrec [TerminateWorkflowExecutionResponse] #
Show TerminateWorkflowExecutionResponse Source #
Instance details Defined in Amazonka.SWF.TerminateWorkflowExecution Methods showsPrec :: Int -> TerminateWorkflowExecutionResponse -> ShowS # show :: TerminateWorkflowExecutionResponse -> String # showList :: [TerminateWorkflowExecutionResponse] -> ShowS #
Generic TerminateWorkflowExecutionResponse Source #
Instance details Defined in Amazonka.SWF.TerminateWorkflowExecution Associated Types type Rep TerminateWorkflowExecutionResponse :: Type -> Type # Methods from :: TerminateWorkflowExecutionResponse -> Rep TerminateWorkflowExecutionResponse x # to :: Rep TerminateWorkflowExecutionResponse x -> TerminateWorkflowExecutionResponse #
NFData TerminateWorkflowExecutionResponse Source #
Instance details Defined in Amazonka.SWF.TerminateWorkflowExecution Methods rnf :: TerminateWorkflowExecutionResponse -> () #
type Rep TerminateWorkflowExecutionResponse Source #
Instance details Defined in Amazonka.SWF.TerminateWorkflowExecution type Rep TerminateWorkflowExecutionResponse = D1 ('MetaData "TerminateWorkflowExecutionResponse" "Amazonka.SWF.TerminateWorkflowExecution" "libZSservicesZSamazonka-swfZSamazonka-swf" 'False) (C1 ('MetaCons "TerminateWorkflowExecutionResponse'" 'PrefixI 'False) (U1 :: Type -> Type))

newTerminateWorkflowExecutionResponse :: TerminateWorkflowExecutionResponse Source #

Create a value of TerminateWorkflowExecutionResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.