Gathering detailed insights and metrics for @aws-amplify/api
Gathering detailed insights and metrics for @aws-amplify/api
A declarative JavaScript library for application development using cloud services.
Installations
npm install @aws-amplify/apiDeveloper Guide
BETA
Typescript
No
Module System
CommonJS, ESM
Node Version
20.19.3
NPM Version
lerna/8.2.1/node@v20.19.3+x64 (linux)
Releases
189
2025-07-03 Amplify JS release - aws-amplify@6.15.3
aws-amplify@6.15.3
Updated on Jul 03, 2025
2025-07-02 Amplify JS release - aws-amplify@6.15.2
aws-amplify@6.15.2
Updated on Jul 02, 2025
2025-06-17 Amplify JS release - aws-amplify@6.15.1
aws-amplify@6.15.1
Updated on Jun 17, 2025
2025-05-27 Amplify JS release - aws-amplify@6.15.0
aws-amplify@6.15.0
Updated on May 27, 2025
2025-04-28 Amplify JS release - aws-amplify@6.14.4
aws-amplify@6.14.4
Updated on Apr 29, 2025
2025-04-21 Amplify JS release - aws-amplify@6.14.3
aws-amplify@6.14.3
Updated on Apr 21, 2025
Languages
10
TypeScript
C
JavaScript
Kotlin
Objective-C
Swift
Ruby
Shell
Objective-C++
Java
TypeScript (93.4%)
C (3.34%)
JavaScript (1.13%)
Kotlin (1.06%)
Objective-C (0.43%)
Swift (0.43%)
Ruby (0.09%)
Shell (0.09%)
Objective-C++ (0.03%)
Java (0.01%)
Developer
Download Statistics
Total Downloads
0
Last Day
0
Last Week
0
Last Month
0
Last Year
0
GitHub Statistics
Apache-2.0 License
9,537 Stars
10,023 Commits
2,161 Forks
206 Watchers
149 Branches
461 Contributors
Updated on Jul 17, 2025
Maintainers
6
Package Meta Information
Latest Version
6.3.15
Package Id
@aws-amplify/api@6.3.15
Unpacked Size
51.72 kB
Size
11.10 kB
File Count
41
NPM Version
lerna/8.2.1/node@v20.19.3+x64 (linux)
Node Version
20.19.3
Published on
Jul 03, 2025
Total Downloads
Cumulative downloads
Total Downloads
NaN
Last Day
0%
NaN
Compared to previous day
Last Week
0%
NaN
Compared to previous week
Last Month
0%
NaN
Compared to previous month
Last Year
0%
NaN
Compared to previous year
Weekly Downloads
Monthly Downloads
Yearly Downloads
Peer Dependencies
1
Dev Dependencies
2
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.
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:
1- import Amplify from 'aws-amplify'; 2+ import { Amplify } from 'aws-amplify' 3 4- import Analytics from '@aws-amplify/analytics'; 5+ import { Analytics } from '@aws-amplify/analytics'; 6// or better 7+ import { Analytics } from 'aws-amplify'; 8 9- import Storage from '@aws-amplify/storage'; 10+ import { Storage } from '@aws-amplify/storage'; 11// or better 12+ import { Storage } from 'aws-amplify'; -
Datastore predicate syntax has changed, impacting the
DataStore.query,DataStore.save,DataStore.delete, andDataStore.observeinterfaces. For example:1- await DataStore.delete(Post, (post) => post.status('eq', PostStatus.INACTIVE)); 2+ await DataStore.delete(Post, (post) => post.status.eq(PostStatus.INACTIVE)); 3 4- await DataStore.query(Post, p => p.and( p => [p.title('eq', 'Amplify Getting Started Guide'), p.score('gt', 8)])); 5+ 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
- Upgrade the Amplify CLI
- 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:
-
Storage.listhas changed the name of themaxKeysparameter topageSizeand has a new return type that contains the results list. For example:1- const photos = await Storage.list('photos/', { maxKeys: 100 }); 2- const { key } = photos[0]; 3 4+ const photos = await Storage.list('photos/', { pageSize: 100 }); 5+ const { key } = photos.results[0]; -
Storage.putwith resumable turned on has changed the key to no longer include the bucket name. For example:1- let uploadedObjectKey; 2- Storage.put(file.name, file, { 3- resumable: true, 4- // Necessary to parse the bucket name out to work with the key 5- completeCallback: (obj) => uploadedObjectKey = obj.key.substring( obj.key.indexOf("/") + 1 ) 6- } 7 8+ let uploadedObjectKey; 9+ Storage.put(file.name, file, { 10+ resumable: true, 11+ completeCallback: (obj) => uploadedObjectKey = obj.key 12+ } -
Analytics.recordno longer accepts string as input. For example:1- Analytics.record('my example event'); 2+ Analytics.record({ name: 'my example event' }); -
The
JSexport has been removed from@aws-amplify/corein favor of exporting the functions it contained. -
Any calls to
Amplify.Auth,Amplify.Cache, andAmplify.ServiceWorkerare no longer supported. Instead, your code should use the named exports. For example:1- import { Amplify } from 'aws-amplify'; 2- Amplify.configure(...); 3- // ... 4- Amplify.Auth.signIn(...); 5 6+ import { Amplify, Auth } from 'aws-amplify'; 7+ Amplify.configure(...); 8+ // ... 9+ 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.credentialsandAWS.configdon’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
aws-sdk@2.xhas been removed fromAmplify@3.x.xin 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 aws-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:1import { 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:1import { Auth } from 'aws-amplify';
DataStore Docs
For more information on contributing to DataStore / how DataStore works, see the DataStore Docs
No vulnerabilities found.
Reason
all changesets reviewed
Reason
30 commit(s) and 15 issue activity found in the last 90 days -- score normalized to 10
Reason
no dangerous workflow patterns detected
Reason
license file detected
Details
- Info: project has a license file: LICENSE:0
- Info: FSF or OSI recognized license: Apache License 2.0: LICENSE:0
Reason
security policy file detected
Details
- Info: security policy file detected: github.com/aws-amplify/.github/SECURITY.md:1
- Info: Found linked content: github.com/aws-amplify/.github/SECURITY.md:1
- Info: Found disclosure, vulnerability, and/or timelines in security policy: github.com/aws-amplify/.github/SECURITY.md:1
- Info: Found text in security policy: github.com/aws-amplify/.github/SECURITY.md:1
Reason
SAST tool detected
Details
- Info: SAST configuration detected: CodeQL
- Info: SAST configuration detected: Snyk
- Warn: 29 commits out of 30 are checked with a SAST tool
Reason
0 existing vulnerabilities detected
Reason
binaries present in source code
Details
- Warn: binary detected: packages/react-native/android/gradle/wrapper/gradle-wrapper.jar:1
- Warn: binary detected: packages/react-native/example/android/gradle/wrapper/gradle-wrapper.jar:1
- Warn: binary detected: packages/rtn-push-notification/android/gradle/wrapper/gradle-wrapper.jar:1
- Warn: binary detected: packages/rtn-web-browser/android/gradle/wrapper/gradle-wrapper.jar:1
Reason
dependency not pinned by hash detected -- score normalized to 6
Details
- Warn: npmCommand not pinned by hash: .github/workflows/callable-canary-sampleapp-tests.yml:53
- Warn: npmCommand not pinned by hash: .github/workflows/callable-canary-sampleapp-tests.yml:126
- Warn: npmCommand not pinned by hash: .github/workflows/callable-canary-sampleapp-tests.yml:129
- Warn: npmCommand not pinned by hash: .github/workflows/callable-canary-sampleapp-tests.yml:187
- Warn: npmCommand not pinned by hash: .github/workflows/callable-canary-sampleapp-tests.yml:203
- Warn: npmCommand not pinned by hash: .github/workflows/callable-docs-update.yml:71
- Info: 36 out of 36 GitHub-owned GitHubAction dependencies pinned
- Info: 3 out of 3 third-party GitHubAction dependencies pinned
- Info: 0 out of 6 npmCommand dependencies pinned
Reason
no effort to earn an OpenSSF best practices badge detected
Reason
detected GitHub workflow tokens with excessive permissions
Details
- Info: jobLevel 'actions' permission set to 'read': .github/workflows/codeql.yml:18
- Info: jobLevel 'contents' permission set to 'read': .github/workflows/codeql.yml:19
- Warn: jobLevel 'contents' permission set to 'write': .github/workflows/push-latest-release.yml:18
- Warn: jobLevel 'contents' permission set to 'write': .github/workflows/push-lts-release.yml:21
- Info: jobLevel 'contents' permission set to 'read': .github/workflows/snyk-security.yml:16
- Info: jobLevel 'actions' permission set to 'read': .github/workflows/snyk-security.yml:18
- Warn: no topLevel permission defined: .github/workflows/aws-amplify-dependency-check.yml:1
- Warn: no topLevel permission defined: .github/workflows/callable-bundle-size-tests.yml:1
- Warn: no topLevel permission defined: .github/workflows/callable-canary-e2e-runner.yml:1
- Warn: no topLevel permission defined: .github/workflows/callable-canary-e2e-tests.yml:1
- Warn: no topLevel permission defined: .github/workflows/callable-canary-e2e.yml:1
- Warn: no topLevel permission defined: .github/workflows/callable-canary-sampleapp-tests.yml:1
- Warn: no topLevel permission defined: .github/workflows/callable-dependency-review.yml:1
- Warn: no topLevel permission defined: .github/workflows/callable-docs-update.yml:1
- Warn: no topLevel permission defined: .github/workflows/callable-e2e-test-detox.yml:1
- Warn: no topLevel permission defined: .github/workflows/callable-e2e-test-headless.yml:1
- Warn: no topLevel permission defined: .github/workflows/callable-e2e-test.yml:1
- Warn: no topLevel permission defined: .github/workflows/callable-e2e-tests.yml:1
- Warn: no topLevel permission defined: .github/workflows/callable-get-package-list.yml:1
- Warn: no topLevel permission defined: .github/workflows/callable-npm-publish-lts-release.yml:1
- Warn: no topLevel permission defined: .github/workflows/callable-npm-publish-preid.yml:1
- Warn: no topLevel permission defined: .github/workflows/callable-npm-publish-release.yml:1
- Warn: no topLevel permission defined: .github/workflows/callable-prebuild-amplify-js.yml:1
- Warn: no topLevel permission defined: .github/workflows/callable-prebuild-samples-staging.yml:1
- Warn: no topLevel permission defined: .github/workflows/callable-release-verification.yml:1
- Warn: no topLevel permission defined: .github/workflows/callable-test-github-actions.yml:1
- Warn: no topLevel permission defined: .github/workflows/callable-test-license.yml:1
- Warn: no topLevel permission defined: .github/workflows/callable-test-tsc-compliance.yml:1
- Warn: no topLevel permission defined: .github/workflows/callable-unit-tests.yml:1
- Warn: no topLevel permission defined: .github/workflows/codeql.yml:1
- Warn: no topLevel permission defined: .github/workflows/issue-comment.yml:1
- Warn: no topLevel permission defined: .github/workflows/issue-labeled.yml:1
- Warn: no topLevel permission defined: .github/workflows/issue-opened.yml:1
- Warn: no topLevel permission defined: .github/workflows/lock.yaml:1
- Warn: no topLevel permission defined: .github/workflows/on-schedule-canary-test.yml:1
- Info: topLevel permissions set to 'read-all': .github/workflows/pr.yml:9
- Warn: no topLevel permission defined: .github/workflows/push-integ-test.yml:1
- Warn: no topLevel permission defined: .github/workflows/push-latest-release.yml:1
- Warn: no topLevel permission defined: .github/workflows/push-lts-release.yml:1
- Warn: no topLevel permission defined: .github/workflows/push-main-release.yml:1
- Warn: no topLevel permission defined: .github/workflows/push-next-release.yml:1
- Warn: no topLevel permission defined: .github/workflows/push-preid-release.yml:1
- Info: topLevel 'contents' permission set to 'read': .github/workflows/snyk-security.yml:10
Reason
project is not fuzzed
Details
- Warn: no fuzzer integrations found
Score
7.2
/10
Last Scanned on 2025-07-14
The Open Source Security Foundation is a cross-industry collaboration to improve the security of open source software (OSS). The Scorecard provides security health metrics for open source projects.
Learn More