BillingConductor / Client / list_custom_line_items
list_custom_line_items#
- BillingConductor.Client.list_custom_line_items(**kwargs)#
A paginated call to get a list of all custom line items (FFLIs) for the given billing period. If you don’t provide a billing period, the current billing period is used.
See also: AWS API Documentation
Request Syntax
response = client.list_custom_line_items( BillingPeriod='string', MaxResults=123, NextToken='string', Filters={ 'Names': [ 'string', ], 'BillingGroups': [ 'string', ], 'Arns': [ 'string', ] } )
- Parameters:
BillingPeriod (string) – The preferred billing period to get custom line items (FFLIs).
MaxResults (integer) – The maximum number of billing groups to retrieve.
NextToken (string) – The pagination token that’s used on subsequent calls 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) –
- 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 }, ], 'NextToken': 'string' }
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
orcredit
.
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.
NextToken (string) –
The pagination token that’s used on subsequent calls to get custom line items (FFLIs).
Exceptions
BillingConductor.Client.exceptions.ThrottlingException
BillingConductor.Client.exceptions.AccessDeniedException
BillingConductor.Client.exceptions.ValidationException
BillingConductor.Client.exceptions.InternalServerException
BillingConductor.Client.exceptions.ResourceNotFoundException