RecommendationDetailData
The details and metrics for the given recommendation.
Contents
- AccountId
-
The AccountID that the recommendation is generated for.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 1024.
Pattern:
[\S\s]*
Required: No
- AccountScope
-
The account scope that you want your recommendations for. AWS calculates recommendations including the management account and member accounts if the value is set to PAYER. If the value is LINKED, recommendations are calculated for individual member accounts only.
Type: String
Valid Values:
PAYER | LINKED
Required: No
- CurrencyCode
-
The currency code that AWS used to generate the recommendation and present potential savings.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 1024.
Pattern:
[\S\s]*
Required: No
- CurrentAverageCoverage
-
The average value of hourly coverage over the lookback period.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 1024.
Pattern:
[\S\s]*
Required: No
- CurrentAverageHourlyOnDemandSpend
-
The average value of hourly On-Demand spend over the lookback period of the applicable usage type.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 1024.
Pattern:
[\S\s]*
Required: No
- CurrentMaximumHourlyOnDemandSpend
-
The highest value of hourly On-Demand spend over the lookback period of the applicable usage type.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 1024.
Pattern:
[\S\s]*
Required: No
- CurrentMinimumHourlyOnDemandSpend
-
The lowest value of hourly On-Demand spend over the lookback period of the applicable usage type.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 1024.
Pattern:
[\S\s]*
Required: No
- EstimatedAverageCoverage
-
The estimated coverage of the recommended Savings Plan.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 1024.
Pattern:
[\S\s]*
Required: No
- EstimatedAverageUtilization
-
The estimated utilization of the recommended Savings Plan.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 1024.
Pattern:
[\S\s]*
Required: No
- EstimatedMonthlySavingsAmount
-
The estimated monthly savings amount based on the recommended Savings Plan.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 1024.
Pattern:
[\S\s]*
Required: No
- EstimatedOnDemandCost
-
The remaining On-Demand cost estimated to not be covered by the recommended Savings Plan, over the length of the lookback period.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 1024.
Pattern:
[\S\s]*
Required: No
- EstimatedOnDemandCostWithCurrentCommitment
-
The estimated On-Demand costs you expect with no additional commitment, based on your usage of the selected time period and the Savings Plan you own.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 1024.
Pattern:
[\S\s]*
Required: No
- EstimatedROI
-
The estimated return on investment that's based on the recommended Savings Plan that you purchased. This is calculated as estimatedSavingsAmount/estimatedSPCost*100.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 1024.
Pattern:
[\S\s]*
Required: No
- EstimatedSavingsAmount
-
The estimated savings amount that's based on the recommended Savings Plan over the length of the lookback period.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 1024.
Pattern:
[\S\s]*
Required: No
- EstimatedSavingsPercentage
-
The estimated savings percentage relative to the total cost of applicable On-Demand usage over the lookback period.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 1024.
Pattern:
[\S\s]*
Required: No
- EstimatedSPCost
-
The cost of the recommended Savings Plan over the length of the lookback period.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 1024.
Pattern:
[\S\s]*
Required: No
- ExistingHourlyCommitment
-
The existing hourly commitment for the Savings Plan type.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 1024.
Pattern:
[\S\s]*
Required: No
- GenerationTimestamp
-
The period of time that you want the usage and costs for.
Type: String
Length Constraints: Minimum length of 20. Maximum length of 25.
Pattern:
^\d{4}-\d\d-\d\dT\d\d:\d\d:\d\d(([+-]\d\d:\d\d)|Z)$
Required: No
- HourlyCommitmentToPurchase
-
The recommended hourly commitment level for the Savings Plan type and the configuration that's based on the usage during the lookback period.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 1024.
Pattern:
[\S\s]*
Required: No
- InstanceFamily
-
The instance family of the recommended Savings Plan.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 1024.
Pattern:
[\S\s]*
Required: No
- LatestUsageTimestamp
-
The period of time that you want the usage and costs for.
Type: String
Length Constraints: Minimum length of 20. Maximum length of 25.
Pattern:
^\d{4}-\d\d-\d\dT\d\d:\d\d:\d\d(([+-]\d\d:\d\d)|Z)$
Required: No
- LookbackPeriodInDays
-
How many days of previous usage that AWS considers when making this recommendation.
Type: String
Valid Values:
SEVEN_DAYS | THIRTY_DAYS | SIXTY_DAYS
Required: No
- MetricsOverLookbackPeriod
-
The related hourly cost, coverage, and utilization metrics over the lookback period.
Type: Array of RecommendationDetailHourlyMetrics objects
Required: No
- OfferingId
-
The unique ID that's used to distinguish Savings Plans from one another.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 1024.
Pattern:
[\S\s]*
Required: No
- PaymentOption
-
The payment option for the commitment (for example, All Upfront or No Upfront).
Type: String
Valid Values:
NO_UPFRONT | PARTIAL_UPFRONT | ALL_UPFRONT | LIGHT_UTILIZATION | MEDIUM_UTILIZATION | HEAVY_UTILIZATION
Required: No
- Region
-
The region the recommendation is generated for.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 1024.
Pattern:
[\S\s]*
Required: No
- SavingsPlansType
-
The requested Savings Plan recommendation type.
Type: String
Valid Values:
COMPUTE_SP | EC2_INSTANCE_SP | SAGEMAKER_SP
Required: No
- TermInYears
-
The term of the commitment in years.
Type: String
Valid Values:
ONE_YEAR | THREE_YEARS
Required: No
- UpfrontCost
-
The upfront cost of the recommended Savings Plan, based on the selected payment option.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 1024.
Pattern:
[\S\s]*
Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following: