API reference / @backpack/aws-lambda / rest

rest

Contains utilities for AWS Lambda functions that implement REST endpoints.

Enumerations

• HttpStatus

Interfaces

• JsonResultOptions
• ValidatedJsonResultOptions

Type Aliases

• HttpRequestHeader
• HttpResponseHeader

AWS Proxy event utilities

• RequestValidationError
• Body
• Headers
• MultiOptions
• Options
• PathParameters
• QueryParameters
• Request
• parseBody
• parseHeaders
• parsePathParameters
• parseQueryParameters
• parseRequest

AWS Proxy result utilities

• jsonOk
• jsonResult
• ok
• problemResult
• result

Error handling

• defaultErrorHandler
• problemErrorConverter
• requestValidationErrorConverter

Lambda helpers

• defineRestLambda

RFC-9457 Problem Details

• BadRequestProblem
• ForbiddenProblem
• InternalServerErrorProblem
• NotFoundProblem
• NotImplementedProblem
• ProblemError
• ServiceUnavailableProblem
• UnauthorizedProblem
• Problem