codygman / amazonka

A comprehensive Amazon Web Services SDK for Haskell.

Amazonka

• Description
• Documentation
• Organisation
• Change Log
• Contribute
  • Package Names
• Licence

Description

A comprehensive Amazon Web Services SDK for Haskell supporting all of the publicly available services.

Parts of the code contained in this repository are auto-generated and automatically kept up to date with Amazon's latest service APIs.

An introductory blog post detailing some of the motivation and design decisions can be found here.

Documentation

You can find the latest stable release documentation for each respective library on Hackage under the AWS section.

Organisation

This repository is organised into the following directory structure:

• amazonka: Actual operational logic, you'll need to import this to send requests etc.
• amazonka-*: Data types for each of the individual Amazon Web Service libraries.
• amazonka-*/test: Tests and fixtures for each respective library.
• core: The amazonka-core library upon which each of the services depends.
• examples: A currently sparse collection of examples for the various services.
• gen: The code generation binary, along with configuration, templates, and assets.
• scripts: CI scripts to manage the release lifecycle of the service libraries.
• share: Makefile plumbing common to all service libraries
• test: The amazonka-test library containing common test functionality.

Change Log

A change log for the entire project can be found under amazonka/CHANGELOG.md.

Contribute

For any problems, comments, or feedback please create an issue here on GitHub.

Package Naming

It is often desirable to provide supplemental functionality to amazonka as an additional library, for example providing S3 encryption via a package such as amazonka-s3-encryption.

I ask that authors of these packages carefully consider package naming and preferably do not prefix the package with amazonka-* to avoid potential collisions with generated package names.

Licence

Amazonka is released under the Mozilla Public License Version 2.0.

Parts of the code are derived from AWS service descriptions, licensed under Apache 2.0. Source files subject to this contain an additional licensing clause in their header.