Crate aws_sdk_budgets

source ·
Expand description

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:

  • How close your plan is to your budgeted amount or to the free tier limits
  • Your usage-to-date, including how much you’ve used of your Reserved Instances (RIs)
  • Your current estimated charges from Amazon Web Services, and how much your predicted usage will accrue in charges by the end of the month
  • How much of your budget has been used

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:

  • Cost budgets - Plan how much you want to spend on a service.
  • Usage budgets - Plan how much you want to use one or more services.
  • 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.
  • 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.

Service Endpoint

The Amazon Web Services Budgets API provides the following endpoint:

  • https://budgets.amazonaws.com

For information about costs that are associated with the Amazon Web Services Budgets API, see Amazon Web Services Cost Management Pricing.

§Getting Started

Examples are available for many services and operations, check out the examples folder in GitHub.

The SDK provides one crate per AWS service. You must add Tokio as a dependency within your Rust project to execute asynchronous code. To add aws-sdk-budgets to your project, add the following to your Cargo.toml file:

[dependencies]
aws-config = { version = "1.1.6", features = ["behavior-version-latest"] }
aws-sdk-budgets = "1.14.0"
tokio = { version = "1", features = ["full"] }

Then in code, a client can be created with the following:

use aws_sdk_budgets as budgets;

#[::tokio::main]
async fn main() -> Result<(), budgets::Error> {
    let config = aws_config::load_from_env().await;
    let client = aws_sdk_budgets::Client::new(&config);

    // ... make some calls with the client

    Ok(())
}

See the client documentation for information on what calls can be made, and the inputs and outputs for each of those calls.

§Using the SDK

Until the SDK is released, we will be adding information about using the SDK to the Developer Guide. Feel free to suggest additional sections for the guide by opening an issue and describing what you are trying to do.

§Getting Help

§Crate Organization

The entry point for most customers will be Client, which exposes one method for each API offered by AWS Budgets. The return value of each of these methods is a “fluent builder”, where the different inputs for that API are added by builder-style function call chaining, followed by calling send() to get a Future that will result in either a successful output or a SdkError.

Some of these API inputs may be structs or enums to provide more complex structured information. These structs and enums live in types. There are some simpler types for representing data such as date times or binary blobs that live in primitives.

All types required to configure a client via the Config struct live in config.

The operation module has a submodule for every API, and in each submodule is the input, output, and error type for that API, as well as builders to construct each of those.

There is a top-level Error type that encompasses all the errors that the client can return. Any other error type can be converted to this Error type via the From trait.

The other modules within this crate are not required for normal usage.

Modules§

  • Client for calling AWS Budgets.
  • Configuration for AWS Budgets.
  • Common errors and error handling utilities.
  • Information about this crate.
  • All operations that this crate can perform.
  • Primitives such as Blob or DateTime used by other types.
  • Data structures used by operation inputs/outputs.

Structs§

  • Client for AWS Budgets
  • Configuration for a aws_sdk_budgets service client.

Enums§

  • All possible error types for this service.