Amazonka.SWF.Types.WorkflowTypeConfiguration

Documentation

data WorkflowTypeConfiguration

The configuration settings of a workflow type.

See: newWorkflowTypeConfiguration smart constructor.

Constructors

WorkflowTypeConfiguration'

Fields

• defaultChildPolicy :: Maybe ChildPolicy

  The default policy to use for the child workflow executions when a workflow execution of this type is terminated, by calling the TerminateWorkflowExecution action explicitly or due to an expired timeout. This default can be overridden when starting a workflow execution using the StartWorkflowExecution action or the StartChildWorkflowExecution Decision.

  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.
• defaultExecutionStartToCloseTimeout :: Maybe Text

  The default maximum duration, specified when registering the workflow type, for executions of this workflow type. This default can be overridden when starting a workflow execution using the StartWorkflowExecution action or the StartChildWorkflowExecution Decision.

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

• defaultLambdaRole :: Maybe Text

  The default IAM role attached to this workflow type.

  Executions of this workflow type need IAM roles to invoke Lambda functions. If you don't specify an IAM role when starting this workflow type, the default Lambda role is attached to the execution. For more information, see https://docs.aws.amazon.com/amazonswf/latest/developerguide/lambda-task.html in the Amazon SWF Developer Guide.

• defaultTaskList :: Maybe TaskList

  The default task list, specified when registering the workflow type, for decisions tasks scheduled for workflow executions of this type. This default can be overridden when starting a workflow execution using the StartWorkflowExecution action or the StartChildWorkflowExecution Decision.

• defaultTaskPriority :: Maybe Text

  The default task priority, specified when registering the workflow type, for all decision tasks of this workflow type. This default can be overridden when starting a workflow execution using the StartWorkflowExecution action or the StartChildWorkflowExecution decision.

  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.

• defaultTaskStartToCloseTimeout :: Maybe Text

  The default maximum duration, specified when registering the workflow type, that a decision task for executions of this workflow type might take before returning completion or failure. If the task doesn'tdo close in the specified time then the task is automatically timed out and rescheduled. If the decider eventually reports a completion or failure, it is ignored. This default can be overridden when starting a workflow execution using the StartWorkflowExecution action or the StartChildWorkflowExecution Decision.

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

Instances

FromJSON WorkflowTypeConfiguration

Defined in Amazonka.SWF.Types.WorkflowTypeConfiguration

Methods

parseJSON :: Value -> Parser WorkflowTypeConfiguration

parseJSONList :: Value -> Parser [WorkflowTypeConfiguration]

Generic WorkflowTypeConfiguration

Defined in Amazonka.SWF.Types.WorkflowTypeConfiguration

Associated Types

type Rep WorkflowTypeConfiguration :: Type -> Type

Methods

from :: WorkflowTypeConfiguration -> Rep WorkflowTypeConfiguration x

to :: Rep WorkflowTypeConfiguration x -> WorkflowTypeConfiguration

Read WorkflowTypeConfiguration

Defined in Amazonka.SWF.Types.WorkflowTypeConfiguration

Methods

readsPrec :: Int -> ReadS WorkflowTypeConfiguration

readList :: ReadS [WorkflowTypeConfiguration]

readPrec :: ReadPrec WorkflowTypeConfiguration

readListPrec :: ReadPrec [WorkflowTypeConfiguration]

Show WorkflowTypeConfiguration

Defined in Amazonka.SWF.Types.WorkflowTypeConfiguration

Methods

showsPrec :: Int -> WorkflowTypeConfiguration -> ShowS

show :: WorkflowTypeConfiguration -> String

showList :: [WorkflowTypeConfiguration] -> ShowS

NFData WorkflowTypeConfiguration

Defined in Amazonka.SWF.Types.WorkflowTypeConfiguration

Methods

rnf :: WorkflowTypeConfiguration -> ()

Eq WorkflowTypeConfiguration

Defined in Amazonka.SWF.Types.WorkflowTypeConfiguration

Methods

(==) :: WorkflowTypeConfiguration -> WorkflowTypeConfiguration -> Bool

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

Hashable WorkflowTypeConfiguration

Defined in Amazonka.SWF.Types.WorkflowTypeConfiguration

Methods

hashWithSalt :: Int -> WorkflowTypeConfiguration -> Int

hash :: WorkflowTypeConfiguration -> Int

type Rep WorkflowTypeConfiguration

Defined in Amazonka.SWF.Types.WorkflowTypeConfiguration

type Rep WorkflowTypeConfiguration = D1 ('MetaData "WorkflowTypeConfiguration" "Amazonka.SWF.Types.WorkflowTypeConfiguration" "amazonka-swf-2.0-DdTBZQl9wbxDbv1sov8BbM" 'False) (C1 ('MetaCons "WorkflowTypeConfiguration'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "defaultChildPolicy") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ChildPolicy)) :*: (S1 ('MetaSel ('Just "defaultExecutionStartToCloseTimeout") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "defaultLambdaRole") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :*: (S1 ('MetaSel ('Just "defaultTaskList") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe TaskList)) :*: (S1 ('MetaSel ('Just "defaultTaskPriority") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "defaultTaskStartToCloseTimeout") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))))

newWorkflowTypeConfiguration :: WorkflowTypeConfiguration

Create a value of WorkflowTypeConfiguration 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:defaultChildPolicy:WorkflowTypeConfiguration', workflowTypeConfiguration_defaultChildPolicy - The default policy to use for the child workflow executions when a workflow execution of this type is terminated, by calling the TerminateWorkflowExecution action explicitly or due to an expired timeout. This default can be overridden when starting a workflow execution using the StartWorkflowExecution action or the StartChildWorkflowExecution Decision.

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.

$sel:defaultExecutionStartToCloseTimeout:WorkflowTypeConfiguration', workflowTypeConfiguration_defaultExecutionStartToCloseTimeout - The default maximum duration, specified when registering the workflow type, for executions of this workflow type. This default can be overridden when starting a workflow execution using the StartWorkflowExecution action or the StartChildWorkflowExecution Decision.

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

$sel:defaultLambdaRole:WorkflowTypeConfiguration', workflowTypeConfiguration_defaultLambdaRole - The default IAM role attached to this workflow type.

Executions of this workflow type need IAM roles to invoke Lambda functions. If you don't specify an IAM role when starting this workflow type, the default Lambda role is attached to the execution. For more information, see https://docs.aws.amazon.com/amazonswf/latest/developerguide/lambda-task.html in the Amazon SWF Developer Guide.

$sel:defaultTaskList:WorkflowTypeConfiguration', workflowTypeConfiguration_defaultTaskList - The default task list, specified when registering the workflow type, for decisions tasks scheduled for workflow executions of this type. This default can be overridden when starting a workflow execution using the StartWorkflowExecution action or the StartChildWorkflowExecution Decision.

$sel:defaultTaskPriority:WorkflowTypeConfiguration', workflowTypeConfiguration_defaultTaskPriority - The default task priority, specified when registering the workflow type, for all decision tasks of this workflow type. This default can be overridden when starting a workflow execution using the StartWorkflowExecution action or the StartChildWorkflowExecution decision.

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:defaultTaskStartToCloseTimeout:WorkflowTypeConfiguration', workflowTypeConfiguration_defaultTaskStartToCloseTimeout - The default maximum duration, specified when registering the workflow type, that a decision task for executions of this workflow type might take before returning completion or failure. If the task doesn'tdo close in the specified time then the task is automatically timed out and rescheduled. If the decider eventually reports a completion or failure, it is ignored. This default can be overridden when starting a workflow execution using the StartWorkflowExecution action or the StartChildWorkflowExecution Decision.

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

workflowTypeConfiguration_defaultChildPolicy :: Lens' WorkflowTypeConfiguration (Maybe ChildPolicy)

The default policy to use for the child workflow executions when a workflow execution of this type is terminated, by calling the TerminateWorkflowExecution action explicitly or due to an expired timeout. This default can be overridden when starting a workflow execution using the StartWorkflowExecution action or the StartChildWorkflowExecution Decision.

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.

workflowTypeConfiguration_defaultExecutionStartToCloseTimeout :: Lens' WorkflowTypeConfiguration (Maybe Text)

The default maximum duration, specified when registering the workflow type, for executions of this workflow type. This default can be overridden when starting a workflow execution using the StartWorkflowExecution action or the StartChildWorkflowExecution Decision.

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

workflowTypeConfiguration_defaultLambdaRole :: Lens' WorkflowTypeConfiguration (Maybe Text)

The default IAM role attached to this workflow type.

Executions of this workflow type need IAM roles to invoke Lambda functions. If you don't specify an IAM role when starting this workflow type, the default Lambda role is attached to the execution. For more information, see https://docs.aws.amazon.com/amazonswf/latest/developerguide/lambda-task.html in the Amazon SWF Developer Guide.

workflowTypeConfiguration_defaultTaskList :: Lens' WorkflowTypeConfiguration (Maybe TaskList)

The default task list, specified when registering the workflow type, for decisions tasks scheduled for workflow executions of this type. This default can be overridden when starting a workflow execution using the StartWorkflowExecution action or the StartChildWorkflowExecution Decision.

workflowTypeConfiguration_defaultTaskPriority :: Lens' WorkflowTypeConfiguration (Maybe Text)

The default task priority, specified when registering the workflow type, for all decision tasks of this workflow type. This default can be overridden when starting a workflow execution using the StartWorkflowExecution action or the StartChildWorkflowExecution decision.

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.

workflowTypeConfiguration_defaultTaskStartToCloseTimeout :: Lens' WorkflowTypeConfiguration (Maybe Text)

The default maximum duration, specified when registering the workflow type, that a decision task for executions of this workflow type might take before returning completion or failure. If the task doesn'tdo close in the specified time then the task is automatically timed out and rescheduled. If the decider eventually reports a completion or failure, it is ignored. This default can be overridden when starting a workflow execution using the StartWorkflowExecution action or the StartChildWorkflowExecution Decision.

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