GetBenefitAllocationOutput ¶

class GetBenefitAllocationOutput(TypedDict, closed=True):
    id: NotRequired[
        "capo_partnercentral_benefits.types.benefit_allocation_id.BenefitAllocationId"
    ]
    """<p>The unique identifier of the benefit allocation.</p>"""
    catalog: NotRequired["capo_partnercentral_benefits.types.catalog_name.CatalogName"]
    """<p>The catalog identifier that the benefit allocation belongs to.</p>"""
    arn: NotRequired[
        "capo_partnercentral_benefits.types.benefit_allocation_arn.BenefitAllocationArn"
    ]
    """<p>The Amazon Resource Name (ARN) of the benefit allocation.</p>"""
    name: NotRequired["str"]
    """<p>The human-readable name of the benefit allocation.</p>"""
    description: NotRequired["str"]
    """<p>A detailed description of the benefit allocation.</p>"""
    status: NotRequired[
        "capo_partnercentral_benefits.types.benefit_allocation_status.BenefitAllocationStatus"
    ]
    """<p>The current status of the benefit allocation (e.g., active, expired, consumed).</p>"""
    status_reason: NotRequired["str"]
    """<p>Additional information explaining the current status of the benefit allocation.</p>"""
    benefit_application_id: NotRequired[
        "capo_partnercentral_benefits.types.benefit_application_id.BenefitApplicationId"
    ]
    """<p>The identifier of the benefit application that resulted in this allocation.</p>"""
    benefit_id: NotRequired["capo_partnercentral_benefits.types.benefit_id.BenefitId"]
    """<p>The identifier of the benefit that this allocation is based on.</p>"""
    fulfillment_type: NotRequired[
        "capo_partnercentral_benefits.types.fulfillment_type.FulfillmentType"
    ]
    """<p>The fulfillment type used for this benefit allocation.</p>"""
    applicable_benefit_ids: NotRequired[
        "capo_partnercentral_benefits.types.benefit_identifiers.BenefitIdentifiers"
    ]
    """<p>A list of benefit identifiers that this allocation can be applied to.</p>"""
    fulfillment_detail: NotRequired[
        "capo_partnercentral_benefits.types.fulfillment_details.FulfillmentDetails"
    ]
    """<p>Detailed information about how the benefit allocation is fulfilled.</p>"""
    created_at: NotRequired["capo_partnercentral_benefits.types.timestamp.Timestamp"]
    """<p>The timestamp when the benefit allocation was created.</p>"""
    updated_at: NotRequired["capo_partnercentral_benefits.types.timestamp.Timestamp"]
    """<p>The timestamp when the benefit allocation was last updated.</p>"""
    starts_at: NotRequired["capo_partnercentral_benefits.types.timestamp.Timestamp"]
    """<p>The timestamp when the benefit allocation becomes active and usable.</p>"""
    expires_at: NotRequired["capo_partnercentral_benefits.types.timestamp.Timestamp"]
    """<p>The timestamp when the benefit allocation expires and is no longer usable.</p>"""