IPWorks S3 2020 Node.js Edition

Questions / Feedback?

StartMultipartUpload Method

Starts a new multipart upload.


s3client.startMultipartUpload(objectName, [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, data){ }

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

'data' is the value returned by the method.

'err' has 2 properties which hold detailed information:



This method starts a new multipart upload for an object named ObjectName, in the bucket currently selected by Bucket, and returns the upload Id that the server associates with it. This upload Id can then be used to call the following methods:

If there are any metadata items present in the Metadata* properties, they will be included in the creation request, and will be applied to the final object after the multipart upload is completed with CompleteMultipartUpload.

Multipart uploads never expire, they must be explicitly completed or aborted using CompleteMultipartUpload or AbortMultipartUpload. The ListMultipartUploads method can be used to retrieve a list of current multipart uploads.

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

IPWorks S3 2020 Node.js Edition - Version 20.0 [Build 7722]