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   470 use Moose;
  1         13  
  1         11  
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 the details of the
40             C<RequestCancelExternalWorkflowExecutionFailed> 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 C<cause> is set to C<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 in the
53             I<Amazon SWF Developer Guide>.
54              
55              
56             =head2 Control => Str
57              
58             The data attached to the event that the decider can use in subsequent
59             workflow tasks. This data isn't sent to the workflow execution.
60              
61              
62             =head2 B<REQUIRED> DecisionTaskCompletedEventId => Int
63              
64             The ID of the C<DecisionTaskCompleted> event corresponding to the
65             decision task that resulted in the
66             C<RequestCancelExternalWorkflowExecution> decision for this
67             cancellation request. This information can be useful for diagnosing
68             problems by tracing back the chain of events leading up to this event.
69              
70              
71             =head2 B<REQUIRED> InitiatedEventId => Int
72              
73             The ID of the C<RequestCancelExternalWorkflowExecutionInitiated> event
74             corresponding to the C<RequestCancelExternalWorkflowExecution> decision
75             to cancel this external workflow execution. This information can be
76             useful for diagnosing problems by tracing back the chain of events
77             leading up to this event.
78              
79              
80             =head2 RunId => Str
81              
82             The C<runId> of the external workflow execution.
83              
84              
85             =head2 B<REQUIRED> WorkflowId => Str
86              
87             The C<workflowId> of the external workflow to which the cancel request
88             was to be delivered.
89              
90              
91              
92             =head1 SEE ALSO
93              
94             This class forms part of L<Paws>, describing an object used in L<Paws::SimpleWorkflow>
95              
96             =head1 BUGS and CONTRIBUTIONS
97              
98             The source code is located here: https://github.com/pplu/aws-sdk-perl
99              
100             Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues
101              
102             =cut
103