AgreementService / Paginator / ListAgreementCancellationRequests

ListAgreementCancellationRequests

class AgreementService.Paginator.ListAgreementCancellationRequests

paginator = client.get_paginator('list_agreement_cancellation_requests')

paginate(**kwargs)

Creates an iterator that will paginate through responses from AgreementService.Client.list_agreement_cancellation_requests().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    partyType='string',
    agreementId='string',
    status='PENDING_APPROVAL'|'APPROVED'|'REJECTED'|'CANCELLED'|'VALIDATION_FAILED',
    agreementType='string',
    catalog='string',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': '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.

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

• PaginationConfig (dict) –

  A dictionary that provides parameters to control pagination.

  • MaxItems (integer) –

    The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.

  • PageSize (integer) –

    The size of each page.

  • StartingToken (string) –

    A token to specify where to start paginating. This is the NextToken from a previous response.

Return type:

dict

Returns:

Response Syntax

{
    '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)
        },
    ],
    'NextToken': 'string'
}

Response Structure

• (dict) –

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

      • updatedAt (datetime) –

        The date and time when the cancellation request was last updated.

  • NextToken (string) –

    A token to resume pagination.