Safe Haskell	Safe-Infered

Aws.Core

Contents

Response
Query
Transactions
Credentials
Service configuration
HTTP types

Synopsis

Response

Metadata in responses

data Response m a Source

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)

tellMetadata :: m -> Response m ()Source

An empty response with some metadata.

tellMetadataRef :: Monoid m => IORef m -> m -> IO ()Source

Add metadata to an IORef (using mappend).

Response data consumers

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

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

class Monoid (ResponseMetadata resp) => ResponseConsumer req resp whereSource

Class for types that AWS HTTP responses can be parsed into.

The request is also passed for possibly required additional metadata.

Note that for debugging, there is an instance for ByteString.

Associated Types

type ResponseMetadata resp Source

Metadata associated with a response. Typically there is one metadata type for each AWS service.

Methods

responseConsumer :: req -> IORef (ResponseMetadata resp) -> HTTPResponseConsumer respSource

Response parser. Takes the corresponding request, an IORef for metadata, and HTTP response data.

Instances

ResponseConsumer r GetBucketResponse
ResponseConsumer r GetServiceResponse
ResponseConsumer r PutBucketResponse
ResponseConsumer r BatchDeleteAttributesResponse
ResponseConsumer r BatchPutAttributesResponse
ResponseConsumer r DeleteAttributesResponse
ResponseConsumer r PutAttributesResponse
ResponseConsumer r GetAttributesResponse
ResponseConsumer r ListDomainsResponse
ResponseConsumer r DomainMetadataResponse
ResponseConsumer r DeleteDomainResponse
ResponseConsumer r CreateDomainResponse
ResponseConsumer r SelectResponse
ResponseConsumer r ChangeMessageVisibilityResponse
ResponseConsumer r ReceiveMessageResponse
ResponseConsumer r DeleteMessageResponse
ResponseConsumer r SendMessageResponse
ResponseConsumer r RemovePermissionResponse
ResponseConsumer r AddPermissionResponse
ResponseConsumer r ListQueuesResponse
ResponseConsumer r DeleteQueueResponse
ResponseConsumer r CreateQueueResponse
ResponseConsumer r SetQueueAttributesResponse
ResponseConsumer r GetQueueAttributesResponse
ResponseConsumer DeleteObject DeleteObjectResponse
ResponseConsumer PutObject PutObjectResponse
ResponseConsumer SendRawEmail SendRawEmailResponse
ResponseConsumer r (Response ByteString)	Does not parse response. For debugging.
ResponseConsumer (GetObject a) (GetObjectResponse a)

Exception types

newtype XmlException Source

An error that occurred during XML parsing / validation.

Constructors

XmlException
Fields xmlErrorMessage :: String

Instances

Show XmlException
Typeable XmlException
Exception XmlException

newtype HeaderException Source

An error that occurred during header parsing / validation.

Constructors

HeaderException
Fields headerErrorMessage :: String

Instances

Show HeaderException
Typeable HeaderException
Exception HeaderException

newtype FormException Source

An error that occurred during form parsing / validation.

Constructors

FormException
Fields formErrorMesage :: String

Instances

Show FormException
Typeable FormException
Exception FormException

Response deconstruction helpers

readHex2 :: [Char] -> Maybe Word8 Source

Parse a two-digit hex number.

XML

elContent :: Text -> Cursor -> [Text]Source

A specific element (case-insensitive, ignoring namespace - sadly necessary), extracting only the textual contents.

elCont :: Text -> Cursor -> [String]Source

Like elContent, but extracts Strings instead of Text.

force :: Failure XmlException m => String -> [a] -> m aSource

Extract the first element from a parser result list, and throw an XmlException if the list is empty.

forceM :: Failure XmlException m => String -> [m a] -> m aSource

Extract the first element from a monadic parser result list, and throw an XmlException if the list is empty.

textReadInt :: (Failure XmlException m, Num a) => Text -> m aSource

Read an integer from a Text, throwing an XmlException on failure.

readInt :: (Failure XmlException m, Num a) => String -> m aSource

Read an integer from a String, throwing an XmlException on failure.

xmlCursorConsumer :: Monoid m => (Cursor -> Response m a) -> IORef m -> HTTPResponseConsumer aSource

Create a complete HTTPResponseConsumer from a simple function that takes a Cursor to XML in the response body.

This function is highly recommended for any services that parse relatively short XML responses. (If status and response headers are required, simply take them as function parameters, and pass them through to this function.)

Query

data SignedQuery Source

A pre-signed medium-level request object.

Constructors

SignedQuery

Fields

sqMethod :: Method: Request method.
sqProtocol :: Protocol: Protocol to be used.
sqHost :: ByteString: HTTP host.
sqPort :: Int: IP port.
sqPath :: ByteString: HTTP path.
sqQuery :: Query: Query string list (used with Get and PostQuery).
sqDate :: Maybe UTCTime: Request date/time.
sqAuthorization :: Maybe ByteString: Authorization string (if applicable), for Authorization header..
sqContentType :: Maybe ByteString: Request body content type.
sqContentMd5 :: Maybe ByteString: Request body content MD5.
sqAmzHeaders :: RequestHeaders: Additional Amazon amz headers.
sqOtherHeaders :: RequestHeaders: Additional non-amz headers.
sqBody :: Maybe (RequestBody (ResourceT IO)): Request body (used with Post and Put).
sqStringToSign :: ByteString: String to sign. Note that the string is already signed, this is passed mostly for debugging purposes.

queryToHttpRequest :: SignedQuery -> Request (ResourceT IO)Source

Create a HTTP request from a SignedQuery object.

queryToUri :: SignedQuery -> ByteString Source

Create a URI fro a SignedQuery object.

Unused / incompatible fields will be silently ignored.

Expiration

data TimeInfo Source

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

data AbsoluteTimeInfo Source

Like TimeInfo, but with all relative times replaced by absolute UTC.

Constructors

AbsoluteTimestamp
Fields fromAbsoluteTimestamp :: UTCTime
AbsoluteExpires
Fields fromAbsoluteExpires :: UTCTime

Instances

Show AbsoluteTimeInfo

fromAbsoluteTimeInfo :: AbsoluteTimeInfo -> UTCTime Source

Just the UTC time value.

makeAbsoluteTimeInfo :: TimeInfo -> UTCTime -> AbsoluteTimeInfo Source

Convert TimeInfo to AbsoluteTimeInfo given the current UTC time.

Signature

data SignatureData Source

Data that is always required for signing requests.

Constructors

SignatureData
Fields signatureTimeInfo :: AbsoluteTimeInfo Expiration or timestamp. signatureTime :: UTCTime Current time. signatureCredentials :: Credentials Access credentials.

signatureData :: TimeInfo -> Credentials -> IO SignatureData Source

Create signature data using the current system time.

class SignQuery r whereSource

A signable request object. Assembles together the Query, and signs it in one go.

Associated Types

type ServiceConfiguration r :: *Source

Additional information, like API endpoints and service-specific preferences.

Methods

signQuery :: r -> ServiceConfiguration r -> SignatureData -> SignedQuery Source

Create a SignedQuery from a request, additional Info, and SignatureData.

Instances

SignQuery DeleteObject	ServiceConfiguration: `S3Configuration`
SignQuery GetBucket	ServiceConfiguration: `S3Configuration`
SignQuery GetService	ServiceConfiguration: `S3Configuration`
SignQuery PutBucket	ServiceConfiguration: `S3Configuration`
SignQuery PutObject	ServiceConfiguration: `S3Configuration`
SignQuery BatchDeleteAttributes	ServiceConfiguration: `SdbConfiguration`
SignQuery BatchPutAttributes	ServiceConfiguration: `SdbConfiguration`
SignQuery DeleteAttributes	ServiceConfiguration: `SdbConfiguration`
SignQuery PutAttributes	ServiceConfiguration: `SdbConfiguration`
SignQuery GetAttributes	ServiceConfiguration: `SdbConfiguration`
SignQuery ListDomains	ServiceConfiguration: `SdbConfiguration`
SignQuery DomainMetadata	ServiceConfiguration: `SdbConfiguration`
SignQuery DeleteDomain	ServiceConfiguration: `SdbConfiguration`
SignQuery CreateDomain	ServiceConfiguration: `SdbConfiguration`
SignQuery Select	ServiceConfiguration: `SdbConfiguration`
SignQuery ChangeMessageVisibility	ServiceConfiguration: `SqsConfiguration`
SignQuery ReceiveMessage	ServiceConfiguration: `SqsConfiguration`
SignQuery DeleteMessage	ServiceConfiguration: `SqsConfiguration`
SignQuery SendMessage	ServiceConfiguration: `SqsConfiguration`
SignQuery RemovePermission	ServiceConfiguration: `SqsConfiguration`
SignQuery AddPermission	ServiceConfiguration: `SqsConfiguration`
SignQuery ListQueues	ServiceConfiguration: `SqsConfiguration`
SignQuery DeleteQueue	ServiceConfiguration: `SqsConfiguration`
SignQuery CreateQueue	ServiceConfiguration: `SqsConfiguration`
SignQuery SetQueueAttributes	ServiceConfiguration: `SqsConfiguration`
SignQuery GetQueueAttributes	ServiceConfiguration: `SqsConfiguration`
SignQuery SendRawEmail	ServiceConfiguration: `SesConfiguration`
SignQuery (GetObject a)	ServiceConfiguration: `S3Configuration`

data AuthorizationHash Source

Supported crypto hashes for the signature.

Constructors

HmacSHA1
HmacSHA256

Instances

Show AuthorizationHash

amzHash :: AuthorizationHash -> ByteString Source

Authorization hash identifier as expected by Amazon.

signature :: Credentials -> AuthorizationHash -> ByteString -> ByteString Source

Create a signature. Usually, AWS wants a specifically constructed string to be signed.

The signature is a HMAC-based hash of the string and the secret access key.

Query construction helpers

queryList :: (a -> [(ByteString, ByteString)]) -> ByteString -> [a] -> [(ByteString, ByteString)]Source

queryList f prefix xs constructs a query list from a list of elements xs, using a common prefix prefix, and a transformer function f.

A dot (.) is interspersed between prefix and generated key.

Example:

queryList swap "pfx" [("a", "b"), ("c", "d")] evaluates to [("pfx.b", "a"), ("pfx.d", "c")] (except with ByteString instead of String, of course).

awsBool :: Bool -> ByteString Source

A "true"/"false" boolean as requested by some services.

awsTrue :: ByteString Source

"true"

awsFalse :: ByteString Source

"false"

fmtTime :: String -> UTCTime -> ByteString Source

Format time according to a format string, as a ByteString.

fmtRfc822Time :: UTCTime -> ByteString Source

Format time in RFC 822 format.

rfc822Time :: String Source

fmtAmzTime :: UTCTime -> ByteString Source

Format time in yyyy-mm-ddThh-mm-ss format.

fmtTimeEpochSeconds :: UTCTime -> ByteString Source

Format time as seconds since the Unix epoch.

Transactions

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

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 Source

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 Source

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

Value: <user directory>/.aws-keys

credentialsDefaultKey :: Text Source

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)Source

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)Source

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)Source

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)Source

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.

Service configuration

class DefaultServiceConfiguration config whereSource

Default configuration for a specific service.

Methods

defaultConfiguration :: configSource

Default service configuration for normal requests.

defaultConfigurationUri :: configSource

Default service configuration for URI-only requests.

debugConfiguration :: configSource

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

debugConfigurationUri :: configSource

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

HTTP types

data Protocol Source

Protocols supported by AWS. Currently, all AWS services use the HTTP or HTTPS protocols.

Constructors

HTTP
HTTPS

Instances

Show Protocol

defaultPort :: Protocol -> Int Source

The default port to be used for a protocol if no specific port is specified.

data Method Source

Request method. Not all request methods are supported by all services.

Constructors

Get	GET method. Put all request parameters in a query string and HTTP headers.
PostQuery	POST method. Put all request parameters in a query string and HTTP headers, but send the query string as a POST payload
Post	POST method. Sends a service- and request-specific request body.
Put	PUT method.
Delete	DELETE method.

Instances

Eq Method
Show Method

httpMethod :: Method -> Method Source

HTTP method associated with a request method.