Important: This documentation covers Yarn 1 (Classic).
For Yarn 2+ docs and migration guide, see yarnpkg.com.

Package detail

@cloud-carbon-footprint/aws

cloud-carbon-footprint3.1kApache-2.00.16.0TypeScript support: included

The core logic to get cloud usage data and estimate energy and carbon emissions from Amazon Web Services.

thoughtworks, cloud, sustainability, climate, carbon-emissions, carbon-footprint

readme

@cloud-carbon-footprint/aws

This package provides the core logic to get cloud usage data and estimate energy and carbon emissions from Amazon Web Services.

Installation

Install the package via npm or Yarn:

$ npm install --save @cloud-carbon-footprint/aws

or

$ yarn add @cloud-carbon-footprint/aws

Documentation

License

© 2021 Thoughtworks, Inc.

changelog

@cloud-carbon-footprint/aws

0.16.0

Minor Changes

  • 7e899dce: Adds support and configuration variables for filtering accounts/projects by id

Patch Changes

0.15.0

Minor Changes

  • 6ffe7497: adds electricity maps api handling. For CLI create-app template changes, refer to this commit.

Patch Changes

0.14.5

Patch Changes

  • 6bf5745d: Fixes Athena query column error for accounts without EC2 hours/usage

0.14.4

Patch Changes

0.14.3

Patch Changes

0.14.2

Patch Changes

  • 689c973e: removes usageUnit from lookup table result Please refer to this commit for create app template updates
  • Updated dependencies [689c973e]
  • Updated dependencies [689c973e]
  • Updated dependencies [689c973e]

0.14.1

Patch Changes

  • f9123277: adds usage types to aws
  • fd4ec19b: Adds new AWS regions and emissions factors for ap-southeast-3 and me-central-1

0.14.0

Minor Changes

  • a6423a68: Aggregate footprint estimates for AWS resources by tags.

Patch Changes

  • a6423a68: updates ts-node dependency
  • a6423a68: Correctly calculate emissions for AWS Lambda when using ARM architecture.
  • a6423a68: Updates the S3 standard replication factor to 6
  • Updated dependencies [a6423a68]
  • Updated dependencies [a6423a68]
  • Updated dependencies [a6423a68]
  • Updated dependencies [a6423a68]
  • Updated dependencies [a6423a68]
  • Updated dependencies [a6423a68]

0.13.0

Minor Changes

  • a7a79c83: Updates emissions factors for cloud provider regions
  • a7a79c83: Add ECS Credentials AWS authentication option

Patch Changes

0.11.1

Patch Changes

  • 84e2d1e2: adds support for missing usage types

0.11.0

Minor Changes

  • 6c590346: adds missing instances and processor mappings

Patch Changes

0.10.0

Minor Changes

  • ef6af294: Adds initial support for energy/carbon estimation for GPU instances for AWS and GCP
  • 9fcbfc67: Adds option for receiving all recommendation services

Patch Changes

  • 03b43e40: Moves f1 and inf1 instances out of the GPU_INSTANCES_TYPES array, because those families don't have GPUs
  • dd2b6744: Adds check for total running queries in Lambda implementation, with a back off, to avoid hitting concurrent queriy limits
  • Updated dependencies [497ae495]
  • Updated dependencies [ef6af294]
  • Updated dependencies [7ecd432d]
  • Updated dependencies [9fcbfc67]
  • Updated dependencies [9938c9b0]

0.9.1

Patch Changes

  • 4873fa2f: Adds reference link for aws instance types

0.9.0

Minor Changes

  • a23e1e59: Updates logic for handling unknown usage types to dynamically build kilowatt hour per usage amount (GCP, Azure) or cost (AWS) by service name and usage unit, to increase accuracy.
  • f40ce29e: Adds Compute Optimizer Recommendations for AWS

Patch Changes

0.8.0

Minor Changes

  • aaeb61a3: Updates estimation for unknown usage types to calculate kilowatt hours first, then co2e, to improve acccuracy

Patch Changes

  • cce87388: Removes suffix from aws usage type
  • 8fd171ed: Updates a number of packages and fixes linting, typescript and dependency issues
  • 2e27711e: adds HostBoxUsage to unsupported usage types in aws to not double count
  • Updated dependencies [8fd171ed]
  • Updated dependencies [808085cc]
  • Updated dependencies [aaeb61a3]

0.7.0

Minor Changes

  • c29a3b53: Adds support for specifying groupBy via API param and for displaying line chart data according to data grouping

    For changes to create-app templates, please refer to this commit.

Patch Changes

0.6.1

Patch Changes

0.6.0

Minor Changes

  • 4238d3b8: Bug fix in core package to handle no estimates and implementation of terraform deployments for aws
  • 4238d3b8: changeset: Adds embodied emissions to the estimations for AWS and Azure

Patch Changes

  • 4238d3b8: Fixes bug with Create Lookup Table requiring credentials for AWS input

    For Create-App updates, please refer to this commit.

  • 4238d3b8: updates aws high fidelity approach to display account names

  • Updated dependencies [4238d3b8]
  • Updated dependencies [4238d3b8]
  • Updated dependencies [4238d3b8]

0.5.1

Patch Changes

0.5.0

Minor Changes

  • 61332214: Adds CLI command for creating a lookup table to be used in ETL pipelines
  • 52237bc6: Adds additional dashboard for viewing cloud provider recommendations including refactoring filters for reusability

    For updating the create-app templates, please refer to the following commit.

Patch Changes

0.4.0

Minor Changes

  • 5a0aab5b: implements classifying unknown usage types for aws

Patch Changes

0.3.0

Minor Changes

  • 52a8b3c1: Adds support for specifying recommendation target for AWS via API parameter

    Please refer to this commit to update create app templates.

  • 22636b35: updates processor coefficients

Patch Changes

  • af761e75: Bugfix: updates region mapping for AWS Recommendations to be correct based on responses from the API
  • f75cf08f: Adds support for getting GCP recommendations from the API
  • ae7d8e19: Fixes bug where AWS r5 instances were estimates emissions incorrectly, due to missing RAM constants and incorrect key from CUR data
  • Updated dependencies [f75cf08f]
  • Updated dependencies [52a8b3c1]

0.2.0

Minor Changes

  • 13f39ac7: implements recommendations for aws rightsizing recommendations api

    Please refer to this commit to update create app templates.

  • 72fc2752: Removed unnecessary config option: targetRoleSessionName

  • e76d5fdd: Adds accountId to the Estimation Results returned from the Cloud Carbon Footprint API

    Please refer to this commit to update create app templates.

Patch Changes

0.1.0

Minor Changes

  • a3b4f6b9: Completed implementation of replication factors for cloud storage seervices
  • bfe69180: Updates Cascade Lake microarchitecture compute and memory coefficients based on latest rows in the SPEC Power database

Patch Changes

0.0.3

Patch Changes

0.0.2

Patch Changes