Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

AWS Lambda node documentation #1489

Conversation

irynamatveieva
Copy link
Contributor

PR description

The documentation updated for AWS Lambda node

Link checker

The links will be checked by the build agent automatically once you create or update your PR.

You can use the following command to check the broken links locally.

docker run --rm -it --network=host --name=linkchecker ghcr.io/linkchecker/linkchecker --check-extern --no-warnings http://0.0.0.0:4000/

@CLAassistant
Copy link

CLAassistant commented May 23, 2024

CLA assistant check
All committers have signed the CLA.


![image](/images/user-guide/rule-engine-2-0/nodes/external-aws-lambda.png)

Node publish messages to AWS Lambda (Amazon Lambda).
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Node publishes messages to AWS Lambda, a service that lets you run code without provisioning or managing servers. It sends messages using a RequestResponse invocation type. The node uses a pre-configured client and specified function to run.


Function configuration

- **Function name** is required to specify which AWS Lambda function will be invoked and executed.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

required parameter to specify which AWS Lambda function should be invoked.

Function configuration

- **Function name** is required to specify which AWS Lambda function will be invoked and executed.
- **Qualifier** is used to specify a version or alias of the Lambda function to invoke. By default, Lambda invokes the **$LATEST** version, which is the latest version of the function.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

optional parameter to specify a version or alias of the Lambda function. If the qualifier is not specified, the default qualifier "$LATEST" will be used.


- **Function name** is required to specify which AWS Lambda function will be invoked and executed.
- **Qualifier** is used to specify a version or alias of the Lambda function to invoke. By default, Lambda invokes the **$LATEST** version, which is the latest version of the function.
- **Invocation type** specifies how the Lambda function is invoked. You can choose from the following options: RequestResponse, Event and DryRun. More information on invocation types can be found [here](https://docs.aws.amazon.com/lambda/latest/api/API_Invoke.html#API_Invoke_RequestSyntax).
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

to remove: "Invocation type"


Advanced settings

- **Connection timeout**: amount of time to wait (in milliseconds) when initially establishing a connection before giving up and timing out.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
- **Connection timeout**: amount of time to wait (in milliseconds) when initially establishing a connection before giving up and timing out.
- **Connection timeout**: amount of time to wait (in seconds) when initially establishing a connection before giving up and timing out.


- **Connection timeout**: amount of time to wait (in milliseconds) when initially establishing a connection before giving up and timing out.
A value of 0 means infinity, and is not recommended.
- **Request timeout**: amount of time to wait (in milliseconds) for the request to complete before giving up and timing out.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
- **Request timeout**: amount of time to wait (in milliseconds) for the request to complete before giving up and timing out.
- **Request timeout**: amount of time to wait (in seconds) for the request to complete before giving up and timing out.

A value of 0 means infinity, and is not recommended.
- **Request timeout**: amount of time to wait (in milliseconds) for the request to complete before giving up and timing out.

- **Tell Failure if AWS Lambda function execution raises exception**: if enabled, forces failure of message processing if AWS Lambda function execution raises exception. If disabled, the error information is added to the response payload, and the message continues via the success route.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
- **Tell Failure if AWS Lambda function execution raises exception**: if enabled, forces failure of message processing if AWS Lambda function execution raises exception. If disabled, the error information is added to the response payload, and the message continues via the success route.
- **Tell Failure if AWS Lambda function execution raises exception**: if enabled, forces failure of message processing if AWS Lambda function execution raises exception. If disabled, the error information is added to the response payload, and the message will be routed via success chain.


- **Tell Failure if AWS Lambda function execution raises exception**: if enabled, forces failure of message processing if AWS Lambda function execution raises exception. If disabled, the error information is added to the response payload, and the message continues via the success route.

> **Note**: **Function name** and **Qualifier** fields supports templatization.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
> **Note**: **Function name** and **Qualifier** fields supports templatization.
> **Note**: **Function name** and **Qualifier** fields support templatization.


**Output**
- **Success**: If message was processed successfully.
- **Failure**: If error happened during message processing or Lambda function execution raises exception, if **Tell Failure if AWS Lambda function execution raises exception** is enabled.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

If an error occurs during message processing or if the AWS Lambda function execution raises an exception, and the option 'Tell Failure if AWS Lambda function execution raises exception' is enabled.

@irynamatveieva irynamatveieva changed the title [WIP] AWS Lambda node documentation AWS Lambda node documentation Jun 11, 2024
@irynamatveieva irynamatveieva changed the base branch from master to develop/3.7.1 August 6, 2024 14:42
@ashvayka ashvayka merged commit b3fc3ea into thingsboard:develop/3.7.1 Aug 28, 2024
2 checks passed
@irynamatveieva irynamatveieva deleted the feature/external-aws-lambda-node-node branch August 29, 2024 07:08
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants