Swiftpack.co - Package - swift-aws/aws-sdk-swift

AWS SDK Swift

AWS SDK for the Swift programming language working on Linux, macOS and iOS.

Swift 5.0

Compatibility

AWSSDKSwift works on both Linux, macOS and iOS. Version 4 is dependent on swift-nio 2. 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 |

Documentation

Visit the aws-sdk-swift documentation to browse the api reference.

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(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: ["S3", "SES", "CloudFront", "ELBV2", "IAM", "Kinesis"]),
    ]
)

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

Contributing

All developers should feel welcome and encouraged to contribute to aws-sdk-swift.

As contributors and maintainers of this project, and in the interest of fostering an open and welcoming community, we pledge to respect all people who contribute through reporting issues, posting feature requests, updating documentation, submitting pull requests or patches, and other activities.

To contribute a feature or idea to aws-sdk-swift, submit an issue and fill in the template. If the request is approved, you or one of the members of the community can start working on it.

If you find a bug, please submit a pull request with a failing test case displaying the bug or create an issue.

If you find a security vulnerability, please contact yuki@miketokyo.com and reach out on the #aws channel on the Vapor Discord as soon as possible. We take these matters seriously.

Configuring Credentials

Before using the SDK, you will need AWS credentials to sign all your requests. Credentials can be provided 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 them.

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.

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

Load Credentials from shared credential file.

You can set shared credentials in the home directory for the user running the app

in ~/.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 functions. Explicitly set accessKeyId and secretAccessKey to "". This will disable all other credential access functions and send requests unsigned.

Using aws-sdk-swift

AWS Swift Modules can be imported into any swift project. Each module provides a struct that can be initialized, with instance methods to call aws services. See documentation for details on specific services.

The underlying aws-sdk-swift httpclient returns a swift-nio EventLoopFuture object. An EventLoopFuture is not the response, 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.

The recommended manner to interact with futures 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 -> Future<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 -> Future<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)!)
            }
    }
}

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.

EventLoopGroup management

The AWS SDK has its own EventLoopGroup but it is recommended that you provide your own EventLoopGroup for the SDK to work off. You can do this when you construct your client.

let s3 = S3(region:.uswest2, eventLoopGroupProvider: .shared(myEventLoopGroup)

The EventLoopGroup types you can use depend on the platform you are running on. On Linux use MultiThreadedEventLoopGroup, on macOS use MultiThreadedEventLoopGroup or NIOTSEventLoopGroup and iOS use NIOTSEventLoopGroup. Using the NIOTSEventLoopGroup will mean you use NIO Transport Services and the Apple Network framework.

Using aws-sdk-swift 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

final class MyController {
    struct EmailData: Content {
        let address: String
        let subject: String
        let message: String
    }
    func sendUserEmailFromJSON(_ req: Request) throws -> Future<HTTPStatus> {
        return try req.content.decode(EmailData.self)
            .flatMap { (emailData)->EventLoopFuture<SES.SendEmailResponse> in
                let client = SES(region: .uswest1)

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

Speed Up Compilation

By specifying only those modules necessary for your application, only those modules will compile which makes for fast compilation.

If you want to create a module for your service, you can try using the module-exporter to build a separate repo for any of the modules.

License

aws-sdk-swift is released under the Apache License, Version 2.0. See LICENSE for details.

Github

link
Stars: 251
Help us keep the lights on

Releases

3.5.0 - Nov 27, 2019

Adam Fowler:

  • Remove switch in S3RequestMiddleware.virtualAddressFixup()
  • Don't apply virtual address to s3 buckets contain a period
  • fixes iam metadata credentials lookup on ec2 instances

4.0.0 - Nov 22, 2019

Using v4.0.0 of aws-sdk-swift-core.

Major version changes

  • aws-sdk-swift now requires Swift 5.0 or later.
  • We are now using Swift NIO 2.x. If you are dependent on a package using Swift NIO 1.14 or earlier eg Vapor 3, do not update to this version of aws-sdk-swift-core.

Features

  • Sync service model files to v1.25.32 of aws-sdk-go.
  • Re-worked HTTPClient so can work with NIO transport services. Because of this work aws-sdk-swift now works on iOS.
  • Service classes have a EventLoopGroupProvider parameter, an enum with which you can provide your own eventLoopGroup for aws-sdk-swift to use.
  • If service struct is initialised with accessKeyId and secretAccessKey set to "" then requests are sent to AWS unsigned. This gives access to AWS services such as CognitoIdentityProvider without access credentials.
  • Added multipart upload and download from S3.

Bug fixes

  • Fixed issue with incorrect error types being thrown for some services.
  • S3: Fixed uploading to S3 with a filename containing spaces.
  • S3: Buckets containing a period do not use virtual addressing anymore. Removed validation saying you cannot use bucket names containing a period.
  • ComprehendMedical: Added dxName case to EntitySubType enum.

3.3.0 - Oct 14, 2019

Using v3.4.0 of aws-sdk-swift-core

  • Sync service model files to v1.25.11 of aws-sdk-go.
  • Fixed issue compiling with Swift 5.1 on Linux.
  • Add validation of s3 bucket names to ensure they don't contain periods. As we use s3 bucket virtual addressing bucket names containing periods do not work.

3.2.0 - Sep 17, 2019

Using v3.3.0 of aws-sdk-swift-core

  • Sync service model files to v1.23.12 of aws-sdk-go.
  • We are now using Stencil to generate our swift service files from the AWS model files.
  • Deprecated api commands are now marked deprecated in swift.
  • Output xml namespace as member of AWSShape where available
  • Added validation code for AWSShape members wherever it is supplied in the model files. Will validate min, max values for numbers, string and collection length and validate strings against regex patterns.
  • Autogenerate idempotency tokens.
  • Remove all AWSShape's not tagged as an input or output of an api function.
  • Stop partition endpoint overwriting the region endpoint where a default value is being used for the region endpoint.
  • let client: AWSClient in service classes is now public.
  • Using Int instead of Int32 in service files.
  • Include sessionToken in service init() functions to allow for access to services via tokens returned from STS.
  • Include middlewares in service init() functions to allow user access to requests and responses as they are processed.
  • Errors thrown by service files all conform to CustomStringConvertible.
  • API functions are not tagged as throwing anymore.

Service changes

  • S3 Add additional regions to BucketLocationConstraint enum.
  • S3 Fixup response from GetBucketLocation so it is parsed correctly.
  • S3 Don't attempt to setup virtual bucket addresses for non amazon endpoints.
  • S3 Support metadata headers for Get/Put/HeadObject
  • Route53 Make Marker optional in ListHealthChecksResponse, ListHostedZonesResponse and ListReusableDelegationSetsResponse.
  • CloudFront Capitalized HttpVersion enum entries.

3.1.0 - Jul 19, 2019

Adam Fowler: CodeGenerator now adds CollectionEncoding enum Add more AWS services Fix Backup and DirectoryService frameworks name clash Add an issue template Patch PlatformValues enum in ec2 Deal with situation where location is set to "headers"

Jonathan McAllister: move the code generator out of the main project. in this way any code gen dependencies are not imposed on the sdks update models to latest from sdk-go 1.20.17 set sdk to min 3.1.1