README.md

Reporting Bugs / Feature Requests

Note aws-amplify 6 has been released. If you are looking for upgrade guidance click here

AWS Amplify is a JavaScript library for frontend and mobile developers building cloud-enabled applications

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.

Visit our documentation site to learn more about AWS Amplify. Please see the Amplify JavaScript page for information around the full list of features we support.

• Demo Applications
• Contributing

Features

Category	AWS Provider	Description
Authentication	Amazon Cognito	APIs and Building blocks to create Authentication experiences.
Analytics	Amazon Pinpoint	Collect Analytics data for your application including tracking user sessions.
REST API	Amazon API Gateway	Sigv4 signing and AWS auth for API Gateway and other REST endpoints.
GraphQL API	AWS AppSync	Interact with your GraphQL or AWS AppSync endpoint(s).
DataStore	AWS AppSync	Programming model for shared and distributed data, with simple online/offline synchronization.
Storage	Amazon S3	Manages content in public, protected, private storage buckets.
Geo (Developer preview)	Amazon Location Service	Provides APIs and UI components for maps and location search for JavaScript-based web apps.
Push Notifications	Amazon Pinpoint	Allows you to integrate push notifications in your app with Amazon Pinpoint targeting and campaign management support.
Interactions	Amazon Lex	Create conversational bots powered by deep learning technologies.
PubSub	AWS IoT	Provides connectivity with cloud-based message-oriented middleware.
Internationalization	---	A lightweight internationalization solution.
Cache	---	Provides a generic LRU cache for JavaScript developers to store data with priority and expiration settings.
Predictions	Various*	Connect your app with machine learning services like NLP, computer vision, TTS, and more.

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

Getting Started

AWS Amplify is available as aws-amplify on npm.

To get started pick your platform from our Getting Started home page

Notice:

Amplify 6.x.x has breaking changes. Please see the breaking changes on our migration guide

Amplify 5.x.x has breaking changes. Please see the breaking changes below:

• If you are using default 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 the DataStore.query, DataStore.save, DataStore.delete, and DataStore.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 the maxKeys parameter to pageSize 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' });

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

• Any calls to Amplify.Auth, Amplify.Cache, and Amplify.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(...);

Amplify 4.x.x has breaking changes for React Native. Please see the breaking changes below:

• 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 Native
yarn add aws-amplify amazon-cognito-identity-js @react-native-community/netinfo @react-native-async-storage/async-storage
npx pod-install

// Expo
yarn add aws-amplify @react-native-community/netinfo @react-native-async-storage/async-storage

Amplify 3.x.x has breaking changes. Please see the breaking changes below:

• AWS.credentials and AWS.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 the AWS SDK for JavaScript v3
• [email protected] has been removed from [email protected] in favor of version 3 of aws-sdk-js. We recommend to migrate to aws-sdk-js-v3 if you rely on AWS services that are not supported by Amplify, since aws-sdk-js-v3 is imported modularly.

If you can't migrate to aws-sdk-js-v3 or rely on [email protected], 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 as Amplify.<Category>, this will no longer work and we recommend to import the category you are needing to use:

  import { Auth } from 'aws-amplify';

DataStore Docs

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