# AWS clients for Elixir

[![Build Status](https://travis-ci.org/aws-beam/aws-elixir.svg?branch=master)](https://travis-ci.org/aws-beam/aws-elixir)

## Features

* Generated by [aws-codegen](https://github.com/aws-beam/aws-codegen) using the
  same JSON descriptions of AWS services used to build the
  [AWS SDK for Go](https://github.com/aws/aws-sdk-go/tree/master/models/apis).
* Support for most AWS services that use `json` and `rest-json` protocols.


## Example

Listing Amazon Kinesis streams. Start a console with `iex -S mix`:

```elixir
iex> client = %AWS.Client{access_key_id: "<access-key-id>",
                     secret_access_key: "<secret-access-key>",
                     region: "us-east-1",
                     endpoint: "amazonaws.com"}

iex> {:ok, result, resp} = AWS.Kinesis.list_streams(client, %{})

iex> IO.inspect result
%{"HasMoreStreams" => false, "StreamNames" => []}
```

## Usage

* Add it as a Mix dependency in the project.

  ```elixir
  def deps do
    [{:aws, "~> 0.5.0"}]
  end
  ```

* Run `mix deps.get` to install.

## Development

Code is generated using the [aws-codegen](https://github.com/aws-beam/aws-codegen)
library from the JSON descriptions of AWS services provided by Amazon.

## Documentation

* Run `MIX_ENV=docs mix docs`
* Open `docs/index.html`

__note:__ Arguments, errors and reponse structure can be found by viewing the model schemas used to generate this module at `aws-sdk-go/models/apis/<aws-service>/<version>/` an example is `aws-sdk-go/models/apis/rekognition/2016-06-27/api-2.json`

## Tests

```
mix test
```

## Release

* Make sure the `CHANGELOG.md` is up-to-date and and reflects the changes for
  the new version.
* Bump the version here in the `README.md` and in `mix.exs`.
* Run `git tag v$VERSION` to tag the version that was just published.
* Run `git push --tags origin master` to push tags to Github.
* Run `mix hex.publish` to publish the new version.

## License

&copy; 2015-2017 Jamshed Kakar <jkakar@kakar.ca>. See `LICENSE` file for
details.