Official |[Amazon S3] Delete File/Folder

Operation name

Delete File/Folder

Function overview

Deletes the folder/files on Amazon S3.

Data model

The data model of this component is XML type.

Tutorials

For details about how to create a connection to Amazon S3, refer to the following tutorial:

Create a connection to Amazon S3

Properties

= Remarks =

For details on use of variables, refer to Variables.

Basic settings

Item name	Required/Optional	Use of variables	Description	Remarks
Name	Required	Not available	Enter a name that is used on the script canvas.

Required settings

Item name	Required/Optional	Use of variables	Description	Remarks
Destination	Required	Not available	Select a connection resource. Add A new connection resource can be added. Edit list Connection resource settings can be edited in > HULFT INTEGRATE > Connections.
Bucket name	Required	Available	Specify a bucket.	For Bucket name, if you specify a bucket in which a large number of files exist, it may take time to update the list in Folder path.
Delete bucket	Optional	Not available	Select whether to delete the bucket. Selected Delete bucket. Not selected (Default) Delete file/folder.
Folder path	Required	Available	Enter an Amazon S3 folder path.	Note Specify the absolute path of Amazon S3 as the folder path. With the exception of the path separator "/", the Restricted characters of HULFT Square Storage can't be used. If you select Delete bucket, this is disabled.
Delete folder	Optional	Not available	Select whether to delete the folder specified in Folder path. Selected Delete the folder specified in Folder path and all files/folders in the folder. Not selected (Default) Don't delete the folder specified in Folder path. Files/folders in the folder are deleted according to the settings of File/folder name and Recursive processing.	If you select Delete bucket, this is disabled.
File/folder name	Required	Available	Specify a file/folder directly under the folder specified in Folder path If a file is specified or if a file matches using wildcards, delete the file. If a folder is specified or if a folder matches using wildcards, the behavior depends on the Recursive processing setting.	If you select Delete bucket or Delete folder, this is disabled. Wildcards ("*" and "?") can be used. "/" can't be included.
Recursive processing	Optional	Not available	Select whether to delete the specified folder recursively. Selected If a folder is specified in File/folder name or if a folder matches using wildcards, delete the folder and files/folders in the folder recursively. Not selected (Default) If a folder is specified in File/folder name, delete only files in that folder. If a folder matches using wildcards, delete nothing.	If you select Delete bucket or Delete folder, this is disabled.

Data processing method

Item name	Required/Optional	Use of variables	Description	Remarks
Data processing method	Required	Not available	Select a data processing method. Apply script settings (Default) The setting for mass data processing in the script properties is applied to the connector. Do not perform mass data processing Mass data processing isn't performed. Perform mass data processing Mass data processing is performed.

Item name

Required/Optional

Use of variables

Description

Remarks

Data processing method

Required

Not available

Select a data processing method.

Apply script settings

(Default)

The setting for mass data processing in the script properties is applied to the connector.

Do not perform mass data processing

Mass data processing isn't performed.

Perform mass data processing

Mass data processing is performed.

Comment

Item name	Required/Optional	Use of variables	Description	Remarks
Comment	Optional	Not available	You can write a short description of this connector.

Schemas

Input schema

None.

Output schema

When deleting files

<?xml version="1.0"?>
<server>
  <bucket name="" status="" >
    <file name="" remotepath="" status="" type="" />
  </bucket>
</server>

Element name	Attribute name	Description	Remarks
server	-
bucket	-	Appears for the bucket that is specified in Bucket name.
	name	Outputs the name that is specified in Bucket name.
	status	Outputs the status of the bucket that is specified in Bucket name. Exist The bucket exists. ErrorBucketNotFound The specified bucket doesn't exist in Amazon S3. The specified Bucket name may be incorrect. Error The existence of the bucket couldn't be confirmed because an error has occurred.
file	-	Appears once for each deleted file/folder.
	name	Outputs the name of the deleted file/folder.	If status is "ErrorRemoteFolderNotFound", then the value is blank. If Delete folder is selected, then the value is blank.
	remotepath	Outputs the file path on Amazon S3 of the deleted file/folder.
	status	Outputs the status of the deleted file/folder. Deleted The file/folder has been successfully deleted. ErrorRemoteFolderNotFound The specified Folder path doesn't exist on Amazon S3, or a file is specified. ErrorRemoteFileNotFound The specified file/folder doesn't exist in the specified Folder path on Amazon S3. Error The file/folder couldn't be deleted due to an error.
	type	Outputs the classification of deleted file/folder. File File Folder Folder

When deleting bucket

<?xml version="1.0"?>
<server>
  <bucket name="" status="" />
</server>

Element name	Attribute name	Description
server	-
bucket	-	Appears once for each retrieved bucket.
	name	Outputs the name of the retrieved bucket.
	status	Outputs the status of the retrieved bucket. Deleted The bucket has been successfully deleted. ErrorBucketNotFound The specified bucket doesn't exist in Amazon S3. The specified Bucket name may be incorrect. Error The bucket couldn't be deleted because an error has occurred.

Loading schema in Mapper

The schema is loaded automatically.

= Remarks =

For details, refer to Edit Schema.

Mass data processing

Mass data processing is supported.

Transaction

Transaction isn't supported.

Parallel Stream Processing

PSP isn't supported.

Available component variables

Component variable name	Description	Remarks
count	The number of deleted files and folders is stored.	The default value is null. The sum of "folder_count" and "file_count".
folder_count	The number of deleted folders is stored.	The default value is null.
file_count	The number of deleted files is stored.	The default value is null.
message_category	When an error occurs, the category of the message code corresponding to the error is stored.	The default value is null.
message_code	When an error occurs, the code of the message code corresponding to the error is stored.	The default value is null.
message_level	When an error occurs, the severity of the message code corresponding to the error is stored.	The default value is null.
error_type	When an error occurs, the error type is stored.	The default value is null. The format of the error type is as follows. Example: java.io.FileNotFoundException
error_message	When an error occurs, the error message is stored.	The default value is null.
error_trace	When an error occurs, the trace information for the error is stored.	The default value is null.

Message codes, exception messages, and limitations

Connector	Message code	Exception message	Limitations
Messages and limitations of the Amazon S3 connector