Skip to content
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

Document of S3.Client.download_file uses the resource interface #4127

Closed
debugger-zhang opened this issue May 14, 2024 · 2 comments · Fixed by #4128
Closed

Document of S3.Client.download_file uses the resource interface #4127

debugger-zhang opened this issue May 14, 2024 · 2 comments · Fixed by #4128
Labels
documentation This is a problem with documentation. needs-review p3 This is a minor priority issue s3

Comments

@debugger-zhang
Copy link

Describe the issue

The example of the page currently reads:

import boto3
s3 = boto3.resource('s3')
s3.meta.client.download_file('mybucket', 'hello.txt', '/tmp/hello.txt')

There are no need to use the resource interface, which is currently in maintanence mode. The example should use client interface:

import boto3
s3 = boto3.client('s3')
s3.download_file('mybucket', 'hello.txt', '/tmp/hello.txt')

Links

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

@debugger-zhang debugger-zhang added documentation This is a problem with documentation. needs-triage This issue or PR still needs to be triaged. labels May 14, 2024
@tim-finnigan tim-finnigan self-assigned this May 14, 2024
@tim-finnigan
Copy link
Contributor

Thanks - it looks like the download_file example should be consistent with upload_file here. Created #4128 to update.

@tim-finnigan tim-finnigan added s3 p3 This is a minor priority issue and removed needs-triage This issue or PR still needs to be triaged. labels May 14, 2024
@tim-finnigan tim-finnigan removed their assignment May 14, 2024
Copy link

This issue is now closed. Comments on closed issues are hard for our team to see.
If you need more assistance, please open a new issue that references this one.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation This is a problem with documentation. needs-review p3 This is a minor priority issue s3
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants