« blib/lib/Paws/CloudWatch/DescribeAlarmHistoryOutput.pm
↑ Summary
blib/lib/Paws/CloudWatch/DescribeAlarmsOutput.pm »
| 1 | |||
| 2 | package Paws::CloudWatch::DescribeAlarms; | ||
| 3 | 1 | ▶ | use Moose; |
|
Subroutine
BEGIN: called CC=1 SCAR=0.0
| |||
| 4 | 1 | has ActionPrefix => (is => 'ro', isa => 'Str'); | |
| 5 | 1 | has AlarmNamePrefix => (is => 'ro', isa => 'Str'); | |
| 6 | 1 | has AlarmNames => (is => 'ro', isa => 'ArrayRef[Str|Undef]'); | |
| 7 | 1 | has AlarmTypes => (is => 'ro', isa => 'ArrayRef[Str|Undef]'); | |
| 8 | 1 | has ChildrenOfAlarmName => (is => 'ro', isa => 'Str'); | |
| 9 | 1 | has MaxRecords => (is => 'ro', isa => 'Int'); | |
| 10 | 1 | has NextToken => (is => 'ro', isa => 'Str'); | |
| 11 | 1 | has ParentsOfAlarmName => (is => 'ro', isa => 'Str'); | |
| 12 | 1 | has StateValue => (is => 'ro', isa => 'Str'); | |
| 13 | |||
| 14 | 1 | ▶ | use MooseX::ClassAttribute; |
|
Subroutine
BEGIN: called CC=1 SCAR=0.0
| |||
| 15 | |||
| 16 | 1 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'DescribeAlarms'); | |
| 17 | 1 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::CloudWatch::DescribeAlarmsOutput'); | |
| 18 | 1 | class_has _result_key => (isa => 'Str', is => 'ro', default => 'DescribeAlarmsResult'); | |
| 19 | 1 | 1; | |
| 20 | |||
| 21 | ### main pod documentation begin ### | ||
| 22 | |||
| 23 | =head1 NAME | ||
| 24 | |||
| 25 | Paws::CloudWatch::DescribeAlarms - Arguments for method DescribeAlarms on L<Paws::CloudWatch> | ||
| 26 | |||
| 27 | =head1 DESCRIPTION | ||
| 28 | |||
| 29 | This class represents the parameters used for calling the method DescribeAlarms on the | ||
| 30 | L<Amazon CloudWatch|Paws::CloudWatch> service. Use the attributes of this class | ||
| 31 | as arguments to method DescribeAlarms. | ||
| 32 | |||
| 33 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to DescribeAlarms. | ||
| 34 | |||
| 35 | =head1 SYNOPSIS | ||
| 36 | |||
| 37 | my $monitoring = Paws->service('CloudWatch'); | ||
| 38 | my $DescribeAlarmsOutput = $monitoring->DescribeAlarms( | ||
| 39 | ActionPrefix => 'MyActionPrefix', # OPTIONAL | ||
| 40 | AlarmNamePrefix => 'MyAlarmNamePrefix', # OPTIONAL | ||
| 41 | AlarmNames => [ | ||
| 42 | 'MyAlarmName', ... # min: 1, max: 255 | ||
| 43 | ], # OPTIONAL | ||
| 44 | AlarmTypes => [ | ||
| 45 | 'CompositeAlarm', ... # values: CompositeAlarm, MetricAlarm | ||
| 46 | ], # OPTIONAL | ||
| 47 | ChildrenOfAlarmName => 'MyAlarmName', # OPTIONAL | ||
| 48 | MaxRecords => 1, # OPTIONAL | ||
| 49 | NextToken => 'MyNextToken', # OPTIONAL | ||
| 50 | ParentsOfAlarmName => 'MyAlarmName', # OPTIONAL | ||
| 51 | StateValue => 'OK', # OPTIONAL | ||
| 52 | ); | ||
| 53 | |||
| 54 | # Results: | ||
| 55 | my $CompositeAlarms = $DescribeAlarmsOutput->CompositeAlarms; | ||
| 56 | my $MetricAlarms = $DescribeAlarmsOutput->MetricAlarms; | ||
| 57 | my $NextToken = $DescribeAlarmsOutput->NextToken; | ||
| 58 | |||
| 59 | # Returns a L<Paws::CloudWatch::DescribeAlarmsOutput> object. | ||
| 60 | |||
| 61 | 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. | ||
| 62 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/monitoring/DescribeAlarms> | ||
| 63 | |||
| 64 | =head1 ATTRIBUTES | ||
| 65 | |||
| 66 | |||
| 67 | =head2 ActionPrefix => Str | ||
| 68 | |||
| 69 | Use this parameter to filter the results of the operation to only those | ||
| 70 | alarms that use a certain alarm action. For example, you could specify | ||
| 71 | the ARN of an SNS topic to find all alarms that send notifications to | ||
| 72 | that topic. | ||
| 73 | |||
| 74 | |||
| 75 | |||
| 76 | =head2 AlarmNamePrefix => Str | ||
| 77 | |||
| 78 | An alarm name prefix. If you specify this parameter, you receive | ||
| 79 | information about all alarms that have names that start with this | ||
| 80 | prefix. | ||
| 81 | |||
| 82 | If this parameter is specified, you cannot specify C<AlarmNames>. | ||
| 83 | |||
| 84 | |||
| 85 | |||
| 86 | =head2 AlarmNames => ArrayRef[Str|Undef] | ||
| 87 | |||
| 88 | The names of the alarms to retrieve information about. | ||
| 89 | |||
| 90 | |||
| 91 | |||
| 92 | =head2 AlarmTypes => ArrayRef[Str|Undef] | ||
| 93 | |||
| 94 | Use this parameter to specify whether you want the operation to return | ||
| 95 | metric alarms or composite alarms. If you omit this parameter, only | ||
| 96 | metric alarms are returned. | ||
| 97 | |||
| 98 | |||
| 99 | |||
| 100 | =head2 ChildrenOfAlarmName => Str | ||
| 101 | |||
| 102 | If you use this parameter and specify the name of a composite alarm, | ||
| 103 | the operation returns information about the "children" alarms of the | ||
| 104 | alarm you specify. These are the metric alarms and composite alarms | ||
| 105 | referenced in the C<AlarmRule> field of the composite alarm that you | ||
| 106 | specify in C<ChildrenOfAlarmName>. Information about the composite | ||
| 107 | alarm that you name in C<ChildrenOfAlarmName> is not returned. | ||
| 108 | |||
| 109 | If you specify C<ChildrenOfAlarmName>, you cannot specify any other | ||
| 110 | parameters in the request except for C<MaxRecords> and C<NextToken>. If | ||
| 111 | you do so, you receive a validation error. | ||
| 112 | |||
| 113 | Only the C<Alarm Name>, C<ARN>, C<StateValue> | ||
| 114 | (OK/ALARM/INSUFFICIENT_DATA), and C<StateUpdatedTimestamp> information | ||
| 115 | are returned by this operation when you use this parameter. To get | ||
| 116 | complete information about these alarms, perform another | ||
| 117 | C<DescribeAlarms> operation and specify the parent alarm names in the | ||
| 118 | C<AlarmNames> parameter. | ||
| 119 | |||
| 120 | |||
| 121 | |||
| 122 | =head2 MaxRecords => Int | ||
| 123 | |||
| 124 | The maximum number of alarm descriptions to retrieve. | ||
| 125 | |||
| 126 | |||
| 127 | |||
| 128 | =head2 NextToken => Str | ||
| 129 | |||
| 130 | The token returned by a previous call to indicate that there is more | ||
| 131 | data available. | ||
| 132 | |||
| 133 | |||
| 134 | |||
| 135 | =head2 ParentsOfAlarmName => Str | ||
| 136 | |||
| 137 | If you use this parameter and specify the name of a metric or composite | ||
| 138 | alarm, the operation returns information about the "parent" alarms of | ||
| 139 | the alarm you specify. These are the composite alarms that have | ||
| 140 | C<AlarmRule> parameters that reference the alarm named in | ||
| 141 | C<ParentsOfAlarmName>. Information about the alarm that you specify in | ||
| 142 | C<ParentsOfAlarmName> is not returned. | ||
| 143 | |||
| 144 | If you specify C<ParentsOfAlarmName>, you cannot specify any other | ||
| 145 | parameters in the request except for C<MaxRecords> and C<NextToken>. If | ||
| 146 | you do so, you receive a validation error. | ||
| 147 | |||
| 148 | Only the Alarm Name and ARN are returned by this operation when you use | ||
| 149 | this parameter. To get complete information about these alarms, perform | ||
| 150 | another C<DescribeAlarms> operation and specify the parent alarm names | ||
| 151 | in the C<AlarmNames> parameter. | ||
| 152 | |||
| 153 | |||
| 154 | |||
| 155 | =head2 StateValue => Str | ||
| 156 | |||
| 157 | Specify this parameter to receive information only about alarms that | ||
| 158 | are currently in the state that you specify. | ||
| 159 | |||
| 160 | Valid values are: C<"OK">, C<"ALARM">, C<"INSUFFICIENT_DATA"> | ||
| 161 | |||
| 162 | |||
| 163 | =head1 SEE ALSO | ||
| 164 | |||
| 165 | This class forms part of L<Paws>, documenting arguments for method DescribeAlarms in L<Paws::CloudWatch> | ||
| 166 | |||
| 167 | =head1 BUGS and CONTRIBUTIONS | ||
| 168 | |||
| 169 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 170 | |||
| 171 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 172 | |||
| 173 | =cut | ||
| 174 | |||