ericclemmons/amplify-android

AWS Amplify provides a high-level interface to perform different categories of cloud operations. Each category is fulfilled by a plugin. You specify which plugins to use 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.

Features / APIs

Authentication APIs and building blocks for developers who want to create user authentication experiences.
Storage Provides a simple mechanism for managing user content for your app in public, protected or private storage buckets
DataStore Provides a programming model for leveraging shared and distributed data without writing additional code for offline and online scenarios.
API (GraphQL) Interact with your GraphQL server or AWS AppSync API with an easy-to-use & configured GraphQL client.
API (REST) Provides a simple solution when making HTTP requests. It provides an automatic, lightweight signing process which complies with AWS Signature Version 4.
Analytics Easily collect analytics data for your app. Analytics data includes user sessions and other custom events.
Predictions Connect your application with machine learning cloud services to enhance your application with natural language processing, computer vision, text to speech, and more.

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 {
    implementation 'com.amplifyframework:core:1.0.0'

    // Only specify modules that provide functionality your app will use
    implementation 'com.amplifyframework:aws-analytics-pinpoint:1.0.0'
    implementation 'com.amplifyframework:aws-api:1.0.0'
    implementation 'com.amplifyframework:aws-auth-cognito:1.0.0'
    implementation 'com.amplifyframework:aws-datastore:1.0.0'
    implementation 'com.amplifyframework:aws-predictions:1.0.0'
    implementation 'com.amplifyframework:aws-storage-s3:1.0.0'
}

Java 8 Compatibility

Amplify Android uses Java 8 features. Please add a compileOptions block inside your app's build.gradle, as below:

android {
    compileOptions {
        sourceCompatibility JavaVersion.VERSION_1_8
        targetCompatibility JavaVersion.VERSION_1_8
    }
}

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.

ericclemmons / amplify-android