Skip to main content

A terminal application that enables interactive searches for AWS resources. It is a mini AWS console in your terminal or shell environment.

Project description

Documentation Status https://github.com/MacHu-GWU/aws_resource_search-project/workflows/CI/badge.svg https://codecov.io/gh/MacHu-GWU/aws_resource_search-project/branch/main/graph/badge.svg https://img.shields.io/pypi/v/aws_resource_search.svg https://img.shields.io/pypi/l/aws_resource_search.svg https://img.shields.io/pypi/pyversions/aws_resource_search.svg https://img.shields.io/badge/Release_History!--None.svg?style=social https://img.shields.io/badge/STAR_Me_on_GitHub!--None.svg?style=social
https://img.shields.io/badge/Link-Document-blue.svg https://img.shields.io/badge/Link-API-blue.svg https://img.shields.io/badge/Link-Source_Code-blue.svg https://img.shields.io/badge/Link-Install-blue.svg https://img.shields.io/badge/Link-GitHub-blue.svg https://img.shields.io/badge/Link-Submit_Issue-blue.svg https://img.shields.io/badge/Link-Request_Feature-blue.svg https://img.shields.io/badge/Link-Download-blue.svg

Welcome to aws_resource_search Documentation

https://ars.readthedocs.io/en/latest/_static/aws_resource_search-logo.png

📙 Full Documentation HERE

AWS Resource Search (ARS) is a terminal application that enables interactive searches for AWS resources. It is a mini AWS console in your terminal or shell environment.

It utilizes advanced indexing techniques that support full-text search (any word, no longer restricted to prefix or suffix matching), fuzzy search (tolerating spelling mistakes), and n-gram search (allowing matching of series of n adjacent characters).

ARS comes with built-in query caching, ensuring blazing-fast performance even when dealing with a large number of AWS resources such as IAM roles, Lambda Functions, CloudFormation stacks, and more.

As a Python library, installation is as simple as running pip install aws_resource_search. There’s no need to set up databases, additional search tools, or install any other software.

The data stays on your laptop, there’s no remote server involved.

The open-source Community Edition of ARS allows searching within a single AWS Account and one AWS region at a time. You can switch between different AWS accounts before conducting your searches. On the other hand, the Enterprise Edition of ARS offers the capability to search across multiple AWS accounts and AWS regions, providing an aggregated view. Currently, the enterprise version is in beta and is expected to become generally available in early 2024.”

Demo

Search S3 Bucket.

https://asciinema.org/a/618423.svg

Search StepFunction execution, which is a child resource of StepFunction state machine.

https://asciinema.org/a/618428.svg

Install

aws_resource_search is released on PyPI, so all you need is:

$ pip install aws_resource_search

To upgrade to latest version:

$ pip install --upgrade aws_resource_search

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

aws_resource_search-0.6.2.tar.gz (95.8 kB view hashes)

Uploaded Source

Built Distribution

aws_resource_search-0.6.2-py3-none-any.whl (161.4 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page