Skip to content

Update AWS Lambda plugin documentation for optional timeout configurations#11771

Merged
natebower merged 4 commits intoopensearch-project:mainfrom
ashrao94:main
Feb 4, 2026
Merged

Update AWS Lambda plugin documentation for optional timeout configurations#11771
natebower merged 4 commits intoopensearch-project:mainfrom
ashrao94:main

Conversation

@ashrao94
Copy link
Contributor

Description

Documentation updates support the new optional timeout features in Data Prepper AWS Lambda plugin.

  1. Add api_call_attempt_timeout as optional configuration parameter
  2. Update read_timeout to be optional (uses AWS SDK defaults when not specified)
    Signed-off-by: Aiswarya Sadananda Rao [email protected]

Issues Resolved

opensearch-project/data-prepper#6257

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

  • [yes ] By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license and subject to the Developers Certificate of Origin.
    For more information on following Developer Certificate of Origin and signing off your commits, please check here.

Aiswarya Sadananda Rao added 2 commits January 15, 2026 18:48
- Add read_timeout field to processor configuration table and example
- Add client configuration options to sink documentation including read_timeout
- Documents new configurable read timeout for Lambda function calls

Signed-off-by: Aiswarya Sadananda Rao <[email protected]>
…tions

- Add api_call_attempt_timeout as optional configuration parameter
- Update read_timeout to be optional (uses AWS SDK defaults when not specified)
- Add timeout configuration guidance section explaining AWS SDK timeout hierarchy
- Update examples to show optional timeout usage for long-running Lambda functions
- Provide clear guidance on when to configure each timeout parameter

Documentation updates support the new optional timeout features in Data Prepper AWS Lambda plugin.

Signed-off-by: Aiswarya Sadananda Rao <[email protected]>
@github-actions
Copy link

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.

@kolchfa-aws kolchfa-aws added Tech review PR: Tech review in progress backport 3.4 labels Jan 15, 2026
@kolchfa-aws
Copy link
Collaborator

Hey @ashrao94 Let me know when this PR is ready for a doc team review. Thanks!

@kolchfa-aws kolchfa-aws added Doc review PR: Doc review in progress and removed Tech review PR: Tech review in progress labels Feb 3, 2026
Signed-off-by: Fanit Kolchina <[email protected]>
@kolchfa-aws kolchfa-aws added Editorial review and removed Doc review PR: Doc review in progress labels Feb 3, 2026
Copy link
Contributor

@natebower natebower left a comment

Choose a reason for hiding this comment

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

LGTM

@natebower natebower merged commit e1c71bb into opensearch-project:main Feb 4, 2026
6 checks passed
opensearch-trigger-bot bot pushed a commit that referenced this pull request Feb 4, 2026
…tions (#11771)

* Add read_timeout configuration documentation for AWS Lambda plugin

- Add read_timeout field to processor configuration table and example
- Add client configuration options to sink documentation including read_timeout
- Documents new configurable read timeout for Lambda function calls

Signed-off-by: Aiswarya Sadananda Rao <[email protected]>

* Update AWS Lambda plugin documentation for optional timeout configurations

- Add api_call_attempt_timeout as optional configuration parameter
- Update read_timeout to be optional (uses AWS SDK defaults when not specified)
- Add timeout configuration guidance section explaining AWS SDK timeout hierarchy
- Update examples to show optional timeout usage for long-running Lambda functions
- Provide clear guidance on when to configure each timeout parameter

Documentation updates support the new optional timeout features in Data Prepper AWS Lambda plugin.

Signed-off-by: Aiswarya Sadananda Rao <[email protected]>

* Doc review

Signed-off-by: Fanit Kolchina <[email protected]>

* Apply suggestions from code review

Signed-off-by: Nathan Bower <[email protected]>

---------

Signed-off-by: Aiswarya Sadananda Rao <[email protected]>
Signed-off-by: Fanit Kolchina <[email protected]>
Signed-off-by: Nathan Bower <[email protected]>
Co-authored-by: Aiswarya Sadananda Rao <[email protected]>
Co-authored-by: Fanit Kolchina <[email protected]>
Co-authored-by: Nathan Bower <[email protected]>
(cherry picked from commit e1c71bb)
Signed-off-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants