AgreementService / Client / get_agreement_cancellation_request

get_agreement_cancellation_request¶

AgreementService.Client.get_agreement_cancellation_request(**kwargs)¶

Retrieves detailed information about a specific agreement cancellation request. Both sellers (proposers) and buyers (acceptors) can use this operation to view cancellation requests associated with their agreements.

Note

The calling identity must be either the acceptor or proposer of the agreement. A ResourceNotFoundException is returned if the cancellation request does not exist.

Request Syntax

response = client.get_agreement_cancellation_request(
    agreementCancellationRequestId='string',
    agreementId='string'
)

Parameters:

agreementCancellationRequestId (string) –
[REQUIRED]

The unique identifier of the cancellation request.
agreementId (string) –
[REQUIRED]

The unique identifier of the agreement associated with the cancellation request.

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 cancellation request.
- agreementId (string) –
  
  The unique identifier of the agreement associated with this cancellation request. Use DescribeAgreement to retrieve full agreement details.
- reasonCode (string) –
  
  The reason code provided for the cancellation.
- description (string) –
  
  The detailed description of the cancellation reason, if provided.
- status (string) –
  
  The current status of the cancellation request. Possible values include PENDING_APPROVAL, APPROVED, REJECTED, CANCELLED, and VALIDATION_FAILED.
- statusMessage (string) –
  
  A message providing additional context about the cancellation request status.
- createdAt (datetime) –
  
  The date and time when the cancellation request was created, as a POSIX timestamp (Unix epoch seconds).
- updatedAt (datetime) –
  
  The date and time when the cancellation request was last updated, 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