ListCustomLineItems
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.
Request Syntax
POST /list-custom-line-items HTTP/1.1
Content-type: application/json
{
"BillingPeriod": "string
",
"Filters": {
"AccountIds": [ "string
" ],
"Arns": [ "string
" ],
"BillingGroups": [ "string
" ],
"Names": [ "string
" ]
},
"MaxResults": number
,
"NextToken": "string
"
}
URI Request Parameters
The request does not use any URI parameters.
Request Body
The request accepts the following data in JSON format.
- BillingPeriod
-
The preferred billing period to get custom line items (FFLIs).
Type: String
Pattern:
\d{4}-(0?[1-9]|1[012])
Required: No
- Filters
-
A
ListCustomLineItemsFilter
that specifies the custom line item names and/or billing group Amazon Resource Names (ARNs) to retrieve FFLI information.Type: ListCustomLineItemsFilter object
Required: No
- MaxResults
-
The maximum number of billing groups to retrieve.
Type: Integer
Valid Range: Minimum value of 1. Maximum value of 100.
Required: No
- NextToken
-
The pagination token that's used on subsequent calls to get custom line items (FFLIs).
Type: String
Required: No
Response Syntax
HTTP/1.1 200
Content-type: application/json
{
"CustomLineItems": [
{
"AccountId": "string",
"Arn": "string",
"AssociationSize": number,
"BillingGroupArn": "string",
"ChargeDetails": {
"Flat": {
"ChargeValue": number
},
"LineItemFilters": [
{
"Attribute": "string",
"MatchOption": "string",
"Values": [ "string" ]
}
],
"Percentage": {
"PercentageValue": number
},
"Type": "string"
},
"CreationTime": number,
"CurrencyCode": "string",
"Description": "string",
"LastModifiedTime": number,
"Name": "string",
"ProductCode": "string"
}
],
"NextToken": "string"
}
Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
- CustomLineItems
-
A list of
FreeFormLineItemListElements
received.Type: Array of CustomLineItemListElement objects
- NextToken
-
The pagination token that's used on subsequent calls to get custom line items (FFLIs).
Type: String
Errors
For information about the errors that are common to all actions, see Common Errors.
- AccessDeniedException
-
You do not have sufficient access to perform this action.
HTTP Status Code: 403
- InternalServerException
-
An unexpected error occurred while processing a request.
HTTP Status Code: 500
- ResourceNotFoundException
-
The request references a resource that doesn't exist.
HTTP Status Code: 404
- ThrottlingException
-
The request was denied due to request throttling.
HTTP Status Code: 429
- ValidationException
-
The input doesn't match with the constraints specified by AWS services.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following: