Skip to content

feat! REQUIRED: Docs update for: Added option to pass existing boto3 … #143

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

rbpotter-aws
Copy link

Description
This PR adds comprehensive documentation for Memory Tool Session Management, including detailed session injection capabilities for the Strands memory tool. The changes provide users with complete guidance on using custom boto3 sessions for flexible AWS authentication patterns when accessing Amazon Bedrock Knowledge Bases.

Type of Change
[x] New content addition
[x] Content update/revision
[x] Structure/organization improvement
[x] Typo/formatting fix
Motivation and Context
The memory tool previously lacked detailed documentation on its session injection capabilities, which are crucial for:

Multi-environment deployments (dev/staging/prod)
Cross-account AWS access
Role-based access control
Regional data compliance requirements
Advanced authentication scenarios
This documentation fills that gap by providing comprehensive guidance on session management patterns that enable flexible and secure AWS authentication.

Areas Affected
New Documentation:

  • docs/docs/user-guide/concepts/tools/memory-tool-sessions.md - New comprehensive guide (958 lines)
    • Session management functions (set_memory_session, get_memory_session)
    • Authentication patterns (default, custom profiles, cross-account)
    • Multiple session management examples
    • Use cases and best practices
    • Security considerations and troubleshooting
    • Complete code examples for all scenarios

Updated Documentation:

  • docs/docs/user-guide/concepts/tools/example-tools-package.md - Enhanced tools overview
  • Added cross-reference to detailed session management documentation
  • Fixed heading level consistency (h4 → h3)
  • Corrected code block language specifications

Key Features Added
Session Management Functions

  • Complete documentation of set_memory_session() and get_memory_session() functions
  • Parameter specifications, usage examples, and best practices

Authentication Patterns

  • Default Session Usage: Using AWS credential chain
  • Custom AWS Profiles: Environment-specific authentication
  • Cross-Account Access: STS assume role patterns
  • Multi-Session Management: Managing multiple environments simultaneously

Comprehensive Examples

  • 26+ working code examples covering all authentication scenarios
  • Real-world use cases for different deployment patterns
  • Error handling and troubleshooting examples

Best Practices & Security

  • Session lifecycle management
  • Credential rotation and expiration handling
  • Security considerations and audit logging
  • Least privilege access patterns

Quality Assurance Completed
Code Validation ✅

  • All 27 code examples are syntactically correct and functional
  • Function signatures match actual implementation
  • Import statements and error handling are properly included

Link Validation ✅

  • All internal documentation links verified
  • External AWS documentation links tested and working
  • Cross-references between documentation pages added

Consistency Review ✅

  • Consistent heading hierarchy throughout
  • Proper code block formatting with language specifications
  • Parameter naming consistency maintained
  • Documentation style follows project standards

Checklist
[x] I have read the CONTRIBUTING document
[x] My changes follow the project's documentation style
[x] I have tested the documentation locally using validation scripts
[x] Links in the documentation are valid and working
[x] All code examples are syntactically correct and functional
[x] Documentation structure and formatting are consistent

Additional Notes
This documentation significantly enhances the memory tool's usability by providing clear guidance on advanced authentication scenarios. The comprehensive examples and troubleshooting sections will help users implement secure, production-ready session management patterns for their Strands agents.

The documentation is designed to be both a tutorial for new users and a reference guide for advanced use cases, supporting the full spectrum of AWS authentication patterns commonly needed in enterprise environments.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant