[ aws . billingconductor ]

list-custom-line-items

Description

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

See ‘aws help’ for descriptions of global parameters.

list-custom-line-items is a paginated operation. Multiple API calls may be issued in order to retrieve the entire data set of results. You can disable pagination by providing the --no-paginate argument. When using --output text and the --query argument on a paginated response, the --query argument must extract data from the results of the following query expressions: CustomLineItems

Synopsis

  list-custom-line-items
[--billing-period <value>]
[--filters <value>]
[--cli-input-json | --cli-input-yaml]
[--starting-token <value>]
[--page-size <value>]
[--max-items <value>]
[--generate-cli-skeleton <value>]

Options

--billing-period (string)

The preferred billing period to get custom line items (FFLIs).

--filters (structure)

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)

Shorthand Syntax:

Names=string,string,BillingGroups=string,string,Arns=string,string

JSON Syntax:

{
  "Names": ["string", ...],
  "BillingGroups": ["string", ...],
  "Arns": ["string", ...]
}

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.

--starting-token (string)

A token to specify where to start paginating. This is the NextToken from a previously truncated response.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

--page-size (integer)

The size of each page to get in the AWS service call. This does not affect the number of items returned in the command’s output. Setting a smaller page size results in more calls to the AWS service, retrieving fewer items in each call. This can help prevent the AWS service calls from timing out.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

--max-items (integer)

The total number of items to return in the command’s output. If the total number of items available is more than the value specified, a NextToken is provided in the command’s output. To resume pagination, provide the NextToken value in the starting-token argument of a subsequent command. Do not use the NextToken response element directly outside of the AWS CLI.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command. The generated JSON skeleton is not stable between versions of the AWS CLI and there are no backwards compatibility guarantees in the JSON skeleton generated.

See ‘aws help’ for descriptions of global parameters.

Output

CustomLineItems -> (list)

A list of FreeFormLineItemListElements received.

(structure)

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 -> (structure)

A ListCustomLineItemChargeDetails that describes the charge details of a custom line item.

Flat -> (structure)

A ListCustomLineItemFlatChargeDetails that describes the charge details of a flat custom line item.

ChargeValue -> (double)

The custom line item’s fixed charge value in USD.

Percentage -> (structure)

A ListCustomLineItemPercentageChargeDetails that describes the charge details of a percentage custom line item.

PercentageValue -> (double)

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 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 -> (long)

The time created.

LastModifiedTime -> (long)

The most recent time the custom line item was modified.

AssociationSize -> (long)

The number of resources that are associated to the custom line item.

NextToken -> (string)

The pagination token used on subsequent calls to get custom line items (FFLIs).