Skip to content

Commit 9fce81c

Browse files
committed
Fix doc
1 parent 9c75695 commit 9fce81c

File tree

1 file changed

+2
-15
lines changed

1 file changed

+2
-15
lines changed

VERSIONING.md

Lines changed: 2 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -23,23 +23,10 @@ following in the AWS SDKs and Tools Shared Configuration and Credentials Referen
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

2525
## 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
2627

27-
**Best Practice: Use matching versions across all SDK modules.**
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.
2829

29-
The SDK supports mixed version combinations only within the same minor version boundary. Mixed version combinations create untested scenarios that are difficult to reproduce and debug. The SDK team cannot guarantee compatibility testing coverage for all possible version combinations, and issues may require upgrading to matching versions to resolve.
30-
31-
Cross minor version mixing is not supported and may cause runtime exceptions when newer core components call methods that older service modules only implement as default stubs.
32-
33-
### Supported Version Combinations
34-
35-
-**Recommended**: All modules at the same version (e.g., `2.34.5`)
36-
-**Limited Support**: New core + old service within the same minor version (e.g., `sdk-core 2.34.5` with `s3 2.34.2`)
37-
38-
39-
-**Not Supported**: Cross minor-version mixing (e.g., `sdk-core 2.34.x` with `s3 2.32.y`)
40-
-**Not Supported**: Old core + new service (causes compile-time failures)
41-
42-
Use the [SDK BOM (Bill of Materials)](https://github.com/aws/aws-sdk-java-v2/?tab=readme-ov-file#importing-the-bom) to automatically manage compatible versions across all SDK modules and prevent version mismatches.
4330

4431
## Internal APIs
4532

0 commit comments

Comments
 (0)