Skip to content

Commit c0bff4b

Browse files
authored
Add version compatibility readme entry (#6521)
* Add version compatibility readme entry * Add clarifications * Fix doc
1 parent 530164b commit c0bff4b

File tree

1 file changed

+6
-0
lines changed

1 file changed

+6
-0
lines changed

VERSIONING.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,12 @@ following in the AWS SDKs and Tools Shared Configuration and Credentials Referen
2222

2323
The SDK versions all service clients (e.g. `S3`, `EC2`, `DynamoDb`, etc) and the runtime (e.g. `aws-config`) together under a single version. This allows customers to easily upgrade multiple SDK clients at once and keep dependencies, such as the core runtime, compatible. The SDK may in the future consider versioning service clients separately from one another.
2424

25+
## Component Version Compatibility
26+
**Always use the same version across all AWS SDK dependencies**. Mixed versions can cause runtime exceptions or compile time errors depending on which components are mismatched
27+
28+
The easiest way to ensure version consistency is to use the [AWS SDK BOM](https://github.com/aws/aws-sdk-java-v2/?tab=readme-ov-file#importing-the-bom), which automatically manages all SDK dependency versions for you.
29+
30+
2531
## Internal APIs
2632

2733
Any API marked with either `@SdkInternalApi` or `@SdkTestInternalApi` is not subject to any backwards compatibility guarantee. These are meant to be consumed only by the SDK and may be changed or removed without notice. The SDK MAY bump the `MINOR` version when making such a change.

0 commit comments

Comments
 (0)