[Suggestion] Specifying what ExtraArgs are in the Boto3 S3 Documentation

[Jun711]

Please fill out the sections below to help us address your issue.
What issue did you see ?
I was looking for what ExtraArgs that can be passed in but I couldn't find it in the documentation.

It just says ExtraArgs (dict) -- Extra arguments that may be passed to the client operation

I eventually found this closed issue that tells us where to look for the documentation for ExtraArgs
#789

I hope it can be made more convenient for boto3 users.

[tim-finnigan]

Hi @Jun711, thanks for reaching out! Here is the boto3 documentation for ExtraArgs. Please note it says:

The list of valid ExtraArgs settings is specified in the ALLOWED_UPLOAD_ARGS attribute of the S3Transfer object at boto3.s3.transfer.S3Transfer.ALLOWED_UPLOAD_ARGS.

And these are the ALLOWED_UPLOAD_ARGS found in the page linked above:

ALLOWED_UPLOAD_ARGS = ['ACL', 'CacheControl', 'ContentDisposition', 'ContentEncoding', 'ContentLanguage', 'ContentType', 'ExpectedBucketOwner', 'Expires', 'GrantFullControl', 'GrantRead', 'GrantReadACP', 'GrantWriteACP', 'Metadata', 'RequestPayer', 'ServerSideEncryption', 'StorageClass', 'SSECustomerAlgorithm', 'SSECustomerKey', 'SSECustomerKeyMD5', 'SSEKMSKeyId', 'SSEKMSEncryptionContext', 'Tagging', 'WebsiteRedirectLocation']

[github-actions]

⚠️COMMENT VISIBILITY WARNING⚠️

Comments on closed issues are hard for our team to see.
If you need more assistance, please either tag a team member or open a new issue that references this one.
If you wish to keep having a conversation with other community members under this issue feel free to do so.

[Jun711]

@tim-finnigan Thank you, I figured out where to look for it after I found the closed issue #789

I meant I hope it should be made easier to find.

[tim-finnigan]

Hi @Jun711, thanks for clarifying that. I agree it should be easier to find. I will open a PR to try and raise more visibility to the ExtraArgs on the boto3 S3 documentation page.