Class: AWS.Billingconductor
- Inherits:
-
AWS.Service
- Object
- AWS.Service
- AWS.Billingconductor
- Identifier:
- billingconductor
- API Version:
- 2021-07-30
- Defined in:
- (unknown)
Overview
Constructs a service interface object. Each API operation is exposed as a function on service.
Service Description
Amazon Web Services Billing Conductor is a fully managed service that you can use to customize a pro forma version of your billing data each month, to accurately show or chargeback your end customers. Amazon Web Services Billing Conductor doesn't change the way you're billed by Amazon Web Services each month by design. Instead, it provides you with a mechanism to configure, generate, and display rates to certain customers over a given billing period. You can also analyze the difference between the rates you apply to your accounting groupings relative to your actual rates from Amazon Web Services. As a result of your Amazon Web Services Billing Conductor configuration, the payer account can also see the custom rate applied on the billing details page of the Amazon Web Services Billing console, or configure a cost and usage report per billing group.
This documentation shows how you can configure Amazon Web Services Billing Conductor using its API. For more information about using the Amazon Web Services Billing Conductor user interface, see the Amazon Web Services Billing Conductor User Guide.
Sending a Request Using Billingconductor
var billingconductor = new AWS.Billingconductor();
billingconductor.associateAccounts(params, function (err, data) {
if (err) console.log(err, err.stack); // an error occurred
else console.log(data); // successful response
});
Locking the API Version
In order to ensure that the Billingconductor object uses this specific API, you can
construct the object by passing the apiVersion
option to the constructor:
var billingconductor = new AWS.Billingconductor({apiVersion: '2021-07-30'});
You can also set the API version globally in AWS.config.apiVersions
using
the billingconductor service identifier:
AWS.config.apiVersions = {
billingconductor: '2021-07-30',
// other service API versions
};
var billingconductor = new AWS.Billingconductor();
Constructor Summary collapse
-
new AWS.Billingconductor(options = {}) ⇒ Object
constructor
Constructs a service object.
Property Summary collapse
-
endpoint ⇒ AWS.Endpoint
readwrite
An Endpoint object representing the endpoint URL for service requests.
Properties inherited from AWS.Service
Method Summary collapse
-
associateAccounts(params = {}, callback) ⇒ AWS.Request
Connects an array of account IDs in a consolidated billing family to a predefined billing group.
-
associatePricingRules(params = {}, callback) ⇒ AWS.Request
Connects an array of
PricingRuleArns
to a definedPricingPlan
. -
batchAssociateResourcesToCustomLineItem(params = {}, callback) ⇒ AWS.Request
Associates a batch of resources to a percentage custom line item.
-
batchDisassociateResourcesFromCustomLineItem(params = {}, callback) ⇒ AWS.Request
Disassociates a batch of resources from a percentage custom line item.
-
createBillingGroup(params = {}, callback) ⇒ AWS.Request
Creates a billing group that resembles a consolidated billing family that Amazon Web Services charges, based off of the predefined pricing plan computation.
-
createCustomLineItem(params = {}, callback) ⇒ AWS.Request
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.
-
createPricingPlan(params = {}, callback) ⇒ AWS.Request
Creates a pricing plan that is used for computing Amazon Web Services charges for billing groups.
-
createPricingRule(params = {}, callback) ⇒ AWS.Request
Creates a pricing rule can be associated to a pricing plan, or a set of pricing plans.
-
deleteBillingGroup(params = {}, callback) ⇒ AWS.Request
Deletes a billing group.
-
deleteCustomLineItem(params = {}, callback) ⇒ AWS.Request
Deletes the custom line item identified by the given ARN in the current, or previous billing period.
-
deletePricingPlan(params = {}, callback) ⇒ AWS.Request
Deletes a pricing plan.
-
deletePricingRule(params = {}, callback) ⇒ AWS.Request
Deletes the pricing rule that's identified by the input Amazon Resource Name (ARN).
-
disassociateAccounts(params = {}, callback) ⇒ AWS.Request
Removes the specified list of account IDs from the given billing group.
-
disassociatePricingRules(params = {}, callback) ⇒ AWS.Request
Disassociates a list of pricing rules from a pricing plan.
-
listAccountAssociations(params = {}, callback) ⇒ AWS.Request
This is a paginated call to list linked accounts that are linked to the payer account for the specified time period.
-
listBillingGroupCostReports(params = {}, callback) ⇒ AWS.Request
A paginated call to retrieve a summary report of actual Amazon Web Services charges and the calculated Amazon Web Services charges based on the associated pricing plan of a billing group.
.
-
listBillingGroups(params = {}, callback) ⇒ AWS.Request
A paginated call to retrieve a list of billing groups for the given billing period.
-
listCustomLineItems(params = {}, callback) ⇒ AWS.Request
A paginated call to get a list of all custom line items (FFLIs) for the given billing period.
-
listCustomLineItemVersions(params = {}, callback) ⇒ AWS.Request
A paginated call to get a list of all custom line item versions.
.
-
listPricingPlans(params = {}, callback) ⇒ AWS.Request
A paginated call to get pricing plans for the given billing period.
-
listPricingPlansAssociatedWithPricingRule(params = {}, callback) ⇒ AWS.Request
A list of the pricing plans that are associated with a pricing rule.
-
listPricingRules(params = {}, callback) ⇒ AWS.Request
Describes a pricing rule that can be associated to a pricing plan, or set of pricing plans.
-
listPricingRulesAssociatedToPricingPlan(params = {}, callback) ⇒ AWS.Request
Lists the pricing rules that are associated with a pricing plan.
-
listResourcesAssociatedToCustomLineItem(params = {}, callback) ⇒ AWS.Request
List the resources that are associated to a custom line item.
-
listTagsForResource(params = {}, callback) ⇒ AWS.Request
A list the tags for a resource.
-
tagResource(params = {}, callback) ⇒ AWS.Request
Associates the specified tags to a resource with the specified
resourceArn
. -
untagResource(params = {}, callback) ⇒ AWS.Request
Deletes specified tags from a resource.
-
updateBillingGroup(params = {}, callback) ⇒ AWS.Request
This updates an existing billing group.
-
updateCustomLineItem(params = {}, callback) ⇒ AWS.Request
Update an existing custom line item in the current or previous billing period.
-
updatePricingPlan(params = {}, callback) ⇒ AWS.Request
This updates an existing pricing plan.
-
updatePricingRule(params = {}, callback) ⇒ AWS.Request
Updates an existing pricing rule.
-
waitFor(state, params = {}, callback) ⇒ AWS.Request
Waits for a given Billingconductor resource.
Methods inherited from AWS.Service
makeRequest, makeUnauthenticatedRequest, setupRequestListeners, defineService
Constructor Details
new AWS.Billingconductor(options = {}) ⇒ Object
Constructs a service object. This object has one method for each API operation.
Property Details
Method Details
associateAccounts(params = {}, callback) ⇒ AWS.Request
Connects an array of account IDs in a consolidated billing family to a predefined billing group. The account IDs must be a part of the consolidated billing family during the current month, and not already associated with another billing group. The maximum number of accounts that can be associated in one call is 30.
associatePricingRules(params = {}, callback) ⇒ AWS.Request
Connects an array of PricingRuleArns
to a defined PricingPlan
. The maximum number PricingRuleArn
that can be associated in one call is 30.
batchAssociateResourcesToCustomLineItem(params = {}, callback) ⇒ AWS.Request
Associates a batch of resources to a percentage custom line item.
batchDisassociateResourcesFromCustomLineItem(params = {}, callback) ⇒ AWS.Request
Disassociates a batch of resources from a percentage custom line item.
createBillingGroup(params = {}, callback) ⇒ AWS.Request
Creates a billing group that resembles a consolidated billing family that Amazon Web Services charges, based off of the predefined pricing plan computation.
createCustomLineItem(params = {}, callback) ⇒ AWS.Request
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.
createPricingPlan(params = {}, callback) ⇒ AWS.Request
Creates a pricing plan that is used for computing Amazon Web Services charges for billing groups.
createPricingRule(params = {}, callback) ⇒ AWS.Request
Creates a pricing rule can be associated to a pricing plan, or a set of pricing plans.
deleteCustomLineItem(params = {}, callback) ⇒ AWS.Request
Deletes the custom line item identified by the given ARN in the current, or previous billing period.
deletePricingPlan(params = {}, callback) ⇒ AWS.Request
Deletes a pricing plan. The pricing plan must not be associated with any billing groups to delete successfully.
deletePricingRule(params = {}, callback) ⇒ AWS.Request
Deletes the pricing rule that's identified by the input Amazon Resource Name (ARN).
disassociateAccounts(params = {}, callback) ⇒ AWS.Request
Removes the specified list of account IDs from the given billing group.
disassociatePricingRules(params = {}, callback) ⇒ AWS.Request
Disassociates a list of pricing rules from a pricing plan.
listAccountAssociations(params = {}, callback) ⇒ AWS.Request
This is a paginated call to list linked accounts that are linked to the payer account for the specified time period. If no information is provided, the current billing period is used. The response will optionally include the billing group that's associated with the linked account.
listBillingGroupCostReports(params = {}, callback) ⇒ AWS.Request
A paginated call to retrieve a summary report of actual Amazon Web Services charges and the calculated Amazon Web Services charges based on the associated pricing plan of a billing group.
listBillingGroups(params = {}, callback) ⇒ AWS.Request
A paginated call to retrieve a list of billing groups for the given billing period. If you don't provide a billing group, the current billing period is used.
listCustomLineItems(params = {}, callback) ⇒ AWS.Request
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.
listCustomLineItemVersions(params = {}, callback) ⇒ AWS.Request
A paginated call to get a list of all custom line item versions.
listPricingPlans(params = {}, callback) ⇒ AWS.Request
A paginated call to get pricing plans for the given billing period. If you don't provide a billing period, the current billing period is used.
listPricingPlansAssociatedWithPricingRule(params = {}, callback) ⇒ AWS.Request
A list of the pricing plans that are associated with a pricing rule.
listPricingRules(params = {}, callback) ⇒ AWS.Request
Describes a pricing rule that can be associated to a pricing plan, or set of pricing plans.
listPricingRulesAssociatedToPricingPlan(params = {}, callback) ⇒ AWS.Request
Lists the pricing rules that are associated with a pricing plan.
listResourcesAssociatedToCustomLineItem(params = {}, callback) ⇒ AWS.Request
List the resources that are associated to a custom line item.
tagResource(params = {}, callback) ⇒ AWS.Request
Associates the specified tags to a resource with the specified resourceArn
. If existing tags on a resource are not specified in the request parameters, they are not changed.
updateCustomLineItem(params = {}, callback) ⇒ AWS.Request
Update an existing custom line item in the current or previous billing period.
waitFor(state, params = {}, callback) ⇒ AWS.Request
Waits for a given Billingconductor resource. The final callback or 'complete' event will be fired only when the resource is either in its final state or the waiter has timed out and stopped polling for the final state.