ListMultipartUploads Method

Lists the current multipart uploads.

Syntax

s3client.listMultipartUploads([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 lists the current multipart uploads in the bucket currently selected by Bucket.

Before calling this method, the ObjectPrefix property may be set in order to restrict the results to only the multipart uploads whose names begin with a given string. The ObjectDelimiter property can also be used to further tune the results returned. The MaxObjects configuration setting may be used to limit the number of results returned.

Calling this method will fire the ObjectList event once for each multipart upload, and will also populate the Objects* properties.

If there are still more multipart uploads available to list when this method returns, the ObjectMarker property will be populated. Continue to call this method until ObjectMarker is empty to accumulate all pages of results in the Objects* properties.

Note: This method is not supported when ServiceProvider is spGoogleStorage (2); Google Cloud Storage does not support multipart uploads.