DownloadObject
Download objects from AWS S3.
Task version: 3.0.0
Required Frends version: 5.7+
Required .NET version: 8.0
Compatible Agents: Crossplatform
Source code: https://github.com/FrendsPlatform/Frends.AmazonS3
Task Parameters
BucketName : String
AWS S3 bucket's name.
Default: -
Example: Bucket
SourceDirectory : String
Downloads all objects with this prefix.
Default: -
Example: directory/
SearchPattern : String
String pattern to search objects.
Default:
Example: .*, *file?.txt
DownloadFromCurrentDirectoryOnly : Boolean
Set to true to download objects from the current directory only.
Default: True
Example: false
TargetDirectory : String
Destination directory where to create folders and files.
Default: -
Example: c:\temp, \network\folder
AuthenticationMethod : AuthenticationMethods
Authentication method to use when connecting to AWS S3 bucket.
Possible values:
AwsCredentials: Authentication method to use when connecting to AWS S3 bucket.PreSignedUrl: Authentication method to use when connecting to AWS S3 bucket.
Default: 0
Example: AwsCredentials
🗝PreSignedUrl : String
A pre-signed URL allows you to grant temporary access to users who don't have permission to directly run AWS operations in your account.
Default: -
Example: "https://bucket.s3.region.amazonaws.com/object/file.txt?X...
🗝AwsAccessKeyId : String
AWS Access Key ID.
Default: -
Example: AKIAQWERTY7NJ5Q7NZ6Q
🗝AwsSecretAccessKey : String
AWS Secret Access Key.
Default: -
Example: TVh5hgd3uGY/2CqH
Region : Region
AWS S3 bucket's region.
Possible values:
AfSouth1: AWS S3 bucket's region.ApEast1: AWS S3 bucket's region.ApNortheast1: AWS S3 bucket's region.ApNortheast2: AWS S3 bucket's region.ApNortheast3: AWS S3 bucket's region.ApSouth1: AWS S3 bucket's region.ApSoutheast1: AWS S3 bucket's region.ApSoutheast2: AWS S3 bucket's region.CaCentral1: AWS S3 bucket's region.CnNorth1: AWS S3 bucket's region.CnNorthWest1: AWS S3 bucket's region.EuCentral1: AWS S3 bucket's region.EuNorth1: AWS S3 bucket's region.EuSouth1: AWS S3 bucket's region.EuWest1: AWS S3 bucket's region.EuWest2: AWS S3 bucket's region.EuWest3: AWS S3 bucket's region.MeSouth1: AWS S3 bucket's region.SaEast1: AWS S3 bucket's region.UsEast1: AWS S3 bucket's region.UsEast2: AWS S3 bucket's region.UsWest1: AWS S3 bucket's region.UsWest2: AWS S3 bucket's region.
Default: -
Example: EuCentral1
DeleteSourceObject : Boolean
Delete the S3 source object after download.
Subfolders will also be deleted if they are part of the object's key and there are no objects left.
Create subfolders manually to make sure they won't be deleted.
Default: False
Example: false
ThrowErrorIfNoMatch : Boolean
Throw an error if there are no objects in the path matching the search pattern.
Default: True
Example: false
ActionOnExistingFile : DestinationFileExistsActions
Actions if a destination file already exists.
Possible values:
Overwrite: Actions if a destination file already exists.Info: Actions if a destination file already exists.Error: Actions if a destination file already exists.
Default: 1
Example: Info
FileLockedRetries : Int32
For how long will this Task try to write to a locked file.
Value in seconds.
Default: 10
Example: 10
ThrowErrorOnFailure : Boolean
Throw an error on failure.
Default: True
Example: true
ErrorMessageOnFailure : String
Error message to display on failure.
Default: -
Example: Can't download an object
Task Result
Success : Boolean
Task complete without errors.
Example: True
Objects : List<SingleResultObject>
List of downloaded objects.
Example: { "File.txt", "C:\temp\File.txt", true, false, "Additional information" }
Error : Error
Error information if the operation failed.
Example: { "An error occurred", { "ErrorCode": 500 } }
Task Changelog
Changelog for Task Frends.AmazonS3.DownloadObject.
[3.0.0] - 2025-07-17
[Breaking] Major refactoring - restructured parameters into Input, Connection, and Options classes with improved error handling
Breaking Changes
Parameter Structure Reorganization: Task parameters have been restructured into three main classes:
Input: Contains core task parameters (BucketName, SourceDirectory, SearchPattern, DownloadFromCurrentDirectoryOnly, TargetDirectory)
Connection: Contains connection-related parameters (AwsCredentials, PreSignedUrl)
Options: Contains optional configuration parameters (FileLockedRetries, DeleteSourceObject, ThrowErrorIfNoMatch, ActionOnExistingFile, ThrowErrorOnFailure, ErrorMessageOnFailure)
Parameter Changes
Moved to Input tab:
Connection.BucketName→Input.BucketNameConnection.S3Directory→Input.SourceDirectory(renamed)Connection.SearchPattern→Input.SearchPatternConnection.DownloadFromCurrentDirectoryOnly→Input.DownloadFromCurrentDirectoryOnlyConnection.DestinationDirectory→Input.TargetDirectory(renamed)
Moved to Options tab:
Connection.FileLockedRetries→Options.FileLockedRetriesConnection.DeleteSourceObject→Options.DeleteSourceObjectConnection.ThrowErrorIfNoMatch→Options.ThrowErrorIfNoMatchConnection.DestinationFileExistsAction→Options.ActionOnExistingFile(renamed)
Updated in Connection tab:
Connection.AWSCredentials→Connection.AwsCredentials(renamed)Connection.PreSignedURL→Connection.PreSignedUrl(renamed)
New Features
Enhanced Error Handling: Added comprehensive error handling with new Options properties:
ThrowErrorOnFailure(bool, default: false) – Controls whether errors throw exceptionsErrorMessageOnFailure(string, default: "") - Custom error message for failures
Improved Result Structure:
Renamed
Dataproperty toObjectsin Result classAdded structured
Errorproperty withMessageandAdditionalInfofields
[2.2.0] - 2024-12-11
Updated
Listing updated to newer version.
[2.1.0] - 2023-05-10
Fixed
Changed the way the Task handles downloaded objects to fix blank PDF files.
Changed
Result change: List name change from 'Results' to 'Data'.
Input parameter name changed from to 'Connection'.
Memory leak fix.
SingleResultObject parameter changes:
New parameters: Overwritten, SourceDeleted, Info.
Removed parameter: ObjectData (replaced by Info).
[2.0.0] - 2022-12-02
Modified
Memory leak fix.
SingleResultObject parameter changes:
New parameters: Overwritten, SourceDeleted, Info.
Removed parameter: ObjectData (replaced by Info).
[1.0.0] - 2022-05-09
Added
Initial implementation
Last updated
Was this helpful?