Skip to content

Commit 86297f4

Browse files
committed
Add version compatibility readme entry
1 parent 85f098a commit 86297f4

1 file changed

Lines changed: 15 additions & 0 deletions

File tree

VERSIONING.md

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,21 @@ 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+
27+
**Best Practice: Use matching versions across all SDK modules.**
28+
29+
The SDK supports limited mixed version combinations within the same minor version boundary only. 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.
30+
31+
### Supported Version Combinations
32+
33+
-**Recommended**: All modules at the same version (e.g., `2.34.5`)
34+
-**Limited Support**: New core + old service within the same minor version (e.g., `sdk-core 2.34.5` with `s3 2.34.2`)
35+
36+
37+
-**Not Supported**: Cross minor-version mixing (e.g., `sdk-core 2.34.x` with `s3 2.32.y`)
38+
-**Not Supported**: Old core + new service (causes compile-time failures)
39+
2540
## Internal APIs
2641

2742
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)