S3 Get Object

S3 Get Object

Note: This feature is only available for instances hosted on AWS.

Transfer a file from Amazon S3 to a remote host.

This component can use a number of common network protocols to transfer data from an amazon S3 bucket. In all cases, the destination is specified with a URL. This component can be considered the opposite of the S3 Put Object.

Currently supported protocols are:

  • SFTP
  • Windows Fileshare
  • HDFS


Property Setting Description
Name Text The descriptive name for the component.
Input Data Type Choice Choose a connection protocol from the options available.
Set Home Directory as Root Choice Used with (S)FTP. By default, URLs are relative to the users home directory. This option tells Matillion ETL that the given path is from the server root.
Output Data URL Text The URL, including full path and file name, that points to the file to download onto a Bucket. The format of the URL varies considerably, however a default 'template' is offered once you have chosen a connection protocol.
Note:Special characters used in this field (e.g. in usernames and passwords) must be URL-safe. See documentation on URL Safe Characters for more information. This can be avoided by using the Username and Password properties.
Username Text This is your URL connection username. It is optional and will only be used if the data source requests it.
Password Text This is your URL connection password. It is optional and will only be used if the data source requests it.Users have the option to store their password inside the component but we highly recommend using the Password Manager option.
SFTP Key Text This is your SFTP Private Key. It is optional, only relevant for SFTP, and will only be used if the data source requests it.
This must be the complete private key, beginning with "-----BEGIN RSA PRIVATE KEY-----" and conforming to the same structure as an RSA private key.
S3 Path S3 Tree The S3 bucket address, path and filename to copy from. A public S3 URL can be entered in the text box, although you must have write access.

Example URLs

Each protocol, when entered for the first time, will have a sample URL associated with it, detailing the structure of the URL format for that protocol.

Protocol Sample URL
HDFS hdfs://host:port/filePath
SFTP sftp://[username[:password]@]hostname[:port][path]
Windows Fileshare smb://[[[authdomain;]user@]host[:port][/share[/dirpath][/name]]][?context]