Lucee Function Reference

s3setmetadata()

Sets the metadata on bucket or object. You can provide the endpoint as a bucket/object defintion (S3SetMetaData(bucket:"mybucket",object:"myobject.txt",metadata:data) ) or as a virtual filesystem path (S3SetMetaData(path:"s3://mybucket/myobject.txt",metadata:data) ).

Example

s3setmetadata(string bucketNameOrPath,[string objectName,struct metadata,[string accessKeyId,[string secretAccessKey,[string host,[number timeout]]]]]):void

Arguments

The arguments for this function are set. You can not use other arguments except the following ones.
Name Type Required Default Value Description
bucketNameOrPath string  Yes   This can be the bucketname or a virtual filesystem path for a file/directory (example "s3://mybucket/myobject.txt").  
objectName string  No Name of the object (path) within the bucket of your object to read. In case you have defined a bucket with the first argument.  
metadata struct  Yes    
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