blib/lib/Paws/CloudWatch/DescribeAlarmHistory.pm

filter: Statementstmt 100% 18 / 18 Branchbran n/a Conditioncond n/a MC/DCmcdc n/a Subroutinesub 100% 2 / 2 Podpod n/a totaltotal 100% 20 / 20 CC 1 SCAR 0.0
CC
1
Cov
100%
BEGIN
1.0
BEGIN
1.0
CRAP 1.0
« blib/lib/Paws/CloudWatch/DatapointValueMap.pm ↑ Summary blib/lib/Paws/CloudWatch/DescribeAlarmHistoryOutput.pm »
1  
2 package Paws::CloudWatch::DescribeAlarmHistory;
3 1 ▶ use Moose;
Subroutine BEGIN: called CC=1 SCAR=0.0
4 1 has AlarmName => (is => 'ro', isa => 'Str');
5 1 has AlarmTypes => (is => 'ro', isa => 'ArrayRef[Str|Undef]');
6 1 has EndDate => (is => 'ro', isa => 'Str');
7 1 has HistoryItemType => (is => 'ro', isa => 'Str');
8 1 has MaxRecords => (is => 'ro', isa => 'Int');
9 1 has NextToken => (is => 'ro', isa => 'Str');
10 1 has ScanBy => (is => 'ro', isa => 'Str');
11 1 has StartDate => (is => 'ro', isa => 'Str');
12  
13 1 ▶ use MooseX::ClassAttribute;
Subroutine BEGIN: called CC=1 SCAR=0.0
14  
15 1 class_has _api_call => (isa => 'Str', is => 'ro', default => 'DescribeAlarmHistory');
16 1 class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::CloudWatch::DescribeAlarmHistoryOutput');
17 1 class_has _result_key => (isa => 'Str', is => 'ro', default => 'DescribeAlarmHistoryResult');
18 1 1;
19  
20 ### main pod documentation begin ###
21  
22 =head1 NAME
23  
24 Paws::CloudWatch::DescribeAlarmHistory - Arguments for method DescribeAlarmHistory on L<Paws::CloudWatch>
25  
26 =head1 DESCRIPTION
27  
28 This class represents the parameters used for calling the method DescribeAlarmHistory on the
29 L<Amazon CloudWatch|Paws::CloudWatch> service. Use the attributes of this class
30 as arguments to method DescribeAlarmHistory.
31  
32 You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to DescribeAlarmHistory.
33  
34 =head1 SYNOPSIS
35  
36 my $monitoring = Paws->service('CloudWatch');
37 my $DescribeAlarmHistoryOutput = $monitoring->DescribeAlarmHistory(
38 AlarmName => 'MyAlarmName', # OPTIONAL
39 AlarmTypes => [
40 'CompositeAlarm', ... # values: CompositeAlarm, MetricAlarm
41 ], # OPTIONAL
42 EndDate => '1970-01-01T01:00:00', # OPTIONAL
43 HistoryItemType => 'ConfigurationUpdate', # OPTIONAL
44 MaxRecords => 1, # OPTIONAL
45 NextToken => 'MyNextToken', # OPTIONAL
46 ScanBy => 'TimestampDescending', # OPTIONAL
47 StartDate => '1970-01-01T01:00:00', # OPTIONAL
48 );
49  
50 # Results:
51 my $AlarmHistoryItems = $DescribeAlarmHistoryOutput->AlarmHistoryItems;
52 my $NextToken = $DescribeAlarmHistoryOutput->NextToken;
53  
54 # Returns a L<Paws::CloudWatch::DescribeAlarmHistoryOutput> object.
55  
56 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.
57 For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/monitoring/DescribeAlarmHistory>
58  
59 =head1 ATTRIBUTES
60  
61  
62 =head2 AlarmName => Str
63  
64 The name of the alarm.
65  
66  
67  
68 =head2 AlarmTypes => ArrayRef[Str|Undef]
69  
70 Use this parameter to specify whether you want the operation to return
71 metric alarms or composite alarms. If you omit this parameter, only
72 metric alarms are returned.
73  
74  
75  
76 =head2 EndDate => Str
77  
78 The ending date to retrieve alarm history.
79  
80  
81  
82 =head2 HistoryItemType => Str
83  
84 The type of alarm histories to retrieve.
85  
86 Valid values are: C<"ConfigurationUpdate">, C<"StateUpdate">, C<"Action">
87  
88 =head2 MaxRecords => Int
89  
90 The maximum number of alarm history records to retrieve.
91  
92  
93  
94 =head2 NextToken => Str
95  
96 The token returned by a previous call to indicate that there is more
97 data available.
98  
99  
100  
101 =head2 ScanBy => Str
102  
103 Specified whether to return the newest or oldest alarm history first.
104 Specify C<TimestampDescending> to have the newest event history
105 returned first, and specify C<TimestampAscending> to have the oldest
106 history returned first.
107  
108 Valid values are: C<"TimestampDescending">, C<"TimestampAscending">
109  
110 =head2 StartDate => Str
111  
112 The starting date to retrieve alarm history.
113  
114  
115  
116  
117 =head1 SEE ALSO
118  
119 This class forms part of L<Paws>, documenting arguments for method DescribeAlarmHistory in L<Paws::CloudWatch>
120  
121 =head1 BUGS and CONTRIBUTIONS
122  
123 The source code is located here: L<https://github.com/pplu/aws-sdk-perl>
124  
125 Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues>
126  
127 =cut
128  
« blib/lib/Paws/CloudWatch/DatapointValueMap.pm ↑ Summary blib/lib/Paws/CloudWatch/DescribeAlarmHistoryOutput.pm »