S3 Storage
Discover more about the S3 Storage component and how to use it on the Digibee Integration Platform.
S3 Storage connects itself with the AWS S3 Storage and makes the following operations in the storage: List, Download, Upload, Delete or Move.
Parameters
Take a look at the configuration options for the component. Parameters supported by Double Braces expressions are marked with (DB)
.
The manipulation of files inside a pipeline occurs in a protected way. All the files can be accessed through one temporary directory only, in which each pipeline key provides access to its own set of files.
Messages flow
Input
It will be necessary to provide some input message only if the component has a field configured with Double Braces expressions. Otherwise, the component doesn't expect any specific input message. All you have to do is to configure the fields shown in each selected operation.
Output
List operation scenario
success: if the call is successful, the result will be “true”; otherwise, it will be “false”.
content: array containing file information.
bucketName: name of the bucket.
key: name of the directory + name of the file.
size: size of the file.
lastModified: date of the last file change.
storageClass: type of storage configured in S3.
owner: nome of the file owner.
etag: entity tag, a hash generated by the file S3.
count: number of returned objects.
nextToken: if there's more than one object to be listed, this property is shown for the remaining items to be paginated.
Download operation scenario
success: if the call is successful, the result will be “true”; otherwise, it will be “false”.
fileName: name of the file downloaded in the pipeline directory.
remoteDirectory: name of the S3 remote directory.
remoteFileName: name of the remote file downloaded in S3.
bucketName: name of the S3 bucket.
Upload operation scenario
success: if the call is successful, the result will be “true”; otherwise, it will be “false”.
fileName: name of the file downloaded in the pipeline directory.
remoteDirectory: name of the S3 remote directory.
remoteFileName: name of the remote file downloaded in S3.
bucketName: name of the S3 bucket.
urlGenerated: download link of the file if the Generate Download Link option is enabled.
Move operation scenario
success: if the call is successful, the result will be “true”; otherwise, it will be “false”.
remoteDirectory: name of the S3 remote directory.
remoteFileName: name of the remote file downloaded in S3.
bucketName: name of the S3 bucket.
bucketNameMove: name of the bucket of the moved file.
remoteDirectoryMove: name of the remote directory of the moved file.
remoteFileNameMove: new name of the remote file to be moved.
Delete operation scenario
success: if the call is successful, the result will be “true”; otherwise, it will be “false”.
remoteDirectory: name of the S3 remote directory.
remoteFileName: name of the remote file deleted from S3.
Output with error
success: “false”, because there was an error in the execution.
message: error message of the component.
error: error message received from the S3 server.
Last updated