View Source aws_pi (aws v1.0.4)

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 Amazon Web Services 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.

  • To learn more about Performance Insights and Amazon Aurora DB instances, go to the Amazon Aurora User Guide: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_PerfInsights.html .

  • To learn more about Performance Insights and Amazon RDS DB instances, go to the Amazon RDS User Guide: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_PerfInsights.html .

  • To learn more about Performance Insights and Amazon DocumentDB clusters, go to the Amazon DocumentDB Developer Guide: https://docs.aws.amazon.com/documentdb/latest/developerguide/performance-insights.html .

Summary

Functions

Creates a new performance analysis report for a specific time period for the DB instance.
Deletes a performance analysis report.

For a specific time period, retrieve the top N dimension keys for a metric.

Get the attributes of the specified dimension group for a DB instance or data source.

Retrieves the report including the report ID, status, time details, and the insights with recommendations.

Retrieve the metadata for different features.

Retrieve Performance Insights metrics for a set of data sources over a time period.

Retrieve the dimensions that can be queried for each specified metric type on a specified DB instance.
Retrieve metrics of the specified types that can be queried for a specified DB instance.

Lists all the analysis reports created for the DB instance.

Retrieves all the metadata tags associated with Amazon RDS Performance Insights resource.
Adds metadata tags to the Amazon RDS Performance Insights resource.
Deletes the metadata tags from the Amazon RDS Performance Insights resource.

Functions

Link to this function

create_performance_analysis_report(Client, Input)

View Source
Creates a new performance analysis report for a specific time period for the DB instance.
Link to this function

create_performance_analysis_report(Client, Input, Options)

View Source
Link to this function

delete_performance_analysis_report(Client, Input)

View Source
Deletes a performance analysis report.
Link to this function

delete_performance_analysis_report(Client, Input, Options)

View Source
Link to this function

describe_dimension_keys(Client, Input)

View Source

For a specific time period, retrieve the top N dimension keys for a metric.

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

describe_dimension_keys(Client, Input, Options)

View Source
Link to this function

get_dimension_key_details(Client, Input)

View Source

Get the attributes of the specified dimension group for a DB instance or data source.

For example, if you specify a SQL ID, GetDimensionKeyDetails retrieves the full text of the dimension db.sql.statement associated with this ID. This operation is useful because GetResourceMetrics and DescribeDimensionKeys don't support retrieval of large SQL statement text.
Link to this function

get_dimension_key_details(Client, Input, Options)

View Source
Link to this function

get_performance_analysis_report(Client, Input)

View Source

Retrieves the report including the report ID, status, time details, and the insights with recommendations.

The report status can be RUNNING, SUCCEEDED, or FAILED. The insights include the description and recommendation fields.
Link to this function

get_performance_analysis_report(Client, Input, Options)

View Source
Link to this function

get_resource_metadata(Client, Input)

View Source

Retrieve the metadata for different features.

For example, the metadata might indicate that a feature is turned on or off on a specific DB instance.
Link to this function

get_resource_metadata(Client, Input, Options)

View Source
Link to this function

get_resource_metrics(Client, Input)

View Source

Retrieve Performance Insights metrics for a set of data sources over a time period.

You can provide specific dimension groups and dimensions, and provide aggregation and filtering criteria for each group.

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

get_resource_metrics(Client, Input, Options)

View Source
Link to this function

list_available_resource_dimensions(Client, Input)

View Source
Retrieve the dimensions that can be queried for each specified metric type on a specified DB instance.
Link to this function

list_available_resource_dimensions(Client, Input, Options)

View Source
Link to this function

list_available_resource_metrics(Client, Input)

View Source
Retrieve metrics of the specified types that can be queried for a specified DB instance.
Link to this function

list_available_resource_metrics(Client, Input, Options)

View Source
Link to this function

list_performance_analysis_reports(Client, Input)

View Source

Lists all the analysis reports created for the DB instance.

The reports are sorted based on the start time of each report.
Link to this function

list_performance_analysis_reports(Client, Input, Options)

View Source
Link to this function

list_tags_for_resource(Client, Input)

View Source
Retrieves all the metadata tags associated with Amazon RDS Performance Insights resource.
Link to this function

list_tags_for_resource(Client, Input, Options)

View Source
Link to this function

tag_resource(Client, Input)

View Source
Adds metadata tags to the Amazon RDS Performance Insights resource.
Link to this function

tag_resource(Client, Input, Options)

View Source
Link to this function

untag_resource(Client, Input)

View Source
Deletes the metadata tags from the Amazon RDS Performance Insights resource.
Link to this function

untag_resource(Client, Input, Options)

View Source