GetSavingsPlanPurchaseRecommendationDetails
Retrieves the details for a Savings Plan recommendation. These details include the hourly data-points that construct the cost, coverage, and utilization charts.
Request Syntax
{
"RecommendationDetailId": "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.
- RecommendationDetailId
-
The ID that is associated with the Savings Plan recommendation.
Type: String
Length Constraints: Fixed length of 36.
Pattern:
^[\S\s]{8}-[\S\s]{4}-[\S\s]{4}-[\S\s]{4}-[\S\s]{12}$Required: Yes
Response Syntax
{
"RecommendationDetailData": {
"AccountId": "string",
"AccountScope": "string",
"CurrencyCode": "string",
"CurrentAverageCoverage": "string",
"CurrentAverageHourlyOnDemandSpend": "string",
"CurrentMaximumHourlyOnDemandSpend": "string",
"CurrentMinimumHourlyOnDemandSpend": "string",
"EstimatedAverageCoverage": "string",
"EstimatedAverageUtilization": "string",
"EstimatedMonthlySavingsAmount": "string",
"EstimatedOnDemandCost": "string",
"EstimatedOnDemandCostWithCurrentCommitment": "string",
"EstimatedROI": "string",
"EstimatedSavingsAmount": "string",
"EstimatedSavingsPercentage": "string",
"EstimatedSPCost": "string",
"ExistingHourlyCommitment": "string",
"GenerationTimestamp": "string",
"HourlyCommitmentToPurchase": "string",
"InstanceFamily": "string",
"LatestUsageTimestamp": "string",
"LookbackPeriodInDays": "string",
"MetricsOverLookbackPeriod": [
{
"CurrentCoverage": "string",
"EstimatedCoverage": "string",
"EstimatedNewCommitmentUtilization": "string",
"EstimatedOnDemandCost": "string",
"StartTime": "string"
}
],
"OfferingId": "string",
"PaymentOption": "string",
"Region": "string",
"SavingsPlansType": "string",
"TermInYears": "string",
"UpfrontCost": "string"
},
"RecommendationDetailId": "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.
- RecommendationDetailData
-
Contains detailed information about a specific Savings Plan recommendation.
Type: RecommendationDetailData object
- RecommendationDetailId
-
The ID that is associated with the Savings Plan recommendation.
Type: String
Length Constraints: Fixed length of 36.
Pattern:
^[\S\s]{8}-[\S\s]{4}-[\S\s]{4}-[\S\s]{4}-[\S\s]{12}$
Errors
For information about the errors that are common to all actions, see Common Errors.
- DataUnavailableException
-
The requested data is unavailable.
HTTP Status Code: 400
- LimitExceededException
-
You made too many calls in a short period of time. Try again later.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
