aws / aws/aws-encryption-sdk-python

thread safety up

Open
#701 0 comments 2 reactions 0 assignees View on GitHub
Dominant language
Python
Stars
255
Forks
92
Avg merge
2d 17h
Merged PRs (30d)
2

Description

### Problem:

[Thread safety](https://github.com/aws/aws-encryption-sdk-python?tab=readme-ov-file#thread-safety) section contains link to the [resources doc](https://boto3.amazonaws.com/v1/documentation/api/latest/guide/resources.html#multithreading-or-multiprocessing-with-resources) but aws-encryption-sdk-python does not use boto3 resources and use boto3 client. According to [clients doc](https://boto3.amazonaws.com/v1/documentation/api/latest/guide/clients.html#multithreading-or-multiprocessing-with-clients) it's thread-safe and could be used in a multithreaded application.

I read #560 and [https://github.com/aws/aws-encryption-sdk-python/issues/11#issuecomment-330716036](https://github.com/aws/aws-encryption-sdk-python/issues/11#issuecomment-330716036), there used irrelevant boto docs, because aws-encryption-sdk-python does not use boto3 resource, but client.

### Solution:

Review multithreaded guidelines and update doc.

Contributor guide

Open the contributing guide

Research direction

Start with the Thread safety section in the README and compare its current resources link with the boto3 clients multithreading guidance cited in the issue. Update the documentation to reflect the SDK's use of boto3 clients and their thread-safety guidance; done means the links and wording are accurate.

Written by the indexing model from the issue text.

Assessment

Tech stack
aws, python
Domain
documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.