AgreementService / Paginator / ListAgreementCharges

ListAgreementCharges¶

class AgreementService.Paginator.ListAgreementCharges¶

paginator = client.get_paginator('list_agreement_charges')

paginate(**kwargs)¶

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

Request Syntax

response_iterator = paginator.paginate(
    catalog='string',
    agreementId='string',
    agreementType='string',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters:

catalog (string) – The catalog in which the charges were created.
agreementId (string) – The unique identifier of the agreement.
agreementType (string) – Filter to retrieve charges of a specific agreement type (for example, PurchaseAgreement).
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': [
        {
            'id': 'string',
            'revision': 123,
            'agreementId': 'string',
            'agreementType': 'string',
            'purchaseOrderReference': 'string',
            'currencyCode': 'string',
            'amount': 'string',
            'time': datetime(2015, 1, 1)
        },
    ],
    'NextToken': 'string'
}

Response Structure

(dict) –
- items (list) –
  
  A list of agreement charges.
  - (dict) –
    
    Represents a charge associated with an agreement, including amount, timing, and purchase order details.
    - id (string) –
      
      The unique identifier of the charge.
    - revision (integer) –
      
      The revision number of the charge.
    - agreementId (string) –
      
      The unique identifier of the agreement that resulted in this charge.
    - agreementType (string) –
      
      The type of agreement that resulted in this charge (for example, PurchaseAgreement).
    - purchaseOrderReference (string) –
      
      The purchase order reference associated with the charge, if any.
    - currencyCode (string) –
      
      The currency code for the charge amount.
    - amount (string) –
      
      The amount of the charge.
    - time (datetime) –
      
      The date and time when the charge will be incurred. This is available only when the charge date is known.
- NextToken (string) –
  
  A token to resume pagination.