NAME

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

DESCRIPTION

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

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

SYNOPSIS

    my $swf = Paws->service('SimpleWorkflow');
    $swf->RegisterWorkflowType(
      Domain                              => 'MyDomainName',
      Name                                => 'MyName',
      Version                             => 'MyVersion',
      DefaultChildPolicy                  => 'TERMINATE',      # OPTIONAL
      DefaultExecutionStartToCloseTimeout =>
        'MyDurationInSecondsOptional',                         # OPTIONAL
      DefaultLambdaRole => 'MyArn',                            # OPTIONAL
      DefaultTaskList   => {
        Name => 'MyName',    # min: 1, max: 256
      },    # OPTIONAL
      DefaultTaskPriority            => 'MyTaskPriority',    # OPTIONAL
      DefaultTaskStartToCloseTimeout =>
        'MyDurationInSecondsOptional',                       # OPTIONAL
      Description => 'MyDescription',                        # OPTIONAL
    );

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/RegisterWorkflowType>

ATTRIBUTES

DefaultChildPolicy => Str

If set, specifies 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 "StartChildWorkflowExecution" Decision.

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.

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

DefaultExecutionStartToCloseTimeout => Str

If set, specifies the default maximum duration for executions of this workflow type. You can override this default when starting an execution through the StartWorkflowExecution Action or "StartChildWorkflowExecution" Decision.

The duration is specified in seconds; an integer greater than or equal to 0. Unlike some of the other timeout parameters in Amazon SWF, you cannot specify a value of "NONE" for "defaultExecutionStartToCloseTimeout"; there is a one-year max limit on the time that a workflow execution can run. Exceeding this limit always causes the workflow execution to time out.

DefaultLambdaRole => Str

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 you start 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 => Paws::SimpleWorkflow::TaskList

If set, specifies the default task list to use for scheduling decision tasks for executions of this workflow type. This default is used only if a task list isn't provided when starting the execution through the StartWorkflowExecution Action or "StartChildWorkflowExecution" Decision.

DefaultTaskPriority => Str

The default task priority to assign to the workflow type. If not assigned, then 0 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.

DefaultTaskStartToCloseTimeout => Str

If set, specifies the default maximum duration of decision tasks for this workflow type. This default can be overridden when starting a workflow execution using the StartWorkflowExecution action or the "StartChildWorkflowExecution" Decision.

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

Description => Str

Textual description of the workflow type.

REQUIRED Domain => Str

The name of the domain in which to register the workflow type.

REQUIRED Name => Str

The name of 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".

REQUIRED Version => Str

The version of the workflow type.

The workflow type consists of the name and version, the combination of which must be unique within the domain. To get a list of all currently registered workflow types, use the ListWorkflowTypes action.

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>