Categories

Versions

You are viewing the RapidMiner Studio documentation for version 9.3 - Check here for latest version

Read Amazon S3 (Cloud Connectivity)

Synopsis

This operator downloads the specified file from the Amazon S3 cloud storage.

Description

After you have configured your Amazon S3 account, you can load the Amazon S3 file with this operator.

Be aware that the operator cannot read the file as example set. For this reason, you must connect the Read Amazon S3 operator to another appropriate operator to read the file. For example, if you want to load an Excel file from your Amazon S3, you must connect the Read Amazon S3 operator with the Read Excel operator to see the result.

Input

  • connection (Connection)

    This input port expects a Connection object if any. See the parameter connection entry for more information.

Output

  • file (File)

    The downloaded file object is returned here. Must be connected to a appropriate Read Operator, for example Read Excel or Read CSV.

  • connection (Connection)

    This output port delivers the Connection object from the input port. If the input port is not connected the port delivers nothing.

Parameters

  • connection_source This parameter indicates how the connection should be specified. It gives you two options, predefined and repository. The parameter is not visible if the connection input port is connected. Range: selection
  • connection_entry This parameter is only available when the connection source parameter is set to repository. This parameter is used to specify a repository location that represents a connection entry. The connection can also be provided using the connection input port. Range: string
  • connection This parameter is only available when the connection source parameter is set to predefined. The connection details for the Amazon S3 connection have to be specified. If you have already configured a Amazon S3 connection, you can select it from the drop-down list. If you have not configured a Amazon S3 connection yet, select the icon to the right of the drop-down list. Create a new Amazon S3 connection in the Manage connections box. The access key, secret key and the region are required. Note: It is very important to select the correct region for your connection. Otherwise an error occurs. Range: configurable
  • file Select the Amazon S3 file you want to download. Note that the concept of folders does not exist in Amazon S3, so the default delimiter ('/') is used to represent them. If your file was stored as 'name1/name2/my_file.xls' on Amazon S3, the file 'my_file.xls' would be displayed as residing in the folder 'name1/name2/'. Range: selection