boto / boto3

AWS SDK for Python
https://aws.amazon.com/sdk-for-python/
Apache License 2.0
9.08k stars 1.87k forks source link

(short issue description)generate_presigned_post documentation should provide a link to S3 doc explaining regional default variation in response #4351

Open jrobbins-LiveData opened 1 week ago

jrobbins-LiveData commented 1 week ago

Describe the issue

While documented in a Note here, the boto3 documentation here ought to include a copy of that Note or a link to that page, because it is surprising to call a boto3 function and have the response fields vary with the region.

It would also be helpful to have the boto3 document show that the default legacy behavior on older regions can be upgraded to "modern" via, e.g.

from botocore.client import Config

s3_client = boto3.client('s3', 'us-east-1', config=Config(signature_version='s3v4'))

Text of the Note

Amazon S3 supports Signature Version 4, a protocol for authenticating inbound API requests to AWS services, in all AWS Regions. At this time, AWS Regions created before January 30, 2014 will continue to support the previous protocol, Signature Version 2. Any new Regions after January 30, 2014 will support only Signature Version 4 and therefore all requests to those Regions must be made with Signature Version 4. For more information about AWS Signature Version 2, see Signing and Authenticating REST Requests in the Amazon Simple Storage Service User Guide.

Links

https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/s3/client/generate_presigned_post.html

adev-code commented 1 week ago

Hello @jrobbins-LiveData, thanks for reaching out and finding out a better way for the boto3 documentation. I have reached out to the documentation in regards. If you have any other questions, please let us know. Thank you.

For internal use: P171266421

github-actions[bot] commented 10 hours ago

Greetings! It looks like this issue hasn’t been active in longer than five days. We encourage you to check if this is still an issue in the latest release. In the absence of more information, we will be closing this issue soon. If you find that this is still a problem, please feel free to provide a comment or upvote with a reaction on the initial post to prevent automatic closure. If the issue is already closed, please feel free to open a new one.