https://github.com/ml-archive/aws

Swift wrapper around AWS API
https://github.com/ml-archive/aws

aws brto s3 server-side-swift swift vapor vapor-2

Last synced: 3 days ago
JSON representation

Swift wrapper around AWS API

• Host: GitHub
• URL: https://github.com/ml-archive/aws
• Owner: ml-archive
• License: mit
• Archived: true
• Created: 2016-11-16T12:03:45.000Z (almost 8 years ago)
• Default Branch: master
• Last Pushed: 2018-03-21T03:25:59.000Z (over 6 years ago)
• Last Synced: 2024-08-02T20:47:22.572Z (3 months ago)
• Topics: aws, brto, s3, server-side-swift, swift, vapor, vapor-2
• Language: Swift
• Size: 94.7 KB
• Stars: 72
• Watchers: 11
• Forks: 20
• Open Issues: 11
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# AWS

[![Swift Version](https://img.shields.io/badge/Swift-3-brightgreen.svg)](http://swift.org)

[![Vapor Version](https://img.shields.io/badge/Vapor-2-F6CBCA.svg)](http://vapor.codes)

[![Circle CI](https://circleci.com/gh/nodes-vapor/aws/tree/master.svg?style=shield)](https://circleci.com/gh/nodes-vapor/aws)

[![codebeat badge](https://codebeat.co/badges/255e7772-28ec-4695-bdd5-770cfd676d9c)](https://codebeat.co/projects/github-com-nodes-vapor-aws-master)

[![codecov](https://codecov.io/gh/nodes-vapor/aws/branch/master/graph/badge.svg)](https://codecov.io/gh/nodes-vapor/aws)

[![Readme Score](http://readme-score-api.herokuapp.com/score.svg?url=https://github.com/nodes-vapor/aws)](http://clayallsopp.github.io/readme-score?url=https://github.com/nodes-vapor/aws)

[![GitHub license](https://img.shields.io/badge/license-MIT-blue.svg)](https://raw.githubusercontent.com/nodes-vapor/aws/master/LICENSE)

This package makes it easy to use AWS resources from Swift.

## 📦 Installation

Update your `Package.swift` file.

```swift

.Package(url: "https://github.com/nodes-vapor/aws.git", majorVersion: 1)

```

## Getting started 🚀

Currently the following AWS Services are available:

- EC2

- S3

If you need other resources you can use Raw call, to call the AWS API directly.

### EC2

**Describe instances**

```swift

do {

    let instances = try EC2(

        accessKey: "my-key", 

        secretKey: "my-secret", 

        region: "my-region"

    ).describeInstances()

} catch {

}

```

### S3

**Upload a file to S3**

```swift

do {

    try S3(

        accessKey: "my-key", 

        secretKey: "my-secret", 

        region: "my-region", 

        bucket: "my-s3-bucket"

    ).uploadFile("/path/to/local/file", "/folder/in/s3/bucket")

} catch {

}

```

### Raw call

If you need a resource not made in one of the functions, you can use the system to call the AWS API directly.

**Describe instances example**

```swift

do {

    return try CallAWS().call(

        method: "GET", 

        service: "ec2", 

        host: "ec2.amazonaws.com", 

        region: "my-region", 

        baseURL: "https://ec2.amazonaws.com", 

        key: "my-key", 

        secret: "my-secret", 

        requestParam: "Action=DescribeInstances"

    )

} catch {

}

```

## 📃 Development

If you want to improve this, you'll need to make sure you're making a copy of OpenSSL available to `swift build` and the toolchain. If you use Xcode, something like the following after `brew install openssl` will work:

```

swift package -Xswiftc -I/usr/local/Cellar/openssl/1.0.2j/include -Xlinker -L/usr/local/Cellar/openssl/1.0.2j/lib/ generate-xcodeproj

```

## 🏆 Credits

This package is developed and maintained by the Vapor team at [Nodes](https://www.nodesagency.com).

The package owner for this project is [Brett](https://github.com/brettRToomey).

## 📄 License

This package is open-sourced software licensed under the [MIT license](http://opensource.org/licenses/MIT)