File Coverage

blib/lib/Paws/SimpleWorkflow/StartWorkflowExecution.pm
Criterion Covered Total %
statement 6 6 100.0
branch n/a
condition n/a
subroutine 2 2 100.0
pod n/a
total 8 8 100.0


line stmt bran cond sub pod time code
1              
2             package Paws::SimpleWorkflow::StartWorkflowExecution;
3 1     1   1051 use Moose;
  1         5  
  1         12  
4             has ChildPolicy => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'childPolicy' );
5             has Domain => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'domain' , required => 1);
6             has ExecutionStartToCloseTimeout => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'executionStartToCloseTimeout' );
7             has Input => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'input' );
8             has LambdaRole => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'lambdaRole' );
9             has TagList => (is => 'ro', isa => 'ArrayRef[Str|Undef]', traits => ['NameInRequest'], request_name => 'tagList' );
10             has TaskList => (is => 'ro', isa => 'Paws::SimpleWorkflow::TaskList', traits => ['NameInRequest'], request_name => 'taskList' );
11             has TaskPriority => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'taskPriority' );
12             has TaskStartToCloseTimeout => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'taskStartToCloseTimeout' );
13             has WorkflowId => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'workflowId' , required => 1);
14             has WorkflowType => (is => 'ro', isa => 'Paws::SimpleWorkflow::WorkflowType', traits => ['NameInRequest'], request_name => 'workflowType' , required => 1);
15              
16 1     1   7325 use MooseX::ClassAttribute;
  1         4  
  1         13  
17              
18             class_has _api_call => (isa => 'Str', is => 'ro', default => 'StartWorkflowExecution');
19             class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::SimpleWorkflow::Run');
20             class_has _result_key => (isa => 'Str', is => 'ro');
21             1;
22              
23             ### main pod documentation begin ###
24              
25             =head1 NAME
26              
27             Paws::SimpleWorkflow::StartWorkflowExecution - Arguments for method StartWorkflowExecution on Paws::SimpleWorkflow
28              
29             =head1 DESCRIPTION
30              
31             This class represents the parameters used for calling the method StartWorkflowExecution on the
32             Amazon Simple Workflow Service service. Use the attributes of this class
33             as arguments to method StartWorkflowExecution.
34              
35             You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to StartWorkflowExecution.
36              
37             As an example:
38              
39             $service_obj->StartWorkflowExecution(Att1 => $value1, Att2 => $value2, ...);
40              
41             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.
42              
43             =head1 ATTRIBUTES
44              
45              
46             =head2 ChildPolicy => Str
47              
48             If set, specifies the policy to use for the child workflow executions
49             of this workflow execution if it is terminated, by calling the
50             TerminateWorkflowExecution action explicitly or due to an expired
51             timeout. This policy overrides the default child policy specified when
52             registering the workflow type using RegisterWorkflowType.
53              
54             The supported child policies are:
55              
56             =over
57              
58             =item *
59              
60             C<TERMINATE> E<ndash> The child executions are terminated.
61              
62             =item *
63              
64             C<REQUEST_CANCEL> E<ndash> A request to cancel is attempted for each
65             child execution by recording a C<WorkflowExecutionCancelRequested>
66             event in its history. It is up to the decider to take appropriate
67             actions when it receives an execution history with this event.
68              
69             =item *
70              
71             C<ABANDON> E<ndash> No action is taken. The child executions continue
72             to run.
73              
74             =back
75              
76             A child policy for this workflow execution must be specified either as
77             a default for the workflow type or through this parameter. If neither
78             this parameter is set nor a default child policy was specified at
79             registration time then a fault is returned.
80              
81             Valid values are: C<"TERMINATE">, C<"REQUEST_CANCEL">, C<"ABANDON">
82              
83             =head2 B<REQUIRED> Domain => Str
84              
85             The name of the domain in which the workflow execution is created.
86              
87              
88              
89             =head2 ExecutionStartToCloseTimeout => Str
90              
91             The total duration for this workflow execution. This overrides the
92             defaultExecutionStartToCloseTimeout specified when registering the
93             workflow type.
94              
95             The duration is specified in seconds; an integer greater than or equal
96             to C<0>. Exceeding this limit causes the workflow execution to time
97             out. Unlike some of the other timeout parameters in Amazon SWF, you
98             cannot specify a value of "NONE" for this timeout; there is a one-year
99             max limit on the time that a workflow execution can run.
100              
101             An execution start-to-close timeout must be specified either through
102             this parameter or as a default when the workflow type is registered. If
103             neither this parameter nor a default execution start-to-close timeout
104             is specified, a fault is returned.
105              
106              
107              
108             =head2 Input => Str
109              
110             The input for the workflow execution. This is a free form string which
111             should be meaningful to the workflow you are starting. This C<input> is
112             made available to the new workflow execution in the
113             C<WorkflowExecutionStarted> history event.
114              
115              
116              
117             =head2 LambdaRole => Str
118              
119             The IAM role to attach to this workflow execution.
120              
121             Executions of this workflow type need IAM roles to invoke Lambda
122             functions. If you don't attach an IAM role, any attempt to schedule a
123             Lambda task fails. This results in a C<ScheduleLambdaFunctionFailed>
124             history event. For more information, see
125             http://docs.aws.amazon.com/amazonswf/latest/developerguide/lambda-task.html
126             in the I<Amazon SWF Developer Guide>.
127              
128              
129              
130             =head2 TagList => ArrayRef[Str|Undef]
131              
132             The list of tags to associate with the workflow execution. You can
133             specify a maximum of 5 tags. You can list workflow executions with a
134             specific tag by calling ListOpenWorkflowExecutions or
135             ListClosedWorkflowExecutions and specifying a TagFilter.
136              
137              
138              
139             =head2 TaskList => L<Paws::SimpleWorkflow::TaskList>
140              
141             The task list to use for the decision tasks generated for this workflow
142             execution. This overrides the C<defaultTaskList> specified when
143             registering the workflow type.
144              
145             A task list for this workflow execution must be specified either as a
146             default for the workflow type or through this parameter. If neither
147             this parameter is set nor a default task list was specified at
148             registration time then a fault is returned.
149              
150             The specified string must not start or end with whitespace. It must not
151             contain a C<:> (colon), C</> (slash), C<|> (vertical bar), or any
152             control characters (C<\u0000-\u001f> | C<\u007f-\u009f>). Also, it must
153             not contain the literal string C<arn>.
154              
155              
156              
157             =head2 TaskPriority => Str
158              
159             The task priority to use for this workflow execution. This overrides
160             any default priority that was assigned when the workflow type was
161             registered. If not set, then the default task priority for the workflow
162             type is used. Valid values are integers that range from Java's
163             C<Integer.MIN_VALUE> (-2147483648) to C<Integer.MAX_VALUE>
164             (2147483647). Higher numbers indicate higher priority.
165              
166             For more information about setting task priority, see Setting Task
167             Priority in the I<Amazon SWF Developer Guide>.
168              
169              
170              
171             =head2 TaskStartToCloseTimeout => Str
172              
173             Specifies the maximum duration of decision tasks for this workflow
174             execution. This parameter overrides the
175             C<defaultTaskStartToCloseTimout> specified when registering the
176             workflow type using RegisterWorkflowType.
177              
178             The duration is specified in seconds, an integer greater than or equal
179             to C<0>. You can use C<NONE> to specify unlimited duration.
180              
181             A task start-to-close timeout for this workflow execution must be
182             specified either as a default for the workflow type or through this
183             parameter. If neither this parameter is set nor a default task
184             start-to-close timeout was specified at registration time then a fault
185             is returned.
186              
187              
188              
189             =head2 B<REQUIRED> WorkflowId => Str
190              
191             The user defined identifier associated with the workflow execution. You
192             can use this to associate a custom identifier with the workflow
193             execution. You may specify the same identifier if a workflow execution
194             is logically a I<restart> of a previous execution. You cannot have two
195             open workflow executions with the same C<workflowId> at the same time.
196              
197             The specified string must not start or end with whitespace. It must not
198             contain a C<:> (colon), C</> (slash), C<|> (vertical bar), or any
199             control characters (C<\u0000-\u001f> | C<\u007f-\u009f>). Also, it must
200             not contain the literal string C<arn>.
201              
202              
203              
204             =head2 B<REQUIRED> WorkflowType => L<Paws::SimpleWorkflow::WorkflowType>
205              
206             The type of the workflow to start.
207              
208              
209              
210              
211             =head1 SEE ALSO
212              
213             This class forms part of L<Paws>, documenting arguments for method StartWorkflowExecution in L<Paws::SimpleWorkflow>
214              
215             =head1 BUGS and CONTRIBUTIONS
216              
217             The source code is located here: https://github.com/pplu/aws-sdk-perl
218              
219             Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues
220              
221             =cut
222