S3Uploader
Using the Amazon Simple Storage Service (S3), uploads data to an Amazon S3 bucket.
Input Ports
This transformer accepts any feature.
Output Ports
Features which have successfully uploaded their contents to S3 are output through this port.
Features which have not successfully uploaded their contents to S3 are output through this port. Additionally, a message stored in an attribute specified in Error Attribute, will contain details about the failure.
Parameters
AWS Credentials
An access key associated with a user with permission to upload data to 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.
Data Source
The source of the data to be uploaded.
- File: The specified file will be uploaded. The Upload Content Type will be automatically determined based on the file extension. See Source Filename.
- Attribute or Expression: The contents of the specified attribute or expression will be uploaded. See Data to Upload.
- Folder: The specified folder will be uploaded. Because permissions are either bucket- or object-specific, the default permissions cannot be altered for a folder. See Source Folder.
When working with large objects, File is the better choice as the data will be streamed directly from disk and not require that the object be stored entirely in memory on a feature.
File/Attribute or Expression Options
The file to be uploaded, when Data Source is File.
The data to be uploaded, when Data Source is Attribute or Expression. An attribute or expression can be used to supply the data.
The MIME type that the uploaded object will be tagged with when Data Source is File or Attribute or Expression. This can impact how some client software (web browsers, for example) will represent the object. For more information, see http://docs.aws.amazon.com/AmazonS3/latest/API/RESTObjectPUT.html.
Folder Options
The folder to be uploaded, when Data Source is Folder.
Option to include or exclude subfolders of the given folder from the upload.
S3 Upload Options
The name of the bucket to upload data to.
The name that the uploaded data will be stored under. Bucket Name and Object Key together uniquely identify an object, and should vary for each feature processed.
The predefined set of grantees and permissions to store with each uploaded object. For more information, please see http://docs.aws.amazon.com/AmazonS3/latest/dev/ACLOverview.html#CannedACL.
Output Options
Specify the output attribute that will store the uploaded object’s URI.
Specify the output attribute that will store any messages from errors during the upload 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.
Transformer Categories
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.