Skip to content

SavingsPlan

Source code in docs_src/capo_savingsplans/types/savings_plan.py
class SavingsPlan(TypedDict, closed=True):
    offering_id: NotRequired[
        "capo_savingsplans.types.savings_plan_offering_id.SavingsPlanOfferingId"
    ]
    """<p>The ID of the offering.</p>"""
    savings_plan_id: NotRequired[
        "capo_savingsplans.types.savings_plan_id.SavingsPlanId"
    ]
    """<p>The ID of the Savings Plan.</p>"""
    savings_plan_arn: NotRequired[
        "capo_savingsplans.types.savings_plan_arn.SavingsPlanArn"
    ]
    """<p>The Amazon Resource Name (ARN) of the Savings Plan.</p>"""
    description: NotRequired["capo_savingsplans.types.string.String"]
    """<p>The description.</p>"""
    start: NotRequired["capo_savingsplans.types.string.String"]
    """<p>The start time.</p>"""
    end: NotRequired["capo_savingsplans.types.string.String"]
    """<p>The end time.</p>"""
    state: NotRequired["capo_savingsplans.types.savings_plan_state.SavingsPlanState"]
    """<p>The current state.</p>"""
    region: NotRequired["capo_savingsplans.types.region.Region"]
    """<p>The Amazon Web Services Region.</p>"""
    ec2_instance_family: NotRequired[
        "capo_savingsplans.types.ec2_instance_family.EC2InstanceFamily"
    ]
    """<p>The EC2 instance family.</p>"""
    savings_plan_type: NotRequired[
        "capo_savingsplans.types.savings_plan_type.SavingsPlanType"
    ]
    """<p>The plan type.</p>"""
    payment_option: NotRequired[
        "capo_savingsplans.types.savings_plan_payment_option.SavingsPlanPaymentOption"
    ]
    """<p>The payment option.</p>"""
    product_types: NotRequired[
        "capo_savingsplans.types.savings_plan_product_type_list.SavingsPlanProductTypeList"
    ]
    """<p>The product types.</p>"""
    currency: NotRequired["capo_savingsplans.types.currency_code.CurrencyCode"]
    """<p>The currency.</p>"""
    commitment: NotRequired["capo_savingsplans.types.amount.Amount"]
    """<p>The hourly commitment amount in the specified currency.</p>"""
    upfront_payment_amount: NotRequired["capo_savingsplans.types.amount.Amount"]
    """<p>The up-front payment amount.</p>"""
    recurring_payment_amount: NotRequired["capo_savingsplans.types.amount.Amount"]
    """<p>The recurring payment amount.</p>"""
    term_duration_in_seconds: (
        "capo_savingsplans.types.term_duration_in_seconds.TermDurationInSeconds"
    )
    """<p>The duration of the term, in seconds.</p>"""
    tags: NotRequired["capo_savingsplans.types.tag_map.TagMap"]
    """<p>One or more tags.</p>"""
    returnable_until: NotRequired["capo_savingsplans.types.string.String"]
    """<p>The time until when a return for the Savings Plan can be requested. If the Savings Plan is not returnable, the field reflects the Savings Plans start time.</p>"""

commitment instance-attribute

commitment: NotRequired[Amount]

The hourly commitment amount in the specified currency.

currency instance-attribute

currency: NotRequired[CurrencyCode]

The currency.

description instance-attribute

description: NotRequired[String]

The description.

ec2_instance_family instance-attribute

ec2_instance_family: NotRequired[EC2InstanceFamily]

The EC2 instance family.

end instance-attribute

end: NotRequired[String]

The end time.

offering_id instance-attribute

offering_id: NotRequired[SavingsPlanOfferingId]

The ID of the offering.

payment_option instance-attribute

payment_option: NotRequired[SavingsPlanPaymentOption]

The payment option.

product_types instance-attribute

product_types: NotRequired[SavingsPlanProductTypeList]

The product types.

recurring_payment_amount instance-attribute

recurring_payment_amount: NotRequired[Amount]

The recurring payment amount.

region instance-attribute

region: NotRequired[Region]

The Amazon Web Services Region.

returnable_until instance-attribute

returnable_until: NotRequired[String]

The time until when a return for the Savings Plan can be requested. If the Savings Plan is not returnable, the field reflects the Savings Plans start time.

savings_plan_arn instance-attribute

savings_plan_arn: NotRequired[SavingsPlanArn]

The Amazon Resource Name (ARN) of the Savings Plan.

savings_plan_id instance-attribute

savings_plan_id: NotRequired[SavingsPlanId]

The ID of the Savings Plan.

savings_plan_type instance-attribute

savings_plan_type: NotRequired[SavingsPlanType]

The plan type.

start instance-attribute

start: NotRequired[String]

The start time.

state instance-attribute

state: NotRequired[SavingsPlanState]

The current state.

tags instance-attribute

tags: NotRequired[TagMap]

One or more tags.

term_duration_in_seconds instance-attribute

term_duration_in_seconds: TermDurationInSeconds

The duration of the term, in seconds.

upfront_payment_amount instance-attribute

upfront_payment_amount: NotRequired[Amount]

The up-front payment amount.