Class: Aws::SWF::Types::ContinueAsNewWorkflowExecutionDecisionAttributes

Inherits:
Struct
  • Object
show all
Includes:
Aws::Structure
Defined in:
lib/aws-sdk-swf/types.rb

Overview

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

[1]: docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dev-iam.html

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#child_policy ⇒ String

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.

<note markdown=“1”> 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.

</note>

Returns:

  • (String) 


1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
 
# File 'lib/aws-sdk-swf/types.rb', line 1106

class ContinueAsNewWorkflowExecutionDecisionAttributes < Struct.new(
  :input,
  :execution_start_to_close_timeout,
  :task_list,
  :task_priority,
  :task_start_to_close_timeout,
  :child_policy,
  :tag_list,
  :workflow_type_version,
  :lambda_role)
  SENSITIVE = []
  include Aws::Structure
end

#execution_start_to_close_timeout ⇒ String

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.

<note markdown=“1”> 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.

</note>

Returns:

  • (String) 


1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
 
# File 'lib/aws-sdk-swf/types.rb', line 1106

class ContinueAsNewWorkflowExecutionDecisionAttributes < Struct.new(
  :input,
  :execution_start_to_close_timeout,
  :task_list,
  :task_priority,
  :task_start_to_close_timeout,
  :child_policy,
  :tag_list,
  :workflow_type_version,
  :lambda_role)
  SENSITIVE = []
  include Aws::Structure
end

#input ⇒ String

The input provided to the new workflow execution.

Returns:

  • (String) 


1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
 
# File 'lib/aws-sdk-swf/types.rb', line 1106

class ContinueAsNewWorkflowExecutionDecisionAttributes < Struct.new(
  :input,
  :execution_start_to_close_timeout,
  :task_list,
  :task_priority,
  :task_start_to_close_timeout,
  :child_policy,
  :tag_list,
  :workflow_type_version,
  :lambda_role)
  SENSITIVE = []
  include Aws::Structure
end

#lambda_role ⇒ String

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

Returns:

  • (String) 


1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
 
# File 'lib/aws-sdk-swf/types.rb', line 1106

class ContinueAsNewWorkflowExecutionDecisionAttributes < Struct.new(
  :input,
  :execution_start_to_close_timeout,
  :task_list,
  :task_priority,
  :task_start_to_close_timeout,
  :child_policy,
  :tag_list,
  :workflow_type_version,
  :lambda_role)
  SENSITIVE = []
  include Aws::Structure
end

#tag_list ⇒ Array<String>

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.

Returns:

  • (Array<String>) 


1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
 
# File 'lib/aws-sdk-swf/types.rb', line 1106

class ContinueAsNewWorkflowExecutionDecisionAttributes < Struct.new(
  :input,
  :execution_start_to_close_timeout,
  :task_list,
  :task_priority,
  :task_start_to_close_timeout,
  :child_policy,
  :tag_list,
  :workflow_type_version,
  :lambda_role)
  SENSITIVE = []
  include Aws::Structure
end

#task_list ⇒ Types::TaskList

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

Returns:



1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
 
# File 'lib/aws-sdk-swf/types.rb', line 1106

class ContinueAsNewWorkflowExecutionDecisionAttributes < Struct.new(
  :input,
  :execution_start_to_close_timeout,
  :task_list,
  :task_priority,
  :task_start_to_close_timeout,
  :child_policy,
  :tag_list,
  :workflow_type_version,
  :lambda_role)
  SENSITIVE = []
  include Aws::Structure
end

#task_priority ⇒ String

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

[1]: docs.aws.amazon.com/amazonswf/latest/developerguide/programming-priority.html

Returns:

  • (String) 


1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
 
# File 'lib/aws-sdk-swf/types.rb', line 1106

class ContinueAsNewWorkflowExecutionDecisionAttributes < Struct.new(
  :input,
  :execution_start_to_close_timeout,
  :task_list,
  :task_priority,
  :task_start_to_close_timeout,
  :child_policy,
  :tag_list,
  :workflow_type_version,
  :lambda_role)
  SENSITIVE = []
  include Aws::Structure
end

#task_start_to_close_timeout ⇒ String

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.

<note markdown=“1”> 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.

</note>

Returns:

  • (String) 


1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
 
# File 'lib/aws-sdk-swf/types.rb', line 1106

class ContinueAsNewWorkflowExecutionDecisionAttributes < Struct.new(
  :input,
  :execution_start_to_close_timeout,
  :task_list,
  :task_priority,
  :task_start_to_close_timeout,
  :child_policy,
  :tag_list,
  :workflow_type_version,
  :lambda_role)
  SENSITIVE = []
  include Aws::Structure
end

#workflow_type_version ⇒ String

The version of the workflow to start.

Returns:

  • (String) 


1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
 
# File 'lib/aws-sdk-swf/types.rb', line 1106

class ContinueAsNewWorkflowExecutionDecisionAttributes < Struct.new(
  :input,
  :execution_start_to_close_timeout,
  :task_list,
  :task_priority,
  :task_start_to_close_timeout,
  :child_policy,
  :tag_list,
  :workflow_type_version,
  :lambda_role)
  SENSITIVE = []
  include Aws::Structure
end