Object to represent an AWS Lambda function execution context.


getRequestId

string

Returns the request execution deadline in milliseconds from the epoch.


getDeadlineMs

Returns the ARN of the function being invoked.


getInvokedFunctionArn

getTraceId

Returns the remaining execution time for this request in milliseconds


getRemainingExecutionTime

Context

The annotation, which is used to mark the function as an AWS Lambda function.


Function

## Module Overview

This module offers the capabilities of creating [AWS Lambda](https://aws.amazon.com/lambda/) functions using Ballerina. 
 

### Annotation Usage Sample:

```ballerina
import ballerinax/awslambda;
import ballerina/uuid;
import ballerina/io;

// The `@awslambda:Function` annotation marks a function to
// generate an AWS Lambda function
@awslambda:Function
public function echo(awslambda:Context ctx, json input) returns json {
   return input;
}

@awslambda:Function
public function uuid(awslambda:Context ctx, json input) returns json {
   return uuid:createType1AsString();
}

// The `awslambda:Context` object contains request execution
// context information
@awslambda:Function
public function ctxinfo(awslambda:Context ctx, json input) returns json|error {
   json result = { RequestID: ctx.getRequestId(),
                   DeadlineMS: ctx.getDeadlineMs(),
                   InvokedFunctionArn: ctx.getInvokedFunctionArn(),
                   TraceID: ctx.getTraceId(),
                   RemainingExecTime: ctx.getRemainingExecutionTime() };
   return result;
}

@awslambda:Function
public function notifySQS(awslambda:Context ctx, 
                          awslambda:SQSEvent event) returns json {
    return event.Records[0].body;
}

@awslambda:Function
public function notifyS3(awslambda:Context ctx, 
                         awslambda:S3Event event) returns json {
    return event.Records[0].s3.'object.key;
}

@awslambda:Function
public function notifyDynamoDB(awslambda:Context ctx, 
                               awslambda:DynamoDBEvent event) returns json {
    return event.Records[0].dynamodb.Keys.toString();
}

@awslambda:Function
public function notifySES(awslambda:Context ctx, 
                          awslambda:SESEvent event) returns json {
    return event.Records[0].ses.mail.commonHeaders.subject;
}

@awslambda:Function
public function apigwRequest(awslambda:Context ctx, 
                             awslambda:APIGatewayProxyRequest request) {
    io:println("Path: ", request.path);
}
```

The output of the bal build is as follows:

```bash
$ bal build functions.bal 
Compiling source
    functions.bal

Generating executable
	functions.jar
	@awslambda:Function: echo, uuid, ctxinfo, notifySQS, notifyS3

	Run the following command to deploy each Ballerina AWS Lambda function:
	aws lambda create-function --function-name $FUNCTION_NAME --zip-file fileb://aws-ballerina-lambda-functions.zip --handler functions.$FUNCTION_NAME --runtime provided --role $LAMBDA_ROLE_ARN --layers arn:aws:lambda:$REGION_ID:134633749276:layer:ballerina-jre11:6 --memory-size 512 --timeout 10

	Run the following command to re-deploy an updated Ballerina AWS Lambda function:
	aws lambda update-function-code --function-name $FUNCTION_NAME --zip-file fileb://aws-ballerina-lambda-functions.zip


__process

Register a function handler with the function and event type.



__register

handler

func

FunctionType

eventType

anydata

Represents the AWS API Gateway proxy request details received from AWS when the gateway is triggered.



'resource

path

httpMethod

requestContext

headers

multi value headers (if they are enabled)


multiValueHeaders

queryStringParameters

multi value query string parameters of the request


multiValueQueryStringParameters

pathParameters

stage variables  of the stage in the API Gateway


stageVariables

body

field to identify if the content is Base64 encoded


isBase64Encoded

boolean

APIGatewayProxyRequest

Represents the DynamoDB event details received from AWS when the DynamoDB notification is triggered.



record list of the DynamoDB notifications


Records

DynamoDBRecord

DynamoDBEvent

Represents the DynamoDB related details.



a globally unique identifier for the event that was recorded in this stream record


eventID

the version number of the stream record format


eventVersion

the main body of the stream record containing all of the DynamoDB-specific fields


dynamodb

DynamoDBStreamRecord

AWS region to which the DynamoDB belongs


awsRegion

the type of data modification that was performed on the DynamoDB table


eventName

eventSourceARN

the AWS service from which the stream record originated


eventSource

Represents the details of the stream related to the DynamoDB.



the primary key attribute(s) of the DynamoDB item that were modified


Keys

json

the item in the DynamoDB table after it is modified


NewImage

the item in the DynamoDB table before it was modified


OldImage

the type of data of the modified DynamoDB item that was captured in this stream record


StreamViewType

the sequence number of the stream record


SequenceNumber

the size of the stream record (in bytes)


SizeBytes

Represents the details of the name related to the simple email service.



name

value

NameValue

Represents the details of the bucket related to the S3 service.



ownerIdentity

S3Identity

S3Bucket

Represents the details of the element related to the S3 service.



s3SchemaVersion

configurationId

bucket

'object

S3Object

S3Element

Represents the S3 event details received from AWS when the S3 notification is triggered.



S3Record

S3Event

Represents the details of the identity related to the S3 service.



principalId

Represents the details of the object related to the S3 service.



size

eTag

sequencer

Represents the S3 bucket notification related details.



the AWS region to which the S3 bucket belongs 


eventTime

identity of the user who invoked the event


userIdentity

requestParameters

responseElements

Represents the details of the action related to the simple email service.



'type

invocationType

functionArn

SESAction

Represents the simple email service related details.



'from

returnPath

the unique ID assigned to the email by Amazon SES


messageId

date

subject

SESCommonHeaders

Represents the details of the element related to the simple email service.



mail

SESMail

receipt

SESReceipt

SESElement

Represents the simple email service event details received from AWS when the SES notification is triggered.



SESRecord

SESEvent

Represents the details of the email related to the simple email service.



commonHeaders

'source

string that specifies the date and time at which the action was triggered (in the ISO 8601 format)


timestamp

a complete list of all recipient addresses


destination

specifies whether the headers were truncated in the notification


headersTruncated

Represents the details of the receipt related to the simple email service.



a list of recipients that were matched by the active receipt rule


recipients

object that indicates whether the message is spam


spamVerdict

SESVerdict

object that indicates whether the DomainKeys Identified Mail (DKIM) check passed


dkimVerdict

processing time taken for the email (in milliseconds)


processingTimeMillis

Object that encapsulates the information about the action that was executed


action

object that indicates whether the Sender Policy Framework (SPF) check passed


spfVerdict

virusVerdict

Represents the details of the notification related to the simple email service.



the AWS service from which the email originated


Represents the details of the verdict related to the simple email service.



status

Represents the AWS SQS event details received from AWS when the SQS notification is triggered.



SQSRecord

SQSEvent

Represents the Amazon simple queue service notification related details.



receiptHandle

the attributes associated with the queue


attributes

messageAttributes

md5OfBody

This module offers the capabilities of creating [AWS Lambda](https://aws.amazon.com/lambda/) functions using Ballerina. 


Class: Context

Methods

getRequestId

Return Type

getDeadlineMs

Return Type

getInvokedFunctionArn

Return Type

getTraceId

Return Type

getRemainingExecutionTime

Return Type

getRequestId	Returns the unique id for this request.
getDeadlineMs	Returns the request execution deadline in milliseconds from the epoch.
getInvokedFunctionArn	Returns the ARN of the function being invoked.
getTraceId	Returns the trace id for this request
getRemainingExecutionTime	Returns the remaining execution time for this request in milliseconds