AWS SDK for Go (PILOT)
API Reference

PREVIEW DOCUMENTATION - This is a preview of a new format for the AWS SDK for Go API Reference documentation. For the current AWS SDK for Go API Reference, see https://docs.aws.amazon.com/sdk-for-go/api/.

We welcome your feedback on this new version of the documentation. Send your comments to aws-sdkdocs-feedback@amazon.com.

WorkflowTypeConfiguration

import "github.com/aws/aws-sdk-go/service/swf"

type WorkflowTypeConfiguration struct { DefaultChildPolicy *string `locationName:"defaultChildPolicy" type:"string" enum:"ChildPolicy"` DefaultExecutionStartToCloseTimeout *string `locationName:"defaultExecutionStartToCloseTimeout" type:"string"` DefaultLambdaRole *string `locationName:"defaultLambdaRole" min:"1" type:"string"` DefaultTaskList *TaskList `locationName:"defaultTaskList" type:"structure"` DefaultTaskPriority *string `locationName:"defaultTaskPriority" type:"string"` DefaultTaskStartToCloseTimeout *string `locationName:"defaultTaskStartToCloseTimeout" type:"string"` }

The configuration settings of a workflow type.

DefaultChildPolicy

Type: *string

The default policy to use for the child workflow executions when a workflow execution of this type is terminated, by calling the TerminateWorkflowExecution action explicitly or due to an expired timeout. This default can be overridden when starting a workflow execution using the StartWorkflowExecution action or the StartChildWorkflowExecutionDecision.

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.

DefaultExecutionStartToCloseTimeout

Type: *string

The default maximum duration, specified when registering the workflow type, for executions of this workflow type. This default can be overridden when starting a workflow execution using the StartWorkflowExecution action or the StartChildWorkflowExecutionDecision.

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

DefaultLambdaRole

Type: *string

The default IAM role attached to this workflow type.

Executions of this workflow type need IAM roles to invoke Lambda functions. If you don't specify an IAM role when starting this workflow type, the default Lambda role is attached to the execution. For more information, see https://docs.aws.amazon.com/amazonswf/latest/developerguide/lambda-task.html (https://docs.aws.amazon.com/amazonswf/latest/developerguide/lambda-task.html) in the Amazon SWF Developer Guide.

DefaultTaskList

Represents a task list.

DefaultTaskPriority

Type: *string

The default task priority, specified when registering the workflow type, for all decision tasks of this workflow type. This default can be overridden when starting a workflow execution using the StartWorkflowExecution action or the StartChildWorkflowExecution decision.

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 (https://docs.aws.amazon.com/amazonswf/latest/developerguide/programming-priority.html) in the Amazon SWF Developer Guide.

DefaultTaskStartToCloseTimeout

Type: *string

The default maximum duration, specified when registering the workflow type, that a decision task for executions of this workflow type might take before returning completion or failure. If the task doesn'tdo close in the specified time then the task is automatically timed out and rescheduled. If the decider eventually reports a completion or failure, it is ignored. This default can be overridden when starting a workflow execution using the StartWorkflowExecution action or the StartChildWorkflowExecutionDecision.

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

Method

GoString

func (s WorkflowTypeConfiguration) GoString() string

GoString returns the string representation

SetDefaultChildPolicy

func (s *WorkflowTypeConfiguration) SetDefaultChildPolicy(v string) *WorkflowTypeConfiguration

SetDefaultChildPolicy sets the DefaultChildPolicy field's value.

SetDefaultExecutionStartToCloseTimeout

func (s *WorkflowTypeConfiguration) SetDefaultExecutionStartToCloseTimeout(v string) *WorkflowTypeConfiguration

SetDefaultExecutionStartToCloseTimeout sets the DefaultExecutionStartToCloseTimeout field's value.

SetDefaultLambdaRole

func (s *WorkflowTypeConfiguration) SetDefaultLambdaRole(v string) *WorkflowTypeConfiguration

SetDefaultLambdaRole sets the DefaultLambdaRole field's value.

SetDefaultTaskList

func (s *WorkflowTypeConfiguration) SetDefaultTaskList(v *TaskList) *WorkflowTypeConfiguration

SetDefaultTaskList sets the DefaultTaskList field's value.

SetDefaultTaskPriority

func (s *WorkflowTypeConfiguration) SetDefaultTaskPriority(v string) *WorkflowTypeConfiguration

SetDefaultTaskPriority sets the DefaultTaskPriority field's value.

SetDefaultTaskStartToCloseTimeout

func (s *WorkflowTypeConfiguration) SetDefaultTaskStartToCloseTimeout(v string) *WorkflowTypeConfiguration

SetDefaultTaskStartToCloseTimeout sets the DefaultTaskStartToCloseTimeout field's value.

String

func (s WorkflowTypeConfiguration) String() string

String returns the string representation

On this page: