AWS Lambda

Disclaimer

Your use of this download is governed by Stonebranch’s Terms of Use, which are available at https://www.stonebranch.com/integration-hub/Terms-and-Privacy/Terms-of-Use/

Overview

AWS Lambda is a serverless compute service that runs your code in response to events and automatically manages the underlying compute resources for you. You can use AWS Lambda to extend other AWS services with custom logic, or create your own back-end services that operate at AWS scale, performance, and security.

This Universal Extension provides the capability to execute a AWS Lambda function and return the result of that execution.

Version Information

Template NameExtension NameExtension Version
AWS Lambdaue-aws-lambda1.2.0

Refer to Changelog for version history information.

Software Requirements

This integration requires a Universal Agent and a Python runtime to execute the Universal Task.

Software Requirements for Universal Template and Universal Task

Requires Python 3.7 (The Universal Agent bundled Python distribution) or 3.11. 

Software Requirements for Universal Agent

Both Windows and Linux agents are supported:

  • Universal Agent for Windows x64 Version >= 7.2.0.0.
  • Universal Agent for Linux Version >= 7.2.0.0. 

Software Requirements for Universal Controller

  • Universal Controller Version 7.2.0.0 and later.

Network and Connectivity Requirements

Extension's Universal Agent host should be able to reach AWS Lambda REST endpoints.

Key Features

This Universal Extension provides the following key features:

  • Trigger Lambda function Synchronously or Asynchronously.
  • Support authorization via IAM Role-Based Access Control (RBAC) strategy.
  • Support Proxy communication via HTTP/HTTPS protocol.

Import Universal Template

To use the Universal Template, you first must perform the following steps.

  1. This Universal Task requires the Resolvable Credentials feature. Check that the Resolvable Credentials Permitted system property has been set to true.

  2. To import the Universal Template into your Controller, follow the instructions here.

  3. When the files have been imported successfully, refresh the Universal Templates list; the Universal Template will appear on the list.

Configure Universal Task

For the new Universal Task type AWS Lambda, create a new task, and enter the task-specific details that were created in the Universal Template.

Input Fields

The input fields for this Universal Extension are described below.

FieldInput typeDefault valueTypeDescription
ActionRequiredTrigger Lambda functionChoice

The action performed upon the task execution. Available action:

  • Trigger Lambda function

AWS Region

Optional since version 1.1.0

Optional-Text

Region for the Amazon Web Service. Find more information about the AWS Service endpoints and quotas here.

When AWS Region is not populated as part of the task definition, during task execution the integration will look for credentials on the task execution environment. Refer to configuration options for more information.

AWS Credentials

Optional since version 1.1.0

Optional-Credentials

The Credentials definition should be as follows.

  • AWS Access Key ID as "Runtime User".
  • AWS Secret Access Key as "Runtime Password".

When AWS Credentials are not populated as part of the task definition, during task execution the integration will look for AWS Credentials on the task execution environment. Refer to configuration options for more information.

Role Based AccessOptionalFalseBoolean

Special type of authorization is provided by Role Assumption where the client sends his own credentials and the role he wants to assume from another user.

If allowed, the client receives temporary credentials with limited time access to some resources.

Role ARNOptional-Text

Role Arn: Amazon Role, which is applied for the connection. Role ARN format: Example RoleArn: arn:aws:iam::119322085622:role.

Required when Role Based Access="True".

Function NameRequired-TextName of the Lambda function, which will be triggered. For example, my-function (name-only) or my-function:v1 (with alias).
Invocation TypeRequiredRequest ResponseChoice

Type of execution for the function being triggered. Available choices are:

  • Request Response (Synchronously)
  • Event (Asynchronously)
Log TypeOptionalNoneChoiceCan be set to Tail to include the execution log in the response. Available choices are:
  • None
  • Tail

Visible only when Invocation Type="Request Response".

Payload SourceOptionalNoneChoice

Source of payload to be sent.

  • None
  • Script
Payload ScriptOptional-Script Field

Script field where the payload can be entered. The scripts must evaluate to a proper JSON format.

Required when Payload Source = "Script".

Client Context SourceOptionalNoneChoice

Client context that's provided to Lambda function by the client application.

  • None
  • Script
Client Context ScriptOptional-Script

Script passing parameters using the ClientContext object. The scripts must evaluate to a proper JSON format.

Required when Client Context Source= "Script".

Use ProxyOptionalFalseBooleanFlag to indicate whether Proxy shall be used in the communication with AWS.
Proxy TypeOptionalHTTPChoice

Type of proxy connection to be used.

Available options are the following.

  • HTTP
  • HTTPS
  • HTTPS with Credentials

Visible only when Use Proxy = "True".

ProxyOptional-Text

Comma separated list of Proxy servers. Valid formats are the following.
http://proxyip:port or http://proxyip:port,https://proxyip:port.

Required when Use Proxy is checked.

Proxy CA Bundle FileOptional-Text

The path to a custom certificate bundle to use when establishing SSL/TLS connections with proxy.

Used when Proxy Type is configured for "HTTPS" or "HTTPS With Credentials".

Proxy CredentialsOptional-Credentials

Credentials to be used for the proxy communication.

The credential definition should be as follows.

  • Proxy Username as "Runtime User".
  • Proxy Password as "Runtime Password".

Required when "Proxy Type" is configured for "HTTPS With Credentials".

QualifierOptional-Text

Version or alias to invoke a published version of the function. Example for version 1 Qualifier = "1".

If empty, default value is the latest version.

Wait For Completion Timeout

Introduced in version 1.1.1
Required60IntegerThe time in seconds that the task will wait for a server response until it throws a timeout exception.

This is linked with the read_timeout config value that is passed to the AWS client.

Endpoint URL

Introduced in version 1.2.0

Optional-Text

The URL of the custom endpoint to use.

The URL must contain a scheme which is either HTTP or HTTPS.

Task Examples

Trigger Lambda Synchronously with Log

Triggering a Lambda function Synchronously with Log Type equals "Tail".

Synchronicity is set by Invocation Type equals "Request_Response".


Trigger Lambda Asynchronously with Role Based Access and HTTPS Proxy

Triggering Lambda function Asynchronously with:

  • Role Based Access
  • HTTPS Proxy connection
  • Payload Source
  • Client Context Source


Trigger Lambda Synchronously with HTTPS with Credentials Proxy

Triggering a Lambda function Synchronously with "HTTPS with Credentials" Proxy connection.


Trigger Lambda Synchronously with Log

Triggering a Lambda function Synchronously with "Region" provided as environment variables and without AWS Credentials. Please refer to AWS Credentials input field for more information.


Task Output

Exit Codes

The exit codes for AWS Lambda Extension are described in the following table.

Exit CodeStatus Classification CodeStatus Classification DescriptionStatus Description
0SUCCESSSuccessful ExecutionSUCCESS: Successful Task execution
0SUCCESSSuccessful Execution, but could not decode AWS log messageDECODE_WARNING: AWS Lambda function invoked successfully, but log message could not be decoded
1FAILFailed ExecutionFAIL: < Error Description >
2AUTHENTICATION_ERRORBad credentialsAUTHENTICATION_ERROR: Account cannot be authenticated.
3AUTHORIZATION_ERRORInsufficient PermissionsAUTHORIZATION_ERROR: Account is not authorized to perform the requested action.
10CONNECTION_ERRORBad connection data or connection timed outCONNECTION_ERROR: < Error Description >
11CONNECTION_ERRORExtension specific connection errorCONNECTION_ERROR: ProxyConnectionError: Failed to connect to proxy URL <url>
20DATA_VALIDATION_ERRORInput fields validation errorDATA_VALIDATION_ERROR: Some of the input fields cannot be validated. See STDOUT for more details.
21READ_TIMEOUT_ERRORLambda function completion timeout errorREAD_TIMEOUT_ERROR: Did not receive a server response within the allotted time frame (wait_for_completion_timeout).

Extension Output

In the context of a workflow, subsequent tasks can rely on the information provided by this integration as Extension Output.

Attribute changed is populated as follows.

  • true in case the job is triggered successfully
  • false otherwise

result section includes the following attributes.

AttributeTypeDescription
status_codeintegerThe HTTP status code is in the 200 range for a successful request. For the RequestResponse invocation type, this status code is 200. For the Event invocation type, this status code is 202. For the DryRun invocation type, the status code is 204.
log_resultstringThe last 4 KB of the execution log, which is base64 encoded.
payloadstringThe response from the function, or an error object.
executed_versionstringThe version of the function that was executed. When you invoke a function with an alias, this indicates which version the alias is resolved to.
function_errorstringIf present, indicates that an error occurred during function execution. Details about the error are included in the response payload.

An example of the Extension Output for a successful triggering job is presented below.

{
    "exit_code": 0,
    "status_description": "SUCCESS: AWS Lambda function invoked successfully",
    "changed": true,
    "invocation": {
        "extension": "ue-aws-lambda",
        "version": "1.2.0",
        "fields": {
            "action": "Trigger Lambda Function",
            "credentials_user": "****",
            "credentials_password": "****",
            "region": "us-east-1",
            "role_based_access": false,
            "role_arn": null,
            "function_name": "test-function",
            "invocation_type": "Event",
            "payload_source": null,
            "payload_script": null,
            "client_context_source": null,
            "client_context_script": null,
            "log_type": "None",
            "qualifier": null,
            "use_proxy": false,
            "proxy_type": null,
            "proxy": null,
            "proxy_credentials_user": null,
            "proxy_credentials_password": null,
            "proxy_ca_bundle_file": null,
            "wait_for_completion_timeout": 60,
            "endpoint_url": null
        }
    },
    "result": {
        "status_code": 202,
        "log_result": null,
        "payload": null,
        "executed_version": null,
        "function_error": null
    }
}

STDOUT and STDERR

STDOUT and STDERR provide additional information to the User. The populated content can be changed in future versions of this extension without notice. Backward compatibility is not guaranteed.

Document References

This document references the following documents.

Document LinkDescription
Universal TemplatesUser documentation for creating, working with and understanding Universal Templates and Integrations.
Universal TasksUser documentation for creating Universal Tasks in the Universal Controller user interface.
AWS LambdaDocumentation for AWS Lambda.
IAM RBAC authorization modelUser Documentation for Comparing ABAC to the traditional RBAC model.

Changelog

ue-aws-lambda-1.2.0 (2024-01-04)

Enhancements

  • Added: Provide the capability to specify a custom endpoint URL to call instead of the default one. (#33020)

ue-aws-lambda-1.1.2 (2023-09-01)

Fixes

  • Fixed: Provide a fix on the decoding of AWS Log Message. (#34100)

ue-aws-lambda-1.1.1 (2023-02-24)

Fixes

  • Fixed: Provide the capability to define the completion timeout of the lambda function and avoid lambda function re-execution if the completion timeout is exceeded. (#31671)

ue-aws-lambda-1.1.0 (2022-06-30)

Enhancements

  • Added: Provide the capability to rely on AWS credentials set-up on the environment where the extension is running and therefore it is not mandatory to be passed on the task definition as input fields. The same applies to AWS Region. (#29115)

ue-aws-lambda-1.0.1 (2022-03-14)

Fixes

  • Fixed: Change of template SysId. (#27744)