Lucee Function Reference
s3read()
Reads an object from S3 as a string.
Example
s3read(string bucketName,string objectName,[string charset,[string accessKeyId,[string secretAccessKey,[string host,[number timeout]]]]]):string
Arguments
The arguments for this function are set. You can not use other arguments except the following ones.
| Name | Type | Required | Default Value | Description |
|---|---|---|---|---|
| bucketName | string | Yes | Name of the bucket of your object to read | |
| objectName | string | Yes | Name of the object (path) within the bucket of your object to read | |
| charset | string | No | UTF-8 | charset to use to store the content. |
| accessKeyId | string | No | S3 accessKeyId, if not defined it checks the system property/environment variable for [lucee.s3.accesskeyid]. | |
| secretAccessKey | string | No | S3 secretAccessKey, if not defined it checks the system property/environment variable for [lucee.s3.secretaccesskey]. | |
| host | string | No | the provider to connect, if not set Amazon AWS is used. | |
| timeout | number | No | 10000 | timeout for this execution |