PartnerCentralBenefits / Client / recall_benefit_application

recall_benefit_application

PartnerCentralBenefits.Client.recall_benefit_application(**kwargs)

Recalls a submitted benefit application, returning it to draft status for further modifications.

See also: AWS API Documentation

Request Syntax

response = client.recall_benefit_application(
    Catalog='string',
    ClientToken='string',
    Identifier='string',
    Reason='string'
)
Parameters:
  • Catalog (string) –

    [REQUIRED]

    The catalog identifier that specifies which benefit catalog the application belongs to.

  • ClientToken (string) – A unique, case-sensitive identifier to ensure idempotent processing of the recall request.

  • Identifier (string) –

    [REQUIRED]

    The unique identifier of the benefit application to recall.

  • Reason (string) –

    [REQUIRED]

    A descriptive reason explaining why the benefit application is being recalled.

Return type:

dict

Returns:

Response Syntax

{}

Response Structure

  • (dict) –

Exceptions

  • PartnerCentralBenefits.Client.exceptions.ValidationException

  • PartnerCentralBenefits.Client.exceptions.AccessDeniedException

  • PartnerCentralBenefits.Client.exceptions.InternalServerException

  • PartnerCentralBenefits.Client.exceptions.ConflictException

  • PartnerCentralBenefits.Client.exceptions.ThrottlingException

  • PartnerCentralBenefits.Client.exceptions.ResourceNotFoundException