GetRDSDatabaseRecommendations
Returns Amazon RDS recommendations.
Amazon Compute Optimizer generates recommendations for Amazon RDS that meet a specific set of requirements. For more information, see the Supported resources and requirements in the Amazon Compute Optimizer User Guide.
Request Syntax
{
"accountIds": [ "string" ],
"filters": [
{
"name": "string",
"values": [ "string" ]
}
],
"maxResults": number,
"nextToken": "string",
"recommendationPreferences": {
"cpuVendorArchitectures": [ "string" ]
},
"resourceArns": [ "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.
- accountIds
-
Return the Amazon RDS recommendations to the specified Amazon Web Services account IDs.
If your account is the management account or the delegated administrator of an organization, use this parameter to return the Amazon RDS recommendations to specific member accounts.
You can only specify one account ID per request.
Type: Array of strings
Required: No
- filters
-
An array of objects to specify a filter that returns a more specific list of Amazon RDS recommendations.
Type: Array of RDSDBRecommendationFilter objects
Required: No
- maxResults
-
The maximum number of Amazon RDS recommendations to return with a single request.
To retrieve the remaining results, make another request with the returned
nextTokenvalue.Type: Integer
Valid Range: Minimum value of 0. Maximum value of 1000.
Required: No
- nextToken
-
The token to advance to the next page of Amazon RDS recommendations.
Type: String
Required: No
- recommendationPreferences
-
Describes the recommendation preferences to return in the response of a GetAutoScalingGroupRecommendations, GetEC2InstanceRecommendations, GetEC2RecommendationProjectedMetrics, GetRDSDatabaseRecommendations, and GetRDSDatabaseRecommendationProjectedMetrics request.
Type: RecommendationPreferences object
Required: No
- resourceArns
-
The ARN that identifies the Amazon RDS.
The following is the format of the ARN:
arn:aws:rds:{region}:{accountId}:db:{resourceName}The following is the format of a DB Cluster ARN:
arn:aws:rds:{region}:{accountId}:cluster:{resourceName}Type: Array of strings
Required: No
Response Syntax
{
"errors": [
{
"code": "string",
"identifier": "string",
"message": "string"
}
],
"nextToken": "string",
"rdsDBRecommendations": [
{
"accountId": "string",
"currentDBInstanceClass": "string",
"currentStorageConfiguration": {
"allocatedStorage": number,
"iops": number,
"maxAllocatedStorage": number,
"storageThroughput": number,
"storageType": "string"
},
"effectiveRecommendationPreferences": {
"cpuVendorArchitectures": [ "string" ],
"enhancedInfrastructureMetrics": "string",
"lookBackPeriod": "string",
"savingsEstimationMode": {
"source": "string"
}
},
"engine": "string",
"engineVersion": "string",
"idle": "string",
"instanceFinding": "string",
"instanceFindingReasonCodes": [ "string" ],
"instanceRecommendationOptions": [
{
"dbInstanceClass": "string",
"performanceRisk": number,
"projectedUtilizationMetrics": [
{
"name": "string",
"statistic": "string",
"value": number
}
],
"rank": number,
"savingsOpportunity": {
"estimatedMonthlySavings": {
"currency": "string",
"value": number
},
"savingsOpportunityPercentage": number
},
"savingsOpportunityAfterDiscounts": {
"estimatedMonthlySavings": {
"currency": "string",
"value": number
},
"savingsOpportunityPercentage": number
}
}
],
"lastRefreshTimestamp": number,
"lookbackPeriodInDays": number,
"resourceArn": "string",
"storageFinding": "string",
"storageFindingReasonCodes": [ "string" ],
"storageRecommendationOptions": [
{
"rank": number,
"savingsOpportunity": {
"estimatedMonthlySavings": {
"currency": "string",
"value": number
},
"savingsOpportunityPercentage": number
},
"savingsOpportunityAfterDiscounts": {
"estimatedMonthlySavings": {
"currency": "string",
"value": number
},
"savingsOpportunityPercentage": number
},
"storageConfiguration": {
"allocatedStorage": number,
"iops": number,
"maxAllocatedStorage": number,
"storageThroughput": number,
"storageType": "string"
}
}
],
"tags": [
{
"key": "string",
"value": "string"
}
],
"utilizationMetrics": [
{
"name": "string",
"statistic": "string",
"value": number
}
]
}
]
}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.
- errors
-
An array of objects that describe errors of the request.
Type: Array of GetRecommendationError objects
- nextToken
-
The token to advance to the next page of Amazon RDS recommendations.
Type: String
- rdsDBRecommendations
-
An array of objects that describe the Amazon RDS recommendations.
Type: Array of RDSDBRecommendation objects
Errors
For information about the errors that are common to all actions, see Common Errors.
- AccessDeniedException
-
You do not have sufficient access to perform this action.
HTTP Status Code: 400
- InternalServerException
-
An internal error has occurred. Try your call again.
HTTP Status Code: 500
- InvalidParameterValueException
-
The value supplied for the input parameter is out of range or not valid.
HTTP Status Code: 400
- MissingAuthenticationToken
-
The request must contain either a valid (registered) Amazon access key ID or X.509 certificate.
HTTP Status Code: 400
- OptInRequiredException
-
The account is not opted in to Amazon Compute Optimizer.
HTTP Status Code: 400
- ResourceNotFoundException
-
A resource that is required for the action doesn't exist.
HTTP Status Code: 400
- ServiceUnavailableException
-
The request has failed due to a temporary failure of the server.
HTTP Status Code: 500
- ThrottlingException
-
The request was denied due to request throttling.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific Amazon SDKs, see the following: