BillingConductor / Client / list_custom_line_item_versions
list_custom_line_item_versions#
- BillingConductor.Client.list_custom_line_item_versions(**kwargs)#
A paginated call to get a list of all custom line item versions.
See also: AWS API Documentation
Request Syntax
response = client.list_custom_line_item_versions( Arn='string', MaxResults=123, NextToken='string', Filters={ 'BillingPeriodRange': { 'StartBillingPeriod': 'string', 'EndBillingPeriod': 'string' } } )
- Parameters:
Arn (string) –
[REQUIRED]
The Amazon Resource Name (ARN) for the custom line item.
MaxResults (integer) – The maximum number of custom line item versions to retrieve.
NextToken (string) – The pagination token that’s used on subsequent calls to retrieve custom line item versions.
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.
- 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 }, ], 'NextToken': 'string' }
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
orcredit
.
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.
NextToken (string) –
The pagination token that’s used on subsequent calls to retrieve custom line item versions.
Exceptions
BillingConductor.Client.exceptions.ThrottlingException
BillingConductor.Client.exceptions.AccessDeniedException
BillingConductor.Client.exceptions.ValidationException
BillingConductor.Client.exceptions.InternalServerException