s3getmetadata()

edit

Returns the metadata related to the object or bucket. You can provide the endpoint as a bucket/object definition (S3GetMetaData(bucket:"mybucket",object:"myobject.txt") ) or as a virtual filesystem path (S3GetMetaData(path:"s3://mybucket/myobject.txt") ).

Requires Extension: S3 Resource Extension

s3getmetadata( bucketNameOrPath=string, objectName=string, accessKeyId=string, secretAccessKey=string, host=string, timeout=number );

Returns: Struct

Argument Description Default
bucketNameOrPath
string, required 		edit

This can be the bucketname or a virtual filesystem path for a file/directory (example "s3://mybucket/myobject.txt").

Alias: bucket, bucketName, path
objectName
string, optional 		edit

Name of the object (path) within the bucket of your object to read. In case you have defined a bucket with the first argument.

Alias: object, path
accessKeyId
string, optional 		edit

S3 accessKeyId, if not defined it checks the system property/environment variable for [lucee.s3.accesskeyid].

Alias: accessKey, awsAccessKeyId, awsAccessKey
secretAccessKey
string, optional 		edit

S3 secretAccessKey, if not defined it checks the system property/environment variable for [lucee.s3.secretaccesskey].

Alias: secretkey, awsSecretkey, awsSecretAccessKey
host
string, optional 		edit

the provider to connect, if not set Amazon AWS is used.

Alias: provider, server
timeout
number, optional 		edit

timeout for this execution

10000

Examples

There are currently no examples for this function 39,904ms WARN No examples for function S3GetMetaData

See also