Misleading docs: CognitoIdentityProvider.Client.list_users()

[jonasao]

The docs for CognitoIdentityProvider.Client.list_users() shows the following example on how to call this method:

response = client.list_users(
    UserPoolId='string',
    AttributesToGet=[
        'string',
    ],
    Limit=123,
    PaginationToken='string',
    Filter='string'
)

Misleading 1 - Limit must be less than 60

When attempting to call this method with Limit=123 the following exception is thrown:

botocore.errorfactory.InvalidParameterException: 
An error occurred (InvalidParameterException) when calling the ListUsers operation:
1 validation error detected: Value '100' at 'limit' failed to satisfy constraint: 
Member must have value less than or equal to 60

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):

response = client.list_users(
    UserPoolId='string',
    AttributesToGet=[ ],
    Limit=60,
    PaginationToken='string',
    Filter='string'
)

WRONG!

In order to make this method return all attributes for all users, the AttributesToGet parameter must be excluded, such in this example:

response = client.list_users(
    UserPoolId='string',
    Limit=60,
    PaginationToken='string',
    Filter='string'
)

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()

[kyleknap]

Thanks for the feedback. We generate our documentation from upstream sources so we will pass on the feedback upstream in order for our documentation for those two parameters to get updated as well. We will also look into seeing if we can get an example added as well so there is sample code other than the request syntax snippet, which is not guaranteed to work if you use it exactly as is.

[thelpbogeyman]

This is still an issue - as of latest version of docs (v2.1.1) and code (boto3==1.16.18).

[doug65536]

Omitting the AttributesToGet parameter does not make it list all attributes. The documentation says that you get all attributes if you specify null. There is no null in Python, passing None causes an invalid parameter exception.

[tim-finnigan]

Thanks all for your patience. The recently came up in another issue (#4079). After discussion with the team, we decided to create a new tracking issue (#4088) that consolidates these two and provides some more context on the team's thoughts. Please feel free to 👍 and comment on that issue going forward.

[github-actions]

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.