Misleading docs: CognitoIdentityProvider.Client.list_users() #1356
Labels
cognito-idp
documentation
This is a problem with documentation.
p2
This is a standard priority issue
service-api
This issue is caused by the service API, not the SDK implementation.
The docs for
CognitoIdentityProvider.Client.list_users()
shows the following example on how to call this method:Misleading 1 - Limit must be less than 60
When attempting to call this method with
Limit=123
the following exception is thrown:In my opinion, if the max. number of records is 60, the example should display
Limit=60
, or at least this limitation should be mentioned in the docs.Misleading 2 - AttributesToGet
The documentation clearly states the following:
"An array of strings, where each string is the name of a user attribute to be returned for each user in the search results. If the array is empty, all attributes are returned."
If one were to return attributes for all users (max=60 pr. page), this will lead to the following config (based on the documentation above):
WRONG!
In order to make this method return all attributes for all users, the
AttributesToGet
parameter must be excluded, such in this example:Please correct the docs, replacing the phrase "If the array is empty, all attributes are returned." with the phrase "If this parameter is excluded, all attributes are returned.".
See the full docs here:
CognitoIdentityProvider.Client.list_users()
The text was updated successfully, but these errors were encountered: