S3Handler-class: S3Handler class and handler objects.

In ConservationInternational/VitalSignsUtilities: Interfaces Google Drive, S3 and Github for Conservation International's Vital Signs Project

Description

This handler object allows users to operate with S3 at a very basic level. It is entirely a wrapper for AWS CLI.

Usage

S3Handler

Format

An R6 class object.

Methods

• writeCredentials(aws_access_key_id, aws_secret_access_key, json_file, profile_name): There are three potential modes of use with this method: 1) The user provides AWS access key id and secret access key 2) The user provides a JSON file with the credentials 3) The user provides a profile name that already exists in the default credentials file (~/.aws/credentials) Then, the method operates appropriately and initializes an object that can interact with AWS

• writeS3(bucket, source_path, target_path, overwrite = FALSE): This method allows the user to write to S3, provided a bucket, source file path and target path in the bucket, along with whether or not the user wishes to overwrite the data.

• listS3(bucket, path = ""): Given a bucket and path (optional), the user gets an entire, recursive listing of files and folders from the combined path of the bucket and path.

• checkFilesS3(bucket, path): Given a bucket and path, the user can use this method to check whether a file already exists in the S3 bucket.

ConservationInternational/VitalSignsUtilities documentation built on May 6, 2019, 12:51 p.m.