boto3 inspectorv2 list_findings maxResults example is over the undocumented limit

[RhysRedbearIT]

Describe the issue

Inspector V2 documentation: maxResults (integer) – The maximum number of results the response can return. If your request would return more than the maximum the response will return a nextToken value, use this value when you call the action again to get the remaining results.

Previous V1 documentation: maxResults (integer) – You can use this parameter to indicate the maximum number of items you want in the response. The default value is 10. The maximum value is 500.

boto3 inspectorv2 list_findings maxResults has no documented limit, and the example is over the undocumented limit. Suspect the example request was copied without realising the limit had changed.

In the Request Syntax maxResults=123,

If you try this: An error occurred (ValidationException) when calling the ListFindings operation: 1 validation error detected: Value at 'maxResults' failed to satisfy constraint: Member must have value less than or equal to 100

Example should be changed to under/equal to 100, and the documentation needs to specify what the max (and possible min) maxResults value can be.

API limit is 1 to 100.

Links

https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/inspector2/client/list_findings.html

[tim-finnigan]

Thanks for reporting. This issue has come up a few times, and I created a tracking issue (https://github.com/boto/boto3/issues/4088) to consolidate those. I went ahead and added this issue there as well, and we can continue tracking there going forward.

[github-actions[bot]]

This issue is now closed. Comments on closed issues are hard for our team to see. If you need more assistance, please open a new issue that references this one.