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.

Sign up for GitHub

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

Jump to bottom

Improve documentation for waiters #6508

Open
aBurmeseDev opened this issue Sep 23, 2024 · 1 comment
Open

Improve documentation for waiters #6508

aBurmeseDev opened this issue Sep 23, 2024 · 1 comment
Assignees
@aBurmeseDev
Labels
documentation This is a problem with documentation. p2 This is a standard priority issue queued This issues is on the AWS team's backlog

Comments

@aBurmeseDev
Copy link
Member

Describe the issue

Current waiter pages could use some examples with more detailed description on the config params. For example: maxWaitTime is a required field for waiter config and it's not mentioned anywhere in the docs.

Here's a blog post about waiters with useful references: https://aws.amazon.com/blogs/developer/waiters-in-modular-aws-sdk-for-javascript/

Links

https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-s3/Variable/waitUntilBucketExists/
@aBurmeseDev aBurmeseDev added documentation This is a problem with documentation. needs-triage This issue or PR still needs to be triaged. labels Sep 23, 2024
@aBurmeseDev aBurmeseDev mentioned this issue Sep 23, 2024
Closed
4 tasks
@aBurmeseDev aBurmeseDev removed the needs-triage This issue or PR still needs to be triaged. label Sep 23, 2024
@aBurmeseDev aBurmeseDev self-assigned this Sep 23, 2024
@aBurmeseDev aBurmeseDev added p2 This is a standard priority issue queued This issues is on the AWS team's backlog labels Sep 23, 2024
@arianvp
Copy link

arianvp commented Dec 23, 2024

Please also document the kind of exceptions it returns. This is currently undocumented

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@aBurmeseDev aBurmeseDev

Labels
documentation This is a problem with documentation. p2 This is a standard priority issue queued This issues is on the AWS team's backlog
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@arianvp @aBurmeseDev