AWS.PI — AWS SDK for JavaScript (original) (raw)

We recommend that you migrate to AWS SDK for JavaScript v3. For dates, additional details, and information on how to migrate, please refer to the linked announcement.

Class: AWS.PI

Overview

Constructs a service interface object. Each API operation is exposed as a function on service.

Service Description

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.

Sending a Request Using PI

var pi = new AWS.PI();
pi.createPerformanceAnalysisReport(params, function (err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Locking the API Version

In order to ensure that the PI object uses this specific API, you can construct the object by passing the apiVersion option to the constructor:

var pi = new AWS.PI({apiVersion: '2018-02-27'});

You can also set the API version globally in AWS.config.apiVersions using the pi service identifier:

AWS.config.apiVersions = {
  pi: '2018-02-27',
  // other service API versions
};

var pi = new AWS.PI();

Constructor Summarycollapse

Property Summarycollapse

Properties inherited from AWS.Service

apiVersions

Method Summarycollapse

Methods inherited from AWS.Service

makeRequest, makeUnauthenticatedRequest, waitFor, setupRequestListeners, defineService

Constructor Details

new AWS.PI(options = {}) ⇒ Object

Constructs a service object. This object has one method for each API operation.

Property Details

endpoint ⇒ AWS.Endpoint

Returns an Endpoint object representing the endpoint URL for service requests.

Method Details

createPerformanceAnalysisReport(params = {}, callback) ⇒ AWS.Request

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

deletePerformanceAnalysisReport(params = {}, callback) ⇒ AWS.Request

Deletes a performance analysis report.

describeDimensionKeys(params = {}, callback) ⇒ AWS.Request

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

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

getDimensionKeyDetails(params = {}, callback) ⇒ AWS.Request

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.

getPerformanceAnalysisReport(params = {}, callback) ⇒ AWS.Request

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.

getResourceMetadata(params = {}, callback) ⇒ AWS.Request

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.

getResourceMetrics(params = {}, callback) ⇒ AWS.Request

Retrieve Performance Insights metrics for a set of data sources over a time period. You can provide specific dimension groups and dimensions, and provide filtering criteria for each group. You must specify an aggregate function for each metric.

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

listAvailableResourceDimensions(params = {}, callback) ⇒ AWS.Request

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

listAvailableResourceMetrics(params = {}, callback) ⇒ AWS.Request

Retrieve metrics of the specified types that can be queried for a specified DB instance.

listPerformanceAnalysisReports(params = {}, callback) ⇒ AWS.Request

Lists all the analysis reports created for the DB instance. The reports are sorted based on the start time of each report.

listTagsForResource(params = {}, callback) ⇒ AWS.Request

Retrieves all the metadata tags associated with Amazon RDS Performance Insights resource.

tagResource(params = {}, callback) ⇒ AWS.Request

Adds metadata tags to the Amazon RDS Performance Insights resource.

untagResource(params = {}, callback) ⇒ AWS.Request

Deletes the metadata tags from the Amazon RDS Performance Insights resource.