AWS SDK for iOS (Beta) Readme

The AWS SDK for iOS provides a library, code samples, and documentation for developers to build connected mobile applications using AWS. This guide walks through the steps for setting up the SDK and running one of the samples. 

About the SDK

The AWS SDK for iOS includes:

• AWS iOS Library—Build mobile applications for the iOS on top of APIs that take the complexity out of coding directly against a web service interface. The library provides APIs that hide much of the lower-level plumbing, including authentication, request retries, and error handling.
• Code Samples—Practical examples for how to use the library to build applications.
• Documentation—Reference documentation demonstrating how to use the SDK.

Get Set Up

To get set up, you must sign up for Amazon Web Services, get your AWS credentials, and set up your environment.

Sign Up for AWS Products

Before you can begin, you must sign up for each AWS product you want to use. The sample we'll cover in this guide uses both Amazon S3 and Amazon SimpleDB, so you'll need to sign up for both products.

1. Go to the home page for the product, for example aws.amazon.com/s3/.
   
   Tip: Go to aws.amazon.com/products for a list of links to all our products.
   
   
2. Click the sign-up button on the top right corner of the page.
3. Follow the on-screen instructions. If you don't already have an AWS account, you are prompted to create one as part of the sign-up process.

AWS sends you a confirmation email after the sign-up process is complete. You can view your current account activity or manage your account at any time, by going to aws.amazon.com and clicking the Account tab.

Get Your Credentials

In order to use the AWS SDK for iOS, you need your AWS Access Key ID and Secret Access Key.

1. Go to http://aws.amazon.com/.
2. Click Account and then click Security Credentials.
   The Security Credentials page displays (you might be prompted to log in).
3. Scroll down to Access Credentials and make sure the Access Keys tab is selected.
   The AWS Access Key ID appears in the Access Key column.
4. To view the Secret Access Key, click Show.

Important! Your Secret Access Key is a secret, which only you and AWS should know. It is important to keep it confidential to protect your account. Store it securely in a safe place. Never include it in your requests to AWS, and never email it to anyone. Do not share it outside your organization, even if an inquiry appears to come from AWS or Amazon.com. No one who legitimately represents Amazon will ever ask you for your Secret Access Key.

Get the iOS SDK

Downlod the SDK from http://aws.amazon.com/sdkforios.

Minimum requirements for using the AWS SDK for iOS are:

• Requires Xcode v3.2.3 or higher.
• Requires iOS v4.1 or higher.

Package Contents

After unzipping the AWS SDK for iOS package, you'll find the following contents:

• Documentation: Contains the DocSet for the AWS iOS SDK framework.
• AWSiOSSDK.framework: A framework to include in an iOS application to access AWS APIs.
• samples: Contains code built using the AWSiOSSDK.framework to create a simple browser for Amazon S3 and SimpleDB.
• src: Contains the original implementation and header files for the SDK, including third-party code.

Run the Sample

The /samples directory in the SDK contains a browser application that demonstrates how to make requests to AWS using the SDK.

To run the browser sample

1. Open the AWSiOSSDK/samples/awsBrowser/AWSiosDEMO.xcodeproj project file in Xcode.
2. If you're using iOS 4.2, update the project build target as follows.
   1. Control-click AWSiosDEMO in the project tree, then select Get Info.
   2. On the Build tab of the info dialog, change Architectures/Base SDK from iOS 4.1 to Latest iOS.
   3. In the Frameworks group, remove UIKit.framework, Foundation.framework, and CoreGraphics.framework.
   4. Re-add each framework back to the project by right-clicking on the Frameworks tab, selecting Add->Existing Frameworks…, selecting each framework by name, then clicking the Add button.
3. Add the AWSiOSSDK Framework.
   1. Expand the project.
   2. Control-click the Framework Group in the Group & Files section.
   3. Select Add -> Existing Frameworks....
   4. Click the Add Other... button.
   5. Navigate to the folder AWSiOSSDK.Framework which was unpacked as part of the AWS SDK for iOS .zip file.
   6. Select the AWSiOSSDK.Framework folder and press the Add button.
4. Configure the sample with your AWS security credentials:
   1. Open the Constants.h file.
   2. Modify the ACCESS_KEY and SECRET_KEY definitions with your AWS Credentials.
5. Run the project by selecting Build and Run from the Build menu.

Where Do I Go from Here?

For more information about the AWS SDK for iOS, including a complete list of supported AWS products, go to aws.amazon.com/sdkforios.

View the Reference Documentation Online

The SDK reference documentation includes the ability to browse and search across all code included with the SDK. It provides thorough documentation, usage examples, and even the ability to browse method source. You can find it at http://docs.amazonwebservices.com/AWSSDKforiOS/latest.

Install the Reference Documentation in XCode

The AWS SDK for iOS includes DocSet documentation, which can be used to view the documentation from within Xcode. To install the DocSet:

1. Create a directory called /Users/$USER/Library/Developer/Shared/Documentaion/DocSets.
2. Copy Documentation/com.amazon.aws.ios.docset from the SDK into the directory you created above.
3. Restart Xcode.

Learn More about iOS Development

For more information on iOS development, see the Apple Developer Connection web site at: http://developer.apple.com/devcenter/ios/index.action.