README.md

Amplify for Android

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
Geo	Location	Add maps to your app with APIs and map UI components
Predictions	Various*	Connect your app with machine learning services like NLP, computer vision, TTS, and more.
Push Notifications	Pinpoint	Segment users, trigger push notifications, and record metrics

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

All services and features not listed above are supported via the Kotlin SDK or if supported by a category can be accessed via the Escape Hatch like below:

Kotlin

val s3StoragePlugin = Amplify.Storage.getPlugin("awsS3StoragePlugin")
val s3Client = s3StoragePlugin.escapeHatch as S3Client

Java

AWSS3StoragePlugin plugin = (AWSS3StoragePlugin) Amplify.Storage.getPlugin("awsS3StoragePlugin");
S3Client s3Client = plugin.getEscapeHatch();

Platform Support

The Amplify Framework supports Android API level 24 (Android 7.0) 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:2.24.0'
    implementation 'com.amplifyframework:aws-api:2.24.0'
    implementation 'com.amplifyframework:aws-auth-cognito:2.24.0'
    implementation 'com.amplifyframework:aws-datastore:2.24.0'
    implementation 'com.amplifyframework:aws-predictions:2.24.0'
    implementation 'com.amplifyframework:aws-storage-s3:2.24.0'
    implementation 'com.amplifyframework:aws-geo-location:2.24.0'
    implementation 'com.amplifyframework:aws-push-notifications-pinpoint:2.24.0'
}

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_11
        targetCompatibility JavaVersion.VERSION_11
    }
}

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'
}

Kotlin & Rx Support

Amplify's default interface renders results through async callbacks. We also provide optional, adapter APIs which better integrate with RxJava and Kotlin:

• Using RxJava with Amplify
• Kotlin Coroutines Support

Semantic versioning

We follow semantic versioning for our releases.

Semantic versioning and enumeration cases

When Amplify adds a new a new enumeration class entry or sealed class subtype, we will publish a new minor version of the library.

Applications that use a when expression to evaluate all members of an enumerated type can add an else branch to prevent new cases from causing compile warnings or errors.

Semantic versioning and dependencies update

We follow semantic versioning for updating our dependencies. This includes updating the Kotlin language version.

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

We welcome any and all contributions from the community! Make sure you read through our Contribution Guidelines before submitting any PR's. Thanks! ♥️