File Coverage

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