Skip to content

ListBenefitsInput

Source code in docs_src/capo_partnercentral_benefits/types/list_benefits_input.py
class ListBenefitsInput(TypedDict, closed=True):
    catalog: "capo_partnercentral_benefits.types.catalog_name.CatalogName"
    """<p>The catalog identifier to filter benefits by catalog.</p>"""
    programs: NotRequired["capo_partnercentral_benefits.types.programs.Programs"]
    """<p>Filter benefits by specific AWS partner programs.</p>"""
    fulfillment_types: NotRequired[
        "capo_partnercentral_benefits.types.fulfillment_types.FulfillmentTypes"
    ]
    """<p>Filter benefits by specific fulfillment types.</p>"""
    status: NotRequired[
        "capo_partnercentral_benefits.types.benefit_statuses.BenefitStatuses"
    ]
    """<p>Filter benefits by their current status.</p>"""
    max_results: NotRequired["int"]
    """<p>The maximum number of benefits to return in a single response.</p>"""
    next_token: NotRequired["str"]
    """<p>A pagination token to retrieve the next set of results from a previous request.</p>"""

catalog instance-attribute

catalog: CatalogName

The catalog identifier to filter benefits by catalog.

fulfillment_types instance-attribute

fulfillment_types: NotRequired[FulfillmentTypes]

Filter benefits by specific fulfillment types.

max_results instance-attribute

max_results: NotRequired[int]

The maximum number of benefits to return in a single response.

next_token instance-attribute

next_token: NotRequired[str]

A pagination token to retrieve the next set of results from a previous request.

programs instance-attribute

programs: NotRequired[Programs]

Filter benefits by specific AWS partner programs.

status instance-attribute

status: NotRequired[BenefitStatuses]

Filter benefits by their current status.