resource-lister 1.2.0

Resource Lister

Resource Lister (Multi Accounts)

Resource Lister is an open source, NO CODE, interactive, python-based command line utility. Resource Lister can generate centralizedlist of AWS resources (for supported services) in single or multiple accounts in consumable CSV, or flatten JSON format. Resource Lister uses AWS SDK for Python(Boto3) sessions and underlying Boto3 List APIs to connect multiple configured child accounts and generate the resource list. It essentially simplifies accessing of Boto3 list APIs. Resource Lister also provides an option to send generated list to file, s3, or print on command line. Resource Lister can be configured to run from Cloud9, Cloudshell, EC2 or from your machine.

Usage:

Resource Lister Utility can be helpful to addresses following usecase

• Resource Lister is handy utility for Developers, Solution Architect, Account Owners, Cloud Ops team or anyone who simply wants to generate list of AWS Resources (for supported services) across accounts and across regions without writing any custom code.

• Utility can help generate list of inventory of AWS resources across region and across accounts in near real time. For example, operation team wants to verify there is no lambda function created in restricted regions in near real time. You can also run the utility in batch mode across all the configured AWS services and create inventory.

• Utility can help enforce budgetary constraints. For example, utility can help Account owners to identify which AWS accounts doesn't have AWS budget setup.

• Utility can help identify particular type of list of resources. for example, you can generate list of lambda function and filter lambda function using python 2.6 version.

• Utility flattens the response in consumable csv format.

How it works?

After you install and configure the Resource Lister you can run the Resource lister utility using pipx run.

pipx run resource_lister

1 . Select AWS Service : Resource Lister Utility will prompt you to select the AWS Service: You can select any of 27 services example S3, lambda or ec2

2 . Select Function: Resource Lister Utility will display number of supported functions for selected AWS service: Example List of S3 buckets or List of Aurora DB clusters or List of Lambda functions depending upon service you selected.

3 . Select Account(s): Resource Lister Utility will prompt you to select AWS Account for which you want to generate list of AWS resources: You can enter ALL to select all the accounts or you can enter single account or comma separated list of accounts. If you don’t know the account number you just press ENTER and utility will prompt you with list of configured accounts.

4 . Select Region(s) for Regional services: If it's regional resource (example Lambda) you will prompt to select AWS Region; you can select ALL for all the regions or specify comma separated list of regions

5 . Result: Resource lister utility will then generates the list of AWS Resources for selected accounts and regions send the output to file or S3 Bucket or print on command prompt depending upon your configuration.

Output

Note : You can also run the utility in batch mode across all the services in selected AWS Account by going to help --> option # 6

Prerequisite

1. Python
2. AWS CLI

Installation

You can install and run Resource lister using pipx

On macOS, Linux, install via pip (requires pip 19.0 or later)

python3 -m pip install  pipx
python3 -m pip install  boto3
python3 -m pipx install resource-lister

On Windows, install via pip (requires pip 19.0 or later)

If you installed python using the app-store, replace python with python3 in the next line.

python -m pip install pipx
python -m pip install boto3
python -m pipx install resource-lister

Run the Resource Lister Utility using pipx

On macOS, Linux, install via pip (requires pip 19.0 or later)

python3 -m pipx run resource_lister

On Windows, install via pip (requires pip 19.0 or later)

python -m pipx run resource_lister

Resource lister utility will open in command prompt

Setup

Express setup for single account using default credentials.

You will use default IAM credentials for this setup. Ensure your current default credentials should have read only permissions

Step1 : Navigate to "Add Master Account"

Type help-->1 [Manage AWS Account]-->1 [Add Master Account.]

Step2 : Configure Master account with dummy values

Since express setup we are using default credentials. Use dummy values for Master Account ARN like arn:aws:iam::<Your 12 Digit Account>:role/dummy_role and for child account role name enter dummy_role

Congratulations! AWS Account is successfully configured.

Step3: Navigate back to main search

Type 0 to exit 0-->0

Step4 : Test Utility by generating list of s3 buckets .csv file

Enter AWS service for help (help) for Exit (0) :-->s3

Please select any of following options:

1. [List of S3 buckets]
2. [List of the objects in a S3 Bucket] Please enter option HERE-->1

Please enter comma separated account id(s) or ALL HERE-->ALL

Utility will create output folder and generate the .csv file with list of s3 buckets in your account.

Multi Account configurations.

• Cloud9 setup

• Cloudshell setup

Help

General help

Supported Services and Functionality

Supported Services and Functionality

Service	Functions
accessanalyzer	1.List of IAM Analyzers 2.List of findings for specified IAM Analyzer
budgets	3.List of budgets
cloudformation	4.List of Cloudformation Stacks
cloudfront	5.List of CloudFront distributions 6.List of CloudFront functions
cloudtrail	7.List of Cloud Trails
cloudwatch	8.List of Cloudwatch Dashboards 9.List of Cloudwatch Metrics
codecommit	10.List of Code commit Repositories
dynamodb	11.List of DynamoDB tables
ec2	12.List of EC2 instances 13.Describes the specified Elastic IP addresses 14.List of VPCs 15.List of EBS volumes 16.List of flow logs 17.List of Network ACLs 18.List of Route tables 19.List of Security Groups 20.List of Security Group Rules 21.List of all the snapshots (self taken) 22.List of Subnets 23.List of Transit Gateways (TGW) 24.List of VPC endpoints 25.List of all the VPC Peering connections 26.List of VPN connections
ecs	27.List of ECS clusters 28.List of ECS Services in specified ECS Cluster 29.List ECS Tasks in specified ECS Cluster
efs	30.List of EFS
eks	31.Describe details of specified EKS Cluster 32.List of EKS Clusters 33.List EKS Fargate profiles in specified EKS Cluster
elbv2	34.List of load balancers (Application, Network)
emr	35.List of Provisioned EMR Clusters 36.List of notebook executions. 37.List of all the EMR Studios 38.List of Instance fleets for specific EMR cluster
emr-serverless	39.List of EMR Serverless applications 40.List of EMR Serverless Job runs for specified EMR serverless application
iam	41.List of IAM Roles 42. List of Managed policies (AWS and Your owned) 43. List of IAM users
kms	44.List of KMS keys
lambda	45.List of Lambda functions 46.List of Lambda layers
organizations	47. List of accounts in the organization 48. List of Service Control Policies (SCP) in an organization
rds	49.List of Aurora DB clusters 50.List of provisioned RDS instances 51.List of DB Security Groups 52.List of Database Sanpshots 53.List of Global aurora clusters
redshift	54.List of Redshift clusters
redshift-serverless	55.List of Redshift serverless namespaces 56.List of Redshift serverless workgroups
route53	57.List of all the Route53 CIDRs 58.List of hosted zones(public and private) 59.List of private hosted zones associated with specified VPC
route53domains	60.List of Route53 Domains 61.Info of Route53 Domain pricing
s3	62.List of S3 buckets 63.List of the objects in a S3 Bucket
sagemaker	64.List of SageMaker Domains 65.List of SageMaker Images 66.List of SageMaker Models 67.List of SageMaker Projects 68.List of SageMaker User Profiles
sns	69.List of SNS subscriptions 70.List of SNS topics
sqs	71.List of SQS queues
ssm	72.Describe Instance Information (OS version)

License

This library is licensed under the Apache-2.0. See the LICENSE file.

Considerations

• Resource-Lister makes list API calls using AWS SDK for Python(Boto3).These list API calls will be applied to your AWS Account List API Quotas.

• Utiliy provide options to use existing IAM roles or to create new roles using utility provided cloudformation templates. If you decided to use utility provided cloudformation templates. Master account cloudformation template will create ReadonlyAccess IAM role in master account .Child account cloudformation template will create ReadOnlyAccess IAM role in child account.

• Most of the cases list generated by utility will have 99% of the attributes send back by Boto3 .Utility doesn't assure 100% attributes are covered.

• When running utility more than 5 accounts,to avoid memory issues,It's recommended to generate Account wise file. Account wise file can be generated by changing configuration settting in help section . Help --> 6. [Manage Configurations (example : format_type, output_type)]-->5.[Modify Seperate file for each AWS Account]-->change to yes

• Utility currently supports only 27 services and 70 functions. Utility is configuration driven so adding new function is easy. If you are interested in additional functions /features, please raise issue.

Know issues/Pending items

• Improvements in error handling messages
• Help section is work in progress