| 1 | # Generated by default/object.tt | ||
| 2 | package Paws::CloudWatch::MetricDatum; | ||
| 3 | use Moose; | ||
| 4 | has Counts => (is => 'ro', isa => 'ArrayRef[Num]'); | ||
| 5 | has Dimensions => (is => 'ro', isa => 'ArrayRef[Paws::CloudWatch::Dimension]'); | ||
| 6 | has MetricName => (is => 'ro', isa => 'Str', required => 1); | ||
| 7 | has StatisticValues => (is => 'ro', isa => 'Paws::CloudWatch::StatisticSet'); | ||
| 8 | has StorageResolution => (is => 'ro', isa => 'Int'); | ||
| 9 | has Timestamp => (is => 'ro', isa => 'Str'); | ||
| 10 | has Unit => (is => 'ro', isa => 'Str'); | ||
| 11 | has Value => (is => 'ro', isa => 'Num'); | ||
| 12 | has Values => (is => 'ro', isa => 'ArrayRef[Num]'); | ||
| 13 | |||
| 14 | 1; | ||
| 15 | |||
| 16 | ### main pod documentation begin ### | ||
| 17 | |||
| 18 | =head1 NAME | ||
| 19 | |||
| 20 | Paws::CloudWatch::MetricDatum | ||
| 21 | |||
| 22 | =head1 USAGE | ||
| 23 | |||
| 24 | This class represents one of two things: | ||
| 25 | |||
| 26 | =head3 Arguments in a call to a service | ||
| 27 | |||
| 28 | Use the attributes of this class as arguments to methods. You shouldn't make instances of this class. | ||
| 29 | Each attribute should be used as a named argument in the calls that expect this type of object. | ||
| 30 | |||
| 31 | As an example, if Att1 is expected to be a Paws::CloudWatch::MetricDatum object: | ||
| 32 | |||
| 33 | $service_obj->Method(Att1 => { Counts => $value, ..., Values => $value }); | ||
| 34 | |||
| 35 | =head3 Results returned from an API call | ||
| 36 | |||
| 37 | Use accessors for each attribute. If Att1 is expected to be an Paws::CloudWatch::MetricDatum object: | ||
| 38 | |||
| 39 | $result = $service_obj->Method(...); | ||
| 40 | $result->Att1->Counts | ||
| 41 | |||
| 42 | =head1 DESCRIPTION | ||
| 43 | |||
| 44 | Encapsulates the information sent to either create a metric or add new | ||
| 45 | values to be aggregated into an existing metric. | ||
| 46 | |||
| 47 | =head1 ATTRIBUTES | ||
| 48 | |||
| 49 | |||
| 50 | =head2 Counts => ArrayRef[Num] | ||
| 51 | |||
| 52 | Array of numbers that is used along with the C<Values> array. Each | ||
| 53 | number in the C<Count> array is the number of times the corresponding | ||
| 54 | value in the C<Values> array occurred during the period. | ||
| 55 | |||
| 56 | If you omit the C<Counts> array, the default of 1 is used as the value | ||
| 57 | for each count. If you include a C<Counts> array, it must include the | ||
| 58 | same amount of values as the C<Values> array. | ||
| 59 | |||
| 60 | |||
| 61 | =head2 Dimensions => ArrayRef[L<Paws::CloudWatch::Dimension>] | ||
| 62 | |||
| 63 | The dimensions associated with the metric. | ||
| 64 | |||
| 65 | |||
| 66 | =head2 B<REQUIRED> MetricName => Str | ||
| 67 | |||
| 68 | The name of the metric. | ||
| 69 | |||
| 70 | |||
| 71 | =head2 StatisticValues => L<Paws::CloudWatch::StatisticSet> | ||
| 72 | |||
| 73 | The statistical values for the metric. | ||
| 74 | |||
| 75 | |||
| 76 | =head2 StorageResolution => Int | ||
| 77 | |||
| 78 | Valid values are 1 and 60. Setting this to 1 specifies this metric as a | ||
| 79 | high-resolution metric, so that CloudWatch stores the metric with | ||
| 80 | sub-minute resolution down to one second. Setting this to 60 specifies | ||
| 81 | this metric as a regular-resolution metric, which CloudWatch stores at | ||
| 82 | 1-minute resolution. Currently, high resolution is available only for | ||
| 83 | custom metrics. For more information about high-resolution metrics, see | ||
| 84 | High-Resolution Metrics | ||
| 85 | (https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/publishingMetrics.html#high-resolution-metrics) | ||
| 86 | in the I<Amazon CloudWatch User Guide>. | ||
| 87 | |||
| 88 | This field is optional, if you do not specify it the default of 60 is | ||
| 89 | used. | ||
| 90 | |||
| 91 | |||
| 92 | =head2 Timestamp => Str | ||
| 93 | |||
| 94 | The time the metric data was received, expressed as the number of | ||
| 95 | milliseconds since Jan 1, 1970 00:00:00 UTC. | ||
| 96 | |||
| 97 | |||
| 98 | =head2 Unit => Str | ||
| 99 | |||
| 100 | When you are using a C<Put> operation, this defines what unit you want | ||
| 101 | to use when storing the metric. | ||
| 102 | |||
| 103 | In a C<Get> operation, this displays the unit that is used for the | ||
| 104 | metric. | ||
| 105 | |||
| 106 | |||
| 107 | =head2 Value => Num | ||
| 108 | |||
| 109 | The value for the metric. | ||
| 110 | |||
| 111 | Although the parameter accepts numbers of type Double, CloudWatch | ||
| 112 | rejects values that are either too small or too large. Values must be | ||
| 113 | in the range of -2^360 to 2^360. In addition, special values (for | ||
| 114 | example, NaN, +Infinity, -Infinity) are not supported. | ||
| 115 | |||
| 116 | |||
| 117 | =head2 Values => ArrayRef[Num] | ||
| 118 | |||
| 119 | Array of numbers representing the values for the metric during the | ||
| 120 | period. Each unique value is listed just once in this array, and the | ||
| 121 | corresponding number in the C<Counts> array specifies the number of | ||
| 122 | times that value occurred during the period. You can include up to 150 | ||
| 123 | unique values in each C<PutMetricData> action that specifies a | ||
| 124 | C<Values> array. | ||
| 125 | |||
| 126 | Although the C<Values> array accepts numbers of type C<Double>, | ||
| 127 | CloudWatch rejects values that are either too small or too large. | ||
| 128 | Values must be in the range of -2^360 to 2^360. In addition, special | ||
| 129 | values (for example, NaN, +Infinity, -Infinity) are not supported. | ||
| 130 | |||
| 131 | |||
| 132 | |||
| 133 | =head1 SEE ALSO | ||
| 134 | |||
| 135 | This class forms part of L<Paws>, describing an object used in L<Paws::CloudWatch> | ||
| 136 | |||
| 137 | =head1 BUGS and CONTRIBUTIONS | ||
| 138 | |||
| 139 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 140 | |||
| 141 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 142 | |||
| 143 | =cut | ||
| 144 |