File Coverage

blib/lib/Paws/IoT/CloudwatchAlarmAction.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::IoT::CloudwatchAlarmAction;
2 1     1   319 use Moose;
  1         3  
  1         7  
3             has AlarmName => (is => 'ro', isa => 'Str', request_name => 'alarmName', traits => ['NameInRequest'], required => 1);
4             has RoleArn => (is => 'ro', isa => 'Str', request_name => 'roleArn', traits => ['NameInRequest'], required => 1);
5             has StateReason => (is => 'ro', isa => 'Str', request_name => 'stateReason', traits => ['NameInRequest'], required => 1);
6             has StateValue => (is => 'ro', isa => 'Str', request_name => 'stateValue', traits => ['NameInRequest'], required => 1);
7             1;
8              
9             ### main pod documentation begin ###
10              
11             =head1 NAME
12              
13             Paws::IoT::CloudwatchAlarmAction
14              
15             =head1 USAGE
16              
17             This class represents one of two things:
18              
19             =head3 Arguments in a call to a service
20              
21             Use the attributes of this class as arguments to methods. You shouldn't make instances of this class.
22             Each attribute should be used as a named argument in the calls that expect this type of object.
23              
24             As an example, if Att1 is expected to be a Paws::IoT::CloudwatchAlarmAction object:
25              
26             $service_obj->Method(Att1 => { AlarmName => $value, ..., StateValue => $value });
27              
28             =head3 Results returned from an API call
29              
30             Use accessors for each attribute. If Att1 is expected to be an Paws::IoT::CloudwatchAlarmAction object:
31              
32             $result = $service_obj->Method(...);
33             $result->Att1->AlarmName
34              
35             =head1 DESCRIPTION
36              
37             Describes an action that updates a CloudWatch alarm.
38              
39             =head1 ATTRIBUTES
40              
41              
42             =head2 B<REQUIRED> AlarmName => Str
43              
44             The CloudWatch alarm name.
45              
46              
47             =head2 B<REQUIRED> RoleArn => Str
48              
49             The IAM role that allows access to the CloudWatch alarm.
50              
51              
52             =head2 B<REQUIRED> StateReason => Str
53              
54             The reason for the alarm change.
55              
56              
57             =head2 B<REQUIRED> StateValue => Str
58              
59             The value of the alarm state. Acceptable values are: OK, ALARM,
60             INSUFFICIENT_DATA.
61              
62              
63              
64             =head1 SEE ALSO
65              
66             This class forms part of L<Paws>, describing an object used in L<Paws::IoT>
67              
68             =head1 BUGS and CONTRIBUTIONS
69              
70             The source code is located here: https://github.com/pplu/aws-sdk-perl
71              
72             Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues
73              
74             =cut
75