« blib/lib/Paws/CloudWatch/DeleteMetricStreamOutput.pm
↑ Summary
blib/lib/Paws/CloudWatch/DescribeAlarmsForMetricOutput.pm »
| 1 | |||
| 2 | package Paws::CloudWatch::DescribeAlarmsForMetric; | ||
| 3 | use Moose; | ||
| 4 | has Dimensions => (is => 'ro', isa => 'ArrayRef[Paws::CloudWatch::Dimension]'); | ||
| 5 | has ExtendedStatistic => (is => 'ro', isa => 'Str'); | ||
| 6 | has MetricName => (is => 'ro', isa => 'Str', required => 1); | ||
| 7 | has Namespace => (is => 'ro', isa => 'Str', required => 1); | ||
| 8 | has Period => (is => 'ro', isa => 'Int'); | ||
| 9 | has Statistic => (is => 'ro', isa => 'Str'); | ||
| 10 | has Unit => (is => 'ro', isa => 'Str'); | ||
| 11 | |||
| 12 | use MooseX::ClassAttribute; | ||
| 13 | |||
| 14 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'DescribeAlarmsForMetric'); | ||
| 15 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::CloudWatch::DescribeAlarmsForMetricOutput'); | ||
| 16 | class_has _result_key => (isa => 'Str', is => 'ro', default => 'DescribeAlarmsForMetricResult'); | ||
| 17 | 1; | ||
| 18 | |||
| 19 | ### main pod documentation begin ### | ||
| 20 | |||
| 21 | =head1 NAME | ||
| 22 | |||
| 23 | Paws::CloudWatch::DescribeAlarmsForMetric - Arguments for method DescribeAlarmsForMetric on L<Paws::CloudWatch> | ||
| 24 | |||
| 25 | =head1 DESCRIPTION | ||
| 26 | |||
| 27 | This class represents the parameters used for calling the method DescribeAlarmsForMetric on the | ||
| 28 | L<Amazon CloudWatch|Paws::CloudWatch> service. Use the attributes of this class | ||
| 29 | as arguments to method DescribeAlarmsForMetric. | ||
| 30 | |||
| 31 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to DescribeAlarmsForMetric. | ||
| 32 | |||
| 33 | =head1 SYNOPSIS | ||
| 34 | |||
| 35 | my $monitoring = Paws->service('CloudWatch'); | ||
| 36 | my $DescribeAlarmsForMetricOutput = $monitoring->DescribeAlarmsForMetric( | ||
| 37 | MetricName => 'MyMetricName', | ||
| 38 | Namespace => 'MyNamespace', | ||
| 39 | Dimensions => [ | ||
| 40 | { | ||
| 41 | Name => 'MyDimensionName', # min: 1, max: 255 | ||
| 42 | Value => 'MyDimensionValue', # min: 1, max: 255 | ||
| 43 | |||
| 44 | }, | ||
| 45 | ... | ||
| 46 | ], # OPTIONAL | ||
| 47 | ExtendedStatistic => 'MyExtendedStatistic', # OPTIONAL | ||
| 48 | Period => 1, # OPTIONAL | ||
| 49 | Statistic => 'SampleCount', # OPTIONAL | ||
| 50 | Unit => 'Seconds', # OPTIONAL | ||
| 51 | ); | ||
| 52 | |||
| 53 | # Results: | ||
| 54 | my $MetricAlarms = $DescribeAlarmsForMetricOutput->MetricAlarms; | ||
| 55 | |||
| 56 | # Returns a L<Paws::CloudWatch::DescribeAlarmsForMetricOutput> object. | ||
| 57 | |||
| 58 | 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. | ||
| 59 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/monitoring/DescribeAlarmsForMetric> | ||
| 60 | |||
| 61 | =head1 ATTRIBUTES | ||
| 62 | |||
| 63 | |||
| 64 | =head2 Dimensions => ArrayRef[L<Paws::CloudWatch::Dimension>] | ||
| 65 | |||
| 66 | The dimensions associated with the metric. If the metric has any | ||
| 67 | associated dimensions, you must specify them in order for the call to | ||
| 68 | succeed. | ||
| 69 | |||
| 70 | |||
| 71 | |||
| 72 | =head2 ExtendedStatistic => Str | ||
| 73 | |||
| 74 | The percentile statistic for the metric. Specify a value between p0.0 | ||
| 75 | and p100. | ||
| 76 | |||
| 77 | |||
| 78 | |||
| 79 | =head2 B<REQUIRED> MetricName => Str | ||
| 80 | |||
| 81 | The name of the metric. | ||
| 82 | |||
| 83 | |||
| 84 | |||
| 85 | =head2 B<REQUIRED> Namespace => Str | ||
| 86 | |||
| 87 | The namespace of the metric. | ||
| 88 | |||
| 89 | |||
| 90 | |||
| 91 | =head2 Period => Int | ||
| 92 | |||
| 93 | The period, in seconds, over which the statistic is applied. | ||
| 94 | |||
| 95 | |||
| 96 | |||
| 97 | =head2 Statistic => Str | ||
| 98 | |||
| 99 | The statistic for the metric, other than percentiles. For percentile | ||
| 100 | statistics, use C<ExtendedStatistics>. | ||
| 101 | |||
| 102 | Valid values are: C<"SampleCount">, C<"Average">, C<"Sum">, C<"Minimum">, C<"Maximum"> | ||
| 103 | |||
| 104 | =head2 Unit => Str | ||
| 105 | |||
| 106 | The unit for the metric. | ||
| 107 | |||
| 108 | Valid values are: C<"Seconds">, C<"Microseconds">, C<"Milliseconds">, C<"Bytes">, C<"Kilobytes">, C<"Megabytes">, C<"Gigabytes">, C<"Terabytes">, C<"Bits">, C<"Kilobits">, C<"Megabits">, C<"Gigabits">, C<"Terabits">, C<"Percent">, C<"Count">, C<"Bytes/Second">, C<"Kilobytes/Second">, C<"Megabytes/Second">, C<"Gigabytes/Second">, C<"Terabytes/Second">, C<"Bits/Second">, C<"Kilobits/Second">, C<"Megabits/Second">, C<"Gigabits/Second">, C<"Terabits/Second">, C<"Count/Second">, C<"None"> | ||
| 109 | |||
| 110 | |||
| 111 | =head1 SEE ALSO | ||
| 112 | |||
| 113 | This class forms part of L<Paws>, documenting arguments for method DescribeAlarmsForMetric in L<Paws::CloudWatch> | ||
| 114 | |||
| 115 | =head1 BUGS and CONTRIBUTIONS | ||
| 116 | |||
| 117 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 118 | |||
| 119 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 120 | |||
| 121 | =cut | ||
| 122 |