CmdID / aws / aws pi

aws pi get-performance-analysis-report

Retrieves the report including the report ID, status, time details, and the insights with recommendations. AWS CLI reference

1 example 5 options Its page in the AWS CLI reference

Examples

from aws-cli, each command read by CmdID

To get a performance analysis report

The following get-performance-analysis-report example gets the performance analysis report for the database db-abcdefg123456789 with the report ID report-0d99cc91c4422ee61. The response provides the report status, ID, time details, and insights.

aws pi get-performance-analysis-report --service-type RDS --identifier db-abcdefg123456789 --analysis-report-id report-0d99cc91c4422ee61

Identify

--service-typeThe Amazon Web Services service for which Performance Insights will return metrics.

--identifierAn immutable identifier for a data source that is unique for an Amazon Web Services Region.

--analysis-report-idA unique identifier of the created analysis report.

Its output

{
    "AnalysisReport": {
        "Status": "Succeeded",
        "ServiceType": "RDS",
        "Identifier": "db-abcdefg123456789",
        "StartTime": 1680583486.584,
        "AnalysisReportId": "report-0d99cc91c4422ee61",
        "EndTime": 1680587086.584,
        "CreateTime": 1680587087.139,
        "Insights": [
            {
                "InsightId": "insight-12345678901234567",
                "InsightType": "HighDBLoad",
                "Context": "CAUSAL",
                "StartTime": 1680583486.584,
                "EndTime": 1680587086.584,
                "Severity": "HIGH",
                "Description": "A high severity Insight found between 04:44 to 05:44, where there was an unusually high DB load 600x above baseline. Likely performance impact."
            }
        ]
    }
}

For more information about performance analysis reports, see Analyzing database performance for a period of time in the Amazon RDS User Guide and Analyzing database performance for a period of time in the Amazon Aurora User Guide.

Options

5 in the AWS CLI reference

--accept-languageThe text language in the report.

--analysis-report-idA unique identifier of the created analysis report.

--identifierAn immutable identifier for a data source that is unique for an Amazon Web Services Region.

--service-typeThe Amazon Web Services service for which Performance Insights will return metrics.

--text-formatIndicates the text format in the report.