File Coverage

blib/lib/Paws/SimpleWorkflow/WorkflowTypeConfiguration.pm
Criterion Covered Total %
statement 3 3 100.0
branch n/a
condition n/a
subroutine 1 1 100.0
pod n/a
total 4 4 100.0


line stmt bran cond sub pod time code
1             package Paws::SimpleWorkflow::WorkflowTypeConfiguration;
2 1     1   511 use Moose;
  1         4  
  1         9  
3             has DefaultChildPolicy => (is => 'ro', isa => 'Str', request_name => 'defaultChildPolicy', traits => ['NameInRequest']);
4             has DefaultExecutionStartToCloseTimeout => (is => 'ro', isa => 'Str', request_name => 'defaultExecutionStartToCloseTimeout', traits => ['NameInRequest']);
5             has DefaultLambdaRole => (is => 'ro', isa => 'Str', request_name => 'defaultLambdaRole', traits => ['NameInRequest']);
6             has DefaultTaskList => (is => 'ro', isa => 'Paws::SimpleWorkflow::TaskList', request_name => 'defaultTaskList', traits => ['NameInRequest']);
7             has DefaultTaskPriority => (is => 'ro', isa => 'Str', request_name => 'defaultTaskPriority', traits => ['NameInRequest']);
8             has DefaultTaskStartToCloseTimeout => (is => 'ro', isa => 'Str', request_name => 'defaultTaskStartToCloseTimeout', traits => ['NameInRequest']);
9             1;
10              
11             ### main pod documentation begin ###
12              
13             =head1 NAME
14              
15             Paws::SimpleWorkflow::WorkflowTypeConfiguration
16              
17             =head1 USAGE
18              
19             This class represents one of two things:
20              
21             =head3 Arguments in a call to a service
22              
23             Use the attributes of this class as arguments to methods. You shouldn't make instances of this class.
24             Each attribute should be used as a named argument in the calls that expect this type of object.
25              
26             As an example, if Att1 is expected to be a Paws::SimpleWorkflow::WorkflowTypeConfiguration object:
27              
28             $service_obj->Method(Att1 => { DefaultChildPolicy => $value, ..., DefaultTaskStartToCloseTimeout => $value });
29              
30             =head3 Results returned from an API call
31              
32             Use accessors for each attribute. If Att1 is expected to be an Paws::SimpleWorkflow::WorkflowTypeConfiguration object:
33              
34             $result = $service_obj->Method(...);
35             $result->Att1->DefaultChildPolicy
36              
37             =head1 DESCRIPTION
38              
39             The configuration settings of a workflow type.
40              
41             =head1 ATTRIBUTES
42              
43              
44             =head2 DefaultChildPolicy => Str
45              
46             The default policy to use for the child workflow executions when a
47             workflow execution of this type is terminated, by calling the
48             TerminateWorkflowExecution action explicitly or due to an expired
49             timeout. This default can be overridden when starting a workflow
50             execution using the StartWorkflowExecution action or the
51             C<StartChildWorkflowExecution> Decision.
52              
53             The supported child policies are:
54              
55             =over
56              
57             =item *
58              
59             C<TERMINATE> E<ndash> The child executions are terminated.
60              
61             =item *
62              
63             C<REQUEST_CANCEL> E<ndash> A request to cancel is attempted for each
64             child execution by recording a C<WorkflowExecutionCancelRequested>
65             event in its history. It is up to the decider to take appropriate
66             actions when it receives an execution history with this event.
67              
68             =item *
69              
70             C<ABANDON> E<ndash> No action is taken. The child executions continue
71             to run.
72              
73             =back
74              
75              
76              
77             =head2 DefaultExecutionStartToCloseTimeout => Str
78              
79             The default maximum duration, specified when registering the workflow
80             type, for executions of this workflow type. This default can be
81             overridden when starting a workflow execution using the
82             StartWorkflowExecution action or the C<StartChildWorkflowExecution>
83             Decision.
84              
85             The duration is specified in seconds, an integer greater than or equal
86             to C<0>. You can use C<NONE> to specify unlimited duration.
87              
88              
89             =head2 DefaultLambdaRole => Str
90              
91             The default IAM role attached to this workflow type.
92              
93             Executions of this workflow type need IAM roles to invoke Lambda
94             functions. If you don't specify an IAM role when starting this workflow
95             type, the default Lambda role is attached to the execution. For more
96             information, see
97             http://docs.aws.amazon.com/amazonswf/latest/developerguide/lambda-task.html
98             in the I<Amazon SWF Developer Guide>.
99              
100              
101             =head2 DefaultTaskList => L<Paws::SimpleWorkflow::TaskList>
102              
103             The default task list, specified when registering the workflow type,
104             for decisions tasks scheduled for workflow executions of this type.
105             This default can be overridden when starting a workflow execution using
106             the StartWorkflowExecution action or the C<StartChildWorkflowExecution>
107             Decision.
108              
109              
110             =head2 DefaultTaskPriority => Str
111              
112             The default task priority, specified when registering the workflow
113             type, for all decision tasks of this workflow type. This default can be
114             overridden when starting a workflow execution using the
115             StartWorkflowExecution action or the C<StartChildWorkflowExecution>
116             decision.
117              
118             Valid values are integers that range from Java's C<Integer.MIN_VALUE>
119             (-2147483648) to C<Integer.MAX_VALUE> (2147483647). Higher numbers
120             indicate higher priority.
121              
122             For more information about setting task priority, see Setting Task
123             Priority in the I<Amazon SWF Developer Guide>.
124              
125              
126             =head2 DefaultTaskStartToCloseTimeout => Str
127              
128             The default maximum duration, specified when registering the workflow
129             type, that a decision task for executions of this workflow type might
130             take before returning completion or failure. If the task doesn'tdo
131             close in the specified time then the task is automatically timed out
132             and rescheduled. If the decider eventually reports a completion or
133             failure, it is ignored. This default can be overridden when starting a
134             workflow execution using the StartWorkflowExecution action or the
135             C<StartChildWorkflowExecution> Decision.
136              
137             The duration is specified in seconds, an integer greater than or equal
138             to C<0>. You can use C<NONE> to specify unlimited duration.
139              
140              
141              
142             =head1 SEE ALSO
143              
144             This class forms part of L<Paws>, describing an object used in L<Paws::SimpleWorkflow>
145              
146             =head1 BUGS and CONTRIBUTIONS
147              
148             The source code is located here: https://github.com/pplu/aws-sdk-perl
149              
150             Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues
151              
152             =cut
153