Amazon Web Services, Inc.

AWS Performance Insights

Amazon RDS Performance Insights Amazon RDS Performance Insights enables you to monitor and explore different dimensions of database load based on data…

Developer tools#openapi#cloud

Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.

Overview

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
.

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
.

Endpoints 14

  • POSTCreate performance analysis report/#X-Amz-Target=PerformanceInsightsv20180227.CreatePerformanceAnalysisReportCreates a new performance analysis report for a specific time period for the DB instance.
  • POSTDelete performance analysis report/#X-Amz-Target=PerformanceInsightsv20180227.DeletePerformanceAnalysisReportDeletes a performance analysis report.
  • POSTDescribe dimension keys/#X-Amz-Target=PerformanceInsightsv20180227.DescribeDimensionKeysFor 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…
  • POSTGet dimension key details/#X-Amz-Target=PerformanceInsightsv20180227.GetDimensionKeyDetailsGet the attributes of the specified dimension group for a DB instance or data source. For example, if you specify a SQL ID, GetDimensionKeyDetails retrieves…
  • POSTGet performance analysis report/#X-Amz-Target=PerformanceInsightsv20180227.GetPerformanceAnalysisReportRetrieves the report including the report ID, status, time details, and the insights with recommendations. The report status can be RUNNING , SUCCEEDED , or…
  • POSTGet resource metadata/#X-Amz-Target=PerformanceInsightsv20180227.GetResourceMetadataRetrieve the metadata for different features. For example, the metadata might indicate that a feature is turned on or off on a specific DB instance.
  • POSTGet resource metrics/#X-Amz-Target=PerformanceInsightsv20180227.GetResourceMetricsRetrieve Performance Insights metrics for a set of data sources over a time period. You can provide specific dimension groups and dimensions, and provide…
  • POSTList available resource dimensions/#X-Amz-Target=PerformanceInsightsv20180227.ListAvailableResourceDimensionsRetrieve the dimensions that can be queried for each specified metric type on a specified DB instance.
  • POSTList available resource metrics/#X-Amz-Target=PerformanceInsightsv20180227.ListAvailableResourceMetricsRetrieve metrics of the specified types that can be queried for a specified DB instance.
  • POSTList performance analysis report recommendations/#X-Amz-Target=PerformanceInsightsv20180227.ListPerformanceAnalysisReportRecommendationsRetrieves recommendations for a performance analysis report.
  • POSTList performance analysis reports/#X-Amz-Target=PerformanceInsightsv20180227.ListPerformanceAnalysisReportsLists all the analysis reports created for the DB instance. The reports are sorted based on the start time of each report.
  • POSTList tags for resource/#X-Amz-Target=PerformanceInsightsv20180227.ListTagsForResourceRetrieves all the metadata tags associated with Amazon RDS Performance Insights resource.
  • POSTTag resource/#X-Amz-Target=PerformanceInsightsv20180227.TagResourceAdds metadata tags to the Amazon RDS Performance Insights resource.
  • POSTUntag resource/#X-Amz-Target=PerformanceInsightsv20180227.UntagResourceDeletes the metadata tags from the Amazon RDS Performance Insights resource.

API details

Base URL
https://pi.{region}.amazonaws.com
Authentication
AWS Signature Version 4 (requests signed with your AWS access key)
Operations
14 operations on 14 pathsPOST 14
Description format
AWS Smithy model, API version 2018-02-27

How to test the AWS Performance Insights in Swastik Codes

  1. Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
  2. Fork it into your workspaceChoose a workspace. You get your own copy of the AWS Performance Insights collection, without the publisher's secrets.
  3. Add your credentialsThis API uses AWS Signature Version 4 (requests signed with your AWS access key). Add yours in the collection's variables or an environment; the requests already reference it.
  4. Send a requestPick an endpoint, for example “Create performance analysis report” (POST /#X-Amz-Target=PerformanceInsightsv20180227.CreatePerformanceAnalysisReport), and press Send. Check the response, add tests and run the whole collection with the runner.

Frequently asked questions

What is the AWS Performance Insights?

Amazon RDS Performance Insights Amazon RDS Performance Insights enables you to monitor and explore different dimensions of database load based on data… It is listed under Developer tools and has 14 endpoints.

Who publishes the AWS Performance Insights?

It is listed from Amazon Web Services, Inc.'s public API description (an OpenAPI document), not published by Amazon Web Services, Inc. on Swastik Codes. Anyone who controls amazonaws.com can claim the profile by adding a DNS TXT record.

What is the base URL of the AWS Performance Insights?

Requests go to https://pi.{region}.amazonaws.com. Endpoint paths are added to this base URL.

How do I authenticate with the AWS Performance Insights?

With AWS Signature Version 4 (requests signed with your AWS access key).

How many endpoints does the AWS Performance Insights have?

14 operations on 14 paths (14 POST).

Is forking the AWS Performance Insights free?

Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.

Suggest an API

Tell us which public API is missing. We check it, then add it here with its endpoints when it has an OpenAPI (Swagger) description.