aws-sdk-js-v3 icon indicating copy to clipboard operation
aws-sdk-js-v3 copied to clipboard

What IS the principal? The cert? And Arn? this should be more descriptive and there should be an example.

Open jknotamzn opened this issue 8 months ago • 2 comments

Describe the issue

principal | Required | String | undefined | The principal.

Links

https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/iot/command/ListPrincipalThingsCommand/

jknotamzn avatar May 17 '25 03:05 jknotamzn

Hi @jknotamzn - thanks for checking in.

Principal is mentioned in the docs description, second sentence. Does that help?

A principal can be X.509 certificates, IAM users, groups, and roles, Amazon Cognito identities or federated identities.

Image

aBurmeseDev avatar May 20 '25 17:05 aBurmeseDev

So is it an Arn then?

"The principal." should be "The principal's ARN" "The Things." should be "An array of thing names" or "An array of thing ARNs"

Just seems that the documentation for much of the IoT stuff is lacking in this way, its very vague.

jknotamzn avatar May 20 '25 22:05 jknotamzn

Thanks for your feedback, I'll pass it along to the docs team. Here's service docs that explains three types of identity principals that client IoT support for your reference: https://docs.aws.amazon.com/iot/latest/developerguide/client-authentication.html

aBurmeseDev avatar Oct 28 '25 17:10 aBurmeseDev

This thread has been automatically locked since there has not been any recent activity after it was closed. Please open a new issue for related bugs and link to relevant comments in this thread.

github-actions[bot] avatar Nov 16 '25 00:11 github-actions[bot]