- Navigation GuideYou are on a Client landing page. Commands (operations) are listed on this page. The Client constructor type is linked at the bottom.
PIClient
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 .
-
To learn more about Performance Insights and Amazon RDS DB instances, go to the Amazon RDS User Guide .
-
To learn more about Performance Insights and Amazon DocumentDB clusters, go to the Amazon DocumentDB Developer Guide .
Installation
npm install @aws-sdk/client-pi
yarn add @aws-sdk/client-pi
pnpm add @aws-sdk/client-pi
PIClient Operations
Command | Summary |
---|
Command | Summary |
---|---|
CreatePerformanceAnalysisReportCommand | Creates a new performance analysis report for a specific time period for the DB instance. |
DeletePerformanceAnalysisReportCommand | Deletes a performance analysis report. |
DescribeDimensionKeysCommand | For a specific time period, retrieve the top Each response element returns a maximum of 500 bytes. For larger elements, such as SQL statements, only the first 500 bytes are returned. |
GetDimensionKeyDetailsCommand | Get the attributes of the specified dimension group for a DB instance or data source. For example, if you specify a SQL ID, |
GetPerformanceAnalysisReportCommand | Retrieves the report including the report ID, status, time details, and the insights with recommendations. The report status can be |
GetResourceMetadataCommand | 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. |
GetResourceMetricsCommand | 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. Each response element returns a maximum of 500 bytes. For larger elements, such as SQL statements, only the first 500 bytes are returned. |
ListAvailableResourceDimensionsCommand | Retrieve the dimensions that can be queried for each specified metric type on a specified DB instance. |
ListAvailableResourceMetricsCommand | Retrieve metrics of the specified types that can be queried for a specified DB instance. |
ListPerformanceAnalysisReportsCommand | Lists all the analysis reports created for the DB instance. The reports are sorted based on the start time of each report. |
ListTagsForResourceCommand | Retrieves all the metadata tags associated with Amazon RDS Performance Insights resource. |
TagResourceCommand | Adds metadata tags to the Amazon RDS Performance Insights resource. |
UntagResourceCommand | Deletes the metadata tags from the Amazon RDS Performance Insights resource. |
PIClient Configuration
Parameter | Type | Description |
---|
Parameter | Type | Description |
---|---|---|
defaultsMode Optional | DefaultsMode | Provider<DefaultsMode> | The @smithy/smithy-client#DefaultsMode that will be used to determine how certain default configuration options are resolved in the SDK. |
disableHostPrefix Optional | boolean | Disable dynamically changing the endpoint of the client based on the hostPrefix trait of an operation. |
extensions Optional | RuntimeExtension[] | Optional extensions |
logger Optional | Logger | Optional logger for logging debug/info/warn/error. |
maxAttempts Optional | number | Provider<number> | Value for how many times a request will be made at most in case of retry. |
profile Optional | string | Setting a client profile is similar to setting a value for the AWS_PROFILE environment variable. Setting a profile on a client in code only affects the single client instance, unlike AWS_PROFILE.When set, and only for environments where an AWS configuration file exists, fields configurable by this file will be retrieved from the specified profile within that file. Conflicting code configuration and environment variables will still have higher priority.For client credential resolution that involves checking the AWS configuration file, the client's profile (this value) will be used unless a different profile is set in the credential provider options. |
region Optional | string | Provider<string> | The AWS region to which this client will send requests |
requestHandler Optional | __HttpHandlerUserInput | The HTTP handler to use or its constructor options. Fetch in browser and Https in Nodejs. |
retryMode Optional | string | Provider<string> | Specifies which retry algorithm to use. |
useDualstackEndpoint Optional | boolean | Provider<boolean> | Enables IPv6/IPv4 dualstack endpoint. |
useFipsEndpoint Optional | boolean | Provider<boolean> | Enables FIPS compatible endpoints. |
Additional config fields are described in the full configuration type: PIClientConfig