AWS SDK for JavaScript Billingconductor Client for Node.js, Browser and React Native
npm install @aws-sdk/client-billingconductorAWS SDK for JavaScript Billingconductor Client for Node.js, Browser and React Native.
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. 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 Billing Conductor configuration, the payer account can also see the custom rate applied on the billing details page of the Billing console, or configure a cost and usage report per billing group.
This documentation shows how you can configure Billing Conductor by using its API. For more information about using the Billing Conductor user interface, see the Billing Conductor User Guide.
npm install @aws-sdk/client-billingconductoryarn add @aws-sdk/client-billingconductorpnpm add @aws-sdk/client-billingconductorThe AWS SDK is modulized by clients and commands.
To send a request, you only need to import the BillingconductorClient and
the commands you need, for example ListBillingGroupsCommand:
``js`
// ES5 example
const { BillingconductorClient, ListBillingGroupsCommand } = require("@aws-sdk/client-billingconductor");
`ts`
// ES6+ example
import { BillingconductorClient, ListBillingGroupsCommand } from "@aws-sdk/client-billingconductor";
To send a request, you:
- Initiate client with configuration (e.g. credentials, region).
- Initiate command with input parameters.
- Call send operation on client with command object as input.destroy()
- If you are using a custom http handler, you may call to close open connections.
`js
// a client can be shared by different commands.
const client = new BillingconductorClient({ region: "REGION" });
const params = { /* input parameters / };
const command = new ListBillingGroupsCommand(params);
`
#### Async/await
We recommend using await
operator to wait for the promise returned by send operation as follows:
`js`
// async/await.
try {
const data = await client.send(command);
// process data.
} catch (error) {
// error handling.
} finally {
// finally.
}
Async-await is clean, concise, intuitive, easy to debug and has better error handling
as compared to using Promise chains or callbacks.
#### Promises
You can also use Promise chaining
to execute send operation.
`js`
client.send(command).then(
(data) => {
// process data.
},
(error) => {
// error handling.
}
);
Promises can also be called using .catch() and .finally() as follows:
`js`
client
.send(command)
.then((data) => {
// process data.
})
.catch((error) => {
// error handling.
})
.finally(() => {
// finally.
});
#### Callbacks
We do not recommend using callbacks because of callback hell,
but they are supported by the send operation.
`js`
// callbacks.
client.send(command, (err, data) => {
// process err and data.
});
#### v2 compatible style
The client can also send requests using v2 compatible style.
However, it results in a bigger bundle size and may be dropped in next major version. More details in the blog post
on modular packages in AWS SDK for JavaScript
`ts
import * as AWS from "@aws-sdk/client-billingconductor";
const client = new AWS.Billingconductor({ region: "REGION" });
// async/await.
try {
const data = await client.listBillingGroups(params);
// process data.
} catch (error) {
// error handling.
}
// Promises.
client
.listBillingGroups(params)
.then((data) => {
// process data.
})
.catch((error) => {
// error handling.
});
// callbacks.
client.listBillingGroups(params, (err, data) => {
// process err and data.
});
`
When the service returns an exception, the error will include the exception information,
as well as response metadata (e.g. request id).
`js`
try {
const data = await client.send(command);
// process data.
} catch (error) {
const { requestId, cfId, extendedRequestId } = error.$metadata;
console.log({ requestId, cfId, extendedRequestId });
/**
* The keys within exceptions are also parsed.
* You can access them by specifying exception names:
* if (error.name === 'SomeServiceException') {
* const value = error.specialKeyInException;
* }
*/
}
Please use these community resources for getting help.
We use the GitHub issues for tracking bugs and feature requests, but have limited bandwidth to address them.
- Visit Developer Guide
or API Reference.
- Check out the blog posts tagged with aws-sdk-js
on AWS Developer Blog.
- Ask a question on StackOverflow and tag it with aws-sdk-js.
- Join the AWS JavaScript community on gitter.
- If it turns out that you may have found a bug, please open an issue.
To test your universal JavaScript code in Node.js, browser and react-native environments,
visit our code samples repo.
This client code is generated automatically. Any modifications will be overwritten the next time the @aws-sdk/client-billingconductor` package is updated.
To contribute to client you can check our generate clients scripts.
This SDK is distributed under the
Apache License, Version 2.0,
see LICENSE for more information.
AssociateAccounts
Command API Reference / Input / Output
AssociatePricingRules
Command API Reference / Input / Output
BatchAssociateResourcesToCustomLineItem
Command API Reference / Input / Output
BatchDisassociateResourcesFromCustomLineItem
Command API Reference / Input / Output
CreateBillingGroup
Command API Reference / Input / Output
CreateCustomLineItem
Command API Reference / Input / Output
CreatePricingPlan
Command API Reference / Input / Output
CreatePricingRule
Command API Reference / Input / Output
DeleteBillingGroup
Command API Reference / Input / Output
DeleteCustomLineItem
Command API Reference / Input / Output
DeletePricingPlan
Command API Reference / Input / Output
DeletePricingRule
Command API Reference / Input / Output
DisassociateAccounts
Command API Reference / Input / Output
DisassociatePricingRules
Command API Reference / Input / Output
GetBillingGroupCostReport
Command API Reference / Input / Output
ListAccountAssociations
Command API Reference / Input / Output
ListBillingGroupCostReports
Command API Reference / Input / Output
ListBillingGroups
Command API Reference / Input / Output
ListCustomLineItems
Command API Reference / Input / Output
ListCustomLineItemVersions
Command API Reference / Input / Output
ListPricingPlans
Command API Reference / Input / Output
ListPricingPlansAssociatedWithPricingRule
Command API Reference / Input / Output
ListPricingRules
Command API Reference / Input / Output
ListPricingRulesAssociatedToPricingPlan
Command API Reference / Input / Output
ListResourcesAssociatedToCustomLineItem
Command API Reference / Input / Output
ListTagsForResource
Command API Reference / Input / Output
TagResource
Command API Reference / Input / Output
UntagResource
Command API Reference / Input / Output
UpdateBillingGroup
Command API Reference / Input / Output
UpdateCustomLineItem
Command API Reference / Input / Output
UpdatePricingPlan
Command API Reference / Input / Output
UpdatePricingRule