Skip to content

janiko71/aws-inventory

Repository files navigation

aws-inventory

Did your never forget to stop an EC2 instance? Or to delete some unusued AWS resource? I'm sure you did. And only remembering it when getting the bill. I know, AWS Config may help you, but did you ever try? It's prohibitive!

This python script lists all the main resources of your AWS account. This inventory may be uncomplete, but it should help you to find what I call "main" resources that are, in my mind, resources that should affect billing and/or security.

Intended for personal use (even if I added some professional features like logging), and for only one account. For more information on multiple accounts, read the wiki.

Pre-requisites

This program needs Python 3.4 or newer.

AWS CLI must be installed and configured on the system you want to run aws-inventory. You SHOULD use a special account with minimal rights (= those in inventory*.json files). See wiki for more.

Make sure that you have the latest boto3 version. Older versions may lead to signature error with the newest regions or to some malfunction. Further information here : http://docs.aws.amazon.com/general/latest/gr/signature-version-4.html.

How to contribute?

TESTERS WANTED! If you test this code, please send me feedback: I can't test every configuration (especially when there are a lot of items in inventories), so either if it works or not, let me know what is fine and what needs to be corrected (use issues).

Supported AWS services is limited, but I add some regulary. Supported services are detailed here (wiki):

If you want to add services, you're welcome but keep two things in mind:

  • Use the 'dev' branch to commit your changes;
  • Please follow the general coding style and structure (to keep all functionnalities like progression status).

Derived from https://github.com/powerupcloud/AWSInventoryLambda but not forked because it has been too much modified. Rewritten from scratch to be more pythonified.

What's new in the oct-21 version?

Serviced added, not always fully tested (ForeCast, SageMaker, GuardDuty, WAF/WAFv2/WAF-Regional...). See here for the supported services.

What's new in the sept-21 version?

Some services added (docDB, QLDB, containers...) but a very important update with a better handling of non-existant services (some tests added, and HSM v1 deleted). Execution time is now 60-70 sec. (instead of 200-220). There's a bug with 'timestream-write', so there's an ugly "wart" to prevent long timeouts: the get_available_regions() function returns an empty array for this service.

What's new in this version?

This is an attempt to use multithreading in order to accelerate the script. And, at first sight, it looks better: 230 seconds instead of 960 (for the same inventory) on my first test. A lot of services has been added, with some improvements (like for Lightsail).

And in the next one?

I'm working on a visualization tool. It can be useful for infra services (EC2, EFS, VPC, etc.). I don't know yet how far I can go, and what is the best dataviz tool for that. I'm trying with vis.js.

How to use it

This script is intented to be executed from any python environment (and not only as a AWS lambda function as the original script). More information on wiki.

If you like it

This project is open source (GPL-3.0), but took me some time and efforts to design, to code, to make some researches and to test it. I hope you like this script, and that it will be useful for you.

So, this project in donationware (or donateware). It means that you can give me a small fee or contribution for my work. For those who are familiar with RFCs, it's not SHOULD but it's MAY. Think about it especially if you fork the project, but there is no obligation.

For instance, a couple of $ or € can help me buying a dozen of coffee at work! And if you are millionnaire or a big company, please note that the service I use (leetchi.com) accepts millions of $/€, which could be help me with coffees until retirement.

You can donate here: janiko71/aws-inventory on leetchi.com

About

Python script for AWS resources inventory (cheaper than AWS Config)

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages