CreditData ¶

class CreditData(TypedDict, closed=True):
    credit_id: "capo_billing.types.credit_id.CreditId"
    """<p>The unique identifier for the credit.</p>"""
    account_id: "capo_billing.types.account_id.AccountId"
    """<p>The Amazon Web Services account ID that owns the credit.</p>"""
    credit_type: "str"
    """<p>The type of credit. Examples: <code>Promotion</code>, <code>Refund</code>, <code>TrueUp</code>.</p>"""
    initial_amount: "capo_billing.types.amount.Amount"
    """<p>The initial amount of the credit when it was issued.</p>"""
    remaining_amount: "capo_billing.types.amount.Amount"
    """<p>The unused balance of the credit.</p>"""
    estimated_amount: NotRequired["capo_billing.types.amount.Amount"]
    """<p>The estimated remaining balance, including in-flight (open) bills that have not yet been finalized.</p>"""
    applicable_product_names: NotRequired[
        "capo_billing.types.product_names.ProductNames"
    ]
    """<p>The names of Amazon Web Services services this credit applies to.</p>"""
    description: "str"
    """<p>A human-readable description of the credit.</p>"""
    start_date: "datetime.datetime"
    """<p>The date the credit becomes valid, as Unix epoch seconds.</p>"""
    end_date: NotRequired["datetime.datetime"]
    """<p>The date the credit expires, as Unix epoch seconds.</p>"""
    exhaust_date: NotRequired["datetime.datetime"]
    """<p>The date the credit balance reached zero, as Unix epoch seconds.</p>"""
    application_type: NotRequired["capo_billing.types.application_type.ApplicationType"]
    """<p>When the credit is applied during bill computation. Valid values: <code>BEFORE_CROSS_SERVICE_DISCOUNTS</code>, <code>AFTER_DISCOUNTS</code>.</p>"""
    shareable_accounts: NotRequired[
        "capo_billing.types.shareable_account_ids.ShareableAccountIds"
    ]
    """<p>The Amazon Web Services account IDs entitled to apply this credit.</p>"""
    account_has_credit_sharing_enabled: NotRequired["bool"]
    """<p>Whether the owning account has account-level credit sharing turned on.</p>"""
    credit_console_visibility: NotRequired["str"]
    """<p>The display configuration for the credit in the Amazon Web Services Billing console.</p>"""
    credit_sharing_type: NotRequired[
        "capo_billing.types.credit_sharing_type.CreditSharingType"
    ]
    """<p>The sharing configuration for the credit. Valid values: <code>DEFAULT</code>, <code>DISABLED</code>, <code>CUSTOM</code>, <code>COST_CATEGORY_RULE</code>.</p>"""
    cost_category_arn: NotRequired["str"]
    """<p>The Amazon Resource Name (ARN) of the Cost Category controlling the credit's sharing scope. Present only when <code>creditSharingType</code> is <code>COST_CATEGORY_RULE</code>.</p>"""
    rule_name: NotRequired["str"]
    """<p>The rule name within the Cost Category. Present only when <code>creditSharingType</code> is <code>COST_CATEGORY_RULE</code>.</p>"""
    credit_status: NotRequired["capo_billing.types.credit_status.CreditStatus"]
    """<p>Whether the credit participates in billing runs. Valid values: <code>ENABLED</code>, <code>DISABLED</code>.</p>"""
    purchase_type_applications: NotRequired[
        "capo_billing.types.purchase_type_applications.PurchaseTypeApplications"
    ]
    """<p>Restricts which purchase types this credit applies to. When <code>null</code> or omitted, the credit applies to all purchase types.</p>"""