Request Syntax Request Parameters Response Syntax Response Elements Errors Examples See Also

GetAgreementCancellationRequest

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.

Request Syntax


{
   "agreementCancellationRequestId": "string",
   "agreementId": "string"
}

Request Parameters

The request accepts the following data in JSON format.

Note

In the following list, the required parameters are described first.

agreementCancellationRequestId

The unique identifier of the cancellation request.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 64.

Pattern: acr-[a-zA-Z0-9]+

Required: Yes

agreementId

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

Type: String

Length Constraints: Minimum length of 1. Maximum length of 64.

Pattern: [A-Za-z0-9_/-]+

Required: Yes

Response Syntax


{
   "agreementCancellationRequestId": "string",
   "agreementId": "string",
   "createdAt": number,
   "description": "string",
   "reasonCode": "string",
   "status": "string",
   "statusMessage": "string",
   "updatedAt": number
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

agreementCancellationRequestId

The unique identifier of the cancellation request.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 64.

Pattern: acr-[a-zA-Z0-9]+

agreementId

The unique identifier of the agreement associated with this cancellation request. Use DescribeAgreement to retrieve full agreement details.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 64.

Pattern: [A-Za-z0-9_/-]+

createdAt

The date and time when the cancellation request was created, as a POSIX timestamp (Unix epoch seconds).

Type: Timestamp

description

The detailed description of the cancellation reason, if provided.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 2000.

Pattern: .+

reasonCode

The reason code provided for the cancellation.

Type: String

status

The current status of the cancellation request.

Type: String

Valid Values: PENDING_APPROVAL | APPROVED | REJECTED | CANCELLED | VALIDATION_FAILED

statusMessage

A message providing additional context about the cancellation request status.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 2000.

updatedAt

The date and time when the cancellation request was last updated, as a POSIX timestamp (Unix epoch seconds).

Type: Timestamp

Errors

For information about the errors that are common to all actions, see Common Error Types.

AccessDeniedException

User does not have sufficient access to perform this action.

requestId: The unique identifier for the error.

HTTP Status Code: 400

InternalServerException

Unexpected error during processing of request.

requestId: The unique identifier for the error.

HTTP Status Code: 500

ResourceNotFoundException

Request references a resource which does not exist.

requestId: The unique identifier for the error.
resourceId: The unique identifier for the resource.
resourceType: The type of resource.

HTTP Status Code: 400

ThrottlingException

Request was denied due to request throttling.

requestId: The unique identifier for the error.

HTTP Status Code: 400

ValidationException

The input fails to satisfy the constraints specified by the service.

fields: The fields associated with the error.
reason: The reason associated with the error.
requestId: The unique identifier associated with the error.

HTTP Status Code: 400

Examples

Sample request

This example illustrates one usage of GetAgreementCancellationRequest.


{
    "agreementId": "agmt-EXAMPLE752jqvg74yo7k",
    "agreementCancellationRequestId": "acr-EXAMPLEsgew33rhsds"
}

Sample response

This example illustrates one usage of GetAgreementCancellationRequest.


{
    "agreementCancellationRequestId": "acr-EXAMPLEsgew33rhsds",
    "agreementId": "agmt-EXAMPLE752jqvg74yo7k",
    "reasonCode": "PRODUCT_DISCONTINUED",
    "description": "Product is being discontinued and no longer supported",
    "status": "VALIDATION_FAILED",
    "statusMessage": "Agreement is not in an active state",
    "createdAt": 1736935800,
    "updatedAt": 1737022200
}