You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.
Class: Aws::SWF::Types::StartWorkflowExecutionInput
- Inherits:
-
Struct
- Object
- Struct
- Aws::SWF::Types::StartWorkflowExecutionInput
- Defined in:
- (unknown)
Overview
When passing StartWorkflowExecutionInput as input to an Aws::Client method, you can use a vanilla Hash:
{
domain: "DomainName", # required
workflow_id: "WorkflowId", # required
workflow_type: { # required
name: "Name", # required
version: "Version", # required
},
task_list: {
name: "Name", # required
},
task_priority: "TaskPriority",
input: "Data",
execution_start_to_close_timeout: "DurationInSecondsOptional",
tag_list: ["Tag"],
task_start_to_close_timeout: "DurationInSecondsOptional",
child_policy: "TERMINATE", # accepts TERMINATE, REQUEST_CANCEL, ABANDON
lambda_role: "Arn",
}
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.
Possible values:
- TERMINATE
- REQUEST_CANCEL
- ABANDON
#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. 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.
#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.
#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.
#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.
#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 start or end with whitespace. It 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
.
#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.
#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.
#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 start or end with whitespace. It 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
.
#workflow_type ⇒ Types::WorkflowType
The type of the workflow to start.