UpdateCustomLineItem
Update an existing custom line item in the current or previous billing period.
Request Syntax
POST /update-custom-line-item HTTP/1.1
Content-type: application/json
{
"Arn": "string",
"BillingPeriodRange": {
"ExclusiveEndBillingPeriod": "string",
"InclusiveStartBillingPeriod": "string"
},
"ChargeDetails": {
"Flat": {
"ChargeValue": number
},
"LineItemFilters": [
{
"Attribute": "string",
"MatchOption": "string",
"Values": [ "string" ]
}
],
"Percentage": {
"PercentageValue": number
}
},
"Description": "string",
"Name": "string"
}URI Request Parameters
The request does not use any URI parameters.
Request Body
The request accepts the following data in JSON format.
- Arn
-
The ARN of the custom line item to be updated.
Type: String
Pattern:
(arn:aws(-cn)?:billingconductor::[0-9]{12}:customlineitem/)?[a-zA-Z0-9]{10}Required: Yes
- BillingPeriodRange
-
The billing period range in which the custom line item request will be applied.
Type: CustomLineItemBillingPeriodRange object
Required: No
- ChargeDetails
-
A
ListCustomLineItemChargeDetailscontaining the new charge details for the custom line item.Type: UpdateCustomLineItemChargeDetails object
Required: No
- Description
-
The new line item description of the custom line item.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 255.
Required: No
- Name
-
The new name for the custom line item.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 128.
Pattern:
[a-zA-Z0-9_\+=\.\-@]+Required: No
Response Syntax
HTTP/1.1 200
Content-type: application/json
{
"Arn": "string",
"AssociationSize": number,
"BillingGroupArn": "string",
"ChargeDetails": {
"Flat": {
"ChargeValue": number
},
"LineItemFilters": [
{
"Attribute": "string",
"MatchOption": "string",
"Values": [ "string" ]
}
],
"Percentage": {
"PercentageValue": number
},
"Type": "string"
},
"Description": "string",
"LastModifiedTime": number,
"Name": "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.
- Arn
-
The ARN of the successfully updated custom line item.
Type: String
Pattern:
(arn:aws(-cn)?:billingconductor::[0-9]{12}:customlineitem/)?[a-zA-Z0-9]{10} - AssociationSize
-
The number of resources that are associated to the custom line item.
Type: Long
Valid Range: Minimum value of 0.
- BillingGroupArn
-
The ARN of the billing group that the custom line item is applied to.
Type: String
Pattern:
arn:aws(-cn)?:billingconductor::[0-9]{12}:billinggroup/[0-9]{12} - ChargeDetails
-
A
ListCustomLineItemChargeDetailscontaining the charge details of the successfully updated custom line item.Type: ListCustomLineItemChargeDetails object
- Description
-
The description of the successfully updated custom line item.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 255.
- LastModifiedTime
-
The most recent time when the custom line item was modified.
Type: Long
- Name
-
The name of the successfully updated custom line item.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 128.
Pattern:
[a-zA-Z0-9_\+=\.\-@]+
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:
