Missing documentation in API reference for connection re-use

[ewolz3]

Describe the issue

The API reference for LambdaClient (and the Javascript SDK in general) should make it clear that the default behavior is for a new TCP connection to be created for every new request.

This can lead to issues with high traffic Lambda functions where usage of file descriptors will continue to grow until it hits the cap and then crash. This is documented in the developer guide but is easily missed by someone just using the API reference.

Links

https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/lambda/

[RanVaknin]

Hi @ewolz3 ,

Thank you for bringing this issue to our attention.

To clarify, the API reference you're referring to is code-generated directly from each AWS service's API model. It's designed to offer specific details on service operations, parameters, and configurations.

On the other hand, the Developer Guide provides comprehensive information on behaviors, best practices, and recommendations, such as the connection reuse topic you pointed out.

If bandwidth opens up to work on this I envision a "see more" button at the bottom of the client configuration page that links users to the developer guide. If you have any other more actionable suggestions please feel free to lay out what you envision this looking like.

Thanks again,
Ran~

[aBurmeseDev]

Since our API reference docs has a left-side navigation link to Developer Guide, we currently don't have plan to add the same link on client page. Closing for now.

[github-actions]

This issue is now closed. Comments on closed issues are hard for our team to see.
If you need more assistance, please open a new issue that references this one.

[github-actions]

This thread has been automatically locked since there has not been any recent activity after it was closed. Please open a new issue for related bugs and link to relevant comments in this thread.