Skip to content

VolumeRecommendationOption

Source code in docs_src/capo_compute_optimizer/types/volume_recommendation_option.py
class VolumeRecommendationOption(TypedDict, closed=True):
    configuration: NotRequired[
        "capo_compute_optimizer.types.volume_configuration.VolumeConfiguration"
    ]
    """<p>An array of objects that describe a volume configuration.</p>"""
    performance_risk: "capo_compute_optimizer.types.performance_risk.PerformanceRisk"
    """<p>The performance risk of the volume recommendation option.</p> <p>Performance risk is the likelihood of the recommended volume type meeting the performance requirement of your workload.</p> <p>The value ranges from <code>0</code> - <code>4</code>, with <code>0</code> meaning that the recommended resource is predicted to always provide enough hardware capability. The higher the performance risk is, the more likely you should validate whether the recommendation will meet the performance requirements of your workload before migrating your resource.</p>"""
    rank: "capo_compute_optimizer.types.rank.Rank"
    """<p>The rank of the volume recommendation option.</p> <p>The top recommendation option is ranked as <code>1</code>.</p>"""
    savings_opportunity: NotRequired[
        "capo_compute_optimizer.types.savings_opportunity.SavingsOpportunity"
    ]
    """<p>An object that describes the savings opportunity for the EBS volume recommendation option. Savings opportunity includes the estimated monthly savings amount and percentage.</p>"""
    savings_opportunity_after_discounts: NotRequired[
        "capo_compute_optimizer.types.ebs_savings_opportunity_after_discounts.EBSSavingsOpportunityAfterDiscounts"
    ]
    """<p> An object that describes the savings opportunity for the Amazon EBS volume recommendation option with specific discounts. Savings opportunity includes the estimated monthly savings and percentage. </p>"""

configuration instance-attribute

configuration: NotRequired[VolumeConfiguration]

An array of objects that describe a volume configuration.

performance_risk instance-attribute

performance_risk: PerformanceRisk

The performance risk of the volume recommendation option.

Performance risk is the likelihood of the recommended volume type meeting the performance requirement of your workload.

The value ranges from 0 - 4, with 0 meaning that the recommended resource is predicted to always provide enough hardware capability. The higher the performance risk is, the more likely you should validate whether the recommendation will meet the performance requirements of your workload before migrating your resource.

rank instance-attribute

rank: Rank

The rank of the volume recommendation option.

The top recommendation option is ranked as 1.

savings_opportunity instance-attribute

savings_opportunity: NotRequired[SavingsOpportunity]

An object that describes the savings opportunity for the EBS volume recommendation option. Savings opportunity includes the estimated monthly savings amount and percentage.

savings_opportunity_after_discounts instance-attribute

savings_opportunity_after_discounts: NotRequired[EBSSavingsOpportunityAfterDiscounts]

An object that describes the savings opportunity for the Amazon EBS volume recommendation option with specific discounts. Savings opportunity includes the estimated monthly savings and percentage.