Aws

Logging

data LogLevel

The severity of a log message, in rising order.

Constructors

Debug

Info

Warning

Error

Instances

Eq LogLevel

Ord LogLevel

Show LogLevel

type Logger = LogLevel -> Text -> IO ()

The interface for any logging function. Takes log level and a log message, and can perform an arbitrary IO action.

defaultLog :: LogLevel -> Logger

The default logger defaultLog minLevel, which prints log messages above level minLevel to stderr.

Configuration

data Configuration

The configuration for an AWS request. You can use multiple configurations in parallel, even over the same HTTP connection manager.

Constructors

Configuration

Fields

timeInfo :: TimeInfo

Whether to restrict the signature validity with a plain timestamp, or with explicit expiration (absolute or relative).

credentials :: Credentials

AWS access credentials.

logger :: Logger

The error / message logger.

baseConfiguration :: MonadIO io => io Configuration

The default configuration, with credentials loaded from environment variable or configuration file (see loadCredentialsDefault).

dbgConfiguration :: MonadIO io => io Configuration

Debug configuration, which avoids using HTTPS for some queries. DO NOT USE THIS IN PRODUCTION!

Transaction runners

Safe runners

aws :: (Transaction r a, MonadIO io) => Configuration -> ServiceConfiguration r -> Manager -> r -> io (Response (ResponseMetadata a) a)

Run an AWS transaction, with HTTP manager and metadata wrapped in a Response.

All errors are caught and wrapped in the Response value.

Usage (with existing Manager): resp <- aws cfg serviceCfg manager request

awsRef :: (Transaction r a, MonadIO io) => Configuration -> ServiceConfiguration r -> Manager -> IORef (ResponseMetadata a) -> r -> io a

Run an AWS transaction, with HTTP manager and metadata returned in an IORef.

Errors are not caught, and need to be handled with exception handlers.

Usage (with existing Manager): ref <- newIORef mempty; resp <- awsRef cfg serviceCfg manager request

simpleAws :: (Transaction r a, MonadIO io) => Configuration -> ServiceConfiguration r -> r -> io (Response (ResponseMetadata a) a)

Run an AWS transaction, without HTTP manager and with metadata wrapped in a Response.

Note that this is potentially less efficient than using aws, because HTTP connections cannot be re-used.

All errors are caught and wrapped in the Response value.

Usage: resp <- simpleAws cfg serviceCfg request

simpleAwsRef :: (Transaction r a, MonadIO io) => Configuration -> ServiceConfiguration r -> IORef (ResponseMetadata a) -> r -> io a

Run an AWS transaction, without HTTP manager and with metadata returned in an IORef.

Errors are not caught, and need to be handled with exception handlers.

Usage: ref <- newIORef mempty; resp <- simpleAwsRef cfg serviceCfg request

Unsafe runners

unsafeAws :: (ResponseConsumer r a, Monoid (ResponseMetadata a), SignQuery r, MonadIO io) => Configuration -> ServiceConfiguration r -> Manager -> r -> io (Response (ResponseMetadata a) a)

Run an AWS transaction, without enforcing that response and request type form a valid transaction pair.

This is especially useful for debugging and development, you should not have to use it in production.

All errors are caught and wrapped in the Response value.

unsafeAwsRef :: (ResponseConsumer r a, Monoid (ResponseMetadata a), SignQuery r, MonadIO io) => Configuration -> ServiceConfiguration r -> Manager -> IORef (ResponseMetadata a) -> r -> io a

Run an AWS transaction, without enforcing that response and request type form a valid transaction pair.

This is especially useful for debugging and development, you should not have to use it in production.

Errors are not caught, and need to be handled with exception handlers.

URI runners

awsUri :: (SignQuery request, MonadIO io) => Configuration -> ServiceConfiguration request -> request -> io ByteString

Run a URI-only AWS transaction. Returns a URI that can be sent anywhere. Does not work with all requests.

Usage: uri <- awsUri cfg request

Response

Full HTTP response

type HTTPResponseConsumer a = Status -> ResponseHeaders -> ResumableSource (ResourceT IO) ByteString -> ResourceT IO a

A full HTTP response parser. Takes HTTP status, response headers, and response body.

Metadata in responses

data Response m a

A response with metadata. Can also contain an error response, or an internal error, via Attempt.

Response forms a Writer-like monad.

Constructors

Response m (Attempt a)

Instances

(Monoid m, Exception e) => Failure e (Response m)

Monoid m => Monad (Response m)

Functor (Response m)

(Show m, Show a) => Show (Response m a)

Exception types

newtype XmlException

An error that occurred during XML parsing / validation.

Constructors

XmlException

Fields

xmlErrorMessage :: String

Instances

Show XmlException

Typeable XmlException

Exception XmlException

newtype HeaderException

An error that occurred during header parsing / validation.

Constructors

HeaderException

Fields

headerErrorMessage :: String

Instances

Show HeaderException

Typeable HeaderException

Exception HeaderException

newtype FormException

An error that occurred during form parsing / validation.

Constructors

FormException

Fields

formErrorMesage :: String

Instances

Show FormException

Typeable FormException

Exception FormException

Query

Service configuration

class DefaultServiceConfiguration config where

Default configuration for a specific service.

Methods

defaultConfiguration :: config

Default service configuration for normal requests.

defaultConfigurationUri :: config

Default service configuration for URI-only requests.

debugConfiguration :: config

Default debugging-only configuration for normal requests. (Normally using HTTP instead of HTTPS for easier debugging.)

debugConfigurationUri :: config

Default debugging-only configuration for URI-only requests. (Normally using HTTP instead of HTTPS for easier debugging.)

Instances

DefaultServiceConfiguration S3Configuration

DefaultServiceConfiguration SdbConfiguration

DefaultServiceConfiguration SqsConfiguration

DefaultServiceConfiguration SesConfiguration

Expiration

data TimeInfo

Whether to restrict the signature validity with a plain timestamp, or with explicit expiration (absolute or relative).

Constructors

Timestamp

Use a simple timestamp to let AWS check the request validity.

ExpiresAt

Let requests expire at a specific fixed time.

Fields

fromExpiresAt :: UTCTime

ExpiresIn

Let requests expire a specific number of seconds after they were generated.

Fields

fromExpiresIn :: NominalDiffTime

Instances

Show TimeInfo

Transactions

class (SignQuery r, ResponseConsumer r a) => Transaction r a | r -> a, a -> r

Associates a request type and a response type in a bi-directional way.

This allows the type-checker to infer the response type when given the request type and vice versa.

Note that the actual request generation and response parsing resides in SignQuery and ResponseConsumer respectively.

Instances

Transaction DeleteObject DeleteObjectResponse

Transaction GetBucket GetBucketResponse

Transaction GetService GetServiceResponse

Transaction PutBucket PutBucketResponse

Transaction PutObject PutObjectResponse

Transaction BatchDeleteAttributes BatchDeleteAttributesResponse

Transaction BatchPutAttributes BatchPutAttributesResponse

Transaction DeleteAttributes DeleteAttributesResponse

Transaction PutAttributes PutAttributesResponse

Transaction GetAttributes GetAttributesResponse

Transaction ListDomains ListDomainsResponse

Transaction DomainMetadata DomainMetadataResponse

Transaction DeleteDomain DeleteDomainResponse

Transaction CreateDomain CreateDomainResponse

Transaction Select SelectResponse

Transaction ChangeMessageVisibility ChangeMessageVisibilityResponse

Transaction ReceiveMessage ReceiveMessageResponse

Transaction DeleteMessage DeleteMessageResponse

Transaction SendMessage SendMessageResponse

Transaction RemovePermission RemovePermissionResponse

Transaction AddPermission AddPermissionResponse

Transaction ListQueues ListQueuesResponse

Transaction DeleteQueue DeleteQueueResponse

Transaction CreateQueue CreateQueueResponse

Transaction SetQueueAttributes SetQueueAttributesResponse

Transaction GetQueueAttributes GetQueueAttributesResponse

Transaction SendRawEmail SendRawEmailResponse

Transaction (GetObject a) (GetObjectResponse a)

Credentials

data Credentials

AWS access credentials.

Constructors

Credentials

Fields

accessKeyID :: ByteString

AWS Access Key ID.

secretAccessKey :: ByteString

AWS Secret Access Key.

Instances

Show Credentials

credentialsDefaultFile :: MonadIO io => io FilePath

The file where access credentials are loaded, when using loadCredentialsDefault.

Value: <user directory>/.aws-keys

credentialsDefaultKey :: Text

The key to be used in the access credential file that is loaded, when using loadCredentialsDefault.

Value: default

loadCredentialsFromFile :: MonadIO io => FilePath -> Text -> io (Maybe Credentials)

Load credentials from a (text) file given a key name.

The file consists of a sequence of lines, each in the following format:

keyName awsKeyID awsKeySecret

loadCredentialsFromEnv :: MonadIO io => io (Maybe Credentials)

Load credentials from the environment variables AWS_ACCESS_KEY_ID and AWS_ACCESS_KEY_SECRET (or AWS_SECRET_ACCESS_KEY), if possible.

loadCredentialsFromEnvOrFile :: MonadIO io => FilePath -> Text -> io (Maybe Credentials)

Load credentials from environment variables if possible, or alternatively from a file with a given key name.

See loadCredentialsFromEnv and loadCredentialsFromFile for details.

loadCredentialsDefault :: MonadIO io => io (Maybe Credentials)

Load credentials from environment variables if possible, or alternative from the default file with the default key name.

Default file: <user directory>/.aws-keys Default key name: default

See loadCredentialsFromEnv and loadCredentialsFromFile for details.