Get Performance Analysis Report

pi_get_performance_analysis_report

R Documentation

Retrieves the report including the report ID, status, time details, and the insights with recommendations

Description

Retrieves the report including the report ID, status, time details, and the insights with recommendations. The report status can be RUNNING, SUCCEEDED, or FAILED. The insights include the description and recommendation fields.

Usage

pi_get_performance_analysis_report(ServiceType, Identifier,
  AnalysisReportId, TextFormat, AcceptLanguage)

Arguments

ServiceType

[required] The Amazon Web Services service for which Performance Insights will return metrics. Valid value is RDS.

Identifier

[required] An immutable identifier for a data source that is unique for an Amazon Web Services Region. Performance Insights gathers metrics from this data source. In the console, the identifier is shown as ResourceID. When you call DescribeDBInstances, the identifier is returned as DbiResourceId.

To use a DB instance as a data source, specify its DbiResourceId value. For example, specify db-ABCDEFGHIJKLMNOPQRSTU1VW2X.

AnalysisReportId

[required] A unique identifier of the created analysis report. For example, report-12345678901234567

TextFormat

Indicates the text format in the report. The options are PLAIN_TEXT or MARKDOWN. The default value is ⁠plain text⁠.

AcceptLanguage

The text language in the report. The default language is EN_US (English).

Value

A list with the following syntax:

list(
  AnalysisReport = list(
    AnalysisReportId = "string",
    Identifier = "string",
    ServiceType = "RDS"|"DOCDB",
    CreateTime = as.POSIXct(
      "2015-01-01"
    ),
    StartTime = as.POSIXct(
      "2015-01-01"
    ),
    EndTime = as.POSIXct(
      "2015-01-01"
    ),
    Status = "RUNNING"|"SUCCEEDED"|"FAILED",
    Insights = list(
      list(
        InsightId = "string",
        InsightType = "string",
        Context = "CAUSAL"|"CONTEXTUAL",
        StartTime = as.POSIXct(
          "2015-01-01"
        ),
        EndTime = as.POSIXct(
          "2015-01-01"
        ),
        Severity = "LOW"|"MEDIUM"|"HIGH",
        SupportingInsights = list(),
        Description = "string",
        Recommendations = list(
          list(
            RecommendationId = "string",
            RecommendationDescription = "string"
          )
        ),
        InsightData = list(
          list(
            PerformanceInsightsMetric = list(
              Metric = "string",
              DisplayName = "string",
              Dimensions = list(
                "string"
              ),
              Value = 123.0
            )
          )
        ),
        BaselineData = list(
          list(
            PerformanceInsightsMetric = list(
              Metric = "string",
              DisplayName = "string",
              Dimensions = list(
                "string"
              ),
              Value = 123.0
            )
          )
        )
      )
    )
  )
)

Request syntax

svc$get_performance_analysis_report(
  ServiceType = "RDS"|"DOCDB",
  Identifier = "string",
  AnalysisReportId = "string",
  TextFormat = "PLAIN_TEXT"|"MARKDOWN",
  AcceptLanguage = "EN_US"
)