s3delete()

deletes a bucket or an object within a bucket.

Status:

deprecated

Requires Extension: S3 Resource Extension

s3delete( bucketName=string, objectName=string, force=boolean, accessKeyId=string, secretAccessKey=string, host=string, timeout=number );

Returns: Query

Argument Description Default
bucketName
string, required

Name of the bucket to delete.

Alias: bucket

objectName
string, optional

Name of the object to delete, if not defined the bucket itself is deleted.

Alias: object

force
boolean, optional

Also delete bucket if it has content.

Alias: bucket

accessKeyId
string, optional

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

Alias: accessKey

secretAccessKey
string, optional

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

Alias: secretkey

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 19,790ms WARN No examples for function s3delete

See also