JarCasting
The Amplify Android library is AWS' preferred mechanism for interacting with AWS services from an Android device.
The library provides a high-level interface to perform different categories of cloud operations. Each category may be fulfilled by a plugin, which you configure during setup.
The default plugins that we provide are designed to facilitate interaction with Amazon Web Services (AWS). But, the Amplify Framework is designed to be extensible to any other backend or service.
To familiarize yourself with Amplify, checkout our Getting Started Guide.
Categories
| Category | AWS Provider | Description |
|---|---|---|
| Authentication | Cognito | Building blocks to create auth experiences |
| Storage | S3 | Manages content in public, protected, private storage buckets |
| DataStore | AppSync | Programming model for shared and distributed data, with simple online/offline synchronization |
| API (GraphQL) | AppSync | Interact with your GraphQL or AppSync endpoint |
| API (REST) | API Gateway | Sigv4 signing and AWS auth for API Gateway and other REST endpoints |
| Analytics | Pinpoint | Collect Analytics data for your app including tracking user sessions |
| 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.
Platform Support
The Amplify Framework supports Android API level 16 (Android 4.1) and above.
Using Amplify from Your App
For step-by-step setup instructions, checkout our Project Setup guide.
Specifying Gradle Dependencies
To begin, include Amplify from your app module's build.gradle dependencies section:
dependencies {
// Only specify modules that provide functionality your app will use
implementation 'com.amplifyframework:aws-analytics-pinpoint:1.6.7'
implementation 'com.amplifyframework:aws-api:1.6.7'
implementation 'com.amplifyframework:aws-auth-cognito:1.6.7'
implementation 'com.amplifyframework:aws-datastore:1.6.7'
implementation 'com.amplifyframework:aws-predictions:1.6.7'
implementation 'com.amplifyframework:aws-storage-s3:1.6.7'
}
Java 8 Requirement
Amplify Android requires Java 8 features. Please add a compileOptions block inside your app's build.gradle, as below:
android {
compileOptions {
coreLibraryDesugaringEnabled true
sourceCompatibility JavaVersion.VERSION_1_8
targetCompatibility JavaVersion.VERSION_1_8
}
}
In the same file, add core library desugaring in your dependencies block:
dependencies {
// Add this line
coreLibraryDesugaring 'com.android.tools:desugar_jdk_libs:1.0.10'
}
Rx Support
By default, Amplify's interfaces render results through async callbacks. However, we also offer an Rx-compatible front-end to Amplify.
See Using RxJava with Amplify for more information.
Authentication
The default plugins for Amplify Android use the Authentication category to provide authentication with AWS services. The default implementation uses Amazon Cognito which allows you to add user sign-up, sign-in, and access control to your mobile apps.
Please see Getting Started with Authentication for full details.
License
This library is licensed under the Apache 2.0 License.
Report a Bug
We appreciate your feedback -- comments, questions, and bug reports. Please submit a GitHub issue, and we'll get back to you.
Contribute to the Project
Please see the Contributing Guidelines.
