blib/lib/Paws/Budgets/Notification.pm untested

filter: Statementstmt 0.0% 0 / 8 Branchbran n/a Conditioncond n/a MC/DCmcdc n/a Subroutinesub 0.0% 0 / 1 Podpod n/a totaltotal 0.0% 0 / 9 CC 1 SCAR 6.9
CC
1
Cov
0%
BEGIN
2.0
CRAP 2.0
1 # Generated by default/object.tt
2 package Paws::Budgets::Notification;
3 use Moose;
4 has ComparisonOperator => (is => 'ro', isa => 'Str', required => 1);
5 has NotificationState => (is => 'ro', isa => 'Str');
6 has NotificationType => (is => 'ro', isa => 'Str', required => 1);
7 has Threshold => (is => 'ro', isa => 'Num', required => 1);
8 has ThresholdType => (is => 'ro', isa => 'Str');
9  
10 1;
11  
12 ### main pod documentation begin ###
13  
14 =head1 NAME
15  
16 Paws::Budgets::Notification
17  
18 =head1 USAGE
19  
20 This class represents one of two things:
21  
22 =head3 Arguments in a call to a service
23  
24 Use the attributes of this class as arguments to methods. You shouldn't make instances of this class.
25 Each attribute should be used as a named argument in the calls that expect this type of object.
26  
27 As an example, if Att1 is expected to be a Paws::Budgets::Notification object:
28  
29 $service_obj->Method(Att1 => { ComparisonOperator => $value, ..., ThresholdType => $value });
30  
31 =head3 Results returned from an API call
32  
33 Use accessors for each attribute. If Att1 is expected to be an Paws::Budgets::Notification object:
34  
35 $result = $service_obj->Method(...);
36 $result->Att1->ComparisonOperator
37  
38 =head1 DESCRIPTION
39  
40 A notification that is associated with a budget. A budget can have up
41 to ten notifications.
42  
43 Each notification must have at least one subscriber. A notification can
44 have one SNS subscriber and up to 10 email subscribers, for a total of
45 11 subscribers.
46  
47 For example, if you have a budget for 200 dollars and you want to be
48 notified when you go over 160 dollars, create a notification with the
49 following parameters:
50  
51 =over
52  
53 =item *
54  
55 A notificationType of C<ACTUAL>
56  
57 =item *
58  
59 A C<thresholdType> of C<PERCENTAGE>
60  
61 =item *
62  
63 A C<comparisonOperator> of C<GREATER_THAN>
64  
65 =item *
66  
67 A notification C<threshold> of C<80>
68  
69 =back
70  
71  
72 =head1 ATTRIBUTES
73  
74  
75 =head2 B<REQUIRED> ComparisonOperator => Str
76  
77 The comparison that is used for this notification.
78  
79  
80 =head2 NotificationState => Str
81  
82 Whether this notification is in alarm. If a budget notification is in
83 the C<ALARM> state, you have passed the set threshold for the budget.
84  
85  
86 =head2 B<REQUIRED> NotificationType => Str
87  
88 Whether the notification is for how much you have spent (C<ACTUAL>) or
89 for how much you're forecasted to spend (C<FORECASTED>).
90  
91  
92 =head2 B<REQUIRED> Threshold => Num
93  
94 The threshold that is associated with a notification. Thresholds are
95 always a percentage, and many customers find value being alerted
96 between 50% - 200% of the budgeted amount. The maximum limit for your
97 threshold is 1,000,000% above the budgeted amount.
98  
99  
100 =head2 ThresholdType => Str
101  
102 The type of threshold for a notification. For C<ABSOLUTE_VALUE>
103 thresholds, AWS notifies you when you go over or are forecasted to go
104 over your total cost threshold. For C<PERCENTAGE> thresholds, AWS
105 notifies you when you go over or are forecasted to go over a certain
106 percentage of your forecasted spend. For example, if you have a budget
107 for 200 dollars and you have a C<PERCENTAGE> threshold of 80%, AWS
108 notifies you when you go over 160 dollars.
109  
110  
111  
112 =head1 SEE ALSO
113  
114 This class forms part of L<Paws>, describing an object used in L<Paws::Budgets>
115  
116 =head1 BUGS and CONTRIBUTIONS
117  
118 The source code is located here: L<https://github.com/pplu/aws-sdk-perl>
119  
120 Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues>
121  
122 =cut
123