Class: Aws::SWF::Types::StartWorkflowExecutionInput
- Inherits:
-
Struct
- Object
- Struct
- Aws::SWF::Types::StartWorkflowExecutionInput
- Defined in:
- gems/aws-sdk-swf/lib/aws-sdk-swf/types.rb
Constant Summary collapse
- SENSITIVE =
[]
Instance Attribute Summary collapse
-
#child_policy ⇒ String
If set, specifies the policy to use for the child workflow executions of this workflow execution if it is terminated, by calling the TerminateWorkflowExecution action explicitly or due to an expired timeout.
-
#domain ⇒ String
The name of the domain in which the workflow execution is created.
-
#execution_start_to_close_timeout ⇒ String
The total duration for this workflow execution.
-
#input ⇒ String
The input for the workflow execution.
-
#lambda_role ⇒ String
The IAM role to attach to this workflow execution.
-
#tag_list ⇒ Array<String>
The list of tags to associate with the workflow execution.
-
#task_list ⇒ Types::TaskList
The task list to use for the decision tasks generated for this workflow execution.
-
#task_priority ⇒ String
The task priority to use for this workflow execution.
-
#task_start_to_close_timeout ⇒ String
Specifies the maximum duration of decision tasks for this workflow execution.
-
#workflow_id ⇒ String
The user defined identifier associated with the workflow execution.
-
#workflow_type ⇒ Types::WorkflowType
The type of the workflow to start.
Instance Attribute Details
#child_policy ⇒ String
If set, specifies the policy to use for the child workflow executions of this workflow 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 aWorkflowExecutionCancelRequested
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.
5349 5350 5351 5352 5353 5354 5355 5356 5357 5358 5359 5360 5361 5362 5363 |
# File 'gems/aws-sdk-swf/lib/aws-sdk-swf/types.rb', line 5349 class StartWorkflowExecutionInput < Struct.new( :domain, :workflow_id, :workflow_type, :task_list, :task_priority, :input, :execution_start_to_close_timeout, :tag_list, :task_start_to_close_timeout, :child_policy, :lambda_role) SENSITIVE = [] include Aws::Structure end |
#domain ⇒ String
The name of the domain in which the workflow execution is created.
The specified string must not contain a :
(colon), /
(slash),
|
(vertical bar), or any control characters (\u0000-\u001f
|
\u007f-\u009f
). Also, it must not be the literal string arn
.
5349 5350 5351 5352 5353 5354 5355 5356 5357 5358 5359 5360 5361 5362 5363 |
# File 'gems/aws-sdk-swf/lib/aws-sdk-swf/types.rb', line 5349 class StartWorkflowExecutionInput < Struct.new( :domain, :workflow_id, :workflow_type, :task_list, :task_priority, :input, :execution_start_to_close_timeout, :tag_list, :task_start_to_close_timeout, :child_policy, :lambda_role) SENSITIVE = [] include Aws::Structure end |
#execution_start_to_close_timeout ⇒ String
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
. Exceeding this limit causes the workflow execution to
time out. Unlike some of the other timeout parameters in Amazon SWF,
you cannot specify a value of "NONE" for this timeout; there is a
one-year max limit on the time that a workflow execution can run.
5349 5350 5351 5352 5353 5354 5355 5356 5357 5358 5359 5360 5361 5362 5363 |
# File 'gems/aws-sdk-swf/lib/aws-sdk-swf/types.rb', line 5349 class StartWorkflowExecutionInput < Struct.new( :domain, :workflow_id, :workflow_type, :task_list, :task_priority, :input, :execution_start_to_close_timeout, :tag_list, :task_start_to_close_timeout, :child_policy, :lambda_role) SENSITIVE = [] include Aws::Structure end |
#input ⇒ String
The input for the workflow execution. This is a free form string
which should be meaningful to the workflow you are starting. This
input
is made available to the new workflow execution in the
WorkflowExecutionStarted
history event.
5349 5350 5351 5352 5353 5354 5355 5356 5357 5358 5359 5360 5361 5362 5363 |
# File 'gems/aws-sdk-swf/lib/aws-sdk-swf/types.rb', line 5349 class StartWorkflowExecutionInput < Struct.new( :domain, :workflow_id, :workflow_type, :task_list, :task_priority, :input, :execution_start_to_close_timeout, :tag_list, :task_start_to_close_timeout, :child_policy, :lambda_role) SENSITIVE = [] include Aws::Structure end |
#lambda_role ⇒ String
The IAM role to attach to this workflow execution.
ScheduleLambdaFunctionFailed
history event. For more information,
see
https://docs.aws.amazon.com/amazonswf/latest/developerguide/lambda-task.html
in the Amazon SWF Developer Guide.
5349 5350 5351 5352 5353 5354 5355 5356 5357 5358 5359 5360 5361 5362 5363 |
# File 'gems/aws-sdk-swf/lib/aws-sdk-swf/types.rb', line 5349 class StartWorkflowExecutionInput < Struct.new( :domain, :workflow_id, :workflow_type, :task_list, :task_priority, :input, :execution_start_to_close_timeout, :tag_list, :task_start_to_close_timeout, :child_policy, :lambda_role) SENSITIVE = [] include Aws::Structure end |
#tag_list ⇒ Array<String>
The list of tags to associate with the workflow execution. You can specify a maximum of 5 tags. You can list workflow executions with a specific tag by calling ListOpenWorkflowExecutions or ListClosedWorkflowExecutions and specifying a TagFilter.
5349 5350 5351 5352 5353 5354 5355 5356 5357 5358 5359 5360 5361 5362 5363 |
# File 'gems/aws-sdk-swf/lib/aws-sdk-swf/types.rb', line 5349 class StartWorkflowExecutionInput < Struct.new( :domain, :workflow_id, :workflow_type, :task_list, :task_priority, :input, :execution_start_to_close_timeout, :tag_list, :task_start_to_close_timeout, :child_policy, :lambda_role) SENSITIVE = [] include Aws::Structure end |
#task_list ⇒ Types::TaskList
The task list to use for the decision tasks generated for this
workflow execution. This overrides the defaultTaskList
specified
when registering the workflow type.
The specified string must not contain a :
(colon), /
(slash),
|
(vertical bar), or any control characters (\u0000-\u001f
|
\u007f-\u009f
). Also, it must not be the literal string arn
.
5349 5350 5351 5352 5353 5354 5355 5356 5357 5358 5359 5360 5361 5362 5363 |
# File 'gems/aws-sdk-swf/lib/aws-sdk-swf/types.rb', line 5349 class StartWorkflowExecutionInput < Struct.new( :domain, :workflow_id, :workflow_type, :task_list, :task_priority, :input, :execution_start_to_close_timeout, :tag_list, :task_start_to_close_timeout, :child_policy, :lambda_role) SENSITIVE = [] include Aws::Structure end |
#task_priority ⇒ String
The task priority to use for this workflow execution. This overrides
any default priority that was assigned when the workflow type was
registered. If not set, then the default task priority for the
workflow type is used. 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.
5349 5350 5351 5352 5353 5354 5355 5356 5357 5358 5359 5360 5361 5362 5363 |
# File 'gems/aws-sdk-swf/lib/aws-sdk-swf/types.rb', line 5349 class StartWorkflowExecutionInput < Struct.new( :domain, :workflow_id, :workflow_type, :task_list, :task_priority, :input, :execution_start_to_close_timeout, :tag_list, :task_start_to_close_timeout, :child_policy, :lambda_role) SENSITIVE = [] include Aws::Structure end |
#task_start_to_close_timeout ⇒ String
Specifies the maximum duration of decision tasks for this 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.
5349 5350 5351 5352 5353 5354 5355 5356 5357 5358 5359 5360 5361 5362 5363 |
# File 'gems/aws-sdk-swf/lib/aws-sdk-swf/types.rb', line 5349 class StartWorkflowExecutionInput < Struct.new( :domain, :workflow_id, :workflow_type, :task_list, :task_priority, :input, :execution_start_to_close_timeout, :tag_list, :task_start_to_close_timeout, :child_policy, :lambda_role) SENSITIVE = [] include Aws::Structure end |
#workflow_id ⇒ String
The user defined identifier associated with the workflow execution.
You can use this to associate a custom identifier with the workflow
execution. You may specify the same identifier if a workflow
execution is logically a restart of a previous execution. You
cannot have two open workflow executions with the same workflowId
at the same time within the same domain.
The specified string must not contain a :
(colon), /
(slash),
|
(vertical bar), or any control characters (\u0000-\u001f
|
\u007f-\u009f
). Also, it must not be the literal string arn
.
5349 5350 5351 5352 5353 5354 5355 5356 5357 5358 5359 5360 5361 5362 5363 |
# File 'gems/aws-sdk-swf/lib/aws-sdk-swf/types.rb', line 5349 class StartWorkflowExecutionInput < Struct.new( :domain, :workflow_id, :workflow_type, :task_list, :task_priority, :input, :execution_start_to_close_timeout, :tag_list, :task_start_to_close_timeout, :child_policy, :lambda_role) SENSITIVE = [] include Aws::Structure end |
#workflow_type ⇒ Types::WorkflowType
The type of the workflow to start.
5349 5350 5351 5352 5353 5354 5355 5356 5357 5358 5359 5360 5361 5362 5363 |
# File 'gems/aws-sdk-swf/lib/aws-sdk-swf/types.rb', line 5349 class StartWorkflowExecutionInput < Struct.new( :domain, :workflow_id, :workflow_type, :task_list, :task_priority, :input, :execution_start_to_close_timeout, :tag_list, :task_start_to_close_timeout, :child_policy, :lambda_role) SENSITIVE = [] include Aws::Structure end |