/aws.signature

Little package to do AWS request signatures

Primary LanguageR

Amazon Web Services Request Signatures

aws.signature is a simple R package to create request signatures for Amazon Web Services (AWS) RESTful APIs.

To use the package, you will need an AWS account and enter your credentials into R. Your keypair can be generated on the IAM Management Console 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.

By default, all cloudyr packages look for the access key ID and secret access key in environment variables. You can also use this to specify a default region. For example:

Sys.setenv("AWS_ACCESS_KEY_ID" = "mykey",
           "AWS_SECRET_ACCESS_KEY" = "mysecretkey",
           "AWS_DEFAULT_REGION" = "us-east-1")

These can alternatively be set on the command line or via an Renviron.site or .Renviron file (see here for instructions).

If you work with multiple AWS accounts, another option that is consistent with other Amazon SDKs is to create a centralized ~/.aws/credentials file, containing credentials for multiple accounts. You can then use credentials from this file on-the-fly by simply doing:

# use your 'default' account credentials
use_credentials()

# use an alternative credentials profile
use_credentials(profile = "bob")

Installation

CRAN Build Status codecov.io

There is little reason to install this package directly (without also installing a client package for a particular AWS API), but to install the latest version you can install from the cloudyr drat repository:

# latest stable version
install.packages("aws.signature", repos = c(getOption("repos"), "http://cloudyr.github.io/drat"))

Or, to pull a potentially unstable version directly from GitHub:

if (!require("ghit")) {
    install.packages("ghit")
}
ghit::install_github("cloudyr/aws.signature")

To install the latest version from CRAN, simply use install.packages("aws.signature").


cloudyr project logo