Document / prefer use of BOM for resolving SDK artifacts

[cloudshiftchris]

Describe the issue

Currently the documentation here does not show or mention the BOM. Using the BOM should be the default / recommended approach, as it encapsulates the version constraints.

For example, using the BOM will prevent users from specifying different versions - perhaps accidentally or incidentally - for different service client dependencies (and perhaps other runtime dependencies such as http clients). This can happen even with the version catalog, as those versions are merely an input into dependency resolution (not a constraint) - other components (perhaps transitive dependencies) could specify a higher version of a specific JAR, leading to misalignment and subsequent quirky runtime behaviour.

The AWS Java SDK documents using the BOM here (also in other pages for Maven etc).

Links

https://docs.aws.amazon.com/sdk-for-kotlin/latest/developer-guide/setup-create-project-file.html

[0marperez]

Hi, thanks for the report. I understand how this would be a good addition to our documentation. I've set this issue as standard priority (p2) and created an internal ticket for us to track this and implement into our sprints.