Upload files
You can implement upload functionality in your app by either using the Storage Manager UI component or further customizing the upload experience using the upload API.
Storage Manager React UI Component
Upload files from your app in minutes by using the cloud-connected Storage Manager UI Component.
npm add @aws-amplify/ui-react-storage aws-amplify
Then, use the component in your app.
import { StorageManager } from '@aws-amplify/ui-react-storage';import '@aws-amplify/ui-react/styles.css';
export const DefaultStorageManagerExample = () => { return ( <StorageManager acceptedFileTypes={['image/*']} path="public/" maxFileCount={1} isResumable /> );};
Learn more about how you can further customize the UI component by referring to the Storage Manager documentation.
Implement upload functionality
Upload from file
The following is an example of how you would upload a file from a file object, this could be retrieved from the local machine or a different source.
import React from 'react';import { uploadData } from 'aws-amplify/storage';
function App() { const [file, setFile] = React.useState();
const handleChange = (event: any) => { setFile(event.target.files[0]); };
return ( <div> <input type="file" onChange={handleChange} /> <button onClick={() => uploadData({ path: `photos/${file.name}`, data: file, }) } > Upload </button> </div> );}
Upload from data
You can following this example if you have data saved in memory and would like to upload this data to the cloud.
import { uploadData } from 'aws-amplify/storage';
try { const result = await uploadData({ path: "album/2024/1.jpg", // Alternatively, path: ({identityId}) => `album/{identityId}/1.jpg` data: file, options: { onProgress // Optional progress callback. } }).result; console.log('Succeeded: ', result);} catch (error) { console.log('Error : ', error);}
Monitor upload progress
Monitor progress of upload by using the onProgress
options
import { uploadData } from 'aws-amplify/storage';
const monitorUpload = async () => { try { const result = await uploadData({ path: "album/2024/1.jpg", // Alternatively, path: ({identityId}) => `album/{identityId}/1.jpg` data: file, options: { onProgress: ({ transferredBytes, totalBytes }) => { if (totalBytes) { console.log( `Upload progress ${Math.round( (transferredBytes / totalBytes) * 100 )} %` ); } }, }, }).result; console.log("Path from Response: ", result.path); } catch (error) { console.log("Error : ", error); }}
Pause, resume, and cancel uploads
We have callback functions that support resuming, pausing, and cancelling uploadData
requests.
import { uploadData, isCancelError } from 'aws-amplify/storage';
// Pause, resume, and cancel a taskconst uploadTask = uploadData({ path, data: file });//...uploadTask.pause();//...uploadTask.resume();//...uploadTask.cancel();//...try { await uploadTask.result;} catch (error) { if (isCancelError(error)) { // Handle error thrown by task cancellation }}
More upload options
Option | Type | Description |
---|---|---|
contentType | String | The default content-type header value of the file when downloading it. Read more at Content-Type documentation |
contentEncoding | String | The default content-encoding header value of the file when downloading it. Read more at Content-Encoding documentation |
contentDisposition | String | Specifies presentational information for the object. Read more at Content-Disposition documentation |
metadata | map<String> | A map of metadata to store with the object in S3. Read more at S3 metadata documentation |
useAccelerateEndpoint | boolean | Whether to use accelerate endpoint. Read more at Transfer Acceleration |
MultiPart upload
Amplify will automatically perform an Amazon S3 multipart upload for objects that are larger than 5MB. For more information about S3's multipart upload, see Uploading and copying objects using multipart upload