@aws-sdk/client-sustainability

Description

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

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

Installing

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

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

Getting Started

Import

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

// ES5 example
const { SustainabilityClient, GetEstimatedCarbonEmissionsCommand } = require("@aws-sdk/client-sustainability");

// ES6+ example
import { SustainabilityClient, GetEstimatedCarbonEmissionsCommand } from "@aws-sdk/client-sustainability";

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 SustainabilityClient({ region: "REGION" });

const params = { /** input parameters */ };
const command = new GetEstimatedCarbonEmissionsCommand(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.

Sustainability extends SustainabilityClient 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 (SustainabilityClient). More details are in the blog post on modular packages in AWS SDK for JavaScript.

import { Sustainability } from "@aws-sdk/client-sustainability";

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

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

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

// callbacks (not recommended).
client.getEstimatedCarbonEmissions(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-sustainability 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> GetEstimatedCarbonEmissions </summary>

Command API Reference / Input / Output

</details> <details> <summary> GetEstimatedCarbonEmissionsDimensionValues </summary>

Command API Reference / Input / Output

</details>