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.Types.WorkflowExecutionConfiguration

Description

Synopsis

Documentation

data WorkflowExecutionConfiguration Source #

The configuration settings for a workflow execution including timeout values, tasklist etc. These configuration settings are determined from the defaults specified when registering the workflow type and those specified when starting the workflow execution.

See: newWorkflowExecutionConfiguration smart constructor.

Constructors

WorkflowExecutionConfiguration'

Fields

lambdaRole :: Maybe Text
The IAM role attached to the child workflow execution.
taskPriority :: Maybe Text
The priority assigned to decision tasks for this workflow execution. Valid values are integers that range from Java's Integer.MIN_VALUE (-2147483648) to Integer.MAX_VALUE (2147483647). Higher numbers indicate higher priority.
For more information about setting task priority, see Setting Task Priority in the Amazon SWF Developer Guide.
taskStartToCloseTimeout :: Text
The maximum duration allowed for decision tasks for this workflow execution.
The duration is specified in seconds, an integer greater than or equal to 0. You can use NONE to specify unlimited duration.
executionStartToCloseTimeout :: Text
The total duration for this workflow execution.
The duration is specified in seconds, an integer greater than or equal to 0. You can use NONE to specify unlimited duration.
taskList :: TaskList
The task list used for the decision tasks generated for this workflow execution.
childPolicy :: ChildPolicy
The policy to use for the child workflow executions if this workflow execution is terminated, by calling the TerminateWorkflowExecution action explicitly or due to an expired timeout.
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.

Instances

Instances details

Eq WorkflowExecutionConfiguration Source #
Instance details Defined in Amazonka.SWF.Types.WorkflowExecutionConfiguration Methods (==) :: WorkflowExecutionConfiguration -> WorkflowExecutionConfiguration -> Bool # (/=) :: WorkflowExecutionConfiguration -> WorkflowExecutionConfiguration -> Bool #
Read WorkflowExecutionConfiguration Source #
Instance details Defined in Amazonka.SWF.Types.WorkflowExecutionConfiguration Methods readsPrec :: Int -> ReadS WorkflowExecutionConfiguration # readList :: ReadS [WorkflowExecutionConfiguration] # readPrec :: ReadPrec WorkflowExecutionConfiguration # readListPrec :: ReadPrec [WorkflowExecutionConfiguration] #
Show WorkflowExecutionConfiguration Source #
Instance details Defined in Amazonka.SWF.Types.WorkflowExecutionConfiguration Methods showsPrec :: Int -> WorkflowExecutionConfiguration -> ShowS # show :: WorkflowExecutionConfiguration -> String # showList :: [WorkflowExecutionConfiguration] -> ShowS #
Generic WorkflowExecutionConfiguration Source #
Instance details Defined in Amazonka.SWF.Types.WorkflowExecutionConfiguration Associated Types type Rep WorkflowExecutionConfiguration :: Type -> Type # Methods from :: WorkflowExecutionConfiguration -> Rep WorkflowExecutionConfiguration x # to :: Rep WorkflowExecutionConfiguration x -> WorkflowExecutionConfiguration #
NFData WorkflowExecutionConfiguration Source #
Instance details Defined in Amazonka.SWF.Types.WorkflowExecutionConfiguration Methods rnf :: WorkflowExecutionConfiguration -> () #
Hashable WorkflowExecutionConfiguration Source #
Instance details Defined in Amazonka.SWF.Types.WorkflowExecutionConfiguration Methods hashWithSalt :: Int -> WorkflowExecutionConfiguration -> Int # hash :: WorkflowExecutionConfiguration -> Int #
FromJSON WorkflowExecutionConfiguration Source #
Instance details Defined in Amazonka.SWF.Types.WorkflowExecutionConfiguration Methods parseJSON :: Value -> Parser WorkflowExecutionConfiguration # parseJSONList :: Value -> Parser [WorkflowExecutionConfiguration] #
type Rep WorkflowExecutionConfiguration Source #
Instance details Defined in Amazonka.SWF.Types.WorkflowExecutionConfiguration type Rep WorkflowExecutionConfiguration = D1 ('MetaData "WorkflowExecutionConfiguration" "Amazonka.SWF.Types.WorkflowExecutionConfiguration" "libZSservicesZSamazonka-swfZSamazonka-swf" 'False) (C1 ('MetaCons "WorkflowExecutionConfiguration'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "lambdaRole") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "taskPriority") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "taskStartToCloseTimeout") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))) :: (S1 ('MetaSel ('Just "executionStartToCloseTimeout") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: (S1 ('MetaSel ('Just "taskList") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 TaskList) :*: S1 ('MetaSel ('Just "childPolicy") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 ChildPolicy)))))

newWorkflowExecutionConfiguration Source #

Arguments

:: Text	`$sel:taskStartToCloseTimeout:WorkflowExecutionConfiguration'`
-> Text	`$sel:executionStartToCloseTimeout:WorkflowExecutionConfiguration'`
-> TaskList	`$sel:taskList:WorkflowExecutionConfiguration'`
-> ChildPolicy	`$sel:childPolicy:WorkflowExecutionConfiguration'`
-> WorkflowExecutionConfiguration

Create a value of WorkflowExecutionConfiguration 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:lambdaRole:WorkflowExecutionConfiguration', workflowExecutionConfiguration_lambdaRole - The IAM role attached to the child workflow execution.

$sel:taskPriority:WorkflowExecutionConfiguration', workflowExecutionConfiguration_taskPriority - The priority assigned to decision tasks for this workflow execution. Valid values are integers that range from Java's Integer.MIN_VALUE (-2147483648) to Integer.MAX_VALUE (2147483647). Higher numbers indicate higher priority.

For more information about setting task priority, see Setting Task Priority in the Amazon SWF Developer Guide.

$sel:taskStartToCloseTimeout:WorkflowExecutionConfiguration', workflowExecutionConfiguration_taskStartToCloseTimeout - The maximum duration allowed for decision tasks for this workflow execution.

The duration is specified in seconds, an integer greater than or equal to 0. You can use NONE to specify unlimited duration.

$sel:executionStartToCloseTimeout:WorkflowExecutionConfiguration', workflowExecutionConfiguration_executionStartToCloseTimeout - The total duration for this workflow execution.

The duration is specified in seconds, an integer greater than or equal to 0. You can use NONE to specify unlimited duration.

$sel:taskList:WorkflowExecutionConfiguration', workflowExecutionConfiguration_taskList - The task list used for the decision tasks generated for this workflow execution.

$sel:childPolicy:WorkflowExecutionConfiguration', workflowExecutionConfiguration_childPolicy - The policy to use for the child workflow executions if this workflow execution is terminated, by calling the TerminateWorkflowExecution action explicitly or due to an expired timeout.

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.

workflowExecutionConfiguration_lambdaRole :: Lens' WorkflowExecutionConfiguration (Maybe Text) Source #

The IAM role attached to the child workflow execution.

workflowExecutionConfiguration_taskPriority :: Lens' WorkflowExecutionConfiguration (Maybe Text) Source #

The priority assigned to decision tasks for this workflow execution. Valid values are integers that range from Java's Integer.MIN_VALUE (-2147483648) to Integer.MAX_VALUE (2147483647). Higher numbers indicate higher priority.

For more information about setting task priority, see Setting Task Priority in the Amazon SWF Developer Guide.

workflowExecutionConfiguration_taskStartToCloseTimeout :: Lens' WorkflowExecutionConfiguration Text Source #

The maximum duration allowed for decision tasks for this workflow execution.

The duration is specified in seconds, an integer greater than or equal to 0. You can use NONE to specify unlimited duration.

workflowExecutionConfiguration_executionStartToCloseTimeout :: Lens' WorkflowExecutionConfiguration Text Source #

The total duration for this workflow execution.

The duration is specified in seconds, an integer greater than or equal to 0. You can use NONE to specify unlimited duration.

workflowExecutionConfiguration_taskList :: Lens' WorkflowExecutionConfiguration TaskList Source #

The task list used for the decision tasks generated for this workflow execution.

workflowExecutionConfiguration_childPolicy :: Lens' WorkflowExecutionConfiguration ChildPolicy Source #

The policy to use for the child workflow executions if this workflow execution is terminated, by calling the TerminateWorkflowExecution action explicitly or due to an expired timeout.

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.