AnalysisReport - Amazon RDS Performance Insights
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).

AnalysisReport

Retrieves the summary of the performance analysis report created for a time period.

Contents

Note

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

AnalysisReportId

The name of the analysis report.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 100.

Pattern: report-[0-9a-f]{17}

Required: Yes

CreateTime

The time you created the analysis report.

Type: Timestamp

Required: No

EndTime

The analysis end time in the report.

Type: Timestamp

Required: No

Identifier

The unique identifier of the analysis report.

Type: String

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

Pattern: ^[a-zA-Z0-9-]+$

Required: No

Insights

The list of identified insights in the analysis report.

Type: Array of Insight objects

Required: No

ServiceType

List the tags for the Amazon service for which Performance Insights returns metrics. Valid values are as follows:

  • RDS

  • DOCDB

Type: String

Valid Values: RDS | DOCDB

Required: No

StartTime

The analysis start time in the report.

Type: Timestamp

Required: No

Status

The status of the created analysis report.

Type: String

Valid Values: RUNNING | SUCCEEDED | FAILED

Required: No

See Also

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