ListCustomLineItemVersions¶

class BillingConductor.Paginator.ListCustomLineItemVersions¶

paginator = client.get_paginator('list_custom_line_item_versions')

paginate(**kwargs)¶

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

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    Arn='string',
    Filters={
        'BillingPeriodRange': {
            'StartBillingPeriod': 'string',
            'EndBillingPeriod': 'string'
        }
    },
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters

Arn (string) --
[REQUIRED]

The Amazon Resource Name (ARN) for the custom line item.
Filters (dict) --
A ListCustomLineItemVersionsFilter that specifies the billing period range in which the custom line item versions are applied.
- BillingPeriodRange (dict) --
  The billing period range in which the custom line item version is applied.
  - StartBillingPeriod (string) --
    The inclusive start billing period that defines a billing period range where a custom line item version is applied.
  - EndBillingPeriod (string) --
    The exclusive end billing period that defines a billing period range where a custom line item version is applied.
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

{
    'CustomLineItemVersions': [
        {
            '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,
            'StartBillingPeriod': 'string',
            'EndBillingPeriod': 'string',
            'Arn': 'string',
            'StartTime': 123
        },
    ],

}

Response Structure

(dict) --
- CustomLineItemVersions (list) --
  
  A list of CustomLineItemVersionListElements that are received.
  - (dict) --
    
    A representation of a custom line item version.
    - Name (string) --
      
      The name of the custom line item.
    - ChargeDetails (dict) --
      
      A representation of 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 charge value currency of the custom line item.
    - Description (string) --
      
      The description of the custom line item.
    - ProductCode (string) --
      
      The product code that’s associated with the custom line item.
    - BillingGroupArn (string) --
      
      The Amazon Resource Name (ARN) of the billing group that the custom line item applies to.
    - CreationTime (integer) --
      
      The time when the custom line item version was created.
    - LastModifiedTime (integer) --
      
      The most recent time that the custom line item version was modified.
    - AssociationSize (integer) --
      
      The number of resources that are associated with the custom line item.
    - StartBillingPeriod (string) --
      
      The start billing period of the custom line item version.
    - EndBillingPeriod (string) --
      
      The end billing period of the custom line item version.
    - Arn (string) --
      
      A list of custom line item Amazon Resource Names (ARNs) to retrieve information.
    - StartTime (integer) --
      
      The inclusive start time.

Table Of Contents

ListCustomLineItemVersions¶