The aws
package attempts to provide support for using Amazon Web
Services like S3 (storage), SQS (queuing) and others to Haskell
programmers. The ultimate goal is to support all Amazon Web Services.
Make sure you have a recent GHC installed, as well as cabal-install, and installation should be as easy as:
$ cabal install aws
If you prefer to install from source yourself, you should first get a
clone of the aws
repository, and install it from inside the source
directory:
$ git clone https://github.com/aristidb/aws.git
$ cd aws
$ cabal install
The aws package is organised into the general Aws
module namespace,
and subnamespaces like Aws.S3
for each Amazon Web Service. Under each
service namespace in turn, there are general support modules and and
Aws.<Service>.Commands.<Command>
module for each command. For easier
usage, there are the "bundling" modules Aws
(general support), and
Aws.<Service>
.
The primary concept in aws is the Transaction, which corresponds to a
single HTTP request to the Amazon Web Services. A transaction consists
of a request and a response, which are associated together via the
Transaction
typeclass. Requests and responses are simple Haskell
records, but for some requests there are convenience functions to fill
in default values for many parameters.
To be able to access AWS resources, you should put your into a
configuration file. (You don't have to store it in a file, but that's
how we do it in this example.) Save the following in $HOME/.aws-keys
.
default AccessKeyID SecretKey
You do have to replace AccessKeyID and SecretKey with the Access Key ID and the Secret Key respectively, of course.
Then, copy this example into a Haskell file, and run it with runghc
(after installing aws):
{-# LANGUAGE OverloadedStrings #-}
import qualified Aws
import qualified Aws.S3 as S3
import Control.Monad.Trans.Resource
import Data.Conduit ((.|), runConduit)
import Data.Conduit.Binary (sinkFile)
import Network.HTTP.Conduit (newManager, tlsManagerSettings, responseBody)
main :: IO ()
main = do
{- Set up AWS credentials and the default configuration. -}
cfg <- Aws.baseConfiguration
let s3cfg = Aws.defServiceConfig :: S3.S3Configuration Aws.NormalQuery
{- Set up a ResourceT region with an available HTTP manager. -}
mgr <- newManager tlsManagerSettings
runResourceT $ do
{- Create a request object with S3.getObject and run the request with pureAws. -}
S3.GetObjectResponse { S3.gorResponse = rsp } <-
Aws.pureAws cfg s3cfg mgr $
S3.getObject "haskell-aws" "cloud-remote.pdf"
{- Save the response to a file. -}
runConduit $ responseBody rsp .| sinkFile "cloud-remote.pdf"
You can also find this example in the source distribution in the
Examples/
folder.
-
I get an error when I try to access my bucket with upper-case characters / a very long name.
Those names are not compliant with DNS. You need to use path-style requests, by setting
s3RequestStyle
in the configuration toPathStyle
. Note that such bucket names are only allowed in the US standard region, so your endpoint needs to be US standard.
See CHANGELOG
- aws on Github
- aws on Hackage (includes reference documentation)
- Official Amazon Web Services website
Name | Github | Company | Components | |
---|---|---|---|---|
Abhinav Gupta | abhinav | [email protected] | - | IAM, SES |
Aristid Breitkreuz | aristidb | [email protected] | - | Co-Maintainer |
Bas van Dijk | basvandijk | [email protected] | Erudify AG | S3 |
David Vollbracht | qxjit | |||
Felipe Lessa | meteficha | [email protected] | currently secret | Core, S3, SES |
Nathan Howell | NathanHowell | [email protected] | Alpha Heavy Industries | S3 |
Ozgun Ataman | ozataman | [email protected] | Soostone Inc | Core, S3, DynamoDb |
Steve Severance | sseveran | [email protected] | Alpha Heavy Industries | S3, SQS |
John Wiegley | jwiegley | [email protected] | FP Complete | S3 |
Chris Dornan | cdornan | [email protected] | Iris Connect | Core |
John Lenz | wuzzeb | DynamoDB, Core | ||
Joey Hess | joeyh | [email protected] | - | Co-Maintainer, S3 |