swf/aws.sdk.kotlin.services.swf.model/StartWorkflowExecutionRequest

StartWorkflowExecutionRequest

class StartWorkflowExecutionRequest

Types

Builder

class Builder

Companion

object Companion

Properties

childPolicy

val childPolicy: ChildPolicy?

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.

domain

val domain: String?

The name of the domain in which the workflow execution is created.

executionStartToCloseTimeout

val executionStartToCloseTimeout: String?

The total duration for this workflow execution. This overrides the defaultExecutionStartToCloseTimeout specified when registering the workflow type.

input

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

lambdaRole

val lambdaRole: String?

The IAM role to attach to this workflow execution.

tagList

val tagList: List<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.

taskList

val taskList: 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.

taskPriority

val taskPriority: 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.

taskStartToCloseTimeout

val taskStartToCloseTimeout: 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.

workflowId

val workflowId: 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.

workflowType

val workflowType: WorkflowType?

The type of the workflow to start.

Functions

copy

inline fun copy(block: StartWorkflowExecutionRequest.Builder.() -> Unit = {}): StartWorkflowExecutionRequest

equals

open operator override fun equals(other: Any?): Boolean

hashCode

open override fun hashCode(): Int

toString

open override fun toString(): String