AgreementService / Client / list_agreement_cancellation_requests

list_agreement_cancellation_requests

AgreementService.Client.list_agreement_cancellation_requests(**kwargs)

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.

Note

PartyType is a required parameter. A ValidationException is returned if PartyType is not provided. Pagination is supported through maxResults (1-50, default 20) and nextToken parameters.

See also: AWS API Documentation

Request Syntax

response = client.list_agreement_cancellation_requests(
    partyType='string',
    agreementId='string',
    status='PENDING_APPROVAL'|'APPROVED'|'REJECTED'|'CANCELLED'|'VALIDATION_FAILED',
    agreementType='string',
    catalog='string',
    maxResults=123,
    nextToken='string'
)

Parameters:

• partyType (string) –

  [REQUIRED]

  The party type for the cancellation requests. Required parameter. Use Proposer to list cancellation requests where you are the seller, or Acceptor to list cancellation requests where you are the buyer.

• agreementId (string) – An optional parameter to filter cancellation requests for a specific agreement.

• status (string) – An optional parameter to filter cancellation requests by status. Valid values include PENDING_APPROVAL, APPROVED, REJECTED, CANCELLED, and VALIDATION_FAILED.

• agreementType (string) – An optional parameter to filter cancellation requests by agreement type (e.g., PurchaseAgreement).

• catalog (string) – An optional parameter to filter cancellation requests by catalog (e.g., AWSMarketplace).

• maxResults (integer) – The maximum number of cancellation requests to return in the response.

• nextToken (string) – A token to specify where to start pagination. Use the nextToken value from a previous response to retrieve the next page of results.

Return type:

dict

Returns:

Response Syntax

{
    'nextToken': 'string',
    'items': [
        {
            'agreementCancellationRequestId': 'string',
            'agreementId': 'string',
            'status': 'PENDING_APPROVAL'|'APPROVED'|'REJECTED'|'CANCELLED'|'VALIDATION_FAILED',
            'reasonCode': 'INCORRECT_TERMS_ACCEPTED'|'REPLACING_AGREEMENT'|'TEST_AGREEMENT'|'ALTERNATIVE_PROCUREMENT_CHANNEL'|'PRODUCT_DISCONTINUED'|'UNINTENDED_RENEWAL'|'BUYER_DISSATISFACTION'|'OTHER',
            'agreementType': 'string',
            'catalog': 'string',
            'createdAt': datetime(2015, 1, 1),
            'updatedAt': datetime(2015, 1, 1)
        },
    ]
}

Response Structure

• (dict) –

  • nextToken (string) –

    A token to retrieve the next page of results. If null, there are no more results to retrieve.

  • items (list) –

    An array of AgreementCancellationRequestSummary objects containing summary information about each cancellation request.

    • (dict) –

      Summary view of an agreement cancellation request.

      • agreementCancellationRequestId (string) –

        The unique identifier of the cancellation request.

      • agreementId (string) –

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

      • status (string) –

        The current status of the cancellation request. Possible values include PENDING_APPROVAL, APPROVED, REJECTED, CANCELLED, and VALIDATION_FAILED.

      • reasonCode (string) –

        The reason code provided for the cancellation.

      • agreementType (string) –

        The type of agreement.

      • catalog (string) –

        The catalog in which the agreement was created.

      • 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.ThrottlingException

• AgreementService.Client.exceptions.InternalServerException