Menu
AWS Performance Insights
API Reference (API Version 2018-02-27)

MetricQuery

A single query to be processed. You must provide the metric to query. If no other parameters are specified, Performance Insights returns all of the data points for that metric. You can optionally request that the data points be aggregated by dimension group ( GroupBy), and return only those data points that match your criteria (Filter).

Contents

Note

In the following list, the required parameters are described first.

Metric

The name of a Performance Insights metric to be measured.

Valid values for Metric are:

  • db.load.avg - a scaled representation of the number of active sessions for the database engine.

  • db.sampledload.avg - the raw number of active sessions for the database engine.

Type: String

Required: Yes

Filter

One or more filters to apply in the request. Restrictions:

  • Any number of filters by the same dimension, as specified in the GroupBy parameter.

  • A single filter for any other dimension in this dimension group.

Type: String to string map

Required: No

GroupBy

A specification for how to aggregate the data points from a query result. You must specify a valid dimension group. Performance Insights will return all of the dimensions within that group, unless you provide the names of specific dimensions within that group. You can also request that Performance Insights return a limited number of values for a dimension.

Type: DimensionGroup object

Required: No

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following:

On this page: