repository·main·Indexed 43 days ago
https://github.com/paws-r/pawsA comprehensive AWS SDK for the R programming language that provides programmatic access to the full suite of Amazon Web Services. It is architected as a collection of packages, including the main paws loader, service-specific paws.<category> packages, and the foundational paws.common utility package.
paws.common is a foundational package for the Paws ecosystem. It provides the core utility functions required to interact with Amazon Web Services (AWS) APIs, specifically focusing on the mechanics of building and sending requests. It serves as the underlying engine for individual Paws service packages (such as paws.ec2), ensuring a consistent way to communicate with AWS services across the entire SDK.Paws is architected as a collection of specialized packages to manage AWS service code while staying within CRAN package size limits:
paws: The main package installed from CRAN. It acts as a loader for the various paws.<category> packages.paws.<category>: Service-specific packages (e.g., paws.storage for S3). Each category contains the code for a subset of AWS services.paws.common: A core package containing shared logic for making AWS requests and decoding responses. All paws.<category> packages depend on this.make.paws: An internal code generator (not on CRAN) that reads JSON metadata from the official AWS SDK for JavaScript and produces the R code for the paws and paws.<category> packages.When using Bedrock services, paws checks for credentials in the following order. If AWS_BEARER_TOKEN_BEDROCK is present, it will be used for Bedrock API authentication, overriding traditional IAM credentials for supported operations:
AWS_BEARER_TOKEN_BEDROCK environment variableAWS_ACCESS_KEY_ID, AWS_SECRET_ACCESS_KEY)~/.aws/credentials)~/.aws/config)Paws resolves credentials and configuration options using a specific hierarchy. If a setting is defined in multiple places, the one higher in this list takes precedence:
paws::svc(config = ...).AWS_ACCESS_KEY_ID or AWS_REGION.~/.aws/credentials and ~/.aws/config.Some AWS operations return incomplete results that require subsequent requests to retrieve the full set (e.g., s3$list_objects). Paws provides three paginator methods to automate this process. As of paws v0.4.0+, you can use these methods to handle pagination automatically.
paginate: Returns all response objects from the operation.paginate_lapply: Applies a function to each response object and returns the results as a list.paginate_sapply: Applies a function to each response object and simplifies the final result (similar to base::sapply).library(paws)
svc <- s3(region = "us-west-2")
# Returns all response objects
results <- paginate(svc$list_objects(Bucket = "my-bucket"))
# Returns a list of specific fields from each response
results <- paginate_lapply(svc$list_objects(Bucket = "my-bucket"), \(resp) resp$Contents)
# Returns a simplified vector/array of specific fields
results <- paginate_sapply(
svc$list_objects(Bucket = "my-bucket"),
\(resp) resp$Contents,
simplify = T
)Paws requires AWS credentials and a region to function. You can configure these per-service or globally using R environment variables, OS environment variables, AWS credential files, or IAM roles.
Warning: Avoid hardcoding credentials directly in your scripts. Use RStudio's best practices for securing credentials (e.g., using keyring) or environment variables.
Example using R environment variables:
Sys.setenv(
AWS_ACCESS_KEY_ID = "abc",
AWS_SECRET_ACCESS_KEY = "123",
AWS_REGION = "us-east-1"
)Sys.setenv(
AWS_ACCESS_KEY_ID = "abc",
AWS_SECRET_ACCESS_KEY = "123",
AWS_REGION = "us-east-1"
)Roxygen documentation is disabled in the make.paws package because it uses templated strings containing Roxygen directives that can cause interpretation errors or unintended side effects.
Because Roxygen is turned off, you must manually perform the following maintenance tasks if you modify the package structure:
NAMESPACE: Manually update this file if you change any @import or @export directives.DESCRIPTION: Manually update the Collate field if you change any @include directives within the package.The paws and paws.<category> packages are generated using make.paws. To build the packages from source, use the make build command.
Note that building is a slow process, but it is cached to speed up subsequent builds. If you have modified the code generator and need to clear the cache, use make clean.
make build
# To clear the cache:
make clean
# To see all available recipes:
makeWhen using renv for project dependency management, you can configure it to use the R-Universe binary source to speed up installation.
# In your project, configure renv to use R-Universe
options(repos = c(
pawsr = 'https://paws-r.r-universe.dev',
CRAN = 'https://cloud.r-project.org'
))
renv::install('paws')The r2u repository provides fast CRAN package installation on Ubuntu via pre-built binaries. After following the r2u installation guide to set up the repository, install Paws normally.
install.packages('paws')Posit Package Manager provides pre-compiled binaries for various Linux distributions. To use this:
install.packages('paws').install.packages('paws')By default, Paws uses the default profile. To use a different profile from your AWS shared credentials and config files, you can either set the AWS_PROFILE environment variable or specify the profile within the service configuration.
# Option 1: Using environment variables
Sys.setenv(AWS_PROFILE = "my-profile")
# Option 2: Using the profile parameter in the service object
svc <- paws::s3(
config = list(
credentials = list(
profile = "my-profile"
)
)
)