line |
stmt |
bran |
cond |
sub |
pod |
time |
code |
1
|
|
|
|
|
|
|
|
2
|
|
|
|
|
|
|
package Paws::SimpleWorkflow::StartWorkflowExecution; |
3
|
1
|
|
|
1
|
|
605
|
use Moose; |
|
1
|
|
|
|
|
3
|
|
|
1
|
|
|
|
|
10
|
|
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
|
|
7584
|
use MooseX::ClassAttribute; |
|
1
|
|
|
|
|
4
|
|
|
1
|
|
|
|
|
12
|
|
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 * B<TERMINATE:> the child executions will be terminated. |
59
|
|
|
|
|
|
|
|
60
|
|
|
|
|
|
|
=item * B<REQUEST_CANCEL:> a request to cancel will be attempted for |
61
|
|
|
|
|
|
|
each child execution by recording a C<WorkflowExecutionCancelRequested> |
62
|
|
|
|
|
|
|
event in its history. It is up to the decider to take appropriate |
63
|
|
|
|
|
|
|
actions when it receives an execution history with this event. |
64
|
|
|
|
|
|
|
|
65
|
|
|
|
|
|
|
=item * B<ABANDON:> no action will be taken. The child executions will |
66
|
|
|
|
|
|
|
continue to run. |
67
|
|
|
|
|
|
|
|
68
|
|
|
|
|
|
|
=back |
69
|
|
|
|
|
|
|
|
70
|
|
|
|
|
|
|
A child policy for this workflow execution must be specified either as |
71
|
|
|
|
|
|
|
a default for the workflow type or through this parameter. If neither |
72
|
|
|
|
|
|
|
this parameter is set nor a default child policy was specified at |
73
|
|
|
|
|
|
|
registration time then a fault will be returned. |
74
|
|
|
|
|
|
|
|
75
|
|
|
|
|
|
|
Valid values are: C<"TERMINATE">, C<"REQUEST_CANCEL">, C<"ABANDON"> |
76
|
|
|
|
|
|
|
|
77
|
|
|
|
|
|
|
=head2 B<REQUIRED> Domain => Str |
78
|
|
|
|
|
|
|
|
79
|
|
|
|
|
|
|
The name of the domain in which the workflow execution is created. |
80
|
|
|
|
|
|
|
|
81
|
|
|
|
|
|
|
|
82
|
|
|
|
|
|
|
|
83
|
|
|
|
|
|
|
=head2 ExecutionStartToCloseTimeout => Str |
84
|
|
|
|
|
|
|
|
85
|
|
|
|
|
|
|
The total duration for this workflow execution. This overrides the |
86
|
|
|
|
|
|
|
defaultExecutionStartToCloseTimeout specified when registering the |
87
|
|
|
|
|
|
|
workflow type. |
88
|
|
|
|
|
|
|
|
89
|
|
|
|
|
|
|
The duration is specified in seconds; an integer greater than or equal |
90
|
|
|
|
|
|
|
to 0. Exceeding this limit will cause the workflow execution to time |
91
|
|
|
|
|
|
|
out. Unlike some of the other timeout parameters in Amazon SWF, you |
92
|
|
|
|
|
|
|
cannot specify a value of "NONE" for this timeout; there is a one-year |
93
|
|
|
|
|
|
|
max limit on the time that a workflow execution can run. |
94
|
|
|
|
|
|
|
|
95
|
|
|
|
|
|
|
An execution start-to-close timeout must be specified either through |
96
|
|
|
|
|
|
|
this parameter or as a default when the workflow type is registered. If |
97
|
|
|
|
|
|
|
neither this parameter nor a default execution start-to-close timeout |
98
|
|
|
|
|
|
|
is specified, a fault is returned. |
99
|
|
|
|
|
|
|
|
100
|
|
|
|
|
|
|
|
101
|
|
|
|
|
|
|
|
102
|
|
|
|
|
|
|
=head2 Input => Str |
103
|
|
|
|
|
|
|
|
104
|
|
|
|
|
|
|
The input for the workflow execution. This is a free form string which |
105
|
|
|
|
|
|
|
should be meaningful to the workflow you are starting. This C<input> is |
106
|
|
|
|
|
|
|
made available to the new workflow execution in the |
107
|
|
|
|
|
|
|
C<WorkflowExecutionStarted> history event. |
108
|
|
|
|
|
|
|
|
109
|
|
|
|
|
|
|
|
110
|
|
|
|
|
|
|
|
111
|
|
|
|
|
|
|
=head2 LambdaRole => Str |
112
|
|
|
|
|
|
|
|
113
|
|
|
|
|
|
|
The ARN of an IAM role that authorizes Amazon SWF to invoke AWS Lambda |
114
|
|
|
|
|
|
|
functions. |
115
|
|
|
|
|
|
|
|
116
|
|
|
|
|
|
|
In order for this workflow execution to invoke AWS Lambda functions, an |
117
|
|
|
|
|
|
|
appropriate IAM role must be specified either as a default for the |
118
|
|
|
|
|
|
|
workflow type or through this field. |
119
|
|
|
|
|
|
|
|
120
|
|
|
|
|
|
|
|
121
|
|
|
|
|
|
|
|
122
|
|
|
|
|
|
|
=head2 TagList => ArrayRef[Str|Undef] |
123
|
|
|
|
|
|
|
|
124
|
|
|
|
|
|
|
The list of tags to associate with the workflow execution. You can |
125
|
|
|
|
|
|
|
specify a maximum of 5 tags. You can list workflow executions with a |
126
|
|
|
|
|
|
|
specific tag by calling ListOpenWorkflowExecutions or |
127
|
|
|
|
|
|
|
ListClosedWorkflowExecutions and specifying a TagFilter. |
128
|
|
|
|
|
|
|
|
129
|
|
|
|
|
|
|
|
130
|
|
|
|
|
|
|
|
131
|
|
|
|
|
|
|
=head2 TaskList => L<Paws::SimpleWorkflow::TaskList> |
132
|
|
|
|
|
|
|
|
133
|
|
|
|
|
|
|
The task list to use for the decision tasks generated for this workflow |
134
|
|
|
|
|
|
|
execution. This overrides the C<defaultTaskList> specified when |
135
|
|
|
|
|
|
|
registering the workflow type. |
136
|
|
|
|
|
|
|
|
137
|
|
|
|
|
|
|
A task list for this workflow execution must be specified either as a |
138
|
|
|
|
|
|
|
default for the workflow type or through this parameter. If neither |
139
|
|
|
|
|
|
|
this parameter is set nor a default task list was specified at |
140
|
|
|
|
|
|
|
registration time then a fault will be returned. |
141
|
|
|
|
|
|
|
|
142
|
|
|
|
|
|
|
The specified string must not start or end with whitespace. It must not |
143
|
|
|
|
|
|
|
contain a C<:> (colon), C</> (slash), C<|> (vertical bar), or any |
144
|
|
|
|
|
|
|
control characters (\u0000-\u001f | \u007f - \u009f). Also, it must not |
145
|
|
|
|
|
|
|
contain the literal string quotarnquot. |
146
|
|
|
|
|
|
|
|
147
|
|
|
|
|
|
|
|
148
|
|
|
|
|
|
|
|
149
|
|
|
|
|
|
|
=head2 TaskPriority => Str |
150
|
|
|
|
|
|
|
|
151
|
|
|
|
|
|
|
The task priority to use for this workflow execution. This will |
152
|
|
|
|
|
|
|
override any default priority that was assigned when the workflow type |
153
|
|
|
|
|
|
|
was registered. If not set, then the default task priority for the |
154
|
|
|
|
|
|
|
workflow type will be used. Valid values are integers that range from |
155
|
|
|
|
|
|
|
Java's C<Integer.MIN_VALUE> (-2147483648) to C<Integer.MAX_VALUE> |
156
|
|
|
|
|
|
|
(2147483647). Higher numbers indicate higher priority. |
157
|
|
|
|
|
|
|
|
158
|
|
|
|
|
|
|
For more information about setting task priority, see Setting Task |
159
|
|
|
|
|
|
|
Priority in the I<Amazon Simple Workflow Developer Guide>. |
160
|
|
|
|
|
|
|
|
161
|
|
|
|
|
|
|
|
162
|
|
|
|
|
|
|
|
163
|
|
|
|
|
|
|
=head2 TaskStartToCloseTimeout => Str |
164
|
|
|
|
|
|
|
|
165
|
|
|
|
|
|
|
Specifies the maximum duration of decision tasks for this workflow |
166
|
|
|
|
|
|
|
execution. This parameter overrides the |
167
|
|
|
|
|
|
|
C<defaultTaskStartToCloseTimout> specified when registering the |
168
|
|
|
|
|
|
|
workflow type using RegisterWorkflowType. |
169
|
|
|
|
|
|
|
|
170
|
|
|
|
|
|
|
The duration is specified in seconds; an integer greater than or equal |
171
|
|
|
|
|
|
|
to 0. The value "NONE" can be used to specify unlimited duration. |
172
|
|
|
|
|
|
|
|
173
|
|
|
|
|
|
|
A task start-to-close timeout for this workflow execution must be |
174
|
|
|
|
|
|
|
specified either as a default for the workflow type or through this |
175
|
|
|
|
|
|
|
parameter. If neither this parameter is set nor a default task |
176
|
|
|
|
|
|
|
start-to-close timeout was specified at registration time then a fault |
177
|
|
|
|
|
|
|
will be returned. |
178
|
|
|
|
|
|
|
|
179
|
|
|
|
|
|
|
|
180
|
|
|
|
|
|
|
|
181
|
|
|
|
|
|
|
=head2 B<REQUIRED> WorkflowId => Str |
182
|
|
|
|
|
|
|
|
183
|
|
|
|
|
|
|
The user defined identifier associated with the workflow execution. You |
184
|
|
|
|
|
|
|
can use this to associate a custom identifier with the workflow |
185
|
|
|
|
|
|
|
execution. You may specify the same identifier if a workflow execution |
186
|
|
|
|
|
|
|
is logically a I<restart> of a previous execution. You cannot have two |
187
|
|
|
|
|
|
|
open workflow executions with the same C<workflowId> at the same time. |
188
|
|
|
|
|
|
|
|
189
|
|
|
|
|
|
|
The specified string must not start or end with whitespace. It must not |
190
|
|
|
|
|
|
|
contain a C<:> (colon), C</> (slash), C<|> (vertical bar), or any |
191
|
|
|
|
|
|
|
control characters (\u0000-\u001f | \u007f - \u009f). Also, it must not |
192
|
|
|
|
|
|
|
contain the literal string quotarnquot. |
193
|
|
|
|
|
|
|
|
194
|
|
|
|
|
|
|
|
195
|
|
|
|
|
|
|
|
196
|
|
|
|
|
|
|
=head2 B<REQUIRED> WorkflowType => L<Paws::SimpleWorkflow::WorkflowType> |
197
|
|
|
|
|
|
|
|
198
|
|
|
|
|
|
|
The type of the workflow to start. |
199
|
|
|
|
|
|
|
|
200
|
|
|
|
|
|
|
|
201
|
|
|
|
|
|
|
|
202
|
|
|
|
|
|
|
|
203
|
|
|
|
|
|
|
=head1 SEE ALSO |
204
|
|
|
|
|
|
|
|
205
|
|
|
|
|
|
|
This class forms part of L<Paws>, documenting arguments for method StartWorkflowExecution in L<Paws::SimpleWorkflow> |
206
|
|
|
|
|
|
|
|
207
|
|
|
|
|
|
|
=head1 BUGS and CONTRIBUTIONS |
208
|
|
|
|
|
|
|
|
209
|
|
|
|
|
|
|
The source code is located here: https://github.com/pplu/aws-sdk-perl |
210
|
|
|
|
|
|
|
|
211
|
|
|
|
|
|
|
Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues |
212
|
|
|
|
|
|
|
|
213
|
|
|
|
|
|
|
=cut |
214
|
|
|
|
|
|
|
|