Skip to content

CreateBenefitApplicationInput

Source code in docs_src/capo_partnercentral_benefits/types/create_benefit_application_input.py
class CreateBenefitApplicationInput(TypedDict, closed=True):
    catalog: "capo_partnercentral_benefits.types.catalog_name.CatalogName"
    """<p>The catalog identifier that specifies which benefit catalog to create the application in.</p>"""
    client_token: "str"
    """<p>A unique, case-sensitive identifier to ensure idempotent processing of the creation request.</p>"""
    name: NotRequired[
        "capo_partnercentral_benefits.types.benefit_application_name.BenefitApplicationName"
    ]
    """<p>A human-readable name for the benefit application.</p>"""
    description: NotRequired[
        "capo_partnercentral_benefits.types.benefit_application_description.BenefitApplicationDescription"
    ]
    """<p>A detailed description of the benefit application and its intended use.</p>"""
    benefit_identifier: "str"
    """<p>The unique identifier of the benefit being requested in this application.</p>"""
    fulfillment_types: NotRequired[
        "capo_partnercentral_benefits.types.fulfillment_types.FulfillmentTypes"
    ]
    """<p>The types of fulfillment requested for this benefit application (e.g., credits, access, disbursement).</p>"""
    benefit_application_details: NotRequired["object"]
    """<p>Detailed information and requirements specific to the benefit being requested.</p>"""
    tags: NotRequired["capo_partnercentral_benefits.types.tags.Tags"]
    """<p>Key-value pairs to categorize and organize the benefit application.</p>"""
    associated_resources: NotRequired["capo_partnercentral_benefits.types.arns.Arns"]
    """<p>AWS resources that are associated with this benefit application.</p>"""
    partner_contacts: NotRequired[
        "capo_partnercentral_benefits.types.contacts.Contacts"
    ]
    """<p>Contact information for partner representatives responsible for this benefit application.</p>"""
    file_details: NotRequired[
        "capo_partnercentral_benefits.types.file_input_details.FileInputDetails"
    ]
    """<p>Supporting documents and files attached to the benefit application.</p>"""

associated_resources instance-attribute

associated_resources: NotRequired[Arns]

AWS resources that are associated with this benefit application.

benefit_application_details instance-attribute

benefit_application_details: NotRequired[object]

Detailed information and requirements specific to the benefit being requested.

benefit_identifier instance-attribute

benefit_identifier: str

The unique identifier of the benefit being requested in this application.

catalog instance-attribute

catalog: CatalogName

The catalog identifier that specifies which benefit catalog to create the application in.

client_token instance-attribute

client_token: str

A unique, case-sensitive identifier to ensure idempotent processing of the creation request.

description instance-attribute

description: NotRequired[BenefitApplicationDescription]

A detailed description of the benefit application and its intended use.

file_details instance-attribute

file_details: NotRequired[FileInputDetails]

Supporting documents and files attached to the benefit application.

fulfillment_types instance-attribute

fulfillment_types: NotRequired[FulfillmentTypes]

The types of fulfillment requested for this benefit application (e.g., credits, access, disbursement).

name instance-attribute

name: NotRequired[BenefitApplicationName]

A human-readable name for the benefit application.

partner_contacts instance-attribute

partner_contacts: NotRequired[Contacts]

Contact information for partner representatives responsible for this benefit application.

tags instance-attribute

tags: NotRequired[Tags]

Key-value pairs to categorize and organize the benefit application.