« blib/lib/Paws/PerformanceInsights/MetricKeyDataPoints.pm
↑ Summary
blib/lib/Paws/PerformanceInsights/MetricQueryFilterMap.pm »
| 1 | # Generated by default/object.tt | ||
| 2 | package Paws::PerformanceInsights::MetricQuery; | ||
| 3 | use Moose; | ||
| 4 | has Filter => (is => 'ro', isa => 'Paws::PerformanceInsights::MetricQueryFilterMap'); | ||
| 5 | has GroupBy => (is => 'ro', isa => 'Paws::PerformanceInsights::DimensionGroup'); | ||
| 6 | has Metric => (is => 'ro', isa => 'Str', required => 1); | ||
| 7 | |||
| 8 | 1; | ||
| 9 | |||
| 10 | ### main pod documentation begin ### | ||
| 11 | |||
| 12 | =head1 NAME | ||
| 13 | |||
| 14 | Paws::PerformanceInsights::MetricQuery | ||
| 15 | |||
| 16 | =head1 USAGE | ||
| 17 | |||
| 18 | This class represents one of two things: | ||
| 19 | |||
| 20 | =head3 Arguments in a call to a service | ||
| 21 | |||
| 22 | Use the attributes of this class as arguments to methods. You shouldn't make instances of this class. | ||
| 23 | Each attribute should be used as a named argument in the calls that expect this type of object. | ||
| 24 | |||
| 25 | As an example, if Att1 is expected to be a Paws::PerformanceInsights::MetricQuery object: | ||
| 26 | |||
| 27 | $service_obj->Method(Att1 => { Filter => $value, ..., Metric => $value }); | ||
| 28 | |||
| 29 | =head3 Results returned from an API call | ||
| 30 | |||
| 31 | Use accessors for each attribute. If Att1 is expected to be an Paws::PerformanceInsights::MetricQuery object: | ||
| 32 | |||
| 33 | $result = $service_obj->Method(...); | ||
| 34 | $result->Att1->Filter | ||
| 35 | |||
| 36 | =head1 DESCRIPTION | ||
| 37 | |||
| 38 | A single query to be processed. You must provide the metric to query. | ||
| 39 | If no other parameters are specified, Performance Insights returns all | ||
| 40 | of the data points for that metric. You can optionally request that the | ||
| 41 | data points be aggregated by dimension group ( C<GroupBy>), and return | ||
| 42 | only those data points that match your criteria (C<Filter>). | ||
| 43 | |||
| 44 | =head1 ATTRIBUTES | ||
| 45 | |||
| 46 | |||
| 47 | =head2 Filter => L<Paws::PerformanceInsights::MetricQueryFilterMap> | ||
| 48 | |||
| 49 | One or more filters to apply in the request. Restrictions: | ||
| 50 | |||
| 51 | =over | ||
| 52 | |||
| 53 | =item * | ||
| 54 | |||
| 55 | Any number of filters by the same dimension, as specified in the | ||
| 56 | C<GroupBy> parameter. | ||
| 57 | |||
| 58 | =item * | ||
| 59 | |||
| 60 | A single filter for any other dimension in this dimension group. | ||
| 61 | |||
| 62 | =back | ||
| 63 | |||
| 64 | |||
| 65 | |||
| 66 | =head2 GroupBy => L<Paws::PerformanceInsights::DimensionGroup> | ||
| 67 | |||
| 68 | A specification for how to aggregate the data points from a query | ||
| 69 | result. You must specify a valid dimension group. Performance Insights | ||
| 70 | will return all of the dimensions within that group, unless you provide | ||
| 71 | the names of specific dimensions within that group. You can also | ||
| 72 | request that Performance Insights return a limited number of values for | ||
| 73 | a dimension. | ||
| 74 | |||
| 75 | |||
| 76 | =head2 B<REQUIRED> Metric => Str | ||
| 77 | |||
| 78 | The name of a Performance Insights metric to be measured. | ||
| 79 | |||
| 80 | Valid values for C<Metric> are: | ||
| 81 | |||
| 82 | =over | ||
| 83 | |||
| 84 | =item * | ||
| 85 | |||
| 86 | C<db.load.avg> - a scaled representation of the number of active | ||
| 87 | sessions for the database engine. | ||
| 88 | |||
| 89 | =item * | ||
| 90 | |||
| 91 | C<db.sampledload.avg> - the raw number of active sessions for the | ||
| 92 | database engine. | ||
| 93 | |||
| 94 | =back | ||
| 95 | |||
| 96 | If the number of active sessions is less than an internal Performance | ||
| 97 | Insights threshold, C<db.load.avg> and C<db.sampledload.avg> are the | ||
| 98 | same value. If the number of active sessions is greater than the | ||
| 99 | internal threshold, Performance Insights samples the active sessions, | ||
| 100 | with C<db.load.avg> showing the scaled values, C<db.sampledload.avg> | ||
| 101 | showing the raw values, and C<db.sampledload.avg> less than | ||
| 102 | C<db.load.avg>. For most use cases, you can query C<db.load.avg> only. | ||
| 103 | |||
| 104 | |||
| 105 | |||
| 106 | =head1 SEE ALSO | ||
| 107 | |||
| 108 | This class forms part of L<Paws>, describing an object used in L<Paws::PerformanceInsights> | ||
| 109 | |||
| 110 | =head1 BUGS and CONTRIBUTIONS | ||
| 111 | |||
| 112 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 113 | |||
| 114 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 115 | |||
| 116 | =cut | ||
| 117 |