Addressing aws lambda documentation changes #11432
Open
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Signed-off-by: Srikanth Govindarajan <[email protected]>
srikanthjg
requested review from
AMoo-Miki,
dlvenable,
epugh,
kolchfa-aws,
natebower and
sumobrian
as code owners
|
Thank you for submitting your PR. The PR states are In progress (or Draft) -> Tech review -> Doc review -> Editorial review -> Merged. Before you submit your PR for doc review, make sure the content is technically accurate. If you need help finding a tech reviewer, tag a maintainer. When you're ready for doc review, tag the assignee of this PR. The doc reviewer may push edits to the PR directly or leave comments and editorial suggestions for you to address (let us know in a comment if you have a preference). The doc reviewer will arrange for an editorial review. |
kkondaka
approved these changes
Oct 28, 2025
Collaborator
|
@dlvenable Could you review this PR please? |
kolchfa-aws
reviewed
Oct 28, 2025
Collaborator
kolchfa-aws
left a comment
kolchfa-aws
left a comment
There was a problem hiding this comment.
Thank you, @srikanthjg! Please see my comments and let me know if you have any questions.
| -------------------- | ------- | -------- | ---------------------------------------------------------------------------- | ||
| `function_name` | String | Required | The name of the AWS Lambda function to invoke. | ||
| `invocation_type` | String | Required | Specifies the invocation type, either `request-response` or `event`. Default is `request-response`. | ||
| `function_name` | String | Required | The name of the AWS Lambda function to invoke. Must be 3-500 characters. |
Collaborator
There was a problem hiding this comment.
Suggested change
| `function_name` | String | Required | The name of the AWS Lambda function to invoke. Must be 3-500 characters. | |
| `function_name` | String | Required | The name of the AWS Lambda function to invoke. Must be 3--500 characters. |
| `aws.region` | String | Required | The AWS Region in which the Lambda function is located. | ||
| `aws.sts_role_arn` | String | Optional | The Amazon Resource Name (ARN) of the role to assume before invoking the Lambda function. | ||
| `max_retries` | Integer | Optional | The maximum number of retries for failed invocations. Default is `3`. | ||
| `aws.sts_role_arn` | String | Optional | The Amazon Resource Name (ARN) of the role to assume before invoking the Lambda function. Must be 20-2048 characters. |
Collaborator
There was a problem hiding this comment.
Suggested change
| `aws.sts_role_arn` | String | Optional | The Amazon Resource Name (ARN) of the role to assume before invoking the Lambda function. Must be 20-2048 characters. | |
| `aws.sts_role_arn` | String | Optional | The Amazon Resource Name (ARN) of the role to assume before invoking the Lambda function. Must be 20--2048 characters. |
| `aws.sts_role_arn` | String | Optional | The Amazon Resource Name (ARN) of the role to assume before invoking the Lambda function. | ||
| `max_retries` | Integer | Optional | The maximum number of retries for failed invocations. Default is `3`. | ||
| `aws.sts_role_arn` | String | Optional | The Amazon Resource Name (ARN) of the role to assume before invoking the Lambda function. Must be 20-2048 characters. | ||
| `aws.sts_external_id` | String | Optional | External ID for STS role assumption. Must be 2-1224 characters. |
Collaborator
There was a problem hiding this comment.
Suggested change
| `aws.sts_external_id` | String | Optional | External ID for STS role assumption. Must be 2-1224 characters. | |
| `aws.sts_external_id` | String | Optional | An external ID for STS role assumption. Must be 2--1224 characters. |
| `aws.sts_external_id` | String | Optional | External ID for STS role assumption. Must be 2-1224 characters. | ||
| `aws.sts_header_overrides` | Map | Optional | STS header overrides. Maximum of 5 headers supported. | ||
| `client.max_retries` | Integer | Optional | The maximum number of retries for failed invocations. Default is `3`. | ||
| `client.api_call_timeout` | Duration | Optional | API call timeout before timing out. Default is `60s`. |
Collaborator
There was a problem hiding this comment.
Suggested change
| `client.api_call_timeout` | Duration | Optional | API call timeout before timing out. Default is `60s`. | |
| `client.api_call_timeout` | Duration | Optional | The API call timeout. Default is `60s`. |
| `aws.sts_header_overrides` | Map | Optional | STS header overrides. Maximum of 5 headers supported. | ||
| `client.max_retries` | Integer | Optional | The maximum number of retries for failed invocations. Default is `3`. | ||
| `client.api_call_timeout` | Duration | Optional | API call timeout before timing out. Default is `60s`. | ||
| `client.connection_timeout` | Duration | Optional | SDK connection timeout. Default is `60s`. |
Collaborator
There was a problem hiding this comment.
Suggested change
| `client.connection_timeout` | Duration | Optional | SDK connection timeout. Default is `60s`. | |
| `client.connection_timeout` | Duration | Optional | The SDK connection timeout. Default is `60s`. |
| `keys` | List | Optional | Keys to send to lambda function. | ||
| `cache` | Object | Optional | Cache configuration. Only valid when `response_mode` is `merge` and `keys` are specified. | ||
| `cache.ttl` | Long | Optional | Cache time-to-live. | ||
| `cache.max_size` | Long | Optional | Maximum cache size. Must be between 1048576 and 10485760. |
Collaborator
There was a problem hiding this comment.
Suggested change
| `cache.max_size` | Long | Optional | Maximum cache size. Must be between 1048576 and 10485760. | |
| `cache.max_size` | Long | Optional | The maximum cache size. Must be between 1048576 and 10485760. |
| `cache` | Object | Optional | Cache configuration. Only valid when `response_mode` is `merge` and `keys` are specified. | ||
| `cache.ttl` | Long | Optional | Cache time-to-live. | ||
| `cache.max_size` | Long | Optional | Maximum cache size. Must be between 1048576 and 10485760. | ||
| `circuit_breaker_retries` | Integer | Optional | Maximum number of circuit breaker checks before proceeding. Default is `0`. |
Collaborator
There was a problem hiding this comment.
Suggested change
| `circuit_breaker_retries` | Integer | Optional | Maximum number of circuit breaker checks before proceeding. Default is `0`. | |
| `circuit_breaker_retries` | Integer | Optional | The maximum number of circuit breaker checks before proceeding. Default is `0`. |
| `cache.ttl` | Long | Optional | Cache time-to-live. | ||
| `cache.max_size` | Long | Optional | Maximum cache size. Must be between 1048576 and 10485760. | ||
| `circuit_breaker_retries` | Integer | Optional | Maximum number of circuit breaker checks before proceeding. Default is `0`. | ||
| `circuit_breaker_wait_interval` | Long | Optional | Time in milliseconds between circuit breaker checks. Default is `1000ms`. |
Collaborator
There was a problem hiding this comment.
Suggested change
| `circuit_breaker_wait_interval` | Long | Optional | Time in milliseconds between circuit breaker checks. Default is `1000ms`. | |
| `circuit_breaker_wait_interval` | Long | Optional | The amount of time, in milliseconds, between circuit breaker checks. Default is `1000ms`. |
|
|
||
| When `response_mode` is set to `merge` and `keys` are specified, the processor can cache Lambda responses to improve performance for repeated requests. | ||
|
|
||
| ### Circuit Breaker |
Collaborator
There was a problem hiding this comment.
Suggested change
| ### Circuit Breaker | |
| ### Circuit breaker |
| `aws.sts_external_id` | String | Optional | External ID for STS role assumption. Must be 2-1224 characters. | ||
| `aws.sts_header_overrides` | Map | Optional | STS header overrides. Maximum of 5 headers supported. | ||
| `client.max_retries` | Integer | Optional | The maximum number of retries for failed invocations. Default is `3`. | ||
| `client.api_call_timeout` | Duration | Optional | API call timeout before timing out. Default is `60s`. |
Collaborator
There was a problem hiding this comment.
Should "duration" be "time unit"? This is how we specify the time unit values for REST requests.
kolchfa-aws
added
Doc review
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
4 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
Synchronized documentation with actual code implementation,
adding missing configuration fields, correcting examples, and documenting new
features like caching, circuit breaker, and response modes that were
implemented but not documented.
Issues Resolved
Closes #[Replace this text, including the brackets, with the issue number. Leave "Closes #" so the issue is closed properly.]
Version
List the OpenSearch version to which this PR applies, e.g. 2.14, 2.12--2.14, or all.
Frontend features
If you're submitting documentation for an OpenSearch Dashboards feature, add a video that shows how a user will interact with the UI step by step. A voiceover is optional.
Checklist
For more information on following Developer Certificate of Origin and signing off your commits, please check here.