awslabs / aws-c-s3

C99 library implementation for communicating with the S3 service, designed for maximizing throughput on high bandwidth EC2 instances.
Apache License 2.0
102 stars 41 forks source link

Improve Samples #315

Open tekktonic opened 1 year ago

tekktonic commented 1 year ago

Describe the feature

As far as I know the API is undocumented (at least I can't find it in search engines and it isn't listed on the official AWS docs links,) but samples go a long way. Unfortunately the only sample given is complicated by trying to make the s3 command act like aws s3, and it also uses private APIs. Standalone examples which only use the public API would go a long way.

Use Case

I'm someone trying to use the API, but I'm not even sure where to start aside from calling aws_s3_client new. I'm unable to follow what the given sample does because it uses private APIs which aren't installed when you install the library and it's not clear from reading the public headers how to perform basic tasks like "get an object from s3."

Proposed Solution

No response

Other Information

No response

Acknowledgements

yasminetalby commented 1 year ago

Hello @tekktonic ,

Thank you very much for your submission and feedback.

We have added this in our team backlog. I will be updating this ticket once the samples are released.

Best regards,

Yasmine