aws / aws-sdk-js-v3

Modularized AWS SDK for JavaScript.
Apache License 2.0
3.09k stars 577 forks source link

Add Range for 'MaxRecords' parameter #5727

Closed chrisnellis closed 9 months ago

chrisnellis commented 9 months ago

Describe the issue

When running with a MaxRecords parameter set to '1', I got an error message that says "Invalid value for max records. Must be between 20 and 100".

Please add this range to the docs here for better visibility.

Links

https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/elasticache/command/DescribeServerlessCachesCommand/

RanVaknin commented 9 months ago

Hi @chrisnellis ,

Thanks for reaching out. The JS SDK docs are code-generated directly from every AWS service's API docs. In this case Elastic Cache's doc: https://docs.aws.amazon.com/AmazonElastiCache/latest/APIReference/API_DescribeServerlessCaches.html

Since our docs are code generated from the service's docs, we cannot make changes to them on the SDK level, and changes need to be made upstream on the service level.

You can use the Feedback button a the top right corner of the page, and your bug report will be submitted directly to the service's doc writers.

Since this is not actionable by the SDK team, I will close this.

Thanks again for taking the time and submit the issue. All the best, Ran~

github-actions[bot] commented 8 months ago

This thread has been automatically locked since there has not been any recent activity after it was closed. Please open a new issue for related bugs and link to relevant comments in this thread.