Skip to content

Commit ce1bc97

Browse files
chore: Add support policy (#352)
1 parent f17586a commit ce1bc97

File tree

2 files changed

+41
-0
lines changed

2 files changed

+41
-0
lines changed

README.rst

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,8 @@ Find us on `GitHub`_.
2626

2727
`Security issue notifications`_
2828

29+
See `Support Policy`_ for details on the current support status of all major versions of this library.
30+
2931
***************
3032
Getting Started
3133
***************
@@ -49,6 +51,7 @@ Installation
4951
5052
$ pip install aws-encryption-sdk
5153
54+
5255
Concepts
5356
========
5457
There are four main concepts that you need to understand to use this library:
@@ -318,3 +321,4 @@ to your use-case in order to obtain peak performance.
318321
.. _final message: https://docs.aws.amazon.com/encryption-sdk/latest/developer-guide/message-format.html
319322
.. _encryption context: https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#encrypt_context
320323
.. _Security issue notifications: ./CONTRIBUTING.md#security-issue-notifications
324+
.. _Support Policy: ./SUPPORT_POLICY.rst

SUPPORT_POLICY.rst

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
Overview
2+
========
3+
This page describes the support policy for the AWS Encryption SDK. We regularly provide the AWS Encryption SDK with updates that may contain support for new or updated APIs, new features, enhancements, bug fixes, security patches, or documentation updates. Updates may also address changes with dependencies, language runtimes, and operating systems.
4+
5+
We recommend users to stay up-to-date with Encryption SDK releases to keep up with the latest features, security updates, and underlying dependencies. Continued use of an unsupported SDK version is not recommended and is done at the user’s discretion
6+
7+
8+
Major Version Lifecycle
9+
========================
10+
The AWS Encryption SDK follows the same major version lifecycle as the AWS SDK. For details on this lifecycle, see `AWS SDKs and Tools Maintenance Policy`_.
11+
12+
Version Support Matrix
13+
======================
14+
This table describes the current support status of each major version of the AWS Encryption SDK for Python. It also shows the next status each major version will transition to, and the date at which that transition will happen.
15+
16+
.. list-table::
17+
:widths: 30 50 50 50
18+
:header-rows: 1
19+
20+
* - Major version
21+
- Current status
22+
- Next status
23+
- Next status date
24+
* - 1.x
25+
- Maintenance
26+
- End of Support
27+
- 2022-06-30
28+
* - 2.x
29+
- General Availability
30+
- Maintenance
31+
- 2021-07-01
32+
* - 3.x
33+
-
34+
- General Availability
35+
- 2021-07-01
36+
37+
.. _AWS SDKs and Tools Maintenance Policy: https://docs.aws.amazon.com/sdkref/latest/guide/maint-policy.html#version-life-cycle

0 commit comments

Comments
 (0)