Skip to content

Improve documentation for waitersΒ #6508

@aBurmeseDev

Description

@aBurmeseDev

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/

Sub-issues

Metadata

Metadata

Assignees

Labels

documentationThis is a problem with documentation.p2This is a standard priority issuequeuedThis issues is on the AWS team's backlog

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions