agreement_cancellation_requests

Creates, updates, deletes, gets or lists an agreement_cancellation_requests resource.

Overview

Name	agreement_cancellation_requests
Type	Resource
Id	aws.marketplace_agreement.agreement_cancellation_requests

Fields

The following fields are returned by SELECT queries:

get_agreement_cancellation_request

Name	Datatype	Description
agreement_cancellation_request_id	string	The unique identifier of the cancellation request. (pattern: <code>acr-[a-zA-Z0-9]+</code>)
agreement_id	string	The unique identifier of the agreement associated with this cancellation request. Use DescribeAgreement to retrieve full agreement details. (pattern: <code>[A-Za-z0-9_/-]+</code>)
created_at	string (date-time)	The date and time when the cancellation request was created.
description	string	The detailed description of the cancellation reason, if provided.
reason_code	string	The reason code provided for the cancellation. (INCORRECT_TERMS_ACCEPTED, REPLACING_AGREEMENT, TEST_AGREEMENT, ALTERNATIVE_PROCUREMENT_CHANNEL, PRODUCT_DISCONTINUED, UNINTENDED_RENEWAL, BUYER_DISSATISFACTION, OTHER)
status	string	The current status of the cancellation request. (PENDING_APPROVAL, APPROVED, REJECTED, CANCELLED, VALIDATION_FAILED)
status_message	string	A message providing additional context about the cancellation request status.
updated_at	string (date-time)	The date and time when the cancellation request was last updated.

list_agreement_cancellation_requests

Name	Datatype	Description
agreement_cancellation_request_id	string	The unique identifier of the cancellation request. (pattern: <code>acr-[a-zA-Z0-9]+</code>)
agreement_id	string	The unique identifier of the agreement associated with this cancellation request. (pattern: <code>[A-Za-z0-9_/-]+</code>)
agreement_type	string	The type of agreement. (pattern: <code>[A-Za-z]+</code>)
catalog	string	The catalog in which the agreement was created. (pattern: <code>[a-zA-Z0-9.-]+</code>)
created_at	string (date-time)	The date and time when the cancellation request was created.
reason_code	string	The reason code provided for the cancellation. (INCORRECT_TERMS_ACCEPTED, REPLACING_AGREEMENT, TEST_AGREEMENT, ALTERNATIVE_PROCUREMENT_CHANNEL, PRODUCT_DISCONTINUED, UNINTENDED_RENEWAL, BUYER_DISSATISFACTION, OTHER)
status	string	The current status of the cancellation request. Possible values include PENDING_APPROVAL, APPROVED, REJECTED, CANCELLED, and VALIDATION_FAILED. (PENDING_APPROVAL, APPROVED, REJECTED, CANCELLED, VALIDATION_FAILED)
updated_at	string (date-time)	The date and time when the cancellation request was last updated.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_agreement_cancellation_request	select	region		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.
list_agreement_cancellation_requests	select	region		Lists agreement cancellation requests available to you as a seller or buyer. Both sellers (proposers) and buyers (acceptors) can use this operation to find cancellation requests by specifying their party type and applying optional filters. PartyType is a required parameter. A ValidationException is returned if PartyType is not provided.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
region	string	AWS region (default: us-east-1)

SELECT examples

get_agreement_cancellation_request

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.

SELECT
agreement_cancellation_request_id,
agreement_id,
created_at,
description,
reason_code,
status,
status_message,
updated_at
FROM aws.marketplace_agreement.agreement_cancellation_requests
WHERE region = '{{ region }}' -- required
;

list_agreement_cancellation_requests

Lists agreement cancellation requests available to you as a seller or buyer. Both sellers (proposers) and buyers (acceptors) can use this operation to find cancellation requests by specifying their party type and applying optional filters. PartyType is a required parameter. A ValidationException is returned if PartyType is not provided.

SELECT
agreement_cancellation_request_id,
agreement_id,
agreement_type,
catalog,
created_at,
reason_code,
status,
updated_at
FROM aws.marketplace_agreement.agreement_cancellation_requests
WHERE region = '{{ region }}' -- required
;