https://github.com/britzl/aws-sdk-lua
Auto generated AWS SDK for Lua
https://github.com/britzl/aws-sdk-lua
amazon-web-services aws-sdk defold defold-library lua
Last synced: about 1 month ago
JSON representation
Auto generated AWS SDK for Lua
- Host: GitHub
- URL: https://github.com/britzl/aws-sdk-lua
- Owner: britzl
- License: apache-2.0
- Created: 2017-06-29T11:43:51.000Z (almost 8 years ago)
- Default Branch: master
- Last Pushed: 2020-03-12T12:34:11.000Z (about 5 years ago)
- Last Synced: 2025-03-31T14:21:42.934Z (2 months ago)
- Topics: amazon-web-services, aws-sdk, defold, defold-library, lua
- Language: Lua
- Size: 14.2 MB
- Stars: 39
- Watchers: 6
- Forks: 10
- Open Issues: 8
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE.txt
Awesome Lists containing this project
- awesome-defold - AWS SDK
README
[](https://travis-ci.org/britzl/aws-sdk-lua)
# AWS SDK for Lua (beta)
Unofficial AWS SDK for Lua, available for LuaJIT and Lua 5.1 and later. The SDK has been used in production, specifically GameLift, but several other services are untested.
For release notes, see the [CHANGELOG](CHANGELOG.md).
## Installing
### Defold
You can use the AWS SDK for Lua in your own project by adding this project as a [Defold library dependency](http://www.defold.com/manuals/libraries/). Open your game.project file and in the dependencies field under project add:
https://github.com/britzl/aws-sdk-lua/archive/master.zip
Or point to the ZIP file of a [specific release](https://github.com/britzl/aws-sdk-lua/releases).
### LuaRocks
The SDK is currently not distributed via LuaRocks. LuaRocks distribution will happen once the SDK is stable and moved out of beta.
## Usage
Using the AWS SDK for Lua is a simple process requiring only a few steps of configuration:
-- Configure AWS to work with Defold (specifically to use http.request() provided by the Defold engine to make HTTP calls)
local config = require "aws-skd.core.config"
config.use_defold()
-- config.use_corona()
-- config.use_luasocket()
-- Set access key and secret access key (read this from config file or os.env)
local credentials = require "aws-sdk.core.credentials"
credentials.set(access_key, secret_access_key)
-- Initialise the AWS service to use, in this case GameLift
local gamelift = require "aws-sdk.gamelift"
gamelift.init({ region = "eu-central-1" })
-- Make a call to a GameLift endpoint
local input = gamelift.CreateGameSessionInput({
CreatorId = "c6e209af-4ac0-47b4-c752-60f81db6d2d0",
AliasId = "alias-4cfbed10-a54d-4e9f-8bc0-ba7f98a6ef40",
Name = "My session",
MaximumPlayerSessionCount = 10
})
gamelift.CreateGameSessionAsync(input, function(response, error_message)
if not error_message then
print(response.GameSession.GameSessionId)
end
end)
## Generating code
The SDK generates the code for all AWS services, their input and output including input validation. The code generator uses official AWS SDK API definitions from the [AWS SDK for Javascript project](https://github.com/aws/aws-sdk-js/tree/master/apis). The code generator uses a [Mustache template](https://mustache.github.io/) and a small Python script to parse the API definitions and outputs one Lua file per AWS service. You can run the generator yourself from a terminal:
python generate.py
The script reads the definition files from ````apis/```` folder and outputs generated code to the ````aws-sdk/```` folder.
## Getting Help
Please use these community resources for getting help. We use the GitHub issues for tracking bugs and feature requests and have limited bandwidth to address them.
* Ask a question on the [Defold forum](https://forum.defold.com/)
* Come join the Defold [slack channel](https://www.defold.com/slack/)
* If it turns out that you may have found a bug, please [open an issue](https://github.com/britzl/aws-sdk-lua/issues/new)
## Opening Issues
If you encounter a bug with the AWS SDK for Lua we would like to hear
about it. Search the [existing issues](https://github.com/britzl/aws-sdk-lua/issues)
and try to make sure your problem doesn’t already exist before opening a new
issue. It’s helpful if you include the version of the SDK and the Lua version
you’re using. Please include a stack trace and reduced repro
case when appropriate, too.
The GitHub issues are intended for bug reports and feature requests. For help
and questions with using the AWS SDK for Lua please make use of the
resources listed in the [Getting Help](https://github.com/britzl/aws-sdk-lua#getting-help)
section. There are limited resources available for handling issues and by
keeping the list of open issues lean we can respond in a timely manner.
## License
This SDK is distributed under the
[Apache License, Version 2.0](http://www.apache.org/licenses/LICENSE-2.0),
see LICENSE.txt for more information.
## Third-party code used
The SDK uses code from the following projects:
* AWS Service definitions from the [AWS SDK for Javascript](https://github.com/aws/aws-sdk-js/tree/master/apis)
* Cryptographic functions from the [Lua-Lockbox](https://github.com/somesocks/lua-lockbox) project.
* JSON encoder from [json.lua](https://github.com/rxi/json.lua)
* URL encode/decode from the [Lua User Wiki]()
* XML parser from [xml2lua](https://github.com/manoelcampos/xml2lua) project.