Packages

aws

0.0.8
1.0.14 1.0.13 1.0.12 1.0.11 1.0.10 1.0.9 1.0.8 1.0.7 1.0.6 1.0.5 1.0.4 1.0.3 1.0.2 1.0.1 1.0.0 0.14.1 0.14.0 0.13.3 0.13.2 0.13.1 0.13.0 0.12.0 0.11.0 0.10.1 0.10.0 0.9.2 0.9.1 0.9.0 0.8.0 0.7.0 0.6.0 0.5.0 0.4.0 0.3.0 0.2.0 0.1.0 0.0.12 0.0.11 0.0.10 0.0.9 0.0.8 0.0.7 0.0.6 0.0.5 0.0.4 0.0.3 0.0.2 0.0.1

AWS clients for Elixir

HexDocs

Current section

Files

Jump to
Readme
48 Versions
3 Dependencies
Dependants
Files
Activity
aws README.md
Raw

README.md 

# AWS SDK for Elixir



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



## Features



* Generated using the same JSON descriptions of AWS services used to build

  the [AWS SDK for Go](https://github.com/awslabs/aws-sdk-go/tree/master/apis).

* Supports AWS services that use `json` and `rest-json` protocols.



## Example



Listing Amazon Kinesis streams



```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.0.8"}]

  end

  ```



* Run `mix deps.get` to install.





## Development



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



## Documentation



* Run `MIX_ENV=docs mix docs`

* Open `docs/index.html`



## 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 $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.

* Run `mix hex.docs` to publish the documentation.



## License



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