File Coverage

blib/lib/Paws/SimpleWorkflow/RequestCancelExternalWorkflowExecutionDecisionAttributes.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::RequestCancelExternalWorkflowExecutionDecisionAttributes;
2 1     1   585 use Moose;
  1         3  
  1         10  
3             has Control => (is => 'ro', isa => 'Str', request_name => 'control', traits => ['NameInRequest']);
4             has RunId => (is => 'ro', isa => 'Str', request_name => 'runId', traits => ['NameInRequest']);
5             has WorkflowId => (is => 'ro', isa => 'Str', request_name => 'workflowId', traits => ['NameInRequest'], required => 1);
6             1;
7              
8             ### main pod documentation begin ###
9              
10             =head1 NAME
11              
12             Paws::SimpleWorkflow::RequestCancelExternalWorkflowExecutionDecisionAttributes
13              
14             =head1 USAGE
15              
16             This class represents one of two things:
17              
18             =head3 Arguments in a call to a service
19              
20             Use the attributes of this class as arguments to methods. You shouldn't make instances of this class.
21             Each attribute should be used as a named argument in the calls that expect this type of object.
22              
23             As an example, if Att1 is expected to be a Paws::SimpleWorkflow::RequestCancelExternalWorkflowExecutionDecisionAttributes object:
24              
25             $service_obj->Method(Att1 => { Control => $value, ..., WorkflowId => $value });
26              
27             =head3 Results returned from an API call
28              
29             Use accessors for each attribute. If Att1 is expected to be an Paws::SimpleWorkflow::RequestCancelExternalWorkflowExecutionDecisionAttributes object:
30              
31             $result = $service_obj->Method(...);
32             $result->Att1->Control
33              
34             =head1 DESCRIPTION
35              
36             Provides details of the C<RequestCancelExternalWorkflowExecution>
37             decision.
38              
39             B<Access Control>
40              
41             You can use IAM policies to control this decision's access to Amazon
42             SWF resources as follows:
43              
44             =over
45              
46             =item * Use a C<Resource> element with the domain name to limit the
47             action to only specified domains.
48              
49             =item * Use an C<Action> element to allow or deny permission to call
50             this action.
51              
52             =item * You cannot use an IAM policy to constrain this action's
53             parameters.
54              
55             =back
56              
57             If the caller does not have sufficient permissions to invoke the
58             action, or the parameter values fall outside the specified constraints,
59             the action fails. The associated event attribute's B<cause> parameter
60             will be set to OPERATION_NOT_PERMITTED. For details and example IAM
61             policies, see Using IAM to Manage Access to Amazon SWF Workflows.
62              
63             =head1 ATTRIBUTES
64              
65              
66             =head2 Control => Str
67              
68             I<Optional.> Data attached to the event that can be used by the decider
69             in subsequent workflow tasks.
70              
71              
72             =head2 RunId => Str
73              
74             The C<runId> of the external workflow execution to cancel.
75              
76              
77             =head2 B<REQUIRED> WorkflowId => Str
78              
79             B<Required.> The C<workflowId> of the external workflow execution to
80             cancel.
81              
82              
83              
84             =head1 SEE ALSO
85              
86             This class forms part of L<Paws>, describing an object used in L<Paws::SimpleWorkflow>
87              
88             =head1 BUGS and CONTRIBUTIONS
89              
90             The source code is located here: https://github.com/pplu/aws-sdk-perl
91              
92             Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues
93              
94             =cut
95