Machine Overview

• Machine Name : S3 Bucket
• Title : AWS S3 File Management: Upload and Retrieve Files
• Short Description :
  This S3 Bucket machine performs two main tasks: reading files from an S3 bucket and uploading files to it, based on the user-provided configuration and file data. And if user in write mode then it returning the S3 object URL and file name, with optional folder placement within the bucket.
• Detail Description : The S3 Bucket machine is designed to interact with Amazon S3, allowing users to either read or upload files based on their configuration. Users can specify a mode ('read' or 'write') to determine the operation. If the mode is 'read', the machine retrieves files from the specified S3 bucket and folder, processes them, and deletes them after handling. If the mode is 'write', it uploads files to the S3 bucket by encoding them in Base64 and providing necessary metadata, including file names and content types. The machine uses user-provided AWS credentials (access key, secret key, and region) to authenticate and access the bucket. The system ensures that any error or failure is logged and handled. This process is part of a broader workflow, which involves getting file data, performing operations, and passing the results to the next step via callbacks.
• Machine Document : Download

Classification

• Industry : IT
• Category : Database
• Sub Category : -

Compatibility and Dependencies

• Dependent Machines : -
• Compatible Machines : -
• Version : 1.0.4

Specifications

• Input Specification : Download

  This input data get the necessary AWS credentials, bucket details, and optional folder information for reading from or uploading files to an S3 bucket.

  • Mode (String): Specifies the mode of operation for file access. Use 'read' for reading files from the S3 bucket or 'write' for uploading files to the S3 bucket.
  • AWS Access Key (String): AWS authentication key for accessing S3 services.
  • AWS Secret Key (String): AWS secret key used for secure S3 authentication.
  • AWS Region (String): AWS region where the S3 bucket is located.
  • S3 Bucket Name (String): The name of the S3 bucket for file storage.
  • S3 Folder (String): Folder name within the S3 bucket for storing files.
  • File Names (Array[String]): A list of file names that you want to read from the S3 bucket. You can provide multiple file names in this list. The file names should be in the following format: ['File 1', 'File 2', 'File 3'].
• Output Specification : Download

  The output provides the URLs and file paths of uploaded files (for write mode) or retrieved files (for read mode), helping identify and access files stored in the S3 bucket.

  • Mode (String): Specifies the mode of operation for file access. 'write' is used for uploading files, and 'read' is used for retrieving files from the S3 bucket.
  • (Write) Uploaded Data (Array): A list of data entries for files that have been uploaded in 'write' mode. Each entry in the array represents an uploaded file.
  • (Write) S3 Object Url (String): The URL that provides access to the file stored in the S3 bucket after uploading.
  • (Write) File Name (String): The name of the file uploaded or retrieved from the S3 bucket.
  • (Read) Get File (Array): A list of data entries for files that have been retrieved in 'read' mode. Each entry in the array represents a retrieved file.
  • (Read) File Path (String): The file path where the file is located on the that path after being retrieved from the S3 bucket.
  • (Read) File Name (String): The name of the file retrieved from the S3 bucket in 'read' mode.

Infrastructure Requirement

• OS Requirement : Linux
• CPU : 500m
• Cloud : AWS
• RAM : 256Mi

Usage Stats

• Total OnBoarded : -
• Active OnBoarding : -