Set Up the AWS Mobile SDK for Android

-

Prerequisites#

Before you can use the AWS Mobile SDK for Android, you will need the following:
After completing the prerequisites, you will need to do the following to get started:
  1. Get the AWS Mobile SDK for Android.
  2. Set permissions in your AndroidManifest.xml file.
  3. Obtain AWS credentials using Amazon Cognito.

Step 1: Get the AWS Mobile SDK for Android

There are three ways to get the AWS Mobile SDK for Android.

Option 1: Using Gradle with Android Studio#

If you are using Android Studio, add the aws-android-sdk-core dependency to yourapp/build.gradle file, along with the dependencies for the individual services that your project will use, as shown below.
dependencies {
    compile 'com.amazonaws:aws-android-sdk-core:2.2.+'
    compile 'com.amazonaws:aws-android-sdk-s3:2.2.+'
    compile 'com.amazonaws:aws-android-sdk-ddb:2.2.+'
}
A full list of dependencies are listed below.
DependencyBuild.gradle Value
AWS Mobile SDK corecom.amazonaws:aws-android-sdk-core:2.2.+
Amazon API Gatewaycom.amazonaws:aws-android-sdk-apigateway-core:2.2.+
Auto Scalingcom.amazonaws:aws-android-sdk-autoscaling:2.2.+
Amazon Cloud Watchcom.amazonaws:aws-android-sdk-cloudwatch:2.2.+
Amazon Cognito Synccom.amazonaws:aws-android-sdk-cognito:2.2.+
Amazon Cognito Identity Providercom.amazonaws:aws-android-sdk-cognitoidentityprovider:2.2.+
Amazon DynamoDBcom.amazonaws:aws-android-sdk-ddb:2.2.+
Amazon DynamoDB Object Mappercom.amazonaws:aws-android-sdk-ddb-mapper:2.2.+
Amazon EC2com.amazonaws:aws-android-sdk-ec2:2.2.+
Elastic Load Balancingcom.amazonaws:aws-android-sdk-elb:2.2.+
AWS IoTcom.amazonaws:aws-android-sdk-iot:2.2.+
Amazon Kinesiscom.amazonaws:aws-android-sdk-kinesis:2.2.+
AWS Key Management Service (KMS)com.amazonaws:aws-android-sdk-kms:2.2.+
Amazon Lexcom.amazonaws:aws-android-sdk-lex:2.3.4@aar
AWS Lambdacom.amazonaws:aws-android-sdk-lambda:2.2.+
Amazon Machine Learningcom.amazonaws:aws-android-sdk-machinelearning:2.2.+
Amazon Mobile Analyticscom.amazonaws:aws-android-sdk-mobileanalytics:2.2.+
Amazon Pinpointcom.amazonaws:aws-android-sdk-pinpoint:2.3.5
Amazon Pollycom.amazonaws:aws-android-sdk-polly:2.3.4
Amazon S3com.amazonaws:aws-android-sdk-s3:2.2.+
Amazon Simple DBcom.amazonaws:aws-android-sdk-sdb:2.2.+
Amazon SEScom.amazonaws:aws-android-sdk-ses:2.2.+
Amazon SNScom.amazonaws:aws-android-sdk-sns:2.2.+
Amazon SQScom.amazonaws:aws-android-sdk-sqs:2.2.+

Option 2: Import the JAR Files#

To obtain the JAR files, download the SDK from http://aws.amazon.com/mobile/sdk. The SDK is stored in a compressed file named aws-android-sdk-#-#-#, where #-#-# represents the version number. Source code is available on GitHub.
If using Android Studio:
In the Project view, drag aws-android-sdk-#-#-#-core.jar plus the .jar files for the individual services your project will use into the apps/libs folder. They'll be included on the build path automatically. Then, sync your project with the Gradle file.
If using Eclipse:
Drag the aws-android-sdk-#-#-#-core.jar file plus the .jar files for the individual services your project will use, into the libs folder. They'll be included on the build path automatically.

Option 3: Using Maven#

The AWS Mobile SDK for Android supports Apache Maven, a dependency management and build automation tool. A Maven project contains a pom.xml file where you can specify the Amazon Web Services that you want to use in your app. Maven then includes the services in your project, so that you don't have to download the entire AWS Mobile SDK and manually include JAR files.
Maven is supported in AWS Mobile SDK for Android v. 2.1.3 and onward. Older versions of the SDK are not available via Maven. If you're new to Maven and you'd like to learn more about it, see the Maven documentation.

pom.xml Example#

Here's an example of how you can add Amazon Cognito Identity, Amazon S3, and Amazon Mobile Analytics to your project:
<dependencies>
    <dependency>
        <groupid>com.amazonaws</groupid>
        <artifactid>aws-android-sdk-core</artifactid>
        <version>[2.2.0, 2.3)</version>
    </dependency>
    <dependency>
        <groupid>com.amazonaws</groupid>
        <artifactid>aws-android-sdk-s3</artifactid>
        <version>[2.2.0, 2.3)</version>
    </dependency>
    <dependency>
        <groupid>com.amazonaws</groupid>
        <artifactid>aws-android-sdk-mobileanalytics</artifactid>
        <version>[2.2.0, 2.3)</version>
    </dependency>
</dependencies>
As shown above, the groupId for the AWS Mobile SDK for Android is com.amazonaws. For each additional service, include a <dependency> element following the model above, and use the appropriate artifactID from the table below. The <version> element specifies the version of the AWS Mobile SDK for Android. The example above demonstrate's Maven's ability to use a range of acceptable versions for a given dependency. To review available versions of the SDK for Android, see the Release Notes.
The AWS Mobile artifactId values are as follows:
Service/FeatureartifactID
AWS Mobile SDK Core [1]aws-android-sdk-core
Amazon API Gatewayaws-android-sdk-apigateway-core
Auto Scalingaws-android-sdk-autoscaling
Amazon Cloud Watchaws-android-sdk-cloudwatch
Amazon Cognito Syncaws-android-sdk-cognito
Amazon Cognito Identity Provideraws-android-sdk-cognitoidentityprovider
Amazon DynamoDBaws-android-sdk-ddb
Amazon DynamoDB Object Mapperaws-android-sdk-ddb-mapper
Amazon EC2aws-android-sdk-ec2
Elastic Load Balancingaws-android-sdk-elb
AWS IoTaws-android-sdk-iot
Amazon Kinesisaws-android-sdk-kinesis
AWS Key Management Service (KMS)aws-android-sdk-kms
AWS Lambdaaws-android-sdk-lambda
Amazon Lexaws-android-sdk-lex
Amazon Machine Learningaws-android-sdk-machinelearning
Amazon Mobile Analyticsaws-android-sdk-mobileanalytics
Amazon Pinpointaws-android-sdk-pinpoint
Amazon Pollyaws-android-sdk-polly
Amazon S3aws-android-sdk-s3
Amazon Simple DBaws-android-sdk-sdb
Amazon SESaws-android-sdk-ses
Amazon SNSaws-android-sdk-sns
Amazon SQSaws-android-sdk-sqs
Footnotes
[1]AWS Mobile SDK Core includes Amazon Cognito Identity and AWS Simple Token Service (STS).

Step 2: Set Permissions in Your Manifest

Add the following permission to your AndroidManifest.xml
<uses-permission android:name="android.permission.INTERNET" />

Step 3: Get AWS Credentials

To use AWS services in your mobile application, you must obtain AWS Credentials using Amazon Cognito Identity as your credential provider. Using a credentials provider allows your app to access AWS services without having to embed your private credentials in your application. This also allows you to set permissions to control which AWS services your users have access to.
To get started with Amazon Cognito, you must create an identity pool. An identity pool is a store of user identity data specific to your account. Every identity pool has configurable IAM roles that allow you to specify which AWS services your application's users can access. Typically, a developer will use one identity pool per application. For more information on identity pools, see the Amazon Cognito Developer Guide.
To create an identity pool for your application:
  1. Log in to the Amazon Cognito Console and click Manage Federated Identities, then Create new identity pool.
  2. Enter a name for your Identity Pool and check the checkbox to enable access to unauthenticated identities. Click Create Pool to create your identity pool.
  3. Click Allow to create the two default roles associated with your identity pool—one for unauthenticated users and one for authenticated users. These default roles provide your identity pool access to Cognito Sync and Mobile Analytics.
The next page displays code that creates a credentials provider so you can easily integrate Cognito Identity with your Android application. You pass the credentials provider object to the constructor of the AWS client you are using. The credentials provider looks like this:
CognitoCachingCredentialsProvider credentialsProvider = new CognitoCachingCredentialsProvider(
    getApplicationContext(),    /* get the context for the application */
    "COGNITO_IDENTITY_POOL",    /* Identity Pool ID */
    Regions.MY_REGION           /* Region for your identity pool--US_EAST_1 or EU_WEST_1*/
);

Comments

Post a Comment

Popular posts from this blog

Styling Bottom Navigation

-
Image
Styling Bottom Navigation Off the bat, the library provides considerable styling options. But after recent updates, there has been a lot more. Some of these additions include notification badges and coordinating behaviors. It also includes  on-scroll Quick Return pattern . Its all that one could ever want with the Bottom Navigation. This library is much more feature-rich than  what Android Design Support Library offers . So if you want more customization options and more control, you know what to use. Before we get to that, here’s a heads-up. We’ll be using and referencing a lot of colors. Normally, we reference colors in Android like this: ContextCompat.getColor(context, R.id.yourcolor); Now I’m no fan of writing such a lengthy line for fetching a simple color resource. So I’ll write a simple method that shortens what I have to type. private int fetchColor( @ColorRes int color) { return ContextCompat.getColor(this, color); } Great! From now on I d...
Read more

Lottie Animation in Android

-
Gradle is the only supported build configuration, so just add the dependency to your project  build.gradle  file: dependencies { ... compile 'com.airbnb.android:lottie:2.2.5' ... } Lottie supports ICS (API 14) and above. The simplest way to use it is with LottieAnimationView: <com.airbnb.lottie.LottieAnimationView android:id="@+id/animation_view" android:layout_width="wrap_content" android:layout_height="wrap_content" app:lottie_fileName="hello-world.json" app:lottie_loop="true" app:lottie_autoPlay="true" /> Or you can load it programmatically in multiple ways. From a json asset in app/src/main/assets: LottieAnimationView animationView = ( LottieAnimationView ) findViewById ( R . id . animation_view ) ; animationView . setAnimation ( "hello-world.json" ) ; animationView . loop ( true ) ; animationView . playAnimation ( ) ; ...
Read more

Minimum Required SDK – Target SDK – Compile With

-
Image
Target SDK and Compile With. It is often confusing for Android developers on What to select for the Minimum Required SDK, Target SDK and Compile With options. To help and clear the air, I have decided to write a post on it. Minimum Required SDK It is the lowest version of Android version that your app going to support and it is usually indicated by the API level. To support as many devices as possible, you should set this to the lowest version available that allows your app to provide its core feature set. If any feature of your app is possible only on newer versions of Android and it’s not critical to the app’s core feature set, you can enable the feature only when running on the versions that support it. The Google play will prevent the user from installing the application if the system’s API Level is lower than the value specified for Minimum Required SDK. Here is the current statistics of Android OS versions distribution: Source:  Platform Versions Decide wh...
Read more