Working with files / attachments

The Storage and GraphQL API categories can be used together to associate a file, such as an image or video, with a particular record. For example, you might create a User model with a profile picture, or a Post model with an associated image. With Amplify's GraphQL API and Storage categories, you can reference the file within the model itself to create an association.

To get started, run the following commands in an existing Amplify project:

1# For Authenticator component:
2npm i @aws-amplify/ui-react
3
4# Select default configuration:
5amplify add auth
6
7# Select "Content", "Auth users only", full CRUD access,
8# and default configuration:
9amplify add storage
10
11# Select default configuration
12amplify add api

When prompted, use the following schema, which can also be found under amplify/backend/api/[name of project]/schema.graphql:

1type Song @model @auth(rules: [{ allow: public }]) {
2  id: ID!
3  name: String!
4  coverArtKey: String # Set as optional to allow adding file after initial create
5}

Save the schema and run amplify push to deploy the changes.

Next, at the root of your project, set all access to private by configuring the Storage object globally. This will restrict file access to only the signed-in user.

1Storage.configure({ level: 'private' });

For the complete working example, including required imports, obtaining the file from the user, and React component state management, see the Complete Example below.

Configuring authorization

Your application needs authorization credentials for reading and writing to both Storage and the GraphQL API, except in the case where all data and files are intended to be publicly accessible.

The Storage and API categories govern data access based on their own authorization patterns, meaning that it's necessary to configure appropriate auth roles for each individual category. Although both categories share the same access credentials set up through the Auth category, they work independently from one another. For instance, adding an @auth directive to the API schema does not guard against file access in the Storage category. Likewise, adding authorization rules to the Storage category does not guard against data access in the API category.

When you run amplify add storage, the CLI will configure appropriate IAM policies on the bucket using a Cognito Identity Pool role. You will then have the option of adding CRUD (Create, Update, Read and Delete) based permissions as well, so that Authenticated and Guest users will be granted limited permissions within these levels. Even after adding this configuration via the CLI, all Storage access is still public by default. To guard against accidental public access, the Storage access levels must either be configured on the Storage object globally, or set within individual function calls. This guide uses the former approach, setting all Storage access to private globally.

The ability to independently configure authorization rules for each category allows for more granular control over data access, and adds greater flexibility. For scenarios where authorization patterns must be mixed and matched, configure the access level on individual Storage function calls. For example, you may want to use private CRUD access on an individual Storage function call for files that should only be accessible by the owner (such as personal files), protected read access to allow all logged in users to view common files (such as images in a shared photo album), and public read access to allow all users to view a file (such as a public profile picture).

For more details on how to configure Storage authorization levels, see the Storage documentation. For more on configuring GraphQL API authorization, see the API documentation.

Create a record with an associated file

First create a record via the GraphQL API, then upload the file to Storage, and finally add the association between the record and file. Use the following example with the GraphQL API and Storage categories to create a record and associate the file with the record.

The API record's id is prepended to the Storage file name to ensure uniqueness. If this is excluded, multiple API records could then be associated with the same file key unintentionally.

1import { generateClient } from 'aws-amplify/api';
2import { uploadData, getUrl } from 'aws-amplify/storage';
3
4const client = generateClient();
5
6const createSongDetails = {
7  name: `My first song`
8};
9
10// Create the API record:
11const response = await client.graphql({
12  query: mutations.createSong,
13  variables: { input: createSongDetails }
14});
15
16const song = response.data.createSong;
17
18if (!song) return;
19
20// Upload the Storage file:
21const result = await uploadData({
22  key: `${song.id}-${file.name}`,
23  data: file,
24  options: {
25    contentType: 'image/png' // contentType is optional
26  }
27}).result;
28
29const updateSongDetails = {
30  id: song.id,
31  coverArtKey: result?.key
32};
33
34// Add the file association to the record:
35const updateResponse = await client.graphql({
36  query: mutations.updateSong,
37  variables: { input: updateSongDetails }
38});
39
40const updatedSong = updateResponse.data.updateSong;
41
42// If the record has no associated file, we can return early.
43if (!updatedSong.coverArtKey) return;
44
45// Retrieve the file's signed URL:
46const signedURL = await getUrl({ key: updatedSong.coverArtKey });

Add or update a file for an associated record

To associate a file with a record, update the record with the key returned by the Storage upload. The following example uploads the file using Storage, updates the record with the file's key, then retrieves the signed URL to download the image. If an image is already associated with the record, this will update the record with the new image.

1import { generateClient } from 'aws-amplify/api';
2import { uploadData, getUrl } from 'aws-amplify/storage';
3
4const client = generateClient();
5// Upload the Storage file:
6const result = await uploadData({
7  key: `${currentSong.id}-${file.name}`,
8  data: file,
9  options: {
10    contentType: 'image/png' // contentType is optional
11  }
12}).result;
13
14const updateSongDetails = {
15  id: currentSong.id,
16  coverArtKey: result?.key
17};
18
19// Add the file association to the record:
20const response = await client.graphql({
21  query: mutations.updateSong,
22  variables: { input: updateSongDetails }
23});
24
25const updatedSong = response.data.updateSong;
26
27// If the record has no associated file, we can return early.
28if (!updatedSong?.coverArtKey) return;
29
30// Retrieve the file's signed URL:
31const signedURL = await getUrl({ key: updatedSong.coverArtKey });

Query a record and retrieve the associated file

To retrieve the file associated with a record, first query the record, then use Storage to get the signed URL. The signed URL can then be used to download the file, display an image, etc:

1import { generateClient } from 'aws-amplify/api';
2import { getUrl } from 'aws-amplify/storage';
3
4const client = generateClient();
5
6// Query the record to get the file key:
7const response = await client.graphql({
8  query: queries.getSong,
9  variables: { id: currentSong.id }
10});
11const song = response.data.getSong;
12
13// If the record has no associated file, we can return early.
14if (!song?.coverArtKey) return;
15
16// Retrieve the signed URL:
17const signedURL = await getUrl({ key: song.coverArtKey });

Delete and remove files associated with API records

There are three common deletion workflows when working with Storage files and the GraphQL API:

Remove the file association, continue to persist both file and record.
Remove the record association and delete the file.
Delete both file and record.

Remove the file association, continue to persist both file and record

The following example removes the file association from the record, but does not delete the file from S3, nor the record from the database.

1import { generateClient } from 'aws-amplify/api';
2
3const client = generateClient();
4
5// Remove the file association, continue to persist both file and record
6const response = await client.graphql({
7  query: queries.getSong,
8  variables: { id: currentSong.id }
9});
10
11const song = response.data.getSong;
12
13// If the record has no associated file, we can return early.
14if (!song?.coverArtKey) return;
15
16const songDetails = {
17  id: song.id,
18  coverArtKey: null
19};
20
21const updatedSong = await client.graphql({
22  query: mutations.updateSong,
23  variables: { input: songDetails }
24});

Remove the record association and delete the file

The following example removes the file from the record, then deletes the file from S3:

1import { generateClient } from 'aws-amplify/api';
2import { remove } from 'aws-amplify/storage';
3
4const client = generateClient();
5
6// Remove the record association and delete the file
7const response = await client.graphql({
8  query: queries.getSong,
9  variables: { id: currentSong.id }
10});
11
12const song = response?.data?.getSong;
13
14// If the record has no associated file, we can return early.
15if (!song?.coverArtKey) return;
16
17const songDetails = {
18  id: song.id,
19  coverArtKey: null // Set the file association to `null`
20};
21
22// Remove associated file from record
23const updatedSong = await client.graphql({
24  query: mutations.updateSong,
25  variables: { input: songDetails }
26});
27
28// Delete the file from S3:
29await remove({ key: song.coverArtKey });

Delete both file and record

1import { generateClient } from 'aws-amplify/api';
2import { remove } from 'aws-amplify/storage';
3
4const client = generateClient();
5
6// Delete both file and record
7const response = await client.graphql({
8  query: queries.getSong,
9  variables: { id: currentSong.id }
10});
11
12const song = response.data.getSong;
13
14// If the record has no associated file, we can return early.
15if (!song?.coverArtKey) return;
16
17await remove({ key: song.coverArtKey });
18
19const songDetails = {
20  id: song.id
21};
22
23await client.graphql({
24  query: mutations.deleteSong,
25  variables: { input: songDetails }
26});

Working with multiple files

You may want to add multiple files to a single record, such as a user profile with multiple images. To do this, you can add a list of file keys to the record. The following example adds a list of file keys to a record:

GraphQL schema to associate a data model with multiple files

When prompted after running amplify add api use the following schema, which can also be found under amplify/backend/api/[name of project]/schema.graphql:

1type PhotoAlbum @model @auth(rules: [{ allow: public }]) {
2  id: ID!
3  name: String!
4  imageKeys: [String] #Set as optional to allow adding file(s) after initial create
5}

CRUD operations when working with multiple files is the same as when working with a single file, with the exception that we are now working with a list of image keys, as opposed to a single image key.

Create a record with multiple associated files

First create a record via the GraphQL API, then upload the files to Storage, and finally add the associations between the record and files.

1import { generateClient } from 'aws-amplify/api';
2import { uploadData, getUrl } from 'aws-amplify/storage';
3
4const client = generateClient();
5
6const photoAlbumDetails = {
7  name: `My first photoAlbum`
8};
9
10// Create the API record:
11const response = await client.graphql({
12  query: mutations.createPhotoAlbum,
13  variables: { input: photoAlbumDetails }
14});
15
16const photoAlbum = response.data.createPhotoAlbum;
17
18if (!photoAlbum) return;
19
20// Upload all files to Storage:
21const imageKeys = await Promise.all(
22  Array.from(e.target.files).map(async (file) => {
23    const result = await uploadData({
24      key: `${photoAlbum.id}-${file.name}`,
25      data: file,
26      options: {
27        contentType: 'image/png' // contentType is optional
28      }
29    }).result;
30
31    return result.key;
32  })
33);
34
35const updatePhotoAlbumDetails = {
36  id: photoAlbum.id,
37  imageKeys: imageKeys
38};
39
40// Add the file association to the record:
41const updateResponse = await client.graphql({
42  query: mutations.updatePhotoAlbum,
43  variables: { input: updatePhotoAlbumDetails }
44});
45
46const updatedPhotoAlbum = updateResponse.data.updatePhotoAlbum;
47
48// If the record has no associated file, we can return early.
49if (!updatedPhotoAlbum.imageKeys?.length) return;
50
51// Retrieve signed urls for all files:
52const signedUrls = await Promise.all(
53  updatedPhotoAlbum.imageKeys.map(async (key) => await getUrl({ key }))
54);

Add new files to an associated record

To associate additional files with a record, update the record with the keys returned by the Storage uploads.

1import { generateClient } from 'aws-amplify/api';
2import { uploadData, getUrl } from 'aws-amplify/storage';
3
4const client = generateClient();
5
6// Upload all files to Storage:
7const newImageKeys = await Promise.all(
8  Array.from(e.target.files).map(async (file) => {
9    const result = await uploadData({
10      key: `${currentPhotoAlbum.id}-${file.name}`,
11      data: file,
12      options: {
13        contentType: 'image/png' // contentType is optional
14      }
15    }).result;
16
17    return result.key;
18  })
19);
20
21// Query existing record to retrieve currently associated files:
22const queriedResponse = await client.graphql({
23  query: queries.getPhotoAlbum,
24  variables: { id: currentPhotoAlbum.id }
25});
26
27const photoAlbum = queriedResponse.data.getPhotoAlbum;
28
29if (!photoAlbum?.imageKeys) return;
30
31// Merge existing and new file keys:
32const updatedImageKeys = [...newImageKeys, ...photoAlbum.imageKeys];
33
34const photoAlbumDetails = {
35  id: currentPhotoAlbum.id,
36  imageKeys: updatedImageKeys
37};
38
39// Update record with merged file associations:
40const response = await client.graphql({
41  query: mutations.updatePhotoAlbum,
42  variables: { input: photoAlbumDetails }
43});
44
45const updatedPhotoAlbum = response.data.updatePhotoAlbum;
46
47// If the record has no associated file, we can return early.
48if (!updatedPhotoAlbum?.imageKeys) return;
49
50// Retrieve signed urls for merged image keys:
51const signedUrls = await Promise.all(
52  updatedPhotoAlbum?.imageKeys.map(async (key) => await getUrl({ key }))
53);

Update the file for an associated record

Updating a file for an associated record is the same as updating a file for a single file record, with the exception that you will need to update the list of file keys.

1import { generateClient } from 'aws-amplify/api';
2import { uploadData, getUrl } from 'aws-amplify/storage';
3
4const client = generateClient();
5
6// Upload new file to Storage:
7const result = await uploadData({
8  key: `${currentPhotoAlbum.id}-${file.name}`,
9  data: file,
10  options: {
11    contentType: 'image/png' // contentType is optional
12  }
13}).result;
14
15const newFileKey = result.key;
16
17// Query existing record to retrieve currently associated files:
18const queriedResponse = await client.graphql({
19  query: queries.getPhotoAlbum,
20  variables: { id: currentPhotoAlbum.id }
21});
22
23const photoAlbum = queriedResponse.data.getPhotoAlbum;
24
25if (!photoAlbum?.imageKeys?.length) return;
26
27// Retrieve last image key:
28const [lastImageKey] = photoAlbum.imageKeys.slice(-1);
29
30// Remove last file association by key
31const updatedImageKeys = [
32  ...photoAlbum.imageKeys.filter((key) => key !== lastImageKey),
33  newFileKey
34];
35
36const photoAlbumDetails = {
37  id: currentPhotoAlbum.id,
38  imageKeys: updatedImageKeys
39};
40
41// Update record with updated file associations:
42const response = await client.graphql({
43  query: mutations.updatePhotoAlbum,
44  variables: { input: photoAlbumDetails }
45});
46
47const updatedPhotoAlbum = response.data.updatePhotoAlbum;
48
49// If the record has no associated file, we can return early.
50if (!updatedPhotoAlbum?.imageKeys) return;
51
52// Retrieve signed urls for merged image keys:
53const signedUrls = await Promise.all(
54  updatedPhotoAlbum?.imageKeys.map(async (key) => await getUrl({ key }))
55);

Query a record and retrieve the associated files

To retrieve the files associated with a record, first query the record, then use Storage to retrieve all of the signed URLs.

1import { generateClient } from 'aws-amplify/api';
2import { getUrl } from 'aws-amplify/storage';
3
4const client = generateClient();
5
6// Query the record to get the file keys:
7const response = await client.graphql({
8  query: queries.getPhotoAlbum,
9  variables: { id: currentPhotoAlbum.id }
10});
11const photoAlbum = response.data.getPhotoAlbum;
12
13// If the record has no associated files, we can return early.
14if (!photoAlbum?.imageKeys) return;
15
16// Retrieve the signed URLs for the associated images:
17const signedUrls = await Promise.all(
18  photoAlbum.imageKeys.map(async (imageKey) => {
19    if (!imageKey) return;
20    return await getUrl({ key: imageKey });
21  })
22);

Delete and remove files associated with API records

The workflow for deleting and removing files associated with API records is the same as when working with a single file, except that when performing a delete you will need to iterate over the list of files keys and call Storage.remove() for each file.

Remove the file association, continue to persist both files and record

1import { generateClient } from 'aws-amplify/api';
2
3const client = generateClient();
4
5const response = await client.graphql({
6  query: queries.getPhotoAlbum,
7  variables: { id: currentPhotoAlbum.id }
8});
9
10const photoAlbum = response.data.getPhotoAlbum;
11
12// If the record has no associated file, we can return early.
13if (!photoAlbum?.imageKeys) return;
14
15const photoAlbumDetails = {
16  id: photoAlbum.id,
17  imageKeys: null
18};
19
20const updatedPhotoAlbum = await client.graphql({
21  query: mutations.updatePhotoAlbum,
22  variables: { input: photoAlbumDetails }
23});

Remove the record association and delete the files

1import { generateClient } from 'aws-amplify/api';
2import { remove } from 'aws-amplify/storage';
3
4const client = generateClient();
5
6const response = await client.graphql({
7  query: queries.getPhotoAlbum,
8  variables: { id: currentPhotoAlbum.id }
9});
10
11const photoAlbum = response.data.getPhotoAlbum;
12
13// If the record has no associated files, we can return early.
14if (!photoAlbum?.imageKeys) return;
15
16const photoAlbumDetails = {
17  id: photoAlbum.id,
18  imageKeys: null // Set the file association to `null`
19};
20
21// Remove associated files from record
22const updateResponse = await client.graphql({
23  query: mutations.updatePhotoAlbum,
24  variables: { input: photoAlbumDetails }
25});
26
27const updatedPhotoAlbum = updateResponse.data.updatePhotoAlbum;
28
29// Delete the files from S3:
30await Promise.all(
31  photoAlbum?.imageKeys.map(async (imageKey) => {
32    if (!imageKey) return;
33    await remove({ key: imageKey });
34  })
35);

Delete record and all associated files

1import { generateClient } from 'aws-amplify/api';
2import { remove } from 'aws-amplify/storage';
3
4const client = generateClient();
5
6const response = await client.graphql({
7  query: queries.getPhotoAlbum,
8  variables: { id: currentPhotoAlbum.id }
9});
10
11const photoAlbum = response.data.getPhotoAlbum;
12
13if (!photoAlbum) return;
14
15const photoAlbumDetails = {
16  id: photoAlbum.id
17};
18
19await client.graphql({
20  query: mutations.deletePhotoAlbum,
21  variables: { input: photoAlbumDetails }
22});
23
24// If the record has no associated file, we can return early.
25if (!photoAlbum?.imageKeys) return;
26
27await Promise.all(
28  photoAlbum?.imageKeys.map(async (imageKey) => {
29    if (!imageKey) return;
30    await remove({ key: imageKey });
31  })
32);

Data consistency when working with records and files

The recommended access patterns in these docs attempt to remove deleted files, but favor leaving orphans over leaving records that point to non-existent files. This optimizes for read latency by ensuring clients rarely attempt to fetch a non-existent file from Storage. However, any app that deletes files can inherently cause records on-device to point to non-existent files.

One example is when we create an API record, associate the Storage file with that record, and then retrieve the file's signed URL. "Device A" calls the GraphQL API to create API_Record_1, and then associates that record with First_Photo. Before "Device A" is about to retrieve the signed URL, "Device B" might query API_Record_1, delete First_Photo, and update the record accordingly. However, "Device A" is still using the old API_Record_1, which is now out-of-date. Even though the shared global state is correctly in sync at every stage, the individual device ("Device A") has an out-of-date record that points to a non-existent file. Similar issues can conceivably occur for updates. Depending on your app, some of these mismatches can be minimized even more with real-time data / GraphQL subscriptions.

It is important to understand when these mismatches can occur and to add meaningful error handling around these cases. This guide does not include exhaustive error handling, real-time subscriptions, re-querying of outdated records, or attempts to retry failed operations. However, these are all important considerations for a production-level application.

Complete examples

import { useState } from "react"; import { Amplify } from 'aws-amplify' import { generateClient } from 'aws-amplify/api' import { getUrl, uploadData, remove } from 'aws-amplify/storage' import { Authenticator } from "@aws-amplify/ui-react"; import "@aws-amplify/ui-react/styles.css"; import config from './amplifyconfiguration.json' import * as queries from "./graphql/queries"; import * as mutations from "./graphql/mutations"; import { Song } from "./API"; Amplify.configure(config, { Storage: { S3: { // configures default access level defaultAccessLevel: 'private' } } }) const client = generateClient() function App() { const [currentSong, setCurrentSong] = useState<Song | null>(null); // Used to display image for current song: const [currentImageUrl, setCurrentImageUrl] = useState<string | null | undefined>(""); async function createSongWithImage(e: React.ChangeEvent<HTMLInputElement>) { if (!e.target.files) return; const file = e.target.files[0]; try { const createSongDetails = { name: `My first song`, }; // Create the API record: const response = await client.graphql({ query: mutations.createSong, variables: { input: createSongDetails }, }); const song = response.data.createSong; if (!song) return; // Upload the Storage file: const result = await uploadData({ key: `${song.id}-${file.name}`, data: file, options: { contentType: "image/png", // contentType is optional } }).result; const updateSongDetails = { id: song.id, coverArtKey: result?.key, }; // Add the file association to the record: const updateResponse = await client.graphql({ query: mutations.updateSong, variables: { input: updateSongDetails }, }); const updatedSong = updateResponse.data.updateSong; setCurrentSong(updatedSong); // If the record has no associated file, we can return early. if (!updatedSong.coverArtKey) return; // Retrieve the file's signed URL: const signedURL = await getUrl({ key: updatedSong.coverArtKey }); setCurrentImageUrl(signedURL.url.toString()); } catch (error) { console.error("Error create song / file:", error); } } // Upload image, add to song, retrieve signed URL and retrieve the image. // Also updates image if one already exists. async function addNewImageToSong(e: React.ChangeEvent<HTMLInputElement>) { if (!currentSong) return; if (!e.target.files) return; const file = e.target.files[0]; try { // Upload the Storage file: const result = await uploadData({ key: `${currentSong.id}-${file.name}`, data: file, options: { contentType: "image/png", // contentType is optional } }).result; const updateSongDetails = { id: currentSong.id, coverArtKey: result?.key, }; // Add the file association to the record: const response = await client.graphql({ query: mutations.updateSong, variables: { input: updateSongDetails }, }); const updatedSong = response.data.updateSong; setCurrentSong(updatedSong); // If the record has no associated file, we can return early. if (!updatedSong?.coverArtKey) return; // Retrieve the file's signed URL: const signedURL = await getUrl({ key: updatedSong.coverArtKey }); setCurrentImageUrl(signedURL.url.toString()); } catch (error) { console.error("Error uploading image / adding image to song: ", error); } } async function getImageForCurrentSong() { if (!currentSong) return; try { // Query the record to get the file key: const response = await client.graphql({ query: queries.getSong, variables: { id: currentSong.id }, }); const song = response.data.getSong; // If the record has no associated file, we can return early. if (!song?.coverArtKey) return; // Retrieve the signed URL: const signedURL = await getUrl({ key: song.coverArtKey }); setCurrentImageUrl(signedURL.url.toString()); } catch (error) { console.error("Error getting song / image:", error); } } // Remove the file association, continue to persist both file and record async function removeImageFromSong() { if (!currentSong) return; try { const response = await client.graphql({ query: queries.getSong, variables: { id: currentSong.id }, }); const song = response.data.getSong; // If the record has no associated file, we can return early. if (!song?.coverArtKey) return; const songDetails = { id: song.id, coverArtKey: null, }; const updatedSong = await client.graphql({ query: mutations.updateSong, variables: { input: songDetails }, }); // If successful, the response here will be `null`: setCurrentSong(updatedSong.data.updateSong); setCurrentImageUrl(updatedSong.data.updateSong.coverArtKey); } catch (error) { console.error("Error removing image from song: ", error); } } // Remove the record association and delete the file async function deleteImageForCurrentSong() { if (!currentSong) return; try { const response = await client.graphql({ query: queries.getSong, variables: { id: currentSong.id }, }); const song = response?.data?.getSong; // If the record has no associated file, we can return early. if (!song?.coverArtKey) return; const songDetails = { id: song.id, coverArtKey: null, // Set the file association to `null` }; // Remove associated file from record const updatedSong = await client.graphql({ query: mutations.updateSong, variables: { input: songDetails }, }); // Delete the file from S3: await remove({ key: song.coverArtKey }); // If successful, the response here will be `null`: setCurrentSong(updatedSong.data.updateSong); setCurrentImageUrl(updatedSong.data.updateSong.coverArtKey); } catch (error) { console.error("Error deleting image: ", error); } } // Delete both file and record async function deleteCurrentSongAndImage() { if (!currentSong) return; try { const response = await client.graphql({ query: queries.getSong, variables: { id: currentSong.id }, }); const song = response.data.getSong; // If the record has no associated file, we can return early. if (!song?.coverArtKey) return; await remove({ key: song.coverArtKey }); const songDetails = { id: song.id, }; await client.graphql({ query: mutations.deleteSong, variables: { input: songDetails }, }); clearLocalState(); } catch (error) { console.error("Error deleting song: ", error); } } function clearLocalState() { setCurrentSong(null); setCurrentImageUrl(""); } return ( <Authenticator> {({ signOut, user }) => ( <main style={{ alignItems: "center", display: "flex", flexDirection: "column", }} > <h1>Hello {user?.username}!</h1> <h2>{`Current Song: ${currentSong?.id}`}</h2> <label> Create song with file: <input id="name" type="file" onChange={createSongWithImage} /> </label> <label> Add / update song image: <input id="name" type="file" onChange={addNewImageToSong} disabled={!currentSong} /> </label> <button onClick={getImageForCurrentSong} disabled={!currentSong || !currentImageUrl} > Get image for current song </button> <button onClick={removeImageFromSong} disabled={!currentSong || !currentImageUrl} > Remove image from current song (does not delete image) </button> <button onClick={deleteImageForCurrentSong} disabled={!currentSong || !currentImageUrl} > Remove image from current song, then delete image </button> <button onClick={deleteCurrentSongAndImage} disabled={!currentSong}> Delete current song (and image, if it exists) </button> <button onClick={signOut}>Sign out</button> {currentImageUrl && ( <img src={currentImageUrl} alt="Storage file"></img> )} </main> )} </Authenticator> ); } export default App;

1import { useState } from "react";
2import { Amplify } from 'aws-amplify'
3import { generateClient } from 'aws-amplify/api'
4import { getUrl, uploadData, remove } from 'aws-amplify/storage'
5import { Authenticator } from "@aws-amplify/ui-react";
6import "@aws-amplify/ui-react/styles.css";
7import config from './amplifyconfiguration.json'
8import * as queries from "./graphql/queries";
9import * as mutations from "./graphql/mutations";
10import { Song } from "./API";
11
12Amplify.configure(config, {
13  Storage: {
14    S3: {
15      // configures default access level
16      defaultAccessLevel: 'private'
17    }
18  }
19})
20
21const client = generateClient()
22
23function App() {
24  const [currentSong, setCurrentSong] = useState<Song | null>(null);
25
26  // Used to display image for current song:
27  const [currentImageUrl, setCurrentImageUrl] = useState<string | null | undefined>("");
28
29  async function createSongWithImage(e: React.ChangeEvent<HTMLInputElement>) {
30    if (!e.target.files) return;
31
32    const file = e.target.files[0];
33
34    try {
35      const createSongDetails = {
36        name: `My first song`,
37      };
38
39      // Create the API record:
40      const response = await client.graphql({
41        query: mutations.createSong,
42        variables: { input: createSongDetails },
43      });
44
45      const song = response.data.createSong;
46
47      if (!song) return;
48
49      // Upload the Storage file:
50      const result = await uploadData({
51        key: `${song.id}-${file.name}`,
52        data: file,
53        options: {
54          contentType: "image/png", // contentType is optional
55        }
56      }).result;
57
58      const updateSongDetails = {
59        id: song.id,
60        coverArtKey: result?.key,
61      };
62
63      // Add the file association to the record:
64      const updateResponse = await client.graphql({
65        query: mutations.updateSong,
66        variables: { input: updateSongDetails },
67      });
68
69      const updatedSong = updateResponse.data.updateSong;
70
71      setCurrentSong(updatedSong);
72
73      // If the record has no associated file, we can return early.
74      if (!updatedSong.coverArtKey) return;
75
76      // Retrieve the file's signed URL:
77      const signedURL = await getUrl({ key: updatedSong.coverArtKey });
78      setCurrentImageUrl(signedURL.url.toString());
79    } catch (error) {
80      console.error("Error create song / file:", error);
81    }
82  }
83
84  // Upload image, add to song, retrieve signed URL and retrieve the image.
85  // Also updates image if one already exists.
86  async function addNewImageToSong(e: React.ChangeEvent<HTMLInputElement>) {
87    if (!currentSong) return;
88
89    if (!e.target.files) return;
90
91    const file = e.target.files[0];
92
93    try {
94      // Upload the Storage file:
95      const result = await uploadData({
96        key: `${currentSong.id}-${file.name}`,
97        data: file, options: {
98          contentType: "image/png", // contentType is optional
99        }
100      }).result;
101
102      const updateSongDetails = {
103        id: currentSong.id,
104        coverArtKey: result?.key,
105      };
106
107      // Add the file association to the record:
108      const response = await client.graphql({
109        query: mutations.updateSong,
110        variables: { input: updateSongDetails },
111      });
112
113      const updatedSong = response.data.updateSong;
114
115      setCurrentSong(updatedSong);
116
117      // If the record has no associated file, we can return early.
118      if (!updatedSong?.coverArtKey) return;
119
120      // Retrieve the file's signed URL:
121      const signedURL = await getUrl({ key: updatedSong.coverArtKey });
122      setCurrentImageUrl(signedURL.url.toString());
123    } catch (error) {
124      console.error("Error uploading image / adding image to song: ", error);
125    }
126  }
127
128  async function getImageForCurrentSong() {
129    if (!currentSong) return;
130    try {
131      // Query the record to get the file key:
132      const response = await client.graphql({
133        query: queries.getSong,
134        variables: { id: currentSong.id },
135      });
136      const song = response.data.getSong;
137
138      // If the record has no associated file, we can return early.
139      if (!song?.coverArtKey) return;
140
141      // Retrieve the signed URL:
142      const signedURL = await getUrl({ key: song.coverArtKey });
143
144      setCurrentImageUrl(signedURL.url.toString());
145    } catch (error) {
146      console.error("Error getting song / image:", error);
147    }
148  }
149
150  // Remove the file association, continue to persist both file and record
151  async function removeImageFromSong() {
152    if (!currentSong) return;
153
154    try {
155      const response = await client.graphql({
156        query: queries.getSong,
157        variables: { id: currentSong.id },
158      });
159
160      const song = response.data.getSong;
161
162      // If the record has no associated file, we can return early.
163      if (!song?.coverArtKey) return;
164
165      const songDetails = {
166        id: song.id,
167        coverArtKey: null,
168      };
169
170      const updatedSong = await client.graphql({
171        query: mutations.updateSong,
172        variables: { input: songDetails },
173      });
174
175      // If successful, the response here will be `null`:
176      setCurrentSong(updatedSong.data.updateSong);
177      setCurrentImageUrl(updatedSong.data.updateSong.coverArtKey);
178    } catch (error) {
179      console.error("Error removing image from song: ", error);
180    }
181  }
182
183  // Remove the record association and delete the file
184  async function deleteImageForCurrentSong() {
185    if (!currentSong) return;
186
187    try {
188      const response = await client.graphql({
189        query: queries.getSong,
190        variables: { id: currentSong.id },
191      });
192
193      const song = response?.data?.getSong;
194
195      // If the record has no associated file, we can return early.
196      if (!song?.coverArtKey) return;
197
198      const songDetails = {
199        id: song.id,
200        coverArtKey: null, // Set the file association to `null`
201      };
202
203      // Remove associated file from record
204      const updatedSong = await client.graphql({
205        query: mutations.updateSong,
206        variables: { input: songDetails },
207      });
208
209      // Delete the file from S3:
210      await remove({ key: song.coverArtKey });
211
212      // If successful, the response here will be `null`:
213      setCurrentSong(updatedSong.data.updateSong);
214      setCurrentImageUrl(updatedSong.data.updateSong.coverArtKey);
215    } catch (error) {
216      console.error("Error deleting image: ", error);
217    }
218  }
219
220  // Delete both file and record
221  async function deleteCurrentSongAndImage() {
222    if (!currentSong) return;
223
224    try {
225      const response = await client.graphql({
226        query: queries.getSong,
227        variables: { id: currentSong.id },
228      });
229
230      const song = response.data.getSong;
231
232      // If the record has no associated file, we can return early.
233      if (!song?.coverArtKey) return;
234
235      await remove({ key: song.coverArtKey });
236
237      const songDetails = {
238        id: song.id,
239      };
240
241      await client.graphql({
242        query: mutations.deleteSong,
243        variables: { input: songDetails },
244      });
245
246      clearLocalState();
247    } catch (error) {
248      console.error("Error deleting song: ", error);
249    }
250  }
251
252  function clearLocalState() {
253    setCurrentSong(null);
254    setCurrentImageUrl("");
255  }
256
257  return (
258    <Authenticator>
259      {({ signOut, user }) => (
260        <main
261          style={{
262            alignItems: "center",
263            display: "flex",
264            flexDirection: "column",
265          }}
266        >
267          <h1>Hello {user?.username}!</h1>
268          <h2>{`Current Song: ${currentSong?.id}`}</h2>
269          <label>
270            Create song with file:
271            <input id="name" type="file" onChange={createSongWithImage} />
272          </label>
273          <label>
274            Add / update song image:
275            <input
276              id="name"
277              type="file"
278              onChange={addNewImageToSong}
279              disabled={!currentSong}
280            />
281          </label>
282          <button
283            onClick={getImageForCurrentSong}
284            disabled={!currentSong || !currentImageUrl}
285          >
286            Get image for current song
287          </button>
288          <button
289            onClick={removeImageFromSong}
290            disabled={!currentSong || !currentImageUrl}
291          >
292            Remove image from current song (does not delete image)
293          </button>
294          <button
295            onClick={deleteImageForCurrentSong}
296            disabled={!currentSong || !currentImageUrl}
297          >
298            Remove image from current song, then delete image
299          </button>
300          <button onClick={deleteCurrentSongAndImage} disabled={!currentSong}>
301            Delete current song (and image, if it exists)
302          </button>
303          <button onClick={signOut}>Sign out</button>
304          {currentImageUrl && (
305            <img src={currentImageUrl} alt="Storage file"></img>
306          )}
307        </main>
308      )}
309    </Authenticator>
310  );
311}
312
313export default App;

Build search and aggregate queries

Optimistic UI