GetRDSDatabaseRecommendationProjectedMetrics
Returns the projected metrics of Amazon RDS recommendations.
Request Syntax
{
"endTime": number
,
"period": number
,
"recommendationPreferences": {
"cpuVendorArchitectures": [ "string
" ]
},
"resourceArn": "string
",
"startTime": number
,
"stat": "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.
- endTime
-
The timestamp of the last projected metrics data point to return.
Type: Timestamp
Required: Yes
- period
-
The granularity, in seconds, of the projected metrics data points.
Type: Integer
Required: Yes
- recommendationPreferences
-
Describes the recommendation preferences to return in the response of a GetAutoScalingGroupRecommendations, GetEC2InstanceRecommendations, GetEC2RecommendationProjectedMetrics, GetRDSDatabaseRecommendations, and GetRDSDatabaseRecommendationProjectedMetrics request.
Type: RecommendationPreferences object
Required: No
- resourceArn
-
The ARN that identifies the Amazon RDS.
The following is the format of the ARN:
arn:aws:rds:{region}:{accountId}:db:{resourceName}
Type: String
Required: Yes
- startTime
-
The timestamp of the first projected metrics data point to return.
Type: Timestamp
Required: Yes
- stat
-
The statistic of the projected metrics.
Type: String
Valid Values:
Maximum | Average
Required: Yes
Response Syntax
{
"recommendedOptionProjectedMetrics": [
{
"projectedMetrics": [
{
"name": "string",
"timestamps": [ number ],
"values": [ number ]
}
],
"rank": number,
"recommendedDBInstanceClass": "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.
- recommendedOptionProjectedMetrics
-
An array of objects that describes the projected metrics.
Type: Array of RDSDatabaseRecommendedOptionProjectedMetric 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) AWS access key ID or X.509 certificate.
HTTP Status Code: 400
- OptInRequiredException
-
The account is not opted in to AWS 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 AWS SDKs, see the following: