Repository files navigation

A list command for AWS resources.

awsls supports listing ofover 250 types of resourcesacross 100 different AWS services. The goal is to code-generate a list function forevery AWS resource that is covered by the Terraform AWS Provider (currently over 500). If you want to contribute,the generator is here.

If you encounter any issue withawsls or have a feature request,please open an issue or write me onTwitter.

Happy listing!

Note: If you're also looking for an easy but powerful way to delete AWS resources, pipe the output ofawsls into its new siblingawsrm via Unix-pipes and use well-known standard tooling such asgrep for filtering.

• List multiple types of resources at once by using glob patterns(e.g.,"aws_iam_*" lists all IAM resources and"*" all resources in your account)
• New: List resources across multiple accounts and regions by using the--profiles and--regions flag(e.g.,-p account1,account2 -r us-east-1,us-west-2)
• Show any resource attribute documented in theTerraform AWS Provider(e.g.,-a private_ip,tags lists the IP and tags for resources of typeaws_instance)

Use Terraform resource types to tellawsls which resources to list. For example,awsls aws_instance showsall EC2 instances. In addition to the default attributesTYPE,ID,REGION, andCREATED timestamp, additional attributescan be displayed via the--attributes <comma-separated list> flag. Every attribute in the Terraform documentation(here are the attributes foraws_instance) is a valid one:

For example,awsls "aws_iam_* lists all IAM resources:

To use specific profiles and/or regions, use the-p (--profiles) or-r (--regions) flags. For example,-p myaccount1,myaccount2 -r us-east-1,us-west-2 lists resources in every permutation of the given profiles and regions,i.e., resources in regionus-west-2 andus-east-1 for accountmyaccount1 as well asmyaccount2:

awsls [flags] <resource_type glob pattern>

To see options available runawsls --help.

You can download a specific version of awsls on thereleases page orinstall it the following way to./bin/:

curl -sSfL https://raw.githubusercontent.com/jckuester/awsls/master/install.sh| sh -s v0.11.0

Homebrew users can install by:

brew install jckuester/tap/awsls

For more information on Homebrew taps please see thetap documentation.

If the--profiles and/or--regions flag is unset,awsls will follow the usualAWS CLI precedenceof first trying to find credentials, profiles and/or regions viaenvironment variables,and so on.

For example, if using--profiles foo,bar, but not setting the regions flag,awsls will first try to use the region from an environment variable (e.g.,AWS_DEFAULT_REGION)and second will try to use the default region for each profile from~/.aws/config.

The--all-profiles flag will use all profiles from~/.aws/config, or ifAWS_CONFIG_FILE=/my/config is set, from/my/config otherwise.

Currently, all 297 resource types across 100 services in the table below can be listed with awsls. TheTags column shows if a resourcesupports displaying tags, theCreation Time column if a resource has a creation timestamp, and theOwner column ifresources are pre-filtered belonging to the account owner.

Note: the prefixaws_ for resource types is now optional. This means, for example,awsls aws_instance andawsls instance are both valid commands.