A UploadDataWithPathInput
object.
A cancelable and resumable task exposing result promise from result
property.
Service: S3Exception
thrown when checking for existence of the object.
Validation: StorageValidationErrorCode
thrown when a validation error occurs.
// Upload a file to s3 bucket
await uploadData({ path, data: file, options: {
onProgress, // Optional progress callback.
} }).result;
// Cancel a task
const uploadTask = uploadData({ path, data: file });
//...
uploadTask.cancel();
try {
await uploadTask.result;
} catch (error) {
if(isCancelError(error)) {
// Handle error thrown by task cancelation.
}
}
// Pause and resume a task
const uploadTask = uploadData({ path, data: file });
//...
uploadTask.pause();
//...
uploadTask.resume();
//...
await uploadTask.result;
Upload data to the specified S3 object key. By default uses single PUT operation to upload if the payload is less than 5MB. Otherwise, uses multipart upload to upload the payload. If the payload length cannot be determined, uses multipart upload.
Limitations:
A UploadDataInput
object.
A cancelable and resumable task exposing result promise from the result
property.
The key
and accessLevel
parameters are deprecated and will be removed in next major version.
Please use path instead.
Service: S3Exception
thrown when checking for existence of the object.
Validation: StorageValidationErrorCode
thrown when a validation error occurs.
// Upload a file to s3 bucket
await uploadData({ key, data: file, options: {
onProgress, // Optional progress callback.
} }).result;
// Cancel a task
const uploadTask = uploadData({ key, data: file });
//...
uploadTask.cancel();
try {
await uploadTask.result;
} catch (error) {
if(isCancelError(error)) {
// Handle error thrown by task cancelation.
}
}
// Pause and resume a task
const uploadTask = uploadData({ key, data: file });
//...
uploadTask.pause();
//...
uploadTask.resume();
//...
await uploadTask.result;
Upload data to the specified S3 object path. By default uses single PUT operation to upload if the payload is less than 5MB. Otherwise, uses multipart upload to upload the payload. If the payload length cannot be determined, uses multipart upload.
Limitations: