libZSservicesZSamazonka-swfZSamazonka-swf
Copyright(c) 2013-2021 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone

Amazonka.SWF.Types.StartChildWorkflowExecutionInitiatedEventAttributes

Description

 
Synopsis

Documentation

data StartChildWorkflowExecutionInitiatedEventAttributes Source #

Provides the details of the StartChildWorkflowExecutionInitiated event.

See: newStartChildWorkflowExecutionInitiatedEventAttributes smart constructor.

Constructors

StartChildWorkflowExecutionInitiatedEventAttributes' 

Fields

  • control :: Maybe Text

    Data attached to the event that can be used by the decider in subsequent decision tasks. This data isn't sent to the activity.

  • tagList :: Maybe [Text]

    The list of tags to associated with the child workflow execution.

  • taskStartToCloseTimeout :: Maybe Text

    The maximum duration allowed for the 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.

  • lambdaRole :: Maybe Text

    The IAM role to attach to the child workflow execution.

  • input :: Maybe Text

    The inputs provided to the child workflow execution.

  • executionStartToCloseTimeout :: Maybe Text

    The maximum duration for the child workflow execution. If the workflow execution isn't closed within this duration, it is timed out and force-terminated.

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

  • taskPriority :: Maybe Text

    The priority assigned for the 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.

  • workflowId :: Text

    The workflowId of the child workflow execution.

  • workflowType :: WorkflowType

    The type of the child workflow execution.

  • taskList :: TaskList

    The name of the task list used for the decision tasks of the child workflow execution.

  • decisionTaskCompletedEventId :: Integer

    The ID of the DecisionTaskCompleted event corresponding to the decision task that resulted in the StartChildWorkflowExecution Decision to request this child workflow execution. This information can be useful for diagnosing problems by tracing back the cause of events.

  • childPolicy :: ChildPolicy

    The policy to use for the child workflow executions if this execution gets terminated by explicitly calling the TerminateWorkflowExecution action 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 StartChildWorkflowExecutionInitiatedEventAttributes Source # 
Instance details

Defined in Amazonka.SWF.Types.StartChildWorkflowExecutionInitiatedEventAttributes

Read StartChildWorkflowExecutionInitiatedEventAttributes Source # 
Instance details

Defined in Amazonka.SWF.Types.StartChildWorkflowExecutionInitiatedEventAttributes

Show StartChildWorkflowExecutionInitiatedEventAttributes Source # 
Instance details

Defined in Amazonka.SWF.Types.StartChildWorkflowExecutionInitiatedEventAttributes

Generic StartChildWorkflowExecutionInitiatedEventAttributes Source # 
Instance details

Defined in Amazonka.SWF.Types.StartChildWorkflowExecutionInitiatedEventAttributes

NFData StartChildWorkflowExecutionInitiatedEventAttributes Source # 
Instance details

Defined in Amazonka.SWF.Types.StartChildWorkflowExecutionInitiatedEventAttributes

Hashable StartChildWorkflowExecutionInitiatedEventAttributes Source # 
Instance details

Defined in Amazonka.SWF.Types.StartChildWorkflowExecutionInitiatedEventAttributes

FromJSON StartChildWorkflowExecutionInitiatedEventAttributes Source # 
Instance details

Defined in Amazonka.SWF.Types.StartChildWorkflowExecutionInitiatedEventAttributes

type Rep StartChildWorkflowExecutionInitiatedEventAttributes Source # 
Instance details

Defined in Amazonka.SWF.Types.StartChildWorkflowExecutionInitiatedEventAttributes

type Rep StartChildWorkflowExecutionInitiatedEventAttributes = D1 ('MetaData "StartChildWorkflowExecutionInitiatedEventAttributes" "Amazonka.SWF.Types.StartChildWorkflowExecutionInitiatedEventAttributes" "libZSservicesZSamazonka-swfZSamazonka-swf" 'False) (C1 ('MetaCons "StartChildWorkflowExecutionInitiatedEventAttributes'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "control") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "tagList") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :*: S1 ('MetaSel ('Just "taskStartToCloseTimeout") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :*: (S1 ('MetaSel ('Just "lambdaRole") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "input") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "executionStartToCloseTimeout") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))) :*: ((S1 ('MetaSel ('Just "taskPriority") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "workflowId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "workflowType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 WorkflowType))) :*: (S1 ('MetaSel ('Just "taskList") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 TaskList) :*: (S1 ('MetaSel ('Just "decisionTaskCompletedEventId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Integer) :*: S1 ('MetaSel ('Just "childPolicy") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 ChildPolicy))))))

newStartChildWorkflowExecutionInitiatedEventAttributes Source #

Create a value of StartChildWorkflowExecutionInitiatedEventAttributes 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:control:StartChildWorkflowExecutionInitiatedEventAttributes', startChildWorkflowExecutionInitiatedEventAttributes_control - Data attached to the event that can be used by the decider in subsequent decision tasks. This data isn't sent to the activity.

$sel:tagList:StartChildWorkflowExecutionInitiatedEventAttributes', startChildWorkflowExecutionInitiatedEventAttributes_tagList - The list of tags to associated with the child workflow execution.

$sel:taskStartToCloseTimeout:StartChildWorkflowExecutionInitiatedEventAttributes', startChildWorkflowExecutionInitiatedEventAttributes_taskStartToCloseTimeout - The maximum duration allowed for the 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:lambdaRole:StartChildWorkflowExecutionInitiatedEventAttributes', startChildWorkflowExecutionInitiatedEventAttributes_lambdaRole - The IAM role to attach to the child workflow execution.

$sel:input:StartChildWorkflowExecutionInitiatedEventAttributes', startChildWorkflowExecutionInitiatedEventAttributes_input - The inputs provided to the child workflow execution.

$sel:executionStartToCloseTimeout:StartChildWorkflowExecutionInitiatedEventAttributes', startChildWorkflowExecutionInitiatedEventAttributes_executionStartToCloseTimeout - The maximum duration for the child workflow execution. If the workflow execution isn't closed within this duration, it is timed out and force-terminated.

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

$sel:taskPriority:StartChildWorkflowExecutionInitiatedEventAttributes', startChildWorkflowExecutionInitiatedEventAttributes_taskPriority - The priority assigned for the 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:workflowId:StartChildWorkflowExecutionInitiatedEventAttributes', startChildWorkflowExecutionInitiatedEventAttributes_workflowId - The workflowId of the child workflow execution.

$sel:workflowType:StartChildWorkflowExecutionInitiatedEventAttributes', startChildWorkflowExecutionInitiatedEventAttributes_workflowType - The type of the child workflow execution.

$sel:taskList:StartChildWorkflowExecutionInitiatedEventAttributes', startChildWorkflowExecutionInitiatedEventAttributes_taskList - The name of the task list used for the decision tasks of the child workflow execution.

$sel:decisionTaskCompletedEventId:StartChildWorkflowExecutionInitiatedEventAttributes', startChildWorkflowExecutionInitiatedEventAttributes_decisionTaskCompletedEventId - The ID of the DecisionTaskCompleted event corresponding to the decision task that resulted in the StartChildWorkflowExecution Decision to request this child workflow execution. This information can be useful for diagnosing problems by tracing back the cause of events.

$sel:childPolicy:StartChildWorkflowExecutionInitiatedEventAttributes', startChildWorkflowExecutionInitiatedEventAttributes_childPolicy - The policy to use for the child workflow executions if this execution gets terminated by explicitly calling the TerminateWorkflowExecution action 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.

startChildWorkflowExecutionInitiatedEventAttributes_control :: Lens' StartChildWorkflowExecutionInitiatedEventAttributes (Maybe Text) Source #

Data attached to the event that can be used by the decider in subsequent decision tasks. This data isn't sent to the activity.

startChildWorkflowExecutionInitiatedEventAttributes_taskStartToCloseTimeout :: Lens' StartChildWorkflowExecutionInitiatedEventAttributes (Maybe Text) Source #

The maximum duration allowed for the 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.

startChildWorkflowExecutionInitiatedEventAttributes_executionStartToCloseTimeout :: Lens' StartChildWorkflowExecutionInitiatedEventAttributes (Maybe Text) Source #

The maximum duration for the child workflow execution. If the workflow execution isn't closed within this duration, it is timed out and force-terminated.

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

startChildWorkflowExecutionInitiatedEventAttributes_taskPriority :: Lens' StartChildWorkflowExecutionInitiatedEventAttributes (Maybe Text) Source #

The priority assigned for the 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.

startChildWorkflowExecutionInitiatedEventAttributes_taskList :: Lens' StartChildWorkflowExecutionInitiatedEventAttributes TaskList Source #

The name of the task list used for the decision tasks of the child workflow execution.

startChildWorkflowExecutionInitiatedEventAttributes_decisionTaskCompletedEventId :: Lens' StartChildWorkflowExecutionInitiatedEventAttributes Integer Source #

The ID of the DecisionTaskCompleted event corresponding to the decision task that resulted in the StartChildWorkflowExecution Decision to request this child workflow execution. This information can be useful for diagnosing problems by tracing back the cause of events.

startChildWorkflowExecutionInitiatedEventAttributes_childPolicy :: Lens' StartChildWorkflowExecutionInitiatedEventAttributes ChildPolicy Source #

The policy to use for the child workflow executions if this execution gets terminated by explicitly calling the TerminateWorkflowExecution action 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.