Network.AWS.Free

Defines the core AST, logic and interpreters for AWS behaviour.

Documentation

data Command r where

Constructors

CheckF :: (Bool -> r) -> Command r

DynF :: Dynamic -> (ByteString -> r) -> Command r

MetaF :: Metadata -> (ByteString -> r) -> Command r

UserF :: (Maybe ByteString -> r) -> Command r

SignF :: (AWSPresigner (Sg s), AWSRequest a) => Service s -> UTCTime -> Seconds -> a -> (ClientRequest -> r) -> Command r

SendF :: (AWSSigner (Sg s), AWSRequest a) => Service s -> a -> (Rs a -> r) -> Command r

AwaitF :: (AWSSigner (Sg s), AWSRequest a) => Service s -> Wait a -> a -> (Rs a -> r) -> Command r

Instances

Functor Command

MonadFree Command (AWST m)

send :: (MonadFree Command m, AWSRequest a) => a -> m (Rs a)

Send a request, returning the associated response if successful.

See: sendWith

sendWith

Arguments

:: (MonadFree Command m, AWSSigner (Sg s), AWSRequest a)

=> (Service (Sv a) -> Service s)

Modify the default service configuration.

-> a

Request.

-> m (Rs a)

A variant of send that allows modifying the default Service definition used to configure the request.

paginate :: (MonadFree Command m, AWSPager a) => a -> Source m (Rs a)

Repeatedly send a request, automatically setting markers and paginating over multiple responses while available.

See: paginateWith

paginateWith

Arguments

:: (MonadFree Command m, AWSSigner (Sg s), AWSPager a)

=> (Service (Sv a) -> Service s)

Modify the default service configuration.

-> a

Initial request.

-> Source m (Rs a)

A variant of paginate that allows modifying the default Service definition used to configure the request.

await :: (MonadFree Command m, AWSRequest a) => Wait a -> a -> m (Rs a)

Poll the API with the supplied request until a specific Wait condition is fulfilled.

See: awaitWith

awaitWith

Arguments

:: (MonadFree Command m, AWSSigner (Sg s), AWSRequest a)

=> (Service (Sv a) -> Service s)

Modify the default service configuration.

-> Wait a

Polling, error and acceptance criteria.

-> a

Request to poll with.

-> m (Rs a)

A variant of await that allows modifying the default Service definition used to configure the request.

presignURL

Arguments

:: (MonadFree Command m, AWSPresigner (Sg (Sv a)), AWSRequest a)

=> UTCTime

Signing time.

-> Seconds

Expiry time.

-> a

Request to presign.

-> m ByteString

Presign an URL that is valid from the specified time until the number of seconds expiry has elapsed.

See: presign, presignWith

presign

Arguments

:: (MonadFree Command m, AWSPresigner (Sg (Sv a)), AWSRequest a)

=> UTCTime

Signing time.

-> Seconds

Expiry time.

-> a

Request to presign.

-> m ClientRequest

Presign an HTTP request that is valid from the specified time until the number of seconds expiry has elapsed.

See: presignWith

presignWith

Arguments

:: (MonadFree Command m, AWSPresigner (Sg s), AWSRequest a)

=> (Service (Sv a) -> Service s)

Function to modify the service configuration.

-> UTCTime

Signing time.

-> Seconds

Expiry time.

-> a

Request to presign.

-> m ClientRequest

A variant of presign that allows specifying the Service definition used to configure the request.

isEC2 :: MonadFree Command m => m Bool

Test whether the underlying host is running on EC2. For IO based interpretations of MonadFree Command, this is memoised and any external check occurs for the first call only.

dynamic :: MonadFree Command m => Dynamic -> m ByteString

Retrieve the specified Dynamic data.

metadata :: MonadFree Command m => Metadata -> m ByteString

Retrieve the specified Metadata.

userdata :: MonadFree Command m => m (Maybe ByteString)

Retrieve the user data. Returns Nothing if no user data is assigned to the instance.