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.

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

boto3 inspectorv2 list_findings maxResults example is over the undocumented limit #4179

Closed
RhysRedbearIT opened this issue Jun 28, 2024 · 2 comments
Assignees
Labels
documentation This is a problem with documentation. duplicate This issue is a duplicate.

Comments

@RhysRedbearIT
Copy link

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

@RhysRedbearIT RhysRedbearIT added documentation This is a problem with documentation. needs-triage This issue or PR still needs to be triaged. labels Jun 28, 2024
@tim-finnigan tim-finnigan self-assigned this Jun 28, 2024
@tim-finnigan tim-finnigan added duplicate This issue is a duplicate. and removed needs-triage This issue or PR still needs to be triaged. labels Jun 28, 2024
@tim-finnigan
Copy link
Contributor

Thanks for reporting. This issue has come up a few times, and I created a tracking issue (#4088) to consolidate those. I went ahead and added this issue there as well, and we can continue tracking there going forward.

@tim-finnigan tim-finnigan closed this as not planned Won't fix, can't repro, duplicate, stale Jun 28, 2024
Copy link

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation This is a problem with documentation. duplicate This issue is a duplicate.
Projects
None yet
Development

No branches or pull requests

2 participants