Interface Context

Handler context parameter. See AWS documentation.

interface Context {
    awsRequestId: string;
    callbackWaitsForEmptyEventLoop: boolean;
    clientContext?: ClientContext;
    functionName: string;
    functionVersion: string;
    identity?: CognitoIdentity;
    invokedFunctionArn: string;
    logGroupName: string;
    logStreamName: string;
    memoryLimitInMB: string;
    done(error?, result?): void;
    fail(error): void;
    getRemainingTimeInMillis(): number;
    succeed(messageOrObject): void;
    succeed(message, object): void;
}

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?, result?): void
Parameters
- Optional error: Error
- Optional result: any
Returns void
Deprecated
Use handler callback or promise result

fail

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

getRemainingTimeInMillis

getRemainingTimeInMillis(): number
Returns number

succeed

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