Reads an object from S3 as a string.
Requires Extension: S3 Resource Extension
s3read( bucketName=string, objectName=string, charset=string, accessKeyId=string, secretAccessKey=string, host=string, timeout=number );
| Argument |
Description |
Default |
|
bucketName
string,
required
|
Name of the bucket of your object to read
Alias:
bucket
|
|
|
objectName
string,
required
|
Name of the object (path) within the bucket of your object to read
Alias:
object, path
|
|
|
charset
string,
optional
|
charset to use to store the content.
|
UTF-8
|
|
accessKeyId
string,
optional
|
S3 accessKeyId, if not defined it checks the system property/environment variable for [lucee.s3.accesskeyid].
Alias:
accessKey, awsAccessKeyId, awsAccessKey
|
|
|
secretAccessKey
string,
optional
|
S3 secretAccessKey, if not defined it checks the system property/environment variable for [lucee.s3.secretaccesskey].
Alias:
secretkey, awsSecretkey, awsSecretAccessKey
|
|
|
host
string,
optional
|
the provider to connect, if not set Amazon AWS is used.
Alias:
provider, server
|
|
|
timeout
number,
optional
|
timeout for this execution
|
10000
|
Examples
There are currently no examples for this function
17,964ms WARN No examples for function s3read
See also
