Delete

The Delete activity is used to delete Amazon S3 objects and buckets. The Delete Bucket operation first deletes all objects in a bucket and then deletes the bucket.

General

The General tab contains the following fields:

Field Module Property? Description
Name No Name to be displayed as a label for the activity in the process
Amazon Connection Yes Provides connection details to communicate with an Amazon S3 instance
Service Name No You can choose from the two options provided:
  • Object: Delete an object from a bucket
  • Bucket: Delete a bucket
Bucket No Select a bucket
Delete When Empty No Enable this option to prevent the delete activity from deleting a bucket that has objects stored in it.

If enabled and the bucket is not empty, the activity is successful but the bucket is not deleted.

This option is not relevant to the Delete Object operation.

Description

In the Description tab, you can provide a short description of the Delete activity.

Field Module Property? Description
Description No Description of the Delete activity

Input

The input of the activity varies depending on the Service Name specified in the General tab.

Input for Delete Bucket
Input Item Data Type Description
bucketName String Name of the bucket to be listed
Input for Delete Object
Input Item Data Type Description
bucketName String Name of a bucket containing the desired object
key String Key under which the desired object is stored
version String Amazon S3 version ID specifying a particular version of the object to be deleted
quiet boolean Value to enable or disable the quiet mode for delete objects

Output

The output activity varies depending on the Service Name specified in the General tab.

Output for Delete Bucket
Output Item Data Type Description
result String Result of the delete bucket operation
Output for Delete Object
Output Item Data Type Description
deleteMakerVersion String Name of the bucket containing the desired object
key String Key under which the object to be deleted is stored
versionId String Version of the object to be deleted
isDeleteMarker Boolean Indicates whether the deleted object was a delete marker

Fault

The Fault tab lists exceptions that are thrown by the Delete activity. It has the following fields:

Error Schema Element Data Type Description
Amazon S3 Plugin Exception Complex Any exception created by TIBCO BusinessWorks Plug-in for Amazon S3

msg: Error message description that is returned by the plug-in

msgCode: Error code that is returned by the plug-in

Amazon S3 Client Exception Complex Any exception or error reported by Amazon S3 Client

msg: Error message description that is returned by the plug-in

msgCode: Error code that is returned by the plug-in

Amazon S3 Service Exception Complex Any exception or error reported by Amazon S3 instance

msg: Error message description that is returned by the plug-in

msgCode: Error code that is returned by the plug-in