/ 
Paws-0.46
River stage two • 9 direct dependents • 11 total dependents
/ Paws::SimpleWorkflow::StartWorkflowExecution

NAME

Paws::SimpleWorkflow::StartWorkflowExecution - Arguments for method StartWorkflowExecution on Paws::SimpleWorkflow

DESCRIPTION

This class represents the parameters used for calling the method StartWorkflowExecution on the Amazon Simple Workflow Service service. Use the attributes of this class as arguments to method StartWorkflowExecution.

You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to StartWorkflowExecution.

SYNOPSIS

my $swf = Paws->service('SimpleWorkflow');
my $Run = $swf->StartWorkflowExecution(
  Domain       => 'MyDomainName',
  WorkflowId   => 'MyWorkflowId',
  WorkflowType => {
    Name    => 'MyName',       # min: 1, max: 256
    Version => 'MyVersion',    # min: 1, max: 64

  },
  ChildPolicy                  => 'TERMINATE',                    # OPTIONAL
  ExecutionStartToCloseTimeout => 'MyDurationInSecondsOptional',  # OPTIONAL
  Input                        => 'MyData',                       # OPTIONAL
  LambdaRole                   => 'MyArn',                        # OPTIONAL
  TagList                      => [
    'MyTag', ...                                                  # max: 256
  ],    # OPTIONAL
  TaskList => {
    Name => 'MyName',    # min: 1, max: 256

  },    # OPTIONAL
  TaskPriority            => 'MyTaskPriority',                 # OPTIONAL
  TaskStartToCloseTimeout => 'MyDurationInSecondsOptional',    # OPTIONAL
);

# Results:
my $RunId = $Run->RunId;

# Returns a L<Paws::SimpleWorkflow::Run> object.

Values for attributes that are native types (Int, String, Float, etc) can passed as-is (scalar values). Values for complex Types (objects) can be passed as a HashRef. The keys and values of the hashref will be used to instance the underlying object. For the AWS API documentation, see https://docs.aws.amazon.com/goto/WebAPI/swf/StartWorkflowExecution

ATTRIBUTES

ChildPolicy => Str

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

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.

Valid values are: "TERMINATE", "REQUEST_CANCEL", "ABANDON"

REQUIRED Domain => Str

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

ExecutionStartToCloseTimeout => Str

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.

An execution start-to-close timeout must be specified either through this parameter or as a default when the workflow type is registered. If neither this parameter nor a default execution start-to-close timeout is specified, a fault is returned.

Input => Str

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 => Str

The IAM role to attach to this workflow execution.

Executions of this workflow type need IAM roles to invoke Lambda functions. If you don't attach an IAM role, any attempt to schedule a Lambda task fails. This results in a ScheduleLambdaFunctionFailed history event. 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.

TagList => ArrayRef[Str|Undef]

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 => Paws::SimpleWorkflow::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.

A task list 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 task list was specified at registration time then a fault is returned.

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.

TaskPriority => Str

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

TaskStartToCloseTimeout => Str

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.

A task start-to-close timeout 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 task start-to-close timeout was specified at registration time then a fault is returned.

REQUIRED WorkflowId => Str

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.

REQUIRED WorkflowType => Paws::SimpleWorkflow::WorkflowType

The type of the workflow to start.

SEE ALSO

This class forms part of Paws, documenting arguments for method StartWorkflowExecution in Paws::SimpleWorkflow

BUGS and CONTRIBUTIONS

The source code is located here: https://github.com/pplu/aws-sdk-perl

Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues