| 1 | # Generated by default/object.tt | ||
| 2 | package Paws::CloudWatch::MetricDataResult; | ||
| 3 | use Moose; | ||
| 4 | has Id => (is => 'ro', isa => 'Str'); | ||
| 5 | has Label => (is => 'ro', isa => 'Str'); | ||
| 6 | has Messages => (is => 'ro', isa => 'ArrayRef[Paws::CloudWatch::MessageData]'); | ||
| 7 | has StatusCode => (is => 'ro', isa => 'Str'); | ||
| 8 | has Timestamps => (is => 'ro', isa => 'ArrayRef[Str|Undef]'); | ||
| 9 | has Values => (is => 'ro', isa => 'ArrayRef[Num]'); | ||
| 10 | |||
| 11 | 1; | ||
| 12 | |||
| 13 | ### main pod documentation begin ### | ||
| 14 | |||
| 15 | =head1 NAME | ||
| 16 | |||
| 17 | Paws::CloudWatch::MetricDataResult | ||
| 18 | |||
| 19 | =head1 USAGE | ||
| 20 | |||
| 21 | This class represents one of two things: | ||
| 22 | |||
| 23 | =head3 Arguments in a call to a service | ||
| 24 | |||
| 25 | Use the attributes of this class as arguments to methods. You shouldn't make instances of this class. | ||
| 26 | Each attribute should be used as a named argument in the calls that expect this type of object. | ||
| 27 | |||
| 28 | As an example, if Att1 is expected to be a Paws::CloudWatch::MetricDataResult object: | ||
| 29 | |||
| 30 | $service_obj->Method(Att1 => { Id => $value, ..., Values => $value }); | ||
| 31 | |||
| 32 | =head3 Results returned from an API call | ||
| 33 | |||
| 34 | Use accessors for each attribute. If Att1 is expected to be an Paws::CloudWatch::MetricDataResult object: | ||
| 35 | |||
| 36 | $result = $service_obj->Method(...); | ||
| 37 | $result->Att1->Id | ||
| 38 | |||
| 39 | =head1 DESCRIPTION | ||
| 40 | |||
| 41 | A C<GetMetricData> call returns an array of C<MetricDataResult> | ||
| 42 | structures. Each of these structures includes the data points for that | ||
| 43 | metric, along with the timestamps of those data points and other | ||
| 44 | identifying information. | ||
| 45 | |||
| 46 | =head1 ATTRIBUTES | ||
| 47 | |||
| 48 | |||
| 49 | =head2 Id => Str | ||
| 50 | |||
| 51 | The short name you specified to represent this metric. | ||
| 52 | |||
| 53 | |||
| 54 | =head2 Label => Str | ||
| 55 | |||
| 56 | The human-readable label associated with the data. | ||
| 57 | |||
| 58 | |||
| 59 | =head2 Messages => ArrayRef[L<Paws::CloudWatch::MessageData>] | ||
| 60 | |||
| 61 | A list of messages with additional information about the data returned. | ||
| 62 | |||
| 63 | |||
| 64 | =head2 StatusCode => Str | ||
| 65 | |||
| 66 | The status of the returned data. C<Complete> indicates that all data | ||
| 67 | points in the requested time range were returned. C<PartialData> means | ||
| 68 | that an incomplete set of data points were returned. You can use the | ||
| 69 | C<NextToken> value that was returned and repeat your request to get | ||
| 70 | more data points. C<NextToken> is not returned if you are performing a | ||
| 71 | math expression. C<InternalError> indicates that an error occurred. | ||
| 72 | Retry your request using C<NextToken>, if present. | ||
| 73 | |||
| 74 | |||
| 75 | =head2 Timestamps => ArrayRef[Str|Undef] | ||
| 76 | |||
| 77 | The timestamps for the data points, formatted in Unix timestamp format. | ||
| 78 | The number of timestamps always matches the number of values and the | ||
| 79 | value for Timestamps[x] is Values[x]. | ||
| 80 | |||
| 81 | |||
| 82 | =head2 Values => ArrayRef[Num] | ||
| 83 | |||
| 84 | The data points for the metric corresponding to C<Timestamps>. The | ||
| 85 | number of values always matches the number of timestamps and the | ||
| 86 | timestamp for Values[x] is Timestamps[x]. | ||
| 87 | |||
| 88 | |||
| 89 | |||
| 90 | =head1 SEE ALSO | ||
| 91 | |||
| 92 | This class forms part of L<Paws>, describing an object used in L<Paws::CloudWatch> | ||
| 93 | |||
| 94 | =head1 BUGS and CONTRIBUTIONS | ||
| 95 | |||
| 96 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 97 | |||
| 98 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 99 | |||
| 100 | =cut | ||
| 101 |