blib/lib/Paws/Lightsail/TestAlarm.pm untested

filter: Statementstmt 0.0% 0 / 13 Branchbran n/a Conditioncond n/a MC/DCmcdc n/a Subroutinesub 0.0% 0 / 2 Podpod n/a totaltotal 0.0% 0 / 15 CC 1 SCAR 6.9
CC
1
Cov
0%
BEGIN
2.0
BEGIN
2.0
CRAP 2.0
1  
2 package Paws::Lightsail::TestAlarm;
3 use Moose;
4 has AlarmName => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'alarmName' , required => 1);
5 has State => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'state' , required => 1);
6  
7 use MooseX::ClassAttribute;
8  
9 class_has _api_call => (isa => 'Str', is => 'ro', default => 'TestAlarm');
10 class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::Lightsail::TestAlarmResult');
11 class_has _result_key => (isa => 'Str', is => 'ro');
12 1;
13  
14 ### main pod documentation begin ###
15  
16 =head1 NAME
17  
18 Paws::Lightsail::TestAlarm - Arguments for method TestAlarm on L<Paws::Lightsail>
19  
20 =head1 DESCRIPTION
21  
22 This class represents the parameters used for calling the method TestAlarm on the
23 L<Amazon Lightsail|Paws::Lightsail> service. Use the attributes of this class
24 as arguments to method TestAlarm.
25  
26 You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to TestAlarm.
27  
28 =head1 SYNOPSIS
29  
30 my $lightsail = Paws->service('Lightsail');
31 my $TestAlarmResult = $lightsail->TestAlarm(
32 AlarmName => 'MyResourceName',
33 State => 'OK',
34  
35 );
36  
37 # Results:
38 my $Operations = $TestAlarmResult->Operations;
39  
40 # Returns a L<Paws::Lightsail::TestAlarmResult> object.
41  
42 Values for attributes that are native types (Int, String, Float, etc) can passed as-is (scalar values). Values for complex Types (objects) can be passed as a HashRef. The keys and values of the hashref will be used to instance the underlying object.
43 For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/lightsail/TestAlarm>
44  
45 =head1 ATTRIBUTES
46  
47  
48 =head2 B<REQUIRED> AlarmName => Str
49  
50 The name of the alarm to test.
51  
52  
53  
54 =head2 B<REQUIRED> State => Str
55  
56 The alarm state to test.
57  
58 An alarm has the following possible states that can be tested:
59  
60 =over
61  
62 =item *
63  
64 C<ALARM> - The metric is outside of the defined threshold.
65  
66 =item *
67  
68 C<INSUFFICIENT_DATA> - The alarm has just started, the metric is not
69 available, or not enough data is available for the metric to determine
70 the alarm state.
71  
72 =item *
73  
74 C<OK> - The metric is within the defined threshold.
75  
76 =back
77  
78  
79 Valid values are: C<"OK">, C<"ALARM">, C<"INSUFFICIENT_DATA">
80  
81  
82 =head1 SEE ALSO
83  
84 This class forms part of L<Paws>, documenting arguments for method TestAlarm in L<Paws::Lightsail>
85  
86 =head1 BUGS and CONTRIBUTIONS
87  
88 The source code is located here: L<https://github.com/pplu/aws-sdk-perl>
89  
90 Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues>
91  
92 =cut
93