AgreementService / Paginator / ListBillingAdjustmentRequests

ListBillingAdjustmentRequests

class AgreementService.Paginator.ListBillingAdjustmentRequests

paginator = client.get_paginator('list_billing_adjustment_requests')

paginate(**kwargs)

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

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    agreementId='string',
    status='PENDING'|'VALIDATION_FAILED'|'COMPLETED',
    createdAfter=datetime(2015, 1, 1),
    createdBefore=datetime(2015, 1, 1),
    catalog='string',
    agreementType='string',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters:

• agreementId (string) – The unique identifier of the agreement to list billing adjustment requests for.

• status (string) – An optional filter to return billing adjustment requests with the specified status.

• createdAfter (datetime) – An optional filter to return billing adjustment requests created after the specified POSIX timestamp (Unix epoch seconds).

• createdBefore (datetime) – An optional filter to return billing adjustment requests created before the specified POSIX timestamp (Unix epoch seconds).

• catalog (string) – An optional filter to return billing adjustment requests by catalog (e.g., AWSMarketplace).

• agreementType (string) – An optional filter to return billing adjustment requests by agreement type (e.g., 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': [
        {
            'billingAdjustmentRequestId': 'string',
            'originalInvoiceId': 'string',
            'adjustmentAmount': 'string',
            'currencyCode': 'string',
            'status': 'PENDING'|'VALIDATION_FAILED'|'COMPLETED',
            'agreementId': 'string',
            'createdAt': datetime(2015, 1, 1),
            'updatedAt': datetime(2015, 1, 1),
            'agreementType': 'string',
            'catalog': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

• (dict) –

  • items (list) –

    An array of BillingAdjustmentSummary objects containing summary information about each billing adjustment request.

    • (dict) –

      Summary view of a billing adjustment request.

      • billingAdjustmentRequestId (string) –

        The unique identifier of the billing adjustment request.

      • originalInvoiceId (string) –

        The identifier of the original invoice being adjusted.

      • adjustmentAmount (string) –

        The adjustment amount as a string representation of a decimal number.

      • currencyCode (string) –

        The currency code for the adjustment amount.

      • status (string) –

        The current status of the billing adjustment request.

      • agreementId (string) –

        The unique identifier of the agreement associated with this billing adjustment request.

      • createdAt (datetime) –

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

      • updatedAt (datetime) –

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

      • agreementType (string) –

        The type of agreement.

      • catalog (string) –

        The catalog in which the agreement was created.

  • NextToken (string) –

    A token to resume pagination.