Safe Haskell	None
Language	Haskell2010

AWS.Lambda.RuntimeAPI

Contents

Entry points
- Mocks
Requests and response
Time remaining
JSON responses

Description

Based on the logic as implemented in https://github.com/awslabs/aws-lambda-cpp

Synopsis

defaultMain :: (Request -> IO Response) -> IO ()
jsonMain :: (FromJSON a, ToJSON b) => (GenRequest a -> IO b) -> IO ()
autoMockMain :: Mock -> (Request -> IO Response) -> IO ()
autoMockJsonMain :: (FromJSON a, ToJSON b) => GenMock a -> (GenRequest a -> IO b) -> IO ()
type Mock = GenMock ByteString
data GenMock a = Mock {
- mockRequest :: IO (GenRequest a)
- mockResponse :: Response -> IO ()
}
makeMockRequest :: a -> Int64 -> IO (GenRequest a)
type Request = GenRequest ByteString
data Response
- = SuccessResponse !MediaType !ByteString
- | FailureResponse !Text !Text
data GenRequest a = Request {
- requestPayload :: !a
- requestId :: !RequestId
- requestXRayTraceId :: !ByteString
- requestClientContext :: !ByteString
- requestCognitoIdentity :: !ByteString
- requestARN :: !ByteString
- requestDeadline :: !Deadline
}
data RequestId
getTimeRemaining :: GenRequest a -> IO Int64
jsonResponse :: ToJSON a => a -> Response
jsonMediaType :: MediaType

Entry points

defaultMain :: (Request -> IO Response) -> IO () Source #

Default main to implement AWS Lambda using Runtime API

jsonMain :: (FromJSON a, ToJSON b) => (GenRequest a -> IO b) -> IO () Source #

Like defaultMain but work with JSON

Mocks

autoMockMain :: Mock -> (Request -> IO Response) -> IO () Source #

Check the existence of AWS_LAMBDA_RUNTIME_API environment variable.

If it exists, assume we are running in AWS Lambda environment, i.e. run normally. Otherwise use supplied MockOptions

autoMockJsonMain :: (FromJSON a, ToJSON b) => GenMock a -> (GenRequest a -> IO b) -> IO () Source #

Like autoMockMain but works with JSON

type Mock = GenMock ByteString Source #

data GenMock a Source #

How to mock the Request, what to do with the Response.

Constructors

Mock
Fields mockRequest :: IO (GenRequest a) mockResponse :: Response -> IO ()

makeMockRequest Source #

Arguments

:: a	payload value
-> Int64	request duration (in milliseconds)
-> IO (GenRequest a)

Create Mock request

Requests and response

type Request = GenRequest ByteString Source #

Request with ByteString payload

data Response Source #

Constructors

SuccessResponse !MediaType !ByteString
FailureResponse !Text !Text	error type, error message

Instances

Show Response Source #
Instance details Defined in AWS.Lambda.RuntimeAPI Methods showsPrec :: Int -> Response -> ShowS # show :: Response -> String # showList :: [Response] -> ShowS #
NFData Response Source #
Instance details Defined in AWS.Lambda.RuntimeAPI Methods rnf :: Response -> () #

data GenRequest a Source #

Constructors

Request

Fields

requestPayload :: !a
The user's payload represented (originally) as a UTF-8 string.
requestId :: !RequestId
And identifier unique to the current invocation.
requestXRayTraceId :: !ByteString
X-Ray tracigng of the current invocation.
requestClientContext :: !ByteString
Information about the client application and device when invoked through the AWS Mobile SDK.
requestCognitoIdentity :: !ByteString
Information about the Amazon Cognito identity provider when invoked through the AWS Mobile SDK.
requestARN :: !ByteString
The ARN requested. This can be different in each invoke that executes the same version.
requestDeadline :: !Deadline
Function execution deadline counted in milliseconds since the Unix epoch.

Instances

Functor GenRequest Source #
Instance details Defined in AWS.Lambda.RuntimeAPI Methods fmap :: (a -> b) -> GenRequest a -> GenRequest b # (<$) :: a -> GenRequest b -> GenRequest a #
Foldable GenRequest Source #
Instance details Defined in AWS.Lambda.RuntimeAPI Methods fold :: Monoid m => GenRequest m -> m # foldMap :: Monoid m => (a -> m) -> GenRequest a -> m # foldr :: (a -> b -> b) -> b -> GenRequest a -> b # foldr' :: (a -> b -> b) -> b -> GenRequest a -> b # foldl :: (b -> a -> b) -> b -> GenRequest a -> b # foldl' :: (b -> a -> b) -> b -> GenRequest a -> b # foldr1 :: (a -> a -> a) -> GenRequest a -> a # foldl1 :: (a -> a -> a) -> GenRequest a -> a # toList :: GenRequest a -> [a] # null :: GenRequest a -> Bool # length :: GenRequest a -> Int # elem :: Eq a => a -> GenRequest a -> Bool # maximum :: Ord a => GenRequest a -> a # minimum :: Ord a => GenRequest a -> a # sum :: Num a => GenRequest a -> a # product :: Num a => GenRequest a -> a #
Traversable GenRequest Source #
Instance details Defined in AWS.Lambda.RuntimeAPI Methods traverse :: Applicative f => (a -> f b) -> GenRequest a -> f (GenRequest b) # sequenceA :: Applicative f => GenRequest (f a) -> f (GenRequest a) # mapM :: Monad m => (a -> m b) -> GenRequest a -> m (GenRequest b) # sequence :: Monad m => GenRequest (m a) -> m (GenRequest a) #
Show a => Show (GenRequest a) Source #
Instance details Defined in AWS.Lambda.RuntimeAPI Methods showsPrec :: Int -> GenRequest a -> ShowS # show :: GenRequest a -> String # showList :: [GenRequest a] -> ShowS #

data RequestId Source #

Opaque request id

Instances

Show RequestId Source #
Instance details Defined in AWS.Lambda.RuntimeAPI Methods showsPrec :: Int -> RequestId -> ShowS # show :: RequestId -> String # showList :: [RequestId] -> ShowS #

Time remaining

getTimeRemaining :: GenRequest a -> IO Int64 Source #

Get time remaining (milliseconds).

JSON responses

jsonResponse :: ToJSON a => a -> Response Source #

Create JSON response.

jsonMediaType :: MediaType Source #