PartnerCentralBenefits / Client / list_benefit_allocations

list_benefit_allocations

PartnerCentralBenefits.Client.list_benefit_allocations(**kwargs)

Retrieves a paginated list of benefit allocations based on specified filter criteria.

See also: AWS API Documentation

Request Syntax

response = client.list_benefit_allocations(
    Catalog='string',
    FulfillmentTypes=[
        'CREDITS'|'CASH'|'ACCESS',
    ],
    BenefitIdentifiers=[
        'string',
    ],
    BenefitApplicationIdentifiers=[
        'string',
    ],
    Status=[
        'ACTIVE'|'INACTIVE'|'FULFILLED',
    ],
    MaxResults=123,
    NextToken='string'
)

Parameters:

• Catalog (string) –

  [REQUIRED]

  The catalog identifier to filter benefit allocations by catalog.

• FulfillmentTypes (list) –

  Filter benefit allocations by specific fulfillment types.

  • (string) –

• BenefitIdentifiers (list) –

  Filter benefit allocations by specific benefit identifiers.

  • (string) –

• BenefitApplicationIdentifiers (list) –

  Filter benefit allocations by specific benefit application identifiers.

  • (string) –

• Status (list) –

  Filter benefit allocations by their current status.

  • (string) –

• MaxResults (integer) – The maximum number of benefit allocations to return in a single response.

• NextToken (string) – A pagination token to retrieve the next set of results from a previous request.

Return type:

dict

Returns:

Response Syntax

{
    'BenefitAllocationSummaries': [
        {
            'Id': 'string',
            'Catalog': 'string',
            'Arn': 'string',
            'Status': 'ACTIVE'|'INACTIVE'|'FULFILLED',
            'StatusReason': 'string',
            'Name': 'string',
            'BenefitId': 'string',
            'BenefitApplicationId': 'string',
            'FulfillmentTypes': [
                'CREDITS'|'CASH'|'ACCESS',
            ],
            'CreatedAt': datetime(2015, 1, 1),
            'ExpiresAt': datetime(2015, 1, 1),
            'ApplicableBenefitIds': [
                'string',
            ]
        },
    ],
    'NextToken': 'string'
}

Response Structure

• (dict) –

  • BenefitAllocationSummaries (list) –

    A list of benefit allocation summaries matching the specified criteria.

    • (dict) –

      A summary view of a benefit allocation containing key information for list operations.

      • Id (string) –

        The unique identifier of the benefit allocation.

      • Catalog (string) –

        The catalog identifier that the benefit allocation belongs to.

      • Arn (string) –

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

      • Status (string) –

        The current status of the benefit allocation.

      • StatusReason (string) –

        Additional information explaining the current status of the benefit allocation.

      • Name (string) –

        The human-readable name of the benefit allocation.

      • BenefitId (string) –

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

      • BenefitApplicationId (string) –

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

      • FulfillmentTypes (list) –

        The fulfillment types used for this benefit allocation.

        • (string) –

      • CreatedAt (datetime) –

        The timestamp when the benefit allocation was created.

      • ExpiresAt (datetime) –

        The timestamp when the benefit allocation expires.

      • ApplicableBenefitIds (list) –

        The identifiers of the benefits applicable for this allocation.

        • (string) –

  • NextToken (string) –

    A pagination token to retrieve the next set of results, if more results are available.

Exceptions

• PartnerCentralBenefits.Client.exceptions.AccessDeniedException

• PartnerCentralBenefits.Client.exceptions.ValidationException

• PartnerCentralBenefits.Client.exceptions.InternalServerException

• PartnerCentralBenefits.Client.exceptions.ResourceNotFoundException

• PartnerCentralBenefits.Client.exceptions.ThrottlingException