search

aws / aws-sdk-js-v3

Modularized AWS SDK for JavaScript.
Apache License 2.0
3.13k stars 580 forks source link

GetIdCommand Input documentation does not include "REGION" in format. Minor issue. #5792

Open JonVDB opened 9 months ago

JonVDB commented 9 months ago

Describe the issue

For the "Logins" Input Parameter, the "Amazon Cognito user pool" option provides the format "cognito-idp..amazonaws.com/YOUR_USER_POOL_ID" while it should be "cognito-idp.YOUR_REGION.amazonaws.com/YOUR_USER_POOL_ID". The actual example right after does demonstrate this: "cognito-idp.us-east-1.amazonaws.com/us-east-1_123456789"

Just a minor issue. :)

Links

https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/cognito-identity/command/GetIdCommand/

RanVaknin commented 9 months ago

Hi @JonVDB ,

Thanks for the report. Seems like the browser treats the placeholder <region> as an HTML tag and attempts to close it, resulting in a .. redacted:

image

Our docs are generated from the AWS service docs here.

I personally think that the fact that the second example provided within that same sentence does include the region makes it pretty self explanatory, but I'll add to our backlog anyway.

Thanks, Ran~

JonVDB commented 9 months ago

Hey @RanVaknin !

Thanks for the swift update. I wasn't aware about that HTML-tag being there. You're definitely right in that the example makes it sufficiently self-explanatory. I figured I'd still report it in case it causes similar issues elsewhere.

Thanks! 🙂