s3clearBucket()

Removes all objects from a s3 bucket, unless maxage is set, in that case only objects that are older than maxage are removed.

Requires Extension: S3 Resource Extension

s3clearBucket( bucketName=string, maxage=timespan, accessKeyId=string, secretAccessKey=string, host=string, timeout=number );

Returns: void

Argument Description Default
bucketName
string, required

Name of the bucket to list objects from.

Alias: bucket

maxage
timespan, optional

Max age of the object we keep, if not set all objects are removed.

Alias: age

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 18,052ms WARN No examples for function s3clearbucket

See also