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   1033 use Moose;
  1         2  
  1         10  
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   6300 use MooseX::ClassAttribute;
  1         4  
  1         11  
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 *
53              
54             C<TERMINATE> E<ndash> The child executions are terminated.
55              
56             =item *
57              
58             C<REQUEST_CANCEL> E<ndash> A request to cancel is attempted for each
59             child execution by recording a C<WorkflowExecutionCancelRequested>
60             event in its history. It is up to the decider to take appropriate
61             actions when it receives an execution history with this event.
62              
63             =item *
64              
65             C<ABANDON> E<ndash> No action is taken. The child executions continue
66             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 is returned.
74              
75             Valid values are: C<"TERMINATE">, C<"REQUEST_CANCEL">, C<"ABANDON">
76              
77             =head2 Details => Str
78              
79             Details for terminating the workflow execution.
80              
81              
82              
83             =head2 B<REQUIRED> Domain => Str
84              
85             The domain of the workflow execution to terminate.
86              
87              
88              
89             =head2 Reason => Str
90              
91             A descriptive reason for terminating the workflow execution.
92              
93              
94              
95             =head2 RunId => Str
96              
97             The runId of the workflow execution to terminate.
98              
99              
100              
101             =head2 B<REQUIRED> WorkflowId => Str
102              
103             The workflowId of the workflow execution to terminate.
104              
105              
106              
107              
108             =head1 SEE ALSO
109              
110             This class forms part of L<Paws>, documenting arguments for method TerminateWorkflowExecution in L<Paws::SimpleWorkflow>
111              
112             =head1 BUGS and CONTRIBUTIONS
113              
114             The source code is located here: https://github.com/pplu/aws-sdk-perl
115              
116             Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues
117              
118             =cut
119