[ aws . billingconductor ]

update-custom-line-item

Description

Update an existing custom line item in the current or previous billing period.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

  update-custom-line-item
--arn <value>
[--name <value>]
[--description <value>]
[--charge-details <value>]
[--billing-period-range <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]

Options

--arn (string)

The ARN of the custom line item to be updated.

--name (string)

The new name for the custom line item.

--description (string)

The new line item description of the custom line item.

--charge-details (structure)

A ListCustomLineItemChargeDetails containing the new charge details for the custom line item.

Flat -> (structure)

An UpdateCustomLineItemFlatChargeDetails that describes the new charge details of a flat custom line item.

ChargeValue -> (double)

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

Percentage -> (structure)

An UpdateCustomLineItemPercentageChargeDetails that describes the new charge details of a percentage custom line item.

PercentageValue -> (double)

The custom line item’s new percentage value. This will be multiplied against the combined value of its associated resources to determine its charge value.

Shorthand Syntax:

Flat={ChargeValue=double},Percentage={PercentageValue=double}

JSON Syntax:

{
  "Flat": {
    "ChargeValue": double
  },
  "Percentage": {
    "PercentageValue": double
  }
}

--billing-period-range (structure)

The billing period range in which the custom line item request will be applied.

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"
}

--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.

--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.

See ‘aws help’ for descriptions of global parameters.

Output

Arn -> (string)

The ARN of the successfully updated custom line item.

BillingGroupArn -> (string)

The ARN of the billing group that the custom line item is applied to.

Name -> (string)

The name of the successfully updated custom line item.

Description -> (string)

The description of the successfully updated custom line item.

ChargeDetails -> (structure)

A ListCustomLineItemChargeDetails containing the charge details of the successfully updated 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 .

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.