AWSLambda.Events.APIGateway

Based on https://github.com/aws/aws-lambda-dotnet/tree/master/Libraries/src/Amazon.Lambda.APIGatewayEvents

To enable processing of API Gateway events, use the events key in serverless.yml as usual:

functions:
  myapifunc:
    handler: mypackage.mypackage-exe
    events:
      - http:
          path: hello/{name}
          method: get

Then use apiGatewayMain in the handler to process the requests.

Documentation

type Method = Text

type HeaderName = Text

type HeaderValue = Text

type QueryParamName = Text

type QueryParamValue = Text

type PathParamName = Text

type PathParamValue = Text

type StageVarName = Text

type StageVarValue = Text

data RequestIdentity

Constructors

RequestIdentity

Fields

• _riCognitoIdentityPoolId :: !(Maybe Text)
• _riAccountId :: !(Maybe Text)
• _riCognitoIdentityId :: !(Maybe Text)
• _riCaller :: !(Maybe Text)
• _riApiKey :: !(Maybe Text)
• _riSourceIp :: !(Maybe IP)
• _riCognitoAuthenticationType :: !(Maybe Text)
• _riCognitoAuthenticationProvider :: !(Maybe Text)
• _riUserArn :: !(Maybe Text)
• _riUserAgent :: !(Maybe Text)
• _riUser :: !(Maybe Text)

Instances

Eq RequestIdentity

Defined in AWSLambda.Events.APIGateway

Methods

(==) :: RequestIdentity -> RequestIdentity -> Bool

(/=) :: RequestIdentity -> RequestIdentity -> Bool

Show RequestIdentity

Defined in AWSLambda.Events.APIGateway

Methods

showsPrec :: Int -> RequestIdentity -> ShowS

show :: RequestIdentity -> String

showList :: [RequestIdentity] -> ShowS

FromJSON RequestIdentity

Defined in AWSLambda.Events.APIGateway

Methods

parseJSON :: Value -> Parser RequestIdentity

parseJSONList :: Value -> Parser [RequestIdentity]

readParse :: Read a => String -> Text -> Parser a

riUserArn :: Lens' RequestIdentity (Maybe Text)

riUserAgent :: Lens' RequestIdentity (Maybe Text)

riUser :: Lens' RequestIdentity (Maybe Text)

riSourceIp :: Lens' RequestIdentity (Maybe IP)

riCognitoIdentityPoolId :: Lens' RequestIdentity (Maybe Text)

riCognitoIdentityId :: Lens' RequestIdentity (Maybe Text)

riCognitoAuthenticationType :: Lens' RequestIdentity (Maybe Text)

riCognitoAuthenticationProvider :: Lens' RequestIdentity (Maybe Text)

riCaller :: Lens' RequestIdentity (Maybe Text)

riApiKey :: Lens' RequestIdentity (Maybe Text)

riAccountId :: Lens' RequestIdentity (Maybe Text)

data Authorizer

Constructors

Authorizer

Fields

• _aPrincipalId :: !(Maybe Text)
• _aClaims :: !Object
• _aContext :: !Object

Instances

Eq Authorizer

Defined in AWSLambda.Events.APIGateway

Methods

(==) :: Authorizer -> Authorizer -> Bool

(/=) :: Authorizer -> Authorizer -> Bool

Show Authorizer

Defined in AWSLambda.Events.APIGateway

Methods

showsPrec :: Int -> Authorizer -> ShowS

show :: Authorizer -> String

showList :: [Authorizer] -> ShowS

FromJSON Authorizer

Defined in AWSLambda.Events.APIGateway

Methods

parseJSON :: Value -> Parser Authorizer

parseJSONList :: Value -> Parser [Authorizer]

aPrincipalId :: Lens' Authorizer (Maybe Text)

aContext :: Lens' Authorizer Object

aClaims :: Lens' Authorizer Object

data ProxyRequestContext

Constructors

ProxyRequestContext

Fields

• _prcPath :: !(Maybe Text)
• _prcAccountId :: !Text
• _prcResourceId :: !Text
• _prcStage :: !Text
• _prcRequestId :: !Text
• _prcIdentity :: !RequestIdentity
• _prcResourcePath :: !Text
• _prcHttpMethod :: !Text
• _prcApiId :: !Text
• _prcProtocol :: !Text
• _prcAuthorizer :: !(Maybe Authorizer)

Instances

Eq ProxyRequestContext

Defined in AWSLambda.Events.APIGateway

Methods

(==) :: ProxyRequestContext -> ProxyRequestContext -> Bool

(/=) :: ProxyRequestContext -> ProxyRequestContext -> Bool

Show ProxyRequestContext

Defined in AWSLambda.Events.APIGateway

Methods

showsPrec :: Int -> ProxyRequestContext -> ShowS

show :: ProxyRequestContext -> String

showList :: [ProxyRequestContext] -> ShowS

FromJSON ProxyRequestContext

Defined in AWSLambda.Events.APIGateway

Methods

parseJSON :: Value -> Parser ProxyRequestContext

parseJSONList :: Value -> Parser [ProxyRequestContext]

prcStage :: Lens' ProxyRequestContext Text

prcResourcePath :: Lens' ProxyRequestContext Text

prcResourceId :: Lens' ProxyRequestContext Text

prcRequestId :: Lens' ProxyRequestContext Text

prcProtocol :: Lens' ProxyRequestContext Text

prcPath :: Lens' ProxyRequestContext (Maybe Text)

prcIdentity :: Lens' ProxyRequestContext RequestIdentity

prcHttpMethod :: Lens' ProxyRequestContext Text

prcAuthorizer :: Lens' ProxyRequestContext (Maybe Authorizer)

prcApiId :: Lens' ProxyRequestContext Text

prcAccountId :: Lens' ProxyRequestContext Text

data APIGatewayProxyRequest body

Constructors

APIGatewayProxyRequest

Fields

• _agprqResource :: !Text
• _agprqPath :: !ByteString
• _agprqHttpMethod :: !Method
• _agprqHeaders :: !RequestHeaders
• _agprqQueryStringParameters :: !Query
• _agprqPathParameters :: !(HashMap PathParamName PathParamValue)
• _agprqStageVariables :: !(HashMap StageVarName StageVarValue)
• _agprqRequestContext :: !ProxyRequestContext
• _agprqBody :: !(Maybe (TextValue body))

Instances

Eq body => Eq (APIGatewayProxyRequest body)

Defined in AWSLambda.Events.APIGateway

Methods

(==) :: APIGatewayProxyRequest body -> APIGatewayProxyRequest body -> Bool

(/=) :: APIGatewayProxyRequest body -> APIGatewayProxyRequest body -> Bool

Show body => Show (APIGatewayProxyRequest body)

Defined in AWSLambda.Events.APIGateway

Methods

showsPrec :: Int -> APIGatewayProxyRequest body -> ShowS

show :: APIGatewayProxyRequest body -> String

showList :: [APIGatewayProxyRequest body] -> ShowS

Generic (APIGatewayProxyRequest body)

Defined in AWSLambda.Events.APIGateway

Associated Types

type Rep (APIGatewayProxyRequest body) :: Type -> Type

Methods

from :: APIGatewayProxyRequest body -> Rep (APIGatewayProxyRequest body) x

to :: Rep (APIGatewayProxyRequest body) x -> APIGatewayProxyRequest body

FromText body => FromJSON (APIGatewayProxyRequest body)

Defined in AWSLambda.Events.APIGateway

Methods

parseJSON :: Value -> Parser (APIGatewayProxyRequest body)

parseJSONList :: Value -> Parser [APIGatewayProxyRequest body]

type Rep (APIGatewayProxyRequest body)

Defined in AWSLambda.Events.APIGateway

type Rep (APIGatewayProxyRequest body) = D1 ('MetaData "APIGatewayProxyRequest" "AWSLambda.Events.APIGateway" "serverless-haskell-0.12.6-IEWArt6KubHEPMr0lSwjcY" 'False) (C1 ('MetaCons "APIGatewayProxyRequest" 'PrefixI 'True) (((S1 ('MetaSel ('Just "_agprqResource") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "_agprqPath") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 ByteString)) :*: (S1 ('MetaSel ('Just "_agprqHttpMethod") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Method) :*: S1 ('MetaSel ('Just "_agprqHeaders") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 RequestHeaders))) :*: ((S1 ('MetaSel ('Just "_agprqQueryStringParameters") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Query) :*: S1 ('MetaSel ('Just "_agprqPathParameters") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (HashMap PathParamName PathParamValue))) :*: (S1 ('MetaSel ('Just "_agprqStageVariables") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (HashMap StageVarName StageVarValue)) :*: (S1 ('MetaSel ('Just "_agprqRequestContext") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 ProxyRequestContext) :*: S1 ('MetaSel ('Just "_agprqBody") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (Maybe (TextValue body))))))))

agprqStageVariables :: forall body. Lens' (APIGatewayProxyRequest body) (HashMap StageVarName StageVarValue)

agprqResource :: forall body. Lens' (APIGatewayProxyRequest body) Text

agprqRequestContext :: forall body. Lens' (APIGatewayProxyRequest body) ProxyRequestContext

agprqQueryStringParameters :: forall body. Lens' (APIGatewayProxyRequest body) Query

agprqPathParameters :: forall body. Lens' (APIGatewayProxyRequest body) (HashMap PathParamName PathParamValue)

agprqPath :: forall body. Lens' (APIGatewayProxyRequest body) ByteString

agprqHttpMethod :: forall body. Lens' (APIGatewayProxyRequest body) Method

agprqHeaders :: forall body. Lens' (APIGatewayProxyRequest body) RequestHeaders

agprqBody :: forall body body. Lens (APIGatewayProxyRequest body) (APIGatewayProxyRequest body) (Maybe (TextValue body)) (Maybe (TextValue body))

requestBody :: Getter (APIGatewayProxyRequest body) (Maybe body)

Get the request body, if there is one

requestBodyEmbedded :: Getter (APIGatewayProxyRequest (Embedded v)) (Maybe v)

Get the embedded request body, if there is one

requestBodyBinary :: Getter (APIGatewayProxyRequest Base64) (Maybe ByteString)

Get the binary (decoded Base64) request body, if there is one

data APIGatewayProxyResponse body

Constructors

APIGatewayProxyResponse

Fields

• _agprsStatusCode :: !Int
• _agprsHeaders :: !ResponseHeaders
• _agprsBody :: !(Maybe (TextValue body))

Instances

Eq body => Eq (APIGatewayProxyResponse body)

Defined in AWSLambda.Events.APIGateway

Methods

(==) :: APIGatewayProxyResponse body -> APIGatewayProxyResponse body -> Bool

(/=) :: APIGatewayProxyResponse body -> APIGatewayProxyResponse body -> Bool

Show body => Show (APIGatewayProxyResponse body)

Defined in AWSLambda.Events.APIGateway

Methods

showsPrec :: Int -> APIGatewayProxyResponse body -> ShowS

show :: APIGatewayProxyResponse body -> String

showList :: [APIGatewayProxyResponse body] -> ShowS

Generic (APIGatewayProxyResponse body)

Defined in AWSLambda.Events.APIGateway

Associated Types

type Rep (APIGatewayProxyResponse body) :: Type -> Type

Methods

from :: APIGatewayProxyResponse body -> Rep (APIGatewayProxyResponse body) x

to :: Rep (APIGatewayProxyResponse body) x -> APIGatewayProxyResponse body

ToText body => ToJSON (APIGatewayProxyResponse body)

Defined in AWSLambda.Events.APIGateway

Methods

toJSON :: APIGatewayProxyResponse body -> Value

toEncoding :: APIGatewayProxyResponse body -> Encoding

toJSONList :: [APIGatewayProxyResponse body] -> Value

toEncodingList :: [APIGatewayProxyResponse body] -> Encoding

FromText body => FromJSON (APIGatewayProxyResponse body)

Defined in AWSLambda.Events.APIGateway

Methods

parseJSON :: Value -> Parser (APIGatewayProxyResponse body)

parseJSONList :: Value -> Parser [APIGatewayProxyResponse body]

type Rep (APIGatewayProxyResponse body)

Defined in AWSLambda.Events.APIGateway

type Rep (APIGatewayProxyResponse body) = D1 ('MetaData "APIGatewayProxyResponse" "AWSLambda.Events.APIGateway" "serverless-haskell-0.12.6-IEWArt6KubHEPMr0lSwjcY" 'False) (C1 ('MetaCons "APIGatewayProxyResponse" 'PrefixI 'True) (S1 ('MetaSel ('Just "_agprsStatusCode") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Int) :*: (S1 ('MetaSel ('Just "_agprsHeaders") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 ResponseHeaders) :*: S1 ('MetaSel ('Just "_agprsBody") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (Maybe (TextValue body))))))

agprsStatusCode :: forall body. Lens' (APIGatewayProxyResponse body) Int

agprsHeaders :: forall body. Lens' (APIGatewayProxyResponse body) ResponseHeaders

agprsBody :: forall body body. Lens (APIGatewayProxyResponse body) (APIGatewayProxyResponse body) (Maybe (TextValue body)) (Maybe (TextValue body))

response :: Int -> APIGatewayProxyResponse body

responseOK :: APIGatewayProxyResponse body

responseNotFound :: APIGatewayProxyResponse body

responseBadRequest :: APIGatewayProxyResponse body

responseBody :: Setter' (APIGatewayProxyResponse body) (Maybe body)

responseBodyEmbedded :: Setter' (APIGatewayProxyResponse (Embedded body)) (Maybe body)

responseBodyBinary :: Setter' (APIGatewayProxyResponse Base64) (Maybe ByteString)

apiGatewayMain

Arguments

:: (FromText reqBody, ToText resBody)

=> (APIGatewayProxyRequest reqBody -> IO (APIGatewayProxyResponse resBody))

Function to process the event

-> IO ()

Process incoming events from serverless-haskell using a provided function.

This is a specialisation of lambdaMain for API Gateway.

The handler receives the input event given to the AWS Lambda function, and its return value is returned from the function.

This is intended to be used as main, for example:

import AWSLambda.Events.APIGateway
import Control.Lens
import Data.Aeson
import Data.Aeson.Embedded

main = apiGatewayMain handler

handler :: APIGatewayProxyRequest (Embedded Value) -> IO (APIGatewayProxyResponse (Embedded [Int]))
handler request = do
  putStrLn "This should go to logs"
  print $ request ^. requestBody
  pure $ responseOK & responseBodyEmbedded ?~ [1, 2, 3]

The type parameters reqBody and resBody represent the types of request and response body, respectively. The FromText and ToText contraints are required because these values come from string fields in the request and response JSON objects. To get direct access to the body string, use Text as the parameter type. To treat the body as a stringified embedded JSON value, use Embedded a, where a has the appropriate FromJSON or ToJSON instances. To treat the body as base 64 encoded binary use Base64.