Skip to content

Conversation

@srikanthjg
Copy link
Contributor

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

  • 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.

Signed-off-by: Srikanth Govindarajan <[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
Copy link
Collaborator

@dlvenable Could you review this PR please?

Copy link
Collaborator

@kolchfa-aws kolchfa-aws left a comment

Choose a reason for hiding this comment

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

Thank you, @srikanthjg! Please see my comments and let me know if you have any questions.

`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`.
Copy link
Collaborator

Choose a reason for hiding this comment

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

Should "duration" be "time unit"? This is how we specify the time unit values for REST requests.

@kolchfa-aws kolchfa-aws added Doc review PR: Doc review in progress and removed Tech review PR: Tech review in progress labels Oct 28, 2025
@kkondaka kkondaka mentioned this pull request Nov 3, 2025
1 task
srikanthjg and others added 10 commits November 14, 2025 12:09
Co-authored-by: kolchfa-aws <[email protected]>
Signed-off-by: Srikanth Govindarajan <[email protected]>
Co-authored-by: kolchfa-aws <[email protected]>
Signed-off-by: Srikanth Govindarajan <[email protected]>
Co-authored-by: kolchfa-aws <[email protected]>
Signed-off-by: Srikanth Govindarajan <[email protected]>
Co-authored-by: kolchfa-aws <[email protected]>
Signed-off-by: Srikanth Govindarajan <[email protected]>
Co-authored-by: kolchfa-aws <[email protected]>
Signed-off-by: Srikanth Govindarajan <[email protected]>
Co-authored-by: kolchfa-aws <[email protected]>
Signed-off-by: Srikanth Govindarajan <[email protected]>
Co-authored-by: kolchfa-aws <[email protected]>
Signed-off-by: Srikanth Govindarajan <[email protected]>
Co-authored-by: kolchfa-aws <[email protected]>
Signed-off-by: Srikanth Govindarajan <[email protected]>
Co-authored-by: kolchfa-aws <[email protected]>
Signed-off-by: Srikanth Govindarajan <[email protected]>
Co-authored-by: kolchfa-aws <[email protected]>
Signed-off-by: Srikanth Govindarajan <[email protected]>
srikanthjg and others added 8 commits November 14, 2025 12:10
Co-authored-by: kolchfa-aws <[email protected]>
Signed-off-by: Srikanth Govindarajan <[email protected]>
Co-authored-by: kolchfa-aws <[email protected]>
Signed-off-by: Srikanth Govindarajan <[email protected]>
Co-authored-by: kolchfa-aws <[email protected]>
Signed-off-by: Srikanth Govindarajan <[email protected]>
Co-authored-by: kolchfa-aws <[email protected]>
Signed-off-by: Srikanth Govindarajan <[email protected]>
Co-authored-by: kolchfa-aws <[email protected]>
Signed-off-by: Srikanth Govindarajan <[email protected]>
Co-authored-by: kolchfa-aws <[email protected]>
Signed-off-by: Srikanth Govindarajan <[email protected]>
Co-authored-by: kolchfa-aws <[email protected]>
Signed-off-by: Srikanth Govindarajan <[email protected]>
Signed-off-by: Srikanth Govindarajan <[email protected]>
@kolchfa-aws kolchfa-aws added Editorial review PR: Editorial review in progress and removed Doc review PR: Doc review in progress Awaiting response labels Nov 14, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

backport 3.3 Editorial review PR: Editorial review in progress

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants