danfilip / aws-codegen Goto Github PK

Code generator for Elixir and Erlang AWS client.

The code generator uses specs from the AWS SDK for the Go programming language to generate code.

Code is generated by running the generate.exs script. It requires Elixir 1.8.4+.

export SPEC_PATH=../../aws/aws-sdk-go/models/apis
export TEMPLATE_PATH=priv
export ELIXIR_OUTPUT_PATH=../aws-elixir/lib/aws/generated
mix run generate.exs elixir $SPEC_PATH $TEMPLATE_PATH $ELIXIR_OUTPUT_PATH

export SPEC_PATH=../../aws/aws-sdk-go/models/apis
export TEMPLATE_PATH=priv
export ERLANG_OUTPUT_PATH=../aws-erlang/src
mix run generate.exs erlang $SPEC_PATH $TEMPLATE_PATH $ERLANG_OUTPUT_PATH

Each AWS API uses a specific protocol which is defined in its specification JSON file in the aws-sdk-go repository. The existing protocols are:

• json
• rest-json
• query
• rest-xml

Every one of these protocols uses HTTP in an asynchronous (request & response) fashion. They mostly differ in what Content-Type they use for the request body, whether they include parameters in the URL or in the headers, and what Content-Type should one expect in the response body.

The following table attempts to capture the specifics of each protocol:

This project has some dependencies you need to install before installing packages with Hex. Here you can find instructions for Ubuntu Linux and Mac OS.

Two packages are needed for Ubuntu: gcc and build-essential. To install them:

$ apt-get install build-essential cmake

Two similar packages are needed in OS X, but you may install them with brew:

$ brew install gcc cmake

Alternatively you can install XCode's Command Line Developer Tools package:

$ xcode-select --install