Skip to content

BenefitAllocationSummary

Source code in docs_src/capo_partnercentral_benefits/types/benefit_allocation_summary.py
class BenefitAllocationSummary(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["str"]
    """<p>The Amazon Resource Name (ARN) of the benefit allocation.</p>"""
    status: NotRequired[
        "capo_partnercentral_benefits.types.benefit_allocation_status.BenefitAllocationStatus"
    ]
    """<p>The current status of the benefit allocation.</p>"""
    status_reason: NotRequired["str"]
    """<p>Additional information explaining the current status of the benefit allocation.</p>"""
    name: NotRequired[
        "capo_partnercentral_benefits.types.benefit_allocation_name.BenefitAllocationName"
    ]
    """<p>The human-readable name of the benefit 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>"""
    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>"""
    fulfillment_types: NotRequired[
        "capo_partnercentral_benefits.types.fulfillment_types.FulfillmentTypes"
    ]
    """<p>The fulfillment types used for this benefit allocation.</p>"""
    created_at: NotRequired["capo_partnercentral_benefits.types.timestamp.Timestamp"]
    """<p>The timestamp when the benefit allocation was created.</p>"""
    expires_at: NotRequired["capo_partnercentral_benefits.types.timestamp.Timestamp"]
    """<p>The timestamp when the benefit allocation expires.</p>"""
    applicable_benefit_ids: NotRequired[
        "capo_partnercentral_benefits.types.benefit_ids.BenefitIds"
    ]
    """<p>The identifiers of the benefits applicable for this allocation.</p>"""

applicable_benefit_ids instance-attribute

applicable_benefit_ids: NotRequired[BenefitIds]

The identifiers of the benefits applicable for this allocation.

arn instance-attribute

arn: NotRequired[str]

The Amazon Resource Name (ARN) of the benefit allocation.

benefit_application_id instance-attribute

benefit_application_id: NotRequired[BenefitApplicationId]

The identifier of the benefit application that resulted in this allocation.

benefit_id instance-attribute

benefit_id: NotRequired[BenefitId]

The identifier of the benefit that this allocation is based on.

catalog instance-attribute

catalog: NotRequired[CatalogName]

The catalog identifier that the benefit allocation belongs to.

created_at instance-attribute

created_at: NotRequired[Timestamp]

The timestamp when the benefit allocation was created.

expires_at instance-attribute

expires_at: NotRequired[Timestamp]

The timestamp when the benefit allocation expires.

fulfillment_types instance-attribute

fulfillment_types: NotRequired[FulfillmentTypes]

The fulfillment types used for this benefit allocation.

id instance-attribute

id: NotRequired[BenefitAllocationId]

The unique identifier of the benefit allocation.

name instance-attribute

name: NotRequired[BenefitAllocationName]

The human-readable name of the benefit allocation.

status instance-attribute

status: NotRequired[BenefitAllocationStatus]

The current status of the benefit allocation.

status_reason instance-attribute

status_reason: NotRequired[str]

Additional information explaining the current status of the benefit allocation.