File Coverage

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