cancel_benefit_application ¶

cancel_benefit_application(
    catalog: CatalogName,
    client_token: str,
    identifier: BenefitApplicationIdentifier,
    *,
    config_overrides: Optional[PartnerCentralBenefitsClientConfig] = None,
    reason: Optional[str] = None,
) -> CancelBenefitApplicationOutput

Cancels a benefit application that is currently in progress, preventing further processing.

Parameters:

catalog (CatalogName) –

The catalog identifier that specifies which benefit catalog the application belongs to.
client_token (str) –

A unique, case-sensitive identifier to ensure idempotent processing of the cancellation request.
identifier (BenefitApplicationIdentifier) –

The unique identifier of the benefit application to cancel.
reason (Optional[str], default: None ) –

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

Raises:

AccessDeniedException –

Thrown when the caller does not have sufficient permissions to perform the requested operation.
ConflictException –

Thrown when the request conflicts with the current state of the resource, such as attempting to modify a resource that has been changed by another process.
InternalServerException –

Thrown when an unexpected error occurs on the server side during request processing.
ResourceNotFoundException –

Thrown when the requested resource cannot be found or does not exist.
ThrottlingException –

Thrown when the request rate exceeds the allowed limits and the request is being throttled.
ValidationException –

Thrown when the request contains invalid parameters or fails input validation requirements.
UnknownServiceError –

The service returned an error code this client does not model.

Source code in docs_src/capo_partnercentral_benefits/_services/partner_central_benefits.py

def cancel_benefit_application(
    self,
    catalog: "capo_partnercentral_benefits.types.catalog_name.CatalogName",
    client_token: str,
    identifier: "capo_partnercentral_benefits.types.benefit_application_identifier.BenefitApplicationIdentifier",
    *,
    config_overrides: Optional[PartnerCentralBenefitsClientConfig] = None,
    reason: Optional[str] = None,
) -> "capo_partnercentral_benefits.types.cancel_benefit_application_output.CancelBenefitApplicationOutput":
    """<p>Cancels a benefit application that is currently in progress, preventing further processing.</p>

    Args:
        catalog: <p>The catalog identifier that specifies which benefit catalog the application belongs to.</p>
        client_token: <p>A unique, case-sensitive identifier to ensure idempotent processing of the cancellation request.</p>
        identifier: <p>The unique identifier of the benefit application to cancel.</p>
        reason: <p>A descriptive reason explaining why the benefit application is being cancelled.</p>

    Raises:
        capo_partnercentral_benefits.errors.access_denied_exception.AccessDeniedException: <p>Thrown when the caller does not have sufficient permissions to perform the requested operation.</p>
        capo_partnercentral_benefits.errors.conflict_exception.ConflictException: <p>Thrown when the request conflicts with the current state of the resource, such as attempting to modify a resource that has been changed by another process.</p>
        capo_partnercentral_benefits.errors.internal_server_exception.InternalServerException: <p>Thrown when an unexpected error occurs on the server side during request processing.</p>
        capo_partnercentral_benefits.errors.resource_not_found_exception.ResourceNotFoundException: <p>Thrown when the requested resource cannot be found or does not exist.</p>
        capo_partnercentral_benefits.errors.throttling_exception.ThrottlingException: <p>Thrown when the request rate exceeds the allowed limits and the request is being throttled.</p>
        capo_partnercentral_benefits.errors.validation_exception.ValidationException: <p>Thrown when the request contains invalid parameters or fails input validation requirements.</p>
        capo_partnercentral_benefits.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_partnercentral_benefits.types.cancel_benefit_application_input.CancelBenefitApplicationInput]",
    ) -> OperationResponse[
        "capo_partnercentral_benefits.types.cancel_benefit_application_output.CancelBenefitApplicationOutput"
    ]:
        import capo_partnercentral_benefits._operations.partner_central_benefits_service.cancel_benefit_application

        output, http_response = (
            capo_partnercentral_benefits._operations.partner_central_benefits_service.cancel_benefit_application.cancel_benefit_application(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("CancelBenefitApplication")
    )
    input_: capo_partnercentral_benefits.types.cancel_benefit_application_input.CancelBenefitApplicationInput = {
        "catalog": catalog,
        "client_token": client_token,
        "identifier": identifier,
    }
    if reason is not None:
        input_["reason"] = reason

    response = execute_pipeline(
        OperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    response.response.close()
    return response.output