Expand description

Amazon RDS Performance Insights

Amazon RDS Performance Insights enables you to monitor and explore different dimensions of database load based on data captured from a running DB instance. The guide provides detailed information about Performance Insights data types, parameters and errors.

When Performance Insights is enabled, the Amazon RDS Performance Insights API provides visibility into the performance of your DB instance. Amazon CloudWatch provides the authoritative source for AWS service-vended monitoring metrics. Performance Insights offers a domain-specific view of DB load.

DB load is measured as Average Active Sessions. Performance Insights provides the data to API consumers as a two-dimensional time-series dataset. The time dimension provides DB load data for each time point in the queried time range. Each time point decomposes overall load in relation to the requested dimensions, measured at that time point. Examples include SQL, Wait event, User, and Host.

If you’re using the service, you’re probably looking for PerformanceInsightsClient and PerformanceInsights.


A timestamp, and a single numerical value, which together represent a measurement at a particular point in time.

A logical grouping of Performance Insights metrics for a related subject area. For example, the db.sql dimension group consists of the following dimensions: db.sql.id, db.sql.dbid, db.sql.statement, and db.sql.tokenizedid.

Each response element returns a maximum of 500 bytes. For larger elements, such as SQL statements, only the first 500 bytes are returned.

An array of descriptions and aggregated values for each dimension within a dimension group.

An object that describes the details for a specified dimension.

A time-ordered series of data points, corresponding to a dimension of a Performance Insights metric.

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).

A client for the AWS PI API.

If PartitionBy was specified in a DescribeDimensionKeys request, the dimensions are returned in an array. Each element in the array specifies one dimension.

An object describing a Performance Insights metric and one or more dimensions for that metric.


Errors returned by DescribeDimensionKeys

Errors returned by GetDimensionKeyDetails

Errors returned by GetResourceMetrics


Trait representing the capabilities of the AWS PI API. AWS PI clients implement this trait.