Skip to main content

httpAWS - a CLI, cURL-like tool for AWS services.

Project description

Directly make HTTP calls to AWS service endpoints using the requsts and aws-requests-auth modules.

This is a low-level command-line tool intended for use by developers so that they can easily make direct HTTP calls
to AWS services. It is effectively a command-line programmatic replacement for using a graphical tool like Postman
(https://www.getpostman.com) and was inspired by tools like HTTPie (https://httpie.org) but is specific to AWS services.

WARNING: This tool is intended for development and educational purposes. It is NOT intended for robust and reliable
administration of AWS services. For interaction with production AWS services, it is highly recommended that you use an
officially supported tool specifically designed for that purpose such as any of the following:
- AWS Console
* https://aws.amazon.com
- AWS CLI
* https://aws.amazon.com/cli/
- AWS Shell
* https://github.com/awslabs/aws-shell
- AWS SDK for Python (boto3)
* https://aws.amazon.com/sdk-for-python/
Home-page: https://github.com/http-aws/http-aws
Author: Todd Leonhardt
Author-email: todd.leonhardt@gmail.com
License: Apache 2.0
Download-URL: https://github.com/http-aws/http-aws
Description: # httpAWS: a CLI, [cURL](https://curl.haxx.se)-like tool for [AWS](https://aws.amazon.com) services

httpAWS is a command line HTTP client for AWS services. Its goal is to make CLI interaction with AWS web services as
human-friendly as possible. It provides a simple ``httpaws`` command that allows for sending HTTP requests to AWS
services using a simple and natural syntax, and displays colorized output. httpAWS can be used for testing, debugging,
and generally interacting direly with AWS services with HTTP requests.

httpAWS directly makes HTTP calls to AWS service endpoints using the [requests](http://docs.python-requests.org) and
[aws-requests-auth](https://github.com/DavidMuller/aws-requests-auth) modules.

This is a low-level command-line tool intended for use by developers so that they can easily make direct HTTP calls
to AWS services. It is effectively a command-line programmatic replacement for using a graphical tool like
[Postman](https://www.getpostman.com) and was inspired by tools like [HTTPie](https://httpie.org) but is specific to
AWS services.

**WARNING**: *This tool is intended for development and educational purposes*. It is NOT intended for robust and reliable
administration of AWS services. For interaction with production AWS services, it is highly recommended that you use an
officially supported tool specifically designed for that purpose such as any of the following:
- [AWS Console](https://aws.amazon.com/console)
- [AWS CLI](https://aws.amazon.com/cli/)
- [AWS Shell](https://github.com/awslabs/aws-shell)
- [AWS SDK for Python (boto3)](https://aws.amazon.com/sdk-for-python/)

# Main Features
- Expressive and intuitive syntax
- Formatted and colorized terminal output
- Built-in XML support
- Python 2.7 and 3.x support
- Linux, macOS and Windows support

# Installation
A universal installation method (that works on Windows, Mac OS X, Linux, …, and always provides the latest version) is
to use [pip](https://pypi.org/project/pip/):

```sh
# Make sure we have an up-to-date version of pip and setuptools:
$ pip install -U pip setuptools

$ pip install -U httpaws
```

# Usage
Hello World:

```sh
$ httpaws -s ec2 DescribeVpcs
```
The above command calls the **DescribeVpcs** API on the EC2 service using the credentials and default region found in
your *~/.aws* directory.

Synopsis:
```sh
$ httpaws [flags] <API>
```

See also ``httpaws -h`` for detailed help:
```sh
httpaws -h
usage: http_aws [-h] [-r REGION] [-s SERVICE] [-e ENDPOINT] [-c CREDS]
[-v VERSION] [-p] [-w]
api

A command line HTTP client for AWS services with an intuitive UI, XML support
and syntax highlighting.

positional arguments:
api Name of the API to call - e.g. "DescribeVpcs" (for ec2
service)

optional arguments:
-h, --help show this help message and exit
-r REGION, --region REGION
The region to use. Overrides config/env settings.
-s SERVICE, --service SERVICE
AWS service - e.g. ec2, s3, etc.
-e ENDPOINT, --endpoint ENDPOINT
Override command's default URL with the given URL -
e.g. ec2.us-east-1.amazonaws.com
-c CREDS, --creds CREDS
Override AWS Access Key Id and AWS Secret Access Key -
i.e. <Access_Key>:<Secret_Key>
-v VERSION, --version VERSION
API version to use for the service
-p, --paginate Paginate long output
-w, --wrap Wrap long lines in paginated output instead of
chopping them off

See the AWS Documentation for API references for each service:
https://docs.aws.amazon.com
```


Keywords: http cli aws
Platform: any
Classifier: Development Status :: 5 - Production/Stable
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.4
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Environment :: Console
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: System Administrators
Classifier: License :: OSI Approved :: Apache 2.0 License
Classifier: Topic :: Internet :: WWW/HTTP
Classifier: Topic :: Software Development
Classifier: Topic :: System :: Networking
Classifier: Topic :: Terminals
Classifier: Topic :: Text Processing
Classifier: Topic :: Utilities
Requires-Python: >=2.7

Project details


Download files

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

Files for httpaws, version 0.0.1
Filename, size File type Python version Upload date Hashes
Filename, size httpaws-0.0.1-py3-none-any.whl (12.4 kB) File type Wheel Python version py3 Upload date Hashes View
Filename, size httpaws-0.0.1.tar.gz (13.6 kB) File type Source Python version None Upload date Hashes View

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page