AddUserMetaData Method

Adds meta data to an object.

Syntax

amazons3.addUserMetaData(key, value, [callback])

Callback

The 'callback' parameter specifies a function which will be called when the operation completes (or an error is encountered). If the 'callback' parameter is not specified, then the method will block and will not return until the operation completes (or an error is encountered).

The callback for this method is defined as:

function(err){ }

'err' is the error that occurred. If there was no error, then 'err' is 'null'.

'err' has 2 properties which hold detailed information:

err.code
err.message

Remarks

This method allows you to associate user meta data with an object. Before calling CreateObject use this method to add up to 2k of user meta data. The "x-amz-meta" prefix is added automatically and will be ignored if specified.

The meta data will be accessible through the Header when calling GetObject.

When unprintable characters are supplied, an "x-amz-missing-meta" header is returned from the server with a number which specifies the number of unprintable entries.