cancelBenefitApplication method

Future<void> cancelBenefitApplication({
  1. required String catalog,
  2. required String clientToken,
  3. required String identifier,
  4. String? reason,
})

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

May throw AccessDeniedException. May throw ConflictException. May throw InternalServerException. May throw ResourceNotFoundException. May throw ThrottlingException. May throw ValidationException.

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

Parameter clientToken : A unique, case-sensitive identifier to ensure idempotent processing of the cancellation request.

Parameter identifier : The unique identifier of the benefit application to cancel.

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

Implementation

Future<void> cancelBenefitApplication({
  required String catalog,
  required String clientToken,
  required String identifier,
  String? reason,
}) async {
  final headers = <String, String>{
    'Content-Type': 'application/x-amz-json-1.0',
    'X-Amz-Target': 'PartnerCentralBenefitsService.CancelBenefitApplication'
  };
  await _protocol.send(
    method: 'POST',
    requestUri: '/',
    exceptionFnMap: _exceptionFns,
    // TODO queryParams
    headers: headers,
    payload: {
      'Catalog': catalog,
      'ClientToken': clientToken,
      'Identifier': identifier,
      if (reason != null) 'Reason': reason,
    },
  );
}