Note: You are viewing the documentation for an older major version of the AWS CLI (version 1).

AWS CLI version 2, the latest major version of AWS CLI, is now stable and recommended for general use. To view this page for the AWS CLI version 2, click here. For more information see the AWS CLI version 2 installation instructions and migration guide.

[ aws . billingconductor ]

create-custom-line-item

Description

Creates a custom line item that can be used to create a one-time fixed charge that can be applied to a single billing group for the current or previous billing period. The one-time fixed charge is either a fee or discount.

See also: AWS API Documentation

See 'aws help' for descriptions of global parameters.

Synopsis

  create-custom-line-item
[--client-token <value>]
--name <value>
--description <value>
--billing-group-arn <value>
[--billing-period-range <value>]
[--tags <value>]
--charge-details <value>
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]

Options

--client-token (string)

The token that is needed to support idempotency. Idempotency isn't currently supported, but will be implemented in a future update.

--name (string)

The name of the custom line item.

--description (string)

The description of the custom line item. This is shown on the Bills page in association with the charge value.

--billing-group-arn (string)

The Amazon Resource Name (ARN) that references the billing group where the custom line item applies to.

--billing-period-range (structure)

A time range for which the custom line item is effective.

InclusiveStartBillingPeriod -> (string)

The inclusive start billing period that defines a billing period range where a custom line is applied.

ExclusiveEndBillingPeriod -> (string)

The inclusive end billing period that defines a billing period range where a custom line is applied.

Shorthand Syntax:

InclusiveStartBillingPeriod=string,ExclusiveEndBillingPeriod=string

JSON Syntax:

{
  "InclusiveStartBillingPeriod": "string",
  "ExclusiveEndBillingPeriod": "string"
}

--tags (map)

A map that contains tag keys and tag values that are attached to a custom line item.

key -> (string)

value -> (string)

Shorthand Syntax:

KeyName1=string,KeyName2=string

JSON Syntax:

{"string": "string"
  ...}

--charge-details (structure)

A CustomLineItemChargeDetails that describes the charge details for a custom line item.

Flat -> (structure)

A CustomLineItemFlatChargeDetails 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 CustomLineItemPercentageChargeDetails 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.

AssociatedValues -> (list)

A list of resource ARNs to associate to the percentage custom line item.

(string)

Type -> (string)

The type of the custom line item that indicates whether the charge is a fee or credit.

Shorthand Syntax:

Flat={ChargeValue=double},Percentage={PercentageValue=double,AssociatedValues=[string,string]},Type=string

JSON Syntax:

{
  "Flat": {
    "ChargeValue": double
  },
  "Percentage": {
    "PercentageValue": double,
    "AssociatedValues": ["string", ...]
  },
  "Type": "CREDIT"|"FEE"
}

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI 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.

--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. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

See 'aws help' for descriptions of global parameters.

Output

Arn -> (string)

The Amazon Resource Name (ARN) of the created custom line item.