Request Syntax Request Parameters Response Syntax Response Elements Errors See Also

ListPerformanceAnalysisReportRecommendations

Retrieves recommendations for a performance analysis report.

Request Syntax


{
   "AnalysisReportId": "string",
   "Identifier": "string",
   "MaxResults": number,
   "NextToken": "string",
   "RecommendationIds": [ "string" ],
   "ServiceType": "string"
}

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

Note

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

AnalysisReportId

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

Type: String

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

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

Required: Yes

Identifier

An immutable identifier for a data source that is unique for an AWS 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.

Type: String

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

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

Required: Yes

ServiceType

The AWS service for which Performance Insights returns metrics. Valid value is RDS.

Type: String

Valid Values: RDS | DOCDB

Required: Yes

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.

Type: Integer

Valid Range: Minimum value of 0. Maximum value of 25.

Required: No

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.

Type: String

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

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

Required: No

RecommendationIds

A list of recommendation identifiers to filter the results.

Type: Array of strings

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

Pattern: .*\S.*

Required: No

Response Syntax


{
   "NextToken": "string",
   "Recommendations": [ 
      { 
         "RecommendationDescription": "string",
         "RecommendationDetails": "string",
         "RecommendationId": "string"
      }
   ]
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

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.

Type: String

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

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

Recommendations

The list of recommendations for the analysis report.

Type: Array of Recommendation objects

Errors

For information about the errors that are common to all actions, see Common Error Types.

InternalServiceError

The request failed due to an unknown error.

HTTP Status Code: 500

InvalidArgumentException

One of the arguments provided is invalid for this request.

HTTP Status Code: 400

NotAuthorizedException

The user is not authorized to perform this request.

HTTP Status Code: 400