ListCustomLineItems¶

class BillingConductor.Paginator.ListCustomLineItems¶

paginator = client.get_paginator('list_custom_line_items')

paginate(**kwargs)¶

Creates an iterator that will paginate through responses from BillingConductor.Client.list_custom_line_items().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    BillingPeriod='string',
    Filters={
        'Names': [
            'string',
        ],
        'BillingGroups': [
            'string',
        ],
        'Arns': [
            'string',
        ]
    },
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters

BillingPeriod (string) -- The preferred billing period to get custom line items (FFLIs).
Filters (dict) --
A ListCustomLineItemsFilter that specifies the custom line item names and/or billing group Amazon Resource Names (ARNs) to retrieve FFLI information.
- Names (list) --
  A list of custom line items to retrieve information.
  - (string) --
- BillingGroups (list) --
  The billing group Amazon Resource Names (ARNs) to retrieve information.
  - (string) --
- Arns (list) --
  A list of custom line item ARNs to retrieve information.
  - (string) --
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

{
    'CustomLineItems': [
        {
            'Arn': 'string',
            'Name': 'string',
            'ChargeDetails': {
                'Flat': {
                    'ChargeValue': 123.0
                },
                'Percentage': {
                    'PercentageValue': 123.0
                },
                'Type': 'CREDIT'|'FEE'
            },
            'CurrencyCode': 'USD'|'CNY',
            'Description': 'string',
            'ProductCode': 'string',
            'BillingGroupArn': 'string',
            'CreationTime': 123,
            'LastModifiedTime': 123,
            'AssociationSize': 123
        },
    ],

}

Response Structure

(dict) --
- CustomLineItems (list) --
  
  A list of FreeFormLineItemListElements received.
  - (dict) --
    
    A representation of a custom line item.
    - Arn (string) --
      
      The Amazon Resource Names (ARNs) for custom line items.
    - Name (string) --
      
      The custom line item's name.
    - ChargeDetails (dict) --
      
      A ListCustomLineItemChargeDetails that describes the charge details of a custom line item.
      - Flat (dict) --
        
        A ListCustomLineItemFlatChargeDetails that describes the charge details of a flat custom line item.
        
        ChargeValue (float) --
        
        The custom line item's fixed charge value in USD.
      - Percentage (dict) --
        
        A ListCustomLineItemPercentageChargeDetails that describes the charge details of a percentage custom line item.
        
        PercentageValue (float) --
        
        The custom line item's percentage value. This will be multiplied against the combined value of its associated resources to determine its charge value.
      - Type (string) --
        
        The type of the custom line item that indicates whether the charge is a fee or credit .
    - CurrencyCode (string) --
      
      The custom line item's charge value currency. Only one of the valid values can be used.
    - Description (string) --
      
      The custom line item's description. This is shown on the Bills page in association with the charge value.
    - ProductCode (string) --
      
      The product code that's associated with the custom line item.
    - BillingGroupArn (string) --
      
      The Amazon Resource Name (ARN) that references the billing group where the custom line item applies to.
    - CreationTime (integer) --
      
      The time created.
    - LastModifiedTime (integer) --
      
      The most recent time when the custom line item was modified.
    - AssociationSize (integer) --
      
      The number of resources that are associated to the custom line item.

Table Of Contents

ListCustomLineItems¶