StartMultipartUpload Method

Starts a multipart upload and returns an UploadId.

Syntax

amazons3.startMultipartUpload(objectName, [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, 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:

err.code
err.message

Remarks

Begins a multipart upload. This method will initiate a multipart upload and return the UploadId associated with the upload. There is no expiration of the upload. The upload must be completed by calling CompleteMultipartUpload or aborted by calling AbortMultipartUpload.

The UploadId returned by this method is used to reference the upload when uploading parts via UploadPart and other operations such as AbortMultipartUpload, CompleteMultipartUpload, and ListParts.

The UploadId may also be retrieved at a later time by calling ListMultipartUploads.