Description Usage Arguments Details Value
This is the workhorse function for executing API requests for S3.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 | s3HTTP(
verb = "GET",
bucket = "",
path = "",
query = NULL,
headers = list(),
request_body = "",
write_disk = NULL,
write_fn = NULL,
accelerate = FALSE,
dualstack = FALSE,
parse_response = TRUE,
check_region = FALSE,
url_style = c("path", "virtual"),
base_url = Sys.getenv("AWS_S3_ENDPOINT", "s3.amazonaws.com"),
verbose = getOption("verbose", FALSE),
show_progress = getOption("verbose", FALSE),
region = NULL,
key = NULL,
secret = NULL,
session_token = NULL,
use_https = TRUE,
...
)
|
verb |
A character string containing an HTTP verb, defaulting to “GET”. |
bucket |
A character string with the name of the bucket, or an object of class “s3_bucket”. If the latter and a region can be inferred from the bucket object attributes, then that region is used instead of |
path |
A character string with the name of the object to put in the bucket (sometimes called the object or 'key name' in the AWS documentation.) |
query |
Any query arguments, passed as a named list of key-value pairs. |
headers |
A list of request headers for the REST call. |
request_body |
A character string containing request body data. |
write_disk |
If |
write_fn |
If set to a function and |
accelerate |
A logical indicating whether to use AWS transfer acceleration, which can produce significant speed improvements for cross-country transfers. Acceleration only works with buckets that do not have dots in bucket name. |
dualstack |
A logical indicating whether to use “dual stack” requests, which can resolve to either IPv4 or IPv6. See http://docs.aws.amazon.com/AmazonS3/latest/dev/dual-stack-endpoints.html. |
parse_response |
A logical indicating whether to return the response as is, or parse and return as a list. Default is |
check_region |
A logical indicating whether to check the value of |
url_style |
A character string specifying either “path” (the default), or “virtual”-style S3 URLs. |
base_url |
A character string specifying the base hostname for the request (it is a misnomer, the actual URL is constructed from this name, region and |
verbose |
A logical indicating whether to be verbose. Default is given by |
show_progress |
A logical indicating whether to show a progress bar for downloads and uploads. Default is given by |
region |
A character string containing the AWS region. Ignored if region can be inferred from |
key |
A character string containing an AWS Access Key ID. If missing, defaults to value stored in environment variable AWS_ACCESS_KEY_ID. |
secret |
A character string containing an AWS Secret Access Key. If missing, defaults to value stored in environment variable AWS_SECRET_ACCESS_KEY. |
session_token |
Optionally, a character string containing an AWS temporary Session Token. If missing, defaults to value stored in environment variable AWS_SESSION_TOKEN. |
use_https |
Optionally, a logical indicating whether to use HTTPS requests. Default is |
... |
Additional arguments passed to an HTTP request function. such as |
This is mostly an internal function for executing API requests. In almost all cases, users do not need to access this directly.
the S3 response, or the relevant error.
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.