Skip to main content

Crate aws_sdk_sustainability

Crate aws_sdk_sustainability 

Source
Expand description

The AWS Sustainability service provides programmatic access to estimated carbon emissions data for your Amazon Web Services usage. Use the AWS Sustainability service to retrieve, analyze, and track the carbon footprint of your cloud infrastructure over time.

With the AWS Sustainability service, you can:

  • Retrieve estimated carbon emissions for your Amazon Web Services usage across different time periods
  • Group emissions data by dimensions such as account, region, and service
  • Filter emissions data to focus on specific accounts, regions, or services
  • Access multiple emissions calculation methodologies including Location-based Method (LBM) and Market-based Method (MBM)
  • Aggregate emissions data at various time granularities including monthly, quarterly, and yearly periods

The API supports pagination for efficient data retrieval and provides dimension values to help you understand the available grouping and filtering options for your account.

All emissions values are calculated using methodologies aligned with the Greenhouse Gas (GHG) Protocol and are provided in metric tons of carbon dioxide-equivalent (MTCO2e).

§Getting Started

Examples are available for many services and operations, check out the usage examples.

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-sustainability to your project, add the following to your Cargo.toml file:

[dependencies]
aws-config = { version = "1.1.7", features = ["behavior-version-latest"] }
aws-sdk-sustainability = "1.0.0"
tokio = { version = "1", features = ["full"] }

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

use aws_sdk_sustainability as sustainability;

#[::tokio::main]
async fn main() -> Result<(), sustainability::Error> {
    let config = aws_config::load_from_env().await;
    let client = aws_sdk_sustainability::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 Sustainability. 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
Client for calling AWS Sustainability.
config
Configuration for AWS Sustainability.
error
Common errors and error handling utilities.
meta
Information about this crate.
operation
All operations that this crate can perform.
primitives
Primitives such as Blob or DateTime used by other types.
types
Data structures used by operation inputs/outputs.

Structs§

Client
Client for AWS Sustainability
Config
Configuration for a aws_sdk_sustainability service client.

Enums§

Error
All possible error types for this service.