Skip to content

boto3 S3 get_object docs do not describe StreamingBody object #4538

@mderner-ca

Description

@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

Metadata

Metadata

Assignees

Labels

documentationThis is a problem with documentation.p3This is a minor priority issues3

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions