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   617 use Moose;
  1         3  
  1         9  
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 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 * Use a C<Resource> element with the domain name to limit the
46             action to only specified domains.
47              
48             =item * Use an C<Action> element to allow or deny permission to call
49             this action.
50              
51             =item * You cannot use an IAM policy to constrain this action's
52             parameters.
53              
54             =back
55              
56             If the caller does not have sufficient permissions to invoke the
57             action, or the parameter values fall outside the specified constraints,
58             the action fails. The associated event attribute's B<cause> parameter
59             will be set to OPERATION_NOT_PERMITTED. For details and example IAM
60             policies, see Using IAM to Manage Access to Amazon SWF Workflows.
61              
62             =head1 ATTRIBUTES
63              
64              
65             =head2 Control => Str
66              
67             I<Optional.> Data attached to the event that can be used by the decider
68             in subsequent workflow tasks.
69              
70              
71             =head2 B<REQUIRED> StartToFireTimeout => Str
72              
73             B<Required.> The duration to wait before firing the timer.
74              
75             The duration is specified in seconds; an integer greater than or equal
76             to 0.
77              
78              
79             =head2 B<REQUIRED> TimerId => Str
80              
81             B<Required.> The unique ID of the timer.
82              
83             The specified string must not start or end with whitespace. It must not
84             contain a C<:> (colon), C</> (slash), C<|> (vertical bar), or any
85             control characters (\u0000-\u001f | \u007f - \u009f). Also, it must not
86             contain the literal string quotarnquot.
87              
88              
89              
90             =head1 SEE ALSO
91              
92             This class forms part of L<Paws>, describing an object used in L<Paws::SimpleWorkflow>
93              
94             =head1 BUGS and CONTRIBUTIONS
95              
96             The source code is located here: https://github.com/pplu/aws-sdk-perl
97              
98             Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues
99              
100             =cut
101