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.ContinueAsNewWorkflowExecutionDecisionAttributes

Description

 
Synopsis

Documentation

data ContinueAsNewWorkflowExecutionDecisionAttributes Source #

Provides the details of the ContinueAsNewWorkflowExecution decision.

Access Control

You can use IAM policies to control this decision'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.
  • Constrain the following parameters by using a Condition element with the appropriate keys.

    • tag – A tag used to identify the workflow execution
    • taskList – String constraint. The key is swf:taskList.name.
    • workflowType.version – String constraint. The key is swf:workflowType.version.

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.

See: newContinueAsNewWorkflowExecutionDecisionAttributes smart constructor.

Constructors

ContinueAsNewWorkflowExecutionDecisionAttributes' 

Fields

  • tagList :: Maybe [Text]

    The list of tags to associate with the new workflow execution. A maximum of 5 tags can be specified. You can list workflow executions with a specific tag by calling ListOpenWorkflowExecutions or ListClosedWorkflowExecutions and specifying a TagFilter.

  • taskStartToCloseTimeout :: Maybe Text

    Specifies the maximum duration of decision tasks for the new workflow execution. This parameter overrides the defaultTaskStartToCloseTimout specified when registering the workflow type using RegisterWorkflowType.

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

    A task start-to-close timeout for the new 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 task start-to-close timeout was specified at registration time then a fault is returned.

  • lambdaRole :: Maybe Text

    The IAM role to attach to the new (continued) execution.

  • input :: Maybe Text

    The input provided to the new workflow execution.

  • workflowTypeVersion :: Maybe Text

    The version of the workflow to start.

  • executionStartToCloseTimeout :: Maybe Text

    If set, specifies the total duration for this workflow execution. This overrides the defaultExecutionStartToCloseTimeout specified when registering the workflow type.

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

    An execution start-to-close timeout for this workflow execution must be specified either as a default for the workflow type or through this field. If neither this field is set nor a default execution start-to-close timeout was specified at registration time then a fault is returned.

  • taskList :: Maybe TaskList

    The task list to use for the decisions of the new (continued) workflow execution.

  • taskPriority :: Maybe Text

    The task priority that, if set, specifies the priority for the decision tasks for this workflow execution. This overrides the defaultTaskPriority specified when registering the workflow type. 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.

  • childPolicy :: Maybe ChildPolicy

    If set, specifies the policy to use for the child workflow executions of the new execution if it is terminated by calling the TerminateWorkflowExecution action explicitly or due to an expired timeout. This policy overrides the default child policy specified when registering the workflow type using RegisterWorkflowType.

    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.

Instances

Instances details
Eq ContinueAsNewWorkflowExecutionDecisionAttributes Source # 
Instance details

Defined in Amazonka.SWF.Types.ContinueAsNewWorkflowExecutionDecisionAttributes

Read ContinueAsNewWorkflowExecutionDecisionAttributes Source # 
Instance details

Defined in Amazonka.SWF.Types.ContinueAsNewWorkflowExecutionDecisionAttributes

Show ContinueAsNewWorkflowExecutionDecisionAttributes Source # 
Instance details

Defined in Amazonka.SWF.Types.ContinueAsNewWorkflowExecutionDecisionAttributes

Generic ContinueAsNewWorkflowExecutionDecisionAttributes Source # 
Instance details

Defined in Amazonka.SWF.Types.ContinueAsNewWorkflowExecutionDecisionAttributes

NFData ContinueAsNewWorkflowExecutionDecisionAttributes Source # 
Instance details

Defined in Amazonka.SWF.Types.ContinueAsNewWorkflowExecutionDecisionAttributes

Hashable ContinueAsNewWorkflowExecutionDecisionAttributes Source # 
Instance details

Defined in Amazonka.SWF.Types.ContinueAsNewWorkflowExecutionDecisionAttributes

ToJSON ContinueAsNewWorkflowExecutionDecisionAttributes Source # 
Instance details

Defined in Amazonka.SWF.Types.ContinueAsNewWorkflowExecutionDecisionAttributes

type Rep ContinueAsNewWorkflowExecutionDecisionAttributes Source # 
Instance details

Defined in Amazonka.SWF.Types.ContinueAsNewWorkflowExecutionDecisionAttributes

type Rep ContinueAsNewWorkflowExecutionDecisionAttributes = D1 ('MetaData "ContinueAsNewWorkflowExecutionDecisionAttributes" "Amazonka.SWF.Types.ContinueAsNewWorkflowExecutionDecisionAttributes" "libZSservicesZSamazonka-swfZSamazonka-swf" 'False) (C1 ('MetaCons "ContinueAsNewWorkflowExecutionDecisionAttributes'" 'PrefixI 'True) (((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 "workflowTypeVersion") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "executionStartToCloseTimeout") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "taskList") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe TaskList)) :*: (S1 ('MetaSel ('Just "taskPriority") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "childPolicy") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ChildPolicy)))))))

newContinueAsNewWorkflowExecutionDecisionAttributes :: ContinueAsNewWorkflowExecutionDecisionAttributes Source #

Create a value of ContinueAsNewWorkflowExecutionDecisionAttributes 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:tagList:ContinueAsNewWorkflowExecutionDecisionAttributes', continueAsNewWorkflowExecutionDecisionAttributes_tagList - The list of tags to associate with the new workflow execution. A maximum of 5 tags can be specified. You can list workflow executions with a specific tag by calling ListOpenWorkflowExecutions or ListClosedWorkflowExecutions and specifying a TagFilter.

$sel:taskStartToCloseTimeout:ContinueAsNewWorkflowExecutionDecisionAttributes', continueAsNewWorkflowExecutionDecisionAttributes_taskStartToCloseTimeout - Specifies the maximum duration of decision tasks for the new workflow execution. This parameter overrides the defaultTaskStartToCloseTimout specified when registering the workflow type using RegisterWorkflowType.

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

A task start-to-close timeout for the new 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 task start-to-close timeout was specified at registration time then a fault is returned.

$sel:lambdaRole:ContinueAsNewWorkflowExecutionDecisionAttributes', continueAsNewWorkflowExecutionDecisionAttributes_lambdaRole - The IAM role to attach to the new (continued) execution.

$sel:input:ContinueAsNewWorkflowExecutionDecisionAttributes', continueAsNewWorkflowExecutionDecisionAttributes_input - The input provided to the new workflow execution.

$sel:workflowTypeVersion:ContinueAsNewWorkflowExecutionDecisionAttributes', continueAsNewWorkflowExecutionDecisionAttributes_workflowTypeVersion - The version of the workflow to start.

$sel:executionStartToCloseTimeout:ContinueAsNewWorkflowExecutionDecisionAttributes', continueAsNewWorkflowExecutionDecisionAttributes_executionStartToCloseTimeout - If set, specifies the total duration for this workflow execution. This overrides the defaultExecutionStartToCloseTimeout specified when registering the workflow type.

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

An execution start-to-close timeout for this workflow execution must be specified either as a default for the workflow type or through this field. If neither this field is set nor a default execution start-to-close timeout was specified at registration time then a fault is returned.

$sel:taskList:ContinueAsNewWorkflowExecutionDecisionAttributes', continueAsNewWorkflowExecutionDecisionAttributes_taskList - The task list to use for the decisions of the new (continued) workflow execution.

$sel:taskPriority:ContinueAsNewWorkflowExecutionDecisionAttributes', continueAsNewWorkflowExecutionDecisionAttributes_taskPriority - The task priority that, if set, specifies the priority for the decision tasks for this workflow execution. This overrides the defaultTaskPriority specified when registering the workflow type. 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:childPolicy:ContinueAsNewWorkflowExecutionDecisionAttributes', continueAsNewWorkflowExecutionDecisionAttributes_childPolicy - If set, specifies the policy to use for the child workflow executions of the new execution if it is terminated by calling the TerminateWorkflowExecution action explicitly or due to an expired timeout. This policy overrides the default child policy specified when registering the workflow type using RegisterWorkflowType.

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.

continueAsNewWorkflowExecutionDecisionAttributes_tagList :: Lens' ContinueAsNewWorkflowExecutionDecisionAttributes (Maybe [Text]) Source #

The list of tags to associate with the new workflow execution. A maximum of 5 tags can be specified. You can list workflow executions with a specific tag by calling ListOpenWorkflowExecutions or ListClosedWorkflowExecutions and specifying a TagFilter.

continueAsNewWorkflowExecutionDecisionAttributes_taskStartToCloseTimeout :: Lens' ContinueAsNewWorkflowExecutionDecisionAttributes (Maybe Text) Source #

Specifies the maximum duration of decision tasks for the new workflow execution. This parameter overrides the defaultTaskStartToCloseTimout specified when registering the workflow type using RegisterWorkflowType.

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

A task start-to-close timeout for the new 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 task start-to-close timeout was specified at registration time then a fault is returned.

continueAsNewWorkflowExecutionDecisionAttributes_executionStartToCloseTimeout :: Lens' ContinueAsNewWorkflowExecutionDecisionAttributes (Maybe Text) Source #

If set, specifies the total duration for this workflow execution. This overrides the defaultExecutionStartToCloseTimeout specified when registering the workflow type.

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

An execution start-to-close timeout for this workflow execution must be specified either as a default for the workflow type or through this field. If neither this field is set nor a default execution start-to-close timeout was specified at registration time then a fault is returned.

continueAsNewWorkflowExecutionDecisionAttributes_taskList :: Lens' ContinueAsNewWorkflowExecutionDecisionAttributes (Maybe TaskList) Source #

The task list to use for the decisions of the new (continued) workflow execution.

continueAsNewWorkflowExecutionDecisionAttributes_taskPriority :: Lens' ContinueAsNewWorkflowExecutionDecisionAttributes (Maybe Text) Source #

The task priority that, if set, specifies the priority for the decision tasks for this workflow execution. This overrides the defaultTaskPriority specified when registering the workflow type. 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.

continueAsNewWorkflowExecutionDecisionAttributes_childPolicy :: Lens' ContinueAsNewWorkflowExecutionDecisionAttributes (Maybe ChildPolicy) Source #

If set, specifies the policy to use for the child workflow executions of the new execution if it is terminated by calling the TerminateWorkflowExecution action explicitly or due to an expired timeout. This policy overrides the default child policy specified when registering the workflow type using RegisterWorkflowType.

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.