s3delete()
deletes a bucket or an object within a bucket.
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
|
edit
Name of the bucket to delete. Alias: bucket |
|
|
objectName
string,
optional
|
edit
Name of the object to delete, if not defined the bucket itself is deleted. Alias: object |
|
|
force
boolean,
optional
|
edit
Also delete bucket if it has content. |
|
|
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 37,613ms WARN No examples for function S3DeleteSee also
- s3deletebucket()
- Search Issue Tracker open_in_new
- Search Lucee Test Cases open_in_new (good for further, detailed examples)