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	558	use Moose;
	1		4
	1		9
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 details of the C<SignalExternalWorkflowExecution> decision.
39
40				B<Access Control>
41
42				You can use IAM policies to control this decision's access to Amazon
43				SWF resources as follows:
44
45				=over
46
47				=item * Use a C<Resource> element with the domain name to limit the
48				action to only specified domains.
49
50				=item * Use an C<Action> element to allow or deny permission to call
51				this action.
52
53				=item * You cannot use an IAM policy to constrain this action's
54				parameters.
55
56				=back
57
58				If the caller does not have sufficient permissions to invoke the
59				action, or the parameter values fall outside the specified constraints,
60				the action fails. The associated event attribute's B<cause> parameter
61				will be set to OPERATION_NOT_PERMITTED. For details and example IAM
62				policies, see Using IAM to Manage Access to Amazon SWF Workflows.
63
64				=head1 ATTRIBUTES
65
66
67				=head2 Control => Str
68
69				I<Optional.> Data attached to the event that can be used by the decider
70				in subsequent decision tasks.
71
72
73				=head2 Input => Str
74
75				I<Optional.> Input data to be provided with the signal. The target
76				workflow execution will use the signal name and input data to process
77				the signal.
78
79
80				=head2 RunId => Str
81
82				The C<runId> of the workflow execution to be signaled.
83
84
85				=head2 B<REQUIRED> SignalName => Str
86
87				B<Required.> The name of the signal.The target workflow execution will
88				use the signal name and input to process the signal.
89
90
91				=head2 B<REQUIRED> WorkflowId => Str
92
93				B<Required.> The C<workflowId> of the workflow execution to be
94				signaled.
95
96
97
98				=head1 SEE ALSO
99
100				This class forms part of L<Paws>, describing an object used in L<Paws::SimpleWorkflow>
101
102				=head1 BUGS and CONTRIBUTIONS
103
104				The source code is located here: https://github.com/pplu/aws-sdk-perl
105
106				Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues
107
108				=cut
109