s3_file_system: Access AWS S3 as if it were a file system.

In s3fs: 'Amazon Web Service S3' File System

Access AWS S3 as if it were a file system.

Description

This creates a file system "like" API based off fs (e.g. dir_ls, file_copy, etc.) for AWS S3 storage. To set up AWS credentials please look at https://docs.aws.amazon.com/cli/latest/userguide/cli-configure-files.html

Usage

s3_file_system(
  aws_access_key_id = NULL,
  aws_secret_access_key = NULL,
  aws_session_token = NULL,
  region_name = NULL,
  profile_name = NULL,
  endpoint = NULL,
  disable_ssl = FALSE,
  multipart_threshold = fs_bytes("2GB"),
  request_payer = FALSE,
  anonymous = FALSE,
  retries = 5,
  refresh = FALSE,
  ...
)

Arguments

aws_access_key_id	(character): AWS access key ID
aws_secret_access_key	(character): AWS secret access key
aws_session_token	(character): AWS temporary session token
region_name	(character): Default region when creating new connections
profile_name	(character): The name of a profile to use. If not given, then the default profile is used.
endpoint	(character): The complete URL to use for the constructed client.
disable_ssl	(logical): Whether or not to use SSL. By default, SSL is used.
multipart_threshold	(fs_bytes): Threshold to use multipart instead of standard copy and upload methods.
request_payer	(logical): Confirms that the requester knows that they will be charged for the request.
anonymous	(logical): Set up anonymous credentials when connecting to AWS S3.
retries	(numeric): max number of retry attempts
refresh	(logical): Refresh cached S3FileSystem class
...	Other parameters within paws client.

Value

S3FileSystem class invisible

Examples

## Not run: 
# Require AWS S3 credentials

# Set up connection using profile
s3_file_system(profile_name = "s3fs_example")

# Reset connection to connect to a different region
s3_file_system(
    profile_name = "s3fs_example",
    region_name = "us-east-1",
    refresh = TRUE
 )

## End(Not run)

s3fs documentation built on Sept. 11, 2024, 6:48 p.m.