What parameters does S3Client::putObject() expect?

[martinbean]

I’m having trouble with the putObject() method of the S3Client class. One of the arguments to be passed is Body. The API documentation says this is to be an array, but doesn’t say or give an example of parameters/keys that should be contained in this array.

I have an upload working, but the file being placed on my Amazon S3 set-up is empty because I’m obviously passing some incorrect data to it, and don‘t know what I should be passing. Below is my current code:

$file = 'public/test.jpg';

try {
    $result = $container['amazon_s3']->putObject(array(
        'Bucket' => (string) $container['misc_config']->images->amazon->bucket,
        'Key' => 'images/test_martin/test.jpg',
        'ContentType' => mime_content_type($file),
        'Body' => array(
            'file' => $file,
            'size' => filesize($file)
        )
    ));
    print '<pre>';
    print_r($result);
    exit;
}
catch (\Exception $e) {
    echo $e->getMessage();
    exit;
}

Any help would be much appreciated.

[jeremeamia]

I responded to your forum post earlier today with a fix: https://forums.aws.amazon.com/thread.jspa?threadID=109616&tstart=0

The docs are wrong for the Body option. We will work on getting that fixed.

[martinbean]

Thanks, @jeremeamia. I tried the wrapping the file name in fopen() as per your suggestion, but get the following exception now:

Validation errors: [Body] must be of type string or object

[martinbean]

Actually, I think I may have solved it: I used file_get_contents() instead.

[jeremeamia]

Yes, file_get_contents() should work fine.

Also, you can use the EntityBody object from Guzzle in conjunction with fopen:

'Body' => EntityBody::factory(fopen($file, 'r'))

This might work better for larger files since you won't have to load the entire file into memory at once as you would with file_get_contents().

I apologize for misleading you with my previous comment.

[martinbean]

Hi Jeremy. No problem. Thanks for clearing this up for me! Much appreciated. I’m new to this Guzzle 😉

[martinbean]

Another question: how do I mark a uploaded file as public? I’m reading the API documentation again (http://docs.amazonwebservices.com/aws-sdk-php-2/latest/class-Aws.S3.S3Client.html) but it’s not too clear the expected values. I’m guessing I want to set something for the ACL key, but not what to set it as. Sample values would be great if possible?

EDIT: Fixed it myself (again)! To mark a file as public, I imported the Aws\S3\Enum\CannedAcl class and used the CannedAcl::PUBLIC_READ class constant.

[jeremeamia]

Yep, you got it! For any enum-like values we have classes under the Enum namespace for that client. Hopefully we can better call information like that out as we improve our docs.

[martinbean]

Cool. Is there a channel where I can report small things like this that are hard-to-understand or could be better-documented if I come across anything?

[jeremeamia]

Right here on the GitHub issue tracker is going to be the easiest for us to track. Thanks.

[martinbean]

No problem.