awslimitchecker

PyPi package version PyPi downloads Code Health travis-ci for master branch coverage report for master branch sphinx documentation for latest release sphinx documentation for develop branch GitHub latest release version GitHub Forks GitHub Stars GitHub Open Issues Project Status: Active - The project has reached a stable, usable state and is being actively developed.

A script and python module to check your AWS service limits and usage using boto.

Users building out scalable services in Amazon AWS often run into AWS’ service limits - often at the least convenient time (i.e. mid-deploy or when autoscaling fails). Amazon’s Trusted Advisor can help this, but even the version that comes with Business and Enterprise support only monitors a small subset of AWS limits and only alerts weekly. awslimitchecker provides a command line script and reusable package that queries your current usage of AWS resources and compares it to limits (hard-coded AWS defaults that you can override, or data from Trusted Advisor where available), notifying you when you are approaching or at your limits.

Status

This project is currently in very early development. At this time please consider it alpha code and not reliable; furthermore its API may be changing rapidly. I hope to have this stabilized soon. I wouldn’t call it ready for use, but contributions are certainly welcome.

What It Does

  • Check current AWS resource usage against AWS Service Limits
  • Show and inspect current usage
  • Override default Service Limits (for accounts with increased limits)
  • Compare current usage to limits; return information about limits that exceed thresholds, and (CLI wrapper) exit non-0 if thresholds are exceeded
  • Define custom thresholds per-limit
  • where possible, pull current limits from Trusted Advisor API

Requirements

  • Python 2.6 through 3.4. Python 2.x is recommended, as boto (the AWS client library) currently has incomplete Python3 support. See the boto documentation for a list of AWS services that are Python3-compatible.
  • Python VirtualEnv and pip (recommended installation method; your OS/distribution should have packages for these)
  • boto >= 2.32.0

Installation and Usage

See Getting Started.

Getting Help and Asking Questions

See Getting Help.

Indices and tables

License

awslimitchecker is licensed under the GNU Affero General Public License, version 3 or later. This shouldn’t be much of a concern to most people; see Development / AGPL for more information.