Clarify MemoryClient deprecation status - documentation inconsistency
Maintainers usually reply within 1 day
Nobody has claimed this yet.
Assessment
- Difficulty
- 5/5
- Estimated time
- Over a week
- Newbie friendliness
- 35/100
- Issue type
- Documentation
- Clarity
- Mostly clear
- Activity status
- Stale
- Tech stack
- python
- Domain
- documentation
Research direction
Start by comparing the three MemoryClient references in src/bedrock_agentcore/memory/README.md with MemoryClient.init() in src/bedrock_agentcore/memory/client.py. Review the three proposed options and confirm the intended deprecation policy with a maintainer before editing. Done means the documentation and any approved warning behavior consistently describe MemoryClient’s status.
Written by the indexing model from the issue text.
Description
Summary
The documentation for MemoryClient has inconsistent messaging about its status:
src/bedrock_agentcore/memory/README.md#L39: "MemoryClient - Legacy client interface (still supported but not recommended for new projects)"src/bedrock_agentcore/memory/README.md#L120: "While still supported, we recommend migrating to MemorySessionManager for new projects"src/bedrock_agentcore/memory/README.md#L555: "MemoryClient: Legacy client interface (deprecated)"
The first two say "still supported" while the third says "deprecated". Additionally, there's no actual DeprecationWarning in the code when users instantiate MemoryClient.
Proposed Options
Option A: Formally deprecate MemoryClient
- Add
DeprecationWarningtoMemoryClient.__init__() - Update all documentation to consistently say "deprecated"
- Set a target removal version (e.g., v2.0.0)
Option B: Keep as "legacy" without formal deprecation
- Remove "deprecated" from API Reference section
- Keep "legacy" and "not recommended" language
- No code changes needed
Option C: Staged approach
- Fix documentation to be consistent ("legacy, not recommended")
- Add deprecation warning in a future minor release
- Remove in a future major release
- Dominant language
- Python
- Stars
- 786
- Forks
- 163
- Avg merge
- 4h
- Merged PRs (30d)
- 22
Getting set up
- No Dockerfile or Docker Compose file
- No pull request template
- Read the contributing guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from aws/bedrock-agentcore-sdk-python
-
bug high-severity
Difficulty 2/5 1-3 hours Newbie friendliness 72/100
aws/bedrock-agentcore-sdk-python#752 ·
Maintainers usually reply within 1 day
-
bug
Difficulty 2/5 1-3 hours Newbie friendliness 82/100
aws/bedrock-agentcore-sdk-python#751 · 1 reaction ·
Maintainers usually reply within 1 day
-
delete_all_long_term_memories_in_namespace deletes only the first 10 recordsPossibly taken @Fire162 claimed this 18 days ago. Openbug high-severity
Difficulty 2/5 1-3 hours Newbie friendliness 75/100
aws/bedrock-agentcore-sdk-python#727 ·
Maintainers usually reply within 1 day
-
MPP: credential is always sent in Authorization, ignoring header="Payment-Authorization" in the challengePossibly taken @abhiramshaji-cyber claimed this 24 days ago. Openbug
Difficulty 2/5 1-3 hours Newbie friendliness 68/100
aws/bedrock-agentcore-sdk-python#702 ·
Maintainers usually reply within 1 day
-
[Bug] update_message fails with parameter validation error when SessionMessage.message_id is a Strands positional integer indexPossibly taken @citizen204 claimed this 144 days ago. Open
Difficulty 2/5 1-3 hours Newbie friendliness 68/100
aws/bedrock-agentcore-sdk-python#556 ·
Maintainers usually reply within 1 day
All issues in aws/bedrock-agentcore-sdk-python
Similar issues
-
Difficulty 1/5 Under an hour Newbie friendliness 88/100
snap-stanford/Biomni#380 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 74/100
microsoft/playwright-python#3361 ·
Maintainers usually reply within 1 day
-
documentation priority: low size: S status: needs triage
Difficulty 2/5 1-3 hours Newbie friendliness 74/100
cubrid-lab/sqlalchemy-cubrid#1397 ·
Maintainers usually reply within 1 day
-
documentation priority: low size: S status: needs triage
Difficulty 2/5 1-3 hours Newbie friendliness 72/100
cubrid-lab/pycubrid#1307 ·
Maintainers usually reply within 1 day
-
[Bug]: Installer hides SSL certificate errors as bare URLError, and the suggested fix can't workOpenbug
Difficulty 2/5 1-3 hours Newbie friendliness 80/100
ShaftHQ/chaosengine-harness#143 ·
Maintainers usually reply within 1 day