ListObjects Method

Lists all objects in a bucket.

Syntax

amazons3.listObjects([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

The output is retrieved through the ObjectList event. The output can also be retrieved by using the Objects property.

The bucket is specified by the Bucket property. ObjectPrefix, ObjectDelimiter, ObjectMarker can be used to control the objects listed.