Cognito admin_create_user API param username need to align with sign in options

[KnightArthurRen]

Describe the issue

The docs on the admin_create_user only says Username param should be a UTF-8 string. However when I was trying it out, this only hold true if your user pool have user name sign in options. On my case the user pool only have email option so if you pass anything else other than a email I got

botocore.errorfactory.InvalidParameterException: An error occurred (InvalidParameterException) when calling the AdminCreateUser operation: Username should be an email.

I just think it's kind of ambiguous on what exactly does Username param refer to as in email sign in option the "username" of a given user is actually the sub while the Username in API is actually the email.

Thank you!

Links

https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/cognito-idp/client/admin_create_user.html

[indrora]

This is a common confusion on Cognito user pools, and you're right it should be updated in the documentation.

[indrora]

Since this is an issue in the service documentation, the best way to do provide feedback to the team responsible (apologies that this is a fragmented portion of our system) is to provide feedback on the raw API documentation: https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_AdminInitiateAuth.html (select the "Feedback" button in the upper corner)

[KnightArthurRen]

Ah awesome sorry for the late reply thanks Indrora!