boto3 S3 `get_object` docs do not describe `StreamingBody` object

[mderner-ca]

Describe the issue

On the page for the get_object S3 Client method, the section on response syntax shows that the object data will be presented under the Key "Body" and then goes on to describe that as:

Body (StreamingBody) – Object data.

and that's it. There's no indication of what a StreamingBody is, what attributes it has, no link to it's own doc page, and a thorough scouring of the internet shows that no such page exists. This reduces one to trial and error with a small amount of unofficial forum support, or for the more advanced Pythonista - using the inspect library in the REPL to inspect the nature of the StreamingBody.

Please throw up a page on StreamingBody to detail how to use it and indicate where we may import something that can act as a typehint.

Links

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

[adev-code]

Hello @mderner-ca, thank you for reaching out and for the feedback. I have reached out to S3 Service Team for your request in regards to Body (StreamingBody). Also, we have a corresponding API documentation for that Boto documentation : https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObject.html feedback can be sent also directly to S3 there for future reach outs . Services under Boto documentation are managed by services and in this case it's S3. Moving forward, for any release by the S3 would be logged in our changelog : https://github.com/boto/boto3/blob/master/CHANGELOG.rst?plain=1 and there's no time frame for now. If you have any other questions, please do let me know. Thanks.

For Internal Tracking: P250008798

[github-actions[bot]]

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.

[mderner-ca]

Hello, I can confirm that this is still an issue

[adev-code]

Thank you for reply. The ticket has been made for the S3 service team for their docs to be improved for Boto3. We don't have a timeline on when the Service Team is going to release update. Although, please check the Botocore and Boto3 changelogs for updates.

[github-actions[bot]]

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.