@aws-sdk/client-cost-and-usage-report-service-node
Version:
Node SDK for AWS Cost and Usage Report Service
145 lines (113 loc) • 5.55 kB
Markdown
# @aws-sdk/client-cost-and-usage-report-service-node
[](https://www.npmjs.com/package/@aws-sdk/client-cost-and-usage-report-service-node)
[](https://www.npmjs.com/package/@aws-sdk/client-cost-and-usage-report-service-node)
## Description
<p>The AWS Cost and Usage Report API enables you to programmatically create, query, and delete AWS Cost and Usage report definitions.</p> <p>AWS Cost and Usage reports track the monthly AWS costs and usage associated with your AWS account. The report contains line items for each unique combination of AWS product, usage type, and operation that your AWS account uses. You can configure the AWS Cost and Usage report to show only the data that you want, using the AWS Cost and Usage API.</p> <p>Service Endpoint</p> <p>The AWS Cost and Usage Report API provides the following endpoint:</p> <ul> <li> <p>cur.us-east-1.amazonaws.com</p> </li> </ul>
## Installing
To install the this package using NPM, simply type the following into a terminal window:
```
npm install @aws-sdk/client-cost-and-usage-report-service-node
```
## Getting Started
### Import
The AWS SDK is modulized by clients and commands in CommonJS modules. To send a request, you only need to import the client(`CostandUsageReportServiceClient`) and the commands you need, for example `DeleteReportDefinitionCommand`:
```javascript
//JavaScript
const {
CostandUsageReportServiceClient
} = require("@aws-sdk/client-cost-and-usage-report-service-node/CostandUsageReportServiceClient");
const {
DeleteReportDefinitionCommand
} = require("@aws-sdk/client-cost-and-usage-report-service-node/commands/DeleteReportDefinitionCommand");
```
```javascript
//TypeScript
import { CostandUsageReportServiceClient } from "@aws-sdk/client-cost-and-usage-report-service-node/CostandUsageReportServiceClient";
import { DeleteReportDefinitionCommand } from "@aws-sdk/client-cost-and-usage-report-service-node/commands/DeleteReportDefinitionCommand";
```
### Usage
To send a request, you:
- Initiate client with configuration (e.g. credentials, region). For more information you can refer to the [API reference][].
- Initiate command with input parameters.
- Call `send` operation on client with command object as input.
- If you are using a custom http handler, you may call `destroy()` to close open connections.
```javascript
const costandUsageReportService = new CostandUsageReportServiceClient({
region: "region"
});
//clients can be shared by different commands
const params = {};
const deleteReportDefinitionCommand = new DeleteReportDefinitionCommand(params);
costandUsageReportService
.send(deleteReportDefinitionCommand)
.then(data => {
// do something
})
.catch(error => {
// error handling
});
```
In addition to using promises, there are 2 other ways to send a request:
```javascript
// async/await
try {
const data = await costandUsageReportService.send(
deleteReportDefinitionCommand
);
// do something
} catch (error) {
// error handling
}
```
```javascript
// callback
costandUsageReportService.send(deleteReportDefinitionCommand, (err, data) => {
//do something
});
```
The SDK can also send requests using the simplified callback style from version 2 of the SDK.
```javascript
import * as AWS from "@aws-sdk/@aws-sdk/client-cost-and-usage-report-service-node/CostandUsageReportService";
const costandUsageReportService = new AWS.CostandUsageReportService({
region: "region"
});
costandUsageReportService.deleteReportDefinition(params, (err, data) => {
//do something
});
```
### Troubleshooting
When the service returns an exception, the error will include the exception information, as well as response metadata (e.g. request id).
```javascript
try {
const data = await costandUsageReportService.send(
deleteReportDefinitionCommand
);
// do something
} catch (error) {
const metadata = error.$metadata;
console.log(
`requestId: ${metadata.requestId}
cfId: ${metadata.cfId}
extendedRequestId: ${metadata.extendedRequestId}`
);
/*
The keys within exceptions are also parsed. You can access them by specifying exception names:
if(error.name === 'SomeServiceException') {
const value = error.specialKeyInException;
}
*/
}
```
## Getting Help
Please use these community resources for getting help. We use the GitHub issues for tracking bugs and feature requests and have limited bandwidth to address them.
- Ask a question on [StackOverflow](https://stackoverflow.com/questions/tagged/aws-sdk-js) and tag it with `aws-sdk-js`
- Come join the AWS JavaScript community on [gitter](https://gitter.im/aws/aws-sdk-js-v3)
- If it turns out that you may have found a bug, please [open an issue](https://github.com/aws/aws-sdk-js-v3/issues)
## Contributing
This client code is generated automatically. Any modifications will be overwritten the next time the `@aws-sdk/@aws-sdk/client-cost-and-usage-report-service-node' package is updated. To contribute to SDK you can checkout our [code generator package][].
## License
This SDK is distributed under the
[Apache License, Version 2.0](http://www.apache.org/licenses/LICENSE-2.0),
see LICENSE for more information.
[code generator package]: https://github.com/aws/aws-sdk-js-v3/tree/master/packages/service-types-generator
[api reference]: https://docs.aws.amazon.com/AWSJavaScriptSDK/latest/