PLATFORMS SOLUTIONS BLOGS CONTACT ☰

S3 Adapter



This adapter allows you to manage Amazon S3 buckets and objects (files).


Want to try it in Azure? Click here to learn more or click here to create a new Enzo Server RTM 3.1 Azure VM now.
Want to try it in AWS? Click here to learn more or click here to create a new Enzo Server RTM 3.1 AWS VM now.


Configuration Settings



Name Description Default
Boolean _isDefault Make this the default configuration. Defaults to true if configName is already the default.
String accessKeyId The accessKeyId used for authentication
String secretAccessKey The secretAccessKey used for authentication
String region Default region in which buckets will be accessed (ex:us-east-1, eu-west-2)

Handlers



CreateBucket
bucket 		Create new bucket details 

Arguments

Name Description Default
bucketName R The name of the bucket
override If true, overrides the bucket if it already exists (default: 0) False
region Overrides the default region when accessing buckets (ex:us-east-1, eu-west-2)

SQL Call

EXEC S3.CreateBucket 'TestBucket'
insert into S3.Bucket (bucketName) values (bucketName)


Http Call

/s3/createbucket

Output Columns

This call does not return data.

DeleteBucket
bucket 		Delete a bucket details 

Arguments

Name Description Default
bucketName R The name of the bucket
region Overrides the default region when accessing buckets (ex:us-east-1, eu-west-2)

SQL Call

EXEC S3.DeleteBucket 'TestBucket'
delete from S3.bucket where bucketName='TestBucket'


Http Call

/s3/deletebucket

Output Columns

This call does not return data.

downloadFile
Download a file to a local or UNC path details 

Arguments

Name Description Default
bucketName R The bucket name to download the file
fileName R The relative path of the file (or the full graphPath). Can also be a File ID (start with id:...)
downloadPath The local or UNC path where file will be downloaded (leave blank to download to a Temp directory)
override If true, overrides the file if it already exists (default: 0) False
timeout Timeout operation in minutes - default: 0 (no timeout) 0
retryCount Number of retries (default: 3) 3
region Overrides the default region when accessing buckets (ex:us-east-1, eu-west-2)

SQL Call

EXEC S3.downloadFile @bucketName='testbucket',  @fileName='file path', @downloadPath='D:\download\file.txt'


Http Call

/s3/downloadfile

Output Columns

String region
String fileName
String tmpFileName
Int64 byteTx
Double elapsedTime
String id
String downloadPath
Boolean override
Int32 timeout
Int32 retryCount
ListBuckets
buckets 		Get list of buckets details 

Arguments

Name Description Default
region Overrides the default region when accessing buckets (ex:us-east-1, eu-west-2)

SQL Call

EXEC S3.ListBuckets
SELECT * FROM S3.buckets


Http Call

/s3/listbuckets

Output Columns

String region
String ownerId
String ownerName
String name
DateTime creationDate
ListFiles
files 		Get list of files details 

Arguments

Name Description Default
bucketName R The name of the bucket
prefix The prefix to provide the folder path
region Overrides the default region when accessing buckets (ex:us-east-1, eu-west-2)

SQL Call

EXEC S3.ListFiles 'test bucket'
SELECT * FROM S3.files where bucketName='test'


Http Call

/s3/listfiles

Output Columns

String region
String bucketName
String name
String prefix
String marker
String path
DateTime lastModified
Double size
String storageClass
uploadFile
Upload a file to s3 details 

Arguments

Name Description Default
bucketName R The name of the bucket
fileName R The destination file name
sourceFile R The full path and name of the source file
override If true, overrides the file if it already exists (default: 0) False
timeout Timeout operation in minutes - default: 0 (no timeout) 0
region Overrides the default region when accessing buckets (ex:us-east-1, eu-west-2)

SQL Call

EXEC S3.uploadFile @bucketName='testbucket',  @fileName='A100.pdf', @sourceFile='D:\Download\A100.pdf'


Http Call

/s3/uploadfile

Output Columns

This call does not return data.








601 21st St Suite 300
Vero Beach, FL 32960
United States

(561) 921-8669
info@enzounified.com
terms of service
privacy policy

PLATFORM

ENZO SERVER
ENZO DATAZEN

SOLUTIONS

SOLUTIONS OVERVIEW
INTEGRATION
SaaS
CLOUD ANALYTICS

RESOURCES

DOWNLOAD
BLOGS & VIDEOS
IN THE NEWS
ENZO ADAPTERS
ONLINE DOCUMENTATION
TCO CALCULATOR

COMPANY

LEADERSHIP TEAM
PARTNERS


© 2023 - Enzo Unified