Skip to content

RecommendationDetailData

Source code in docs_src/capo_cost_explorer/types/recommendation_detail_data.py
class RecommendationDetailData(TypedDict, closed=True):
    account_scope: NotRequired["capo_cost_explorer.types.account_scope.AccountScope"]
    """<p>The account scope that you want your recommendations for. Amazon Web Services 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.</p>"""
    lookback_period_in_days: NotRequired[
        "capo_cost_explorer.types.lookback_period_in_days.LookbackPeriodInDays"
    ]
    """<p>How many days of previous usage that Amazon Web Services considers when making this recommendation.</p>"""
    savings_plans_type: NotRequired[
        "capo_cost_explorer.types.supported_savings_plans_type.SupportedSavingsPlansType"
    ]
    """<p>The requested Savings Plan recommendation type.</p>"""
    term_in_years: NotRequired["capo_cost_explorer.types.term_in_years.TermInYears"]
    """<p>The term of the commitment in years.</p>"""
    payment_option: NotRequired["capo_cost_explorer.types.payment_option.PaymentOption"]
    """<p>The payment option for the commitment (for example, All Upfront or No Upfront).</p>"""
    account_id: NotRequired["capo_cost_explorer.types.generic_string.GenericString"]
    """<p>The AccountID that the recommendation is generated for.</p>"""
    currency_code: NotRequired["capo_cost_explorer.types.generic_string.GenericString"]
    """<p>The currency code that Amazon Web Services used to generate the recommendation and present potential savings.</p>"""
    instance_family: NotRequired[
        "capo_cost_explorer.types.generic_string.GenericString"
    ]
    """<p>The instance family of the recommended Savings Plan.</p>"""
    region: NotRequired["capo_cost_explorer.types.generic_string.GenericString"]
    """<p>The region the recommendation is generated for.</p>"""
    offering_id: NotRequired["capo_cost_explorer.types.generic_string.GenericString"]
    """<p>The unique ID that's used to distinguish Savings Plans from one another.</p>"""
    generation_timestamp: NotRequired[
        "capo_cost_explorer.types.zoned_date_time.ZonedDateTime"
    ]
    latest_usage_timestamp: NotRequired[
        "capo_cost_explorer.types.zoned_date_time.ZonedDateTime"
    ]
    current_average_hourly_on_demand_spend: NotRequired[
        "capo_cost_explorer.types.generic_string.GenericString"
    ]
    """<p>The average value of hourly On-Demand spend over the lookback period of the applicable usage type.</p>"""
    current_maximum_hourly_on_demand_spend: NotRequired[
        "capo_cost_explorer.types.generic_string.GenericString"
    ]
    """<p>The highest value of hourly On-Demand spend over the lookback period of the applicable usage type.</p>"""
    current_minimum_hourly_on_demand_spend: NotRequired[
        "capo_cost_explorer.types.generic_string.GenericString"
    ]
    """<p>The lowest value of hourly On-Demand spend over the lookback period of the applicable usage type.</p>"""
    estimated_average_utilization: NotRequired[
        "capo_cost_explorer.types.generic_string.GenericString"
    ]
    """<p>The estimated utilization of the recommended Savings Plan.</p>"""
    estimated_monthly_savings_amount: NotRequired[
        "capo_cost_explorer.types.generic_string.GenericString"
    ]
    """<p>The estimated monthly savings amount based on the recommended Savings Plan.</p>"""
    estimated_on_demand_cost: NotRequired[
        "capo_cost_explorer.types.generic_string.GenericString"
    ]
    """<p>The remaining On-Demand cost estimated to not be covered by the recommended Savings Plan, over the length of the lookback period.</p>"""
    estimated_on_demand_cost_with_current_commitment: NotRequired[
        "capo_cost_explorer.types.generic_string.GenericString"
    ]
    """<p>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.</p>"""
    estimated_roi: NotRequired["capo_cost_explorer.types.generic_string.GenericString"]
    """<p>The estimated return on investment that's based on the recommended Savings Plan that you purchased. This is calculated as estimatedSavingsAmount/estimatedSPCost*100.</p>"""
    estimated_sp_cost: NotRequired[
        "capo_cost_explorer.types.generic_string.GenericString"
    ]
    """<p>The cost of the recommended Savings Plan over the length of the lookback period.</p>"""
    estimated_savings_amount: NotRequired[
        "capo_cost_explorer.types.generic_string.GenericString"
    ]
    """<p>The estimated savings amount that's based on the recommended Savings Plan over the length of the lookback period.</p>"""
    estimated_savings_percentage: NotRequired[
        "capo_cost_explorer.types.generic_string.GenericString"
    ]
    """<p>The estimated savings percentage relative to the total cost of applicable On-Demand usage over the lookback period.</p>"""
    existing_hourly_commitment: NotRequired[
        "capo_cost_explorer.types.generic_string.GenericString"
    ]
    """<p>The existing hourly commitment for the Savings Plan type.</p>"""
    hourly_commitment_to_purchase: NotRequired[
        "capo_cost_explorer.types.generic_string.GenericString"
    ]
    """<p>The recommended hourly commitment level for the Savings Plan type and the configuration that's based on the usage during the lookback period.</p>"""
    upfront_cost: NotRequired["capo_cost_explorer.types.generic_string.GenericString"]
    """<p>The upfront cost of the recommended Savings Plan, based on the selected payment option.</p>"""
    current_average_coverage: NotRequired[
        "capo_cost_explorer.types.generic_string.GenericString"
    ]
    """<p>The average value of hourly coverage over the lookback period.</p>"""
    estimated_average_coverage: NotRequired[
        "capo_cost_explorer.types.generic_string.GenericString"
    ]
    """<p>The estimated coverage of the recommended Savings Plan.</p>"""
    metrics_over_lookback_period: NotRequired[
        "capo_cost_explorer.types.metrics_over_lookback_period.MetricsOverLookbackPeriod"
    ]
    """<p>The related hourly cost, coverage, and utilization metrics over the lookback period.</p>"""

account_id instance-attribute

account_id: NotRequired[GenericString]

The AccountID that the recommendation is generated for.

account_scope instance-attribute

account_scope: NotRequired[AccountScope]

The account scope that you want your recommendations for. Amazon Web Services 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.

currency_code instance-attribute

currency_code: NotRequired[GenericString]

The currency code that Amazon Web Services used to generate the recommendation and present potential savings.

current_average_coverage instance-attribute

current_average_coverage: NotRequired[GenericString]

The average value of hourly coverage over the lookback period.

current_average_hourly_on_demand_spend instance-attribute

current_average_hourly_on_demand_spend: NotRequired[GenericString]

The average value of hourly On-Demand spend over the lookback period of the applicable usage type.

current_maximum_hourly_on_demand_spend instance-attribute

current_maximum_hourly_on_demand_spend: NotRequired[GenericString]

The highest value of hourly On-Demand spend over the lookback period of the applicable usage type.

current_minimum_hourly_on_demand_spend instance-attribute

current_minimum_hourly_on_demand_spend: NotRequired[GenericString]

The lowest value of hourly On-Demand spend over the lookback period of the applicable usage type.

estimated_average_coverage instance-attribute

estimated_average_coverage: NotRequired[GenericString]

The estimated coverage of the recommended Savings Plan.

estimated_average_utilization instance-attribute

estimated_average_utilization: NotRequired[GenericString]

The estimated utilization of the recommended Savings Plan.

estimated_monthly_savings_amount instance-attribute

estimated_monthly_savings_amount: NotRequired[GenericString]

The estimated monthly savings amount based on the recommended Savings Plan.

estimated_on_demand_cost instance-attribute

estimated_on_demand_cost: NotRequired[GenericString]

The remaining On-Demand cost estimated to not be covered by the recommended Savings Plan, over the length of the lookback period.

estimated_on_demand_cost_with_current_commitment instance-attribute

estimated_on_demand_cost_with_current_commitment: NotRequired[GenericString]

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.

estimated_roi instance-attribute

estimated_roi: NotRequired[GenericString]

The estimated return on investment that's based on the recommended Savings Plan that you purchased. This is calculated as estimatedSavingsAmount/estimatedSPCost*100.

estimated_savings_amount instance-attribute

estimated_savings_amount: NotRequired[GenericString]

The estimated savings amount that's based on the recommended Savings Plan over the length of the lookback period.

estimated_savings_percentage instance-attribute

estimated_savings_percentage: NotRequired[GenericString]

The estimated savings percentage relative to the total cost of applicable On-Demand usage over the lookback period.

estimated_sp_cost instance-attribute

estimated_sp_cost: NotRequired[GenericString]

The cost of the recommended Savings Plan over the length of the lookback period.

existing_hourly_commitment instance-attribute

existing_hourly_commitment: NotRequired[GenericString]

The existing hourly commitment for the Savings Plan type.

generation_timestamp instance-attribute

generation_timestamp: NotRequired[ZonedDateTime]

hourly_commitment_to_purchase instance-attribute

hourly_commitment_to_purchase: NotRequired[GenericString]

The recommended hourly commitment level for the Savings Plan type and the configuration that's based on the usage during the lookback period.

instance_family instance-attribute

instance_family: NotRequired[GenericString]

The instance family of the recommended Savings Plan.

latest_usage_timestamp instance-attribute

latest_usage_timestamp: NotRequired[ZonedDateTime]

lookback_period_in_days instance-attribute

lookback_period_in_days: NotRequired[LookbackPeriodInDays]

How many days of previous usage that Amazon Web Services considers when making this recommendation.

metrics_over_lookback_period instance-attribute

metrics_over_lookback_period: NotRequired[MetricsOverLookbackPeriod]

The related hourly cost, coverage, and utilization metrics over the lookback period.

offering_id instance-attribute

offering_id: NotRequired[GenericString]

The unique ID that's used to distinguish Savings Plans from one another.

payment_option instance-attribute

payment_option: NotRequired[PaymentOption]

The payment option for the commitment (for example, All Upfront or No Upfront).

region instance-attribute

region: NotRequired[GenericString]

The region the recommendation is generated for.

savings_plans_type instance-attribute

savings_plans_type: NotRequired[SupportedSavingsPlansType]

The requested Savings Plan recommendation type.

term_in_years instance-attribute

term_in_years: NotRequired[TermInYears]

The term of the commitment in years.

upfront_cost instance-attribute

upfront_cost: NotRequired[GenericString]

The upfront cost of the recommended Savings Plan, based on the selected payment option.