redavis22 / awscurl

Curl like simplicity to access AWS resources with AWS Signature Version 4 request signing.

awscurl

Curl like tool with AWS Signature Version 4 request signing.

Features

• performes requests to AWS services with requests signing using curl interface
• supports IAM profile credentials

Overview

Requests to AWS API must be signed (see Signing AWS API Requests) automates the process of signing and allows to make requests to AWS as simple as standard curl command.

Installation

$ pip install awscurl

Installation from source (bleeding edge)

$ pip install git+https://github.com/okigan/awscurl

Installation via Homebrew for MacOS

$ brew install awscurl

Installation via Docker

Assumes Docker is installed and the working directory is project root of the cloned repo. Result will be an image named $USER/awscurl.

$ docker build --rm -t $USER/awscurl .

On OS X run via a shell script in your $PATH or directly with something like the following:

#!/bin/bash

export AWS_DIR="${AWS_DIR:-$HOME/.aws}"
mkdir -p $AWS_DIR

docker run --rm -it -v "$AWS_DIR:/root/.aws" "$USER/awscurl:latest" "$@"

Examples

• Call S3: List bucket content

  $ awscurl --service s3 https://awscurl-sample-bucket.s3.amazonaws.com

• Call EC2:

  $ awscurl --service ec2 'https://ec2.amazonaws.com?Action=DescribeRegions&Version=2013-10-15'

• Call API Gateway:

  $ awscurl --service execute-api -X POST -d @request.json \
    https://<prefix>.execute-api.us-east-1.amazonaws.com/<resource>

Options

usage: awscurl [-h] [-v] [-i] [-X REQUEST] [-d DATA] [-H HEADER]
                  [--region REGION] [--service SERVICE]
                  [--profile AWS_PROFILE]
                  [--access_key ACCESS_KEY] [--secret_key SECRET_KEY]
                  [--security_token SECURITY_TOKEN]
                  uri

Curl AWS request signing If an arg is specified in more than one place, then
command-line values override environment variables which override defaults.

positional arguments:
  uri

optional arguments:
  -h, --help            show this help message and exit
  -v, --verbose         verbose flag (default: False)
  -i, --include         include headers in response (default: False)
  -X REQUEST, --request REQUEST
                        Specify request command to use (default: GET)
  -d DATA, --data DATA  HTTP POST data (default: )
  -H HEADER, --header HEADER
                        HTTP POST data (default: None)
  --region REGION       AWS region (default: us-east-1)
  --profile PROFILE     [env var: AWS_PROFILE] (default: default)
  --service SERVICE     AWS service (default: execute-api)
  --access_key ACCESS_KEY
                        [env var: AWS_ACCESS_KEY_ID] (default: None)
  --secret_key SECRET_KEY
                        [env var: AWS_SECRET_ACCESS_KEY] (default: None)
  --security_token SECURITY_TOKEN
                        [env var: AWS_SECURITY_TOKEN] (default: None)

If you do not specify the --access_key or --secret_key (or environment variables), awscurl will attempt to use the credentials you set in ~/.aws/credentials. If you do not specify a --profile or AWS_PROFILE, awscurl uses default.

Who uses awscurl

• AWS Documentation
• Onica blog

Related projects

• awscurl in Go: https://github.com/allthings/awscurl
• awscurl in List: https://github.com/aw/picolisp-awscurl

Last but not least

• Sponsor awscurl