Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/cloudyr/aws.lambda
AWS Lambda Client Package
https://github.com/cloudyr/aws.lambda
aws aws-lambda cloudyr lambda r
Last synced: 3 months ago
JSON representation
AWS Lambda Client Package
- Host: GitHub
- URL: https://github.com/cloudyr/aws.lambda
- Owner: cloudyr
- License: gpl-3.0
- Created: 2014-12-27T11:30:46.000Z (almost 10 years ago)
- Default Branch: master
- Last Pushed: 2020-04-29T15:53:44.000Z (over 4 years ago)
- Last Synced: 2024-07-22T17:59:19.516Z (4 months ago)
- Topics: aws, aws-lambda, cloudyr, lambda, r
- Language: R
- Homepage: https://cran.r-project.org/package=aws.lambda
- Size: 92.8 KB
- Stars: 32
- Watchers: 7
- Forks: 5
- Open Issues: 9
-
Metadata Files:
- Readme: README.Rmd
- Contributing: .github/CONTRIBUTING.md
- License: LICENSE.md
Awesome Lists containing this project
- jimsghstars - cloudyr/aws.lambda - AWS Lambda Client Package (R)
README
---
output: github_document
---
```{r, include = FALSE}
knitr::opts_chunk$set(
collapse = TRUE,
comment = "#>",
fig.path = "man/figures/README-",
out.width = "100%"
)
```
# aws.lambda
[](https://CRAN.R-project.org/package=aws.lambda)
[](https://github.com/cloudyr/aws.lambda/actions)
**aws.lambda** is a client package for the [Amazon Web Services (AWS) Lambda API](https://aws.amazon.com/lambda/).
## Installation
You can install the released version of aws.lambda from [CRAN](https://CRAN.R-project.org) with:
``` r
install.packages("aws.lambda")
```
And the development version from [GitHub](https://github.com/) with:
``` r
# install.packages("remotes")
remotes::install_github("cloudyr/aws.lambda")
```
## API Keys
To use the package, you will need an AWS account and to enter your credentials into R. Your keypair can be generated on the [IAM Management Console](https://aws.amazon.com/) under the heading *Access Keys*. Note that you only have access to your secret key once. After it is generated, you need to save it in a secure location. New keypairs can be generated at any time if yours has been lost, stolen, or forgotten. The [**aws.iam** package](https://github.com/cloudyr/aws.iam) profiles tools for working with IAM, including creating roles, users, groups, and credentials programmatically; it is not needed to *use* IAM credentials.
A detailed description of how credentials can be specified is provided at: https://github.com/cloudyr/aws.signature/. The easiest way is to simply set environment variables on the command line prior to starting R or via an `Renviron.site` or `.Renviron` file, which are used to set environment variables in R during startup (see `? Startup`). They can also be set within R:
```{r eval=FALSE}
Sys.setenv("AWS_ACCESS_KEY_ID" = "mykey",
"AWS_SECRET_ACCESS_KEY" = "mysecretkey",
"AWS_DEFAULT_REGION" = "us-east-1",
"AWS_SESSION_TOKEN" = "mytoken")
```
## Code Examples
The package is still under rapid development, but a simple and literal "Hello, world!" example can be found by doing the following:
```{r eval=FALSE}
library("aws.lambda")
# get list of all current functions
funclist <- sapply(list_functions(), get_function_name)
# 'hello world!' example code
hello <- system.file("templates", "helloworld.js", package = "aws.lambda")
# get IAM role for Lambda execution. Note: This is not currently sufficient, and
# will be updated in an upcoming update to the package.
requireNamespace("aws.iam")
id <- aws.iam::get_caller_identity()[["Account"]]
role <- paste0("arn:aws:iam::", id, ":role/lambda_basic_execution")
if (!"helloworld" %in% funclist) {
func <- create_function(name = "helloworld", func = hello,
handler = "helloworld.handler", role = role)
} else {
func <- get_function("helloworld")
}
# invoke function
invoke_function(func)
```
```{r eval=FALSE}
delete_function(func)
```
Obviously this is a trivial lambda function, but the point is that basically anything (in node.js, python, or java) could be written into the "deployment package" and called in this way.
A slightly more complex example shows how to pass arguments to the lambda function via the function's `payload` and examine the response.
```{r eval=FALSE}
# example function that performs simple addition
plus <- system.file("templates", "plus.js", package = "aws.lambda")
# get IAM role for Lambda execution
requireNamespace("aws.iam")
id <- aws.iam::get_caller_identity()[["Account"]]
role <- paste0("arn:aws:iam::", id, ":role/lambda_basic_execution")
if (!"plus" %in% funclist) {
func <- create_function(name = "plus", func = plus,
handler = "plus.handler", role = role)
} else {
func <- get_function("plus")
}
# invoke function
invoke_function(func, payload = list(a = 2, b = 3))
invoke_function(func, payload = list(a = -5, b = 7))
```
```{r eval=FALSE}
delete_function(func)
```
---
[](https://github.com/cloudyr)