AWS SDK Swift

AWS SDK for the Swift programming language working on Linux, macOS and iOS. This library provides access to all AWS services. The service APIs it provides are a direct mapping of the REST APIs Amazon publishes for each of its services.

The library consists of three parts

1. aws-sdk-swift-core which does all the core request encoding and signing, response decoding and error handling.
2. The service api files which define the individual AWS services and their commands with their input and output structures.
3. The CodeGenerator which builds the service api files from the JSON model files supplied by Amazon.

Installation

Swift Package Manager

AWSSDKSwift uses the Swift Package Manager to manage its code dependencies. To use AWSSDKSwift in your codebase it is recommended you do the same. Add a dependency to the package in your own Package.swift dependencies.

    dependencies: [
        .package(name: "AWSSDKSwift", url: "https://github.com/swift-aws/aws-sdk-swift.git", from: "4.0.0")
    ],

Then add target dependencies for each of the AWSSDKSwift targets you want to use.

    targets: [
        .target(name: "MyAWSApp", dependencies: [
            .product(name: "S3", package: "AWSSDKSwift"),
            .product(name: "SES", package: "AWSSDKSwift"),
            .product(name: "IAM", package: "AWSSDKSwift")
        ]),
    ]
)

If you are using one of the v5.0.0 pre-releases then the name parameter in the package dependencies is unnecessary, the package parameter of the target dependencies is aws-sdk-swift instead of AWSSDKSwift and also all the target names are prefixed with AWS.

Alternatively if you are using Xcode 11+ you can use the Swift Package integration and add a dependency to AWSSDKSwift through that.

Compatibility

AWSSDKSwift works on Linux, macOS and iOS. Version 4 is dependent on version 2 of swift-nio. Libraries/frameworks that are dependent on an earlier version of swift-nio will not work with version 4 of AWSSDKSwift. In this case Version 3 can be used. For example Vapor 3 uses swift-nio 1.13 so you can only use versions 3.x of AWSSDKSwift with Vapor 3. Below is a compatibility table for versions 3 and 4 of AWSSDKSwift.

Version	Swift	MacOS	iOS	Linux	Vapor
3.x	4.2 -	✓		Ubuntu 14.04-18.04	3.0
4.x	5.0 -	✓	12.0 -	Ubuntu 14.04-18.04	4.0

Configuring Credentials

Before using the SDK, you will need AWS credentials to sign all your requests. Credentials can be provided to the library in the following ways.

Via EC2 Instance Profile

If you are running your code on an AWS EC2 instance, you can setup an IAM role as the server's Instance Profile to automatically grant credentials via the metadata service.

There are no code changes or configurations to specify in the code, it will automatically pull and use the credentials.

Via ECS Container credentials

If you are running your code as an AWS ECS container task, you can setup an IAM role for your container task to automatically grant credentials via the metadata service.

Similar to the EC2 setup there are no code changes or configurations to specify in the code, it will automatically pull and use the credentials.

Load Credentials from shared credential file.

You can set shared credentials in the home directory for the user running the app, in the file ~/.aws/credentials,

[default]
aws_access_key_id = YOUR_AWS_ACCESS_KEY_ID
aws_secret_access_key = YOUR_AWS_SECRET_ACCESS_KEY

Load Credentials from Environment Variable

Alternatively, you can set the following environment variables:

AWS_ACCESS_KEY_ID=YOUR_AWS_ACCESS_KEY_ID
AWS_SECRET_ACCESS_KEY=YOUR_AWS_SECRET_ACCESS_KEY

Pass the Credentials to the AWS Service struct directly

All of the AWS Services's initializers accept accessKeyId and secretAccessKey

let ec2 = EC2(
    accessKeyId: "YOUR_AWS_ACCESS_KEY_ID",
    secretAccessKey: "YOUR_AWS_SECRET_ACCESS_KEY"
)

Without Credentials

Some services like CognitoIdentityProvider don't require credentials to access some of their functionality. In this case explicitly set accessKeyId and secretAccessKey to "". This will disable all other credential access functions and send requests unsigned.

Using AWSSDKSwift

AWS Swift Modules can be imported into any swift project. Each module provides a service struct that can be initialized with AWS credentials, if required, AWS region, and some configuration options. This struct contains the instance methods that correspond to the AWS service REST apis. See documentation for details on specific services.

Each aws-sdk-swift command returns a swift-nio EventLoopFuture. An EventLoopFuture is not the response of the command, but rather a container object that will be populated with the response sometime later. In this manner calls to AWS do not block the main thread. It is recommended you familiarise yourself with the swift-nio documentation, specifically EventLoopFuture if you want to take full advantage of aws-sdk-swift.

The recommended manner to interact with EventLoopFutures is chaining. The following function returns an EventLoopFuture that creates an S3 bucket, puts a file in the bucket, reads the file back from the bucket and finally prints the contents of the file. Each of these operations are chained together. The output of one being the input of the next.

import S3 //ensure this module is specified as a dependency in your package.swift

let bucket = "my-bucket"

let s3 = S3(accessKeyId: "Your-Access-Key", secretAccessKey: "Your-Secret-Key", region: .uswest2)

func createBucketPutGetObject() -> EventLoopFuture<S3.GetObjectOutput> {
    // Create Bucket, Put an Object, Get the Object
    let createBucketRequest = S3.CreateBucketRequest(bucket: bucket)

    s3.createBucket(createBucketRequest)
        .flatMap { response -> EventLoopFuture<S3.PutObjectOutput> in
            // Upload text file to the s3
            let bodyData = "hello world".data(using: .utf8)!
            let putObjectRequest = S3.PutObjectRequest(acl: .publicRead, body: bodyData, bucket: bucket, contentLength: Int64(bodyData.count), key: "hello.txt")
            return s3.putObject(putObjectRequest)
        }
        .flatMap { response -> EventLoopFuture<S3.GetObjectOutput> in
            let getObjectRequest = S3.GetObjectRequest(bucket: bucket, key: "hello.txt")
            return s3.getObject(getObjectRequest)
        }
        .whenSuccess { response in
            if let body = response.body {
                print(String(data: body, encoding: .utf8)!)
            }
    }
}

HTTP client (v5.x.x)

The AWS SDK sets up its own HTTP client for communication with AWS but you are also able to provide your own as long as it conforms to the protocol AWSHTTPClient. If you don't provide a client the SDK uses one of two different HTTP clients depending on what platform you are running on. We have extended the swift server AsyncHTTPClient so it conforms with AWSHTTPClient. This is the default client if you are running on Linux or macOS 10.14 and earlier. AsyncHTTPClient is not available on iOS. We have also supplied are own client NIOTSHTTPClient which uses NIO Transport Services and the Apple Network framework. This is the default client if you are running on iOS or macOS 10.15 and later. NIOTSHTTPClient is not available on Linux or versions of macOS earlier than 10.15.

You can provide your own HTTP client as follows

let s3 = S3(region:.uswest2, httpClientProvider: .shared(myHTTPClient))

Reasons you might want to provide your own client.

• You have one HTTP client you want to use across all your systems.
• You want to provide a client that is using a global EventLoopGroup.
• On macOS you want to force the usage of the swift server AsyncHTTPClient regardless of OS version.
• You want to change the configuration for the HTTP client used.
• You want to provide your own custom built HTTP client.

Using AWSSDKSwift with Vapor

Integration with Vapor is pretty straight forward. Although be sure you use the correct version of AWSSDKSwift depending on which version of Vapor you are using. See the compatibility section for details. Below is a simple Vapor 3 example that extracts an email address, subject and message from a request and then sends an email using these details. Take note of the hopTo(eventLoop:) call. If your AWS SDK is not working off the same EventLoopGroup as the Vapor Request this is a requirement.

import Vapor
import HTTP
import SES

let client = SES(region: .uswest1)

final class MyController {
    struct EmailData: Content {
        let address: String
        let subject: String
        let message: String
    }
    func sendUserEmailFromJSON(_ req: Request) throws -> EventLoopFuture<HTTPStatus> {
        return try req.content.decode(EmailData.self)
            .flatMap { (emailData)->EventLoopFuture<SES.SendEmailResponse> in
                let destination = SES.Destination(toAddresses: [emailData.address])
                let message = SES.Message(body:SES.Body(text:SES.Content(data:emailData.message)), subject:SES.Content(data:emailData.subject))
                let sendEmailRequest = SES.SendEmailRequest(destination: destination, message: message, source:"awssdkswift@me.com")

                return client.sendEmail(sendEmailRequest)
            }
            .hopTo(eventLoop: req.eventLoop)
            .map { response -> HTTPResponseStatus in
                return HTTPStatus.ok
        }
    }
}

Documentation

Visit the aws-sdk-swift documentation to browse the api reference. As there is a one-to-one correspondence with AWS REST api calls and the aws-sdk-swift api calls, you can also use the official AWS documentation for more detailed information about aws-sdk-swift commands.

upgrading from <3.0.x

The simplest way to upgrade from an existing 1.0 or 2.0 implementation is to call .wait() on existing synchronous calls. However it is recommend to rewrite your synchronous code to work with the returned future objects. It is no longer necessary to use a DispatchQueue.

License

AWSSDKSwift is released under the Apache License, Version 2.0. See LICENSE for details.