AgreementService / Client / cancel_agreement_cancellation_request

cancel_agreement_cancellation_request¶

AgreementService.Client.cancel_agreement_cancellation_request(**kwargs)¶

Allows sellers (proposers) to withdraw an existing agreement cancellation request that is in a pending state. Once cancelled, the cancellation request transitions to CANCELLED status and can no longer be approved or rejected by the buyer.

Note

Only cancellation requests in PENDING_APPROVAL status can be cancelled. A ConflictException is thrown if the cancellation request is in any other status.

Request Syntax

response = client.cancel_agreement_cancellation_request(
    agreementId='string',
    agreementCancellationRequestId='string',
    cancellationReason='string'
)

Parameters:

agreementId (string) –
[REQUIRED]

The unique identifier of the agreement associated with the cancellation request.
agreementCancellationRequestId (string) –
[REQUIRED]

The unique identifier of the cancellation request to cancel.
cancellationReason (string) –
[REQUIRED]

A required message explaining why the cancellation request is being withdrawn (1-2000 characters).

Return type:

dict

Returns:

Response Syntax

{
    'agreementCancellationRequestId': 'string',
    'agreementId': 'string',
    'reasonCode': 'INCORRECT_TERMS_ACCEPTED'|'REPLACING_AGREEMENT'|'TEST_AGREEMENT'|'ALTERNATIVE_PROCUREMENT_CHANNEL'|'PRODUCT_DISCONTINUED'|'UNINTENDED_RENEWAL'|'BUYER_DISSATISFACTION'|'OTHER',
    'description': 'string',
    'status': 'PENDING_APPROVAL'|'APPROVED'|'REJECTED'|'CANCELLED'|'VALIDATION_FAILED',
    'statusMessage': 'string',
    'createdAt': datetime(2015, 1, 1),
    'updatedAt': datetime(2015, 1, 1)
}

Response Structure

(dict) –
- agreementCancellationRequestId (string) –
  
  The unique identifier of the cancelled cancellation request.
- agreementId (string) –
  
  The unique identifier of the agreement associated with this cancellation request.
- reasonCode (string) –
  
  The original reason code provided when the cancellation request was created.
- description (string) –
  
  The detailed description of the original cancellation reason, if provided.
- status (string) –
  
  The updated status of the cancellation request, which is CANCELLED.
- statusMessage (string) –
  
  A message providing additional context about the cancellation request status.
- createdAt (datetime) –
  
  The date and time when the cancellation request was originally created, as a POSIX timestamp (Unix epoch seconds).
- updatedAt (datetime) –
  
  The date and time when the cancellation request was cancelled, as a POSIX timestamp (Unix epoch seconds).

Exceptions

AgreementService.Client.exceptions.ValidationException
AgreementService.Client.exceptions.AccessDeniedException
AgreementService.Client.exceptions.ResourceNotFoundException
AgreementService.Client.exceptions.ThrottlingException
AgreementService.Client.exceptions.InternalServerException
AgreementService.Client.exceptions.ConflictException