AWS Well-Architected Tool: reviewOwner field marked Required in UI but Optional in API documentation

[niraj-ranjan-comprinno]

Describe the issue

While working with the AWS Well-Architected Tool, we identified an inconsistency in the reviewOwner field requirement between the UI and the API documentation.

AWS Well-Architected Tool UI:
reviewOwner is marked as Required

AWS Well-Architected Tool API documentation:
reviewOwner is documented as Optional

This discrepancy leads to confusion during automation and API-based integrations.

Links

https://docs.aws.amazon.com/wellarchitected/latest/APIReference/API_CreateWorkload.html#wellarchitected-CreateWorkload-request-ReviewOwner

[bhoradc]

Hello @niraj-ranjan-comprinno

Looking at the service API documentation, I can see that while ReviewOwner is listed as optional in the parameter table, there's an explicit note stating: "You also must specify ReviewOwner, even though the parameter is listed as not being required in the following section."

Therefore this appears to be intentional design by the service team to handle different use cases where ReviewOwner may have conditional requirements.

Since this is a Java SDK repository, if you have further queries regarding the service API documentation, I would suggest to submit a documentation feedback from the AWS Well-Architected Tool API Reference page. This will route your feedback directly to the concerned service team who manages that documentation and can provide more context about the parameter requirements.

Regards,
Chaitanya