awslabs / awslabs/aws-sdk-rust
S3 get_bucket_location Would Benefit from Deprecation Attribute
- Dominant language
- Rust
- Stars
- 3.3k
- Forks
- 290
- Avg merge
- 1d 12h
- Merged PRs (30d)
- 3
Description
### Describe the feature
The AWS [S3 API documentation](https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketLocation.html) notes that HEAD should be used instead of get_bucket_location, presumably because of the non-standard return values for us-east-1/eu-west-1.
Currently, the rust SDK doesn't include a [deprecated attribute](https://doc.rust-lang.org/reference/attributes/diagnostics.html#the-deprecated-attribute), which makes it easy for developers to use a function call that is easy to misuse.
### Use Case
Deprecation attributes on get_bucket_location would help developers avoid using a method that is easy to misuse (in favor of the recommended HEAD method).
### Proposed Solution
_No response_
### Other Information
_No response_
### Acknowledgements
- [ ] I may be able to implement this feature request
- [ ] This feature might incur a breaking change
### A note for the community
### Community Note
* Please vote on this issue by adding a 👍 [reaction](https://blog.github.com/2016-03-10-add-reactions-to-pull-requests-issues-and-comments/) to the original issue to help the community and maintainers prioritize this request
* Please do not leave "+1" or "me too" comments, they generate extra noise for issue followers and do not help prioritize the request
* If you are interested in working on this issue, please leave a comment
Contributor guide
Research direction
Start by locating the Rust SDK entry point for the S3 get_bucket_location operation and compare it with the recommended HEAD operation. Add the Rust deprecation attribute to get_bucket_location, preserving the guidance that HEAD should be used instead, and verify that the SDK emits the expected deprecation warning.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- aws, rust
- Domain
- api, cloud
- Issue type
- Feature
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100