File Coverage

blib/lib/Paws/SimpleWorkflow/RequestCancelExternalWorkflowExecutionFailedEventAttributes.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::RequestCancelExternalWorkflowExecutionFailedEventAttributes;
2 1     1   908 use Moose;
  1         6  
  1         14  
3             has Cause => (is => 'ro', isa => 'Str', request_name => 'cause', traits => ['NameInRequest'], required => 1);
4             has Control => (is => 'ro', isa => 'Str', request_name => 'control', traits => ['NameInRequest']);
5             has DecisionTaskCompletedEventId => (is => 'ro', isa => 'Int', request_name => 'decisionTaskCompletedEventId', traits => ['NameInRequest'], required => 1);
6             has InitiatedEventId => (is => 'ro', isa => 'Int', request_name => 'initiatedEventId', traits => ['NameInRequest'], required => 1);
7             has RunId => (is => 'ro', isa => 'Str', request_name => 'runId', traits => ['NameInRequest']);
8             has WorkflowId => (is => 'ro', isa => 'Str', request_name => 'workflowId', traits => ['NameInRequest'], required => 1);
9             1;
10              
11             ### main pod documentation begin ###
12              
13             =head1 NAME
14              
15             Paws::SimpleWorkflow::RequestCancelExternalWorkflowExecutionFailedEventAttributes
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::RequestCancelExternalWorkflowExecutionFailedEventAttributes object:
27              
28             $service_obj->Method(Att1 => { Cause => $value, ..., WorkflowId => $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::RequestCancelExternalWorkflowExecutionFailedEventAttributes object:
33              
34             $result = $service_obj->Method(...);
35             $result->Att1->Cause
36              
37             =head1 DESCRIPTION
38              
39             Provides details of the C<RequestCancelExternalWorkflowExecutionFailed>
40             event.
41              
42             =head1 ATTRIBUTES
43              
44              
45             =head2 B<REQUIRED> Cause => Str
46              
47             The cause of the failure. This information is generated by the system
48             and can be useful for diagnostic purposes.
49              
50             If B<cause> is set to OPERATION_NOT_PERMITTED, the decision failed
51             because it lacked sufficient permissions. For details and example IAM
52             policies, see Using IAM to Manage Access to Amazon SWF Workflows.
53              
54              
55             =head2 Control => Str
56              
57            
58              
59              
60             =head2 B<REQUIRED> DecisionTaskCompletedEventId => Int
61              
62             The ID of the C<DecisionTaskCompleted> event corresponding to the
63             decision task that resulted in the
64             C<RequestCancelExternalWorkflowExecution> decision for this
65             cancellation request. This information can be useful for diagnosing
66             problems by tracing back the chain of events leading up to this event.
67              
68              
69             =head2 B<REQUIRED> InitiatedEventId => Int
70              
71             The ID of the C<RequestCancelExternalWorkflowExecutionInitiated> event
72             corresponding to the C<RequestCancelExternalWorkflowExecution> decision
73             to cancel this external workflow execution. This information can be
74             useful for diagnosing problems by tracing back the chain of events
75             leading up to this event.
76              
77              
78             =head2 RunId => Str
79              
80             The C<runId> of the external workflow execution.
81              
82              
83             =head2 B<REQUIRED> WorkflowId => Str
84              
85             The C<workflowId> of the external workflow to which the cancel request
86             was to be delivered.
87              
88              
89              
90             =head1 SEE ALSO
91              
92             This class forms part of L<Paws>, describing an object used in L<Paws::SimpleWorkflow>
93              
94             =head1 BUGS and CONTRIBUTIONS
95              
96             The source code is located here: https://github.com/pplu/aws-sdk-perl
97              
98             Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues
99              
100             =cut
101