amazonka

# [Amazonka]

[![MPL2][license-badge]][license]
[![Hackage][hackage-badge]][hackage]
[![Build][build-badge]][actions]

[license]: https://opensource.org/licenses/MPL-2.0
[actions]: https://github.com/brendanhay/amazonka/actions
[license-badge]: https://img.shields.io/badge/license-MPL%202.0-blue.svg
[build-badge]: https://github.com/brendanhay/amazonka/workflows/build/badge.svg
[hackage]: http://hackage.haskell.org/package/amazonka
[hackage-badge]: https://img.shields.io/hackage/v/amazonka.svg
[amazonka]: https://www.brendanhay.nz/amazonka
[nix]: https://nixos.org/nix/
[nixpkgs]: https://github.com/NixOS/nixpkgs/
[ghc]: https://www.haskell.org/ghc/
[direnv]: https://direnv.net
[direnv wiki]: https://github.com/direnv/direnv/wiki
[botocore]: https://github.com/boto/botocore
[cabal]: https://www.haskell.org/cabal/

An Amazon Web Services SDK for Haskell with support for most public services. Parts of the code contained in this repository are auto-generated and automatically kept up to date with Amazon's latest service APIs.

- You can find the latest Haddock documentation for each respective library on the [Amazonka] website.
- A release changelog can be found in [lib/amazonka/CHANGELOG.md](lib/amazonka/CHANGELOG.md).
- For problems, comments, or feedback please create an issue [here on GitHub](https://github.com/brendanhay/amazonka/issues).

## Table of Contents

* [License](#license)
* [Directory Layout](#directory-layout)
* [Supported Platforms and GHC Versions](#supported-platforms-and-ghc-versions)
* [Getting Started](#getting-started)
* [Building the Project](#building-the-project)
* [Running the Code Generator](#running-the-code-generator)
* [Amazonka as a Git Dependency](#amazonka-as-a-git-dependency)
* [Code Formatting](#code-formatting)
* [Third Party Packages](#third-party-packages)

## License

Amazonka is licensed under the [Mozilla Public License Version 2.0](http://www.mozilla.org/MPL/).

The AWS service descriptions are licensed under Apache 2.0. Source files derived from the service descriptions contain an additional licensing clause in their header.

## Directory Layout

This repository is organised under the following directory structure:

- [`lib/amazonka`](lib/amazonka): The main library containing setup, authentication, and send logic. This will be your primary dependency.
- `lib/service/amazonka-*`: A library per supported Amazon Web Service, you'll need to add a dependency on each selected service library.
- [`lib/amazonka-core`](lib/amazonka-core): The `amazonka-core` library upon which each of the services depends.
- [`lib/amazonka-test`](lib/amazonka-test): Common test functionality.
- [`examples`](examples): Basic examples for using the service libraries.
- [`configs`](configs): Service configuration, templates, and assets used by the code generator.
- [`docs`](docs): The documentation website.
- [`gen`](gen): The code and configuration generators.
- [`scripts`](scripts): Scripts to manage the project, such as the releas