File Coverage

blib/lib/Paws/SimpleWorkflow/TerminateWorkflowExecution.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::TerminateWorkflowExecution;
3 1     1   663 use Moose;
  1         5  
  1         12  
4             has ChildPolicy => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'childPolicy' );
5             has Details => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'details' );
6             has Domain => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'domain' , required => 1);
7             has Reason => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'reason' );
8             has RunId => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'runId' );
9             has WorkflowId => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'workflowId' , required => 1);
10              
11 1     1   6922 use MooseX::ClassAttribute;
  1         4  
  1         9  
12              
13             class_has _api_call => (isa => 'Str', is => 'ro', default => 'TerminateWorkflowExecution');
14             class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::API::Response');
15             class_has _result_key => (isa => 'Str', is => 'ro');
16             1;
17              
18             ### main pod documentation begin ###
19              
20             =head1 NAME
21              
22             Paws::SimpleWorkflow::TerminateWorkflowExecution - Arguments for method TerminateWorkflowExecution on Paws::SimpleWorkflow
23              
24             =head1 DESCRIPTION
25              
26             This class represents the parameters used for calling the method TerminateWorkflowExecution on the
27             Amazon Simple Workflow Service service. Use the attributes of this class
28             as arguments to method TerminateWorkflowExecution.
29              
30             You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to TerminateWorkflowExecution.
31              
32             As an example:
33              
34             $service_obj->TerminateWorkflowExecution(Att1 => $value1, Att2 => $value2, ...);
35              
36             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.
37              
38             =head1 ATTRIBUTES
39              
40              
41             =head2 ChildPolicy => Str
42              
43             If set, specifies the policy to use for the child workflow executions
44             of the workflow execution being terminated. This policy overrides the
45             child policy specified for the workflow execution at registration time
46             or when starting the execution.
47              
48             The supported child policies are:
49              
50             =over
51              
52             =item * B<TERMINATE:> the child executions will be terminated.
53              
54             =item * B<REQUEST_CANCEL:> a request to cancel will be attempted for
55             each child execution by recording a C<WorkflowExecutionCancelRequested>
56             event in its history. It is up to the decider to take appropriate
57             actions when it receives an execution history with this event.
58              
59             =item * B<ABANDON:> no action will be taken. The child executions will
60             continue to run.
61              
62             =back
63              
64             A child policy for this workflow execution must be specified either as
65             a default for the workflow type or through this parameter. If neither
66             this parameter is set nor a default child policy was specified at
67             registration time then a fault will be returned.
68              
69             Valid values are: C<"TERMINATE">, C<"REQUEST_CANCEL">, C<"ABANDON">
70              
71             =head2 Details => Str
72              
73             I<Optional.> Details for terminating the workflow execution.
74              
75              
76              
77             =head2 B<REQUIRED> Domain => Str
78              
79             The domain of the workflow execution to terminate.
80              
81              
82              
83             =head2 Reason => Str
84              
85             I<Optional.> A descriptive reason for terminating the workflow
86             execution.
87              
88              
89              
90             =head2 RunId => Str
91              
92             The runId of the workflow execution to terminate.
93              
94              
95              
96             =head2 B<REQUIRED> WorkflowId => Str
97              
98             The workflowId of the workflow execution to terminate.
99              
100              
101              
102              
103             =head1 SEE ALSO
104              
105             This class forms part of L<Paws>, documenting arguments for method TerminateWorkflowExecution in L<Paws::SimpleWorkflow>
106              
107             =head1 BUGS and CONTRIBUTIONS
108              
109             The source code is located here: https://github.com/pplu/aws-sdk-perl
110              
111             Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues
112              
113             =cut
114