[Documentation] - Replace limit=123
/maxResults=123
placeholders with actual valid range or max value
#4088
Labels
documentation
This is a problem with documentation.
feature-request
This issue requests a feature.
p3
This is a minor priority issue
Describe the issue
In the Boto3 documentation,
limit=123
(orLimit=123
) is used as a placeholder to show how a limit value is passed. For example, see the describe_log_users command. But the maximum value forlimit
in that example is actually 50. This can be confusing, because different commands/APIs have varying valid ranges.So the request is: can we document the "Valid Range" for
limit
in the Boto3 documentation, or document the actual maximum value allowed per command?There was already some team discussion regarding this issue: if a range were documented, then that would also be misleading because the request expects an integer, not a range. And if the maximum value is shown, then that might lead to some customers paying more for requests than they intended. So there is still some debate as far as the best path forward here.
This issue has been reported a few times, for example:
We decided to close those issues in favor of using this as a consolidated tracking issue. Please feel free to 👍 this issue and comment with any feedback/questions.
The text was updated successfully, but these errors were encountered: