Using the Amazon Simple Storage Service (S3), downloads data from an object in an S3 bucket.
This transformer accepts any feature.
Features which have successfully downloaded their contents from S3 are output through this port.
Features which have not successfully downloaded their contents from S3 are output through this port. Additionally, a message stored in an attribute specified in Error Attribute, will contain details about the failure.
An access key associated with a user with permission to download data from the specified bucket. If a pairing of an access key and a secret access key is not given, credentials will be searched in various locations listed here.
- In a file titled AwsCredentials.properties located in the Java classpath
- For the properties aws.accessKeyId and aws.secretKey in the Java system properties
- In the environment variables AWS_ACCESS_KEY_ID and AWS_SECRET_KEY
If credentials are still not found, the client will act as if it is in anonymous mode, where requests aren’t signed. This is useful if accessing a publicly accessible object or bucket.
A secret key paired with the access key provided. See the Access Key ID parameter for credential searching.
S3 Download Options
The name of the bucket which contains the object to download.
The name of the object to download. If the object is stored at the root of the bucket, specify only the file name (for example, myFile.txt). If it is stored inside a folder in the bucket, specify the path to the file (for example: FolderName/myFile.txt).
The target of the object data to be downloaded.
- Attribute: The downloaded object will be stored in the specified attribute. See Target Attribute.
- File: The downloaded object will be stored in the specified file. See Target Filename.
When working with large objects, File is the better choice as the data will be streamed directly to disk rather than stored entirely in memory on a feature.
Specify the name of the file that will store the downloaded object.
Specify the attribute that will store the downloaded object.
Specify the output attribute that will store any messages from errors during the download process.
Editing Transformer Parameters
Using a set of menu options, transformer parameters can be assigned by referencing other elements in the workspace. More advanced functions, such as an advanced editor and an arithmetic editor, are also available in some transformers. To access a menu of these options, click beside the applicable parameter. For more information, see Transformer Parameter Menu Options.
FME Licensing Level
FME Professional edition and above
Search FME Knowledge Center
Search for samples and information about this transformer on the FME Knowledge Center.