awslimitchecker

Master:

Develop:

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, API-based limits where available, 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 beta code and not fully tested in all situations; furthermore its API may be changing rapidly. I hope to have this stabilized soon.

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
• where possible, pull current limits from each service’s API (for services that provide this information)
• Supports explicitly setting the AWS region
• Supports using STS to assume roles in other accounts, including using external_id.

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.

Changelog

See https://github.com/jantman/awslimitchecker/blob/develop/CHANGES.rst

Contents

• Getting Started
  • What It Does
  • Nomenclature
  • Requirements
  • Installing
  • Credentials
  • Regions
  • Required Permissions
• Command Line Usage
  • Examples
    • Listing Supported Services
    • Listing Default Limits
    • Viewing Limits
    • Disabling Trusted Advisor Checks
    • Checking Usage
    • Overriding Limits
    • Check Limits Against Thresholds
    • Set Custom Thresholds
    • Required IAM Policy
    • Connect to a Specific Region
    • Assume a Role in Another Account with STS
• Python Usage
  • Full Jenkins Example
  • Simple Examples
    • Instantiating the Class
    • Specifying a Region
    • Assuming a Role with STS
    • Setting a Limit Override
    • Checking Thresholds
    • Disabling Trusted Advisor
  • Logging
  • Advanced Examples
    • CI / Deployment Checks
• Required IAM Permissions
• Supported Limits
  • Trusted Advisor Data
  • Limits Retrieved from Service APIs
  • Current Checks
    • AutoScaling
    • EBS
    • EC2
    • ELB
    • ElastiCache
    • RDS
    • VPC
• Development
  • Pull Requests
  • Installing for Development
  • Guidelines
  • Adding New Limits and Checks to Existing Services
  • Adding New Services
  • Trusted Advisor Checks
  • Unit Testing
  • Integration Testing
  • Building Docs
  • AGPL License
  • Handling Issues and PRs
  • Release Checklist
• Internals
  • Overall Program Flow
  • Trusted Advisor
  • Service API Limit Information
  • Limit Value Precedence
• API
  • awslimitchecker package
    • Subpackages
      • awslimitchecker.services package
    • Submodules
      • awslimitchecker.checker module
      • awslimitchecker.connectable module
      • awslimitchecker.limit module
      • awslimitchecker.runner module
      • awslimitchecker.trustedadvisor module
      • awslimitchecker.utils module
      • awslimitchecker.version module
      • awslimitchecker.versioncheck module
• Getting Help
  • Reporting Bugs and Asking Questions
  • IRC

Indices and tables

• Index
• Module Index
• Search Page

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.