Insight - Amazon RDS Performance Insights
ContentsSee Also
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China (PDF).

Insight

Retrieves the list of performance issues which are identified.

Contents

Note

In the following list, the required parameters are described first.

InsightId

The unique identifier for the insight. For example, insight-12345678901234567.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 256.

Pattern: .*\S.*

Required: Yes

BaselineData

Metric names and values from the timeframe used as baseline to generate the insight.

Type: Array of Data objects

Required: No

Context

Indicates if the insight is causal or correlated insight.

Type: String

Valid Values: CAUSAL | CONTEXTUAL

Required: No

Description

Description of the insight. For example: A high severity Insight found between 02:00 to 02:30, where there was an unusually high DB load 600x above baseline. Likely performance impact.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 8000.

Pattern: (.|\n)*

Required: No

EndTime

The end time of the insight. For example, 2018-10-30T00:00:00Z.

Type: Timestamp

Required: No

InsightData

List of data objects containing metrics and references from the time range while generating the insight.

Type: Array of Data objects

Required: No

InsightType

The type of insight. For example, HighDBLoad, HighCPU, or DominatingSQLs.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 256.

Pattern: .*\S.*

Required: No

Recommendations

List of recommendations for the insight. For example, Investigate the following SQLs that contributed to 100% of the total DBLoad during that time period: sql-id.

Type: Array of Recommendation objects

Required: No

Severity

The severity of the insight. The values are: Low, Medium, or High.

Type: String

Valid Values: LOW | MEDIUM | HIGH

Required: No

StartTime

The start time of the insight. For example, 2018-10-30T00:00:00Z.

Type: Timestamp

Required: No

SupportingInsights

List of supporting insights that provide additional factors for the insight.

Type: Array of Insight objects

Required: No

See Also

For more information about using this API in one of the language-specific Amazon SDKs, see the following: