...
| Template Name | Extension Name | Extension Version |
|---|---|---|
| AWS Lambda | ue-aws-lambda | 1.12.20 |
Refer to Changelog for version history information.
...
Software Requirements for Universal Template and Universal Task
Requires Python 3.7 .0 or higher. Tested with the (The Universal Agent bundled Python distribution) or 3.11.
Software Requirements for Universal Agent
...
- Universal Agent for Windows x64 Version >= 7.02.0.0 and later with python options installed.
- Universal Agent for Linux Version Version >= 7.02.0.0 and later with python options installed.
Software Requirements for Universal Controller
- Universal Controller Version 7.02.0.0 and later.
Network and Connectivity Requirements
...
This Universal Task requires the Resolvable the Resolvable Credentials feature. Check that the Resolvable Credentials Permitted system property has been set to true.
To import the Universal Template into your Controller, follow the instructions here.
When the files have been imported successfully, refresh the Universal Templates list; the Universal Template will appear on the list.
...
| Field | Input type | Default value | Type | Description |
|---|---|---|---|---|
| Action | Required | Trigger Lambda function | Choice | The action performed upon the task execution. Available action:
|
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.
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 Access | Optional | False | Boolean | 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 ARN | Optional | - | Text | Role Arn: Amazon Role, which is applied for the connection. Role ARN format: Required when Role Based Access="True". |
| Function Name | Required | - | Text | Name of the Lambda function, which will be triggered. For example, my-function (name-only) or my-function:v1 (with alias). |
| Invocation Type | Required | Request Response | Choice | Type of execution for the function being triggered. Available choices are:
|
| Log Type | Optional | None | Choice | Can be set to Tail to include the execution log in the response. Available choices are:
Visible only when Invocation Type="Request Response". |
| Payload Source | Optional | None | Choice | Source of payload to be sent.
|
| Payload Script | Optional | - | 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 Source | Optional | None | Choice | Client context that's provided to Lambda function by the client application.
|
| Client Context Script | Optional | - | Script | Script passing parameters using the ClientContext object. The scripts must evaluate to a proper JSON format. Required when Client Context Source= "Script". |
| Use Proxy | Optional | False | Boolean | Flag to indicate whether Proxy shall be used in the communication with AWS. |
| Proxy Type | Optional | HTTP | Choice | Type of proxy connection to be used. Available options are the following.
Visible only when Use Proxy = "True". |
| Proxy | Optional | - | Text | Comma separated list of Proxy servers. Valid formats are the following. Required when Use Proxy is checked. |
| Proxy CA Bundle File | Optional | - | 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 Credentials | Optional | - | Credentials | Credentials to be used for the proxy communication. The credential definition should be as follows.
Required when "Proxy Type" is configured for "HTTPS With Credentials". |
| Qualifier | Optional | - | 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 | Required | 60 | Integer | The 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
...
Synchronicity is set by Invocation Type equals "Request_Response".
Trigger Lambda Asynchronously with Role Based Access and HTTPS Proxy
...
- 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
...
An example of the Extension Output for a successful triggering job is presented below.
| Code Block | ||
|---|---|---|
| ||
{
"exit_code": 0,
"status_description": "SUCCESS: AWS Lambda function invoked successfully",
"changed": true,
"invocation": {
"extension": "ue-aws-lambda",
"version": "1.12.20",
"fields": {
"action": "Trigger Lambda Function",
"credentials_user": "test-user****",
"credentials_password": "****",
"region": "us-east-1",
"role_based_access": false,
"role_arn": null,
"function_name": "test-function",
"invocation_type": "RequestResponseEvent",
"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": 200,202,
"log_result": "Multiline Log text", null,
"payload": "{\"statusCode\": 999, \"body\": {\"message\": \"Hello World\"}}",null,
"executed_version": "$LATEST",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 Link | Description |
|---|---|
| Universal Templates | User documentation for creating, working with and understanding Universal Templates and Integrations. |
| Universal Tasks | User documentation for creating Universal Tasks in the Universal Controller user interface. |
| AWS Lambda | Documentation for AWS Lambda. |
| IAM RBAC authorization model | User 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)
...
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)
...