Skip to content

List Performance Analysis Report Recommendations

pi_list_performance_analysis_report_recommendations R Documentation

Retrieves recommendations for a performance analysis report

Description

Retrieves recommendations for a performance analysis report.

Usage

pi_list_performance_analysis_report_recommendations(ServiceType,
  Identifier, AnalysisReportId, RecommendationIds, MaxResults, NextToken)

Arguments

ServiceType

[required] The Amazon Web Services service for which Performance Insights returns 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
RecommendationIds

A list of recommendation identifiers to filter the results.
MaxResults

The maximum number of items to return in the response. If more items exist than the specified MaxResults value, a pagination token is included in the response so that the remaining results can be retrieved.
NextToken

An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the token, up to the value specified by MaxResults.

Value

A list with the following syntax:

list(
  Recommendations = list(
    list(
      RecommendationId = "string",
      RecommendationDescription = "string",
      RecommendationDetails = "string"
    )
  ),
  NextToken = "string"
)

Request syntax

svc$list_performance_analysis_report_recommendations(
  ServiceType = "RDS"|"DOCDB",
  Identifier = "string",
  AnalysisReportId = "string",
  RecommendationIds = list(
    "string"
  ),
  MaxResults = 123,
  NextToken = "string"
)