Name:
interface
Value:
Amplify has re-imagined the way frontend developers build fullstack applications. Develop and deploy without the hassle.

Fullstack TypeScript

Write your app's data model, auth, storage, and functions in TypeScript; Amplify will do the rest.

Built with the AWS CDK

Use any cloud resource your app needs. Never worry about scale.

Learn more about Gen 2

Choose your framework/language

v5v6
Edit on GitHub

Page updated Apr 29, 2024

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:

# For Authenticator component:
npm i @aws-amplify/ui-react


# Select default configuration:
amplify add auth


# Select "Content", "Auth users only", full CRUD access,
# and default configuration:
amplify add storage


# Select default configuration
amplify add api

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

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

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.

Storage.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.

const createSongDetails: CreateSongInput = {
  name: `My first song`
};


// Create the API record:
const response = await API.graphql<GraphQLQuery<CreateSongMutation>>({
  query: mutations.createSong,
  variables: { input: createSongDetails }
});


const song = response?.data?.createSong;


if (!song) return;


// Upload the Storage file:
const result = await Storage.put(`${song.id}-${file.name}`, file, {
  contentType: 'image/png' // contentType is optional
});


const updateSongDetails: UpdateSongInput = {
  id: song.id,
  coverArtKey: result?.key
};


// Add the file association to the record:
const updateResponse = await API.graphql<GraphQLQuery<UpdateSongMutation>>({
  query: mutations.updateSong,
  variables: { input: updateSongDetails }
});


const updatedSong = updateResponse?.data?.updateSong;


// If the record has no associated file, we can return early.
if (!updatedSong?.coverArtKey) return;


// Retrieve the signed URL:
const signedURL = await Storage.get(updatedSong.coverArtKey);
const createSongDetails: CreateSongInput = {
  name: `My first song`,
};


// Create the API record:
const response = await API.graphql({
  query: mutations.createSong,
  variables: { input: createSongDetails },
});


const song = response?.data?.createSong;


if (!song) return;


// Upload the Storage file:
const result = await Storage.put(`${song.id}-${file.name}`, file, {
  contentType: "image/png", // contentType is optional
});


const updateSongDetails = {
  id: song.id,
  coverArtKey: result?.key,
};


// Add the file association to the record:
const updateResponse = await API.graphql<
  GraphQLQuery<UpdateSongMutation>
>({
  query: mutations.updateSong,
  variables: { input: updateSongDetails },
});


const updatedSong = updateResponse?.data?.updateSong;


// If the record has no associated file, we can return early.
if (!updatedSong?.coverArtKey) return;


// Retrieve the signed URL:
const signedURL = await Storage.get(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.

// Upload the Storage file:
const result = await Storage.put(`${currentSong.id}-${file.name}`, file, {
  contentType: 'image/png' // contentType is optional
});


const updateSongDetails: UpdateSongInput = {
  id: currentSong.id,
  coverArtKey: result?.key
};


// Add the file association to the record:
const response = await API.graphql<GraphQLQuery<UpdateSongMutation>>({
  query: mutations.updateSong,
  variables: { input: updateSongDetails }
});


const updatedSong = response?.data?.updateSong;


// If the record has no associated file, we can return early.
if (!updatedSong?.coverArtKey) return;


// Retrieve the file's signed URL:
const signedURL = await Storage.get(updatedSong.coverArtKey);
// Upload the Storage file:
const result = await Storage.put(`${currentSong.id}-${file.name}`, file, {
  contentType: 'image/png' // contentType is optional
});


const updateSongDetails = {
  id: currentSong.id,
  coverArtKey: result?.key
};


// Add the file association to the record:
const response = await API.graphql({
  query: mutations.updateSong,
  variables: { input: updateSongDetails }
});


const updatedSong = response?.data?.updateSong;


// If the record has no associated file, we can return early.
if (!updatedSong?.coverArtKey) return;


// Retrieve the file's signed URL:
const signedURL = await Storage.get(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:

// Query the record to get the file key:
const response = await API.graphql<GraphQLQuery<GetSongQuery>>({
  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 Storage.get(song.coverArtKey);
// Query the record to get the file key:
const response = await API.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 Storage.get(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:

  1. Remove the file association, continue to persist both file and record.
  2. Remove the record association and delete the file.
  3. 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.

const response = await API.graphql<GraphQLQuery<GetSongQuery>>({
  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: UpdateSongInput = {
  id: song.id,
  coverArtKey: null
};


const updatedSong = await API.graphql<GraphQLQuery<UpdateSongMutation>>({
  query: mutations.updateSong,
  variables: { input: songDetails }
});
const response = await API.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 API.graphql({
  query: mutations.updateSong,
  variables: { input: songDetails }
});

Remove the record association and delete the file

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

const response = await API.graphql<GraphQLQuery<GetSongQuery>>({
  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: UpdateSongInput = {
  id: song.id,
  coverArtKey: null // Set the file association to `null`
};


// Remove associated file from record
const updatedSong = await API.graphql<GraphQLQuery<UpdateSongMutation>>({
  query: mutations.updateSong,
  variables: { input: songDetails }
});


// Delete the file from S3:
await Storage.remove(song.coverArtKey);
const response = await API.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: UpdateSongInput = {
  id: song.id,
  coverArtKey: null, // Set the file association to `null`
};


// Remove associated file from record
const updatedSong = await API.graphql({
  query: mutations.updateSong,
  variables: { input: songDetails },
});


// Delete the file from S3:
await Storage.remove(song.coverArtKey);

Delete both file and record

const response = await API.graphql<GraphQLQuery<GetSongQuery>>({
  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 Storage.remove(song.coverArtKey);


const songDetails: DeleteSongInput = {
  id: song.id
};


const deletedSong = await API.graphql<GraphQLQuery<DeleteSongMutation>>({
  query: mutations.deleteSong,
  variables: { input: songDetails }
});
const response = await API.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 Storage.remove(song.coverArtKey);


const songDetails = {
  id: song.id
};


const deletedSong = await API.graphql({
  query: mutations.deleteSong,
  variables: { input: songDetails }
});

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:

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

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.

const photoAlbumDetails: CreatePhotoAlbumInput = {
  name: `My first photoAlbum`
};


// Create the API record:
const response = await API.graphql<GraphQLQuery<CreatePhotoAlbumMutation>>({
  query: mutations.createPhotoAlbum,
  variables: { input: photoAlbumDetails }
});


const photoAlbum = response?.data?.createPhotoAlbum;


if (!photoAlbum) return;


// Upload all files to Storage:
const imageKeys = await Promise.all(
  Array.from(e.target.files).map(async (file) => {
    const result = await Storage.put(`${photoAlbum.id}-${file.name}`, file, {
      contentType: 'image/png' // contentType is optional
    });


    return result?.key;
  })
);


const updatePhotoAlbumDetails: UpdatePhotoAlbumInput = {
  id: photoAlbum.id,
  imageKeys: imageKeys
};


// Add the file association to the record:
const updateResponse = await API.graphql<
  GraphQLQuery<UpdatePhotoAlbumMutation>
>({
  query: mutations.updatePhotoAlbum,
  variables: { input: updatePhotoAlbumDetails }
});


const updatedPhotoAlbum = updateResponse?.data?.updatePhotoAlbum;


// If the record has no associated file, we can return early.
if (!updatedPhotoAlbum?.imageKeys?.length) return;


// Retrieve signed urls for all files:
const signedUrls = await Promise.all(
  updatedPhotoAlbum.imageKeys.map(async (key) => await Storage.get(key!))
);
const photoAlbumDetails = {
  name: `My first photoAlbum`
};


// Create the API record:
const response = await API.graphql({
  query: mutations.createPhotoAlbum,
  variables: { input: photoAlbumDetails }
});


const photoAlbum = response?.data?.createPhotoAlbum;


if (!photoAlbum) return;


// Upload all files to Storage:
const imageKeys = await Promise.all(
  Array.from(e.target.files).map(async (file) => {
    const result = await Storage.put(`${photoAlbum.id}-${file.name}`, file, {
      contentType: 'image/png' // contentType is optional
    });


    return result?.key;
  })
);


const updatePhotoAlbumDetails = {
  id: photoAlbum.id,
  imageKeys: imageKeys
};


// Add the file association to the record:
const updateResponse = await API.graphql({
  query: mutations.updatePhotoAlbum,
  variables: { input: updatePhotoAlbumDetails }
});


const updatedPhotoAlbum = updateResponse?.data?.updatePhotoAlbum;


// If the record has no associated file, we can return early.
if (!updatedPhotoAlbum?.imageKeys?.length) return;


// Retrieve signed urls for all files:
const signedUrls = await Promise.all(
  updatedPhotoAlbum.imageKeys.map(async (key) => await Storage.get(key))
);

Create a record with a single associated file

When a schema allows for multiple associated images, you can still create a record with a single associated file.

const photoAlbumDetails: CreatePhotoAlbumInput = {
  name: `My first photoAlbum`
};


// Create the API record:
const response = await API.graphql<GraphQLQuery<CreatePhotoAlbumMutation>>({
  query: mutations.createPhotoAlbum,
  variables: { input: photoAlbumDetails }
});


const photoAlbum = response?.data?.createPhotoAlbum;


if (!photoAlbum) return;


// Upload the Storage file:
const result = await Storage.put(`${photoAlbum.id}-${file.name}`, file, {
  contentType: 'image/png' // contentType is optional
});


const updatePhotoAlbumDetails: UpdatePhotoAlbumInput = {
  id: photoAlbum.id,
  imageKeys: [result?.key]
};


// Add the file association to the record:
const updateResponse = await API.graphql<
  GraphQLQuery<UpdatePhotoAlbumMutation>
>({
  query: mutations.updatePhotoAlbum,
  variables: { input: updatePhotoAlbumDetails }
});


const updatedPhotoAlbum = updateResponse?.data?.updatePhotoAlbum;


// If the record has no associated file, we can return early.
if (!updatedPhotoAlbum?.imageKeys?.length) return;


// Retrieve the file's signed URL:
const signedURL = await Storage.get(updatedPhotoAlbum.imageKeys[0]!);
const photoAlbumDetails = {
  name: `My first photoAlbum`
};


// Create the API record:
const response = await API.graphql({
  query: mutations.createPhotoAlbum,
  variables: { input: photoAlbumDetails }
});


const photoAlbum = response?.data?.createPhotoAlbum;


if (!photoAlbum) return;


// Upload the Storage file:
const result = await Storage.put(`${photoAlbum.id}-${file.name}`, file, {
  contentType: 'image/png' // contentType is optional
});


const updatePhotoAlbumDetails = {
  id: photoAlbum.id,
  imageKeys: [result?.key]
};


// Add the file association to the record:
const updateResponse = await API.graphql({
  query: mutations.updatePhotoAlbum,
  variables: { input: updatePhotoAlbumDetails }
});


const updatedPhotoAlbum = updateResponse?.data?.updatePhotoAlbum;


// If the record has no associated file, we can return early.
if (!updatedPhotoAlbum?.imageKeys?.length) return;


// Retrieve the file's signed URL:
const signedURL = await Storage.get(updatedPhotoAlbum.imageKeys[0]);

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.

// Upload all files to Storage:
const newImageKeys = await Promise.all(
  Array.from(e.target.files).map(async (file) => {
    const result = await Storage.put(
      `${currentPhotoAlbum.id}-${file.name}`,
      file,
      {
        contentType: 'image/png' // contentType is optional
      }
    );


    return result?.key;
  })
);


// Query existing record to retrieve currently associated files:
const queriedResponse = await API.graphql<GraphQLQuery<GetPhotoAlbumQuery>>({
  query: queries.getPhotoAlbum,
  variables: { id: currentPhotoAlbum.id }
});


const photoAlbum = queriedResponse.data?.getPhotoAlbum;


if (!photoAlbum?.imageKeys) return;


// Merge existing and new file keys:
const updatedImageKeys = [...newImageKeys, ...photoAlbum.imageKeys];


const photoAlbumDetails: UpdatePhotoAlbumInput = {
  id: currentPhotoAlbum.id,
  imageKeys: updatedImageKeys
};


// Update record with merged file associations:
const response = await API.graphql<GraphQLQuery<UpdatePhotoAlbumMutation>>({
  query: mutations.updatePhotoAlbum,
  variables: { input: photoAlbumDetails }
});


const updatedPhotoAlbum = response?.data?.updatePhotoAlbum;


// If the record has no associated file, we can return early.
if (!updatedPhotoAlbum?.imageKeys) return;


// Retrieve signed urls for merged image keys:
const signedUrls = await Promise.all(
  updatedPhotoAlbum?.imageKeys.map(async (key) => await Storage.get(key!))
);
// Upload all files to Storage:
const newImageKeys = await Promise.all(
  Array.from(e.target.files).map(async (file) => {
    const result = await Storage.put(
      `${currentPhotoAlbum.id}-${file.name}`,
      file,
      {
        contentType: 'image/png' // contentType is optional
      }
    );


    return result?.key;
  })
);


// Query existing record to retrieve currently associated files:
const queriedResponse = await API.graphql({
  query: queries.getPhotoAlbum,
  variables: { id: currentPhotoAlbum.id }
});


const photoAlbum = queriedResponse.data?.getPhotoAlbum;


if (!photoAlbum?.imageKeys) return;


// Merge existing and new file keys:
const updatedImageKeys = [...newImageKeys, ...photoAlbum.imageKeys];


const photoAlbumDetails = {
  id: currentPhotoAlbum.id,
  imageKeys: updatedImageKeys
};


// Update record with merged file associations:
const response = await API.graphql({
  query: mutations.updatePhotoAlbum,
  variables: { input: photoAlbumDetails }
});


const updatedPhotoAlbum = response?.data?.updatePhotoAlbum;


// If the record has no associated file, we can return early.
if (!updatedPhotoAlbum?.imageKeys) return;


// Retrieve signed urls for merged image keys:
const signedUrls = await Promise.all(
  updatedPhotoAlbum?.imageKeys.map(async (key) => await Storage.get(key))
);

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.

// Upload new file to Storage:
const result = await Storage.put(`${currentPhotoAlbum.id}-${file.name}`, file, {
  contentType: 'image/png' // contentType is optional
});


const newFileKey = result?.key;


// Query existing record to retrieve currently associated files:
const queriedResponse = await API.graphql<GraphQLQuery<GetPhotoAlbumQuery>>({
  query: queries.getPhotoAlbum,
  variables: { id: currentPhotoAlbum.id }
});


const photoAlbum = queriedResponse.data?.getPhotoAlbum;


if (!photoAlbum?.imageKeys?.length) return;


// Retrieve last image key:
const [lastImageKey] = photoAlbum.imageKeys.slice(-1);


// Remove last file association by key
const updatedImageKeys = [
  ...photoAlbum.imageKeys.filter((key) => key !== lastImageKey),
  newFileKey
];


const photoAlbumDetails: UpdatePhotoAlbumInput = {
  id: currentPhotoAlbum.id,
  // @ts-ignore
  imageKeys: updatedImageKeys
};


// Update record with updated file associations:
const response = await API.graphql<GraphQLQuery<UpdatePhotoAlbumMutation>>({
  query: mutations.updatePhotoAlbum,
  variables: { input: photoAlbumDetails }
});


const updatedPhotoAlbum = response?.data?.updatePhotoAlbum;


// If the record has no associated file, we can return early.
if (!updatedPhotoAlbum?.imageKeys) return;


// Retrieve signed urls for merged image keys:
const signedUrls = await Promise.all(
  updatedPhotoAlbum?.imageKeys.map(async (key) => await Storage.get(key!))
);
// Upload new file to Storage:
const result = await Storage.put(`${currentPhotoAlbum.id}-${file.name}`, file, {
  contentType: 'image/png' // contentType is optional
});


const newFileKey = result?.key;


// Query existing record to retrieve currently associated files:
const queriedResponse = await API.graphql({
  query: queries.getPhotoAlbum,
  variables: { id: currentPhotoAlbum.id }
});


const photoAlbum = queriedResponse.data?.getPhotoAlbum;


if (!photoAlbum?.imageKeys?.length) return;


// Retrieve last image key:
const [lastImageKey] = photoAlbum.imageKeys.slice(-1);


// Remove last file association by key
const updatedImageKeys = [
  ...photoAlbum.imageKeys.filter((key) => key !== lastImageKey),
  newFileKey
];


const photoAlbumDetails = {
  id: currentPhotoAlbum.id,
  // @ts-ignore
  imageKeys: updatedImageKeys
};


// Update record with updated file associations:
const response = await API.graphql({
  query: mutations.updatePhotoAlbum,
  variables: { input: photoAlbumDetails }
});


const updatedPhotoAlbum = response?.data?.updatePhotoAlbum;


// If the record has no associated file, we can return early.
if (!updatedPhotoAlbum?.imageKeys) return;


// Retrieve signed urls for merged image keys:
const signedUrls = await Promise.all(
  updatedPhotoAlbum?.imageKeys.map(async (key) => await Storage.get(key))
);

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.

// Query the record to get the file keys:
const response = await API.graphql<GraphQLQuery<GetPhotoAlbumQuery>>({
  query: queries.getPhotoAlbum,
  variables: { id: currentPhotoAlbum.id }
});
const photoAlbum = response.data?.getPhotoAlbum;


// If the record has no associated files, we can return early.
if (!photoAlbum?.imageKeys) return;


// Retrieve the signed URLs for the associated images:
const signedUrls = await Promise.all(
  photoAlbum.imageKeys.map(async (imageKey) => {
    if (!imageKey) return;
    return await Storage.get(imageKey);
  })
);
// Query the record to get the file keys:
const response = await API.graphql({
  query: queries.getPhotoAlbum,
  variables: { id: currentPhotoAlbum.id }
});
const photoAlbum = response.data?.getPhotoAlbum;


// If the record has no associated files, we can return early.
if (!photoAlbum?.imageKeys) return;


// Retrieve the signed URLs for the associated images:
const signedUrls = await Promise.all(
  photoAlbum.imageKeys.map(async (imageKey) => {
    if (!imageKey) return;
    return await Storage.get(imageKey);
  })
);

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

const response = await API.graphql<GraphQLQuery<GetPhotoAlbumQuery>>({
  query: queries.getPhotoAlbum,
  variables: { id: currentPhotoAlbum.id }
});


const photoAlbum = response?.data?.getPhotoAlbum;


// If the record has no associated file, we can return early.
if (!photoAlbum?.imageKeys) return;


const photoAlbumDetails: UpdatePhotoAlbumInput = {
  id: photoAlbum.id,
  imageKeys: null
};


const updatedPhotoAlbum = await API.graphql<
  GraphQLQuery<UpdatePhotoAlbumMutation>
>({
  query: mutations.updatePhotoAlbum,
  variables: { input: photoAlbumDetails }
});
const response = await API.graphql({
  query: queries.getPhotoAlbum,
  variables: { id: currentPhotoAlbum.id }
});


const photoAlbum = response?.data?.getPhotoAlbum;


// If the record has no associated file, we can return early.
if (!photoAlbum?.imageKeys) return;


const photoAlbumDetails = {
  id: photoAlbum.id,
  imageKeys: null
};


const updatedPhotoAlbum = await API.graphql({
  query: mutations.updatePhotoAlbum,
  variables: { input: photoAlbumDetails }
});

Remove the record association and delete the files

const response = await API.graphql<GraphQLQuery<GetPhotoAlbumQuery>>({
  query: queries.getPhotoAlbum,
  variables: { id: currentPhotoAlbum.id }
});


const photoAlbum = response?.data?.getPhotoAlbum;


// If the record has no associated files, we can return early.
if (!photoAlbum?.imageKeys) return;


const photoAlbumDetails: UpdatePhotoAlbumInput = {
  id: photoAlbum.id,
  imageKeys: null // Set the file association to `null`
};


// Remove associated files from record
const updateResponse = await API.graphql<
  GraphQLQuery<UpdatePhotoAlbumMutation>
>({
  query: mutations.updatePhotoAlbum,
  variables: { input: photoAlbumDetails }
});


const updatedPhotoAlbum = updateResponse?.data?.updatePhotoAlbum;


// Delete the files from S3:
await Promise.all(
  photoAlbum?.imageKeys.map(async (imageKey) => {
    if (!imageKey) return;
    await Storage.remove(imageKey);
  })
);
const response = await API.graphql({
  query: queries.getPhotoAlbum,
  variables: { id: currentPhotoAlbum.id }
});


const photoAlbum = response?.data?.getPhotoAlbum;


// If the record has no associated files, we can return early.
if (!photoAlbum?.imageKeys) return;


const photoAlbumDetails = {
  id: photoAlbum.id,
  imageKeys: null // Set the file association to `null`
};


// Remove associated files from record
const updateResponse = await API.graphql({
  query: mutations.updatePhotoAlbum,
  variables: { input: photoAlbumDetails }
});


const updatedPhotoAlbum = updateResponse?.data?.updatePhotoAlbum;


// Delete the files from S3:
await Promise.all(
  photoAlbum?.imageKeys.map(async (imageKey) => {
    if (!imageKey) return;
    await Storage.remove(imageKey);
  })
);

Delete record and all associated files

const response = await API.graphql<GraphQLQuery<GetPhotoAlbumQuery>>({
  query: queries.getPhotoAlbum,
  variables: { id: currentPhotoAlbum.id }
});


const photoAlbum = response?.data?.getPhotoAlbum;


if (!photoAlbum) return;


const photoAlbumDetails: DeletePhotoAlbumInput = {
  id: photoAlbum.id
};


await API.graphql<GraphQLQuery<DeletePhotoAlbumMutation>>({
  query: mutations.deletePhotoAlbum,
  variables: { input: photoAlbumDetails }
});


// If the record has no associated file, we can return early.
if (!photoAlbum?.imageKeys) return;


await Promise.all(
  photoAlbum?.imageKeys.map(async (imageKey) => {
    if (!imageKey) return;
    await Storage.remove(imageKey);
  })
);
const response = await API.graphql({
  query: queries.getPhotoAlbum,
  variables: { id: currentPhotoAlbum.id }
});


const photoAlbum = response?.data?.getPhotoAlbum;


if (!photoAlbum) return;


const photoAlbumDetails = {
  id: photoAlbum.id
};


await API.graphql({
  query: mutations.deletePhotoAlbum,
  variables: { input: photoAlbumDetails }
});


// If the record has no associated file, we can return early.
if (!photoAlbum?.imageKeys) return;


await Promise.all(
  photoAlbum?.imageKeys.map(async (imageKey) => {
    if (!imageKey) return;
    await Storage.remove(imageKey);
  })
);

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 { API, Storage } from "aws-amplify";
import { Authenticator } from "@aws-amplify/ui-react";
import "@aws-amplify/ui-react/styles.css";
import { GraphQLQuery } from "@aws-amplify/api";
import * as queries from "./graphql/queries";
import * as mutations from "./graphql/mutations";
import {
  CreateSongInput,
  CreateSongMutation,
  DeleteSongInput,
  DeleteSongMutation,
  GetSongQuery,
  UpdateSongInput,
  UpdateSongMutation,
} from "./API";


function App() {
  const [currentSong, setCurrentSong] = useState<any>();


  // Used to display image for current song:
  const [currentImageUrl, setCurrentImageUrl] = useState<
    string | null | undefined
  >("");


  // Private access level configuration on the Storage object:
  Storage.configure({ level: 'private' });


  async function createSongWithImage(e: React.ChangeEvent<HTMLInputElement>) {
    if (!e.target.files) return;


    const file = e.target.files[0];


    try {
      const createSongDetails: CreateSongInput = {
        name: `My first song`,
      };


      // Create the API record:
      const response = await API.graphql<GraphQLQuery<CreateSongMutation>>({
        query: mutations.createSong,
        variables: { input: createSongDetails },
      });


      const song = response?.data?.createSong;


      if (!song) return;


      // Upload the Storage file:
      const result = await Storage.put(`${song.id}-${file.name}`, file, {
        contentType: "image/png", // contentType is optional
      });


      const updateSongDetails: UpdateSongInput = {
        id: song.id,
        coverArtKey: result?.key,
      };


      // Add the file association to the record:
      const updateResponse = await API.graphql<
        GraphQLQuery<UpdateSongMutation>
      >({
        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 Storage.get(updatedSong.coverArtKey);
      setCurrentImageUrl(signedURL);
    } 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 Storage.put(`${currentSong.id}-${file.name}`, file, {
        contentType: "image/png", // contentType is optional
      });


      const updateSongDetails: UpdateSongInput = {
        id: currentSong.id,
        coverArtKey: result?.key,
      };


      // Add the file association to the record:
      const response = await API.graphql<GraphQLQuery<UpdateSongMutation>>({
        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 Storage.get(updatedSong.coverArtKey);
      setCurrentImageUrl(signedURL);
    } catch (error) {
      console.error("Error uploading image / adding image to song: ", error);
    }
  }


  async function getImageForCurrentSong() {
    try {
      // Query the record to get the file key:
      const response = await API.graphql<GraphQLQuery<GetSongQuery>>({
        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 Storage.get(song.coverArtKey);


      setCurrentImageUrl(signedURL);
    } 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 API.graphql<GraphQLQuery<GetSongQuery>>({
        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: UpdateSongInput = {
        id: song.id,
        coverArtKey: null,
      };


      const updatedSong = await API.graphql<GraphQLQuery<UpdateSongMutation>>({
        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 API.graphql<GraphQLQuery<GetSongQuery>>({
        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: UpdateSongInput = {
        id: song.id,
        coverArtKey: null, // Set the file association to `null`
      };


      // Remove associated file from record
      const updatedSong = await API.graphql<GraphQLQuery<UpdateSongMutation>>({
        query: mutations.updateSong,
        variables: { input: songDetails },
      });


      // Delete the file from S3:
      await Storage.remove(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 API.graphql<GraphQLQuery<GetSongQuery>>({
        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 Storage.remove(song.coverArtKey);


      const songDetails: DeleteSongInput = {
        id: song.id,
      };


      await API.graphql<GraphQLQuery<DeleteSongMutation>>({
        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;
import { useState } from 'react';
import { API, Storage } from 'aws-amplify';
import { Authenticator } from '@aws-amplify/ui-react';
import '@aws-amplify/ui-react/styles.css';
import * as queries from './graphql/queries';
import * as mutations from './graphql/mutations';


function App() {
  const [currentSong, setCurrentSong] = useState();


  // Used to display image for current song:
  const [currentImageUrl, setCurrentImageUrl] = useState('');


  // Private access level configuration on the Storage object:
  Storage.configure({ level: 'private' });


  async function createSongWithImage(e) {
    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 API.graphql({
        query: mutations.createSong,
        variables: { input: createSongDetails }
      });


      const song = response?.data?.createSong;


      if (!song) return;


      // Upload the Storage file:
      const result = await Storage.put(`${song.id}-${file.name}`, file, {
        contentType: 'image/png' // contentType is optional
      });


      const updateSongDetails = {
        id: song.id,
        coverArtKey: result?.key
      };


      // Add the file association to the record:
      const updateResponse = await API.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 Storage.get(updatedSong.coverArtKey);
      setCurrentImageUrl(signedURL);
    } 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) {
    if (!currentSong) return;


    if (!e.target.files) return;


    const file = e.target.files[0];


    try {
      // Upload the Storage file:
      const result = await Storage.put(`${currentSong.id}-${file.name}`, file, {
        contentType: 'image/png' // contentType is optional
      });


      const updateSongDetails = {
        id: currentSong.id,
        coverArtKey: result?.key
      };


      // Add the file association to the record:
      const response = await API.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 Storage.get(updatedSong.coverArtKey);
      setCurrentImageUrl(signedURL);
    } catch (error) {
      console.error('Error uploading image / adding image to song: ', error);
    }
  }


  async function getImageForCurrentSong() {
    try {
      // Query the record to get the file key:
      const response = await API.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 Storage.get(song.coverArtKey);


      setCurrentImageUrl(signedURL);
    } 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 API.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 API.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 API.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 API.graphql({
        query: mutations.updateSong,
        variables: { input: songDetails }
      });


      // Delete the file from S3:
      await Storage.remove(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 API.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 Storage.remove(song.coverArtKey);


      const songDetails = {
        id: song.id
      };


      await API.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;
import { useState } from "react";
import { API, Storage } from "aws-amplify";
import { Authenticator } from "@aws-amplify/ui-react";
import "@aws-amplify/ui-react/styles.css";
import { GraphQLQuery } from "@aws-amplify/api";
import * as queries from "./graphql/queries";
import * as mutations from "./graphql/mutations";
import {
  CreatePhotoAlbumInput,
  CreatePhotoAlbumMutation,
  DeletePhotoAlbumInput,
  DeletePhotoAlbumMutation,
  GetPhotoAlbumQuery,
  ListPhotoAlbumsQuery,
  UpdatePhotoAlbumInput,
  UpdatePhotoAlbumMutation,
} from "./API";


function App() {
  const [currentPhotoAlbum, setCurrentPhotoAlbum] = useState<any>();


  // Used to display images for current photoAlbum:
  const [currentImages, setCurrentImages] = useState<
    (string | null | undefined)[] | null | undefined
  >([]);


  // Private access level configuration on the Storage object:
  Storage.configure({ level: 'private' });


  async function createPhotoAlbumWithFirstImage(
    e: React.ChangeEvent<HTMLInputElement>
  ) {
    if (!e.target.files) return;


    const file = e.target.files[0];


    try {
      const photoAlbumDetails: CreatePhotoAlbumInput = {
        name: `My first photoAlbum`,
      };


      // Create the API record:
      const response = await API.graphql<
        GraphQLQuery<CreatePhotoAlbumMutation>
      >({
        query: mutations.createPhotoAlbum,
        variables: { input: photoAlbumDetails },
      });


      const photoAlbum = response?.data?.createPhotoAlbum;


      if (!photoAlbum) return;


      // Upload the Storage file:
      const result = await Storage.put(`${photoAlbum.id}-${file.name}`, file, {
        contentType: "image/png", // contentType is optional
      });


      const updatePhotoAlbumDetails: UpdatePhotoAlbumInput = {
        id: photoAlbum.id,
        imageKeys: [result?.key],
      };


      // Add the file association to the record:
      const updateResponse = await API.graphql<
        GraphQLQuery<UpdatePhotoAlbumMutation>
      >({
        query: mutations.updatePhotoAlbum,
        variables: { input: updatePhotoAlbumDetails },
      });


      const updatedPhotoAlbum = updateResponse?.data?.updatePhotoAlbum;


      setCurrentPhotoAlbum(updatedPhotoAlbum);


      // If the record has no associated file, we can return early.
      if (!updatedPhotoAlbum?.imageKeys?.length) return;


      // Retrieve the file's signed URL:
      const signedURL = await Storage.get(updatedPhotoAlbum.imageKeys[0]!);
      setCurrentImages([signedURL]);
    } catch (error) {
      console.error("Error create photoAlbum / file:", error);
    }
  }


  async function createPhotoAlbumWithMultipleImages(
    e: React.ChangeEvent<HTMLInputElement>
  ) {
    if (!e.target.files) return;


    try {
      const photoAlbumDetails: CreatePhotoAlbumInput = {
        name: `My first photoAlbum`,
      };


      // Create the API record:
      const response = await API.graphql<
        GraphQLQuery<CreatePhotoAlbumMutation>
      >({
        query: mutations.createPhotoAlbum,
        variables: { input: photoAlbumDetails },
      });


      const photoAlbum = response?.data?.createPhotoAlbum;


      if (!photoAlbum) return;


      // Upload all files to Storage:
      const imageKeys = await Promise.all(
        Array.from(e.target.files).map(async (file) => {
          const result = await Storage.put(
            `${photoAlbum.id}-${file.name}`,
            file,
            {
              contentType: "image/png", // contentType is optional
            }
          );


          return result?.key;
        })
      );


      const updatePhotoAlbumDetails: UpdatePhotoAlbumInput = {
        id: photoAlbum.id,
        imageKeys: imageKeys,
      };


      // Add the file association to the record:
      const updateResponse = await API.graphql<
        GraphQLQuery<UpdatePhotoAlbumMutation>
      >({
        query: mutations.updatePhotoAlbum,
        variables: { input: updatePhotoAlbumDetails },
      });


      const updatedPhotoAlbum = updateResponse?.data?.updatePhotoAlbum;


      setCurrentPhotoAlbum(updatedPhotoAlbum);


      // If the record has no associated file, we can return early.
      if (!updatedPhotoAlbum?.imageKeys?.length) return;


      // Retrieve signed urls for all files:
      const signedUrls = await Promise.all(
        updatedPhotoAlbum.imageKeys.map(async (key) => await Storage.get(key!))
      );


      if (!signedUrls) return;
      setCurrentImages(signedUrls);
    } catch (error) {
      console.error("Error create photoAlbum / file:", error);
    }
  }


  async function addNewImagesToPhotoAlbum(
    e: React.ChangeEvent<HTMLInputElement>
  ) {
    if (!currentPhotoAlbum) return;


    if (!e.target.files) return;


    try {
      // Upload all files to Storage:
      const newImageKeys = await Promise.all(
        Array.from(e.target.files).map(async (file) => {
          const result = await Storage.put(
            `${currentPhotoAlbum.id}-${file.name}`,
            file,
            {
              contentType: "image/png", // contentType is optional
            }
          );


          return result?.key;
        })
      );


      // Query existing record to retrieve currently associated files:
      const queriedResponse = await API.graphql<
        GraphQLQuery<GetPhotoAlbumQuery>
      >({
        query: queries.getPhotoAlbum,
        variables: { id: currentPhotoAlbum.id },
      });


      const photoAlbum = queriedResponse.data?.getPhotoAlbum;


      if (!photoAlbum?.imageKeys) return;


      // Merge existing and new file keys:
      const updatedImageKeys = [...newImageKeys, ...photoAlbum.imageKeys];


      const photoAlbumDetails: UpdatePhotoAlbumInput = {
        id: currentPhotoAlbum.id,
        imageKeys: updatedImageKeys,
      };


      // Update record with merged file associations:
      const response = await API.graphql<
        GraphQLQuery<UpdatePhotoAlbumMutation>
      >({
        query: mutations.updatePhotoAlbum,
        variables: { input: photoAlbumDetails },
      });


      const updatedPhotoAlbum = response?.data?.updatePhotoAlbum;
      setCurrentPhotoAlbum(updatedPhotoAlbum);


      // If the record has no associated file, we can return early.
      if (!updatedPhotoAlbum?.imageKeys) return;


      // Retrieve signed urls for merged image keys:
      const signedUrls = await Promise.all(
        updatedPhotoAlbum?.imageKeys.map(async (key) => await Storage.get(key!))
      );


      if (!signedUrls) return;


      setCurrentImages(signedUrls);
    } catch (error) {
      console.error(
        "Error uploading image / adding image to photoAlbum: ",
        error
      );
    }
  }


  // Replace last image associated with current photoAlbum:
  async function updateLastImage(e: React.ChangeEvent<HTMLInputElement>) {
    if (!currentPhotoAlbum) return;


    if (!e.target.files) return;


    const file = e.target.files[0];


    try {
      // Upload new file to Storage:
      const result = await Storage.put(
        `${currentPhotoAlbum.id}-${file.name}`,
        file,
        {
          contentType: "image/png", // contentType is optional
        }
      );


      const newFileKey = result?.key;


      // Query existing record to retrieve currently associated files:
      const queriedResponse = await API.graphql<
        GraphQLQuery<GetPhotoAlbumQuery>
      >({
        query: queries.getPhotoAlbum,
        variables: { id: currentPhotoAlbum.id },
      });


      const photoAlbum = queriedResponse.data?.getPhotoAlbum;


      if (!photoAlbum?.imageKeys?.length) return;


      // Retrieve last image key:
      const [lastImageKey] = photoAlbum.imageKeys.slice(-1);


      // Remove last file association by key
      const updatedImageKeys = [
        ...photoAlbum.imageKeys.filter((key) => key !== lastImageKey),
        newFileKey,
      ];


      const photoAlbumDetails: UpdatePhotoAlbumInput = {
        id: currentPhotoAlbum.id,
        // @ts-ignore
        imageKeys: updatedImageKeys,
      };


      // Update record with updated file associations:
      const response = await API.graphql<
        GraphQLQuery<UpdatePhotoAlbumMutation>
      >({
        query: mutations.updatePhotoAlbum,
        variables: { input: photoAlbumDetails },
      });


      const updatedPhotoAlbum = response?.data?.updatePhotoAlbum;
      setCurrentPhotoAlbum(updatedPhotoAlbum);


      // If the record has no associated file, we can return early.
      if (!updatedPhotoAlbum?.imageKeys) return;


      // Retrieve signed urls for merged image keys:
      const signedUrls = await Promise.all(
        updatedPhotoAlbum?.imageKeys.map(async (key) => await Storage.get(key!))
      );


      if (!signedUrls) return;


      setCurrentImages(signedUrls);
    } catch (error) {
      console.error(
        "Error uploading image / adding image to photoAlbum: ",
        error
      );
    }
  }


  async function getImagesForPhotoAlbum() {
    try {
      // Query the record to get the file keys:
      const response = await API.graphql<GraphQLQuery<GetPhotoAlbumQuery>>({
        query: queries.getPhotoAlbum,
        variables: { id: currentPhotoAlbum.id },
      });
      const photoAlbum = response.data?.getPhotoAlbum;


      // If the record has no associated files, we can return early.
      if (!photoAlbum?.imageKeys) return;


      // Retrieve the signed URLs for the associated images:
      const signedUrls = await Promise.all(
        photoAlbum.imageKeys.map(async (imageKey) => {
          if (!imageKey) return;
          return await Storage.get(imageKey);
        })
      );


      setCurrentImages(signedUrls);
    } catch (error) {
      console.error("Error getting photoAlbum / image:", error);
    }
  }


  // Remove the file associations, continue to persist both files and record
  async function removeImagesFromPhotoAlbum() {
    if (!currentPhotoAlbum) return;


    try {
      const response = await API.graphql<GraphQLQuery<GetPhotoAlbumQuery>>({
        query: queries.getPhotoAlbum,
        variables: { id: currentPhotoAlbum.id },
      });


      const photoAlbum = response?.data?.getPhotoAlbum;


      // If the record has no associated file, we can return early.
      if (!photoAlbum?.imageKeys) return;


      const photoAlbumDetails: UpdatePhotoAlbumInput = {
        id: photoAlbum.id,
        imageKeys: null,
      };


      const updatedPhotoAlbum = await API.graphql<
        GraphQLQuery<UpdatePhotoAlbumMutation>
      >({
        query: mutations.updatePhotoAlbum,
        variables: { input: photoAlbumDetails },
      });


      // If successful, the response here will be `null`:
      setCurrentPhotoAlbum(updatedPhotoAlbum?.data?.updatePhotoAlbum);
      setCurrentImages(updatedPhotoAlbum?.data?.updatePhotoAlbum?.imageKeys);
    } catch (error) {
      console.error("Error removing image from photoAlbum: ", error);
    }
  }


  // Remove the record association and delete the file
  async function deleteImagesForCurrentPhotoAlbum() {
    if (!currentPhotoAlbum) return;


    try {
      const response = await API.graphql<GraphQLQuery<GetPhotoAlbumQuery>>({
        query: queries.getPhotoAlbum,
        variables: { id: currentPhotoAlbum.id },
      });


      const photoAlbum = response?.data?.getPhotoAlbum;


      // If the record has no associated files, we can return early.
      if (!photoAlbum?.imageKeys) return;


      const photoAlbumDetails: UpdatePhotoAlbumInput = {
        id: photoAlbum.id,
        imageKeys: null, // Set the file association to `null`
      };


      // Remove associated files from record
      const updateResponse = await API.graphql<
        GraphQLQuery<UpdatePhotoAlbumMutation>
      >({
        query: mutations.updatePhotoAlbum,
        variables: { input: photoAlbumDetails },
      });


      const updatedPhotoAlbum = updateResponse?.data?.updatePhotoAlbum;


      // Delete the files from S3:
      await Promise.all(
        photoAlbum?.imageKeys.map(async (imageKey) => {
          if (!imageKey) return;
          await Storage.remove(imageKey);
        })
      );


      // If successful, the response here will be `null`:
      setCurrentPhotoAlbum(updatedPhotoAlbum);
      setCurrentImages(null);
    } catch (error) {
      console.error("Error deleting image: ", error);
    }
  }


  // Delete both files and record
  async function deleteCurrentPhotoAlbumAndImages() {
    if (!currentPhotoAlbum) return;


    try {
      const response = await API.graphql<GraphQLQuery<GetPhotoAlbumQuery>>({
        query: queries.getPhotoAlbum,
        variables: { id: currentPhotoAlbum.id },
      });


      const photoAlbum = response?.data?.getPhotoAlbum;


      if (!photoAlbum) return;


      const photoAlbumDetails: DeletePhotoAlbumInput = {
        id: photoAlbum.id,
      };


      await API.graphql<GraphQLQuery<DeletePhotoAlbumMutation>>({
        query: mutations.deletePhotoAlbum,
        variables: { input: photoAlbumDetails },
      });


      setCurrentPhotoAlbum(null);


      // If the record has no associated file, we can return early.
      if (!photoAlbum?.imageKeys) return;


      await Promise.all(
        photoAlbum?.imageKeys.map(async (imageKey) => {
          if (!imageKey) return;
          await Storage.remove(imageKey);
        })
      );


      clearLocalState();
    } catch (error) {
      console.error("Error deleting photoAlbum: ", error);
    }
  }


  function clearLocalState() {
    setCurrentPhotoAlbum(null);
    setCurrentImages([]);
  }


  return (
    <Authenticator>
      {({ signOut, user }) => (
        <main
          style={{
            alignItems: "center",
            display: "flex",
            flexDirection: "column",
          }}
        >
          <h1>Hello {user?.username}!</h1>
          <h2>{`Current PhotoAlbum: ${currentPhotoAlbum?.id}`}</h2>
          <label>
            Create photoAlbum with one file:
            <input
              type="file"
              accept="image/*"
              onChange={createPhotoAlbumWithFirstImage}
            />
          </label>
          <label>
            Create photoAlbum with multiple files:
            <input
              type="file"
              accept="image/*"
              onChange={createPhotoAlbumWithMultipleImages}
              multiple
            />
          </label>
          <label>
            Add multiple images to current photoAlbum:
            <input
              type="file"
              accept="image/*"
              onChange={addNewImagesToPhotoAlbum}
              disabled={!currentPhotoAlbum}
              multiple
            />
          </label>
          <label>
            Replace last image:
            <input
              type="file"
              accept="image/*"
              onChange={updateLastImage}
              disabled={!currentPhotoAlbum || !currentImages}
            />
          </label>
          <button
            onClick={getImagesForPhotoAlbum}
            disabled={!currentPhotoAlbum || !currentImages}
          >
            Get Images for Current Photo Album
          </button>
          <button
            onClick={removeImagesFromPhotoAlbum}
            disabled={!currentPhotoAlbum || !currentImages}
          >
            Remove images from current PhotoAlbum (does not delete images)
          </button>
          <button
            onClick={deleteImagesForCurrentPhotoAlbum}
            disabled={!currentPhotoAlbum || !currentImages}
          >
            Remove images from current PhotoAlbum, then delete images
          </button>
          <button
            onClick={deleteCurrentPhotoAlbumAndImages}
            disabled={!currentPhotoAlbum}
          >
            Delete current PhotoAlbum (and images, if they exist)
          </button>
          <button onClick={signOut}>Sign out</button>
          {currentImages &&
            currentImages.map((url, idx) => {
              if (!url) return undefined;
              return <img src={url} key={idx} alt="Storage file"></img>;
            })}
        </main>
      )}
    </Authenticator>
  );
}


export default App;
import { useState } from 'react';
import { API, Storage } from 'aws-amplify';
import { Authenticator } from '@aws-amplify/ui-react';
import '@aws-amplify/ui-react/styles.css';
import * as queries from './graphql/queries';
import * as mutations from './graphql/mutations';


function App() {
  const [currentPhotoAlbum, setCurrentPhotoAlbum] = useState();


  // Used to display images for current photoAlbum:
  const [currentImages, setCurrentImages] = useState([]);


  // Private access level configuration on the Storage object:
  Storage.configure({ level: 'private' });


  async function createPhotoAlbumWithFirstImage(e) {
    if (!e.target.files) return;


    const file = e.target.files[0];


    try {
      const photoAlbumDetails = {
        name: `My first photoAlbum`
      };


      // Create the API record:
      const response = await API.graphql({
        query: mutations.createPhotoAlbum,
        variables: { input: photoAlbumDetails }
      });


      const photoAlbum = response?.data?.createPhotoAlbum;


      if (!photoAlbum) return;


      // Upload the Storage file:
      const result = await Storage.put(`${photoAlbum.id}-${file.name}`, file, {
        contentType: 'image/png' // contentType is optional
      });


      const updatePhotoAlbumDetails = {
        id: photoAlbum.id,
        imageKeys: [result?.key]
      };


      // Add the file association to the record:
      const updateResponse = await API.graphql({
        query: mutations.updatePhotoAlbum,
        variables: { input: updatePhotoAlbumDetails }
      });


      const updatedPhotoAlbum = updateResponse?.data?.updatePhotoAlbum;


      setCurrentPhotoAlbum(updatedPhotoAlbum);


      // If the record has no associated file, we can return early.
      if (!updatedPhotoAlbum?.imageKeys?.length) return;


      // Retrieve the file's signed URL:
      const signedURL = await Storage.get(updatedPhotoAlbum.imageKeys[0]);
      setCurrentImages([signedURL]);
    } catch (error) {
      console.error('Error create photoAlbum / file:', error);
    }
  }


  async function createPhotoAlbumWithMultipleImages(e) {
    if (!e.target.files) return;


    try {
      const photoAlbumDetails = {
        name: `My first photoAlbum`
      };


      // Create the API record:
      const response = await API.graphql({
        query: mutations.createPhotoAlbum,
        variables: { input: photoAlbumDetails }
      });


      const photoAlbum = response?.data?.createPhotoAlbum;


      if (!photoAlbum) return;


      // Upload all files to Storage:
      const imageKeys = await Promise.all(
        Array.from(e.target.files).map(async (file) => {
          const result = await Storage.put(
            `${photoAlbum.id}-${file.name}`,
            file,
            {
              contentType: 'image/png' // contentType is optional
            }
          );


          return result?.key;
        })
      );


      const updatePhotoAlbumDetails = {
        id: photoAlbum.id,
        imageKeys: imageKeys
      };


      // Add the file association to the record:
      const updateResponse = await API.graphql({
        query: mutations.updatePhotoAlbum,
        variables: { input: updatePhotoAlbumDetails }
      });


      const updatedPhotoAlbum = updateResponse?.data?.updatePhotoAlbum;


      setCurrentPhotoAlbum(updatedPhotoAlbum);


      // If the record has no associated file, we can return early.
      if (!updatedPhotoAlbum?.imageKeys?.length) return;


      // Retrieve signed urls for all files:
      const signedUrls = await Promise.all(
        updatedPhotoAlbum.imageKeys.map(async (key) => await Storage.get(key))
      );


      if (!signedUrls) return;
      setCurrentImages(signedUrls);
    } catch (error) {
      console.error('Error create photoAlbum / file:', error);
    }
  }


  async function addNewImagesToPhotoAlbum(e) {
    if (!currentPhotoAlbum) return;


    if (!e.target.files) return;


    try {
      // Upload all files to Storage:
      const newImageKeys = await Promise.all(
        Array.from(e.target.files).map(async (file) => {
          const result = await Storage.put(
            `${currentPhotoAlbum.id}-${file.name}`,
            file,
            {
              contentType: 'image/png' // contentType is optional
            }
          );


          return result?.key;
        })
      );


      // Query existing record to retrieve currently associated files:
      const queriedResponse = await API.graphql({
        query: queries.getPhotoAlbum,
        variables: { id: currentPhotoAlbum.id }
      });


      const photoAlbum = queriedResponse.data?.getPhotoAlbum;


      if (!photoAlbum?.imageKeys) return;


      // Merge existing and new file keys:
      const updatedImageKeys = [...newImageKeys, ...photoAlbum.imageKeys];


      const photoAlbumDetails = {
        id: currentPhotoAlbum.id,
        imageKeys: updatedImageKeys
      };


      // Update record with merged file associations:
      const response = await API.graphql({
        query: mutations.updatePhotoAlbum,
        variables: { input: photoAlbumDetails }
      });


      const updatedPhotoAlbum = response?.data?.updatePhotoAlbum;
      setCurrentPhotoAlbum(updatedPhotoAlbum);


      // If the record has no associated file, we can return early.
      if (!updatedPhotoAlbum?.imageKeys) return;


      // Retrieve signed urls for merged image keys:
      const signedUrls = await Promise.all(
        updatedPhotoAlbum?.imageKeys.map(async (key) => await Storage.get(key))
      );


      if (!signedUrls) return;


      setCurrentImages(signedUrls);
    } catch (error) {
      console.error(
        'Error uploading image / adding image to photoAlbum: ',
        error
      );
    }
  }


  // Replace last image associated with current photoAlbum:
  async function updateLastImage(e) {
    if (!currentPhotoAlbum) return;


    if (!e.target.files) return;


    const file = e.target.files[0];


    try {
      // Upload new file to Storage:
      const result = await Storage.put(
        `${currentPhotoAlbum.id}-${file.name}`,
        file,
        {
          contentType: 'image/png' // contentType is optional
        }
      );


      const newFileKey = result?.key;


      // Query existing record to retrieve currently associated files:
      const queriedResponse = await API.graphql({
        query: queries.getPhotoAlbum,
        variables: { id: currentPhotoAlbum.id }
      });


      const photoAlbum = queriedResponse.data?.getPhotoAlbum;


      if (!photoAlbum?.imageKeys?.length) return;


      // Retrieve last image key:
      const [lastImageKey] = photoAlbum.imageKeys.slice(-1);


      // Remove last file association by key
      const updatedImageKeys = [
        ...photoAlbum.imageKeys.filter((key) => key !== lastImageKey),
        newFileKey
      ];


      const photoAlbumDetails = {
        id: currentPhotoAlbum.id,
        // @ts-ignore
        imageKeys: updatedImageKeys
      };


      // Update record with updated file associations:
      const response = await API.graphql({
        query: mutations.updatePhotoAlbum,
        variables: { input: photoAlbumDetails }
      });


      const updatedPhotoAlbum = response?.data?.updatePhotoAlbum;
      setCurrentPhotoAlbum(updatedPhotoAlbum);


      // If the record has no associated file, we can return early.
      if (!updatedPhotoAlbum?.imageKeys) return;


      // Retrieve signed urls for merged image keys:
      const signedUrls = await Promise.all(
        updatedPhotoAlbum?.imageKeys.map(async (key) => await Storage.get(key))
      );


      if (!signedUrls) return;


      setCurrentImages(signedUrls);
    } catch (error) {
      console.error(
        'Error uploading image / adding image to photoAlbum: ',
        error
      );
    }
  }


  async function getImagesForPhotoAlbum() {
    try {
      // Query the record to get the file keys:
      const response = await API.graphql({
        query: queries.getPhotoAlbum,
        variables: { id: currentPhotoAlbum.id }
      });
      const photoAlbum = response.data?.getPhotoAlbum;


      // If the record has no associated files, we can return early.
      if (!photoAlbum?.imageKeys) return;


      // Retrieve the signed URLs for the associated images:
      const signedUrls = await Promise.all(
        photoAlbum.imageKeys.map(async (imageKey) => {
          if (!imageKey) return;
          return await Storage.get(imageKey);
        })
      );


      setCurrentImages(signedUrls);
    } catch (error) {
      console.error('Error getting photoAlbum / image:', error);
    }
  }


  // Remove the file associations, continue to persist both files and record
  async function removeImagesFromPhotoAlbum() {
    if (!currentPhotoAlbum) return;


    try {
      const response = await API.graphql({
        query: queries.getPhotoAlbum,
        variables: { id: currentPhotoAlbum.id }
      });


      const photoAlbum = response?.data?.getPhotoAlbum;


      // If the record has no associated file, we can return early.
      if (!photoAlbum?.imageKeys) return;


      const photoAlbumDetails = {
        id: photoAlbum.id,
        imageKeys: null
      };


      const updatedPhotoAlbum = await API.graphql({
        query: mutations.updatePhotoAlbum,
        variables: { input: photoAlbumDetails }
      });


      // If successful, the response here will be `null`:
      setCurrentPhotoAlbum(updatedPhotoAlbum?.data?.updatePhotoAlbum);
      setCurrentImages(updatedPhotoAlbum?.data?.updatePhotoAlbum?.imageKeys);
    } catch (error) {
      console.error('Error removing image from photoAlbum: ', error);
    }
  }


  // Remove the record association and delete the file
  async function deleteImagesForCurrentPhotoAlbum() {
    if (!currentPhotoAlbum) return;


    try {
      const response = await API.graphql({
        query: queries.getPhotoAlbum,
        variables: { id: currentPhotoAlbum.id }
      });


      const photoAlbum = response?.data?.getPhotoAlbum;


      // If the record has no associated files, we can return early.
      if (!photoAlbum?.imageKeys) return;


      const photoAlbumDetails = {
        id: photoAlbum.id,
        imageKeys: null // Set the file association to `null`
      };


      // Remove associated files from record
      const updateResponse = await API.graphql({
        query: mutations.updatePhotoAlbum,
        variables: { input: photoAlbumDetails }
      });


      const updatedPhotoAlbum = updateResponse?.data?.updatePhotoAlbum;


      // Delete the files from S3:
      await Promise.all(
        photoAlbum?.imageKeys.map(async (imageKey) => {
          if (!imageKey) return;
          await Storage.remove(imageKey);
        })
      );


      // If successful, the response here will be `null`:
      setCurrentPhotoAlbum(updatedPhotoAlbum);
      setCurrentImages(null);
    } catch (error) {
      console.error('Error deleting image: ', error);
    }
  }


  // Delete both files and record
  async function deleteCurrentPhotoAlbumAndImages() {
    if (!currentPhotoAlbum) return;


    try {
      const response = await API.graphql({
        query: queries.getPhotoAlbum,
        variables: { id: currentPhotoAlbum.id }
      });


      const photoAlbum = response?.data?.getPhotoAlbum;


      if (!photoAlbum) return;


      const photoAlbumDetails = {
        id: photoAlbum.id
      };


      await API.graphql({
        query: mutations.deletePhotoAlbum,
        variables: { input: photoAlbumDetails }
      });


      setCurrentPhotoAlbum(null);


      // If the record has no associated file, we can return early.
      if (!photoAlbum?.imageKeys) return;


      await Promise.all(
        photoAlbum?.imageKeys.map(async (imageKey) => {
          if (!imageKey) return;
          await Storage.remove(imageKey);
        })
      );


      clearLocalState();
    } catch (error) {
      console.error('Error deleting photoAlbum: ', error);
    }
  }


  function clearLocalState() {
    setCurrentPhotoAlbum(null);
    setCurrentImages([]);
  }


  return (
    <Authenticator>
      {({ signOut, user }) => (
        <main
          style={{
            alignItems: 'center',
            display: 'flex',
            flexDirection: 'column'
          }}
        >
          <h1>Hello {user?.username}!</h1>
          <h2>{`Current PhotoAlbum: ${currentPhotoAlbum?.id}`}</h2>
          <label>
            Create photoAlbum with one file:
            <input
              type="file"
              accept="image/*"
              onChange={createPhotoAlbumWithFirstImage}
            />
          </label>
          <label>
            Create photoAlbum with multiple files:
            <input
              type="file"
              accept="image/*"
              onChange={createPhotoAlbumWithMultipleImages}
              multiple
            />
          </label>
          <label>
            Add multiple images to current photoAlbum:
            <input
              type="file"
              accept="image/*"
              onChange={addNewImagesToPhotoAlbum}
              disabled={!currentPhotoAlbum}
              multiple
            />
          </label>
          <label>
            Replace last image:
            <input
              type="file"
              accept="image/*"
              onChange={updateLastImage}
              disabled={!currentPhotoAlbum || !currentImages}
            />
          </label>
          <button
            onClick={getImagesForPhotoAlbum}
            disabled={!currentPhotoAlbum || !currentImages}
          >
            Get Images for Current Photo Album
          </button>
          <button
            onClick={removeImagesFromPhotoAlbum}
            disabled={!currentPhotoAlbum || !currentImages}
          >
            Remove images from current PhotoAlbum (does not delete images)
          </button>
          <button
            onClick={deleteImagesForCurrentPhotoAlbum}
            disabled={!currentPhotoAlbum || !currentImages}
          >
            Remove images from current PhotoAlbum, then delete images
          </button>
          <button
            onClick={deleteCurrentPhotoAlbumAndImages}
            disabled={!currentPhotoAlbum}
          >
            Delete current PhotoAlbum (and images, if they exist)
          </button>
          <button onClick={signOut}>Sign out</button>
          {currentImages &&
            currentImages.map((url, idx) => {
              if (!url) return undefined;
              return <img src={url} key={idx} alt="Storage file"></img>;
            })}
        </main>
      )}
    </Authenticator>
  );
}


export default App;
Site color mode

Amplify open source software, documentation and community are supported by Amazon Web Services.

© 2024, Amazon Web Services, Inc. and its affiliates.

All rights reserved. View the site terms and privacy policy.

Flutter and the related logo are trademarks of Google LLC. We are not endorsed by or affiliated with Google LLC.