Skip to content

GetBenefitOutput

Source code in docs_src/capo_partnercentral_benefits/types/get_benefit_output.py
class GetBenefitOutput(TypedDict, closed=True):
    id: NotRequired["str"]
    """<p>The unique identifier of the benefit.</p>"""
    catalog: NotRequired["capo_partnercentral_benefits.types.catalog_name.CatalogName"]
    """<p>The catalog identifier that the benefit belongs to.</p>"""
    arn: NotRequired["str"]
    """<p>The Amazon Resource Name (ARN) of the benefit.</p>"""
    name: NotRequired["str"]
    """<p>The human-readable name of the benefit.</p>"""
    description: NotRequired["str"]
    """<p>A detailed description of the benefit and its purpose.</p>"""
    programs: NotRequired["capo_partnercentral_benefits.types.programs.Programs"]
    """<p>The AWS partner programs that this benefit is associated with.</p>"""
    fulfillment_types: NotRequired[
        "capo_partnercentral_benefits.types.fulfillment_types.FulfillmentTypes"
    ]
    """<p>The available fulfillment types for this benefit (e.g., credits, access, disbursement).</p>"""
    benefit_request_schema: NotRequired["object"]
    """<p>The schema definition that describes the required fields for requesting this benefit.</p>"""
    status: NotRequired[
        "capo_partnercentral_benefits.types.benefit_status.BenefitStatus"
    ]
    """<p>The current status of the benefit (e.g., active, inactive, deprecated).</p>"""

arn instance-attribute

arn: NotRequired[str]

The Amazon Resource Name (ARN) of the benefit.

benefit_request_schema instance-attribute

benefit_request_schema: NotRequired[object]

The schema definition that describes the required fields for requesting this benefit.

catalog instance-attribute

catalog: NotRequired[CatalogName]

The catalog identifier that the benefit belongs to.

description instance-attribute

description: NotRequired[str]

A detailed description of the benefit and its purpose.

fulfillment_types instance-attribute

fulfillment_types: NotRequired[FulfillmentTypes]

The available fulfillment types for this benefit (e.g., credits, access, disbursement).

id instance-attribute

id: NotRequired[str]

The unique identifier of the benefit.

name instance-attribute

name: NotRequired[str]

The human-readable name of the benefit.

programs instance-attribute

programs: NotRequired[Programs]

The AWS partner programs that this benefit is associated with.

status instance-attribute

status: NotRequired[BenefitStatus]

The current status of the benefit (e.g., active, inactive, deprecated).