Repository files navigation

Noteaws-amplify 6 has been released. If you are looking for upgrade guidanceclick here

AWS Amplify provides a declarative and easy-to-use interface across different categories of cloud operations. AWS Amplify goes well with any JavaScript based frontend workflow and React Native for mobile developers.

Our default implementation works with Amazon Web Services (AWS), but AWS Amplify is designed to be open and pluggable for any custom backend or service.

• Contributing

• Predictions utilizes a range of Amazon's Machine Learning services, including: Amazon Comprehend, Amazon Polly, Amazon Rekognition, Amazon Textract, and Amazon Translate.

AWS Amplify is available asaws-amplify onnpm.

To get started pick your platform from ourGetting Started home page

AWS Amplify JavaScript library v4 and below will end support onApril 13, 2026, as documented in ourAWS Amplify JavaScript library version support calendar.

Effective immediately, the AWS Amplify JavaScript library v4 and below will enterMaintenance Mode until April 13, 2026 after which it will receive no more updates. While in Maintenance Mode, the libraries will only receive updates forcritical bug fixes and security vulnerabilities. Refer toAmplify Documentation for more information on the maintenance policy.

If you are using AWS Amplify JavaScript library v4 and below, we strongly recommend upgrading to the AWS Amplify JavaScript Library v6 before April 13, 2026.

• If you are usingdefault exports from any Amplify package, then you will need to migrate to using named exports. For example:

  - import Amplify from 'aws-amplify';+ import { Amplify } from 'aws-amplify'- import Analytics from '@aws-amplify/analytics';+ import { Analytics } from '@aws-amplify/analytics';// or better+ import { Analytics } from 'aws-amplify';- import Storage from '@aws-amplify/storage';+ import { Storage } from '@aws-amplify/storage';// or better+ import { Storage } from 'aws-amplify';

• Datastore predicate syntax has changed, impacting theDataStore.query,DataStore.save,DataStore.delete, andDataStore.observe interfaces. For example:

  - await DataStore.delete(Post, (post) => post.status('eq', PostStatus.INACTIVE));+ await DataStore.delete(Post, (post) => post.status.eq(PostStatus.INACTIVE));- await DataStore.query(Post, p => p.and( p => [p.title('eq', 'Amplify Getting Started Guide'), p.score('gt', 8)]));+ await DataStore.query(Post, p => p.and( p => [p.title.eq('Amplify Getting Started Guide'), p.score.gt(8)]));

  • To use the new syntax with 5.x.x you may need to rebuild your Datastore models with the latest version of Amplify codegen. To do this:
    • Upgrade the Amplify CLI
      • npm install -g @aws-amplify/cli
    • Re-generate your models with Amplify codegen
      • amplify codegen models

• Storage.list has changed the name of themaxKeys parameter topageSize and has a new return type that contains the results list. For example:

  - const photos = await Storage.list('photos/', { maxKeys: 100 });- const { key } = photos[0];+ const photos = await Storage.list('photos/', { pageSize: 100 });+ const { key } = photos.results[0];

• Storage.put with resumable turned on has changed the key to no longer include the bucket name. For example:

  - let uploadedObjectKey;- Storage.put(file.name, file, {-   resumable: true,-   // Necessary to parse the bucket name out to work with the key-   completeCallback: (obj) => uploadedObjectKey = obj.key.substring( obj.key.indexOf("/") + 1 )- }+ let uploadedObjectKey;+ Storage.put(file.name, file, {+   resumable: true,+   completeCallback: (obj) => uploadedObjectKey = obj.key+ }

• Analytics.record no longer accepts string as input. For example:

  - Analytics.record('my example event');+ Analytics.record({ name: 'my example event' });

• TheJS export has been removed from@aws-amplify/core in favor of exporting the functions it contained.

• Any calls toAmplify.Auth,Amplify.Cache, andAmplify.ServiceWorker are no longer supported. Instead, your code should use the named exports. For example:

  - import { Amplify } from 'aws-amplify';- Amplify.configure(...);- // ...- Amplify.Auth.signIn(...);+ import { Amplify, Auth } from 'aws-amplify';+ Amplify.configure(...);+ // ...+ Auth.signIn(...);

• If you are using React Native (vanilla or Expo), you will need to add the following React Native community dependencies:
  • @react-native-community/netinfo
  • @react-native-async-storage/async-storage

// React Nativeyarn add aws-amplify amazon-cognito-identity-js @react-native-community/netinfo @react-native-async-storage/async-storagenpx pod-install// Expoyarn add aws-amplify @react-native-community/netinfo @react-native-async-storage/async-storage

• AWS.credentials andAWS.config don’t exist anymore in Amplify JavaScript.
  • Both options will not be available to use in version 3. You will not be able to use and set your own credentials.
  • For more information on this change, please see theAWS SDK for JavaScript v3
• aws-sdk@2.x has been removed fromAmplify@3.x.x in favor ofversion 3 of aws-sdk-js. We recommend to migrate toaws-sdk-js-v3 if you rely on AWS services that are not supported by Amplify, sinceaws-sdk-js-v3 is imported modularly.

If you can't migrate toaws-sdk-js-v3 or rely onaws-sdk@2.x, you will need to import it separately.

• If you are using exported paths within your Amplify JS application, (e.g.import from "@aws-amplify/analytics/lib/Analytics") this will now break and no longer will be supported. You will need to change to named imports:

  import{Analytics}from'aws-amplify';

• If you are using categories asAmplify.<Category>, this will no longer work and we recommend to import the category you are needing to use:

  import{Auth}from'aws-amplify';

For more information on contributing to DataStore / how DataStore works, see theDataStore Docs