@aws-sdk/client-budgets

Description

AWS SDK for JavaScript Budgets Client for Node.js, Browser and React Native.

Use the Amazon Web Services Budgets API to plan your service usage, service costs, and instance reservations. This API reference provides descriptions, syntax, and usage examples for each of the actions and data types for the Amazon Web Services Budgets feature. Budgets provide you with a way to see the following information: <ul> <li> How close your plan is to your budgeted amount or to the free tier limits </li> <li> Your usage-to-date, including how much you've used of your Reserved Instances (RIs) </li> <li> Your current estimated charges from Amazon Web Services, and how much your predicted usage will accrue in charges by the end of the month </li> <li> How much of your budget has been used </li> </ul> Amazon Web Services updates your budget status several times a day. Budgets track your unblended costs, subscriptions, refunds, and RIs. You can create the following types of budgets: <ul> <li> Cost budgets - Plan how much you want to spend on a service. </li> <li> Usage budgets - Plan how much you want to use one or more services. </li> <li> RI utilization budgets - Define a utilization threshold, and receive alerts when your RI usage falls below that threshold. This lets you see if your RIs are unused or under-utilized. </li> <li> RI coverage budgets - Define a coverage threshold, and receive alerts when the number of your instance hours that are covered by RIs fall below that threshold. This lets you see how much of your instance usage is covered by a reservation. </li> </ul> Service Endpoint The Amazon Web Services Budgets API provides the following endpoint: <ul> <li> https://budgets.amazonaws.com </li> </ul> For information about costs that are associated with the Amazon Web Services Budgets API, see <a href="https://aws.amazon.com/aws-cost-management/pricing/">Amazon Web Services Cost Management Pricing</a>.

Installing

To install this package, use the CLI of your favorite package manager:

npm install @aws-sdk/client-budgets
yarn add @aws-sdk/client-budgets
pnpm add @aws-sdk/client-budgets

Getting Started

Import

The AWS SDK is modulized by clients and commands. To send a request, you only need to import the BudgetsClient and the commands you need, for example ListTagsForResourceCommand:

// ES5 example
const { BudgetsClient, ListTagsForResourceCommand } = require("@aws-sdk/client-budgets");

// ES6+ example
import { BudgetsClient, ListTagsForResourceCommand } from "@aws-sdk/client-budgets";

Usage

To send a request:

Instantiate a client with configuration (e.g. credentials, region).
- See docs/CLIENTS for configuration details.
- See @aws-sdk/config for additional options.
Instantiate a command with input parameters.
Call the send operation on the client, providing the command object as input.

const client = new BudgetsClient({ region: "REGION" });

const params = { /** input parameters */ };
const command = new ListTagsForResourceCommand(params);

Async/await

We recommend using the await operator to wait for the promise returned by send operation as follows:

// async/await.
try {
  const data = await client.send(command);
  // process data.
} catch (error) {
  // error handling.
} finally {
  // finally.
}

Promises

You can also use Promise chaining.

client
  .send(command)
  .then((data) => {
    // process data.
  })
  .catch((error) => {
    // error handling.
  })
  .finally(() => {
    // finally.
  });

Aggregated client

The aggregated client class is exported from the same package, but without the "Client" suffix.

Budgets extends BudgetsClient and additionally supports all operations, waiters, and paginators as methods. This style may be familiar to you from the AWS SDK for JavaScript v2.

If you are bundling the AWS SDK, we recommend using only the bare-bones client (BudgetsClient). More details are in the blog post on modular packages in AWS SDK for JavaScript.

import { Budgets } from "@aws-sdk/client-budgets";

const client = new Budgets({ region: "REGION" });

// async/await.
try {
  const data = await client.listTagsForResource(params);
  // process data.
} catch (error) {
  // error handling.
}

// Promises.
client
  .listTagsForResource(params)
  .then((data) => {
    // process data.
  })
  .catch((error) => {
    // error handling.
  });

// callbacks (not recommended).
client.listTagsForResource(params, (err, data) => {
  // process err and data.
});

Troubleshooting

When the service returns an exception, the error will include the exception information, as well as response metadata (e.g. request id).

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;
   * }
   */
}

Getting Help

Please use these community resources for getting help. We use GitHub issues for tracking bugs and feature requests, but have limited bandwidth to address them.

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

Contributing

This client code is generated automatically. Any modifications will be overwritten the next time the @aws-sdk/client-budgets package is updated. To contribute to client you can check our generate clients scripts.

License

This SDK is distributed under the Apache License, Version 2.0, see LICENSE for more information.

Client Commands (Operations List)

<details> <summary> CreateBudget </summary>