Interface Context

Handler context parameter. See AWS documentation.

Hierarchy

Context

Index

Properties

awsRequestId callbackWaitsForEmptyEventLoop clientContext? functionName functionVersion identity? invokedFunctionArn logGroupName logStreamName memoryLimitInMB

Methods

done fail getRemainingTimeInMillis succeed

Properties

awsRequestId

awsRequestId: string

callbackWaitsForEmptyEventLoop

callbackWaitsForEmptyEventLoop: boolean

`Optional` clientContext

clientContext?: ClientContext

functionName

functionName: string

functionVersion

functionVersion: string

`Optional` identity

identity?: CognitoIdentity

invokedFunctionArn

invokedFunctionArn: string

logGroupName

logGroupName: string

logStreamName

logStreamName: string

memoryLimitInMB

memoryLimitInMB: string

Methods

done

done(error?: Error, result?: any): void
Deprecated
Use handler callback or promise result
Parameters
- Optional error: Error
- Optional result: any
Returns void

fail

fail(error: string | Error): void
Deprecated
Use handler callback with first argument or reject a promise result
Parameters
- error: string | Error
Returns void

getRemainingTimeInMillis

getRemainingTimeInMillis(): number
Returns number

succeed

succeed(messageOrObject: any): void
Deprecated
Use handler callback with second argument or resolve a promise result
Parameters
- messageOrObject: any
Returns void
succeed(message: string, object: any): void
Deprecated
Use handler callback or promise result
Parameters
- message: string
- object: any
Returns void

Generated using TypeDoc