Downloads objects from a specified bucket to a local environment or external application.

Procedure-Specific Information

If Object is not specified, all the objects from the specified bucket are retrieved. To download a specific object from a subfolder rather than the entire bucket, use the following path: Object = 'FolderName/SubfolderName/FileName'.

The following example shows how to execute this procedure:

EXECUTE DownloadObjects  
     @Bucket='BucketName',  
     @Object='ObjectName',  
     @LocalFolderPath='C:/Users/User/Desktop/LocalFolderName'

Input

Name	Type	Required	Accepts Output Streams	Description
Bucket	String	True	False	The name of the S3 bucket that contains the object or objects to be downloaded.
Object	String	False	False	The key (name) of a specific object to download. If not provided, all objects in the specified bucket are retrieved.
LocalFolderPath	String	False	False	The local directory path where the downloaded object files are saved.
ByteRangeStart	Long	False	False	The starting byte position for a partial object download, used to fetch a specific byte range.
ByteRangeEnd	Long	False	False	The ending byte position for a partial object download. Paired with ByteRangeStart.
UpdatedStartDate	Datetime	False	False	The earliest last-modified date for filtering which objects to download from the bucket.
UpdatedEndDate	Datetime	False	False	The latest last-modified date for filtering which objects to download from the bucket.
FileStream	String	False	True	An output stream instance where the object data is written. Used when LocalFolderPath is not specified.

Result Set Columns

Name	Type	Description
Status	String	Indicates the result of the download operation, such as success or failure.
Content	String	When LocalFolderPath is not specified, provides the downloaded object's content, encoded in Base64.
Object	String	The key (name) of the object that was downloaded.