File Coverage

blib/lib/Paws/SimpleWorkflow/StartTimerDecisionAttributes.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::StartTimerDecisionAttributes;
2 1     1   797 use Moose;
  1         3  
  1         8  
3             has Control => (is => 'ro', isa => 'Str', request_name => 'control', traits => ['NameInRequest']);
4             has StartToFireTimeout => (is => 'ro', isa => 'Str', request_name => 'startToFireTimeout', traits => ['NameInRequest'], required => 1);
5             has TimerId => (is => 'ro', isa => 'Str', request_name => 'timerId', traits => ['NameInRequest'], required => 1);
6             1;
7              
8             ### main pod documentation begin ###
9              
10             =head1 NAME
11              
12             Paws::SimpleWorkflow::StartTimerDecisionAttributes
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::StartTimerDecisionAttributes object:
24              
25             $service_obj->Method(Att1 => { Control => $value, ..., TimerId => $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::StartTimerDecisionAttributes object:
30              
31             $result = $service_obj->Method(...);
32             $result->Att1->Control
33              
34             =head1 DESCRIPTION
35              
36             Provides the details of the C<StartTimer> decision.
37              
38             B<Access Control>
39              
40             You can use IAM policies to control this decision's access to Amazon
41             SWF resources as follows:
42              
43             =over
44              
45             =item *
46              
47             Use a C<Resource> element with the domain name to limit the action to
48             only specified domains.
49              
50             =item *
51              
52             Use an C<Action> element to allow or deny permission to call this
53             action.
54              
55             =item *
56              
57             You cannot use an IAM policy to constrain this action's parameters.
58              
59             =back
60              
61             If the caller doesn't have sufficient permissions to invoke the action,
62             or the parameter values fall outside the specified constraints, the
63             action fails. The associated event attribute's C<cause> parameter is
64             set to C<OPERATION_NOT_PERMITTED>. For details and example IAM
65             policies, see Using IAM to Manage Access to Amazon SWF Workflows in the
66             I<Amazon SWF Developer Guide>.
67              
68             =head1 ATTRIBUTES
69              
70              
71             =head2 Control => Str
72              
73             The data attached to the event that can be used by the decider in
74             subsequent workflow tasks.
75              
76              
77             =head2 B<REQUIRED> StartToFireTimeout => Str
78              
79             The duration to wait before firing the timer.
80              
81             The duration is specified in seconds, an integer greater than or equal
82             to C<0>.
83              
84              
85             =head2 B<REQUIRED> TimerId => Str
86              
87             The unique ID of the timer.
88              
89             The specified string must not start or end with whitespace. It must not
90             contain a C<:> (colon), C</> (slash), C<|> (vertical bar), or any
91             control characters (C<\u0000-\u001f> | C<\u007f-\u009f>). Also, it must
92             not contain the literal string C<arn>.
93              
94              
95              
96             =head1 SEE ALSO
97              
98             This class forms part of L<Paws>, describing an object used in L<Paws::SimpleWorkflow>
99              
100             =head1 BUGS and CONTRIBUTIONS
101              
102             The source code is located here: https://github.com/pplu/aws-sdk-perl
103              
104             Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues
105              
106             =cut
107